rdoc 2.0.0

data/test/test_rdoc_ri_formatter.rb

@@ -0,0 +1,318 @@
+require 'stringio'
+require 'test/unit'
+require 'rdoc/ri/formatter'
+require 'rdoc/markup/to_flow'
+
+class TestRDocRIFormatter < Test::Unit::TestCase
+
+  def setup
+    @output = StringIO.new
+    @width = 78
+    @indent = '  '
+
+    @f = RDoc::RI::Formatter.new @output, @width, @indent
+    @markup = RDoc::Markup.new
+    @flow = RDoc::Markup::ToFlow.new
+  end
+
+  def test_blankline
+    @f.blankline
+
+    assert_equal "\n", @output.string
+  end
+
+  def test_bold_print
+    @f.bold_print 'a b c'
+
+    assert_equal 'a b c', @output.string
+  end
+
+  def test_break_to_newline
+    @f.break_to_newline
+
+    assert_equal '', @output.string
+  end
+
+  def test_conv_html
+    assert_equal '> < " &', @f.conv_html('&gt; &lt; &quot; &amp;')
+  end
+
+  def test_conv_markup
+    text = '<tt>a</tt> <code>b</code> <b>c</b> <em>d</em>'
+
+    expected = '+a+ +b+ *c* _d_'
+
+    assert_equal expected, @f.conv_markup(text)
+  end
+
+  def test_display_flow
+    flow = [
+      RDoc::Markup::Flow::H.new(1, 'heading'),
+      RDoc::Markup::Flow::P.new('paragraph'),
+    ]
+
+    @f.display_flow flow
+
+    assert_equal "\nHEADING\n=======\n\n  paragraph\n\n", @output.string
+  end
+
+  def test_display_flow_item_h
+    item = RDoc::Markup::Flow::H.new 1, 'heading'
+
+    @f.display_flow_item item
+
+    assert_equal "\nHEADING\n=======\n\n", @output.string
+  end
+
+  def test_display_flow_item_li
+    item = RDoc::Markup::Flow::LI.new nil, 'paragraph'
+
+    @f.display_flow_item item
+
+    assert_equal "  paragraph\n\n", @output.string
+  end
+
+  def test_display_flow_item_list
+    item = RDoc::Markup::Flow::LIST.new :NUMBER
+
+    @f.display_flow_item item
+
+    assert_equal "", @output.string
+  end
+
+  def test_display_flow_item_p
+    item = RDoc::Markup::Flow::P.new 'paragraph'
+
+    @f.display_flow_item item
+
+    assert_equal "  paragraph\n\n", @output.string
+  end
+
+  def test_display_flow_item_rule
+    item = RDoc::Markup::Flow::RULE.new 1
+
+    @f.display_flow_item item
+
+    assert_equal "#{'-' * 78}\n", @output.string
+  end
+
+  def test_display_flow_item_unknown
+    e = assert_raise RDoc::Error do
+      @f.display_flow_item Object.new
+    end
+
+    assert_equal "Unknown flow element: Object", e.message
+  end
+
+  def test_display_flow_item_verb
+    item = RDoc::Markup::Flow::VERB.new 'a b c'
+
+    @f.display_flow_item item
+
+    assert_equal "  a b c\n\n", @output.string
+  end
+
+  def test_display_heading_1
+    @f.display_heading 'heading', 1, '  '
+
+    assert_equal "\nHEADING\n=======\n\n", @output.string
+  end
+
+  def test_display_heading_2
+    @f.display_heading 'heading', 2, '  '
+
+    assert_equal "\nheading\n-------\n\n", @output.string
+  end
+
+  def test_display_heading_3
+    @f.display_heading 'heading', 3, '  '
+
+    assert_equal "  heading\n\n", @output.string
+  end
+
+  def test_display_list
+    list = RDoc::Markup::Flow::LIST.new :NUMBER
+    list << RDoc::Markup::Flow::LI.new(nil, 'a b c')
+    list << RDoc::Markup::Flow::LI.new(nil, 'd e f')
+
+    @f.display_list list
+
+    assert_equal "  1.  a b c\n\n  2.  d e f\n\n", @output.string
+  end
+
+  def test_display_list_bullet
+    list = RDoc::Markup::Flow::LIST.new :BULLET
+    list << RDoc::Markup::Flow::LI.new(nil, 'a b c')
+
+    @f.display_list list
+
+    assert_equal "  *   a b c\n\n", @output.string
+  end
+
+  def test_display_list_labeled
+    list = RDoc::Markup::Flow::LIST.new :LABELED
+    list << RDoc::Markup::Flow::LI.new('label', 'a b c')
+
+    @f.display_list list
+
+    assert_equal "  label a b c\n\n", @output.string
+  end
+
+  def test_display_list_lower_alpha
+    list = RDoc::Markup::Flow::LIST.new :LOWERALPHA
+    list << RDoc::Markup::Flow::LI.new(nil, 'a b c')
+
+    @f.display_list list
+
+    assert_equal "  a.  a b c\n\n", @output.string
+  end
+
+  def test_display_list_note
+    list = RDoc::Markup::Flow::LIST.new :NOTE
+    list << RDoc::Markup::Flow::LI.new('note:', 'a b c')
+
+    @f.display_list list
+
+    assert_equal "  note: a b c\n\n", @output.string
+  end
+
+  def test_display_list_number
+    list = RDoc::Markup::Flow::LIST.new :NUMBER
+    list << RDoc::Markup::Flow::LI.new(nil, 'a b c')
+
+    @f.display_list list
+
+    assert_equal "  1.  a b c\n\n", @output.string
+  end
+
+  def test_display_list_unknown
+    list = RDoc::Markup::Flow::LIST.new :UNKNOWN
+    list << RDoc::Markup::Flow::LI.new(nil, 'a b c')
+
+    e = assert_raise ArgumentError do
+      @f.display_list list
+    end
+
+    assert_equal 'unknown list type UNKNOWN', e.message
+  end
+
+  def test_display_list_upper_alpha
+    list = RDoc::Markup::Flow::LIST.new :UPPERALPHA
+    list << RDoc::Markup::Flow::LI.new(nil, 'a b c')
+
+    @f.display_list list
+
+    assert_equal "  A.  a b c\n\n", @output.string
+  end
+
+  def test_display_verbatim_flow_item
+    verbatim = RDoc::Markup::Flow::VERB.new "a b c\nd e f"
+
+    @f.display_verbatim_flow_item verbatim
+
+    assert_equal "  a b c\n  d e f\n\n", @output.string
+  end
+
+  def test_display_verbatim_flow_item_bold
+    verbatim = RDoc::Markup::Flow::VERB.new "*a* b c"
+
+    @f.display_verbatim_flow_item verbatim
+
+    assert_equal "  *a* b c\n\n", @output.string
+  end
+
+  def test_draw_line
+    @f.draw_line
+
+    expected = '-' * @width + "\n"
+    assert_equal expected, @output.string
+  end
+
+  def test_draw_line_label
+    @f.draw_line 'label'
+
+    expected = '-' * (@width - 6) + " label\n"
+    assert_equal expected, @output.string
+  end
+
+  def test_draw_line_label_long
+    @f.draw_line 'a' * @width
+
+    expected = '-' * @width + "\n" + ('a' * @width) + "\n"
+    assert_equal expected, @output.string
+  end
+
+  def test_raw_print_line
+    @f.raw_print_line 'a b c'
+
+    assert_equal "a b c\n", @output.string
+  end
+
+  def test_strip_attributes_b
+    text = @f.strip_attributes 'hello <b>world</b>'
+
+    expected = 'hello world'
+
+    assert_equal expected, text
+  end
+
+  def test_strip_attributes_code
+    text = @f.strip_attributes 'hello <code>world</code>'
+
+    expected = 'hello world'
+
+    assert_equal expected, text
+  end
+
+  def test_strip_attributes_em
+    text = @f.strip_attributes 'hello <em>world</em>'
+
+    expected = 'hello world'
+
+    assert_equal expected, text
+  end
+
+  def test_strip_attributes_i
+    text = @f.strip_attributes 'hello <i>world</i>'
+
+    expected = 'hello world'
+
+    assert_equal expected, text
+  end
+
+  def test_strip_attributes_tt
+    text = @f.strip_attributes 'hello <tt>world</tt>'
+
+    expected = 'hello world'
+
+    assert_equal expected, text
+  end
+
+  def test_wrap_empty
+    @f.wrap ''
+    assert_equal '', @output.string
+  end
+
+  def test_wrap_long
+    @f.wrap 'a ' * (@width / 2)
+    assert_equal "  a a a a a a a a a a a a a a a a a a a a a a a a a a a a a a a a a a a a a a\n  a \n",
+                 @output.string
+  end
+
+  def test_wrap_markup
+    @f.wrap 'a <tt>b</tt> c'
+    assert_equal "  a +b+ c\n", @output.string
+  end
+
+  def test_wrap_nil
+    @f.wrap nil
+    assert_equal '', @output.string
+  end
+
+  def test_wrap_short
+    @f.wrap 'a b c'
+    assert_equal "  a b c\n", @output.string
+  end
+
+end
+

