Class: ParseState

Inherits:
Object
  • Object
show all
Includes:
RubyToken
Defined in:
lib/saikuro.rb

Overview

Main class and structure used to compute the cyclomatic complexity of Ruby programs.

Direct Known Subclasses

EndableParseState, ParseComment, ParseSymbol

Constant Summary collapse

@@top_state = 
nil
@@token_counter = 
TokenCounter.new

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(lexer, parent = nil) ⇒ ParseState

Returns a new instance of ParseState.



169
170
171
172
173
174
175
176
177
178
179
 
# File 'lib/saikuro.rb', line 169

def initialize(lexer,parent=nil)
  @name = ""
  @children = Array.new
  @complexity = 0
  @parent = parent
  @lexer = lexer
  @run = true
  # To catch one line def statements, We always have one line.
  @lines = 0
  @last_token_line_and_char = Array.new
end

Instance Attribute Details

#children ⇒ Object

Returns the value of attribute children.



152
153
154
 
# File 'lib/saikuro.rb', line 152

def children
  @children
end

#complexity ⇒ Object

Returns the value of attribute complexity.



152
153
154
 
# File 'lib/saikuro.rb', line 152

def complexity
  @complexity
end

#lines ⇒ Object

Returns the value of attribute lines.



152
153
154
 
# File 'lib/saikuro.rb', line 152

def lines
  @lines
end

#name ⇒ Object

Returns the value of attribute name.



152
153
154
 
# File 'lib/saikuro.rb', line 152

def name
  @name
end

#parent ⇒ Object

Returns the value of attribute parent.



152
153
154
 
# File 'lib/saikuro.rb', line 152

def parent
  @parent
end

Class Method Details

.get_token_counter ⇒ Object 



165
166
167
 
# File 'lib/saikuro.rb', line 165

def ParseState.get_token_counter
  @@token_counter
end

.make_top_state ⇒ Object 



155
156
157
158
159
 
# File 'lib/saikuro.rb', line 155

def ParseState.make_top_state()
  @@top_state = ParseState.new(nil)
  @@top_state.name = "__top__"
  @@top_state
end

.set_token_counter(counter) ⇒ Object 



162
163
164
 
# File 'lib/saikuro.rb', line 162

def ParseState.set_token_counter(counter)
  @@token_counter = counter
end

Instance Method Details

#calc_complexity ⇒ Object 



196
197
198
199
200
201
202
 
# File 'lib/saikuro.rb', line 196

def calc_complexity
  complexity = @complexity
  children.each do |child|
    complexity += child.calc_complexity
  end
  complexity
end

#calc_lines ⇒ Object 



204
205
206
207
208
209
210
 
# File 'lib/saikuro.rb', line 204

def calc_lines
  lines = @lines
  children.each do |child|
    lines += child.calc_lines
  end
  lines
end

#compute_state(formater) ⇒ Object 



212
213
214
215
216
217
218
219
220
 
# File 'lib/saikuro.rb', line 212

def compute_state(formater)
  if top_state?
    compute_state_for_global(formater)
  end

  @children.each do |s|
    s.compute_state(formater)
  end
end

#compute_state_for_global(formater) ⇒ Object 



222
223
224
225
226
227
228
229
230
231
232
233
234
 
# File 'lib/saikuro.rb', line 222

def compute_state_for_global(formater)
  global_def, @children = @children.partition do |s|
    !s.kind_of?(ParseClass)
  end
  return if global_def.empty?
  gx = global_def.inject(0) { |c,s| s.calc_complexity }
  gl = global_def.inject(0) { |c,s| s.calc_lines }
  formater.start_class_compute_state("Global", "", gx, gl)
  global_def.each do |s|
    s.compute_state(formater)
  end
  formater.end_class_compute_state("")
end

#count_tokens? ⇒ Boolean

Count the tokens parsed if true else ignore them.

Returns:

  • (Boolean) 


237
238
239
 
# File 'lib/saikuro.rb', line 237

def count_tokens?
  true
end

#do_begin_token(token) ⇒ Object 



282
283
284
 
# File 'lib/saikuro.rb', line 282

