rdoc 4.0.0.preview2.1 → 4.0.0.rc.2

data/test/test_rdoc_rd_inline_parser.rb

@@ -26,7 +26,8 @@ class TestRDocRdInlineParser < RDoc::TestCase
     assert_equal '{*1}[rdoc-label:foottext-1:footmark-1]', parse('((-text-))')
 
     expected = [
-      @RM::Paragraph.new('{^1}[rdoc-label:footmark-1:foottext-1]', 'text')
+      @RM::Paragraph.new('{^1}[rdoc-label:footmark-1:foottext-1]', ' ', 'text'),
+      blank_line,
     ]
 
     assert_equal expected, @block_parser.footnotes
@@ -161,6 +162,10 @@ class TestRDocRdInlineParser < RDoc::TestCase
     assert_equal '<tt>text "</tt>', parse("(('text \\\"'))")
   end
 
+  def test_parse_verb_emphasis
+    assert_equal '<tt>((*emphasis*))</tt>', parse("(('((*emphasis*))'))")
+  end
+
   def test_parse_verb_multiple
     assert_equal '<tt>((*text*))</tt>', parse("(('((*text*))'))")
   end

data/test/test_rdoc_rdoc.rb

@@ -14,19 +14,22 @@ class TestRDocRDoc < RDoc::TestCase
 
   def test_document # functional test
     options = RDoc::Options.new
-    options.files = [File.expand_path('../xref_data.rb')]
+    options.files = [File.expand_path('../xref_data.rb', __FILE__)]
     options.setup_generator 'ri'
     options.main_page = 'MAIN_PAGE.rdoc'
+    options.root      = Pathname File.expand_path('..', __FILE__)
     options.title     = 'title'
 
     rdoc = RDoc::RDoc.new
 
     temp_dir do
+      options.op_dir = 'ri'
+
       capture_io do
         rdoc.document options
       end
 
-      assert File.directory? 'doc'
+      assert File.directory? 'ri'
       assert_equal rdoc, rdoc.store.rdoc
     end
 

data/test/test_rdoc_ruby_lex.rb

@@ -70,7 +70,8 @@ end
       @TK::TkIDENTIFIER.new( 4, 1,  4, 'x'),
       @TK::TkNL        .new( 5, 1,  5, "\n"),
       @TK::TkSPACE     .new( 6, 2,  0, '  '),
-      @TK::TkSTRING    .new( 8, 2,  2, %Q{"Line 1\nLine 2\n"}),
+      @TK::TkHEREDOC   .new( 8, 2,  2,
+                            %Q{<<E\nLine 1\nLine 2\nE}),
       @TK::TkNL        .new(27, 5, 28, "\n"),
       @TK::TkEND       .new(28, 6,  0, 'end'),
       @TK::TkNL        .new(31, 6, 28, "\n"),
@@ -96,12 +97,56 @@ end
     assert_equal expected, tokens
   end
 
+  def test_class_tokenize_heredoc_CR_NL
+    tokens = RDoc::RubyLex.tokenize <<-RUBY, nil
+string = <<-STRING\r
+Line 1\r
+Line 2\r
+  STRING\r
+    RUBY
+
+    expected = [
+      @TK::TkIDENTIFIER.new( 0, 1,  0, 'string'),
+      @TK::TkSPACE     .new( 6, 1,  6, ' '),
+      @TK::TkASSIGN    .new( 7, 1,  7, '='),
+      @TK::TkSPACE     .new( 8, 1,  8, ' '),
+      @TK::TkHEREDOC   .new( 9, 1,  9,
+                            %Q{<<-STRING\nLine 1\nLine 2\n  STRING}),
+      @TK::TkSPACE     .new(44, 4, 45, "\r"),
+      @TK::TkNL        .new(45, 4, 46, "\n"),
+    ]
+
+    assert_equal expected, tokens
+  end
+
+  def test_class_tokenize_heredoc_call
+    tokens = RDoc::RubyLex.tokenize <<-'RUBY', nil
+string = <<-STRING.chomp
+Line 1
+Line 2
+  STRING
+    RUBY
+
+    expected = [
+      @TK::TkIDENTIFIER.new( 0, 1,  0, 'string'),
+      @TK::TkSPACE     .new( 6, 1,  6, ' '),
+      @TK::TkASSIGN    .new( 7, 1,  7, '='),
+      @TK::TkSPACE     .new( 8, 1,  8, ' '),
+      @TK::TkSTRING    .new( 9, 1,  9, %Q{"Line 1\nLine 2\n"}),
+      @TK::TkDOT       .new(41, 4, 42, '.'),
+      @TK::TkIDENTIFIER.new(42, 4, 43, 'chomp'),
+      @TK::TkNL        .new(47, 4, 48, "\n"),
+    ]
+
+    assert_equal expected, tokens
+  end
+
   def test_class_tokenize_heredoc_indent
     tokens = RDoc::RubyLex.tokenize <<-'RUBY', nil
 string = <<-STRING
 Line 1
 Line 2
