rdoc 2.5.4 → 2.5.5

data/History.txt

@@ -1,9 +1,9 @@
-=== 2.5.4 / 2010-04-18
+=== 2.5.5 / 2010-04-19
 
 *NOTE*:
 
 RDoc 2.5 did not save method parameters, so you should upgrade your rdoc-data
-gem to a version > 2.5.1.
+gem to a version >= 2.5.3.
 
 To have ri data for core and stdlib you'll need to:
 
@@ -19,6 +19,18 @@ To have ri data for you gems you'll also need to run:
 
 If you don't want to rebuild the rdoc for `gem server`, add --no-rdoc.
 
+* 1 Minor Enhancement
+  * Use #binread in RDoc::Markup::PreProcess.  Patch from ruby trunk.
+* 3 Bug Fixes
+  * Fixed indentation of method-description lists in Darkfish.  Bug #28081 by
+    Theresa Dwinnell.
+  * Fixed loading RDoc::AnyMethod aliases to no longer infinitely loop.  Bug
+    #28107 by Sven Riedel
+  * Fixed handling of ignored invalid options to continue after the invalid
+    option.
+
+=== 2.5.4 / 2010-04-18
+
 * 2 Minor Enhancements
   * Methods will now be cross-referenced when preceeded with ::.  Ruby Bug
     #3169 by Marc-Andre Lafortune.

data/Rakefile

@@ -13,7 +13,8 @@ Hoe.spec 'rdoc' do
   self.remote_rdoc_dir = ''
   self.testlib = :minitest
 
-  extra_dev_deps << ['minitest', '~> 1.3']
+  extra_dev_deps   << ['minitest', '~> 1.3']
+  extra_rdoc_files << 'Rakefile'
   spec_extras['required_rubygems_version'] = '>= 1.3'
   spec_extras['homepage'] = 'http://rdoc.rubyforge.org'
 end

data/lib/rdoc.rb

@@ -383,7 +383,7 @@ module RDoc
   ##
   # RDoc version you are using
 
-  VERSION = '2.5.4'
+  VERSION = '2.5.5'
 
   ##
   # Name of the dotfile that contains the description of files to be processed

data/lib/rdoc/any_method.rb

@@ -173,6 +173,7 @@ class RDoc::AnyMethod < RDoc::CodeObject
     @dont_rename_initialize = nil
     @is_alias_for           = nil
     @token_stream           = nil
+    @aliases                = []
 
     @name         = array[1]
     @full_name    = array[2]
@@ -181,7 +182,6 @@ class RDoc::AnyMethod < RDoc::CodeObject
     @comment      = array[5]
     @call_seq     = array[6]
     @block_params = array[7]
-    @aliases      = array[8]
     @params       = array[9]
 
     @parent_name = if @full_name =~ /#/ then
@@ -192,8 +192,8 @@ class RDoc::AnyMethod < RDoc::CodeObject
                      name.join '::'
                    end
 
-    array[8].each do |old_name, new_name, comment|
-      add_alias RDoc::Alias.new(nil, old_name, new_name, comment)
+    array[8].each do |new_name, comment|
+      add_alias RDoc::Alias.new(nil, @name, new_name, comment)
     end
   end
 

data/lib/rdoc/generator/template/darkfish/rdoc.css

@@ -270,8 +270,12 @@ ul.link-list .type {
 	margin: 1em 0.4em;
 }
 
+#description li p {
+  margin: 0;
+}
+
 #description ul {
-	margin-left: 2em;
+	margin-left: 1.5em;
 }
 #description ul li {
 	line-height: 1.4em;
@@ -401,6 +405,9 @@ ul.link-list .type {
 #documentation .method-description p + p {
 	margin-bottom: 0.5em;
 }
+#documentation .method-description ul {
+  margin-left: 1.5em;
+}
 
 #documentation .attribute-method-heading {
 	background: url(images/tag_green.png) no-repeat left bottom;

data/lib/rdoc/markup/preprocess.rb

@@ -46,7 +46,12 @@ class RDoc::Markup::PreProcess
 
   def include_file(name, indent)
     if full_name = find_include_file(name) then
-      content = File.read full_name
+      content = if defined?(Encoding) then
+                  File.binread full_name
+                else
+                  File.read full_name
+                end
+      # HACK determine content type and force encoding
       content = content.sub(/\A# .*coding[=:].*$/, '').lstrip
 
       # strip leading '#'s, but only if all lines start with them

data/lib/rdoc/options.rb

@@ -350,13 +350,14 @@ Usage: #{opt.program_name} [options] [names...]
     end
 
     argv.insert(0, *ENV['RDOCOPT'].split) if ENV['RDOCOPT']
+    ignored = []
 
     begin
       opts.parse! argv
     rescue OptionParser::InvalidArgument, OptionParser::InvalidOption => e
-      if ignore_invalid and not quiet then
-        $stderr.puts e
-        $stderr.puts '(invalid options are ignored)'
+      if ignore_invalid then
+        ignored << e.args.join(' ')
+        retry
       else
         $stderr.puts opts
         $stderr.puts
@@ -365,6 +366,11 @@ Usage: #{opt.program_name} [options] [names...]
       end
     end
 
+    if ignored and not quiet then
+      $stderr.puts "invalid options: #{ignored.join ', '}"
+      $stderr.puts '(invalid options are ignored)'
+    end
+
     @op_dir ||= 'doc'
     @files = argv.dup
 

data/test/test_rdoc_options.rb

@@ -14,16 +14,18 @@ class TestRDocOptions < MiniTest::Unit::TestCase
     end
 
     refute_match %r%^Usage: %, err
-    assert_match %r%^invalid option: --bogus%, err
+    assert_match %r%^invalid options: --bogus%, err
   end
 
   def test_parse_ignore_invalid_default
     out, err = capture_io do
-      @options.parse %w[--bogus]
+      @options.parse %w[--bogus --main BLAH]
     end
 
     refute_match %r%^Usage: %, err
-    assert_match %r%^invalid option: --bogus%, err
+    assert_match %r%^invalid options: --bogus%, err
+
+    assert_equal 'BLAH', @options.main_page
   end
 
   def test_parse_ignore_invalid_no

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 2
   - 5
-  - 4
-  version: 2.5.4
+  - 5
+  version: 2.5.5
 platform: ruby
 authors: 
 - Eric Hodel
@@ -38,7 +38,7 @@ cert_chain:
   x52qPcexcYZR7w==
   -----END CERTIFICATE-----
 
-date: 2010-04-18 00:00:00 -07:00
+date: 2010-04-19 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -122,6 +122,7 @@ extra_rdoc_files:
 - Manifest.txt
 - README.txt
 - RI.txt
+- Rakefile
 files: 
 - .autotest
 - .document