nronn 0.10.1.pre2

data/Rakefile

@@ -0,0 +1,153 @@
+require 'rake/clean'
+require 'date'
+
+task default: :test
+
+ROOTDIR = File.expand_path(__dir__).sub(/#{Dir.pwd}(?=\/)/, '.')
+LIBDIR = "#{ROOTDIR}/lib".freeze
+BINDIR = "#{ROOTDIR}/bin".freeze
+
+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 'kramdown'
+  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'].sort.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 'Build the manual'
+task man: :environment do
+  require 'ronn'
+  ENV['RONN_MANUAL'] = 'Ronn Manual'
+  ENV['RONN_ORGANIZATION'] = "nRonn #{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) do
+    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
+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('nronn.gemspec'))
+
+def package(ext = '')
+  "pkg/nronn-#{@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/ nronn.gemspec] + @spec.files do |f|
+  sh 'gem build nronn.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 'nronn.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}'")
+  # 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 => e
+  unless defined?(Gem)
+    warn "warn: #{e}. 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

data/bin/ronn

@@ -0,0 +1,253 @@
+#!/usr/bin/env ruby
+# / Usage: ronn <options> <file>...
+# /        ronn -m|--man <file>
+# /        ronn -S|--server <file> ...
+# /        ronn --pipe [<file>...]
+# / Convert ronn source <file>s to roff or HTML manpage. In the first synopsis form,
+# / build HTML and roff output files based on the input file names.
+# /
+# / Mode options alter the default behavior of generating files:
+# /       --pipe                write to standard output instead of generating files
+# /   -m, --man                 show manual like with man(1)
+# /   -S, --server              serve <file>s at http://localhost:1207/
+# /       --port <port>         run server at specified port instead of 1207
+# /   -o, --output-dir <dir>    write generated files to specified directory
+# /
+# / Format options control which files / formats are generated:
+# /   -r, --roff                generate roff output
+# /   -5, --html                generate entire HTML page with layout
+# /   -f, --fragment            generate HTML fragment
+# /       --markdown            generate post-processed markdown output
+# /
+# / 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(/^# \/.*/)
+           .map { |line| line.chomp[4..-1] }
+           .join("\n")
+end
+
+##
+# Libraries and LOAD_PATH shenanigans
+
+begin
+  require 'kramdown'
+  require 'nokogiri'
+  require '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 ..."
+      $LOAD_PATH.unshift libdir
+      retry
+    end
+  elsif !defined?(Gem)
+    warn "warn: #{e}. loading rubygems ..."
+    require 'rubygems'
+    retry
+  end
+  abort e.to_s
+end
+
+##
+# Argument defaults
+
+build   = true
+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 -s'
+output_dir = nil
+
+##
+# Environment variables
+
+%w[manual organization date].each do |attribute|
+  value = ENV["RONN_#{attribute.upcase}"]
+  next if value.nil? || value.empty?
+
+  options[attribute] = value
+end
+
+##
+# Argument parsing
+
+ARGV.options do |argv|
+  # modes
+  argv.on('--pipe')           { build = server = false }
+  argv.on('-b', '--build')    { build = true; server = false }
+  argv.on('-m', '--man')      { build = server = false; view = true }
+  argv.on('-S', '--server')   { build = view = false; server = true }
+  argv.on('-i', '--index')    { write_index = true }
+  argv.on('-o', '--output-dir=V') { |val| output_dir = val }
+  argv.on('--port=V')         { |val| port_arg = val }
+
+  # format options
+  argv.on('-r', '--roff')     { (formats ||= []) << 'roff' }
+  argv.on('-5', '--html')     { (formats ||= []) << 'html' }
+  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]+/) }
+
+  # manual attribute options
+  %w[name section manual organization date].each do |attribute|
+    argv.on("--#{attribute}=VALUE") { |val| options[attribute] = val }
+  end
+
+  # misc
+  argv.on('-w', '--warnings') { groff += ' -ww' }
+  argv.on('-W')               { groff += ' -Ww' }
+  argv.on('-v', '--version')  do
+    require 'ronn'
+    if Ronn.release?
+      printf "nRonn v%s\n", Ronn::VERSION
+    else
+      printf "nRonn v%s (%s)\n", Ronn::VERSION, Ronn::REV
+    end
+    printf "https://github.com/n-ronn/nronn/tree/%s\n", Ronn.revision
+    exit 0
+  end
+  argv.on_tail('--help') { usage; exit 0 }
+  argv.parse!
+end
+
+##
+# Modes, Formats, Options
+
+if ARGV.empty? && $stdin.tty?
+  usage
+  exit 2
+elsif ARGV.empty? && !server
+  ARGV.push '-'
+  build = false
+  formats ||= %w[roff]
+elsif view
+  formats ||= %w[roff]
+elsif build
+  formats ||= %w[roff html]
+end
+formats ||= []
+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
+    options['port'] = Integer(port_arg)
+  rescue ArgumentError
+    warn "Error: invalid port number: '#{port_arg}'"
+    exit 1
+  end
+end
+
+##
+# Server
+
+if server
+  require 'ronn/server'
+  Ronn::Server.run(ARGV, options)
+  exit 0
+end
+
+##
+# Build Pipeline
+
+pid = nil
+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
+  if view && !build
+    rd, wr = IO.pipe
+    pid = fork
+    if pid
+      rd.close
+    else
+      wr.close
+      $stdin.reopen rd
+      exec "#{groff} | #{pager}"
+    end
+  end
+
+  # write output for each format
+  formats.each do |fmt|
+    if build
+      path = doc.path_for(fmt)
+      case fmt
+      when 'html'
+        warn format('%9s: %-43s%15s', fmt, path, '+' + doc.styles.join(','))
+      when 'roff', 'html_fragment', 'markdown'
+        warn format('%9s: %-43s', fmt, path)
+      end
+
+      output = doc.convert(fmt)
+      File.open(path, 'wb') { |f| f.puts(output) }
+
+      if fmt == 'roff'
+        if view
+          system "man #{path}"
+        else
+          system "#{groff} <#{path} >/dev/null"
+        end
+      end
+    else
+      output = doc.convert(fmt)
+      wr.puts(output)
+    end
+  end
+
+  # wait for children to exit
+  if pid
+    wr.close
+    Process.wait
+  end
+end
+
+# Write index.txt files
+
+if write_index
+  indexes = documents.map(&:index).uniq
+  indexes.each do |index|
+    File.open(index.path, 'wb') do |fd|
+      fd.puts(index.to_text)
+    end
+  end
+end

