Class: Tailor::Rulers::IndentationSpacesRuler

Inherits:
Tailor::Ruler show all
Defined in:
lib/tailor/rulers/indentation_spaces_ruler.rb,
lib/tailor/rulers/indentation_spaces_ruler/ast_xml.rb,
lib/tailor/rulers/indentation_spaces_ruler/argument_alignment.rb,
lib/tailor/rulers/indentation_spaces_ruler/line_continuations.rb,
lib/tailor/rulers/indentation_spaces_ruler/indentation_manager.rb

Defined Under Namespace

Modules: AstXml Classes: ArgumentAlignment, IndentationManager, LineContinuations

Instance Attribute Summary

Attributes inherited from Tailor::Ruler

#lexer_observers

Instance Method Summary collapse

Methods inherited from Tailor::Ruler

#add_child_ruler, #problem_type, #problems

Methods included from Logger::Mixin

included

Constructor Details

#initialize(config, options) ⇒ IndentationSpacesRuler

Returns a new instance of IndentationSpacesRuler.



12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
 
# File 'lib/tailor/rulers/indentation_spaces_ruler.rb', line 12

def initialize(config, options)
  super(config, options)
  add_lexer_observers(
    :comment,
    :embexpr_beg,
    :embexpr_end,
    :file_beg,
    :ignored_nl,
    :kw,
    :lbrace,
    :lbracket,
    :lparen,
    :nl,
    :rbrace,
    :rbracket,
    :rparen,
    :tstring_beg,
    :tstring_end
  )
  @manager = IndentationManager.new(@config)
  @embexpr_nesting = []
  @tstring_nesting = []
end

Instance Method Details

#argument_alignment? ⇒ Boolean

Returns:

  • (Boolean) 


253
254
255
 
# File 'lib/tailor/rulers/indentation_spaces_ruler.rb', line 253

def argument_alignment?
  @options[:argument_alignment] and @options[:argument_alignment] != :off
end

#comment_update(token, lexed_line, file_text, lineno, column) ⇒ Object 



36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
 
# File 'lib/tailor/rulers/indentation_spaces_ruler.rb', line 36

def comment_update(token, lexed_line, file_text, lineno, column)
  if token.fake_backslash_line_end?
    log 'Line was altered by tailor to accommodate trailing backslash'
    @manager.add_indent_reason(:trailing_backslash, :trailing_backslash,
      lineno)
  end

  # trailing comment?
  if token.ends_with_newline?
    log 'Comment ends with newline.  Removing comment...'
    log "Old lexed line: #{lexed_line.inspect}"

    new_lexed_line = lexed_line.remove_trailing_comment(file_text)

    log "New lexed line: #{new_lexed_line.inspect}"

    if new_lexed_line.ends_with_ignored_nl?
      log 'New lexed line ends with :on_ignored_nl.'
      ignored_nl_update(new_lexed_line, lineno, column)
    elsif new_lexed_line.ends_with_nl?
      log 'New lexed line ends with :on_nl.'
      nl_update(new_lexed_line, lineno, column)
    end
  end
end

#embexpr_beg_update(lexed_line, lineno, column) ⇒ Object 



62
63
64
65
66
67
 
# File 'lib/tailor/rulers/indentation_spaces_ruler.rb', line 62

def embexpr_beg_update(lexed_line, lineno, column)
  @embexpr_nesting << true

  token = Tailor::Lexer::Token.new('{')
  @manager.update_for_opening_reason(:on_embexpr_beg, token, lineno)
end

#embexpr_end_update(current_lexed_line, lineno, column) ⇒ Object

Due to a Ripper bug that was fixed in ruby 2.0.0-p0, this will not get triggered if you’re using 1.9.x. More info: bugs.ruby-lang.org/issues/6211



72
73
74
75
 
# File 'lib/tailor/rulers/indentation_spaces_ruler.rb', line 72

def embexpr_end_update(current_lexed_line, lineno, column)
  @embexpr_nesting.pop
  @manager.update_for_closing_reason(:on_embexpr_end, current_lexed_line)
end

#file_beg_update(file_name) ⇒ Object 



77
78
79
80
81
82
83
 
# File 'lib/tailor/rulers/indentation_spaces_ruler.rb', line 77

def file_beg_update(file_name)
  # For statements that continue over multiple lines we may want to treat
  # the second and subsequent lines differently and ident them further,
  # controlled by the :line_continuations option.
  @lines = LineContinuations.new(file_name) if line_continuations?
  @args = ArgumentAlignment.new(file_name) if argument_alignment?
end

