rdoc 5.1.0 → 6.13.1

data/lib/rdoc/generator/template/json_index/js/navigation.js

@@ -10,10 +10,8 @@ Navigation = new function() {
   this.initNavigation = function() {
     var _this = this;
 
-    $(document).keydown(function(e) {
+    document.addEventListener('keydown', function(e) {
       _this.onkeydown(e);
-    }).keyup(function(e) {
-      _this.onkeyup(e);
     });
 
     this.navigationActive = true;
@@ -21,68 +19,33 @@ Navigation = new function() {
 
   this.setNavigationActive = function(state) {
     this.navigationActive = state;
-    this.clearMoveTimeout();
-  }
-
-  this.onkeyup = function(e) {
-    if (!this.navigationActive) return;
-
-    switch(e.keyCode) {
-      case 37: //Event.KEY_LEFT:
-      case 38: //Event.KEY_UP:
-      case 39: //Event.KEY_RIGHT:
-      case 40: //Event.KEY_DOWN:
-        this.clearMoveTimeout();
-        break;
-    }
   }
 
   this.onkeydown = function(e) {
     if (!this.navigationActive) return;
-    switch(e.keyCode) {
-      case 37: //Event.KEY_LEFT:
+    switch(e.key) {
+      case 'ArrowLeft':
         if (this.moveLeft()) e.preventDefault();
         break;
-      case 38: //Event.KEY_UP:
-        if (e.keyCode == 38 || e.ctrlKey) {
+      case 'ArrowUp':
+        if (e.key == 'ArrowUp' || e.ctrlKey) {
           if (this.moveUp()) e.preventDefault();
-          this.startMoveTimeout(false);
         }
         break;
-      case 39: //Event.KEY_RIGHT:
+      case 'ArrowRight':
         if (this.moveRight()) e.preventDefault();
         break;
-      case 40: //Event.KEY_DOWN:
-        if (e.keyCode == 40 || e.ctrlKey) {
+      case 'ArrowDown':
+        if (e.key == 'ArrowDown' || e.ctrlKey) {
           if (this.moveDown()) e.preventDefault();
-          this.startMoveTimeout(true);
         }
         break;
-      case 13: //Event.KEY_RETURN:
-        if (this.$current)
-          e.preventDefault();
-          this.select(this.$current);
+      case 'Enter':
+        if (this.current) e.preventDefault();
+        this.select(this.current);
         break;
     }
-    if (e.ctrlKey && e.shiftKey) this.select(this.$current);
-  }
-
-  this.clearMoveTimeout = function() {
-    clearTimeout(this.moveTimeout);
-    this.moveTimeout = null;
-  }
-
-  this.startMoveTimeout = function(isDown) {
-    if (!$.browser.mozilla && !$.browser.opera) return;
-    if (this.moveTimeout) this.clearMoveTimeout();
-    var _this = this;
-
-    var go = function() {
-      if (!_this.moveTimeout) return;
-      _this[isDown ? 'moveDown' : 'moveUp']();
-      _this.moveTimout = setTimeout(go, 100);
-    }
-    this.moveTimeout = setTimeout(go, 200);
+    if (e.ctrlKey && e.shiftKey) this.select(this.current);
   }
 
   this.moveRight = function() {

data/lib/rdoc/generator/template/json_index/js/searcher.js

@@ -51,20 +51,20 @@ Searcher.prototype = new function() {
 
   /*  ----- Utilities ------  */
   function splitQuery(query) {
-    return jQuery.grep(query.split(/(\s+|::?|\(\)?)/), function(string) {
+    return query.split(/(\s+|::?|\(\)?)/).filter(function(string) {
       return string.match(/\S/);
     });
   }
 
   function buildRegexps(queries) {
-    return jQuery.map(queries, function(query) {
+    return queries.map(function(query) {
       return new RegExp(query.replace(/(.)/g, '([$1])([^$1]*?)'), 'i');
     });
   }
 
   function buildHilighters(queries) {
-    return jQuery.map(queries, function(query) {
-      return jQuery.map(query.split(''), function(l, i) {
+    return queries.map(function(query) {
+      return query.split('').map(function(l, i) {
         return '\u0001$' + (i*2+1) + '\u0002$' + (i*2+2);
       }).join('');
     });
@@ -221,9 +221,9 @@ Searcher.prototype = new function() {
   }
 
   function triggerResults(results, isLast) {
-    jQuery.each(this.handlers, function(i, fn) {
+    this.handlers.forEach(function(fn) {
       fn.call(this, results, isLast)
-    })
+    });
   }
 }
 

data/lib/rdoc/generator.rb

@@ -1,4 +1,4 @@
-# frozen_string_literal: false
+# frozen_string_literal: true
 ##
 # RDoc uses generators to turn parsed source code in the form of an
 # RDoc::CodeObject tree into some form of output.  RDoc comes with the HTML
@@ -41,11 +41,11 @@
 
 module RDoc::Generator
 
-  autoload :Markup,   'rdoc/generator/markup'
+  autoload :Markup,   "#{__dir__}/generator/markup"
 
-  autoload :Darkfish,  'rdoc/generator/darkfish'
-  autoload :JsonIndex, 'rdoc/generator/json_index'
-  autoload :RI,        'rdoc/generator/ri'
-  autoload :POT,       'rdoc/generator/pot'
+  autoload :Darkfish,  "#{__dir__}/generator/darkfish"
+  autoload :JsonIndex, "#{__dir__}/generator/json_index"
+  autoload :RI,        "#{__dir__}/generator/ri"
+  autoload :POT,       "#{__dir__}/generator/pot"
 
 end

data/lib/rdoc/i18n/locale.rb

@@ -1,4 +1,4 @@
-# frozen_string_literal: false
+# frozen_string_literal: true
 ##
 # A message container for a locale.
 #

data/lib/rdoc/i18n/text.rb

@@ -1,4 +1,4 @@
-# frozen_string_literal: false
+# frozen_string_literal: true
 ##
 # An i18n supported text.
 #
@@ -46,9 +46,9 @@ class RDoc::I18n::Text
     parse do |part|
       case part[:type]
       when :paragraph
-        translated_text << locale.translate(part[:paragraph])
+        translated_text += locale.translate(part[:paragraph])
       when :empty_line
-        translated_text << part[:line]
+        translated_text += part[:line]
       else
         raise "should not reach here: unexpected type: #{type}"
       end
@@ -69,14 +69,14 @@ class RDoc::I18n::Text
         if paragraph.empty?
           emit_empty_line_event(line, line_no, &block)
         else
-          paragraph << line
+          paragraph += line
           emit_paragraph_event(paragraph, paragraph_start_line, line_no,
                                &block)
           paragraph = ''
         end
       else
         paragraph_start_line = line_no if paragraph.empty?
-        paragraph << line
+        paragraph += line
       end
     end
 

data/lib/rdoc/i18n.rb

@@ -1,10 +1,10 @@
-# frozen_string_literal: false
+# frozen_string_literal: true
 ##
-# This module provides i18n realated features.
+# This module provides i18n related features.
 
 module RDoc::I18n
 
-  autoload :Locale, 'rdoc/i18n/locale'
-  autoload :Text,   'rdoc/i18n/text'
+  autoload :Locale, "#{__dir__}/i18n/locale"
+  require_relative 'i18n/text'
 
 end

data/lib/rdoc/known_classes.rb

@@ -1,4 +1,4 @@
-# frozen_string_literal: false
+# frozen_string_literal: true
 module RDoc
 
   ##
@@ -25,6 +25,7 @@ module RDoc
     "rb_cObject"           => "Object",
     "rb_cProc"             => "Proc",
     "rb_cRange"            => "Range",
+    "rb_cRefinement"       => "Refinement",
     "rb_cRegexp"           => "Regexp",
     "rb_cRubyVM"           => "RubyVM",
     "rb_cSocket"           => "Socket",
@@ -35,7 +36,7 @@ module RDoc
     "rb_cTime"             => "Time",
     "rb_cTrueClass"        => "TrueClass",
 
-    "rb_eArgError"         => "ArgError",
+    "rb_eArgError"         => "ArgumentError",
     "rb_eEOFError"         => "EOFError",
     "rb_eException"        => "Exception",
     "rb_eFatal"            => "fatal",
@@ -45,8 +46,8 @@ module RDoc
     "rb_eInterrupt"        => "Interrupt",
     "rb_eLoadError"        => "LoadError",
     "rb_eNameError"        => "NameError",
-    "rb_eNoMemError"       => "NoMemError",
-    "rb_eNotImpError"      => "NotImpError",
+    "rb_eNoMemError"       => "NoMemoryError",
+    "rb_eNotImpError"      => "NotImplementedError",
     "rb_eRangeError"       => "RangeError",
     "rb_eRuntimeError"     => "RuntimeError",
     "rb_eScriptError"      => "ScriptError",
@@ -57,7 +58,7 @@ module RDoc
     "rb_eSystemCallError"  => "SystemCallError",
     "rb_eSystemExit"       => "SystemExit",
     "rb_eTypeError"        => "TypeError",
-    "rb_eZeroDivError"     => "ZeroDivError",
+    "rb_eZeroDivError"     => "ZeroDivisionError",
 
     "rb_mComparable"       => "Comparable",
     "rb_mEnumerable"       => "Enumerable",

data/lib/rdoc/markdown/entities.rb

@@ -1,4 +1,4 @@
-# frozen_string_literal: false
+# frozen_string_literal: true
 ##
 # HTML entity name map for RDoc::Markdown
 
@@ -2129,4 +2129,3 @@ RDoc::Markdown::HTML_ENTITIES = {
   "zwj" => [0x0200D],
   "zwnj" => [0x0200C],
 }
-

data/lib/rdoc/markdown/literals.kpeg

@@ -2,10 +2,10 @@
 
 %% header {
 # coding: UTF-8
+# frozen_string_literal: true
 # :markup: markdown
 
 ##
-#--
 # This set of literals is for Ruby 1.9 regular expressions and gives full
 # unicode support.
 #
@@ -19,4 +19,3 @@ BOM               = "\uFEFF"
 Newline           = /\n|\r\n?|\p{Zl}|\p{Zp}/
 NonAlphanumeric   = /\p{^Word}/
 Spacechar         = /\t|\p{Zs}/
-

data/lib/rdoc/markdown/literals.rb

@@ -1,9 +1,8 @@
 # coding: UTF-8
-# frozen_string_literal: false
+# frozen_string_literal: true
 # :markup: markdown
 
 ##
-#--
 # This set of literals is for Ruby 1.9 regular expressions and gives full
 # unicode support.
 #
@@ -29,6 +28,7 @@ class RDoc::Markdown::Literals
       @result = nil
       @failed_rule = nil
       @failing_rule_offset = -1
+      @line_offsets = nil
 
       setup_foreign_grammar
     end
@@ -38,30 +38,75 @@ class RDoc::Markdown::Literals
     attr_accessor :result, :pos
 
     def current_column(target=pos)
-      if c = string.rindex("\n", target-1)
-        return target - c - 1
+      if string[target] == "\n" && (c = string.rindex("\n", target-1) || -1)
+        return target - c
+      elsif c = string.rindex("\n", target)
+        return target - c
       end
 
       target + 1
     end
 
-    def current_line(target=pos)
-      cur_offset = 0
-      cur_line = 0
+    def position_line_offsets
+      unless @position_line_offsets
+        @position_line_offsets = []
+        total = 0
+        string.each_line do |line|
+          total += line.size
+          @position_line_offsets << total
+        end
+      end
+      @position_line_offsets
+    end
+
+    if [].respond_to? :bsearch_index
+      def current_line(target=pos)
+        if line = position_line_offsets.bsearch_index {|x| x > target }
+          return line + 1
+        end
+        raise "Target position #{target} is outside of string"
+      end
+    else
+      def current_line(target=pos)
+        if line = position_line_offsets.index {|x| x > target }
+          return line + 1
+        end
+
+        raise "Target position #{target} is outside of string"
+      end
+    end
 
-      string.each_line do |line|
-        cur_line += 1
-        cur_offset += line.size
-        return cur_line if cur_offset >= target
+    def current_character(target=pos)
+      if target < 0 || target >= string.size
+        raise "Target position #{target} is outside of string"
       end
+      string[target, 1]
+    end
+
+    KpegPosInfo = Struct.new(:pos, :lno, :col, :line, :char)
 
-      -1
+    def current_pos_info(target=pos)
+      l = current_line target
+      c = current_column target
+      ln = get_line(l-1)
+      chr = string[target,1]
+      KpegPosInfo.new(target, l, c, ln, chr)
     end
 
     def lines
-      lines = []
-      string.each_line { |l| lines << l }
-      lines
+      string.lines
+    end
+
+    def get_line(no)
+      loff = position_line_offsets
+      if no < 0
+        raise "Line No is out of range: #{no} < 0"
+      elsif no >= loff.size
+        raise "Line No is out of range: #{no} >= #{loff.size}"
+      end
+      lend = loff[no]-1
+      lstart = no > 0 ? loff[no-1] : 0
+      string[lstart..lend]
     end
 
 
@@ -75,6 +120,7 @@ class RDoc::Markdown::Literals
       @string = string
       @string_size = string ? string.size : 0
       @pos = pos
+      @position_line_offsets = nil
     end
 
     def show_pos
@@ -99,30 +145,22 @@ class RDoc::Markdown::Literals
     end
 
     def failure_caret
-      l = current_line @failing_rule_offset
-      c = current_column @failing_rule_offset
-
-      line = lines[l-1]
-      "#{line}\n#{' ' * (c - 1)}^"
+      p = current_pos_info @failing_rule_offset
+      "#{p.line.chomp}\n#{' ' * (p.col - 1)}^"
     end
 
     def failure_character
-      l = current_line @failing_rule_offset
-      c = current_column @failing_rule_offset
-      lines[l-1][c-1, 1]
+      current_character @failing_rule_offset
     end
 
     def failure_oneline
-      l = current_line @failing_rule_offset
-      c = current_column @failing_rule_offset
-
-      char = lines[l-1][c-1, 1]
+      p = current_pos_info @failing_rule_offset
 
       if @failed_rule.kind_of? Symbol
         info = self.class::Rules[@failed_rule]
-        "@#{l}:#{c} failed rule '#{info.name}', got '#{char}'"
+        "@#{p.lno}:#{p.col} failed rule '#{info.name}', got '#{p.char}'"
       else
-        "@#{l}:#{c} failed rule '#{@failed_rule}', got '#{char}'"
+        "@#{p.lno}:#{p.col} failed rule '#{@failed_rule}', got '#{p.char}'"
       end
     end
 
@@ -135,10 +173,9 @@ class RDoc::Markdown::Literals
 
     def show_error(io=STDOUT)
       error_pos = @failing_rule_offset
-      line_no = current_line(error_pos)
-      col_no = current_column(error_pos)
+      p = current_pos_info(error_pos)
 
-      io.puts "On line #{line_no}, column #{col_no}:"
+      io.puts "On line #{p.lno}, column #{p.col}:"
 
       if @failed_rule.kind_of? Symbol
         info = self.class::Rules[@failed_rule]
@@ -147,10 +184,9 @@ class RDoc::Markdown::Literals
         io.puts "Failed to match rule '#{@failed_rule}'"
       end
 
-      io.puts "Got: #{string[error_pos,1].inspect}"
-      line = lines[line_no-1]
-      io.puts "=> #{line}"
-      io.print(" " * (col_no + 3))
+      io.puts "Got: #{p.char.inspect}"
+      io.puts "=> #{p.line}"
+      io.print(" " * (p.col + 2))
       io.puts "^"
     end
 
@@ -174,23 +210,34 @@ class RDoc::Markdown::Literals
     end
 
     def scan(reg)
-      if m = reg.match(@string[@pos..-1])
-        width = m.end(0)
-        @pos += width
+      if m = reg.match(@string, @pos)
+        @pos = m.end(0)
         return true
       end
 
       return nil
     end
 
-    def get_byte
-      if @pos >= @string_size
-        return nil
+    if "".respond_to? :ord
+      def get_byte
+        if @pos >= @string_size
+          return nil
+        end
+
+        s = @string[@pos].ord
+        @pos += 1
+        s
       end
+    else
+      def get_byte
+        if @pos >= @string_size
+          return nil
+        end
 
-      s = @string[@pos].ord
-      @pos += 1
-      s
+        s = @string[@pos]
+        @pos += 1
+        s
+      end
     end
 
     def parse(rule=nil)
@@ -248,6 +295,7 @@ class RDoc::Markdown::Literals
     end
 
     def apply_with_args(rule, *args)
+      @result = nil
       memo_key = [rule, args]
       if m = @memoizations[memo_key][@pos]
         @pos = m.pos
@@ -281,6 +329,7 @@ class RDoc::Markdown::Literals
     end
 
     def apply(rule)
+      @result = nil
       if m = @memoizations[rule][@pos]
         @pos = m.pos
         if !m.set
@@ -354,14 +403,14 @@ class RDoc::Markdown::Literals
 
   # Alphanumeric = /\p{Word}/
   def _Alphanumeric
-    _tmp = scan(/\A(?-mix:\p{Word})/)
+    _tmp = scan(/\G(?-mix:\p{Word})/)
     set_failed_rule :_Alphanumeric unless _tmp
     return _tmp
   end
 
   # AlphanumericAscii = /[A-Za-z0-9]/
   def _AlphanumericAscii
-    _tmp = scan(/\A(?-mix:[A-Za-z0-9])/)
+    _tmp = scan(/\G(?-mix:[A-Za-z0-9])/)
     set_failed_rule :_AlphanumericAscii unless _tmp
     return _tmp
   end
@@ -375,21 +424,21 @@ class RDoc::Markdown::Literals
 
   # Newline = /\n|\r\n?|\p{Zl}|\p{Zp}/
   def _Newline
-    _tmp = scan(/\A(?-mix:\n|\r\n?|\p{Zl}|\p{Zp})/)
+    _tmp = scan(/\G(?-mix:\n|\r\n?|\p{Zl}|\p{Zp})/)
     set_failed_rule :_Newline unless _tmp
     return _tmp
   end
 
   # NonAlphanumeric = /\p{^Word}/
   def _NonAlphanumeric
-    _tmp = scan(/\A(?-mix:\p{^Word})/)
+    _tmp = scan(/\G(?-mix:\p{^Word})/)
     set_failed_rule :_NonAlphanumeric unless _tmp
     return _tmp
   end
 
   # Spacechar = /\t|\p{Zs}/
   def _Spacechar
-    _tmp = scan(/\A(?-mix:\t|\p{Zs})/)
+    _tmp = scan(/\G(?-mix:\t|\p{Zs})/)
     set_failed_rule :_Spacechar unless _tmp
     return _tmp
   end