RubyGems - rdoc - Versions diffs - 3.9.5 → 3.10.pre.1 - Mend

rdoc 3.9.5 → 3.10.pre.1

Potentially problematic release.

This version of rdoc might be problematic. Click here for more details.

Files changed (183) hide show

data.tar.gz.sig +0 -0
data/.autotest +6 -3
data/History.txt +63 -13
data/LICENSE.rdoc +57 -0
data/Manifest.txt +60 -6
data/Rakefile +24 -12
data/TODO.rdoc +30 -0
data/bin/rdoc +0 -2
data/lib/rdoc.rb +55 -2
data/lib/rdoc/alias.rb +0 -2
data/lib/rdoc/anon_class.rb +0 -2
data/lib/rdoc/any_method.rb +0 -3
data/lib/rdoc/attr.rb +0 -2
data/lib/rdoc/class_module.rb +40 -7
data/lib/rdoc/code_object.rb +1 -3
data/lib/rdoc/code_objects.rb +3 -21
data/lib/rdoc/comment.rb +225 -0
data/lib/rdoc/constant.rb +0 -2
data/lib/rdoc/context.rb +37 -120
data/lib/rdoc/context/section.rb +114 -0
data/lib/rdoc/cross_reference.rb +16 -7
data/lib/rdoc/encoding.rb +0 -2
data/lib/rdoc/gauntlet.rb +1 -1
data/lib/rdoc/generator.rb +7 -2
data/lib/rdoc/generator/darkfish.rb +126 -20
data/lib/rdoc/generator/json_index.rb +240 -0
data/lib/rdoc/generator/markup.rb +17 -54
data/lib/rdoc/generator/ri.rb +0 -3
data/lib/rdoc/generator/template/darkfish/_footer.rhtml +5 -0
data/lib/rdoc/generator/template/darkfish/_head.rhtml +16 -0
data/lib/rdoc/generator/template/darkfish/_sidebar_VCS_info.rhtml +18 -0
data/lib/rdoc/generator/template/darkfish/_sidebar_classes.rhtml +9 -0
data/lib/rdoc/generator/template/darkfish/_sidebar_in_files.rhtml +8 -0
data/lib/rdoc/generator/template/darkfish/_sidebar_includes.rhtml +16 -0
data/lib/rdoc/generator/template/darkfish/_sidebar_methods.rhtml +12 -0
data/lib/rdoc/generator/template/darkfish/_sidebar_navigation.rhtml +7 -0
data/lib/rdoc/generator/template/darkfish/_sidebar_pages.rhtml +12 -0
data/lib/rdoc/generator/template/darkfish/_sidebar_parent.rhtml +10 -0
data/lib/rdoc/generator/template/darkfish/_sidebar_search.rhtml +10 -0
data/lib/rdoc/generator/template/darkfish/_sidebar_sections.rhtml +10 -0
data/lib/rdoc/generator/template/darkfish/class.rhtml +161 -0
data/lib/rdoc/generator/template/darkfish/fileinfo.rhtml +32 -0
data/lib/rdoc/generator/template/darkfish/images/add.png +0 -0
data/lib/rdoc/generator/template/darkfish/images/delete.png +0 -0
data/lib/rdoc/generator/template/darkfish/images/tag_blue.png +0 -0
data/lib/rdoc/generator/template/darkfish/images/transparent.png +0 -0
data/lib/rdoc/generator/template/darkfish/index.rhtml +16 -61
data/lib/rdoc/generator/template/darkfish/js/darkfish.js +99 -64
data/lib/rdoc/generator/template/darkfish/js/jquery.js +15 -29
data/lib/rdoc/generator/template/darkfish/js/search.js +94 -0
data/lib/rdoc/generator/template/darkfish/page.rhtml +16 -0
data/lib/rdoc/generator/template/darkfish/rdoc.css +126 -286
data/lib/rdoc/generator/template/darkfish/table_of_contents.rhtml +50 -0
data/lib/rdoc/generator/template/json_index/js/navigation.js +142 -0
data/lib/rdoc/generator/template/json_index/js/searcher.js +228 -0
data/lib/rdoc/ghost_method.rb +0 -2
data/lib/rdoc/include.rb +0 -2
data/lib/rdoc/markup.rb +204 -43
data/lib/rdoc/markup/attr_changer.rb +25 -0
data/lib/rdoc/markup/attr_span.rb +29 -0
data/lib/rdoc/markup/attribute.rb +51 -0
data/lib/rdoc/markup/document.rb +22 -1
data/lib/rdoc/markup/formatter.rb +4 -11
data/lib/rdoc/markup/formatter_test_case.rb +1 -2
data/lib/rdoc/markup/heading.rb +44 -0
data/lib/rdoc/markup/include.rb +42 -0
data/lib/rdoc/markup/inline.rb +1 -144
data/lib/rdoc/markup/list.rb +2 -1
data/lib/rdoc/markup/parser.rb +6 -16
data/lib/rdoc/markup/pre_process.rb +64 -10
data/lib/rdoc/markup/raw.rb +1 -1
data/lib/rdoc/markup/special.rb +40 -0
data/lib/rdoc/markup/text_formatter_test_case.rb +0 -2
data/lib/rdoc/markup/to_ansi.rb +0 -2
data/lib/rdoc/markup/to_bs.rb +0 -2
data/lib/rdoc/markup/to_html.rb +102 -34
data/lib/rdoc/markup/to_html_crossref.rb +36 -5
data/lib/rdoc/markup/to_html_snippet.rb +270 -0
data/lib/rdoc/markup/to_label.rb +55 -0
data/lib/rdoc/markup/to_rdoc.rb +0 -3
data/lib/rdoc/markup/to_table_of_contents.rb +62 -0
data/lib/rdoc/markup/to_test.rb +0 -3
data/lib/rdoc/markup/to_tt_only.rb +0 -3
data/lib/rdoc/markup/verbatim.rb +18 -0
data/lib/rdoc/meta_method.rb +0 -2
data/lib/rdoc/method_attr.rb +17 -1
data/lib/rdoc/normal_class.rb +0 -2
data/lib/rdoc/normal_module.rb +0 -2
data/lib/rdoc/options.rb +18 -3
data/lib/rdoc/parser.rb +74 -42
data/lib/rdoc/parser/c.rb +79 -118
data/lib/rdoc/parser/rd.rb +22 -0
data/lib/rdoc/parser/ruby.rb +86 -54
data/lib/rdoc/parser/simple.rb +21 -9
data/lib/rdoc/parser/text.rb +11 -0
data/lib/rdoc/rd.rb +95 -0
data/lib/rdoc/rd/block_parser.ry +638 -0
data/lib/rdoc/rd/inline.rb +71 -0
data/lib/rdoc/rd/inline_parser.ry +575 -0
data/lib/rdoc/rdoc.rb +8 -23
data/lib/rdoc/require.rb +0 -2
data/lib/rdoc/ri.rb +4 -2
data/lib/rdoc/ri/driver.rb +2 -6
data/lib/rdoc/ri/store.rb +0 -1
data/lib/rdoc/ruby_lex.rb +43 -20
data/lib/rdoc/ruby_token.rb +44 -2
data/lib/rdoc/single_class.rb +0 -2
data/lib/rdoc/stats.rb +0 -5
data/lib/rdoc/task.rb +2 -6
data/lib/rdoc/test_case.rb +59 -0
data/lib/rdoc/text.rb +42 -30
data/lib/rdoc/token_stream.rb +45 -0
data/lib/rdoc/tom_doc.rb +232 -0
data/lib/rdoc/top_level.rb +36 -4
data/test/test_attribute_manager.rb +26 -29
data/test/test_rdoc_any_method.rb +2 -26
data/test/test_rdoc_attr.rb +4 -4
data/test/test_rdoc_class_module.rb +95 -12
data/test/test_rdoc_code_object.rb +10 -3
data/test/test_rdoc_comment.rb +504 -0
data/test/test_rdoc_context.rb +60 -11
data/test/test_rdoc_context_section.rb +16 -17
data/test/test_rdoc_cross_reference.rb +17 -2
data/test/test_rdoc_encoding.rb +4 -7
data/test/test_rdoc_generator_darkfish.rb +12 -11
data/test/test_rdoc_generator_json_index.rb +255 -0
data/test/test_rdoc_generator_markup.rb +56 -0
data/test/test_rdoc_generator_ri.rb +8 -11
data/test/test_rdoc_markup.rb +9 -5
data/test/test_rdoc_markup_attribute_manager.rb +5 -8
data/test/test_rdoc_markup_document.rb +34 -6
data/test/test_rdoc_markup_formatter.rb +11 -13
data/test/test_rdoc_markup_heading.rb +20 -0
data/test/test_rdoc_markup_include.rb +19 -0
data/test/test_rdoc_markup_indented_paragraph.rb +4 -5
data/test/test_rdoc_markup_paragraph.rb +2 -5
data/test/test_rdoc_markup_parser.rb +87 -7
data/test/test_rdoc_markup_pre_process.rb +60 -9
data/test/test_rdoc_markup_raw.rb +4 -6
data/test/test_rdoc_markup_to_ansi.rb +1 -4
data/test/test_rdoc_markup_to_bs.rb +1 -4
data/test/test_rdoc_markup_to_html.rb +170 -31
data/test/test_rdoc_markup_to_html_crossref.rb +89 -11
data/test/test_rdoc_markup_to_html_snippet.rb +668 -0
data/test/test_rdoc_markup_to_label.rb +50 -0
data/test/test_rdoc_markup_to_rdoc.rb +1 -4
data/test/test_rdoc_markup_to_table_of_contents.rb +90 -0
data/test/test_rdoc_markup_to_tt_only.rb +1 -4
data/test/test_rdoc_markup_verbatim.rb +16 -0
data/test/test_rdoc_method_attr.rb +16 -1
data/test/test_rdoc_options.rb +17 -7
data/test/test_rdoc_parser.rb +75 -6
data/test/test_rdoc_parser_c.rb +56 -104
data/test/test_rdoc_parser_rd.rb +52 -0
data/test/test_rdoc_parser_ruby.rb +264 -323
data/test/test_rdoc_parser_simple.rb +33 -17
data/test/test_rdoc_rd.rb +30 -0
data/test/test_rdoc_rd_block_parser.rb +527 -0
data/test/test_rdoc_rd_inline.rb +63 -0
data/test/test_rdoc_rd_inline_parser.rb +173 -0
data/test/test_rdoc_rdoc.rb +7 -9
data/test/test_rdoc_ri_driver.rb +10 -15
data/test/test_rdoc_ri_paths.rb +6 -6
data/test/test_rdoc_ri_store.rb +6 -13
data/test/test_rdoc_ruby_lex.rb +53 -5
data/test/test_rdoc_rubygems_hook.rb +2 -1
data/test/test_rdoc_stats.rb +83 -103
data/test/test_rdoc_task.rb +5 -4
data/test/test_rdoc_text.rb +156 -11
data/test/test_rdoc_token_stream.rb +42 -0
data/test/test_rdoc_tom_doc.rb +458 -0
data/test/test_rdoc_top_level.rb +49 -2
data/test/xref_test_case.rb +4 -8
metadata +217 -111
metadata.gz.sig +0 -0
checksums.yaml +0 -7
checksums.yaml.gz.sig +0 -0
data/CVE-2013-0256.rdoc +0 -49
data/LICENSE.txt +0 -57
data/lib/rdoc/generator/template/darkfish/classpage.rhtml +0 -321
data/lib/rdoc/generator/template/darkfish/filepage.rhtml +0 -124
data/lib/rdoc/generator/template/darkfish/js/quicksearch.js +0 -114
data/lib/rdoc/generator/template/darkfish/js/thickbox-compressed.js +0 -10

