org-ruby 0.5.0 → 0.5.1

data/History.txt

@@ -1,4 +1,10 @@
-== 0.5.0 / 2009-12-29
+== 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:

data/lib/org-ruby.rb

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

data/lib/org-ruby/html_output_buffer.rb

@@ -17,7 +17,9 @@ module Orgmode
       :ordered_list => "ol",
       :table => "table",
       :blockquote => "blockquote",
-      :code => "pre"
+      :example => "pre",
+      :src => "pre",
+      :inline_example => "pre"
     }
 
     attr_reader :options
@@ -33,17 +35,25 @@ module Orgmode
       @logger.debug "HTML export options: #{@options.inspect}"
     end
 
+    # Output buffer is entering a new mode. Use this opportunity to
+    # write out one of the block tags in the ModeTag constant to put
+    # this information in the HTML stream.
     def push_mode(mode)
       if ModeTag[mode] then
         output_indentation
-        @logger.debug "<#{ModeTag[mode]}>\n" 
-        @output << "<#{ModeTag[mode]}>\n" unless mode == :table and skip_tables?
+        css_class = ""
+        css_class = " class=\"src\"" if mode == :src
+        css_class = " class=\"example\"" if (mode == :example || mode == :inline_example)
+        @logger.debug "#{mode}: <#{ModeTag[mode]}#{css_class}>\n" 
+        @output << "<#{ModeTag[mode]}#{css_class}>\n" unless mode == :table and skip_tables?
         # Entering a new mode obliterates the title decoration
         @title_decoration = ""
       end
       super(mode)
     end
 
+    # We are leaving a mode. Close any tags that were opened when
+    # entering this mode.
     def pop_mode(mode = nil)
       m = super(mode)
       if ModeTag[m] then
@@ -55,12 +65,9 @@ module Orgmode
 
     def flush!
       escape_buffer!
-      if @buffer_mode == :code then
+      if mode_is_code(@buffer_mode) 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

data/lib/org-ruby/line.rb

@@ -117,6 +117,18 @@ module Orgmode
       $2 if @line =~ BlockRegexp
     end
 
+    def code_block_type?
+      block_type =~ /^(EXAMPLE|SRC)$/
+    end
+
+    InlineExampleRegexp = /^\s*:/
+
+    # Test if the line matches the "inline example" case:
+    # the first character on the line is a colon.
+    def inline_example?
+      check_assignment_or_regexp(:inline_example, InlineExampleRegexp)
+    end
+
     InBufferSettingRegexp = /^#\+(\w+):\s*(.*)$/
 
     # call-seq:
@@ -148,6 +160,7 @@ module Orgmode
       return :table_separator if table_separator?
       return :table_row if table_row?
       return :table_header if table_header?
+      return :inline_example if inline_example?
       return :paragraph
     end
 
@@ -180,10 +193,12 @@ module Orgmode
           
           if line.begin_block?
             output_buffer.push_mode(:blockquote) if line.block_type == "QUOTE"
-            output_buffer.push_mode(:code) if line.block_type == "EXAMPLE"
+            output_buffer.push_mode(:src) if line.block_type == "SRC"
+            output_buffer.push_mode(:example) 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"
+            output_buffer.pop_mode(:src) if line.block_type == "SRC"
+            output_buffer.pop_mode(:example) if line.block_type == "EXAMPLE"
           else
             output_buffer << line.line if output_buffer.preserve_whitespace?
           end
@@ -200,6 +215,10 @@ module Orgmode
           
           output_buffer << line.strip_unordered_list_tag << " "
 
+        when :inline_example
+
+          output_buffer << line.line.sub(InlineExampleRegexp, "")
+          
         when :paragraph
 
           if output_buffer.preserve_whitespace? then

data/lib/org-ruby/output_buffer.rb

@@ -45,7 +45,7 @@ module Orgmode
       push_mode(:normal)
     end
 
