org-ruby 0.5.1 → 0.5.2

data/History.txt

@@ -1,77 +1,81 @@
-== 0.5.1 / 2009-12-30
-
-* Minor enhancement: Recognize lines starting with ":" as examples.
-* Minor enhancement: Recognize #+BEGIN_SRC as source blocks
-* Minor enhancement: Add "src" and "example" classes to <pre> blocks.
-
-== 0.5.0 / 2009-12-30
-
-* Parse (but not necessarily *use*) in-buffer settings. The following
-  in-buffer settings *are* used:
-  * Understand the #+TITLE: directive.
-  * Exporting todo keywords (option todo:t)
-  * Numbering headlines (option num:t)
-  * Skipping text before the first headline (option skip:t)
-  * Skipping tables (option |:nil)
-  * Custom todo keywords
-  * EXPORT_SELECT_TAGS and EXPORT_EXLUDE_TAGS for controlling parts of
-    the tree to export
-* Rewrite "file:(blah).org" links to "http:(blah).html" links. This
-  makes the inter-links to other org-mode files work.
-* Uses <th> tags inside table rows that precede table separators.
-* Bugfixes:
-  * Headings now have HTML escaped.
-
-== 0.4.2 / 2009-12-29
-
-* Got rid of the extraneous newline at the start of code blocks.
-* Everything now shows up in code blocks, even org-mode metadata.
-* Fixed bugs:
-  * Regressed smart double quotes with HTML escaping. Added a test
-    case and fixed the regression.
-
-== 0.4.1 / 2009-12-29
-
-* HTML is now escaped by default
-* org-mode comments will show up in a code block.
-
-== 0.4.0 / 2009-12-28
-
-* The first thing output in HTML gets the class "title"
-* HTML output is now indented
-* Proper support for multi-paragraph list items.
-* Fixed bugs:
-  * "rake spec" wouldn't work on Linux. Needed "require 'rubygems'".
-
-== 0.3.0 / 2009-12-27
-
-* Uses rubypants to get better typography (smart quotes, elipses, etc.).
-* Fixed bugs:
-  * Tables and lists did not get properly closed at the end of file
-  * You couldn't do inline formatting inside table cells
-  * Characters in PRE blocks were not HTML escaped.
-
-== 0.2.0 / 2009-12-26
-
-* Renamed the gem to org-ruby
-* Added +to_html+ for HTML output
-* Now supports the following inline markup: 
-  * bold
-  * italic
-  * code
-  * verbatim
-  * underline
-  * strikethrough
-* Continued code cleanup and refactoring
-
-== 0.1.0 / 2009-12-23
-
-* Added support for block code
-* Added support for list items that wrap in the org source
-* Major code cleanup:
-  Added +OutputBuffer+ class that should make the code more maintainable.
-
-== 0.0.2 / 2009-12-21
-
-* Initial version. Handles tables (but not headers), headlines,
-  paragraphs, block quotes, strong & emphasis formatting.
+== 0.5.2 / 2010-01-05
+
+* Refactored to improve layering.
+
+== 0.5.1 / 2009-12-30
+
+* Minor enhancement: Recognize lines starting with ":" as examples.
+* Minor enhancement: Recognize #+BEGIN_SRC as source blocks
+* Minor enhancement: Add "src" and "example" classes to <pre> blocks.
+
+== 0.5.0 / 2009-12-30
+
+* Parse (but not necessarily *use*) in-buffer settings. The following
+  in-buffer settings *are* used:
+  * Understand the #+TITLE: directive.
+  * Exporting todo keywords (option todo:t)
+  * Numbering headlines (option num:t)
+  * Skipping text before the first headline (option skip:t)
+  * Skipping tables (option |:nil)
+  * Custom todo keywords
+  * EXPORT_SELECT_TAGS and EXPORT_EXLUDE_TAGS for controlling parts of
+    the tree to export
+* Rewrite "file:(blah).org" links to "http:(blah).html" links. This
+  makes the inter-links to other org-mode files work.
+* Uses <th> tags inside table rows that precede table separators.
+* Bugfixes:
+  * Headings now have HTML escaped.
+
+== 0.4.2 / 2009-12-29
+
+* Got rid of the extraneous newline at the start of code blocks.
+* Everything now shows up in code blocks, even org-mode metadata.
+* Fixed bugs:
+  * Regressed smart double quotes with HTML escaping. Added a test
+    case and fixed the regression.
+
+== 0.4.1 / 2009-12-29
+
+* HTML is now escaped by default
+* org-mode comments will show up in a code block.
+
+== 0.4.0 / 2009-12-28
+
+* The first thing output in HTML gets the class "title"
+* HTML output is now indented
+* Proper support for multi-paragraph list items.
+* Fixed bugs:
+  * "rake spec" wouldn't work on Linux. Needed "require 'rubygems'".
+
+== 0.3.0 / 2009-12-27
+
+* Uses rubypants to get better typography (smart quotes, elipses, etc.).
+* Fixed bugs:
+  * Tables and lists did not get properly closed at the end of file
+  * You couldn't do inline formatting inside table cells
+  * Characters in PRE blocks were not HTML escaped.
+
+== 0.2.0 / 2009-12-26
+
+* Renamed the gem to org-ruby
+* Added +to_html+ for HTML output
+* Now supports the following inline markup: 
+  * bold
+  * italic
+  * code
+  * verbatim
+  * underline
+  * strikethrough
+* Continued code cleanup and refactoring
+
+== 0.1.0 / 2009-12-23
+
+* Added support for block code
+* Added support for list items that wrap in the org source
+* Major code cleanup:
+  Added +OutputBuffer+ class that should make the code more maintainable.
+
+== 0.0.2 / 2009-12-21
+
+* Initial version. Handles tables (but not headers), headlines,
+  paragraphs, block quotes, strong & emphasis formatting.

