rdoc-babel 1.0.0 → 1.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 2f7ec88ffbcd36a682da0814c2f89b107448be7e
-  data.tar.gz: 77ca385dee05d1d29333c848954e4c2049876403
+SHA256:
+  metadata.gz: 0f3a9a864631f9ecf3f446e3297fe4a9c17d171e921f127bdd9a410c650daad5
+  data.tar.gz: 2f6046c1008775bf41816b7ddba1af7b5213431a2934e41d750345c30c0b25e9
 SHA512:
-  metadata.gz: ec85494b8e8c08baae241cf95072ab0efbadd7746a52caacbb7db4880a486e75d73859131ef5065b53cd6f90f09ff378a58cd7daad94a2cc46dfc11d108c6b6c
-  data.tar.gz: d041bee6d46b9721f7aaba7d1d71e2b13dffc6896bbb9bbcd47363142fa05f2e1dfd608b7c6ecf9b1767f4154dc9bdadf6ffe502050de4e7ffe79e2dedeb565c
+  metadata.gz: 8ac3b681e7d3b44bb9cbc078002c33c657a50617dfa7aeee6e027d6d610137987559c8b9047496df6d1233f2fae8ec2d88832b8ff8fea0ee171e704bd59294e7
+  data.tar.gz: 9f96ce72a6ec9b4660c077b4bf199b0210ef11d4acf7c88be26280b1315abca64576da24a88ce25b6eebdb5928b6e7e6817658c13037e37cb459a7e5ba9943f0

data/HISTORY.rdoc

@@ -1,12 +1,35 @@
 
-=== 0.9.0 / 2010-10-02
+=== 1.0.5 / 2020-06-01
 
