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 /test/rdoc/test_rdoc_markup_to_html_snippet.rb | |
| parent | e0be1b902549f80fcdc95e801d4d533b0fdec43b (diff) | |
Migrate rdoc as bundled gems
Notes
Notes:
Merged: https://github.com/ruby/ruby/pull/12577
Diffstat (limited to 'test/rdoc/test_rdoc_markup_to_html_snippet.rb')
| -rw-r--r-- | test/rdoc/test_rdoc_markup_to_html_snippet.rb | 709 |
1 files changed, 0 insertions, 709 deletions
diff --git a/test/rdoc/test_rdoc_markup_to_html_snippet.rb b/test/rdoc/test_rdoc_markup_to_html_snippet.rb deleted file mode 100644 index 94f58b6529..0000000000 --- a/test/rdoc/test_rdoc_markup_to_html_snippet.rb +++ /dev/null @@ -1,709 +0,0 @@ -# frozen_string_literal: true -require_relative 'helper' - -class TestRDocMarkupToHtmlSnippet < RDoc::Markup::FormatterTestCase - - add_visitor_tests - - def setup - super - - @to = RDoc::Markup::ToHtmlSnippet.new @options, 100, 100 - @ellipsis = @to.to_html '...' - end - - def accept_blank_line - assert_empty @to.res.join - end - - def accept_block_quote - assert_equal "\n<blockquote><p>quote\n</blockquote>\n", @to.res.join - - assert_equal 5, @to.characters - end - - def accept_document - assert_equal "<p>hello\n", @to.res.join - assert_equal 5, @to.characters - end - - def accept_heading - assert_equal "<p>Hello\n", @to.res.join - assert_equal 5, @to.characters - end - - def accept_heading_1 - assert_equal "<p>Hello\n", @to.res.join - assert_equal 5, @to.characters - end - - def accept_heading_2 - assert_equal "<p>Hello\n", @to.res.join - assert_equal 5, @to.characters - end - - def accept_heading_3 - assert_equal "<p>Hello\n", @to.res.join - assert_equal 5, @to.characters - end - - def accept_heading_4 - assert_equal "<p>Hello\n", @to.res.join - assert_equal 5, @to.characters - end - - def accept_heading_b - assert_equal "<p><strong>Hello</strong>\n", - @to.res.join - assert_equal 5, @to.characters - end - - def accept_heading_suppressed_crossref - assert_equal "<p>Hello\n", @to.res.join - assert_equal 5, @to.characters - end - - def accept_list_end_bullet - assert_equal [], @to.list - assert_equal [], @to.in_list_entry - - assert_equal "\n", @to.res.join - assert_equal 0, @to.characters - end - - def accept_list_end_label - assert_equal [], @to.list - assert_equal [], @to.in_list_entry - - assert_equal "\n", @to.res.join - assert_equal 0, @to.characters - end - - def accept_list_end_lalpha - assert_equal [], @to.list - assert_equal [], @to.in_list_entry - - assert_equal "\n", @to.res.join - assert_equal 0, @to.characters - end - - def accept_list_end_number - assert_equal [], @to.list - assert_equal [], @to.in_list_entry - - assert_equal "\n", @to.res.join - assert_equal 0, @to.characters - end - - def accept_list_end_note - assert_equal [], @to.list - assert_equal [], @to.in_list_entry - - assert_equal "\n", @to.res.join - assert_equal 0, @to.characters - end - - def accept_list_end_ualpha - assert_equal [], @to.list - assert_equal [], @to.in_list_entry - - assert_equal "\n", @to.res.join - assert_equal 0, @to.characters - end - - def accept_list_item_end_bullet - assert_equal [''], @to.in_list_entry - assert_equal 0, @to.characters - end - - def accept_list_item_end_label - assert_equal [''], @to.in_list_entry - assert_equal 4, @to.characters - end - - def accept_list_item_end_lalpha - assert_equal [''], @to.in_list_entry - assert_equal 0, @to.characters - end - - def accept_list_item_end_note - assert_equal [''], @to.in_list_entry - assert_equal 4, @to.characters - end - - def accept_list_item_end_number - assert_equal [''], @to.in_list_entry - assert_equal 0, @to.characters - end - - def accept_list_item_end_ualpha - assert_equal [''], @to.in_list_entry - assert_equal 0, @to.characters - end - - def accept_list_item_start_bullet - assert_equal "<p>", @to.res.join - assert_equal 0, @to.characters - end - - def accept_list_item_start_label - assert_equal "<p>cat — ", @to.res.join - assert_equal 4, @to.characters - end - - def accept_list_item_start_lalpha - assert_equal "<p>", @to.res.join - assert_equal 0, @to.characters - end - - def accept_list_item_start_note - assert_equal "<p>cat — ", - @to.res.join - assert_equal 4, @to.characters - end - - def accept_list_item_start_note_2 - expected = <<-EXPECTED -<p><code>teletype</code> — teletype description - - EXPECTED - - assert_equal expected, @to.res.join - assert_equal 29, @to.characters - end - - def accept_list_item_start_note_multi_description - expected = <<-EXPECTED -<p>label — description one -<p>description two - - EXPECTED - - assert_equal expected, @to.res.join - assert_equal 37, @to.characters - end - - def accept_list_item_start_note_multi_label - expected = <<-EXPECTED -<p>one, two — two headers - - EXPECTED - - assert_equal expected, @to.res.join - assert_equal 18, @to.characters - end - - def accept_list_item_start_number - assert_equal "<p>", @to.res.join - assert_equal 0, @to.characters - end - - def accept_list_item_start_ualpha - assert_equal "<p>", @to.res.join - assert_equal 0, @to.characters - end - - def accept_list_start_bullet - assert_equal [:BULLET], @to.list - assert_equal [''], @to.in_list_entry - - assert_equal '', @to.res.join - assert_equal 0, @to.characters - end - - def accept_list_start_label - assert_equal [:LABEL], @to.list - assert_equal [''], @to.in_list_entry - - assert_equal '', @to.res.join - assert_equal 0, @to.characters - end - - def accept_list_start_lalpha - assert_equal [:LALPHA], @to.list - assert_equal [''], @to.in_list_entry - - assert_equal '', @to.res.join - assert_equal 0, @to.characters - end - - def accept_list_start_note - assert_equal [:NOTE], @to.list - assert_equal [''], @to.in_list_entry - - assert_equal '', @to.res.join - assert_equal 0, @to.characters - end - - def accept_list_start_number - assert_equal [:NUMBER], @to.list - assert_equal [''], @to.in_list_entry - - assert_equal '', @to.res.join - assert_equal 0, @to.characters - end - - def accept_list_start_ualpha - assert_equal [:UALPHA], @to.list - assert_equal [''], @to.in_list_entry - - assert_equal '', @to.res.join - assert_equal 0, @to.characters - end - - def accept_paragraph - assert_equal "<p>hi\n", @to.res.join - - assert_equal 2, @to.characters - end - - def accept_paragraph_b - assert_equal "<p>reg <strong>bold words</strong> reg\n", @to.res.join - - assert_equal 18, @to.characters - end - - def accept_paragraph_br - assert_equal "<p>one<br>two\n", @to.res.join - - assert_equal 6, @to.characters - end - - def accept_paragraph_break - assert_equal "<p>hello<br>\nworld\n", @to.res.join - - assert_equal 11, @to.characters - end - - def accept_paragraph_i - assert_equal "<p>reg <em>italic words</em> reg\n", @to.res.join - - assert_equal 20, @to.characters - end - - def accept_paragraph_plus - assert_equal "<p>reg <code>teletype</code> reg\n", @to.res.join - - assert_equal 16, @to.characters - end - - def accept_paragraph_star - assert_equal "<p>reg <strong>bold</strong> reg\n", @to.res.join - - assert_equal 12, @to.characters - end - - def accept_paragraph_underscore - assert_equal "<p>reg <em>italic</em> reg\n", @to.res.join - - assert_equal 14, @to.characters - end - - def accept_raw - assert_equal '', @to.res.join - assert_equal 0, @to.characters - end - - def accept_rule - assert_empty @to.res - assert_equal 0, @to.characters - end - - def accept_verbatim - assert_equal "\n<pre class=\"ruby\"><span class=\"ruby-identifier\">hi</span>\n <span class=\"ruby-identifier\">world</span>\n</pre>\n", @to.res.join - assert_equal 10, @to.characters - end - - def end_accepting - assert_equal 'hi', @to.res.join - end - - def start_accepting - assert_equal [], @to.res - assert_equal [], @to.in_list_entry - assert_equal [], @to.list - assert_equal 0, @to.characters - end - - def list_nested - expected = <<-EXPECTED -<p>l1 -<p>l1.1 - -<p>l2 - - EXPECTED - - assert_equal expected, @to.res.join - assert_equal 8, @to.characters - end - - def list_verbatim - expected = <<-EXPECTED -<p>list stuff - -<pre>* list - with - - second - - 1. indented - 2. numbered - - third - -* second</pre> - - EXPECTED - - assert_equal expected, @to.end_accepting - assert_equal 81, @to.characters - end - - def test_accept_heading_7 - @to.start_accepting - - @to.accept_heading @RM::Heading.new(7, 'Hello') - - assert_equal "<p>Hello\n", @to.res.join - assert_equal 5, @to.characters - end - - def test_accept_heading_aref_class - @to.code_object = RDoc::NormalClass.new 'Foo' - @to.start_accepting - - @to.accept_heading @RM::Heading.new(1, 'Hello') - - assert_equal "<p>Hello\n", - @to.res.join - assert_equal 5, @to.characters - end - - def test_accept_heading_aref_method - @to.code_object = RDoc::AnyMethod.new nil, 'foo' - @to.start_accepting - - @to.accept_heading @RM::Heading.new(1, 'Hello') - - assert_equal "<p>Hello\n", - @to.res.join - assert_equal 5, @to.characters - end - - def test_accept_verbatim_ruby - options = RDoc::Options.new - rdoc = RDoc::RDoc.new - rdoc.options = options - RDoc::RDoc.current = rdoc - - verb = @RM::Verbatim.new("class C\n", "end\n") - - @to.start_accepting - @to.accept_verbatim verb - - expected = <<-EXPECTED - -<pre class="ruby"><span class="ruby-keyword">class</span> <span class="ruby-constant">C</span> -<span class="ruby-keyword">end</span> -</pre> - EXPECTED - - assert_equal expected, @to.res.join - assert_equal 11, @to.characters - end - - def test_accept_verbatim_ruby_error - options = RDoc::Options.new - rdoc = RDoc::RDoc.new - rdoc.options = options - RDoc::RDoc.current = rdoc - - verb = @RM::Verbatim.new("a % 09 # => blah\n") - - @to.start_accepting - @to.accept_verbatim verb - - inner = CGI.escapeHTML "a % 09 # => blah" - - expected = <<-EXPECTED - -<pre>#{inner}</pre> - EXPECTED - - assert_equal expected, @to.res.join - assert_equal 16, @to.characters - end - - def test_add_paragraph - @to = RDoc::Markup::ToHtmlSnippet.new @options, 0, 3 - assert_throws :done do - @to.add_paragraph - @to.add_paragraph - @to.add_paragraph - end - - assert_equal 3, @to.paragraphs - end - - def test_convert_limit - rdoc = <<-RDOC -= Hello - -This is some text, it *will* be cut off after 100 characters and an ellipsis -must follow - -So there you have it - RDOC - - expected = <<-EXPECTED -<p>Hello -<p>This is some text, it <strong>will</strong> be cut off after 100 characters and an ellipsis must follow -<p>So there you #{@ellipsis} - EXPECTED - - actual = @to.convert rdoc - - assert_equal expected, actual - assert_equal 111, @to.characters, 'snippet character length' - end - - def test_convert_limit_2 - rdoc = <<-RDOC -Outputs formatted RI data for the class or method +name+. - -Returns true if +name+ was found, false if it was not an alternative could -be guessed, raises an error if +name+ couldn't be guessed. - RDOC - - expected = <<-EXPECTED -<p>Outputs formatted RI data for the class or method <code>name</code>. -<p>Returns true if <code>name</code> was found, false if it was #{@ellipsis} - EXPECTED - - actual = @to.convert rdoc - - assert_equal expected, actual - assert_equal 159, @to.characters, 'snippet character length' - end - - def test_convert_limit_paragraphs - @to = RDoc::Markup::ToHtmlSnippet.new @options, 100, 3 - - rdoc = <<-RDOC -= \RDoc - Ruby Documentation System - -* {RDoc Project Page}[https://github.com/ruby/rdoc] -* {RDoc Documentation}[https://ruby.github.io/rdoc] -* {RDoc Bug Tracker}[https://github.com/ruby/rdoc/issues] - -== DESCRIPTION: - -RDoc produces HTML and command-line documentation for Ruby projects. RDoc -includes the +rdoc+ and +ri+ tools for generating and displaying online -documentation. - -See RDoc for a description of RDoc's markup and basic use. - RDOC - - expected = <<-EXPECTED -<p>RDoc - Ruby Documentation System -<p>RDoc Project Page -<p>RDoc Documentation - EXPECTED - - actual = @to.convert rdoc - - assert_equal expected, actual - assert_equal 67, @to.characters - end - - def test_convert_limit_in_tag - @to = RDoc::Markup::ToHtmlSnippet.new @options, 4 - rdoc = "* ab *c* d\n" - - expected = "<p>ab <strong>c</strong> #{@ellipsis}\n\n" - - actual = @to.convert rdoc - - assert_equal 4, @to.characters - assert_equal expected, actual - end - - def test_convert_limit_verbatim - rdoc = <<-RDOC -= Hello There - -This is some text, it *will* be cut off after 100 characters - - This one is cut off in this verbatim section - RDOC - - expected = <<-EXPECTED -<p>Hello There -<p>This is some text, it <strong>will</strong> be cut off after 100 characters - -<pre>This one is cut off in this verbatim ...</pre> - EXPECTED - - actual = @to.convert rdoc - - assert_equal expected, actual - assert_equal 113, @to.characters - end - - def test_convert_limit_verbatim_2 - rdoc = <<-RDOC -Extracts the class, selector and method name parts from +name+ like -Foo::Bar#baz. - -NOTE: Given Foo::Bar, Bar is considered a class even though it may be a - method - RDOC - - expected = <<-EXPECTED -<p>Extracts the class, selector and method name parts from <code>name</code> like Foo::Bar#baz. -<p>NOTE: Given Foo::Bar, #{@ellipsis} - EXPECTED - - actual = @to.convert rdoc - - assert_equal expected, actual - assert_equal 101, @to.characters - end - - def test_convert_limit_verbatim_multiline - rdoc = <<-RDOC -Look for directives in a normal comment block: - - # :stopdoc: - # Don't display comment from this point forward - -This routine modifies its +comment+ parameter. - RDOC - - inner = CGI.escapeHTML "# Don't display comment from this point forward" - expected = <<-EXPECTED -<p>Look for directives in a normal comment block: - -<pre class=\"ruby\"><span class=\"ruby-comment\"># :stopdoc:</span> -<span class=\"ruby-comment\">#{inner}</span> -</pre> - EXPECTED - - actual = @to.convert rdoc - - assert_equal expected, actual - assert_equal 105, @to.characters - end - - def test_convert_limit_over - @to = RDoc::Markup::ToHtmlSnippet.new @options, 4 - rdoc = "* text\n" * 2 - - expected = "<p>text\n" - expected = expected.chomp - expected << " #{@ellipsis}\n" - - actual = @to.convert rdoc - - assert_equal 4, @to.characters - assert_equal expected, actual - end - - def test_convert_string - assert_equal '<>', @to.convert_string('<>') - end - - def test_convert_RDOCLINK_label_label - result = @to.convert 'rdoc-label:label-One' - - assert_equal "<p>One\n", result - assert_equal 3, @to.characters - end - - def test_convert_RDOCLINK_label_foottext - result = @to.convert 'rdoc-label:foottext-1' - - assert_equal "<p>1\n", result - assert_equal 1, @to.characters - end - - def test_convert_RDOCLINK_label_footmark - result = @to.convert 'rdoc-label:footmark-1' - - assert_equal "<p>1\n", result - assert_equal 1, @to.characters - end - - def test_convert_RDOCLINK_ref - result = @to.convert 'rdoc-ref:C' - - assert_equal "<p>C\n", result - assert_equal 1, @to.characters - end - - def test_convert_TIDYLINK_rdoc_label - result = @to.convert '{foo}[rdoc-label:foottext-1]' - - assert_equal "<p>foo\n", result - assert_equal 3, @to.characters - end - - def test_handle_regexp_HYPERLINK_link - target = RDoc::Markup::RegexpHandling.new 0, 'link:README.txt' - - link = @to.handle_regexp_HYPERLINK target - - assert_equal 'README.txt', link - end - - def test_list_verbatim_2 - str = "* one\n verb1\n verb2\n* two\n" - - expected = <<-EXPECTED -<p>one - -<pre class=\"ruby\"><span class=\"ruby-identifier\">verb1</span> -<span class=\"ruby-identifier\">verb2</span> -</pre> -<p>two - - EXPECTED - - assert_equal expected, @m.convert(str, @to) - assert_equal 17, @to.characters - end - - def test_on_tags - on = RDoc::Markup::AttrChanger.new 2, 0 - - @to.on_tags [], on - - assert_equal 2, @to.mask - end - - def test_off_tags - on = RDoc::Markup::AttrChanger.new 2, 0 - off = RDoc::Markup::AttrChanger.new 0, 2 - - @to.on_tags [], on - @to.off_tags [], off - - assert_equal 0, @to.mask - end - - def test_to_html - assert_equal "<p><code>--</code>\n", util_format("<tt>--</tt>") - assert_equal 2, @to.characters - end - - def util_format text - paragraph = RDoc::Markup::Paragraph.new text - - @to.start_accepting - @to.accept_paragraph paragraph - @to.end_accepting - end - -end |