org-ruby 0.8.2 → 0.8.3

data/History.txt

@@ -1,3 +1,9 @@
+== 0.8.3 / 2014-02-02
+
+* Bugfix: Two backslashes \\ at the end of the line make a line break without breaking paragraph.
+* Bugfix: Fix inline formatting not working for definition lists
+* Add basic markdown exporter
+
 == 0.8.2 / 2013-11-09
 
 * Manage the #+INCLUDE tag in org files (contribution by pierre-lecocq)

data/bin/org-ruby

@@ -17,7 +17,7 @@ options_parser = OptionParser.new do |opts|
     options[:debug] = true
   end
 
-  opts.on("-t", "--translate FORMAT", [:html, :textile],
+  opts.on("-t", "--translate FORMAT", [:html, :textile, :markdown],
           "Translate the ORG file to the specified format.") do |v|
     options[:format] = v
   end
@@ -43,9 +43,8 @@ begin
     $DEBUG = true if options[:debug]
     puts p.to_html if options[:format] == :html
     puts p.to_textile if options[:format] == :textile
+    puts p.to_markdown if options[:format] == :markdown
   end
 rescue OptionParser::ParseError
   puts options_parser
 end
-
-

data/lib/org-ruby.rb

@@ -15,13 +15,16 @@ require 'org-ruby/html_symbol_replace'
 require 'org-ruby/textile_output_buffer'
 require 'org-ruby/textile_symbol_replace'
 
+# Markdown exporter
+require 'org-ruby/markdown_output_buffer'
+
 # Tilt support
 require 'org-ruby/tilt'
 
 module OrgRuby
 
   # :stopdoc:
-  VERSION = '0.8.2'
+  VERSION = '0.8.3'
   LIBPATH = ::File.expand_path(::File.dirname(__FILE__)) + ::File::SEPARATOR
   PATH = ::File.dirname(LIBPATH) + ::File::SEPARATOR
   # :startdoc:

data/lib/org-ruby/html_output_buffer.rb

@@ -172,6 +172,8 @@ module Orgmode
           push_mode(:definition_descr, indent)
           @output << inline_formatting(d[2].strip + d[3])
           @new_paragraph = nil
+          # FIXME: Need to restore tags once again (this should be done in escape_buffer!)
+          @output.gsub!(/@(<[^<>\n]*>)/, "\\1")
 
         when :horizontal_rule
           add_paragraph unless @new_paragraph == :start
@@ -328,6 +330,10 @@ module Orgmode
           "@<sup>@<a class=\"footref\" name=\"fnr.#{name}\" href=\"#fn.#{name}\">#{name}@</a>@</sup>"
         end
       end
+      # Two backslashes \\ at the end of the line make a line break without breaking paragraph.
+      if @output_type != :table_row and @output_type != :table_header then
+        str.sub!(/\\\\$/, "@<br />")
+      end
       escape_buffer!
       Orgmode.special_symbols_to_html str
       str = @re_help.restore_code_snippets str

data/lib/org-ruby/markdown_output_buffer.rb

@@ -0,0 +1,109 @@
+require 'stringio'
+
+module Orgmode
+
+  class MarkdownOutputBuffer < OutputBuffer
+
+    def initialize(output)
+      super(output)
+    end
+
+    def push_mode(mode, indent)
+      super(mode, indent)
+    end
+
+    def pop_mode(mode = nil)
+      m = super(mode)
+      @list_indent_stack.pop
+      m
+    end
+
+    # Maps org markup to markdown markup.
+    MarkdownMap = {
+      "*" => "**",
+      "/" => "*",
+      "_" => "*",
+      "=" => "`",
+      "~" => "`",
+      "+" => "~~"
+    }
+
+    # Handles inline formatting for markdown.
+    def inline_formatting(input)
+      @re_help.rewrite_emphasis input do |marker, body|
+        m = MarkdownMap[marker]
+        "#{m}#{body}#{m}"
+      end
+      @re_help.rewrite_subp input do |type, text|
+        if type == "_" then
+          "<sub>#{text}</sub>"
+        elsif type == "^" then
+          "<sup>#{text}</sup>"
+        end
+      end
+      @re_help.rewrite_links input do |link, defi|
+        # We don't add a description for images in links, because its
+        # empty value forces the image to be inlined.
+        defi ||= link unless link =~ @re_help.org_image_file_regexp
+        link = link.gsub(/ /, "%%20")
+
+        if defi =~ @re_help.org_image_file_regexp
+          "![#{defi}](#{defi})"
+        elsif defi
+          "[#{defi}](#{link})"
+        else
+          "[#{link}](#{link})"
+        end
+      end
+
+      # Just reuse Textile special symbols for now?
+      Orgmode.special_symbols_to_textile(input)
+      input = @re_help.restore_code_snippets input
+      input
+    end
+
+    # TODO: Implement this
+    def output_footnotes!
+      return false
+    end
+
+    # Flushes the current buffer
+    def flush!
+      return false if @buffer.empty? and @output_type != :blank
+      @logger.debug "FLUSH ==========> #{@output_type}"
+      @buffer.gsub!(/\A\n*/, "")
+
+      case
+      when mode_is_code?(current_mode)
+        @output << "```#{@block_lang}\n"
+        @output << @buffer << "\n"
+        @output << "```\n"
+      when preserve_whitespace?
+        @output << @buffer << "\n"
+
+      when @output_type == :blank
+        @output << "\n"
+
+      else
+        case current_mode
+        when :paragraph
+          @output << "> " if @mode_stack[0] == :quote
+
+        when :list_item
+          @output << " " * @mode_stack.count(:list_item) << "* "
+
+        when :horizontal_rule
+          @output << "---"
+
+        end
+        @output << inline_formatting(@buffer) << "\n"
+      end
+      @buffer = ""
+    end
+
+    def add_line_attributes headline
+      @output << "#" * headline.level
+      @output << " "
+    end
+  end                           # class MarkdownOutputBuffer
+end                             # module Orgmode

data/lib/org-ruby/parser.rb

@@ -255,6 +255,27 @@ module Orgmode
       output
     end
 
+    # Exports the Org mode content into Markdown format
+    def to_markdown
+      mark_trees_for_export
+      output = ""
+      output_buffer = MarkdownOutputBuffer.new(output)
+
+      translate(@header_lines, output_buffer)
+      @headlines.each do |headline|
+        next if headline.export_state == :exclude
+        case headline.export_state
+        when :exclude
+          # NOTHING
+        when :headline_only
+          translate(headline.body_lines[0, 1], output_buffer)
+        when :all
+          translate(headline.body_lines, output_buffer)
+        end
+      end
+      output
+    end
+
     # Converts the loaded org-mode file to HTML.
     def to_html
       mark_trees_for_export

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: org-ruby
 version: !ruby/object:Gem::Version
-  version: 0.8.2
+  version: 0.8.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-23 00:00:00.000000000Z
+date: 2014-02-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubypants
-  requirement: &70289581896800 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,7 +21,12 @@ dependencies:
         version: 0.2.0
   type: :runtime
   prerelease: false
-  version_requirements: *70289581896800
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.2.0
 description: ! 'An org-mode parser written in Ruby. This gem contains Ruby routines
   for parsing org-mode files.The most
 
@@ -52,10 +57,11 @@ files:
 - lib/org-ruby/output_buffer.rb
 - lib/org-ruby/parser.rb
 - lib/org-ruby/regexp_helper.rb
+- lib/org-ruby/markdown_output_buffer.rb
 - lib/org-ruby/textile_output_buffer.rb
 - lib/org-ruby/textile_symbol_replace.rb
 - lib/org-ruby/tilt.rb
-homepage: http://github.com/bdewey/org-ruby
+homepage: https://github.com/bdewey/org-ruby
 licenses:
 - MIT
 post_install_message: 
@@ -78,8 +84,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: org-ruby
-rubygems_version: 1.8.10
+rubygems_version: 1.8.21
 signing_key: 
 specification_version: 3
 summary: This gem contains Ruby routines for parsing org-mode files.
 test_files: []
+has_rdoc: