org-ruby 0.6.0 → 0.6.2

data/.gitignore

@@ -0,0 +1,2 @@
+*.tmproj
+/util/gen-special-replace.elc

data/Gemfile

@@ -0,0 +1,8 @@
+source :rubygems
+
+gemspec
+
+group :development do
+  gem 'rspec'
+  gem 'tilt'
+end

data/Gemfile.lock

@@ -0,0 +1,36 @@
+PATH
+  remote: .
+  specs:
+    org-ruby (0.6.1)
+      rubypants (>= 0.2.0)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    bones (3.8.0)
+      little-plugger (~> 1.1.3)
+      loquacious (~> 1.9.1)
+      rake (>= 0.8.7)
+    diff-lcs (1.1.3)
+    little-plugger (1.1.3)
+    loquacious (1.9.1)
+    rake (0.9.2.2)
+    rspec (2.9.0)
+      rspec-core (~> 2.9.0)
+      rspec-expectations (~> 2.9.0)
+      rspec-mocks (~> 2.9.0)
+    rspec-core (2.9.0)
+    rspec-expectations (2.9.1)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.9.0)
+    rubypants (0.2.0)
+    tilt (1.3.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bones (>= 3.8.0)
+  org-ruby!
+  rspec
+  tilt

data/History.txt

@@ -1,3 +1,12 @@
+== 0.6.2 / 2012-04-14
+
+* Added encoding directive to support Ruby 1.9.2
+* Headlines with the COMMENT keyword, and the PROPERTIES drawer are not exported
+* Angle links in org-mode are embedded in anchor tags on html output
+* #+BEGIN/END_SRC lang code blocks are embedded in code tags with class that specifies the coding language
+* Fixed bug in code blocks when a colon was at the beginning
+* More than five dashes create an horizontal rule in html output
+
 == 0.6.0 / 2011-09-03
 
 * Added support for a "header offset" -- turns one star into an H2, etc. (thanks, niku)

data/README.rdoc

@@ -16,6 +16,7 @@ extracting "content" from the orgfile as opposed to "metadata."
 * Supports tables, block quotes, and block code
 * Supports bold, italic, underline, strikethrough, and code inline formatting.
 * Supports hyperlinks that are in double-brackets
+* Supports +.org+ views in Rails through Tilt.
 * Upcoming: Handle export options specified in the org buffer.
 
 == SYNOPSIS:
@@ -34,7 +35,7 @@ From Ruby code:
 
      Orgmode::Parser.new(data)
 
-...will construct a new +Parser+ object. 
+...will construct a new +Parser+ object.
 
 == INSTALL:
 

data/Rakefile

@@ -1,15 +1,16 @@
-
-begin
-  require 'bones'
-rescue LoadError
-  abort '### Please install the "bones" gem ###'
-end
-
+require 'bones'
 ensure_in_path 'lib'
 require 'org-ruby'
 
-task :default => 'spec:run'
-task 'gem:release' => 'spec:run'
+require 'rspec/core'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+task :default => 'spec'
+task 'gem:release' => 'spec'
 
 Bones {
   readme_file 'README.rdoc'
@@ -19,7 +20,6 @@ Bones {
   url  'http://github.com/bdewey/org-ruby'
   version  OrgRuby::VERSION
   depend_on 'rubypants'
-  spec.opts ['--color']
 }
 
 

data/announcement.txt

@@ -1,4 +1,4 @@
-org-ruby version 0.6.0
+org-ruby version 0.6.2
     by Brian Dewey
     http://github.com/bdewey/org-ruby
 
@@ -11,14 +11,9 @@ conversion. The supplied textile conversion is optimized for
 extracting "content" from the orgfile as opposed to "metadata." 
 
 == CHANGES
-* The anchor text for a link can now be an image, and will get an img tag (thanks, punchagan)
-* Fixed bug in tables; only the first row is a header even if others have divider lines (thanks, leathekd)
-* Fixed bug in the list regular expression; lists require a space after the item delimiter (thanks, punchagan)
-* Lots from ruediger:
-  * subscript / superscript
-  * definition lists
-  * centered text
-  * symbol replacement
-
-* Minor enhancement: Displays inline images
-
+* Added encoding directive to support Ruby 1.9.2
+* Headlines with the COMMENT keyword, and the PROPERTIES drawer are not exported
+* Angle links in org-mode are embedded in anchor tags on html output
+* #+BEGIN/END_SRC lang code blocks are embedded in code tags with class that specifies the coding language
+* Fixed bug in code blocks when a colon was at the beginning
+* More than five dashes create an horizontal rule in html output (thanks Neil-Smithline!)

data/lib/org-ruby.rb

@@ -3,7 +3,7 @@ unless defined? ::OrgRuby
 module OrgRuby
 
   # :stopdoc:
-  VERSION = '0.6.0'
+  VERSION = '0.6.2'
   LIBPATH = ::File.expand_path(::File.dirname(__FILE__)) + ::File::SEPARATOR
   PATH = ::File.dirname(LIBPATH) + ::File::SEPARATOR
   # :startdoc:

data/lib/org-ruby/headline.rb

@@ -41,6 +41,9 @@ module Orgmode
 
     KeywordsRegexp = Regexp.new("^(#{Keywords.join('|')})\$")
 
+    # This matches a headline marked as COMMENT
+    CommentHeadlineRegexp = /^COMMENT\s+/
+
     def initialize(line, parser = nil, offset=0)
       super(line, parser)
       @body_lines = []
@@ -74,6 +77,11 @@ module Orgmode
       line =~ LineRegexp
     end
 
+    # Determines if a headline has the COMMENT keyword.
+    def comment_headline?
+      @headline_text =~ CommentHeadlineRegexp
+    end
+
     # Overrides Line.paragraph_type.
     def paragraph_type
       :"heading#{@level}"

data/lib/org-ruby/html_output_buffer.rb

@@ -59,6 +59,11 @@ module Orgmode
         css_class = " style=\"text-align: center\"" if mode == :center
         @logger.debug "#{mode}: <#{ModeTag[mode]}#{css_class}>\n" 
         @output << "<#{ModeTag[mode]}#{css_class}>\n" unless mode == :table and skip_tables?
+        # Special case to add code tags to src blogs and specify language
+        if mode == :src
+          @logger.debug "<code class=\"#{@block_lang}\">\n"
+          @output << "<code class=\"#{@block_lang}\">\n"
+        end
         # Entering a new mode obliterates the title decoration
         @title_decoration = ""
       end
@@ -71,6 +76,10 @@ module Orgmode
       m = super(mode)
       if ModeTag[m] then
         output_indentation
+        if mode == :src
+          @logger.debug "</code>\n"
+          @output << "</code>\n"
+        end
         @logger.debug "</#{ModeTag[m]}>\n"
         @output << "</#{ModeTag[m]}>\n" unless mode == :table and skip_tables?
       end
@@ -84,7 +93,9 @@ module Orgmode
         @logger.debug "FLUSH CODE ==========> #{@buffer.inspect}"
         @output << @buffer << "\n"
       else
-        if @buffer.length > 0 and @output_type == :definition_list then
+        if @buffer.length > 0 and @output_type == :horizontal_rule then
+          @output << "<hr />\n"
+        elsif @buffer.length > 0 and @output_type == :definition_list then
           unless buffer_mode_is_table? and skip_tables?
             output_indentation
             d = @buffer.split("::", 2)

data/lib/org-ruby/line.rb

@@ -41,6 +41,26 @@ module Orgmode
       return @line =~ /^#/
     end
 
+    PropertyDrawerRegexp = /^\s*:(PROPERTIES|END):/i
+
+    def property_drawer_begin_block?
+      @line =~ PropertyDrawerRegexp && $1 =~ /PROPERTIES/
+    end
+
+    def property_drawer_end_block?
+      @line =~ PropertyDrawerRegexp && $1 =~ /END/
+    end
+
+    def property_drawer?
+      check_assignment_or_regexp(:property_drawer, PropertyDrawerRegexp)
+    end
+
+    PropertyDrawerItemRegexp = /^\s*:(\w+):\s*(.*)$/i
+
+    def property_drawer_item?
+      @line =~ PropertyDrawerItemRegexp
+    end
+
     # Tests if a line contains metadata instead of actual content.
     def metadata?
       check_assignment_or_regexp(:metadata, /^\s*(CLOCK|DEADLINE|START|CLOSED|SCHEDULED):/)
@@ -74,6 +94,12 @@ module Orgmode
       check_assignment_or_regexp(:definition_list, DefinitionListRegexp)
     end
 
+    HorizontalRuleRegexp = /^\s*-{5,}\s*$/
+
+    def horizontal_rule?
+      check_assignment_or_regexp(:horizontal_rule, HorizontalRuleRegexp)
+    end
+
     OrderedListRegexp = /^\s*\d+(\.|\))\s+/
 
     def ordered_list?
@@ -120,7 +146,7 @@ module Orgmode
       table_row? or table_separator? or table_header?
     end
 
-    BlockRegexp = /^\s*#\+(BEGIN|END)_(\w*)/i
+    BlockRegexp = /^\s*#\+(BEGIN|END)_(\w*)\s*(\w*)?/i
 
     def begin_block?
       @line =~ BlockRegexp && $1 =~ /BEGIN/i
@@ -134,11 +160,15 @@ module Orgmode
       $2 if @line =~ BlockRegexp
     end
 
+    def block_lang
+      $3 if @line =~ BlockRegexp
+    end
+
     def code_block_type?
       block_type =~ /^(EXAMPLE|SRC)$/i
     end
 
-    InlineExampleRegexp = /^\s*:/
+    InlineExampleRegexp = /^\s*:\s/
 
     # Test if the line matches the "inline example" case:
     # the first character on the line is a colon.
@@ -173,6 +203,9 @@ module Orgmode
       return :definition_list if definition_list? # order is important! A definition_list is also an unordered_list!
       return :ordered_list if ordered_list?
       return :unordered_list if unordered_list?
+      return :property_drawer_begin_block if property_drawer_begin_block?
+      return :property_drawer_end_block if property_drawer_end_block?
+      return :property_drawer_item if property_drawer_item?
       return :metadata if metadata?
       return :begin_block if begin_block?
       return :end_block if end_block?
@@ -181,6 +214,7 @@ module Orgmode
       return :table_row if table_row?
       return :table_header if table_header?
       return :inline_example if inline_example?
+      return :horizontal_rule if horizontal_rule?
       return :paragraph
     end
 

data/lib/org-ruby/output_buffer.rb

@@ -54,7 +54,7 @@ module Orgmode
       push_mode(:normal)
     end
 
-    Modes = [:normal, :ordered_list, :unordered_list, :definition_list, :blockquote, :src, :example, :table, :inline_example, :center]
+    Modes = [:normal, :ordered_list, :unordered_list, :definition_list, :blockquote, :src, :example, :table, :inline_example, :center, :property_drawer]
 
     def current_mode
       @mode_stack.last
@@ -80,12 +80,15 @@ module Orgmode
     def prepare(line)
       @logger.debug "Looking at #{line.paragraph_type}: #{line.to_s}"
       if not should_accumulate_output?(line) then
+        @block_lang = line.block_lang if line.begin_block? and line.code_block_type?
         flush!
         maintain_list_indent_stack(line)
         @output_type = line.paragraph_type 
       end
-      push_mode(:inline_example) if line.inline_example? and current_mode != :inline_example
-      pop_mode(:inline_example) if current_mode == :inline_example && !line.inline_example?
+      push_mode(:inline_example) if line.inline_example? and current_mode != :inline_example and not line.property_drawer?
+      pop_mode(:inline_example) if current_mode == :inline_example and !line.inline_example?
+      push_mode(:property_drawer) if line.property_drawer? and current_mode != :property_drawer
+      pop_mode(:property_drawer) if current_mode == :property_drawer and line.property_drawer_end_block?
       push_mode(:table) if enter_table?
       pop_mode(:table) if exit_table?
       @buffered_lines.push(line)

data/lib/org-ruby/parser.rb

@@ -77,7 +77,7 @@ module Orgmode
     # Should we export sub/superscripts? (_{foo}/^{foo})
     # only {} mode is currently supported.
     def use_sub_superscripts?
-      @options["^"] != "nil" 
+      @options["^"] != "nil"
     end
 
     # I can construct a parser object either with an array of lines
@@ -122,6 +122,7 @@ module Orgmode
             table_header_set = false if !line.table?
             mode = :code if line.begin_block? and line.block_type == "EXAMPLE"
             mode = :block_comment if line.begin_block? and line.block_type == "COMMENT"
+            mode = :property_drawer if line.property_drawer_begin_block?
             if (@current_headline) then
               @current_headline.body_lines << line
             else
@@ -152,6 +153,20 @@ module Orgmode
           else
             @header_lines << line
           end
+
+        when :property_drawer
+
+          line = Line.new line, self
+          if line.property_drawer_end_block?
+            mode = :normal
+          else
+            line.assigned_paragraph_type = :property_drawer unless line.blank?
+          end
+          if (@current_headline) then
+            @current_headline.body_lines << line
+          else
+            @header_lines << line
+          end
         end                     # case
         previous_line = line
       end                       # @lines.each
@@ -186,7 +201,7 @@ module Orgmode
       export_options[:skip_tables] = true if not export_tables?
       output = ""
       output_buffer = HtmlOutputBuffer.new(output, export_options)
-      
+
       if @in_buffer_settings["TITLE"] then
 
         # If we're given a new title, then just create a new line
@@ -195,7 +210,7 @@ module Orgmode
         Parser.translate([title], output_buffer)
       end
       Parser.translate(@header_lines, output_buffer) unless skip_header_lines?
-      
+
       # If we've output anything at all, remove the :decorate_title option.
       export_options.delete(:decorate_title) if (output.length > 0)
       @headlines.each do |headline|
@@ -224,11 +239,10 @@ module Orgmode
         # 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, :comment
+        when :metadata, :table_separator, :blank, :comment, :property_drawer_item, :property_drawer_begin_block, :property_drawer_end_block
 
-          output_buffer << line.line if output_buffer.preserve_whitespace?          
+          output_buffer << line.line if output_buffer.preserve_whitespace?
 
         when :begin_block
 
@@ -249,7 +263,7 @@ module Orgmode
           output_buffer << line.line.lstrip
 
         when :unordered_list, :ordered_list, :definition_list
-          
+
           output_buffer << line.output_text << " "
 
         when :inline_example
@@ -315,6 +329,10 @@ module Orgmode
               inherit_export_level = headline.level
             end
           end
+          if headline.comment_headline?
+            headline.export_state = :exclude
+            inherit_export_level = headline.level
+          end
         end
       end
     end

data/lib/org-ruby/regexp_helper.rb

@@ -141,14 +141,15 @@ module Orgmode
     # HTML-style link, and that is how things will get recorded in
     # +result+.
     def rewrite_links(str) #  :yields: link, text
-      i = str.gsub(@org_link_regexp) do |match|
+      str.gsub(@org_link_regexp) do |match|
         yield $1, nil
-      end
-      i.gsub(@org_link_text_regexp) do |match|
-        yield $1, $2
+      end.gsub(@org_link_text_regexp) do |match|
+          yield $1, $2
+      end.gsub(@org_angle_link_text_regexp) do |match|
+          yield "#{$2}:#{$3}", nil
       end
     end
-    
+
     # Rewrites all of the inline image tags.
     def rewrite_images(str) #  :yields: image_link
       str.gsub(@org_img_regexp) do |match|
@@ -180,6 +181,7 @@ module Orgmode
                                \]\[
                                  ([^\]]*) # This is the friendly text
                                \]\]/x
+      @org_angle_link_text_regexp = /(<|&lt;)(\w+):([^\]\t\n\r<> ][^\]\t\n\r<> ]*)(>|&gt;)/x
     end
   end                           # class Emphasis
 end                             # module Orgmode

data/lib/org-ruby/textile_symbol_replace.rb

@@ -1,3 +1,4 @@
+# encoding: utf-8
 # Autogenerated by util/gen-special-replace.el
 
 module Orgmode

data/lib/org-ruby/tilt.rb

@@ -0,0 +1,29 @@
+begin
+  require 'tilt'
+
+  module Tilt
+    class OrgTemplate < Template
+      def self.engine_initialized?
+        defined? ::Orgmode
+      end
+
+      def initialize_engine
+        require 'org-ruby'
+      end
+
+      def prepare
+        @engine = Orgmode::Parser.new(data)
+        @output = nil
+      end
+
+      def evaluate(scope, locals, &block)
+        @output ||= @engine.to_html
+      end
+    end
+  end
+
+  Tilt.register Tilt::OrgTemplate, 'org'
+
+rescue LoadError
+  # Tilt is not available.
+end