sdoc 1.0.0 → 2.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 29716368d7c072908ecc4b13c04570fe435166e6
-  data.tar.gz: 706d48301caebca63b188da2033a7dee963bfaa8
+SHA256:
+  metadata.gz: 234ba541d36b61d2b4bb680ab8df4e2463d4cc63f0517f160270a3e7a48f0f81
+  data.tar.gz: afae81f60c7f9218da174c06cb4d5799f7c0db8e5188c6dc49c54ea3bacb5dc3
 SHA512:
-  metadata.gz: 94539d716999ecf5b07ba5b93a2974e5fdc22b8f231449195c70129a74856e4ce9ef68bfff8d80ded0bcf4852b14be66110510fa62a7a4200dc04620f3ce0203
-  data.tar.gz: 42a050c73aa5ab6fc403d3b4f37fd66261b9edb78b974ec2bf2b76289f9734e3ce8b4e8a348a0d6e0743b89ff924dcf571cddf1a078ddbe051fc5f310eb90abc
+  metadata.gz: 3b24a3309f283113f8b0f0cd1e2e0d7711a40a293612599499f09b6d6793f25669e9aa0f9925ef9d844a31a89be30f296fdd8f47d3161a8f24629d5d2f41b99c
+  data.tar.gz: f5355d4fd9d7aa0478db5c6aa398502c1480ece246f811b795721471e15eddc74dafe7640cca5de2e32751a65d5fcea0d156933aa2eabc691d1daba222428fdd

data/.travis.yml

@@ -1,15 +1,17 @@
 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.9
-  - 2.3.6
-  - 2.4.2
-  - 2.5.0
+  - 2.2.10
+  - 2.3.7
+  - 2.4.4
+  - 2.5.1
+  - 2.6.0
   - ruby-head
   - jruby-head
 matrix:
@@ -17,10 +19,11 @@ matrix:
     - env: rdoc=master
     - rvm: jruby-head
   include:
-    - { rvm: 2.2.9, env: rdoc=master }
-    - { rvm: 2.3.6, env: rdoc=master }
-    - { rvm: 2.4.2, env: rdoc=master }
-    - { rvm: 2.5.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-head, env: rdoc=master }
 notifications:

data/CHANGELOG.md

@@ -1,3 +1,44 @@
+2.0.3
+=====
+
+* Use @options.title for the index
+
+2.0.2
+=====
+
+* Remove accidental rack inclusion in gemspec
+
+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/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,24 @@ 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.
+
+To view the just generated documentation start up a rack application by running:
+
+```bash
+rackup config.ru
+```
+
+Then open http://localhost:9292 in the browser to view the documentation.
 
 ### Who?
 

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/config.ru

@@ -0,0 +1,30 @@
+# Rack application for serving the documentation locally.
+# After generating the documentation run:
+#
+#   bundle exec rackup config.ru
+#
+require 'bundler/setup'
+
+root = "doc/rails"
+unless Dir.exists?(root)
+  puts <<~MESSAGE
+    Could not find any docs in #{root}.
+    Run the following command to generate sample documentation:
+      bundle exec rake test:rails
+  MESSAGE
+  exit
+end
+
+use Rack::Static,
+  :urls => ["/files", "/images", "/js", "/css", "/panel", "/i", "/classes"],
+  :root => root
+run lambda { |env|
+  [
+    200,
+    { 
+      'Content-Type'  => 'text/html',
+      'Cache-Control' => 'public, max-age=86400'
+    },
+    File.open("#{root}/index.html", File::RDONLY)
+  ]
+}

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/_head.rhtml

@@ -1,6 +1,39 @@
-<link rel="stylesheet" href="<%= "#{rel_prefix}/css/reset.css" %>" type="text/css" media="screen" />
-<link rel="stylesheet" href="<%= "#{rel_prefix}/css/main.css" %>" type="text/css" media="screen" />
-<link rel="stylesheet" href="<%= "#{rel_prefix}/css/github.css" %>" type="text/css" media="screen" />
-<script src="<%= "#{rel_prefix}/js/jquery-1.3.2.min.js" %>" type="text/javascript" charset="utf-8"></script>
-<script src="<%= "#{rel_prefix}/js/main.js" %>" type="text/javascript" charset="utf-8"></script>
-<script src="<%= "#{rel_prefix}/js/highlight.pack.js" %>" type="text/javascript" charset="utf-8"></script>
+<%
+  # 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>

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

