Sha256: 9e791340b8bbaca7f30a4b8dfd745db6e70d0a0c08882c8def04fe420e27d7dd

Contents?: true

Size: 1.95 KB

Versions: 151

Compression:

Stored size: 1.95 KB

Contents

# frozen_string_literal: true

module RuboCop
  module Cop
    module Lint
      # Checks for useless method definitions, specifically: empty constructors
      # and methods just delegating to `super`.
      #
      # @safety
      #   This cop is unsafe as it can register false positives for cases when an empty
      #   constructor just overrides the parent constructor, which is bad anyway.
      #
      # @example
      #   # bad
      #   def initialize
      #     super
      #   end
      #
      #   def method
      #     super
      #   end
      #
      #   # good - with default arguments
      #   def initialize(x = Object.new)
      #     super
      #   end
      #
      #   # good
      #   def initialize
      #     super
      #     initialize_internals
      #   end
      #
      #   def method(*args)
      #     super(:extra_arg, *args)
      #   end
      #
      class UselessMethodDefinition < Base
        extend AutoCorrector

        MSG = 'Useless method definition detected.'

        def on_def(node)
          return if method_definition_with_modifier?(node) || use_rest_or_optional_args?(node)
          return unless delegating?(node.body, node)

          add_offense(node) do |corrector|
            range = node.parent&.send_type? ? node.parent : node

            corrector.remove(range)
          end
        end
        alias on_defs on_def

        private

        def method_definition_with_modifier?(node)
          node.parent&.send_type? && !node.parent&.non_bare_access_modifier?
        end

        def use_rest_or_optional_args?(node)
          node.arguments.any? { |arg| arg.restarg_type? || arg.optarg_type? || arg.kwoptarg_type? }
        end

        def delegating?(node, def_node)
          if node&.zsuper_type?
            true
          elsif node&.super_type?
            node.arguments.map(&:source) == def_node.arguments.map(&:source)
          else
            false
          end
        end
      end
    end
  end
end

Version data entries

151 entries across 150 versions & 15 rubygems

Version Path
rubocop-1.70.0 lib/rubocop/cop/lint/useless_method_definition.rb
minato_ruby_api_client-0.2.2 vendor/bundle/ruby/3.2.0/gems/rubocop-1.64.1/lib/rubocop/cop/lint/useless_method_definition.rb
rubocop-1.69.2 lib/rubocop/cop/lint/useless_method_definition.rb
rubocop-1.69.1 lib/rubocop/cop/lint/useless_method_definition.rb
rubocop-1.69.0 lib/rubocop/cop/lint/useless_method_definition.rb
rubocop-1.68.0 lib/rubocop/cop/lint/useless_method_definition.rb
rubocop-1.67.0 lib/rubocop/cop/lint/useless_method_definition.rb
rubocop-1.66.1 lib/rubocop/cop/lint/useless_method_definition.rb
rubocop-1.66.0 lib/rubocop/cop/lint/useless_method_definition.rb
rubocop-1.65.1 lib/rubocop/cop/lint/useless_method_definition.rb
blacklight-spotlight-3.6.0.beta8 vendor/bundle/ruby/3.2.0/gems/rubocop-1.64.1/lib/rubocop/cop/lint/useless_method_definition.rb
rubocop-1.65.0 lib/rubocop/cop/lint/useless_method_definition.rb
katalyst-govuk-formbuilder-1.9.2 vendor/bundle/ruby/3.3.0/gems/rubocop-1.64.1/lib/rubocop/cop/lint/useless_method_definition.rb
rubocop-1.64.1 lib/rubocop/cop/lint/useless_method_definition.rb
rubocop-1.63.4 lib/rubocop/cop/lint/useless_method_definition.rb
rubocop-1.63.3 lib/rubocop/cop/lint/useless_method_definition.rb
rubocop-1.63.2 lib/rubocop/cop/lint/useless_method_definition.rb
harbr-2.8.1 vendor/bundle/ruby/3.2.0/gems/rubocop-1.57.2/lib/rubocop/cop/lint/useless_method_definition.rb
rubocop-1.63.1 lib/rubocop/cop/lint/useless_method_definition.rb
rubocop-1.63.0 lib/rubocop/cop/lint/useless_method_definition.rb