Class: RuboCop::Cop::Style::EachForSimpleLoop

Inherits:
Cop
  • Object
show all
Defined in:
lib/rubocop/cop/style/each_for_simple_loop.rb

Overview

This cop checks for loops which iterate a constant number of times, using a Range literal and ‘#each`. This can be done more readably using `Integer#times`.

This check only applies if the block takes no parameters.

Examples:

# bad
(1..5).each { }

# good
5.times { }
# bad
(0...10).each {}

# good
10.times {}

Constant Summary collapse

MSG = 
'Use `Integer#times` for a simple loop which iterates a fixed ' \
'number of times.'.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, autocorrect_incompatible_with, 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_rails_version, #target_ruby_version

Methods included from AST::Sexp

#s

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?, comment_line?, double_quotes_required?, effective_column, ends_its_line?, escape_string, first_part_of_call_chain, interpret_string_escapes, line_range, needs_escaping?, on_node, operator?, parentheses?, parenthesized_call?, precede?, range_between, range_by_whole_lines, range_with_surrounding_comma, range_with_surrounding_space, same_line?, source_range, strip_quotes, stripped_source_upto, symbol_without_quote?, to_string_literal, to_supported_styles, to_symbol_literal, within_node?

Methods included from PathUtil

absolute?, find_file_upwards, 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 



39
40
41
42
43
44
45
46
47
48
 
# File 'lib/rubocop/cop/style/each_for_simple_loop.rb', line 39

def autocorrect(node)
  lambda do |corrector|
    range_type, min, max = offending_each_range(node)

    max += 1 if range_type == :irange

    corrector.replace(node.send_node.source_range,
                      "#{max - min}.times")
  end
end

#on_block(node) ⇒ Object 



29
30
31
32
33
34
35
36
37
 
# File 'lib/rubocop/cop/style/each_for_simple_loop.rb', line 29

def on_block(node)
  return unless offending_each_range(node)

  send_node = node.send_node

  range = send_node.receiver.source_range.join(send_node.loc.selector)

  add_offense(node, location: range)
end