data/test/test_rdoc_ri_overstrike_formatter.rb

@@ -0,0 +1,69 @@
+require 'stringio'
+require 'test/unit'
+require 'rdoc/ri/formatter'
+require 'rdoc/markup/fragments'
+require 'rdoc/markup/to_flow'
+
+class TestRDocRIOverstrikeFormatter < Test::Unit::TestCase
+
+  def setup
+    @output = StringIO.new
+    @width = 78
+    @indent = '  '
+
+    @f = RDoc::RI::OverstrikeFormatter.new @output, @width, @indent
+    @markup = RDoc::Markup.new
+    @flow = RDoc::Markup::ToFlow.new
+
+    @af = RDoc::RI::AttributeFormatter
+  end
+
+  def test_display_verbatim_flow_item_bold
+    verbatim = RDoc::Markup::Flow::VERB.new "*a* b c"
+
+    @f.display_verbatim_flow_item verbatim
+
+    assert_equal "  *a* b c\n\n", @output.string
+  end
+
+  def test_write_attribute_text_bold
+    line = [RDoc::RI::AttributeFormatter::AttrChar.new('b', @af::BOLD)]
+
+    @f.write_attribute_text '  ', line
+
+    assert_equal "  b\bb\n", @output.string
+  end
+
+  def test_write_attribute_text_bold_italic
+    attr = @af::BOLD | @af::ITALIC
+    line = [RDoc::RI::AttributeFormatter::AttrChar.new('d', attr)]
+
+    @f.write_attribute_text '  ', line
+
+    assert_equal "  _\bd\bd\n", @output.string
+  end
+
+  def test_write_attribute_text_code
+    line = [RDoc::RI::AttributeFormatter::AttrChar.new('c', @af::CODE)]
+
+    @f.write_attribute_text '  ', line
+
+    assert_equal "  _\bc\n", @output.string
+  end
+
+  def test_write_attribute_text_italic
+    line = [RDoc::RI::AttributeFormatter::AttrChar.new('a', @af::ITALIC)]
+
+    @f.write_attribute_text '  ', line
+
+    assert_equal "  _\ba\n", @output.string
+  end
+
+  def test_bold_print
+    @f.bold_print 'a b c'
+
+    assert_equal "a\ba \b b\bb \b c\bc", @output.string
+  end
+
+end
+

