rdoc 6.5.0 → 6.7.0

data/lib/rdoc/markdown/literals.rb

@@ -3,7 +3,6 @@
 # :markup: markdown
 
 ##
-#--
 # This set of literals is for Ruby 1.9 regular expressions and gives full
 # unicode support.
 #
@@ -39,45 +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 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)
-        unless @line_offsets
-          @line_offsets = []
-          total = 0
-          string.each_line do |line|
-            total += line.size
-            @line_offsets << total
-          end
+        if line = position_line_offsets.bsearch_index {|x| x > target }
+          return line + 1
         end
-
-        @line_offsets.bsearch_index {|x| x >= target } + 1 || -1
+        raise "Target position #{target} is outside of string"
       end
     else
       def current_line(target=pos)
-        cur_offset = 0
-        cur_line = 0
-
-        string.each_line do |line|
-          cur_line += 1
-          cur_offset += line.size
-          return cur_line if cur_offset >= target
+        if line = position_line_offsets.index {|x| x > target }
+          return line + 1
         end
 
-        -1
+        raise "Target position #{target} is outside of string"
+      end
+    end
+
+    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)
+
+    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
 
 
@@ -91,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
@@ -115,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
 
@@ -151,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]
@@ -163,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
 
@@ -275,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
@@ -308,6 +329,7 @@ class RDoc::Markdown::Literals
     end
 
     def apply(rule)
+      @result = nil
       if m = @memoizations[rule][@pos]
         @pos = m.pos
         if !m.set

data/lib/rdoc/markdown.kpeg

@@ -9,7 +9,7 @@
 # RDoc::Markdown as described by the [markdown syntax][syntax].
 #
 # To choose Markdown as your only default format see
-# RDoc::Options@Saved+Options for instructions on setting up a `.doc_options`
+# RDoc::Options@Saved+Options for instructions on setting up a `.rdoc_options`
 # file to store your project default.
 #
 # ## Usage
@@ -178,7 +178,7 @@
 # [dingus]: http://daringfireball.net/projects/markdown/dingus
 # [GFM]: https://github.github.com/gfm/
 # [pegmarkdown]: https://github.com/jgm/peg-markdown
-# [PHPE]: http://michelf.com/projects/php-markdown/extra/#def-list
+# [PHPE]: https://michelf.ca/projects/php-markdown/extra/#def-list
 # [syntax]: http://daringfireball.net/projects/markdown/syntax
 #--
 # Last updated to jgm/peg-markdown commit 8f8fc22ef0
@@ -1237,7 +1237,7 @@ DefinitionListItem = ( DefinitionListLabel+ ):label
                        list_items
                      }
 
-DefinitionListLabel = StrChunk:label @Sp @Newline
+DefinitionListLabel = Inline:label @Sp @Newline
                       { label }
 
 DefinitionListDefinition = @NonindentSpace ":" @Space Inlines:a @BlankLine+

data/lib/rdoc/markdown.rb

@@ -6,7 +6,7 @@
 # RDoc::Markdown as described by the [markdown syntax][syntax].
 #
 # To choose Markdown as your only default format see
-# RDoc::Options@Saved+Options for instructions on setting up a `.doc_options`
+# RDoc::Options@Saved+Options for instructions on setting up a `.rdoc_options`
 # file to store your project default.
 #
 # ## Usage
@@ -175,7 +175,7 @@
 # [dingus]: http://daringfireball.net/projects/markdown/dingus
 # [GFM]: https://github.github.com/gfm/
 # [pegmarkdown]: https://github.com/jgm/peg-markdown
-# [PHPE]: http://michelf.com/projects/php-markdown/extra/#def-list
+# [PHPE]: https://michelf.ca/projects/php-markdown/extra/#def-list
 # [syntax]: http://daringfireball.net/projects/markdown/syntax
 #--
 # Last updated to jgm/peg-markdown commit 8f8fc22ef0
@@ -466,6 +466,7 @@ class RDoc::Markdown
     end
 
     def apply_with_args(rule, *args)
+      @result = nil
       memo_key = [rule, args]
       if m = @memoizations[memo_key][@pos]
         @pos = m.pos
@@ -499,6 +500,7 @@ class RDoc::Markdown
     end
 
     def apply(rule)
+      @result = nil
       if m = @memoizations[rule][@pos]
         @pos = m.pos
         if !m.set
@@ -16443,12 +16445,12 @@ class RDoc::Markdown
     return _tmp
   end
 
-  # DefinitionListLabel = StrChunk:label @Sp @Newline { label }
+  # DefinitionListLabel = Inline:label @Sp @Newline { label }
   def _DefinitionListLabel
 
     _save = self.pos
     while true # sequence
