rdoc 3.3 → 3.4

data.tar.gz.sig

@@ -1,3 +1 @@
-+&ɢZ���B�/�����r�����3��|�Ę��y�����~?� ��
-�/2G�-[��E>kc�o�+E<�.�"�6h�8��O�^ێ<�f^ v)�j'(�O%C!�W#���F�x���
lUÜé{^f�
-}�~%~�	�nA�uX��<��+;sD�����`1�H��)]ͽ����
+�K��9�io(t�3;s0���p�'���qj�S�?I�cӗj��:�\���%�u!���r��N��2�����
�"����[��|�j�;+ljls*�����TG���5�A�`��ew�f��)�-�R,��*�*���5��<8X�-�~�m,���ЊP��ti�C���ߌ|�"0j�f9Y�F�#��5�����I\

data/History.txt

@@ -1,4 +1,12 @@
-=== 3.3 / ??
+=== 3.4
+
+* Minor enhancements
+  * RDoc::RDoc#document may now be called with an RDoc::Options instance.
+* Bug fixes
+  * Added skips to Encoding tests running on 1.8.
+  * Fixed warnings
+
+=== 3.3 / 2010-01-03
 
 * Minor enhancements
   * The coverage report can now report undocumented method parameters

data/Rakefile

@@ -5,6 +5,7 @@ require 'rdoc/rdoc'
 Hoe.plugin :git
 Hoe.plugin :isolate
 Hoe.plugin :minitest
+Hoe.plugin :rdoc_tags
 
 $rdoc_rakefile = true
 

data/lib/rdoc.rb

@@ -95,7 +95,7 @@ module RDoc
   ##
   # RDoc version you are using
 
-  VERSION = '3.3'
+  VERSION = '3.4'
 
   ##
   # Method visibilities

data/lib/rdoc/options.rb

@@ -71,7 +71,7 @@ class RDoc::Options
   attr_accessor :formatter
 
   ##
-  # Description of the output generator (set with the <tt>-fmt</tt> option)
+  # Description of the output generator (set with the <tt>--fmt</tt> option)
 
   attr_accessor :generator
 
@@ -246,6 +246,35 @@ class RDoc::Options
     @title ||= string
   end
 
+  ##
+  # Completes any unfinished option setup business such as filtering for
+  # existent files, creating a regexp for #exclude and setting a default
+  # #template.
+
+  def finish
+    @op_dir ||= 'doc'
+
+    @rdoc_include << "." if @rdoc_include.empty?
+
+    if @exclude.empty? then
+      @exclude = nil
+    else
+      @exclude = Regexp.new(@exclude.join("|"))
+    end
+
+    check_files
+
+    # If no template was specified, use the default template for the output
+    # formatter
+
+    unless @template then
+      @template     = @generator_name
+      @template_dir = template_dir_for @template
+    end
+
+    self
+  end
+
   ##
   # Returns a properly-space list of generators and their descriptions.
 
@@ -273,7 +302,7 @@ class RDoc::Options
   end
 
   ##
-  # Parse command line options.
+  # Parses command line options.
 
   def parse(argv)
     ignore_invalid = true
@@ -677,26 +706,9 @@ Usage: #{opt.program_name} [options] [names...]
       end
     end
 
-    @op_dir ||= 'doc'
     @files = argv.dup
 
-    @rdoc_include << "." if @rdoc_include.empty?
-
-    if @exclude.empty? then
-      @exclude = nil
-    else
-      @exclude = Regexp.new(@exclude.join("|"))
-    end
-
-    check_files
-
-    # If no template was specified, use the default template for the output
-    # formatter
-
-    unless @template then
-      @template     = @generator_name
-      @template_dir = template_dir_for @template
-    end
+    finish
   end
 
   ##
@@ -733,7 +745,10 @@ Usage: #{opt.program_name} [options] [names...]
     @generator_name = generator_name
     @generator_options << @generator
 
-    @generator.setup_options self if @generator.respond_to? :setup_options
+    if @generator.respond_to? :setup_options then
+      @option_parser ||= OptionParser.new
+      @generator.setup_options self 
+    end
   end
 
   ##

data/lib/rdoc/rdoc.rb

@@ -382,21 +382,30 @@ The internal error was:
   end
 
   ##
-  # Format up one or more files according to the given arguments.
+  # Generates documentation or a coverage report depending upon the settings
+  # in +options+.
   #
-  # For simplicity, +argv+ is an array of strings, equivalent to the strings
-  # that would be passed on the command line. (This isn't a coincidence, as
-  # we _do_ pass in ARGV when running interactively). For a list of options,
-  # see <tt>rdoc --help</tt>. By default, output will be stored in a directory
-  # called +doc+ below the current directory, so make sure you're somewhere
-  # writable before invoking.
-
-  def document(argv)
+  # +options+ can be either an RDoc::Options instance or an array of strings
+  # equivalent to the strings that would be passed on the command line like
+  # <tt>%w[-q -o doc -t My\ Doc\ Title]</tt>.  #document will automatically
+  # call RDoc::Options#finish if an options instance was given.
+  #
+  # For a list of options, see either RDoc::Options or <tt>rdoc --help</tt>.
+  #
+  # By default, output will be stored in a directory called "doc" below the
+  # current directory, so make sure you're somewhere writable before invoking.
+
+  def document options
     RDoc::TopLevel.reset
     RDoc::Parser::C.reset
 
-    @options = RDoc::Options.new
-    @options.parse argv
+    if RDoc::Options === options then
+      @options = options
+      @options.finish
+    else
+      @options = RDoc::Options.new
+      @options.parse options
+    end
 
     if @options.pipe then
       handle_pipe
