rdoc 3.12.2 → 4.0.0.preview2

data/test/test_rdoc_servlet.rb

@@ -0,0 +1,429 @@
+require 'rdoc/test_case'
+
+class TestRDocServlet < RDoc::TestCase
+
+  def setup
+    super
+
+    @orig_gem_path = Gem.path
+
+    @tempdir = File.join Dir.tmpdir, "test_rdoc_servlet_#{$$}"
+    Gem.use_paths @tempdir
+    Gem.ensure_gem_subdirectories @tempdir
+
+    @spec = Gem::Specification.new 'spec', '1.0'
+    @spec.loaded_from = File.join @tempdir, @spec.spec_file
+
+    Gem::Specification.reset
+    Gem::Specification.all = [@spec]
+
+    @server = {}
+    def @server.mount(*) end
+
+    @stores = {}
+    @cache  = Hash.new { |hash, store| hash[store] = {} }
+
+    @s = RDoc::Servlet.new @server, @stores, @cache
+
+    @req = WEBrick::HTTPRequest.new :Logger => nil
+    @res = WEBrick::HTTPResponse.new :HTTPVersion => '1.0'
+
+    def @req.path= path
+      instance_variable_set :@path, path
+    end
+
+    @req.instance_variable_set :@header, Hash.new { |h, k| h[k] = [] }
+
+    @base       = File.join @tempdir, 'base'
+    @system_dir = File.join @tempdir, 'base', 'system'
+
+    @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.instance_variable_set \
+      :@gemdirs, %w[/nonexistent/gems/example-1.0/ri]
+  end
+
+  def teardown
+    super
+
+    Gem.use_paths(*@orig_gem_path)
+    Gem::Specification.reset
+
+    FileUtils.rm_rf @tempdir
+
+    RDoc::RI::Paths::BASE.replace @orig_base
+    RDoc::RI::Paths::HOMEDIR.replace @orig_ri_path_homedir
+    RDoc::RI::Paths.instance_variable_set :@gemdirs, nil
+  end
+
+  def test_asset
+    temp_dir do
+      now = Time.now
+
+      open 'rdoc.css', 'w' do |io| io.write 'h1 { color: red }' end
+      File.utime now, now, 'rdoc.css'
+
+      @s.asset_dirs[:darkfish] = '.'
+
+      @req.path = 'rdoc.css'
+
+      @s.asset :darkfish, @req, @res
+
+      assert_equal 'h1 { color: red }', @res.body
+      assert_equal 'text/css',          @res.content_type
+      assert_equal now.httpdate,        @res['last-modified']
+    end
+  end
+
+  def test_do_GET
+    touch_system_cache_path
+
+    @req.path = '/ruby/Missing.html'
+
+    @s.do_GET @req, @res
+
+    assert_equal 404, @res.status
+  end
+
+  def test_do_GET_asset_darkfish
+    temp_dir do
+      FileUtils.touch 'rdoc.css'
+
+      @s.asset_dirs[:darkfish] = '.'
+
+      @req.path = '/rdoc.css'
+
+      @s.do_GET @req, @res
+
+      assert_equal 'text/css',          @res.content_type
+    end
+  end
+
+  def test_do_GET_asset_json_index
+    temp_dir do
+      FileUtils.mkdir 'js'
+      FileUtils.touch 'js/navigation.js'
+
+      @s.asset_dirs[:json_index] = '.'
+
+      @req.path = '/js/navigation.js'
+
+      @s.do_GET @req, @res
+
+      assert_equal 'application/javascript', @res.content_type
+    end
+  end
+
+  def test_do_GET_error
+    touch_system_cache_path
+
+    def @req.path() raise 'no' end
+
+    @s.do_GET @req, @res
+
+    assert_equal 500, @res.status
+  end
+
+  def test_do_GET_mount_path
+    @s = RDoc::Servlet.new @server, @stores, @cache, '/mount/path'
+
+    temp_dir do
+      FileUtils.touch 'rdoc.css'
+
+      @s.asset_dirs[:darkfish] = '.'
+
+      @req.path = '/mount/path/rdoc.css'
+
+      @s.do_GET @req, @res
+
+      assert_equal 'text/css', @res.content_type
+    end
+  end
+
+  def test_do_GET_not_modified
+    touch_system_cache_path
+    @req.header['if-modified-since'] = [(Time.now + 10).httpdate]
+    @req.path = '/ruby/Missing.html'
+
+    assert_raises WEBrick::HTTPStatus::NotModified do
+      @s.do_GET @req, @res
+    end
+  end
+
+  def test_do_GET_root
+    touch_system_cache_path
+
+    @req.path = '/'
+
+    @s.do_GET @req, @res
+
+    assert_equal 'text/html',                                 @res.content_type
+    assert_match %r%<title>Local RDoc Documentation</title>%, @res.body
+  end
+
+  def test_do_GET_root_search
+    touch_system_cache_path
+
+    @req.path = '/js/search_index.js'
+
+    @s.do_GET @req, @res
+
+    assert_equal 'application/javascript', @res.content_type
+  end
+
+  def test_documentation_page_class
+    store = RDoc::Store.new
+
+    generator = @s.generator_for store
+
+    file      = store.add_file 'file.rb'
+    klass     = file.add_class RDoc::NormalClass, 'Klass'
+                klass.add_class RDoc::NormalClass, 'Sub'
+
+    @s.documentation_page store, generator, 'Klass::Sub.html', @req, @res
+
+    assert_match %r%<title>class Klass::Sub - </title>%, @res.body
+    assert_match %r%<body id="top" class="class">%,      @res.body
+  end
+
+  def test_documentation_page_not_found
+    store = RDoc::Store.new
+
+    generator = @s.generator_for store
+
+    @req.path = '/ruby/Missing.html'
+
+    @s.documentation_page store, generator, 'Missing.html', @req, @res
+
+    assert_equal 404, @res.status
+  end
+
+  def test_documentation_page_page
+    store = RDoc::Store.new
+
+    generator = @s.generator_for store
+
+    readme = store.add_file 'README.rdoc'
+    readme.parser = RDoc::Parser::Simple
+
+    @s.documentation_page store, generator, 'README_rdoc.html', @req, @res
+
+    assert_match %r%<title>README - </title>%, @res.body
+    assert_match %r%<body class="file">%,      @res.body
+  end
+
+  def test_documentation_source
+    store, path = @s.documentation_source '/ruby/Object.html'
+
+    assert_equal @system_dir, store.path
+
+    assert_equal 'Object.html', path
+  end
+
+  def test_documentation_source_cached
+    cached_store = RDoc::Store.new
+
+    @stores['ruby'] = cached_store
+
+    store, path = @s.documentation_source '/ruby/Object.html'
+
+    assert_same cached_store, store
+
+    assert_equal 'Object.html', path
+  end
+
+  def test_error
+    e = RuntimeError.new 'foo'
+    e.set_backtrace caller
+
+    @s.error e, @req, @res
+
+    assert_equal 'text/html',      @res.content_type
+    assert_equal 500,              @res.status
+    assert_match %r%<title>Error%, @res.body
+  end
+
+  def test_generator_for
+    store = RDoc::Store.new
+    store.main  = 'MAIN_PAGE.rdoc'
+    store.title = 'Title'
+
+    generator = @s.generator_for store
+
+    refute generator.file_output
+
+    assert_equal '..', generator.asset_rel_path
+
+    assert_equal 'MAIN_PAGE.rdoc', @s.options.main_page
+    assert_equal 'Title',          @s.options.title
+
+    assert_kind_of RDoc::RDoc, store.rdoc
+    assert_same generator, store.rdoc.generator
+  end
+
+  def test_if_modified_since
+    skip 'File.utime on directory not supported' if Gem.win_platform?
+
+    temp_dir do
+      now = Time.now
+      File.utime now, now, '.'
+
+      @s.if_modified_since @req, @res, '.'
+
+      assert_equal now.to_i, Time.parse(@res['last-modified']).to_i
+    end
+  end
+
+  def test_if_modified_since_not_modified
+    skip 'File.utime on directory not supported' if Gem.win_platform?
+
+    temp_dir do
+      now = Time.now
+      File.utime now, now, '.'
+
+      @req.header['if-modified-since'] = [(now + 10).httpdate]
+
+      assert_raises WEBrick::HTTPStatus::NotModified do
+        @s.if_modified_since @req, @res, '.'
+      end
+
+      assert_equal now.to_i, Time.parse(@res['last-modified']).to_i
+    end
+  end
+
+  def test_installed_docs
+    touch_system_cache_path
+
+    expected = [
+      ['Ruby Documentation', 'ruby/', true,  :system,
+        @system_dir],
+      ['Site Documentation', 'site/', false, :site,
+        File.join(@base, 'site')],
+      ['Home Documentation', 'home/', false, :home,
+        RDoc::RI::Paths::HOMEDIR],
+      ['spec-1.0', 'spec-1.0/',       false, :gem,
+        File.join(@spec.doc_dir, 'ri')],
+    ]
+
+    assert_equal expected, @s.installed_docs
+  end
+
+  def test_not_found
+    generator = @s.generator_for RDoc::Store.new
+
+    @req.path = '/ruby/Missing.html'
+
+    @s.not_found generator, @req, @res
+
+    assert_equal 404,                                @res.status
+    assert_match %r%<title>Not Found</title>%,       @res.body
+    assert_match %r%<kbd>/ruby/Missing\.html</kbd>%, @res.body
+  end
+
+  def test_ri_paths
+    paths = @s.ri_paths
+
+    expected = [
+      [@system_dir,                    :system],
+      [File.join(@base, 'site'),       :site],
+      [RDoc::RI::Paths::HOMEDIR,       :home],
+      [File.join(@spec.doc_dir, 'ri'), :gem],
+    ]
+
+    assert_equal expected, paths.to_a
+  end
+
+  def test_root
+    @s.root @req, @res
+
+    assert_equal 'text/html',                                 @res.content_type
+    assert_match %r%<title>Local RDoc Documentation</title>%, @res.body
+  end
+
+  def test_root_search
+    touch_system_cache_path
+
+    @s.root_search @req, @res
+
+    assert_equal 'application/javascript', @res.content_type
+
+    @res.body =~ /\{.*\}/
+
+    index = JSON.parse $&
+
+    expected = {
+      'index' => {
+        'searchIndex' => %w[
+          Ruby\ Documentation
+        ],
+        'longSearchIndex' => %w[
+          Ruby\ Documentation
+        ],
+        'info' => [
+          ['Ruby Documentation', '', @system_dir, '',
+            'Documentation for the Ruby standard library'],
+        ],
+      }
+    }
+
+    assert_equal expected, index
+  end
+
+  def test_show_documentation_index
+    touch_system_cache_path
+
+    @req.path = '/ruby'
+
+    @s.show_documentation @req, @res
+
+    assert_equal 'text/html',                               @res.content_type
+    assert_match %r%<title>Standard Library Documentation%, @res.body
+  end
+
+  def test_show_documentation_table_of_contents
+    touch_system_cache_path
+
+    @req.path = '/ruby/table_of_contents.html'
+
+    @s.show_documentation @req, @res
+
+    assert_equal 'text/html',         @res.content_type
+    assert_match %r%<title>Table of Contents - Standard Library Documentation%,
+                 @res.body
+  end
+
+  def test_show_documentation_page
+    touch_system_cache_path
+
+    @req.path = '/ruby/Missing.html'
+
+    @s.show_documentation @req, @res
+
+    assert_equal 404, @res.status
+  end
+
+  def test_show_documentation_search_index
+    touch_system_cache_path
+
+    @req.path = '/ruby/js/search_index.js'
+
+    @s.show_documentation @req, @res
+
+    assert_equal 'application/javascript', @res.content_type
+    assert_match %r%\Avar search_data =%,  @res.body
+  end
+
+  def touch_system_cache_path
+    store = RDoc::Store.new @system_dir
+    store.title = 'Standard Library Documentation'
+
+    FileUtils.mkdir_p File.dirname store.cache_path
+
+    store.save
+  end
+
+end
+

