rdoc 3.6.1 → 3.7

data/test/test_rdoc_rubygems_hook.rb

@@ -0,0 +1,201 @@
+require 'rubygems/test_case'
+require 'rubygems'
+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 = quick_spec 'a'
+
+    @rdoc = 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
+    assert @rdoc.generate_rdoc
+    assert @rdoc.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
+    ]
+
+    @rdoc.delete_legacy_args args
+
+    assert_empty args
+  end
+
+  def test_document
+    options = RDoc::Options.new
+    options.files = []
+
+    @rdoc.instance_variable_set :@rdoc, @rdoc.new_rdoc
+    @rdoc.instance_variable_set :@file_info, []
+
+    @rdoc.document 'darkfish', options, @a.doc_dir('rdoc')
+
+    assert @rdoc.rdoc_installed?
+  end
+
+  def test_generate
+    FileUtils.mkdir_p @a.doc_dir
+    FileUtils.mkdir_p File.join(@a.gem_dir, 'lib')
+
+    @rdoc.generate
+
+    assert @rdoc.rdoc_installed?
+    assert @rdoc.ri_installed?
+
+    rdoc = @rdoc.instance_variable_get :@rdoc
+
+    refute rdoc.options.hyperlink_all
+  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')
+
+    @rdoc.generate
+
+    rdoc = @rdoc.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')
+
+    @rdoc.generate
+
+    rdoc = @rdoc.instance_variable_get :@rdoc
+
+    assert rdoc.options.hyperlink_all
+  end
+
+  def test_generate_disabled
+    @rdoc.generate_rdoc = false
+    @rdoc.generate_ri   = false
+
+    @rdoc.generate
+
+    refute @rdoc.rdoc_installed?
+    refute @rdoc.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')
+
+    @rdoc.force = true
+
+    @rdoc.generate
+
+    assert_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')
+
+    @rdoc.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
+  end
+
+  def test_rdoc_installed?
+    refute @rdoc.rdoc_installed?
+
+    FileUtils.mkdir_p @a.doc_dir 'rdoc'
+
+    assert @rdoc.rdoc_installed?
+  end
+
+  def test_remove
+    FileUtils.mkdir_p @a.doc_dir 'rdoc'
+    FileUtils.mkdir_p @a.doc_dir 'ri'
+
+    @rdoc.remove
+
+    refute @rdoc.rdoc_installed?
+    refute @rdoc.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
+      @rdoc.remove
+    end
+
+    assert_equal @a.base_dir, e.directory
+  ensure
+    FileUtils.chmod 0755, @a.base_dir
+  end
+
+  def test_ri_installed?
+    refute @rdoc.ri_installed?
+
+    FileUtils.mkdir_p @a.doc_dir 'ri'
+
+    assert @rdoc.ri_installed?
+  end
+
+  def test_setup
+    @rdoc.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
+    end
+
+    assert_equal @a.doc_dir, e.directory
+  ensure
+    FileUtils.chmod 0755, @a.doc_dir
+  end
+
+end
+

data/test/test_rdoc_stats.rb

@@ -17,7 +17,7 @@ class TestRDocStats < MiniTest::Unit::TestCase
     tl = RDoc::TopLevel.new 'file.rb'
     c = tl.add_class RDoc::NormalClass, 'C'
     c.record_location tl
-    c.comment = 'C'
+    c.add_comment 'C', tl
 
     a = RDoc::Attr.new nil, 'a', 'RW', nil
     a.record_location tl
@@ -43,7 +43,7 @@ end
     tl = RDoc::TopLevel.new 'file.rb'
     c = tl.add_class RDoc::NormalClass, 'C'
     c.record_location tl
-    c.comment = 'C'
+    c.add_comment 'C', tl
 
     a = RDoc::Attr.new nil, 'a', 'RW', 'a'
     a.record_location tl
@@ -60,7 +60,7 @@ end
     tl = RDoc::TopLevel.new 'file.rb'
     m = tl.add_module RDoc::NormalModule, 'M'
     m.record_location tl
-    m.comment = 'M'
+    m.add_comment 'M', tl
 
     c = RDoc::Constant.new 'C', nil, nil
     c.record_location tl
@@ -152,7 +152,7 @@ end
     tl = RDoc::TopLevel.new 'file.rb'
     c = tl.add_class RDoc::NormalClass, 'C'
     c.record_location tl
-    c.comment = 'C'
+    c.add_comment 'C', tl
 
     m = RDoc::AnyMethod.new nil, 'm'
     m.record_location tl
