rdoc 4.1.2 → 4.2.0

data/lib/rdoc/generator/template/darkfish/{rdoc.css → css/rdoc.css}

@@ -23,12 +23,22 @@ h3 span,
 h4 span,
 h5 span,
 h6 span {
+  position: relative;
+
   display: none;
   padding-left: 1em;
+  line-height: 0;
+  vertical-align: baseline;
   font-size: 10px;
-  vertical-align: super;
 }
 
+h1 span { top: -1.3em; }
+h2 span { top: -1.2em; }
+h3 span { top: -1.0em; }
+h4 span { top: -0.8em; }
+h5 span { top: -0.5em; }
+h6 span { top: -0.5em; }
+
 h1:hover span,
 h2:hover span,
 h3:hover span,

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

@@ -44,14 +44,6 @@ function hookSourceViews() {
   $('.method-heading').click( showSource );
 };
 
-function toggleDebuggingSection() {
-  $('.debugging-section').slideToggle();
-};
-
-function hookDebuggingToggle() {
-  $('#debugging-toggle img').click( toggleDebuggingSection );
-};
-
 function hookSearch() {
   var input  = $('#search-field').eq(0);
   var result = $('#search-results').eq(0);
@@ -129,12 +121,41 @@ function highlightClickTarget( event ) {
   };
 };
 
+function loadAsync(path, success) {
+  $.ajax({
+    url: rdoc_rel_prefix + path,
+    dataType: 'script',
+    success: success,
+    cache: true
+  });
+};
 
 $(document).ready( function() {
   hookSourceViews();
-  hookDebuggingToggle();
-  hookSearch();
   highlightLocationTarget();
-
   $('ul.link-list a').bind( "click", highlightClickTarget );
+
+  var search_scripts_loaded = {
+    navigation_loaded:   false,
+    search_loaded:       false,
+    search_index_loaded: false,
+    searcher_loaded:     false,
+  }
+
+  var search_success_function = function(variable) {
+    return (function (data, status, xhr) {
+      search_scripts_loaded[variable] = true;
+
+      if (search_scripts_loaded['navigation_loaded']   == true &&
+          search_scripts_loaded['search_loaded']       == true &&
+          search_scripts_loaded['search_index_loaded'] == true &&
+          search_scripts_loaded['searcher_loaded']     == true)
+        hookSearch();
+    });
+  }
+
+  loadAsync('js/navigation.js',   search_success_function('navigation_loaded'));
+  loadAsync('js/search.js',       search_success_function('search_loaded'));
+  loadAsync('js/search_index.js', search_success_function('search_index_loaded'));
+  loadAsync('js/searcher.js',     search_success_function('searcher_loaded'));
 });

data/lib/rdoc/markdown.kpeg

@@ -602,6 +602,10 @@ ListBlockLine = !@BlankLine
 # Parsers for different kinds of block-level HTML content.
 # This is repetitive due to constraints of PEG grammar.
 
+HtmlOpenAnchor = "<" Spnl ("a" | "A") Spnl HtmlAttribute* ">"
+HtmlCloseAnchor = "<" Spnl "/" ("a" | "A") Spnl ">"
+HtmlAnchor = HtmlOpenAnchor (HtmlAnchor | !HtmlCloseAnchor .)* HtmlCloseAnchor
+
 HtmlBlockOpenAddress = "<" Spnl ("address" | "ADDRESS") Spnl HtmlAttribute* ">"
 HtmlBlockCloseAddress = "<" Spnl "/" ("address" | "ADDRESS") Spnl ">"
 HtmlBlockAddress = HtmlBlockOpenAddress (HtmlBlockAddress | !HtmlBlockCloseAddress .)* HtmlBlockCloseAddress
@@ -735,7 +739,8 @@ HtmlBlockCloseScript = "<" Spnl "/" ("script" | "SCRIPT") Spnl ">"
 HtmlBlockScript = HtmlBlockOpenScript (!HtmlBlockCloseScript .)* HtmlBlockCloseScript
 
 