data/test/test_rdoc_stats.rb

@@ -5,9 +5,9 @@ class TestRDocStats < RDoc::TestCase
   def setup
     super
 
-    @s = RDoc::Stats.new 0
+    @s = RDoc::Stats.new @store, 0
 
-    @tl = RDoc::TopLevel.new 'file.rb'
+    @tl = @store.add_file 'file.rb'
     @tl.parser = RDoc::Parser::Ruby
   end
 
@@ -40,7 +40,7 @@ class TestRDocStats < RDoc::TestCase
     a.record_location @tl
     c.add_attribute a
 
-    RDoc::TopLevel.complete :public
+    @store.complete :public
 
     report = @s.report
 
@@ -65,13 +65,28 @@ end
     a.record_location @tl
     c.add_attribute a
 
-    RDoc::TopLevel.complete :public
+    @store.complete :public
 
     report = @s.report
 
     assert_equal @s.great_job, report
   end
 
+  def test_report_attr_line
+    c = @tl.add_class RDoc::NormalClass, 'C'
+    c.record_location @tl
+    c.add_comment 'C', @tl
+
+    a = RDoc::Attr.new nil, 'a', 'RW', nil
+    a.record_location @tl
+    a.line = 3
+    c.add_attribute a
+
+    @store.complete :public
+
+    assert_match '# in file file.rb:3', @s.report
+  end
+
   def test_report_constant
     m = @tl.add_module RDoc::NormalModule, 'M'
     m.record_location @tl
