rdoc 6.3.3 → 6.6.3.1

data/lib/rdoc/parser/changelog.rb

@@ -216,12 +216,22 @@ class RDoc::Parser::ChangeLog < RDoc::Parser
     @top_level
   end
 
+  ##
+  # The extension for Git commit log
+
   module Git
+    ##
+    # Parses auxiliary info.  Currentry `base-url` to expand
+    # references is effective.
+
     def parse_info(info)
       /^\s*base-url\s*=\s*(.*\S)/ =~ info
       @base_url = $1
     end
 
+    ##
+    # Parses the entries in the Git commit logs
+
     def parse_entries
       entries = []
 
@@ -244,6 +254,11 @@ class RDoc::Parser::ChangeLog < RDoc::Parser
       entries
     end
 
+    ##
+    # Returns a list of ChangeLog entries as
+    # RDoc::Parser::ChangeLog::Git::LogEntry list for the given
+    # +entries+.
+
     def create_entries entries
       # git log entries have no strictly itemized style like the old
       # style, just assume Markdown.
@@ -332,4 +347,3 @@ class RDoc::Parser::ChangeLog < RDoc::Parser
     end
   end
 end
-

data/lib/rdoc/parser/markdown.rb

@@ -20,5 +20,3 @@ class RDoc::Parser::Markdown < RDoc::Parser
   end
 
 end
-
-

data/lib/rdoc/parser/rd.rb

@@ -20,4 +20,3 @@ class RDoc::Parser::RD < RDoc::Parser
   end
 
 end
-

data/lib/rdoc/parser/ripper_state_lex.rb

@@ -1,7 +1,12 @@
 # frozen_string_literal: true
 require 'ripper'
 
+##
+# Wrapper for Ripper lex states
+
 class RDoc::Parser::RipperStateLex
+  # :stopdoc:
+
   # TODO: Remove this constants after Ruby 2.4 EOL
   RIPPER_HAS_LEX_STATE = Ripper::Filter.method_defined?(:state)
 
@@ -368,7 +373,7 @@ class RDoc::Parser::RipperStateLex
   private def get_symbol_tk(tk)
     is_symbol = true
     symbol_tk = Token.new(tk.line_no, tk.char_no, :on_symbol)
-    if ":'" == tk[:text] or ':"' == tk[:text]
+    if ":'" == tk[:text] or ':"' == tk[:text] or tk[:text].start_with?('%s')
       tk1 = get_string_tk(tk)
       symbol_tk[:text] = tk1[:text]
       symbol_tk[:state] = tk1[:state]
@@ -565,6 +570,9 @@ class RDoc::Parser::RipperStateLex
     tk
   end
 
+  # :startdoc:
+
+  # New lexer for +code+.
   def initialize(code)
     @buf = []
     @heredoc_queue = []
@@ -572,6 +580,7 @@ class RDoc::Parser::RipperStateLex
     @tokens = @inner_lex.parse([])
   end
 
+  # Returns tokens parsed from +code+.
   def self.parse(code)
     lex = self.new(code)
     tokens = []
@@ -584,6 +593,7 @@ class RDoc::Parser::RipperStateLex
     tokens
   end
 
+  # Returns +true+ if lex state will be +END+ after +token+.
   def self.end?(token)
     (token[:state] & EXPR_END)
   end

data/lib/rdoc/parser/ruby.rb

@@ -8,6 +8,9 @@
 #       by Keiju ISHITSUKA (Nippon Rational Inc.)
 #
 
+require 'ripper'
+require_relative 'ripper_state_lex'
+
 ##
 # Extracts code elements from a source file returning a TopLevel object
 # containing the constituent file elements.
@@ -138,9 +141,6 @@
 # Note that by default, the :method: directive will be ignored if there is a
 # standard rdocable item following it.
 
-require 'ripper'
-require_relative 'ripper_state_lex'
-
 class RDoc::Parser::Ruby < RDoc::Parser
 
   parse_files_matching(/\.rbw?$/)
@@ -164,15 +164,7 @@ class RDoc::Parser::Ruby < RDoc::Parser
   def initialize(top_level, file_name, content, options, stats)
     super
 
