pandoc-ruby 1.0.0 → 2.0.0

data/README.markdown

@@ -1,95 +0,0 @@
-# PandocRuby
-
-Wrapper for [Pandoc](http://johnmacfarlane.net/pandoc/), a Haskell library with command line tools for converting one markup format to another.
-
-Pandoc can convert documents in markdown, reStructuredText, textile, HTML, DocBook, LaTeX, or MediaWiki markup to a variety of formats, including markdown, reStructuredText, HTML, LaTeX, ConTeXt, PDF, RTF, DocBook XML, OpenDocument XML, ODT, GNU Texinfo, MediaWiki markup, groff man pages, HTML slide shows, EPUB, and Microsoft Word docx.
-
-## Installation
-
-First, make sure to [install Pandoc](http://johnmacfarlane.net/pandoc/installing.html).
-
-Next, install PandocRuby from [RubyGems](http://rubygems.org/gems/pandoc-ruby).
-
-    gem install pandoc-ruby
-
-## Usage
-
-    require 'pandoc-ruby'
-    @converter = PandocRuby.new('# Markdown Title', :from => :markdown, :to => :rst)
-    puts @converter.convert
-
-This takes the Markdown formatted file and converts it to reStructuredText.
-
-You can also use the `#convert` class method:
-
-    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('<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('# Markdown Title', :s, {:f => :markdown, :to => :rst}, 'no-wrap', :table_of_contents)
-
-is equivalent to
-
-    echo "# Markdown Title" | pandoc -s -f markdown --to=rst --no-wrap --table-of-contents
-
-Also provided are `#to_[writer]` instance methods for each of the writers, and these can also accept options:
-
-    PandocRuby.new("# Some title").to_html(:no_wrap)
-    => "<div id=\"some-title\"><h1>Some title</h1></div>"
-    # or
-    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:
-
-    PandocRuby.html("<h1>hello</h1>").to_latex
-    => "\\section{hello}"
-
-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` ([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](https://github.com/alphabetum/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 Tip
-
-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
-
-* Ruby 1.9.3 or higher is required.
-* This has only been tested on \*nix systems.
-* PDF conversion may require additional dependencies and has not been tested.
-
-## Note on Patches/Pull Requests
-
-* Fork the project.
-* Make your feature addition or bug fix.
-* Add tests for it. This is important so I don't break it in a
-  future version unintentionally.
-* Commit, do not mess with rakefile, version, or history.
-  (if you want to have your own version, that is fine but
-  bump version in a commit by itself I can ignore when I pull)
-* Send me a pull request. Bonus points for topic branches.
-
-## Copyright
-
-Copyright (c) 2009-∞ William Melody · => [@alphabetum](http://twitter.com/alphabetum)

data/test/test_pandoc-ruby.rb

@@ -1,199 +0,0 @@
-require 'helper'
-
-class TestPandocRuby < Test::Unit::TestCase
-
-  def setup
-    @file = File.join(File.dirname(__FILE__), 'files', 'test.md')
-    @converter = PandocRuby.new(@file, :t => :rst)
-  end
-
-  def teardown
-    PandocRuby.bin_path = nil
-    PandocRuby.allow_file_paths = false
-  end
-
-  should "call bare pandoc when passed no options" do
-    converter = PandocRuby.new(@file)
-    converter.expects(:execute).with('pandoc').returns(true)
-    assert converter.convert
-  end
-
-  should "convert with altered bin_path" do
-    path = %x[which pandoc].strip
-    PandocRuby.bin_path = path
-    converter = PandocRuby.new(@file)
-    converter.expects(:execute).with("#{path}/pandoc").returns(true)
-    assert converter.convert
-  end
-
-  should "treat file paths as strings by default" do
-    assert_equal "<p>#{@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
-  end
-
-  should "accept long options" do
-    converter = PandocRuby.new(@file, :to => :rst)
-    converter.expects(:execute).with('pandoc --to rst').returns(true)
-    assert converter.convert
-  end
-
-  should "accept a variety of options in initializer" do
-    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 "accept a variety of options in convert" do
-    converter = PandocRuby.new(@file)
-    converter \
-      .expects(:execute) \
-      .with('pandoc -s -f markdown --to rst --no-wrap') \
-      .returns(true)
-    assert converter.convert(:s, {:f => :markdown, :to => :rst}, 'no-wrap')
-  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
-
-  should "accept optional executable" do
-    converter = PandocRuby.new(@file, 'html2markdown')
-    converter.expects(:execute).with('html2markdown').returns(true)
-    assert converter.convert
-  end
-
-  should "use non-executable second arg as option" do
-    converter = PandocRuby.new(@file, 'toc')
-    converter.expects(:execute).with('pandoc --toc').returns(true)
-    assert converter.convert
-  end
-
-  should "raise RuntimeError from pandoc executable error" do
-    assert_raise RuntimeError do
-      PandocRuby.new("# hello", "badopt").to_html5
-    end
-  end
-
-  PandocRuby::READERS.each_key do |r|
-    should "convert from #{r} with PandocRuby.#{r}" do
-      converter = PandocRuby.send(r, @file)
-      converter.expects(:execute).with("pandoc --from #{r}").returns(true)
-      assert converter.convert
-    end
-  end
-
-  PandocRuby::STRING_WRITERS.each_key do |w|
-    should "convert to #{w} with to_#{w}" do
-      converter = PandocRuby.new(@file)
-      converter \
-        .expects(:execute) \
-        .with("pandoc --no-wrap --to #{w}") \
-        .returns(true)
-      assert converter.send("to_#{w}", :no_wrap)
-    end
-  end
-
-  PandocRuby::BINARY_WRITERS.each_key do |w|
-    should "convert to #{w} with to_#{w}" do
-      converter = PandocRuby.new(@file)
-      converter \
-        .expects(:execute) \
-        .with(regexp_matches(/^pandoc --no-wrap --to #{w} --output /)) \
-        .returns(true)
-      assert converter.send("to_#{w}", :no_wrap)
-    end
-  end
-
-  should "work with strings" do
-    converter = PandocRuby.new('## this is a title')
-    assert_match %r(h2), converter.convert
-  end
-
-  should "alias to_s" do
-    assert_equal @converter.convert, @converter.to_s
-  end
-
-  should "have convert class method" do
-    assert_equal @converter.convert, PandocRuby.convert(@file, :t => :rst)
-  end
-
-  should "run more than 400 times without error" do
-    begin
-      400.times do
-        PandocRuby.convert(@file)
-      end
-      assert true
-    rescue Errno::EMFILE, Errno::EAGAIN => e
-      flunk e
-    end
-  end
-
-  should "have reader and writer constants" do
-    assert_equal PandocRuby::READERS, {
-      "html"      =>  "HTML",
-      "latex"     =>  "LaTeX",
-      "textile"   =>  "textile",
-      "native"    =>  "pandoc native",
-      "markdown"  =>  "markdown",
-      "json"      =>  "pandoc JSON",
-      "rst"       =>  "reStructuredText"
-    }
-
-    assert_equal PandocRuby::STRING_WRITERS, {
-      "mediawiki"     =>  "MediaWiki markup",
-      "html"          =>  "HTML",
-      "plain"         =>  "plain",
-      "latex"         =>  "LaTeX",
-      "s5"            =>  "S5 HTML slideshow",
-      "textile"       =>  "textile",
-      "texinfo"       =>  "GNU Texinfo",
-      "docbook"       =>  "DocBook XML",
-      "html5"         =>  "HTML5",
-      "native"        =>  "pandoc native",
-      "org"           =>  "emacs org mode",
-      "rtf"           =>  "rich text format",
-      "markdown"      =>  "markdown",
-      "man"           =>  "groff man",
-      "dzslides"      =>  "Dzslides HTML slideshow",
-      "beamer"        =>  "Beamer PDF slideshow",
-      "json"          =>  "pandoc JSON",
-      "opendocument"  =>  "OpenDocument XML",
-      "slidy"         =>  "Slidy HTML slideshow",
-      "rst"           =>  "reStructuredText",
-      "context"       =>  "ConTeXt",
-      "asciidoc"      =>  "asciidoc"
-    }
-
-    assert_equal PandocRuby::BINARY_WRITERS, {
-      "odt"   => "OpenDocument",
-      "docx"  => "Word docx",
-      "epub"  => "EPUB V2",
-      "epub3" => "EPUB V3"
-    }
-
-    assert_equal PandocRuby::WRITERS, (
-      PandocRuby::STRING_WRITERS.merge(PandocRuby::BINARY_WRITERS)
-    )
-  end
-end