org-ruby 0.6.4 → 0.7.0

data/History.txt

@@ -1,3 +1,7 @@
+== 0.7.0 / 2012-07-08
+
+* Highlight source code blocks using Pygments or CodeRay when available
+
 == 0.6.4 / 2012-07-08
 
 * Fixed lists behavior when code fragments, tables and examples were present

data/README.rdoc

@@ -17,6 +17,7 @@ extracting "content" from the orgfile as opposed to "metadata."
 * Supports bold, italic, underline, strikethrough, and code inline formatting.
 * Supports hyperlinks that are in double-brackets
 * Supports +.org+ views in Rails through Tilt.
+* Code syntax highlight of code blocks using Pygments.rb or Coderay when available
 * Upcoming: Handle export options specified in the org buffer.
 
 == SYNOPSIS:

data/lib/org-ruby.rb

@@ -21,7 +21,7 @@ require 'org-ruby/tilt'
 module OrgRuby
 
   # :stopdoc:
-  VERSION = '0.6.4'
+  VERSION = '0.7.0'
   LIBPATH = ::File.expand_path(::File.dirname(__FILE__)) + ::File::SEPARATOR
   PATH = ::File.dirname(LIBPATH) + ::File::SEPARATOR
   # :startdoc:

data/lib/org-ruby/html_output_buffer.rb

@@ -1,3 +1,14 @@
+begin
+  require 'pygments'
+rescue LoadError
+  # Pygments is not supported so we try instead with CodeRay
+  begin
+    require 'coderay'
+  rescue LoadError
+    # No code syntax highlighting
+  end
+end
+
 module Orgmode
 
   class HtmlOutputBuffer < OutputBuffer
@@ -56,8 +67,12 @@ module Orgmode
         css_class = " class=\"src src-#{@block_lang}\"" if mode == :src and not @block_lang.empty?
         css_class = " class=\"example\"" if (mode == :example || mode == :inline_example)
         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?
+
+        unless ((mode == :table and skip_tables?) or
+                (mode == :src and defined? Pygments))
+          @logger.debug "#{mode}: <#{ModeTag[mode]}#{css_class}>\n"
+          @output << "<#{ModeTag[mode]}#{css_class}>\n"
+        end
         # Entering a new mode obliterates the title decoration
         @title_decoration = ""
       end
@@ -78,8 +93,11 @@ module Orgmode
           close_floating_li_tags
         end
 
-        @logger.debug "</#{ModeTag[m]}>\n"
-        @output << "</#{ModeTag[m]}>\n" unless mode == :table and skip_tables?
+        unless ((mode == :table and skip_tables?) or
+                (mode == :src and defined? Pygments))
+          @logger.debug "</#{ModeTag[m]}>\n"
+          @output << "</#{ModeTag[m]}>\n"
+        end
 
         # In case it was a sublist, close it here
         close_last_li_tag_maybe
@@ -87,13 +105,40 @@ module Orgmode
     end
 
     def flush!
-      escape_buffer!
-      if mode_is_code(@buffer_mode) then
+      if buffer_mode_is_src_block?
+
+        # Only try to colorize #+BEGIN_SRC blocks with a specified language,
+        # but we still have to catch the cases when a lexer for the language was not available
+        if not @block_lang.empty? and (defined? Pygments or defined? CodeRay)
+          # NOTE: CodeRay and Pygments already escape the html once, so no need to escape_buffer!
+          if defined? Pygments
+            begin
+              @buffer = Pygments.highlight(@buffer, :lexer => @block_lang)
+            rescue ::RubyPython::PythonError
+              # Not supported lexer from Pygments, we fallback on using the text lexer
+              @buffer = Pygments.highlight(@buffer, :lexer => 'text')
+            end
+          elsif defined? CodeRay
+            # CodeRay might throw a warning when unsupported lang is set
+            silence_warnings do
+              @buffer = CodeRay.scan(@buffer, @block_lang).html(:wrap => nil, :css => :style)
+            end
+          end
+        else
+          escape_buffer!
+        end
+
+        @logger.debug "FLUSH SRC CODE ==========> #{@buffer.inspect}"
+        @output << @buffer
+      elsif mode_is_code(@buffer_mode) then
+        escape_buffer!
+
         # Whitespace is significant in :code mode. Always output the buffer
         # and do not do any additional translation.
         @logger.debug "FLUSH CODE ==========> #{@buffer.inspect}"
         @output << @buffer << "\n"
       else
+        escape_buffer!
         if @buffer.length > 0 and @output_type == :horizontal_rule then
           @output << "<hr />\n"
         elsif @buffer.length > 0 and @output_type == :definition_list then
