rdoc 6.3.0 → 6.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 18741ef6dd2db34af2ea15a9e8a154a760c1f01bb0d69d15dc3af3f70cc00d7c
-  data.tar.gz: e61ab91ee4b0e776dd36e934da0534e6d52aa259ddff18be057955e109db08b4
+  metadata.gz: d6c9787594ed9d69a7a9177e449d925063acbc6ace0273f7d0b1fc9ca6a31139
+  data.tar.gz: 5f5afd10a18a1aeabc8319350c191eeaa137e5f715a2e95cbf2443f5dca7f96c
 SHA512:
-  metadata.gz: 9ea75c4b0339de23f73f84c890b23cb0b7bacb87ea191258f54160a28a4519c0e8edfbf6bc17ef67e631d923b17cb2030f79048d269b032eefe8b92f62fdb9df
-  data.tar.gz: bdbf42dea5706d0b13ce653a8591ff9fc0ece11b4d49c18e7d32bd725e901a3dd2e5feb3479b4185a874d12e024e7f77b6324592405a9b826efd00bb68589373
+  metadata.gz: 94fbc007d81c0cc1774b44d5f174b5e011ef5ae3d998344b981a8b6170f1c630c3c80e45f87bcc4c05f97f51e34e9f3ede791846e0c01e4015c45cc8aab1b05e
+  data.tar.gz: '068da922a56b61ca85fa7b61d5554cdbe1533c30caae11e7d81894e41fca58157971c18a76c55391538324c168a720c2cbbc8150a12dc276eab033e70fae0217'

data/Gemfile

@@ -3,10 +3,10 @@ source 'https://rubygems.org'
 gemspec
 
 group :development do
-  gem "rake"
-  gem "racc", "> 1.4.10"
-  gem "kpeg"
-  gem "test-unit"
-  gem "minitest" # for test_rdoc_rubygems_hook.rb
-  gem "rubocop"
+  gem 'rake'
+  gem 'racc', '> 1.4.10'
+  gem 'kpeg', github: 'evanphx/kpeg'
+  gem 'test-unit'
+  gem 'rubocop'
+  gem 'gettext'
 end

data/Rakefile

@@ -2,7 +2,6 @@ $:.unshift File.expand_path 'lib'
 require 'rdoc/task'
 require 'bundler/gem_tasks'
 require 'rake/testtask'
-require 'rubocop/rake_task'
 
 task :docs    => :generate
 task :test    => [:normal_test, :rubygems_test]
@@ -62,13 +61,13 @@ package_parser_files = PARSER_FILES.map do |parser_file|
 end
 
 parsed_files = PARSER_FILES.map do |parser_file|
-  name = File.basename(parser_file, File.extname(parser_file))
-  _path = File.dirname(parser_file)
-  parsed_file = "#{_path}/#{name}.rb"
+  ext = File.extname(parser_file)
+  parsed_file = "#{parser_file.chomp(ext)}.rb"
 
-  file parsed_file do |t|
+  file parsed_file => parser_file do |t|
     puts "Generating #{parsed_file}..."
-    if parser_file =~ /\.ry\z/ # need racc
+    case ext
+    when '.ry' # need racc
       racc = Gem.bin_path 'racc', 'racc'
       rb_file = parser_file.gsub(/\.ry\z/, ".rb")
       ruby "#{racc} -l -o #{rb_file} #{parser_file}"
@@ -77,7 +76,7 @@ parsed_files = PARSER_FILES.map do |parser_file|
         f.rewind
         f.write newtext
       end
-    elsif parser_file =~ /\.kpeg\z/ # need kpeg
+    when '.kpeg' # need kpeg
       kpeg = Gem.bin_path 'kpeg', 'kpeg'
       rb_file = parser_file.gsub(/\.kpeg\z/, ".rb")
       ruby "#{kpeg} -fsv -o #{rb_file} #{parser_file}"
@@ -88,12 +87,21 @@ parsed_files = PARSER_FILES.map do |parser_file|
 end
 
 task "#{path}.gem" => package_parser_files
+desc "Generate all files used racc and kpeg"
+task :generate => parsed_files
 
-RuboCop::RakeTask.new(:rubocop) do |t|
-  t.options = [*parsed_files]
+task :clean do
+  parsed_files.each do |path|
+    File.delete(path) if File.exist?(path)
+  end
 end
 
