Class: RDoc::Stats::Normal
| Relationships & Source Files | |
| Extension / Inclusion / Inheritance Descendants | |
|
Subclasses:
|
|
| Super Chains via Extension / Inclusion / Inheritance | |
|
Class Chain:
self,
Quiet
|
|
|
Instance Chain:
self,
Quiet
|
|
| Inherits: |
RDoc::Stats::Quiet
|
| Defined in: | lib/rdoc/stats/normal.rb |
Overview
::RDoc::Stats printer that prints just the files being documented with a progress bar
Class Method Summary
Instance Method Summary
-
#print_file(files_so_far, filename)
Prints a file with a progress bar.
- #begin_adding Internal use only
- #done_adding Internal use only
Quiet - Inherited
| #begin_adding | Prints a message at the beginning of parsing. |
| #done_adding | Prints when |
| #print_alias | Prints when an alias is added. |
| #print_attribute | Prints when an attribute is added. |
| #print_class | Prints when a class is added. |
| #print_constant | Prints when a constant is added. |
| #print_file | Prints when a file is added. |
| #print_method | Prints when a method is added. |
| #print_module | Prints when a module is added. |
Constructor Details
This class inherits a constructor from RDoc::Stats::Quiet
Instance Method Details
#begin_adding
This method is for internal use only.
[ GitHub ]
# File 'lib/rdoc/stats/normal.rb', line 15
def begin_adding # :nodoc: puts "Parsing sources..." @last_width = 0 end
#done_adding
This method is for internal use only.
[ GitHub ]
# File 'lib/rdoc/stats/normal.rb', line 54
def done_adding # :nodoc: puts end
#print_file(files_so_far, filename)
Prints a file with a progress bar
# File 'lib/rdoc/stats/normal.rb', line 23
def print_file files_so_far, filename = 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 - .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] = "..." 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 = .size + filename.size term = "\r" else term = "\n" end $stdout.print(, filename, term) $stdout.flush end