rdoc 6.0.0.beta3 → 6.0.0.beta4

data/lib/rdoc/normal_module.rb

@@ -1,4 +1,4 @@
-# frozen_string_literal: false
+# frozen_string_literal: true
 ##
 # A normal module, like NormalClass
 

data/lib/rdoc/options.rb

@@ -1,4 +1,4 @@
-# frozen_string_literal: false
+# frozen_string_literal: true
 require 'optparse'
 require 'pathname'
 
@@ -624,16 +624,16 @@ Usage: #{opt.program_name} [options] [names...]
       end
 
       parsers.sort.each do |parser, regexp|
-        opt.banner << "  - #{parser}: #{regexp.join ', '}\n"
+        opt.banner += "  - #{parser}: #{regexp.join ', '}\n"
       end
-      opt.banner << "  - TomDoc:  Only in ruby files\n"
+      opt.banner += "  - TomDoc:  Only in ruby files\n"
 
-      opt.banner << "\n  The following options are deprecated:\n\n"
+      opt.banner += "\n  The following options are deprecated:\n\n"
 
       name_length = DEPRECATED.keys.sort_by { |k| k.length }.last.length
 
       DEPRECATED.sort_by { |k,| k }.each do |name, reason|
-        opt.banner << "    %*1$2$s  %3$s\n" % [-name_length, name, reason]
+        opt.banner += "    %*1$2$s  %3$s\n" % [-name_length, name, reason]
       end
 
       opt.accept Template do |template|
@@ -1087,7 +1087,7 @@ Usage: #{opt.program_name} [options] [names...]
 
     unless quiet then
       deprecated.each do |opt|
-        $stderr.puts 'option ' << opt << ' is deprecated: ' << DEPRECATED[opt]
+        $stderr.puts 'option ' + opt + ' is deprecated: ' + DEPRECATED[opt]
       end
     end
 

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

data/lib/rdoc/parser/c.rb

@@ -1,4 +1,4 @@
-# frozen_string_literal: false
+# frozen_string_literal: true
 require 'tsort'
 
 ##
@@ -865,8 +865,8 @@ class RDoc::Parser::C < RDoc::Parser
 
   def handle_attr(var_name, attr_name, read, write)
     rw = ''
-    rw << 'R' if '1' == read
-    rw << 'W' if '1' == write
+    rw += 'R' if '1' == read
+    rw += 'W' if '1' == write
 
     class_name = @known_classes[var_name]
 
@@ -982,8 +982,8 @@ class RDoc::Parser::C < RDoc::Parser
         if new_definition.empty? then # Default to literal C definition
           new_definition = definition
         else
-          new_definition.gsub!("\:", ":")
-          new_definition.gsub!("\\", '\\')
+          new_definition = new_definition.gsub("\:", ":")
+          new_definition = new_definition.gsub("\\", '\\')
         end
 
         new_definition.sub!(/\A(\s+)/, '')
@@ -1237,7 +1237,7 @@ class RDoc::Parser::C < RDoc::Parser
   # when scanning for classes and methods
 
   def remove_commented_out_lines
