rdoc 4.1.0 → 4.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0819c40fa54344a9bfad2ebcad36dbb0f5230345
-  data.tar.gz: 20484e07c670f704600a3a2ae4f1708984256f18
+  metadata.gz: e988b11410d57700687c89834e6074da186bf845
+  data.tar.gz: 8dca91d7c35a7145976a31304e408f51d3f361fe
 SHA512:
-  metadata.gz: 6f481cd483af36f9c8954874d035e4436dcc7e0ca654be6032b321f15aa560918c699b020eb8512d4acb96d4304c73b7bea68d2d385c03334560772cc95d8f5f
-  data.tar.gz: 2037b1742a963cd6d78afbda235235b12db016053e410071c765ca95e1e7d7680f765ac274b19f37135fbbb88bcd8c5f7fa1e936bf200010e5213277036a75f2
+  metadata.gz: 57e0b3e2182fbdf7058f6fba5a6f7fe96bbdcc1990be0b646757d73713306be9e09ce6af7bcbe5f4e84cb26e836bab8e41cee59658e84106f0081bb12e2c815e
+  data.tar.gz: 32a2e6177e836b68ecccc47ebcf5555f17baa72f59dac17d2e976423fc7cdc8e70ba92478f1a6912061e72124f7dbb8007922ccd955dbfd5b1ca6a8e03aeef83

data/History.rdoc

@@ -1,3 +1,14 @@
+=== 4.1.1 / 2014-01-09
+
+* Bug fixes
+  * Fixed reporting of undocumented method parameters when including when
+    yield and &block are present.  Pull request #281 by Victor Bilyk.
+  * Fixed merging of rd-style and hash-style comments at the top of a file.
+    Bug #266 by Zachary Scott.
+  * Fixed Document-attr in the C parser.  Bug #271 by Hanmac.
+  * Removed duplicated condition in superclass fixup.  Pull request #282 by
+    Benoit Daloze.
+
 === 4.1.0 / 2013-12-26
 
 * Notable changes

data/Rakefile

@@ -63,7 +63,7 @@ Depending on your version of ruby, you may need to install ruby rdoc/ri data:
 
   require_ruby_version '>= 1.8.7'
   extra_deps     << ['json',     '~> 1.4']
-  extra_dev_deps << ['racc',     '~> 1.4', '!= 1.4.10']
+  extra_dev_deps << ['racc',     '~> 1.4', '> 1.4.10']
   extra_dev_deps << ['minitest', '~> 4']
 
   extra_rdoc_files << 'Rakefile'

data/lib/rdoc.rb

@@ -64,7 +64,7 @@ module RDoc
   ##
   # RDoc version you are using
 
-  VERSION = '4.1.0'
+  VERSION = '4.1.1'
 
   ##
   # Method visibilities

data/lib/rdoc/any_method.rb

@@ -240,7 +240,15 @@ class RDoc::AnyMethod < RDoc::MethodAttr
       return []
     end
 
-    params = params.gsub(/\s+/, '').split ','
+    if @block_params then
+      # If this method has explicit block parameters, remove any explicit
+      # &block
+      params.sub!(/,?\s*&\w+/, '')
+    else
+      params.sub!(/\&(\w+)/, '\1')
+    end
+
+    params = params.gsub(/\s+/, '').split(',').reject(&:empty?)
 
     params.map { |param| param.sub(/=.*/, '') }
   end

data/lib/rdoc/context.rb

@@ -321,10 +321,11 @@ class RDoc::Context < RDoc::CodeObject
     end
 
     # fix up superclass
-    superclass = nil if full_name == 'BasicObject'
-    superclass = nil if full_name == 'Object' and defined?(::BasicObject)
-    superclass = '::BasicObject' if
-      defined?(::BasicObject) and full_name == 'Object'
+    if full_name == 'BasicObject' then
+      superclass = nil
+    elsif full_name == 'Object' then
+      superclass = defined?(::BasicObject) ? '::BasicObject' : nil
+    end
 
     # find the superclass full name
     if superclass then

data/lib/rdoc/parser/c.rb

@@ -594,9 +594,10 @@ class RDoc::Parser::C < RDoc::Parser
                                             \s*#{attr_name}\s*,
                                             #{rw},.*?\)\s*;%xm then
                 $1