-HtmlBlockInTags = HtmlBlockAddress
+HtmlBlockInTags = HtmlAnchor
+                | HtmlBlockAddress
                 | HtmlBlockBlockquote
                 | HtmlBlockCenter
                 | HtmlBlockDir

data/lib/rdoc/markdown.rb

@@ -2822,6 +2822,172 @@ class RDoc::Markdown
     return _tmp
   end
 
+  # HtmlOpenAnchor = "<" Spnl ("a" | "A") Spnl HtmlAttribute* ">"
+  def _HtmlOpenAnchor
+
+    _save = self.pos
+    while true # sequence
+      _tmp = match_string("<")
+      unless _tmp
+        self.pos = _save
+        break
+      end
+      _tmp = apply(:_Spnl)
+      unless _tmp
+        self.pos = _save
+        break
+      end
+
+      _save1 = self.pos
+      while true # choice
+        _tmp = match_string("a")
+        break if _tmp
+        self.pos = _save1
+        _tmp = match_string("A")
+        break if _tmp
+        self.pos = _save1
+        break
+      end # end choice
+
+      unless _tmp
+        self.pos = _save
+        break
+      end
+      _tmp = apply(:_Spnl)
+      unless _tmp
+        self.pos = _save
+        break
+      end
+      while true
+        _tmp = apply(:_HtmlAttribute)
+        break unless _tmp
+      end
+      _tmp = true
+      unless _tmp
+        self.pos = _save
+        break
+      end
+      _tmp = match_string(">")
+      unless _tmp
+        self.pos = _save
+      end
+      break
+    end # end sequence
+
+    set_failed_rule :_HtmlOpenAnchor unless _tmp
+    return _tmp
+  end
+
+  # HtmlCloseAnchor = "<" Spnl "/" ("a" | "A") Spnl ">"
+  def _HtmlCloseAnchor
+
+    _save = self.pos
+    while true # sequence
+      _tmp = match_string("<")
+      unless _tmp
+        self.pos = _save
+        break
+      end
+      _tmp = apply(:_Spnl)
+      unless _tmp
+        self.pos = _save
+        break
+      end
+      _tmp = match_string("/")
+      unless _tmp
+        self.pos = _save
+        break
+      end
+
+      _save1 = self.pos
+      while true # choice
+        _tmp = match_string("a")
+        break if _tmp
+        self.pos = _save1
+        _tmp = match_string("A")
+        break if _tmp
+        self.pos = _save1
+        break
+      end # end choice
+
+      unless _tmp
+        self.pos = _save
+        break
+      end
+      _tmp = apply(:_Spnl)
+      unless _tmp
+        self.pos = _save
+        break
+      end
+      _tmp = match_string(">")
+      unless _tmp
+        self.pos = _save
+      end
+      break
+    end # end sequence
+
+    set_failed_rule :_HtmlCloseAnchor unless _tmp
+    return _tmp
+  end
+
+  # HtmlAnchor = HtmlOpenAnchor (HtmlAnchor | !HtmlCloseAnchor .)* HtmlCloseAnchor
+  def _HtmlAnchor
+
+    _save = self.pos
+    while true # sequence
+      _tmp = apply(:_HtmlOpenAnchor)
+      unless _tmp
+        self.pos = _save
+        break
+      end
+      while true
+
+        _save2 = self.pos
+        while true # choice
+          _tmp = apply(:_HtmlAnchor)
+          break if _tmp
+          self.pos = _save2
+
+          _save3 = self.pos
+          while true # sequence
+            _save4 = self.pos
+            _tmp = apply(:_HtmlCloseAnchor)
+            _tmp = _tmp ? nil : true
+            self.pos = _save4
+            unless _tmp
+              self.pos = _save3
+              break
+            end
+            _tmp = get_byte
+            unless _tmp
+              self.pos = _save3
+            end
+            break
+          end # end sequence
+
+          break if _tmp
+          self.pos = _save2
+          break
+        end # end choice
+
+        break unless _tmp
+      end
+      _tmp = true
+      unless _tmp
+        self.pos = _save
+        break
+      end
+      _tmp = apply(:_HtmlCloseAnchor)
+      unless _tmp
+        self.pos = _save
+      end
+      break
+    end # end sequence
+
+    set_failed_rule :_HtmlAnchor unless _tmp
+    return _tmp
+  end
+
   # HtmlBlockOpenAddress = "<" Spnl ("address" | "ADDRESS") Spnl HtmlAttribute* ">"
   def _HtmlBlockOpenAddress
 
