ronn-ng 0.8.1.beta.1 → 0.10.0.pre.SNAPSHOT

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cae4ba81f57d12143471cdf54866a6a88c94425e418d021870609cb61ae8199a
-  data.tar.gz: 01e5f919b8daaa90541080439e711e4b915f419e0338c45b6eaa95fe3f80088b
+  metadata.gz: 42d3c988ea961f9b89073f5534e6c0fc721c2f951e0a3d4e14f74987bab263db
+  data.tar.gz: ef7745fc686d7ba4de2bfa94f9071e05a675a18389a064cf651970976ba09e0f
 SHA512:
-  metadata.gz: 1f54961fb896a1fe5d62ae679fe2c16451cb022452fadde3605a32d94ed5a14ef09291ad73590dcb8e0f45cadaaff839e2722a25dcd73f527d20fdc21850d0e2
-  data.tar.gz: ba9ef921c56fb10fb9c02567c3b53eaed61f6f27de4b2fd669bb79b57da13ba98376a2f88b25bbca8ac5b3d5e70241246ea612f3fd32f80fc3e6ddc88df602f0
+  metadata.gz: 3a065288a7f12e64f33c1c5fea974a1954e21b0ea56b96f934fbad5f1570ee5b71716d10feb9b28cf9cd894ef4a185054889fa1c698f249595b1e8abbc8f24f9
+  data.tar.gz: '0338fdc307af4380e99127bd9e137c53e6ea7c9ddb7e719616667602de4fd7cae856c7099a3b9053cdc02c4083b10feae666f87e40688016782433f8663d1cc8'

data/CHANGES

@@ -1,8 +1,35 @@
 Ronn-NG CHANGES
 ===============
 
-Version 0.8.1 (???)
--------------------
+Version 0.10.0 (2020 Oct 22)
+----------------------------
+
+* 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>)
+* Bump to mustache 1.x
+
+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)
 
 Version 0.8.0 (2018 Dec 25)
 ---------------------------

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/LICENSE.txt

@@ -1,7 +1,7 @@
 The MIT License
 
        Copyright (C) 2009 Ryan Tomayko <tomayko.com/about>
-       Copyright (C) 2018 Andrew Janke <apjanke.net>
+       Copyright (C) 2018, 2019 Andrew Janke <apjanke.net>
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 

data/README.md

@@ -1,6 +1,6 @@
 # Ronn-NG
 
