sdoc 2.0.3 → 2.3.0

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

@@ -1,18 +1,119 @@
 /* Panel (begin) */
+    .panel_checkbox, .panel_mobile_button, .panel_mobile_button_close
+    {
+        display: none;
+    }
+
+    @media (max-width: 39.99em) {
+        .panel_mobile_button {
+            display: block;
+            height: 40px;
+            position: sticky;
+            top: 0;
+            background: #000;
+            color: #fff;
+            padding-right: 10px;
+            text-align: right;
+            line-height: 40px;
+            cursor: pointer;
+            z-index: 2;
+        }
+        .panel_checkbox:checked ~ .panel_mobile_button {
+        }
+
+        .panel_checkbox:checked ~ .panel .panel_mobile_button_close {
+            display: block;
+            height: 40px;
+            position: absolute;
+            top: 0;
+            right: 10px;
+            z-index: 3000;
+            text-align: right;
+            line-height: 40px;
+            cursor: pointer;
+        }
+    }
+
+    .panel_mobile_button span {
+         position: relative;
+         display: inline-block;
+         width: 1em;
+         height: 0.55em;
+         margin-right: 0.3em;
+         border-top: 0.1em solid #fff;
+         border-bottom: 0.1em solid #fff;
+    }
+
+    .panel_mobile_button span:before {
+         content: "";
+         position: absolute;
+         top: 0.25em;
+         left: 0px;
+         width: 100%;
+         border-top: 0.1em solid #fff;
+    }
+
+    .panel_mobile_button_close span {
+         position: relative;
+         display: inline-block;
+         width: 1em;
+         height: 0.625em;
+    }
+
+    .panel_mobile_button_close span:before, .panel_mobile_button_close span:after {
+         content: "";
+         position: absolute;
+         top: 0.2em;
+         left: 0px;
+         width: 100%;
+         border-top: 0.1em solid #000;
+    }
+
+    .panel_mobile_button_close span:before {
+        transform: rotate(45deg);
+    }
+
+    .panel_mobile_button_close span:after {
+        transform: rotate(-45deg);
+    }
+
     .panel
     {
         position: fixed;
+        top: 0;
         width: 300px;
         height: 100%;
         background: #FFF;
-        z-index: 2;
+        z-index: 10;
         font-family: "Helvetica Neue", "Arial", sans-serif;
         overflow-x: hidden;
         border-right: 1px #ccc solid;
         line-height: 1;
     }
 
-    .panel_tree .results,
+    @media (max-width: 39.99em) {
+        .panel
+        {
+            transition: left 0s ease-in-out;
+            left: -100%;
+            width: 100%;
+            bottom: 0;
+            visibility: hidden;
+        }
+
+        .panel_checkbox:checked ~ .panel {
+            left: 0%;
+            transition: left 0.3s ease-in-out;
+            visibility: visible;
+        }
+
+        .panel_checkbox:checked ~ #bodyContent {
+            visibility: hidden;
+            display: none;
+        }
+    }
+
+    .panel_tree .result,
     .panel_results .tree
     {
         display: none;
@@ -27,11 +128,19 @@
             height: 40px;
             width: 300px;
             position: fixed;
+            position: sticky;
             left: 0; top: 0;
             z-index: 300;
             overflow-x: hidden;
         }
 
+        @media (max-width: 39.99em) {
+            .panel .header
+            {
+                width: 100%;
+            }
+        }
+
         .panel .header input
         {
             border: 0;
@@ -46,6 +155,15 @@
             outline: none;
         }
 
+        @media (max-width: 39.99em) {
+            .panel .header input
+            {
+                width: 70%;
+                width: calc(100% - 100px);
+                font-size: 16px;
+            }
+        }
+
     /* Header with search box (end) */
 
 
@@ -54,10 +172,10 @@
         {
             position: relative;
             bottom: 0;
-            top: 40px;
+            top: 0;
             left: 0;
             width: 100%;
-            overflow-y: scroll;
+            overflow-y: auto;
             overflow-x: hidden;
             z-index: 2;
         }
