ron 0.3 → 0.4

data/ron.gemspec

@@ -1,62 +1,50 @@
 Gem::Specification.new do |s|
   s.specification_version = 2 if s.respond_to? :specification_version=
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
 
   s.name = 'ron'
-  s.version = '0.3'
-  s.date = '2009-12-09'
+  s.version = '0.4'
+  s.date = '2010-03-08'
 
-  s.description = "The opposite of roff"
-  s.summary     = "The opposite of roff"
+  s.description = "ron -- the opposite of roff -- is now known as 'ronn'"
+
+  s.summary     = (<<-TEXT).gsub(/^ {4}/, '')
+    IMPORTANT: ron -- the opposite of roff -- is now known as "ronn". Ownership
+    of the "ron" gem will be handed over to the Ruby Object Notation (Ron)
+    project in the not-too-distant future.
+
+    If you came here looking for "ron" -- the opposite of roff --, see the
+    "ronn" gem instead: http://rubygems.org/gems/ronn
+
+    If you came here looking for Ron (Ruby Object Notation), see the "Ron"
+    gem instead: http://rubygems.org/gems/Ron
+  TEXT
 
   s.authors = ["Ryan Tomayko"]
   s.email = "rtomayko@gmail.com"
-
-  # = MANIFEST =
-  s.files = %w[
-    COPYING
-    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/titleless_document.html
-    test/titleless_document.ron
-  ]
-  # = MANIFEST =
-
-  s.executables = ['ron']
-  s.test_files = s.files.select { |path| path =~ /^test\/.*_test.rb/ }
-
-  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'
+  s.files = %w[ron.gemspec]
+  s.executables = []
+  s.test_files = []
 
   s.has_rdoc = true
-  s.homepage = "http://github.com/rtomayko/ron/"
-  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Ron"]
-  s.require_paths = %w[lib]
-  s.rubygems_version = '1.1.1'
+  s.homepage = "http://rtomayko.github.com/ronn/"
+  s.require_paths = ['.']
+  s.add_dependency 'ronn', '>= 0.4'
+
+  s.post_install_message = (<<-TEXT).gsub(/^ {4}/, '')
+    ==================================================================
+    WARNING: ron -- the opposite of roff -- is now known as "ronn"
+
+    The "ronn" gem has automatically been installed. However, in the
+    not-too-distant future, the "ron" gem will be owned by the
+    Ruby Object Notation <http://github.com/coatl/ron> project. Please
+    use the "ronn" gem to install ronn -- the opposite of roff -- from
+    this point forward.
+
+    If you meant to install the Ruby Object Notation (Ron) gem,
+    uninstall the "ron" and "ronn" gems and install the "Ron" gem:
+      gem uninstall ron ronn
+      gem install Ron
+    ==================================================================
+  TEXT
 end

metadata

@@ -1,7 +1,11 @@
 --- !ruby/object:Gem::Specification 
 name: ron
 version: !ruby/object:Gem::Version 
-  version: "0.3"
+  prerelease: false
+  segments: 
+  - 0
+  - 4
+  version: "0.4"
 platform: ruby
 authors: 
 - Ryan Tomayko
@@ -9,108 +13,77 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-12-09 00:00:00 -08:00
+date: 2010-03-08 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: nokogiri
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  name: ronn
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
     requirements: 
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version 
-        version: "1.4"
-    version: 
-- !ruby/object:Gem::Dependency 
-  name: rdiscount
+        segments: 
+        - 0
+        - 4
+        version: "0.4"
   type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        version: "1.3"
-    version: 
-- !ruby/object:Gem::Dependency 
-  name: contest
-  type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        version: "0.1"
-    version: 
-description: The opposite of roff
+  version_requirements: *id001
+description: ron -- the opposite of roff -- is now known as 'ronn'
 email: rtomayko@gmail.com
-executables: 
-- ron
+executables: []
+
 extensions: []
 
