Extended maintenance of Ruby 1.9.3 ended on February 23, 2015. Read more
Stats printer that prints just the files being documented with a progress bar
Prints a file with a progress bar
# File rdoc/stats/normal.rb, line 14 def print_file files_so_far, filename return unless $stdout.tty? progress_bar = sprintf("%3d%% [%2d/%2d] ", 100 * files_so_far / @num_files, files_so_far, @num_files) # 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") $stdout.flush end
Commenting is here to help enhance the documentation. For example, code samples, or clarification of the documentation.
If you have questions about Ruby or the documentation, please post to one of the Ruby mailing lists. You will get better, faster, help that way.
If you wish to post a correction of the docs, please do so, but also file bug report so that it can be corrected for the next release. Thank you.
If you want to help improve the Ruby documentation, please visit Documenting-ruby.org.