Class: Tailor::Rulers::IndentationSpacesRuler

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

Defined Under Namespace

Classes: IndentationManager

Instance Attribute Summary

Attributes inherited from Tailor::Ruler

#level, #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.



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

def initialize(config, options)
  super(config, options)
  add_lexer_observers(
    :comment,
    :embexpr_beg,
    :embexpr_end,
    :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

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



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

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 ⇒ Object 



58
59
60
 
# File 'lib/tailor/rulers/indentation_spaces_ruler.rb', line 58

def embexpr_beg_update
  @embexpr_nesting << true
end

#embexpr_end_update ⇒ Object

Due to a Ripper bug (depending on which Ruby version you have), this may or may not get triggered. More info: bugs.ruby-lang.org/issues/6211



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

def embexpr_end_update
  @embexpr_nesting.pop
end

#ignored_nl_update(current_lexed_line, lineno, column) ⇒ Object 



69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
 
# File 'lib/tailor/rulers/indentation_spaces_ruler.rb', line 69

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)
  @manager.set_up_line_transition
  measure(lineno, column)

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

#in_embexpr? ⇒ Boolean

Since Ripper 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) 


175
176
177
 
# File 'lib/tailor/rulers/indentation_spaces_ruler.rb', line 175

def in_embexpr?
  !@embexpr_nesting.empty?
end

#in_tstring? ⇒ Boolean

Returns:

  • (Boolean) 


251
252
253
 
# File 'lib/tailor/rulers/indentation_spaces_ruler.rb', line 251

def in_tstring?
  !@tstring_nesting.empty?
end

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



105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
 
# File 'lib/tailor/rulers/indentation_spaces_ruler.rb', line 105

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 



128
129
130
131
 
# File 'lib/tailor/rulers/indentation_spaces_ruler.rb', line 128

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 



133
134
135
136
 
# File 'lib/tailor/rulers/indentation_spaces_ruler.rb', line 133

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

#lparen_update(lineno, column) ⇒ Object 



138
139
140
141
 
# File 'lib/tailor/rulers/indentation_spaces_ruler.rb', line 138

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.



259
260
261
262
263
264
265
266
267
268
269
 
# File 'lib/tailor/rulers/indentation_spaces_ruler.rb', line 259

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

  if @manager.actual_indentation != @manager.should_be_at
    msg = "Line is indented to column #{@manager.actual_indentation}, "
    msg << "but should be at #{@manager.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 



143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
 
# File 'lib/tailor/rulers/indentation_spaces_ruler.rb', line 143

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

  @manager.set_up_line_transition

  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 



179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
 
# File 'lib/tailor/rulers/indentation_spaces_ruler.rb', line 179

def rbrace_update(current_lexed_line, lineno, column)
  if in_embexpr?
    msg = "Got :rbrace and @embexpr_beg is true. "
    msg << " Must be at an @embexpr_end."
    log msg
    @embexpr_nesting.pop
    return
  end

  if @manager.multi_line_braces?(lineno)
    log "End of multi-line braces!"

    if current_lexed_line.only_rbrace?
      @manager.amount_to_change_this -= 1
      msg = "lonely rbrace.  "
      msg << "change_this -= 1 -> #{@manager.amount_to_change_this}"
      log msg
    end
  end

  @manager.update_for_closing_reason(:on_rbrace, current_lexed_line)
end

#rbracket_update(current_lexed_line, lineno, column) ⇒ Object 



202
203
204
205
206
207
208
209
210
211
212
213
214
215
 
# File 'lib/tailor/rulers/indentation_spaces_ruler.rb', line 202

def rbracket_update(current_lexed_line, lineno, column)
  if @manager.multi_line_brackets?(lineno)
    log "End of multi-line brackets!"

    if current_lexed_line.only_rbracket?
      @manager.amount_to_change_this -= 1
      msg = "lonely rbracket.  "
      msg << "change_this -= 1 -> #{@manager.amount_to_change_this}"
      log msg
    end
  end

  @manager.update_for_closing_reason(:on_rbracket, current_lexed_line)
end

#rparen_update(current_lexed_line, lineno, column) ⇒ Object 



217
218
219
220
221
222
223
224
225
226
227
228
229
230
 
# File 'lib/tailor/rulers/indentation_spaces_ruler.rb', line 217

def rparen_update(current_lexed_line, lineno, column)
  if @manager.multi_line_parens?(lineno)
    log "End of multi-line parens!"

    if current_lexed_line.only_rparen?
      @manager.amount_to_change_this -= 1
      msg = "lonely rparen.  "
      msg << "change_this -= 1 -> #{@manager.amount_to_change_this}"
      log msg
    end
  end

  @manager.update_for_closing_reason(:on_rparen, current_lexed_line)
end

#tstring_beg_update(lexed_line, lineno) ⇒ Object 



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

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 



239
240
241
242
243
244
245
246
247
248
249
 
# File 'lib/tailor/rulers/indentation_spaces_ruler.rb', line 239

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