rdoc 3.12.1 → 3.12.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 273a837395647f78a5238c46c58b00040ac02b8c
-  data.tar.gz: 0140308e6098631af5fa1fb3cb1fd751f81023ca
+  metadata.gz: 3b704b430d22c0010c5bf44dff765cdeff8332cf
+  data.tar.gz: ed7f5ac64e53d6e684172983e26fb417af9e826c
 SHA512:
-  metadata.gz: 47b2995d687fdb88b09ab589e93cc1b63b078387e7ab12ea5cb38b82cac4b44412a3f801b985c96021a298ebdd1f47fcf4e6828fefe7205084267c3567dc3743
-  data.tar.gz: 079a4eaba7614a7002d98d4d43a12afb4213b8d2364d29bb58954fad1f560a4b21ccb0e80e8c7b09f2270a783ba9caba46b918dadeaacedb0f54871a9607004c
+  metadata.gz: 5b3e509ae9b95e66eead63f2f0252f98ec04c3c9779df939ceddad9c0c9d5e71f0e107868fb33fe3e9f445e07a671c1e3de33236952b4fc2e54ca85592dea971
+  data.tar.gz: 06800292e99ab9b0648acc38922d1034c124a23df8ed31ac22453449ce90b591f5bc9afa5181857492245511eb2ca33d5136e0dee76702785bfc20fa72449b86

checksums.yaml.gz.sig

