rodolfo 1.0.1.pre.pre → 2.0.0.pre.pre

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 68773cd4b01068d325a4be05c192b943fdbf6c5a
-  data.tar.gz: 7927974f44f4e4cd7065efa3e3984f9163310a7d
+  metadata.gz: d2b0721e70e5346041cdfbf0c46ee84b67220cc5
+  data.tar.gz: 7a1f3b769ef3aed6dd24bffa95f18d03d86becb6
 SHA512:
-  metadata.gz: 1054b5eebdb65342242d126f24e73493bb0818b407e2aa98cdb465a2fba07d9b288263cb4e5d0d978152ac89472d5ced1501454b45eb01e293a252a68cfe92e5
-  data.tar.gz: acd180749aba6c8d747d422aa690c9fbbbffbe6ecb6fb17c30bb875cdbdc7c16b3f5175cc54cced180be982a65c3199f094d15fde97adb87fcb6fcba9a97632c
+  metadata.gz: acf315467d8d0de4ba117b64f05d6cec9f03169dbee28dd3b8f84cd6907cbe6abc5850750eb69c6bc517af8268378e71634467e964de1099eae2daf6a2db195f
+  data.tar.gz: 22f66c10d3c83ab6ce896bbedac939717c36a031e9522d46ddbcf3f1e7b047f6f5ea18f43534176c3477c7b18cc85805d12f2f21683e0ca8c8653c978f98e9c8

data/bin/rodolfo

@@ -1,44 +1,6 @@
 #!/usr/bin/env ruby
 
 root_path = File.dirname __dir__
-
-require 'json'
-require 'slop'
-require File.join(root_path, 'lib', 'rodolfo')
-
-opts = Slop.parse do |o|
-  o.string '-p', '--package', 'package name'
-  o.on '--schema', 'get the package json schema'
-  o.on '--skip-validation', 'skip json schema validation'
-  o.on '--version', 'print the version' do
-    require File.join(root_path, 'lib', 'meta')
-    STDOUT.write Rodolfo::VERSION
-    exit 0
-  end
-end
-
-unless opts.package?
-  puts opts
-  exit 1
-end
-
-if opts.schema?
-  STDOUT.write Rodolfo::Package.new(opts[:package], {}).schema
-  exit 0
-end
-
-data = $stdin.tty? ? {} : JSON.parse($stdin.read, symbolize_names: true)
-package = Rodolfo::Package.new opts[:package], data
-
-unless opts.skip_validation? || package.valid?
-  STDOUT.write JSON.dump(package.validation_errors)
-  exit 2
-end
-
-begin
-  STDOUT.write package.make
-  exit 0
-rescue NoMethodError
-  STDOUT.write 'Missing or incorrect data, template can\'t be rendered'
-  exit 2
-end
+rodolfo_path = File.join(root_path, 'lib', 'rodolfo')
+require File.join(rodolfo_path, 'cli')
+Rodolfo::CLI.start(ARGV)

data/lib/rodolfo/cli.rb

@@ -0,0 +1,41 @@
+require 'thor'
+require_relative 'exceptions'
+require_relative 'meta'
+require_relative 'renderer'
+
+module Rodolfo
+  # Rodolfo CLI
+  class CLI < Thor
+    def self.exit_on_failure?
+      true
+    end
+
+    map %w(--version -v) => :__print_version
+
+    desc '--version, -v', 'print the version'
+    def __print_version
+      puts VERSION
+    end
+
+    desc 'schema PACKAGE PATH', 'print the package json schema'
+    def schema(package_path)
+      puts Rodolfo::Renderer.new(package_path, {}).json_schema
+    end
+
+    desc 'render PACKAGE PATH', 'render a rodolfo package path'
+    def render(package_path)
+      data = $stdin.tty? ? {} : JSON.parse($stdin.read, symbolize_names: true)
+      package = Rodolfo::Renderer.new package_path, data
+      STDOUT.write package.render
+      exit 0
+    rescue RenderError, SchemaValidationError => error
+      STDOUT.write error.errors
+      exit 2
+    end
+
+    def help(*args, &block)
+      puts "Rodolfo v#{Rodolfo::VERSION}"
+      super(*args, &block)
+    end
+  end
+end

data/lib/rodolfo/exceptions.rb

@@ -0,0 +1,19 @@
+module Rodolfo
+  # Package rendering failed
+  class RenderError < RuntimeError
+    attr_reader :errors
+
+    def initialize(errors)
+      @errors = errors
+    end
+  end
+
+  # Schema validation failed
+  class SchemaValidationError < RuntimeError
+    attr_reader :errors
+
+    def initialize(errors)
+      @errors = errors
+    end
+  end
+end

data/lib/rodolfo/json_schema.rb

