rakali 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f100f7c3e9f272f29ae6d04f4d6bfd6c08503e01
-  data.tar.gz: 6b910f09126fc3fb6208c304d77f230b6ce6e7fd
+  metadata.gz: fbcaba4904aa189e1f6d70fb4b4c1f988c1d79bc
+  data.tar.gz: 2d606db038c01b720c0842efaa821f90ca0893a5
 SHA512:
-  metadata.gz: 7e29cc1e99f2bd1e4980369da3f7c4766fec28df424092a4639ab767a82df89274de9f371cb7f6908167a97ef255f75e4739094b1ebc7eb5b6bb04d3f2a879e7
-  data.tar.gz: f0072b709f8462dbc88e4e430f10484b26a552d23c9204516a56e96e8aaf1ed91e226002988f11b6e2909a2941b29b1712a1883f109e62bb8592fbf3b22b0a51
+  metadata.gz: a81348d6aedbc7680d92e752d2eb594265d401def51cb9d810f17f8fa2b7f52ccb0d1e2e3531123ea7e4a161831aaf1343a5f120263b7c5912b20c5fc4936277
+  data.tar.gz: 75cff22509e12081aab80da77f6a72b77ffe4bb10e017795a6a960fb0de473584093fa925f8dce997067f096911b74a04a3fef6b3d14351c7cf71531afd91ccb

data/.gitignore

