123456789_123456789_123456789_123456789_123456789_

Class: RuboCop::Cop::Style::SelectByRange

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_range.rb

Overview

Looks for places where a subset of an Enumerable (array, range, set, etc.; see note below) is calculated based on a range check, 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).

Examples:

# bad (select or find_all)
array.select { |x| x.between?(1, 10) }
array.select { |x| (1..10).cover?(x) }
array.select { |x| (1..10).include?(x) }

# bad (reject)
array.reject { |x| x.between?(1, 10) }

# bad (find or detect)
array.find { |x| x.between?(1, 10) }
array.detect { |x| (1..10).cover?(x) }

# bad (negative form)
array.reject { |x| !x.between?(1, 10) }
array.find { |x| !(1..10).cover?(x) }

# good
array.grep(1..10)
array.grep_v(1..10)
array.grep(1..10).first
array.grep_v(1..10).first

Cop Safety Information:

  • Autocorrection is marked as unsafe because the cop cannot guarantee that the receiver 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.

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, #eol_comment, #eol_comment_would_be_inside_literal?, #heredoc_range, #line_with_eol_comment_too_long?, #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, #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

#between_call?(node, name)

[ GitHub ] 

  


# File 'lib/rubocop/cop/style/select_by_range.rb', line 93



def_node_matcher :between_call?, <<~PATTERN
  (send (lvar %1) :between? _ _)
PATTERN


  








  

    #calls_lvar_in_range_check?(node, block_arg_name)  ⇒ Boolean  (private)
  



  

    
  





  


  [ GitHub ]


  

  


# File 'lib/rubocop/cop/style/select_by_range.rb', line 160



def calls_lvar_in_range_check?(node, block_arg_name)
  between_call?(node, block_arg_name) || range_cover_call?(node, block_arg_name)
end


  








  

    #creates_hash?(node)  
  



  

    


Returns true if a node appears to return a hash



  



  [ GitHub ]


  

  


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



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_range.rb', line 88



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_range.rb', line 149



def extract_send_node(block_node)
  return unless (block_arg_name, range_check_send_node = range_check?(block_node))

  block_arg_name = :"_#{block_arg_name}" if block_node.numblock_type?
  block_arg_name = :it if block_node.type?(:itblock)

  inner_node = unwrap_negation(range_check_send_node)

  range_check_send_node if calls_lvar_in_range_check?(inner_node, block_arg_name)
end


  








  

    #find_range(node)   (private)
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/style/select_by_range.rb', line 178



def find_range(node)
  inner = unwrap_negation(node)

  if inner.method?(:between?)
    # x.between?(min, max) -> min..max
    min = inner.first_argument.source
    max = inner.arguments[1].source
    "#{min}..#{max}"
  else
    # (min..max).cover?(x) or (min..max).include?(x)
    receiver = inner.receiver
    # Unwrap begin node from parentheses
    receiver = receiver.children.first if receiver.begin_type?
    receiver.source
  end
end


  








  

    #negated?(range_check_send_node)  ⇒ Boolean  (private)
  



  

    
  





  


  [ GitHub ]


  

  


# File 'lib/rubocop/cop/style/select_by_range.rb', line 164



def negated?(range_check_send_node)
  range_check_send_node.send_type? && range_check_send_node.method?(:!)
end


  








  

    #on_csend(node)  
  



  

    


Alias for #on_send.



  



  [ GitHub ]


  

  


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



alias on_csend on_send


  








  

    #on_send(node)  
    Also known as: #on_csend
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/style/select_by_range.rb', line 102



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 (range_check_send_node = extract_send_node(block_node))

  replacement = replacement(range_check_send_node, node)
  range_literal = find_range(range_check_send_node)

  register_offense(node, block_node, range_literal, replacement)
end


  








  

    #range_check?(node)  
  



  

    


Matches: x.between?(min, max) or (min..max).cover?(x) or (min..max).include?(x)



  



  [ GitHub ]


  

  


# File 'lib/rubocop/cop/style/select_by_range.rb', line 54



def_node_matcher :range_check?, <<~PATTERN
  {
    (block call (args (arg $_)) ${(send (lvar _) :between? _ _)})
    (block call (args (arg $_)) ${(send {range (begin range)} {:cover? :include?} (lvar _))})
    (block call (args (arg $_)) ${(send (send (lvar _) :between? _ _) :!)})
    (block call (args (arg $_)) ${(send (send {range (begin range)} {:cover? :include?} (lvar _)) :!)})
    (block call (args (arg $_)) ${(send (begin (send (lvar _) :between? _ _)) :!)})
    (block call (args (arg $_)) ${(send (begin (send {range (begin range)} {:cover? :include?} (lvar _))) :!)})
    (numblock call $1 ${(send (lvar _) :between? _ _)})
    (numblock call $1 ${(send {range (begin range)} {:cover? :include?} (lvar _))})
    (numblock call $1 ${(send (send (lvar _) :between? _ _) :!)})
    (numblock call $1 ${(send (send {range (begin range)} {:cover? :include?} (lvar _)) :!)})
    (numblock call $1 ${(send (begin (send (lvar _) :between? _ _)) :!)})
    (numblock call $1 ${(send (begin (send {range (begin range)} {:cover? :include?} (lvar _))) :!)})
    (itblock call $_ ${(send (lvar _) :between? _ _)})
    (itblock call $_ ${(send {range (begin range)} {:cover? :include?} (lvar _))})
    (itblock call $_ ${(send (send (lvar _) :between? _ _) :!)})
    (itblock call $_ ${(send (send {range (begin range)} {:cover? :include?} (lvar _)) :!)})
    (itblock call $_ ${(send (begin (send (lvar _) :between? _ _)) :!)})
    (itblock call $_ ${(send (begin (send {range (begin range)} {:cover? :include?} (lvar _))) :!)})
  }
PATTERN


  








  

    #range_cover_call?(node, name)  
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/style/select_by_range.rb', line 98



def_node_matcher :range_cover_call?, <<~PATTERN
  (send {range (begin range)} {:cover? :include?} (lvar %1))
PATTERN


  








  

    #receiver_allowed?(node)  ⇒ Boolean  (private)
  



  

    
  





  


  [ GitHub ]


  

  


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



def receiver_allowed?(node)
  return false unless node

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


  








  

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

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/style/select_by_range.rb', line 136



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

  add_offense(block_node, message: message) do |corrector|
    if range_literal
      range = range_between(node.loc.selector.begin_pos, block_node.loc.end.end_pos)
      grep_method = replacement.include?('grep_v') ? 'grep_v' : 'grep'
      suffix = replacement.include?('.first') ? '.first' : ''
      corrector.replace(range, "#{grep_method}(#{range_literal})#{suffix}")
    end
  end
end


  








  

    #replacement(range_check_send_node, node)   (private)
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/style/select_by_range.rb', line 123



def replacement(range_check_send_node, node)
  negated = negated?(range_check_send_node)
  method_name = node.method_name

  if SELECT_METHODS.include?(method_name)
    negated ? 'grep_v' : 'grep'
  elsif FIND_METHODS.include?(method_name)
    negated ? 'grep_v(...).first' : 'grep(...).first'
  else # reject
    negated ? 'grep' : 'grep_v'
  end
end


  








  

    #unwrap_negation(node)   (private)
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/style/select_by_range.rb', line 168



def unwrap_negation(node)
  if node.send_type? && node.method?(:!)
    receiver = node.receiver
    receiver = receiver.children.first if receiver.begin_type?
    receiver
  else
    node
  end
end