123456789_123456789_123456789_123456789_123456789_

Class: RuboCop::Cop::Lint::NonDeterministicRequireOrder

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:
Inherits: RuboCop::Cop::Base
Defined in: lib/rubocop/cop/lint/non_deterministic_require_order.rb

Overview

Dir[…​] and Dir.glob(…​) do not make any guarantees about the order in which files are returned. The final order is determined by the operating system and file system. This means that using them in cases where the order matters, such as requiring files, can lead to intermittent failures that are hard to debug. To ensure this doesn’t happen, always sort the list.

Dir.glob and Dir[] sort globbed results by default in Ruby 3.0. So all bad cases are acceptable when Ruby 3.0 or higher are used.

Note
This cop will be deprecated and removed when supporting only Ruby 3.0 and higher.

Examples:

# bad
Dir["./lib/**/*.rb"].each do |file|
  require file
end

# good
Dir["./lib/**/*.rb"].sort.each do |file|
  require file
end

# bad
Dir.glob(Rails.root.join(__dir__, 'test', '*.rb')) do |file|
  require file
end

# good
Dir.glob(Rails.root.join(__dir__, 'test', '*.rb')).sort.each do |file|
  require file
end

# bad
Dir['./lib/**/*.rb'].each(&method(:require))

# good
Dir['./lib/**/*.rb'].sort.each(&method(:require))

# bad
Dir.glob(Rails.root.join('test', '*.rb'), &method(:require))

# good
Dir.glob(Rails.root.join('test', '*.rb')).sort.each(&method(:require))

# good - Respect intent if `sort` keyword option is specified in Ruby 3.0 or higher.
Dir.glob(Rails.root.join(__dir__, 'test', '*.rb'), sort: false).each(&method(:require))

Cop Safety Information:

  • This cop is unsafe in the case where sorting files changes existing expected behavior.

Constant Summary

::RuboCop::Cop::Base - Inherited

EMPTY_OFFENSES, RESTRICT_ON_SEND

Class Attribute Summary

::RuboCop::Cop::AutoCorrector - Extended

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

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

::RuboCop::Cop::IgnoredNode - Included

Constructor Details

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

Instance Method Details

#correct_block(corrector, node) (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/lint/non_deterministic_require_order.rb', line 107

def correct_block(corrector, node)
  if unsorted_dir_block?(node)
    corrector.replace(node, "#{node.source}.sort.each")
  else
    source = node.receiver.source

    corrector.replace(node, "#{source}.sort.each")
  end
end

#correct_block_pass(corrector, node) (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/lint/non_deterministic_require_order.rb', line 117

def correct_block_pass(corrector, node)
  if unsorted_dir_glob_pass?(node)
    block_arg = node.last_argument

    corrector.remove(last_arg_range(node))
    corrector.insert_after(node, ".sort.each(#{block_arg.source})")
  else
    corrector.replace(node.loc.selector, 'sort.each')
  end
end

#last_arg_range(node) ⇒ Parser::Source::Range (private)

Returns range of last argument including comma and whitespace.

[ GitHub ]

  
# File 'lib/rubocop/cop/lint/non_deterministic_require_order.rb', line 132

def last_arg_range(node)
  node.last_argument.source_range.join(node.arguments[-2].source_range.end)
end

#loop_variable(node) (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/lint/non_deterministic_require_order.rb', line 172

def_node_matcher :loop_variable, <<~PATTERN
  (args (arg $_))
PATTERN

#method_require?(node) (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/lint/non_deterministic_require_order.rb', line 155

def_node_matcher :method_require?, <<~PATTERN
  (block-pass (send nil? :method (sym {:require :require_relative})))
PATTERN

#on_block(node)

[ GitHub ]

  
# File 'lib/rubocop/cop/lint/non_deterministic_require_order.rb', line 65

def on_block(node)
  return if target_ruby_version >= 3.0
  return unless node.body
  return unless unsorted_dir_loop?(node.send_node)

  loop_variable(node.arguments) do |var_name|
    return unless var_is_required?(node.body, var_name)

    add_offense(node.send_node) { |corrector| correct_block(corrector, node.send_node) }
  end
end

#on_block_pass(node)

[ GitHub ]

  
# File 'lib/rubocop/cop/lint/non_deterministic_require_order.rb', line 89

def on_block_pass(node)
  return if target_ruby_version >= 3.0
  return unless method_require?(node)
  return unless unsorted_dir_pass?(node.parent)

  parent_node = node.parent

  add_offense(parent_node) do |corrector|
    if parent_node.last_argument&.block_pass_type?
      correct_block_pass(corrector, parent_node)
    else
      correct_block(corrector, parent_node)
    end
  end
end

#on_numblock(node)

[ GitHub ]

  
# File 'lib/rubocop/cop/lint/non_deterministic_require_order.rb', line 77

def on_numblock(node)
  return if target_ruby_version >= 3.0
  return unless node.body
  return unless unsorted_dir_loop?(node.send_node)

  node.argument_list
      .filter { |argument| var_is_required?(node.body, argument.name) }
      .each do
        add_offense(node.send_node) { |corrector| correct_block(corrector, node.send_node) }
      end
end

#unsorted_dir_block?(node) (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/lint/non_deterministic_require_order.rb', line 145

def_node_matcher :unsorted_dir_block?, <<~PATTERN
  (send (const {nil? cbase} :Dir) :glob ...)
PATTERN

#unsorted_dir_each?(node) (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/lint/non_deterministic_require_order.rb', line 150

def_node_matcher :unsorted_dir_each?, <<~PATTERN
  (send (send (const {nil? cbase} :Dir) {:[] :glob} ...) :each)
PATTERN

#unsorted_dir_each_pass?(node) (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/lint/non_deterministic_require_order.rb', line 166

def_node_matcher :unsorted_dir_each_pass?, <<~PATTERN
  (send (send (const {nil? cbase} :Dir) {:[] :glob} ...) :each
    (block-pass (send nil? :method (sym {:require :require_relative}))))
PATTERN

#unsorted_dir_glob_pass?(node) (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/lint/non_deterministic_require_order.rb', line 160

def_node_matcher :unsorted_dir_glob_pass?, <<~PATTERN
  (send (const {nil? cbase} :Dir) :glob ...
    (block-pass (send nil? :method (sym {:require :require_relative}))))
PATTERN

#unsorted_dir_loop?(node) ⇒ Boolean (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/lint/non_deterministic_require_order.rb', line 136

def unsorted_dir_loop?(node)
  unsorted_dir_block?(node) || unsorted_dir_each?(node)
end

#unsorted_dir_pass?(node) ⇒ Boolean (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/lint/non_deterministic_require_order.rb', line 140

def unsorted_dir_pass?(node)
  unsorted_dir_glob_pass?(node) || unsorted_dir_each_pass?(node)
end

#var_is_required?(node, name) (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/lint/non_deterministic_require_order.rb', line 177

def_node_search :var_is_required?, <<~PATTERN
  (send nil? {:require :require_relative} (lvar %1))
PATTERN