-STRING
+  STRING
     RUBY
 
     expected = [
@@ -109,8 +154,9 @@ STRING
       @TK::TkSPACE     .new( 6, 1,  6, ' '),
       @TK::TkASSIGN    .new( 7, 1,  7, '='),
       @TK::TkSPACE     .new( 8, 1,  8, ' '),
-      @TK::TkSTRING    .new( 9, 1,  9, %Q{"Line 1\nLine 2\n"}),
-      @TK::TkNL        .new(39, 4, 40, "\n"),
+      @TK::TkHEREDOC   .new( 9, 1,  9,
+                            %Q{<<-STRING\nLine 1\nLine 2\n  STRING}),
+      @TK::TkNL        .new(41, 4, 42, "\n"),
     ]
 
     assert_equal expected, tokens
@@ -128,7 +174,7 @@ U
       @TK::TkSPACE     .new( 1, 1,  1, ' '),
       @TK::TkIDENTIFIER.new( 2, 1,  2, 'b'),
       @TK::TkSPACE     .new( 3, 1,  3, ' '),
-      @TK::TkSTRING    .new( 4, 1,  4, %Q{"%N\n"}),
+      @TK::TkHEREDOC   .new( 4, 1,  4, %Q{<<-U\n%N\nU}),
       @TK::TkNL        .new(13, 3, 14, "\n"),
     ]
 

data/test/test_rdoc_servlet.rb

@@ -12,7 +12,7 @@ class TestRDocServlet < RDoc::TestCase
     Gem.ensure_gem_subdirectories @tempdir
 
     @spec = Gem::Specification.new 'spec', '1.0'
-    @spec.loaded_from = File.join @tempdir, @spec.spec_file
+    @spec.loaded_from = @spec.spec_file
 
     Gem::Specification.reset
     Gem::Specification.all = [@spec]
@@ -34,13 +34,15 @@ class TestRDocServlet < RDoc::TestCase
 
     @req.instance_variable_set :@header, Hash.new { |h, k| h[k] = [] }
 
-    @base       = File.join @tempdir, 'base'
-    @system_dir = File.join @tempdir, 'base', 'system'
+    @base        = File.join @tempdir, 'base'
+    @system_dir  = File.join @tempdir, 'base', 'system'
+    @home_dir    = File.join @tempdir, 'home'
+    @gem_doc_dir = File.join @tempdir, 'doc'
 
     @orig_base = RDoc::RI::Paths::BASE
     RDoc::RI::Paths::BASE.replace @base
     @orig_ri_path_homedir = RDoc::RI::Paths::HOMEDIR
-    RDoc::RI::Paths::HOMEDIR.replace File.join @tempdir, 'home'
+    RDoc::RI::Paths::HOMEDIR.replace @home_dir
 
     RDoc::RI::Paths.instance_variable_set \
       :@gemdirs, %w[/nonexistent/gems/example-1.0/ri]
@@ -363,7 +365,7 @@ class TestRDocServlet < RDoc::TestCase
           Ruby\ Documentation
         ],
         'info' => [
-          ['Ruby Documentation', '', @system_dir, '',
+          ['Ruby Documentation', '', 'ruby', '',
             'Documentation for the Ruby standard library'],
         ],
       }
@@ -416,6 +418,42 @@ class TestRDocServlet < RDoc::TestCase
     assert_match %r%\Avar search_data =%,  @res.body
   end
 
+  def test_store_for_gem
+    store = @s.store_for 'spec-1.0'
+
+    assert_equal File.join(@gem_doc_dir, 'spec-1.0', 'ri'), store.path
+    assert_equal :gem, store.type
+  end
+
+  def test_store_for_home
+    store = @s.store_for 'home'
+
+    assert_equal @home_dir, store.path
+    assert_equal :home, store.type
+  end
+
+  def test_store_for_missing
+    e = assert_raises RDoc::Error do
+      @s.store_for 'missing'
+    end
+
+    assert_equal 'could not find ri documentation for missing', e.message
+  end
+
+  def test_store_for_ruby
+    store = @s.store_for 'ruby'
+
+    assert_equal @system_dir, store.path
+    assert_equal :system, store.type
+  end
+
+  def test_store_for_site
+    store = @s.store_for 'site'
+
+    assert_equal File.join(@base, 'site'), store.path
+    assert_equal :site, store.type
+  end
+
   def touch_system_cache_path
     store = RDoc::Store.new @system_dir
     store.title = 'Standard Library Documentation'

data/test/test_rdoc_store.rb

@@ -274,6 +274,18 @@ class TestRDocStore < XrefTestCase
     assert_includes @s.c_enclosure_classes, 'cObject'
   end
 
+  def test_find_c_enclosure_from_cache_legacy
+    @klass.in_files.clear
+    @s.save_class @klass
+    @s.classes_hash.clear
+
+    assert_nil @s.find_c_enclosure 'cObject'
+
+    @s.c_enclosure_names['cObject'] = 'Object'
+
+    assert_nil @s.find_c_enclosure('cObject')
+  end
+
   def test_find_class_named
     assert_equal @c1, @store.find_class_named('C1')
 
@@ -766,6 +778,7 @@ class TestRDocStore < XrefTestCase
     @s.save_method @klass, @meth
     @s.save_method @klass, @meth_bang
     @s.save_method @klass, @cmeth
+    @s.save_method @klass, @attr
     @s.save_cache
 
     klass = RDoc::NormalClass.new 'Object'
@@ -787,11 +800,15 @@ class TestRDocStore < XrefTestCase
 
     assert_cache({ 'Object' => %w[replace] }, {},
                  { 'Object' => %w[attr_accessor\ attr] }, %w[Object],
-                 'Object' => OBJECT_ANCESTORS)
+                   'Object' => OBJECT_ANCESTORS)
 
-    refute File.exist? @s.method_file(@klass.full_name, @meth.full_name)
-    refute File.exist? @s.method_file(@klass.full_name, @meth_bang.full_name)
-    refute File.exist? @s.method_file(@klass.full_name, @cmeth.full_name)
+    # assert these files were deleted
+    refute_file @s.method_file(@klass.full_name, @meth.full_name)
+    refute_file @s.method_file(@klass.full_name, @meth_bang.full_name)
+    refute_file @s.method_file(@klass.full_name, @cmeth.full_name)
+
+    # assert these files were not deleted
+    assert_file @s.method_file(@klass.full_name, @attr.full_name)
   end
 
   def test_save_class_dry_run
@@ -803,6 +820,40 @@ class TestRDocStore < XrefTestCase
     refute_file File.join(@tmpdir, 'Object', 'cdesc-Object.ri')
   end
 
+  def test_save_class_loaded
+    @s.save
+
+    assert_directory File.join(@tmpdir, 'Object')
+    assert_file      File.join(@tmpdir, 'Object', 'cdesc-Object.ri')
+
+    assert_file @s.method_file(@klass.full_name, @attr.full_name)
+    assert_file @s.method_file(@klass.full_name, @cmeth.full_name)
+    assert_file @s.method_file(@klass.full_name, @meth.full_name)
+    assert_file @s.method_file(@klass.full_name, @meth_bang.full_name)
+
+    s = RDoc::Store.new @s.path
+    s.load_cache
+
+    loaded = s.load_class 'Object'
+
+    assert_equal @klass, loaded
+
+    s.save_class loaded
+
+    s = RDoc::Store.new @s.path
+    s.load_cache
+
+    reloaded = s.load_class 'Object'
+
+    assert_equal @klass, reloaded
+
+    # assert these files were not deleted.  Bug #171
+    assert_file s.method_file(@klass.full_name, @attr.full_name)
+    assert_file s.method_file(@klass.full_name, @cmeth.full_name)
+    assert_file s.method_file(@klass.full_name, @meth.full_name)
+    assert_file s.method_file(@klass.full_name, @meth_bang.full_name)
+  end
+
   def test_save_class_merge
     @s.save_class @klass
 