data/completion/bash/ronn

@@ -0,0 +1,32 @@
+# Bash completion script for ronn(1) from nRonn
+
+_ronn()
+{
+	local cur prev words cword
+	_init_completion -n = || return
+
+	COMREPLY=()
+	cur=${COMP_WORDS[COMP_CWORD]}
+
+	case "$prev" in
+		--help|--version|-!(-*)'?')
+			return
+			;;
+		-o|--output-dir|-!(-*)e)
+			_filedir -d
+			return
+			;;
+	esac
+
+	if [[ "$cur" == -* ]]; then
+		COMREPLY=( $( compgen -W '--pipe -m --man -S --server --port -o --output-dir -r --roff -5 --html -f --fragment --markdown --date --manual --organization -w --warnings -W --version --help'))
+		return
+	fi
+
+	_filedir
+
+	return 0
+} &&
+complete -F _ronn ronn
+
+# ex: filetype=sh

data/completion/zsh/_ronn

@@ -0,0 +1,24 @@
+#compdef ronn
+
+# Zsh completion definitions for ronn, from nRonn
+
+_arguments -C -s -S \
+  '(--pipe)--pipe[write to standard output instead of generating files]' \
+  '(-m --man)'{-m,--man}'[show manual like with man]' \
+  '(-S --server)'{-S,--server}'[serve <file>s at http://localhost:1207/]' \
+  '(--port)--port[run server at specified port instead of 1207]:Port Number' \
+  '(-o --output-dir)'{-o,--output-dir}'[write generated files to specified directory]:Output Directory:_dirs' \
+  '(-r --roff)'{-r,--roff}'[generate roff output]' \
+  '(-5 --html)'{-5,--html}'[generate entire HTML page with layout]' \
+  '(-f --fragment)'{-f,--fragment}'[generate HTML fragment]' \
+  '(--markdown)--markdown[generate post-processed markdown output]' \
+  '(--date)--date[published date in YYYY-MM-DD format]:Date' \
+  '(--manual)--manual[name of the manual]:Manual Name' \
+  '(--organization)--organization[publishing group or individual]:Organization Name' \
+  '(-w --warnings)'{-w,--warnings}'[show troff warnings on stderr]' \
+  '(-W)-W[disable previously enabled troff warnings]' \
+  '(--version)--version[show ronn version and exit]' \
+  '(--help)--help[show help message and exit]' \
+  '*:input files:_files' \
+  && ret=0
+

data/config.ru

@@ -0,0 +1,15 @@
+#\ -p 1207
+$LOAD_PATH << File.expand_path('lib', __dir__)
+
+require 'ronn'
+require 'ronn/server'
+
+# use Rack::Lint
+
+options = {
+  styles: %w[man toc],
+  organization: "Ronn v#{Ronn::VERSION}"
+}
+files = Dir['man/*.ronn'] + Dir['test/*.ronn']
+
+run Ronn::Server.new(files, options)