pandoc-ruby 0.1.0 → 0.2.0

data/README.markdown

@@ -8,14 +8,15 @@ Pandoc can read markdown and (subsets of) reStructuredText, HTML, and LaTeX, and
 
 First, make sure to [install Pandoc](http://johnmacfarlane.net/pandoc/#installing-pandoc).
 
-Next, install PandocRuby from gemcutter.
-
+Next, install PandocRuby from [gemcutter](http://gemcutter.org/gems/pandoc-ruby).
+    
     gem install gemcutter
-    gem tumble
+    gem tumble  # unless you've already run this.
     gem install pandoc-ruby
     
 ## Usage
 
+    require 'pandoc-ruby'
     @converter = PandocRuby.new('/some/file.md', :from => :markdown, :to => :rst)
     puts @converter.convert
 
@@ -33,11 +34,19 @@ will use Pandoc's `html2markdown` wrapper.
 
 Other arguments are simply converted into command line options, accepting symbols or strings for options without arguments and hashes of strings or symbols for options with arguments.
 
-    PandocRuby.convert('/some/file.html', :s, {:to => :rst, :f => :markdown}, 'no-wrap')
+    PandocRuby.convert('/some/file.html', :s, {:f => :markdown, :to => :rst}, 'no-wrap', :table_of_contents)
+
+is equivalent to
+
+    pandoc -s -f markdown --to=rst --no-wrap --table-of-contents /some/file.html
 
-becomes
+Also provided are `#to_[writer]` instance methods for each of the writers:
 
-    pandoc -s --to=rst -f markdown --no-wrap /some/file.html
+    PandocRuby.new("# Some title").to_html
+    => "<div id=\"some-title\"\n><h1\n  >Some title</h1\n  ></div\n>"
+    # or
+    PandocRuby.new("# Some title").to_rtf
+    => "{\\pard \\ql \\f0 \\sa180 \\li0 \\fi0 \\b \\fs36 Some title\\par}"
 
 PandocRuby assumes the pandoc executables are in the path.  If not, set their location
 with `PandocRuby.bin_path = '/path/to/bin'`
@@ -46,7 +55,7 @@ Available format readers and writers are available in the `PandocRuby::READERS`
 
 For more information on Pandoc, see the [Pandoc documentation](http://johnmacfarlane.net/pandoc/) or run `man pandoc`.
 
-If you'd prefer a pure-Ruby extended markdown interpreter that can output a few different formats, take a look at [Maruku](http://maruku.rubyforge.org/).
+If you'd prefer a pure-Ruby extended markdown interpreter that can output a few different formats, take a look at [Maruku](http://maruku.rubyforge.org/). If you want to use the full reStructuredText syntax from within Ruby, check out [RbST](http://rdoc.info/projects/autodata/rbst), a docutils wrapper.
 
 This gem was inspired by [Albino](http://github.com/github/albino). For a slightly different approach to using Pandoc with Ruby, see [Pandoku](http://github.com/dahlia/pandoku).
 

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.2.0

data/lib/pandoc-ruby.rb

@@ -52,9 +52,11 @@ class PandocRuby
   end
   alias_method :to_s, :convert
   
-  def to_html
-    @options << {:to => :html}
-    convert
+  WRITERS.each_key do |w|
+    define_method(:"to_#{w}") do
+      @options << {:to => w.to_sym}
+      convert
+    end
   end
   
 private
@@ -72,12 +74,17 @@ private
   def convert_options
     @options.inject('') do |string, opt|
       string + if opt.respond_to?(:each_pair)
-        opt.inject('') do |s, (flag, val)|
-          s + (flag.to_s.length == 1 ? " -#{flag} #{val}" : " --#{flag}=#{val}")
-        end
+        convert_opts_with_args(opt)
       else
-        opt.to_s.length == 1 ? " -#{opt}" : " --#{opt}"
+        opt.to_s.length == 1 ? " -#{opt}" : " --#{opt.to_s.gsub(/_/, '-')}"
       end
     end
   end
+  
+  def convert_opts_with_args(opt)
+    opt.inject('') do |string, (flag, val)|
+      flag = flag.to_s.gsub(/_/, '-')
+      string + (flag.length == 1 ? " -#{flag} #{val}" : " --#{flag}=#{val}")
+    end
+  end
 end

data/pandoc-ruby.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{pandoc-ruby}
-  s.version = "0.1.0"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["William Melody"]
-  s.date = %q{2009-11-04}
+  s.date = %q{2009-11-18}
   s.description = %q{Ruby wrapper for Pandoc}
   s.email = %q{wmelody@gmail.com}
   s.extra_rdoc_files = [
@@ -26,8 +26,8 @@ Gem::Specification.new do |s|
      "lib/pandoc-ruby.rb",
      "pandoc-ruby.gemspec",
      "test/benchmark.rb",
-     "test/benchmark.txt",
-     "test/test.md",
+     "test/files/benchmark.txt",
+     "test/files/test.md",
      "test/test_conversions.rb",
      "test/test_helper.rb",
      "test/test_pandoc-ruby.rb"

data/test/benchmark.rb

@@ -4,7 +4,7 @@
 #   http://tomayko.com/writings/ruby-markdown-libraries-real-cheap-for-you-two-for-price-of-one
 
 iterations = 100
-test_file = "#{File.dirname(__FILE__)}/benchmark.txt"
+test_file = File.join(File.dirname(__FILE__), 'files', 'benchmark.txt')
 impl_gems = {
   'BlueCloth'   => 'bluecloth',
   'RDiscount'   => 'rdiscount',

data/test/test_conversions.rb

@@ -1,5 +1,4 @@
 require 'test_helper'
-require 'mocha'
 
 class TestConversions < Test::Unit::TestCase
   

data/test/test_helper.rb

@@ -1,6 +1,7 @@
 require 'rubygems'
 require 'test/unit'
 require 'shoulda'
+require 'mocha'
 
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 $LOAD_PATH.unshift(File.dirname(__FILE__))

data/test/test_pandoc-ruby.rb

@@ -1,10 +1,9 @@
 require 'test_helper'
-require 'mocha'
 
 class TestPandocRuby < Test::Unit::TestCase
   
   def setup
-    @file = File.join(File.dirname(__FILE__), 'test.md')
+    @file = File.join(File.dirname(__FILE__), 'files', 'test.md')
     @converter = PandocRuby.new(@file, :t => :rst)
   end
   
@@ -38,8 +37,14 @@ class TestPandocRuby < Test::Unit::TestCase
   end
   
   should "accept a variety of options" do
-    converter = PandocRuby.new(@file, :s, {:to => :rst, :f => :markdown}, 'no-wrap')
-    converter.expects(:execute).with('pandoc -s --to=rst -f markdown --no-wrap').returns(true)
+    converter = PandocRuby.new(@file, :s, {:f => :markdown, :to => :rst}, 'no-wrap')
+    converter.expects(:execute).with('pandoc -s -f markdown --to=rst --no-wrap').returns(true)
+    assert converter.convert
+  end
+  
+  should "convert underscore symbol ares to hyphenated long options" do
+    converter = PandocRuby.new(@file, {:email_obfuscation => :javascript}, :table_of_contents)
+    converter.expects(:execute).with('pandoc --email-obfuscation=javascript --table-of-contents').returns(true)
     assert converter.convert
   end
 
@@ -55,10 +60,12 @@ class TestPandocRuby < Test::Unit::TestCase
     assert converter.convert
   end
   
-  should "convert to html with to_html" do
-    converter = PandocRuby.new(@file)
-    converter.expects(:execute).with('pandoc --to=html').returns(true)
-    assert converter.to_html
+  PandocRuby::WRITERS.each_key do |w|
+    should "convert to #{w} with to_#{w}" do
+      converter = PandocRuby.new(@file)
+      converter.expects(:execute).with("pandoc --to=#{w}").returns(true)
+      assert converter.send("to_#{w}")
+    end
   end
   
   should "work with strings" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: pandoc-ruby
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors: 
 - William Melody
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-11-04 00:00:00 -06:00
+date: 2009-11-18 00:00:00 -06:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -61,8 +61,8 @@ files:
 - lib/pandoc-ruby.rb
 - pandoc-ruby.gemspec
 - test/benchmark.rb
-- test/benchmark.txt
-- test/test.md
+- test/files/benchmark.txt
+- test/files/test.md
 - test/test_conversions.rb
 - test/test_helper.rb
 - test/test_pandoc-ruby.rb