#ignored_nl_update(current_lexed_line, lineno, column) ⇒ Object 



85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
 
# File 'lib/tailor/rulers/indentation_spaces_ruler.rb', line 85

def ignored_nl_update(current_lexed_line, lineno, column)
  log "indent reasons on entry: #{@manager.indent_reasons}"

  if current_lexed_line.only_spaces?
    log 'Line of only spaces.  Moving on.'
    # todo: maybe i shouldn't return here? ...do transitions?
    return
  end

  if @manager.line_ends_with_single_token_indenter?(current_lexed_line)
    log 'Line ends with single-token indent token.'

    unless @manager.in_an_enclosure? &&
      current_lexed_line.ends_with_comma?
      log 'Line-ending single-token indenter found.'
      token_event = current_lexed_line.last_non_line_feed_event

      unless @manager.line_ends_with_same_as_last token_event
        msg = 'Line ends with different type of single-token '
        msg << "indenter: #{token_event}"
        log msg
        @manager.add_indent_reason(token_event[1], token_event.last,
          lineno)
      end
    end
  end

  @manager.update_actual_indentation(current_lexed_line)
  measure(lineno, column)

  log "indent reasons on exit: #{@manager.indent_reasons}"
  # prep for next line
  @manager.transition_lines
end

#in_embexpr? ⇒ Boolean

Since Ripper in Ruby 1.9.x parses the } in a #{} as :on_rbrace instead of :on_embexpr_end, this works around that by using +@embexpr_beg to track the state of that event. As such, this should only be called from #rbrace_update.

Returns:

  • (Boolean) 


188
189
190
 
# File 'lib/tailor/rulers/indentation_spaces_ruler.rb', line 188

def in_embexpr?
  !@embexpr_nesting.empty?
end

#in_tstring? ⇒ Boolean

Returns:

  • (Boolean) 


235
236
237
 
# File 'lib/tailor/rulers/indentation_spaces_ruler.rb', line 235

def in_tstring?
  !@tstring_nesting.empty?
end

#kw_update(token, lexed_line, lineno, column) ⇒ Object 



120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
 
# File 'lib/tailor/rulers/indentation_spaces_ruler.rb', line 120

def kw_update(token, lexed_line, lineno, column)
  if lexed_line.keyword_is_symbol?
    log "Keyword is prefaced by a :, indicating it's really a Symbol."
    return
  end

  if token == 'end'
    @manager.update_for_closing_reason(:on_kw, lexed_line)
    return
  end

  if token.continuation_keyword?
    log "Continuation keyword found: '#{token}'."
    @manager.update_for_continuation_reason(token, lexed_line, lineno)
    return
  end

  if token.keyword_to_indent?
    log "Indent keyword found: '#{token}'."
    @manager.update_for_opening_reason(:on_kw, token, lineno)
  end
end

#lbrace_update(lexed_line, lineno, column) ⇒ Object 



143
144
145
146
 
# File 'lib/tailor/rulers/indentation_spaces_ruler.rb', line 143

def lbrace_update(lexed_line, lineno, column)
  token = Tailor::Lexer::Token.new('{')
  @manager.update_for_opening_reason(:on_lbrace, token, lineno)
end

#lbracket_update(lexed_line, lineno, column) ⇒ Object 



148
149
150
151
 
# File 'lib/tailor/rulers/indentation_spaces_ruler.rb', line 148

def lbracket_update(lexed_line, lineno, column)
  token = Tailor::Lexer::Token.new('[')
  @manager.update_for_opening_reason(:on_lbracket, token, lineno)
end

#line_continuations? ⇒ Boolean

Returns:

  • (Boolean) 


239
240
241
 
# File 'lib/tailor/rulers/indentation_spaces_ruler.rb', line 239

def line_continuations?
  @options[:line_continuations] and @options[:line_continuations] != :off
end

#lparen_update(lineno, column) ⇒ Object 



153
154
155
156
 
# File 'lib/tailor/rulers/indentation_spaces_ruler.rb', line 153

def lparen_update(lineno, column)
  token = Tailor::Lexer::Token.new('(')
  @manager.update_for_opening_reason(:on_lparen, token, lineno)
end

#measure(lineno, column) ⇒ Object

Checks if the line’s indentation level is appropriate.

Parameters:

  • lineno (Fixnum) —

    The line the potential problem is on.

  • column (Fixnum) —

    The column the potential problem is on.



266
267
268
269
270
271
272
273
274
275
276
277
278
279
 
# File 'lib/tailor/rulers/indentation_spaces_ruler.rb', line 266

