Gecko [ www.corporacionhdm.com.pe ]

Name	Size	Permission	Date
generator	[ DIR ]	drwxr-xr-x	2024-03-03 22:48
markup	[ DIR ]	drwxr-xr-x	2024-03-03 22:48
parser	[ DIR ]	drwxr-xr-x	2024-03-03 22:48
ri	[ DIR ]	drwxr-xr-x	2024-03-03 22:48
stats	[ DIR ]	drwxr-xr-x	2024-03-03 22:48
alias.rb	2.12 KB	-rw-r--r--	2010-12-20 03:22
anon_class.rb	171 B	-rw-r--r--	2011-02-02 00:32
any_method.rb	4.54 KB	-rw-r--r--	2011-06-16 04:59
attr.rb	2.88 KB	-rw-r--r--	2011-06-16 04:59
class_module.rb	14.49 KB	-rw-r--r--	2011-08-05 21:21
code_object.rb	6.56 KB	-rw-r--r--	2011-08-05 21:21
code_objects.rb	535 B	-rw-r--r--	2010-04-01 07:45
constant.rb	1.5 KB	-rw-r--r--	2010-12-20 03:22
context.rb	28.14 KB	-rw-r--r--	2011-08-05 21:21
cross_reference.rb	5.82 KB	-rw-r--r--	2011-08-05 21:21
encoding.rb	2.52 KB	-rw-r--r--	2012-02-14 07:55
erbio.rb	794 B	-rw-r--r--	2011-05-15 11:55
generator.rb	1.3 KB	-rw-r--r--	2011-02-02 00:32
ghost_method.rb	141 B	-rw-r--r--	2010-04-01 07:45
include.rb	2.11 KB	-rw-r--r--	2010-12-20 03:22
known_classes.rb	2.58 KB	-rw-r--r--	2011-06-29 21:17
markup.rb	20.96 KB	-rw-r--r--	2011-08-26 23:58
meta_method.rb	126 B	-rw-r--r--	2010-04-01 07:45
method_attr.rb	7.57 KB	-rw-r--r--	2011-05-15 11:55
normal_class.rb	1.58 KB	-rw-r--r--	2011-02-02 00:32
normal_module.rb	1.24 KB	-rw-r--r--	2011-02-02 00:32
options.rb	18.79 KB	-rw-r--r--	2011-05-14 00:39
parser.rb	5.39 KB	-rw-r--r--	2011-08-26 23:58
rdoc.rb	11.97 KB	-rw-r--r--	2011-06-16 04:59
require.rb	963 B	-rw-r--r--	2010-12-20 03:22
ri.rb	230 B	-rw-r--r--	2010-04-01 07:45
ruby_lex.rb	26.07 KB	-rw-r--r--	2011-08-24 00:02
ruby_token.rb	10.14 KB	-rw-r--r--	2010-12-20 03:22
rubygems_hook.rb	4.5 KB	-rw-r--r--	2011-06-16 04:59
single_class.rb	359 B	-rw-r--r--	2011-02-02 00:32
stats.rb	9.52 KB	-rw-r--r--	2011-05-14 00:39
task.rb	7.5 KB	-rw-r--r--	2011-05-14 00:39
text.rb	7.22 KB	-rw-r--r--	2011-08-05 21:21
token_stream.rb	1015 B	-rw-r--r--	2010-12-20 03:22
top_level.rb	10.1 KB	-rw-r--r--	2011-06-29 21:17

Rename

require 'rdoc'

##
# 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 num_files, verbosity = 1
    @files_so_far = 0
    @num_files = num_files

@coverage_level = 0
    @doc_items = nil
    @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 = RDoc::TopLevel.unique_classes_and_modules
    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 RDoc::TopLevel.unique_classes
    @num_constants,  @undoc_constants  = doc_stats constants
    @num_methods,    @undoc_methods    = doc_stats methods
    @num_modules,    @undoc_modules    = doc_stats RDoc::TopLevel.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
    [collection.length, collection.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
      require 'rdoc/markup/to_tt_only'
      require 'rdoc/generator/markup'
      require 'rdoc/text'
      extend RDoc::Text
    end

report = []

if @coverage_level.zero? then
      calculate

return great_job if @num_items == @doc_items
    end

ucm = RDoc::TopLevel.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?
      report << "  #{attr.definition} :#{attr.name} " \
        "# in file #{attr.file.full_name}"
    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?

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
      report << "  # in file #{constant.file.full_name}"
      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
      report << "  # in file #{method.file.full_name}"
      report << param_report if param_report
      report << "  def #{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