123456789_123456789_123456789_123456789_123456789_

Class: RuboCop::Cop::InternalAffairs::NodeTypeGroup

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::RangeHelp, ::RuboCop::Cop::Base, ::RuboCop::Cop::AutocorrectLogic, ::RuboCop::Cop::IgnoredNode, ::RuboCop::Util, RuboCop::AST::Sexp
Inherits: RuboCop::Cop::Base
Defined in: lib/rubocop/cop/internal_affairs/node_type_group.rb

Overview

Checks that node types are checked against their group when all types of a group are checked.

Examples:

# bad
node.type?(:irange, :erange)

# good
node.range_type?

# bad
node.type?(:irange, :erange, :send, :csend)

# good
node.type?(:range, :call)

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

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.

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

#active_support_extensions_enabled?, #always_autocorrect?, #config, #config_to_allow_offenses, #config_to_allow_offenses=, #contextual_autocorrect?, #processed_source, #string_literals_frozen_by_default?, #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::RangeHelp - Included

#add_range,
#arguments_range

A range containing the first to the last argument of a method call or method definition.
#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_gem_version

Returns a gems locked versions (i.e.
#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

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

Constructor Details

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

Instance Method Details

#arguments_range(node) (private)

[ GitHub ] 

  


# File 'lib/rubocop/cop/internal_affairs/node_type_group.rb', line 49



def arguments_range(node)
  range_between(
    node.first_argument.source_range.begin_pos,
    node.last_argument.source_range.end_pos
  )
end


  








  

    #autocorrect(corrector, node, symbol_args, group_name, group_types)   (private)
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/internal_affairs/node_type_group.rb', line 60



def autocorrect(corrector, node, symbol_args, group_name, group_types)
  if node.method?(:type?) && node.arguments.count == group_types.count
    autocorrect_to_explicit_predicate(corrector, node, group_name)
  else
    autocorrect_keep_method(corrector, symbol_args, group_name, group_types)
  end
end


  








  

    #autocorrect_keep_method(corrector, symbol_args, group_name, group_types)   (private)
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/internal_affairs/node_type_group.rb', line 73



def autocorrect_keep_method(corrector, symbol_args, group_name, group_types)
  first_replaced = false
  symbol_args.each do |arg|
    next unless group_types.include?(arg.value)

    if first_replaced
      range = range_with_surrounding_space(arg.source_range)
      range = range_with_surrounding_comma(range, :left)
      corrector.remove(range)
    else
      first_replaced = true
      corrector.replace(arg, ":#{group_name}")
    end
  end
end


  








  

    #autocorrect_to_explicit_predicate(corrector, node, group_name)   (private)
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/internal_affairs/node_type_group.rb', line 68



def autocorrect_to_explicit_predicate(corrector, node, group_name)
  corrector.replace(node.selector, "#{group_name}_type?")
  corrector.remove(arguments_range(node))
end


  








  

    #group_satisfied?(group_types, symbol_args)  ⇒ Boolean  (private)
  



  

    
  





  


  [ GitHub ]


  

  


# File 'lib/rubocop/cop/internal_affairs/node_type_group.rb', line 56



def group_satisfied?(group_types, symbol_args)
  group_types.all? { |type| symbol_args.any? { |arg| arg.value == type } }
end


  








  

    #on_csend(node)  
  



  

    


Alias for #on_send.



  



  [ GitHub ]


  

  


# File 'lib/rubocop/cop/internal_affairs/node_type_group.rb', line 45



alias on_csend on_send


  








  

    #on_send(node)  
    Also known as: #on_csend
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/internal_affairs/node_type_group.rb', line 30



def on_send(node)
  return unless node.receiver

  symbol_args = node.arguments.select(&:sym_type?)
  return if symbol_args.none?

  NodePatternGroups::NODE_GROUPS.each do |group_name, group_types|
    next unless group_satisfied?(group_types, symbol_args)

    offense_range = arguments_range(node)
    add_offense(offense_range, message: format(MSG, group: group_name)) do |corrector|
      autocorrect(corrector, node, symbol_args, group_name, group_types)
    end
  end
end