Class: RDoc::Stats

Inherits:
Object
  • Object
show all
Defined in:
lib/rdoc/stats.rb

Overview

RDoc statistics collector which prints a summary and report of a project’s documentation totals.

Defined Under Namespace

Classes: Normal, Quiet, Verbose

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(store, num_files, verbosity = 1) ⇒ Stats

Creates a new Stats that will have num_files. verbosity defaults to 1 which will create an RDoc::Stats::Normal outputter.



26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
 
# File 'lib/rdoc/stats.rb', line 26

def initialize store, num_files, verbosity = 1
  @num_files = num_files
  @store     = store

  @coverage_level   = 0
  @doc_items        = nil
  @files_so_far     = 0
  @fully_documented = false
  @num_params       = 0
  @percent_doc      = nil
  @start            = Time.now
  @undoc_params     = 0

  @display = case verbosity
             when 0 then Quiet.new   num_files
             when 1 then Normal.new  num_files
             else        Verbose.new num_files
             end
end

Instance Attribute Details

#coverage_level ⇒ Object

Output level for the coverage report



10
11
12
 
# File 'lib/rdoc/stats.rb', line 10

def coverage_level
  @coverage_level
end

#files_so_far ⇒ Object (readonly)

Count of files parsed during parsing



15
16
17
 
# File 'lib/rdoc/stats.rb', line 15

def files_so_far
  @files_so_far
end

#num_files ⇒ Object (readonly)

Total number of files found



20
21
22
 
# File 'lib/rdoc/stats.rb', line 20

def num_files
  @num_files
end

Instance Method Details

#add_alias(as) ⇒ Object

Records the parsing of an alias as.



49
50
51
 
# File 'lib/rdoc/stats.rb', line 49

def add_alias as
  @display.print_alias as
end

#add_attribute(attribute) ⇒ Object

Records the parsing of an attribute attribute



56
57
58
 
# File 'lib/rdoc/stats.rb', line 56

def add_attribute attribute
  @display.print_attribute attribute
end

#add_class(klass) ⇒ Object

Records the parsing of a class klass



63
64
65
 
# File 'lib/rdoc/stats.rb', line 63

def add_class klass
  @display.print_class klass
end

#add_constant(constant) ⇒ Object

Records the parsing of constant



70
71
72
 
# File 'lib/rdoc/stats.rb', line 70

def add_constant constant
  @display.print_constant constant
end

#add_file(file) ⇒ Object

Records the parsing of file



77
78
79
80
 
# File 'lib/rdoc/stats.rb', line 77

def add_file(file)
  @files_so_far += 1
  @display.print_file @files_so_far, file
end

#add_method(method) ⇒ Object

Records the parsing of method



85
86
87
 
# File 'lib/rdoc/stats.rb', line 85

def add_method(method)
  @display.print_method method
end

#add_module(mod) ⇒ Object

Records the parsing of a module mod



92
93
94
 
# File 'lib/rdoc/stats.rb', line 92

def add_module(mod)
  @display.print_module mod
end

#begin_adding ⇒ Object

Call this to mark the beginning of parsing for display purposes



99
100
101
 
# File 'lib/rdoc/stats.rb', line 99

def begin_adding
  @display.begin_adding
end

#calculate ⇒ Object

Calculates documentation totals and percentages for classes, modules, constants, attributes and methods.



107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
 
# File 'lib/rdoc/stats.rb', line 107

def calculate
  return if @doc_items

  ucm = @store.unique_classes_and_modules

  classes = @store.unique_classes.reject { |cm| cm.full_name == 'Object' }

  constants = []
  ucm.each { |cm| constants.concat cm.constants }

  methods = []
  ucm.each { |cm| methods.concat cm.method_list }

  attributes = []
  ucm.each { |cm| attributes.concat cm.attributes }

  @num_attributes, @undoc_attributes = doc_stats attributes
  @num_classes,    @undoc_classes    = doc_stats classes
  @num_constants,  @undoc_constants  = doc_stats constants
  @num_methods,    @undoc_methods    = doc_stats methods
  @num_modules,    @undoc_modules    = doc_stats @store.unique_modules

  @num_items =
    @num_attributes +
    @num_classes +
    @num_constants +
    @num_methods +
    @num_modules +
    @num_params

  @undoc_items =
    @undoc_attributes +
    @undoc_classes +
    @undoc_constants +
    @undoc_methods +
    @undoc_modules +
    @undoc_params

  @doc_items = @num_items - @undoc_items
