RubyGems - rdoc - Versions diffs - 4.2.1 → 6.3.1 - Mend

rdoc 4.2.1 → 6.3.1

Potentially problematic release.

This version of rdoc might be problematic. Click here for more details.

Files changed (277) hide show

checksums.yaml +5 -5
data/CONTRIBUTING.rdoc +8 -7
data/Gemfile +12 -0
data/History.rdoc +48 -4
data/LEGAL.rdoc +2 -2
data/README.rdoc +5 -5
data/Rakefile +73 -155
data/bin/console +7 -0
data/bin/setup +6 -0
data/{bin → exe}/rdoc +0 -0
data/{bin → exe}/ri +0 -0
data/lib/rdoc/alias.rb +1 -0
data/lib/rdoc/anon_class.rb +1 -0
data/lib/rdoc/any_method.rb +59 -14
data/lib/rdoc/attr.rb +1 -0
data/lib/rdoc/class_module.rb +5 -2
data/lib/rdoc/code_object.rb +3 -11
data/lib/rdoc/code_objects.rb +1 -0
data/lib/rdoc/comment.rb +32 -11
data/lib/rdoc/constant.rb +3 -2
data/lib/rdoc/context/section.rb +7 -13
data/lib/rdoc/context.rb +78 -23
data/lib/rdoc/cross_reference.rb +33 -14
data/lib/rdoc/encoding.rb +92 -55
data/lib/rdoc/erb_partial.rb +2 -1
data/lib/rdoc/erbio.rb +8 -3
data/lib/rdoc/extend.rb +1 -0
data/lib/rdoc/generator/darkfish.rb +62 -32
data/lib/rdoc/generator/json_index.rb +8 -5
data/lib/rdoc/generator/markup.rb +3 -12
data/lib/rdoc/generator/pot/message_extractor.rb +68 -0
data/lib/rdoc/generator/pot/po.rb +84 -0
data/lib/rdoc/generator/pot/po_entry.rb +141 -0
data/lib/rdoc/generator/pot.rb +4 -3
data/lib/rdoc/generator/ri.rb +1 -0
data/lib/rdoc/generator/template/darkfish/_footer.rhtml +2 -2
data/lib/rdoc/generator/template/darkfish/_head.rhtml +11 -8
data/lib/rdoc/generator/template/darkfish/_sidebar_VCS_info.rhtml +2 -2
data/lib/rdoc/generator/template/darkfish/_sidebar_classes.rhtml +2 -2
data/lib/rdoc/generator/template/darkfish/_sidebar_extends.rhtml +7 -7
data/lib/rdoc/generator/template/darkfish/_sidebar_in_files.rhtml +2 -2
data/lib/rdoc/generator/template/darkfish/_sidebar_includes.rhtml +7 -7
data/lib/rdoc/generator/template/darkfish/_sidebar_installed.rhtml +6 -6
data/lib/rdoc/generator/template/darkfish/_sidebar_methods.rhtml +5 -5
data/lib/rdoc/generator/template/darkfish/_sidebar_pages.rhtml +5 -5
data/lib/rdoc/generator/template/darkfish/_sidebar_parent.rhtml +5 -5
data/lib/rdoc/generator/template/darkfish/_sidebar_sections.rhtml +4 -4
data/lib/rdoc/generator/template/darkfish/_sidebar_table_of_contents.rhtml +4 -4
data/lib/rdoc/generator/template/darkfish/class.rhtml +45 -47
data/lib/rdoc/generator/template/darkfish/css/fonts.css +6 -6
data/lib/rdoc/generator/template/darkfish/css/rdoc.css +55 -6
data/lib/rdoc/generator/template/darkfish/index.rhtml +3 -4
data/lib/rdoc/generator/template/darkfish/js/darkfish.js +23 -100
data/lib/rdoc/generator/template/darkfish/js/search.js +32 -31
data/lib/rdoc/generator/template/darkfish/servlet_root.rhtml +15 -16
data/lib/rdoc/generator/template/darkfish/table_of_contents.rhtml +16 -16
data/lib/rdoc/generator/template/json_index/js/navigation.js +4 -41
data/lib/rdoc/generator/template/json_index/js/searcher.js +7 -6
data/lib/rdoc/generator.rb +1 -1
data/lib/rdoc/ghost_method.rb +1 -0
data/lib/rdoc/i18n/locale.rb +2 -1
data/lib/rdoc/i18n/text.rb +5 -4
data/lib/rdoc/i18n.rb +3 -2
data/lib/rdoc/include.rb +1 -0
data/lib/rdoc/known_classes.rb +1 -0
data/lib/rdoc/markdown/entities.rb +1 -0
data/lib/rdoc/markdown/{literals_1_9.kpeg → literals.kpeg} +1 -0
data/lib/rdoc/markdown/{literals_1_9.rb → literals.rb} +1 -4
data/lib/rdoc/markdown.kpeg +94 -51
data/lib/rdoc/markdown.rb +1171 -619
data/lib/rdoc/markup/attr_changer.rb +1 -0
data/lib/rdoc/markup/attr_span.rb +9 -2
data/lib/rdoc/markup/attribute_manager.rb +115 -49
data/lib/rdoc/markup/attributes.rb +7 -6
data/lib/rdoc/markup/blank_line.rb +1 -0
data/lib/rdoc/markup/block_quote.rb +1 -0
data/lib/rdoc/markup/document.rb +1 -0
data/lib/rdoc/markup/formatter.rb +25 -23
data/lib/rdoc/markup/hard_break.rb +1 -0
data/lib/rdoc/markup/heading.rb +4 -3
data/lib/rdoc/markup/include.rb +1 -0
data/lib/rdoc/markup/indented_paragraph.rb +1 -0
data/lib/rdoc/markup/list.rb +1 -0
data/lib/rdoc/markup/list_item.rb +1 -0
data/lib/rdoc/markup/paragraph.rb +1 -0
data/lib/rdoc/markup/parser.rb +78 -61
data/lib/rdoc/markup/pre_process.rb +12 -9
data/lib/rdoc/markup/raw.rb +1 -0
data/lib/rdoc/markup/regexp_handling.rb +41 -0
data/lib/rdoc/markup/rule.rb +1 -0
data/lib/rdoc/markup/to_ansi.rb +1 -0
data/lib/rdoc/markup/to_bs.rb +4 -5
data/lib/rdoc/markup/to_html.rb +71 -25
data/lib/rdoc/markup/to_html_crossref.rb +41 -25
data/lib/rdoc/markup/to_html_snippet.rb +10 -9
data/lib/rdoc/markup/to_joined_paragraph.rb +7 -31
data/lib/rdoc/markup/to_label.rb +10 -9
data/lib/rdoc/markup/to_markdown.rb +9 -8
data/lib/rdoc/markup/to_rdoc.rb +35 -6
data/lib/rdoc/markup/to_table_of_contents.rb +2 -0
data/lib/rdoc/markup/to_test.rb +1 -0
data/lib/rdoc/markup/to_tt_only.rb +3 -2
data/lib/rdoc/markup/verbatim.rb +1 -0
data/lib/rdoc/markup.rb +14 -16
data/lib/rdoc/meta_method.rb +1 -0
data/lib/rdoc/method_attr.rb +2 -1
data/lib/rdoc/mixin.rb +1 -0
data/lib/rdoc/normal_class.rb +3 -2
data/lib/rdoc/normal_module.rb +1 -0
data/lib/rdoc/options.rb +92 -58
data/lib/rdoc/parser/c.rb +219 -223
data/lib/rdoc/parser/changelog.rb +155 -18
data/lib/rdoc/parser/markdown.rb +1 -0
data/lib/rdoc/parser/rd.rb +1 -0
data/lib/rdoc/parser/ripper_state_lex.rb +590 -0
data/lib/rdoc/parser/ruby.rb +635 -468
data/lib/rdoc/parser/ruby_tools.rb +33 -33
data/lib/rdoc/parser/simple.rb +3 -3
data/lib/rdoc/parser/text.rb +1 -0
data/lib/rdoc/parser.rb +17 -50
data/lib/rdoc/rd/block_parser.rb +66 -65
data/lib/rdoc/rd/block_parser.ry +3 -3
data/lib/rdoc/rd/inline.rb +5 -4
data/lib/rdoc/rd/inline_parser.rb +52 -51
data/lib/rdoc/rd/inline_parser.ry +1 -1
data/lib/rdoc/rd.rb +1 -0
data/lib/rdoc/rdoc.rb +68 -63
data/lib/rdoc/require.rb +1 -0
data/lib/rdoc/ri/driver.rb +133 -58
data/lib/rdoc/ri/formatter.rb +1 -0
data/lib/rdoc/ri/paths.rb +4 -20
data/lib/rdoc/ri/store.rb +1 -0
data/lib/rdoc/ri/task.rb +71 -0
data/lib/rdoc/ri.rb +1 -0
data/lib/rdoc/rubygems_hook.rb +5 -12
data/lib/rdoc/servlet.rb +24 -14
data/lib/rdoc/single_class.rb +1 -0
data/lib/rdoc/stats/normal.rb +20 -21
data/lib/rdoc/stats/quiet.rb +1 -0
data/lib/rdoc/stats/verbose.rb +1 -0
data/lib/rdoc/stats.rb +1 -0
data/lib/rdoc/store.rb +41 -41
data/lib/rdoc/task.rb +2 -3
data/lib/rdoc/text.rb +19 -38
data/lib/rdoc/token_stream.rb +56 -32
data/lib/rdoc/tom_doc.rb +17 -11
data/lib/rdoc/top_level.rb +9 -2
data/lib/rdoc/version.rb +8 -0
data/lib/rdoc.rb +24 -10
data/man/ri.1 +247 -0
data/rdoc.gemspec +248 -0
metadata +43 -236
data/.autotest +0 -24
data/.document +0 -5
data/Manifest.txt +0 -306
data/lib/gauntlet_rdoc.rb +0 -84
data/lib/rdoc/generator/template/darkfish/js/jquery.js +0 -4
data/lib/rdoc/markdown/literals_1_8.kpeg +0 -18
data/lib/rdoc/markdown/literals_1_8.rb +0 -416
data/lib/rdoc/markup/formatter_test_case.rb +0 -767
data/lib/rdoc/markup/inline.rb +0 -1
data/lib/rdoc/markup/special.rb +0 -40
data/lib/rdoc/markup/text_formatter_test_case.rb +0 -114
data/lib/rdoc/ruby_lex.rb +0 -1377
data/lib/rdoc/ruby_token.rb +0 -460
data/lib/rdoc/test_case.rb +0 -217
data/test/MarkdownTest_1.0.3/Amps and angle encoding.text +0 -21
data/test/MarkdownTest_1.0.3/Auto links.text +0 -13
data/test/MarkdownTest_1.0.3/Backslash escapes.text +0 -120
data/test/MarkdownTest_1.0.3/Blockquotes with code blocks.text +0 -11
data/test/MarkdownTest_1.0.3/Code Blocks.text +0 -14
data/test/MarkdownTest_1.0.3/Code Spans.text +0 -6
data/test/MarkdownTest_1.0.3/Hard-wrapped paragraphs with list-like lines.text +0 -8
data/test/MarkdownTest_1.0.3/Horizontal rules.text +0 -67
data/test/MarkdownTest_1.0.3/Inline HTML (Advanced).text +0 -15
data/test/MarkdownTest_1.0.3/Inline HTML (Simple).text +0 -69
data/test/MarkdownTest_1.0.3/Inline HTML comments.text +0 -13
data/test/MarkdownTest_1.0.3/Links, inline style.text +0 -12
data/test/MarkdownTest_1.0.3/Links, reference style.text +0 -71
data/test/MarkdownTest_1.0.3/Links, shortcut references.text +0 -20
data/test/MarkdownTest_1.0.3/Literal quotes in titles.text +0 -7
data/test/MarkdownTest_1.0.3/Markdown Documentation - Basics.text +0 -306
data/test/MarkdownTest_1.0.3/Markdown Documentation - Syntax.text +0 -888
data/test/MarkdownTest_1.0.3/Nested blockquotes.text +0 -5
data/test/MarkdownTest_1.0.3/Ordered and unordered lists.text +0 -131
data/test/MarkdownTest_1.0.3/Strong and em together.text +0 -7
data/test/MarkdownTest_1.0.3/Tabs.text +0 -21
data/test/MarkdownTest_1.0.3/Tidyness.text +0 -5
data/test/README +0 -1
data/test/binary.dat +0 -0
data/test/hidden.zip.txt +0 -1
data/test/test.ja.largedoc +0 -3
data/test/test.ja.rdoc +0 -10
data/test/test.ja.txt +0 -8
data/test/test.txt +0 -1
data/test/test_rdoc_alias.rb +0 -13
data/test/test_rdoc_any_method.rb +0 -460
data/test/test_rdoc_attr.rb +0 -190
data/test/test_rdoc_class_module.rb +0 -1492
data/test/test_rdoc_code_object.rb +0 -450
data/test/test_rdoc_comment.rb +0 -504
data/test/test_rdoc_constant.rb +0 -181
data/test/test_rdoc_context.rb +0 -901
data/test/test_rdoc_context_section.rb +0 -130
data/test/test_rdoc_cross_reference.rb +0 -192
data/test/test_rdoc_encoding.rb +0 -227
data/test/test_rdoc_extend.rb +0 -94
data/test/test_rdoc_generator_darkfish.rb +0 -229
data/test/test_rdoc_generator_json_index.rb +0 -324
data/test/test_rdoc_generator_markup.rb +0 -59
data/test/test_rdoc_generator_pot.rb +0 -91
data/test/test_rdoc_generator_pot_po.rb +0 -51
data/test/test_rdoc_generator_pot_po_entry.rb +0 -139
data/test/test_rdoc_generator_ri.rb +0 -78
data/test/test_rdoc_i18n_locale.rb +0 -73
data/test/test_rdoc_i18n_text.rb +0 -123
data/test/test_rdoc_include.rb +0 -108
data/test/test_rdoc_markdown.rb +0 -980
data/test/test_rdoc_markdown_test.rb +0 -1884
data/test/test_rdoc_markup.rb +0 -95
data/test/test_rdoc_markup_attribute_manager.rb +0 -364
data/test/test_rdoc_markup_attributes.rb +0 -39
data/test/test_rdoc_markup_document.rb +0 -207
data/test/test_rdoc_markup_formatter.rb +0 -175
data/test/test_rdoc_markup_hard_break.rb +0 -31
data/test/test_rdoc_markup_heading.rb +0 -29
data/test/test_rdoc_markup_include.rb +0 -19
data/test/test_rdoc_markup_indented_paragraph.rb +0 -53
data/test/test_rdoc_markup_paragraph.rb +0 -32
data/test/test_rdoc_markup_parser.rb +0 -1680
data/test/test_rdoc_markup_pre_process.rb +0 -473
data/test/test_rdoc_markup_raw.rb +0 -22
data/test/test_rdoc_markup_to_ansi.rb +0 -369
data/test/test_rdoc_markup_to_bs.rb +0 -366
data/test/test_rdoc_markup_to_html.rb +0 -662
data/test/test_rdoc_markup_to_html_crossref.rb +0 -225
data/test/test_rdoc_markup_to_html_snippet.rb +0 -711
data/test/test_rdoc_markup_to_joined_paragraph.rb +0 -32
data/test/test_rdoc_markup_to_label.rb +0 -112
data/test/test_rdoc_markup_to_markdown.rb +0 -389
data/test/test_rdoc_markup_to_rdoc.rb +0 -377
data/test/test_rdoc_markup_to_table_of_contents.rb +0 -126
data/test/test_rdoc_markup_to_tt_only.rb +0 -246
data/test/test_rdoc_markup_verbatim.rb +0 -29
data/test/test_rdoc_method_attr.rb +0 -193
data/test/test_rdoc_normal_class.rb +0 -47
data/test/test_rdoc_normal_module.rb +0 -42
data/test/test_rdoc_options.rb +0 -766
data/test/test_rdoc_parser.rb +0 -327
data/test/test_rdoc_parser_c.rb +0 -1896
data/test/test_rdoc_parser_changelog.rb +0 -315
data/test/test_rdoc_parser_markdown.rb +0 -61
data/test/test_rdoc_parser_rd.rb +0 -55
data/test/test_rdoc_parser_ruby.rb +0 -3322
data/test/test_rdoc_parser_simple.rb +0 -115
data/test/test_rdoc_rd.rb +0 -30
data/test/test_rdoc_rd_block_parser.rb +0 -535
data/test/test_rdoc_rd_inline.rb +0 -63
data/test/test_rdoc_rd_inline_parser.rb +0 -177
data/test/test_rdoc_rdoc.rb +0 -455
data/test/test_rdoc_require.rb +0 -25
data/test/test_rdoc_ri_driver.rb +0 -1436
data/test/test_rdoc_ri_paths.rb +0 -155
data/test/test_rdoc_ruby_lex.rb +0 -421
data/test/test_rdoc_ruby_token.rb +0 -19
data/test/test_rdoc_rubygems_hook.rb +0 -251
data/test/test_rdoc_servlet.rb +0 -534
data/test/test_rdoc_single_class.rb +0 -20
data/test/test_rdoc_stats.rb +0 -722
data/test/test_rdoc_store.rb +0 -993
data/test/test_rdoc_task.rb +0 -173
data/test/test_rdoc_text.rb +0 -557
data/test/test_rdoc_token_stream.rb +0 -42
data/test/test_rdoc_tom_doc.rb +0 -520
data/test/test_rdoc_top_level.rb +0 -287
data/test/xref_data.rb +0 -76
data/test/xref_test_case.rb +0 -67

