org-ruby 0.2.0 → 0.3.0

data/History.txt

@@ -1,24 +1,32 @@
-== 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.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.txt

@@ -1,66 +1,66 @@
-org-ruby
-    by Brian Dewey
-    http://www.bdewey.com
-
-== 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,22 +1,26 @@
-
-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 {
-  name  'org-ruby'
-  authors  'Brian Dewey'
-  email  'bdewey@gmail.com'
-  url  'http://bdewey.com'
-  version  OrgRuby::VERSION
-}
-
-# 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 {
+  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'
+}
+
+
+# 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,48 +1,50 @@
-
-module OrgRuby
-
-  # :stopdoc:
-  VERSION = '0.2.0'
-  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__)
-
+unless defined? ::OrgRuby
+
+module OrgRuby
+
+  # :stopdoc:
+  VERSION = '0.3.0'
+  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?

data/lib/org-ruby/headline.rb

@@ -1,75 +1,75 @@
-require OrgRuby.libpath(*%w[org-ruby line])
-
-module Orgmode
-
-  # Represents a headline in an orgmode file.
-  class Headline < Line
-
-    # This is the "level" of the headline
-    attr_reader :level
-
-    # This is the headline text -- the part of the headline minus the leading
-    # asterisks, the keywords, and the tags.
-    attr_reader :headline_text
-
-    # This contains the lines that "belong" to the headline.
-    attr_reader :body_lines
-
-    # These are the headline tags
-    attr_reader :tags
-
-    # Optional keyword found at the beginning of the headline.
-    attr_reader :keyword
-
-    # This is the regex that matches a line
-    LineRegexp = /^\*+\s+/
-
-    # This matches the tags on a headline
-    TagsRegexp = /\s*:[\w:]*:\s*$/
-
-    # Special keywords allowed at the start of a line.
-    Keywords = %w[TODO DONE]
-
-    KeywordsRegexp = Regexp.new("\\s*(#{Keywords.join('|')})\\s*")
-
-    def initialize(line)
-      super(line)
-      @body_lines = []
-      @tags = []
-      if (@line =~ LineRegexp) then
-        @level = $&.strip.length
-        @headline_text = $'.strip
-        if (@headline_text =~ TagsRegexp) then
-          @tags = $&.split(/:/)              # split tag text on semicolon
-          @tags.delete_at(0)                 # the first item will be empty; discard
-          @headline_text.gsub!(TagsRegexp, "") # Removes the tags from the headline
-        end
-        if (@headline_text =~ KeywordsRegexp) then
-          @headline_text = $'
-          @keyword = $1
-        end
-      else
-        raise "'#{line}' is not a valid headline"
-      end
-    end
-
-    # Determines if a line is an orgmode "headline":
-    # A headline begins with one or more asterisks.
-    def self.headline?(line)
-      line =~ LineRegexp
-    end
-
-    # Converts this headline and its body to textile.
-    def to_textile
-      output = "h#{@level}. #{@headline_text}\n"
-      output << Line.to_textile(@body_lines)
-      output
-    end
-
-    def to_html
-      output = "<h#{@level}>#{@headline_text}</h#{@level}>\n"
-      output << Line.to_html(@body_lines)
-      output
-    end
-  end                           # class Headline
-end                             # class Orgmode
+require OrgRuby.libpath(*%w[org-ruby line])
+
+module Orgmode
+
+  # Represents a headline in an orgmode file.
+  class Headline < Line
+
+    # This is the "level" of the headline
+    attr_reader :level
+
+    # This is the headline text -- the part of the headline minus the leading
+    # asterisks, the keywords, and the tags.
+    attr_reader :headline_text
+
+    # This contains the lines that "belong" to the headline.
+    attr_reader :body_lines
+
+    # These are the headline tags
+    attr_reader :tags
+
+    # Optional keyword found at the beginning of the headline.
+    attr_reader :keyword
+
+    # This is the regex that matches a line
+    LineRegexp = /^\*+\s+/
+
+    # This matches the tags on a headline
+    TagsRegexp = /\s*:[\w:]*:\s*$/
+
+    # Special keywords allowed at the start of a line.
+    Keywords = %w[TODO DONE]
+
+    KeywordsRegexp = Regexp.new("\\s*(#{Keywords.join('|')})\\s*")
+
+    def initialize(line)
+      super(line)
+      @body_lines = []
+      @tags = []
+      if (@line =~ LineRegexp) then
+        @level = $&.strip.length
+        @headline_text = $'.strip
+        if (@headline_text =~ TagsRegexp) then
+          @tags = $&.split(/:/)              # split tag text on semicolon
+          @tags.delete_at(0)                 # the first item will be empty; discard
+          @headline_text.gsub!(TagsRegexp, "") # Removes the tags from the headline
+        end
+        if (@headline_text =~ KeywordsRegexp) then
+          @headline_text = $'
+          @keyword = $1
+        end
+      else
+        raise "'#{line}' is not a valid headline"
+      end
+    end
+
+    # Determines if a line is an orgmode "headline":
+    # A headline begins with one or more asterisks.
+    def self.headline?(line)
+      line =~ LineRegexp
+    end
+
+    # Converts this headline and its body to textile.
+    def to_textile
+      output = "h#{@level}. #{@headline_text}\n"
+      output << Line.to_textile(@body_lines)
+      output
+    end
+
+    def to_html
+      output = "<h#{@level}>#{@headline_text}</h#{@level}>\n"
+      output << Line.to_html(@body_lines)
+      output
+    end
+  end                           # class Headline
+end                             # class Orgmode