Class: RuboCop::Cop::Lint::RequireRangeParentheses

Inherits:
Base
  • Object
show all
Defined in:
lib/rubocop/cop/lint/require_range_parentheses.rb

Overview

Checks that a range literal is enclosed in parentheses when the end of the range is at a line break.

NOTE: The following is maybe intended for ‘(42..)`. But, compatible is `42..do_something`. So, this cop does not provide autocorrection because it is left to user.

source,ruby

case condition when 42..

do_something

end

Examples:


# bad - Represents `(1..42)`, not endless range.
1..
42

# good - It's incompatible, but your intentions when using endless range may be:
(1..)
42

# good
1..42

# good
(1..42)

# good
(1..
42)

Constant Summary collapse

MSG = 
'Wrap the endless range literal `%<range>s` to avoid precedence ambiguity.'

Constants inherited from Base

Base::RESTRICT_ON_SEND

Instance Attribute Summary

Attributes inherited from Base

#config, #processed_source

Instance Method Summary collapse

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

#on_irange(node) ⇒ Object Also known as: on_erange 



43
44
45
46
47
48
49
50
51
 
# File 'lib/rubocop/cop/lint/require_range_parentheses.rb', line 43

def on_irange(node)
  return if node.parent&.begin_type?
  return unless node.begin && node.end
  return if same_line?(node.begin, node.end)

  message = format(MSG, range: "#{node.begin.source}#{node.loc.operator.source}")

  add_offense(node, message: message)
end