sdoc 2.1.0 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2501b7ecbe5f0166265183e512bea38f69a47e7fdf350346307b2b1d06ac208c
-  data.tar.gz: b45da3c5d1044c713b3972888a69b58e318e616bbb0285db327621470b203f5e
+  metadata.gz: 002ca37375a4f9d51c68f2c7ac421cec8c4baf74171615627e828fbf8947bc48
+  data.tar.gz: 06f44cb76f359c63d97a0b9e5c0eb5c5b06277c700928006e2e390c05955eb17
 SHA512:
-  metadata.gz: b960da6795d44598a71048843a15eda6d115fe67bf44c4251aec6496a17674b4f47095978868d09dc35fd2dca81289f36d6b65a7de5eb574c3e228d53b0156cf
-  data.tar.gz: 4df53cf2db5874f971f343c2ccea52b59a0341cd15153a9580608800bfa10dc65e114377496bd439ea0955ece61835c9b1de980006ef87507be313c70bd4b445
+  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,3 +1,18 @@
+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
 =====
 
@@ -91,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,15 +92,25 @@ 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

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

@@ -5,7 +5,7 @@
 #
 require 'bundler/setup'
 
-root = "doc/rails"
+root = "doc/public"
 unless Dir.exists?(root)
   puts <<~MESSAGE
     Could not find any docs in #{root}.
@@ -16,12 +16,12 @@ unless Dir.exists?(root)
 end
 
 use Rack::Static,
-  :urls => ["/files", "/images", "/js", "/css", "/panel", "/i", "/classes"],
+  :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'
     },

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,8 +1,8 @@
 <input type="checkbox" id="hamburger" class="panel_checkbox">
 <label class="panel_mobile_button" for="hamburger"><span></span> Menu</label>
-<div class="panel panel_tree" id="panel" data-turbolinks-permanent>
+<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" tabindex="-1" />
+    <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">
@@ -14,4 +14,4 @@
     </ul>
   </div>
   <a href="links.html" id="links">index</a>
-</div>
+</nav>

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

@@ -18,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' %>
 
@@ -45,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

@@ -8,6 +8,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' %>
 
@@ -32,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

@@ -8,6 +8,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,9 +26,8 @@
         </ul>
     </div>
 
-    <div id="bodyContent">
+    <main id="bodyContent">
         <%= include_template '_context.rhtml', {:context => index } %>
-    </div>
+    </main>
   </body>
 </html>
-

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

@@ -31,10 +31,6 @@ h1 a, h2 a, .banner a {
   color: #fff;
 }
 
-h1 a:hover, h2 a:hover {
-  color: #fff;
-}
-
 p {
   margin-bottom: 1em;
   text-align: justify;
@@ -378,3 +374,32 @@ p code {
   margin-bottom: 1px;
   padding: 0 5px;
 }
+
+.sr-only {
+  position: absolute;
+  width: 1px;
+  height: 1px;
+  padding: 0;
+  overflow: hidden;
+  clip: rect(0,0,0,0);
+  white-space: nowrap;
+  border: 0;
+}
+.sr-only-focusable:active,
+.sr-only-focusable:focus {
+  position: fixed;
+  top: 10%;
+  width: auto;
+  height: auto;
+  overflow: visible;
+  clip: auto;
+  white-space: normal;
+  padding: 2rem;
+  border: 4px solid #990000;
+  border-radius: 1rem;
+  box-shadow: 0 0.5rem 1rem rgb(0 0 0 / 15%) !important;
+  left: 40%;
+  z-index: 100;
+  background: #fff;
+  font-size: 2rem;
+}

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

@@ -98,7 +98,7 @@
             left: -100%;
             width: 100%;
             bottom: 0;
-            visibility: hidden; 
+            visibility: hidden;
         }
 
         .panel_checkbox:checked ~ .panel {
@@ -113,7 +113,7 @@
         }
     }
 
-    .panel_tree .results,
+    .panel_tree .result,
     .panel_results .tree
     {
         display: none;

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, $('meta[name="data-rel-prefix"]').attr("content"));
+    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);
     };
@@ -481,4 +479,3 @@ Searchdoc.Tree.prototype = $.extend({}, Searchdoc.Navigation, new function() {
         return 5 + 18 * level + 'px';
     }
 });