end

#doc_stats(collection) ⇒ Object

Returns the length and number of undocumented items in collection.



164
165
166
167
 
# File 'lib/rdoc/stats.rb', line 164

def doc_stats collection
  visible = collection.select { |item| item.display? }
  [visible.length, visible.count { |item| not item.documented? }]
end

#done_adding ⇒ Object

Call this to mark the end of parsing for display purposes



172
173
174
 
# File 'lib/rdoc/stats.rb', line 172

def done_adding
  @display.done_adding
end

#fully_documented? ⇒ Boolean

The documentation status of this project. true when 100%, false when less than 100% and nil when unknown.

Set by calling #calculate

Returns:

  • (Boolean) 


182
183
184
 
# File 'lib/rdoc/stats.rb', line 182

def fully_documented?
  @fully_documented
end

#great_job ⇒ Object

A report that says you did a great job!



189
190
191
192
193
194
195
196
 
# File 'lib/rdoc/stats.rb', line 189

def great_job
  report = []
  report << '100% documentation!'
  report << nil
  report << 'Great Job!'

  report.join "\n"
end

#percent_doc ⇒ Object

Calculates the percentage of items documented.



201
202
203
204
205
206
207
208
209
210
 
# File 'lib/rdoc/stats.rb', line 201

def percent_doc
  return @percent_doc if @percent_doc

  @fully_documented = (@num_items - @doc_items) == 0

  @percent_doc = @doc_items.to_f / @num_items * 100 if @num_items.nonzero?
  @percent_doc ||= 0

  @percent_doc
end

#report ⇒ Object

Returns a report on which items are not documented



215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
 
# File 'lib/rdoc/stats.rb', line 215

def report
  if @coverage_level > 0 then
    extend RDoc::Text
  end

  report = []

  if @coverage_level.zero? then
    calculate

    return great_job if @num_items == @doc_items
  end

  ucm = @store.unique_classes_and_modules

  ucm.sort.each do |cm|
    report << report_class_module(cm) {
      [
        report_constants(cm),
        report_attributes(cm),
        report_methods(cm),
      ].compact
    }
  end

  if @coverage_level > 0 then
    calculate

    return great_job if @num_items == @doc_items
  end

  report.unshift nil
  report.unshift 'The following items are not documented:'

  report.join "\n"
end

#report_attributes(cm) ⇒ Object

Returns a report on undocumented attributes in ClassModule cm



255
256
257
258
259
260
261
262
263
264
265
266
267
 
# File 'lib/rdoc/stats.rb', line 255

def report_attributes cm
  return if cm.attributes.empty?

  report = []

  cm.each_attribute do |attr|
    next if attr.documented?
    line = attr.line ? ":#{attr.line}" : nil
    report << "  #{attr.definition} :#{attr.name} # in file #{attr.file.full_name}#{line}"
  end

  report
end

#report_class_module(cm) ⇒ Object

Returns a report on undocumented items in ClassModule cm



272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
 
# File 'lib/rdoc/stats.rb', line 272

def report_class_module cm
  return if cm.fully_documented? and @coverage_level.zero?
  return unless cm.display?

  report = []

  if cm.in_files.empty? then
    report << "# #{cm.definition} is referenced but empty."
    report << "#"
    report << "# It probably came from another project.  I'm sorry I'm holding it against you."
    report << nil

    return report
  elsif cm.documented? then
    documented = true
    report << "#{cm.definition} # is documented"
  else
    report << '# in files:'

    cm.in_files.each do |file|
      report << "#   #{file.full_name}"
    end

    report << nil

    report << "#{cm.definition}"
  end

  body = yield.flatten # HACK remove #flatten

  return if body.empty? and documented

  report << nil << body unless body.empty?

  report << 'end'
  report << nil

  report