data/lib/rdoc/generator/template/darkfish/table_of_contents.rhtml ADDED

@@ -0,0 +1,50 @@
+<body class="indexpage">
+<h1><%= h @title %></h1>
+<% simple_files = @files.select { |f| f.text? } %>
+<% unless simple_files.empty? then %>
+<h2>Pages</h2>
+<ul>
+<% simple_files.sort.each do |file| %>
+  <li class="file">
+    <a href="<%= file.path %>"><%= h file.page_name %></a>
+<% table = file.parse(file.comment).table_of_contents # HACK
+   unless table.empty? then %>
+    <img class="toc-toggle" src="images/transparent.png" alt="" title="toggle headings">
+    <ul class="initially-hidden">
+<% table.each do |heading| %>
+      <li><a href="<%= file.path %>#<%= heading.label %>"><%= heading.plain_html %></a>
+<%   end %>
+    </ul>
+<% end %>
+  </li>
+  <% end %>
+</ul>
+<% end %>
+<h2 id="classes">Classes/Modules</h2>
+<ul>
+<% @modsort.each do |klass| %>
+  <li class="<%= klass.type %>">
+    <a href="<%= klass.path %>"><%= klass.full_name %></a>
+<% table = klass.parse(klass.comment).table_of_contents # HACK
+   unless table.empty? then %>
+    <img class="toc-toggle" src="images/transparent.png" alt="" title="toggle headings">
+    <ul class="initially-hidden">
+<% table.each do |heading| %>
+      <li><a href="<%= klass.path %>#<%= heading.label %>"><%= heading.plain_html %></a>
+<%   end %>
+    </ul>
+<% end %>
+  </li>
+  <% end %>
+</ul>
+<h2 id="methods">Methods</h2>
+<ul>
+  <% RDoc::TopLevel.all_classes_and_modules.map do |mod|
+       mod.method_list
+     end.flatten.sort.each do |method| %>
+    <li class="method"><a href="<%= method.path %>"><%= method.pretty_name %> &mdash; <%= method.parent.full_name %></a>
+  <% end %>
+</ul>

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