@@ -183,6 +228,10 @@ module Orgmode
       @buffer_mode == :table
     end
 
+    def buffer_mode_is_src_block?
+      @buffer_mode == :src
+    end
+
     # Escapes any HTML content in the output accumulation buffer @buffer.
     def escape_buffer!
       @buffer.gsub!(/&/, "&amp;")
@@ -286,5 +335,15 @@ module Orgmode
         end
       end
     end
+
+    # Helper method taken from Rails
+    # https://github.com/rails/rails/blob/c2c8ef57d6f00d1c22743dc43746f95704d67a95/activesupport/lib/active_support/core_ext/kernel/reporting.rb#L10
+    def silence_warnings
+      warn_level = $VERBOSE
+      $VERBOSE = nil
+      yield
+    ensure
+      $VERBOSE = warn_level
+    end
   end                           # class HtmlOutputBuffer
 end                             # module Orgmode

data/lib/org-ruby/line.rb

@@ -164,10 +164,14 @@ module Orgmode
       $3 if @line =~ BlockRegexp
     end
 
-    def code_block_type?
+    def code_block?
       block_type =~ /^(EXAMPLE|SRC)$/i
     end
 
+    def code_block_line?
+      @assigned_paragraph_type == :src
+    end
+
     InlineExampleRegexp = /^\s*:\s/
 
     # Test if the line matches the "inline example" case:
@@ -200,6 +204,7 @@ module Orgmode
     # Determines the paragraph type of the current line.
     def paragraph_type
       return :blank if blank?
+      return :src if code_block_line? # Do not try to guess the type of this line if it is accumulating source code
       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?

data/lib/org-ruby/output_buffer.rb

@@ -78,9 +78,16 @@ module Orgmode
     # Prepares the output buffer to receive content from a line.
     # As a side effect, this may flush the current accumulated text.
     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?
+      @logger.debug "Looking at #{line.paragraph_type}(#{current_mode}) : #{line.to_s}"
+      if line.begin_block? and line.code_block?
+        flush!
+        # We try to get the lang from #+BEGIN_SRC blocks
+        @block_lang = line.block_lang
+        @output_type = line.paragraph_type
+      elsif current_mode == :example and line.end_block?
+        flush!
+        @output_type = line.paragraph_type
+      elsif not should_accumulate_output?(line)
         flush!
         maintain_list_indent_stack(line)
         @output_type = line.paragraph_type
@@ -207,6 +214,9 @@ module Orgmode
     # line breaks.)
     def should_accumulate_output?(line)
 
+      # Special case: We are accumulating source code block content for colorizing
+      return true if line.paragraph_type == :src and @output_type == :src
+
       # Special case: Preserve line breaks in block code mode.
       return false if preserve_whitespace?
 

data/lib/org-ruby/parser.rb

@@ -119,7 +119,8 @@ module Orgmode
               end
             end
             table_header_set = false if !line.table?
-            mode = :code if line.begin_block? and line.block_type == "EXAMPLE"
+            mode = :code if line.begin_block? and line.block_type.casecmp("EXAMPLE") == 0
+            mode = :src_code if line.begin_block? and line.block_type.casecmp("SRC") == 0
             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
@@ -142,7 +143,7 @@ module Orgmode
           # As long as we stay in code mode, force lines to be either blank or paragraphs.
           # Don't try to interpret structural items, like headings and tables.
           line = Line.new line, self
-          if line.end_block? and line.block_type == "EXAMPLE"
+          if line.end_block? and line.code_block?
             mode = :normal
           else
             line.assigned_paragraph_type = :paragraph unless line.blank?
@@ -153,6 +154,20 @@ module Orgmode
             @header_lines << line
           end
 
+        when :src_code
+
+          line = Line.new line, self
+          if line.end_block? and line.code_block?
+            mode = :normal            
+          else
+            line.assigned_paragraph_type = :src
+          end
+          if (@current_headline) then
+            @current_headline.body_lines << line
+          else
+            @header_lines << line
+          end
+
         when :property_drawer
 
           line = Line.new line, self
@@ -274,7 +289,6 @@ module Orgmode
           output_buffer << line.output_text << "\n"
 
         else
-
           if output_buffer.preserve_whitespace? then
             output_buffer << line.output_text
           else

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: org-ruby
 version: !ruby/object:Gem::Version 
-  hash: 15
+  hash: 3
   prerelease: 
   segments: 
   - 0
-  - 6
-  - 4
-  version: 0.6.4
+  - 7
+  - 0
+  version: 0.7.0
 platform: ruby
 authors: 
 - Brian Dewey