-

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

@@ -44,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

@@ -21,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/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/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/version.rb

@@ -1,3 +1,3 @@
 module SDoc
-  VERSION = '2.1.0'
+  VERSION = '2.2.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"

data/spec/helpers_spec.rb

@@ -19,14 +19,14 @@ describe SDoc::Helpers do
       ]
 
       strings.each do |(html, stripped)|
-        @helpers.strip_tags(html).must_equal stripped
+        _(@helpers.strip_tags(html)).must_equal stripped
       end
     end
   end
 
   describe "#truncate" do
     it "should truncate the given text around a given length" do
-      @helpers.truncate("Hello world", length: 5).must_equal "Hello."
+      _(@helpers.truncate("Hello world", length: 5)).must_equal "Hello."
     end
   end
 end

data/spec/rdoc_generator_spec.rb

@@ -8,12 +8,12 @@ describe RDoc::Generator::SDoc do
   end
 
   it "should find sdoc generator" do
-    RDoc::RDoc::GENERATORS.must_include 'sdoc'
+    _(RDoc::RDoc::GENERATORS).must_include 'sdoc'
   end
 
   it "should use sdoc generator" do
-    @options.generator.must_equal RDoc::Generator::SDoc
-    @options.generator_name.must_equal 'sdoc'
+    _(@options.generator).must_equal RDoc::Generator::SDoc
+    _(@options.generator_name).must_equal 'sdoc'
   end
 
   it "should parse github option" do
@@ -23,8 +23,8 @@ describe RDoc::Generator::SDoc do
       @parser.parse %w[--github]
     end
 
-    err.wont_match(/^invalid options/)
-    @options.github.must_equal true
+    _(err).wont_match(/^invalid options/)
+    _(@options.github).must_equal true
   end
 
   it "should parse github short-hand option" do
@@ -34,15 +34,15 @@ describe RDoc::Generator::SDoc do
       @parser.parse %w[-g]
     end
 
-    err.wont_match(/^invalid options/)
-    @options.github.must_equal true
+    _(err).wont_match(/^invalid options/)
+    _(@options.github).must_equal true
   end
 
   it "should display SDoc version on -v or --version" do
     out_full  = `./bin/sdoc --version`
     out_short = `./bin/sdoc -v`
 
-    out_short.strip.must_equal SDoc::VERSION
-    out_full.strip.must_equal SDoc::VERSION
+    _(out_short.strip).must_equal SDoc::VERSION
+    _(out_full.strip).must_equal SDoc::VERSION
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sdoc
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.2.0
 platform: ruby
 authors:
 - Vladimir Kolesnikov
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-03-31 00:00:00.000000000 Z
+date: 2021-05-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rdoc
@@ -50,8 +50,8 @@ extensions: []
 extra_rdoc_files:
 - README.md
 files:
+- ".github/workflows/test.yml"
 - ".gitignore"
-- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - LICENSE
@@ -61,7 +61,6 @@ files:
 - bin/sdoc-merge
 - config.ru
 - lib/rdoc/discover.rb
-- lib/rdoc/generator/template/merge/index.rhtml
 - lib/rdoc/generator/template/rails/_context.rhtml
 - lib/rdoc/generator/template/rails/_head.rhtml
 - lib/rdoc/generator/template/rails/_panel.rhtml
@@ -113,6 +112,7 @@ files:
 - lib/sdoc/merge.rb
 - lib/sdoc/templatable.rb
 - lib/sdoc/version.rb
+- netlify.toml
 - sdoc.gemspec
 - spec/helpers_spec.rb
 - spec/rdoc_generator_spec.rb

data/.travis.yml

@@ -1,31 +0,0 @@
-language: ruby
-cache: bundler
-before_install:
-  - 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.10
-  - 2.3.7
-  - 2.4.4
-  - 2.5.1
-  - 2.6.0
-  - ruby-head
-  - jruby-head
-matrix:
-  allow_failures:
-    - env: rdoc=master
-    - rvm: jruby-head
-  include:
-    - { 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:
-  email:
-    - mail@zzak.io

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

@@ -1,12 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
-<head>
-  <meta charset="utf-8">
-  <title><%= @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" />
-    <frame src="<%= index_path %>" name="docwin" />
-</frameset>
-</html>