RubyGems - ron - Versions diffs - 0.1 → 0.3 - Mend

ron 0.1 → 0.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (29) hide show

data/README.md +133 -0
data/Rakefile +27 -6
data/bin/ron +56 -20
data/lib/ron/document.rb +221 -49
data/lib/ron/layout.html +58 -22
data/lib/ron/roff.rb +39 -6
data/lib/ron.rb +5 -4
data/man/markdown.5 +1614 -0
data/man/ron.1 +226 -0
data/man/ron.1.ron +79 -57
data/man/ron.5 +210 -0
data/man/ron.5.ron +39 -35
data/man/ron.7 +201 -0
data/man/ron.7.ron +133 -0
data/ron.gemspec +19 -5
data/test/angle_bracket_syntax.html +12 -0
data/test/angle_bracket_syntax.ron +12 -0
data/test/basic_document.html +3 -0
data/test/{simple.ron → basic_document.ron} +2 -0
data/test/custom_title_document.html +3 -0
data/test/custom_title_document.ron +5 -0
data/test/definition_list_syntax.html +21 -0
data/test/definition_list_syntax.ron +18 -0
data/test/document_test.rb +64 -11
data/test/ron_test.rb +37 -7
data/test/titleless_document.html +2 -0
data/test/titleless_document.ron +2 -0
metadata +18 -5
data/README +0 -145

data/test/document_test.rb CHANGED Viewed

@@ -2,34 +2,87 @@ require 'contest'
 require 'ron/document'
 class DocumentTest < Test::Unit::TestCase
-  SIMPLE_FILE = "#{File.dirname(__FILE__)}/simple.ron"
-  HELLO_DATA = "# hello(1) -- hello world"
+  SIMPLE_FILE = "#{File.dirname(__FILE__)}/basic_document.ron"
-  test "creating with a file" do
+  test "new with path" do
     doc = Ron::Document.new(SIMPLE_FILE)
     assert_equal File.read(SIMPLE_FILE), doc.data
   end
-  test "creating with a string and a file" do
-    doc = Ron::Document.new('hello.1.ron') { HELLO_DATA }
-    assert_equal HELLO_DATA, doc.data
+  test "new with path and block" do
+    doc = Ron::Document.new('hello.1.ron') { "# hello(1) -- hello world" }
+    assert_equal "# hello(1) -- hello world", doc.data
   end
-  context "Document" do
+  test "new with path and block but missing name section" do
+    doc = Ron::Document.new('foo.7.ron') { '' }
+    assert_equal 'foo', doc.name
+    assert_equal '7', doc.section
+  end
+  test "new with non conventional path and missing name section" do
+    doc = Ron::Document.new('bar.ron') { '' }
+    assert_equal 'bar', doc.name
+    assert_equal nil, doc.section
+    assert_equal "./bar.html", doc.path_for('html')
+    assert_equal "./bar", doc.path_for('roff')
+    assert_equal "./bar", doc.path_for('')
+    assert_equal "./bar", doc.path_for(nil)
+  end
+  test "new with path and name section mismatch" do
+    doc = Ron::Document.new('foo/rick.7.ron') { "# randy(3) -- I'm confused." }
+    assert_equal 'randy', doc.name
+    assert_equal 'rick', doc.path_name
+    assert_equal '3', doc.section
+    assert_equal '7', doc.path_section
+    assert_equal 'rick.7', doc.basename
+    assert_equal 'foo/rick.7.bar', doc.path_for(:bar)
+  end
+  test "new with no path and a name section" do
+    doc = Ron::Document.new { "# brandy(5) -- wootderitis" }
+    assert_equal nil, doc.path_name
+    assert_equal nil, doc.path_section
+    assert_equal 'brandy', doc.name
+    assert_equal '5', doc.section
+    assert_equal 'brandy.5', doc.basename
+    assert_equal 'brandy.5.foo', doc.path_for(:foo)
+  end
+  context "simple conventionally named document" do
     setup do
-      @doc = Ron::Document.new('hello.1.ron') { HELLO_DATA }
+      @doc = Ron::Document.new('hello.1.ron') { "# hello(1) -- hello world" }
     end
     should "load data" do
-      assert_equal HELLO_DATA, @doc.data
+      assert_equal "# hello(1) -- hello world", @doc.data
     end
-    should "extract the name" do
+    should "extract the manual page name from the filename or document" do
       assert_equal 'hello', @doc.name
     end
-    should "extract the section" do
+    should "extract the manual page section from the filename or document" do
       assert_equal '1', @doc.section
     end
+    should "convert to an HTML fragment" do
+      assert_equal %[<h2 id='NAME'>NAME</h2>\n<p><code>hello</code> -- hello world</p>\n],
+        @doc.to_html_fragment
+    end
+    should "convert to HTML with a layout" do
+      assert_match %r{^<!DOCTYPE html.*}m, @doc.to_html
+      assert_match %[<h2 id='NAME'>NAME</h2>\n<p><code>hello</code> -- hello world</p>],
+        @doc.to_html
+    end
+    should "construct a path to related documents" do
+      assert_equal "./hello.1.html", @doc.path_for(:html)
+      assert_equal "./hello.1", @doc.path_for(:roff)
+      assert_equal "./hello.1", @doc.path_for('')
+      assert_equal "./hello.1", @doc.path_for(nil)
+    end
   end
 end

data/test/ron_test.rb CHANGED Viewed

@@ -1,21 +1,27 @@
 require 'contest'
-# ron command tests
 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']}"
-  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`
+    output = `echo '# hello(1) -- hello world' | ron --date=2009-11-23`
     lines = output.split("\n")
     assert_equal 7, lines.size
-    assert_equal %[.\\" generated with Ron], lines.shift
+    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 "" "" ""], 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
@@ -24,6 +30,30 @@ class RonTest < Test::Unit::TestCase
   test "produces html instead of roff with the --html argument" do
     output = `echo '# hello(1) -- hello world' | ron --html`
-    assert_match(/<h2 id="NAME">NAME<\/h2>/, output)
+    assert_match(/<h2 id='NAME'>NAME<\/h2>/, output)
+  end
+  test "produces html fragment with the --fragment argument" do
+    output = `echo '# hello(1) -- hello world' | ron --fragment`
+    assert_equal "<h2 id='NAME'>NAME</h2>\n<p><code>hello</code> -- hello world</p>\n",
+      output
+  end
+  # file based tests
+  Dir[testdir + '/*.ron'].each do |source|
+    dest = source.sub(/ron$/, 'html')
+    wrong = source.sub(/ron$/, "wrong")
+    test File.basename(source, '.ron') do
+      html = `ron --html --fragment #{source}`
+      expected = File.read(dest) rescue ''
+      if expected != html
+        File.open(wrong, 'wb') { |f| f.write(html) }
+        diff = `diff -u #{dest} #{wrong} 2>/dev/null`
+        fail "the #{dest} file does not exist" if diff.empty?
+        flunk diff
+      elsif File.exist?(wrong)
+        File.unlink(wrong)
+      end
+    end
   end
 end

data/test/titleless_document.html ADDED Viewed

	@@ -0,0 +1,2 @@
1	+ <p>This is a document without a level 1 heading. It doesn't output
2	+ a <code>NAME</code> section or custom <code><h1></code>.</p>

data/test/titleless_document.ron ADDED Viewed

	@@ -0,0 +1,2 @@
1	+ This is a document without a level 1 heading. It doesn't output
2	+ a `NAME` section or custom `<h1>`.

metadata CHANGED Viewed

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ron
 version: !ruby/object:Gem::Version
-  version: "0.1"
+  version: "0.3"
 platform: ruby
 authors:
 - Ryan Tomayko
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
-date: 2009-11-05 00:00:00 -08:00
+date: 2009-12-09 00:00:00 -08:00
 default_executable:
 dependencies:
 - !ruby/object:Gem::Dependency
@@ -49,24 +49,37 @@ 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
+- test/angle_bracket_syntax.ron
+- test/basic_document.html
+- test/basic_document.ron
+- test/custom_title_document.html
+- test/custom_title_document.ron
+- test/definition_list_syntax.html
+- test/definition_list_syntax.ron
 - test/document_test.rb
 - test/ron_test.rb
-- test/simple.ron
+- test/titleless_document.html
+- test/titleless_document.ron
 has_rdoc: true
 homepage: http://github.com/rtomayko/ron/
 licenses: []

data/README DELETED Viewed

@@ -1,145 +0,0 @@
-         ron -- the opposite of roff
-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
--------
-The easiest way to install ron is with
-rubygems:
-    $ [sudo] gem install ron -s gems.gemcutter.org
-Or, clone the git repository and install from
-source:
-    $ git clone git://github.com/rtomayko/ron.git
-    $ cd ron
-    $ 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.