diff options
| author | Hiroshi SHIBATA <[email protected]> | 2025-01-15 11:52:40 +0900 |
|---|---|---|
| committer | Hiroshi SHIBATA <[email protected]> | 2025-01-15 16:52:56 +0900 |
| commit | 86d871d29cda15810d9d60dc1b94a07e9530e0cb (patch) | |
| tree | ae0fd977690197a4c82eed861527c109caade4f1 /lib/rdoc/stats | |
| parent | e0be1b902549f80fcdc95e801d4d533b0fdec43b (diff) | |
Migrate rdoc as bundled gems
Notes
Notes:
Merged: https://github.com/ruby/ruby/pull/12577
Diffstat (limited to 'lib/rdoc/stats')
| -rw-r--r-- | lib/rdoc/stats/normal.rb | 58 | ||||
| -rw-r--r-- | lib/rdoc/stats/quiet.rb | 59 | ||||
| -rw-r--r-- | lib/rdoc/stats/verbose.rb | 44 |
3 files changed, 0 insertions, 161 deletions
diff --git a/lib/rdoc/stats/normal.rb b/lib/rdoc/stats/normal.rb deleted file mode 100644 index 0a22f0582b..0000000000 --- a/lib/rdoc/stats/normal.rb +++ /dev/null @@ -1,58 +0,0 @@ -# frozen_string_literal: true -begin - require 'io/console/size' -rescue LoadError - # for JRuby - require 'io/console' -end - -## -# Stats printer that prints just the files being documented with a progress -# bar - -class RDoc::Stats::Normal < RDoc::Stats::Quiet - - def begin_adding # :nodoc: - puts "Parsing sources..." - @last_width = 0 - end - - ## - # Prints a file with a progress bar - - 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? - # 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 - progress_bar.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 = progress_bar.size + filename.size - term = "\r" - else - term = "\n" - end - $stdout.print(progress_bar, filename, term) - $stdout.flush - end - - def done_adding # :nodoc: - puts - end - -end diff --git a/lib/rdoc/stats/quiet.rb b/lib/rdoc/stats/quiet.rb deleted file mode 100644 index 9c98ea5f86..0000000000 --- a/lib/rdoc/stats/quiet.rb +++ /dev/null @@ -1,59 +0,0 @@ -# frozen_string_literal: true -## -# Stats printer that prints nothing - -class RDoc::Stats::Quiet - - ## - # Creates a new Quiet that will print nothing - - def initialize num_files - @num_files = num_files - end - - ## - # Prints a message at the beginning of parsing - - def begin_adding(*) end - - ## - # Prints when an alias is added - - def print_alias(*) end - - ## - # Prints when an attribute is added - - def print_attribute(*) end - - ## - # Prints when a class is added - - def print_class(*) end - - ## - # Prints when a constant is added - - def print_constant(*) end - - ## - # Prints when a file is added - - def print_file(*) end - - ## - # Prints when a method is added - - def print_method(*) end - - ## - # Prints when a module is added - - def print_module(*) end - - ## - # Prints when RDoc is done - - def done_adding(*) end - -end diff --git a/lib/rdoc/stats/verbose.rb b/lib/rdoc/stats/verbose.rb deleted file mode 100644 index 7090d561f8..0000000000 --- a/lib/rdoc/stats/verbose.rb +++ /dev/null @@ -1,44 +0,0 @@ -# frozen_string_literal: true -## -# Stats printer that prints everything documented, including the documented -# status - -class RDoc::Stats::Verbose < RDoc::Stats::Normal - - ## - # Returns a marker for RDoc::CodeObject +co+ being undocumented - - def nodoc co - " (undocumented)" unless co.documented? - end - - def print_alias as # :nodoc: - puts " alias #{as.new_name} #{as.old_name}#{nodoc as}" - end - - def print_attribute attribute # :nodoc: - puts " #{attribute.definition} #{attribute.name}#{nodoc attribute}" - end - - def print_class(klass) # :nodoc: - puts " class #{klass.full_name}#{nodoc klass}" - end - - def print_constant(constant) # :nodoc: - puts " #{constant.name}#{nodoc constant}" - end - - def print_file(files_so_far, file) # :nodoc: - super - puts - end - - def print_method(method) # :nodoc: - puts " #{method.singleton ? '::' : '#'}#{method.name}#{nodoc method}" - end - - def print_module(mod) # :nodoc: - puts " module #{mod.full_name}#{nodoc mod}" - end - -end |