Class: RuboCop::Cop::Bundler::OrderedGems

Inherits:
Cop
  • Object
show all
Defined in:
lib/rubocop/cop/bundler/ordered_gems.rb

Overview

Gems in consecutive lines should be alphabetically sorted

Examples:

# bad
gem 'rubocop'
gem 'rspec'

# good
gem 'rspec'
gem 'rubocop'

# good
gem 'rubocop'

gem 'rspec'

Constant Summary collapse

MSG =
'Gem `%s` should appear before `%s` in their gem group.'.freeze

Constants included from Util

Util::ASGN_NODES, Util::BYTE_ORDER_MARK, Util::EQUALS_ASGN_NODES, Util::LITERAL_REGEX, Util::OPERATOR_METHODS, Util::SHORTHAND_ASGN_NODES

Instance Attribute Summary

Attributes inherited from Cop

#config, #corrections, #offenses, #processed_source

Instance Method Summary collapse

Methods inherited from Cop

#add_offense, all, #config_to_allow_offenses, #config_to_allow_offenses=, #cop_config, cop_name, #cop_name, cop_type, #correct, #debug?, #details, #display_cop_names?, #display_style_guide?, #duplicate_location?, #excluded_file?, #extra_details?, #find_location, #highlights, inherited, #initialize, #join_force?, lint?, match?, #message, #messages, non_rails, #parse, qualified_cop_name, #reference_url, #relevant_file?, #style_guide_url, #target_ruby_version

Methods included from Sexp

#s

Methods included from NodePattern::Macros

#def_node_matcher, #def_node_search, #node_search, #node_search_all, #node_search_body, #node_search_first

Methods included from AutocorrectLogic

#autocorrect?, #autocorrect_enabled?, #autocorrect_requested?, #support_autocorrect?

Methods included from IgnoredNode

#ignore_node, #ignored_node?, #part_of_ignored_node?

Methods included from Util

begins_its_line?, block_length, comment_line?, compatible_external_encoding_for?, directions, double_quotes_acceptable?, double_quotes_required?, effective_column, ends_its_line?, escape_string, first_part_of_call_chain, hard_to_type?, interpret_string_escapes, line_distance, line_range, move_pos, needs_escaping?, numeric_range_size, on_node, operator?, parentheses?, parenthesized_call?, preceed?, range_between, range_with_surrounding_comma, range_with_surrounding_space, same_line?, source_range, strip_quotes, stripped_source_upto, to_string_literal, to_symbol_literal, within_node?

Methods included from PathUtil

absolute?, match_path?, relative_path

Constructor Details

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

Instance Method Details

#consecutive_lines(previous, current) ⇒ Object



32
33
34
# File 'lib/rubocop/cop/bundler/ordered_gems.rb', line 32

def consecutive_lines(previous, current)
  previous.source_range.last_line == current.source_range.first_line - 1
end

#investigate(processed_source) ⇒ Object



21
22
23
24
25
26
27
28
29
30
# File 'lib/rubocop/cop/bundler/ordered_gems.rb', line 21

def investigate(processed_source)
  return if processed_source.ast.nil?
  gem_declarations(processed_source.ast)
    .each_cons(2) do |previous, current|
    next unless consecutive_lines(previous, current)
    next unless current.children[2].children.first.to_s <
                previous.children[2].children.first.to_s
    register_offense(previous, current)
  end
end

#register_offense(previous, current) ⇒ Object



36
37
38
39
40
41
42
43
44
45
46
# File 'lib/rubocop/cop/bundler/ordered_gems.rb', line 36

def register_offense(previous, current)
  add_offense(
    current,
    current.source_range,
    format(
      MSG,
      current.children[2].children.first,
      previous.children[2].children.first
    )
  )
end