@@ -3,7 +3,7 @@
 <head>
     <title><%= h klass.full_name %></title>
     <meta charset="<%= @options.charset %>" />
-    <%= include_template '_head.rhtml', {:rel_prefix => rel_prefix} %>
+    <%= include_template '_head.rhtml', {:rel_prefix => rel_prefix, :tree_keys => klass.full_name.split('::') } %>
 
     <meta property="og:title" value="<%= klass.full_name %>">
 
@@ -13,18 +13,18 @@
     <meta property="og:description" content="<%= human_desc %>">
   <% end %>
 
-    <meta name="keywords" content="<%= klass.full_name %> class">
-  <% unless klass.method_list.empty? %>
-    <meta name="keywords" content="<%= klass.method_list.map(&:name).join(", ") %>">
-  <% end %>
+    <meta name="keywords" content="<%= klass.full_name %> class, <%= klass.method_list.map(&:name).join(", ") %>">
 </head>
 
 <body>
+
+    <%= include_template '_panel.rhtml' %>
+
     <div class="banner">
         <% if ENV['HORO_PROJECT_NAME'] %>
             <span><%= ERB::Util.html_escape(ENV['HORO_PROJECT_NAME']) %> <%= ERB::Util.html_escape(ENV['HORO_PROJECT_VERSION']) %></span><br />
         <% end %>
-        <h1>
+        <h2>
             <span class="type"><%= klass.module? ? 'Module' : 'Class' %></span>
             <%= h klass.full_name %>
             <% if klass.type == 'class' %>
@@ -36,13 +36,14 @@
                     <% end %>
                 </span>
             <% end %>
-        </h1>
+        </h2>
         <ul class="files">
             <% klass.in_files.each do |file| %>
             <li><a href="<%= "#{rel_prefix}/#{h file.path}" %>"><%= h file.absolute_name %></a></li>
             <% end  %>
         </ul>
     </div>
+
     <div id="bodyContent">
         <%= include_template '_context.rhtml', {:context => klass, :rel_prefix => rel_prefix} %>
     </div>

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

@@ -3,17 +3,20 @@
 <head>
     <title><%= h file.name %></title>
     <meta charset="<%= @options.charset %>" />
-    <%= include_template '_head.rhtml', {:rel_prefix => rel_prefix} %>
+    <%= include_template '_head.rhtml', {:rel_prefix => rel_prefix, :tree_keys => [] } %>
 </head>
 
 <body>
+
+    <%= include_template '_panel.rhtml' %>
+
     <div class="banner">
         <% if ENV['HORO_PROJECT_NAME'] %>
             <span><%= ERB::Util.html_escape(ENV['HORO_PROJECT_NAME']) %> <%= ERB::Util.html_escape(ENV['HORO_PROJECT_VERSION']) %></span><br />
         <% end %>
-        <h1>
+        <h2>
             <%= h file.name %>
-        </h1>
+        </h2>
         <ul class="files">
             <%
                 github = github_url(file.relative_name) if options.github

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

@@ -1,11 +1,33 @@
-<!DOCTYPE html>
-<html lang="en">
+<?xml version="1.0" encoding="utf-8"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
 <head>
-    <meta charset="<%= @options.charset %>">
     <title><%= @options.title %></title>
+    <meta http-equiv="Content-Type" content="text/html; charset=<%= @options.charset %>" />
+    <%= include_template '_head.rhtml', {:rel_prefix => rel_prefix, tree_keys: []} %>
 </head>
