rdoc 6.0.4 → 6.1.0.beta1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 73cda21536da8aea204eec25054f346a21e97c1d16f7b8f43b7db552398e0a38
-  data.tar.gz: 3cfb14465a6bee87b00f470fb632e5557d84f623d84c90b7fcf0e37021667887
+  metadata.gz: 89e2fd9301cffd5438098b0666fbce4b53a02769e9a442853ee1b0a055267f30
+  data.tar.gz: 8177c1c7f3e5cb944b8427a9f57147fc36aedb225342c3b3b08b723e44c53775
 SHA512:
-  metadata.gz: ff1a36f399c5e3c3e3e833853c6ce27fe6886c6d09b0ba81e07b8d351cd339c7f120d0bd21691c792a2a7e63d323fece44ce8566b9d76e343b1aed3671fa7b3f
-  data.tar.gz: 50da0ecbb101c3104ff5a0bf7644fdb2db7758a6ad6243075b4b5180ba3175b20fcb3848ad47861794b4ba5ec6168d956579e939ed94dd7b53c0afc51e06a685
+  metadata.gz: 92f7944e6864801b64ca4dd5ccf7e1b1f6fecc84c10c52a9fb682a859968f588ed5a2205570f43d402ce45c38a01107e23f88972449185b04e2e56f580758d73
+  data.tar.gz: c98e04a271ccc6354e5b7000f652fe289a887d2684dc57367a3eb0dfd8270fada871ee0167e1942843232b75bd06db7f084881fb29cc437cd761668ec8b4ffbe

data/.travis.yml

@@ -4,16 +4,17 @@ before_install:
   - gem update bundler
 language: ruby
 rvm:
-  - 2.2.9
-  - 2.3.6
-  - 2.4.3
-  - 2.5.0
+  - 2.3.7
+  - 2.4.4
+  - 2.5.1
   - ruby-head
-  - jruby-9.1.16.0
+  - jruby-9.1.17.0
+  - jruby-9.2.0.0
 env:
   global:
     NOBENCHMARK=1
 script: rake
 matrix:
   allow_failures:
-    - rvm: jruby-9.1.16.0
+    - rvm: jruby-9.1.17.0
+    - rvm: jruby-9.2.0.0

data/Rakefile

@@ -2,6 +2,7 @@ $:.unshift File.expand_path 'lib'
 require 'rdoc/task'
 require 'bundler/gem_tasks'
 require 'rake/testtask'
+require 'rubocop/rake_task'
 
 task :docs    => :generate
 task :test    => :generate
@@ -80,7 +81,11 @@ end
 
 task "#{path}.gem" => package_parser_files
 
+RuboCop::RakeTask.new(:rubocop) do |t|
+  t.options = [*parsed_files]
+end
+
 desc "Genrate all files used racc and kpeg"
 task :generate => parsed_files
 
-task :build => [:generate]
+task :build => [:generate, "rubocop:auto_correct"]

data/lib/rdoc.rb

@@ -62,10 +62,7 @@ module RDoc
 
   class Error < RuntimeError; end
 
-  ##
-  # RDoc version you are using
-
-  VERSION = '6.0.4'
+  require 'rdoc/version'
 
   ##
   # Method visibilities
@@ -146,7 +143,6 @@ module RDoc
 
   autoload :KNOWN_CLASSES,  'rdoc/known_classes'
 
-  autoload :RipperStateLex, 'rdoc/parser/ripper_state_lex'
   autoload :TokenStream,    'rdoc/token_stream'
 
   autoload :Comment,        'rdoc/comment'

data/lib/rdoc/cross_reference.rb

@@ -19,12 +19,12 @@ class RDoc::CrossReference
   #
   # See CLASS_REGEXP_STR
 
