Class: RuboCop::Cop::Style::OperatorMethodCall
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:
self,
::RuboCop::Cop::Base ,
::RuboCop::Cop::AutocorrectLogic ,
::RuboCop::Cop::IgnoredNode ,
::RuboCop::Util ,
RuboCop::AST::Sexp
|
|
Inherits: |
RuboCop::Cop::Base
|
Defined in: | lib/rubocop/cop/style/operator_method_call.rb |
Overview
Checks for redundant dot before operator method call.
The target operator methods are {|}, ^
, &
, <⇒
, ==
, ===
, =~
, >
, >=
, <
,
⇐
, <<
, >>
, +
, -
, ,
/
, %
, *
, ~
, !
, !=
, and !~
.
Constant Summary
-
INVALID_SYNTAX_ARG_TYPES =
# File 'lib/rubocop/cop/style/operator_method_call.rb', line 25%i[ splat kwsplat forwarded_args forwarded_restarg forwarded_kwrestarg block_pass ].freeze
-
MSG =
# File 'lib/rubocop/cop/style/operator_method_call.rb', line 23'Redundant dot detected.'
-
RESTRICT_ON_SEND =
# File 'lib/rubocop/cop/style/operator_method_call.rb', line 24%i[| ^ & <=> == === =~ > >= < <= << >> + - * / % ** ~ ! != !~].freeze
::RuboCop::Cop::Base
- Inherited
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 |
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 a 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
::RuboCop::Cop::Base
- Inherited
::RuboCop::Cop::AutocorrectLogic
- Included
Instance Method Summary
-
#on_send(node)
Metrics/CyclomaticComplexity.
- #insert_space_after?(node) ⇒ Boolean private
- #invalid_syntax_argument?(argument) ⇒ Boolean private
-
#method_call_with_parenthesized_arg?(argument) ⇒ Boolean
private
Checks for an acceptable case of
foo.+(bar).baz
. - #wrap_in_parentheses_if_chained(corrector, node) private
::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 |
#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
#disable_offense, #disable_offense_at_end_of_line, #disable_offense_before_and_after, #disable_offense_with_eol_or_surround_comment, #heredoc_range, #max_line_length, #multiline_ranges, #multiline_string?, | |
#range_by_lines | Expand the given range to include all of any lines it covers. |
#range_of_first_line, #range_overlaps_offense?, #string_continuation?, #surrounding_heredoc?, #surrounding_percent_array? |
::RuboCop::Cop::IgnoredNode
- Included
Constructor Details
This class inherits a constructor from RuboCop::Cop::Base
Instance Method Details
#insert_space_after?(node) ⇒ Boolean
(private)
# File 'lib/rubocop/cop/style/operator_method_call.rb', line 74
def insert_space_after?(node) rhs = node.first_argument selector = node.loc.selector return true if selector.end_pos == rhs.source_range.begin_pos return false if node.parent&.call_type? # if chained, a space is already added # For `/` operations, if the RHS starts with a `(` without space, # add one to avoid a syntax error. range = selector.end.join(rhs.source_range.begin) return true if node.method?(:/) && range.source == '(' false end
#invalid_syntax_argument?(argument) ⇒ Boolean
(private)
# File 'lib/rubocop/cop/style/operator_method_call.rb', line 57
def invalid_syntax_argument?(argument) type = argument.hash_type? ? argument.children.first&.type : argument.type INVALID_SYNTAX_ARG_TYPES.include?(type) end
#method_call_with_parenthesized_arg?(argument) ⇒ Boolean
(private)
Checks for an acceptable case of foo.+(bar).baz
.
# File 'lib/rubocop/cop/style/operator_method_call.rb', line 51
def method_call_with_parenthesized_arg?(argument) return false unless argument.parent.parent&.send_type? argument.children.first && argument.parent.parenthesized? end
#on_send(node)
Metrics/CyclomaticComplexity
# File 'lib/rubocop/cop/style/operator_method_call.rb', line 30
def on_send(node) return unless (dot = node.loc.dot) return if node.receiver.const_type? || !node.arguments.one? return unless (rhs = node.first_argument) return if method_call_with_parenthesized_arg?(rhs) return if invalid_syntax_argument?(rhs) add_offense(dot) do |corrector| wrap_in_parentheses_if_chained(corrector, node) corrector.replace(dot, ' ') selector = node.loc.selector corrector.insert_after(selector, ' ') if insert_space_after?(node) end end
#wrap_in_parentheses_if_chained(corrector, node) (private)
[ GitHub ]# File 'lib/rubocop/cop/style/operator_method_call.rb', line 63
def wrap_in_parentheses_if_chained(corrector, node) return unless node.parent&.call_type? return if node.parent.first_argument == node operator = node.loc.selector ParenthesesCorrector.correct(corrector, node) corrector.insert_after(operator, ' ') corrector.wrap(node, '(', ')') end