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

Inherits:
Base
  • Object
show all
Extended by:
AutoCorrector
Includes:
RangeHelp
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)

Constant Summary collapse

MSG = 
'Useless call to `%<count>i.times` detected.'
RESTRICT_ON_SEND = 
%i[times].freeze

Instance Attribute Summary

Attributes inherited from Base

#config, #processed_source

Instance Method Summary collapse

Methods included from AutoCorrector

support_autocorrect?

Methods inherited from Base

#active_support_extensions_enabled?, #add_global_offense, #add_offense, #always_autocorrect?, autocorrect_incompatible_with, badge, #begin_investigation, #callbacks_needed, callbacks_needed, #config_to_allow_offenses, #config_to_allow_offenses=, #contextual_autocorrect?, #cop_config, cop_name, #cop_name, department, documentation_url, exclude_from_registry, #excluded_file?, #external_dependency_checksum, inherited, #initialize, #inspect, joining_forces, lint?, match?, #message, #offenses, #on_investigation_end, #on_new_investigation, #on_other_file, #parse, #parser_engine, #ready, #relevant_file?, requires_gem, #string_literals_frozen_by_default?, support_autocorrect?, support_multiple_source?, #target_rails_version, #target_ruby_version

Methods included from ExcludeLimit

#exclude_limit

Methods included from AutocorrectLogic

#autocorrect?, #autocorrect_enabled?, #autocorrect_requested?, #autocorrect_with_disable_uncorrectable?, #correctable?, #disable_uncorrectable?, #safe_autocorrect?

Methods included from IgnoredNode

#ignore_node, #ignored_node?, #part_of_ignored_node?

Methods included from Util

silence_warnings

Constructor Details

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

Instance Method Details

#block_arg(node) ⇒ Object 



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

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

#block_reassigns_arg?(node) ⇒ Object 



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

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

#on_send(node) ⇒ Object 



46
47
48
49
50
51
52
53
54
55
56
57
58
 
# 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

#times_call?(node) ⇒ Object 



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

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