Class: RuboCop::Cop::Style::RequireOrder
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/require_order.rb |
Overview
Sort require
and require_relative
in alphabetical order.
Constant Summary
-
MSG =
# File 'lib/rubocop/cop/style/require_order.rb', line 73'Sort `%<name>s` in alphabetical order.'
-
RESTRICT_ON_SEND =
# File 'lib/rubocop/cop/style/require_order.rb', line 71%i[require require_relative].freeze
::RuboCop::Cop::Base
- Inherited
EMPTY_OFFENSES, RESTRICT_ON_SEND
::RuboCop::Cop::RangeHelp
- Included
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 |
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
::RuboCop::Cop::AutocorrectLogic
- Included
Instance Method Summary
- #if_inside_only_require(node)
- #on_send(node)
- #autocorrect(corrector, node, previous_older_sibling) private
- #find_previous_older_sibling(node) private
- #in_same_section?(node1, node2) ⇒ Boolean private
- #not_modifier_form?(node) ⇒ Boolean private
- #search_node(node) private
- #sibling_node(node) private
::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 |
#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
#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
Constructor Details
This class inherits a constructor from RuboCop::Cop::Base
Instance Method Details
#autocorrect(corrector, node, previous_older_sibling) (private)
[ GitHub ]# File 'lib/rubocop/cop/style/require_order.rb', line 115
def autocorrect(corrector, node, previous_older_sibling) range1 = range_with_comments_and_lines(previous_older_sibling) range2 = range_with_comments_and_lines(node.parent.if_type? ? node.parent : node) corrector.remove(range2) corrector.insert_before(range1, range2.source) end
#find_previous_older_sibling(node) (private)
[ GitHub ]# File 'lib/rubocop/cop/style/require_order.rb', line 101
def find_previous_older_sibling(node) # rubocop:disable Metrics search_node(node).left_siblings.reverse.find do |sibling| next unless sibling.is_a?(AST::Node) sibling = sibling_node(sibling) break unless sibling&.send_type? && sibling.method?(node.method_name) break unless sibling.arguments? && !sibling.receiver break unless in_same_section?(sibling, node) break unless node.first_argument.str_type? && sibling.first_argument.str_type? node.first_argument.value < sibling.first_argument.value end end
#if_inside_only_require(node)
[ GitHub ]# 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
#in_same_section?(node1, node2) ⇒ Boolean
(private)
# File 'lib/rubocop/cop/style/require_order.rb', line 133
def in_same_section?(node1, node2) !node1.source_range.join(node2.source_range.end).source.include?("\n\n") end
#not_modifier_form?(node) ⇒ Boolean
(private)
# File 'lib/rubocop/cop/style/require_order.rb', line 97
def not_modifier_form?(node) node.if_type? && !node.modifier_form? end
#on_send(node)
[ GitHub ]# 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| autocorrect(corrector, node, previous_older_sibling) end end
#search_node(node) (private)
[ GitHub ]# File 'lib/rubocop/cop/style/require_order.rb', line 123
def search_node(node) node.parent.if_type? ? node.parent : node end
#sibling_node(node) (private)
[ GitHub ]# File 'lib/rubocop/cop/style/require_order.rb', line 127
def sibling_node(node) return if not_modifier_form?(node) node.if_type? ? if_inside_only_require(node) : node end