-    Modes = [:normal, :ordered_list, :unordered_list, :blockquote, :code, :table]
+    Modes = [:normal, :ordered_list, :unordered_list, :blockquote, :src, :example, :table, :inline_example]
 
     def current_mode
       @mode_stack.last
@@ -75,6 +75,8 @@ module Orgmode
         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(:table) if enter_table?
       pop_mode(:table) if exit_table?
     end
@@ -108,17 +110,19 @@ module Orgmode
 
     # Test if we're in an output mode in which whitespace is significant.
     def preserve_whitespace?
-      return current_mode == :code
+      mode_is_code current_mode
     end
 
     ######################################################################
     private
 
-    # call-seq:
-    #     continue_current_list?  => boolean
-    #
-    # Tests if the line should continue the current list.
-    def continue_current_list?(line)
+    def mode_is_code(mode)
+      case mode
+      when :src, :inline_example, :example
+        true
+      else
+        false
+      end
     end
 
     def maintain_list_indent_stack(line)

data/lib/org-ruby/textile_output_buffer.rb

@@ -11,12 +11,12 @@ module Orgmode
 
     def push_mode(mode)
       super(mode)
-      @output << "bc.. " if mode == :code
+      @output << "bc.. " if mode_is_code(mode)
     end
 
     def pop_mode(mode = nil)
       m = super(mode)
-      @add_paragraph = (m == :code)
+      @add_paragraph = (mode_is_code(m))
       m
     end
 

data/spec/html_examples/advanced-code.html

@@ -0,0 +1,36 @@
+<p class="title">advanced-code.org</p>
+<p>Turns out there&#8217;s more way to do code than just BEGIN_EXAMPLE.</p>
+<h1><span class="heading-number heading-number-1">1 </span>Inline examples</h1>
+<p>This should work:</p>
+<pre class="example">
+   fixed width? how does this work?   
+                         ...........
+                        ............
+                                   .
+                        .  .   .   .
+                        .          ..
+                        ....... .....
+                            .  .
+                            ....
+</pre>
+<p>Two ASCII blobs.</p>
+<h1><span class="heading-number heading-number-1">2 </span>BEGIN_SRC</h1>
+<pre class="example">
+PROPERTIES:
+ARCHIVE_TIME: 2009-12-26 Sat 22:16
+ARCHIVE_FILE: ~/brians-brain/content/projects/orgmode_parser.org
+ARCHIVE_OLPATH: &amp;lt;%= @page.title %&amp;gt;/Future Development
+ARCHIVE_CATEGORY: orgmode_parser
+ARCHIVE_TODO: DONE
+END:
+</pre>
+<p>And this:</p>
+<pre class="src">
+    # Finds all emphasis matches in a string.
+    # Supply a block that will get the marker and body as parameters.
+    def match_all(str)
+      str.scan(@org_emphasis_regexp) do |match|
+        yield $2, $3
+      end
+    end
+</pre>

data/spec/html_examples/advanced-code.org

@@ -0,0 +1,53 @@
+#+TITLE:     advanced-code.org
+#+AUTHOR:    Brian Dewey
+#+EMAIL:     bdewey@gmail.com
+#+DATE:      2009-12-30 Wed
+#+DESCRIPTION: More types of code support
+#+KEYWORDS: 
+#+LANGUAGE:  en
+#+OPTIONS:   H:3 num:t toc:nil \n:nil @:t ::t |:t ^:t -:t f:t *:t <:t
+#+OPTIONS:   TeX:t LaTeX:nil skip:nil d:nil todo:t pri:nil tags:not-in-toc
+#+INFOJS_OPT: view:nil toc:nil ltoc:t mouse:underline buttons:0 path:http://orgmode.org/org-info.js
+#+EXPORT_SELECT_TAGS: export
+#+EXPORT_EXCLUDE_TAGS: noexport
+#+LINK_UP:   
+#+LINK_HOME: 
+
+Turns out there's more way to do code than just BEGIN_EXAMPLE. 
+
+* Inline examples
+
+This should work:
+
+:   fixed width? how does this work?   
+:                         ...........
+:                        ............
+:                                   .
+:                        .  .   .   .
+:                        .          ..
+:                        ....... .....
+:                            .  .
+:                            ....
+
+Two ASCII blobs.
+
+* BEGIN_SRC
+:PROPERTIES:
+:ARCHIVE_TIME: 2009-12-26 Sat 22:16
+:ARCHIVE_FILE: ~/brians-brain/content/projects/orgmode_parser.org
+:ARCHIVE_OLPATH: &lt;%= @page.title %&gt;/Future Development
+:ARCHIVE_CATEGORY: orgmode_parser
+:ARCHIVE_TODO: DONE
+:END:
+
+And this:
+
+#+BEGIN_SRC ruby
+    # Finds all emphasis matches in a string.
+    # Supply a block that will get the marker and body as parameters.
+    def match_all(str)
+      str.scan(@org_emphasis_regexp) do |match|
+        yield $2, $3
+      end
+    end
+#+END_SRC

