org-ruby 0.8.3 → 0.9.0

data/History.txt

@@ -1,3 +1,8 @@
+== 0.9.0 / 2014-02-08
+
+* Add explicit enable or disable of include file feature
+* Add lang attribute to src code block to support syntax highlight in Github
+
 == 0.8.3 / 2014-02-02
 
 * Bugfix: Two backslashes \\ at the end of the line make a line break without breaking paragraph.

data/README.rdoc

@@ -25,6 +25,10 @@ From Ruby code:
      Orgmode::Parser.new("* Hello world!).to_textile
      # => "h1. Hello world!\n" 
 
+     # Renders Markdown
+     Orgmode::Parser.new("* Hello world!).to_markdown
+     # => "# Hello world!\n" 
+
 It can also be used from the command line:
 
      org-ruby sample.org --translate html
@@ -35,6 +39,10 @@ It can also be used from the command line:
 
 ...will output a textile version of sample.org.
 
+     org-ruby --translate markdown sample.org
+
+...will output a markdown version of sample.org.
+
 == Features
 
 * Converts org-mode files to HTML or Textile

data/lib/org-ruby.rb

@@ -24,7 +24,7 @@ require 'org-ruby/tilt'
 module OrgRuby
 
   # :stopdoc:
-  VERSION = '0.8.3'
+  VERSION = '0.9.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

@@ -67,7 +67,7 @@ module Orgmode
                       when (mode == :src and @block_lang.empty?)
                         " class=\"src\""
                       when (mode == :src and not @block_lang.empty?)
-                        " class=\"src src-#{@block_lang}\""
+                        " class=\"src\" lang=\"#{@block_lang}\""
                       when (mode == :example || mode == :inline_example)
                         " class=\"example\""
                       when mode == :center

data/lib/org-ruby/parser.rb

@@ -81,7 +81,7 @@ module Orgmode
 
     # I can construct a parser object either with an array of lines
     # or with a single string that I will split along \n boundaries.
-    def initialize(lines, offset=0)
+    def initialize(lines, parser_options={ })
       if lines.is_a? Array then
         @lines = lines
       elsif lines.is_a? String then
@@ -97,8 +97,34 @@ module Orgmode
       @in_buffer_settings = { }
       @options = { }
       @link_abbrevs = { }
+      @parser_options = parser_options
+
+      #
+      # Include file feature disabled by default since 
+      # it would be dangerous in some environments
+      #
+      # http://orgmode.org/manual/Include-files.html
+      #
+      # It will be activated by one of the following:
+      #
+      # - setting an ORG_RUBY_ENABLE_INCLUDE_FILES env variable to 'true'
+      # - setting an ORG_RUBY_INCLUDE_ROOT env variable with the root path
+      # - explicitly enabling it by passing it as an option:
+      #   e.g. Orgmode::Parser.new(org_text, { :allow_include_files => true })
+      #
+      # IMPORTANT: To avoid the feature altogether, it can be _explicitly disabled_ as follows:
+      #   e.g. Orgmode::Parser.new(org_text, { :allow_include_files => false })
+      #
+      if @parser_options[:allow_include_files].nil?
+        if ENV['ORG_RUBY_ENABLE_INCLUDE_FILES'] == 'true' \
+          or not ENV['ORG_RUBY_INCLUDE_ROOT'].nil?
+          @parser_options[:allow_include_files] = true
+        end
+      end
 
-      parse_lines @lines, offset
+      @parser_options[:offset] ||= 0
+
+      parse_lines @lines
     end
 
     # Check include file availability and permissions
@@ -119,24 +145,19 @@ module Orgmode
       can_be_included
     end
 
-    # Parse lines
-    def parse_lines(lines, offset)
+    def parse_lines(lines)
       mode = :normal
       previous_line = nil
       table_header_set = false
       lines.each do |text|
         line = Line.new text, self
 
-        # Disable file include feature by default since it would be dangerous in some environments
-        # It can be activated either by setting a ORG_RUBY_ENABLE_INCLUDE_FILES environment variable
-        # or by setting a root path for included file via the ORG_RUBY_INCLUDE_ROOT environment variable
-        if ENV['ORG_RUBY_ENABLE_INCLUDE_FILES'] == 'true' \
-          or not ENV['ORG_RUBY_INCLUDE_ROOT'].nil?
+        if @parser_options[:allow_include_files]
           if line.include_file? and not line.include_file_path.nil?
             next if not check_include_file line.include_file_path
             include_data = get_include_data line
-            include_lines = Orgmode::Parser.new(include_data).lines
-            parse_lines include_lines, offset
+            include_lines = Orgmode::Parser.new(include_data, @parser_options).lines
+            parse_lines include_lines
           end
         end
 
@@ -152,7 +173,7 @@ module Orgmode
         case mode
         when :normal, :quote, :center
           if Headline.headline? line.to_s
-            line = Headline.new line.to_s, self, offset
+            line = Headline.new line.to_s, self, @parser_options[:offset]
           elsif line.table_separator?
             if previous_line and previous_line.paragraph_type == :table_row and !table_header_set
               previous_line.assigned_paragraph_type = :table_header

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: org-ruby
 version: !ruby/object:Gem::Version
-  version: 0.8.3
+  version: 0.9.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-02 00:00:00.000000000 Z
+date: 2014-02-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubypants
@@ -84,9 +84,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: org-ruby
-rubygems_version: 1.8.21
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: This gem contains Ruby routines for parsing org-mode files.
 test_files: []
-has_rdoc: