rdoc 3.12.2 → 4.0.0.preview2

data/test/test_rdoc_ri_paths.rb

@@ -5,41 +5,150 @@ class TestRDocRIPaths < RDoc::TestCase
   def setup
     super
 
-    RDoc::RI::Paths.instance_variable_set :@gemdirs, %w[/nonexistent/gemdir]
+    @orig_gem_path = Gem.path
+
+    @tempdir = File.join Dir.tmpdir, "test_rdoc_ri_paths_#{$$}"
+    Gem.use_paths @tempdir
+    Gem.ensure_gem_subdirectories @tempdir
+
+    specs = [
+      @rake_10   = Gem::Specification.new('rake', '10.0.1'),
+      @rdoc_4_0  = Gem::Specification.new('rdoc', '4.0'),
+      @rdoc_3_12 = Gem::Specification.new('rdoc', '3.12'),
+      @nodoc     = Gem::Specification.new('nodoc', '1.0'),
+    ]
+
+    specs.each do |spec|
+      spec.loaded_from = spec.spec_file
+
+      open spec.spec_file, 'w' do |file|
+        file.write spec.to_ruby_for_cache
+      end
+
+      FileUtils.mkdir_p File.join(spec.doc_dir, 'ri') unless
+        spec.name == 'nodoc'
+    end
+
+    Gem::Specification.reset
+    Gem::Specification.all = specs
   end
 
   def teardown
     super
 
-    RDoc::RI::Paths.instance_variable_set :@gemdirs, nil
+    Gem.use_paths(*@orig_gem_path)
+    Gem::Specification.reset
+    FileUtils.rm_rf @tempdir
+  end
+
+  def test_class_each
+    enum = RDoc::RI::Paths.each true, true, true, :all
+
+    path = enum.map { |dir,| dir }
+
+    assert_equal RDoc::RI::Paths.system_dir,          path.shift
+    assert_equal RDoc::RI::Paths.site_dir,            path.shift
+    assert_equal RDoc::RI::Paths.home_dir,            path.shift
+    assert_equal File.join(@nodoc.doc_dir, 'ri'),     path.shift
+    assert_equal File.join(@rake_10.doc_dir, 'ri'),   path.shift
+    assert_equal File.join(@rdoc_4_0.doc_dir, 'ri'),  path.shift
+    assert_equal File.join(@rdoc_3_12.doc_dir, 'ri'), path.shift
+    assert_empty path
+  end
+
+  def test_class_gemdirs_latest
+    Dir.chdir @tempdir do
+      gemdirs = RDoc::RI::Paths.gemdirs :latest
+
+      expected = [
+        File.join(@rake_10.doc_dir, 'ri'),
+        File.join(@rdoc_4_0.doc_dir, 'ri'),
+      ]
+
+      assert_equal expected, gemdirs
+    end
+  end
+
+  def test_class_gemdirs_legacy
+    Dir.chdir @tempdir do
+      gemdirs = RDoc::RI::Paths.gemdirs true
+
+      expected = [
+        File.join(@rake_10.doc_dir, 'ri'),
+        File.join(@rdoc_4_0.doc_dir, 'ri'),
+      ]
+
+      assert_equal expected, gemdirs
+    end
+  end
+
+  def test_class_gemdirs_all
+    Dir.chdir @tempdir do
+      gemdirs = RDoc::RI::Paths.gemdirs :all
+
+      expected = [
+        File.join(@nodoc.doc_dir,     'ri'),
+        File.join(@rake_10.doc_dir,   'ri'),
+        File.join(@rdoc_4_0.doc_dir,  'ri'),
+        File.join(@rdoc_3_12.doc_dir, 'ri'),
+      ]
+
+      assert_equal expected, gemdirs
+    end
+  end
+
+  def test_class_gem_dir
+    dir = RDoc::RI::Paths.gem_dir 'rake', '10.0.1'
+
+    expected = File.join @rake_10.doc_dir, 'ri'
+
+    assert_equal expected, dir
+  end
+
+  def test_class_home_dir
+    dir = RDoc::RI::Paths.home_dir
+
+    assert_equal RDoc::RI::Paths::HOMEDIR, dir
   end
 
   def test_class_path_nonexistent
     temp_dir do |dir|
       nonexistent = File.join dir, 'nonexistent'
-      path = RDoc::RI::Paths.path true, true, true, true, nonexistent
+      dir = RDoc::RI::Paths.path true, true, true, true, nonexistent
 
-      refute_includes path, nonexistent
+      refute_includes dir, nonexistent
     end
   end
 
   def test_class_raw_path
     path = RDoc::RI::Paths.raw_path true, true, true, true
 
-    assert_equal RDoc::RI::Paths::SYSDIR,  path.shift
-    assert_equal RDoc::RI::Paths::SITEDIR, path.shift
-    assert_equal RDoc::RI::Paths::HOMEDIR, path.shift
-    assert_equal '/nonexistent/gemdir',    path.shift
+    assert_equal RDoc::RI::Paths.system_dir,        path.shift
+    assert_equal RDoc::RI::Paths.site_dir,          path.shift
+    assert_equal RDoc::RI::Paths.home_dir,          path.shift
+    assert_equal File.join(@rake_10.doc_dir, 'ri'), path.shift
   end
 
   def test_class_raw_path_extra_dirs
     path = RDoc::RI::Paths.raw_path true, true, true, true, '/nonexistent'
 
-    assert_equal '/nonexistent',           path.shift
-    assert_equal RDoc::RI::Paths::SYSDIR,  path.shift
-    assert_equal RDoc::RI::Paths::SITEDIR, path.shift
-    assert_equal RDoc::RI::Paths::HOMEDIR, path.shift
-    assert_equal '/nonexistent/gemdir',    path.shift
+    assert_equal '/nonexistent',                    path.shift
+    assert_equal RDoc::RI::Paths.system_dir,        path.shift
+    assert_equal RDoc::RI::Paths.site_dir,          path.shift
+    assert_equal RDoc::RI::Paths.home_dir,          path.shift
+    assert_equal File.join(@rake_10.doc_dir, 'ri'), path.shift
+  end
+
+  def test_class_site_dir
+    dir = RDoc::RI::Paths.site_dir
+
+    assert_equal File.join(RDoc::RI::Paths::BASE, 'site'), dir
+  end
+
+  def test_class_system_dir
+    dir = RDoc::RI::Paths.system_dir
+
+    assert_equal File.join(RDoc::RI::Paths::BASE, 'system'), dir
   end
 
 end

data/test/test_rdoc_ruby_lex.rb

@@ -1,5 +1,3 @@
-# coding: UTF-8
-
 require 'rdoc/test_case'
 
 class TestRDocRubyLex < RDoc::TestCase
@@ -70,8 +68,7 @@ end
       @TK::TkIDENTIFIER.new( 4, 1,  4, 'x'),
       @TK::TkNL        .new( 5, 1,  5, "\n"),
       @TK::TkSPACE     .new( 6, 2,  0, '  '),
-      @TK::TkHEREDOC   .new( 8, 2,  2,
-                            %Q{<<E\nLine 1\nLine 2\nE}),
+      @TK::TkSTRING    .new( 8, 2,  2, %Q{"Line 1\nLine 2\n"}),
       @TK::TkNL        .new(27, 5, 28, "\n"),
       @TK::TkEND       .new(28, 6,  0, 'end'),
       @TK::TkNL        .new(31, 6, 28, "\n"),
@@ -97,56 +94,12 @@ 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 = [
@@ -154,9 +107,8 @@ Line 2
       @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::TkNL        .new(41, 4, 42, "\n"),
+      @TK::TkSTRING    .new( 9, 1,  9, %Q{"Line 1\nLine 2\n"}),
+      @TK::TkNL        .new(39, 4, 40, "\n"),
     ]
 
     assert_equal expected, tokens
@@ -174,21 +126,13 @@ U
       @TK::TkSPACE     .new( 1, 1,  1, ' '),
       @TK::TkIDENTIFIER.new( 2, 1,  2, 'b'),
       @TK::TkSPACE     .new( 3, 1,  3, ' '),
-      @TK::TkHEREDOC   .new( 4, 1,  4, %Q{<<-U\n%N\nU}),
+      @TK::TkSTRING    .new( 4, 1,  4, %Q{"%N\n"}),
       @TK::TkNL        .new(13, 3, 14, "\n"),
     ]
 
     assert_equal expected, tokens
   end
 
-  def test_class_tokenize_identifier_high_unicode
-    tokens = RDoc::RubyLex.tokenize '𝖒', nil
-
-    expected = @TK::TkIDENTIFIER.new(0, 1, 0, '𝖒')
-
-    assert_equal expected, tokens.first
-  end
-
   def test_class_tokenize_percent_1
     tokens = RDoc::RubyLex.tokenize 'v%10==10', nil
 

data/test/test_rdoc_ruby_token.rb

@@ -0,0 +1,19 @@
+require 'rdoc/test_case'
+
+class TestRDocRubyToken < RDoc::TestCase
+
+  def test_Token_text
+    token = RDoc::RubyToken::Token.new 0, 0, 0, 'text'
+
+    assert_equal 'text', token.text
+  end
+
+  def test_TkOp_name
+    token = RDoc::RubyToken::TkOp.new 0, 0, 0, '&'
+
+    assert_equal '&', token.text
+    assert_equal '&', token.name
+  end
+
+end
+

data/test/test_rdoc_rubygems_hook.rb

@@ -12,7 +12,7 @@ class TestRDocRubygemsHook < Gem::TestCase
 
     @a = quick_spec 'a'
 
-    @rdoc = RDoc::RubygemsHook.new @a
+    @hook = RDoc::RubygemsHook.new @a
 
     begin
       RDoc::RubygemsHook.load_rdoc
@@ -24,8 +24,8 @@ class TestRDocRubygemsHook < Gem::TestCase
   end
 
   def test_initialize
-    assert @rdoc.generate_rdoc
-    assert @rdoc.generate_ri
+    assert @hook.generate_rdoc
+    assert @hook.generate_ri
 
     rdoc = RDoc::RubygemsHook.new @a, false, false
 
@@ -41,7 +41,7 @@ class TestRDocRubygemsHook < Gem::TestCase
       -p
     ]
 
-    @rdoc.delete_legacy_args args
+    @hook.delete_legacy_args args
 
     assert_empty args
   end
@@ -50,24 +50,26 @@ class TestRDocRubygemsHook < Gem::TestCase
     options = RDoc::Options.new
     options.files = []
 
-    @rdoc.instance_variable_set :@rdoc, @rdoc.new_rdoc
-    @rdoc.instance_variable_set :@file_info, []
+    rdoc = @hook.new_rdoc
+    rdoc.store = RDoc::Store.new
+    @hook.instance_variable_set :@rdoc, rdoc
+    @hook.instance_variable_set :@file_info, []
 
-    @rdoc.document 'darkfish', options, @a.doc_dir('rdoc')
+    @hook.document 'darkfish', options, @a.doc_dir('rdoc')
 
-    assert @rdoc.rdoc_installed?
+    assert @hook.rdoc_installed?
   end
 
   def test_generate
     FileUtils.mkdir_p @a.doc_dir
     FileUtils.mkdir_p File.join(@a.gem_dir, 'lib')
 
-    @rdoc.generate
+    @hook.generate
 
-    assert @rdoc.rdoc_installed?
-    assert @rdoc.ri_installed?
+    assert @hook.rdoc_installed?
+    assert @hook.ri_installed?
 
-    rdoc = @rdoc.instance_variable_get :@rdoc
+    rdoc = @hook.instance_variable_get :@rdoc
 
     refute rdoc.options.hyperlink_all
   end
@@ -78,9 +80,9 @@ class TestRDocRubygemsHook < Gem::TestCase
     FileUtils.mkdir_p @a.doc_dir
     FileUtils.mkdir_p File.join(@a.gem_dir, 'lib')
 
-    @rdoc.generate
+    @hook.generate
 
-    rdoc = @rdoc.instance_variable_get :@rdoc
+    rdoc = @hook.instance_variable_get :@rdoc
 
     assert rdoc.options.hyperlink_all
   end
@@ -91,21 +93,35 @@ class TestRDocRubygemsHook < Gem::TestCase
     FileUtils.mkdir_p @a.doc_dir
     FileUtils.mkdir_p File.join(@a.gem_dir, 'lib')
 
-    @rdoc.generate
+    @hook.generate
 
-    rdoc = @rdoc.instance_variable_get :@rdoc
+    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'
+
+    FileUtils.mkdir_p @a.doc_dir
+    FileUtils.mkdir_p File.join(@a.gem_dir, 'lib')
+
+    @hook.generate
+
+    refute @hook.rdoc_installed?
+    refute @hook.ri_installed?
+  end
+
   def test_generate_disabled
-    @rdoc.generate_rdoc = false
-    @rdoc.generate_ri   = false
+    @hook.generate_rdoc = false
+    @hook.generate_ri   = false
 
-    @rdoc.generate
+    @hook.generate
 
-    refute @rdoc.rdoc_installed?
-    refute @rdoc.ri_installed?
+    refute @hook.rdoc_installed?
+    refute @hook.ri_installed?
   end
 
   def test_generate_force
@@ -113,9 +129,9 @@ class TestRDocRubygemsHook < Gem::TestCase
     FileUtils.mkdir_p @a.doc_dir 'rdoc'
     FileUtils.mkdir_p File.join(@a.gem_dir, 'lib')
 
-    @rdoc.force = true
+    @hook.force = true
 
-    @rdoc.generate
+    @hook.generate
 
     assert_path_exists File.join(@a.doc_dir('rdoc'), 'index.html')
     assert_path_exists File.join(@a.doc_dir('ri'),   'cache.ri')
@@ -126,32 +142,32 @@ class TestRDocRubygemsHook < Gem::TestCase
     FileUtils.mkdir_p @a.doc_dir 'rdoc'
     FileUtils.mkdir_p File.join(@a.gem_dir, 'lib')
 
-    @rdoc.generate
+    @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, @rdoc.new_rdoc
+    assert_kind_of RDoc::RDoc, @hook.new_rdoc
   end
 
   def test_rdoc_installed?
-    refute @rdoc.rdoc_installed?
+    refute @hook.rdoc_installed?
 
     FileUtils.mkdir_p @a.doc_dir 'rdoc'
 
-    assert @rdoc.rdoc_installed?
+    assert @hook.rdoc_installed?
   end
 
   def test_remove
     FileUtils.mkdir_p @a.doc_dir 'rdoc'
     FileUtils.mkdir_p @a.doc_dir 'ri'
 
-    @rdoc.remove
+    @hook.remove
 
-    refute @rdoc.rdoc_installed?
-    refute @rdoc.ri_installed?
+    refute @hook.rdoc_installed?
+    refute @hook.ri_installed?
 
     assert_path_exists @a.doc_dir
   end
@@ -162,7 +178,7 @@ class TestRDocRubygemsHook < Gem::TestCase
     FileUtils.chmod 0, @a.base_dir
 
     e = assert_raises Gem::FilePermissionError do
-      @rdoc.remove
+      @hook.remove
     end
 
     assert_equal @a.base_dir, e.directory
@@ -171,31 +187,36 @@ class TestRDocRubygemsHook < Gem::TestCase
   end
 
   def test_ri_installed?
-    refute @rdoc.ri_installed?
+    refute @hook.ri_installed?
 
     FileUtils.mkdir_p @a.doc_dir 'ri'
 
-    assert @rdoc.ri_installed?
+    assert @hook.ri_installed?
   end
 
   def test_setup
-    @rdoc.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
-      @rdoc.setup
+    begin
+      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
-
-    assert_equal @a.doc_dir, e.directory
-  ensure
-    FileUtils.chmod 0755, @a.doc_dir
   end
 
 end