sdoc 1.0.0.rc2 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: fd8f108539b22e091aee84678e782138bb18aa53
-  data.tar.gz: 6155efbb4da708d34160dd72c7b3d6cc961713fc
+SHA256:
+  metadata.gz: 92be8c9ef112cad65ae175c43397ba7c74e5ce6a5dd487defe7391c519a7f4e0
+  data.tar.gz: 87fbba0f4724a4d61468db740892afc6b4cb3492427ea9fa41bf9c4f7bdb3d33
 SHA512:
-  metadata.gz: 1f279d16a4661525a966e664a26572e787e53383c91dd050a8a24037b277fd005394c48cb0856d495a15b36928c035d50872c28909fce411440b540639c81572
-  data.tar.gz: 5ed8e231e52ac56ba9f959780cb2307637e35d85d02b193de0d369b67af50bd512d0235bc800d1037e1b7f0c84489168d5c99eb5fa24f1dfacd873affcd686da
+  metadata.gz: a032a96408400f81bcb381c2aa68b6bbd79bf37dea20c7e9c2e70e5e8f470d277736b5bdc77ad1ea493077de89fe294cf8abe58ef9f946f661822758547a81b1
+  data.tar.gz: 707cc43e783acfab07306c54d760d57bbb9df21e6a1ed0295a406a5d4c05fe6dd0acdf977d9773527ebe3d3841fcfdf476b3a00b456f4c2f8fd1ce0b8e005cee

data/.gitignore

