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

Inherits:
Cop
  • Object
show all
Includes:
PrecedingFollowingAlignment, RangeHelp
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  += "/rubocop-hq/rubocop" unless cond
puts        "rubocop"          if     debug

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

# good only if AllowBeforeTrailingComments is true
object.method(arg)  # this is a comment

# good even if AllowBeforeTrailingComments is false or not set
object.method(arg) # this is a comment

# good with either AllowBeforeTrailingComments or AllowForAlignment
object.method(arg)         # this is a comment
another_object.method(arg) # this is another comment
some_object.method(arg)    # this is some comment

Constant Summary collapse

MSG_UNNECESSARY = 
'Unnecessary spacing detected.'
MSG_UNALIGNED_ASGN = 
'`=` is not aligned with the %<location>s ' \
'assignment.'

Constants included from Util

Util::LITERAL_REGEX

Instance Attribute Summary

Attributes inherited from Cop

#config, #corrections, #offenses, #processed_source

Instance Method Summary collapse

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, #disable_uncorrectable, #duplicate_location?, #excluded_file?, #find_location, #highlights, inherited, #initialize, #join_force?, lint?, match?, #message, #messages, #parse, qualified_cop_name, #reason_to_not_correct, #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?, #correctable?, #disable_offense, #disable_uncorrectable?, #support_autocorrect?

Methods included from IgnoredNode

#ignore_node, #ignored_node?, #part_of_ignored_node?

Methods included from Util

begins_its_line?, comment_line?, double_quotes_required?, escape_string, first_part_of_call_chain, interpret_string_escapes, line_range, needs_escaping?, on_node, parentheses?, same_line?, to_string_literal, to_supported_styles, tokens, trim_string_interporation_escape_character

Methods included from PathUtil

absolute?, chdir, hidden_dir?, hidden_file_in_not_hidden_dir?, match_path?, pwd, relative_path, reset_pwd, smart_path

Constructor Details

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

Instance Method Details

#autocorrect(range) ⇒ Object 



51
52
53
54
55
56
57
58
59
 
# File 'lib/rubocop/cop/layout/extra_spacing.rb', line 51

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 



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

def investigate(processed_source)
  return if processed_source.blank?

  @corrected = Set.new if force_equal_sign_alignment?

  processed_source.tokens.each_cons(2) do |token1, token2|
    check_tokens(processed_source.ast, token1, token2)
  end
end