@@ -0,0 +1,142 @@
+/*
+ * Navigation allows movement using the arrow keys through the search results.
+ *
+ * When using this library you will need to set scrollIntoView to the
+ * appropriate function for your layout.  Use scrollInWindow if the container
+ * is not scrollable and scrollInElement if the container is a separate
+ * scrolling region.
+ */
+Navigation = new function() {
+  this.initNavigation = function() {
+    var _this = this;
+    $(document).keydown(function(e) {
+      _this.onkeydown(e);
+    }).keyup(function(e) {
+      _this.onkeyup(e);
+    });
+    this.navigationActive = true;
+  }
+  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:
+        if (this.moveLeft()) e.preventDefault();
+        break;
+      case 38: //Event.KEY_UP:
+        if (e.keyCode == 38 || e.ctrlKey) {
+          if (this.moveUp()) e.preventDefault();
+          this.startMoveTimeout(false);
+        }
+        break;
+      case 39: //Event.KEY_RIGHT:
+        if (this.moveRight()) e.preventDefault();
+        break;
+      case 40: //Event.KEY_DOWN:
+        if (e.keyCode == 40 || 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);
+        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);
+  }
+  this.moveRight = function() {
+  }
+  this.moveLeft = function() {
+  }
+  this.move = function(isDown) {
+  }
+  this.moveUp = function() {
+    return this.move(false);
+  }
+  this.moveDown = function() {
+    return this.move(true);
+  }
+  /*
+   * Scrolls to the given element in the scrollable element view.
+   */
+  this.scrollInElement = function(element, view) {
+    var offset, viewHeight, viewScroll, height;
+    offset = element.offsetTop;
+    height = element.offsetHeight;
+    viewHeight = view.offsetHeight;
+    viewScroll = view.scrollTop;
+    if (offset - viewScroll + height > viewHeight) {
+      view.scrollTop = offset - viewHeight + height;
+    }
+    if (offset < viewScroll) {
+      view.scrollTop = offset;
+    }
+  }
+  /*
+   * Scrolls to the given element in the window.  The second argument is
+   * ignored
+   */
+  this.scrollInWindow = function(element, ignored) {
+    var offset, viewHeight, viewScroll, height;
+    offset = element.offsetTop;
+    height = element.offsetHeight;
+    viewHeight = window.innerHeight;
+    viewScroll = window.scrollY;
+    if (offset - viewScroll + height > viewHeight) {
+      window.scrollTo(window.scrollX, offset - viewHeight + height);
+    }
+    if (offset < viewScroll) {
+      window.scrollTo(window.scrollX, offset);
+    }
+  }
+}

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

