Sha256: 39cda64481ffd20c8ccf386c2156dce48a255c13c36eb4b900c81c7087aab88e

Contents?: true

Size: 1.37 KB

Versions: 203

Compression:

Stored size: 1.37 KB

Contents

# frozen_string_literal: true

module RuboCop
  module Cop
    module Style
      # 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

203 entries across 196 versions & 20 rubygems

Version Path
rubocop-1.74.0 lib/rubocop/cop/style/class_methods.rb
rubocop-1.73.2 lib/rubocop/cop/style/class_methods.rb
siteimprove_api_client-1.0.1 vendor/bundle/ruby/3.2.0/gems/rubocop-1.73.1/lib/rubocop/cop/style/class_methods.rb
rubocop-1.73.1 lib/rubocop/cop/style/class_methods.rb
rubocop-1.73.0 lib/rubocop/cop/style/class_methods.rb
rubocop-1.72.2 lib/rubocop/cop/style/class_methods.rb
rubocop-1.72.1 lib/rubocop/cop/style/class_methods.rb
rubocop-1.72.0 lib/rubocop/cop/style/class_methods.rb
rubocop-1.71.2 lib/rubocop/cop/style/class_methods.rb
tailscale_middleware-0.0.3 vendor/cache/ruby/3.4.0/gems/rubocop-1.71.1/lib/rubocop/cop/style/class_methods.rb
rubocop-1.71.1 lib/rubocop/cop/style/class_methods.rb
rubocop-1.71.0 lib/rubocop/cop/style/class_methods.rb
rubocop-1.70.0 lib/rubocop/cop/style/class_methods.rb
minato_ruby_api_client-0.2.2 vendor/bundle/ruby/3.2.0/gems/rubocop-1.64.1/lib/rubocop/cop/style/class_methods.rb
rubocop-1.69.2 lib/rubocop/cop/style/class_methods.rb
rubocop-1.69.1 lib/rubocop/cop/style/class_methods.rb
rubocop-1.69.0 lib/rubocop/cop/style/class_methods.rb
rubocop-1.68.0 lib/rubocop/cop/style/class_methods.rb
rubocop-1.67.0 lib/rubocop/cop/style/class_methods.rb
rubocop-1.66.1 lib/rubocop/cop/style/class_methods.rb