Class: RuboCop::Cop::Style::CollectionMethods
- Includes:
- MethodPreference
- Defined in:
- lib/rubocop/cop/style/collection_methods.rb
Overview
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.
Constant Summary collapse
- MSG =
'Prefer `%<prefer>s` over `%<current>s`.'
Constants included from Util
Instance Attribute Summary
Attributes inherited from Cop
#config, #corrections, #offenses, #processed_source
Instance Method Summary collapse
Methods inherited from Cop
#add_offense, all, autocorrect_incompatible_with, badge, #config_to_allow_offenses, #config_to_allow_offenses=, #cop_config, cop_name, #cop_name, #correct, department, #disable_uncorrectable, #duplicate_location?, #excluded_file?, #external_dependency_checksum, #find_location, #highlights, inherited, #initialize, #join_force?, lint?, match?, #messages, #parse, qualified_cop_name, #reason_to_not_correct, #relevant_file?, #target_rails_version, #target_ruby_version
Methods included from AST::Sexp
Methods included from NodePattern::Macros
#def_node_matcher, #def_node_search, #node_search, #node_search_all, #node_search_body, #node_search_first
Methods included from AutocorrectLogic
#autocorrect?, #autocorrect_enabled?, #autocorrect_requested?, #correctable?, #disable_offense, #disable_uncorrectable?, #safe_autocorrect?, #support_autocorrect?
Methods included from IgnoredNode
#ignore_node, #ignored_node?, #part_of_ignored_node?
Methods included from Util
add_parentheses, args_begin, args_end, begins_its_line?, comment_line?, comment_lines?, double_quotes_required?, escape_string, first_part_of_call_chain, interpret_string_escapes, line_range, needs_escaping?, on_node, parentheses?, same_line?, to_string_literal, to_supported_styles, tokens, trim_string_interporation_escape_character
Methods included from PathUtil
absolute?, chdir, hidden_dir?, hidden_file_in_not_hidden_dir?, match_path?, pwd, relative_path, reset_pwd, smart_path
Constructor Details
This class inherits a constructor from RuboCop::Cop::Cop
Instance Method Details
#autocorrect(node) ⇒ Object
56 57 58 59 60 61 |
# File 'lib/rubocop/cop/style/collection_methods.rb', line 56 def autocorrect(node) lambda do |corrector| corrector.replace(node.loc.selector, preferred_method(node.loc.selector.source)) end end |
#on_block(node) ⇒ Object
45 46 47 |
# File 'lib/rubocop/cop/style/collection_methods.rb', line 45 def on_block(node) check_method_node(node.send_node) end |
#on_send(node) ⇒ Object
49 50 51 52 53 54 |
# File 'lib/rubocop/cop/style/collection_methods.rb', line 49 def on_send(node) return unless node.arguments.one? && node.first_argument.block_pass_type? check_method_node(node) end |