@@ -478,6 +487,7 @@ begin
         load extension
       rescue => e
         warn "error loading #{extension.inspect}: #{e.message} (#{e.class})"
+        warn "\t#{e.backtrace.join "\n\t"}" if $DEBUG
       end
     end
   end

data/lib/rdoc/stats.rb

@@ -30,6 +30,7 @@ class RDoc::Stats
     @num_files = num_files
 
     @coverage_level = 0
+    @doc_items = nil
     @fully_documented = nil
     @num_params = 0
     @percent_doc = nil

data/test/test_rdoc_code_object.rb

@@ -31,6 +31,8 @@ class TestRDocCodeObject < XrefTestCase
   end
 
   def test_comment_equals_encoding
+    skip "Encoding not implemented" unless Object.const_defined? :Encoding
+
     refute_equal Encoding::UTF_8, ''.encoding, 'Encoding sanity check'
 
     input = 'text'
@@ -43,6 +45,8 @@ class TestRDocCodeObject < XrefTestCase
   end
 
   def test_comment_equals_encoding_blank
+    skip "Encoding not implemented" unless Object.const_defined? :Encoding
+
     refute_equal Encoding::UTF_8, ''.encoding, 'Encoding sanity check'
 
     input = ''

data/test/test_rdoc_options.rb

@@ -345,16 +345,38 @@ file 'unreadable' not readable
       def self.op() @op end
     end
 
-    RDoc::RDoc::GENERATORS['TestGenerator'] = test_generator
+    RDoc::RDoc::GENERATORS['test'] = test_generator
 
-    @options.setup_generator 'TestGenerator'
+    @options.setup_generator 'test'
 
     assert_equal test_generator, @options.generator
     assert_equal [test_generator], @options.generator_options
 
     assert_equal @options, test_generator.op
   ensure
-    RDoc::RDoc::GENERATORS.delete 'TestGenerator'
+    RDoc::RDoc::GENERATORS.delete 'test'
+  end
+
+  def test_setup_generator_no_option_parser
+    test_generator = Class.new do
+      def self.setup_options op
+        op.option_parser.separator nil
+        @op = op
+      end
+
+      def self.op() @op end
+    end
+
+    RDoc::RDoc::GENERATORS['test'] = test_generator
+
+    @options.setup_generator 'test'
+
+    assert_equal test_generator, @options.generator
+    assert_equal [test_generator], @options.generator_options
+
+    assert_equal @options, test_generator.op
+  ensure
+    RDoc::RDoc::GENERATORS.delete 'test'
   end
 
   def test_update_output_dir

data/test/test_rdoc_parser_ruby.rb

@@ -643,20 +643,6 @@ end
     assert_equal 1, const_fail_meta.attributes.length
   end
 
-  def test_parse_class_nested_superclass
-    foo = RDoc::NormalModule.new 'Foo'
-    foo.parent = @top_level
-
-    util_parser "class Bar < Super\nend"
-
-    tk = @parser.get_tk
-
-    @parser.parse_class foo, RDoc::Parser::Ruby::NORMAL, tk, ''
-
-    bar = foo.classes.first
-    assert_equal 'Super', bar.superclass
-  end
-
   def test_parse_class_nested_superclass
     util_top_level
     foo = @top_level.add_module RDoc::NormalModule, 'Foo'

data/test/test_rdoc_ri_driver.rb

@@ -570,12 +570,12 @@ Foo::Bar#bother
   end
 
   def test_name_regexp
-    assert_equal /^RDoc::AnyMethod#new$/,
+    assert_equal %r%^RDoc::AnyMethod#new$%,
                  @driver.name_regexp('RDoc::AnyMethod#new')
-    assert_equal /^RDoc::AnyMethod::new$/,
+    assert_equal %r%^RDoc::AnyMethod::new$%,
                  @driver.name_regexp('RDoc::AnyMethod::new')
 
-    assert_equal /^RDoc::AnyMethod(#|::)new$/,
+    assert_equal %r%^RDoc::AnyMethod(#|::)new$%,
                  @driver.name_regexp('RDoc::AnyMethod.new')
   end
 

data/test/test_rdoc_text.rb

@@ -145,6 +145,8 @@ The comments associated with
   end
 
   def test_strip_newlines_encoding
+    skip "Encoding not implemented" unless Object.const_defined? :Encoding
+
     assert_equal Encoding::UTF_8, ''.encoding, 'Encoding sanity check'
 
     text = " \n"

metadata

@@ -1,12 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: rdoc
 version: !ruby/object:Gem::Version 
-  hash: 1
+  hash: 15
   prerelease: false
   segments: 
   - 3
-  - 3
-  version: "3.3"
+  - 4
+  version: "3.4"
 platform: ruby
 authors: 
 - Eric Hodel
@@ -38,7 +38,7 @@ cert_chain:
   x52qPcexcYZR7w==
   -----END CERTIFICATE-----
 
-date: 2011-01-03 00:00:00 -08:00
+date: 2011-01-06 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 

metadata.gz.sig

@@ -1,2 +1,3 @@
-~�:h�-ɓ����C^���
-/��sݦ�ϟS|Ѿ=��f�H��R_�AN!�wK��8{&s}�xN'�4�tk}z<�N“Q�W��èˢ����_���1�ĊB��l�k�� #�������������+�Ʃ|�w��|N�����{=u���b�q�7g�_$t���N�
+.��d:��P�	��l���$���r�ɢ	8�����\FJ����5�l���nJ���3Z��R��˸\s`����s(�蚯+�����
+n	��-�PH6�r�ZGThU~P}
+�����]���!5+��<"��E�-��F�ӣb]�z�'l�<�-V��#U��-c��/$����P��W)�[������IŦ�z��j 
�O����@�;�@_�L�����mu����5I��M-l*J$��Z