@@ -81,7 +96,7 @@ end
     c.record_location @tl
     m.add_constant c
 
-    RDoc::TopLevel.complete :public
+    @store.complete :public
 
     report = @s.report
 
@@ -109,7 +124,7 @@ end
 
     @tl.add_constant ca
 
-    RDoc::TopLevel.complete :public
+    @store.complete :public
 
     report = @s.report
 
@@ -127,13 +142,28 @@ end
     c.record_location @tl
     m.add_constant c
 
-    RDoc::TopLevel.complete :public
+    @store.complete :public
 
     report = @s.report
 
     assert_equal @s.great_job, report
   end
 
+  def test_report_constant_line
+    m = @tl.add_module RDoc::NormalModule, 'M'
+    m.record_location @tl
+    m.add_comment 'M', @tl
+
+    c = RDoc::Constant.new 'C', nil, nil
+    c.record_location @tl
+    c.line = 5
+    m.add_constant c
+
+    @store.complete :public
+
+    assert_match '# in file file.rb:5', @s.report
+  end
+
   def test_report_class
     c = @tl.add_class RDoc::NormalClass, 'C'
     c.record_location @tl
@@ -143,7 +173,7 @@ end
     c.add_method m
     m.comment = 'm'
 
-    RDoc::TopLevel.complete :public
+    @store.complete :public
 
     report = @s.report
 