-<frameset cols="300,*" frameborder="1" border="1" bordercolor="#999999" framespacing="1">
-    <frame src="panel/index.html" title="Search" name="panel" />
-    <frame src="<%= index_path %>" name="docwin" />
-</frameset>
+
+<body>
+
+    <%= include_template '_panel.rhtml' %>
+
+    <div class="banner">
+        <% if ENV['HORO_PROJECT_NAME'] %>
+            <span><%= ERB::Util.html_escape(ENV['HORO_PROJECT_NAME']) %> <%= ERB::Util.html_escape(ENV['HORO_PROJECT_VERSION']) %></span><br />
+        <% end %>
+        <h2>
+            <%= h index.name %>
+        </h2>
+        <ul class="files">
+            <li><%= h index.relative_name %></li>
+            <li>Last modified: <%= index.last_modified %></li>
+        </ul>
+    </div>
+
+    <div id="bodyContent">
+        <%= include_template '_context.rhtml', {:context => index } %>
+    </div>
+  </body>
 </html>
+

data/lib/rdoc/generator/template/rails/resources/css/main.css

@@ -7,6 +7,10 @@ body {
   line-height: 1.25em;
 }
 
+.banner, #bodyContent {
+  margin-left: 300px;
+}
+
 a:link, a:active, a:visited, a:hover {
   color: #CC0000;
   text-decoration: none;
@@ -121,20 +125,20 @@ ol li
     padding: 1em;
     box-shadow: 1px 1px 3px rgba(0, 0, 0, 0.2);
 }
-.banner h1
+.banner h2
 {
     font-size: 1.2em;
     margin: 0;
 }
 
-.banner h1 .type
+.banner h2 .type
 {
     font-size: 0.833em;
     display:block;
 }
 
-.banner h1 .type,
-.banner h1 .parent
+.banner h2 .type,
+.banner h2 .parent
 {
     color: #CCC;
 }

data/lib/rdoc/generator/template/rails/resources/css/panel.css

@@ -1,15 +1,15 @@
 /* Panel (begin) */
     .panel
     {
-        position: absolute;
-        width: 100%;
+        position: fixed;
+        width: 300px;
         height: 100%;
-        top: 0;
-        left: 0;
         background: #FFF;
         z-index: 2;
         font-family: "Helvetica Neue", "Arial", sans-serif;
         overflow-x: hidden;
+        border-right: 1px #ccc solid;
+        line-height: 1;
     }
 
     .panel_tree .results,
@@ -25,10 +25,11 @@
             background-position: 5px;
             box-shadow: 1px 1px 3px rgba(0, 0, 0, 0.2);
             height: 40px;
-            width: 100%;
-            position: absolute;
+            width: 300px;
+            position: fixed;
             left: 0; top: 0;
             z-index: 300;
+            overflow-x: hidden;
         }
 
         .panel .header input
@@ -51,9 +52,9 @@
     /* Results (begin) */
         .panel .result
         {
-            position: absolute;
-            top: 40px;
+            position: relative;
             bottom: 0;
+            top: 40px;
             left: 0;
             width: 100%;
             overflow-y: scroll;
@@ -73,6 +74,7 @@
             overflow: hidden;
             padding: 4px 10px 0 10px;
             cursor: pointer;
+            margin: 0;
         }
 
         .panel .result ul li:nth-child(2n) {
@@ -84,6 +86,7 @@
             font-size: 13px;
             font-weight: normal;
             color: #333;
+            margin-top: 0;
             margin-bottom: 2px;
             white-space: nowrap;
         }
@@ -216,7 +219,7 @@
         .panel .tree
         {
             background: white;
-            position: absolute;
+            position: relative;
             top: 40px;
             bottom: 0;
             left: 0;
@@ -238,6 +241,7 @@
             overflow: hidden;
             height: 30px;
             line-height: 100%;
+            margin: 0;
         }
 
 
@@ -273,6 +277,7 @@
             font-size: 13px;
             font-weight: normal;
             color: #000;
+            margin-top: 0;
             margin-bottom: 2px;
             white-space: nowrap;
         }
@@ -315,13 +320,13 @@
 
         .panel .tree ul li.current .icon
         {
-            background: url(../i/arrow-right.svg);
+            background: url(../i/arrow-down-current.svg);
             background-size: 10px;
         }
 
         .panel .tree ul li.current.closed .icon
         {
-            background: url(../i/arrow-down.svg);
+            background: url(../i/arrow-right-current.svg);
             background-size: 10px;
         }