123456789_123456789_123456789_123456789_123456789_

Class: RuboCop::Cop::InternalAffairs::NodeTypeMultiplePredicates

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/internal_affairs/node_type_multiple_predicates.rb

Overview

Use node.type?(:foo, :bar) instead of node.foo_type? || node.bar_type?, and !node.type?(:foo, :bar) instead of !node.foo_type? && !node.bar_type?.

Examples:

# bad
node.str_type? || node.sym_type?

# good
node.type?(:str, :sym)

# bad
node.type?(:str, :sym) || node.boolean_type?

# good
node.type?(:str, :sym, :boolean)

# bad
!node.str_type? && !node.sym_type?

# good
!node.type?(:str, :sym)

# bad
!node.type?(:str, :sym) && !node.boolean_type?

# good
!node.type?(:str, :sym, :boolean)

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.

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::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

#and_not_another_type?(node)

[ GitHub ] 

  


# File 'lib/rubocop/cop/internal_affairs/node_type_multiple_predicates.rb', line 63



def_node_matcher :and_not_another_type?, <<~PATTERN
  (and {
    (send $(call _receiver :type? sym+) :!) (send (call _receiver #type_predicate?) :!) |
    (send (call _receiver #type_predicate?) :!) (send $(call _receiver :type? sym+) :!)
  })
PATTERN


  








  

    #none_of_node_types?(node)  
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/internal_affairs/node_type_multiple_predicates.rb', line 55



def_node_matcher :none_of_node_types?, <<~PATTERN
  (and
    (send $(call _receiver #type_predicate?) :!)
    (send (call _receiver #type_predicate?) :!)
  )
PATTERN


  








  

    #on_and(node)  
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/internal_affairs/node_type_multiple_predicates.rb', line 80



def on_and(node)
  return unless (send_node = none_of_node_types?(node) || and_not_another_type?(node))
  return unless send_node.receiver

  replacement = "!#{replacement(node, send_node)}"

  add_offense(node, message: format(MSG_AND, replacement: replacement)) do |corrector|
    corrector.replace(node, replacement)
  end
end


  








  

    #on_or(node)  
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/internal_affairs/node_type_multiple_predicates.rb', line 70



def on_or(node)
  return unless (send_node = one_of_node_types?(node) || or_another_type?(node))
  return unless send_node.receiver

  replacement = replacement(node, send_node)
  add_offense(node, message: format(MSG_OR, replacement: replacement)) do |corrector|
    corrector.replace(node, replacement)
  end
end


  








  

    #one_of_node_types?(node)  
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/internal_affairs/node_type_multiple_predicates.rb', line 42



def_node_matcher :one_of_node_types?, <<~PATTERN
  (or $(call _receiver #type_predicate?) (call _receiver #type_predicate?))
PATTERN


  








  

    #or_another_type?(node)  
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/internal_affairs/node_type_multiple_predicates.rb', line 47



def_node_matcher :or_another_type?, <<~PATTERN
  (or {
    $(call _receiver :type? sym+) (call _receiver #type_predicate?) |
    (call _receiver #type_predicate?) $(call _receiver :type? sym+)
  })
PATTERN


  








  

    #replacement(node, send_node)   (private)
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/internal_affairs/node_type_multiple_predicates.rb', line 97



def replacement(node, send_node)
  send_node = send_node.children.first if send_node.method?(:!)

  types = types(node)
  receiver = send_node.receiver.source
  dot = send_node.loc.dot.source

  "#{receiver}#{dot}type?(:#{types.join(', :')})"
end


  








  

    #type_predicate?(method_name)  ⇒ Boolean  (private)
  



  

    
  





  


  [ GitHub ]


  

  


# File 'lib/rubocop/cop/internal_affairs/node_type_multiple_predicates.rb', line 93



def type_predicate?(method_name)
  method_name.end_with?('_type?')
end


  








  

    #types(node)   (private)
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/internal_affairs/node_type_multiple_predicates.rb', line 107



def types(node)
  [types_in_branch(node.lhs), types_in_branch(node.rhs)]
end


  








  

    #types_in_branch(branch)   (private)
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/internal_affairs/node_type_multiple_predicates.rb', line 111



def types_in_branch(branch)
  branch = branch.children.first if branch.method?(:!)

  if branch.method?(:type?)
    branch.arguments.map(&:value)
  elsif branch.method?(:defined_type?)
    # `node.defined_type?` relates to `node.type == :defined?`
    'defined?'
  else
    branch.method_name.to_s.delete_suffix('_type?')
  end
end