data/test/test_rdoc_rubygems_hook.rb DELETED Viewed

@@ -1,251 +0,0 @@
-require 'rubygems'
-require 'rubygems/test_case'
-require 'rdoc/rubygems_hook'
-class TestRDocRubygemsHook < Gem::TestCase
-  def setup
-    super
-    skip 'requires RubyGems 1.9+' unless
-      Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.9')
-    @a = util_spec 'a', 2 do |s|
-      s.rdoc_options = %w[--main MyTitle]
-      s.extra_rdoc_files = %w[README]
-    end
-    write_file File.join(@tempdir, 'lib', 'a.rb')
-    write_file File.join(@tempdir, 'README')
-    install_gem @a
-    @hook = RDoc::RubygemsHook.new @a
-    begin
-      RDoc::RubygemsHook.load_rdoc
-    rescue Gem::DocumentError => e
-      skip e.message
-    end
-    Gem.configuration[:rdoc] = nil
-  end
-  def test_initialize
-    refute @hook.generate_rdoc
-    assert @hook.generate_ri
-    rdoc = RDoc::RubygemsHook.new @a, false, false
-    refute rdoc.generate_rdoc
-    refute rdoc.generate_ri
-  end
-  def test_delete_legacy_args
-    args = %w[
-      --inline-source
-      --one-file
-      --promiscuous
-      -p
-    ]
-    @hook.delete_legacy_args args
-    assert_empty args
-  end
-  def test_document
-    options = RDoc::Options.new
-    options.files = []
-    rdoc = @hook.new_rdoc
-    rdoc.store = RDoc::Store.new
-    @hook.instance_variable_set :@rdoc, rdoc
-    @hook.instance_variable_set :@file_info, []
-    @hook.document 'darkfish', options, @a.doc_dir('rdoc')
-    assert @hook.rdoc_installed?
-  end
-  def test_generate
-    FileUtils.mkdir_p @a.doc_dir
-    FileUtils.mkdir_p File.join(@a.gem_dir, 'lib')
-    @hook.generate
-    refute @hook.rdoc_installed?
-    assert @hook.ri_installed?
-    rdoc = @hook.instance_variable_get :@rdoc
-    refute rdoc.options.hyperlink_all
-    assert_equal Pathname(@a.full_gem_path), rdoc.options.root
-    assert_equal %w[README lib], rdoc.options.files.sort
-    assert_equal 'MyTitle', rdoc.store.main
-  end
-  def test_generate_all
-    @hook.generate_rdoc = true
-    @hook.generate_ri   = true
-    FileUtils.mkdir_p @a.doc_dir
-    FileUtils.mkdir_p File.join(@a.gem_dir, 'lib')
-    @hook.generate
-    assert @hook.rdoc_installed?
-    assert @hook.ri_installed?
-    rdoc = @hook.instance_variable_get :@rdoc
-    refute rdoc.options.hyperlink_all
-    assert_equal Pathname(@a.full_gem_path), rdoc.options.root
-    assert_equal %w[README lib], rdoc.options.files.sort
-    assert_equal 'MyTitle', rdoc.store.main
-  end
-  def test_generate_configuration_rdoc_array
-    Gem.configuration[:rdoc] = %w[-A]
-    FileUtils.mkdir_p @a.doc_dir
-    FileUtils.mkdir_p File.join(@a.gem_dir, 'lib')
-    @hook.generate
-    rdoc = @hook.instance_variable_get :@rdoc
-    assert rdoc.options.hyperlink_all
-  end
-  def test_generate_configuration_rdoc_string
-    Gem.configuration[:rdoc] = '-A'
-    FileUtils.mkdir_p @a.doc_dir
-    FileUtils.mkdir_p File.join(@a.gem_dir, 'lib')
-    @hook.generate
-    rdoc = @hook.instance_variable_get :@rdoc
-    assert rdoc.options.hyperlink_all
-  end
-  def test_generate_default_gem
-    skip 'RubyGems 2 required' unless @a.respond_to? :default_gem?
-    @a.loaded_from =
-      File.join Gem::Specification.default_specifications_dir, 'a.gemspec'
-    @hook.generate
-    refute @hook.rdoc_installed?
-    refute @hook.ri_installed?
-  end
-  def test_generate_disabled
-    @hook.generate_rdoc = false
-    @hook.generate_ri   = false
-    @hook.generate
-    refute @hook.rdoc_installed?
-    refute @hook.ri_installed?
-  end
-  def test_generate_force
-    FileUtils.mkdir_p @a.doc_dir 'ri'
-    FileUtils.mkdir_p @a.doc_dir 'rdoc'
-    FileUtils.mkdir_p File.join(@a.gem_dir, 'lib')
-    @hook.force = true
-    @hook.generate
-    refute_path_exists File.join(@a.doc_dir('rdoc'), 'index.html')
-    assert_path_exists File.join(@a.doc_dir('ri'),   'cache.ri')
-  end
-  def test_generate_no_overwrite
-    FileUtils.mkdir_p @a.doc_dir 'ri'
-    FileUtils.mkdir_p @a.doc_dir 'rdoc'
-    FileUtils.mkdir_p File.join(@a.gem_dir, 'lib')
-    @hook.generate
-    refute_path_exists File.join(@a.doc_dir('rdoc'), 'index.html')
-    refute_path_exists File.join(@a.doc_dir('ri'),   'cache.ri')
-  end
-  def test_new_rdoc
-    assert_kind_of RDoc::RDoc, @hook.new_rdoc
-  end
-  def test_rdoc_installed?
-    refute @hook.rdoc_installed?
-    FileUtils.mkdir_p @a.doc_dir 'rdoc'
-    assert @hook.rdoc_installed?
-  end
-  def test_remove
-    FileUtils.mkdir_p @a.doc_dir 'rdoc'
-    FileUtils.mkdir_p @a.doc_dir 'ri'
-    @hook.remove
-    refute @hook.rdoc_installed?
-    refute @hook.ri_installed?
-    assert_path_exists @a.doc_dir
-  end
-  def test_remove_unwritable
-    skip 'chmod not supported' if Gem.win_platform?
-    FileUtils.mkdir_p @a.base_dir
-    FileUtils.chmod 0, @a.base_dir
-    e = assert_raises Gem::FilePermissionError do
-      @hook.remove
-    end
-    assert_equal @a.base_dir, e.directory
-  ensure
-    FileUtils.chmod(0755, @a.base_dir) if File.directory?(@a.base_dir)
-  end
-  def test_ri_installed?
-    refute @hook.ri_installed?
-    FileUtils.mkdir_p @a.doc_dir 'ri'
-    assert @hook.ri_installed?
-  end
-  def test_setup
-    @hook.setup
-    assert_path_exists @a.doc_dir
-  end
-  def test_setup_unwritable
-    skip 'chmod not supported' if Gem.win_platform?
-    FileUtils.mkdir_p @a.doc_dir
-    FileUtils.chmod 0, @a.doc_dir
-    e = assert_raises Gem::FilePermissionError do
-      @hook.setup
-    end
-    assert_equal @a.doc_dir, e.directory
-  ensure
-    if File.exist? @a.doc_dir
-      FileUtils.chmod 0755, @a.doc_dir
-      FileUtils.rm_r @a.doc_dir
-    end
-  end
-end