-desc "Genrate all files used racc and kpeg"
-task :generate => parsed_files
-
-task :build => [:generate, "rubocop:auto_correct"]
+begin
+  require 'rubocop/rake_task'
+rescue LoadError
+else
+  RuboCop::RakeTask.new(:rubocop) do |t|
+    t.options = [*parsed_files]
+  end
+  task :build => [:generate, "rubocop:auto_correct"]
+end

data/lib/rdoc/any_method.rb

@@ -26,6 +26,9 @@ class RDoc::AnyMethod < RDoc::MethodAttr
 
   attr_accessor :c_function
 
+  # The section title of the method (if defined in a C file via +:category:+)
+  attr_accessor :section_title
+
   # Parameters for this method
 
   attr_accessor :params
@@ -356,6 +359,6 @@ class RDoc::AnyMethod < RDoc::MethodAttr
         entry =~ /\s#{ignore}\s/
     end
 
-    matching.join "\n"
+    matching.empty? ? nil : matching.join("\n")
   end
 end

data/lib/rdoc/cross_reference.rb

@@ -19,7 +19,7 @@ class RDoc::CrossReference
   #
   # See CLASS_REGEXP_STR
 
-  METHOD_REGEXP_STR = '([a-z]\w*[!?=]?|%|===|\[\]=?|<<|>>|\+@|-@|-|\+|\*)(?:\([\w.+*/=<>-]*\))?'
+  METHOD_REGEXP_STR = '([A-Za-z]\w*[!?=]?|%|===?|\[\]=?|<<|>>|\+@|-@|-|\+|\*)(?:\([\w.+*/=<>-]*\))?'
 
   ##
   # Regular expressions matching text that should potentially have
@@ -34,12 +34,6 @@ class RDoc::CrossReference
                        # A::B::C.meth
                        #{CLASS_REGEXP_STR}(?:[.#]|::)#{METHOD_REGEXP_STR}
 
-                       # Stand-alone method (preceded by a #)
-                       | \\?\##{METHOD_REGEXP_STR}
-
-                       # Stand-alone method (preceded by ::)
-                       | ::#{METHOD_REGEXP_STR}
-
                        # A::B::C
                        # The stuff after CLASS_REGEXP_STR is a
                        # nasty hack.  CLASS_REGEXP_STR unfortunately matches
@@ -56,6 +50,12 @@ class RDoc::CrossReference
                        # marker.
                        | #{CLASS_REGEXP_STR}(?=[@\s).?!,;<\000]|\z)
 
+                       # Stand-alone method (preceded by a #)
+                       | \\?\##{METHOD_REGEXP_STR}
+
+                       # Stand-alone method (preceded by ::)
+                       | ::#{METHOD_REGEXP_STR}
+
                        # Things that look like filenames
                        # The key thing is that there must be at least
                        # one special character (period, slash, or
@@ -82,12 +82,12 @@ class RDoc::CrossReference
                        # A::B::C.meth
                        #{CLASS_REGEXP_STR}(?:[.#]|::)#{METHOD_REGEXP_STR}
 
-                       # Stand-alone method
-                       | \\?#{METHOD_REGEXP_STR}
-
                        # A::B::C
                        | #{CLASS_REGEXP_STR}(?=[@\s).?!,;<\000]|\z)
 
+                       # Stand-alone method
+                       | \\?#{METHOD_REGEXP_STR}
+
                        # Things that look like filenames
                        | (?:\.\.\/)*[-\/\w]+[_\/.][-\w\/.]+
 
@@ -115,15 +115,8 @@ class RDoc::CrossReference
     @seen = {}
   end
 
-  ##
-  # Returns a reference to +name+.
-  #
-  # If the reference is found and +name+ is not documented +text+ will be
-  # returned.  If +name+ is escaped +name+ is returned.  If +name+ is not
-  # found +text+ is returned.
-
-  def resolve name, text
-    return @seen[name] if @seen.include? name
+  def resolve_method name
+    ref = nil
 
     if /#{CLASS_REGEXP_STR}([.#]|::)#{METHOD_REGEXP_STR}/o =~ name then
       type = $2
@@ -165,12 +158,27 @@ class RDoc::CrossReference
       end
     end
 