data/test/test_rdoc_tom_doc.rb

@@ -156,6 +156,24 @@ description - arguments description
     assert_equal expected, @TD.parse(text)
   end
 
+  def test_parse_arguments_array
+    text = <<-TEXT
+Create new Arg object.
+
+names[] - names of arguments
+    TEXT
+
+    expected =
+      doc(
+        para('Create new Arg object.'),
+        blank_line,
+        list(:NOTE,
+          item(%w[names[]],
+            para('names of arguments'))))
+
+    assert_equal expected, @TD.parse(text)
+  end
+
   def test_parse_arguments_multiline
     text = <<-TEXT
 Do some stuff
@@ -343,6 +361,25 @@ description - arguments description
     assert_equal expected, @td.tokens
   end
 
+  def test_tokenize_arguments_array
+    @td.tokenize <<-TEXT
+Create new Arg object.
+
+names[stuff] - names of arguments
+    TEXT
+
+    expected = [
+      [:TEXT,    "Create new Arg object.",  0, 0],
+      [:NEWLINE, "\n",                     22, 0],
+      [:NEWLINE, "\n",                      0, 1],
+      [:NOTE,    "names[stuff]",            0, 2],
+      [:TEXT,    "names of arguments",     15, 2],
+      [:NEWLINE, "\n",                     33, 2],
+    ]
+
+    assert_equal expected, @td.tokens
+  end
+
   def test_tokenize_arguments_multiline
     @td.tokenize <<-TEXT
 Do some stuff

data/test/test_rdoc_top_level.rb

@@ -205,6 +205,8 @@ class TestRDocTopLevel < XrefTestCase
     assert_equal RDoc::Parser::Simple, loaded.parser
 
     assert_equal comment, loaded.comment
+
+    assert loaded.display?
   end
 
   def test_name
@@ -214,7 +216,7 @@ class TestRDocTopLevel < XrefTestCase
   def test_page_name
     assert_equal 'top_level', @top_level.page_name
 
-    tl = @store.add_file 'README.ja.rdoc'
+    tl = @store.add_file 'README.ja'
 
     assert_equal 'README.ja', tl.page_name
 
@@ -223,6 +225,20 @@ class TestRDocTopLevel < XrefTestCase
     assert_equal 'Rakefile', tl.page_name
   end
 
+  def test_page_name_trim_extension
+    tl = @store.add_file 'README.ja.rdoc'
+
+    assert_equal 'README.ja', tl.page_name
+
+    tl = @store.add_file 'README.ja.md'
+
+    assert_equal 'README.ja', tl.page_name
+
+    tl = @store.add_file 'README.txt'
+
+    assert_equal 'README', tl.page_name
+  end
+
   def test_search_record
     assert_nil @xref_data.search_record
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rdoc
 version: !ruby/object:Gem::Version
-  version: 4.0.0.preview2.1
+  version: 4.0.0.rc.2
 platform: ruby
 authors:
 - Eric Hodel