@@ -220,11 +338,10 @@
         {
             background: white;
             position: relative;
-            top: 40px;
             bottom: 0;
             left: 0;
             width: 100%;
-            overflow-y: scroll;
+            overflow-y: auto;
             overflow-x: hidden;
             z-index: 30;
         }

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

@@ -13,7 +13,6 @@ table, caption, tbody, tfoot, thead, tr, th, td {
 	margin: 0;
 	padding: 0;
 	border: 0;
-	outline: 0;
 	font-size: 100%;
 	vertical-align: baseline;
 	background: transparent;

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

@@ -27,6 +27,23 @@ document.addEventListener("turbolinks:load", function() {
   });
 });
 
+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);
+    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(JSON.parse($('meta[name="data-tree-keys"]').attr("content")));
+  }
+});
+
 // Keep scroll position for panel
 (function() {
   var scrollTop = 0;

data/lib/rdoc/generator/template/rails/resources/js/searchdoc.js

@@ -32,10 +32,6 @@ Searchdoc.Navigation = new function() {
             case 74: // j
             case 75: // k
             case 76: // l
-            case 67: // c - dvorak
-            case 72: // h
-            case 84: // t
-            case 78: // n
                 this.clearMoveTimeout();
                 break;
         }
@@ -43,15 +39,14 @@ Searchdoc.Navigation = new function() {
 
     this.onkeydown = function(e) {
         if (!this.navigationActive) return;
+
         switch (e.keyCode) {
             case 37: //Event.KEY_LEFT:
             case 74: // j (qwerty)
-            case 72: // h (dvorak)
                 if (this.moveLeft()) e.preventDefault();
                 break;
             case 38: //Event.KEY_UP:
             case 73: // i (qwerty)
-            case 67: // c (dvorak)
                 if (e.keyCode == 38 || e.ctrlKey) {
                     if (this.moveUp()) e.preventDefault();
                     this.startMoveTimeout(false);
@@ -59,28 +54,31 @@ Searchdoc.Navigation = new function() {
                 break;
             case 39: //Event.KEY_RIGHT:
             case 76: // l (qwerty)
-            case 78: // n (dvorak)
                 if (this.moveRight()) e.preventDefault();
                 break;
             case 40: //Event.KEY_DOWN:
             case 75: // k (qwerty)
-            case 84: // t (dvorak)
                 if (e.keyCode == 40 || e.ctrlKey) {
                     if (this.moveDown()) e.preventDefault();
                     this.startMoveTimeout(true);
                 }
                 break;
-            case 9: //Event.KEY_TAB:
             case 13: //Event.KEY_RETURN:
+                if(e.target.dataset["turbolinks"]) { break; }
                 if (this.$current) this.select(this.$current);
                 break;
-            case 83: // s (qwerty)
-            case 79: // o (dvorak)
+            case 83: // s (qwerty) - Focuses search
                 if (e.ctrlKey) {
                     $('#search').focus();
                     e.preventDefault();
                 }
                 break;
+            case 191: // / - Search by pressing "/"
+                if( !$('#search').is(":focus") ) {
+                    $('#search').focus();
+                    e.preventDefault();
+                }
+                break;
         }
         if (e.ctrlKey && e.shiftKey) this.select(this.$current);
     };
@@ -137,11 +135,10 @@ function scrollIntoView(element, view) {
 
 // panel.js -----------------------------------------------
 
-Searchdoc.Panel = function(element, data, tree, prefix) {
+Searchdoc.Panel = function(element, data, tree) {
     this.$element = $(element);
     this.$input = $('input', element).eq(0);
     this.$result = $('.result ul', element).eq(0);
-    this.prefix = prefix;
     this.$current = null;
     this.$view = this.$result.parent();
     this.data = data;
@@ -234,12 +231,13 @@ Searchdoc.Panel.prototype = $.extend({}, Searchdoc.Navigation, new function() {
     };
 
     this.open = function(src) {
-        Turbolinks.visit(this.prefix + src);
+        var prefix = $('meta[name="data-rel-prefix"]').attr("content");
+        Turbolinks.visit(prefix + src);
         if (this.highlight) this.highlight(src);
     };
 
     this.select = function() {
-        this.open(this.$current.data('path'));
+        this.open(this.$current.attr('data-path'));
     };
 
     this.move = function(isDown) {
@@ -268,7 +266,7 @@ Searchdoc.Panel.prototype = $.extend({}, Searchdoc.Navigation, new function() {
         html += hlt(result.namespace) + '</p>';
         if (result.snippet) html += '<p class="snippet">' + stripHTML(result.snippet) + '</p>';
         li.innerHTML = html;
-        jQuery.data(li, 'path', result.path);
+        $(li).attr('data-path', result.path)
         return li;
     }
 
@@ -481,4 +479,3 @@ Searchdoc.Tree.prototype = $.extend({}, Searchdoc.Navigation, new function() {
         return 5 + 18 * level + 'px';
     }
 });
-

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

@@ -1,5 +1,9 @@
-<html>
-    <head>File index</head>
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <title>File Index</title>
+    <meta name="viewport" content="width=device-width,initial-scale=1">
+</head>
     <body>
     <% @files.each do |file| %>
       <a href="../<%= file.path %>"><%= file.relative_name %></a>

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

@@ -195,12 +195,20 @@
                 else
                   false
                 end
+
+                ghost = method.instance_of?(RDoc::GhostMethod)
               %>
               <p class="source-link">
-                Source:
-                <a href="javascript:toggleSource('<%= method.aref %>_source')" id="l_<%= method.aref %>_source">show</a>
+                <% if !ghost || github %> Source: <% end %>
+
+                <% unless ghost %>
+                  <a href="javascript:toggleSource('<%= method.aref %>_source')" id="l_<%= method.aref %>_source">show</a>
+                <% end %>
+
+                <% if !ghost && github %> | <% end %>
+
                 <% if github %>
-                  | <a href="<%= "#{github}#L#{line}" %>" target="_blank" class="github_url">on GitHub</a>
+                  <a href="<%= "#{github}#L#{line}" %>" target="_blank" class="github_url">on GitHub</a>
                 <% end %>
               </p>
               <div id="<%= method.aref %>_source" class="dyn-source">

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

@@ -1,10 +1,9 @@
-<?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 klass.full_name %></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} %>
 
     <meta property="og:title" value="<%= klass.full_name %>">
@@ -45,8 +44,8 @@
             <% end  %>
         </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/sdoc/file.rhtml

@@ -1,10 +1,9 @@
-<?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 file.name %></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} %>
 </head>
 
@@ -22,8 +21,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/sdoc/index.rhtml

@@ -1,10 +1,9 @@
-<!DOCTYPE html
-     PUBLIC "-//W3C//DTD XHTML 1.0 Frameset//EN"
-     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-frameset.dtd">
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<!DOCTYPE html>
+<html lang="en">
 <head>
     <meta http-equiv="Content-Type" content="text/html; charset=<%= @options.charset %>" />
     <title><%= @options.title %></title>
+    <meta name="viewport" content="width=device-width,initial-scale=1">
 </head>
 <frameset cols="300,*" frameborder="1" border="1" bordercolor="#999999" framespacing="1">
     <frame src="panel/index.html" title="Search" name="panel" />

data/lib/rdoc/generator/template/sdoc/resources/css/reset.css

@@ -13,7 +13,6 @@ table, caption, tbody, tfoot, thead, tr, th, td {
 	margin: 0;
 	padding: 0;
 	border: 0;
-	outline: 0;
 	font-size: 100%;
 	vertical-align: baseline;
 	background: transparent;

data/lib/rdoc/generator/template/sdoc/resources/js/searchdoc.js

@@ -32,10 +32,6 @@ Searchdoc.Navigation = new function() {
             case 74: // j
             case 75: // k
             case 76: // l
-            case 67: // c - dvorak
-            case 72: // h
-            case 84: // t
-            case 78: // n
                 this.clearMoveTimeout();
                 break;
         }
@@ -46,12 +42,10 @@ Searchdoc.Navigation = new function() {
         switch (e.keyCode) {
             case 37: //Event.KEY_LEFT:
             case 74: // j (qwerty)
-            case 72: // h (dvorak)
                 if (this.moveLeft()) e.preventDefault();
                 break;
             case 38: //Event.KEY_UP:
             case 73: // i (qwerty)
-            case 67: // c (dvorak)
                 if (e.keyCode == 38 || e.ctrlKey) {
                     if (this.moveUp()) e.preventDefault();
                     this.startMoveTimeout(false);
@@ -59,23 +53,19 @@ Searchdoc.Navigation = new function() {
                 break;
             case 39: //Event.KEY_RIGHT:
             case 76: // l (qwerty)
-            case 78: // n (dvorak)
                 if (this.moveRight()) e.preventDefault();
                 break;
             case 40: //Event.KEY_DOWN:
             case 75: // k (qwerty)
-            case 84: // t (dvorak)
                 if (e.keyCode == 40 || e.ctrlKey) {
                     if (this.moveDown()) e.preventDefault();
                     this.startMoveTimeout(true);
                 }
                 break;
-            case 9: //Event.KEY_TAB:
             case 13: //Event.KEY_RETURN:
                 if (this.$current) this.select(this.$current);
                 break;
             case 83: // s (qwerty)
-            case 79: // o (dvorak)
                 if (e.ctrlKey) {
                     $('#search').focus();
                     e.preventDefault();

data/lib/rdoc/generator/template/sdoc/resources/panel/index.html

@@ -1,7 +1,8 @@
 <!DOCTYPE html>
 <html lang="en">
 <head>
-  <title>search index</title>
+  <title>Search Index</title>
+  <meta name="viewport" content="width=device-width,initial-scale=1">
   <link rel="stylesheet" href="../css/reset.css" type="text/css" media="screen" charset="utf-8" />
   <link rel="stylesheet" href="../css/panel.css" type="text/css" media="screen" charset="utf-8" />
   <script src="../js/search_index.js" type="text/javascript" charset="utf-8"></script>

data/lib/rdoc/generator/template/sdoc/search_index.rhtml

@@ -1,5 +1,9 @@
-<html>
-    <head>File index</head>
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <title>File Index</title>
+    <meta name="viewport" content="width=device-width,initial-scale=1">
+</head>
     <body>
     <% @files.each do |file| %>
       <a href="../<%= file.path %>"><%= file.relative_name %></a>

data/lib/sdoc/generator.rb

@@ -118,7 +118,7 @@ class RDoc::Generator::SDoc
     debug_msg "Generating index file in #@outputdir"
     templatefile = @template_dir + 'index.rhtml'
     outfile      = @outputdir + 'index.html'
-    rel_prefix  = @outputdir.relative_path_from( outfile.dirname )
+    rel_prefix = rel_prefix  = @outputdir.relative_path_from( outfile.dirname )
 
     self.render_template( templatefile, binding(), outfile ) unless @options.dry_run
   end
@@ -131,7 +131,7 @@ class RDoc::Generator::SDoc
     @classes.each do |klass|
       debug_msg "  working on %s (%s)" % [ klass.full_name, klass.path ]
       outfile     = @outputdir + klass.path
-      rel_prefix  = @outputdir.relative_path_from( outfile.dirname )
+      rel_prefix = rel_prefix  = @outputdir.relative_path_from( outfile.dirname )
 
       debug_msg "  rendering #{outfile}"
       self.render_template( templatefile, binding(), outfile ) unless @options.dry_run
@@ -146,7 +146,7 @@ class RDoc::Generator::SDoc
     @files.each do |file|
       outfile     = @outputdir + file.path
       debug_msg "  working on %s (%s)" % [ file.full_name, outfile ]
-      rel_prefix  = @outputdir.relative_path_from( outfile.dirname )
+      rel_prefix = rel_prefix  = @outputdir.relative_path_from( outfile.dirname )
 
       debug_msg "  rendering #{outfile}"
       self.render_template( templatefile, binding(), outfile ) unless @options.dry_run

data/lib/sdoc/merge.rb

@@ -3,11 +3,7 @@ require 'pathname'
 require 'fileutils'
 require 'json'
 
-require 'sdoc/templatable'
-
 class SDoc::Merge
-  include SDoc::Templatable
-
   FLAG_FILE = "created.rid"
 
   def initialize()
@@ -20,9 +16,6 @@ class SDoc::Merge
 
   def merge(options)
     parse_options options
-
-    @outputdir = Pathname.new( @op_dir )
-
     check_directories
     setup_output_dir
     setup_names
@@ -30,7 +23,7 @@ class SDoc::Merge
     copy_docs if @urls.empty?
     merge_search_index
     merge_tree
-    generate_index_file
+    copy_index_file
   end
 
   def parse_options(options)
@@ -56,7 +49,6 @@ class SDoc::Merge
       end
     end
     opts.parse! options
-    @template_dir = Pathname.new(RDoc::Options.new.template_dir_for 'merge')
     @directories = options.dup
   end
 
@@ -70,7 +62,7 @@ class SDoc::Merge
       subtree = JSON.parse(data, :max_nesting => 0)
       item = [
         name,
-        url + '/' + extract_index_path(dir),
+        url + '/index.html',
         '',
         append_path(subtree, url)
       ]
@@ -137,24 +129,8 @@ class SDoc::Merge
     end
   end
 
-  def extract_index_path dir
-    filename = File.join dir, 'index.html'
-    content = File.open(filename) { |f| f.read }
-    match = content.match(/<frame\s+src="([^"]+)"\s+name="docwin"/mi)
-    if match
-      match[1]
-    else
-      ''
-    end
-  end
-
-  def generate_index_file
-    templatefile = @template_dir + 'index.rhtml'
-    outfile      = @outputdir + 'index.html'
-    url          = @urls.empty? ? @names[0] : @urls[0]
-    index_path   = url + '/' + extract_index_path(@directories[0])
-
-    render_template templatefile, binding(), outfile
+  def copy_index_file
+    FileUtils.cp File.join(@directories[0], 'index.html'), @op_dir
   end
 
   def setup_names
@@ -178,6 +154,7 @@ class SDoc::Merge
           FileUtils.cp_r File.join(dir, item), File.join(@op_dir, name, item), :preserve => true
         end
       end
+      FileUtils.cp File.join(dir, 'index.html'), File.join(@op_dir, name)
     end
   end
 

data/lib/sdoc/templatable.rb

@@ -28,7 +28,7 @@ module SDoc::Templatable
   ### current context. Adds all +local_assigns+ to context
   def include_template(template_name, local_assigns = {})
     source = local_assigns.keys.map { |key| "#{key} = local_assigns[:#{key}];" }.join
-    templatefile = @template_dir + template_name
+    templatefile = templatefile = @template_dir + template_name
     eval("#{source};eval_template(templatefile, binding)")
   end
 

data/lib/sdoc/version.rb

@@ -1,3 +1,3 @@
 module SDoc
-  VERSION = '2.0.3'
+  VERSION = '2.3.0'
 end

data/netlify.toml

@@ -0,0 +1,39 @@
+[build]
+  command = "rake install && sdoc -o doc/public -T rails -f sdoc"
+  publish = "doc/public"
+
+[build.processing]
+  skip_processing = false
+[build.processing.css]
+  bundle = true
+  minify = true
+[build.processing.js]
+  bundle = true
+  minify = true
+[build.processing.html]
+  pretty_urls = true
+[build.processing.images]
+  compress = true
+
+[[headers]]
+  for = "*"
+  [headers.values]
+    X-Frame-Options = "DENY"
+    X-XSS-Protection = "1; mode=block"
+    X-Content-Type-Options = "nosniff"
+    Content-Security-Policy = '''
+      object-src  'none';
+      worker-src  'none';
+      block-all-mixed-content;
+      upgrade-insecure-requests;'''
+    Strict-Transport-Security = "max-age=15552000; includeSubDomains"
+    Referrer-Policy = "no-referrer-when-downgrade"
+    Cache-Control = "public, max-age=604800, s-max-age=604800"
+
+[[headers]]
+  for = "/"
+
+[[headers]]
+  for = "/*.(png|jpg|js|css|svg|woff|ttf|eot|ico|woff2)"
+  [headers.values]
+    Cache-Control = "public, max-age=31536000, s-max-age=31536000"