+    ref
+  end
+
+  ##
+  # Returns a reference to +name+.
+  #
+  # If the reference is found and +name+ is not documented +text+ will be
+  # returned.  If +name+ is escaped +name+ is returned.  If +name+ is not
+  # found +text+ is returned.
+
+  def resolve name, text
+    return @seen[name] if @seen.include? name
+
     ref = case name
           when /^\\(#{CLASS_REGEXP_STR})$/o then
             @context.find_symbol $1
           else
             @context.find_symbol name
-          end unless ref
+          end
+
+    ref = resolve_method name unless ref
 
     # Try a page name
     ref = @store.page name if not ref and name =~ /^[\w.]+$/

data/lib/rdoc/generator/darkfish.rb

@@ -220,8 +220,8 @@ class RDoc::Generator::Darkfish
       install_rdoc_static_file @template_dir + item, "./#{item}", options
     end
 
-    @options.template_stylesheets.each do |stylesheet|
-      FileUtils.cp stylesheet, '.', options
+    unless @options.template_stylesheets.empty?
+      FileUtils.cp @options.template_stylesheets, '.', **options
     end
 
     Dir[(@template_dir + "{js,images}/**/*").to_s].each do |path|

data/lib/rdoc/generator/template/darkfish/_head.rhtml

@@ -15,8 +15,6 @@
 
 <link href="<%= asset_rel_prefix %>/css/fonts.css" rel="stylesheet">
 <link href="<%= asset_rel_prefix %>/css/rdoc.css" rel="stylesheet">
-<%- if @options.template_stylesheets.flatten.any? then -%>
-<%-   @options.template_stylesheets.flatten.each do |stylesheet| -%>
+<%- @options.template_stylesheets.each do |stylesheet| -%>
 <link href="<%= asset_rel_prefix %>/<%= File.basename stylesheet %>" rel="stylesheet">
-<%-   end -%>
 <%- end -%>

data/lib/rdoc/generator/template/darkfish/css/rdoc.css

@@ -79,6 +79,25 @@ pre {
   border-radius: 0.2em;
 }
 
+table {
+  margin: 0;
+  border-spacing: 0;
+  border-collapse: collapse;
+}
+
+table tr th, table tr td {
+  padding: 0.2em 0.4em;
+  border: 1px solid #ccc;
+}
+
+table tr th {
+  background-color: #eceaed;
+}
+
+table tr:nth-child(even) td {
+  background-color: #f5f4f6;
+}
+
 /* @group Generic Classes */
 
 .initially-hidden {
@@ -166,6 +185,7 @@ nav {
   width: 260px;
   font-family: Helvetica, sans-serif;
   font-size: 14px;
+  border-right: 1px solid #ccc;
 }
 
 main {

data/lib/rdoc/markdown/literals.rb

@@ -174,9 +174,8 @@ 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
 
@@ -366,14 +365,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
@@ -387,21 +386,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

data/lib/rdoc/markdown.kpeg

@@ -506,6 +506,7 @@ Block =     @BlankLine*
             ( BlockQuote
             | Verbatim
             | CodeFence
+            | Table
             | Note
             | Reference
             | HorizontalRule
@@ -896,7 +897,8 @@ StyleBlock =    < InStyleTags >
                   end }
 
 Inlines  =  ( !@Endline Inline:i { i }
-            | @Endline:c &Inline { c } )+:chunks @Endline?
+            | @Endline:c !( &{ github? } Ticks3 /[^`\n]*$/ )
+	      &Inline { c } )+:chunks @Endline?
             { chunks }
 
 Inline  = Str
@@ -1195,6 +1197,22 @@ CodeFence = &{ github? }
               verbatim
             }
 
+Table = &{ github? }
+        TableRow:header TableLine:line TableRow+:body
+        { table = RDoc::Markup::Table.new(header, line, body) }
+
+TableRow = TableItem+:row "|" @Newline
+           { row }
+TableItem = "|" < (!"|" !@Newline .)+ >
+            { text.strip }
+
+TableLine = TableColumn+:line "|" @Newline
+            { line }
+TableColumn = "|" < ( "-"+ ":"? | ":" "-"* ) >
+              { text.start_with?(":") ? :left :
+                text.end_with?(":") ? :right : nil
+              }
+
 DefinitionList = &{ definition_lists? }
                  ( DefinitionListItem+:list )
                  { RDoc::Markup::List.new :NOTE, *list.flatten }