@@ -0,0 +1,228 @@
+Searcher = function(data) {
+  this.data = data;
+  this.handlers = [];
+}
+Searcher.prototype = new function() {
+  // search is performed in chunks of 1000 for non-blocking user input
+  var CHUNK_SIZE = 1000;
+  // do not try to find more than 100 results
+  var MAX_RESULTS = 100;
+  var huid = 1;
+  var suid = 1;
+  var runs = 0;
+  this.find = function(query) {
+    var queries = splitQuery(query);
+    var regexps = buildRegexps(queries);
+    var highlighters = buildHilighters(queries);
+    var state = { from: 0, pass: 0, limit: MAX_RESULTS, n: suid++};
+    var _this = this;
+    this.currentSuid = state.n;
+    if (!query) return;
+    var run = function() {
+      // stop current search thread if new search started
+      if (state.n != _this.currentSuid) return;
+      var results =
+        performSearch(_this.data, regexps, queries, highlighters, state);
+      var hasMore = (state.limit > 0 && state.pass < 4);
+      triggerResults.call(_this, results, !hasMore);
+      if (hasMore) {
+        setTimeout(run, 2);
+      }
+      runs++;
+    };
+    runs = 0;
+    // start search thread
+    run();
+  }
+  /*  ----- Events ------  */
+  this.ready = function(fn) {
+    fn.huid = huid;
+    this.handlers.push(fn);
+  }
+  /*  ----- Utilities ------  */
+  function splitQuery(query) {
+    return jQuery.grep(query.split(/(\s+|::?|\(\)?)/), function(string) {
+      return string.match(/\S/)
+    });
+  }
+  function buildRegexps(queries) {
+    return jQuery.map(queries, 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 '\u0001$' + (i*2+1) + '\u0002$' + (i*2+2);
+      }).join('');
+    });
+  }
+  // function longMatchRegexp(index, longIndex, regexps) {
+  //     for (var i = regexps.length - 1; i >= 0; i--){
+  //         if (!index.match(regexps[i]) && !longIndex.match(regexps[i])) return false;
+  //     };
+  //     return true;
+  // }
+  /*  ----- Mathchers ------  */
+  /*
+   * This record matches if the index starts with queries[0] and the record
+   * matches all of the regexps
+   */
+  function matchPassBeginning(index, longIndex, queries, regexps) {
+    if (index.indexOf(queries[0]) != 0) return false;
+    for (var i=1, l = regexps.length; i < l; i++) {
+      if (!index.match(regexps[i]) && !longIndex.match(regexps[i]))
+        return false;
+    };
+    return true;
+  }
+  /*
+   * This record matches if the longIndex starts with queries[0] and the
+   * longIndex matches all of the regexps
+   */
+  function matchPassLongIndex(index, longIndex, queries, regexps) {
+    if (longIndex.indexOf(queries[0]) != 0) return false;
+    for (var i=1, l = regexps.length; i < l; i++) {
+      if (!longIndex.match(regexps[i]))
+        return false;
+    };
+    return true;
+  }
+  /*
+   * This record matches if the index contains queries[0] and the record
+   * matches all of the regexps
+   */
+  function matchPassContains(index, longIndex, queries, regexps) {
+    if (index.indexOf(queries[0]) == -1) return false;
+    for (var i=1, l = regexps.length; i < l; i++) {
+      if (!index.match(regexps[i]) && !longIndex.match(regexps[i]))
+        return false;
+    };
+    return true;
+  }
+  /*
+   * This record matches if regexps[0] matches the index and the record
+   * matches all of the regexps
+   */
+  function matchPassRegexp(index, longIndex, queries, regexps) {
+    if (!index.match(regexps[0])) return false;
+    for (var i=1, l = regexps.length; i < l; i++) {
+      if (!index.match(regexps[i]) && !longIndex.match(regexps[i]))
+        return false;
+    };
+    return true;
+  }
+  /*  ----- Highlighters ------  */
+  function highlightRegexp(info, queries, regexps, highlighters) {
+    var result = createResult(info);
+    for (var i=0, l = regexps.length; i < l; i++) {
+      result.title = result.title.replace(regexps[i], highlighters[i]);
+      result.namespace = result.namespace.replace(regexps[i], highlighters[i]);
+    };
+    return result;
+  }
+  function hltSubstring(string, pos, length) {
+    return string.substring(0, pos) + '\u0001' + string.substring(pos, pos + length) + '\u0002' + string.substring(pos + length);
+  }
+  function highlightQuery(info, queries, regexps, highlighters) {
+    var result = createResult(info);
+    var pos = 0;
+    var lcTitle = result.title.toLowerCase();
+    pos = lcTitle.indexOf(queries[0]);
+    if (pos != -1) {
+      result.title = hltSubstring(result.title, pos, queries[0].length);
+    }
+    result.namespace = result.namespace.replace(regexps[0], highlighters[0]);
+    for (var i=1, l = regexps.length; i < l; i++) {
+      result.title = result.title.replace(regexps[i], highlighters[i]);
+      result.namespace = result.namespace.replace(regexps[i], highlighters[i]);
+    };
+    return result;
+  }
+  function createResult(info) {
+    var result = {};
+    result.title = info[0];
+    result.namespace = info[1];
+    result.path = info[2];
+    result.params = info[3];
+    result.snippet = info[4];
+    return result;
+  }
+  /*  ----- Searching ------  */
+  function performSearch(data, regexps, queries, highlighters, state) {
+    var searchIndex = data.searchIndex;
+    var longSearchIndex = data.longSearchIndex;
+    var info = data.info;
+    var result = [];
+    var i = state.from;
+    var l = searchIndex.length;
+    var togo = CHUNK_SIZE;
+    var matchFunc, hltFunc;
+    while (state.pass < 4 && state.limit > 0 && togo > 0) {
+      if (state.pass == 0) {
+        matchFunc = matchPassBeginning;
+        hltFunc = highlightQuery;
+      } else if (state.pass == 1) {
+        matchFunc = matchPassLongIndex;
+        hltFunc = highlightQuery;
+      } else if (state.pass == 2) {
+        matchFunc = matchPassContains;
+        hltFunc = highlightQuery;
+      } else if (state.pass == 3) {
+        matchFunc = matchPassRegexp;
+        hltFunc = highlightRegexp;
+      }
+      for (; togo > 0 && i < l && state.limit > 0; i++, togo--) {
+        if (info[i].n == state.n) continue;
+        if (matchFunc(searchIndex[i], longSearchIndex[i], queries, regexps)) {
+          info[i].n = state.n;
+          result.push(hltFunc(info[i], queries, regexps, highlighters));
+          state.limit--;
+        }
+      };
+      if (searchIndex.length <= i) {
+        state.pass++;
+        i = state.from = 0;
+      } else {
+        state.from = i;
+      }
+    }
+    return result;
+  }
+  function triggerResults(results, isLast) {
+    jQuery.each(this.handlers, function(i, fn) {
+      fn.call(this, results, isLast)
+    })
+  }
+}

