rdoc 3.9.5 → 3.10.pre.1

checksums.yaml

@@ -1,7 +0,0 @@
----
-SHA1:
-  metadata.gz: 9d9a58840506bd6b738237a6af63e481cb99d722
-  data.tar.gz: dd7c3e432a825b7d424a72c6d809fc846b4ca15d
-SHA512:
-  metadata.gz: 4aed26561794caea63847544ac7af1664170b460e6c1f0124f31396aa1a0e4f1f7feb59101342fe00160a0f4c823d64aaa5b5744c350b597d5bdf7ae39f23c9d
-  data.tar.gz: d7b563efe923aedecb2cfcd7d6c256cf70dc12791104e348be074ea68e9b951d9fef08bd32e8f36c9594124a94a7a629317d32c5a551d4311a69e4398ed177c7

data/CVE-2013-0256.rdoc

@@ -1,49 +0,0 @@
-= RDoc 2.3.0 through 3.12 XSS Exploit
-
-RDoc documentation generated by rdoc 2.3.0 through rdoc 3.12 and prereleases up
-to rdoc 4.0.0.preview2.1 are vulnerable to an XSS exploit.  This exploit may
-lead to cookie disclosure to third parties.
-
-The exploit exists in darkfish.js which is copied from the RDoc install
-location to the generated documentation.
-
-RDoc is a static documentation generation tool.  Patching the library itself
-is insufficient to correct this exploit.  Those hosting rdoc documentation will
-need to apply the following patch.  If applied while ignoring whitespace, this
-patch will correct all affected versions:
-
-  diff --git darkfish.js darkfish.js
-  index 4be722f..f26fd45 100644
-  --- darkfish.js
-  +++ darkfish.js
-  @@ -109,13 +109,15 @@ function hookSearch() {
-   function highlightTarget( anchor ) {
-     console.debug( "Highlighting target '%s'.", anchor );
-   
-  -  $("a[name=" + anchor + "]").each( function() {
-  -    if ( !$(this).parent().parent().hasClass('target-section') ) {
-  -      console.debug( "Wrapping the target-section" );
-  -      $('div.method-detail').unwrap( 'div.target-section' );
-  -      $(this).parent().wrap( '<div class="target-section"></div>' );
-  -    } else {
-  -      console.debug( "Already wrapped." );
-  +  $("a[name]").each( function() {
-  +    if ( $(this).attr("name") == anchor ) {
-  +      if ( !$(this).parent().parent().hasClass('target-section') ) {
-  +        console.debug( "Wrapping the target-section" );
-  +        $('div.method-detail').unwrap( 'div.target-section' );
-  +        $(this).parent().wrap( '<div class="target-section"></div>' );
-  +      } else {
-  +        console.debug( "Already wrapped." );
-  +      }
-       }
-     });
-   };
-
-RDoc 3.9.5, 3.12.1 and RDoc 4.0.0.rc.2 and newer are not vulnerable to this
-exploit.
-
-This exploit was discovered by Evgeny Ermakov <corwmh@gmail.com>.
-
-This vulnerability has been assigned the CVE identifier CVE-2013-0256.
-

data/LICENSE.txt

@@ -1,57 +0,0 @@
-RDoc is copyrighted free software.
-
-You can redistribute it and/or modify it under either the terms of the GPL
-version 2 (see the file GPL), or the conditions below:
-
-  1. You may make and give away verbatim copies of the source form of the
-     software without restriction, provided that you duplicate all of the
-     original copyright notices and associated disclaimers.
-
-  2. You may modify your copy of the software in any way, provided that
-     you do at least ONE of the following:
-
-       a) place your modifications in the Public Domain or otherwise
-          make them Freely Available, such as by posting said
-          modifications to Usenet or an equivalent medium, or by allowing
-          the author to include your modifications in the software.
-
-       b) use the modified software only within your corporation or
-          organization.
-
-       c) give non-standard binaries non-standard names, with
-          instructions on where to get the original software distribution.
-
-       d) make other distribution arrangements with the author.
-
-  3. You may distribute the software in object code or binary form,
-     provided that you do at least ONE of the following:
-
-       a) distribute the binaries and library files of the software,
-          together with instructions (in the manual page or equivalent)
-          on where to get the original distribution.
-
-       b) accompany the distribution with the machine-readable source of
-          the software.
-
-       c) give non-standard binaries non-standard names, with
-          instructions on where to get the original software distribution.
-
-       d) make other distribution arrangements with the author.
-
-  4. You may modify and include the part of the software into any other
-     software (possibly commercial).  But some files in the distribution
-     are not written by the author, so that they are not under these terms.
-
-     For the list of those files and their copying conditions, see the
-     file LEGAL.
-
-  5. The scripts and library files supplied as input to or produced as
-     output from the software do not automatically fall under the
-     copyright of the software, but belong to whomever generated them,
-     and may be sold commercially, and may be aggregated with this
-     software.
-
-  6. THIS SOFTWARE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR
-     IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
-     WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
-     PURPOSE.

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