-    if /\t/ =~ content then
-      tab_width = @options.tab_width
-      content = content.split(/\n/).map do |line|
-        1 while line.gsub!(/\t+/) {
-          ' ' * (tab_width*$&.length - $`.length % tab_width)
-        }  && $~
-        line
-      end.join("\n")
-    end
+    content = handle_tab_width(content)
 
     @size = 0
     @token_listeners = nil
@@ -188,6 +180,9 @@ class RDoc::Parser::Ruby < RDoc::Parser
     reset
   end
 
+  ##
+  # Return +true+ if +tk+ is a newline.
+
   def tk_nl?(tk)
     :on_nl == tk[:kind] or :on_ignored_nl == tk[:kind]
   end
@@ -399,6 +394,29 @@ class RDoc::Parser::Ruby < RDoc::Parser
     return [container, name_t, given_name, new_modules]
   end
 
+  ##
+  # Skip opening parentheses and yield the block.
+  # Skip closing parentheses too when exists.
+
+  def skip_parentheses(&block)
+    left_tk = peek_tk
+
+    if :on_lparen == left_tk[:kind]
+      get_tk
+
+      ret = skip_parentheses(&block)
+
+      right_tk = peek_tk
+      if :on_rparen == right_tk[:kind]
+        get_tk
+      end
+
+      ret
+    else
+      yield
+    end
+  end
+
   ##
   # Return a superclass, which can be either a constant of an expression
 
@@ -833,7 +851,7 @@ class RDoc::Parser::Ruby < RDoc::Parser
       cls = parse_class_regular container, declaration_context, single,
         name_t, given_name, comment
     elsif name_t[:kind] == :on_op && name_t[:text] == '<<'
-      case name = get_class_specification
+      case name = skip_parentheses { get_class_specification }
       when 'self', container.name
         read_documentation_modifiers cls, RDoc::CLASS_MODIFIERS
         parse_statements container, SINGLE
@@ -1193,6 +1211,22 @@ class RDoc::Parser::Ruby < RDoc::Parser
     end
   end
 
+  ##
+  # Parses an +included+ with a block feature of ActiveSupport::Concern.
+
+  def parse_included_with_activesupport_concern container, comment # :nodoc:
+    skip_tkspace_without_nl
+    tk = get_tk
+    unless tk[:kind] == :on_lbracket || (tk[:kind] == :on_kw && tk[:text] == 'do')
+      unget_tk tk
+      return nil # should be a block
+    end
+
+    parse_statements container
+
+    container
+  end
+
   ##
   # Parses identifiers that can create new methods or change visibility.
   #
@@ -1893,6 +1927,8 @@ class RDoc::Parser::Ruby < RDoc::Parser
           parse_extend_or_include RDoc::Include, container, comment
         when "extend" then
           parse_extend_or_include RDoc::Extend, container, comment
+        when "included" then
+          parse_included_with_activesupport_concern container, comment
         end
 
       else
@@ -2101,7 +2137,7 @@ class RDoc::Parser::Ruby < RDoc::Parser
       if :on_nl == tk[:kind] or (:on_kw == tk[:kind] && 'def' == tk[:text]) then
         return
       elsif :on_comment == tk[:kind] or :on_embdoc == tk[:kind] then
-        return unless tk[:text] =~ /\s*:?([\w-]+):\s*(.*)/
+        return unless tk[:text] =~ /:?\b([\w-]+):\s*(.*)/
 
         directive = $1.downcase
 

data/lib/rdoc/parser/ruby_tools.rb

@@ -163,5 +163,3 @@ module RDoc::Parser::RubyTools
   end
 
 end
-
-

data/lib/rdoc/parser/text.rb

@@ -9,4 +9,3 @@
 
 module RDoc::Parser::Text
 end
-

data/lib/rdoc/parser.rb

@@ -263,9 +263,26 @@ class RDoc::Parser
     @preprocess.options = @options
   end
 
-  autoload :RubyTools, 'rdoc/parser/ruby_tools'
-  autoload :Text,      'rdoc/parser/text'
+  autoload :RubyTools, "#{__dir__}/parser/ruby_tools"
+  autoload :Text,      "#{__dir__}/parser/text"
 
+  ##
+  # Normalizes tabs in +body+
+
+  def handle_tab_width(body)
+    if /\t/ =~ body
+      tab_width = @options.tab_width
+      body.split(/\n/).map do |line|
+        1 while line.gsub!(/\t+/) do
+          b, e = $~.offset(0)
+          ' ' * (tab_width * (e-b) - b % tab_width)
+        end
+        line
+      end.join "\n"
+    else
+      body
+    end
+  end
 end
 
 # simple must come first in order to show up last in the parsers list