def measure(lineno, column)
  log 'Measuring...'

  should_be_at = with_line_continuations(lineno, @manager.should_be_at)
  should_be_at = with_argument_alignment(lineno, should_be_at)

  if @manager.actual_indentation != should_be_at
    msg = "Line is indented to column #{@manager.actual_indentation}, "
    msg << "but should be at #{should_be_at}."

    @problems << Problem.new(problem_type, lineno,
      @manager.actual_indentation, msg, @options[:level])
  end
end

#nl_update(current_lexed_line, lineno, column) ⇒ Object 



158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
 
# File 'lib/tailor/rulers/indentation_spaces_ruler.rb', line 158

def nl_update(current_lexed_line, lineno, column)
  log "indent reasons on entry: #{@manager.indent_reasons}"
  @manager.update_actual_indentation(current_lexed_line)

  if @manager.last_indent_reason_type != :on_kw &&
    @manager.last_indent_reason_type != :on_lbrace &&
    @manager.last_indent_reason_type != :on_lbracket &&
    @manager.last_indent_reason_type != :on_lparen &&
    !@manager.last_indent_reason_type.nil?
    log "last indent reason type: #{@manager.last_indent_reason_type}"
    log 'I think this is a single-token closing line...'

    @manager.update_for_closing_reason(@manager.indent_reasons.
      last[:event_type], current_lexed_line)
  end

  unless current_lexed_line.end_of_multi_line_string?
    measure(lineno, column)
  end

  log "indent reasons on exit: #{@manager.indent_reasons}"
  @manager.transition_lines
end

#rbrace_update(current_lexed_line, lineno, column) ⇒ Object 



192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
 
# File 'lib/tailor/rulers/indentation_spaces_ruler.rb', line 192

def rbrace_update(current_lexed_line, lineno, column)
  # Is this an rbrace that should've been parsed as an embexpr_end?
  if in_embexpr? && RUBY_VERSION < '2.0.0'
    msg = 'Got :rbrace and @embexpr_beg is true. '
    msg << ' Must be at an @embexpr_end.'
    log msg
    @embexpr_nesting.pop
    @manager.update_for_closing_reason(:on_embexpr_end,
      current_lexed_line)

    return
  end

  @manager.update_for_closing_reason(:on_rbrace, current_lexed_line)
end

#rbracket_update(current_lexed_line, lineno, column) ⇒ Object 



208
209
210
 
# File 'lib/tailor/rulers/indentation_spaces_ruler.rb', line 208

def rbracket_update(current_lexed_line, lineno, column)
  @manager.update_for_closing_reason(:on_rbracket, current_lexed_line)
end

#rparen_update(current_lexed_line, lineno, column) ⇒ Object 



212
213
214
 
# File 'lib/tailor/rulers/indentation_spaces_ruler.rb', line 212

def rparen_update(current_lexed_line, lineno, column)
  @manager.update_for_closing_reason(:on_rparen, current_lexed_line)
end

#tstring_beg_update(lexed_line, lineno) ⇒ Object 



216
217
218
219
220
221
 
# File 'lib/tailor/rulers/indentation_spaces_ruler.rb', line 216

def tstring_beg_update(lexed_line, lineno)
  @tstring_nesting << lineno
  @manager.update_actual_indentation(lexed_line)
  log "tstring_nesting is now: #{@tstring_nesting}"
  @manager.stop
end

#tstring_end_update(current_line) ⇒ Object 



223
224
225
226
227
228
229
230
231
232
233
 
# File 'lib/tailor/rulers/indentation_spaces_ruler.rb', line 223

def tstring_end_update(current_line)
  unless @tstring_nesting.empty?
    tstring_start_line = @tstring_nesting.pop

    if tstring_start_line < current_line
      measure(tstring_start_line, @manager.actual_indentation)
    end
  end

  @manager.start unless in_tstring?
end

#with_argument_alignment(lineno, should_be_at) ⇒ Object 



257
258
259
260
 
# File 'lib/tailor/rulers/indentation_spaces_ruler.rb', line 257

def with_argument_alignment(lineno, should_be_at)
  return should_be_at unless argument_alignment?
  @args.expected_column(lineno, should_be_at)
end

#with_line_continuations(lineno, should_be_at) ⇒ Object 



243
244
245
246
247
248
249
250
251
 
# File 'lib/tailor/rulers/indentation_spaces_ruler.rb', line 243

def with_line_continuations(lineno, should_be_at)
  return should_be_at unless line_continuations?
  if @lines.line_is_continuation?(lineno) and
    @lines.line_has_nested_statements?(lineno)
    should_be_at + @config
  else
    should_be_at
  end
end