Class: RuboCop::Cop::Style::InitialIndentation

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

Overview

This cops checks for indentation of the first non-blank non-comment line in a file.

Constant Summary collapse

MSG = 
'Indentation of first line in file detected.'.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

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?, #highlights, inherited, #initialize, #join_force?, lint?, match?, #message, #messages, 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?, escape_string, first_part_of_call_chain, interpret_string_escapes, line_range, move_pos, needs_escaping?, numeric_range_size, on_node, operator?, parentheses?, parenthesized_call?, range_with_surrounding_comma, range_with_surrounding_space, source_range, strip_quotes, to_string_literal, 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(range) ⇒ Object 



32
33
34
 
# File 'lib/rubocop/cop/style/initial_indentation.rb', line 32

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

#investigate(processed_source) ⇒ Object 



12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
 
# File 'lib/rubocop/cop/style/initial_indentation.rb', line 12

def investigate(processed_source)
  first_token = processed_source.tokens.find do |t|
    !t.text.start_with?('#')
  end
  return unless first_token
  return if first_token.pos.column == 0

  with_space = range_with_surrounding_space(first_token.pos, :left,
                                            !:with_newline)
  # If the file starts with a byte order mark (BOM), the column can be
  # non-zero, but then we find out here if there's no space to the left
  # of the first token.
  return if with_space == first_token.pos

  space = Parser::Source::Range.new(processed_source.buffer,
                                    with_space.begin_pos,
                                    first_token.pos.begin_pos)
  add_offense(space, first_token.pos)
end