sdoc 2.2.0 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 002ca37375a4f9d51c68f2c7ac421cec8c4baf74171615627e828fbf8947bc48
-  data.tar.gz: 06f44cb76f359c63d97a0b9e5c0eb5c5b06277c700928006e2e390c05955eb17
+  metadata.gz: 70eb2edc18b9ea26f3e275f9e7cbe89b1ce69af8c94fe4e0757ade7d39585d65
+  data.tar.gz: 9358e5e14fc3e26fd5c39f9ff348c4e5ee0cf569921256de2234006b5055ff68
 SHA512:
-  metadata.gz: b48d64b1e6c87db2088e56c692ed31c8f85fef24e640b18a5c4f609966f7d0b912d78a2e2a973bfffc2bbbecf1ffb3bfb5f16adeecc69780f3e7286850a8f92a
-  data.tar.gz: 9e59249e7ea77c4057c1a741e9d4dd6c6fe058ba63fe976d88e20806520d7ce8b219aa5b04acc0943b8f91b0abfb11d97e9fb2d28360381cf893a5c7f8ec3b7f
+  metadata.gz: d001cb3198db3cdd7db808a56d7c06325d126a73b93de6240e1826abc6a0b7ad7743b21b67e289289ed35346192164e44900702191def749a5c22ec833f39569
+  data.tar.gz: 731ad61d0e0ac791e02050d173cc97eab604634c3e9252ed691d2714142b97c0e7f19a30fa9eddda56516fc2e3f46f7d393f0c36d3a3aaad49c28dddcbbca14c

data/.github/workflows/test.yml

@@ -31,6 +31,7 @@ jobs:
         with:
           ruby-version: ${{ matrix.ruby }}
           bundler-cache: true
+          cache-version: 1
 
       - name: Test
         run: |

data/CHANGELOG.md

@@ -1,6 +1,15 @@
 Master
 ======
 
+2.3.0
+=====
+
+* #178 Don't use rdoc 6.4.0 for now [@p8](https://github.com/p8)
+* #177 Remove rake version constraint for ruby head [@p8](https://github.com/p8)
+* #176 Make sidepanel work with relative paths/URLs [@p8](https://github.com/p8)
+* #175 Avoid displaying source toggler for ghost methods [Robin Dupret](https://github.com/robin850)
+* #174 Suppress unused variable warnings [Masataka Pocke Kuwabara](https://github.com/pocke)
+
 2.2.0
 =====
 

data/Gemfile

@@ -2,9 +2,15 @@ source "https://rubygems.org"
 
 gemspec
 
-gem "rake", "< 11"
-gem "minitest"
+gem "rack"
+gem "rake"
 gem "hoe"
+gem "minitest"
+
+
+if RUBY_VERSION.to_f <= 2.5
+  gem "psych", "< 4.0"
+end
 
 if ENV["rdoc"] == "master"
   gem "rdoc", :github => "ruby/rdoc"

data/lib/rdoc/generator/template/rails/_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/rails/_head.rhtml

@@ -1,22 +1,14 @@
-<%
-  # 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>
-
+<link rel="stylesheet" href="<%= rel_prefix %>/css/reset.css" type="text/css" media="screen" />
+<link rel="stylesheet" href="<%= rel_prefix %>/css/panel.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-3.5.1.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>
+<script src="<%= rel_prefix %>/js/turbolinks.js" type="text/javascript" charset="utf-8"></script>
+<script src="<%= rel_prefix %>/js/search_index.js" type="text/javascript" charset="utf-8"></script>
+<script src="<%= rel_prefix %>/js/searcher.js" type="text/javascript" charset="utf-8"></script>
+<script src="<%= rel_prefix %>/panel/tree.js" type="text/javascript" charset="utf-8"></script>
+<script src="<%= rel_prefix %>/js/searchdoc.js" type="text/javascript" charset="utf-8"></script>
 <meta name="data-rel-prefix" content="<%= rel_prefix %>/">
 <meta name="data-tree-keys" content='<%= tree_keys %>'>

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

@@ -31,7 +31,7 @@ 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 panel = new Searchdoc.Panel($('#panel'), search_data, tree);
     var s = window.location.search.match(/\?q=([^&]+)/);
     if (s) {
       s = decodeURIComponent(s[1]).replace(/\+/g, ' ');

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

@@ -135,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;
@@ -232,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) {
@@ -266,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;
     }
 

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/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/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.2.0'
+  VERSION = '2.3.0'
 end

data/sdoc.gemspec

@@ -22,9 +22,7 @@ Gem::Specification.new do |s|
   s.rdoc_options = ["--charset=UTF-8"]
   s.extra_rdoc_files = ["README.md"]
 
-  s.add_runtime_dependency("rdoc", ">= 5.0")
-
-  s.add_development_dependency("rack")
+  s.add_runtime_dependency("rdoc", ">= 5.0", "< 6.4.0")
 
   s.files         = `git ls-files`.split("\n")
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }

metadata

@@ -1,17 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: sdoc
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 2.3.0
 platform: ruby
 authors:
 - Vladimir Kolesnikov
 - Nathan Broadbent
 - Jean Mertz
 - Zachary Scott
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-05-21 00:00:00.000000000 Z
+date: 2022-01-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rdoc
@@ -20,6 +20,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '5.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 6.4.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -27,20 +30,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '5.0'
-- !ruby/object:Gem::Dependency
-  name: rack
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 6.4.0
 description: rdoc generator html with javascript search index.
 email: voloko@gmail.com mail@zzak.io
 executables:
@@ -121,7 +113,7 @@ homepage: https://github.com/zzak/sdoc
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options:
 - "--charset=UTF-8"
 require_paths:
@@ -137,8 +129,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 1.3.6
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.1.6
+signing_key:
 specification_version: 4
 summary: rdoc html with javascript search index.
 test_files: []