-extra_rdoc_files: 
-- COPYING
+extra_rdoc_files: []
+
 files: 
-- COPYING
-- 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/titleless_document.html
-- test/titleless_document.ron
 has_rdoc: true
-homepage: http://github.com/rtomayko/ron/
+homepage: http://rtomayko.github.com/ronn/
 licenses: []
 
-post_install_message: 
-rdoc_options: 
-- --line-numbers
-- --inline-source
-- --title
-- Ron
+post_install_message: |
+  ==================================================================
+  WARNING: ron -- the opposite of roff -- is now known as "ronn"
+  
+  The "ronn" gem has automatically been installed. However, in the
+  not-too-distant future, the "ron" gem will be owned by the
+  Ruby Object Notation <http://github.com/coatl/ron> project. Please
+  use the "ronn" gem to install ronn -- the opposite of roff -- from
+  this point forward.
+  
+  If you meant to install the Ruby Object Notation (Ron) gem,
+  uninstall the "ron" and "ronn" gems and install the "Ron" gem:
+    gem uninstall ron ronn
+    gem install Ron
+  ==================================================================
+
+rdoc_options: []
+
 require_paths: 
-- lib
+- .
 required_ruby_version: !ruby/object:Gem::Requirement 
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      version: "0"
-  version: 
+      segments: 
+      - 1
+      - 2
+      version: "1.2"
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.5
+rubygems_version: 1.3.6
 signing_key: 
 specification_version: 2
-summary: The opposite of roff
-test_files: 
-- test/document_test.rb
-- test/ron_test.rb
+summary: "IMPORTANT: ron -- the opposite of roff -- is now known as \"ronn\". Ownership of the \"ron\" gem will be handed over to the Ruby Object Notation (Ron) project in the not-too-distant future.  If you came here looking for \"ron\" -- the opposite of roff --, see the \"ronn\" gem instead: http://rubygems.org/gems/ronn  If you came here looking for Ron (Ruby Object Notation), see the \"Ron\" gem instead: http://rubygems.org/gems/Ron"
+test_files: []
+

data/COPYING

@@ -1,21 +0,0 @@
-       Copyright (C) 2009 Ryan Tomayko <tomayko.com/about>
-
-Permission  is  hereby granted, free of charge, to any person ob-
-taining a copy of  this  software  and  associated  documentation
-files  (the "Software"), to deal in the Software without restric-
-tion, including without limitation the rights to use, copy, modi-
-fy, merge, publish, distribute, sublicense, and/or sell copies of
-the Software, and to permit persons to whom the Software is  fur-
-nished 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  NONIN-
-FRINGEMENT. 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

