123456789_123456789_123456789_123456789_123456789_

Class: RuboCop::Cop::Style::MethodCallWithoutArgsParentheses

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::AllowedPattern, ::RuboCop::Cop::AllowedMethods, ::RuboCop::Cop::Base, ::RuboCop::Cop::AutocorrectLogic, ::RuboCop::Cop::IgnoredNode, ::RuboCop::Util, RuboCop::AST::Sexp
Inherits: RuboCop::Cop::Base
Defined in: lib/rubocop/cop/style/method_call_without_args_parentheses.rb

Overview

Checks for unwanted parentheses in parameterless method calls.

This cop can be customized allowed methods with AllowedMethods. By default, there are no methods to allowed.

Note
 This cop allows the use of it() without arguments in blocks, as in 0.times { it() }, following Lint/ItWithoutArgumentsInBlock cop.

Examples:

# bad
object.some_method()

# good
object.some_method

AllowedMethods: [] (default)

# bad
object.foo()

AllowedMethods: [foo]

# good
object.foo()

Constant Summary

::RuboCop::Cop::Base - Inherited

EMPTY_OFFENSES, RESTRICT_ON_SEND

Class Attribute Summary

::RuboCop::Cop::AutoCorrector - Extended

support_autocorrect?

::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.
.builtin?

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

Cops (other than builtin) are encouraged to implement this.
.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

#active_support_extensions_enabled?, #always_autocorrect?, #config, #config_to_allow_offenses, #config_to_allow_offenses=, #contextual_autocorrect?, #processed_source, #target_satisfies_all_gem_version_requirements?

::RuboCop::Cop::AutocorrectLogic - Included

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

Instance Method Summary

::RuboCop::Cop::AllowedPattern - Included

#allowed_line?, #allowed_patterns, #cop_config_deprecated_methods_values, #cop_config_patterns_values,
#ignored_line?

Alias for AllowedPattern#allowed_line?.
#matches_allowed_pattern?,
#matches_ignored_pattern?

Alias for AllowedPattern#matches_allowed_pattern?.

::RuboCop::Cop::AllowedMethods - Included

#allowed_method?, #allowed_methods, #cop_config_allowed_methods, #cop_config_deprecated_values,
#ignored_method?

Alias for AllowedMethods#allowed_method?.

::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, #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, #max_line_length,
#range_by_lines

Expand the given range to include all of any lines it covers.
#range_of_first_line, #surrounding_heredoc, #surrounding_percent_array

::RuboCop::Cop::IgnoredNode - Included

#ignore_node, #ignored_node?, #part_of_ignored_node?, #ignored_nodes

Constructor Details

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

Instance Method Details

#allowed_method_name?(name) ⇒ Boolean (private)

[ GitHub ] 

  


# File 'lib/rubocop/cop/style/method_call_without_args_parentheses.rb', line 66



def allowed_method_name?(name)
  allowed_method?(name) || matches_allowed_pattern?(name)
end


  








  

    #any_assignment?(node)  ⇒ Boolean  (private)
  



  

    
  





  


  [ GitHub ]


  

  


# File 'lib/rubocop/cop/style/method_call_without_args_parentheses.rb', line 94



def any_assignment?(node)
  node.each_ancestor(*AST::Node::ASSIGNMENTS).any? do |asgn_node|
    # `obj.method = value` parses as (send ... :method= ...), and will
    # not be returned as an `asgn_node` here, however,
    # `obj.method ||= value` parses as (or-asgn (send ...) ...)
    # which IS an `asgn_node`. Similarly, `obj.method += value` parses
    # as (op-asgn (send ...) ...), which is also an `asgn_node`.
    if asgn_node.shorthand_asgn?
      asgn_node, _value = *asgn_node
      next if asgn_node.send_type?
    end

    yield asgn_node
  end
end


  








  

    #default_argument?(node)  ⇒ Boolean  (private)
  



  

    
  





  


  [ GitHub ]


  

  


# File 'lib/rubocop/cop/style/method_call_without_args_parentheses.rb', line 62



def default_argument?(node)
  node.parent&.optarg_type?
end


  








  

    #ineligible_node?(node)  ⇒ Boolean  (private)
  



  

    
  





  


  [ GitHub ]


  

  


# File 'lib/rubocop/cop/style/method_call_without_args_parentheses.rb', line 58



def ineligible_node?(node)
  node.camel_case_method? || node.implicit_call? || node.prefix_not?
end


  








  

    #offense_range(node)   (private)
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/style/method_call_without_args_parentheses.rb', line 117



def offense_range(node)
  node.loc.begin.join(node.loc.end)
end


  








  

    #on_send(node)  
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/style/method_call_without_args_parentheses.rb', line 37



def on_send(node)
  return unless !node.arguments? && node.parenthesized?
  return if ineligible_node?(node)
  return if default_argument?(node)
  return if allowed_method_name?(node.method_name)
  return if same_name_assignment?(node)
  return if parenthesized_it_method_in_block?(node)

  register_offense(node)
end


  








  

    #parenthesized_it_method_in_block?(node)  ⇒ Boolean  (private)
  



  

    


Respects Lint/ItWithoutArgumentsInBlock cop and the following Ruby 3.3’s warning:






$ ruby -e '0.times { begin; it; end }'
-e:1: warning: it calls without arguments will refer to the first block param in
Ruby 3.4; use it() or self.it



  





  


  [ GitHub ]


  

  


# File 'lib/rubocop/cop/style/method_call_without_args_parentheses.rb', line 86



def parenthesized_it_method_in_block?(node)
  return false unless node.method?(:it)
  return false unless (block_node = node.each_ancestor(:block).first)
  return false unless block_node.arguments.empty_and_without_delimiters?

  !node.receiver && node.arguments.empty? && !node.block_literal?
end


  








  

    #register_offense(node)   (private)
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/style/method_call_without_args_parentheses.rb', line 51



def register_offense(node)
  add_offense(offense_range(node)) do |corrector|
    corrector.remove(node.loc.begin)
    corrector.remove(node.loc.end)
  end
end


  








  

    #same_name_assignment?(node)  ⇒ Boolean  (private)
  



  

    
  





  


  [ GitHub ]


  

  


# File 'lib/rubocop/cop/style/method_call_without_args_parentheses.rb', line 70



def same_name_assignment?(node)
  return false if node.receiver

  any_assignment?(node) do |asgn_node|
    next variable_in_mass_assignment?(node.method_name, asgn_node) if asgn_node.masgn_type?

    asgn_node.loc.name.source == node.method_name.to_s
  end
end


  








  

    #variable_in_mass_assignment?(variable_name, node)  ⇒ Boolean  (private)
  



  

    
  





  


  [ GitHub ]


  

  


# File 'lib/rubocop/cop/style/method_call_without_args_parentheses.rb', line 110



def variable_in_mass_assignment?(variable_name, node)
  mlhs_node, _mrhs_node = *node
  var_nodes = *mlhs_node

  var_nodes.any? { |n| n.to_a.first == variable_name }
end