def do_begin_token(token)
  make_state(EndableParseState, self)
end

#do_block_token(token) ⇒ Object 



319
320
321
 
# File 'lib/saikuro.rb', line 319

def do_block_token(token)
  make_state(ParseBlock,self)
end

#do_case_token(token) ⇒ Object 



331
332
333
 
# File 'lib/saikuro.rb', line 331

def do_case_token(token)
  make_state(EndableParseState, self)
end

#do_class_token(token) ⇒ Object 



286
287
288
 
# File 'lib/saikuro.rb', line 286

def do_class_token(token)
  make_state(ParseClass,self)
end

#do_comment_token(token) ⇒ Object 



351
352
353
 
# File 'lib/saikuro.rb', line 351

def do_comment_token(token)
  make_state(ParseComment, self)
end

#do_conditional_do_control_token(token) ⇒ Object 



327
328
329
 
# File 'lib/saikuro.rb', line 327

def do_conditional_do_control_token(token)
  make_state(ParseDoCond,self)
end

#do_conditional_token(token) ⇒ Object 



323
324
325
 
# File 'lib/saikuro.rb', line 323

def do_conditional_token(token)
  make_state(ParseCond,self)
end

#do_constant_token(token) ⇒ Object 



298
299
300
 
# File 'lib/saikuro.rb', line 298

def do_constant_token(token)
  nil
end

#do_def_token(token) ⇒ Object 



294
295
296
 
# File 'lib/saikuro.rb', line 294

def do_def_token(token)
  make_state(ParseDef,self)
end

#do_else_token(token) ⇒ Object 



346
347
348
349
 
# File 'lib/saikuro.rb', line 346

def do_else_token(token)
  STDOUT.puts "Ignored/Unknown Token:#{token.class}" if $VERBOSE
  nil
end

#do_end_token(token) ⇒ Object 



314
315
316
317
 
# File 'lib/saikuro.rb', line 314

def do_end_token(token)
  end_debug
  nil
end

#do_identifier_token(token) ⇒ Object 



302
303
304
305
306
307
308
 
# File 'lib/saikuro.rb', line 302

def do_identifier_token(token)
  if (token.name == "__END__" && token.char_no.to_i == 0)
    # The Ruby code has stopped and the rest is data so cease parsing.
    @run = false
  end
  nil
end

#do_module_token(token) ⇒ Object 



290
291
292
 
# File 'lib/saikuro.rb', line 290

def do_module_token(token)
  make_state(ParseModule,self)
end

#do_one_line_conditional_token(token) ⇒ Object 



335
336
337
338
339
340
341
342
343
344
 
# File 'lib/saikuro.rb', line 335

def do_one_line_conditional_token(token)
  # This is an if with no end
  @complexity += 1
  #STDOUT.puts "got IF_MOD: #{self.to_yaml}" if $VERBOSE
  #if state.type != "class" && state.type != "def" && state.type != "cond"
  #STDOUT.puts "Changing IF_MOD Parent" if $VERBOSE
  #state = state.parent
  #@run = false
  nil
end

#do_right_brace_token(token) ⇒ Object 



310
311
312
 
# File 'lib/saikuro.rb', line 310

def do_right_brace_token(token)
  nil
end

#do_symbol_token(token) ⇒ Object 



355
356
357
 
# File 'lib/saikuro.rb', line 355

def do_symbol_token(token)
  make_state(ParseSymbol, self)
end

#end_debug ⇒ Object 



419
420
421
422
423
424
425
426
427
428
429
430
431
 
# File 'lib/saikuro.rb', line 419

def end_debug
  STDOUT.puts "got an end: #{@name} in #{self.class.name}" if $VERBOSE
  if @parent.nil?
    STDOUT.puts "DEBUG: Line #{@lexer.line_no}"
    STDOUT.puts "DEBUG: #{@name}; #{self.class}"
    # to_yaml can cause an infinite loop?
    #STDOUT.puts "TOP: #{@@top_state.to_yaml}"
    #STDOUT.puts "TOP: #{@@top_state.inspect}"

    # This may not be an error?
    #exit 1
  end
end

