pandoc_rb 0.2.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c27ff79488f9163a4b41df80ae1d95e84f89e824
+  data.tar.gz: 0513060bf403e6030a1b0a4404a87a60260aa04d
+SHA512:
+  metadata.gz: 53e519be108994e836a6607d628c21e710df3d5b1cf05de9946073bf358e7c5d85f16dc8e2359b5e8b8e552ee28103320faa664a650c9b78dd603a3630a3e018
+  data.tar.gz: c18837eeb3c34ef302ab17cdc5dd2ca8678679cafc26b5f8ecd538515f043a9e2696354ca00e29900a65b77e1bb91052c1953e7149002ed9661f5d426a73851a

data/.gitignore

@@ -0,0 +1,45 @@
+*.aux
+*.chi
+*.chs.h
+*.dyn_hi
+*.dyn_o
+*.eventlog
+*.gem
+*.hi
+*.hp
+*.log
+*.o
+*.out
+*.prof
+*.rbc
+*.so
+*.swp
+.HTF/
+.cabal-sandbox/
+.hpc
+.hsenv
+.rvmrc
+.stack-work/
+/.bundle/
+/.config
+/.yardoc/
+/InstalledFiles
+/_yardoc/
+/coverage/
+/doc/
+/ext/pandoc_rb/Makefile
+/lib/Text_Pandoc_C.so
+/lib/bundler/man/
+/pkg/
+/rdoc/
+/spec/examples.txt
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+/vendor/bundle
+cabal-dev
+cabal.project.local
+cabal.sandbox.config
+dist
+dist-*

data/.ruby-gemset

@@ -0,0 +1 @@
+pandoc_rb

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.3.1

data/.travis.yml