metadata

@@ -0,0 +1,134 @@
+--- !ruby/object:Gem::Specification 
+name: rdoc
+version: !ruby/object:Gem::Version 
+  version: 2.0.0
+platform: ruby
+authors: 
+- Eric Hodel
+- Dave Thomas
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-04-10 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.5.1
+    version: 
+description: RDoc is an application that produces documentation for one or more Ruby source files.  RDoc includes the `rdoc` and `ri` tools for generating and displaying online documentation.  At this point in time, RDoc 2.x is a work in progress and may incur further API changes beyond what has been made to the RDoc 1.0.1.  Command-line tools are largely unaffected, but internal APIs may shift rapidly.
+email: 
+- drbrain@segment7.net
+- ""
+executables: 
+- rdoc
+- ri
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- README.txt
+files: 
+- History.txt
+- Manifest.txt
+- README.txt
+- Rakefile
+- bin/rdoc
+- bin/ri
+- lib/rdoc.rb
+- lib/rdoc/code_objects.rb
+- lib/rdoc/diagram.rb
+- lib/rdoc/dot.rb
+- lib/rdoc/generator.rb
+- lib/rdoc/generator/chm.rb
+- lib/rdoc/generator/chm/chm.rb
+- lib/rdoc/generator/html.rb
+- lib/rdoc/generator/html/hefss.rb
+- lib/rdoc/generator/html/html.rb
+- lib/rdoc/generator/html/kilmer.rb
+- lib/rdoc/generator/html/one_page_html.rb
+- lib/rdoc/generator/ri.rb
+- lib/rdoc/generator/xml.rb
+- lib/rdoc/generator/xml/rdf.rb
+- lib/rdoc/generator/xml/xml.rb
+- lib/rdoc/markup.rb
+- lib/rdoc/markup/attribute_manager.rb
+- lib/rdoc/markup/formatter.rb
+- lib/rdoc/markup/fragments.rb
+- lib/rdoc/markup/inline.rb
+- lib/rdoc/markup/lines.rb
+- lib/rdoc/markup/preprocess.rb
+- lib/rdoc/markup/to_flow.rb
+- lib/rdoc/markup/to_html.rb
+- lib/rdoc/markup/to_html_crossref.rb
+- lib/rdoc/markup/to_latex.rb
+- lib/rdoc/markup/to_test.rb
+- lib/rdoc/options.rb
+- lib/rdoc/parsers/parse_c.rb
+- lib/rdoc/parsers/parse_f95.rb
+- lib/rdoc/parsers/parse_rb.rb
+- lib/rdoc/parsers/parse_simple.rb
+- lib/rdoc/parsers/parserfactory.rb
+- lib/rdoc/rdoc.rb
+- lib/rdoc/ri.rb
+- lib/rdoc/ri/cache.rb
+- lib/rdoc/ri/descriptions.rb
+- lib/rdoc/ri/display.rb
+- lib/rdoc/ri/driver.rb
+- lib/rdoc/ri/formatter.rb
+- lib/rdoc/ri/paths.rb
+- lib/rdoc/ri/reader.rb
+- lib/rdoc/ri/util.rb
+- lib/rdoc/ri/writer.rb
+- lib/rdoc/stats.rb
+- lib/rdoc/template.rb
+- lib/rdoc/tokenstream.rb
+- test/test_rdoc_c_parser.rb
+- test/test_rdoc_markup.rb
+- test/test_rdoc_markup_attribute_manager.rb
+- test/test_rdoc_ri_attribute_formatter.rb
+- test/test_rdoc_ri_default_display.rb
+- test/test_rdoc_ri_formatter.rb
+- test/test_rdoc_ri_overstrike_formatter.rb
+has_rdoc: true
+homepage: http://rubyforge.org/projects/rdoc/
+post_install_message: 
+rdoc_options: 
+- --main
+- README.txt
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: rdoc
+rubygems_version: 1.1.0
+signing_key: 
+specification_version: 2
+summary: RDoc is an application that produces documentation for one or more Ruby source files
+test_files: 
+- test/test_rdoc_c_parser.rb
+- test/test_rdoc_markup.rb
+- test/test_rdoc_markup_attribute_manager.rb
+- test/test_rdoc_ri_attribute_formatter.rb
+- test/test_rdoc_ri_default_display.rb
+- test/test_rdoc_ri_formatter.rb
+- test/test_rdoc_ri_overstrike_formatter.rb