Sha256: cdc90ed6c11093041fdec4e15541e374396ef7987a7bf5e59ae36275bf0795bb

Contents?: true

Size: 1.67 KB

Versions: 6949

Compression:

Stored size: 1.67 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 < Cop
        MSG = 'Use `self.%<method>s` instead of `%<class>s.%<method>s`.'.freeze

        def on_class(node)
          name, _superclass, body = *node
          check(name, body)
        end

        def on_module(node)
          name, body = *node
          check(name, body)
        end

        def autocorrect(node)
          ->(corrector) { corrector.replace(node.loc.name, 'self') }
        end

        private

        def check(name, node)
          return unless node

          if node.defs_type?
            check_defs(name, node)
          elsif node.begin_type?
            node.each_child_node(:defs) { |n| check_defs(name, n) }
          end
        end

        def check_defs(name, node)
          definee, method_name, _args, _body = *node
          # check if the class/module name matches the definee for the defs node
          return unless name == definee

          _, class_name = *definee
          add_offense(definee, location: :name,
                               message: message(class_name, method_name))
        end

        def message(class_name, method_name)
          format(MSG, method: method_name, class: class_name)
        end
      end
    end
  end
end

Version data entries

6,949 entries across 6,943 versions & 26 rubygems

Version Path
ory-client-0.0.1.alpha161 vendor/bundle/ruby/2.5.0/gems/rubocop-0.66.0/lib/rubocop/cop/style/class_methods.rb
ory-client-0.0.1.alpha160 vendor/bundle/ruby/2.5.0/gems/rubocop-0.66.0/lib/rubocop/cop/style/class_methods.rb
ory-client-0.0.1.alpha159 vendor/bundle/ruby/2.5.0/gems/rubocop-0.66.0/lib/rubocop/cop/style/class_methods.rb
ory-client-0.0.1.alpha158 vendor/bundle/ruby/2.5.0/gems/rubocop-0.66.0/lib/rubocop/cop/style/class_methods.rb
ory-client-0.0.1.alpha157 vendor/bundle/ruby/2.5.0/gems/rubocop-0.66.0/lib/rubocop/cop/style/class_methods.rb
ory-client-0.0.1.alpha156 vendor/bundle/ruby/2.5.0/gems/rubocop-0.66.0/lib/rubocop/cop/style/class_methods.rb
ory-client-0.0.1.alpha155 vendor/bundle/ruby/2.5.0/gems/rubocop-0.66.0/lib/rubocop/cop/style/class_methods.rb
ory-client-0.0.1.alpha154 vendor/bundle/ruby/2.5.0/gems/rubocop-0.66.0/lib/rubocop/cop/style/class_methods.rb
ory-oathkeeper-client-0.38.24.beta1 vendor/bundle/ruby/2.5.0/gems/rubocop-0.66.0/lib/rubocop/cop/style/class_methods.rb
ory-client-0.0.1.alpha153 vendor/bundle/ruby/2.5.0/gems/rubocop-0.66.0/lib/rubocop/cop/style/class_methods.rb
ory-client-0.0.1.alpha152 vendor/bundle/ruby/2.5.0/gems/rubocop-0.66.0/lib/rubocop/cop/style/class_methods.rb
ory-client-0.0.1.alpha151 vendor/bundle/ruby/2.5.0/gems/rubocop-0.66.0/lib/rubocop/cop/style/class_methods.rb
ory-client-0.0.1.alpha150 vendor/bundle/ruby/2.5.0/gems/rubocop-0.66.0/lib/rubocop/cop/style/class_methods.rb
ory-client-0.0.1.alpha149 vendor/bundle/ruby/2.5.0/gems/rubocop-0.66.0/lib/rubocop/cop/style/class_methods.rb
ory-client-0.0.1.alpha148 vendor/bundle/ruby/2.5.0/gems/rubocop-0.66.0/lib/rubocop/cop/style/class_methods.rb
ory-client-0.0.1.alpha147 vendor/bundle/ruby/2.5.0/gems/rubocop-0.66.0/lib/rubocop/cop/style/class_methods.rb
ory-kratos-client-0.9.0.alpha3 vendor/bundle/ruby/2.5.0/gems/rubocop-0.66.0/lib/rubocop/cop/style/class_methods.rb
ory-client-0.0.1.alpha146 vendor/bundle/ruby/2.5.0/gems/rubocop-0.66.0/lib/rubocop/cop/style/class_methods.rb
ory-client-0.0.1.alpha145 vendor/bundle/ruby/2.5.0/gems/rubocop-0.66.0/lib/rubocop/cop/style/class_methods.rb
ory-kratos-client-0.9.0.alpha2 vendor/bundle/ruby/2.5.0/gems/rubocop-0.66.0/lib/rubocop/cop/style/class_methods.rb