-Initial version, developed along with {RDoc}[http://github.com/rdoc/rdoc] 3.0.
+* Fix warning with Ruby 2.7
+* Tune CSS for definition lists
 
-=== 0.9.1 / 2011-07-16
+=== 1.0.4 / 2019-08-02
 
-First public release.
+Fix for latest ERB syntax.
+
+=== 1.0.3 / 2019-07-29
+
+Compatibility with RDoc 6.
+
+=== 1.0.2 / 2017-02-25
+
+Fix for compatibility with RDoc 5 dupping the options.
+
+=== 1.0.1 / 2015-06-29
+
+* Fix rendering of Markdown files
+* Fix CSS file (code instead of tt)
 
 === 1.0.0 / 2014-07-20
 
 Make it compatible with RDoc 4.1 and its bugs.
+
+=== 0.9.1 / 2011-07-16
+
+First public release.
+
+=== 0.9.0 / 2010-10-02
+
+Initial version, developed along with {RDoc}[http://github.com/rdoc/rdoc] 3.0.
+

data/README.rdoc

@@ -70,8 +70,8 @@ Babel supports specific options in addition to the standard RDoc options:
 
 == Requirements
 
-- Ruby >= 1.8.7
-- RDoc >= 3.0
+- Ruby >= 2.3.0 (may work with >= 1.9.3, but untested)
+- RDoc >= 5.0 (may work with >= 4.0, but untested)
 
 == Installation
 
@@ -81,7 +81,7 @@ Babel supports specific options in addition to the standard RDoc options:
 
 (The MIT License)
 
-Copyright (c) 2010 Thierry Lambert
+Copyright (c) 2010-2020 Thierry Lambert
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/Rakefile

@@ -1,33 +1,11 @@
-require 'hoe'
-
-Hoe.spec 'rdoc-babel' do
-
-  developer 'Thierry Lambert', 'thyresias@gmail.com'
-  license 'MIT'
-
-  self.summary = "An RDoc formatter producing HTML documentation."
-  self.description = paragraphs_of('README.rdoc', 3, 6).join("\n\n")
-
-  self.readme_file = 'README.rdoc'
-  self.history_file = 'HISTORY.rdoc'
-  self.extra_rdoc_files = ['README.rdoc', 'HISTORY.rdoc']
-
-  self.remote_rdoc_dir = ''
-  self.testlib = :minitest
-  # self.test_prelude = %(gem "minitest")
-
-  self.extra_deps << ['rdoc', '~> 4.1']
-
-  self.extra_dev_deps << ['minitest', '~> 5.4']
-  self.extra_dev_deps << ['nokogiri', '~> 1.6']
-
-  spec_extras[:homepage] = 'http://github.com/thyresias/rdoc-babel'
-  spec_extras[:rdoc_options] = %w(--main README.rdoc)
+require "rake/testtask"
 
+Rake::TestTask.new do |t|
+  t.test_files = FileList['test/test*.rb']
 end
 
-task :file_list do
-  puts Dir['*'].reject { |f| File.directory? f }
-  puts Dir['lib/**/*'].reject { |f| File.directory? f }
-  puts Dir['test/**/*'].reject { |f| File.directory? f }
+desc 'build & install gem'
+task 'gem' do
+  system 'gem build rdoc-babel.gemspec'
+  system 'gem install rdoc-babel --local'
 end

data/lib/rdoc/generator/babel.rb

@@ -73,7 +73,8 @@ class RDoc::Generator::Babel
         :see_standard_ancestors => false,
       }
 
-      rdoc_options.extend Options
+      rdoc_options.extend Options  # extend the existing object
+      rdoc_options.class.include Options  # make sure #babel_options will be there on #dup'ed objects
       rdoc_options.babel_options = options
 
       opt = rdoc_options.option_parser
@@ -131,7 +132,7 @@ class RDoc::Generator::Babel
     @options = options
     @babel_options = options.babel_options
     @see_standard_ancestors = @babel_options[:see_standard_ancestors]
-    RDoc::AnyMethod.add_line_numbers = options.line_numbers
+    RDoc::AnyMethod.add_line_numbers = options.line_numbers if RDoc::AnyMethod.respond_to? :add_line_numbers
     @options.template = 'ruby-lang' if @options.template == 'babel' # TODO leave template nil
     @template_dir = TEMPLATE_ROOT + @options.template
     @template_dir.directory? or raise RDoc::Error, "template not found: '#@template_dir'"
@@ -211,7 +212,7 @@ class RDoc::Generator::Babel
       if source_path.directory?
         out_path.mkpath unless @options.dry_run
       else
-        FileUtils.cp source_path.to_s, out_path.dirname.to_s, options
+        FileUtils.cp source_path.to_s, out_path.dirname.to_s, **options
       end
     end
   end
@@ -369,7 +370,7 @@ protected
     @stylesheet_url = @babel_options[:stylesheet_url] || (@rel_prefix + 'rdoc.css').to_s
 
     template_src = template_file.read
-    template = ERB.new(template_src, nil, '><')
+    template = ERB.new(template_src, trim_mode: '<>')
     template.filename = template_file.to_s
 
     output = nil

data/lib/rdoc/generator/ruby-lang/file-page.html.erb

@@ -18,7 +18,7 @@
   </p>
 </div>
 <div id="documentation">
-<% if @file.parser == RDoc::Parser::Simple %>
+<% if @file.parser == RDoc::Parser::Simple || @file.parser == RDoc::Parser::Markdown %>
   <%= @file.description %>
 <% else %>
   <% unless @file.comment.empty? %>

data/lib/rdoc/generator/ruby-lang/rdoc.css

@@ -24,16 +24,30 @@ td {
 }
 
 ul { margin-left: 1.5em; }
-ol { margin-left: 2em; }
 li { margin-top: 0.5ex; }
+
+ol { margin-left: 2em; }
 ol li { margin-top: 1em; }
 
-dt {
+/* label lists: classic DT/DD */
+
+.label-list dt {
   margin-top: 1ex;
   font-weight: bold;
 }
-dt tt { font-size: 100%; }
-dd { margin-left: 2em; }
+.label-list dt code { font-size: 100%; }
+.label-list dd { margin-left: 2em; }
+
+/* note lists: DT and DD on same row, no space between rows */
+
+dl.note-list {
+  display: grid;
+  grid-template-columns: max-content auto;
+  margin-left: 1ex;
+}
+dl.note-list dt { grid-column-start: 1; }
+dl.note-list dd { grid-column-start: 2; }
+dl.note-list dd p { margin-top: 0; margin-left: 1ex; }
 
 table {
   border-collapse: collapse;
@@ -196,7 +210,11 @@ h4, h5, h6 {
   border: none;
 }
 
-tt {
+h4 {
+  font-weight: bold;
+}
+
+code {
   font-family: Monaco, Consolas, "Lucida Console", monospace;
   font-size: 100%;
 }

data/lib/rdoc_babel.rb

@@ -1,3 +1,3 @@
 module RDocBabel
-  VERSION = '1.0.0'
+  VERSION = '1.0.5'
 end

data/test/test_rdoc_generator_babel.rb

@@ -1,5 +1,4 @@
 require 'rdoc'
-require 'rdoc/generator/babel'
 require 'minitest/autorun'
 require 'tmpdir'
 require 'nokogiri'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rdoc-babel
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.5
 platform: ruby
 authors:
 - Thierry Lambert
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-21 00:00:00.000000000 Z
+date: 2020-06-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rdoc
@@ -16,81 +16,59 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.1'
+        version: '6.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.1'
+        version: '6.2'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.4'
+        version: '5.14'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.4'
+        version: '5.14'
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '1.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
-- !ruby/object:Gem::Dependency
-  name: hoe
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.12'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.12'
-description: |-
+        version: '1.10'
+description: |
   Babel is an RDoc formatter producing HTML documentation.
-  The default template is +ruby-lang+.
-
-  - Look and feel inspired from ruby-lang.org[http://www.ruby-lang.org/].
+  The default template is +ruby-lang+:
+  - Look and feel inspired from https://www.ruby-lang.org/.
   - Dual-frame output, with indexes on the left.
   - Search boxes for classes and methods.
   - Links to undocumented classes/methods are grayed.
   - Highlights target methods, attributes and constants.
   - Adds links to ancestor methods/attributes.
-  - Borrows some ideas (and one icon) from Darkfish.
-  - Tested on Firefox 3.5 & 5, Chrome 9 & 12, Safari 4 & 5.
-email:
-- thyresias@gmail.com
+email: thyresias@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files:
-- HISTORY.rdoc
-- Manifest.txt
 - README.rdoc
+- HISTORY.rdoc
 files:
-- ".autotest"
-- ".gemtest"
 - HISTORY.rdoc
-- Manifest.txt
 - README.rdoc
 - Rakefile
 - lib/rdoc/discover.rb
@@ -116,12 +94,14 @@ files:
 - test/data/no_content.rb
 - test/data/not_commented.rb
 - test/test_rdoc_generator_babel.rb
-homepage: http://github.com/thyresias/rdoc-babel
+homepage: https://github.com/thyresias/rdoc-babel
 licenses:
 - MIT
 metadata: {}
 post_install_message: 
 rdoc_options:
+- "--title"
+- RDoc Babel
 - "--main"
 - README.rdoc
 require_paths:
@@ -137,10 +117,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.1
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: An RDoc formatter producing HTML documentation.
-test_files:
-- test/test_rdoc_generator_babel.rb
+test_files: []

data/.autotest

@@ -1,12 +0,0 @@
-require 'autotest/restart'
-
-Autotest.add_hook :initialize do |at|
-  at.testlib = 'minitest/unit'
-  class << at
-    alias zen_path_to_classname path_to_classname
-    def path_to_classname(s)
-      zen_path_to_classname(s).sub('Rdoc', 'RDoc')
-    end
-  end
-end
-

data/Manifest.txt

@@ -1,28 +0,0 @@
-.autotest
-HISTORY.rdoc
-Manifest.txt
-Rakefile
-README.rdoc
-lib/rdoc/discover.rb
-lib/rdoc/generator/babel.rb
-lib/rdoc/generator/ruby-lang/class-page.html.erb
-lib/rdoc/generator/ruby-lang/file-page.html.erb
-lib/rdoc/generator/ruby-lang/images/zoom.png
-lib/rdoc/generator/ruby-lang/index.html.erb
-lib/rdoc/generator/ruby-lang/indexes.html.erb
-lib/rdoc/generator/ruby-lang/rdoc.css
-lib/rdoc/generator/ruby-lang/scripts/indexFrame.js
-lib/rdoc/generator/ruby-lang/scripts/jquery.js
-lib/rdoc/generator/ruby-lang/scripts/jquery.quicksearch.js
-lib/rdoc/generator/ruby-lang/scripts/mainFrame.js
-lib/rdoc_babel.rb
-test/data/ancestors.rb
-test/data/commented.rb
-test/data/context_alias.rb
-test/data/HISTORY.rdoc
-test/data/main_file.rb
-test/data/not_commented.rb
-test/data/no_class_nor_module.rb
-test/data/no_content.rb
-test/data/README.rdoc
-test/test_rdoc_generator_babel.rb