@@ -11,37 +11,29 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain:
-- !binary |-
-  LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tCk1JSURlRENDQW1DZ0F3SUJB
-  Z0lCQVRBTkJna3Foa2lHOXcwQkFRVUZBREJCTVJBd0RnWURWUVFEREFka2Nt
-  SnkKWVdsdU1SZ3dGZ1lLQ1pJbWlaUHlMR1FCR1JZSWMyVm5iV1Z1ZERjeEV6
-  QVJCZ29Ka2lhSmsvSXNaQUVaRmdOdQpaWFF3SGhjTk1USXdNakk0TVRjMU5E
-  STFXaGNOTVRNd01qSTNNVGMxTkRJMVdqQkJNUkF3RGdZRFZRUUREQWRrCmNt
-  SnlZV2x1TVJnd0ZnWUtDWkltaVpQeUxHUUJHUllJYzJWbmJXVnVkRGN4RXpB
-  UkJnb0praWFKay9Jc1pBRVoKRmdOdVpYUXdnZ0VpTUEwR0NTcUdTSWIzRFFF
-  QkFRVUFBNElCRHdBd2dnRUtBb0lCQVFDYmJnTHJHTEdJREU3NgpMVi9jdnhk
-  RXpDdVl1UzNvRzlQclNabnVEd2V5U1VmZHAvc28wY0RxK2o4YnF5Nk96WlN3
-  MDdnZGp3Rk1TZDZKClU1ZGRaQ1Z5d241bm5BUStVaTdqTVc1NENZdDUvSDZm
-  MlVTNlUwaFFPakpSNmNwZml5bWd4R2RmeVRpVmN2VG0KR2ovb2tXclFsME5q
-  WU9ZQnBEaSs5UFBtYUgyUm1MSnUwZEIvTnlsc0RuVzVqNnlOMUJFSThNZkpS
-  UitIUktaWQptVXRnekJ3RjFWNEtJWlE4RXVMNkkvbkhWdTA3aTZJa3JwQWd4
-  cFhVZmRKUUppMG9aQXFYdXJBVjN5VHhrRndkCmc2MllyclcyNm1EZStwWkJ6
-  UjZicExFK1BtWEN6ejdVeFVxM0FFMGdQSGJpTVhpZTNFRkUwb3huc1UzbElk
-  dWgKc0NBTmlROEJBZ01CQUFHamV6QjVNQWtHQTFVZEV3UUNNQUF3Q3dZRFZS
-  MFBCQVFEQWdTd01CMEdBMVVkRGdRVwpCQlM1azRaNzVWU3BkTTBBY2xHMlV2
-  ekZBL1ZXNURBZkJnTlZIUkVFR0RBV2dSUmtjbUp5WVdsdVFITmxaMjFsCmJu
-  UTNMbTVsZERBZkJnTlZIUklFR0RBV2dSUmtjbUp5WVdsdVFITmxaMjFsYm5R
-  M0xtNWxkREFOQmdrcWhraUcKOXcwQkFRVUZBQU9DQVFFQVBlV3pGbnJjdkM2
-  ZVZ6ZGxobWpVdWIyczZxaWVCa29uZ0tSREhRejVNRWVRdjRMUwpTQVJub0hZ
-  K3VDQVZMLzF4R0FobXB6cVEzZkpHV0s5ZUJhY1cvZThFNUdGOXhRY1YzbUUx
-  YkEwV05haURsWDVqClUyYUkrWkdTYmxxdkhVQ3hLQkhSMXM3VU1Ic2J6MXNh
-  T21nZFJUeVB4MGp1SnM2OG9jYlVUZVlCTFd1OVY0S1AKemRHQUcySlhPMmdP
-  TmczYjR0WUR2cEJMYnJ5K0tPWDI3aUFKdWxVYUg5VGlUT1VMTDRJVEpWRnNL
-  MG1ZVnFtUgpROFRubzlTM2U0WEdHUDFaV2ZMclRXRUpiYXZGZmhHSHV0MmlN
-  UndmQzdzL1lJTEFITkFUb3BhSmRIOUROcGQxClU4MXpHSE1VQk92ei9WR1Q2
-  d0p3WUozZW1TMm5mQTJOT0hGZmdBPT0KLS0tLS1FTkQgQ0VSVElGSUNBVEUt
-  LS0tLQo=
-date: 2012-12-15 00:00:00.000000000 Z
+- |
+  -----BEGIN CERTIFICATE-----
+  MIIDeDCCAmCgAwIBAgIBATANBgkqhkiG9w0BAQUFADBBMRAwDgYDVQQDDAdkcmJy
+  YWluMRgwFgYKCZImiZPyLGQBGRYIc2VnbWVudDcxEzARBgoJkiaJk/IsZAEZFgNu
+  ZXQwHhcNMTIwMjI4MTc1NDI1WhcNMTMwMjI3MTc1NDI1WjBBMRAwDgYDVQQDDAdk
+  cmJyYWluMRgwFgYKCZImiZPyLGQBGRYIc2VnbWVudDcxEzARBgoJkiaJk/IsZAEZ
+  FgNuZXQwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQCbbgLrGLGIDE76
+  LV/cvxdEzCuYuS3oG9PrSZnuDweySUfdp/so0cDq+j8bqy6OzZSw07gdjwFMSd6J
+  U5ddZCVywn5nnAQ+Ui7jMW54CYt5/H6f2US6U0hQOjJR6cpfiymgxGdfyTiVcvTm
+  Gj/okWrQl0NjYOYBpDi+9PPmaH2RmLJu0dB/NylsDnW5j6yN1BEI8MfJRR+HRKZY
+  mUtgzBwF1V4KIZQ8EuL6I/nHVu07i6IkrpAgxpXUfdJQJi0oZAqXurAV3yTxkFwd
+  g62YrrW26mDe+pZBzR6bpLE+PmXCzz7UxUq3AE0gPHbiMXie3EFE0oxnsU3lIduh
+  sCANiQ8BAgMBAAGjezB5MAkGA1UdEwQCMAAwCwYDVR0PBAQDAgSwMB0GA1UdDgQW
+  BBS5k4Z75VSpdM0AclG2UvzFA/VW5DAfBgNVHREEGDAWgRRkcmJyYWluQHNlZ21l
+  bnQ3Lm5ldDAfBgNVHRIEGDAWgRRkcmJyYWluQHNlZ21lbnQ3Lm5ldDANBgkqhkiG
+  9w0BAQUFAAOCAQEAPeWzFnrcvC6eVzdlhmjUub2s6qieBkongKRDHQz5MEeQv4LS
+  SARnoHY+uCAVL/1xGAhmpzqQ3fJGWK9eBacW/e8E5GF9xQcV3mE1bA0WNaiDlX5j
+  U2aI+ZGSblqvHUCxKBHR1s7UMHsbz1saOmgdRTyPx0juJs68ocbUTeYBLWu9V4KP
+  zdGAG2JXO2gONg3b4tYDvpBLbry+KOX27iAJulUaH9TiTOULL4ITJVFsK0mYVqmR
+  Q8Tno9S3e4XGGP1ZWfLrTWEJbavFfhGHut2iMRwfC7s/YILAHNATopaJdH9DNpd1
+  U81zGHMUBOvz/VGT6wJwYJ3emS2nfA2NOHFfgA==
+  -----END CERTIFICATE-----
+date: 2013-02-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -155,6 +147,7 @@ executables:
 - ri
 extensions: []
 extra_rdoc_files:
+- CVE-2013-0256.rdoc
 - DEVELOPERS.rdoc
 - History.rdoc
 - LEGAL.rdoc
@@ -168,6 +161,7 @@ extra_rdoc_files:
 files:
 - ".autotest"
 - ".document"
+- CVE-2013-0256.rdoc
 - DEVELOPERS.rdoc
 - History.rdoc
 - LEGAL.rdoc
@@ -253,6 +247,7 @@ files:
 - lib/rdoc/generator/template/darkfish/servlet_not_found.rhtml
 - lib/rdoc/generator/template/darkfish/servlet_root.rhtml
 - lib/rdoc/generator/template/darkfish/table_of_contents.rhtml
+- lib/rdoc/generator/template/json_index/.document
 - lib/rdoc/generator/template/json_index/js/navigation.js
 - lib/rdoc/generator/template/json_index/js/searcher.js
 - lib/rdoc/ghost_method.rb
@@ -370,7 +365,7 @@ files:
 - test/README
 - test/binary.dat
 - test/hidden.zip.txt
-- test/test.ja.large.rdoc
+- test/test.ja.largedoc
 - test/test.ja.rdoc
 - test/test.ja.txt
 - test/test.txt
@@ -481,7 +476,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '1.3'
 requirements: []
 rubyforge_project: rdoc
-rubygems_version: 2.0.0.preview2.1
+rubygems_version: 2.0.0.rc.2
 signing_key: 
 specification_version: 4
 summary: RDoc produces HTML and command-line documentation for Ruby projects