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 = 
'Gems should be sorted in an alphabetical order within their '\
'section of the Gemfile. '\
'Gem `%s` should appear before `%s`.'.freeze

Constants included from Util

Util::ASGN_NODES, Util::BYTE_ORDER_MARK, Util::CONDITIONAL_NODES, Util::EQUALS_ASGN_NODES, Util::LITERAL_REGEX, Util::LOGICAL_OPERATOR_NODES, Util::MODIFIER_NODES, 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, badge, #config_to_allow_offenses, #config_to_allow_offenses=, #cop_config, #cop_name, cop_name, #correct, department, #duplicate_location?, #excluded_file?, #find_location, #highlights, inherited, #initialize, #join_force?, lint?, match?, #message, #messages, non_rails, #parse, qualified_cop_name, #relevant_file?, #target_ruby_version

Methods included from AST::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_supported_styles, 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

#autocorrect(node) ⇒ Object 



56
57
58
59
60
61
62
63
64
65
 
# File 'lib/rubocop/cop/bundler/ordered_gems.rb', line 56

def autocorrect(node)
  previous = previous_declaration(node)

  current_range = declaration_with_comment(node)
  previous_range = declaration_with_comment(previous)

  lambda do |corrector|
    swap_range(corrector, current_range, previous_range)
  end
end

#case_insensitive_out_of_order?(string_a, string_b) ⇒ Boolean

Returns:

  • (Boolean) 


36
37
38
 
# File 'lib/rubocop/cop/bundler/ordered_gems.rb', line 36

def case_insensitive_out_of_order?(string_a, string_b)
  1 > string_a.casecmp(string_b)
end

#consecutive_lines(previous, current) ⇒ Object 



40
41
42
 
# File 'lib/rubocop/cop/bundler/ordered_gems.rb', line 40

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

#declaration_with_comment(node) ⇒ Object 



67
68
69
70
71
72
73
 
# File 'lib/rubocop/cop/bundler/ordered_gems.rb', line 67

def declaration_with_comment(node)
  buffer = processed_source.buffer
  begin_pos = node.loc.expression.begin_pos
  end_line = buffer.line_for_position(node.loc.expression.end_pos)
  end_pos = buffer.line_range(end_line).end_pos
  Parser::Source::Range.new(buffer, begin_pos, end_pos)
end

#investigate(processed_source) ⇒ Object 



23
24
25
26
27
28
29
30
31
32
33
34
 
# File 'lib/rubocop/cop/bundler/ordered_gems.rb', line 23

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 case_insensitive_out_of_order?(
      current.children[2].children.first.to_s,
      previous.children[2].children.first.to_s
    )
    register_offense(previous, current)
  end
end

#previous_declaration(node) ⇒ Object 



82
83
84
85
86
 
# File 'lib/rubocop/cop/bundler/ordered_gems.rb', line 82

def previous_declaration(node)
  declarations = gem_declarations(processed_source.ast)
  node_index = declarations.find_index(node)
  declarations.to_a[node_index - 1]
end

#register_offense(previous, current) ⇒ Object 



44
45
46
47
48
49
50
51
52
53
54
 
# File 'lib/rubocop/cop/bundler/ordered_gems.rb', line 44

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

#swap_range(corrector, range1, range2) ⇒ Object 



75
76
77
78
79
80
 
# File 'lib/rubocop/cop/bundler/ordered_gems.rb', line 75

def swap_range(corrector, range1, range2)
  src1 = range1.source
  src2 = range2.source
  corrector.replace(range1, src2)
  corrector.replace(range2, src1)
end