-Ronn-NG is a new, currently-maintained fork of the defunct [original Ronn 
+Ronn-NG is a new, currently-maintained fork of the defunct [original Ronn
 project](https://github.com/rtomayko/ronn).
 
 Ronn builds manuals. It converts simple, human readable textfiles to roff for
@@ -127,8 +127,7 @@ MIT License.
 
 Ronn is Copyright (C) 2010 [Ryan Tomayko](http://tomayko.com/about).
 
-New Ronn-NG material is Copyright (c) 2018 [Andrew Janke](https://apjanke.net)
-and other contributors.
+New Ronn-NG material is Copyright (C) 2018, 2019 [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.0-SNAPSHOT'.freeze
   VERSION = version
 end

data/lib/ronn/document.rb

@@ -1,7 +1,7 @@
 require 'time'
 require 'cgi'
 require 'nokogiri'
-require 'rdiscount'
+require 'kramdown'
 require 'ronn/index'
 require 'ronn/roff'
 require 'ronn/template'
@@ -20,9 +20,12 @@ module Ronn
     include Ronn::Utils
 
     # Path to the Ronn document. This may be '-' or nil when the Ronn::Document
-    # object is created with a stream.
+    # object is created with a stream, in which case stdin will be read.
     attr_reader :path
 
+    # Encoding that the Ronn document is in
+    attr_accessor :encoding
+
     # The raw input data, read from path or stream and unmodified.
     attr_reader :data
 
@@ -58,7 +61,7 @@ module Ronn
     # Array of style modules to apply to the document.
     attr_reader :styles
 
-    # Output directory to write files to
+    # Output directory to write files to.
     attr_accessor :outdir
 
     # Create a Ronn::Document given a path or with the data returned by
@@ -71,9 +74,9 @@ module Ronn
       @reader = block ||
                 lambda do |f|
                   if ['-', nil].include?(f)
-                    STDIN.read
+                    $stdin.read
                   else
-                    File.read(f)
+                    File.read(f, encoding: @encoding)
                   end
                 end
       @data = @reader.call(path)
@@ -118,7 +121,7 @@ module Ronn
       return unless @basename
 
       parts = @basename.split('.')
-      parts.pop if parts.last.casecmp('ronn').zero?
+      parts.pop if parts.length > 1 && parts.last =~ /^\w+$/
       parts.pop if parts.last =~ /^\d+$/
       parts.join('.')
     end
@@ -205,7 +208,9 @@ module Ronn
     # tuple of the form: [name, section, description], where missing information
     # is represented by nil and any element may be missing.
     def sniff
-      html = Markdown.new(data[0, 512], :no_superscript).to_html
+      html = Kramdown::Document.new(data[0, 512], auto_ids: false,
+        smart_quotes: ['apos', 'apos', 'quot', 'quot'],
+        typographic_symbols: { hellip: '...', ndash: '--', mdash: '--' }).to_html
       heading, html = html.split("</h1>\n", 2)
       return [nil, nil, nil] if html.nil?
 
@@ -289,7 +294,7 @@ module Ronn
       to_h.to_yaml
     end
 
-    def to_json
+    def to_json(*_args)
       require 'json'
       to_h.merge('date' => date.iso8601).to_json
     end
@@ -307,7 +312,13 @@ module Ronn
     end
 
     def input_html
-      @input_html ||= strip_heading(Markdown.new(markdown, :no_superscript).to_html)
+      @input_html ||= strip_heading(Kramdown::Document.new(markdown,
+        auto_ids: false,
+        input: 'GFM',
+        hard_wrap: 'false',
+        syntax_highlighter_opts: 'line_numbers: false',
+        smart_quotes: ['apos', 'apos', 'quot', 'quot'],
+        typographic_symbols: { hellip: '...', ndash: '--', mdash: '--' }).to_html)
     end
 
     def strip_heading(html)
@@ -362,7 +373,7 @@ module Ronn
 
     # Convert <WORD> to <var>WORD</var> but only if WORD isn't an HTML tag.
     def markdown_filter_angle_quotes(markdown)
-      markdown.gsub(/<([^:.\/]+?)>/) do |match|
+      markdown.gsub(/(?<!\\)<([^:.\/]+?)>/) do |match|
         contents = $1
         tag, attrs = contents.split(' ', 2)
         if attrs =~ /\/=/ || html_element?(tag.sub(/^\//, '')) ||
@@ -395,12 +406,12 @@ module Ronn
       # process all unordered lists depth-first
       @html.search('ul').to_a.reverse_each do |ul|
         items = ul.search('li')
-        next if items.any? { |item| item.inner_text.split("\n", 2).first !~ /:$/ }
+        next if items.any? { |item| item.inner_text.strip.split("\n", 2).first !~ /:$/ }
 
         dl = Nokogiri::XML::Node.new 'dl', html
         items.each do |item|
           # This processing is specific to how Markdown generates definition lists
-          term, definition = item.inner_html.split(":\n", 2)
+          term, definition = item.inner_html.strip.split(":\n", 2)
           term = term.sub(/^<p>/, '')
 
           dt = Nokogiri::XML::Node.new 'dt', html

data/lib/ronn/index.rb

@@ -5,8 +5,7 @@ module Ronn
   class Index
     include Enumerable
 
-    attr_reader :path
-    attr_reader :references
+    attr_reader :path, :references
 
     # Retrieve an Index for <path>, where <path> is a directory or normal
     # file. The index is loaded from the corresponding index.txt file if
@@ -142,8 +141,7 @@ module Ronn
   #
   # The #url method should be used to obtain the href value for HTML.
   class Reference
-    attr_reader :name
-    attr_reader :location
+    attr_reader :name, :location
 
     def initialize(index, name, location)
       @index = index

data/lib/ronn/roff.rb

@@ -36,7 +36,11 @@ module Ronn
       comment "generated with Ronn-NG/v#{Ronn.version}"
       comment "http://github.com/apjanke/ronn-ng/tree/#{Ronn.revision}"
       return if name.nil?
-      macro 'TH', %("#{escape(name.upcase)}" "#{section}" "#{date.strftime('%B %Y')}" "#{version}" "#{manual}")
+      if manual
+        macro 'TH', %("#{escape(name.upcase)}" "#{section}" "#{date.strftime('%B %Y')}" "#{version}" "#{manual}")
+      else
+        macro 'TH', %("#{escape(name.upcase)}" "#{section}" "#{date.strftime('%B %Y')}" "#{version}")
+      end
     end
 
     def remove_extraneous_elements!(doc)
@@ -164,7 +168,7 @@ module Ronn
           when 'ol'
             macro 'IP', %W["#{node.parent.children.index(node) + 1}." 4]
           when 'ul'
-            macro 'IP', ['"\\[ci]"', '4']
+            macro 'IP', ['"\(bu"', '4']
           else
             raise "List element found as a child of non-list parent element: #{node.inspect}"
           end
@@ -277,13 +281,13 @@ module Ronn
             inline_filter(node.children)
           elsif node.has_attribute?('data-bare-link')
             write '\fI'
-            write '\%' + escape(node.attributes['href'].content)
+            inline_filter(node.children)
             write '\fR'
           else
             inline_filter(node.children)
             write ' '
             write '\fI'
-            write '\%' + escape(node.attributes['href'].content)
+            write escape(node.attributes['href'].content)
             write '\fR'
           end
 
@@ -312,7 +316,7 @@ module Ronn
     end
 
     HTML_ROFF_ENTITIES = {
-      '•' => '\[ci]',
+      '•' => '\(bu',
       '&lt;' => '<',
       '&gt;' => '>',
       ' ' => '\~', # That's a literal non-breaking space character there
@@ -335,7 +339,7 @@ module Ronn
       text.gsub!(/&#(\d+);/) { $1.to_i.chr }                # dec entities
       text.gsub!('\\', '\e')                                # backslash
       text.gsub!('...', '\|.\|.\|.')                        # ellipses
-      text.gsub!(/['.-]/) { |m| "\\#{m}" }                  # control chars
+      text.gsub!(/[.-]/) { |m| "\\#{m}" }                   # control chars
       ent.each do |key, val|
         text.gsub!(key, val)
       end
@@ -350,10 +354,12 @@ module Ronn
     # write text to output buffer
     def write(text)
       return if text.nil? || text.empty?
-      # lines cannot start with a '.'. insert zero-width character before.
-      text = text.gsub(/\n\\\./s, "\n\\\\&\\.")
+      # lines cannot start with a '.' or "'". insert zero-width character before.
+      text = text.gsub(/\n\\\./, "\n\\\\&\\.")
+      text = text.gsub(/\n'/, "\n\\&\\'")
       buf_ends_in_newline = @buf.last && @buf.last[-1] == "\n"
       @buf << '\&' if text[0, 2] == '\.' && buf_ends_in_newline
+      @buf << '\&' if text[0, 1] == "'" && buf_ends_in_newline
       @buf << text
     end