rdoc 8.0.0 → 8.1.0

data/lib/rdoc/stats/normal.rb

@@ -6,53 +6,57 @@ rescue LoadError
   require 'io/console'
 end
 
-##
-# Stats printer that prints just the files being documented with a progress
-# bar
+module RDoc
+  class Stats
+    ##
+    # Stats printer that prints just the files being documented with a progress
+    # bar
 
-class RDoc::Stats::Normal < RDoc::Stats::Quiet
+    class Normal < Stats::Quiet
 
-  def begin_adding # :nodoc:
-    puts "Parsing sources..."
-    @last_width = 0
-  end
+      def begin_adding # :nodoc:
+        puts "Parsing sources..."
+        @last_width = 0
+      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?
-      # Print a progress bar, but make sure it fits on a single line. Filename
-      # will be truncated if necessary.
-      size = IO.respond_to?(:console_size) ? IO.console_size : IO.console.winsize
-      terminal_width = size[1].to_i.nonzero? || 80
-      max_filename_size = (terminal_width - progress_bar.size) - 1
-
-      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] = "..."
+      ##
+      # 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?
+          # Print a progress bar, but make sure it fits on a single line. Filename
+          # will be truncated if necessary.
+          size = IO.respond_to?(:console_size) ? IO.console_size : IO.console.winsize
+          terminal_width = size[1].to_i.nonzero? || 80
+          max_filename_size = (terminal_width - progress_bar.size) - 1
+
+          if filename.size > max_filename_size
+            # Turn "some_long_filename.rb" to "...ong_filename.rb"
+            filename = filename[(filename.size - max_filename_size) .. -1]
+            filename[0..2] = "..."
+          end
+
+          # Clean the line with whitespaces so that leftover output from the
+          # previous line doesn't show up.
+          $stdout.print("\r\e[K") if @last_width && @last_width > 0
+          @last_width = progress_bar.size + filename.size
+          term = "\r"
+        else
+          term = "\n"
+        end
+        $stdout.print(progress_bar, filename, term)
+        $stdout.flush
       end
 
-      # Clean the line with whitespaces so that leftover output from the
-      # previous line doesn't show up.
-      $stdout.print("\r\e[K") if @last_width && @last_width > 0
-      @last_width = progress_bar.size + filename.size
-      term = "\r"
-    else
-      term = "\n"
-    end
-    $stdout.print(progress_bar, filename, term)
-    $stdout.flush
-  end
+      def done_adding # :nodoc:
+        puts
+      end
 
-  def done_adding # :nodoc:
-    puts
+    end
   end
-
 end

data/lib/rdoc/stats/quiet.rb

@@ -1,59 +1,63 @@
 # frozen_string_literal: true
-##
-# Stats printer that prints nothing
+module RDoc
+  class Stats
+    ##
+    # Stats printer that prints nothing
 
-class RDoc::Stats::Quiet
+    class Quiet
 
-  ##
-  # Creates a new Quiet that will print nothing
+      ##
+      # Creates a new Quiet that will print nothing
 
-  def initialize(num_files)
-    @num_files = num_files
-  end
+      def initialize(num_files)
+        @num_files = num_files
+      end
 
-  ##
-  # Prints a message at the beginning of parsing
+      ##
+      # Prints a message at the beginning of parsing
 
-  def begin_adding(*) end
+      def begin_adding(*) end
 
-  ##
-  # Prints when an alias is added
+      ##
+      # Prints when an alias is added
 
-  def print_alias(*) end
+      def print_alias(*) end
 
-  ##
-  # Prints when an attribute is added
+      ##
+      # Prints when an attribute is added
 
-  def print_attribute(*) end
+      def print_attribute(*) end
 
-  ##
-  # Prints when a class is added
+      ##
+      # Prints when a class is added
 
-  def print_class(*) end
+      def print_class(*) end
 
-  ##
-  # Prints when a constant is added
+      ##
+      # Prints when a constant is added
 
-  def print_constant(*) end
+      def print_constant(*) end
 
-  ##
-  # Prints when a file is added
+      ##
+      # Prints when a file is added
 
-  def print_file(*) end
+      def print_file(*) end
 
-  ##
-  # Prints when a method is added
+      ##
+      # Prints when a method is added
 
-  def print_method(*) end
+      def print_method(*) end
 
-  ##
-  # Prints when a module is added
+      ##
+      # Prints when a module is added
 
-  def print_module(*) end
+      def print_module(*) end
 
-  ##
-  # Prints when RDoc is done
+      ##
+      # Prints when RDoc is done
 
-  def done_adding(*) end
+      def done_adding(*) end
 
+    end
+  end
 end

data/lib/rdoc/stats/verbose.rb

@@ -1,44 +1,48 @@
 # frozen_string_literal: true
-##
-# Stats printer that prints everything documented, including the documented
-# status
+module RDoc
+  class Stats
+    ##
+    # Stats printer that prints everything documented, including the documented
+    # status
 
-class RDoc::Stats::Verbose < RDoc::Stats::Normal
+    class Verbose < Stats::Normal
 
-  ##
-  # Returns a marker for RDoc::CodeObject +co+ being undocumented
+      ##
+      # Returns a marker for RDoc::CodeObject +co+ being undocumented
 
-  def nodoc(co)
-    " (undocumented)" unless co.documented?
-  end
+      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_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_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_class(klass) # :nodoc:
+        puts "  class #{klass.full_name}#{nodoc klass}"
+      end
 
-  def print_constant(constant) # :nodoc:
-    puts "    #{constant.name}#{nodoc constant}"
-  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_file(files_so_far, file) # :nodoc:
+        super
+        puts
+      end
 
-  def print_method(method) # :nodoc:
-    puts "    #{method.singleton ? '::' : '#'}#{method.name}#{nodoc method}"
-  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
+      def print_module(mod) # :nodoc:
+        puts "  module #{mod.full_name}#{nodoc mod}"
+      end
 
+    end
+  end
 end