@@ -8289,11 +8455,14 @@ class RDoc::Markdown
     return _tmp
   end
 
-  # HtmlBlockInTags = (HtmlBlockAddress | HtmlBlockBlockquote | HtmlBlockCenter | HtmlBlockDir | HtmlBlockDiv | HtmlBlockDl | HtmlBlockFieldset | HtmlBlockForm | HtmlBlockH1 | HtmlBlockH2 | HtmlBlockH3 | HtmlBlockH4 | HtmlBlockH5 | HtmlBlockH6 | HtmlBlockMenu | HtmlBlockNoframes | HtmlBlockNoscript | HtmlBlockOl | HtmlBlockP | HtmlBlockPre | HtmlBlockTable | HtmlBlockUl | HtmlBlockDd | HtmlBlockDt | HtmlBlockFrameset | HtmlBlockLi | HtmlBlockTbody | HtmlBlockTd | HtmlBlockTfoot | HtmlBlockTh | HtmlBlockThead | HtmlBlockTr | HtmlBlockScript)
+  # HtmlBlockInTags = (HtmlAnchor | HtmlBlockAddress | HtmlBlockBlockquote | HtmlBlockCenter | HtmlBlockDir | HtmlBlockDiv | HtmlBlockDl | HtmlBlockFieldset | HtmlBlockForm | HtmlBlockH1 | HtmlBlockH2 | HtmlBlockH3 | HtmlBlockH4 | HtmlBlockH5 | HtmlBlockH6 | HtmlBlockMenu | HtmlBlockNoframes | HtmlBlockNoscript | HtmlBlockOl | HtmlBlockP | HtmlBlockPre | HtmlBlockTable | HtmlBlockUl | HtmlBlockDd | HtmlBlockDt | HtmlBlockFrameset | HtmlBlockLi | HtmlBlockTbody | HtmlBlockTd | HtmlBlockTfoot | HtmlBlockTh | HtmlBlockThead | HtmlBlockTr | HtmlBlockScript)
   def _HtmlBlockInTags
 
     _save = self.pos
     while true # choice
+      _tmp = apply(:_HtmlAnchor)
+      break if _tmp
+      self.pos = _save
       _tmp = apply(:_HtmlBlockAddress)
       break if _tmp
       self.pos = _save
@@ -15748,6 +15917,9 @@ class RDoc::Markdown
   Rules[:_Enumerator] = rule_info("Enumerator", "@NonindentSpace [0-9]+ \".\" @Spacechar+")
   Rules[:_OrderedList] = rule_info("OrderedList", "&Enumerator (ListTight | ListLoose):a { RDoc::Markup::List.new(:NUMBER, *a) }")
   Rules[:_ListBlockLine] = rule_info("ListBlockLine", "!@BlankLine !(Indent? (Bullet | Enumerator)) !HorizontalRule OptionallyIndentedLine")
