RDoc::Stats::Normal

Stats printer that prints just the files being documented with a progress bar

Public Instance Methods

print_file(files_so_far, filename) click to toggle source

Prints a file with a progress bar

 
               # File rdoc/stats/normal.rb, line 20
def print_file files_so_far, filename
  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 = if defined?(IO) && IO.respond_to?(:console_size)
                     IO.console_size[1].to_i.nonzero? || 80
                   else
                     80
                   end
  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

  line = "#{progress_bar}#{filename}"
  if $stdout.tty?
    # Clean the line with whitespaces so that leftover output from the
    # previous line doesn't show up.
    $stdout.print("\r" << (" " * @last_width) << ("\b" * @last_width) << "\r") if @last_width && @last_width > 0
    @last_width = line.size
    $stdout.print("#{line}\r")
  else
    $stdout.puts(line)
  end
  $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.

Home Classes Methods

In Files

Parent

Methods

Class/Module Index

RDoc::Stats::Normal

Public Instance Methods