Gecko [ goons4good.org ]

Name	Size	Permission	Date
context	[ DIR ]	drwxr-xr-x	2023-08-27 00:26
generator	[ DIR ]	drwxr-xr-x	2023-08-27 00:26
markdown	[ DIR ]	drwxr-xr-x	2023-08-27 00:26
markup	[ DIR ]	drwxr-xr-x	2023-08-27 00:26
parser	[ DIR ]	drwxr-xr-x	2023-08-27 00:26
rd	[ DIR ]	drwxr-xr-x	2023-08-27 00:26
ri	[ DIR ]	drwxr-xr-x	2023-08-27 00:26
stats	[ DIR ]	drwxr-xr-x	2023-08-27 00:26
alias.rb	2.09 KB	-rw-r--r--	2012-11-26 23:28
anon_class.rb	142 B	-rw-r--r--	2012-11-26 23:28
any_method.rb	5.9 KB	-rw-r--r--	2013-01-22 20:02
attr.rb	3.73 KB	-rw-r--r--	2013-01-22 20:02
class_module.rb	19.15 KB	-rw-r--r--	2013-01-22 20:02
code_object.rb	7.71 KB	-rw-r--r--	2013-01-22 20:02
code_objects.rb	121 B	-rw-r--r--	2012-11-26 23:28
comment.rb	5.39 KB	-rw-r--r--	2012-11-27 03:54
constant.rb	3.34 KB	-rw-r--r--	2012-11-27 03:54
context.rb	28.26 KB	-rw-r--r--	2012-12-06 01:20
cross_reference.rb	5.81 KB	-rw-r--r--	2013-01-04 01:16
encoding.rb	2.74 KB	-rw-r--r--	2012-12-18 03:24
erb_partial.rb	370 B	-rw-r--r--	2012-11-26 23:28
erbio.rb	794 B	-rw-r--r--	2011-05-15 07:55
extend.rb	2.53 KB	-rw-r--r--	2012-11-26 23:28
generator.rb	1.72 KB	-rw-r--r--	2012-11-26 23:28
ghost_method.rb	114 B	-rw-r--r--	2012-11-26 23:28
include.rb	2.61 KB	-rw-r--r--	2012-11-26 23:28
known_classes.rb	2.58 KB	-rw-r--r--	2011-06-29 17:17
markdown.rb	380.09 KB	-rw-r--r--	2012-11-30 22:58
markup.rb	28.31 KB	-rw-r--r--	2012-11-26 23:28
meta_method.rb	99 B	-rw-r--r--	2012-11-26 23:28
method_attr.rb	8.57 KB	-rw-r--r--	2012-11-26 23:28
normal_class.rb	2.06 KB	-rw-r--r--	2012-11-26 23:28
normal_module.rb	1.36 KB	-rw-r--r--	2012-11-26 23:28
options.rb	28.49 KB	-rw-r--r--	2012-12-11 02:44
parser.rb	7.83 KB	-rw-r--r--	2013-01-04 01:16
rd.rb	3.54 KB	-rw-r--r--	2012-11-26 23:28
rdoc.rb	13.25 KB	-rw-r--r--	2012-12-13 02:58
require.rb	935 B	-rw-r--r--	2012-11-26 23:28
ri.rb	315 B	-rw-r--r--	2012-11-26 23:28
ruby_lex.rb	27.23 KB	-rw-r--r--	2012-12-18 02:31
ruby_token.rb	11.21 KB	-rw-r--r--	2012-12-18 02:31
rubygems_hook.rb	4.91 KB	-rw-r--r--	2012-12-14 00:16
servlet.rb	10.83 KB	-rw-r--r--	2013-02-05 03:24
single_class.rb	330 B	-rw-r--r--	2012-11-26 23:28
stats.rb	9.78 KB	-rw-r--r--	2012-11-26 23:28
store.rb	22.32 KB	-rw-r--r--	2013-01-24 19:15
task.rb	7.66 KB	-rw-r--r--	2012-11-26 23:28
test_case.rb	3.46 KB	-rw-r--r--	2012-11-29 18:34
text.rb	7.59 KB	-rw-r--r--	2015-01-30 02:13
token_stream.rb	2.46 KB	-rw-r--r--	2012-11-26 23:28
tom_doc.rb	5.7 KB	-rw-r--r--	2013-01-04 01:16
top_level.rb	5.4 KB	-rw-r--r--	2013-01-22 20:02

Rename

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

class RDoc::Stats

##
  # Output level for the coverage report

attr_reader :coverage_level

##
  # Count of files parsed during parsing

attr_reader :files_so_far

##
  # Total number of files found

attr_reader :num_files

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

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

##
  # Records the parsing of an alias +as+.

def add_alias as
    @display.print_alias as
  end

##
  # Records the parsing of an attribute +attribute+

def add_attribute attribute
    @display.print_attribute attribute
  end

##
  # Records the parsing of a class +klass+

def add_class klass
    @display.print_class klass
  end

##
  # Records the parsing of +constant+

def add_constant constant
    @display.print_constant constant
  end

##
  # Records the parsing of +file+

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

##
  # Records the parsing of +method+

def add_method(method)
    @display.print_method method
  end

##
  # Records the parsing of a module +mod+

def add_module(mod)
    @display.print_module mod
  end

##
  # Call this to mark the beginning of parsing for display purposes

def begin_adding
    @display.begin_adding
  end

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

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

##
  # Sets coverage report level.  Accepted values are:
  #
  # false or nil:: No report
  # 0:: Classes, modules, constants, attributes, methods
  # 1:: Level 0 + method parameters

def coverage_level= level
    level = -1 unless level

@coverage_level = level
  end

##
  # Returns the length and number of undocumented items in +collection+.

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

##
  # Call this to mark the end of parsing for display purposes

def done_adding
    @display.done_adding
  end

##
  # The documentation status of this project.  +true+ when 100%, +false+ when
  # less than 100% and +nil+ when unknown.
  #
  # Set by calling #calculate

def fully_documented?
    @fully_documented
  end

##
  # A report that says you did a great job!

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

report.join "\n"
  end

##
  # Calculates the percentage of items documented.

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

##
  # Returns a report on which items are not documented

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

##
  # Returns a report on undocumented attributes in ClassModule +cm+

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

##
  # Returns a report on undocumented items in ClassModule +cm+

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

##
  # Returns a report on undocumented constants in ClassModule +cm+

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

##
  # Returns a report on undocumented methods in ClassModule +cm+

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

##
  # Returns a summary of the collected statistics.

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

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

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

autoload :Quiet,   'rdoc/stats/quiet'
  autoload :Normal,  'rdoc/stats/normal'
  autoload :Verbose, 'rdoc/stats/verbose'

end