org-ruby 0.4.0 → 0.4.1

data/lib/org-ruby/headline.rb

@@ -1,80 +1,80 @@
-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(opts = {})
-      if opts[:decorate_title]
-        decoration = " class=\"title\""
-      else
-        decoration = ""
-      end
-      output = "<h#{@level}#{decoration}>#{@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(opts = {})
+      if opts[:decorate_title]
+        decoration = " class=\"title\""
+      else
+        decoration = ""
+      end
+      output = "<h#{@level}#{decoration}>#{@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

@@ -1,105 +1,117 @@
-require OrgRuby.libpath(*%w[org-ruby output_buffer])
-require 'cgi'
-
-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 initialize(output, opts = {})
-      super(output)
-      if opts[:decorate_title] then
-        @title_decoration = " class=\"title\""
-      else
-        @title_decoration = ""
-      end
-    end
-
-    def push_mode(mode)
-      if ModeTag[mode] then
-        output_indentation
-        @output << "<#{ModeTag[mode]}>\n" 
-        # Entering a new mode obliterates the title decoration
-        @title_decoration = ""
-      end
-      super(mode)
-    end
-
-    def pop_mode(mode = nil)
-      m = super(mode)
-      if ModeTag[m] then
-        output_indentation
-        @output << "</#{ModeTag[m]}>\n"
-      end
-    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 << CGI.escapeHTML(@buffer) << "\n"
-      else
-        if (@buffer.length > 0) then
-          output_indentation
-          @output << "<#{HtmlBlockTag[@output_type]}#{@title_decoration}>" \
-            << inline_formatting(@buffer) \
-            << "</#{HtmlBlockTag[@output_type]}>\n"
-          @title_decoration = ""
-        end
-      end
-      @buffer = ""
-    end
-
-    ######################################################################
-    private
-
-    def output_indentation
-      indent = "  " * (@mode_stack.length - 1)
-      @output << indent
-    end
-
-    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!
-      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
-      if (@output_type == :table_row) then
-        str.gsub!(/^\|\s*/, "<td>")
-        str.gsub!(/\s*\|$/, "</td>")
-        str.gsub!(/\s*\|\s*/, "</td><td>")
-      end
-      str
-    end
-
-  end                           # class HtmlOutputBuffer
-end                             # module Orgmode
+require OrgRuby.libpath(*%w[org-ruby output_buffer])
+require 'cgi'
+
+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 initialize(output, opts = {})
+      super(output)
+      if opts[:decorate_title] then
+        @title_decoration = " class=\"title\""
+      else
+        @title_decoration = ""
+      end
+    end
+
+    def push_mode(mode)
+      if ModeTag[mode] then
+        output_indentation
+        @logger.debug "<#{ModeTag[mode]}>\n" 
+        @output << "<#{ModeTag[mode]}>\n" 
+        # Entering a new mode obliterates the title decoration
+        @title_decoration = ""
+      end
+      super(mode)
+    end
+
+    def pop_mode(mode = nil)
+      m = super(mode)
+      if ModeTag[m] then
+        output_indentation
+        @logger.debug "</#{ModeTag[m]}>\n"
+        @output << "</#{ModeTag[m]}>\n"
+      end
+    end
+
+    def flush!
+      escape_buffer!
+      if current_mode == :code then
+        # Whitespace is significant in :code mode. Always output the buffer
+        # and do not do any additional translation.
+        # 
+        # FIXME 2009-12-29 bdewey: It looks like I'll always get an extraneous
+        # newline at the start of code blocks. Find a way to fix this.
+        @logger.debug "FLUSH CODE ==========> #{@buffer.inspect}"
+        @output << @buffer << "\n"
+      else
+        if (@buffer.length > 0) then
+          @logger.debug "FLUSH      ==========> #{@output_type}"
+          output_indentation
+          @output << "<#{HtmlBlockTag[@output_type]}#{@title_decoration}>" \
+            << inline_formatting(@buffer) \
+            << "</#{HtmlBlockTag[@output_type]}>\n"
+          @title_decoration = ""
+        end
+      end
+      @buffer = ""
+    end
+
+    ######################################################################
+    private
+
+    # Escapes any HTML content in the output accumulation buffer @buffer.
+    def escape_buffer!
+      @buffer = CGI.escapeHTML(@buffer)
+    end
+
+    def output_indentation
+      indent = "  " * (@mode_stack.length - 1)
+      @output << indent
+    end
+
+    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!
+      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
+      if (@output_type == :table_row) then
+        str.gsub!(/^\|\s*/, "<td>")
+        str.gsub!(/\s*\|$/, "</td>")
+        str.gsub!(/\s*\|\s*/, "</td><td>")
+      end
+      str
+    end
+
+  end                           # class HtmlOutputBuffer
+end                             # module Orgmode

data/lib/org-ruby/line.rb

