Class: RuboCop::Cop::Style::EachWithObject
- Defined in:
- lib/rubocop/cop/style/each_with_object.rb
Overview
This cop looks for inject / reduce calls where the passed in object is returned at the end and so could be replaced by each_with_object without the need to return the object at the end.
However, we can’t replace with each_with_object if the accumulator parameter is assigned to within the block.
Constant Summary collapse
- MSG =
'Use `each_with_object` instead of `%s`.'.freeze
- METHODS =
[:inject, :reduce].freeze
Constants included from Util
Util::ASGN_NODES, Util::BYTE_ORDER_MARK, Util::CONDITIONAL_NODES, Util::EQUALS_ASGN_NODES, Util::LITERAL_REGEX, Util::LOGICAL_OPERATOR_NODES, Util::MODIFIER_NODES, Util::OPERATOR_METHODS, Util::SHORTHAND_ASGN_NODES
Instance Attribute Summary
Attributes inherited from Cop
#config, #corrections, #offenses, #processed_source
Instance Method Summary collapse
Methods inherited from Cop
#add_offense, all, badge, #config_to_allow_offenses, #config_to_allow_offenses=, #cop_config, #cop_name, cop_name, #correct, department, #duplicate_location?, #excluded_file?, #find_location, #highlights, inherited, #initialize, #join_force?, lint?, match?, #message, #messages, non_rails, #parse, qualified_cop_name, #relevant_file?, #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?, #support_autocorrect?
Methods included from IgnoredNode
#ignore_node, #ignored_node?, #part_of_ignored_node?
Methods included from Util
begins_its_line?, block_length, comment_line?, compatible_external_encoding_for?, directions, double_quotes_acceptable?, double_quotes_required?, effective_column, ends_its_line?, escape_string, first_part_of_call_chain, hard_to_type?, interpret_string_escapes, line_distance, line_range, move_pos, needs_escaping?, numeric_range_size, on_node, operator?, parentheses?, parenthesized_call?, preceed?, range_between, range_with_surrounding_comma, range_with_surrounding_space, same_line?, source_range, strip_quotes, stripped_source_upto, to_string_literal, to_supported_styles, to_symbol_literal, within_node?
Methods included from PathUtil
absolute?, match_path?, relative_path
Constructor Details
This class inherits a constructor from RuboCop::Cop::Cop
Instance Method Details
#autocorrect(node) ⇒ Object
41 42 43 44 45 46 47 48 49 50 51 52 |
# File 'lib/rubocop/cop/style/each_with_object.rb', line 41 def autocorrect(node) lambda do |corrector| method, args, body = *node corrector.replace(method.loc.selector, 'each_with_object') first_arg, second_arg = *args corrector.replace(first_arg.loc.expression, second_arg.source) corrector.replace(second_arg.loc.expression, first_arg.source) return_value = return_value(body) corrector.remove(return_value.loc.expression) end end |
#on_block(node) ⇒ Object
27 28 29 30 31 32 33 34 35 36 37 38 39 |
# File 'lib/rubocop/cop/style/each_with_object.rb', line 27 def on_block(node) each_with_object_candidate?(node) do |method, args, body| _, method_name, method_arg = *method return if simple_method_arg?(method_arg) return_value = return_value(body) return unless return_value return unless first_argument_returned?(args, return_value) return if accumulator_param_assigned_to?(body, args) add_offense(node, method.loc.selector, format(MSG, method_name)) end end |