@@ -160,6 +190,20 @@ end
     assert_equal expected, report
   end
 
+  def test_report_skip_object
+    c = @tl.add_class RDoc::NormalClass, 'Object'
+    c.record_location @tl
+
+    m = RDoc::AnyMethod.new nil, 'm'
+    m.record_location @tl
+    c.add_method m
+    m.comment = 'm'
+
+    @store.complete :public
+
+    refute_match %r%^class Object$%, @s.report
+  end
+
   def test_report_class_documented
     c = @tl.add_class RDoc::NormalClass, 'C'
     c.record_location @tl
@@ -170,7 +214,7 @@ end
     c.add_method m
     m.comment = 'm'
 
-    RDoc::TopLevel.complete :public
+    @store.complete :public
 
     report = @s.report
 
@@ -195,7 +239,7 @@ end
     c2.add_method m2
     m2.comment = 'm2'
 
-    RDoc::TopLevel.complete :public
+    @store.complete :public
 
     @s.coverage_level = 1
 
@@ -218,7 +262,7 @@ end
   def test_report_class_empty
     @tl.add_class RDoc::NormalClass, 'C'
 
-    RDoc::TopLevel.complete :public
+    @store.complete :public
 
     report = @s.report
 
@@ -241,7 +285,7 @@ The following items are not documented:
     c2.record_location @tl
     c2.add_comment 'C2', @tl
 
