Class: RuboCop::Cop::Style::RequireOrder

Inherits:
Base
  • Object
show all
Extended by:
AutoCorrector
Includes:
RangeHelp
Defined in:
lib/rubocop/cop/style/require_order.rb

Overview

Sort `require` and `require_relative` in alphabetical order.

Examples:

# bad
require 'b'
require 'a'

# good
require 'a'
require 'b'

# bad
require_relative 'b'
require_relative 'a'

# good
require_relative 'a'
require_relative 'b'

# good (sorted within each section separated by a blank line)
require 'a'
require 'd'

require 'b'
require 'c'

# good
require 'b'
require_relative 'c'
require 'a'

# bad
require 'a'
require 'c' if foo
require 'b'

# good
require 'a'
require 'b'
require 'c' if foo

# bad
require 'c'
if foo
  require 'd'
  require 'b'
end
require 'a'

# good
require 'c'
if foo
  require 'b'
  require 'd'
end
require 'a'

Constant Summary collapse

RESTRICT_ON_SEND =
%i[require require_relative].freeze
MSG =
'Sort `%<name>s` in alphabetical order.'

Instance Attribute Summary

Attributes inherited from Base

#config, #processed_source

Instance Method Summary collapse

Methods included from AutoCorrector

support_autocorrect?

Methods inherited from Base

#active_support_extensions_enabled?, #add_global_offense, #add_offense, autocorrect_incompatible_with, badge, callbacks_needed, #callbacks_needed, #config_to_allow_offenses, #config_to_allow_offenses=, #cop_config, #cop_name, cop_name, department, documentation_url, exclude_from_registry, #excluded_file?, #external_dependency_checksum, inherited, #initialize, joining_forces, lint?, match?, #message, #offenses, #on_investigation_end, #on_new_investigation, #on_other_file, #parse, #ready, #relevant_file?, support_autocorrect?, support_multiple_source?, #target_rails_version, #target_ruby_version

Methods included from ExcludeLimit

#exclude_limit

Methods included from AutocorrectLogic

#autocorrect?, #autocorrect_enabled?, #autocorrect_requested?, #autocorrect_with_disable_uncorrectable?, #correctable?, #disable_uncorrectable?, #safe_autocorrect?

Methods included from IgnoredNode

#ignore_node, #ignored_node?, #part_of_ignored_node?

Methods included from Util

silence_warnings

Constructor Details

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

Instance Method Details

#if_inside_only_require(node) ⇒ Object


76
77
78
79
80
81
# File 'lib/rubocop/cop/style/require_order.rb', line 76

def_node_matcher :if_inside_only_require, <<~PATTERN
  {
    (if _ _ $(send nil? {:require :require_relative} _))
    (if _ $(send nil? {:require :require_relative} _) _)
  }
PATTERN

#on_send(node) ⇒ Object


83
84
85
86
87
88
89
90
91
92
93
94
95
96
# File 'lib/rubocop/cop/style/require_order.rb', line 83

def on_send(node)
  return unless node.parent && node.arguments?
  return if not_modifier_form?(node.parent)

  previous_older_sibling = find_previous_older_sibling(node)
  return unless previous_older_sibling

  add_offense(node, message: format(MSG, name: node.method_name)) do |corrector|
    corrector.swap(
      range_with_comments_and_lines(previous_older_sibling),
      range_with_comments_and_lines(node.parent.if_type? ? node.parent : node)
    )
  end
end