ronn-ng 0.8.1 → 0.10.1.pre1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '078c363c172599ee081ef5ccd7418db877361bc403fbc534aa3154bba06e71c6'
-  data.tar.gz: 69cd991067704f87ddb02c335c5c6538073c7117b44ca5f0ae798d257f8e980c
+  metadata.gz: 717e3056a1751d795f7584cdc1024e2b3f391ab1fad7a415f92384e2c09466fb
+  data.tar.gz: 6bfc3273ec1218c858248fe7783db4280f7bee0330b2deaf1673210ad1c0b1a0
 SHA512:
-  metadata.gz: 7b07f6839425415fef229d2198274f72ebf194bf6dde8690f9940d49006f6ddb5c3f7332cf35f567b85c993d40d63127801f5ff0e3c2f1ea611b2b969d3f17de
-  data.tar.gz: 914e3c27b9fc4c95b066d130ea87b6f5f6eb84f7cd5dcce5cad86a5dc080a24cb7e69d1f0c5556d204c6f2a5a52f3358d81649ebdcc9c72481dca6611c2b97e8
+  metadata.gz: afaf5a115cf75430f54f4699d2cc693172c358c5e2d8d4e86517bed361e5950066a0a923579b1e2aa660fdcedc317f565382e32adf109b51e3531e5e2af7d414
+  data.tar.gz: 20a63fce583758ce3ec9330a7550e451a735402997fe71f9d59fb90ce51bd2b7c8d7a94310d872173232d3012187a2423606f0daf689215e65fa61d1c99d6398

data/CHANGES

@@ -1,11 +1,40 @@
 Ronn-NG CHANGES
 ===============
 
