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

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

Instance Attribute Summary (collapse)

Class Method Summary (collapse)

Instance Method Summary (collapse)

Constructor Details

- (ParseState) initialize(lexer, parent = nil)

Returns a new instance of ParseState



122
123
124
125
126
127
128
129
130
131
132
# File 'lib/saikuro.rb', line 122

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

- (Object) children

Returns the value of attribute children



105
106
107
# File 'lib/saikuro.rb', line 105

def children
  @children
end

- (Object) complexity

Returns the value of attribute complexity



105
106
107
# File 'lib/saikuro.rb', line 105

def complexity
  @complexity
end

- (Object) lines

Returns the value of attribute lines



105
106
107
# File 'lib/saikuro.rb', line 105

def lines
  @lines
end

- (Object) name

Returns the value of attribute name



105
106
107
# File 'lib/saikuro.rb', line 105

def name
  @name
end

- (Object) parent

Returns the value of attribute parent



105
106
107
# File 'lib/saikuro.rb', line 105

def parent
  @parent
end

Class Method Details

+ (Object) get_token_counter



118
119
120
# File 'lib/saikuro.rb', line 118

def ParseState.get_token_counter
  @@token_counter
end

+ (Object) make_top_state



108
109
110
111
112
# File 'lib/saikuro.rb', line 108

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

+ (Object) set_token_counter(counter)



115
116
117
# File 'lib/saikuro.rb', line 115

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

Instance Method Details

- (Object) calc_complexity



149
150
151
152
153
154
155
# File 'lib/saikuro.rb', line 149

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

- (Object) calc_lines



157
158
159
160
161
162
163
# File 'lib/saikuro.rb', line 157

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

- (Object) compute_state(formater)



165
166
167
168
169
170
171
172
173
# File 'lib/saikuro.rb', line 165

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

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

- (Object) compute_state_for_global(formater)



175
176
177
178
179
180
181
182
183
184
185
186
187
# File 'lib/saikuro.rb', line 175

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

- (Boolean) count_tokens?

Count the tokens parsed if true else ignore them.

Returns:

  • (Boolean)


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

def count_tokens?
  true
end

- (Object) do_begin_token(token)



235
236
237
# File 'lib/saikuro.rb', line 235

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

- (Object) do_block_token(token)



272
273
274
# File 'lib/saikuro.rb', line 272

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

- (Object) do_case_token(token)



284
285
286
# File 'lib/saikuro.rb', line 284

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

- (Object) do_class_token(token)



239
240
241
# File 'lib/saikuro.rb', line 239

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

- (Object) do_comment_token(token)



304
305
306
# File 'lib/saikuro.rb', line 304

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

- (Object) do_conditional_do_control_token(token)



280
281
282
# File 'lib/saikuro.rb', line 280

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

- (Object) do_conditional_token(token)



276
277
278
# File 'lib/saikuro.rb', line 276

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

- (Object) do_constant_token(token)



251
252
253
# File 'lib/saikuro.rb', line 251

def do_constant_token(token)
  nil
end

- (Object) do_def_token(token)



247
248
249
# File 'lib/saikuro.rb', line 247

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

- (Object) do_else_token(token)



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

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

- (Object) do_end_token(token)



267
268
269
270
# File 'lib/saikuro.rb', line 267

def do_end_token(token)
  end_debug
  nil
end

- (Object) do_identifier_token(token)



255
256
257
258
259
260
261
# File 'lib/saikuro.rb', line 255

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

- (Object) do_module_token(token)



243
244
245
# File 'lib/saikuro.rb', line 243

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

- (Object) do_one_line_conditional_token(token)



288
289
290
291
292
293
294
295
296
297
# File 'lib/saikuro.rb', line 288

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

- (Object) do_right_brace_token(token)



263
264
265
# File 'lib/saikuro.rb', line 263

def do_right_brace_token(token)
  nil
end

- (Object) do_symbol_token(token)



308
309
310
# File 'lib/saikuro.rb', line 308

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

- (Object) end_debug



372
373
374
375
376
377
378
379
380
381
382
383
384
# File 'lib/saikuro.rb', line 372

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

- (Object) lexer=(lexer)



138
139
140
141
# File 'lib/saikuro.rb', line 138

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

- (Boolean) lexer_loop?(token)

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

Returns:

  • (Boolean)


212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
# File 'lib/saikuro.rb', line 212

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

- (Object) make_state(type, parent = nil)



143
144
145
146
147
# File 'lib/saikuro.rb', line 143

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

- (Object) parse



194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
# File 'lib/saikuro.rb', line 194

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

- (Object) parse_token(token)



312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
# File 'lib/saikuro.rb', line 312

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

- (Boolean) top_state?

Returns:

  • (Boolean)


134
135
136
# File 'lib/saikuro.rb', line 134

def top_state?
  self == @@top_state
end