sdoc 2.0.1 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 92be8c9ef112cad65ae175c43397ba7c74e5ce6a5dd487defe7391c519a7f4e0
-  data.tar.gz: 87fbba0f4724a4d61468db740892afc6b4cb3492427ea9fa41bf9c4f7bdb3d33
+  metadata.gz: 002ca37375a4f9d51c68f2c7ac421cec8c4baf74171615627e828fbf8947bc48
+  data.tar.gz: 06f44cb76f359c63d97a0b9e5c0eb5c5b06277c700928006e2e390c05955eb17
 SHA512:
-  metadata.gz: a032a96408400f81bcb381c2aa68b6bbd79bf37dea20c7e9c2e70e5e8f470d277736b5bdc77ad1ea493077de89fe294cf8abe58ef9f946f661822758547a81b1
-  data.tar.gz: 707cc43e783acfab07306c54d760d57bbb9df21e6a1ed0295a406a5d4c05fe6dd0acdf977d9773527ebe3d3841fcfdf476b3a00b456f4c2f8fd1ce0b8e005cee
+  metadata.gz: b48d64b1e6c87db2088e56c692ed31c8f85fef24e640b18a5c4f609966f7d0b912d78a2e2a973bfffc2bbbecf1ffb3bfb5f16adeecc69780f3e7286850a8f92a
+  data.tar.gz: 9e59249e7ea77c4057c1a741e9d4dd6c6fe058ba63fe976d88e20806520d7ce8b219aa5b04acc0943b8f91b0abfb11d97e9fb2d28360381cf893a5c7f8ec3b7f

data/.github/workflows/test.yml

@@ -0,0 +1,37 @@
+name: Tests
+
+on:
+  push:
+  schedule:
+    - cron: '0 0 * * *'
+
+jobs:
+  test:
+    runs-on: ubuntu-20.04
+    strategy:
+      matrix:
+        ruby:
+          - '2.1'
+          - '2.2'
+          - '2.3'
+          - '2.4'
+          - '2.5'
+          - '2.6'
+          - '2.7'
+          - '3.0'
+          - 'ruby-head'
+          - 'jruby-head'
+          - 'truffleruby-head'
+
+    steps:
+      - uses: actions/checkout@v1
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+
+      - name: Test
+        run: |
+          bundle exec rake

data/.gitignore

@@ -7,3 +7,4 @@ Gemfile.lock
 /.rake_tasks~
 /*.gem
 /rails/
+/ruby/

data/CHANGELOG.md

@@ -1,14 +1,52 @@
+Master
+======
+
+2.2.0
+=====
+
+* #161 Add 'skip to content' link and improve shortcut keys [@MikeRogers0](https://github.com/MikeRogers0)
+* #170 Fix link hovers in headings [@tlatsas](https://github.com/tlatsas)
+* #169 Fix clearing search results [@mikdiet](https://github.com/mikdiet)
+* #167 Update Merge script to work with sdoc v2 [@mikdiet](https://github.com/mikdiet)
+* #160 Remove outline from reset stylesheet [@p8](https://github.com/p8)
+* #159 Remove TAB override in panel [@p8](https://github.com/p8)
+* #157 Move to GitHub action for tests [@MikeRogers0](https://github.com/MikeRogers0)
+* #155 Fix Ctrl+C copying [Jan Schär](https://github.com/jscissr)
+
+2.1.0
+=====
+
+* #154 Make panel responsive for mobile [@MikeRogers0](https://github.com/MikeRogers0) and [@p8](https://github.com/p8)
+* #153 Add viewport metatag to views for improved Lighthouse score. [@MikeRogers0](https://github.com/MikeRogers0)
+* #150 Use semantic headers for better SEO [@p8](https://github.com/p8)
+
+2.0.4
+=====
+
+* #149 Using HTML5 doctype accross all HTML files. [@MikeRogers0](https://github.com/MikeRogers0)
+* #148 Fix overflow CSS property of panel elements. [@cveneziani](https://github.com/cveneziani)
+
+2.0.3
+=====
+
+* #147 Use @options.title for the index [@p8](https://github.com/p8)
+
+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
+* #142 Fix arrow icons for selected panel items [@p8](https://github.com/p8)
+* #141 Always use only one metatag for keywords [@p8](https://github.com/p8)
+* #140 Use h2 instead of h1 for banner header [@p8](https://github.com/p8)
 
 2.0.0
 =====
 
-* #137 Replace frames based implementation with a css
+* #137 Replace frames based implementation with a css [@p8](https://github.com/p8)
 * #132 Deprecate safe_level of ERB.new in Ruby 2.6
 
 1.1.0
@@ -68,4 +106,3 @@ Bug Fixes
 [Compare v0.3.20...v0.4.0](https://github.com/voloko/sdoc/compare/v0.3.20...v0.4.0)
 
 No friendly log for this version yet, but PRs are welcome!
-

data/README.md

@@ -1,6 +1,6 @@
 # SDoc
 
-[![Build Status](https://travis-ci.org/zzak/sdoc.svg?branch=master)](https://travis-ci.org/zzak/sdoc)
+[![Tests](https://github.com/zzak/sdoc/actions/workflows/test.yml/badge.svg)](https://github.com/zzak/sdoc/actions/workflows/test.yml)
 
 **Powering http://api.rubyonrails.org/**
 
@@ -92,14 +92,32 @@ As maintainer of both projects, I'll see if I can identify the root of the cause
 
 ## Contributing
 
-If you'd like to contribute you can generate the Rails documentation by running:
+If you'd like to contribute you can generate the Rails main branch 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.
+You can generate the Ruby default branch documentation by running:
+
+```bash
+rake test:ruby
+```
+
+You can generate merged Rails and Ruby documentation by running:
+
+```bash
+rake test:merged
+```
+
+The generated documentation will be put into `doc/public` directory.
+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/Rakefile

@@ -12,22 +12,74 @@ task :default => :test
 task :spec => :test
 
 require 'sdoc'
+require 'sdoc/merge'
 require 'rdoc/task'
 
 rails = File.expand_path "rails"
+ruby = File.expand_path "ruby"
 
 directory rails do
   sh "git clone --depth=1 https://github.com/rails/rails"
 end
 
+directory ruby do
+  sh "git clone --depth=1 https://github.com/ruby/ruby"
+end
+
 namespace :test do
-  task :rails => rails
+  desc 'Deletes all generated test documentation'
+  task :reset_docs do
+    FileUtils.remove_dir(File.expand_path('doc'), force: true)
+  end
+
+  desc 'Generates test rails documentation'
+  task :rails => [rails, :generate_rails] do
+    FileUtils.mv(
+      File.expand_path('doc/rails'),
+      File.expand_path('doc/public')
+    )
+  end
 
-  RDoc::Task.new(:rails) do |rdoc|
+  RDoc::Task.new(:generate_rails) do |rdoc|
     rdoc.rdoc_dir = 'doc/rails'
     rdoc.generator = 'sdoc'
     rdoc.template = 'rails'
+    rdoc.title = 'Ruby on Rails'
+    rdoc.main = 'rails/README.md'
+    rdoc.options << '--exclude=test'
 
     rdoc.rdoc_files.include("rails/")
   end
+
+  desc 'Generates test ruby documentation'
+  task :ruby => [ruby, :generate_ruby] do
+    FileUtils.mv(
+      File.expand_path('doc/ruby'),
+      File.expand_path('doc/public')
+    )
+  end
+
+  RDoc::Task.new(:generate_ruby) do |rdoc|
+    rdoc.rdoc_dir = 'doc/ruby'
+    rdoc.generator = 'sdoc'
+    rdoc.template = 'rails'
+    rdoc.title = 'Ruby'
+    rdoc.main = 'ruby/README.md'
+
+    rdoc.rdoc_files.include("ruby/")
+  end
+
+  desc 'Generates merged test documentation'
+  task :merged => [rails, :generate_rails, ruby, :generate_ruby, :merge]
+
+  task :merge do
+    SDoc::Merge.new.merge(
+      [
+        '--title', 'Rails + Ruby',
+        '--op', 'doc/public',
+        '--names', 'rails, ruby',
+        'doc/rails', 'doc/ruby'
+      ]
+    )
+  end
 end

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/public"
+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", "/ruby", "/rails"],
+  :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/generator/template/rails/_context.rhtml

@@ -101,7 +101,7 @@
 
     <% unless constants.empty? %>
       <!-- Section constants -->
-      <div class="sectiontitle">Constants</div>
+      <h2 class="sectiontitle">Constants</h2>
       <table border='0' cellpadding='5'>
         <% constants.each do |const| %>
           <tr valign='top'>
@@ -122,7 +122,7 @@
 
     <% unless attributes.empty? %>
       <!-- Section attributes -->
-      <div class="sectiontitle">Attributes</div>
+      <h2 class="sectiontitle">Attributes</h2>
       <table border='0' cellpadding='5'>
         <% attributes.each do |attrib| %>
           <tr valign='top'>
@@ -145,17 +145,17 @@
         visibilities.each do |visibility, methods|
           next if methods.empty?
     %>
-      <div class="sectiontitle"><%= type.capitalize %> <%= visibility.to_s.capitalize %> methods</div>
+      <h2 class="sectiontitle"><%= type.capitalize %> <%= visibility.to_s.capitalize %> methods</h2>
       <% methods.each do |method| %>
         <div class="method">
-          <div class="title method-title" id="<%= method.aref %>">
+          <h3 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>
+          </h3>
 
           <% if method.comment %>
             <div class="description">

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

@@ -17,23 +17,6 @@
 <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>
 
+<meta name="data-rel-prefix" content="<%= rel_prefix %>/">
+<meta name="data-tree-keys" content='<%= tree_keys %>'>

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

@@ -1,6 +1,9 @@
-<div class="panel panel_tree" id="panel" data-turbolinks-permanent>
+<input type="checkbox" id="hamburger" class="panel_checkbox">
+<label class="panel_mobile_button" for="hamburger"><span></span> Menu</label>
+<nav 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" />
+    <input type="text" placeholder="Search (/) for a class, method, ..." autosave="searchdoc" results="10" id="search" autocomplete="off" tabindex="-1" />
+    <label class="panel_mobile_button_close" for="hamburger"><span></span> Close</label>
   </div>
   <div class="tree">
     <ul>
@@ -11,4 +14,4 @@
     </ul>
   </div>
   <a href="links.html" id="links">index</a>
-</div>
+</nav>

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

@@ -3,6 +3,7 @@
 <head>
     <title><%= h klass.full_name %></title>
     <meta charset="<%= @options.charset %>" />
+    <meta name="viewport" content="width=device-width,initial-scale=1">
     <%= include_template '_head.rhtml', {:rel_prefix => rel_prefix, :tree_keys => klass.full_name.split('::') } %>
 
     <meta property="og:title" value="<%= klass.full_name %>">
@@ -17,6 +18,8 @@
 </head>
 
 <body>
+    <a class="sr-only sr-only-focusable" href="#content" data-turbolinks="false">Skip to Content</a>
+    <a class="sr-only sr-only-focusable" href="#search" data-turbolinks="false">Skip to Search</a>
 
     <%= include_template '_panel.rhtml' %>
 
@@ -24,7 +27,7 @@
         <% 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,7 +39,7 @@
                     <% 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>
@@ -44,8 +47,8 @@
         </ul>
     </div>
 
-    <div id="bodyContent">
+    <main id="bodyContent">
         <%= include_template '_context.rhtml', {:context => klass, :rel_prefix => rel_prefix} %>
-    </div>
+    </main>
   </body>
 </html>

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

@@ -3,10 +3,13 @@
 <head>
     <title><%= h file.name %></title>
     <meta charset="<%= @options.charset %>" />
+    <meta name="viewport" content="width=device-width,initial-scale=1">
     <%= include_template '_head.rhtml', {:rel_prefix => rel_prefix, :tree_keys => [] } %>
 </head>
 
 <body>
+    <a class="sr-only sr-only-focusable" href="#content" data-turbolinks="false">Skip to Content</a>
+    <a class="sr-only sr-only-focusable" href="#search" data-turbolinks="false">Skip to Search</a>
 
     <%= include_template '_panel.rhtml' %>
 
@@ -14,9 +17,9 @@
         <% 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
@@ -31,8 +34,8 @@
         </ul>
     </div>
 
-    <div id="bodyContent">
+    <main id="bodyContent">
         <%= include_template '_context.rhtml', {:context => file, :rel_prefix => rel_prefix} %>
-    </div>
+    </main>
   </body>
 </html>

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

@@ -1,14 +1,15 @@
-<?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">
+<!DOCTYPE html>
+<html lang="en">
 <head>
-    <title><%= h index.name %></title>
+    <title><%= @options.title %></title>
     <meta http-equiv="Content-Type" content="text/html; charset=<%= @options.charset %>" />
+    <meta name="viewport" content="width=device-width,initial-scale=1">
     <%= include_template '_head.rhtml', {:rel_prefix => rel_prefix, tree_keys: []} %>
 </head>
 
 <body>
+    <a class="sr-only sr-only-focusable" href="#content" data-turbolinks="false">Skip to Content</a>
+    <a class="sr-only sr-only-focusable" href="#search" data-turbolinks="false">Skip to Search</a>
 
     <%= include_template '_panel.rhtml' %>
 
@@ -16,18 +17,17 @@
         <% 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 index.name %>
-        </h1>
+        </h2>
         <ul class="files">
             <li><%= h index.relative_name %></li>
             <li>Last modified: <%= index.last_modified %></li>
         </ul>
     </div>
 
-    <div id="bodyContent">
+    <main id="bodyContent">
         <%= include_template '_context.rhtml', {:context => index } %>
-    </div>
+    </main>
   </body>
 </html>
-