ronn-ng 0.7.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f3b5bd87ab795aca2c2a93fa2e9fd4546bf0f487e514f08e438f7fc4db8f669a
+  data.tar.gz: bac6bfb79ee2a082f0920f96608f644f8573c3dc69d5852ce7ae81cbf3f5c875
+SHA512:
+  metadata.gz: 92e0355ea7b2466ed1f31741099dc54b39032bf2a8e89fa7a385a07c329433d034ea893c84bb2e585c8223425b2330350f71332e3181430091627a852288389d
+  data.tar.gz: 102c172c8aabd4e942a956bde33697e762803ad63461a4dee7ab032fc3a453126ebba70412b6c7d56a5c02c5d4bae288d072c7a0ee72fa52120178e9c223c5e9

data/AUTHORS

@@ -0,0 +1,8 @@
+# This is a list of people who have contributed code or ideas to ronn -- for
+# copyright purposes or whatever.
+
+Ryan Tomayko         <http://github.com/rtomayko>
+Chris Wanstrath      <http://github.com/defunkt>
+Suraj N. Kurapati    <http://github.com/sunaku>
+Hallison Batista     <http://github.com/hallison>
+Andrew Janke         <http://github.com/apjanke>

data/CHANGES

@@ -0,0 +1,184 @@
+Ronn-NG CHANGES
+===============
+
+Version 0.7.4 (2018 sometime)
+-----------------------------
+
+* Forked Ronn-NG from original Ronn. (apjanke)
+
+
+Original Ronn CHANGES
+=====================
+
+Version 0.7.3 (2010 June 24)
+----------------------------
+
+* Fixed a major bug in roff output due to overly aggressive doublequote
+  escaping. Paragraphs and code blocks were not being displayed if they
+  included a double-quote character. (rtomayko, pawelz)
+
+Version 0.7.0 (2010 June 21)
+----------------------------
+
+* HTML: Manual references (like 'grep(1)', 'ls(1)', etc.) are now hyperlinked
+  based on a set of name -> URL mappings defined in an index.txt file. The index
+  may also define links to things that aren't manuals for use in markdown
+  reference-style links. See the ronn(1) manual on LINK INDEXES for more
+  inforation: <http://rtomayko.github.com/ronn/ronn.1.html#LINK-INDEXES>
+  (rtomayko)
+
+* ROFF: Fixed a bug where multiple dot characters (.) at the beginning of a
+  line were not being escaped properly and were not displayed when viewed
+  in the terminal. (rtomayko)
+
+* ROFF: Non-breaking space characters (&nbsp;) can now be used to control line
+  wrap in roff output. (rtomayko)
+
+* ROFF: Named HTML entities like &bull;, &trade;, &copy;, and &mdash; are now
+  converted to their roff escaped equivalents. (rtomayko)
+
+* An undocumented --markdown format option argument has been added to ronn(1).
+  When given, ronn generates a <name>.<section>.markdown file with the
+  post-processed markdown text. This is mostly useful for debugging but may be
+  useful for converting ronn-format to 100% compatible markdown text.
+  (rtomayko)
+
+* The ronn(5) manpage is now known as ronn-format(7) (section 5 is limited
+  to configuration files and stuff like that historically). The old ronn(7)
+  manpage, which was really just the README, has been removed.
+  (rtomayko)
+
+* Performance improvements. Fixed a few cases where HTML was being reparsed
+  needlessly, tuned dom selectors, ... (rtomayko)
+
+Version 0.6.6 (2010 June 13)
+----------------------------
+
+Small bug fix release fixes whitespace stripping between adjacent
+inline elements in roff output (adamv, rtomayko)
+
+Version 0.6 (2010 June 13)
+--------------------------
+
+Features:
+
+* HTML: New styling system:
+    ronn --style=toc,print program.1.ronn
+    ronn -s dark,toc,/path/to/custom.css man/*.ronn
+
+  The --style (-s) option takes a list of CSS stylesheets to embed into the
+  generated HTML. Stylesheets are inserted in the order specified and can use
+  the cascade to add or remove visual elements.
+
+  Ronn ships with a few built in styles: toc, dark, 80c, and print. You can
+  insert your own by giving the path or manipulating the RONN_STYLE environment
+  variable.
+
+  See ronn(1) for full details on all of these things (rtomayko)
+
+* HTML: It's now possible to generate a Table Of Contents of manpage sections.
+  The TOC is disabled by default. To enable it: ronn --style=toc file.ronn
+  (sunaku)
+
+* HTML: The RONN_LAYOUT environment variable can be used to apply a custom
+  mustache layout template:
+
+  RONN_LAYOUT=mine.mustache ronn man/great-program.1.ronn
+
+  See lib/ronn/template/default.html for default markup and features
+  (defunkt)
+
+* HTML: All heading elements include page anchor id attributes to make
+  it possible to link to a specific manpage section (sunaku)
+
+* HTML: Markdown reference links can be used to refer to sections. To link
+  to the SEE ALSO section of the current manpage, use: [SEE ALSO][], or [to
+  control the link text][SEE ALSO], or even [use the relative URL](#SEE-ALSO).
+  (rtomayko)
+
+* HTML: 80 character terminal style: ronn -s 80c file.ronn -- precisely
+  emulates a 80c terminal (sunaku)
+
+* HTML: Various appearance changes to the default stylesheet: smaller type
+  with consistent vertical baseline; darker type for more contrast; em, var,
+  and u are italic instead of underline (rtomayko)
+
+* HTML: Various print stylesheet tweaks, including hyperlinks and layout
+  enhancements (sunaku)
+
+* ROFF: ronn --warnings (-w) shows troff warnings on stderr when building
+  or viewing manuals. (rtomayko)
+
+* ROFF: Ordered lists. (sunaku)
+
+* ROFF: URLs for hyperlinks are shown immediately after hyperlink text.
+  (sunaku)
+
+* The RONN_MANUAL, RONN_ORGANIZATION, and RONN_DATE environment variables
+  establish the default values of the --manual, --organization, and --date
+  options (rtomayko)
+
+Bugs:
+
+* ROFF: Don't crash with empty preformatted blocks (sunaku)
+
+* ROFF: A whole bunch of weird whitespace related problems in roff output,
+  such as the first line of definition lists being indented by two
+  characters (rtomayko)
+
+* ROFF: All ['".] characters are backslash escaped in roff output. These
+  characters are used for various roff macro syntax (rtomayko)
+
+Deprecations, Obsoletions:
+
+* The ronn(1) command line interface has changed in ways that are not
+  backward-compatible with previous versions of ronn. The --build option is
+  assumed when one or more .ronn files is given on the command line. Previous
+  versions write generated content to standard output with no explicit --build
+  options.
+
+  The default behavior when no files are given remains the same as previous
+  versions: ronn source text is read from stdin and roff is written to stdout.
+
+  See `ronn --help' or the ronn(1) manual for more on command line interface
+  changes.
+
+  (rtomayko, defunkt)
+
+* HTML: Ronn no longer uses a specific monospace font-family; the system
+  default monospace font is used instead. Use 'ronn --style' to set up a font
+  stack (rtomayko)
+
+* HTML: The following HTML elements are deprecated and will be removed at some
+  point: div#man, div#man ol.man, div#man ol.head, div#man ol.man.
+
+  The .mp, .man-decor, .man-head, .man-foot, .man-title, and .man-navigation
+  classes should be used instead (rtomayko)
+
+* The markdown(5) manpage is no longer shipped with the ronn package. It is
+  shipped with the latest version of rdiscount, however.
+  (rtomayko, sunaku)
+
+0.5 (2010 April 24)
+-------------------
+
+* Fixed a bug in roff output where multiple successive newlines were being
+  collapsed into a single newline in preformatted output.
+
+* Hexadecimal and decimal entity references generated by the Markdown to HTML
+  conversion are now properly decoded into normal characters in roff output.
+
+* The compatibility shims that allowed the ronn command to be invoked as "ron",
+  and the ronn library to be required as "ron", have been removed.
+
+
+0.4 (2010 March 08)
+-------------------
+
+* Ron has been renamed "Ronn", including the "ronn" command and the "ronn"
+  library. Compatibility shims are included in this release but will be removed
+  in the next release.
+
+* The hpricot library is now used for HTML hackery instead of the nokogiri
+  library. The hpricot library is preferred because it doesn't depend on external
+  system dependencies.

data/INSTALLING

@@ -0,0 +1,20 @@
+Ronn is currently distributed mainly as a gem package. Install with rubygems:
+
+    $ gem install ronn
+    $ ronn --help
+
+Historical Ronn tarballs available at: <http://github.com/rtomayko/ronn/downloads>
+
+    $ curl -L http://github.com/rtomayko/ronn/downloads/0.6.6 | tar xvzf -
+    $ cd rtomayko-r*
+    $ ruby setup.rb
+
+The hpricot, mustache, and rdiscount packages are required.
+
+    $ gem install hpricot mustache rdiscount
+
+Hacking? Clone the git repository and put ronn/bin on your PATH:
+
+    $ git clone git://github.com/apjanke/ronn-ng
+    $ PATH=$(pwd)/ronn-ng/bin:$PATH
+    $ ronn --help

data/LICENSE.txt

@@ -0,0 +1,11 @@
+The MIT License
+
+       Copyright (C) 2009 Ryan Tomayko <tomayko.com/about>
+       Copyright (C) 2018 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:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+       

data/README.md

@@ -0,0 +1,113 @@
+# 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
+terminal display, and also to HTML for the web.
+
+The source format includes all of Markdown but has a more rigid structure and
+syntax extensions for features commonly found in manpages (definition lists,
+link notation, etc.). The ronn-format(7) manual page defines the format in
+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-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
+
+As an alternative, you might want to check out [pandoc](http://johnmacfarlane.net/pandoc/) which can also convert markdown into roff manual pages.
+
+## Examples
+
+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
+
+Generate only a standalone HTML version of one or more files:
+
+    $ 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
+
+View a ronn file as if it were a manpage without building intermediate files:
+
+    $ ronn --man man/markdown.5.ronn
+
+View roff output with man(1):
+
+    $ 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:
+
+- 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
+  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
+  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
+  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
+  (_The Feynman Lectures on Physics_, 1970).
+
+- 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).
+  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.
+
+
+## Project Management
+
+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
+development had been defunct for a couple years, and Andrew wanted
+some bugs fixed.
+
+## License and Copying
+
+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.
+
+See the file LICENSE.txt for information of licensing and distribution.

data/Rakefile

@@ -0,0 +1,163 @@
+require 'rake/clean'
+require 'date'
+
+task :default => :test
+
+ROOTDIR = File.expand_path('..', __FILE__).sub(/#{Dir.pwd}(?=\/)/, '.')
+LIBDIR  = "#{ROOTDIR}/lib"
+BINDIR  = "#{ROOTDIR}/bin"
+
+task :environment do
+  $LOAD_PATH.unshift ROOTDIR if !$:.include?(ROOTDIR)
+  $LOAD_PATH.unshift LIBDIR if !$:.include?(LIBDIR)
+  require_library 'hpricot'
+  require_library 'rdiscount'
+  ENV['RUBYLIB'] = $LOAD_PATH.join(':')
+  ENV['PATH'] = "#{BINDIR}:#{ENV['PATH']}"
+end
+
+desc 'Run tests'
+task :test => :environment do
+  $LOAD_PATH.unshift "#{ROOTDIR}/test"
+  Dir['test/test_*.rb'].each { |f| require(f) }
+end
+
+desc 'Start the server'
+task :server => :environment do
+  if system('type shotgun >/dev/null 2>&1')
+    exec "shotgun config.ru"
+  else
+    require 'ronn/server'
+    Ronn::Server.run('man/*.ronn')
+  end
+end
+
+desc 'Start the server'
+task :server => :environment do
+  if system('type shotgun >/dev/null 2>&1')
+    exec "shotgun config.ru"
+  else
+    require 'ronn/server'
+    Ronn::Server.run('man/*.ronn')
+  end
+end
+
+desc 'Build the manual'
+task :man => :environment do
+  require 'ronn'
+  ENV['RONN_MANUAL']  = "Ronn Manual"
+  ENV['RONN_ORGANIZATION'] = "Ronn #{Ronn::revision}"
+  sh "ronn -w -s toc -r5 --markdown man/*.ronn"
+end
+
+desc 'Publish to github pages'
+task :pages => :man do
+  puts '----------------------------------------------'
+  puts 'Rebuilding pages ...'
+  verbose(false) {
+    rm_rf 'pages'
+    push_url = `git remote show origin`.grep(/Push.*URL/).first[/git@.*/]
+    sh "
+      set -e
+      git fetch -q origin
+      rev=$(git rev-parse origin/gh-pages)
+      git clone -q -b gh-pages . pages
+      cd pages
+      git reset --hard $rev
+      rm -f ronn*.html index.html
+      cp -rp ../man/ronn*.html ../man/index.txt ../man/index.html ./
+      git add -u ronn*.html index.html index.txt
+      git commit -m 'rebuild manual'
+      git push #{push_url} gh-pages
+    ", :verbose => false
+  }
+end
+
+# PACKAGING ============================================================
+
+# Rev Ronn::VERSION
+task :rev do
+  rev = ENV['REV'] || `git describe --tags`.chomp
+  data = File.read('lib/ronn.rb')
+  data.gsub!(/^( *)REV *=.*/, "\\1REV = '#{rev}'")
+  File.open('lib/ronn.rb', 'wb') { |fd| fd.write(data) }
+  puts "revision: #{rev}"
+  puts "version:  #{`ruby -Ilib -rronn -e 'puts Ronn::VERSION'`}"
+end
+
+require 'rubygems'
+$spec = eval(File.read('ronn-ng.gemspec'))
+
+def package(ext='')
+  "pkg/ronn-#{$spec.version}" + ext
+end
+
+desc 'Build packages'
+task :package => %w[.gem .tar.gz].map { |ext| package(ext) }
+
+desc 'Build and install as local gem'
+task :install => package('.gem') do
+  sh "gem install #{package('.gem')}"
+end
+
+directory 'pkg/'
+CLOBBER.include('pkg')
+
+file package('.gem') => %w[pkg/ ronn-ng.gemspec] + $spec.files do |f|
+  sh "gem build ronn-ng.gemspec"
+  mv File.basename(f.name), f.name
+end
+
+file package('.tar.gz') => %w[pkg/] + $spec.files do |f|
+  sh <<-SH
+    git archive --prefix=ronn-#{source_version}/ --format=tar HEAD |
+    gzip > #{f.name}
+  SH
+end
+
+def source_version
+  @source_version ||= `ruby -Ilib -rronn -e 'puts Ronn::VERSION'`.chomp
+end
+
+file 'ronn-ng.gemspec' => FileList['{lib,test,bin}/**','Rakefile'] do |f|
+  # read spec file and split out manifest section
+  spec = File.read(f.name)
+  head, manifest, tail = spec.split("  # = MANIFEST =\n")
+  # replace version and date
+  head.sub!(/\.version = '.*'/, ".version = '#{source_version}'")
+  head.sub!(/\.date = '.*'/, ".date = '#{Date.today.to_s}'")
+  # determine file list from git ls-files
+  files = `git ls-files`.
+    split("\n").
+    sort.
+    reject{ |file| file =~ /^\./ }.
+    reject { |file| file =~ /^doc/ }.
+    map{ |file| "    #{file}" }.
+    join("\n")
+  # piece file back together and write...
+  manifest = "  s.files = %w[\n#{files}\n  ]\n"
+  spec = [head,manifest,tail].join("  # = MANIFEST =\n")
+  File.open(f.name, 'w') { |io| io.write(spec) }
+  puts "updated #{f.name}"
+end
+
+# Misc ===============================================================
+
+def require_library(name)
+  require name
+rescue LoadError => boom
+  if !defined?(Gem)
+    warn "warn: #{boom}. trying again with rubygems."
+    require 'rubygems'
+    retry
+  end
+  abort "fatal: the '#{name}' library is required (gem install #{name})"
+end
+
+# make .wrong test files right
+task :right do
+  Dir['test/*.wrong'].each do |file|
+    dest = file.sub(/\.wrong$/, '')
+    mv file, dest
+  end
+end