rdoc 2.5.5 → 2.5.6

data/History.txt

@@ -1,4 +1,4 @@
-=== 2.5.5 / 2010-04-19
+=== 2.5.6 / 2010-04-22
 
 *NOTE*:
 
@@ -19,6 +19,22 @@ 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.
 
+* Minor Enhancements
+  * Unrecognized RDoc directives are added as metadata to the object they get
+    attached to.
+
+      ##
+      # :my_new_directive: my cool value
+
+    Results in a 'my_new_directive' metadata key with value 'my cool value' on
+    the RDoc::CodeObject it is for
+* Bug Fixes
+  * RDoc no longer prints out "invalid options:" when there were no invalid
+    options.
+  * Fixed link size on Darkfish file pages
+
+=== 2.5.5 / 2010-04-19
+
 * 1 Minor Enhancement
   * Use #binread in RDoc::Markup::PreProcess.  Patch from ruby trunk.
 * 3 Bug Fixes

data/lib/rdoc.rb

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

data/lib/rdoc/any_method.rb

@@ -68,7 +68,6 @@ class RDoc::AnyMethod < RDoc::CodeObject
     @text = text
     @name = name
 
-    @aref                   = nil
     @aliases                = []
     @block_params           = nil
     @call_seq               = nil

data/lib/rdoc/code_object.rb

@@ -54,6 +54,11 @@ class RDoc::CodeObject
 
   attr_accessor :force_documentation
 
+  ##
+  # Hash of arbitrary metadata for this CodeObject
+
+  attr_reader :metadata
+
   ##
   # Our parent CodeObject
 
@@ -75,6 +80,7 @@ class RDoc::CodeObject
   # Creates a new CodeObject that will document itself and its children
 
   def initialize
+    @metadata = {}
     @comment = ''
 
     @document_children   = true

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

@@ -103,9 +103,7 @@ body.file p {
 	list-style: none;
 }
 .indexpage ul :link,
-.indexpage ul :visited,
-.file #documentation ul :link,
-.file #documentation ul :visited {
+.indexpage ul :visited {
 	font-size: 16px;
 }
 

data/lib/rdoc/options.rb

@@ -366,7 +366,7 @@ Usage: #{opt.program_name} [options] [names...]
       end
     end
 
-    if ignored and not quiet then
+    unless ignored.empty? or quiet then
       $stderr.puts "invalid options: #{ignored.join ', '}"
       $stderr.puts '(invalid options are ignored)'
     end

data/lib/rdoc/parser/c.rb

@@ -670,7 +670,7 @@ class RDoc::Parser::C < RDoc::Parser
         @options.title = param
         ''
       else
-        warn "Unrecognized directive :#{directive}:"
+        context.metadata[directive] = param
         false
       end
     end

data/lib/rdoc/parser/ruby.rb

@@ -404,7 +404,7 @@ class RDoc::Parser::Ruby < RDoc::Parser
         @options.title = param
         ''
       else
-        warn "Unrecognized directive :#{directive}:"
+        @top_level.metadata[directive] = param
         false
       end
     end

data/lib/rdoc/parser/simple.rb