@@ -6,4 +6,4 @@ doc
 Gemfile.lock
 /.rake_tasks~
 /*.gem
-rails/
+/rails/

data/.travis.yml

@@ -1,29 +1,30 @@
 language: ruby
 cache: bundler
 before_install:
-  - gem install bundler
+  - gem update --system || gem update --system 2.7.8
+  - gem install bundler || gem install bundler -v 1.17.3
 rvm:
   - 1.9.3
   - 2.0.0
   - 2.1.0
-  - 2.2.0
-  - 2.3.0
-  - 2.4.0
+  - 2.2.10
+  - 2.3.7
+  - 2.4.4
+  - 2.5.1
+  - 2.6.0
   - ruby-head
-  - jruby-19mode
   - jruby-head
 matrix:
   allow_failures:
     - env: rdoc=master
     - rvm: jruby-head
   include:
-    - { rvm: 1.9.3, env: rdoc=master }
-    - { rvm: 2.0.0, env: rdoc=master }
-    - { rvm: 2.1.0, env: rdoc=master }
-    - { rvm: 2.2.0, env: rdoc=master }
-    - { rvm: 2.3.0, env: rdoc=master }
+    - { rvm: 2.2.10, env: rdoc=master }
+    - { rvm: 2.3.7, env: rdoc=master }
+    - { rvm: 2.4.4, env: rdoc=master }
+    - { rvm: 2.5.1, env: rdoc=master }
+    - { rvm: 2.6.0, env: rdoc=master }
     - { rvm: ruby-head, env: rdoc=master }
-    - { rvm: jruby-19mode, env: rdoc=master }
     - { rvm: jruby-head, env: rdoc=master }
 notifications:
   email:

data/CHANGELOG.md

@@ -1,3 +1,34 @@
+2.0.1
+=====
+
+* #142 Fix arrow icons for selected panel items 
+* #141 Always use only one metatag for keywords
+* #140 Use h2 instead of h1 for banner header
+
+2.0.0
+=====
+
+* #137 Replace frames based implementation with a css
+* #132 Deprecate safe_level of ERB.new in Ruby 2.6
+
+1.1.0
+=====
+
+* #138 - Fix panel header overflow on Chrome
+* 39e6cae9 - Display version using `-v` or `--version` flags
+
+1.0.0
+=====
+
+* #110 - Strip out HTML tags from search results description
+* #109 - Add basic SEO tags
+* #108 - Tiny refresh of the Rails theme
+* e6f02b91 - Remove the jQuery effect library
+* 73ace366 - Remove the `--without-search` option
+* b1d429f2 - Produce HTML 5 output
+* 38d06095 - Support only RDoc 5 and up
+* #96 - Require at least Ruby 1.9.3
+
 0.4.2
 =====
 

data/Gemfile

@@ -7,5 +7,5 @@ gem "minitest"
 gem "hoe"
 
 if ENV["rdoc"] == "master"
-  gem "rdoc", :github => "rdoc/rdoc"
+  gem "rdoc", :github => "ruby/rdoc"
 end

data/README.md

@@ -1,6 +1,6 @@
 # SDoc
 
-[![Build Status](https://travis-ci.org/zzak/sdoc.png?branch=master)](https://travis-ci.org/zzak/sdoc)
+[![Build Status](https://travis-ci.org/zzak/sdoc.svg?branch=master)](https://travis-ci.org/zzak/sdoc)
 
 **Powering http://api.rubyonrails.org/**
 
@@ -62,9 +62,9 @@ require 'sdoc' # and use your RDoc task the same way you used it before
 require 'rdoc/task' # ensure this file is also required in order to use `RDoc::Task`
 
 RDoc::Task.new do |rdoc|
-  rdoc.rdoc_dir = 'doc/rdoc' # name of output directory
-  rdoc.generator = 'sdoc' # explictly set the sdoc generator
-  rdoc.template = 'rails' # template used on api.rubyonrails.org
+  rdoc.rdoc_dir = 'doc/rdoc'      # name of output directory
+  rdoc.options << '--format=sdoc' # explictly set the sdoc generator
+  rdoc.template = 'rails'         # template used on api.rubyonrails.org
 end
 ```
 
@@ -78,7 +78,7 @@ Alternatively you can pass this command a path to the project you wish to compil
 
 As mentioned before, SDoc is built on top of the RDoc project.
 
-If you notice any bugs in the output of your documentation, it may be RDoc's fault and should be [reported upstream](https://github.com/rdoc/rdoc/issues/new).
+If you notice any bugs in the output of your documentation, it may be RDoc's fault and should be [reported upstream](https://github.com/ruby/rdoc/issues/new).
 
 An example of an SDoc bug would be:
 
@@ -90,6 +90,16 @@ Please feel free to still report issues here for both projects, especially if yo
 
 As maintainer of both projects, I'll see if I can identify the root of the cause :bow: :bow: :bow:
 
+## Contributing
+
+If you'd like to contribute you can generate the Rails documentation by running:
+
+```bash
+rake test:rails
+```
+
+This task will generate documentation for the Rails master branch.
+Since the task doesn't do any file filtering it contains a lot of extra pages.
 
 ### Who?
 

data/Rakefile

@@ -1,5 +1,3 @@
-require 'rubygems'
-
 require 'bundler'
 Bundler::GemHelper.install_tasks
 
@@ -7,6 +5,7 @@ require 'rake/testtask'
 
 Rake::TestTask.new do |t|
   t.pattern = "spec/*_spec.rb"
+  t.libs << "spec"
 end
 
 task :default => :test

data/bin/sdoc

@@ -1,4 +1,4 @@
-#!/usr/bin/env ruby -KU
+#!/usr/bin/env ruby
 require 'sdoc'
 
 begin

data/bin/sdoc-merge

@@ -1,4 +1,4 @@
-#!/usr/bin/env ruby -KU
+#!/usr/bin/env ruby
 require File.dirname(__FILE__) + '/../lib/sdoc' # add extensions
 require 'sdoc/merge'
 

data/lib/rdoc/discover.rb

@@ -1,5 +1,5 @@
 begin
-  gem 'rdoc', '~> 5.0'
+  gem 'rdoc', '>= 5.0'
   require File.join(File.dirname(__FILE__), '/../sdoc')
 rescue Gem::LoadError
 end

data/lib/rdoc/generator/template/rails/_context.rhtml

@@ -0,0 +1,216 @@
+<div id="content">
+  <% unless (description = context.description).empty? %>
+    <div class="description">
+      <%= description %>
+    </div>
+  <% end %>
+
+
+  <% unless context.requires.empty? %>
+    <!-- File only: requires -->
+    <div class="sectiontitle">Required Files</div>
+    <ul>
+      <% context.requires.each do |req| %>
+        <li><%= h req.name %></li>
+      <% end %>
+    </ul>
+  <% end %>
+
+
+  <% sections = context.sections.select { |s| s.title }.sort_by{ |s| s.title.to_s } %>
+  <% unless sections.empty? then %>
+    <!-- Sections -->
+    <div class="sectiontitle">Sections</div>
+    <ul>
+      <% sections.each do |section| %>
+        <li><a href="#<%= section.aref %>"><%= h section.title %></a></li>
+      <% end %>
+    </ul>
+  <% end %>
+
+
+  <% unless context.classes_and_modules.empty? %>
+    <!-- Namespace -->
+    <div class="sectiontitle">Namespace</div>
+    <ul>
+      <% (context.modules.sort + context.classes.sort).each do |mod| %>
+        <li>
+          <span class="type"><%= mod.type.upcase %></span>
+          <a href="<%= context.aref_to mod.path %>"><%= mod.full_name %></a>
+        </li>
+      <% end %>
+    </ul>
+  <% end %>
+
+
+  <% unless context.method_list.empty? %>
+    <!-- Method ref -->
+    <div class="sectiontitle">Methods</div>
+    <dl class="methods">
+      <% each_letter_group(context.method_list) do |group| %>
+        <dt><%= group[:name] %></dt>
+        <dd>
+          <ul>
+            <% group[:methods].each_with_index do |method, i|  %>
+              <%
+                comma = group[:methods].size == i+1 ? '' : ','
+              %>
+              <li>
+                <a href="#<%= method.aref %>"><%= h method.name %></a><%= comma %>
+              </li>
+            <% end %>
+          </ul>
+        </dd>
+      <% end %>
+    </dl>
+  <% end %>
+
+  <% unless context.includes.empty? %>
+    <!-- Includes -->
+    <div class="sectiontitle">Included Modules</div>
+    <ul>
+      <% context.includes.each do |inc| %>
+        <li>
+          <% unless String === inc.module %>
+            <a href="<%= context.aref_to inc.module.path %>">
+              <%= h inc.module.full_name %>
+            </a>
+          <% else %>
+            <%= h inc.name %>
+          <% end %>
+        </li>
+      <% end %>
+    </ul>
+  <% end %>
+
+
+
+  <% context.each_section do |section, constants, attributes| %>
+
+    <% if section.title then %>
+      <div class="contenttitle" id="<%= h section.aref %>">
+        <%= h section.title %>
+      </div>
+    <% end %>
+
+    <% if section.comment then %>
+      <div class="description">
+        <%= section.description %>
+      </div>
+    <% end %>
+
+    <% unless constants.empty? %>
+      <!-- Section constants -->
+      <div class="sectiontitle">Constants</div>
+      <table border='0' cellpadding='5'>
+        <% constants.each do |const| %>
+          <tr valign='top'>
+            <td class="attr-name"><%= h const.name %></td>
+            <td>=</td>
+            <td class="attr-value"><%= h const.value %></td>
+          </tr>
+          <% if const.comment %>
+            <tr valign='top'>
+              <td>&nbsp;</td>
+              <td colspan="2" class="attr-desc"><%= const.description.strip %></td>
+            </tr>
+          <% end %>
+        <% end %>
+      </table>
+    <% end %>
+
+
+    <% unless attributes.empty? %>
+      <!-- Section attributes -->
+      <div class="sectiontitle">Attributes</div>
+      <table border='0' cellpadding='5'>
+        <% attributes.each do |attrib| %>
+          <tr valign='top'>
+            <td class='attr-rw'>
+              [<%= attrib.rw %>]
+            </td>
+            <td class='attr-name'><%= h attrib.name %></td>
+            <td class='attr-desc'><%= attrib.description.strip %></td>
+          </tr>
+        <% end %>
+      </table>
+    <% end %>
+
+
+    <!-- Methods -->
+    <%
+      context.methods_by_type(section).each do |type, visibilities|
+        next if visibilities.empty?
+
+        visibilities.each do |visibility, methods|
+          next if methods.empty?
+    %>
+      <div class="sectiontitle"><%= type.capitalize %> <%= visibility.to_s.capitalize %> methods</div>
+      <% methods.each do |method| %>
+        <div class="method">
+          <div class="title method-title" id="<%= method.aref %>">
+            <% if method.call_seq %>
+              <b><%= method.call_seq.gsub(/->/, '&rarr;').gsub(/\n(.)/, '<br />\1') %></b>
+            <% else %>
+              <b><%= h method.name %></b><%= h method.params %>
+            <% end %>
+            <a href="<%= "#{rel_prefix}/#{context.path}##{method.aref}"%>" name="<%= method.aref %>" class="permalink">Link</a>
+          </div>
+
+          <% if method.comment %>
+            <div class="description">
+              <%= method.description.strip %>
+            </div>
+          <% end %>
+
+          <% unless method.aliases.empty? %>
+            <div class="aka">
+              Also aliased as: <%= method.aliases.map do |aka|
+                if aka.parent then # HACK lib/rexml/encodings
+                  %{<a href="#{context.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="aka">
+              Alias for: <a href="<%= context.aref_to method.is_alias_for.path %>"><%= h method.is_alias_for.name %></a>
+            </div>
+          <% end %>
+
+          <% if method.token_stream %>
+            <% markup = method.markup_code %>
+            <div class="sourcecode">
+              <%
+                # generate github link
+                github = if options.github
+                  if markup =~ /File\s(\S+), line (\d+)/
+                    path = $1
+                    line = $2.to_i
+                  end
+                  path && github_url(path)
+                else
+                  false
+                end
+              %>
+              <p class="source-link">
+                Source:
+                <a href="javascript:toggleSource('<%= method.aref %>_source')" id="l_<%= method.aref %>_source">show</a>
+                <% if github %>
+                  | <a href="<%= "#{github}#L#{line}" %>" target="_blank" class="github_url">on GitHub</a>
+                <% end %>
+              </p>
+              <div id="<%= method.aref %>_source" class="dyn-source">
+                <pre><%= markup %></pre>
+              </div>
+            </div>
+            <% end %>
+          </div>
+        <% end %><%# methods.each %>
+      <% end %><%# visibilities.each %>
+    <% end %><%# context.methods_by_type %>
+  <% end %><%# context.each_section %>
+</div>

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

@@ -0,0 +1,39 @@
+<%
+  # Turbolinks does not consider relative urls similar, resulting in page
+  # reloads and losing the context of the panel. Emptying the rel_prefix makes
+  # asset paths absolute. This breaks opening the docs locally. Maybe all
+  # generated docs should be in the same folder?
+  rel_prefix = ''
+%>
+<link rel="stylesheet" href="<%= "#{rel_prefix}/css/reset.css" %>" type="text/css" media="screen" data-turbolinks-track="reload" />
+<link rel="stylesheet" href="<%= "#{rel_prefix}/css/panel.css" %>" type="text/css" media="screen" data-turbolinks-track="reload" />
+<link rel="stylesheet" href="<%= "#{rel_prefix}/css/main.css" %>" type="text/css" media="screen" data-turbolinks-track="reload" />
+<link rel="stylesheet" href="<%= "#{rel_prefix}/css/github.css" %>" type="text/css" media="screen" data-turbolinks-track="reload" />
+<script src="<%= "#{rel_prefix}/js/jquery-3.5.1.min.js" %>" type="text/javascript" charset="utf-8" data-turbolinks-track="reload"></script>
+<script src="<%= "#{rel_prefix}/js/main.js" %>" type="text/javascript" charset="utf-8" data-turbolinks-track="reload"></script>
+<script src="<%= "#{rel_prefix}/js/highlight.pack.js" %>" type="text/javascript" charset="utf-8" data-turbolinks-track="reload"></script>
+<script src="<%= rel_prefix %>/js/turbolinks.js" type="text/javascript" charset="utf-8" data-turbolinks-track="reload"></script>
+<script src="<%= rel_prefix %>/js/search_index.js" type="text/javascript" charset="utf-8" data-turbolinks-track="reload"></script>
+<script src="<%= rel_prefix %>/js/searcher.js" type="text/javascript" charset="utf-8" data-turbolinks-track="reload"></script>
+<script src="<%= rel_prefix %>/panel/tree.js" type="text/javascript" charset="utf-8" data-turbolinks-track="reload"></script>
+<script src="<%= rel_prefix %>/js/searchdoc.js" type="text/javascript" charset="utf-8" data-turbolinks-track="reload"></script>
+<script type="text/javascript" charset="utf-8">
+document.addEventListener("turbolinks:load", function() {
+  // Only initialize panel if not yet initialized
+  if(!$('#panel .tree ul li').length) {
+    $('#links').hide();
+    var panel = new Searchdoc.Panel($('#panel'), search_data, tree, '<%= rel_prefix %>/');
+    $('#search').focus();
+    var s = window.location.search.match(/\?q=([^&]+)/);
+    if (s) {
+      s = decodeURIComponent(s[1]).replace(/\+/g, ' ');
+      if (s.length > 0) {
+        $('#search').val(s);
+        panel.search(s, true);
+      }
+    }
+    panel.toggle(<%= tree_keys %>);
+  }
+})
+</script>
+

data/lib/rdoc/generator/template/rails/_panel.rhtml

@@ -0,0 +1,14 @@
+<div class="panel panel_tree" id="panel" data-turbolinks-permanent>
+  <div class="header">
+    <input type="text" placeholder="Search for a class, method, ..." autosave="searchdoc" results="10" id="search" autocomplete="off" />
+  </div>
+  <div class="tree">
+    <ul>
+    </ul>
+  </div>
+  <div class="result">
+    <ul>
+    </ul>
+  </div>
+  <a href="links.html" id="links">index</a>
+</div>