rdoc 2.0.0 → 2.1.0

data/lib/rdoc/stats.rb

@@ -5,11 +5,49 @@ require 'rdoc'
 
 class RDoc::Stats
 
-  attr_accessor :num_files, :num_classes, :num_modules, :num_methods
+  attr_reader :num_classes
+  attr_reader :num_files
+  attr_reader :num_methods
+  attr_reader :num_modules
+
+  def initialize(verbosity = 1)
+    @num_classes = 0
+    @num_files   = 0
+    @num_methods = 0
+    @num_modules = 0
 
-  def initialize
-    @num_files = @num_classes = @num_modules = @num_methods = 0
     @start = Time.now
+
+    @display = case verbosity
+               when 0 then Quiet.new
+               when 1 then Normal.new
+               else        Verbose.new
+               end
+  end
+
+  def add_alias(as)
+    @display.print_alias as
+    @num_methods += 1
+  end
+
+  def add_class(klass)
+    @display.print_class klass
+    @num_classes += 1
+  end
+
+  def add_file(file)
+    @display.print_file file
+    @num_files += 1
+  end
+
+  def add_method(method)
+    @display.print_method method
+    @num_methods += 1
+  end
+
+  def add_module(mod)
+    @display.print_module mod
+    @num_modules += 1
   end
 
   def print
@@ -17,7 +55,59 @@ class RDoc::Stats
     puts "Classes: #@num_classes"
     puts "Modules: #@num_modules"
     puts "Methods: #@num_methods"
-    puts "Elapsed: " + sprintf("%0.3fs", Time.now - @start)
+    puts "Elapsed: " + sprintf("%0.1fs", Time.now - @start)
+  end
+
+  class Quiet
+    def print_alias(*) end
+    def print_class(*) end
+    def print_file(*) end
+    def print_method(*) end
+    def print_module(*) end
+  end
+
+  class Normal
+    def print_alias(as)
+      print 'a'
+    end
+
+    def print_class(klass)
+      print 'C'
+    end
+
+    def print_file(file)
+      print "\n#{file}: "
+    end
+
+    def print_method(method)
+      print 'm'
+    end
+
+    def print_module(mod)
+      print 'M'
+    end
+  end
+
+  class Verbose
+    def print_alias(as)
+      puts "\t\talias #{as.new_name} #{as.old_name}"
+    end
+
+    def print_class(klass)
+      puts "\tclass #{klass.full_name}"
+    end
+
+    def print_file(file)
+      puts file
+    end
+
+    def print_method(method)
+      puts "\t\t#{method.singleton ? '::' : '#'}#{method.name}"
+    end
+
+    def print_module(mod)
+      puts "\tmodule #{mod.full_name}"
+    end
   end
 
 end

data/test/test_rdoc_info_formatting.rb

