123456789_123456789_123456789_123456789_123456789_

Class: RuboCop::Cop::Style::SelectByRegexp

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/style/select_by_regexp.rb

Overview

Looks for places where an subset of an Enumerable (array, range, set, etc.; see note below) is calculated based on a Regexp match, and suggests grep or grep_v instead.

Note
 Hashes do not behave as you may expect with grep, which means that hash.grep is not equivalent to hash.select. Although RuboCop is limited by static analysis, this cop attempts to avoid registering an offense when the receiver is a hash (hash literal, Hash.new, Hash#[], or to_h/to_hash).
Note
 grep and grep_v were optimized when used without a block in Ruby 3.0, but may be slower in previous versions. See https://bugs.ruby-lang.org/issues/17030

Examples:

# bad (select or find_all)
array.select { |x| x.match? /regexp/ }
array.select { |x| /regexp/.match?(x) }
array.select { |x| x =~ /regexp/ }
array.select { |x| /regexp/ =~ x }

# bad (reject)
array.reject { |x| x.match? /regexp/ }
array.reject { |x| /regexp/.match?(x) }
array.reject { |x| x =~ /regexp/ }
array.reject { |x| /regexp/ =~ x }

# good
array.grep(regexp)
array.grep_v(regexp)

Cop Safety Information:

  • Autocorrection is marked as unsafe because MatchData will not be created by grep, but may have previously been relied upon after the match? or =~ call.

    Additionally, the cop cannot guarantee that the receiver of select or reject is actually an array by static analysis, so the correction may not be actually equivalent.

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.
.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::RangeHelp - Included

#add_range, #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_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

#calls_lvar?(node, name)

[ GitHub ] 

  


# File 'lib/rubocop/cop/style/select_by_regexp.rb', line 79



def_node_matcher :calls_lvar?, <<~PATTERN
  {
    (send (lvar %1) ...)
    (send ... (lvar %1))
    (match-with-lvasgn regexp (lvar %1))
  }
PATTERN


  








  

    #creates_hash?(node)  
  



  

    


Returns true if a node appears to return a hash



  



  [ GitHub ]


  

  


# File 'lib/rubocop/cop/style/select_by_regexp.rb', line 65



def_node_matcher :creates_hash?, <<~PATTERN
  {
    (call (const _ :Hash) {:new :[]} ...)
    (block (call (const _ :Hash) :new ...) ...)
    (call _ { :to_h :to_hash } ...)
  }
PATTERN


  








  

    #env_const?(node)  
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/style/select_by_regexp.rb', line 74



def_node_matcher :env_const?, <<~PATTERN
  (const {nil? cbase} :ENV)
PATTERN


  








  

    #extract_send_node(block_node)   (private)
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/style/select_by_regexp.rb', line 133



def extract_send_node(block_node)
  return unless (block_arg_name, regexp_method_send_node = regexp_match?(block_node))

  block_arg_name = :"_#{block_arg_name}" if block_node.numblock_type?
  return unless calls_lvar?(regexp_method_send_node, block_arg_name)

  regexp_method_send_node
end


  








  

    #find_regexp(node, block)   (private)
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/style/select_by_regexp.rb', line 146



def find_regexp(node, block)
  return node.child_nodes.first if node.match_with_lvasgn_type?

  if node.receiver.lvar_type? &&
     (block.numblock_type? || node.receiver.source == block.first_argument.source)
    node.first_argument
  elsif node.first_argument.lvar_type?
    node.receiver
  end
end


  








  

    #match_predicate_without_receiver?(node)  ⇒ Boolean  (private)
  



  

    
  





  


  [ GitHub ]


  

  


# File 'lib/rubocop/cop/style/select_by_regexp.rb', line 157



def match_predicate_without_receiver?(node)
  node.send_type? && node.method?(:match?) && node.receiver.nil?
end


  








  

    #on_csend(node)  
  



  

    


Alias for #on_send.



  



  [ GitHub ]


  

  


# File 'lib/rubocop/cop/style/select_by_regexp.rb', line 103



alias on_csend on_send


  








  

    #on_send(node)  
    Also known as: #on_csend
  



  

    


Metrics/PerceivedComplexity



  



  [ GitHub ]


  

  


# File 'lib/rubocop/cop/style/select_by_regexp.rb', line 88



def on_send(node)
  return unless (block_node = node.block_node)
  return if block_node.body&.begin_type?
  return if receiver_allowed?(block_node.receiver)
  return unless (regexp_method_send_node = extract_send_node(block_node))
  return if match_predicate_without_receiver?(regexp_method_send_node)

  replacement = replacement(regexp_method_send_node, node)
  return if target_ruby_version <= 2.2 && replacement == 'grep_v'

  regexp = find_regexp(regexp_method_send_node, block_node)

  register_offense(node, block_node, regexp, replacement)
end


  








  

    #opposite?(regexp_method_send_node)  ⇒ Boolean  (private)
  



  

    
  





  


  [ GitHub ]


  

  


# File 'lib/rubocop/cop/style/select_by_regexp.rb', line 142



def opposite?(regexp_method_send_node)
  regexp_method_send_node.send_type? && regexp_method_send_node.method?(:!~)
end


  








  

    #receiver_allowed?(node)  ⇒ Boolean  (private)
  



  

    
  





  


  [ GitHub ]


  

  


# File 'lib/rubocop/cop/style/select_by_regexp.rb', line 107



def receiver_allowed?(node)
  return false unless node

  node.hash_type? || creates_hash?(node) || env_const?(node)
end


  








  

    #regexp_match?(node)  
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/style/select_by_regexp.rb', line 56



def_node_matcher :regexp_match?, <<~PATTERN
  {
    (block call (args (arg $_)) ${(send _ %REGEXP_METHODS _) match-with-lvasgn})
    (numblock call $1 ${(send _ %REGEXP_METHODS _) match-with-lvasgn})
  }
PATTERN


  








  

    #register_offense(node, block_node, regexp, replacement)   (private)
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/style/select_by_regexp.rb', line 121



def register_offense(node, block_node, regexp, replacement)
  message = format(MSG, replacement: replacement, original_method: node.method_name)

  add_offense(block_node, message: message) do |corrector|
    # Only correct if it can be determined what the regexp is
    if regexp
      range = range_between(node.loc.selector.begin_pos, block_node.loc.end.end_pos)
      corrector.replace(range, "#{replacement}(#{regexp.source})")
    end
  end
end


  








  

    #replacement(regexp_method_send_node, node)   (private)
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/style/select_by_regexp.rb', line 113



def replacement(regexp_method_send_node, node)
  opposite = opposite?(regexp_method_send_node)

  method_name = node.method_name

  opposite ? OPPOSITE_REPLACEMENTS[method_name] : REPLACEMENTS[method_name]
end