-  METHOD_REGEXP_STR = '([a-z]\w*[!?=]?|%|===|\[\]=?|<<|>>)(?:\([\w.+*/=<>-]*\))?'
+  METHOD_REGEXP_STR = '([a-z]\w*[!?=]?|%|===|\[\]=?|<<|>>|-|\+|\*)(?:\([\w.+*/=<>-]*\))?'
 
   ##
   # Regular expressions matching text that should potentially have
-  # cross-reference links generated are passed to add_special.  Note that
-  # these expressions are meant to pick up text for which cross-references
+  # cross-reference links generated are passed to add_regexp_handling. Note
+  # that these expressions are meant to pick up text for which cross-references
   # have been suppressed, since the suppression characters are removed by the
   # code that is triggered.
 
@@ -127,23 +127,41 @@ class RDoc::CrossReference
 
     if /#{CLASS_REGEXP_STR}([.#]|::)#{METHOD_REGEXP_STR}/o =~ name then
       type = $2
-      type = '' if type == '.'  # will find either #method or ::method
-      method = "#{type}#{$3}"
+      if '.' == type # will find either #method or ::method
+        method = $3
+      else
+        method = "#{type}#{$3}"
+      end
       container = @context.find_symbol_module($1)
     elsif /^([.#]|::)#{METHOD_REGEXP_STR}/o =~ name then
       type = $1
-      type = '' if type == '.'
-      method = "#{type}#{$2}"
+      if '.' == type
+        method = $2
+      else
+        method = "#{type}#{$2}"
+      end
       container = @context
     else
+      type = nil
       container = nil
     end
 
     if container then
-      ref = container.find_local_symbol method
-
-      unless ref || RDoc::TopLevel === container then
-        ref = container.find_ancestor_local_symbol method
+      unless RDoc::TopLevel === container then
+        if '.' == type then
+          if 'new' == method then # AnyClassName.new will be class method
+            ref = container.find_local_symbol method
+            ref = container.find_ancestor_local_symbol method unless ref
+          else
+            ref = container.find_local_symbol "::#{method}"
+            ref = container.find_ancestor_local_symbol "::#{method}" unless ref
+            ref = container.find_local_symbol "##{method}" unless ref
+            ref = container.find_ancestor_local_symbol "##{method}" unless ref
+          end
+        else
+          ref = container.find_local_symbol method
+          ref = container.find_ancestor_local_symbol method unless ref
+        end
       end
     end
 

data/lib/rdoc/generator/markup.rb

@@ -65,16 +65,6 @@ end
 
 class RDoc::MethodAttr
 
-  @add_line_numbers = false
-
-  class << self
-    ##
-    # Allows controlling whether <tt>#markup_code</tt> adds line numbers to
-    # the source code.
-
-    attr_accessor :add_line_numbers
-  end
-
   ##
   # Prepend +src+ with line numbers.  Relies on the first line of a source
   # code listing having:
@@ -106,7 +96,7 @@ class RDoc::MethodAttr
   ##
   # Turns the method's token stream into HTML.
   #
-  # Prepends line numbers if +add_line_numbers+ is true.
+  # Prepends line numbers if +options.line_numbers+ is true.
 
   def markup_code
     return '' unless @token_stream
@@ -126,7 +116,7 @@ class RDoc::MethodAttr
     end
     src.gsub!(/^#{' ' * indent}/, '') if indent > 0
 
-    add_line_numbers(src) if RDoc::MethodAttr.add_line_numbers
+    add_line_numbers(src) if options.line_numbers
 
     src
   end

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

@@ -59,9 +59,8 @@ Navigation = new function() {
         }
         break;
       case 13: //Event.KEY_RETURN:
-        if (this.$current)
-          e.preventDefault();
-          this.select(this.$current);
+        if (this.$current) e.preventDefault();
+        this.select(this.$current);
         break;
     }
     if (e.ctrlKey && e.shiftKey) this.select(this.$current);
@@ -80,7 +79,7 @@ Navigation = new function() {
     var go = function() {
       if (!_this.moveTimeout) return;
       _this[isDown ? 'moveDown' : 'moveUp']();
-      _this.moveTimout = setTimeout(go, 100);
+      _this.moveTimeout = setTimeout(go, 100);
     }
     this.moveTimeout = setTimeout(go, 200);
   }

data/lib/rdoc/markup.rb

@@ -65,17 +65,16 @@
 #   puts h.convert(input_string)
 #
 # You can extend the RDoc::Markup parser to recognize new markup
-# sequences, and to add special processing for text that matches a
-# regular expression.  Here we make WikiWords significant to the parser,
-# and also make the sequences {word} and \<no>text...</no> signify
+# sequences, and to add regexp handling. Here we make WikiWords significant to
+# the parser, and also make the sequences {word} and \<no>text...</no> signify
 # strike-through text.  We then subclass the HTML output class to deal
 # with these:
 #
 #   require 'rdoc'
 #
 #   class WikiHtml < RDoc::Markup::ToHtml
-#     def handle_special_WIKIWORD(special)
-#       "<font color=red>" + special.text + "</font>"
+#     def handle_regexp_WIKIWORD(target)
+#       "<font color=red>" + target.text + "</font>"
 #     end
 #   end
 #
@@ -83,7 +82,7 @@
 #   markup.add_word_pair("{", "}", :STRIKE)
 #   markup.add_html("no", :STRIKE)
 #
-#   markup.add_special(/\b([A-Z][a-z]+[A-Z]\w+)/, :WIKIWORD)
+#   markup.add_regexp_handling(/\b([A-Z][a-z]+[A-Z]\w+)/, :WIKIWORD)
 #
 #   wh = WikiHtml.new RDoc::Options.new, markup
 #   wh.add_tag(:STRIKE, "<strike>", "</strike>")
@@ -800,13 +799,12 @@ https://github.com/ruby/rdoc/issues
   # Add to other inline sequences.  For example, we could add WikiWords using
   # something like:
   #
-  #    parser.add_special(/\b([A-Z][a-z]+[A-Z]\w+)/, :WIKIWORD)
+  #    parser.add_regexp_handling(/\b([A-Z][a-z]+[A-Z]\w+)/, :WIKIWORD)
   #
-  # Each wiki word will be presented to the output formatter via the
-  # accept_special method.
+  # Each wiki word will be presented to the output formatter.
 
-  def add_special(pattern, name)
-    @attribute_manager.add_special(pattern, name)
+  def add_regexp_handling(pattern, name)
+    @attribute_manager.add_regexp_handling(pattern, name)
   end
 
   ##
@@ -832,7 +830,7 @@ https://github.com/ruby/rdoc/issues
   autoload :AttrSpan,              'rdoc/markup/attr_span'
   autoload :Attributes,            'rdoc/markup/attributes'
   autoload :AttributeManager,      'rdoc/markup/attribute_manager'
-  autoload :Special,               'rdoc/markup/special'
+  autoload :RegexpHandling,        'rdoc/markup/regexp_handling'
 
   # RDoc::Markup AST
   autoload :BlankLine,             'rdoc/markup/blank_line'

data/lib/rdoc/markup/attribute_manager.rb

@@ -53,10 +53,10 @@ class RDoc::Markup::AttributeManager
   attr_reader :protectable
 
   ##
-  # And this maps _special_ sequences to a name. A special sequence is
-  # something like a WikiWord
+  # And this maps _regexp handling_ sequences to a name. A regexp handling
+  # sequence is something like a WikiWord
 
-  attr_reader :special
+  attr_reader :regexp_handlings
 
   ##
   # Creates a new attribute manager that understands bold, emphasized and
@@ -66,7 +66,7 @@ class RDoc::Markup::AttributeManager
     @html_tags = {}
     @matching_word_pairs = {}
     @protectable = %w[<]
-    @special = []
+    @regexp_handlings = []
     @word_pair_map = {}
     @attributes = RDoc::Markup::Attributes.new
 
@@ -166,22 +166,22 @@ class RDoc::Markup::AttributeManager
   end
 
   ##
-  # Converts special sequences to RDoc attributes
+  # Converts regexp handling sequences to RDoc attributes
 
-  def convert_specials str, attrs
-    @special.each do |regexp, attribute|
+  def convert_regexp_handlings str, attrs
+    @regexp_handlings.each do |regexp, attribute|
       str.scan(regexp) do
         capture = $~.size == 1 ? 0 : 1
 
         s, e = $~.offset capture
 
-        attrs.set_attrs s, e - s, attribute | @attributes.special
+        attrs.set_attrs s, e - s, attribute | @attributes.regexp_handling
       end
     end
   end
 
   ##
-  # Escapes special sequences of text to prevent conversion to RDoc
+  # Escapes regexp handling sequences of text to prevent conversion to RDoc
 
   def mask_protected_sequences
     # protect __send__, __FILE__, etc.
@@ -193,7 +193,7 @@ class RDoc::Markup::AttributeManager
   end
 
   ##
-  # Unescapes special sequences of text
+  # Unescapes regexp handling sequences of text
 
   def unmask_protected_sequences
     @str.gsub!(/(.)#{PROTECT_ATTR}/, "\\1\000")
@@ -233,17 +233,17 @@ class RDoc::Markup::AttributeManager
   end
 
   ##
-  # Adds a special handler for +pattern+ with +name+.  A simple URL handler
+  # Adds a regexp handling for +pattern+ with +name+.  A simple URL handler
   # would be:
   #
-  #   @am.add_special(/((https?:)\S+\w)/, :HYPERLINK)
+  #   @am.add_regexp_handling(/((https?:)\S+\w)/, :HYPERLINK)
 
-  def add_special pattern, name
-    @special << [pattern, @attributes.bitmap_for(name)]
+  def add_regexp_handling pattern, name
+    @regexp_handlings << [pattern, @attributes.bitmap_for(name)]
   end
 
   ##
-  # Processes +str+ converting attributes, HTML and specials
+  # Processes +str+ converting attributes, HTML and regexp handlings
 
   def flow str
     @str = str.dup
@@ -252,9 +252,9 @@ class RDoc::Markup::AttributeManager
 
     @attrs = RDoc::Markup::AttrSpan.new @str.length
 
-    convert_attrs    @str, @attrs
-    convert_html     @str, @attrs
-    convert_specials @str, @attrs
+    convert_attrs            @str, @attrs
+    convert_html             @str, @attrs
+    convert_regexp_handlings @str, @attrs
 
     unmask_protected_sequences
 
@@ -312,12 +312,12 @@ class RDoc::Markup::AttributeManager
         res << change_attribute(current_attr, new_attr)
         current_attr = new_attr
 
-        if (current_attr & @attributes.special) != 0 then
+        if (current_attr & @attributes.regexp_handling) != 0 then
           i += 1 while
-            i < str_len and (@attrs[i] & @attributes.special) != 0
+            i < str_len and (@attrs[i] & @attributes.regexp_handling) != 0
 
-          res << RDoc::Markup::Special.new(current_attr,
-                                           copy_string(start_pos, i))
+          res << RDoc::Markup::RegexpHandling.new(current_attr,
+                                                  copy_string(start_pos, i))
           start_pos = i
           next
         end

data/lib/rdoc/markup/attributes.rb

@@ -6,21 +6,21 @@
 class RDoc::Markup::Attributes
 
   ##
-  # The special attribute type.  See RDoc::Markup#add_special
+  # The regexp handling attribute type. See RDoc::Markup#add_regexp_handling
 
-  attr_reader :special
+  attr_reader :regexp_handling
 
   ##
   # Creates a new attributes set.
 
   def initialize
-    @special = 1
+    @regexp_handling = 1
 
     @name_to_bitmap = [
-      [:_SPECIAL_, @special],
+      [:_REGEXP_HANDLING_, @regexp_handling],
     ]
 
-    @next_bitmap = @special << 1
+    @next_bitmap = @regexp_handling << 1
   end
 
   ##
@@ -61,7 +61,7 @@ class RDoc::Markup::Attributes
     return enum_for __method__, bitmap unless block_given?
 
     @name_to_bitmap.each do |name, bit|
-      next if bit == @special
+      next if bit == @regexp_handling
 
       yield name.to_s if (bitmap & bit) != 0
     end

data/lib/rdoc/markup/formatter.rb

@@ -50,7 +50,7 @@ class RDoc::Markup::Formatter
 
     @markup = markup || RDoc::Markup.new
     @am     = @markup.attribute_manager
-    @am.add_special(/<br>/, :HARD_BREAK)
+    @am.add_regexp_handling(/<br>/, :HARD_BREAK)
 
     @attributes = @am.attributes
 
@@ -78,23 +78,24 @@ class RDoc::Markup::Formatter
   end
 
   ##
-  # Adds a special for links of the form rdoc-...:
+  # Adds a regexp handling for links of the form rdoc-...:
 
-  def add_special_RDOCLINK
-    @markup.add_special(/rdoc-[a-z]+:[^\s\]]+/, :RDOCLINK)
+  def add_regexp_handling_RDOCLINK
+    @markup.add_regexp_handling(/rdoc-[a-z]+:[^\s\]]+/, :RDOCLINK)
   end
 
   ##
-  # Adds a special for links of the form {<text>}[<url>] and <word>[<url>]
+  # Adds a regexp handling for links of the form {<text>}[<url>] and
+  # <word>[<url>]
 
-  def add_special_TIDYLINK
-    @markup.add_special(/(?:
-                          \{.*?\} |    # multi-word label
-                          \b[^\s{}]+? # single-word label
-                         )
+  def add_regexp_handling_TIDYLINK
+    @markup.add_regexp_handling(/(?:
+                                  \{.*?\} |    # multi-word label
+                                  \b[^\s{}]+? # single-word label
+                                 )
 
-                         \[\S+?\]     # link target
-                        /x, :TIDYLINK)
+                                 \[\S+?\]     # link target
+                                /x, :TIDYLINK)
   end
 
   ##
@@ -133,8 +134,8 @@ class RDoc::Markup::Formatter
       when RDoc::Markup::AttrChanger then
         off_tags res, item
         on_tags res, item
-      when RDoc::Markup::Special then
-        res << convert_special(item)
+      when RDoc::Markup::RegexpHandling then
+        res << convert_regexp_handling(item)
       else
         raise "Unknown flow element: #{item.inspect}"
       end
@@ -144,29 +145,29 @@ class RDoc::Markup::Formatter
   end
 
   ##
-  # Converts added specials.  See RDoc::Markup#add_special
+  # Converts added regexp handlings. See RDoc::Markup#add_regexp_handling
 
-  def convert_special special
-    return special.text if in_tt?
+  def convert_regexp_handling target
+    return target.text if in_tt?
 
     handled = false
 
-    @attributes.each_name_of special.type do |name|
-      method_name = "handle_special_#{name}"
+    @attributes.each_name_of target.type do |name|
+      method_name = "handle_regexp_#{name}"
 
       if respond_to? method_name then
-        special.text = send method_name, special
+        target.text = send method_name, target
         handled = true
       end
     end
 
     unless handled then
-      special_name = @attributes.as_string special.type
+      target_name = @attributes.as_string target.type
 
-      raise RDoc::Error, "Unhandled special #{special_name}: #{special}"
+      raise RDoc::Error, "Unhandled regexp handling #{target_name}: #{target}"
     end
 
-    special.text
+    target.text
   end
 
   ##