rdoc 5.1.0 → 6.3.1

data/lib/rdoc/parser/ruby_tools.rb

@@ -1,12 +1,9 @@
-# frozen_string_literal: false
+# frozen_string_literal: true
 ##
-# Collection of methods for writing parsers against RDoc::RubyLex and
-# RDoc::RubyToken
+# Collection of methods for writing parsers
 
 module RDoc::Parser::RubyTools
 
-  include RDoc::RubyToken
-
   ##
   # Adds a token listener +obj+, but you should probably use token_listener
 
@@ -22,37 +19,24 @@ module RDoc::Parser::RubyTools
     tk = nil
 
     if @tokens.empty? then
-      tk = @scanner.token
-      @read.push @scanner.get_readed
-      puts "get_tk1 => #{tk.inspect}" if $TOKEN_DEBUG
+      if @scanner_point >= @scanner.size
+        return nil
+      else
+        tk = @scanner[@scanner_point]
+        @scanner_point += 1
+        @read.push tk[:text]
+      end
     else
       @read.push @unget_read.shift
       tk = @tokens.shift
-      puts "get_tk2 => #{tk.inspect}" if $TOKEN_DEBUG
     end
 
-    tk = nil if TkEND_OF_SCRIPT === tk
-
-    if TkSYMBEG === tk then
-      set_token_position tk.line_no, tk.char_no
-
-      case tk1 = get_tk
-      when TkId, TkOp, TkSTRING, TkDSTRING, TkSTAR, TkAMPER then
-        if tk1.respond_to?(:name) then
-          tk = Token(TkSYMBOL).set_text(":" + tk1.name)
-        else
-          tk = Token(TkSYMBOL).set_text(":" + tk1.text)
-        end
-
-        # remove the identifier we just read to replace it with a symbol
-        @token_listeners.each do |obj|
-          obj.pop_token
-        end if @token_listeners
-      else
-        tk = tk1
-      end
+    if tk == nil || :on___end__ == tk[:kind]
+      tk = nil
     end
 
+    return nil unless tk
+
     # inform any listeners of our shiny new token
     @token_listeners.each do |obj|
       obj.add_token(tk)
@@ -122,19 +106,34 @@ module RDoc::Parser::RubyTools
     @tokens     = []
     @unget_read = []
     @nest = 0
+    @scanner_point = 0
+  end
+
+  ##
+  # Skips whitespace tokens including newlines
+
+  def skip_tkspace
+    tokens = []
+
+    while (tk = get_tk) and (:on_sp == tk[:kind] or :on_nl == tk[:kind] or :on_ignored_nl == tk[:kind]) do
+      tokens.push(tk)
+    end
+
+    unget_tk(tk)
+    tokens
   end
 
   ##
-  # Skips whitespace tokens including newlines if +skip_nl+ is true
+  # Skips whitespace tokens excluding newlines
 
-  def skip_tkspace(skip_nl = true) # HACK dup
+  def skip_tkspace_without_nl
     tokens = []
 
-    while TkSPACE === (tk = get_tk) or (skip_nl and TkNL === tk) do
-      tokens.push tk
+    while (tk = get_tk) and :on_sp == tk[:kind] do
+      tokens.push(tk)
     end
 
-    unget_tk tk
+    unget_tk(tk)
     tokens
   end
 

data/lib/rdoc/parser/simple.rb

@@ -1,4 +1,4 @@
-# frozen_string_literal: false
+# frozen_string_literal: true
 ##
 # Parse a non-source file. We basically take the whole thing as one big
 # comment.
@@ -19,7 +19,7 @@ class RDoc::Parser::Simple < RDoc::Parser
 
     preprocess = RDoc::Markup::PreProcess.new @file_name, @options.rdoc_include
 
-    preprocess.handle @content, @top_level
+    @content = preprocess.handle @content, @top_level
   end
 
   ##
@@ -52,7 +52,7 @@ class RDoc::Parser::Simple < RDoc::Parser
   def remove_private_comment comment
     # Workaround for gsub encoding for Ruby 1.9.2 and earlier
     empty = ''
-    empty.force_encoding comment.encoding
+    empty = RDoc::Encoding.change_encoding empty, comment.encoding
 
     comment = comment.gsub(%r%^--\n.*?^\+\+\n?%m, empty)
     comment.sub(%r%^--\n.*%m, empty)

data/lib/rdoc/parser/text.rb

@@ -1,4 +1,4 @@
-# frozen_string_literal: false
+# frozen_string_literal: true
 ##
 # Indicates this parser is text and doesn't contain code constructs.
 #

data/lib/rdoc/parser.rb

@@ -1,5 +1,5 @@
 # -*- coding: us-ascii -*-
