rakali 0.0.8

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5a9db33f283b3c0c005337c9f4e278198b72f5a0
+  data.tar.gz: dd9193ea8f7ffedff4bf346554ec5901a282f69a
+SHA512:
+  metadata.gz: 9a35a109180245835fecac87d95a514483ca9975b2757ed7aa32c92f904135da4eb7298680c86c1445fe465e44490741c3f81b4f5f2577b873477ed434ec6173
+  data.tar.gz: ee50a5a11353568443edafdbb5255b753b018e54520f362457790c3b7a98dfa3e845ca45a792647d016c3848382806058bde03bae6485c115d0f52f2bdd5f95c

data/bin/rakali

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require File.expand_path("../../lib/rakali", __FILE__)
+
+Rakali::CLI.start

data/lib/rakali.rb

@@ -0,0 +1,22 @@
+require "thor"
+require 'safe_yaml/load'
+require 'colorator'
+require 'json-schema'
+require 'json'
+require 'open3'
+
+require 'rakali/version'
+require 'rakali/cli'
+require 'rakali/converter'
+require 'rakali/document'
+require 'rakali/utils'
+require 'rakali/logger'
+
+SafeYAML::OPTIONS[:suppress_warnings] = false
+SafeYAML::OPTIONS[:default_mode] = :safe
+
+module Rakali
+  def self.logger
+    @logger ||= Logger.new
+  end
+end

data/lib/rakali/cli.rb

@@ -0,0 +1,23 @@
+# encoding: UTF-8
+
+module Rakali
+  class CLI < Thor
+    def self.exit_on_failure?
+      true
+    end
+
+    desc "read FILE", "read configuration FILE in yaml format"
+
+    def convert(file)
+      converter = Rakali::Converter.new(file)
+
+      # don't proceed unless input validates against schema
+      unless converter.valid?
+        message = "Error: input did not validate with schema #{converter.schema["title"]}\n" + converter.errors.join("\n")
+        raise Thor::Error, message
+      end
+    end
+
+    default_task :convert
+  end
+end

data/lib/rakali/converter.rb

@@ -0,0 +1,63 @@
+# encoding: UTF-8
+
+module Rakali
+  class Converter
+
+    # Default options.
+    DEFAULTS = {
+      'from'          => { 'format' => 'md' },
+      'to'            => { 'folder' => nil, 'format' => 'html' },
+      'schema'        => 'schemata/default.json',
+      'strict'        => false,
+      'templates'     => 'rakali/templates',
+      'csl'           => 'rakali/csl',
+      'bibliography'  => 'rakali/bibliography',
+      'filters'       => 'rakali/filters',
+      'writers'       => 'rakali/writers'
+    }
+
+    attr_accessor :config, :documents, :errors
+
+    def initialize(file, options = {})
+      begin
+        config = read_config_file(file)
+
+        # deep merge defaults to preserve nested keys
+        @config = Utils.deep_merge_hashes(DEFAULTS, config)
+
+        # print configuration
+        Rakali.logger.info "Starting:", "Reading configuration... \n#{to_yaml}"
+
+        from_folder = @config.fetch('from').fetch('folder')
+        from_format = @config.fetch('from').fetch('format')
+        documents = Dir.glob("#{from_folder}/*.#{from_format}")
+        @documents = documents.map { |document| Rakali::Document.new(document, @config) }
+      rescue KeyError => e
+        Rakali.logger.abort_with "Fatal:", "Configuration #{e.message}."
+      rescue => e
+        Rakali.logger.abort_with "Fatal:", "#{e.message}."
+      end
+    end
+
+    def read_config_file(file)
+      # use an empty hash if the file is empty
+      SafeYAML.load_file(file) || {}
+    rescue SystemCallError
+      Rakali.logger.abort_with "Fatal:", "Configuration file not found: \"#{file}\"."
+    end
+
+    def from_json(string)
+      JSON.parse(string)
+    rescue JSON::ParserError, TypeError
+      nil
+    end
+
+    def to_json
+      content.to_json
+    end
+
+    def to_yaml
+      config.to_yaml
+    end
+  end
+end

