Sha256: 914170d21792036ce794a617e00f9509f7df2d25b504a6b1fda44961c1bc7736

Contents?: true

Size: 1.95 KB

Versions: 16

Compression:

Stored size: 1.95 KB

Contents

# frozen_string_literal: true

module RuboCop
  module Cop
    module Style
      # This cop enforces the use of consistent method names
      # from the Enumerable module.
      #
      # Unfortunately we cannot actually know if a method is from
      # Enumerable or not (static analysis limitation), so this cop
      # can yield some false positives.
      #
      # You can customize the mapping from undesired method to desired method.
      #
      # e.g. to use `detect` over `find`:
      #
      #   Style/CollectionMethods:
      #     PreferredMethods:
      #       find: detect
      #
      # The default mapping for `PreferredMethods` behaves as follows.
      #
      # @example
      #   # bad
      #   items.collect
      #   items.collect!
      #   items.inject
      #   items.detect
      #   items.find_all
      #   items.member?
      #
      #   # good
      #   items.map
      #   items.map!
      #   items.reduce
      #   items.find
      #   items.select
      #   items.include?
      #
      class CollectionMethods < Cop
        include MethodPreference

        MSG = 'Prefer `%<prefer>s` over `%<current>s`.'

        def on_block(node)
          check_method_node(node.send_node)
        end

        def on_send(node)
          return unless node.arguments.one? &&
                        node.first_argument.block_pass_type?

          check_method_node(node)
        end

        def autocorrect(node)
          lambda do |corrector|
            corrector.replace(node.loc.selector,
                              preferred_method(node.loc.selector.source))
          end
        end

        private

        def message(node)
          format(MSG,
                 prefer: preferred_method(node.method_name),
                 current: node.method_name)
        end

        def check_method_node(node)
          return unless preferred_methods[node.method_name]

          add_offense(node, location: :selector)
        end
      end
    end
  end
end

Version data entries

16 entries across 16 versions & 3 rubygems

Version Path
rubocop-0.89.0 lib/rubocop/cop/style/collection_methods.rb
rubocop-0.88.0 lib/rubocop/cop/style/collection_methods.rb
rbhint-0.87.1.rc1 lib/rubocop/cop/style/collection_methods.rb
rubocop-0.87.1 lib/rubocop/cop/style/collection_methods.rb
rubocop-0.87.0 lib/rubocop/cop/style/collection_methods.rb
rubocop-0.86.0 lib/rubocop/cop/style/collection_methods.rb
files.com-1.0.1 vendor/bundle/ruby/2.5.0/gems/rubocop-0.85.1/lib/rubocop/cop/style/collection_methods.rb
rbhint-0.85.1.rc2 lib/rubocop/cop/style/collection_methods.rb
rbhint-0.85.1.rc1 lib/rubocop/cop/style/collection_methods.rb
rubocop-0.85.1 lib/rubocop/cop/style/collection_methods.rb
rbhint-0.8.5.rc1 lib/rubocop/cop/style/collection_methods.rb
rubocop-0.85.0 lib/rubocop/cop/style/collection_methods.rb
rubocop-0.84.0 lib/rubocop/cop/style/collection_methods.rb
rubocop-0.83.0 lib/rubocop/cop/style/collection_methods.rb
rubocop-0.82.0 lib/rubocop/cop/style/collection_methods.rb
rubocop-0.81.0 lib/rubocop/cop/style/collection_methods.rb