org-ruby 0.2.0

data/.bnsignore

@@ -0,0 +1,18 @@
+# The list of files that should be ignored by Mr Bones.
+# Lines that start with '#' are comments.
+#
+# A .gitignore file can be used instead by setting it as the ignore
+# file in your Rakefile:
+#
+#   Bones {
+#     ignore_file  '.gitignore'
+#   }
+#
+# For a project with a C extension, the following would be a good set of
+# exclude patterns (uncomment them if you want to use them):
+# *.[oa]
+# *~
+announcement.txt
+coverage
+doc
+pkg

data/History.txt

@@ -0,0 +1,24 @@
+== 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

@@ -0,0 +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.

data/Rakefile

@@ -0,0 +1,22 @@
+
+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

data/TAGS

@@ -0,0 +1,128 @@
+
+./spec/parser_spec.rb,0
+
+./spec/headline_spec.rb,0
+
+./spec/line_spec.rb,0
+
+./spec/spec_helper.rb,0
+
+./spec/regexp_helper_spec.rb,0
+
+./spec/textile_output_buffer_spec.rb,0
+
+./lib/org-ruby.rb,242
+module OrgRuby::OrgRuby
2,1
+  def self.version::OrgRuby.version
12,251
+  def self.libpath::OrgRuby.libpath
20,450
+  def self.path::OrgRuby.path
28,695
+  def self.require_all_libs_relative_to::OrgRuby.require_all_libs_relative_to
37,1082
+
+./lib/org-ruby/html_output_buffer.rb,349
+module Orgmode::Orgmode
3,54
+  class HtmlOutputBuffer::Orgmode::HtmlOutputBuffer
5,72
+    def push_mode::Orgmode::HtmlOutputBuffer#push_mode
22,417
+    def pop_mode::Orgmode::HtmlOutputBuffer#pop_mode
27,525
+    def flush!::Orgmode::HtmlOutputBuffer#flush!
32,647
+    def inline_formatting::Orgmode::HtmlOutputBuffer#inline_formatting
62,1689
+
+./lib/org-ruby/output_buffer.rb,1195
+module Orgmode::Orgmode
3,18
+  class OutputBuffer::Orgmode::OutputBuffer
9,297
+    attr_reader :buffer::Orgmode::OutputBuffer#buffer
12,381
+    attr_reader :output::Orgmode::OutputBuffer#output
15,446
+    attr_accessor :output_type::Orgmode::OutputBuffer#output_type
18,532
+    def initialize::Orgmode::OutputBuffer#Orgmode::OutputBuffer.new
22,686
+    def current_mode::Orgmode::OutputBuffer#current_mode
40,1138
+    def current_mode_list?::Orgmode::OutputBuffer#current_mode_list?
44,1197
+    def push_mode::Orgmode::OutputBuffer#push_mode
48,1286
+    def pop_mode::Orgmode::OutputBuffer#pop_mode
53,1421
+    def prepare::Orgmode::OutputBuffer#prepare
61,1729
+    def enter_table?::Orgmode::OutputBuffer#enter_table?
73,2129
+    def exit_table?::Orgmode::OutputBuffer#exit_table?
79,2314
+    def <<::Orgmode::OutputBuffer#<<
85,2480
+    def list_indent_level::Orgmode::OutputBuffer#list_indent_level
90,2585
+    def preserve_whitespace?::Orgmode::OutputBuffer#preserve_whitespace?
95,2729
+    def maintain_list_indent_stack::Orgmode::OutputBuffer#maintain_list_indent_stack
102,2866
+    def should_accumulate_output?::Orgmode::OutputBuffer#should_accumulate_output?
127,3724
+
+./lib/org-ruby/headline.rb,619
+module Orgmode::Orgmode
3,45
+  class Headline::Orgmode::Headline
6,109
+    attr_reader :level::Orgmode::Headline#level
9,178
+    attr_reader :headline_text::Orgmode::Headline#headline_text
13,325
+    attr_reader :body_lines::Orgmode::Headline#body_lines
16,418
+    attr_reader :tags::Orgmode::Headline#tags
19,481
+    attr_reader :keyword::Orgmode::Headline#keyword
22,567
+    def initialize::Orgmode::Headline#Orgmode::Headline.new
35,896
+    def self.headline?::Orgmode::Headline.headline?
58,1687
+    def to_textile::Orgmode::Headline#to_textile
63,1818
+    def to_html::Orgmode::Headline#to_html
69,1950
+
+./lib/org-ruby/regexp_helper.rb,1014
+module Orgmode::Orgmode
3,18
+  class RegexpHelper::Orgmode::RegexpHelper
17,456
+    attr_reader   :pre_emphasis::Orgmode::RegexpHelper#pre_emphasis
42,1785
+    attr_reader   :post_emphasis::Orgmode::RegexpHelper#post_emphasis
43,1817
+    attr_reader   :border_forbidden::Orgmode::RegexpHelper#border_forbidden
44,1850
+    attr_reader   :body_regexp::Orgmode::RegexpHelper#body_regexp
45,1886
+    attr_reader   :markers::Orgmode::RegexpHelper#markers
46,1917
+    attr_reader   :org_emphasis_regexp::Orgmode::RegexpHelper#org_emphasis_regexp
48,1945
+    def initialize::Orgmode::RegexpHelper#Orgmode::RegexpHelper.new
50,1999
+    def match_all::Orgmode::RegexpHelper#match_all
65,2476
+    def rewrite_emphasis::Orgmode::RegexpHelper#rewrite_emphasis
92,3413
+    def rewrite_links::Orgmode::RegexpHelper#rewrite_links
124,4523
+    def build_org_emphasis_regexp::Orgmode::RegexpHelper#build_org_emphasis_regexp
135,4759
+    def build_org_link_regexp::Orgmode::RegexpHelper#build_org_link_regexp
145,5326
+
+./lib/org-ruby/textile_output_buffer.rb,454
+module Orgmode::Orgmode
3,20
+  class TextileOutputBuffer::Orgmode::TextileOutputBuffer
5,38
+    def initialize::Orgmode::TextileOutputBuffer#Orgmode::TextileOutputBuffer.new
7,84
+    def push_mode::Orgmode::TextileOutputBuffer#push_mode
12,169
+    def pop_mode::Orgmode::TextileOutputBuffer#pop_mode
17,262
+    def inline_formatting::Orgmode::TextileOutputBuffer#inline_formatting
34,585
+    def flush!::Orgmode::TextileOutputBuffer#flush!
48,973
+
+./lib/org-ruby/parser.rb,471
+module Orgmode::Orgmode
5,61
+  class Parser::Orgmode::Parser
7,79
+    attr_reader :lines::Orgmode::Parser#lines
10,140
+    attr_reader :headlines::Orgmode::Parser#headlines
13,207
+    attr_reader :header_lines::Orgmode::Parser#header_lines
16,287
+    def initialize::Orgmode::Parser#Orgmode::Parser.new
20,459
+    def self.load::Orgmode::Parser.load
48,1267
+    def to_textile::Orgmode::Parser#to_textile
54,1433
+    def to_html::Orgmode::Parser#to_html
63,1620
+
+./lib/org-ruby/line.rb,1430
+module Orgmode::Orgmode
1,0
+  class Line::Orgmode::Line
4,67
+    attr_reader :line::Orgmode::Line#line
7,114
+    attr_reader :indent::Orgmode::Line#indent
12,300
+    def initialize::Orgmode::Line#Orgmode::Line.new
14,325
+    def to_s::Orgmode::Line#to_s
21,465
+    def comment?::Orgmode::Line#comment?
26,546
+    def metadata?::Orgmode::Line#metadata?
31,663
+    def nonprinting?::Orgmode::Line#nonprinting?
35,755
+    def blank?::Orgmode::Line#blank?
39,807
+    def plain_list?::Orgmode::Line#plain_list?
43,859
+    def unordered_list?::Orgmode::Line#unordered_list?
49,974
+    def strip_unordered_list_tag::Orgmode::Line#strip_unordered_list_tag
53,1051
+    def ordered_list?::Orgmode::Line#ordered_list?
59,1168
+    def strip_ordered_list_tag::Orgmode::Line#strip_ordered_list_tag
63,1241
+    def plain_text?::Orgmode::Line#plain_text?
67,1309
+    def table_row?::Orgmode::Line#table_row?
71,1392
+    def table_separator?::Orgmode::Line#table_separator?
77,1539
+    def table?::Orgmode::Line#table?
85,1775
+    def begin_block?::Orgmode::Line#begin_block?
91,1888
+    def end_block?::Orgmode::Line#end_block?
95,1960
+    def block_type::Orgmode::Line#block_type
99,2030
+    def paragraph_type::Orgmode::Line#paragraph_type
104,2152
+    def self.to_textile::Orgmode::Line.to_textile
115,2470
+    def self.to_html::Orgmode::Line.to_html
121,2620
+    def self.translate::Orgmode::Line.translate
128,2816
+
+./bin/org-ruby,0
+
+./test/test_orgmode_parser.rb,0