@@ -1,133 +0,0 @@
-ron -- 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 a
-compatible subset of Markdown syntax but have a more rigid structure and
-extend Markdown in some ways to provide features commonly found in man
-pages (e.g., definition lists). The ron(5) manual page defines the
-format in more detail.
-
-## DOCUMENTATION
-
-The `.ron` files located under the `man/` directory show off a wide
-range of ron capabilities and are the source of Ron's own documentation.
-The source files and generated HTML / roff output files are available
-at:
-
-  * [ron(1)](http://rtomayko.github.com/ron/ron.1.html) -
-    build markdown based manual pages at the command line.  
-    [source file](http://github.com/rtomayko/ron/blob/master/man/ron.1.ron),
-    [roff output](http://github.com/rtomayko/ron/blob/master/man/ron.1)
-
-  * [ron(5)](http://rtomayko.github.com/ron/ron.5.html) -
-    humane manual page authoring format syntax reference.  
-    [source file](http://github.com/rtomayko/ron/blob/master/man/ron.5.ron),
-    [roff output](http://github.com/rtomayko/ron/blob/master/man/ron.5)
-
-  * [markdown(5)](http://rtomayko.github.com/ron/markdown.5.html) -
-    humane text markup syntax (taken from
-    [Markdown Syntax](http://daringfireball.net/projects/markdown/syntax),
-    John Gruber)  
-    [source file](http://github.com/rtomayko/ron/blob/master/man/ron.5.ron),
-    [roff output](http://github.com/rtomayko/ron/blob/master/man/ron.5)
-
-## INSTALL
-
-Install with Rubygems:
-
-    $ [sudo] gem install ron
-    $ ron --help
-
-Or, clone the git repository:
-
-    $ git clone git://github.com/rtomayko/ron.git
-    $ PATH=ron/bin:$PATH
-    $ ron --help
-
-## BASIC USAGE
-
-To generate a roff man page from the included
-[`markdown.5.ron`](man/markdown.5.ron) file and open it with 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 intermediate files:
-
-    $ ron -m man/markdown.5.ron
-
-The [ron(1)](http://rtomayko.github.com/ron/ron.1.html) manual page
-includes comprehensive documentation on `ron` command line options.
-
-## ABOUT
-
-Some people think UNIX manual pages are a poor and outdated style of
-documentation. I disagree:
-
-- Man pages 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 references to other sources of information, man pages
-  provide the best of both cheat sheet and reference style
-  documentation.
-
-- Man pages have extremely -- unbelievably -- limited 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 man pages use only a single level. Unwieldy
-  document hierarchies complicate otherwise good documentation.
-  Feynman covered all of physics -- heavenly bodies through QED --
-  with only two levels of document hierarchy (_The Feynman Lectures
-  on Physics_, 1970).
-
-- 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 monospace text,
-  nicely indented paragraphs, intelligently aligned definition
-  lists, and an informational header and footer.
-
-Unfortunately, trying to figure out how to create a man page is a
-fairly tedious process. The roff/man macro languages are highly
-extensible, fractured between multiple dialects, and include a bunch
-of device specific stuff that's entirely irrelevant to modern
-publishing tools.
-
-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.
-
-## COPYING
-
-Ron is Copyright (C) 2009 [Ryan Tomayko](http://tomayko.com/about)
-See the file COPYING for information of licensing and distribution.
-
-## SEE ALSO
-
-ron(1), ron(5), markdown(5)

data/Rakefile

@@ -1,94 +0,0 @@
-require 'rake/clean'
-
-task :default => :test
-
-task :environment do
-  require_library 'nokogiri'
-  require_library 'rdiscount'
-  ENV['RUBYLIB'] = "#{$:.join(':')}:#{ENV['RUBYLIB']}"
-  ENV['PATH'] = "bin:#{ENV['PATH']}"
-end
-
-desc 'Run tests'
-task :test => :environment do
-  require_library 'contest'
-  if ENV['PATH'].split(':').any? { |p| File.executable?("#{p}/turn") }
-    sh 'turn -Ilib test/*_test.rb'
-  else
-    sh 'testrb Ilib test/*_test.rb'
-  end
-end
-
-desc 'Build the manual'
-task :man => :environment do
-  sh "ron -br5 --manual='Ron Manual' --organization='Ryan Tomayko' man/*.ron"
-end
-
-# PACKAGING ============================================================
-
-require 'rubygems/specification'
-$spec = eval(File.read('ron.gemspec'))
-
-def package(ext='')
-  "pkg/ron-#{$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/ ron.gemspec] + $spec.files do |f|
-  sh "gem build ron.gemspec"
-  mv File.basename(f.name), f.name
-end
-
-file package('.tar.gz') => %w[pkg/] + $spec.files do |f|
-  sh <<-SH
-    git archive --prefix=ron-#{source_version}/ --format=tar HEAD |
-    gzip > #{f.name}
-  SH
-end
-
-# Gemspec Helpers ====================================================
-
-def source_version
-  line = File.read('lib/ron.rb')[/^\s*VERSION = .*/]
-  line.match(/.*VERSION = '(.*)'/)[1]
-end
-
-file 'ron.gemspec' => FileList['{lib,test}/**','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
-  abort "fatal: the '#{name}' library is required (gem install #{name})"
-end