data/lib/rdoc/ghost_method.rb CHANGED

@@ -1,5 +1,3 @@
-require 'rdoc/any_method'
 ##
 # GhostMethod represents a method referenced only by a comment

data/lib/rdoc/include.rb CHANGED

@@ -1,5 +1,3 @@
-require 'rdoc/code_object'
 ##
 # A Module include in a class with \#include

data/lib/rdoc/markup.rb CHANGED

@@ -1,5 +1,3 @@
-require 'rdoc'
 ##
 # RDoc::Markup parses plain text documents and attempts to decompose them into
 # their constituent parts.  Some of these parts are high-level: paragraphs,
@@ -26,7 +24,7 @@ require 'rdoc'
 # the +convert+ method, so you can use the same RDoc::Markup converter to
 # convert multiple input strings.
 #
-#   require 'rdoc/markup/to_html'
+#   require 'rdoc'
 #
 #   h = RDoc::Markup::ToHtml.new
 #
@@ -39,8 +37,7 @@ require 'rdoc'
 # strike-through text.  We then subclass the HTML output class to deal
 # with these:
 #
-#   require 'rdoc/markup'
-#   require 'rdoc/markup/to_html'
+#   require 'rdoc'
 #
 #   class WikiHtml < RDoc::Markup::ToHtml
 #     def handle_special_WIKIWORD(special)