@@ -1,8 +1,6 @@
 pkg/*
 *.gem
 .bundle
-*.html
-*.epub
-*.jats
 spec/fixtures/*.html
 spec/fixtures/*.docx
+spec/fixtures/*.epub

data/.rakali.yml

@@ -1,6 +1,11 @@
 from:
   folder: examples
-  format: md
+  format: docx
 to:
-  format: epub
-merge: true
+  format: html
+merge: false
+options:
+  latex-engine: xelatex
+variables:
+  mainfont: 'Minion Pro'
+  sansfont: 'Myriad Pro'

data/.travis.yml

@@ -1,17 +1,14 @@
 language: haskell
-
 rvm:
-  - 1.9.3
-  - 2.1.2
-
+- 1.9.3
+- 2.1.2
 install:
-  - travis_retry cabal install pandoc pandoc-citeproc
-  - travis_retry bundle install
-
+- travis_retry cabal install pandoc pandoc-citeproc
+- travis_retry bundle install
 script:
-  - bundle exec rake
-  - bundle exec rakali convert .rakali.yml
-
+- bundle exec rake
+- bundle exec rakali convert .rakali.yml
+- bundle exec rake repo:push
 deploy:
   provider: rubygems
   api_key:
@@ -20,3 +17,8 @@ deploy:
   on:
     tags: true
     repo: rakali/rakali.rb
+env:
+  global:
+  - secure: hO+7d+PxnOAk0tLbJOSisF6aKzGjll6E3TsaMuZHoBAA93WCvpZgYmn5VyJy1eRCobxqeP/7xIfiCHBMzHNtr7BC4wHMWx+z6tE/M3osTwQVVsg8Cdviq4LU/XvgXjk4dI8Owsk2aEC/Dw2uRm3XBmvnpMwrj3QoNjunCUeXwo4=
+  - secure: JCEDpRmeSeR3nqJg3659mXafpjyvHG5jdg5Uk54zdb/jQfDoHX7qHO5bPG0IJTAKx+vnVWpcs6JMC6ADocymaMxv195Acu9Ch3IEjcYBwdZFoqbBC7d5ZgmhloAVrWBAWgT9zoOj7ppiO3U2iUuj/vHOL57Nnf/DCkW4oxB6ykU=
+  - secure: MLmk4mLBqOK8rDbYaT+IZnP0IoxLueCWTGwoNpyx2HdcUIny2235iCmJGE66FY0/ULFsQ3WmFuB5OWgRGkj1bvYAOFiucWotZzDnsUrWyGcH+ZL4xBaZuP9qEFedtB7r1Dv9nrBn6CuhLi1l+BJwk01PpPVq0UPWXxTQ8f9wbhI=

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rakali (0.1.0)
+    rakali (0.1.2)
       colorator (~> 0.1)
       json-schema (~> 2.2)
       safe_yaml (~> 1.0)
@@ -17,6 +17,8 @@ GEM
     builder (3.2.2)
     childprocess (0.5.3)
       ffi (~> 1.0, >= 1.0.11)
+    codeclimate-test-reporter (0.3.0)
+      simplecov (>= 0.7.1, < 1.0.0)
     colorator (0.1)
     cucumber (1.3.16)
       builder (>= 2.1.2)
@@ -41,6 +43,10 @@ GEM
       diff-lcs (>= 1.1.3, < 2.0)
     rspec-mocks (2.99.2)
     safe_yaml (1.0.3)
+    simplecov (0.7.1)
+      multi_json (~> 1.0)
+      simplecov-html (~> 0.7.1)
+    simplecov-html (0.7.1)
     thor (0.19.1)
 
 PLATFORMS
@@ -48,6 +54,7 @@ PLATFORMS
 
 DEPENDENCIES
   aruba (~> 0)
+  codeclimate-test-reporter (~> 0)
   cucumber (~> 1.3)
   rakali!
   rake (~> 0)

data/README.md

@@ -4,6 +4,7 @@ rakali.rb
 [![Build Status](https://travis-ci.org/rakali/rakali.rb.svg)](https://travis-ci.org/rakali/rakali.rb)
 [![Gem Version](https://badge.fury.io/rb/rakali.svg)](http://badge.fury.io/rb/rakali)
 [![Code Climate](https://codeclimate.com/github/rakali/rakali.rb.png)](https://codeclimate.com/github/rakali/rakali.rb)
+[![Test Coverage](https://codeclimate.com/github/rakali/rakali.rb/badges/coverage.svg)](https://codeclimate.com/github/rakali/rakali.rb)
 
 Rakali is a wrapper for the [Pandoc](http://johnmacfarlane.net/pandoc/) document converter with the following features:
 
@@ -40,21 +41,16 @@ strict: false
 merge: false
 ```
 
-The only required key for the input yaml file is `from` `folder`, and you can override any key in the default file.
+The only required key for the input yaml file is `from` `folder` (missing in the default file), and you can override any key in the default file.
 
 * **schema**: JSON schema used for validation. Use `your_folder/schema.json` for a custom schema, or use one of the built-in schemata (see [pandoc-schemata](https://github.com/rakali/pandoc-schemata) for a list.)
 * **citations**: include `-f citeproc-pandoc` for citation formatting
 * **strict**: abort conversion on validation errors
 * **merge**: merge all input files into a single file
 
-To integrate rakali into a continuous integration environment such as [Travis CI](https://travis-ci.org), add a configuration file (e.g. `.rakali.yml`) into the root folder of your repo and include the following line in your `.travis.yml` file:
+Validation against **JSON Schema** also works directly with Pandoc, generate a JSON representation of the internal Pandoc document format (abstract syntax tree or AST) with `pandoc -o file.json`, and use a JSON Schema file for validation. If possible, please contribute your schema files to the [pandoc-schemata](https://github.com/rakali/pandoc-schemata).
 
-```
-language: haskell
-script:
-  - gem install rakali
-  - rakali convert .rakali.yml
-```
+To integrate rakali into a continuous integration environment such as [Travis CI](https://travis-ci.org), add a configuration file (e.g. `.rakali.yml`) into the root folder of your repo, install Pandoc and the rakali gem and run `rakali convert .rakali.yml`. Look at `.travis.yml`, `.rakali.yml` and the `examples` folder in this repo for a working example.
 
 ## Feedback
 

data/Rakefile

@@ -6,5 +6,24 @@ require 'rspec/core/rake_task'
 Bundler::GemHelper.install_tasks
 RSpec::Core::RakeTask.new('spec')
 
+namespace :repo do
+  desc "push files generated with rakali to remote"
+  task :push do
+
+    # Configure git if this is run in Travis CI
+    if ENV["TRAVIS"]
+      sh "git config --global user.name '#{ENV['GIT_NAME']}'"
+      sh "git config --global user.email '#{ENV['GIT_EMAIL']}'"
+      sh "git config --global push.default simple"
+    end
+
+    # Commit and push to github
+    sh "git add --all ."
+    sh "git commit -m 'Committing converted files.'"
+    sh "git push https://${GH_TOKEN}@github.com/rakali/rakali.rb master --quiet"
+    puts "Pushed converted files to repo"
+  end
+end
+
 # default task is running rspec tests
 task :default => :spec

data/lib/rakali/converter.rb

@@ -10,7 +10,8 @@ module Rakali
       'schema'        => 'default.json',
       'citations'     => false,
       'strict'        => false,
-      'merge'         => false
+      'merge'         => false,
+      'options'       => {}
     }
 
     attr_accessor :config, :documents, :errors

data/lib/rakali/document.rb

@@ -3,7 +3,7 @@
 module Rakali
   class Document
 
-    attr_accessor :config, :source, :destination, :content, :schema, :errors, :to_folder
+    attr_accessor :config, :source, :destination, :content, :schema, :errors, :options, :variables, :to_folder
 
     def initialize(document, config)
       begin
@@ -26,11 +26,19 @@ module Rakali
           @destination = @source.sub(/\.#{@from_format}$/, ".#{@to_format}")
         end
 
+        # add pandoc options from config
+        options = @config.fetch('options') || {}
+        @options = options.map { |k,v| "--#{k}=#{v}" }.join(" ")
+
+        # add pandoc variables from config
+        variables = @config.fetch('variables', nil) || {}
+        @variables = variables.map { |k,v| "--variable #{k}='#{v}'" }.join(" ")
+
         # use citeproc-pandoc if citations flag is set
-        bibliography = @config.fetch('citations') ? "-f citeproc-pandoc" : ""
+        bibliography = @config.fetch('citations') ? "-f citeproc-pandoc " : ""
 
         # convert source document into JSON version of native AST
-        @content = convert(nil, @from_folder, "#{@source} #{bibliography}-t json")
+        @content = convert(nil, @from_folder, "#{@source} #{bibliography}-t json #{@options} #{@variables}")
 
         # read in JSON schema, use included schemata folder if no folder is given
         @schema = scheme
@@ -39,7 +47,7 @@ module Rakali
         @errors = validate
 
         # convert to destination document from JSON version of native AST
-        @output = convert(@content, @to_folder, "-f json #{bibliography}-o #{@destination}")
+        @output = convert(@content, @to_folder, "-f json #{bibliography}-o #{@destination} #{@options} #{@variables}")
         Rakali.logger.abort_with "Fatal:", "Writing file #{@destination} failed" unless created?
 
         if @errors.empty?
@@ -67,7 +75,10 @@ module Rakali
       end
 
       # abort with log message if non-zero exit_status
-      Rakali.logger.abort_with "Fatal:", "#{captured_stderr}." unless exit_status.success?
+      unless exit_status.success?
+        Rakali.logger.error "Pandoc Args:", "#{args}."
+        Rakali.logger.abort_with "Fatal:", "#{captured_stderr}."
+      end
 
       # otherwise return stdout
       captured_stdout

data/lib/rakali/version.rb

@@ -1,3 +1,3 @@
 module Rakali
-  VERSION = "0.1.0"
+  VERSION = "0.1.2"
 end

data/rakali.gemspec

@@ -22,6 +22,7 @@ Gem::Specification.new do |s|
   s.add_development_dependency "rspec", '~> 2.6'
   s.add_development_dependency "cucumber", '~> 1.3'
   s.add_development_dependency "aruba", '~> 0'
+  s.add_development_dependency "codeclimate-test-reporter", '~> 0'
 
   s.files       = `git ls-files`.split($/)
   s.executables = ["rakali"]

data/spec/spec_helper.rb

@@ -1,3 +1,6 @@
+require "codeclimate-test-reporter"
+CodeClimate::TestReporter.start
+
 require 'bundler/setup'
 Bundler.setup
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rakali
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors:
 - Martin Fenner
@@ -122,6 +122,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
 description: A Pandoc command-line wrapper written in Ruby.
 email: mf@martinfenner.org
 executables:
@@ -143,7 +157,9 @@ files:
 - examples/2014-07-24-dont-reinvent-the-wheel.md
 - examples/2014-08-06-what-is-doi.md
 - examples/fenner_2011.docx
+- examples/fenner_2011.epub
 - examples/fenner_2013.docx
+- examples/fenner_2013.epub
 - filters/caps.rb
 - filters/default.rb
 - lib/rakali.rb