data/lib/rakali/document.rb

@@ -0,0 +1,95 @@
+# encoding: UTF-8
+
+module Rakali
+  class Document
+
+    attr_accessor :config, :source, :destination, :content, :schema, :errors, :to_folder
+
+    def initialize(document, config)
+      begin
+        @config = config
+
+        @from_folder = @config.fetch('from').fetch('folder')
+        @from_format = @config.fetch('from').fetch('format')
+        @to_folder = @config.fetch('to').fetch('folder') || @from_folder
+        @to_format = @config.fetch('to').fetch('format')
+        #config_path = File.expand_path("../config.yml", __FILE__)
+
+        # for destination filename use source name with new extension
+        @source = File.basename(document)
+        @destination = @source.sub(/\.#{@from_format}$/, ".#{@to_format}")
+
+        # convert source document into JSON version of native AST
+        @content = convert(nil, "#{@from_folder}/#{@source} -t json")
+
+        # read in JSON schema
+        @schema = IO.read(@config.fetch('schema'))
+
+        # validate JSON against schema and report errors
+        @errors = validate
+
+        # convert to destination document from JSON version of native AST
+        @output = convert(@content, "-f json -o #{@to_folder}/#{@destination}")
+        Rakali.logger.abort_with "Fatal:", "Writing file #{@destination} failed" unless created?
+
+        if @errors.empty?
+          Rakali.logger.info "Success:", "Converted file #{@source} to file #{@destination}."
+        else
+          Rakali.logger.warn "With Errors:", "Converted file #{@source} to file #{@destination}."
+        end
+      rescue KeyError => e
+        Rakali.logger.abort_with "Fatal:", "Configuration #{e.message}."
+      rescue => e
+        Rakali.logger.abort_with "Fatal:", "#{e.message}."
+      end
+    end
+
+    def convert(string = nil, args)
+      Open3::popen3("pandoc #{args}") do |stdin, stdout, stderr, wait_thr|
+        unless string.nil?
+          stdin.puts string
+          stdin.close
+        end
+
+        # abort with log message if exit_status of command not 0
+        Rakali.logger.abort_with "Fatal:", "#{stderr.read}." if wait_thr.value.exitstatus > 0
+
+        stdout.read
+      end
+    end
+
+    def validate
+      errors = JSON::Validator.fully_validate(@schema, @content)
+      return [] if errors.empty?
+
+      if @config.fetch('strict', false)
+        errors.each { |error| Rakali.logger.error "Validation Error:", "#{error} for file #{source}" }
+        Rakali.logger.abort_with "Fatal:", "Conversion of file #{source} failed."
+      else
+        errors.each { |error| Rakali.logger.warn "Validation Error:", "#{error} for file #{source}" }
+      end
+    end
+
+    def valid?
+      errors == []
+    end
+
+    def created?
+      # file exists
+      return false unless File.exist?("#{@to_folder}/#{@destination}")
+
+      # file was created in the last 5 seconds
+      Time.now - File.mtime("#{@to_folder}/#{@destination}") < 5
+    end
+
+    def from_json(string)
+      JSON.parse(string)
+    rescue JSON::ParserError, TypeError
+      nil
+    end
+
+    def to_json
+      content.to_json
+    end
+  end
+end

data/lib/rakali/logger.rb

@@ -0,0 +1,92 @@
+# This code was taken from Jekyll, available under MIT-LICENSE
+# Copyright (c) 2008-2014 Tom Preston-Werner
+
+module Rakali
+  class Logger
+    attr_accessor :log_level
+
+    DEBUG  = 0
+    INFO   = 1
+    WARN   = 2
+    ERROR  = 3
+
+    # Public: Create a new logger instance
+    #
+    # level - (optional, integer) the log level
+    #
+    # Returns nothing
+    def initialize(level = INFO)
+      @log_level = level
+    end
+
+    # Public: Print a debug message to stdout
+    #
+    # topic - the topic of the message, e.g. "Configuration file", "Deprecation", etc.
+    # message - the message detail
+    #
+    # Returns nothing
+    def debug(topic, message = nil)
+      $stdout.puts(message(topic, message)) if log_level <= DEBUG
+    end
+
+    # Public: Print a message to stdout
+    #
+    # topic - the topic of the message, e.g. "Configuration file", "Deprecation", etc.
+    # message - the message detail
+    #
+    # Returns nothing
+    def info(topic, message = nil)
+      $stdout.puts(message(topic, message)) if log_level <= INFO
+    end
+
+    # Public: Print a message to stderr
+    #
+    # topic - the topic of the message, e.g. "Configuration file", "Deprecation", etc.
+    # message - the message detail
+    #
+    # Returns nothing
+    def warn(topic, message = nil)
+      $stderr.puts(message(topic, message).yellow) if log_level <= WARN
+    end
+
+    # Public: Print a error message to stderr
+    #
+    # topic - the topic of the message, e.g. "Configuration file", "Deprecation", etc.
+    # message - the message detail
+    #
+    # Returns nothing
+    def error(topic, message = nil)
+      $stderr.puts(message(topic, message).red) if log_level <= ERROR
+    end
+
+    # Public: Print a error message to stderr and immediately abort the process
+    #
+    # topic - the topic of the message, e.g. "Configuration file", "Deprecation", etc.
+    # message - the message detail (can be omitted)
+    #
+    # Returns nothing
+    def abort_with(topic, message = nil)
+      error(topic, message)
+      abort
+    end
+
+    # Public: Build a topic method
+    #
+    # topic - the topic of the message, e.g. "Configuration file", "Deprecation", etc.
+    # message - the message detail
+    #
+    # Returns the formatted message
+    def message(topic, message)
+      formatted_topic(topic) + message.to_s.gsub(/---\n/, '')
+    end
+
+    # Public: Format the topic
+    #
+    # topic - the topic of the message, e.g. "Configuration file", "Deprecation", etc.
+    #
+    # Returns the formatted topic statement
+    def formatted_topic(topic)
+      "#{topic} ".rjust(20)
+    end
+  end
+end

data/lib/rakali/utils.rb

@@ -0,0 +1,29 @@
+# encoding: UTF-8
+
+module Rakali
+  class Utils
+    # This code was taken from Jekyll, available under MIT-LICENSE
+    # Copyright (c) 2008-2014 Tom Preston-Werner
+    # Merges a master hash with another hash, recursively.
+    #
+    # master_hash - the "parent" hash whose values will be overridden
+    # other_hash  - the other hash whose values will be persisted after the merge
+    #
+    # This code was lovingly stolen from some random gem:
+    # http://gemjack.com/gems/tartan-0.1.1/classes/Hash.html
+    def self.deep_merge_hashes(master_hash, other_hash)
+      target = master_hash.dup
+
+      other_hash.keys.each do |key|
+        if other_hash[key].is_a? Hash and target[key].is_a? Hash
+          target[key] = deep_merge_hashes(target[key], other_hash[key])
+          next
+        end
+
+        target[key] = other_hash[key]
+      end
+
+      target
+    end
+  end
+end

data/lib/rakali/version.rb

@@ -0,0 +1,3 @@
+module Rakali
+  VERSION = "0.0.8"
+end

metadata

@@ -0,0 +1,164 @@
+--- !ruby/object:Gem::Specification
+name: rakali
+version: !ruby/object:Gem::Version
+  version: 0.0.8
+platform: ruby
+authors:
+- Martin Fenner
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-08-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.19'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.19'
+- !ruby/object:Gem::Dependency
+  name: json-schema
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+- !ruby/object:Gem::Dependency
+  name: safe_yaml
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: colorator
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+- !ruby/object:Gem::Dependency
+  name: cucumber
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: aruba
+  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:
+- rakali
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/rakali
+- lib/rakali.rb
+- lib/rakali/cli.rb
+- lib/rakali/converter.rb
+- lib/rakali/document.rb
+- lib/rakali/logger.rb
+- lib/rakali/utils.rb
+- lib/rakali/version.rb
+homepage: https://github.com/rakali/rakali.rb
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.3.6
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: A Pandoc command-line wrapper
+test_files: []