-    @content.gsub!(%r%//.*rb_define_%, '//')
+    @content = @content.gsub(%r%//.*rb_define_%, '//')
   end
 
   ##

data/lib/rdoc/parser/changelog.rb

@@ -1,4 +1,4 @@
-# frozen_string_literal: false
+# frozen_string_literal: true
 require 'time'
 
 ##
@@ -29,13 +29,13 @@ class RDoc::Parser::ChangeLog < RDoc::Parser
 
     if last =~ /\)\s*\z/ and continuation =~ /\A\(/ then
       last.sub!(/\)\s*\z/, ',')
-      continuation.sub!(/\A\(/, '')
+      continuation = continuation.sub(/\A\(/, '')
     end
 
     if last =~ /\s\z/ then
       last << continuation
     else
-      last << ' ' << continuation
+      last << ' ' + continuation
     end
   end
 
@@ -162,12 +162,12 @@ class RDoc::Parser::ChangeLog < RDoc::Parser
 
         entry_body = []
       when /^(\t| {8})?\*\s*(.*)/ then # "\t* file.c (func): ..."
-        entry_body << $2
+        entry_body << $2.dup
       when /^(\t| {8})?\s*(\(.*)/ then # "\t(func): ..."
         entry = $2
 
         if entry_body.last =~ /:/ then
-          entry_body << entry
+          entry_body << entry.dup
         else
           continue_entry_body entry_body, entry
         end

data/lib/rdoc/parser/markdown.rb

@@ -1,4 +1,4 @@
-# frozen_string_literal: false
+# frozen_string_literal: true
 ##
 # Parse a Markdown format file.  The parsed RDoc::Markup::Document is attached
 # as a file comment.

data/lib/rdoc/parser/rd.rb

@@ -1,4 +1,4 @@
-# frozen_string_literal: false
+# frozen_string_literal: true
 ##
 # Parse a RD format file.  The parsed RDoc::Markup::Document is attached as a
 # file comment.

data/lib/rdoc/parser/ripper_state_lex.rb

@@ -1,6 +1,9 @@
 require 'ripper'
 
 class RDoc::RipperStateLex
+  # TODO: Remove this constants after Ruby 2.4 EOL
+  RIPPER_HAS_LEX_STATE = Ripper::Filter.method_defined?(:state)
+
   EXPR_NONE = 0
   EXPR_BEG = 1
   EXPR_END = 2
@@ -283,7 +286,22 @@ class RDoc::RipperStateLex
       @callback = block
       parse
     end
-  end
+  end unless RIPPER_HAS_LEX_STATE
+
+  class InnerStateLex < Ripper::Filter
+    def initialize(code)
+      super(code)
+    end
+
+    def on_default(event, tok, data)
+      @callback.call({ :line_no => lineno, :char_no => column, :kind => event, :text => tok, :state => state})
+    end
+
+    def each(&block)
+      @callback = block
+      parse
+    end
+  end if RIPPER_HAS_LEX_STATE
 
   def get_squashed_tk
     if @buf.empty?
@@ -297,10 +315,10 @@ class RDoc::RipperStateLex
     when :on_tstring_beg then
       tk = get_string_tk(tk)
     when :on_backtick then
-      if (EXPR_FNAME & tk[:state]) != 0
-        @inner_lex.lex_state = EXPR_ARG
+      if (tk[:state] & (EXPR_FNAME | EXPR_ENDFN)) != 0
+        @inner_lex.lex_state = EXPR_ARG unless RIPPER_HAS_LEX_STATE
         tk[:kind] = :on_ident
-        tk[:state] = @inner_lex.lex_state
+        tk[:state] = Ripper::Lexer.const_defined?(:State) ? Ripper::Lexer::State.new(EXPR_ARG) : EXPR_ARG
       else
         tk = get_string_tk(tk)
       end
@@ -310,7 +328,7 @@ class RDoc::RipperStateLex
       tk = get_embdoc_tk(tk)
     when :on_heredoc_beg then
       @heredoc_queue << retrieve_heredoc_info(tk)
-      @inner_lex.lex_state = EXPR_END
+      @inner_lex.lex_state = EXPR_END unless RIPPER_HAS_LEX_STATE
     when :on_nl, :on_ignored_nl, :on_comment, :on_heredoc_end then
       unless @heredoc_queue.empty?
         get_heredoc_tk(*@heredoc_queue.shift)
@@ -540,10 +558,10 @@ class RDoc::RipperStateLex
 
   private def get_op_tk(tk)
     redefinable_operators = %w[! != !~ % & * ** + +@ - -@ / < << <= <=> == === =~ > >= >> [] []= ^ ` | ~]
-    if redefinable_operators.include?(tk[:text]) and EXPR_ARG == tk[:state] then
-      @inner_lex.lex_state = EXPR_ARG
+    if redefinable_operators.include?(tk[:text]) and tk[:state] == EXPR_ARG then
+      @inner_lex.lex_state = EXPR_ARG unless RIPPER_HAS_LEX_STATE
+      tk[:state] = Ripper::Lexer.const_defined?(:State) ? Ripper::Lexer::State.new(EXPR_ARG) : EXPR_ARG
       tk[:kind] = :on_ident
-      tk[:state] = @inner_lex.lex_state
     elsif tk[:text] =~ /^[-+]$/ then
       tk_ahead = get_squashed_tk
       case tk_ahead[:kind]

data/lib/rdoc/parser/ruby.rb

@@ -1,4 +1,4 @@
-# frozen_string_literal: false
+# frozen_string_literal: true
 ##
 # This file contains stuff stolen outright from:
 #
@@ -239,8 +239,8 @@ class RDoc::Parser::Ruby < RDoc::Parser
 
   def collect_first_comment
     skip_tkspace
-    comment = ''
-    comment.force_encoding @encoding if @encoding
+    comment = ''.dup
+    comment = RDoc::Encoding.change_encoding comment, @encoding if @encoding
     first_line = true
     first_comment_tk_kind = nil
 
@@ -318,8 +318,7 @@ class RDoc::Parser::Ruby < RDoc::Parser
   end
 
   ##
-  # Looks for a true or false token.  Returns false if TkFALSE or TkNIL are
-  # found.
+  # Looks for a true or false token.
 
   def get_bool
     skip_tkspace
@@ -342,7 +341,7 @@ class RDoc::Parser::Ruby < RDoc::Parser
   def get_class_or_module container, ignore_constants = false
     skip_tkspace
     name_t = get_tk
-    given_name = ''
+    given_name = ''.dup
 
     # class ::A -> A is in the top level
     if :on_op == name_t[:kind] and '::' == name_t[:text] then # bug
@@ -379,7 +378,7 @@ class RDoc::Parser::Ruby < RDoc::Parser
       if prev_container == container and !ignore_constants
         given_name = name_t[:text]
       else
-        given_name << '::' << name_t[:text]
+        given_name << '::' + name_t[:text]
       end
     end
 
@@ -574,27 +573,28 @@ class RDoc::Parser::Ruby < RDoc::Parser
   #
   # This routine modifies its +comment+ parameter.
 
-  def look_for_directives_in context, comment
-    @preprocess.handle comment, context do |directive, param|
+  def look_for_directives_in container, comment
+    @preprocess.handle comment, container do |directive, param|
       case directive
       when 'method', 'singleton-method',
            'attr', 'attr_accessor', 'attr_reader', 'attr_writer' then
         false # handled elsewhere
       when 'section' then
-        context.set_current_section param, comment.dup
+        break unless container.kind_of?(RDoc::Context)
+        container.set_current_section param, comment.dup
         comment.text = ''
         break
       end
     end
 
-    remove_private_comments comment
+    comment.remove_private
   end
 
   ##
   # Adds useful info about the parser to +message+
 
   def make_message message
-    prefix = "#{@file_name}:"
+    prefix = "#{@file_name}:".dup
 
     tk = peek_tk
     prefix << "#{tk[:line_no]}:#{tk[:char_no]}:" if tk
@@ -913,7 +913,7 @@ class RDoc::Parser::Ruby < RDoc::Parser
 
     return unless body
 
-    value.replace body
+    con.value = body
     record_location con
     con.line   = line_no
     read_documentation_modifiers con, RDoc::CONSTANT_MODIFIERS
@@ -928,7 +928,7 @@ class RDoc::Parser::Ruby < RDoc::Parser
 
   def parse_constant_body container, constant, is_array_or_hash # :nodoc:
     nest     = 0
-    rhs_name = ''
+    rhs_name = ''.dup
 
     get_tkread
 
@@ -944,7 +944,7 @@ class RDoc::Parser::Ruby < RDoc::Parser
       elsif (:on_kw == tk[:kind] && 'def' == tk[:text]) then
         nest += 1
       elsif (:on_kw == tk[:kind] && %w{do if unless case begin}.include?(tk[:text])) then
-        if (RDoc::RipperStateLex::EXPR_LABEL & tk[:state]) == 0
+        if (tk[:state] & RDoc::RipperStateLex::EXPR_LABEL) == 0
           nest += 1
         end
       elsif [:on_rparen, :on_rbrace, :on_rbracket].include?(tk[:kind]) ||
@@ -990,14 +990,13 @@ class RDoc::Parser::Ruby < RDoc::Parser
     column  = tk[:char_no]
     line_no = tk[:line_no]
 
-    text = comment.text
-
-    singleton = !!text.sub!(/(^# +:?)(singleton-)(method:)/, '\1\3')
+    comment.text = comment.text.sub(/(^# +:?)(singleton-)(method:)/, '\1\3')
+    singleton = !!$~
 
     co =
-      if text.sub!(/^# +:?method: *(\S*).*?\n/i, '') then
-        parse_comment_ghost container, text, $1, column, line_no, comment
-      elsif text.sub!(/# +:?(attr(_reader|_writer|_accessor)?): *(\S*).*?\n/i, '') then
+      if (comment.text = comment.text.sub(/^# +:?method: *(\S*).*?\n/i, '')) && !!$~ then
+        parse_comment_ghost container, comment.text, $1, column, line_no, comment
+      elsif (comment.text = comment.text.sub(/# +:?(attr(_reader|_writer|_accessor)?): *(\S*).*?\n/i, '')) && !!$~ then
         parse_comment_attr container, $1, $3, comment
       end
 
@@ -1194,7 +1193,9 @@ class RDoc::Parser::Ruby < RDoc::Parser
     tmp = RDoc::CodeObject.new
     read_documentation_modifiers tmp, RDoc::ATTR_MODIFIERS
 
-    if comment.text.sub!(/^# +:?(attr(_reader|_writer|_accessor)?): *(\S*).*?\n/i, '') then
+    regexp = /^# +:?(attr(_reader|_writer|_accessor)?): *(\S*).*?\n/i
+    if regexp =~ comment.text then
+      comment.text = comment.text.sub(regexp, '')
       rw = case $1
            when 'attr_reader' then 'R'
            when 'attr_writer' then 'W'
@@ -1227,7 +1228,8 @@ class RDoc::Parser::Ruby < RDoc::Parser
 
     skip_tkspace false
 
-    singleton = !!comment.text.sub!(/(^# +:?)(singleton-)(method:)/, '\1\3')
+    comment.text = comment.text.sub(/(^# +:?)(singleton-)(method:)/, '\1\3')
+    singleton = !!$~
 
     name = parse_meta_method_name comment, tk
 
@@ -1290,6 +1292,7 @@ class RDoc::Parser::Ruby < RDoc::Parser
     token_listener meth do
       meth.params = ''
 
+      look_for_directives_in meth, comment
       comment.normalize
       comment.extract_call_seq meth
 
@@ -1336,6 +1339,7 @@ class RDoc::Parser::Ruby < RDoc::Parser
     return unless name
 
     meth = RDoc::AnyMethod.new get_tkread, name
+    look_for_directives_in meth, comment
     meth.singleton = single == SINGLE ? true : singleton
 
     record_location meth
@@ -1458,8 +1462,7 @@ class RDoc::Parser::Ruby < RDoc::Parser
     name_t2 = get_tk
 
     if (:on_kw == name_t[:kind] && 'self' == name_t[:text]) || (:on_op == name_t[:kind] && '%' == name_t[:text]) then
-      # NOTE: work around '[' being consumed early and not being re-tokenized
-      # as a TkAREF
+      # NOTE: work around '[' being consumed early
       if :on_lbracket == name_t2[:kind]
         get_tk
         name = '[]'
@@ -1535,7 +1538,7 @@ class RDoc::Parser::Ruby < RDoc::Parser
       when :on_comment, :on_embdoc then
         @read.pop
         if :on_nl == end_token[:kind] and "\n" == tk[:text][-1] and
-          (!continue or (RDoc::RipperStateLex::EXPR_LABEL & tk[:state]) != 0) then
+          (!continue or (tk[:state] & RDoc::RipperStateLex::EXPR_LABEL) != 0) then
           if method && method.block_params.nil? then
             unget_tk tk
             read_documentation_modifiers method, modifiers
@@ -1642,7 +1645,7 @@ class RDoc::Parser::Ruby < RDoc::Parser
   def parse_statements(container, single = NORMAL, current_method = nil,
                        comment = new_comment(''))
     raise 'no' unless RDoc::Comment === comment
-    comment.force_encoding @encoding if @encoding
+    comment = RDoc::Encoding.change_encoding comment, @encoding if @encoding
 
     nest = 1
     save_visibility = container.visibility
@@ -1685,12 +1688,12 @@ class RDoc::Parser::Ruby < RDoc::Parser
               comment.empty?
 
             comment = ''
-            comment.force_encoding @encoding if @encoding
+            comment = RDoc::Encoding.change_encoding comment, @encoding if @encoding
           end
 
           while tk and (:on_comment == tk[:kind] or :on_embdoc == tk[:kind]) do
-            comment << tk[:text]
-            comment << "\n" unless "\n" == tk[:text].chars.to_a.last
+            comment += tk[:text]
+            comment += "\n" unless "\n" == tk[:text].chars.to_a.last
 
             if tk[:text].size > 1 && "\n" == tk[:text].chars.to_a.last then
               skip_tkspace false # leading spaces
@@ -1740,7 +1743,7 @@ class RDoc::Parser::Ruby < RDoc::Parser
           end
 
         when 'until', 'while' then
-          if (RDoc::RipperStateLex::EXPR_LABEL & tk[:state]) == 0
+          if (tk[:state] & RDoc::RipperStateLex::EXPR_LABEL) == 0
             nest += 1
             skip_optional_do_after_expression
           end
@@ -1756,7 +1759,7 @@ class RDoc::Parser::Ruby < RDoc::Parser
           skip_optional_do_after_expression
 
         when 'case', 'do', 'if', 'unless', 'begin' then
-          if (RDoc::RipperStateLex::EXPR_LABEL & tk[:state]) == 0
+          if (tk[:state] & RDoc::RipperStateLex::EXPR_LABEL) == 0
             nest += 1
           end
 
@@ -1809,7 +1812,7 @@ class RDoc::Parser::Ruby < RDoc::Parser
 
       unless keep_comment then
         comment = new_comment ''
-        comment.force_encoding @encoding if @encoding
+        comment = RDoc::Encoding.change_encoding comment, @encoding if @encoding
         container.params = nil
         container.block_params = nil
       end
@@ -2053,15 +2056,6 @@ class RDoc::Parser::Ruby < RDoc::Parser
     container.record_location @top_level
   end
 
-  ##
-  # Removes private comments from +comment+
-  #--
-  # TODO remove
-
-  def remove_private_comments comment
-    comment.remove_private
-  end
-
   ##
   # Scans this Ruby file for Ruby constructs
 

data/lib/rdoc/parser/ruby_tools.rb

@@ -1,7 +1,6 @@
-# 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