data/spec/html_examples/block_code.html

@@ -1,6 +1,6 @@
 <h1 class="title">Block Code</h1>
 <p>I need to get block code examples working. In <code>orgmode</code>, they look like this:</p>
-<pre>
+<pre class="example">
 
     def initialize(output)
       @output = output
@@ -17,7 +17,7 @@
 <p>And now I should be back to normal text.</p>
 <p>Putting in another paragraph for good measure.</p>
 <p>Code should also get cancelled by a list, thus:</p>
-<pre>
+<pre class="example">
 This is my code!
 
 Another line!

data/spec/html_examples/code-comment.html

@@ -1,6 +1,6 @@
 <h1 class="title">Code Comment</h1>
 <p>I need to be able to export things that look like org-mode comments inside of code blocks, like this:</p>
-<pre>
+<pre class="example">
 #+TITLE:     orgmode_parser.org
 #+AUTHOR:    
 #+EMAIL:     brian@BRIAN-DESK

data/spec/html_examples/escape-pre.html

@@ -1,4 +1,4 @@
-<pre>
+<pre class="example">
 &lt;li&gt;[ ] &amp;#8220;smart quotes&amp;#8221;&lt;/li&gt; 
 &lt;li&gt;[ ] I think I need this for &amp;#8216;single quotes&amp;#8217; too. Don&amp;#8217;t I?&lt;/li&gt; 
 &lt;li&gt;[ ] Em dashes would be great &amp;#8212; wouldn&amp;#8217;t they?&lt;/li&gt; 

data/spec/html_examples/metadata-comment.html

@@ -1,6 +1,6 @@
 <h1 class="title">Metadata, etc.</h1>
 <p>I normally filter out things that look like metadata. Can&#8217;t do it any more. I need to see all of the following:</p>
-<pre>
+<pre class="example">
 * DONE Handle inline formatting
   CLOSED: [2009-12-26 Sat 21:41]
   :PROPERTIES:

data/spec/line_spec.rb

@@ -24,6 +24,13 @@ describe Orgmode::Line do
     end
   end
 
+  [": inline", " :inline", "\t\t:\tinline"].each do |inline_example|
+    it "should recognize this inline example: #{inline_example}" do
+      Orgmode::Line.new(inline_example).inline_example?.should be_true
+    end
+  end
+    
+
   it "should recognize plain lists" do
     list_formats = ["-",
                     "+",

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: org-ruby
 version: !ruby/object:Gem::Version 
-  version: 0.5.0
+  version: 0.5.1
 platform: ruby
 authors: 
 - Brian Dewey
@@ -65,6 +65,8 @@ files:
 - spec/data/hyp-planning.org
 - spec/data/remember.org
 - spec/headline_spec.rb
+- spec/html_examples/advanced-code.html
+- spec/html_examples/advanced-code.org
 - spec/html_examples/advanced-lists.html
 - spec/html_examples/advanced-lists.org
 - spec/html_examples/block_code.html