@@ -170,7 +170,7 @@ end
     tl = RDoc::TopLevel.new 'file.rb'
     c1 = tl.add_class RDoc::NormalClass, 'C1'
     c1.record_location tl
-    c1.comment = 'C1'
+    c1.add_comment 'C1', tl
 
     m1 = RDoc::AnyMethod.new nil, 'm1'
     m1.record_location tl
@@ -231,7 +231,7 @@ The following items are not documented:
 
     c2 = tl.add_class RDoc::NormalClass, 'C2'
     c2.record_location tl
-    c2.comment = 'C2'
+    c2.add_comment 'C2', tl
 
     RDoc::TopLevel.complete :public
 
@@ -291,7 +291,7 @@ end
     tl = RDoc::TopLevel.new 'file.rb'
     c = tl.add_class RDoc::NormalClass, 'C'
     c.record_location tl
-    c.comment = 'C'
+    c.add_comment 'C', tl
 
     m1 = RDoc::AnyMethod.new nil, 'm1'
     m1.record_location tl
@@ -324,7 +324,7 @@ end
     tl = RDoc::TopLevel.new 'file.rb'
     c = tl.add_class RDoc::NormalClass, 'C'
     c.record_location tl
-    c.comment = 'C'
+    c.add_comment 'C', tl
 
     m = RDoc::AnyMethod.new nil, 'm'
     m.record_location tl
@@ -342,7 +342,7 @@ end
     tl = RDoc::TopLevel.new 'file.rb'
     c = tl.add_class RDoc::NormalClass, 'C'
     c.record_location tl
-    c.comment = 'C'
+    c.add_comment 'C', tl
 
     m1 = RDoc::AnyMethod.new nil, 'm1'
     m1.record_location tl
@@ -379,7 +379,7 @@ end
     tl = RDoc::TopLevel.new 'file.rb'
     c = tl.add_class RDoc::NormalClass, 'C'
     c.record_location tl
-    c.comment = 'C'
+    c.add_comment 'C', tl
 
     m = RDoc::AnyMethod.new nil, 'm'
     m.record_location tl
@@ -399,7 +399,7 @@ end
     tl = RDoc::TopLevel.new 'file.rb'
     c = tl.add_class RDoc::NormalClass, 'C'
     c.record_location tl
-    c.comment = 'C'
+    c.add_comment 'C', tl
 
     m = RDoc::AnyMethod.new nil, 'm'
     m.record_location tl
@@ -505,7 +505,7 @@ Total:      1 (1 undocumented)
     tl = RDoc::TopLevel.new 'file.rb'
     c = tl.add_class RDoc::NormalClass, 'C'
     c.record_location tl
-    c.comment = 'C'
+    c.add_comment 'C', tl
 
     m = RDoc::AnyMethod.new nil, 'm'
     m.record_location tl

data/test/test_rdoc_text.rb

@@ -240,6 +240,23 @@ The comments associated with
     assert_equal expected, strip_stars(text)
   end
 
+  def test_strip_stars_document_method
+    text = <<-TEXT
+/*
+ * Document-method: Zlib::GzipFile#mtime=
+ *
+ * A comment
+ */
+    TEXT
+
+    expected = <<-EXPECTED
+
+   A comment
+    EXPECTED
+
+    assert_equal expected, strip_stars(text)
+  end
+
   def test_strip_stars_encoding
     skip "Encoding not implemented" unless Object.const_defined? :Encoding
 

data/test/test_rdoc_top_level.rb

@@ -81,6 +81,15 @@ class TestRDocTopLevel < XrefTestCase
                  RDoc::TopLevel.modules.map { |m| m.full_name }.sort
   end
 
+  def test_class_new
+    tl1 = RDoc::TopLevel.new 'file.rb'
+    tl2 = RDoc::TopLevel.new 'file.rb'
+    tl3 = RDoc::TopLevel.new 'other.rb'
+
+    assert_same tl1, tl2
+    refute_same tl1, tl3
+  end
+
   def test_class_reset
     RDoc::TopLevel.reset
 
@@ -93,6 +102,24 @@ class TestRDocTopLevel < XrefTestCase
     assert_equal 'top_level.rb', @top_level.base_name
   end
 
+  def test_eql_eh
+    top_level2 = RDoc::TopLevel.new 'path/top_level.rb'
+    other_level = RDoc::TopLevel.new 'path/other_level.rb'
+
+    assert_operator @top_level, :eql?, top_level2
+
+    refute_operator other_level, :eql?, @top_level
+  end
+
+  def test_equals2
+    top_level2 = RDoc::TopLevel.new 'path/top_level.rb'
+    other_level = RDoc::TopLevel.new 'path/other_level.rb'
+
+    assert_equal @top_level, top_level2
+
+    refute_equal other_level, @top_level
+  end
+
   def test_find_class_or_module
     assert_equal @c1,    @xref_data.find_class_or_module('C1')
     assert_equal @c2_c3, @xref_data.find_class_or_module('C2::C3')