#lexer=(lexer) ⇒ Object 



185
186
187
188
 
# File 'lib/saikuro.rb', line 185

def lexer=(lexer)
  @run = true
  @lexer = lexer
end

#lexer_loop?(token) ⇒ Boolean

Ruby-Lexer can go into a loop if the file does not end with a newline.

Returns:

  • (Boolean) 


259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
 
# File 'lib/saikuro.rb', line 259

def lexer_loop?(token)
  return false if @last_token_line_and_char.empty?
  loop_flag = false
  last = @last_token_line_and_char.last
  line = last[0]
  char = last[1]
  ltok = last[2]

  if ( (line == @lexer.line_no.to_i) &&
         (char == @lexer.char_no.to_i) &&
         (ltok.class == token.class) )
    # We are potentially in a loop
    if @last_token_line_and_char.size >= 3
      loop_flag = true
    end
  else
    # Not in a loop so clear stack
    @last_token_line_and_char = Array.new
  end

  loop_flag
end

#make_state(type, parent = nil) ⇒ Object 



190
191
192
193
194
 
# File 'lib/saikuro.rb', line 190

def make_state(type,parent = nil)
  cstate = type.new(@lexer,self)
  parent.children<< cstate
  cstate
end

#parse ⇒ Object 



241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
 
# File 'lib/saikuro.rb', line 241

def parse
  while @run do
    tok = @lexer.token
    @run = false if tok.nil?
    if lexer_loop?(tok)
      STDERR.puts "Lexer loop at line : #{@lexer.line_no} char #{@lexer.char_no}."
      @run = false
    end
    @last_token_line_and_char<< [@lexer.line_no.to_i, @lexer.char_no.to_i, tok]
    if $VERBOSE
	puts "DEBUG: #{@lexer.line_no} #{tok.class}:#{tok.name if tok.respond_to?(:name)}"
    end
    @@token_counter.count_token(@lexer.line_no, tok) if count_tokens?
    parse_token(tok)
  end
end

#parse_token(token) ⇒ Object 



359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
 
# File 'lib/saikuro.rb', line 359

def parse_token(token)
  state = nil
  case token
  when TkCLASS
    state = do_class_token(token)
  when TkMODULE
    state = do_module_token(token)
  when TkDEF
    state = do_def_token(token)
  when TkCONSTANT
    # Nothing to do with a constant at top level?
    state = do_constant_token(token)
  when TkIDENTIFIER,TkFID
    # Nothing to do at top level?
    state = do_identifier_token(token)
  when TkRBRACE
    # Nothing to do at top level
    state = do_right_brace_token(token)
  when TkEND
    state = do_end_token(token)
    # At top level this might be an error...
  when TkDO,TkfLBRACE
    state = do_block_token(token)
  when TkIF,TkUNLESS
    state = do_conditional_token(token)
  when TkWHILE,TkUNTIL,TkFOR
    state = do_conditional_do_control_token(token)
  when TkELSIF #,TkELSE
    @complexity += 1
  when TkELSE
    # Else does not increase complexity
  when TkCASE
    state = do_case_token(token)
  when TkWHEN
    @complexity += 1
  when TkBEGIN
    state = do_begin_token(token)
  when TkRESCUE
    # Maybe this should add complexity and not begin
    @complexity += 1
  when TkIF_MOD, TkUNLESS_MOD, TkUNTIL_MOD, TkWHILE_MOD, TkQUESTION
    state = do_one_line_conditional_token(token)
  when TkNL
    #
    @lines += 1
  when TkRETURN
    # Early returns do not increase complexity as the condition that
    # calls the return is the one that increases it.
  when TkCOMMENT
    state = do_comment_token(token)
  when TkSYMBEG
    state = do_symbol_token(token)
  when TkError
    STDOUT.puts "Lexer received an error for line #{@lexer.line_no} char #{@lexer.char_no}"
  else
    state = do_else_token(token)
  end
  state.parse if state
end

#top_state? ⇒ Boolean

Returns:

  • (Boolean) 


181
182
183
 
# File 'lib/saikuro.rb', line 181

def top_state?
  self == @@top_state
end