-# frozen_string_literal: false
+# frozen_string_literal: true
 
 ##
 # A parser is simple a class that subclasses RDoc::Parser and implements #scan
@@ -78,7 +78,7 @@ class RDoc::Parser
 
     return true if s[0, 2] == Marshal.dump('')[0, 2] or s.index("\x00")
 
-    mode = 'r:utf-8' # default source encoding has been chagened to utf-8
+    mode = 'r:utf-8' # default source encoding has been changed to utf-8
     s.sub!(/\A#!.*\n/, '')     # assume shebang line isn't longer than 1024.
     encoding = s[/^\s*\#\s*(?:-\*-\s*)?(?:en)?coding:\s*([^\s;]+?)(?:-\*-|[\s;])/, 1]
     mode = "rb:#{encoding}" if encoding
@@ -87,31 +87,6 @@ class RDoc::Parser
     not s.valid_encoding?
   end
 
-  ##
-  # Processes common directives for CodeObjects for the C and Ruby parsers.
-  #
-  # Applies +directive+'s +value+ to +code_object+, if appropriate
-
-  def self.process_directive code_object, directive, value
-    warn "RDoc::Parser::process_directive is deprecated and wil be removed in RDoc 4.  Use RDoc::Markup::PreProcess#handle_directive instead" if $-w
-
-    case directive
-    when 'nodoc' then
-      code_object.document_self = nil # notify nodoc
-      code_object.document_children = value.downcase != 'all'
-    when 'doc' then
-      code_object.document_self = true
-      code_object.force_documentation = true
-    when 'yield', 'yields' then
-      # remove parameter &block
-      code_object.params.sub!(/,?\s*&\w+/, '') if code_object.params
-
-      code_object.block_params = value
-    when 'arg', 'args' then
-      code_object.params = value
-    end
-  end
-
   ##
   # Checks if +file+ is a zip file in disguise.  Signatures from
   # http://www.garykessler.net/library/file_sigs.html
@@ -164,7 +139,7 @@ class RDoc::Parser
   # Returns the file type from the modeline in +file_name+
 
   def self.check_modeline file_name
-    line = open file_name do |io|
+    line = File.open file_name do |io|
       io.gets
     end
 
@@ -294,9 +269,9 @@ class RDoc::Parser
 end
 
 # simple must come first in order to show up last in the parsers list
-require 'rdoc/parser/simple'
-require 'rdoc/parser/c'
-require 'rdoc/parser/changelog'
-require 'rdoc/parser/markdown'
-require 'rdoc/parser/rd'
-require 'rdoc/parser/ruby'
+require_relative 'parser/simple'
+require_relative 'parser/c'
+require_relative 'parser/changelog'
+require_relative 'parser/markdown'
+require_relative 'parser/rd'
+require_relative 'parser/ruby'

data/lib/rdoc/rd/block_parser.rb

@@ -1,6 +1,7 @@
+# frozen_string_literal: true
 #
 # DO NOT MODIFY!!!!
-# This file is automatically generated by Racc 1.4.14
+# This file is automatically generated by Racc 1.5.1
 # from Racc grammar file "".
 #
 
@@ -207,7 +208,7 @@ def next_token # :nodoc:
       if @in_verbatim
         [:STRINGLINE, line]
       else
-        @indent_stack.push("\s" << newIndent)
+        @indent_stack.push("\s" + newIndent)
         [:ITEMLISTLINE, rest]
       end
     end
@@ -219,7 +220,7 @@ def next_token # :nodoc:
       if @in_verbatim
         [:STRINGLINE, line]
       else
-        @indent_stack.push("\s" * mark.size << newIndent)
+        @indent_stack.push("\s" * mark.size + newIndent)
         [:ENUMLISTLINE, rest]
       end
     end
@@ -419,52 +420,52 @@ end
 
 racc_action_table = [
     34,    35,    30,    33,    40,    34,    35,    30,    33,    40,
-    65,    34,    35,    30,    33,    14,    73,    14,    54,    76,
-    15,    88,    34,    35,    30,    33,    14,    73,    77,    33,
-    54,    15,    34,    35,    30,    33,    14,    73,    81,    38,
-    38,    15,    34,    35,    30,    33,    14,    73,    40,    36,
-    83,    15,    34,    35,    30,    33,    54,    47,    30,    35,
-    34,    15,    34,    35,    30,    33,    14,    73,    38,    67,
-    59,    15,    34,    35,    30,    33,    14,     9,    10,    11,
-    12,    15,    34,    35,    30,    33,    14,    73,    14,   nil,
+    65,    34,    35,    30,    33,    14,    73,    36,    38,    34,
+    15,    88,    34,    35,    30,    33,    14,     9,    10,    11,
+    12,    15,    34,    35,    30,    33,    14,     9,    10,    11,
+    12,    15,    34,    35,    30,    33,    35,    47,    30,    54,
+    33,    15,    34,    35,    30,    33,    54,    47,    14,    14,
+    59,    15,    34,    35,    30,    33,    14,    73,    67,    76,
+    77,    15,    34,    35,    30,    33,    14,    73,    54,    81,
+    38,    15,    34,    35,    30,    33,    14,    73,    38,    40,
+    83,    15,    34,    35,    30,    33,    14,    73,   nil,   nil,
    nil,    15,    34,    35,    30,    33,    14,    73,   nil,   nil,
-   nil,    15,    34,    35,    30,    33,   nil,    47,   nil,   nil,
    nil,    15,    34,    35,    30,    33,    14,    73,   nil,   nil,
    nil,    15,    34,    35,    30,    33,    14,    73,   nil,   nil,
-   nil,    15,    34,    35,    30,    33,    14,     9,    10,    11,
-    12,    15,    34,    35,    30,    33,    14,    73,    61,    63,
+   nil,    15,    34,    35,    30,    33,    14,    73,   nil,   nil,
+   nil,    15,    34,    35,    30,    33,    14,    73,    61,    63,
    nil,    15,    14,    62,    60,    61,    63,    79,    61,    63,
     62,    87,   nil,    62,    34,    35,    30,    33 ]
 
 racc_action_check = [
     41,    41,    41,    41,    41,    15,    15,    15,    15,    15,
-    41,    86,    86,    86,    86,    86,    86,    34,    33,    49,
-    86,    86,    85,    85,    85,    85,    85,    85,    51,    31,
-    54,    85,    79,    79,    79,    79,    79,    79,    56,    57,
-    58,    79,    78,    78,    78,    78,    78,    78,    62,     1,
-    66,    78,    24,    24,    24,    24,    30,    24,    28,    25,
-    22,    24,    75,    75,    75,    75,    75,    75,    13,    44,
-    36,    75,     2,     2,     2,     2,     2,     2,     2,     2,
-     2,     2,    46,    46,    46,    46,    46,    46,    35,   nil,
-   nil,    46,    45,    45,    45,    45,    45,    45,   nil,   nil,
-   nil,    45,    27,    27,    27,    27,   nil,    27,   nil,   nil,
-   nil,    27,    74,    74,    74,    74,    74,    74,   nil,   nil,
-   nil,    74,    68,    68,    68,    68,    68,    68,   nil,   nil,
-   nil,    68,     0,     0,     0,     0,     0,     0,     0,     0,
-     0,     0,    47,    47,    47,    47,    47,    47,    39,    39,
-   nil,    47,    52,    39,    39,    82,    82,    52,    64,    64,
+    41,    86,    86,    86,    86,    86,    86,     1,    13,    22,
+    86,    86,     0,     0,     0,     0,     0,     0,     0,     0,
+     0,     0,     2,     2,     2,     2,     2,     2,     2,     2,
+     2,     2,    24,    24,    24,    24,    25,    24,    28,    30,
+    31,    24,    27,    27,    27,    27,    33,    27,    34,    35,
+    36,    27,    45,    45,    45,    45,    45,    45,    44,    49,
+    51,    45,    46,    46,    46,    46,    46,    46,    54,    56,
+    57,    46,    47,    47,    47,    47,    47,    47,    58,    62,
+    66,    47,    68,    68,    68,    68,    68,    68,   nil,   nil,
+   nil,    68,    74,    74,    74,    74,    74,    74,   nil,   nil,
+   nil,    74,    75,    75,    75,    75,    75,    75,   nil,   nil,
+   nil,    75,    78,    78,    78,    78,    78,    78,   nil,   nil,
+   nil,    78,    79,    79,    79,    79,    79,    79,   nil,   nil,
+   nil,    79,    85,    85,    85,    85,    85,    85,    39,    39,
+   nil,    85,    52,    39,    39,    82,    82,    52,    64,    64,
     82,    82,   nil,    64,    20,    20,    20,    20 ]
 
 racc_action_pointer = [
-   129,    49,    69,   nil,   nil,   nil,   nil,   nil,   nil,   nil,
-   nil,   nil,   nil,    61,   nil,     2,   nil,   nil,   nil,   nil,
-   161,   nil,    57,   nil,    49,    55,   nil,    99,    53,   nil,
-    48,    23,   nil,    10,    10,    81,    70,   nil,   nil,   141,
-   nil,    -3,   nil,   nil,    56,    89,    79,   139,   nil,     6,
-   nil,    15,   145,   nil,    22,   nil,    25,    32,    33,   nil,
-   nil,   nil,    41,   nil,   151,   nil,    37,   nil,   119,   nil,
-   nil,   nil,   nil,   nil,   109,    59,   nil,   nil,    39,    29,
-   nil,   nil,   148,   nil,   nil,    19,     8,   nil,   nil ]
+    19,    17,    29,   nil,   nil,   nil,   nil,   nil,   nil,   nil,
+   nil,   nil,   nil,    11,   nil,     2,   nil,   nil,   nil,   nil,
+   161,   nil,    16,   nil,    39,    42,   nil,    49,    43,   nil,
+    41,    44,   nil,    48,    51,    52,    60,   nil,   nil,   141,
+   nil,    -3,   nil,   nil,    55,    59,    69,    79,   nil,    56,
+   nil,    57,   145,   nil,    70,   nil,    66,    73,    81,   nil,
+   nil,   nil,    82,   nil,   151,   nil,    77,   nil,    89,   nil,
+   nil,   nil,   nil,   nil,    99,   109,   nil,   nil,   119,   129,
+   nil,   nil,   148,   nil,   nil,   139,     8,   nil,   nil ]
 
 racc_action_default = [
     -2,   -73,    -1,    -4,    -5,    -6,    -7,    -8,    -9,   -10,
@@ -478,26 +479,26 @@ racc_action_default = [
    -60,   -47,   -73,   -29,   -52,   -48,   -73,   -20,   -50 ]
 
 racc_goto_table = [
-     4,    39,     4,    68,    74,    75,     6,     5,     6,     5,
-    44,    42,    51,    49,     3,    56,    37,    57,    58,    80,
+     4,    39,     4,    68,    74,    75,     5,     6,     5,     6,
+    44,    42,    51,    49,     3,    56,    37,    57,    58,     1,
      2,    66,    84,    41,    43,    48,    50,    64,    84,    84,
-    46,    45,    42,    46,    45,    55,    85,    86,     1,    84,
+    45,    46,    42,    45,    46,    55,    85,    86,    80,    84,
     84,   nil,   nil,   nil,   nil,   nil,   nil,   nil,    82,   nil,
    nil,   nil,    78 ]
 
 racc_goto_check = [
-     4,    10,     4,    31,    31,    31,     6,     5,     6,     5,
-    21,    12,    27,    21,     3,    27,     3,     9,     9,    33,
+     4,    10,     4,    31,    31,    31,     5,     6,     5,     6,
+    21,    12,    27,    21,     3,    27,     3,     9,     9,     1,
      2,    11,    32,    17,    19,    23,    26,    10,    32,    32,
-     6,     5,    12,     6,     5,    29,    31,    31,     1,    32,
+     5,     6,    12,     5,     6,    29,    31,    31,    33,    32,
     32,   nil,   nil,   nil,   nil,   nil,   nil,   nil,    10,   nil,
    nil,   nil,     4 ]
 
 racc_goto_pointer = [
-   nil,    38,    20,    14,     0,     7,     6,   nil,   nil,   -17,
+   nil,    19,    20,    14,     0,     6,     7,   nil,   nil,   -17,
    -14,   -20,    -9,   nil,   nil,   nil,   nil,     8,   nil,     2,
    nil,   -14,   nil,     0,   nil,   nil,    -2,   -18,   nil,     4,
-   nil,   -42,   -46,   -35 ]
+   nil,   -42,   -46,   -16 ]
 
 racc_goto_default = [
    nil,   nil,   nil,   nil,    70,    71,    72,     7,     8,    13,

data/lib/rdoc/rd/block_parser.ry

@@ -420,7 +420,7 @@ def next_token # :nodoc:
       if @in_verbatim
         [:STRINGLINE, line]
       else
-        @indent_stack.push("\s" << newIndent)
+        @indent_stack.push("\s" + newIndent)
         [:ITEMLISTLINE, rest]
       end
     end
@@ -432,7 +432,7 @@ def next_token # :nodoc:
       if @in_verbatim
         [:STRINGLINE, line]
       else
-        @indent_stack.push("\s" * mark.size << newIndent)
+        @indent_stack.push("\s" * mark.size + newIndent)
         [:ENUMLISTLINE, rest]
       end
     end

data/lib/rdoc/rd/inline.rb

@@ -1,4 +1,4 @@
-# frozen_string_literal: false
+# frozen_string_literal: true
 ##
 # Inline keeps track of markup and labels to create proper links.
 
@@ -50,11 +50,11 @@ class RDoc::RD::Inline
   def append more
     case more
     when String then
-      @reference << more
-      @rdoc      << more
+      @reference += more
+      @rdoc      += more
     when RDoc::RD::Inline then
-      @reference << more.reference
-      @rdoc      << more.rdoc
+      @reference += more.reference
+      @rdoc      += more.rdoc
     else
       raise "unknown thingy #{more}"
     end