@@ -96,7 +93,12 @@ require 'rdoc'
 # have been removed. In addition, the verbatim text has been shifted
 # left, so the amount of indentation of verbatim text is unimportant.
 #
-# === Headers and Rules
+# For HTML output RDoc makes a small effort to determine if a verbatim section
+# contains ruby source code.  If so, the verbatim block will be marked up as
+# HTML.  Triggers include "def", "class", "module", "require", the "hash
+# rocket"# (=>) or a block call with a parameter.
+#
+# === Headers
 #
 # A line starting with an equal sign (=) is treated as a
 # heading.  Level one headings have one equals sign, level two headings
@@ -104,7 +106,36 @@ require 'rdoc'
 # (seven hyphens or more result in a level six heading).
 #
 # For example, the above header was obtained with:
-#   == Headers and Rules
+#
+#   === Headers
+#
+# In HTML output headers have an id matching their name.  The above example's
+# HTML is:
+#
+#   <h3 id="label-Headers">Headers</h3>
+#
+# If a heading is inside a method body the id will be prefixed with the
+# method's id.  If the above header where in the documentation for a method
+# such as:
+#
+#   ##
+#   # This method does fun things
+#   #
+#   # = Example
+#   #
+#   #   Example of fun things goes here ...
+#
+#   def do_fun_things
+#   end
+#
+# The header's id would be:
+#
+#   <h1 id="method-i-do_fun_things-label-Example">Example</h3>
+#
+# The label can be linked-to using <tt>SomeClass@Headers</tt>.  See
+# {Links}[RDoc::Markup@Links] for further details.
+#
+# === Rules
 #
 # A line starting with three or more hyphens (at the current indent)
 # generates a horizontal rule.  The more hyphens, the thicker the rule
@@ -240,7 +271,6 @@ require 'rdoc'
 #   verbatim text outside of the list (the list is therefore closed)
 # regular paragraph after the list
 #
-#
 # == Text Markup
 #
 # === Bold, Italic, Typewriter Text
@@ -272,15 +302,26 @@ require 'rdoc'
 # === Links
 #
 # Links to starting with +http:+, +https:+, +mailto:+, +ftp:+ or +www.+
-# are recognized.  An HTTP url that references an external image file is
-# converted into an inline image element.
-#
-# Links starting with <tt>rdoc-ref:</tt> will link to the referenced class,
-# module, method, file, etc.  If the referenced item is not documented the
-# text will be and no link will be generated.
-#
-# Links starting with +link:+ refer to local files whose path is relative to
-# the <tt>--op</tt> directory.
+# are recognized.  An HTTP url that references an external image is converted
+# into an inline image element.
+#
+# Classes and methods will be automatically linked to their definition.  For
+# example, <tt>RDoc::Markup</tt> will link to this documentation.  By default
+# methods will only be automatically linked if they contain an <tt>_</tt> (all
+# methods can be automatically linked through the <tt>--hyperlink-all</tt>
+# command line option).
+#
+# Single-word methods can be linked by using the <tt>#</tt> character for
+# instance methods or <tt>::</tt> for class methods.  For example,
+# <tt>#convert</tt> links to #convert.  A class or method may be combined like
+# <tt>RDoc::Markup#convert</tt>.
+#
+# A heading inside the documentation can be linked by following the class
+# or method by an <tt>@</tt> then the heading name.
+# <tt>RDoc::Markup@Links</tt> will link to this section like this:
+# RDoc::Markup@Links.  Spaces in headings with multiple words must be escaped
+# with <tt>+</tt> like <tt>RDoc::Markup@Escaping+Text+Markup</tt>.
+# Punctuation and other special characters must be escaped like CGI.escape.
 #
 # Links can also be of the form <tt>label[url]</tt>, in which case +label+ is
 # used in the displayed text, and +url+ is used as the target.  If +label+