data/README.rdoc

@@ -1,66 +1,66 @@
-org-ruby
-    by Brian Dewey
-    http://github.com/bdewey/org-ruby
-
-== DESCRIPTION:
-
-This gem contains Ruby routines for parsing org-mode files.The most
-significant thing this library does today is convert org-mode files to
-HTML or textile. Currently, you cannot do much to customize the
-conversion. The supplied textile conversion is optimized for
-extracting "content" from the orgfile as opposed to "metadata." 
-
-== FEATURES/PROBLEMS:
-
-* Converts org-mode files to HTML or Textile
-* Supports tables, block quotes, and block code
-* Supports bold, italic, underline, strikethrough, and code inline formatting.
-* Supports hyperlinks that are in double-brackets
-* Upcoming: Handle export options specified in the org buffer.
-
-== SYNOPSIS:
-
-From the command line:
-
-     org-ruby sample.org
-
-...will output a HTML version of sample.org.
-
-     org-ruby --translate textile sample.org
-
-...will output a textile version of sample.org.
-
-From Ruby code:
-
-     Orgmode::Parser.new(data)
-
-...will construct a new +Parser+ object. 
-
-== INSTALL:
-
-sudo gem install org-ruby
-
-== LICENSE:
-
-(The MIT License)
-
-Copyright (c) 2009 Brian Dewey
-
-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.
+org-ruby
+    by Brian Dewey
+    http://github.com/bdewey/org-ruby
+
+== DESCRIPTION:
+
+This gem contains Ruby routines for parsing org-mode files.The most
+significant thing this library does today is convert org-mode files to
+HTML or textile. Currently, you cannot do much to customize the
+conversion. The supplied textile conversion is optimized for
+extracting "content" from the orgfile as opposed to "metadata." 
+
+== FEATURES/PROBLEMS:
+
+* Converts org-mode files to HTML or Textile
+* Supports tables, block quotes, and block code
+* Supports bold, italic, underline, strikethrough, and code inline formatting.
+* Supports hyperlinks that are in double-brackets
+* Upcoming: Handle export options specified in the org buffer.
+
+== SYNOPSIS:
+
+From the command line:
+
+     org-ruby sample.org
+
+...will output a HTML version of sample.org.
+
+     org-ruby --translate textile sample.org
+
+...will output a textile version of sample.org.
+
+From Ruby code:
+
+     Orgmode::Parser.new(data)
+
+...will construct a new +Parser+ object. 
+
+== INSTALL:
+
+sudo gem install org-ruby
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2009 Brian Dewey
+
+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/Rakefile

@@ -1,28 +1,28 @@
-
-begin
-  require 'bones'
-rescue LoadError
-  abort '### Please install the "bones" gem ###'
-end
-
-ensure_in_path 'lib'
-require 'org-ruby'
-
-task :default => 'test:run'
-task 'gem:release' => 'test:run'
-
-Bones {
-  readme_file 'README.rdoc'
-  name  'org-ruby'
-  authors  'Brian Dewey'
-  email  'bdewey@gmail.com'
-  url  'http://github.com/bdewey/org-ruby'
-  version  OrgRuby::VERSION
-  colorize false                # Windows consoles won't colorize
-  gem.need_tar false            # Can't TAR from Windows
-  depend_on 'rubypants'
-  spec.opts ['-D', '--color']
-}
-
-
-# EOF
+
+begin
+  require 'bones'
+rescue LoadError
+  abort '### Please install the "bones" gem ###'
+end
+
+ensure_in_path 'lib'
+require 'org-ruby'
+
+task :default => 'test:run'
+task 'gem:release' => 'test:run'
+
+Bones {
+  readme_file 'README.rdoc'
+  name  'org-ruby'
+  authors  'Brian Dewey'
+  email  'bdewey@gmail.com'
+  url  'http://github.com/bdewey/org-ruby'
+  version  OrgRuby::VERSION
+  colorize false                # Windows consoles won't colorize
+  gem.need_tar false            # Can't TAR from Windows
+  depend_on 'rubypants'
+  spec.opts ['-D', '--color']
+}
+
+
+# EOF

data/bin/org-ruby

@@ -1,40 +1,40 @@
-#!/usr/bin/env ruby
-
-require File.expand_path(
-    File.join(File.dirname(__FILE__), %w[.. lib org-ruby]))
-require 'optparse'
-
-# Put your code here
-
-options = {}
-options_parser = OptionParser.new do |opts|
-  options[:help] = false
-  options[:format] = :html
-  
-  opts.banner = "Usage: org-ruby <file> [options]"
-
-  opts.on("-h", "--help", "Show this message") do |v|
-    options[:help] = true
-  end
-
-  opts.on("-t", "--translate FORMAT", [:html, :textile],
-          "Translate the ORG file to the specified format.") do |v|
-    options[:format] = v
-  end
-end
-
-begin
-  options_parser.parse!
-  if (ARGV.length == 0) then
-    puts options_parser
-  else
-    data = IO.read(ARGV[0])
-    p = Orgmode::Parser.new(data)
-    puts p.to_html if options[:format] == :html
-    puts p.to_textile if options[:format] == :textile
-  end
-rescue OptionParser::ParseError
-  puts options_parser
-end
-
-
+#!/usr/bin/env ruby
+
+require File.expand_path(
+    File.join(File.dirname(__FILE__), %w[.. lib org-ruby]))
+require 'optparse'
+
+# Put your code here
+
+options = {}
+options_parser = OptionParser.new do |opts|
+  options[:help] = false
+  options[:format] = :html
+  
+  opts.banner = "Usage: org-ruby <file> [options]"
+
+  opts.on("-h", "--help", "Show this message") do |v|
+    options[:help] = true
+  end
+
+  opts.on("-t", "--translate FORMAT", [:html, :textile],
+          "Translate the ORG file to the specified format.") do |v|
+    options[:format] = v
+  end
+end
+
+begin
+  options_parser.parse!
+  if (ARGV.length == 0) then
+    puts options_parser
+  else
+    data = IO.read(ARGV[0])
+    p = Orgmode::Parser.new(data)
+    puts p.to_html if options[:format] == :html
+    puts p.to_textile if options[:format] == :textile
+  end
+rescue OptionParser::ParseError
+  puts options_parser
+end
+
+

data/lib/org-ruby.rb

@@ -1,50 +1,50 @@
-unless defined? ::OrgRuby
-
-module OrgRuby
-
-  # :stopdoc:
-  VERSION = '0.5.1'
-  LIBPATH = ::File.expand_path(::File.dirname(__FILE__)) + ::File::SEPARATOR
-  PATH = ::File.dirname(LIBPATH) + ::File::SEPARATOR
-  # :startdoc:
-
-  # Returns the version string for the library.
-  #
-  def self.version
-    VERSION
-  end
-
-  # Returns the library path for the module. If any arguments are given,
-  # they will be joined to the end of the libray path using
-  # <tt>File.join</tt>.
-  #
-  def self.libpath( *args )
-    args.empty? ? LIBPATH : ::File.join(LIBPATH, args.flatten)
-  end
-
-  # Returns the lpath for the module. If any arguments are given,
-  # they will be joined to the end of the path using
-  # <tt>File.join</tt>.
-  #
-  def self.path( *args )
-    args.empty? ? PATH : ::File.join(PATH, args.flatten)
-  end
-
-  # Utility method used to require all files ending in .rb that lie in the
-  # directory below this file that has the same name as the filename passed
-  # in. Optionally, a specific _directory_ name can be passed in such that
-  # the _filename_ does not have to be equivalent to the directory.
-  #
-  def self.require_all_libs_relative_to( fname, dir = nil )
-    dir ||= ::File.basename(fname, '.*')
-    search_me = ::File.expand_path(
-        ::File.join(::File.dirname(fname), dir, '**', '*.rb'))
-
-    Dir.glob(search_me).sort.each {|rb| require rb}
-  end
-
-end  # module OrgmodeParser
-
-OrgRuby.require_all_libs_relative_to(__FILE__)
-
-end                             # unless defined?
+unless defined? ::OrgRuby
+
+module OrgRuby
+
+  # :stopdoc:
+  VERSION = '0.5.2'
+  LIBPATH = ::File.expand_path(::File.dirname(__FILE__)) + ::File::SEPARATOR
+  PATH = ::File.dirname(LIBPATH) + ::File::SEPARATOR
+  # :startdoc:
+
+  # Returns the version string for the library.
+  #
+  def self.version
+    VERSION
+  end
+
+  # Returns the library path for the module. If any arguments are given,
+  # they will be joined to the end of the libray path using
+  # <tt>File.join</tt>.
+  #
+  def self.libpath( *args )
+    args.empty? ? LIBPATH : ::File.join(LIBPATH, args.flatten)
+  end
+
+  # Returns the lpath for the module. If any arguments are given,
+  # they will be joined to the end of the path using
+  # <tt>File.join</tt>.
+  #
+  def self.path( *args )
+    args.empty? ? PATH : ::File.join(PATH, args.flatten)
+  end
+
+  # Utility method used to require all files ending in .rb that lie in the
+  # directory below this file that has the same name as the filename passed
+  # in. Optionally, a specific _directory_ name can be passed in such that
+  # the _filename_ does not have to be equivalent to the directory.
+  #
+  def self.require_all_libs_relative_to( fname, dir = nil )
+    dir ||= ::File.basename(fname, '.*')
+    search_me = ::File.expand_path(
+        ::File.join(::File.dirname(fname), dir, '**', '*.rb'))
+
+    Dir.glob(search_me).sort.each {|rb| require rb}
+  end
+
+end  # module OrgmodeParser
+
+OrgRuby.require_all_libs_relative_to(__FILE__)
+
+end                             # unless defined?