@@ -0,0 +1,175 @@
+require 'fileutils'
+require 'tmpdir'
+require 'test/unit'
+
+require 'rdoc/generator/texinfo'
+
+# From chapter 18 of the Pickaxe 3rd ed. and the TexInfo manual.
+class TestRdocInfoFormatting < Test::Unit::TestCase
+  def setup
+    @output_dir = File.join Dir.tmpdir, "test_rdoc_info_formatting_#{$$}"
+    @output_file = File.join @output_dir, 'rdoc.texinfo'
+
+    RDoc::RDoc.new.document(['--fmt=texinfo', '--quiet',
+                             File.expand_path(__FILE__),
+                             "--op=#{@output_dir}"])
+    @text = File.read @output_file
+
+    # File.open('rdoc.texinfo', 'w') { |f| f.puts @text }
+  end
+
+  def teardown
+    FileUtils.rm_rf @output_dir
+  end
+
+  # Make sure tags like *this* do not make HTML
+  def test_descriptions_are_not_html
+    assert_no_match Regexp.new("\<b\>this\<\/b\>"), @text, "We had some HTML; icky!"
+  end
+
+  # Ensure we get a reasonable amount
+  #
+  # of space in between paragraphs.
+  def test_paragraphs_are_spaced
+    assert_match(/amount\n\n\nof space/, @text)
+  end
+
+  # @ and {} should be at-sign-prefixed
+  def test_escaping
+    assert_match(/@@ and @\{@\} should be at-sign-prefixed/)
+  end
+  
+  # This tests that *bold* and <b>bold me</b> become @strong{bolded}
+  def test_bold
+    # Seems like a limitation of the Info format: @strong{bold}
+    # becomes *bold* when read in Info or M-x info. highly lame!
+    assert_match(/@strong\{bold\}/)
+    assert_match(/@strong\{bold me\}/)
+  end
+
+  # Test that _italics_ and <em>italicize me</em> becomes @emph{italicized}
+  def test_italics
+    assert_match(/@emph\{italics\}/)
+    assert_match(/@emph\{italicize me\}/)
+  end
+
+  # And that typewriter +text+ and <tt>typewriter me</tt> becomes @code{typewriter}
+  def test_tt
+    assert_match(/@code\{text\}/)
+    assert_match(/@code\{typewriter me\}/)
+  end
+
+  # Check that
+  #   anything indented is
+  #   verbatim @verb{|foo bar baz|}
+  def test_literal_code
+    assert_match("@verb{|  anything indented is
+  verbatim @@verb@{|foo bar baz|@}
+|}")
+  end
+
+  # = Huge heading should be a @majorheading
+  # == There is also @chapheading
+  # === Everything deeper becomes a regular @heading
+  # ====== Regardless of its nesting level
+  def test_headings
+    assert_match(/@majorheading\{Huge heading should be a @@majorheading\}/)
+    assert_match(/@chapheading\{There is also @@chapheading\}/)
+    assert_match(/@heading\{Everything deeper becomes a regular @@heading\}/)
+    assert_match(/@heading\{Regardless of its nesting level\}/)
+  end
+
+  # * list item
+  # * list item2
+  #
+  # with a paragraph in between
+  #
+  # - hyphen lists
+  # - are also allowed
+  #   and items may flow over lines
+  def test_bullet_lists
+    assert_match("@itemize @bullet
+@item
+list item
+@item
+list item2
+@end itemize")
+    assert_match("@itemize @bullet
+@item
+hyphen lists
+@item
+are also allowed and items may flow over lines
+@end itemize")
+  end
+
+  # 2. numbered lists
+  # 8. are made by
+  # 9. a digit followed by a period
+  def test_numbered_lists
+  end
+
+  # a. alpha lists
+  # b. should be parsed too
+  def test_alpha_lists
+  end
+
+  # [cat]   small domestic animal
+  # [+cat+] command to copy standard input
+  #         to standard output
+  def test_labelled_lists
+  end
+
+  # * First item.
+  #   * Inner item.
+  #   * Second inner item.
+  # * Second outer item.
+  def test_nested_lists
+    assert_match("@itemize @bullet
+@item
+First item.
+@itemize @bullet
+@item
+Inner item.
+@item
+Second inner item.
+@end itemize
+@item
+Second outer item.
+@end itemize")
+  end
+  
+  def test_internal_hyperlinks
+    # be sure to test multi-word hyperlinks as well.
+  end
+
+  def test_hyperlink_targets
+  end
+
+  def test_web_links
+    # An example of the two-argument form: The official
+    # @uref{ftp://ftp.gnu.org/gnu, GNU ftp site} holds programs and texts.
+
+    # produces:
+    #      The official GNU ftp site (ftp://ftp.gnu.org/gnu)
+    #      holds programs and texts.
+    # and the HTML output is this:
+    #      The official <a href="ftp://ftp.gnu.org/gnu">GNU ftp site</a>
+    #      holds programs and texts.
+  end
+
+  # three or more hyphens
+  # ----
+  # should produce a horizontal rule
+  def test_horizontal_rule
+    # gah; not sure texinfo supports horizontal rules
+  end
+
+  private
+
+  # We don't want the whole string inspected if we pass our own
+  # message in.
+  def assert_match(regex, string = @text,
+                   message = "Didn't find #{regex.inspect} in #{string}.")
+    assert string[regex] #, message
+  end
+end

data/test/test_rdoc_info_sections.rb

@@ -0,0 +1,136 @@
+require 'fileutils'
+require 'tempfile'
+require 'test/unit'
+require 'tmpdir'
+
+require 'rdoc/generator/texinfo'
+
+# give us access to check this stuff before it's rendered
+class RDoc::Generator::Texinfo; attr_reader :files, :classes; end
+class RDoc::RDoc; attr_reader :options; attr_reader :gen; end
+
+class TestRdocInfoSections < Test::Unit::TestCase
+
+  def setup
+    @output_dir = File.join Dir.tmpdir, "test_rdoc_info_sections_#{$$}"
+    @output_file = File.join @output_dir, 'rdoc.texinfo'
+
+    @input_file = Tempfile.new 'my_file.rb'
+
+    open @input_file.path, 'w' do |io|
+      io.write TEST_DOC
+    end
+
+    RDoc::Parser.alias_extension '.rb', File.extname(@input_file.path)
+
+    @rdoc = RDoc::RDoc.new
+    @rdoc.document(['--fmt=texinfo', '--quiet', @input_file.path,
+                    "--op=#{@output_dir}"])
+
+    @text = File.read @output_file
+  end
+
+  def teardown
+    @input_file.close
+    FileUtils.rm_rf @output_dir
+  end
+
+  def test_output_exists
+    assert ! @text.empty?
+  end
+
+  def test_each_class_has_a_chapter
+    assert_section "Class MyClass", '@chapter'
+  end
+
+  def test_class_descriptions_are_given
+    assert_match(/Documentation for my class/, @text.gsub("\n", ' '))
+  end
+
+  def test_included_modules_are_given
+    assert_match(/Includes.* MyModule/m, @text)
+  end
+
+  def test_class_methods_are_given
+    assert_match(/my_class_method\(my_first_argument\)/, @text)
+  end
+
+  def test_classes_instance_methods_are_given
+    assert_section 'Class MyClass#my_method'
+    assert_match(/my_method\(my_first_argument\)/, @text)
+  end
+
+  def test_each_module_has_a_chapter
+    assert_section 'MyModule', '@chapter'
+  end
+
+  def test_methods_are_shown_only_once
+    methods = @rdoc.gen.classes.map do |c|
+      c.methods.map do |m|
+        c.name + '#' + m.name
+      end
+    end.flatten
+
+    assert_equal methods, methods.uniq
+  end
+
+#   if system "makeinfo --version > /dev/null"
+#     def test_compiles_to_info
+#       makeinfo_output = `cd #{@output_dir} && makeinfo rdoc.texinfo`
+#       assert(File.exist?(File.join(@output_dir, 'rdoc.info')),
+#              "Info file was not compiled: #{makeinfo_output}")
+#     end
+#   end
+
+#   def test_constants_are_documented_somehow
+#     assert_section 'DEFAULT_FILENAME' # what kind of section?
+#     assert_section 'DEFAULT_INFO_FILENAME'
+#   end
+
+#   def test_oh_yeah_dont_forget_files
+#   end
+
+  def assert_section(name, command = '@section')
+    assert_match Regexp.new("^#{command}.*#{Regexp.escape name}"), @text, "Could not find a #{command} #{name}"
+  end
+
+  TEST_DOC = <<-DOC
+##
+# Documentation for my module
+
+module MyModule
+
+  ##
+  # Documentation for my included method
+
+  def my_included_method() end
+
+end
+
+##
+# Documentation for my class
+
+class MyClass
+
+  include MyModule
+
+  ##
+  # Documentation for my constant
+
+  MY_CONSTANT = 'my value'
+
+  ##
+  # Documentation for my class method
+
+  def self.my_class_method(my_first_argument) end
+
+  ##
+  # Documentation for my method
+
+  def my_method(my_first_argument) end
+
+end
+
+  DOC
+
+end

data/test/test_rdoc_markup_to_html.rb

@@ -0,0 +1,30 @@
+require 'test/unit'
+require 'rdoc/markup'
+require 'rdoc/markup/to_html'
+
+class TestRdocMarkupToHtml < Test::Unit::TestCase
+
+  def setup
+    @am = RDoc::Markup::AttributeManager.new
+    @th = RDoc::Markup::ToHtml.new
+  end
+
+  def test_tt_formatting
+    assert_equal "<p>\n<tt>--</tt> &#8212; <tt>(c)</tt> &#169;\n</p>\n",
+                 util_format("<tt>--</tt> -- <tt>(c)</tt> (c)")
+    assert_equal "<p>\n<b>&#8212;</b>\n</p>\n", util_format("<b>--</b>")
+  end
+
+  def util_fragment(text)
+    RDoc::Markup::Fragment.new 0, nil, nil, text
+  end
+
+  def util_format(text)
+    fragment = util_fragment text
+
+    @th.start_accepting
+    @th.accept_paragraph @am, fragment
+    @th.end_accepting
+  end
+
+end