@@ -293,6 +334,11 @@ require 'rdoc'
 # no link will be generated and <tt>rdoc-ref:</tt> will be removed from the
 # resulting text.
 #
+# Links starting with <tt>rdoc-label:label_name</tt> will link to the
+# +label_name+.  You can create a label for the current link (for
+# bidirectional links) by supplying a name for the current link like
+# <tt>rdoc-label:label-other:label-mine</tt>.
+#
 # Links starting with +link:+ refer to local files whose path is relative to
 # the <tt>--op</tt> directory.  Use <tt>rdoc-ref:</tt> instead of
 # <tt>link:</tt> to link to files generated by RDoc as the link target may
@@ -492,27 +538,54 @@ require 'rdoc'
 #   so you won't see the documentation unless you use the +-a+ command line
 #   option.
 #
-# === Other directives
+# === Method arguments
 #
-# [+:include:+ _filename_]
-#   Include the contents of the named file at this point. This directive
-#   must appear alone on one line, possibly preceded by spaces. In this
-#   position, it can be escaped with a \ in front of the first colon.
+# [+:arg:+ or +:args:+ _parameters_]
+#   Overrides the default argument handling with exactly these parameters.
 #
-#   The file will be searched for in the directories listed by the +--include+
-#   option, or in the current directory by default.  The contents of the file
-#   will be shifted to have the same indentation as the ':' at the start of
-#   the +:include:+ directive.
+#     ##
+#     #  :args: a, b
 #
-# [+:title:+ _text_]
-#   Sets the title for the document.  Equivalent to the <tt>--title</tt>
-#   command line parameter.  (The command line parameter overrides any :title:
-#   directive in the source).
+#     def some_method(*a)
+#     end
 #
-# [+:main:+ _name_]
-#   Equivalent to the <tt>--main</tt> command line parameter.
+# [+:yield:+ or +:yields:+ _parameters_]
+#   Overrides the default yield discovery with these parameters.
+#
+#     ##
+#     # :yields: key, value
+#
+#     def each_thing &block
+#       @things.each(&block)
+#     end
+#
+# [+:call-seq:+]
+#   Lines up to the next blank line or lines with a common prefix in the
+#   comment are treated as the method's calling sequence, overriding the
+#   default parsing of method parameters and yield arguments.
+#
+#   Multiple lines may be used.
+#
+#     # :call-seq:
+#     #   ARGF.readlines(sep=$/)     -> array
+#     #   ARGF.readlines(limit)      -> array
+#     #   ARGF.readlines(sep, limit) -> array
+#     #
+#     #   ARGF.to_a(sep=$/)     -> array
+#     #   ARGF.to_a(limit)      -> array
+#     #   ARGF.to_a(sep, limit) -> array
+#     #
+#     # The remaining lines are documentation ...
+#
+# === Sections
 #
-# [<tt>:category: section</tt>]
+# Sections allow you to group methods in a class into sensible containers.  If
+# you use the sections 'Public', 'Internal' and 'Deprecated' (the three
+# allowed method statuses from TomDoc) the sections will be displayed in that
+# order placing the most useful methods at the top.  Otherwise, sections will
+# be displayed in alphabetical order.
+#
+# [+:category:+ _section_]
 #   Adds this item to the named +section+ overriding the current section.  Use
 #   this to group methods by section in RDoc output while maintaining a
 #   sensible ordering (like alphabetical).
@@ -541,7 +614,7 @@ require 'rdoc'
 #   Use the :section: directive to provide introductory text for a section of
 #   documentation.
 #
-# [<tt>:section: title</tt>]
+# [+:section:+ _title_]
 #   Provides section introductory text in RDoc output.  The title following
 #   +:section:+ is used as the section name and the remainder of the comment
 #   containing the section is used as introductory text.  A section's comment
@@ -573,12 +646,37 @@ require 'rdoc'
 #       # ...
 #     end
 #