@@ -0,0 +1,24 @@
+language: ruby
+cache: bundler
+cache:
+  directories:
+  - $HOME/.ghc
+  - $HOME/.cabal
+  - $HOME/.stack
+sudo: required
+rvm:
+- 2.3.1
+
+before_install:
+- sudo apt-get -qq update
+- sudo apt-get install -y libgmp-dev
+- sudo apt-get install -y build-essential
+- mkdir -p ~/.local/bin
+- export PATH=$HOME/.local/bin:$PATH
+- travis_retry curl -L https://www.stackage.org/stack/linux-x86_64 | tar xz --wildcards --strip-components=1 -C ~/.local/bin '*/stack'
+- stack update
+
+install:
+- bundle install
+- bundle exec rake compile
+- bundle exec rake build

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in pandoc-rb.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,48 @@
+PATH
+  remote: .
+  specs:
+    pandoc_rb (0.2.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    benchmark-ips (2.7.2)
+    byebug (9.0.6)
+    coderay (1.1.1)
+    kalibera (0.1)
+      memoist (~> 0.11.0)
+      rbzip2 (~> 0.2.0)
+    memoist (0.11.0)
+    method_source (0.8.2)
+    minitest (5.8.3)
+    pandoc-ruby (2.0.1)
+    pry (0.10.4)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    pry-byebug (3.4.2)
+      byebug (~> 9.0)
+      pry (~> 0.10)
+    rake (10.5.0)
+    rake-compiler (1.0.4)
+      rake
+    rbzip2 (0.2.0)
+    slop (3.6.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  benchmark-ips
+  bundler (~> 1.15.1)
+  kalibera
+  minitest (~> 5.0)
+  pandoc-ruby
+  pandoc_rb!
+  pry
+  pry-byebug
+  rake (~> 10.0)
+  rake-compiler
+
+BUNDLED WITH
+   1.15.1

data/LICENSE

@@ -0,0 +1,30 @@
+Copyright Michael Klein (c) 2017
+
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+    * Redistributions of source code must retain the above copyright
+      notice, this list of conditions and the following disclaimer.
+
+    * Redistributions in binary form must reproduce the above
+      copyright notice, this list of conditions and the following
+      disclaimer in the documentation and/or other materials provided
+      with the distribution.
+
+    * Neither the name of Michael Klein nor the names of other
+      contributors may be used to endorse or promote products derived
+      from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/LICENSE.txt

@@ -0,0 +1,31 @@
+Copyright Michael Klein (c) 2017
+
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+    * Redistributions of source code must retain the above copyright
+      notice, this list of conditions and the following disclaimer.
+
+    * Redistributions in binary form must reproduce the above
+      copyright notice, this list of conditions and the following
+      disclaimer in the documentation and/or other materials provided
+      with the distribution.
+
+    * Neither the name of Michael Klein nor the names of other
+      contributors may be used to endorse or promote products derived
+      from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+

data/README.md

@@ -0,0 +1,83 @@
+[![Build Status](https://travis-ci.org/michaeljklein/pandoc-ruby.svg?branch=master)](https://travis-ci.org/michaeljklein/pandoc-ruby)
+
+
+# PandocRb
+
+Like [PandocRuby](https://github.com/alphabetum/pandoc-ruby), but its interface is more limited:
+
+```ruby
+module PandocRb
+  def self.raise_exception(result)
+  ..
+
+  def self.convert(in_format_str, out_format_str, input_str, extract_media_path='')
+  ..
+
+  def self.reader_from_ext(extension)
+  ..
+end
+```
+
+The primary benefit is that instead of using `system` calls,
+`pandoc_rb` directly uses the memory allocated for Ruby [String](https://ruby-doc.org/core-2.2.1/String.html)s
+through the FFI.
+
+The benchmark results indicate that both significant constant (from initialization) and linear (from streaming through bash pipes)
+overhead for `PandocRuby` is eliminated in `pandoc_rb`.
+
+## Installation
+
+Requires Haskell-[`stack`](https://docs.haskellstack.org/en/stable/README/)
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'pandoc_rb'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install pandoc_rb
+
+## Usage
+
+`pandoc_rb`'s main interface is contained in the `PandocRb` module.
+
+The public interface consists of constants and a main conversion function
+
+The constants include:
+```ruby
+PandocRb::Version # The current version
+PandocRb::Readers # A list of allowed readers
+PandocRb::Writers # A list of allowed writers
+```
+
+And the main conversion function is:
+```ruby
+# General conversion function
+PandocRb.convert input_format, output_format, input_string, (optional) extract_media_path
+
+# Convert `markdown` to `latex`
+PandocRb.convert 'markdown', 'latex', '_italic text_'
+
+# Convert `docx` to `latex` from file
+PandocRb.convert 'docx', 'latex', File.binread('some_doc.docx'), `extract/figures/dir`
+
+# Convert `markdown` to `docx`, writing to a `docx` file
+File.open 'some_doc.docx', 'wb' do |file|
+  file.write PandocRb.convert('markdown', 'docx', '_italic text_')
+end
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/michaeljklein/pandoc_rb/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request
+

data/Rakefile

@@ -0,0 +1,31 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+require 'rake/extensiontask'
+
+Rake::ExtensionTask.new 'pandoc_rb', $gemspec do |ext|
+  ext.lib_dir = "lib/pandoc_rb"
+end
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :build => :compile
+
+desc "Run tests"
+task :default => :test
+
+task :nuke do
+  Dir.chdir(__dir__) do
+    FileUtils.rm_rf 'tmp'
+    FileUtils.rm_rf 'ext/pandoc_rb/.stack-work'
+    FileUtils.rm_f  'ext/pandoc_rb/a.out'
+    Dir['**/*.so'].each do |so|
+      FileUtils.rm_f so
+    end
+  end
+end
+
+

data/Setup.hs

@@ -0,0 +1,2 @@
+import Distribution.Simple
+main = defaultMain

data/bench/bench.rb

@@ -0,0 +1,69 @@
+require 'pandoc_rb'
+require 'benchmark/ips'
+require 'pandoc-ruby'
+
+
+def test_files_hash(dir='test/files')
+  @test_files_hash ||= begin
+    hash = {}
+    Dir["#{dir}/*"].each do |file|
+      extension = PandocRb.reader_from_ext File.extname(file)
+      hash[extension] ||= []
+      hash[extension] << file
+    end
+    hash
+  end
+end
+
+
+Benchmark.ips do |bench|
+  10.times do
+    PandocRb.convert 'markdown', 'latex', 'warmup'
+  end
+
+  10.times do
+    PandocRuby.convert 'warmup', from: 'markdown', to: 'latex'
+  end
+
+  # Number of seconds to run each benchmark
+  bench.time       = 5 # seconds
+
+  bench.stats = :bootstrap
+  bench.confidence = 95 # percent
+
+  test_files_hash.each do |reader, file_paths|
+    if PandocRb::Readers.include? reader
+      file_paths.each do |file_path|
+        file = File.binread file_path
+        file.force_encoding "UTF-8"
+        bench.report "from: #{reader}, to: Fixnum, file: #{File.basename(file_path)}, sum bytes" do
+          file.each_byte.reduce(:+)
+        end
+        ['markdown', 'latex', 'html', 'docx'].each do |writer|
+          GC.start(full_mark: true, immediate_sweep: true)
+
+          # Convert by telling pandoc through a C extension to read the string
+          bench.report "from: #{reader}, to: #{writer}, file: #{File.basename(file_path)}, pandoc_rb" do
+            PandocRb.convert reader, writer, file
+          end
+
+          # Convert by telling pandoc through PandocRuby to read the file
+          bench.report "from: #{reader}, to: #{writer}, file: #{File.basename(file_path)}, pandoc-ruby (read file)" do
+            PandocRuby.convert [file_path], from: reader, to: writer
+          end
+
+          # PandocRuby is incapable of accepting a raw docx file as input
+          unless file_path.match(/\.docx/)
+            # Convert by telling pandoc through PandocRuby to read stdin
+            bench.report "from: #{reader}, to: #{writer}, file: #{File.basename(file_path)}, pandoc-ruby" do
+              PandocRuby.convert file     , from: reader, to: writer
+            end
+          end
+        end
+      end
+    end
+  end
+
+  bench.compare!
+end
+

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "pandoc_rb"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/ext/pandoc_rb/extconf.rb

@@ -0,0 +1,130 @@
+# Loads mkmf which is used to make makefiles for Ruby extensions
+require 'mkmf'
+require 'pry'
+require 'open3'
+
+
+module OS
+  def OS.windows?
+    (/cygwin|mswin|mingw|bccwin|wince|emx/ =~ RUBY_PLATFORM) != nil
+  end
+
+  def OS.mac?
+   (/darwin/ =~ RUBY_PLATFORM) != nil
+  end
+
+  def OS.unix?
+    !OS.windows?
+  end
+
+  def OS.linux?
+    OS.unix? and not OS.mac?
+  end
+end
+
+
+def system_indent(command)
+  puts "running #{command}"
+  exit_status = system command
+  if exit_status
+    puts "ran #{command}"
+  else
+    puts ["failed:", "<command>", command.split(' '), "</command>"].flatten
+    raise "#{command} failed"
+  end
+  exit_status
+end
+
+Dir.chdir(__dir__){ system_indent 'stack setup' }
+
+Dir.chdir(__dir__){ system_indent 'stack build' }
+
+def stack_path
+  @stack_path ||= begin
+    Dir.chdir(__dir__) do
+      temp_stack_path = `stack path`.lines.map do |line|
+        /^(?<var>[^:]+): (?<val>.*)$/ =~ line.chomp
+        [var, File.absolute_path(val)]
+      end.to_h
+      temp_stack_path['compiler-lib'] = temp_stack_path['compiler-bin'].sub(/bin$/, 'lib')
+      temp_stack_path['compiler'] = temp_stack_path['compiler-bin'].sub(/^.*\/([^\/]+)\/bin$/, '\1')
+      temp_stack_path
+    end
+  end
+end
+
+
+# Give it a name
+extension_name = 'pandoc_rb/pandoc_rb'
+
+LIBDIR      = ::CONFIG['libdir']
+INCLUDEDIR  = ::CONFIG['includedir']
+
+HEADER_DIRS = [
+  File.join(stack_path['compiler-lib'], stack_path['compiler'], "rts"),
+  File.join(stack_path['local-install-root'], "bin"),
+
+  # /home/hsolo/.stack/programs/x86_64-linux/ghc-8.0.2/lib/ghc-8.0.2/include/
+  File.join(stack_path['compiler-lib'], stack_path['compiler'], "include"),
+
+  # .stack-work/dist/x86_64-osx/Cabal-1.24.2.0/build/PandocRb.dylib/PandocRb.dylib-tmp/
+  File.join(stack_path['dist-dir'], "build/PandocRb.dylib/PandocRb.dylib-tmp"),
+
+  # Then search /usr/local for people that installed from source
+  '/usr/local/include',
+
+  # Check the ruby install locations
+  INCLUDEDIR,
+
+  # Finally fall back to /usr
+  '/usr/include',
+]
+
+LIB_DIRS = [
+  # /home/hsolo/.stack/programs/x86_64-linux/ghc-8.0.2/lib/ghc-8.0.2/rts/
+  File.join(stack_path['compiler-lib'], stack_path['compiler'], "rts"),
+  File.join(stack_path['local-install-root'], "bin"),
+  File.join(stack_path['dist-dir'], "build/PandocRb.dylib/PandocRb.dylib-tmp"), # PandocRb_stub.h
+  File.join(stack_path['compiler-lib'], stack_path['compiler'], "include"),
+
+  # First search /opt/local for macports
+  '/opt/local/lib',
+
+  # Then search /usr/local for people that installed from source
+  '/usr/local/lib',
+
+  # Check the ruby install locations
+  LIBDIR,
+
+  # Finally fall back to /usr
+  '/usr/lib',
+]
+
+dir_config extension_name, HEADER_DIRS, LIB_DIRS
+
+have_header 'stdio.h'
+have_header 'ruby.h'
+have_header 'HsFFI.h'
+have_header 'PandocRb_stub.h', 'HsFFI.h'
+find_library 'HSrts-ghc8.0.2', nil
+find_library 'PandocRb', nil
+
+$INCFLAGS  = File.join(stack_path['local-install-root'], "bin/PandocRb.dylib") + ' ' + $INCFLAGS
+$INCFLAGS += " -I#{File.join(stack_path['compiler-lib'], stack_path['compiler'], "include")}" # HsFFI.h
+$INCFLAGS += " -I#{File.join(stack_path['dist-dir'], "build/PandocRb.dylib/PandocRb.dylib-tmp")}" # PandocRb_stub.h
+$INCFLAGS += " -L#{File.join(stack_path['compiler-lib'], stack_path['compiler'], "rts")}"
+$INCFLAGS += " -lHSrts-ghc8.0.2"
+
+$LDFLAGS  = File.join(stack_path['local-install-root'], "bin/PandocRb.dylib") + ' ' + $LDFLAGS
+$LDFLAGS += " -I#{File.join(stack_path['compiler-lib'], stack_path['compiler'], "include")}" # HsFFI.h
+$LDFLAGS += " -I#{File.join(stack_path['dist-dir'], "build/PandocRb.dylib/PandocRb.dylib-tmp")}" # PandocRb_stub.h
+$LDFLAGS += " -L#{File.join(stack_path['compiler-lib'], stack_path['compiler'], "rts")}"
+$LDFLAGS += " -Wl,-rpath,'#{File.join(stack_path['compiler-lib'], stack_path['compiler'], "rts")}'"
+$LDFLAGS += " -Wl,-R'#{File.join(stack_path['local-install-root'], "bin")}'" unless OS.mac?
+$LDFLAGS += " -Wl,-rpath,'#{File.join(stack_path['local-install-root'], "bin")}'"
+$LDFLAGS += " -lHSrts-ghc8.0.2"
+
+create_makefile extension_name
+
+system_indent 'make'
+