pandoc-ruby 0.3.1 → 0.4.0

data/README.markdown

@@ -15,24 +15,24 @@ Next, install PandocRuby from [gemcutter](http://gemcutter.org/gems/pandoc-ruby)
 ## Usage
 
     require 'pandoc-ruby'
-    @converter = PandocRuby.new('/some/file.md', :from => :markdown, :to => :rst)
+    @converter = PandocRuby.new('# Markdown Title', :from => :markdown, :to => :rst)
     puts @converter.convert
 
-This takes the Markdown formatted file and converts it to reStructuredText. The first argument can be either a file or a string.
+This takes the Markdown formatted file and converts it to reStructuredText.
 
 You can also use the `#convert` class method:
 
-    puts PandocRuby.convert('/some/file.md', :from => :markdown, :to => :html)
+    puts PandocRuby.convert('# Markdown Title', :from => :markdown, :to => :html)
 
 When no options are passed, pandoc's default behavior converts markdown to html. To specify options, simply pass options as a hash to the initializer. Pandoc's wrapper executables can also be used by passing the executable name as the second argument. For example,
 
-    PandocRuby.new('/some/file.html', 'html2markdown')
+    PandocRuby.new('<p>Some <em>HTML</em></p>', 'html2markdown')
 
 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, {:f => :markdown, :to => :rst}, 'no-wrap', :table_of_contents)
+    PandocRuby.convert('# Markdown Title', :s, {:f => :markdown, :to => :rst}, 'no-wrap', :table_of_contents)
 
 is equivalent to
 
@@ -43,8 +43,8 @@ Also provided are `#to_[writer]` instance methods for each of the writers, and t
     PandocRuby.new("# Some title").to_html(:no_wrap)
     => "<div id=\"some-title\"><h1>Some title</h1></div>"
     # or
-    PandocRuby.new("# Some title").to_rtf
-    => "{\\pard \\ql \\f0 \\sa180 \\li0 \\fi0 \\b \\fs36 Some title\\par}"
+    PandocRuby.new("# Some title").to_rst
+    => "Some title\n=========="
 
 Similarly, there are class methods for each of the readers, so readers and writers can be specified like this:
 
@@ -54,14 +54,25 @@ Similarly, there are class methods for each of the readers, so readers and write
 PandocRuby assumes the pandoc executables are in the path.  If not, set their location
 with `PandocRuby.bin_path = '/path/to/bin'`
 
+Pandoc can also be set to take a file path as the first argument. For security reasons, this is disabled by default, but it can be enabled and used as follows
+
+    PandocRuby.allow_file_paths = true
+    PandocRuby.html('/some/file.html').to_markdown
+
 Available format readers and writers are available in the `PandocRuby::READERS` and `PandocRuby::WRITERS` constants.
 
-For more information on Pandoc, see the [Pandoc documentation](http://johnmacfarlane.net/pandoc/) or run `man pandoc`.
+For more information on Pandoc, see the [Pandoc documentation](http://johnmacfarlane.net/pandoc/) or run `man pandoc` ([also available here](http://johnmacfarlane.net/pandoc/pandoc.1.html)).
 
 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).
 
+## Pandoc Hint
+
+If you are trying to generate a standalone file with full file headers rather than just a marked up fragment, remember to pass the `:standalone` option so the correct header and footer are added.
+
+    PandocRuby.new("# Some title", :standalone).to_rtf
+
 ## Caveats
 
 * This has only been tested on \*nix systems.

data/VERSION

@@ -1 +1 @@
-0.3.1
+0.4.0

data/lib/pandoc-ruby.rb

@@ -2,6 +2,8 @@ require 'open3'
 
 class PandocRuby
   @@bin_path = nil
+  @@allow_file_paths = false
+  
   EXECUTABLES = %W[
     pandoc
     markdown2pdf
@@ -34,14 +36,22 @@ class PandocRuby
   def self.bin_path=(path)
     @@bin_path = path
   end
-
+  
+  def self.allow_file_paths=(value)
+    @@allow_file_paths = value
+  end
+  
   def self.convert(*args)
     new(*args).convert
   end
 
   def initialize(*args)
     target = args.shift
-    @target  = File.exists?(target) ? File.read(target) : target rescue target
+    @target = if @@allow_file_paths && File.exists?(target)
+      File.read(target)
+    else
+      target rescue target
+    end
     @executable = EXECUTABLES.include?(args[0]) ? args.shift : 'pandoc'
     @options = args
   end

data/pandoc-ruby.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{pandoc-ruby}
-  s.version = "0.3.1"
+  s.version = "0.4.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["William Melody"]
-  s.date = %q{2009-12-02}
+  s.date = %q{2010-02-10}
   s.description = %q{Ruby wrapper for Pandoc}
   s.email = %q{wmelody@gmail.com}
   s.extra_rdoc_files = [

data/test/test_pandoc-ruby.rb

@@ -9,6 +9,7 @@ class TestPandocRuby < Test::Unit::TestCase
   
   def teardown
     PandocRuby.bin_path = nil
+    PandocRuby.allow_file_paths = false
   end
   
   should "call bare pandoc when passed no options" do
@@ -25,6 +26,16 @@ class TestPandocRuby < Test::Unit::TestCase
     assert converter.convert
   end
   
+  should "treat file paths as strings by default" do
+    assert_equal "<p\n>#{@file}</p\n>", PandocRuby.new(@file).to_html
+  end
+
+  should "treat file paths as file paths when enabled" do
+    PandocRuby.allow_file_paths = true
+    assert PandocRuby.new(@file).to_html.match(%r{This is a Title})
+  end
+
+
   should "accept short options" do
     @converter.expects(:execute).with('pandoc -t rst').returns(true)
     assert @converter.convert
@@ -128,5 +139,6 @@ class TestPandocRuby < Test::Unit::TestCase
       's5'            => 'S5 HTML and javascript slide show',
       'rtf'           => 'rich text format'
     }
+
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: pandoc-ruby
 version: !ruby/object:Gem::Version 
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors: 
 - William Melody
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-12-02 00:00:00 -06:00
+date: 2010-02-10 00:00:00 -06:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency