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

Inherits:
Cop
  • Object
show all
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 spacing detected.'

Constants included from Util

Util::ASGN_NODES, Util::BASIC_LITERALS, Util::EQUALS_ASGN_NODES, Util::LITERALS, Util::OPERATOR_METHODS, Util::PROC_NEW_NODE, 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?, #excluded_file?, #extra_details?, inherited, #initialize, #join_force?, lint?, match?, #message, non_rails, qualified_cop_name, rails?, #reference_url, #relevant_file?, #style_guide_url

Methods included from NodePattern::Macros

#def_node_matcher, #def_node_search

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, command?, comment_line?, const_name, directions, first_part_of_call_chain, lambda?, lambda_or_proc?, line_range, move_pos, numeric_range_size, on_node, operator?, parentheses?, proc?, range_with_surrounding_comma, range_with_surrounding_space, source_range, strip_quotes, within_node?

Methods included from PathUtil

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
# File 'lib/rubocop/cop/style/extra_spacing.rb', line 44

def autocorrect(range)
  ->(corrector) { corrector.remove(range) }
end

#investigate(processed_source) ⇒ Object


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

def investigate(processed_source)
  ast = processed_source.ast

  processed_source.tokens.each_cons(2) do |t1, t2|
    next if t2.type == :tNL
    next if t1.pos.line != t2.pos.line
    next if t2.pos.begin_pos - 1 <= t1.pos.end_pos
    next if allow_for_alignment? && aligned_with_something?(t2)
    start_pos = t1.pos.end_pos
    next if ignored_ranges(ast).find { |r| r.include?(start_pos) }

    end_pos = t2.pos.begin_pos - 1
    range = Parser::Source::Range.new(processed_source.buffer,
                                      start_pos, end_pos)
    # Unary + doesn't appear as a token and needs special handling.
    next if unary_plus_non_offense?(range)

    add_offense(range, range, MSG)
  end
end