123456789_123456789_123456789_123456789_123456789_

Class: RuboCop::Cop::Lint::UselessTimes

Relationships & Source Files
Super Chains via Extension / Inclusion / Inheritance
Class Chain:
self, ::RuboCop::Cop::AutoCorrector, ::RuboCop::Cop::Base, ::RuboCop::ExcludeLimit, NodePattern::Macros, RuboCop::AST::Sexp
Instance Chain:
Inherits: RuboCop::Cop::Base
Defined in: lib/rubocop/cop/lint/useless_times.rb

Overview

Checks for uses of Integer#times that will never yield (when the integer ⇐ 0) or that will only ever yield once (1.times).

Examples:

# bad
-5.times { do_something }
0.times { do_something }
1.times { do_something  }
1.times { |i| do_something(i) }

# good
do_something
do_something(1)

Cop Safety Information:

  • This cop is unsafe as times returns its receiver, which is usually OK, but might change behavior.

Constant Summary

::RuboCop::Cop::Base - Inherited

EMPTY_OFFENSES, RESTRICT_ON_SEND

::RuboCop::Cop::RangeHelp - Included

BYTE_ORDER_MARK, NOT_GIVEN

Class Attribute Summary

::RuboCop::Cop::AutoCorrector - Extended

::RuboCop::Cop::Base - Inherited

.gem_requirements, .lint?,
.support_autocorrect?

Returns if class supports autocorrect.

.support_multiple_source?

Override if your cop should be called repeatedly for multiple investigations Between calls to on_new_investigation and on_investigation_end, the result of processed_source will remain constant.

Class Method Summary

::RuboCop::Cop::Base - Inherited

.autocorrect_incompatible_with

List of cops that should not try to autocorrect at the same time as this cop.

.badge

Naming.

.callbacks_needed, .cop_name, .department,
.documentation_url

Returns an url to view this cops documentation online.

.exclude_from_registry

Call for abstract Cop classes.

.inherited,
.joining_forces

Override and return the Force class(es) you need to join.

.match?

Returns true if the cop name or the cop namespace matches any of the given names.

.new,
.requires_gem

Register a version requirement for the given gem name.

.restrict_on_send

::RuboCop::ExcludeLimit - Extended

exclude_limit

Sets up a configuration option to have an exclude limit tracked.

transform

Instance Attribute Summary

Instance Method Summary

::RuboCop::Cop::RangeHelp - Included

#add_range, #column_offset_between,
#contents_range