+Version 0.10.1 (in progress)
+----------------------------
+
+* Switch to GitHub Flavored Markdown, fixing code block rendering (<https://github.com/apjanke/ronn-ng/pull/53>)
+* Revert `\[ci]` back to `\(bu)` (<https://github.com/apjanke/ronn-ng/pull/51>)
+* Minor fix to single-quote escaping (<https://github.com/apjanke/ronn-ng/issues/55>)
+* Elide HTML comments when producing roff output (<https://github.com/apjanke/ronn-ng/issues/65>)
+* Bump to mustache 1.x
+
+Version 0.10.0 (never)
+---------------------------
+* Doesn't exist due to a RubyGems publishing mistake
+
+Version 0.9.1 (2020 Apr 09)
+---------------------------
+
+* Fix underlining issue (<https://github.com/apjanke/ronn-ng/pull/41>)
+
+Version 0.9.0 (2019 Dec 21)
+---------------------------
+
+* Migrate to kramdown for the underlying Markdown library
+* Minor output formatting and documentation improvements
+
+Version 0.8.2 (2019 Mar 5)
+--------------------------
+
+* Fixes packaging error in 0.8.1
+
 Version 0.8.1 (2019 Mar 5)
--------------------
+--------------------------
 
-* Fixed URL hyphenation bug. (https://github.com/apjanke/ronn-ng/issues/23) (apjanke)
-* Fixed ordered-list bustication. (https://github.com/apjanke/ronn-ng/issues/24) (apjanke)
+* Fixed URL hyphenation bug. (<https://github.com/apjanke/ronn-ng/issues/23>) (apjanke)
+* Fixed ordered-list bustication. (<https://github.com/apjanke/ronn-ng/issues/24>) (apjanke)
 
 Version 0.8.0 (2018 Dec 25)
 ---------------------------

data/Gemfile.lock

@@ -0,0 +1,70 @@
+PATH
+  remote: .
+  specs:
+    ronn-ng (0.10.1.pre1)
+      kramdown (~> 2.1)
+      kramdown-parser-gfm (~> 1.0.1)
+      mustache (~> 1.0)
+      nokogiri (~> 1.9, >= 1.9.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.1)
+    kramdown (2.3.0)
+      rexml
+    kramdown-parser-gfm (1.0.1)
+      kramdown (~> 2.0)
+    mini_portile2 (2.4.0)
+    mustache (1.1.1)
+    mustermann (1.1.1)
+      ruby2_keywords (~> 0.0.1)
+    nokogiri (1.10.10)
+      mini_portile2 (~> 2.4.0)
+    parallel (1.20.1)
+    parser (2.7.2.0)
+      ast (~> 2.4.1)
+    power_assert (1.2.0)
+    rack (2.2.3)
+    rack-protection (2.1.0)
+      rack
+    rainbow (3.0.0)
+    rake (12.3.3)
+    regexp_parser (2.0.1)
+    rexml (3.2.4)
+    rubocop (0.93.1)
+      parallel (~> 1.10)
+      parser (>= 2.7.1.5)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8)
+      rexml
+      rubocop-ast (>= 0.6.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (1.3.0)
+      parser (>= 2.7.1.5)
+    ruby-progressbar (1.10.1)
+    ruby2_keywords (0.0.2)
+    sinatra (2.1.0)
+      mustermann (~> 1.0)
+      rack (~> 2.2)
+      rack-protection (= 2.1.0)
+      tilt (~> 2.0)
+    test-unit (3.3.7)
+      power_assert
+    tilt (2.0.10)
+    unicode-display_width (1.7.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rack (~> 2.2, >= 2.2.3)
+  rake (~> 12.3, >= 12.3.3)
+  ronn-ng!
+  rubocop (~> 0.88, >= 0.88.0)
+  sinatra (~> 2.0, >= 2.0.8)
+  test-unit (~> 3.3, >= 3.3.6)
+
+BUNDLED WITH
+   2.1.4

data/INSTALLING.md

@@ -68,7 +68,7 @@ PATH=$(pwd)/ronn-ng/bin:$PATH
 The following gems are required for ronn-ng development:
  * nokogiri
  * mustache
- * rdiscount
+ * kramdown
  * rubocop
  * sinatra
  * rack
@@ -76,7 +76,7 @@ The following gems are required for ronn-ng development:
  * test-unit
 
 ```
-gem install nokogiri mustache rdiscount rubocop sinatra rack rake test-unit
+gem install nokogiri mustache kramdown rubocop sinatra rack rake test-unit
 ```
 
 Or install them with bundler using the project's gem definition:

data/README.md

@@ -14,13 +14,13 @@ detail.
 The `*.ronn` files found in the [`man/`][1] directory show off a wide range of
 ronn capabilities:
 
-  * [ronn(1)](http://rtomayko.github.com/ronn/ronn.1) command -
-    [source file](http://github.com/apjanke/ronn-ng/blob/master/man/ronn.1.ronn),
-    [roff output](http://github.com/apjanke/ronn-ng/blob/master/man/ronn.1)
+* [ronn(1)](http://rtomayko.github.com/ronn/ronn.1) command -
+  [source file](http://github.com/apjanke/ronn-ng/blob/master/man/ronn.1.ronn),
+  [roff output](http://github.com/apjanke/ronn-ng/blob/master/man/ronn.1)
 
-  * [ronn-format(7)](http://rtomayko.github.com/ronn/ronn-format.7) -
-    [source file](http://github.com/apjanke/ronn-ng/blob/master/man/ronn-format.7.ronn),
-    [roff output](http://github.com/apjanke/ronn-ng/blob/master/man/ronn-format.7)
+* [ronn-format(7)](http://rtomayko.github.com/ronn/ronn-format.7) -
+  [source file](http://github.com/apjanke/ronn-ng/blob/master/man/ronn-format.7.ronn),
+  [roff output](http://github.com/apjanke/ronn-ng/blob/master/man/ronn-format.7)
 
 [1]: http://github.com/apjanke/ronn-ng/tree/master/man
 
@@ -30,14 +30,14 @@ As an alternative, you might want to check out [pandoc](http://johnmacfarlane.ne
 
 Install with Homebrew on macOS:
 
-```
+```bash
 brew tap apjanke/ronn-ng
 brew install ronn-ng
 ```
 
 Install with `gem` anywhere that supports it:
 
-```
+```bash
 gem install ronn-ng
 ```
 
@@ -47,74 +47,84 @@ See [INSTALLING.md](INSTALLING.md) for details on other systems and installation
 
 Build roff and HTML output files for one or more input files:
 
-    $ ronn man/ronn.5.ronn
-    roff: man/ronn.5
-    html: man/ronn.5.html
+```bash
+$ ronn man/ronn.5.ronn
+roff: man/ronn.5
+html: man/ronn.5.html
+```
 
 Generate only a standalone HTML version of one or more files:
 
-    $ ronn --html man/markdown.5.ronn
-    html: man/markdown.5.html
+```bash
+$ ronn --html man/markdown.5.ronn
+html: man/markdown.5.html
+```
 
 Build roff versions of all ronn files in a directory:
 
-    $ ronn --roff man/*.ronn
+```bash
+$ ronn --roff man/*.ronn
+```
 
 View a ronn file as if it were a manpage without building intermediate files:
 
-    $ ronn --man man/markdown.5.ronn
+```bash
+$ ronn --man man/markdown.5.ronn
+```
 
 View roff output with man(1):
 
-    $ man man/ronn.5
+```bash
+$ man man/ronn.5
+```
 
 The [ronn(1)](http://rtomayko.github.com/ronn/ronn.1) manual page includes
 comprehensive documentation on `ronn` command line options.
 
 ## Background
 
-Some think Unix manual pages are a poor and outdated form of documentation. I
-disagree:
+Some think Unix manual pages are a poor and outdated form of documentation. Ronn-NG
+disagrees:
 
-- Manpages follow a well defined structure that's immediately familiar. This
+* Manpages follow a well defined structure that's immediately familiar. This
   gives developers a starting point when documenting new tools, libraries, and
   formats.
 
-- Manpages get to the point. Because they're written in an inverted style, with
+* Manpages get to the point. Because they're written in an inverted style, with
   a SYNOPSIS section followed by additional detail, prose and references to
   other sources of information, manpages provide the best of both cheat sheet
   and reference style documentation.
 
-- Historically, manpages use an extremely -- unbelievably -- limited set of
+* Historically, manpages use an extremely — unbelievably — limited set of
   text formatting capabilities. You get a couple of headings, lists, bold,
   underline and no more. This is a feature.
 
-- Although two levels of section hierarchy are technically supported, most
+* Although two levels of section hierarchy are technically supported, most
   manpages use only a single level. Unwieldy document hierarchies complicate
   otherwise good documentation. Remember that Feynman covered all of physics
-  -- heavenly bodies through QED -- with only two levels of document hierarchy
+  — heavenly bodies through QED — with only two levels of document hierarchy
   (_The Feynman Lectures on Physics_, 1970).
 
-- The classical terminal manpage display is typographically well thought out.
+* The classical terminal manpage display is typographically well thought out.
   Big bold section headings, justified monospace text, nicely indented
   paragraphs, intelligently aligned definition lists, and an informational
   header and footer.
 
-- Manpages have a simple referencing syntax; e.g., sh(1), fork(2), markdown(7).
+* Manpages have a simple referencing syntax; e.g., sh(1), fork(2), markdown(7).
   HTML versions can use this to generate links between pages.
 
 Unfortunately, figuring out how to create a manpage is a fairly tedious process.
 The roff/mandoc/mdoc macro languages are highly extensible, fractured between
-multiple dialects, and include a bunch of device specific stuff irrelevant to
-modern publishing tools.
+multiple dialects, and include a bunch of device-specific stuff irrelevant to
+modern publishing tools. Ronn aims to solve that problem.
 
 ## Requirements
 
-Ruby 2.3 or newer.
+Ruby 2.3 or newer, and gems as listed in `ronn-ng.gemspec`.
 
 ## Project Management
 
-The project home page is at https://github.com/apjanke/ronn-ng. Bug reports,
+The project home page is at <https://github.com/apjanke/ronn-ng>. Bug reports,
 feature requests, and patch submissions are welcome.
 
 Ronn-NG was forked from the original Ronn project in 2018 after Ronn
@@ -127,7 +137,7 @@ MIT License.
 
 Ronn is Copyright (C) 2010 [Ryan Tomayko](http://tomayko.com/about).
 
-New Ronn-NG material is Copyright (C) 2018, 2019 [Andrew Janke](https://apjanke.net).
+New Ronn-NG material is Copyright (C) 2018-2020 [Andrew Janke](https://apjanke.net).
 
 See the file LICENSE.txt for information of licensing and distribution.
 

data/Rakefile

@@ -11,7 +11,7 @@ task :environment do
   $LOAD_PATH.unshift ROOTDIR unless $LOAD_PATH.include?(ROOTDIR)
   $LOAD_PATH.unshift LIBDIR unless $LOAD_PATH.include?(LIBDIR)
   require_library 'nokogiri'
-  require_library 'rdiscount'
+  require_library 'kramdown'
   ENV['RUBYLIB'] = $LOAD_PATH.join(':')
   ENV['PATH'] = "#{BINDIR}:#{ENV['PATH']}"
 end
@@ -19,7 +19,7 @@ end
 desc 'Run tests'
 task test: :environment do
   $LOAD_PATH.unshift "#{ROOTDIR}/test"
-  Dir['test/test_*.rb'].each { |f| require(f) }
+  Dir['test/test_*.rb'].sort.each { |f| require(f) }
 end
 
 desc 'Start the server'
@@ -135,9 +135,9 @@ end
 
 def require_library(name)
   require name
-rescue LoadError => boom
+rescue LoadError => e
   unless defined?(Gem)
-    warn "warn: #{boom}. trying again with rubygems."
+    warn "warn: #{e}. trying again with rubygems."
     require 'rubygems'
     retry
   end

data/bin/ronn

@@ -22,19 +22,28 @@
 # / Document attributes:
 # /       --date=<date>          published date in YYYY-MM-DD format (bottom-center)
 # /       --manual=<name>        name of the manual (top-center)
+# /       --name=<name>          title of the manual page (top-left, top-right, bottom-right)
 # /       --organization=<name>  publishing group or individual (bottom-left)
+# /       --section=<sec>        section of the manual page (with name)
 # /
 # / Misc options:
 # /   -w, --warnings            show troff warnings on stderr
 # /   -W                        disable previously enabled troff warnings
 # /       --version             show ronn version and exit
 # /       --help                show this help message
+# /   -E <encoding>             specify the encoding files are in (default is UTF-8)
+# /                             Note: this only affects files. Data passed in to ronn's STDIN
+# /                             must be in UTF-8 regardless of the -E setting.
 # /
 # / A <file> named example.1.ronn generates example.1.html (HTML manpage)
 # / and example.1 (roff manpage) by default.
 require 'date'
 require 'optparse'
 
+# Ronn wants its inputs to be in UTF-8, regardless of the user's
+# locale settings or Ruby version.
+Encoding.default_external = Encoding::UTF_8
+
 def usage
   puts File.readlines(__FILE__)
            .grep(/^# \/.*/)
@@ -46,11 +55,11 @@ end
 # Libraries and LOAD_PATH shenanigans
 
 begin
-  require 'rdiscount'
+  require 'kramdown'
   require 'nokogiri'
   require 'ronn'
-rescue LoadError => boom
-  if boom.to_s =~ /ronn/
+rescue LoadError => e
+  if e.to_s =~ /ronn/
     libdir = File.expand_path('../lib', __dir__).sub(%r{^#{Dir.pwd}/}, './')
     if File.directory?(libdir) && !$LOAD_PATH.include?(libdir)
       # warn "warn: #{boom}. adding #{libdir} to RUBYLIB ..."
@@ -58,11 +67,11 @@ rescue LoadError => boom
       retry
     end
   elsif !defined?(Gem)
-    warn "warn: #{boom}. loading rubygems ..."
+    warn "warn: #{e}. loading rubygems ..."
     require 'rubygems'
     retry
   end
-  abort boom.to_s
+  abort e.to_s
 end
 
 ##
@@ -73,11 +82,12 @@ view    = false
 server  = false
 port_arg = nil
 formats = nil
+encoding = 'UTF-8'
 options = {}
 write_index = false
-styles  = %w[man]
-groff   = 'groff -Wall -mtty-char -mandoc -Tascii -t'
-pager   = ENV['MANPAGER'] || ENV['PAGER'] || 'more -is'
+styles = %w[man]
+groff = 'groff -Wall -mtty-char -mandoc -Tascii -t'
+pager = ENV['MANPAGER'] || ENV['PAGER'] || 'more -is'
 output_dir = nil
 
 ##
@@ -109,9 +119,10 @@ ARGV.options do |argv|
   argv.on('-f', '--fragment') { (formats ||= []) << 'html_fragment' }
   argv.on('--markdown')       { (formats ||= []) << 'markdown' }
   argv.on('--yaml')           { (formats ||= []) << 'yaml' }
+  argv.on('-E', '--encoding=V') { |val| encoding = val }
 
   # html output options
-  argv.on('-s', '--style=V')  { |val| styles += val.split(/[, \n]+/) }
+  argv.on('-s', '--style=V') { |val| styles += val.split(/[, \n]+/) }
 
   # manual attribute options
   %w[name section manual organization date].each do |attribute|
@@ -156,6 +167,7 @@ formats.delete('html') if formats.include?('html_fragment')
 options['date'] &&= Date.strptime(options['date'], '%Y-%m-%d')
 options['styles'] = styles
 options['outdir'] = output_dir
+options['encoding'] = encoding
 
 unless port_arg.nil?
   begin
@@ -179,7 +191,7 @@ end
 # Build Pipeline
 
 pid = nil
-wr = STDOUT
+wr = $stdout
 documents = ARGV.map { |file| Ronn::Document.new(file, options) }
 documents.each do |doc|
   # setup the man pipeline if the --man option was specified
@@ -190,7 +202,7 @@ documents.each do |doc|
       rd.close
     else
       wr.close
-      STDIN.reopen rd
+      $stdin.reopen rd
       exec "#{groff} | #{pager}"
     end
   end

data/lib/ronn.rb

@@ -15,13 +15,11 @@ module Ronn
     Document.new(filename, attributes, &block)
   end
 
-  # truthy when this a release (\d.\d.\d) version.
+  # truthy when this a release (\d\.\d\.\d) version.
   def self.release?
     revision != '' && !revision.include?('-')
   end
 
-  # version: 0.6.11
-  #
   # A semantic version number based on the git revision. The third element
   # of the version is incremented by the commit offset, such that version
   # 0.6.6-5-gdacd74b => 0.6.11
@@ -31,11 +29,8 @@ module Ronn
     ver.join('.')
   end
 
-  # revision: 0.6.6-5-gdacd74b
-  # revision: 0.6.25
-  #
   # The string revision as reported by: git-describe --tags. This is just the
-  # tag name when a tag references the HEAD commit (0.6.25). When the HEAD
+  # tag name when a tag references the HEAD commit (e.g. 0.6.25). When the HEAD
   # commit is not tagged, this is a "<tag>-<offset>-<sha1>" string:
   #   <tag>    - closest tag name
   #   <offset> - number of commits ahead of <tag>
@@ -47,6 +42,6 @@ module Ronn
   # value generated by: rake rev
   # or edit manually; I'm not sure of how rake rev interacts with git
   # tags -apjanke
-  REV = '0.8.1.SNAPSHOT'.freeze
+  REV = '0.10.1.pre1'.freeze
   VERSION = version
 end