Class: RuboCop::Cop::Layout::ExtraSpacing

Inherits:
Cop
  • Object
show all
Includes:
PrecedingFollowingAlignment
Defined in:
lib/rubocop/cop/layout/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::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 included from PrecedingFollowingAlignment

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

Methods inherited from Cop

#add_offense, all, autocorrect_incompatible_with, 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_rails_version, #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_required?, effective_column, ends_its_line?, escape_string, first_part_of_call_chain, interpret_string_escapes, line_distance, line_range, move_pos, needs_escaping?, on_node, operator?, parentheses?, parenthesized_call?, preceed?, range_between, range_by_whole_lines, range_with_surrounding_comma, range_with_surrounding_space, same_line?, scrub_string, source_range, strip_quotes, stripped_source_upto, symbol_without_quote?, to_string_literal, to_supported_styles, to_symbol_literal, within_node?

Methods included from PathUtil

absolute?, match_path?, relative_path, smart_path

Constructor Details

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

Instance Method Details

#autocorrect(range) ⇒ Object 



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

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

#investigate(processed_source) ⇒ Object 



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

def investigate(processed_source)
  return if processed_source.ast.nil?

  if force_equal_sign_alignment?
    @asgn_tokens = assignment_tokens
    @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