Import RDoc 3

git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@30249 b2dd03c8-39d4-4d8f-98ff-823fe69b080e

3 files changed, 155 insertions, 0 deletions

diff --git a/lib/rdoc/stats/normal.rb b/lib/rdoc/stats/normal.rb
new file mode 100644
index 0000000000..2057332b2d
--- /dev/null
+++ b/lib/rdoc/stats/normal.rb
@@ -0,0 +1,51 @@
+##
+# Stats printer that prints just the files being documented with a progress
+# bar
+
+class RDoc::Stats::Normal < RDoc::Stats::Quiet
+
+  def begin_adding # :nodoc:
+    puts "Parsing sources..."
+  end
+
+  ##
+  # Prints a file with a progress bar
+
+  def print_file files_so_far, filename
+    progress_bar = sprintf("%3d%% [%2d/%2d]  ",
+                           100 * files_so_far / @num_files,
+                           files_so_far,
+                           @num_files)
+
+    if $stdout.tty? then
+      # Print a progress bar, but make sure it fits on a single line. Filename
+      # will be truncated if necessary.
+      terminal_width = (ENV['COLUMNS'] || 80).to_i
+      max_filename_size = terminal_width - progress_bar.size
+
+      if filename.size > max_filename_size then
+        # Turn "some_long_filename.rb" to "...ong_filename.rb"
+        filename = filename[(filename.size - max_filename_size) .. -1]
+        filename[0..2] = "..."
+      end
+
+      # Pad the line with whitespaces so that leftover output from the
+      # previous line doesn't show up.
+      line = "#{progress_bar}#{filename}"
+      padding = terminal_width - line.size
+      line << (" " * padding) if padding > 0
+
+      $stdout.print("#{line}\r")
+    else
+      $stdout.puts "#{progress_bar} #{filename}"
+    end
+
+    $stdout.flush
+  end
+
+  def done_adding # :nodoc:
+    puts
+  end
+
+end
+
diff --git a/lib/rdoc/stats/quiet.rb b/lib/rdoc/stats/quiet.rb
new file mode 100644
index 0000000000..eed27b2a88
--- /dev/null
+++ b/lib/rdoc/stats/quiet.rb
@@ -0,0 +1,59 @@
+##
+# Stats printer that prints nothing
+
+class RDoc::Stats::Quiet
+
+  ##
+  # Creates a new Quiet that will print nothing
+
+  def initialize num_files
+    @num_files = num_files
+  end
+
+  ##
+  # Prints a message at the beginning of parsing
+
+  def begin_adding(*) end
+
+  ##
+  # Prints when an alias is added
+
+  def print_alias(*) end
+
+  ##
+  # Prints when an attribute is added
+
+  def print_attribute(*) end
+
+  ##
+  # Prints when a class is added
+
+  def print_class(*) end
+
+  ##
+  # Prints when a constant is added
+
+  def print_constant(*) end
+
+  ##
+  # Prints when a file is added
+
+  def print_file(*) end
+
+  ##
+  # Prints when a method is added
+
+  def print_method(*) end
+
+  ##
+  # Prints when a module is added
+
+  def print_module(*) end
+
+  ##
+  # Prints when RDoc is done
+
+  def done_adding(*) end
+
+end
+
diff --git a/lib/rdoc/stats/verbose.rb b/lib/rdoc/stats/verbose.rb
new file mode 100644
index 0000000000..430809ae07
--- /dev/null
+++ b/lib/rdoc/stats/verbose.rb
@@ -0,0 +1,45 @@
+##
+# Stats printer that prints everything documented, including the documented
+# status
+
+class RDoc::Stats::Verbose < RDoc::Stats::Normal
+
+  ##
+  # Returns a marker for RDoc::CodeObject +co+ being undocumented
+
+  def nodoc co
+    " (undocumented)" unless co.documented?
+  end
+
+  def print_alias as # :nodoc:
+    puts "    alias #{as.new_name} #{as.old_name}#{nodoc as}"
+  end
+
+  def print_attribute attribute # :nodoc:
+    puts "    #{attribute.definition} #{attribute.name}#{nodoc attribute}"
+  end
+
+  def print_class(klass) # :nodoc:
+    puts "  class #{klass.full_name}#{nodoc klass}"
+  end
+
+  def print_constant(constant) # :nodoc:
+    puts "    #{constant.name}#{nodoc constant}"
+  end
+
+  def print_file(files_so_far, file) # :nodoc:
+    super
+    puts
+  end
+
+  def print_method(method) # :nodoc:
+    puts "    #{method.singleton ? '::' : '#'}#{method.name}#{nodoc method}"
+  end
+
+  def print_module(mod) # :nodoc:
+    puts "  module #{mod.full_name}#{nodoc mod}"
+  end
+
+end
+
+