-    RDoc::TopLevel.complete :public
+    @store.complete :public
 
     @s.coverage_level = 1
     report = @s.report
@@ -269,7 +313,7 @@ end
     c.add_method m
     m.comment = 'm'
 
-    RDoc::TopLevel.complete :public
+    @store.complete :public
 
     report = @s.report
 
@@ -290,7 +334,7 @@ end
     c = @tl.add_class RDoc::NormalClass, 'C'
     c.ignore
 
-    RDoc::TopLevel.complete :public
+    @store.complete :public
 
     report = @s.report_class_module c
 
@@ -298,7 +342,7 @@ end
   end
 
   def test_report_empty
-    RDoc::TopLevel.complete :public
+    @store.complete :public
 
     report = @s.report
 
@@ -319,7 +363,7 @@ end
     c.add_method m2
     m2.comment = 'm2'
 
-    RDoc::TopLevel.complete :public
+    @store.complete :public
 
     report = @s.report
 
@@ -353,7 +397,7 @@ end
     c.add_method m2
     m2.comment = 'm2'
 
-    RDoc::TopLevel.complete :public
+    @store.complete :public
 
     report = @s.report
 
@@ -381,13 +425,28 @@ end
     c.add_method m
     m.comment = 'm'
 
-    RDoc::TopLevel.complete :public
+    @store.complete :public
 
     report = @s.report
 
     assert_equal @s.great_job, report
   end
 
+  def test_report_method_line
+    c = @tl.add_class RDoc::NormalClass, 'C'
+    c.record_location @tl
+    c.add_comment 'C', @tl
+
+    m1 = RDoc::AnyMethod.new nil, 'm1'
+    m1.record_location @tl
+    m1.line = 4
+    c.add_method m1
+
+    @store.complete :public
+
+    assert_match '# in file file.rb:4', @s.report
+  end
+
   def test_report_method_parameters
     c = @tl.add_class RDoc::NormalClass, 'C'
     c.record_location @tl
@@ -404,7 +463,7 @@ end
     c.add_method m2
     m2.comment = 'm2'
 
-    RDoc::TopLevel.complete :public
+    @store.complete :public
 
     @s.coverage_level = 1
     report = @s.report
@@ -436,7 +495,7 @@ end
     m.comment = 'Stuff with +p1+'
     c.add_method m
 
-    RDoc::TopLevel.complete :public
+    @store.complete :public
 
     @s.coverage_level = 1
     report = @s.report
@@ -458,7 +517,7 @@ m(a, b) { |c, d| ... }
     m.comment = 'Stuff with +a+, yields +c+ for you to do stuff with'
     c.add_method m
 
-    RDoc::TopLevel.complete :public
+    @store.complete :public
 
     @s.coverage_level = 1
     report = @s.report
@@ -497,7 +556,7 @@ end
     m.record_location @tl
     c.add_method m
 
-    RDoc::TopLevel.complete :public
+    @store.complete :public
 
     summary = @s.summary
     summary.sub!(/Elapsed:.*/, '')
@@ -523,7 +582,7 @@ Total:      5 (5 undocumented)
     c = @tl.add_class RDoc::NormalClass, 'C'
     c.record_location @tl
 
-    RDoc::TopLevel.complete :public
+    @store.complete :public
 
     @s.coverage_level = false
 
@@ -558,7 +617,7 @@ Total:      1 (1 undocumented)
     m.comment = 'Stuff with +p1+'
     c.add_method m
 
-    RDoc::TopLevel.complete :public
+    @store.complete :public
 
     @s.coverage_level = 1
     @s.report