@@ -7,6 +7,8 @@ class RDoc::Parser::Simple < RDoc::Parser
 
   parse_files_matching(//)
 
+  attr_reader :content # :nodoc:
+
   ##
   # Prepare to parse a plain file
 
@@ -16,7 +18,8 @@ class RDoc::Parser::Simple < RDoc::Parser
     preprocess = RDoc::Markup::PreProcess.new @file_name, @options.rdoc_include
 
     preprocess.handle @content do |directive, param|
-      warn "Unrecognized directive '#{directive}' in #{@file_name}"
+      top_level.metadata[directive] = param
+      false
     end
   end
 

data/test/test_rdoc_code_object.rb

@@ -61,6 +61,18 @@ class TestRDocCodeObject < XrefTestCase
     assert @co.documented?
   end
 
+  def test_metadata
+    assert_empty @co.metadata
+
+    @co.metadata['markup'] = 'not_rdoc'
+
+    expected = { 'markup' => 'not_rdoc' }
+
+    assert_equal expected, @co.metadata
+
+    assert_equal 'not_rdoc', @co.metadata['markup']
+  end
+
   def test_parent_file_name
     assert_equal '(unknown)', @co.parent_file_name
     assert_equal 'xref_data.rb', @c1.parent_file_name

data/test/test_rdoc_options.rb

@@ -39,5 +39,16 @@ class TestRDocOptions < MiniTest::Unit::TestCase
     assert_match %r%^invalid option: --bogus%, err
   end
 
+  def test_parse_main
+    out, err = capture_io do
+      @options.parse %w[--main MAIN]
+    end
+
+    assert_empty out
+    assert_empty err
+
+    assert_equal 'MAIN', @options.main_page
+  end
+
 end
 

data/test/test_rdoc_parser_c.rb

@@ -406,6 +406,17 @@ Init_Foo(void) {
     assert_equal "a comment for bar", bar.comment
   end
 
+  def test_look_for_directives_in
+    parser = util_parser ''
+
+    comment = "# :markup: not_rdoc\n"
+
+    parser.look_for_directives_in @top_level, comment
+
+    assert_equal "# :markup: not_rdoc\n", comment
+    assert_equal 'not_rdoc', @top_level.metadata['markup']
+  end
+
   def test_define_method
     content = <<-EOF
 /*Method Comment! */

data/test/test_rdoc_parser_ruby.rb

@@ -151,11 +151,14 @@ class TestRDocParserRuby < MiniTest::Unit::TestCase
   def test_look_for_directives_in_unhandled
     util_parser ""
 
-    comment = "# :unhandled: \n# :title: hi\n"
+    comment = "# :unhandled: \n# :markup: not rdoc\n# :title: hi\n"
 
     @parser.look_for_directives_in @top_level, comment
 
-    assert_equal "# :unhandled: \n", comment
+    assert_equal "# :unhandled: \n# :markup: not rdoc\n", comment
+
+    assert_equal nil,        @top_level.metadata['unhandled']
+    assert_equal 'not rdoc', @top_level.metadata['markup']
 
     assert_equal 'hi', @options.title
   end

data/test/test_rdoc_parser_simple.rb

@@ -22,6 +22,15 @@ class TestRDocParserSimple < MiniTest::Unit::TestCase
     @tempfile.close
   end
 
+  def test_initialize_metadata
+    parser = util_parser ":unhandled: \n# :markup: not rdoc\n"
+
+    assert_equal nil,        @top_level.metadata['unhandled']
+    assert_equal 'not rdoc', @top_level.metadata['markup']
+
+    assert_equal ":unhandled: \n# :markup: not rdoc\n", parser.content
+  end
+
   def test_remove_coding_comment
     parser = util_parser <<-TEXT
 # -*- mode: rdoc; coding: utf-8; fill-column: 74; -*-

metadata

@@ -1,12 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: rdoc
 version: !ruby/object:Gem::Version 
+  hash: 23
   prerelease: false
   segments: 
   - 2
   - 5
-  - 5
-  version: 2.5.5
+  - 6
+  version: 2.5.6
 platform: ruby
 authors: 
 - Eric Hodel
@@ -38,16 +39,18 @@ cert_chain:
   x52qPcexcYZR7w==
   -----END CERTIFICATE-----
 
-date: 2010-04-19 00:00:00 -07:00
+date: 2010-04-22 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rubyforge
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 9
         segments: 
         - 2
         - 0
@@ -59,9 +62,11 @@ dependencies:
   name: gemcutter
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 11
         segments: 
         - 0
         - 5
@@ -73,9 +78,11 @@ dependencies:
   name: minitest
   prerelease: false
   requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
+        hash: 9
         segments: 
         - 1
         - 3
@@ -86,9 +93,11 @@ dependencies:
   name: hoe
   prerelease: false
   requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 27
         segments: 
         - 2
         - 5
@@ -282,16 +291,20 @@ rdoc_options:
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 9
       segments: 
       - 1
       - 3
@@ -299,7 +312,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: rdoc
-rubygems_version: 1.3.6
+rubygems_version: 1.3.7.pre.1
 signing_key: 
 specification_version: 3
 summary: RDoc is an application that produces documentation for one or more Ruby source files