-# [+:call-seq:+]
-#   Lines up to the next blank line in the comment are treated as the method's
-#   calling sequence, overriding the default parsing of method parameters and
-#   yield arguments.
+# === Other directives
+#
+# [+:markup:+ _type_]
+#   Overrides the default markup type for this comment with the specified
+#   markup type.  For ruby files, if the first comment contains this directive
+#   it is applied automatically to all comments in the file.
+#
+#   To add additional markup types to RDoc, add the type's name and parsing
+#   class to RDoc::Text::MARKUP_FORMAT.  The parsing class must respond to
+#   \::parse and accept a String argument.
+#
+#   The parsing class must return an RDoc::Document.
+#
+# [+:include:+ _filename_]
+#   Include the contents of the named file at this point. This directive
+#   must appear alone on one line, possibly preceded by spaces. In this
+#   position, it can be escaped with a \ in front of the first colon.
+#
+#   The file will be searched for in the directories listed by the +--include+
+#   option, or in the current directory by default.  The contents of the file
+#   will be shifted to have the same indentation as the ':' at the start of
+#   the +:include:+ directive.
+#
+# [+:title:+ _text_]
+#   Sets the title for the document.  Equivalent to the <tt>--title</tt>
+#   command line parameter.  (The command line parameter overrides any :title:
+#   directive in the source).
+#
+# [+:main:+ _name_]
+#   Equivalent to the <tt>--main</tt> command line parameter.
 #
-# Further directives can be found in RDoc::Parser::Ruby and RDoc::Parser::C.
 #--
 # Original Author:: Dave Thomas,  dave@pragmaticprogrammer.com
 # License:: Ruby license
@@ -590,6 +688,34 @@ class RDoc::Markup
   attr_reader :attribute_manager
+  ##
+  # Parses +str+ into an RDoc::Markup::Document.
+  def self.parse str
+    RDoc::Markup::Parser.parse str
+  rescue RDoc::Markup::Parser::Error => e
+    $stderr.puts <<-EOF
+While parsing markup, RDoc encountered a #{e.class}:
+#{e}
+\tfrom #{e.backtrace.join "\n\tfrom "}
+---8<---
+#{text}
+---8<---
+RDoc #{RDoc::VERSION}
+Ruby #{RUBY_VERSION}-p#{RUBY_PATCHLEVEL} #{RUBY_RELEASE_DATE}
+Please file a bug report with the above information at:
+https://github.com/rdoc/rdoc/issues
+    EOF
+    raise
+  end
   ##
   # Take a block of text and use various heuristics to determine its
   # structure (paragraphs, lists, and so on).  Invoke an event handler as we
@@ -644,9 +770,44 @@ class RDoc::Markup
     document.accept formatter
   end
-end
+  autoload :Parser,                'rdoc/markup/parser'
+  autoload :PreProcess,            'rdoc/markup/pre_process'
-require 'rdoc/markup/parser'
-require 'rdoc/markup/attribute_manager'
-require 'rdoc/markup/inline'
+  # Inline markup classes
+  autoload :AttrChanger,           'rdoc/markup/attr_changer'
+  autoload :AttrSpan,              'rdoc/markup/attr_span'
+  autoload :Attribute,             'rdoc/markup/attribute'
+  autoload :AttributeManager,      'rdoc/markup/attribute_manager'
+  autoload :Special,               'rdoc/markup/special'
+  # RDoc::Markup AST
+  autoload :BlankLine,             'rdoc/markup/blank_line'
+  autoload :Document,              'rdoc/markup/document'
+  autoload :Heading,               'rdoc/markup/heading'
+  autoload :Include,               'rdoc/markup/include'
+  autoload :IndentedParagraph,     'rdoc/markup/indented_paragraph'
+  autoload :List,                  'rdoc/markup/list'
+  autoload :ListItem,              'rdoc/markup/list_item'
+  autoload :Paragraph,             'rdoc/markup/paragraph'
+  autoload :Raw,                   'rdoc/markup/raw'
+  autoload :Rule,                  'rdoc/markup/rule'
+  autoload :Verbatim,              'rdoc/markup/verbatim'
+  # Formatters
+  autoload :Formatter,             'rdoc/markup/formatter'
+  autoload :FormatterTestCase,     'rdoc/markup/formatter_test_case'
+  autoload :TextFormatterTestCase, 'rdoc/markup/text_formatter_test_case'
+  autoload :ToAnsi,                'rdoc/markup/to_ansi'
+  autoload :ToBs,                  'rdoc/markup/to_bs'
+  autoload :ToHtml,                'rdoc/markup/to_html'
+  autoload :ToHtmlCrossref,        'rdoc/markup/to_html_crossref'
+  autoload :ToHtmlSnippet,         'rdoc/markup/to_html_snippet'
+  autoload :ToLabel,               'rdoc/markup/to_label'
+  autoload :ToRdoc,                'rdoc/markup/to_rdoc'
+  autoload :ToTableOfContents,     'rdoc/markup/to_table_of_contents'
+  autoload :ToTest,                'rdoc/markup/to_test'
+  autoload :ToTtOnly,              'rdoc/markup/to_tt_only'
+end