-      _tmp = apply(:_StrChunk)
+      _tmp = apply(:_Inline)
       label = @result
       unless _tmp
         self.pos = _save
@@ -16775,7 +16777,7 @@ class RDoc::Markdown
   Rules[:_TableAlign] = rule_info("TableAlign", "< /:?-+:?/ > @Sp {                 text.start_with?(\":\") ?                 (text.end_with?(\":\") ? :center : :left) :                 (text.end_with?(\":\") ? :right : nil)               }")
   Rules[:_DefinitionList] = rule_info("DefinitionList", "&{ definition_lists? } DefinitionListItem+:list { RDoc::Markup::List.new :NOTE, *list.flatten }")
   Rules[:_DefinitionListItem] = rule_info("DefinitionListItem", "DefinitionListLabel+:label DefinitionListDefinition+:defns { list_items = []                        list_items <<                          RDoc::Markup::ListItem.new(label, defns.shift)                         list_items.concat defns.map { |defn|                          RDoc::Markup::ListItem.new nil, defn                        } unless list_items.empty?                         list_items                      }")
-  Rules[:_DefinitionListLabel] = rule_info("DefinitionListLabel", "StrChunk:label @Sp @Newline { label }")
+  Rules[:_DefinitionListLabel] = rule_info("DefinitionListLabel", "Inline:label @Sp @Newline { label }")
   Rules[:_DefinitionListDefinition] = rule_info("DefinitionListDefinition", "@NonindentSpace \":\" @Space Inlines:a @BlankLine+ { paragraph a }")
   # :startdoc:
 end

data/lib/rdoc/markup/attr_changer.rb

@@ -20,4 +20,3 @@ class RDoc::Markup::AttrChanger
   end
 
 end
-

data/lib/rdoc/markup/attr_span.rb

@@ -33,4 +33,3 @@ class RDoc::Markup::AttrSpan
   end
 
 end
-

data/lib/rdoc/markup/attribute_manager.rb

@@ -1,19 +1,19 @@
 # frozen_string_literal: true
+
 ##
 # Manages changes of attributes in a block of text
 
-unless MatchData.method_defined?(:match_length)
-  using Module.new {
-    refine(MatchData) {
-      def match_length(nth)
-        b, e = offset(nth)
-        e - b if b
-      end
-    }
-  }
-end
-
 class RDoc::Markup::AttributeManager
+  unless ::MatchData.method_defined?(:match_length)
+    using ::Module.new {
+      refine(::MatchData) {
+        def match_length(nth) # :nodoc:
+          b, e = offset(nth)
+          e - b if b
+        end
+      }
+    }
+  end
 
   ##
   # The NUL character
@@ -138,6 +138,7 @@ class RDoc::Markup::AttributeManager
     res
   end
 
+  # :nodoc:
   def exclusive?(attr)
     (attr & @exclusive_bitmap) != 0
   end
@@ -155,6 +156,7 @@ class RDoc::Markup::AttributeManager
     convert_attrs_word_pair_map(str, attrs, exclusive)
   end
 