+  Rules[:_HtmlOpenAnchor] = rule_info("HtmlOpenAnchor", "\"<\" Spnl (\"a\" | \"A\") Spnl HtmlAttribute* \">\"")
+  Rules[:_HtmlCloseAnchor] = rule_info("HtmlCloseAnchor", "\"<\" Spnl \"/\" (\"a\" | \"A\") Spnl \">\"")
+  Rules[:_HtmlAnchor] = rule_info("HtmlAnchor", "HtmlOpenAnchor (HtmlAnchor | !HtmlCloseAnchor .)* HtmlCloseAnchor")
   Rules[:_HtmlBlockOpenAddress] = rule_info("HtmlBlockOpenAddress", "\"<\" Spnl (\"address\" | \"ADDRESS\") Spnl HtmlAttribute* \">\"")
   Rules[:_HtmlBlockCloseAddress] = rule_info("HtmlBlockCloseAddress", "\"<\" Spnl \"/\" (\"address\" | \"ADDRESS\") Spnl \">\"")
   Rules[:_HtmlBlockAddress] = rule_info("HtmlBlockAddress", "HtmlBlockOpenAddress (HtmlBlockAddress | !HtmlBlockCloseAddress .)* HtmlBlockCloseAddress")
@@ -15847,7 +16019,7 @@ class RDoc::Markdown
   Rules[:_HtmlBlockOpenScript] = rule_info("HtmlBlockOpenScript", "\"<\" Spnl (\"script\" | \"SCRIPT\") Spnl HtmlAttribute* \">\"")
   Rules[:_HtmlBlockCloseScript] = rule_info("HtmlBlockCloseScript", "\"<\" Spnl \"/\" (\"script\" | \"SCRIPT\") Spnl \">\"")
   Rules[:_HtmlBlockScript] = rule_info("HtmlBlockScript", "HtmlBlockOpenScript (!HtmlBlockCloseScript .)* HtmlBlockCloseScript")
-  Rules[:_HtmlBlockInTags] = rule_info("HtmlBlockInTags", "(HtmlBlockAddress | HtmlBlockBlockquote | HtmlBlockCenter | HtmlBlockDir | HtmlBlockDiv | HtmlBlockDl | HtmlBlockFieldset | HtmlBlockForm | HtmlBlockH1 | HtmlBlockH2 | HtmlBlockH3 | HtmlBlockH4 | HtmlBlockH5 | HtmlBlockH6 | HtmlBlockMenu | HtmlBlockNoframes | HtmlBlockNoscript | HtmlBlockOl | HtmlBlockP | HtmlBlockPre | HtmlBlockTable | HtmlBlockUl | HtmlBlockDd | HtmlBlockDt | HtmlBlockFrameset | HtmlBlockLi | HtmlBlockTbody | HtmlBlockTd | HtmlBlockTfoot | HtmlBlockTh | HtmlBlockThead | HtmlBlockTr | HtmlBlockScript)")
+  Rules[:_HtmlBlockInTags] = rule_info("HtmlBlockInTags", "(HtmlAnchor | HtmlBlockAddress | HtmlBlockBlockquote | HtmlBlockCenter | HtmlBlockDir | HtmlBlockDiv | HtmlBlockDl | HtmlBlockFieldset | HtmlBlockForm | HtmlBlockH1 | HtmlBlockH2 | HtmlBlockH3 | HtmlBlockH4 | HtmlBlockH5 | HtmlBlockH6 | HtmlBlockMenu | HtmlBlockNoframes | HtmlBlockNoscript | HtmlBlockOl | HtmlBlockP | HtmlBlockPre | HtmlBlockTable | HtmlBlockUl | HtmlBlockDd | HtmlBlockDt | HtmlBlockFrameset | HtmlBlockLi | HtmlBlockTbody | HtmlBlockTd | HtmlBlockTfoot | HtmlBlockTh | HtmlBlockThead | HtmlBlockTr | HtmlBlockScript)")
   Rules[:_HtmlBlock] = rule_info("HtmlBlock", "< (HtmlBlockInTags | HtmlComment | HtmlBlockSelfClosing | HtmlUnclosed) > @BlankLine+ { if html? then                 RDoc::Markup::Raw.new text               end }")
   Rules[:_HtmlUnclosed] = rule_info("HtmlUnclosed", "\"<\" Spnl HtmlUnclosedType Spnl HtmlAttribute* Spnl \">\"")
   Rules[:_HtmlUnclosedType] = rule_info("HtmlUnclosedType", "(\"HR\" | \"hr\")")

data/lib/rdoc/markup.rb