-              elsif @content =~ %r%Document-attr:\s#{attr_name}\s*?\n
-                                   ((?>.*?\*/))%xm then
-                $1
+              elsif @content =~ %r%(/\*.*?(?:\s*\*\s*)?)
+                                   Document-attr:\s#{attr_name}\s*?\n
+                                   ((?>(.|\n)*?\*/))%x then
+                "#{$1}\n#{$2}"
               else
                 ''
               end

data/lib/rdoc/parser/ruby.rb

@@ -226,6 +226,7 @@ class RDoc::Parser::Ruby < RDoc::Parser
     comment = ''
     comment.force_encoding @encoding if @encoding
     first_line = true
+    first_comment_tk_class = nil
 
     tk = get_tk
 
@@ -238,6 +239,9 @@ class RDoc::Parser::Ruby < RDoc::Parser
         skip_tkspace
         tk = get_tk
       else
+        break if first_comment_tk_class and not first_comment_tk_class === tk
+        first_comment_tk_class = tk.class
+
         first_line = false
         comment << tk.text << "\n"
         tk = get_tk

data/lib/rdoc/rd/block_parser.rb

@@ -1,6 +1,6 @@
 #
 # DO NOT MODIFY!!!!
-# This file is automatically generated by Racc 1.4.9
+# This file is automatically generated by Racc 1.4.11
 # from Racc grammer file "".
 #
 

data/lib/rdoc/rd/inline_parser.rb

@@ -1,6 +1,6 @@
 #
 # DO NOT MODIFY!!!!
-# This file is automatically generated by Racc 1.4.9
+# This file is automatically generated by Racc 1.4.11
 # from Racc grammer file "".
 #
 

data/lib/rdoc/rubygems_hook.rb

@@ -153,7 +153,13 @@ class RDoc::RubygemsHook
     options = nil
 
     args = @spec.rdoc_options
-    args.concat @spec.require_paths
+
+    if @spec.respond_to? :source_paths then
+      args.concat @spec.source_paths
+    else
+      args.concat @spec.require_paths
+    end
+
     args.concat @spec.extra_rdoc_files
 
     case config_args = Gem.configuration[:rdoc]

data/test/test_rdoc_any_method.rb

@@ -334,6 +334,35 @@ method(a, b) { |c, d| ... }
     assert_equal %w[a b c d], m.param_list
   end
 
+  def test_param_list_empty_params_with_block
+    m = RDoc::AnyMethod.new nil, 'method'
+    m.parent = @c1
+
+    m.params = '()'
+    m.block_params = 'a, b'
+
+    assert_equal %w[a b], m.param_list
+  end
+
+  def test_param_list_ampersand_param_block_params
+    m = RDoc::AnyMethod.new nil, 'method'
+    m.parent = @c1
+
+    m.params = '(a, b, &block)'
+    m.block_params = 'c, d'
+
+    assert_equal %w[a b c d], m.param_list
+  end
+
+  def test_param_list_ampersand_param
+    m = RDoc::AnyMethod.new nil, 'method'
+    m.parent = @c1
+
+    m.params = '(a, b, &block)'
+
+    assert_equal %w[a b block], m.param_list
+  end
+
   def test_param_seq
     m = RDoc::AnyMethod.new nil, 'method'
     m.parent = @c1

data/test/test_rdoc_constant.rb

@@ -8,6 +8,36 @@ class TestRDocConstant < XrefTestCase
     @const = @c1.constants.first
   end
 
+  def test_documented_eh
+    top_level = @store.add_file 'file.rb'
+
+    const = RDoc::Constant.new 'CONST', nil, nil
+    top_level.add_constant const
+
+    refute const.documented?
+
+    const.comment = comment 'comment'
+
+    assert const.documented?
+  end
+
+  def test_documented_eh_alias
+    top_level = @store.add_file 'file.rb'
+
+    const = RDoc::Constant.new 'CONST', nil, nil
+    top_level.add_constant const
+
+    refute const.documented?
+
+    const.is_alias_for = 'C1'
+
+    refute const.documented?
+
+    @c1.add_comment comment('comment'), @top_level
+
+    assert const.documented?
+  end
+
   def test_full_name
     assert_equal 'C1::CONST', @const.full_name
   end