@@ -0,0 +1,30 @@
+require 'json'
+require 'json-schema'
+require_relative 'exceptions'
+
+# Create PDFs from the CLI using Prawn
+module Rodolfo
+  # Rodolfo Package JSON Schema
+  class JSONSchema
+    def initialize(path)
+      @path = path
+    end
+
+    # Validate the json schema
+    # May raise a SchemaValidationError
+    def validate(data)
+      opts = { errors_as_objects: true, insert_defaults: true,
+               strict: true }
+      errors = JSON::Validator.fully_validate json, data, opts
+      raise SchemaValidationError, errors unless errors.empty?
+    end
+
+    def json
+      @json ||= File.read @path
+    end
+
+    def to_s
+      json
+    end
+  end
+end

data/lib/{meta.rb → rodolfo/meta.rb}

@@ -1,5 +1,4 @@
-##
 # Create PDFs from the CLI using Prawn
 module Rodolfo
-  VERSION = '1.0.1-pre'.freeze
+  VERSION = '2.0.0-pre'.freeze
 end

data/lib/rodolfo/renderer.rb

@@ -0,0 +1,46 @@
+require 'pathname'
+require 'prawn'
+require 'prawn/measurements'
+require 'prawn/measurement_extensions'
+require 'prawn/table'
+
+require_relative 'json_schema'
+require_relative 'exceptions.rb'
+
+# Create PDFs from the CLI using Prawn
+module Rodolfo
+  ##
+  # Requires a filesystem folder path which should contain
+  # - schema.json to perform the validation
+  # - data.json as example data (for testing purposes only and valid example)
+  # - template.rb the pdf generator itself
+  #
+  # It renders the the given template validating
+  # the data against that json schema
+  class Renderer
+    attr_reader :data, :validation_errors
+
+    def initialize(path, data)
+      @path = Pathname.new(path).absolute? ? path : File.join(Dir.pwd, path)
+      @data = data
+      @schema = JSONSchema.new File.join(@path, 'schema.json')
+    end
+
+    # Get the package json schema
+    def json_schema
+      @schema.to_s
+    end
+
+    # Render the template
+    # May raises a ValidationError
+    def render
+      @schema.validate(@data)
+      require File.join @path, 'template'
+      Rodolfo::Template.new(@data).render
+
+    rescue NoMethodError
+      msg = 'Missing or incorrect data, template can\'t be rendered'
+      raise RenderError, [msg]
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rodolfo
 version: !ruby/object:Gem::Version
-  version: 1.0.1.pre.pre
+  version: 2.0.0.pre.pre
 platform: ruby
 authors:
 - Initios
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-11-10 00:00:00.000000000 Z
+date: 2016-11-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json-schema
@@ -59,25 +59,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 0.2.2
 - !ruby/object:Gem::Dependency
-  name: slop
+  name: thor
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.4.1
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 4.4.1
+        version: 0.19.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.4.1
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 4.4.1
+        version: 0.19.1
 - !ruby/object:Gem::Dependency
   name: aruba
   requirement: !ruby/object:Gem::Requirement
@@ -246,8 +240,11 @@ extensions: []
 extra_rdoc_files: []
 files:
 - bin/rodolfo
-- lib/meta.rb
-- lib/rodolfo.rb
+- lib/rodolfo/cli.rb
+- lib/rodolfo/exceptions.rb
+- lib/rodolfo/json_schema.rb
+- lib/rodolfo/meta.rb
+- lib/rodolfo/renderer.rb
 homepage: https://github.com/initios/rodolfo
 licenses:
 - MIT

data/lib/rodolfo.rb

@@ -1,44 +0,0 @@
-require 'json'
-require 'json-schema'
-require 'pathname'
-require 'prawn'
-require 'prawn/measurements'
-require 'prawn/measurement_extensions'
-require 'prawn/table'
-
-##
-# Create PDFs from the CLI using Prawn
-module Rodolfo
-  ##
-  # Represents a filesystem folder which should contain
-  # - schema.json to perform the validation
-  # - data.json as example data
-  # - template.rb the pdf generator itself
-  #
-  # It handles methods for manipulate those files and the pdf generation
-  class Package
-    attr_reader :data, :validation_errors
-
-    def initialize(path, data)
-      @path = Pathname.new(path).absolute? ? path : File.join(Dir.pwd, path)
-      opts = { errors_as_objects: true, insert_defaults: true }
-      @validation_errors = JSON::Validator.fully_validate(schema, data, opts)
-      @data = data
-    end
-
-    def schema
-      json_file_path = File.join @path, 'schema.json'
-      File.read json_file_path
-    end
-
-    def valid?
-      @validation_errors.empty?
-    end
-
-    def make
-      template_file_path = File.join @path, 'template'
-      require template_file_path
-      Rodolfo::Template.new(@data).render
-    end
-  end
-end