Sha256: 1e03ad9f0338d88340d6ab80f3b2cc78a61d779b7b1dead828c6a37d1e51de8c

Contents?: true

Size: 1.67 KB

Versions: 14

Compression:

Stored size: 1.67 KB

Contents

# frozen_string_literal: true

module RuboCop
  module Cop
    module Lint
      # This cop checks for useless method definitions, specifically: empty constructors
      # and methods just delegating to `super`.
      #
      # This cop is marked as unsafe as it can trigger 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 optional_args?(node)
          return unless delegating?(node.body, node)

          add_offense(node) { |corrector| corrector.remove(node) }
        end
        alias on_defs on_def

        private

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

        def delegating?(node, def_node)
          if node.nil?
            false
          elsif 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

14 entries across 14 versions & 2 rubygems

Version Path
plaid-14.13.0 vendor/bundle/ruby/3.0.0/gems/rubocop-0.91.1/lib/rubocop/cop/lint/useless_method_definition.rb
plaid-14.12.1 vendor/bundle/ruby/3.0.0/gems/rubocop-0.91.1/lib/rubocop/cop/lint/useless_method_definition.rb
plaid-14.12.0 vendor/bundle/ruby/2.6.0/gems/rubocop-0.91.1/lib/rubocop/cop/lint/useless_method_definition.rb
plaid-14.11.1 vendor/bundle/ruby/2.6.0/gems/rubocop-0.91.1/lib/rubocop/cop/lint/useless_method_definition.rb
plaid-14.10.0 vendor/bundle/ruby/2.6.0/gems/rubocop-0.91.1/lib/rubocop/cop/lint/useless_method_definition.rb
plaid-14.7.0 vendor/bundle/ruby/2.6.0/gems/rubocop-0.91.1/lib/rubocop/cop/lint/useless_method_definition.rb
rubocop-1.2.0 lib/rubocop/cop/lint/useless_method_definition.rb
rubocop-1.1.0 lib/rubocop/cop/lint/useless_method_definition.rb
rubocop-1.0.0 lib/rubocop/cop/lint/useless_method_definition.rb
rubocop-0.93.1 lib/rubocop/cop/lint/useless_method_definition.rb
rubocop-0.93.0 lib/rubocop/cop/lint/useless_method_definition.rb
rubocop-0.92.0 lib/rubocop/cop/lint/useless_method_definition.rb
rubocop-0.91.1 lib/rubocop/cop/lint/useless_method_definition.rb
rubocop-0.91.0 lib/rubocop/cop/lint/useless_method_definition.rb