Class: RDoc::Stats::Normal

Inherits:
Quiet show all
Defined in:
lib/rdoc/stats/normal.rb

Overview

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

Instance Method Summary (collapse)

Methods inherited from Quiet

#initialize, #print_alias, #print_attribute, #print_class, #print_constant, #print_method, #print_module

Constructor Details

This class inherits a constructor from RDoc::Stats::Quiet

Instance Method Details

- (Object) begin_adding

:nodoc:



7
8
9
 
# File 'lib/rdoc/stats/normal.rb', line 7

def begin_adding # :nodoc:
  puts "Parsing sources..."
end

- (Object) done_adding

:nodoc:



46
47
48
 
# File 'lib/rdoc/stats/normal.rb', line 46

def done_adding # :nodoc:
  puts
end

- (Object) print_file(files_so_far, filename)

Prints a file with a progress bar



14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
 
# File 'lib/rdoc/stats/normal.rb', line 14

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