@@ -84,7 +84,7 @@
 #
 #   markup.add_special(/\b([A-Z][a-z]+[A-Z]\w+)/, :WIKIWORD)
 #
-#   wh = WikiHtml.new markup
+#   wh = WikiHtml.new RDoc::Options.new, markup
 #   wh.add_tag(:STRIKE, "<strike>", "</strike>")
 #
 #   puts "<body>#{wh.convert ARGF.read}</body>"
@@ -163,7 +163,7 @@
 #
 # The header's id would be:
 #
-#   <h1 id="method-i-do_fun_things-label-Example">Example</h3>
+#   <h1 id="method-i-do_fun_things-label-Example">Example</h1>
 #
 # The label can be linked-to using <tt>SomeClass@Headers</tt>.  See
 # {Links}[RDoc::Markup@Links] for further details.

data/lib/rdoc/markup/attribute_manager.rb

@@ -130,7 +130,7 @@ class RDoc::Markup::AttributeManager
     # first do matching ones
     tags = @matching_word_pairs.keys.join("")
 
-    re = /(^|\W)([#{tags}])([#:\\]?[\w.\/-]+?\S?)\2(\W|$)/
+    re = /(^|\W)([#{tags}])([#\\]?[\w:.\/-]+?\S?)\2(\W|$)/
 
     1 while str.gsub!(re) do
       attr = @matching_word_pairs[$2]

data/lib/rdoc/markup/to_html.rb

@@ -286,7 +286,7 @@ class RDoc::Markup::ToHtml < RDoc::Markup::Formatter
     @res << to_html(heading.text)
     unless @options.pipe then
       @res << "<span><a href=\"##{label}\">&para;</a>"
-      @res << " <a href=\"#documentation\">&uarr;</a></span>"
+      @res << " <a href=\"#top\">&uarr;</a></span>"
     end
     @res << "</h#{level}>\n"
   end
@@ -379,11 +379,12 @@ class RDoc::Markup::ToHtml < RDoc::Markup::Formatter
   end
 
   ##
-  # Returns true if Ripper is available it can create a sexp from +text+
+  # Returns true if text is valid ruby syntax
 
   def parseable? text
-    text =~ /\b(def|class|module|require) |=>|\{\s?\||do \|/ and
-      text !~ /<%|%>/
+    eval("BEGIN {return true}\n#{text}")
+  rescue SyntaxError
+    false
   end
 
   ##

data/lib/rdoc/markup/to_label.rb

@@ -31,7 +31,7 @@ class RDoc::Markup::ToLabel < RDoc::Markup::Formatter
   def convert text
     label = convert_flow @am.flow text
 
-    CGI.escape label
+    CGI.escape(label).gsub('%', '-').sub(/^-/, '')
   end
 
   ##

data/lib/rdoc/method_attr.rb

@@ -110,12 +110,15 @@ class RDoc::MethodAttr < RDoc::CodeObject
   # Order by #singleton then #name
 
   def <=>(other)
+    return unless other.respond_to?(:singleton) &&
+                  other.respond_to?(:name)
+
     [     @singleton ? 0 : 1,       name] <=>
     [other.singleton ? 0 : 1, other.name]
   end
 
   def == other # :nodoc:
-    super or self.class == other.class and full_name == other.full_name
+    equal?(other) or self.class == other.class and full_name == other.full_name
   end
 
   ##
@@ -181,8 +184,8 @@ class RDoc::MethodAttr < RDoc::CodeObject
       parent != kernel && !searched.include?(kernel)
 
     searched.each do |ancestor|
-      next if parent == ancestor
       next if String === ancestor
+      next if parent == ancestor
 
       other = ancestor.find_method_named('#' << name) ||
               ancestor.find_attribute_named(name)
@@ -358,7 +361,12 @@ class RDoc::MethodAttr < RDoc::CodeObject
   end
 
   def pretty_print q # :nodoc:
-    alias_for = @is_alias_for ? "alias for #{@is_alias_for.name}" : nil
+    alias_for =
+      if @is_alias_for.respond_to? :name then
+        "alias for #{@is_alias_for.name}"
+      elsif Array === @is_alias_for then
+        "alias for #{@is_alias_for.last}"
+      end
 
     q.group 2, "[#{self.class.name} #{full_name} #{visibility}", "]" do
       if alias_for then

data/lib/rdoc/options.rb

@@ -213,6 +213,16 @@ class RDoc::Options
 
   attr_accessor :line_numbers
 
+  ##
+  # The output locale.
+
+  attr_accessor :locale
+
+  ##
+  # The directory where locale data live.
+
+  attr_accessor :locale_dir
+
   ##
   # Name of the file, class or module to display in the initial index page (if
   # not specified the first file we encounter is used)
@@ -325,7 +335,7 @@ class RDoc::Options
   # other visibilities may be overridden on a per-method basis with the :doc:
   # directive.
 
-  attr_accessor :visibility
+  attr_reader :visibility
 
   def initialize # :nodoc:
     init_ivars
@@ -343,6 +353,9 @@ class RDoc::Options
     @generators = RDoc::RDoc::GENERATORS
     @hyperlink_all = false
     @line_numbers = false
+    @locale = nil
+    @locale_name = nil
+    @locale_dir = 'locale'
     @main_page = nil
     @markup = 'rdoc'
     @coverage_report = false
@@ -388,6 +401,8 @@ class RDoc::Options
     @generator_name = map['generator_name']
     @hyperlink_all  = map['hyperlink_all']
     @line_numbers   = map['line_numbers']
+    @locale_name    = map['locale_name']
+    @locale_dir     = map['locale_dir']
     @main_page      = map['main_page']
     @markup         = map['markup']
     @op_dir         = map['op_dir']
@@ -412,6 +427,8 @@ class RDoc::Options
       @generator_name == other.generator_name and
       @hyperlink_all  == other.hyperlink_all  and
       @line_numbers   == other.line_numbers   and
+      @locale         == other.locale         and
+      @locale_dir     == other.locale_dir and
       @main_page      == other.main_page      and
       @markup         == other.markup         and
       @op_dir         == other.op_dir         and
@@ -515,6 +532,13 @@ class RDoc::Options
       @template_dir = template_dir_for @template
     end
 
+    if @locale_name
+      @locale = RDoc::I18n::Locale[@locale_name]
+      @locale.load(@locale_dir)
+    else
+      @locale = nil
+    end
+
     self
   end
 
@@ -677,6 +701,19 @@ Usage: #{opt.program_name} [options] [names...]
         opt.separator nil
       end
 
+
+      opt.on("--locale=NAME",
+             "Specifies the output locale.") do |value|
+        @locale_name = value
+      end
+
+      opt.on("--locale-data-dir=DIR",
+             "Specifies the directory where locale data live.") do |value|
+        @locale_dir = value
+      end
+
+      opt.separator nil
+
       opt.on("--all", "-a",
              "Synonym for --visibility=private.") do |value|
         @visibility = :private
@@ -1016,8 +1053,7 @@ Usage: #{opt.program_name} [options] [names...]
 
       opt.separator nil
 
-      opt.on("--help",
-             "Display this help") do
+      opt.on("--help", "-h", "Display this help") do
         RDoc::RDoc::GENERATORS.each_key do |generator|
           setup_generator generator
         end
@@ -1174,6 +1210,22 @@ Usage: #{opt.program_name} [options] [names...]
     end
   end
 
+  # Sets the minimum visibility of a documented method.
+  #
+  # Accepts +:public+, +:protected+, +:private+, +:nodoc+, or +:all+.
+  #
+  # When +:all+ is passed, visibility is set to +:private+, similarly to
+  # RDOCOPT="--all", see #visibility for more information.
+
+  def visibility= visibility
+    case visibility
+    when :all
+      @visibility = :private
+    else
+      @visibility = visibility
+    end
+  end
+
   ##
   # Displays a warning using Kernel#warn if we're being verbose