A range containing only the contents of a literal with delimiters (e.g.

#directions,
#effective_column

Returns the column attribute of the range, except if the range is on the first line and there’s a byte order mark at the beginning of that line, in which case 1 is subtracted from the column value.

#final_pos, #move_pos, #move_pos_str, #range_between, #range_by_whole_lines, #range_with_comments, #range_with_comments_and_lines, #range_with_surrounding_comma, #range_with_surrounding_space, #source_range

::RuboCop::Cop::Base - Inherited

#add_global_offense

Adds an offense that has no particular location.

#add_offense

Adds an offense on the specified range (or node with an expression) Unless that offense is disabled for this range, a corrector will be yielded to provide the cop the opportunity to autocorrect the offense.

#begin_investigation

Called before any investigation.

#callbacks_needed,
#cop_config

Configuration Helpers.

#cop_name, #excluded_file?,
#external_dependency_checksum

This method should be overridden when a cop’s behavior depends on state that lives outside of these locations:

#inspect
#message

Gets called if no message is specified when calling add_offense or add_global_offense Cops are discouraged to override this; instead pass your message directly.

#name

Alias for Base#cop_name.

#offenses,
#on_investigation_end

Called after all on_…​

#on_new_investigation

Called before all on_…​

#on_other_file

Called instead of all on_…​

#parse

There should be very limited reasons for a Cop to do it’s own parsing.

#parser_engine,
#ready

Called between investigations.

#relevant_file?, #target_rails_version, #target_ruby_version, #annotate, #apply_correction, #attempt_correction,
#callback_argument

Reserved for Cop::Cop.

#complete_investigation

Called to complete an investigation.

#correct, #current_corrector,
#current_offense_locations

Reserved for Commissioner:

#current_offenses, #currently_disabled_lines, #custom_severity, #default_severity, #disable_uncorrectable, #enabled_line?, #file_name_matches_any?, #find_message, #find_severity, #range_for_original, #range_from_node_or_range,
#reset_investigation

Actually private methods.

#use_corrector

::RuboCop::Cop::AutocorrectLogic - Included

::RuboCop::Cop::IgnoredNode - Included

Constructor Details

This class inherits a constructor from RuboCop::Cop::Base

Instance Method Details

#autocorrect(corrector, count, node, proc_name) (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/lint/useless_times.rb', line 62

def autocorrect(corrector, count, node, proc_name)
  if never_process?(count, node)
    remove_node(corrector, node)
  elsif !proc_name.empty?
    autocorrect_block_pass(corrector, node, proc_name)
  elsif node.block_type?
    autocorrect_block(corrector, node)
  end
end

#autocorrect_block(corrector, node) (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/lint/useless_times.rb', line 84

def autocorrect_block(corrector, node)
  block_arg = block_arg(node)
  return if block_reassigns_arg?(node, block_arg)

  source = node.body.source
  source.gsub!(/\b#{block_arg}\b/, '0') if block_arg

  corrector.replace(node, fix_indentation(source, node.loc.column...node.body.loc.column))
end

#autocorrect_block_pass(corrector, node, proc_name) (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/lint/useless_times.rb', line 80

def autocorrect_block_pass(corrector, node, proc_name)
  corrector.replace(node, proc_name)
end

#block_arg(node)

[ GitHub ]

  
# File 'lib/rubocop/cop/lint/useless_times.rb', line 37

def_node_matcher :block_arg, <<~PATTERN
  (block _ (args (arg $_)) ...)
PATTERN

#block_reassigns_arg?(node)

[ GitHub ]

  
# File 'lib/rubocop/cop/lint/useless_times.rb', line 42

def_node_search :block_reassigns_arg?, <<~PATTERN
  (lvasgn %)
PATTERN

#fix_indentation(source, range) (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/lint/useless_times.rb', line 94

def fix_indentation(source, range)
  # Cleanup indentation in a multiline block
  source_lines = source.split("\n")

  source_lines[1..].each do |line|
    next if line.empty?

    line[range] = ''
  end
  source_lines.join("\n")
end

#never_process?(count, node) ⇒ Boolean (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/lint/useless_times.rb', line 72

def never_process?(count, node)
  count < 1 || (node.block_type? && node.body.nil?)
end

#on_send(node)

[ GitHub ]

  
# File 'lib/rubocop/cop/lint/useless_times.rb', line 46

def on_send(node)
  return unless (count, proc_name = times_call?(node))
  return if count > 1

  # Get the block node if applicable
  node = node.block_node if node.block_literal?

  add_offense(node, message: format(MSG, count: count)) do |corrector|
    next if !own_line?(node) || node.parent&.send_type?

    autocorrect(corrector, count, node, proc_name)
  end
end

#own_line?(node) ⇒ Boolean (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/lint/useless_times.rb', line 106

def own_line?(node)
  # If there is anything else on the line other than whitespace,
  # don't try to autocorrect
  processed_source.buffer.source_line(node.loc.line)[0...node.loc.column] !~ /\S/
end

#remove_node(corrector, node) (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/lint/useless_times.rb', line 76

def remove_node(corrector, node)
  corrector.remove(range_by_whole_lines(node.source_range, include_final_newline: true))
end

#times_call?(node)

[ GitHub ]

  
# File 'lib/rubocop/cop/lint/useless_times.rb', line 32

def_node_matcher :times_call?, <<~PATTERN
  (send (int $_) :times (block-pass (sym $_))?)
PATTERN