Sha256: 741ccfe45c02d63a47e94b30ba9abe4218f8fbe269e9b2c08fdad86c2ab85403

Contents?: true

Size: 1.38 KB

Versions: 38

Compression:

Stored size: 1.38 KB

Contents

# frozen_string_literal: true

module RuboCop
  module Cop
    module Style
      # This cop checks for uses of the class/module name instead of
      # self, when defining class/module methods.
      #
      # @example
      #   # bad
      #   class SomeClass
      #     def SomeClass.class_method
      #       # ...
      #     end
      #   end
      #
      #   # good
      #   class SomeClass
      #     def self.class_method
      #       # ...
      #     end
      #   end
      class ClassMethods < Base
        extend AutoCorrector

        MSG = 'Use `self.%<method>s` instead of `%<class>s.%<method>s`.'

        def on_class(node)
          return unless node.body

          if node.body.defs_type?
            check_defs(node.identifier, node.body)
          elsif node.body.begin_type?
            node.body.each_child_node(:defs) { |def_node| check_defs(node.identifier, def_node) }
          end
        end
        alias on_module on_class

        private

        def check_defs(name, node)
          # check if the class/module name matches the definee for the defs node
          return unless name == node.receiver

          message = format(MSG, method: node.method_name, class: name.source)

          add_offense(node.receiver.loc.name, message: message) do |corrector|
            corrector.replace(node.receiver, 'self')
          end
        end
      end
    end
  end
end

Version data entries

38 entries across 38 versions & 6 rubygems

Version Path
scrapbook-0.3.2 vendor/ruby/2.7.0/gems/rubocop-1.26.0/lib/rubocop/cop/style/class_methods.rb
scrapbook-0.3.1 vendor/ruby/2.7.0/gems/rubocop-1.26.0/lib/rubocop/cop/style/class_methods.rb
rubocop-1.29.1 lib/rubocop/cop/style/class_methods.rb
rubocop-1.29.0 lib/rubocop/cop/style/class_methods.rb
rubocop-1.28.2 lib/rubocop/cop/style/class_methods.rb
rubocop-1.28.1 lib/rubocop/cop/style/class_methods.rb
rubocop-1.28.0 lib/rubocop/cop/style/class_methods.rb
rubocop-1.27.0 lib/rubocop/cop/style/class_methods.rb
rubocop-1.26.1 lib/rubocop/cop/style/class_methods.rb
op_connect-0.1.2 vendor/bundle/ruby/3.1.0/gems/rubocop-1.26.0/lib/rubocop/cop/style/class_methods.rb
rubocop-1.26.0 lib/rubocop/cop/style/class_methods.rb
rubocop-1.25.1 lib/rubocop/cop/style/class_methods.rb
rubocop-1.25.0 lib/rubocop/cop/style/class_methods.rb
phillipug-foodie-0.1.0 .vendor/ruby/3.0.0/gems/rubocop-1.24.0/lib/rubocop/cop/style/class_methods.rb
rubocop-1.24.1 lib/rubocop/cop/style/class_methods.rb
rubocop-1.24.0 lib/rubocop/cop/style/class_methods.rb
rubocop-1.23.0 lib/rubocop/cop/style/class_methods.rb
rubocop-1.22.3 lib/rubocop/cop/style/class_methods.rb
rubocop-1.22.2 lib/rubocop/cop/style/class_methods.rb
rubocop-1.22.1 lib/rubocop/cop/style/class_methods.rb