end

#report_constants(cm) ⇒ Object

Returns a report on undocumented constants in ClassModule cm



315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
 
# File 'lib/rdoc/stats.rb', line 315

def report_constants cm
  return if cm.constants.empty?

  report = []

  cm.each_constant do |constant|
    # TODO constant aliases are listed in the summary but not reported
    # figure out what to do here
    next if constant.documented? || constant.is_alias_for

    line = constant.line ? ":#{constant.line}" : line
    report << "  # in file #{constant.file.full_name}#{line}"
    report << "  #{constant.name} = nil"
  end

  report
end

#report_methods(cm) ⇒ Object

Returns a report on undocumented methods in ClassModule cm



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
 
# File 'lib/rdoc/stats.rb', line 336

def report_methods cm
  return if cm.method_list.empty?

  report = []

  cm.each_method do |method|
    next if method.documented? and @coverage_level.zero?

    if @coverage_level > 0 then
      params, undoc = undoc_params method

      @num_params += params

      unless undoc.empty? then
        @undoc_params += undoc.length

        undoc = undoc.map do |param| "+#{param}+" end
        param_report = "  # #{undoc.join ', '} is not documented"
      end
    end

    next if method.documented? and not param_report

    line = method.line ? ":#{method.line}" : nil
    scope = method.singleton ? 'self.' : nil

    report << "  # in file #{method.file.full_name}#{line}"
    report << param_report if param_report
    report << "  def #{scope}#{method.name}#{method.params}; end"
    report << nil
  end

  report
end

#summary ⇒ Object

Returns a summary of the collected statistics.



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/rdoc/stats.rb', line 374

def summary
  calculate

  num_width = [@num_files, @num_items].max.to_s.length
  undoc_width = [
    @undoc_attributes,
    @undoc_classes,
    @undoc_constants,
    @undoc_items,
    @undoc_methods,
    @undoc_modules,
    @undoc_params,
  ].max.to_s.length

  report = []
  report << 'Files:      %*d' % [num_width, @num_files]

  report << nil

  report << 'Classes:    %*d (%*d undocumented)' % [
    num_width, @num_classes, undoc_width, @undoc_classes]
  report << 'Modules:    %*d (%*d undocumented)' % [
    num_width, @num_modules, undoc_width, @undoc_modules]
  report << 'Constants:  %*d (%*d undocumented)' % [
    num_width, @num_constants, undoc_width, @undoc_constants]
  report << 'Attributes: %*d (%*d undocumented)' % [
    num_width, @num_attributes, undoc_width, @undoc_attributes]
  report << 'Methods:    %*d (%*d undocumented)' % [
    num_width, @num_methods, undoc_width, @undoc_methods]
  report << 'Parameters: %*d (%*d undocumented)' % [
    num_width, @num_params, undoc_width, @undoc_params] if
      @coverage_level > 0

  report << nil

  report << 'Total:      %*d (%*d undocumented)' % [
    num_width, @num_items, undoc_width, @undoc_items]

  report << '%6.2f%% documented' % percent_doc
  report << nil
  report << 'Elapsed: %0.1fs' % (Time.now - @start)

  report.join "\n"
end

#undoc_params(method) ⇒ Object

Determines which parameters in method were not documented. Returns a total parameter count and an Array of undocumented methods.



423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
 
# File 'lib/rdoc/stats.rb', line 423

def undoc_params method
  @formatter ||= RDoc::Markup::ToTtOnly.new

  params = method.param_list

  return 0, [] if params.empty?

  document = parse method.comment

  tts = document.accept @formatter

  undoc = params - tts

  [params.length, undoc]
end