@@ -104,6 +131,14 @@ class TestRDocTopLevel < XrefTestCase
     assert_equal 'path/top_level.rb', @top_level.full_name
   end
 
+  def test_hash
+    tl2 = RDoc::TopLevel.new 'path/top_level.rb'
+    tl3 = RDoc::TopLevel.new 'other/top_level.rb'
+
+    assert_equal @top_level.hash, tl2.hash
+    refute_equal @top_level.hash, tl3.hash
+  end
+
   def test_http_url
     assert_equal 'prefix/path/top_level_rb.html', @top_level.http_url('prefix')
   end

metadata

@@ -1,13 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: rdoc
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 9
   prerelease: 
   segments: 
   - 3
-  - 6
-  - 1
-  version: 3.6.1
+  - 7
+  version: "3.7"
 platform: ruby
 authors: 
 - Eric Hodel
@@ -39,7 +38,7 @@ cert_chain:
   x52qPcexcYZR7w==
   -----END CERTIFICATE-----
 
-date: 2011-05-15 00:00:00 Z
+date: 2011-06-27 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: minitest
@@ -49,12 +48,12 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 11
+        hash: 1
         segments: 
         - 2
-        - 0
-        - 2
-        version: 2.0.2
+        - 3
+        - 1
+        version: 2.3.1
   type: :development
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
@@ -105,14 +104,13 @@ dependencies:
   requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version 
-        hash: 35
+        hash: 17
         segments: 
         - 2
         - 9
-        - 4
-        version: 2.9.4
+        version: "2.9"
   type: :development
   version_requirements: *id005
 description: |-
@@ -205,6 +203,7 @@ files:
 - lib/rdoc/markup/formatter.rb
 - lib/rdoc/markup/formatter_test_case.rb
 - lib/rdoc/markup/heading.rb
+- lib/rdoc/markup/indented_paragraph.rb
 - lib/rdoc/markup/inline.rb
 - lib/rdoc/markup/list.rb
 - lib/rdoc/markup/list_item.rb
@@ -241,6 +240,7 @@ files:
 - lib/rdoc/ri/store.rb
 - lib/rdoc/ruby_lex.rb
 - lib/rdoc/ruby_token.rb
+- lib/rdoc/rubygems_hook.rb
 - lib/rdoc/single_class.rb
 - lib/rdoc/stats.rb
 - lib/rdoc/stats/normal.rb
@@ -273,6 +273,7 @@ files:
 - test/test_rdoc_markup.rb
 - test/test_rdoc_markup_attribute_manager.rb
 - test/test_rdoc_markup_document.rb
+- test/test_rdoc_markup_indented_paragraph.rb
 - test/test_rdoc_markup_paragraph.rb
 - test/test_rdoc_markup_parser.rb
 - test/test_rdoc_markup_pre_process.rb
@@ -297,6 +298,7 @@ files:
 - test/test_rdoc_ri_paths.rb
 - test/test_rdoc_ri_store.rb
 - test/test_rdoc_ruby_lex.rb
+- test/test_rdoc_rubygems_hook.rb
 - test/test_rdoc_single_class.rb
 - test/test_rdoc_stats.rb
 - test/test_rdoc_task.rb
@@ -338,7 +340,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: rdoc
-rubygems_version: 1.8.2
+rubygems_version: 1.8.5
 signing_key: 
 specification_version: 3
 summary: RDoc produces HTML and command-line documentation for Ruby projects
@@ -359,6 +361,7 @@ test_files:
 - test/test_rdoc_markup.rb
 - test/test_rdoc_markup_attribute_manager.rb
 - test/test_rdoc_markup_document.rb
+- test/test_rdoc_markup_indented_paragraph.rb
 - test/test_rdoc_markup_paragraph.rb
 - test/test_rdoc_markup_parser.rb
 - test/test_rdoc_markup_pre_process.rb
@@ -383,6 +386,7 @@ test_files:
 - test/test_rdoc_ri_paths.rb
 - test/test_rdoc_ri_store.rb
 - test/test_rdoc_ruby_lex.rb
+- test/test_rdoc_rubygems_hook.rb
 - test/test_rdoc_single_class.rb
 - test/test_rdoc_stats.rb
 - test/test_rdoc_task.rb