ron 0.2 → 0.3

data/ron.gemspec

@@ -3,8 +3,8 @@ Gem::Specification.new do |s|
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
 
   s.name = 'ron'
-  s.version = '0.2'
-  s.date = '2009-11-23'
+  s.version = '0.3'
+  s.date = '2009-12-09'
 
   s.description = "The opposite of roff"
   s.summary     = "The opposite of roff"
@@ -15,16 +15,20 @@ Gem::Specification.new do |s|
   # = MANIFEST =
   s.files = %w[
     COPYING
-    README
+    README.md
     Rakefile
     bin/ron
     lib/ron.rb
     lib/ron/document.rb
     lib/ron/layout.html
     lib/ron/roff.rb
+    man/markdown.5
     man/markdown.5.ron
+    man/ron.1
     man/ron.1.ron
+    man/ron.5
     man/ron.5.ron
+    man/ron.7
     man/ron.7.ron
     ron.gemspec
     test/angle_bracket_syntax.html
@@ -45,7 +49,7 @@ Gem::Specification.new do |s|
   s.executables = ['ron']
   s.test_files = s.files.select { |path| path =~ /^test\/.*_test.rb/ }
 
-  s.extra_rdoc_files = %w[README COPYING]
+  s.extra_rdoc_files = %w[COPYING]
   s.add_dependency 'nokogiri',    '~> 1.4'
   s.add_dependency 'rdiscount',   '~> 1.3'
   s.add_development_dependency 'contest', '~> 0.1'

data/test/ron_test.rb

@@ -1,13 +1,18 @@
 require 'contest'
-require 'ron'
 
 class RonTest < Test::Unit::TestCase
   testdir = File.dirname(__FILE__)
-  bindir = File.dirname(testdir)
+
+  # setup PATH so that we execute the right ron command
+  bindir = File.dirname(testdir) + "/bin"
   ENV['PATH'] = "#{bindir}:#{ENV['PATH']}"
-  ENV['RUBYLIB'] = $LOAD_PATH.join(':')
 
-  SIMPLE_FILE = "#{File.dirname(__FILE__)}/simple.ron"
+  # make sure the load path is setup correctly
+  libdir = File.expand_path("#{testdir}/../lib")
+  $:.unshift(libdir) unless $:.any? { |path| File.expand_path(path) == libdir }
+  ENV['RUBYLIB'] = $:.join(':')
+
+  require 'ron'
 
   test "takes ron text on stdin and produces roff on stdout" do
     output = `echo '# hello(1) -- hello world' | ron --date=2009-11-23`
@@ -16,7 +21,7 @@ class RonTest < Test::Unit::TestCase
     assert_equal %[.\\" generated with Ron/v#{Ron::VERSION}], lines.shift 
     assert_equal %[.\\" http://github.com/rtomayko/ron/], lines.shift
     assert_equal %[.], lines.shift
-    assert_equal %[.TH "HELLO" 1 "November 2009" "" ""], lines.shift
+    assert_equal %[.TH "HELLO" "1" "November 2009" "" ""], lines.shift
     assert_equal %[.], lines.shift
     assert_equal %[.SH "NAME"], lines.shift
     assert_equal %[\\fBhello\\fR \\-\\- hello world], lines.shift

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: ron
 version: !ruby/object:Gem::Version 
-  version: "0.2"
+  version: "0.3"
 platform: ruby
 authors: 
 - Ryan Tomayko
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-11-23 00:00:00 -08:00
+date: 2009-12-09 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -49,20 +49,23 @@ executables:
 extensions: []
 
 extra_rdoc_files: 
-- README
 - COPYING
 files: 
 - COPYING
-- README
+- README.md
 - Rakefile
 - bin/ron
 - lib/ron.rb
 - lib/ron/document.rb
 - lib/ron/layout.html
 - lib/ron/roff.rb
+- man/markdown.5
 - man/markdown.5.ron
+- man/ron.1
 - man/ron.1.ron
+- man/ron.5
 - man/ron.5.ron
+- man/ron.7
 - man/ron.7.ron
 - ron.gemspec
 - test/angle_bracket_syntax.html

data/README

@@ -1,149 +0,0 @@
-ron(7) -- the opposite of roff
-==============================
-
-DESCRIPTION
------------
-
-Ron is a humane text format and toolchain for
-creating UNIX man pages -- and things that
-appear as man pages from a distance. Use it
-to build and install standard UNIX roff man
-pages or to generate nicely formatted HTML
-manual pages for the web.
-
-The ron file format is based on Markdown. In
-fact, ron files are 100% Markdown compatible
-but have a more rigidly defined structure and
-extend Markdown in some ways to provide
-features commonly found in man pages (e.g.,
-definition lists). The ron(5) manual page
-included with this distribution defines the
-format in more detail.
-
-INSTALL
--------
-
-Ron can be installed using rubygems:
-
-    $ [sudo] gem install ron
-
-Or, clone the git repository and install from
-source:
-
-    $ git clone git://github.com/rtomayko/ron.git
-    $ cd ron
-    $ rake package
-    $ [sudo] rake install
-
-EXAMPLES
---------
-
-The .ron files located under the repository's
-./man directory show off a wide range of ron
-capabilities. The HTML versions of these
-files are available at:
-
-    http://rtomayko.github.com/ron/ron.1.html
-    http://rtomayko.github.com/ron/ron.5.html
-    http://rtomayko.github.com/ron/markdown.5.html
-
-BASIC USAGE
------------
-
-To generate a roff man page from the included
-`markdown.5.ron` file and open it in man(1):
-
-    $ ron -b man/markdown.5.ron
-    building: man/markdown.5
-    $ man man/markdown.5
-
-To generate a standalone HTML version:
-
-    $ ron -b --html man/markdown.5.ron
-    building: man/markdown.5.html
-    $ open man/markdown.5.html
-
-To build roff and HTML versions of all ron
-files:
-
-    $ ron -b --roff --html man/*.ron
-
-If you just want to view a ron file as if it
-were a man page without building any
-intermediate files:
-
-    $ ron -m man/markdown.5.ron
-
-The ron(1) manual page included with this
-distribution includes full documentation on
-ron command line options.
-
-RATIONALE
----------
-
-Some people think UNIX manual pages are a
-poor and outdated form of documentation. I
-disagree.
-
-- Man pages typically follow a well defined
-  structure that's immediately familiar and
-  provides a useful starting point for
-  developers documenting new tools,
-  libraries, and formats.
-
-- Man pages get to the point. Because they're
-  written in an inverted style, with a
-  SYNOPSIS section followed by additional
-  detail, prose, and finally references to
-  other sources of information, man pages
-  provide the best of both cheat sheet and
-  reference style documentation.
-
-- Man pages have very limited text formatting
-  capabilities. This is a feature. You get
-  bold and underline, basically, and they're
-  typically applied consistently across man
-  pages.
-
-- Most man pages use only a single level of
-  section hierarchy (although two levels are
-  technically supported). Hierarchy destroys
-  otherwise good documentation by adding
-  unnecessary complexity. Feynman described
-  the whole of quantum electro dynamics with
-  only two levels of hierarchy. How can you
-  possibly need more? Man pages force you to
-  keep it simple.
-
-- Man pages have a simple referencing syntax;
-  e.g., sh(1), fork(2), markdown(5).  HTML
-  versions can use this to generate links
-  between pages.
-
-- The classical terminal man page display is
-  typographically well thought out. Big bold
-  section headings, justified monospaced
-  text, nicely indented paragraphs,
-  intelligently aligned definition lists, and
-  an informational header and footer.
-
-All that being said, trying to figure out how
-to create a man page can be a really tedious
-process. The roff/man macro languages are
-highly extensible, fractured between multiple
-dialects, and include a bunch of stuff that's
-entirely irrelevant to modern man page
-creation. It's also horribly ugly compared to
-today's humane text formats or even HTML
-(just sayin').
-
-Ron aims to address many of the issues with
-man page creation while preserving the things
-that makes man pages a great form of
-documentation.
-
-COPYRIGHT
----------
-
-Ron is Copyright (C) 2009 Ryan Tomayko
-See the file COPYING for more information.