@@ -1,173 +1,178 @@
-module Orgmode
-
-  # Represents a single line of an orgmode file.
-  class Line
-
-    # This is the line itself.
-    attr_reader :line
-
-    # The indent level of this line. this is important to properly translate
-    # nested lists from orgmode to textile.
-    # TODO 2009-12-20 bdewey: Handle tabs
-    attr_reader :indent
-
-    def initialize(line)
-      @line = line
-      @indent = 0
-      @line =~ /\s*/
-      @indent = $&.length unless blank?
-    end
-
-    def to_s
-      return @line
-    end
-
-    # Tests if a line is a comment.
-    def comment?
-      @line =~ /^\s*#/
-    end
-
-    # Tests if a line contains metadata instead of actual content.
-    def metadata?
-      @line =~ /^\s*(CLOCK|DEADLINE|START|CLOSED|SCHEDULED):/
-    end
-
-    def nonprinting?
-      comment? || metadata?
-    end
-
-    def blank?
-      @line =~ /^\s*$/
-    end
-
-    def plain_list?
-      ordered_list? or unordered_list?
-    end
-
-    UnorderedListRegexp = /^\s*(-|\+)\s*/
-
-    def unordered_list?
-      @line =~ UnorderedListRegexp
-    end
-
-    def strip_unordered_list_tag
-      @line.sub(UnorderedListRegexp, "")
-    end
-
-    OrderedListRegexp = /^\s*\d+(\.|\))\s*/
-
-    def ordered_list?
-      @line =~ OrderedListRegexp
-    end
-
-    def strip_ordered_list_tag
-      @line.sub(OrderedListRegexp, "")
-    end
-
-    def plain_text?
-      not metadata? and not blank? and not plain_list?
-    end
-
-    def table_row?
-      # for an org-mode table, the first non-whitespace character is a
-      # | (pipe).
-      @line =~ /^\s*\|/
-    end
-
-    def table_separator?
-      # an org-mode table separator has the first non-whitespace
-      # character as a | (pipe), then consists of nothing else other
-      # than pipes, hyphens, and pluses.
-
-      @line =~ /^\s*\|[-\|\+]*\s*$/
-    end
-
-    def table?
-      table_row? or table_separator?
-    end
-
-    BlockRegexp = /^\s*#\+(BEGIN|END)_(\w*)/
-
-    def begin_block?
-      @line =~ BlockRegexp && $1 == "BEGIN"
-    end
-
-    def end_block?
-      @line =~ BlockRegexp && $1 == "END"
-    end
-
-    def block_type
-      $2 if @line =~ BlockRegexp
-    end
-
-    # Determines the paragraph type of the current line.
-    def paragraph_type
-      return :blank if blank?
-      return :ordered_list if ordered_list?
-      return :unordered_list if unordered_list?
-      return :metadata if metadata?
-      return :comment if comment?
-      return :table_separator if table_separator?
-      return :table_row if table_row?
-      return :paragraph
-    end
-
-    def self.to_textile(lines)
-      output = ""
-      output_buffer = TextileOutputBuffer.new(output)
-      translate(lines, output_buffer)
-    end
-
-    def self.to_html(lines, opts = { })
-      output = ""
-      output_buffer = HtmlOutputBuffer.new(output, opts)
-      translate(lines, output_buffer)
-    end
-
-    # Converts an array of lines to textile format.
-    def self.translate(lines, output_buffer)
-      lines.each do |line|
-
-        # See if we're carrying paragraph payload, and output
-        # it if we're about to switch to some other output type.
-        output_buffer.prepare(line)
-
-        case line.paragraph_type
-        when :metadata, :table_separator, :blank
-
-          # IGNORE
-
-        when :comment
-          
-          output_buffer.push_mode(:blockquote) if line.begin_block? and line.block_type == "QUOTE"
-          output_buffer.push_mode(:code) if line.begin_block? and line.block_type == "EXAMPLE"
-          output_buffer.pop_mode(:blockquote) if line.end_block? and line.block_type == "QUOTE"
-          output_buffer.pop_mode(:code) if line.end_block? and line.block_type == "EXAMPLE"
-
-        when :table_row
-
-          output_buffer << line.line.lstrip
-
-        when :ordered_list
-            
-          output_buffer << line.strip_ordered_list_tag << " "
-          
-        when :unordered_list
-          
-          output_buffer << line.strip_unordered_list_tag << " "
-
-        when :paragraph
-
-          if output_buffer.preserve_whitespace? then
-            output_buffer << line.line
-          else
-            output_buffer << line.line.strip << " "
-          end
-        end
-      end
-      output_buffer.flush!
-      output_buffer.pop_mode until output_buffer.current_mode == :normal
-      output_buffer.output
-    end
-  end                           # class Line
-end                             # module Orgmode
+module Orgmode
+
+  # Represents a single line of an orgmode file.
+  class Line
+
+    # This is the line itself.
+    attr_reader :line
+
+    # The indent level of this line. this is important to properly translate
+    # nested lists from orgmode to textile.
+    # TODO 2009-12-20 bdewey: Handle tabs
+    attr_reader :indent
+
+    def initialize(line)
+      @line = line
+      @indent = 0
+      @line =~ /\s*/
+      @indent = $&.length unless blank?
+    end
+
+    def to_s
+      return @line
+    end
+
+    # Tests if a line is a comment.
+    def comment?
+      @line =~ /^\s*#/
+    end
+
+    # Tests if a line contains metadata instead of actual content.
+    def metadata?
+      @line =~ /^\s*(CLOCK|DEADLINE|START|CLOSED|SCHEDULED):/
+    end
+
+    def nonprinting?
+      comment? || metadata?
+    end
+
+    def blank?
+      @line =~ /^\s*$/
+    end
+
+    def plain_list?
+      ordered_list? or unordered_list?
+    end
+
+    UnorderedListRegexp = /^\s*(-|\+)\s*/
+
+    def unordered_list?
+      @line =~ UnorderedListRegexp
+    end
+
+    def strip_unordered_list_tag
+      @line.sub(UnorderedListRegexp, "")
+    end
+
+    OrderedListRegexp = /^\s*\d+(\.|\))\s*/
+
+    def ordered_list?
+      @line =~ OrderedListRegexp
+    end
+
+    def strip_ordered_list_tag
+      @line.sub(OrderedListRegexp, "")
+    end
+
+    def plain_text?
+      not metadata? and not blank? and not plain_list?
+    end
+
+    def table_row?
+      # for an org-mode table, the first non-whitespace character is a
+      # | (pipe).
+      @line =~ /^\s*\|/
+    end
+
+    def table_separator?
+      # an org-mode table separator has the first non-whitespace
+      # character as a | (pipe), then consists of nothing else other
+      # than pipes, hyphens, and pluses.
+
+      @line =~ /^\s*\|[-\|\+]*\s*$/
+    end
+
+    def table?
+      table_row? or table_separator?
+    end
+
+    BlockRegexp = /^\s*#\+(BEGIN|END)_(\w*)/
+
+    def begin_block?
+      @line =~ BlockRegexp && $1 == "BEGIN"
+    end
+
+    def end_block?
+      @line =~ BlockRegexp && $1 == "END"
+    end
+
+    def block_type
+      $2 if @line =~ BlockRegexp
+    end
+
+    # Determines the paragraph type of the current line.
+    def paragraph_type
+      return :blank if blank?
+      return :ordered_list if ordered_list?
+      return :unordered_list if unordered_list?
+      return :metadata if metadata?
+      return :comment if comment?
+      return :table_separator if table_separator?
+      return :table_row if table_row?
+      return :paragraph
+    end
+
+    def self.to_textile(lines)
+      output = ""
+      output_buffer = TextileOutputBuffer.new(output)
+      translate(lines, output_buffer)
+    end
+
+    def self.to_html(lines, opts = { })
+      output = ""
+      output_buffer = HtmlOutputBuffer.new(output, opts)
+      translate(lines, output_buffer)
+    end
+
+    # Converts an array of lines to textile format.
+    def self.translate(lines, output_buffer)
+      lines.each do |line|
+
+        # See if we're carrying paragraph payload, and output
+        # it if we're about to switch to some other output type.
+        output_buffer.prepare(line)
+
+        case line.paragraph_type
+        when :metadata, :table_separator, :blank
+
+          output_buffer << line.line if output_buffer.preserve_whitespace?          
+
+        when :comment
+          
+          if line.begin_block?
+            output_buffer.push_mode(:blockquote) if line.block_type == "QUOTE"
+            output_buffer.push_mode(:code) if line.block_type == "EXAMPLE"
+          elsif line.end_block?
+            output_buffer.pop_mode(:blockquote) if line.block_type == "QUOTE"
+            output_buffer.pop_mode(:code) if line.block_type == "EXAMPLE"
+          else
+            output_buffer << line.line if output_buffer.preserve_whitespace?
+          end
+
+        when :table_row
+
+          output_buffer << line.line.lstrip
+
+        when :ordered_list
+            
+          output_buffer << line.strip_ordered_list_tag << " "
+          
+        when :unordered_list
+          
+          output_buffer << line.strip_unordered_list_tag << " "
+
+        when :paragraph
+
+          if output_buffer.preserve_whitespace? then
+            output_buffer << line.line
+          else
+            output_buffer << line.line.strip << " "
+          end
+        end
+      end
+      output_buffer.flush!
+      output_buffer.pop_mode until output_buffer.current_mode == :normal
+      output_buffer.output
+    end
+  end                           # class Line
+end                             # module Orgmode