@@ -1,321 +0,0 @@
-<?xml version="1.0" encoding="<%= @options.charset %>"?>
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
-  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-<head>
-  <meta content="text/html; charset=<%= @options.charset %>" http-equiv="Content-Type" />
-
-  <title><%= klass.type.capitalize %>: <%= klass.full_name %></title>
-
-  <link rel="stylesheet" href="<%= rel_prefix %>/rdoc.css" type="text/css" media="screen" />
-
-  <script src="<%= rel_prefix %>/js/jquery.js" type="text/javascript" charset="utf-8"></script>
-  <script src="<%= rel_prefix %>/js/thickbox-compressed.js" type="text/javascript" charset="utf-8"></script>
-  <script src="<%= rel_prefix %>/js/quicksearch.js" type="text/javascript" charset="utf-8"></script>
-  <script src="<%= rel_prefix %>/js/darkfish.js" type="text/javascript" charset="utf-8"></script>
-
-</head>
-<body id="top" class="<%= klass.type %>">
-
-  <div id="metadata">
-    <div id="home-metadata">
-      <div id="home-section" class="section">
-        <h3 class="section-header">
-          <a href="<%= rel_prefix %>/index.html">Home</a>
-          <a href="<%= rel_prefix %>/index.html#classes">Classes</a>
-          <a href="<%= rel_prefix %>/index.html#methods">Methods</a>
-        </h3>
-      </div>
-    </div>
-
-    <div id="file-metadata">
-      <div id="file-list-section" class="section">
-        <h3 class="section-header">In Files</h3>
-        <div class="section-body">
-          <ul>
-          <% klass.in_files.each do |tl| %>
-            <li><a href="<%= rel_prefix %>/<%= h tl.path %>?TB_iframe=true&amp;height=550&amp;width=785"
-              class="thickbox" title="<%= h tl.absolute_name %>"><%= h tl.absolute_name %></a></li>
-          <% end %>
-          </ul>
-        </div>
-      </div>
-
-      <% if !svninfo.empty? then %>
-      <div id="file-svninfo-section" class="section">
-        <h3 class="section-header">Subversion Info</h3>
-        <div class="section-body">
-          <dl class="svninfo">
-            <dt>Rev</dt>
-            <dd><%= svninfo[:rev] %></dd>
-
-            <dt>Last Checked In</dt>
-            <dd><%= svninfo[:commitdate].strftime('%Y-%m-%d %H:%M:%S') %>
-              (<%= svninfo[:commitdelta] %> ago)</dd>
-
-            <dt>Checked in by</dt>
-            <dd><%= svninfo[:committer] %></dd>
-          </dl>
-        </div>
-      </div>
-      <% end %>
-    </div>
-
-    <div id="class-metadata">
-      <% if klass.type == 'class' then %>
-      <!-- Parent Class -->
-      <div id="parent-class-section" class="section">
-        <h3 class="section-header">Parent</h3>
-        <% if klass.superclass and not String === klass.superclass then %>
-        <p class="link"><a href="<%= klass.aref_to klass.superclass.path %>"><%= klass.superclass.full_name %></a></p>
-        <% else %>
-        <p class="link"><%= klass.superclass %></p>
-        <% end %>
-      </div>
-      <% end %>
-
-      <% unless klass.sections.length == 1 then %>
-      <!-- Sections -->
-      <div id="sections-section" class="section">
-        <h3 class="section-header">Sections</h3>
-        <ul class="link-list">
-          <% klass.sections.sort_by { |s| s.title.to_s }.each do |section| %>
-            <li><a href="#<%= section.aref %>"><%= h section.title %></a></li>
-          <% end %>
-        </ul>
-      </div>
-      <% end %>
-
-      <% unless klass.classes_and_modules.empty? then %>
-      <!-- Namespace Contents -->
-      <div id="namespace-list-section" class="section">
-        <h3 class="section-header">Namespace</h3>
-        <ul class="link-list">
-          <% (klass.modules.sort + klass.classes.sort).each do |mod| %>
-          <li><span class="type"><%= mod.type.upcase %></span> <a href="<%= klass.aref_to mod.path %>"><%= mod.full_name %></a></li>
-          <% end %>
-        </ul>
-      </div>
-      <% end %>
-
-      <% unless klass.method_list.empty? then %>
-      <!-- Method Quickref -->
-      <div id="method-list-section" class="section">
-        <h3 class="section-header">Methods</h3>
-        <ul class="link-list">
-          <% klass.each_method do |meth| %>
-          <li><a href="#<%= meth.aref %>"><%= meth.singleton ? '::' : '#' %><%= meth.name %></a></li>
-          <% end %>
-        </ul>
-      </div>
-      <% end %>
-
-      <% unless klass.includes.empty? then %>
-      <!-- Included Modules -->
-      <div id="includes-section" class="section">
-        <h3 class="section-header">Included Modules</h3>
-        <ul class="link-list">
-        <% klass.each_include do |inc| %>
-        <% unless String === inc.module then %>
-          <li><a class="include" href="<%= klass.aref_to inc.module.path %>"><%= inc.module.full_name %></a></li>
-        <% else %>
-          <li><span class="include"><%= inc.name %></span></li>
-        <% end %>
-        <% end %>
-        </ul>
-      </div>
-      <% end %>
-    </div>
-
-    <div id="project-metadata">
-      <% simple_files = @files.select {|tl| tl.parser == RDoc::Parser::Simple } %>
-      <% unless simple_files.empty? then %>
-      <div id="fileindex-section" class="section project-section">
-        <h3 class="section-header">Files</h3>
-        <ul>
-        <% simple_files.each do |file| %>
-          <li class="file"><a href="<%= rel_prefix %>/<%= file.path %>"><%= h file.base_name %></a></li>
-        <% end %>
-        </ul>
-      </div>
-      <% end %>
-
-      <div id="classindex-section" class="section project-section">
-        <h3 class="section-header">Class/Module Index
-          <span class="search-toggle"><img src="<%= rel_prefix %>/images/find.png"
-            height="16" width="16" alt="[+]"
-            title="show/hide quicksearch" /></span></h3>
-        <form action="#" method="get" accept-charset="utf-8" class="initially-hidden">
-        <fieldset>
-          <legend>Quicksearch</legend>
-          <input type="text" name="quicksearch" value=""
-            class="quicksearch-field" />
-        </fieldset>
-        </form>
-
-        <ul class="link-list">
-        <% @modsort.each do |index_klass| %>
-          <li><a href="<%= rel_prefix %>/<%= index_klass.path %>"><%= index_klass.full_name %></a></li>
-        <% end %>
-        </ul>
-        <div id="no-class-search-results" style="display: none;">No matching classes.</div>
-      </div>
-
-      <% if $DEBUG_RDOC then %>
-      <div id="debugging-toggle"><img src="<%= rel_prefix %>/images/bug.png"
-        alt="toggle debugging" height="16" width="16" /></div>
-      <% end %>
-    </div>
-  </div>
-
-  <div id="documentation">
-    <h1 class="<%= klass.type %>"><%= klass.full_name %></h1>
-
-    <div id="description" class="description">
-      <%= klass.description %>
-    </div><!-- description -->
-
-    <% klass.each_section do |section, constants, attributes| %>
-    <% constants = constants.select { |const| const.display? } %>
-    <% attributes = attributes.select { |attr| attr.display? } %>
-    <div id="<%= section.aref %>" class="documentation-section">
-      <% if section.title then %>
-      <h2 class="section-header">
-        <%= section.title %>
-        <a href="#top">&uarr; top</a>
-      </h2>
-      <% end %>
-
-      <% if section.comment then %>
-      <div class="description">
-        <%= section.description %>
-      </div>
-      <% end %>
-
-      <% unless constants.empty? then %>
-      <!-- Constants -->
-      <div id="constants-list" class="section">
-        <h3 class="section-header">Constants</h3>
-        <dl>
-        <% constants.each do |const| %>
-          <dt><a name="<%= const.name %>"><%= const.name %></a></dt>
-          <% if const.comment then %>
-          <dd class="description"><%= const.description.strip %></dd>
-          <% else %>
-          <dd class="description missing-docs">(Not documented)</dd>
-          <% end %>
-        <% end %>
-        </dl>
-      </div>
-      <% end %>
-
-      <% unless attributes.empty? then %>
-      <!-- Attributes -->
-      <div id="attribute-method-details" class="method-section section">
-        <h3 class="section-header">Attributes</h3>
-
-        <% attributes.each do |attrib| %>
-        <div id="<%= attrib.html_name %>-attribute-method" class="method-detail">
-          <a name="<%= h attrib.name %>"></a>
-          <% if attrib.rw =~ /w/i then %>
-          <a name="<%= h attrib.name %>="></a>
-          <% end %>
-          <div class="method-heading attribute-method-heading">
-            <span class="method-name"><%= h attrib.name %></span><span
-              class="attribute-access-type">[<%= attrib.rw %>]</span>
-          </div>
-
-          <div class="method-description">
-          <% if attrib.comment then %>
-          <%= attrib.description.strip %>
-          <% else %>
-          <p class="missing-docs">(Not documented)</p>
-          <% end %>
-          </div>
-        </div>
-        <% end %>
-      </div><!-- attribute-method-details -->
-      <% end %>
-
-      <!-- Methods -->
-      <% klass.methods_by_type(section).each do |type, visibilities|
-         next if visibilities.empty?
-         visibilities.each do |visibility, methods|
-           next if methods.empty? %>
-      <div id="<%= visibility %>-<%= type %>-method-details" class="method-section section">
-        <h3 class="section-header"><%= visibility.to_s.capitalize %> <%= type.capitalize %> Methods</h3>
-
-      <% methods.each do |method| %>
-        <div id="<%= method.html_name %>-method" class="method-detail <%= method.is_alias_for ? "method-alias" : '' %>">
-          <a name="<%= h method.aref %>"></a>
-
-          <% if method.call_seq then %>
-          <% method.call_seq.strip.split("\n").each_with_index do |call_seq, i| %>
-          <div class="method-heading">
-            <span class="method-callseq"><%= call_seq.strip.gsub(/->/, '&rarr;').gsub( /^\w+\./m, '') %></span>
-            <% if i == 0 then %>
-            <span class="method-click-advice">click to toggle source</span>
-            <% end %>
-          </div>
-          <% end %>
-          <% else %>
-          <div class="method-heading">
-            <span class="method-name"><%= h method.name %></span><span
-              class="method-args"><%= method.params %></span>
-            <span class="method-click-advice">click to toggle source</span>
-          </div>
-          <% end %>
-
-          <div class="method-description">
-            <% if method.comment then %>
-            <%= method.description.strip %>
-            <% else %>
-            <p class="missing-docs">(Not documented)</p>
-            <% end %>
-
-            <% if method.token_stream then %>
-            <div class="method-source-code" id="<%= method.html_name %>-source">
-<pre>
-<%= method.markup_code %>
-</pre>
-            </div><!-- <%= method.html_name %>-source -->
-            <% end %>
-          </div>
-
-          <% unless method.aliases.empty? then %>
-          <div class="aliases">
-            Also aliased as: <%= method.aliases.map do |aka|
-              if aka.parent then # HACK lib/rexml/encodings
-                %{<a href="#{klass.aref_to aka.path}">#{h aka.name}</a>}
-              else
-                h aka.name
-              end
-            end.join ", " %>
-          </div>
-          <% end %>
-
-          <% if method.is_alias_for then %>
-          <div class="aliases">
-            Alias for: <a href="<%= klass.aref_to method.is_alias_for.path %>"><%= h method.is_alias_for.name %></a>
-          </div>
-          <% end %>
-        </div><!-- <%= method.html_name %>-method -->
-
-      <% end %>
-      </div><!-- <%= visibility %>-<%= type %>-method-details -->
-    <% end
-       end %>
-    </div><!-- <%= section.aref %> -->
-  <% end %>
-
-  </div><!-- documentation -->
-
-  <div id="validator-badges">
-    <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
-    <p><small>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish
-      Rdoc Generator</a> <%= RDoc::Generator::Darkfish::VERSION %></small>.</p>
-  </div>
-
-</body>
-</html>
-

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

@@ -1,124 +0,0 @@
-<?xml version="1.0" encoding="utf-8"?>
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
-  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
-
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-<head>
-  <meta content="text/html; charset=<%= @options.charset %>" http-equiv="Content-Type" />
-
-  <title>File: <%= file.base_name %> [<%= @options.title %>]</title>
-
-  <link type="text/css" media="screen" href="<%= rel_prefix %>/rdoc.css" rel="stylesheet" />
-
-  <script src="<%= rel_prefix %>/js/jquery.js" type="text/javascript"
-    charset="utf-8"></script>
-  <script src="<%= rel_prefix %>/js/thickbox-compressed.js" type="text/javascript"
-    charset="utf-8"></script>
-  <script src="<%= rel_prefix %>/js/quicksearch.js" type="text/javascript"
-    charset="utf-8"></script>
-  <script src="<%= rel_prefix %>/js/darkfish.js" type="text/javascript"
-    charset="utf-8"></script>
-</head>
-
-<% if file.parser == RDoc::Parser::Simple %>
-<body class="file">
-  <div id="metadata">
-    <div id="home-metadata">
-      <div id="home-section" class="section">
-        <h3 class="section-header">
-          <a href="<%= rel_prefix %>/index.html">Home</a>
-          <a href="<%= rel_prefix %>/index.html#classes">Classes</a>
-          <a href="<%= rel_prefix %>/index.html#methods">Methods</a>
-        </h3>
-      </div>
-    </div>
-
-    <div id="project-metadata">
-      <% simple_files = @files.select { |f| f.parser == RDoc::Parser::Simple } %>
-      <% unless simple_files.empty? then %>
-      <div id="fileindex-section" class="section project-section">
-        <h3 class="section-header">Files</h3>
-        <ul>
-        <% simple_files.each do |f| %>
-          <li class="file"><a href="<%= rel_prefix %>/<%= f.path %>"><%= h f.base_name %></a></li>
-        <% end %>
-        </ul>
-      </div>
-      <% end %>
-
-      <div id="classindex-section" class="section project-section">
-        <h3 class="section-header">Class Index
-          <span class="search-toggle"><img src="<%= rel_prefix %>/images/find.png"
-            height="16" width="16" alt="[+]"
-            title="show/hide quicksearch" /></span></h3>
-        <form action="#" method="get" accept-charset="utf-8" class="initially-hidden">
-        <fieldset>
-          <legend>Quicksearch</legend>
-          <input type="text" name="quicksearch" value=""
-            class="quicksearch-field" />
-        </fieldset>
-        </form>
-
-        <ul class="link-list">
-        <% @modsort.each do |index_klass| %>
-          <li><a href="<%= rel_prefix %>/<%= index_klass.path %>"><%= index_klass.full_name %></a></li>
-        <% end %>
-        </ul>
-        <div id="no-class-search-results" style="display: none;">No matching classes.</div>
-      </div>
-
-      <% if $DEBUG_RDOC %>
-      <div id="debugging-toggle"><img src="<%= rel_prefix %>/images/bug.png"
-        alt="toggle debugging" height="16" width="16" /></div>
-      <% end %>
-    </div>
-  </div>
-
-  <div id="documentation">
-    <%= file.description %>
-  </div>
-
-  <div id="validator-badges">
-    <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
-    <p><small>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish
-      Rdoc Generator</a> <%= RDoc::Generator::Darkfish::VERSION %></small>.</p>
-  </div>
-</body>
-<% else %>
-<body class="file file-popup">
-  <div id="metadata">
-    <dl>
-      <dt class="modified-date">Last Modified</dt>
-      <dd class="modified-date"><%= file.last_modified %></dd>
-
-      <% if file.requires %>
-      <dt class="requires">Requires</dt>
-      <dd class="requires">
-        <ul>
-        <% file.requires.each do |require| %>
-          <li><%= require.name %></li>
-        <% end %>
-        </ul>
-      </dd>
-      <% end %>
-
-      <% if @options.webcvs %>
-      <dt class="scs-url">Trac URL</dt>
-      <dd class="scs-url"><a target="_top"
-        href="<%= file.cvs_url %>"><%= file.cvs_url %></a></dd>
-      <% end %>
-    </dl>
-  </div>
-
-  <div id="documentation">
-    <% if file.comment %>
-    <div class="description">
-      <h2>Description</h2>
-      <%= file.description %>
-    </div>
-    <% end %>
-  </div>
-</body>
-<% end %>
-</html>
-