Class: RuboCop::Cop::Style::ExtraSpacing

Inherits:
Cop
  • Object
show all
Includes:
PrecedingFollowingAlignment
Defined in:
lib/rubocop/cop/style/extra_spacing.rb

Overview

This cop checks for extra/unnecessary whitespace.

Examples:


# good if AllowForAlignment is true
name      = "RuboCop"
# Some comment and an empty line

website  += "/bbatsov/rubocop" unless cond
puts        "rubocop"          if     debug

# bad for any configuration
set_app("RuboCop")
website  = "https://github.com/bbatsov/rubocop"

Constant Summary collapse

MSG_UNNECESSARY = 
'Unnecessary spacing detected.'.freeze
MSG_UNALIGNED_ASGN = 
'`=` is not aligned with the %s assignment.'.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, Util::STRING_ESCAPES, Util::STRING_ESCAPE_REGEX

Instance Attribute Summary

Attributes inherited from Cop

#config, #corrections, #offenses, #processed_source

Instance Method Summary collapse

Methods included from PrecedingFollowingAlignment

#aligned_assignment?, #aligned_char?, #aligned_identical?, #aligned_operator?, #aligned_token?, #aligned_with_adjacent_line?, #aligned_with_line?, #aligned_with_operator?, #aligned_with_something?, #aligned_words?, #allow_for_alignment?, #comment_lines

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?, #excluded_file?, #extra_details?, inherited, #initialize, #join_force?, lint?, match?, #message, 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_body

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?, directions, double_quotes_acceptable?, double_quotes_required?, effective_column, ends_its_line?, first_part_of_call_chain, interpret_string_escapes, line_range, move_pos, numeric_range_size, on_node, operator?, parentheses?, parenthesized_call?, range_with_surrounding_comma, range_with_surrounding_space, source_range, strip_quotes, ternary_op?, to_string_literal, to_symbol_literal, within_node?

Methods included from PathUtil

absolute?, hidden?, issue_deprecation_warning, match_path?, relative_path

Constructor Details

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

Instance Method Details

#autocorrect(range) ⇒ Object 



44
45
46
47
48
49
50
51
52
 
# File 'lib/rubocop/cop/style/extra_spacing.rb', line 44

def autocorrect(range)
  lambda do |corrector|
    if range.source.end_with?('=')
      align_equal_sign(range, corrector)
    else
      corrector.remove(range)
    end
  end
end

#investigate(processed_source) ⇒ Object 



29
30
31
32
33
34
35
36
37
38
39
40
41
42
 
# File 'lib/rubocop/cop/style/extra_spacing.rb', line 29

def investigate(processed_source)
  if force_equal_sign_alignment?
    @asgn_tokens = processed_source.tokens.select { |t| equal_sign?(t) }
    # Only attempt to align the first = on each line
    @asgn_tokens = Set.new(@asgn_tokens.uniq { |t| t.pos.line })
    @asgn_lines  = @asgn_tokens.map { |t| t.pos.line }
    # Don't attempt to correct the same = more than once
    @corrected   = Set.new
  end

  processed_source.tokens.each_cons(2) do |t1, t2|
    check_tokens(processed_source.ast, t1, t2)
  end
end