data/test/test_rdoc_parser_c.rb

@@ -736,6 +736,47 @@ rb_define_alias(C, "[]", "index");
     assert_equal "/*\n * comment\n */\n\n", comment.text
   end
 
+  def test_find_attr_comment_document_attr
+    parser= util_parser <<-C
+/*
+ * Document-attr: y
+ * comment
+ */
+    C
+
+    comment = parser.find_attr_comment nil, 'y'
+
+    assert_equal "/*\n * \n * comment\n */", comment.text
+  end
+
+  def test_find_attr_comment_document_attr_oneline
+    parser= util_parser <<-C
+/* Document-attr: y
+ * comment
+ */
+    C
+
+    comment = parser.find_attr_comment nil, 'y'
+
+    assert_equal "/* \n * comment\n */", comment.text
+  end
+
+  def test_find_attr_comment_document_attr_overlap
+    parser= util_parser <<-C
+/* Document-attr: x
+ * comment
+ */
+
+/* Document-attr: y
+ * comment
+ */
+    C
+
+    comment = parser.find_attr_comment nil, 'y'
+
+    assert_equal "/* \n * comment\n */", comment.text
+  end
+
   def test_find_class_comment
     @options.rdoc_include << File.dirname(__FILE__)
 

data/test/test_rdoc_parser_ruby.rb

@@ -63,6 +63,21 @@ class C; end
     assert_equal Encoding::CP852, comment.text.encoding
   end
 
+  def test_collect_first_comment_rd_hash
+    parser = util_parser <<-CONTENT
+=begin
+first
+=end
+
+# second
+class C; end
+    CONTENT
+
+    comment = parser.collect_first_comment
+
+    assert_equal RDoc::Comment.new("first\n\n", @top_level), comment
+  end
+
   def test_get_class_or_module
     ctxt = RDoc::Context.new
     ctxt.store = @store

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rdoc
 version: !ruby/object:Gem::Version
-  version: 4.1.0
+  version: 4.1.1
 platform: ruby
 authors:
 - Eric Hodel
@@ -33,96 +33,96 @@ cert_chain:
   KDyY1VIazVgoC8XvR4h/95/iScPiuglzA+DBG1hip1xScAtw05BrXyUNrc9CEMYU
   wgF94UVoHRp6ywo8I7NP3HcwFQDFNEZPNGXsng==
   -----END CERTIFICATE-----
-date: 2013-12-26 00:00:00.000000000 Z
+date: 2014-01-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.4'
 - !ruby/object:Gem::Dependency
   name: kpeg
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.9'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '5.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '5.2'
 - !ruby/object:Gem::Dependency
   name: rdoc
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '4.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '4.0'
 - !ruby/object:Gem::Dependency
   name: racc
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.4'
-    - - '!='
+    - - ">"
       - !ruby/object:Gem::Version
         version: 1.4.10
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.4'
-    - - '!='
+    - - ">"
       - !ruby/object:Gem::Version
         version: 1.4.10
 - !ruby/object:Gem::Dependency
   name: hoe
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.7'
 description: |-
@@ -152,8 +152,9 @@ extra_rdoc_files:
 - TODO.rdoc
 - Rakefile
 files:
-- .autotest
-- .document
+- ".autotest"
+- ".document"
+- ".gemtest"
 - CONTRIBUTING.rdoc
 - CVE-2013-0256.rdoc
 - ExampleMarkdown.md
@@ -449,7 +450,6 @@ files:
 - test/test_rdoc_top_level.rb
 - test/xref_data.rb
 - test/xref_test_case.rb
-- .gemtest
 homepage: http://docs.seattlerb.org/rdoc
 licenses:
 - Ruby
@@ -462,23 +462,23 @@ post_install_message: |
    = 1.9.1 : gem install rdoc-data; rdoc-data --install
   >= 1.9.2 : nothing to do! Yay!
 rdoc_options:
-- --main
+- "--main"
 - README.rdoc
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: 1.8.7
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '1.3'
 requirements: []
 rubyforge_project: rdoc
-rubygems_version: 2.1.11
+rubygems_version: 2.2.1
 signing_key: 
 specification_version: 4
 summary: RDoc produces HTML and command-line documentation for Ruby projects