Class: RDoc::Stats::Normal

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

Overview

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

Direct Known Subclasses

Verbose

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

#begin_adding ⇒ Object

:nodoc:



12
13
14
15
 
# File 'lib/rdoc/stats/normal.rb', line 12

def begin_adding # :nodoc:
  puts "Parsing sources..."
  @last_width = 0
end

#done_adding ⇒ Object

:nodoc:



54
55
56
 
# File 'lib/rdoc/stats/normal.rb', line 54

def done_adding # :nodoc:
  puts
end

#print_file(files_so_far, filename) ⇒ Object

Prints a file with a progress bar



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
45
46
47
48
49
50
51
52
 
# File 'lib/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