pandoc-ruby 0.0.2

data/.document

@@ -0,0 +1,5 @@
+README.markdown
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,5 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 William Melody
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.markdown

@@ -0,0 +1,64 @@
+# PandocRuby
+
+Wrapper for [Pandoc](http://johnmacfarlane.net/pandoc/), a Haskell library with command line tools for converting one markup format to another.
+
+Pandoc can read markdown and (subsets of) reStructuredText, HTML, and LaTeX, and it can write markdown, reStructuredText, HTML, LaTeX, ConTeXt, PDF, RTF, DocBook XML, OpenDocument XML, ODT, GNU Texinfo, MediaWiki markup, groff man pages, and S5 HTML slide shows
+
+## Installation
+
+First, make sure to [install Pandoc](http://johnmacfarlane.net/pandoc/#installing-pandoc).
+
+Next, install PandocRuby from gemcutter.
+
+    gem install gemcutter
+    gem tumble
+    gem install pandoc-ruby
+    
+## Usage
+
+    @converter = PandocRuby.new('/some/file.md', :from => :markdown, :to => :rst)
+    puts @converter.convert
+
+This takes the 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)
+
+Another also: you get a `#to_s`, for somewhat nicer use in Rails views.
+
+    ... helper file ...
+    def format(text)
+      PandocRuby.convert(text)
+    end
+
+    ... view file ...
+    <%= format text %>
+
+The default behavior follows the pandoc executable's behavior, converting 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')
+
+will use Pandoc's `html2markdown` wrapper.
+
+Assumes pandoc executables are in the path.  If not, set their location
+with `PandocRuby.bin_path = '/path/to/bin'`
+
+For more information on Pandoc, see the [Pandoc documentation](http://johnmacfarlane.net/pandoc/) or run `man pandoc`.
+
+Pretty much everything in the gem was derived directly from [Albino](http://github.com/github/albino).
+
+## 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. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,56 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "pandoc-ruby"
+    gem.summary = %Q{PandocRuby}
+    gem.description = %Q{Ruby wrapper for Pandoc}
+    gem.email = "wmelody@gmail.com"
+    gem.homepage = "http://github.com/autodata/pandoc-ruby"
+    gem.authors = ["William Melody"]
+    gem.add_development_dependency "thoughtbot-shoulda"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/*_test.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION')
+    version = File.read('VERSION')
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "pandoc-ruby #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.2

data/lib/pandoc-ruby.rb

@@ -0,0 +1,55 @@
+require 'open4'
+
+class PandocRuby
+  @@bin_path = nil
+  EXECUTABLES = %W[
+    pandoc
+    markdown2pdf
+    html2markdown
+    hsmarkdown
+  ]
+  
+  def self.bin_path=(path)
+    @@bin_path = bin_path
+  end
+
+  def self.convert(*args)
+    new(*args).convert
+  end
+
+  def initialize(target, *args)
+    @target  = File.exists?(target) ? File.read(target) : target rescue target
+    if args[0] && !args[0].respond_to?(:merge) && EXECUTABLES.include?(args[0])
+      @executable = args[0]
+    else
+      @executable = 'pandoc'
+    end
+    @options = args.last.respond_to?(:merge) ? args.last : {}
+  end
+
+  def execute(command)
+    pid, stdin, stdout, stderr = Open4.popen4(command)
+    stdin.puts @target
+    stdin.close
+    stdout.read.strip
+  end
+
+  def convert
+    if @@bin_path
+      execute File.join(@@bin_path, @executable) + convert_options
+    else
+      execute @executable + convert_options
+    end
+  end
+  alias_method :to_s, :convert
+
+  def convert_options
+    @options.inject('') do |string, (flag, value)|
+      if flag.to_s.length == 1
+        string + " -#{flag} #{value}"
+      else
+        string + " --#{flag}=#{value}"
+      end
+    end
+  end
+end

data/pandoc-ruby.gemspec

@@ -0,0 +1,54 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE
+# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec`
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{pandoc-ruby}
+  s.version = "0.0.2"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["William Melody"]
+  s.date = %q{2009-10-12}
+  s.description = %q{Ruby wrapper for Pandoc}
+  s.email = %q{wmelody@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.markdown"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.markdown",
+     "Rakefile",
+     "VERSION",
+     "lib/pandoc-ruby.rb",
+     "pandoc-ruby.gemspec",
+     "test/pandoc-ruby_test.rb",
+     "test/test.md",
+     "test/test_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/autodata/pandoc-ruby}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{PandocRuby}
+  s.test_files = [
+    "test/pandoc-ruby_test.rb",
+     "test/test_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+    else
+      s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+  end
+end

data/test/pandoc-ruby_test.rb

@@ -0,0 +1,52 @@
+require 'test_helper'
+require 'mocha'
+
+class PandocRubyTest < Test::Unit::TestCase
+  
+  def setup
+    @file = File.join(File.dirname(__FILE__), 'test.md')
+    @converter = PandocRuby.new(@file, :t => :rst)
+  end
+  
+  should "convert mimic default behavior" do
+    converter = PandocRuby.new(@file)
+    assert converter.expects(:execute).with('pandoc').returns(true)
+    converter.convert
+  end
+  
+  should "accept short options" do
+    assert @converter.expects(:execute).with('pandoc -t rst').returns(true)
+    @converter.convert
+  end
+  
+  should "accept long options" do
+    converter = PandocRuby.new(@file, :to => :rst)
+    assert converter.expects(:execute).with('pandoc --to=rst').returns(true)
+    converter.convert
+  end
+  
+  should "accept optional executable" do
+    converter = PandocRuby.new(@file, 'html2markdown')
+    assert converter.expects(:execute).with('html2markdown').returns(true)
+    converter.convert
+  end
+  
+  should "not accept non-pandoc optional executable" do
+    converter = PandocRuby.new(@file, 'ls')
+    assert converter.expects(:execute).with('pandoc').returns(true)
+    converter.convert
+  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
+end

data/test/test.md

@@ -0,0 +1,3 @@
+# This is a Title
+
+Some *emphasized text* and [a link](http://daringfireball.net/projects/markdown/)

data/test/test_helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'pandoc-ruby'
+
+class Test::Unit::TestCase
+end

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification 
+name: pandoc-ruby
+version: !ruby/object:Gem::Version 
+  version: 0.0.2
+platform: ruby
+authors: 
+- William Melody
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-10-12 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: thoughtbot-shoulda
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: Ruby wrapper for Pandoc
+email: wmelody@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.markdown
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.markdown
+- Rakefile
+- VERSION
+- lib/pandoc-ruby.rb
+- pandoc-ruby.gemspec
+- test/pandoc-ruby_test.rb
+- test/test.md
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/autodata/pandoc-ruby
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: PandocRuby
+test_files: 
+- test/pandoc-ruby_test.rb
+- test/test_helper.rb