data/bin/org-ruby

@@ -0,0 +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
+
+

data/lib/org-ruby.rb

@@ -0,0 +1,48 @@
+
+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__)
+

data/lib/org-ruby/headline.rb

@@ -0,0 +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

data/lib/org-ruby/html_output_buffer.rb

@@ -0,0 +1,80 @@
+require OrgRuby.libpath(*%w[org-ruby output_buffer])
+
+module Orgmode
+
+  class HtmlOutputBuffer < OutputBuffer
+
+    HtmlBlockTag = {
+      :paragraph => "p",
+      :ordered_list => "li",
+      :unordered_list => "li",
+      :table_row => "tr"
+    }
+
+    ModeTag = {
+      :unordered_list => "ul",
+      :ordered_list => "ol",
+      :table => "table",
+      :blockquote => "blockquote",
+      :code => "pre"
+    }
+
+    def push_mode(mode)
+      super(mode)
+      @output << "<#{ModeTag[mode]}>\n" if ModeTag[mode]
+    end
+
+    def pop_mode(mode = nil)
+      m = super(mode)
+      @output << "</#{ModeTag[m]}>\n" if ModeTag[m]
+    end
+
+    def flush!
+      @logger.debug "FLUSH ==========> #{@output_type}"
+      if current_mode == :code then
+        # Whitespace is significant in :code mode. Always output the buffer
+        # and do not do any additional translation.
+        @output << @buffer << "\n"
+      else
+        if (@buffer.length > 0) then
+          @output << "<#{HtmlBlockTag[@output_type]}>" \
+            << inline_formatting(@buffer) \
+            << "</#{HtmlBlockTag[@output_type]}>\n"
+        end
+      end
+      @buffer = ""
+    end
+
+    ######################################################################
+    private
+
+    Tags = {
+      "*" => { :open => "<b>", :close => "</b>" },
+      "/" => { :open => "<i>", :close => "</i>" },
+      "_" => { :open => "<span style=\"text-decoration:underline;\">",
+        :close => "</span>" },
+      "=" => { :open => "<code>", :close => "</code>" },
+      "~" => { :open => "<code>", :close => "</code>" },
+      "+" => { :open => "<del>", :close => "</del>" }
+    }
+
+    # Applies inline formatting rules to a string.
+    def inline_formatting(str)
+      str.rstrip!
+      if (@output_type == :table_row) then
+        str.gsub!(/^\|\s*/, "<td>")
+        str.gsub!(/\s*\|$/, "</td>")
+        str.gsub!(/\s*\|\s*/, "</td><td>")
+      end
+      str = @re_help.rewrite_emphasis(str) do |marker, s|
+        "#{Tags[marker][:open]}#{s}#{Tags[marker][:close]}"
+      end
+      str = @re_help.rewrite_links(str) do |link, text|
+        text ||= link
+        "<a href=\"#{link}\">#{text}</a>"
+      end
+      str
+    end
+
+  end                           # class HtmlOutputBuffer
+end                             # module Orgmode