+  # :nodoc:
   def convert_attrs_matching_word_pairs(str, attrs, exclusive)
     # first do matching ones
     tags = @matching_word_pairs.select { |start, bitmap|
@@ -179,6 +181,7 @@ class RDoc::Markup::AttributeManager
     str.delete!(NON_PRINTING_START + NON_PRINTING_END)
   end
 
+  # :nodoc:
   def convert_attrs_word_pair_map(str, attrs, exclusive)
     # then non-matching
     unless @word_pair_map.empty? then
@@ -400,4 +403,3 @@ class RDoc::Markup::AttributeManager
   end
 
 end
-

data/lib/rdoc/markup/attributes.rb

@@ -68,4 +68,3 @@ class RDoc::Markup::Attributes
   end
 
 end
-

data/lib/rdoc/markup/blank_line.rb

@@ -25,4 +25,3 @@ class RDoc::Markup::BlankLine
   end
 
 end
-

data/lib/rdoc/markup/block_quote.rb

@@ -12,4 +12,3 @@ class RDoc::Markup::BlockQuote < RDoc::Markup::Raw
   end
 
 end
-

data/lib/rdoc/markup/document.rb

@@ -162,4 +162,3 @@ class RDoc::Markup::Document
   end
 
 end
-

data/lib/rdoc/markup/formatter.rb

@@ -90,7 +90,7 @@ class RDoc::Markup::Formatter
 
   def add_regexp_handling_TIDYLINK
     @markup.add_regexp_handling(/(?:
-                                  \{.*?\} |    # multi-word label
+                                  \{[^{}]*\} | # multi-word label
                                   \b[^\s{}]+? # single-word label
                                  )
 
@@ -263,4 +263,3 @@ class RDoc::Markup::Formatter
   end
 
 end
-

data/lib/rdoc/markup/hard_break.rb

@@ -29,4 +29,3 @@ class RDoc::Markup::HardBreak
   end
 
 end
-

data/lib/rdoc/markup/heading.rb

@@ -76,4 +76,3 @@ RDoc::Markup::Heading =
   end
 
 end
-

data/lib/rdoc/markup/include.rb

@@ -40,4 +40,3 @@ class RDoc::Markup::Include
   end
 
 end
-

data/lib/rdoc/markup/indented_paragraph.rb

@@ -45,4 +45,3 @@ class RDoc::Markup::IndentedParagraph < RDoc::Markup::Raw
   end
 
 end
-

data/lib/rdoc/markup/list.rb

@@ -99,4 +99,3 @@ class RDoc::Markup::List
   end
 
 end
-

data/lib/rdoc/markup/list_item.rb

@@ -97,4 +97,3 @@ class RDoc::Markup::ListItem
   end
 
 end
-

data/lib/rdoc/markup/paragraph.rb

@@ -26,4 +26,3 @@ class RDoc::Markup::Paragraph < RDoc::Markup::Raw
   end
 
 end
-

data/lib/rdoc/markup/parser.rb

@@ -218,7 +218,7 @@ class RDoc::Markup::Parser
 
         break if peek_token.first == :BREAK
 
-        data << ' ' if skip :NEWLINE
+        data << ' ' if skip :NEWLINE and /#{SPACE_SEPARATED_LETTER_CLASS}\z/o.match?(data)
       else
         unget
         break
@@ -420,6 +420,8 @@ class RDoc::Markup::Parser
   # A simple wrapper of StringScanner that is aware of the current column and lineno
 
   class MyStringScanner
+    # :stopdoc:
+
     def initialize(input)
       @line = @column = 0
       @s = StringScanner.new input
@@ -456,6 +458,8 @@ class RDoc::Markup::Parser
     def [](i)
       @s[i]
     end
+
+    #:startdoc:
   end
 
   ##

data/lib/rdoc/markup/raw.rb

@@ -67,4 +67,3 @@ class RDoc::Markup::Raw
   end
 
 end
-

data/lib/rdoc/markup/regexp_handling.rb

@@ -38,4 +38,3 @@ class RDoc::Markup::RegexpHandling
   end
 
 end
-

data/lib/rdoc/markup/rule.rb

@@ -18,4 +18,3 @@ class RDoc::Markup::Rule < Struct.new :weight
   end
 
 end
-

data/lib/rdoc/markup/table.rb

@@ -3,12 +3,21 @@
 # A section of table
 
 class RDoc::Markup::Table
-  attr_accessor :header, :align, :body
+  # headers of each column
+  attr_accessor :header
 
+  # alignments of each column
+  attr_accessor :align
+
+  # body texts of each column
+  attr_accessor :body
+
+  # Creates new instance
   def initialize header, align, body
     @header, @align, @body = header, align, body
   end
 
+  # :stopdoc:
   def == other
     self.class == other.class and
       @header == other.header and
@@ -20,7 +29,7 @@ class RDoc::Markup::Table
     visitor.accept_table @header, @body, @align
   end
 
-  def pretty_print q # :nodoc:
+  def pretty_print q
     q.group 2, '[Table: ', ']' do
       q.group 2, '[Head: ', ']' do
         q.seplist @header.zip(@align) do |text, align|

data/lib/rdoc/markup/to_ansi.rb

@@ -91,4 +91,3 @@ class RDoc::Markup::ToAnsi < RDoc::Markup::ToRdoc
   end
 
 end
-

data/lib/rdoc/markup/to_bs.rb

@@ -40,6 +40,31 @@ class RDoc::Markup::ToBs < RDoc::Markup::ToRdoc
     @res << "\n"
   end
 
+  ##
+  # Prepares the visitor for consuming +list_item+
+
+  def accept_list_item_start list_item
+    type = @list_type.last
+
+    case type
+    when :NOTE, :LABEL then
+      bullets = Array(list_item.label).map do |label|
+        attributes(label).strip
+      end.join "\n"
+
+      bullets << ":\n" unless bullets.empty?
+
+      @prefix = ' ' * @indent
+      @indent += 2
+      @prefix << bullets + (' ' * @indent)
+    else
+      bullet = type == :BULLET ? '*' :  @list_index.last.to_s + '.'
+      @prefix = (' ' * @indent) + bullet.ljust(bullet.length + 1)
+      width = bullet.length + 1
+      @indent += width
+    end
+  end
+
   ##
   # Turns on or off regexp handling for +convert_string+
 

data/lib/rdoc/markup/to_html.rb

@@ -61,6 +61,7 @@ class RDoc::Markup::ToHtml < RDoc::Markup::Formatter
   #
   # These methods are used by regexp handling markup added by RDoc::Markup#add_regexp_handling.
 
+  # :nodoc:
   URL_CHARACTERS_REGEXP_STR = /[A-Za-z0-9\-._~:\/\?#\[\]@!$&'\(\)*+,;%=]/.source
 
   ##
@@ -202,7 +203,9 @@ class RDoc::Markup::ToHtml < RDoc::Markup::Formatter
   def accept_paragraph paragraph
     @res << "\n<p>"
     text = paragraph.text @hard_break
-    text = text.gsub(/\r?\n/, ' ')
+    text = text.gsub(/(#{SPACE_SEPARATED_LETTER_CLASS})?\K\r?\n(?=(?(1)(#{SPACE_SEPARATED_LETTER_CLASS})?))/o) {
+      defined?($2) && ' '
+    }
     @res << to_html(text)
     @res << "</p>\n"
   end
@@ -430,7 +433,9 @@ class RDoc::Markup::ToHtml < RDoc::Markup::Formatter
 
   def parseable? text
     verbose, $VERBOSE = $VERBOSE, nil
-    eval("BEGIN {return true}\n#{text}")
+    catch(:valid) do
+      eval("BEGIN { throw :valid, true }\n#{text}")
+    end
   rescue SyntaxError
     false
   ensure
@@ -445,4 +450,3 @@ class RDoc::Markup::ToHtml < RDoc::Markup::Formatter
   end
 
 end
-

data/lib/rdoc/markup/to_html_crossref.rb

@@ -42,6 +42,7 @@ class RDoc::Markup::ToHtmlCrossref < RDoc::Markup::ToHtml
     @cross_reference = RDoc::CrossReference.new @context
   end
 
+  # :nodoc:
   def init_link_notation_regexp_handlings
     add_regexp_handling_RDOCLINK
 
@@ -62,8 +63,8 @@ class RDoc::Markup::ToHtmlCrossref < RDoc::Markup::ToHtml
 
     name = name[1..-1] unless @show_hash if name[0, 1] == '#'
 
-    if !(name.end_with?('+@', '-@')) and name =~ /(.*[^#:])@/
-      text ||= "#{CGI.unescape $'} at <code>#{$1}</code>"
+    if !(name.end_with?('+@', '-@')) and name =~ /(.*[^#:])?@/
+      text ||= [CGI.unescape($'), (" at <code>#{$1}</code>" if $~.begin(1))].join("")
       code = false
     else
       text ||= name
@@ -138,39 +139,37 @@ class RDoc::Markup::ToHtmlCrossref < RDoc::Markup::ToHtml
   # Creates an HTML link to +name+ with the given +text+.
 
   def link name, text, code = true
-    if !(name.end_with?('+@', '-@')) and name =~ /(.*[^#:])@/
+    if !(name.end_with?('+@', '-@')) and name =~ /(.*[^#:])?@/
       name = $1
       label = $'
     end
 
-    ref = @cross_reference.resolve name, text
+    ref = @cross_reference.resolve name, text if name
 
     case ref
     when String then
       ref
     else
-      path = ref.as_href @from_path
+      path = ref ? ref.as_href(@from_path) : +""
 
       if code and RDoc::CodeObject === ref and !(RDoc::TopLevel === ref)
         text = "<code>#{CGI.escapeHTML text}</code>"
       end
 
-      if path =~ /#/ then
-        path << "-label-#{label}"
-      elsif ref.sections and
-            ref.sections.any? { |section| label == section.title } then
-        path << "##{label}"
-      else
-        if ref.respond_to?(:aref)
+      if label
+        if path =~ /#/
+          path << "-label-#{label}"
+        elsif ref&.sections&.any? { |section| label == section.title }
+          path << "##{label}"
+        elsif ref.respond_to?(:aref)
           path << "##{ref.aref}-label-#{label}"
         else
           path << "#label-#{label}"
         end
-      end if label
+      end
 
       "<a href=\"#{path}\">#{text}</a>"
     end
   end
 
 end
-

data/lib/rdoc/markup/to_html_snippet.rb

@@ -66,6 +66,9 @@ class RDoc::Markup::ToHtmlSnippet < RDoc::Markup::ToHtml
 
   alias accept_rule ignore
 
+  ##
+  # Adds +paragraph+ to the output
+
   def accept_paragraph paragraph
     para = @in_list_entry.last || "<p>"
 
@@ -282,4 +285,3 @@ class RDoc::Markup::ToHtmlSnippet < RDoc::Markup::ToHtml
   end
 
 end
-