@@ -1 +1,2 @@
-P���X�Lk��5�d�wD��(��W��h�AY9u^�)��g1�i����$�>9t;#h��㟲98QI�������IDŽ ��:2���E��Kf�fPP˂x��:a(��~!נ�"���7;��Y�ܠﰪ�W��e�8Y\Ӹv8��9��N��*&�o�=�X2�\���wp7K��]f8�Iҷ#���o�8e�rW���Vwyf��5���\!�I��ѡ�����A�]��Z��iY�!�W۠XIC
+D��[
�8��ǚCM������Z?�����������������V�8��(R~�ܤ���j<Zy�@
+z� k�^��!���b#�}F�6c��.��(���!��ډ��I�#�dYv��t��*���F��S��B�rrS�w�ų�yǨ2�����Bɢ

data/History.rdoc

@@ -1,3 +1,17 @@
+=== 3.12.2 / 2013-02-24
+
+* Bug fixes
+  * Fixed bug in syntax-highlighting that would corrupt regular expressions.
+    Ruby Bug #6488 by Benny Lyne Amorsen.
+  * Fixed lexing of character syntax (<code>?x</code>).  Reported by Xavier
+    Noria.
+  * Fixed tokenization of % when it is not followed by a $-string type
+  * Fixed display of __END__ in documentation examples in HTML output
+  * Fixed tokenization of reserved words used as new-style hash keys
+  * Fixed HEREDOC output for the limited case of a heredoc followed by a line
+    end.  When a HEREDOC is not followed by a line end RDoc is not currently
+    smart enough to restore the source correctly.  Bug #162 by Zachary Scott.
+
 === 3.12.1 / 2013-02-05
 
 * Bug fixes

data/lib/rdoc.rb

@@ -108,7 +108,7 @@ module RDoc
   ##
   # RDoc version you are using
 
-  VERSION = '3.12.1'
+  VERSION = '3.12.2'
 
   ##
   # Method visibilities

data/lib/rdoc/ruby_lex.rb

@@ -412,7 +412,7 @@ class RDoc::RubyLex
   def lex_init()
     @OP = IRB::SLex.new
     @OP.def_rules("\0", "\004", "\032") do |op, io|
-      Token(TkEND_OF_SCRIPT)
+      Token(TkEND_OF_SCRIPT, '')
     end
 
     @OP.def_rules(" ", "\t", "\f", "\r", "\13") do |op, io|
@@ -536,13 +536,8 @@ class RDoc::RubyLex
           @lex_state = EXPR_BEG;
           Token(TkQUESTION)
         else
-          str = ch
-          if ch == '\\'
-            str << read_escape
-          end
           @lex_state = EXPR_END
-          str << (ch.respond_to?(:ord) ? ch.ord : ch[0])
-          Token(TkINTEGER, str)
+          Token(TkSTRING, ch)
         end
       end
     end
@@ -813,7 +808,8 @@ class RDoc::RubyLex
 
     @OP.def_rule("_") do
       if peek_match?(/_END__/) and @lex_state == EXPR_BEG then
-        Token(TkEND_OF_SCRIPT)
+        6.times { getc }
+        Token(TkEND_OF_SCRIPT, '__END__')
       else
         ungetc
         identify_identifier
@@ -861,7 +857,7 @@ class RDoc::RubyLex
   end
 
   IDENT_RE = if defined? Encoding then
-               /[\w\u0080-\uFFFF]/u
+               eval '/[\w\u{0080}-\u{FFFFF}]/u' # 1.8 can't parse \u{}
              else
                /[\w\x80-\xFF]/
              end
@@ -940,6 +936,8 @@ class RDoc::RubyLex
                   @indent += 1
                   @indent_stack.push token_c
                 end
+              else
+                token_c = TkIDENTIFIER
               end
 
             elsif DEINDENT_CLAUSE.include?(token)
@@ -984,12 +982,13 @@ class RDoc::RubyLex
       indent = true
     end
     if /['"`]/ =~ ch
-      lt = ch
+      user_quote = lt = ch
       quoted = ""
       while (c = getc) && c != lt
         quoted.concat c
       end
     else
+      user_quote = nil
       lt = '"'
       quoted = ch.dup
       while (c = getc) && c =~ /\w/
@@ -1009,8 +1008,17 @@ class RDoc::RubyLex
       end
     end
 
+    output_heredoc = reserve.join =~ /\A\r?\n\z/
+
+    if output_heredoc then
+      doc = '<<'
+      doc << '-' if indent
+      doc << "#{user_quote}#{quoted}#{user_quote}\n"
+    else
+      doc = '"'
+    end
+
     @here_header = false
-    doc = '"'
     while l = gets
       l = l.sub(/(:?\r)?\n\z/, "\n")
       if (indent ? l.strip : l.chomp) == quoted
@@ -1018,7 +1026,12 @@ class RDoc::RubyLex
       end
       doc << l
     end
-    doc << '"'
+
+    if output_heredoc then
+      doc << l.chomp
+    else
+      doc << '"'
+    end
 
     @here_header = true
     @here_readed.concat reserve
@@ -1026,9 +1039,10 @@ class RDoc::RubyLex
       ungetc ch
     end
 
+    token_class = output_heredoc ? RDoc::RubyLex::TkHEREDOC : Ltype2Token[lt]
     @ltype = ltback
     @lex_state = EXPR_END
-    Token(Ltype2Token[lt], doc)
+    Token(token_class, doc)
   end
 
   def identify_quotation
@@ -1039,7 +1053,7 @@ class RDoc::RubyLex
       type = nil
       lt = "\""
     else
-      raise Error, "unknown type of %string #{type.inspect}"
+      return Token(TkMOD, '%')
     end
     #     if ch !~ /\W/
     #       ungetc
@@ -1163,7 +1177,7 @@ class RDoc::RubyLex
     @ltype = ltype
     @quoted = quoted
 
-    str = if ltype == quoted and %w[" '].include? ltype then
+    str = if ltype == quoted and %w[" ' /].include? ltype then
             ltype.dup
           elsif RUBY_VERSION > '1.9' then
             "%#{type or PERCENT_LTYPE.key ltype}#{PERCENT_PAREN_REV[quoted]}"
@@ -1189,14 +1203,18 @@ class RDoc::RubyLex
           else
             ungetc
           end
-        elsif ch == '\\' and @ltype == "'" #'
-          case ch = getc
-          when "\\", "\n", "'"
+        elsif ch == '\\'
+          if %w[' /].include? @ltype then
+            case ch = getc
+            when "\\", "\n", "'"
+            when @ltype
+              str << ch
+            else
+              ungetc
+            end
           else
-            ungetc
+            str << read_escape
           end
-        elsif ch == '\\' #'
-          str << read_escape
         end
 
         if close then

data/lib/rdoc/ruby_token.rb

@@ -331,6 +331,7 @@ module RDoc::RubyToken
     [:TkINTEGER,    TkVal],
     [:TkFLOAT,      TkVal],
     [:TkSTRING,     TkVal],
+    [:TkHEREDOC,    TkVal],
     [:TkXSTRING,    TkVal],
     [:TkREGEXP,     TkVal],
     [:TkSYMBOL,     TkVal],

data/test/test_rdoc_markup_to_html.rb

@@ -350,14 +350,14 @@ class TestRDocMarkupToHtml < RDoc::Markup::FormatterTestCase
     rdoc.options = options
     RDoc::RDoc.current = rdoc
 
-    verb = @RM::Verbatim.new("a %z'foo' # => blah\n")
+    verb = @RM::Verbatim.new("a % 09 # => blah\n")
 
     @to.start_accepting
     @to.accept_verbatim verb
 
     expected = <<-EXPECTED
 
-<pre>a %z'foo' # =&gt; blah
+<pre>a % 09 # =&gt; blah
 </pre>
     EXPECTED
 

data/test/test_rdoc_markup_to_html_snippet.rb

@@ -379,19 +379,19 @@ class TestRDocMarkupToHtmlSnippet < RDoc::Markup::FormatterTestCase
     rdoc.options = options
     RDoc::RDoc.current = rdoc
 
-    verb = @RM::Verbatim.new("a %z'foo' # => blah\n")
+    verb = @RM::Verbatim.new("a % 09 # => blah\n")
 
     @to.start_accepting
     @to.accept_verbatim verb
 
     expected = <<-EXPECTED
 
-<pre>a %z'foo' # =&gt; blah
+<pre>a % 09 # =&gt; blah
 </pre>
     EXPECTED
 
     assert_equal expected, @to.res.join
-    assert_equal 19, @to.characters
+    assert_equal 16, @to.characters
   end
 
   def test_add_paragraph
@@ -543,11 +543,12 @@ Look for directives in a normal comment block:
 This routine modifies its +comment+ parameter.
     RDOC
 
+    inner = CGI.escapeHTML "# Don't display comment from this point forward"
     expected = <<-EXPECTED
 <p>Look for directives in a normal comment block:
 
 <pre># :stopdoc:
-# Don't display comment from this point forward</pre>
+#{inner}</pre>
     EXPECTED
 
     actual = @to.convert rdoc

data/test/test_rdoc_ruby_lex.rb

@@ -1,3 +1,5 @@
+# coding: UTF-8
+
 require 'rdoc/test_case'
 
 class TestRDocRubyLex < RDoc::TestCase
@@ -30,6 +32,28 @@ class TestRDocRubyLex < RDoc::TestCase
     assert_equal expected, tokens
   end
 
+  def test_class_tokenize___END__
+    tokens = RDoc::RubyLex.tokenize '__END__', nil
+
+    expected = [
+      @TK::TkEND_OF_SCRIPT.new(0, 1, 0, '__END__'),
+      @TK::TkNL           .new(7, 1, 7, "\n"),
+    ]
+
+    assert_equal expected, tokens
+  end
+
+  def test_class_tokenize_character_literal
+    tokens = RDoc::RubyLex.tokenize "?\\", nil
+
+    expected = [
+      @TK::TkSTRING.new( 0, 1,  0, "\\"),
+      @TK::TkNL    .new( 2, 1,  2, "\n"),
+    ]
+
+    assert_equal expected, tokens
+  end
+
   def test_class_tokenize_def_heredoc
     tokens = RDoc::RubyLex.tokenize <<-'RUBY', nil
 def x
@@ -46,7 +70,8 @@ end
       @TK::TkIDENTIFIER.new( 4, 1,  4, 'x'),
       @TK::TkNL        .new( 5, 1,  5, "\n"),
       @TK::TkSPACE     .new( 6, 2,  0, '  '),
-      @TK::TkSTRING    .new( 8, 2,  2, %Q{"Line 1\nLine 2\n"}),
+      @TK::TkHEREDOC   .new( 8, 2,  2,
+                            %Q{<<E\nLine 1\nLine 2\nE}),
       @TK::TkNL        .new(27, 5, 28, "\n"),
       @TK::TkEND       .new(28, 6,  0, 'end'),
       @TK::TkNL        .new(31, 6, 28, "\n"),
@@ -55,12 +80,73 @@ end
     assert_equal expected, tokens
   end
 
+  def test_class_tokenize_hash_symbol
+    tokens = RDoc::RubyLex.tokenize '{ class:"foo" }', nil
+
+    expected = [
+      @TK::TkLBRACE    .new( 0, 1,  0, '{'),
+      @TK::TkSPACE     .new( 1, 1,  1, ' '),
+      @TK::TkIDENTIFIER.new( 2, 1,  2, 'class'),
+      @TK::TkSYMBEG    .new( 7, 1,  7, ':'),
+      @TK::TkSTRING    .new( 8, 1,  8, '"foo"'),
+      @TK::TkSPACE     .new(13, 1, 13, ' '),
+      @TK::TkRBRACE    .new(14, 1, 14, '}'),
+      @TK::TkNL        .new(15, 1, 15, "\n"),
+    ]
+
+    assert_equal expected, tokens
+  end
+
+  def test_class_tokenize_heredoc_CR_NL
+    tokens = RDoc::RubyLex.tokenize <<-RUBY, nil
+string = <<-STRING\r
+Line 1\r
+Line 2\r
+  STRING\r
+    RUBY
+
+    expected = [
+      @TK::TkIDENTIFIER.new( 0, 1,  0, 'string'),
+      @TK::TkSPACE     .new( 6, 1,  6, ' '),
+      @TK::TkASSIGN    .new( 7, 1,  7, '='),
+      @TK::TkSPACE     .new( 8, 1,  8, ' '),
+      @TK::TkHEREDOC   .new( 9, 1,  9,
+                            %Q{<<-STRING\nLine 1\nLine 2\n  STRING}),
+      @TK::TkSPACE     .new(44, 4, 45, "\r"),
+      @TK::TkNL        .new(45, 4, 46, "\n"),
+    ]
+
+    assert_equal expected, tokens
+  end
+
+  def test_class_tokenize_heredoc_call
+    tokens = RDoc::RubyLex.tokenize <<-'RUBY', nil
+string = <<-STRING.chomp
+Line 1
+Line 2
+  STRING
+    RUBY
+
+    expected = [
+      @TK::TkIDENTIFIER.new( 0, 1,  0, 'string'),
+      @TK::TkSPACE     .new( 6, 1,  6, ' '),
+      @TK::TkASSIGN    .new( 7, 1,  7, '='),
+      @TK::TkSPACE     .new( 8, 1,  8, ' '),
+      @TK::TkSTRING    .new( 9, 1,  9, %Q{"Line 1\nLine 2\n"}),
+      @TK::TkDOT       .new(41, 4, 42, '.'),
+      @TK::TkIDENTIFIER.new(42, 4, 43, 'chomp'),
+      @TK::TkNL        .new(47, 4, 48, "\n"),
+    ]
+
+    assert_equal expected, tokens
+  end
+
   def test_class_tokenize_heredoc_indent
     tokens = RDoc::RubyLex.tokenize <<-'RUBY', nil
 string = <<-STRING
 Line 1
 Line 2
-STRING
+  STRING
     RUBY
 
     expected = [
@@ -68,8 +154,9 @@ STRING
       @TK::TkSPACE     .new( 6, 1,  6, ' '),
       @TK::TkASSIGN    .new( 7, 1,  7, '='),
       @TK::TkSPACE     .new( 8, 1,  8, ' '),
-      @TK::TkSTRING    .new( 9, 1,  9, %Q{"Line 1\nLine 2\n"}),
-      @TK::TkNL        .new(39, 4, 40, "\n"),
+      @TK::TkHEREDOC   .new( 9, 1,  9,
+                            %Q{<<-STRING\nLine 1\nLine 2\n  STRING}),
+      @TK::TkNL        .new(41, 4, 42, "\n"),
     ]
 
     assert_equal expected, tokens
@@ -87,13 +174,47 @@ U
       @TK::TkSPACE     .new( 1, 1,  1, ' '),
       @TK::TkIDENTIFIER.new( 2, 1,  2, 'b'),
       @TK::TkSPACE     .new( 3, 1,  3, ' '),
-      @TK::TkSTRING    .new( 4, 1,  4, %Q{"%N\n"}),
+      @TK::TkHEREDOC   .new( 4, 1,  4, %Q{<<-U\n%N\nU}),
       @TK::TkNL        .new(13, 3, 14, "\n"),
     ]
 
     assert_equal expected, tokens
   end
 
+  def test_class_tokenize_identifier_high_unicode
+    tokens = RDoc::RubyLex.tokenize '𝖒', nil
+
+    expected = @TK::TkIDENTIFIER.new(0, 1, 0, '𝖒')
+
+    assert_equal expected, tokens.first
+  end
+
+  def test_class_tokenize_percent_1
+    tokens = RDoc::RubyLex.tokenize 'v%10==10', nil
+
+    expected = [
+      @TK::TkIDENTIFIER.new(0, 1, 0, 'v'),
+      @TK::TkMOD.new(       1, 1, 1, '%'),
+      @TK::TkINTEGER.new(   2, 1, 2, '10'),
+      @TK::TkEQ.new(        4, 1, 4, '=='),
+      @TK::TkINTEGER.new(   6, 1, 6, '10'),
+      @TK::TkNL.new(        8, 1, 8, "\n"),
+    ]
+
+    assert_equal expected, tokens
+  end
+
+  def test_class_tokenize_percent_r
+    tokens = RDoc::RubyLex.tokenize '%r[hi]', nil
+
+    expected = [
+      @TK::TkREGEXP.new( 0, 1,  0, '%r[hi]'),
+      @TK::TkNL    .new( 6, 1, 6, "\n"),
+    ]
+
+    assert_equal expected, tokens
+  end
+
   def test_class_tokenize_percent_w
     tokens = RDoc::RubyLex.tokenize '%w[hi]', nil
 
@@ -105,6 +226,39 @@ U
     assert_equal expected, tokens
   end
 
+  def test_class_tokenize_regexp
+    tokens = RDoc::RubyLex.tokenize "/hay/", nil
+
+    expected = [
+      @TK::TkREGEXP.new( 0, 1,  0, "/hay/"),
+      @TK::TkNL    .new( 5, 1,  5, "\n"),
+    ]
+
+    assert_equal expected, tokens
+  end
+
+  def test_class_tokenize_regexp_backref
+    tokens = RDoc::RubyLex.tokenize "/[csh](..) [csh]\\1 in/", nil
+
+    expected = [
+      @TK::TkREGEXP.new( 0, 1,  0, "/[csh](..) [csh]\\1 in/"),
+      @TK::TkNL    .new(22, 1, 22, "\n"),
+    ]
+
+    assert_equal expected, tokens
+  end
+
+  def test_class_tokenize_regexp_escape
+    tokens = RDoc::RubyLex.tokenize "/\\//", nil
+
+    expected = [
+      @TK::TkREGEXP.new( 0, 1,  0, "/\\//"),
+      @TK::TkNL    .new( 4, 1,  4, "\n"),
+    ]
+
+    assert_equal expected, tokens
+  end
+
   def test_class_tokenize_string
     tokens = RDoc::RubyLex.tokenize "'hi'", nil
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rdoc
 version: !ruby/object:Gem::Version
-  version: 3.12.1
+  version: 3.12.2
 platform: ruby
 authors:
 - Eric Hodel
@@ -33,92 +33,92 @@ cert_chain:
   Q8Tno9S3e4XGGP1ZWfLrTWEJbavFfhGHut2iMRwfC7s/YILAHNATopaJdH9DNpd1
   U81zGHMUBOvz/VGT6wJwYJ3emS2nfA2NOHFfgA==
   -----END CERTIFICATE-----
-date: 2013-02-06 00:00:00.000000000 Z
+date: 2013-02-25 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: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '4.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '4.3'
 - !ruby/object:Gem::Dependency
   name: rdoc
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '3.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '3.10'
 - !ruby/object:Gem::Dependency
   name: racc
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.4'
 - !ruby/object:Gem::Dependency
   name: ZenTest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '4'
 - !ruby/object:Gem::Dependency
   name: hoe
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '3.3'
+        version: '3.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '3.3'
+        version: '3.5'
 description: |-
   RDoc produces HTML and command-line documentation for Ruby projects.  RDoc
   includes the +rdoc+ and +ri+ tools for generating and displaying online
@@ -147,8 +147,8 @@ extra_rdoc_files:
 - bin/rdoc
 - Rakefile
 files:
-- ".autotest"
-- ".document"
+- .autotest
+- .document
 - CVE-2013-0256.rdoc
 - DEVELOPERS.rdoc
 - History.rdoc
@@ -378,7 +378,7 @@ files:
 - test/test_rdoc_top_level.rb
 - test/xref_data.rb
 - test/xref_test_case.rb
-- ".gemtest"
+- .gemtest
 homepage: http://docs.seattlerb.org/rdoc
 licenses: []
 metadata: {}
@@ -390,23 +390,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.0.0.rc.2
+rubygems_version: 2.0.0
 signing_key: 
 specification_version: 4
 summary: RDoc produces HTML and command-line documentation for Ruby projects

metadata.gz.sig

@@ -1 +1,2 @@
-F���Z�2���CнH�L
+�$�*�V@׮8��ɵ�L��Ni����_#�#EE����<s���.H���)p���2���(+�w��*�Oõ]�C����{�N֯1=��u�u���fv�coR?8W”d!�H�;�c���J��Ω���?Gn!3�@��'ZG�k�

+5)��9�:��]�ِA�������D���"�́��4�IW)u"��*����6PC� +��-�����t$0V[Y�Gȿ��V�AW;��8