proforma-prawn-renderer 1.0.0.pre.alpha

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ac74c9e31440fb51da3a35d2a83f66d4d2003bade1012dffb0607fe30317de96
+  data.tar.gz: ca3305a73f6bd5f1f3de011b6606e8e43ef5820aac35e380282f99bf86bde3ef
+SHA512:
+  metadata.gz: c570b4a567c7160b32044d7d5204ed5d967528ea776f1975cf8de54f1af5e6a94763ae6a0820010ac8855527b66eac23b7e0f8e7a1aa78aec2727e2883469d3d
+  data.tar.gz: 3473499c3ecf5cfb7a0dd704c666aa208e107d954d78837d366936caaa4b31b8cd0086fae33151e9a99dc165cd27c6a740a238182600352b37c67790743d6bba

data/.editorconfig

@@ -0,0 +1,8 @@
+# See http://editorconfig.org/
+
+[*]
+trim_trailing_whitespace = true
+indent_style = space
+indent_size = 2
+insert_final_newline = true
+end_of_line = lf

data/.gitignore

@@ -0,0 +1,4 @@
+.DS_Store
+*.gem
+/tmp
+/coverage

data/.rubocop.yml

@@ -0,0 +1,11 @@
+Metrics/LineLength:
+  Max: 100
+
+Metrics/BlockLength:
+  ExcludedMethods: ['let', 'it', 'describe', 'context', 'specify']
+
+Metrics/MethodLength:
+  Max: 25
+
+AllCops:
+  TargetRubyVersion: 2.3

data/.ruby-version

@@ -0,0 +1 @@
+2.6.0

data/.travis.yml

@@ -0,0 +1,20 @@
+env:
+  global:
+    - CC_TEST_REPORTER_ID=f4247e1b007aa38ed314c32b6e25be8617336be2a34b0fe906b57119d26434c3
+language: ruby
+rvm:
+  # Build on the latest stable of all supported Rubies (https://www.ruby-lang.org/en/downloads/):
+  - 2.3.8
+  - 2.4.5
+  - 2.5.3
+  - 2.6.0
+cache: bundler
+before_script:
+  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+  - chmod +x ./cc-test-reporter
+  - ./cc-test-reporter before-build
+script:
+  - bundle exec rubocop
+  - bundle exec rspec spec --format documentation
+after_script:
+  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+# 0.0.1 (April 17th, 2019)
+
+Library Shell.

data/Gemfile

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,129 @@
+PATH
+  remote: .
+  specs:
+    proforma-prawn-renderer (1.0.0.pre.alpha)
+      prawn (~> 2)
+      prawn-table (~> 0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    Ascii85 (1.0.3)
+    acts_as_hashable (1.0.5)
+    afm (0.2.2)
+    ansi (1.5.0)
+    ast (2.4.0)
+    coderay (1.1.2)
+    diff-lcs (1.3)
+    docile (1.3.1)
+    ffi (1.9.25)
+    formatador (0.2.5)
+    guard (2.15.0)
+      formatador (>= 0.2.4)
+      listen (>= 2.7, < 4.0)
+      lumberjack (>= 1.0.12, < 2.0)
+      nenv (~> 0.1)
+      notiffany (~> 0.0)
+      pry (>= 0.9.12)
+      shellany (~> 0.0)
+      thor (>= 0.18.1)
+    guard-compat (1.2.1)
+    guard-rspec (4.7.3)
+      guard (~> 2.1)
+      guard-compat (~> 1.1)
+      rspec (>= 2.99.0, < 4.0)
+    hashery (2.1.2)
+    hirb (0.7.3)
+    jaro_winkler (1.5.2)
+    json (2.1.0)
+    listen (3.1.5)
+      rb-fsevent (~> 0.9, >= 0.9.4)
+      rb-inotify (~> 0.9, >= 0.9.7)
+      ruby_dep (~> 1.2)
+    lumberjack (1.0.13)
+    method_source (0.9.2)
+    nenv (0.3.0)
+    notiffany (0.1.1)
+      nenv (~> 0.1)
+      shellany (~> 0.0)
+    parallel (1.13.0)
+    parser (2.6.0.0)
+      ast (~> 2.4.0)
+    pdf-core (0.7.0)
+    pdf-inspector (1.3.0)
+      pdf-reader (>= 1.0, < 3.0.a)
+    pdf-reader (2.2.0)
+      Ascii85 (~> 1.0.0)
+      afm (~> 0.2.1)
+      hashery (~> 2.0)
+      ruby-rc4
+      ttfunk
+    powerpack (0.1.2)
+    prawn (2.2.2)
+      pdf-core (~> 0.7.0)
+      ttfunk (~> 1.5)
+    prawn-table (0.2.2)
+      prawn (>= 1.3.0, < 3.0.0)
+    proforma (1.0.0.pre.alpha)
+      acts_as_hashable (~> 1)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rainbow (3.0.0)
+    rb-fsevent (0.10.3)
+    rb-inotify (0.9.10)
+      ffi (>= 0.5.0, < 2)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    rubocop (0.63.1)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.5, != 2.5.1.1)
+      powerpack (~> 0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.4.0)
+    ruby-progressbar (1.10.0)
+    ruby-rc4 (0.1.5)
+    ruby_dep (1.5.0)
+    shellany (0.0.1)
+    simplecov (0.16.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-console (0.4.2)
+      ansi
+      hirb
+      simplecov
+    simplecov-html (0.10.2)
+    thor (0.20.3)
+    ttfunk (1.5.1)
+    unicode-display_width (1.4.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  guard-rspec (~> 4.7)
+  pdf-inspector (~> 1)
+  proforma (>= 1.0.0.pre.alpha)
+  proforma-prawn-renderer!
+  pry (~> 0)
+  rspec (~> 3.8)
+  rubocop (~> 0.63.1)
+  simplecov (~> 0.16.1)
+  simplecov-console (~> 0.4.2)
+
+BUNDLED WITH
+   1.17.3

data/Guardfile

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+guard :rspec, cmd: 'bundle exec rspec' do
+  require 'guard/rspec/dsl'
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+end

data/LICENSE

@@ -0,0 +1,7 @@
+Copyright 2019 Blue Marble Payroll, LLC
+
+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.md

@@ -0,0 +1,137 @@
+# Proforma Prawn Renderer
+
+[![Gem Version](https://badge.fury.io/rb/proforma-prawn-renderer.svg)](https://badge.fury.io/rb/proforma-prawn-renderer) [![Build Status](https://travis-ci.org/bluemarblepayroll/proforma-prawn-renderer.svg?branch=master)](https://travis-ci.org/bluemarblepayroll/proforma-prawn-renderer) [![Maintainability](https://api.codeclimate.com/v1/badges/c7807c3864ca2c32e244/maintainability)](https://codeclimate.com/github/bluemarblepayroll/proforma-prawn-renderer/maintainability) [![Test Coverage](https://api.codeclimate.com/v1/badges/c7807c3864ca2c32e244/test_coverage)](https://codeclimate.com/github/bluemarblepayroll/proforma-prawn-renderer/test_coverage) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+[Proforma](https://github.com/bluemarblepayroll/proforma) ships with a basic plain-text renderer.  Luckily we can plug in different rendering engines to provide additional business value.  This library gives Proforma the ability to render PDF's instead of simple plain-text.
+
+## Installation
+
+To install through Rubygems:
+
+````
+gem install install proforma-prawn-renderer
+````
+
+You can also add this to your Gemfile:
+
+````
+bundle add proforma-prawn-renderer
+````
+
+## Examples
+
+### Connecting to Proforma Rendering Pipeline
+
+To use this plugin within Proforma:
+
+1. Install [Proforma](https://github.com/bluemarblepayroll/proforma)
+2. Install this library
+3. Require both libraries
+4. Pass in an instance of Proforma::PrawnRenderer into the Proforma#render method
+
+````ruby
+require 'proforma'
+require 'proforma/prawn_renderer'
+
+data = [
+  { id: 1, name: 'Chicago Bulls' },
+  { id: 2, name: 'Indiana Pacers' },
+  { id: 3, name: 'Boston Celtics' }
+]
+
+template = {
+  title: 'nba_team_list',
+  children: [
+    { type: 'Header', value: 'NBA Teams' },
+    { type: 'Separator' },
+    {
+      type: 'DataTable',
+      columns: [
+        { header: 'Team ID #', body: '$:id' },
+        { header: 'Team Name', body: '$:name' },
+      ]
+    }
+  ]
+}
+
+documents = Proforma.render(data, template, renderer: Proforma::PrawnRenderer.new)
+````
+
+The `documents` attribute will now be an array with one object:
+
+```ruby
+expected_documents = [
+  {
+    contents: "...", # PDF Data
+    extension: '.pdf',
+    title: 'nba_team_list'
+  }
+]
+```
+
+The `contents` attribute will contain the native PDF data.
+
+### Prawn Customization
+
+All options for Prawn are passed through the Proforma::PrawnRenderer::Options object:
+
+Name             | Default
+---------------- | -------
+bold_font_style  | :bold
+header_font_size | 15
+text_font_size   | 10
+font_name        | null
+
+These options will be used during the PDF rendering process.
+
+## Contributing
+
+### Development Environment Configuration
+
+Basic steps to take to get this repository compiling:
+
+1. Install [Ruby](https://www.ruby-lang.org/en/documentation/installation/) (check proforma-prawn-renderer.gemspec for versions supported)
+2. Install bundler (gem install bundler)
+3. Clone the repository (git clone git@github.com:bluemarblepayroll/proforma-prawn-renderer.git)
+4. Navigate to the root folder (cd proforma)
+5. Install dependencies (bundle)
+
+### Running Tests
+
+To execute the test suite run:
+
+````
+bundle exec rspec spec --format documentation
+````
+
+Alternatively, you can have Guard watch for changes:
+
+````
+bundle exec guard
+````
+
+Also, do not forget to run Rubocop:
+
+````
+bundle exec rubocop
+````
+
+### Publishing
+
+Note: ensure you have proper authorization before trying to publish new versions.
+
+After code changes have successfully gone through the Pull Request review process then the following steps should be followed for publishing new versions:
+
+1. Merge Pull Request into master
+2. Update `lib/proforma/prawn_renderer/version.rb` using [semantic versioning](https://semver.org/)
+3. Install dependencies: `bundle`
+4. Update `CHANGELOG.md` with release notes
+5. Commit & push master to remote and ensure CI builds master successfully
+6. Build the project locally: `gem build proforma-prawn-renderer`
+7. Publish package to RubyGems: `gem push proforma-prawn-renderer-X.gem` where X is the version to push
+8. Tag master with new version: `git tag <version>`
+9. Push tags remotely: `git push origin --tags`
+
+## License
+
+This project is MIT Licensed.

data/bin/console

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'proforma/prawn_renderer'
+
+# 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.
+
+require 'pry'
+Pry.start

data/bin/render

@@ -0,0 +1,86 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'proforma/prawn_renderer'
+require 'fileutils'
+require 'yaml'
+require 'pry'
+require 'pdf/inspector'
+
+def read_yaml(filename)
+  # rubocop:disable Security/YAMLLoad
+  YAML.load(read(filename))
+  # rubocop:enable Security/YAMLLoad
+end
+
+def read(filename)
+  File.open(filename, 'r:bom|utf-8').read
+end
+
+def data_merge(data, hash)
+  if data.is_a?(Array)
+    data.map do |record|
+      record.merge(hash)
+    end
+  elsif data.is_a?(Hash)
+    data.merge(hash)
+  end
+end
+
+jobs_dir = File.join('tmp', 'jobs')
+output_dir = File.join('tmp', 'jobs_output')
+
+jobs = Dir[File.join(jobs_dir, '*.yml')]
+
+if jobs.empty?
+  puts "No jobs detected in the path: #{jobs_dir}"
+  puts '--------------------------------------------------------------'
+  puts "To use, place YAML files into #{jobs_dir} directory."
+  puts 'You can find example YAML files in: spec/fixtures/snapshots'
+  puts '--------------------------------------------------------------'
+
+  exit
+end
+
+images_dir = File.join('tmp', 'images', '*')
+
+images_hash = Dir[images_dir].map do |image_filename|
+  key = File.basename(image_filename, File.extname(image_filename))
+  [key, File.open(image_filename, 'rb')]
+end.to_h
+
+jobs.each do |job|
+  job_name = File.basename(job, File.extname(job))
+
+  puts "Rendering: #{job_name} (#{job})"
+
+  contents        = read_yaml(job)
+  data            = data_merge(contents['data'], images_hash)
+  template        = contents['template']
+  evaluator       = contents['evaluator'] || Proforma::HashEvaluator.new
+  renderer        = contents['renderer'] || Proforma::PrawnRenderer.new
+  job_output_dir  = File.join(output_dir, job_name)
+
+  FileUtils.mkdir_p(job_output_dir)
+
+  outputs = Proforma.render(
+    data,
+    template,
+    evaluator: evaluator,
+    renderer: renderer
+  )
+
+  outputs.each_with_index do |output, index|
+    name_without_extension = [
+      index.to_s,
+      output.title.to_s
+    ].reject(&:empty?).join('.')
+
+    filename = "#{name_without_extension}#{output.extension}"
+
+    IO.write(File.join(job_output_dir, filename), output.contents)
+  end
+
+  puts "Done Rendering: #{job} (output can be found in: #{job_output_dir})"
+end

data/lib/proforma/prawn_renderer/banner_renderer.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+#
+# Copyright (c) 2019-present, Blue Marble Payroll, LLC
+#
+# This source code is licensed under the MIT license found in the
+# LICENSE file in the root directory of this source tree.
+#
+
+module Proforma
+  class PrawnRenderer
+    # This class understands how to ender a Proforma::Modeling::Banner component.
+    class BannerRenderer < Renderer
+      def render(banner)
+        pdf.table(
+          make_rows(banner),
+          width: total_width,
+          column_widths: make_column_widths(banner)
+        )
+      end
+
+      private
+
+      def make_rows(banner)
+        row = []
+        row << make_image_cell(banner) if banner.image
+        row << make_text_cell(banner) unless text_contents(banner).empty?
+        [row]
+      end
+
+      def make_column_widths(banner)
+        column_widths = []
+
+        if banner.image && banner.image_width && !text_contents(banner).empty?
+          column_widths << banner.image_width
+        end
+
+        column_widths
+      end
+
+      def make_text_cell(banner)
+        pdf.make_cell(text_contents(banner), text_cell_style(!banner.image.nil?))
+      end
+
+      def make_image_cell(banner)
+        {
+          image: banner.image,
+          image_width: banner.image_width,
+          image_height: banner.image_height,
+          padding: 0,
+          border_width: 0
+        }
+      end
+
+      def text_contents(banner)
+        contents = []
+        contents << "<b>#{banner.title}</b>" unless banner.title.empty?
+        contents << banner.details.to_s unless banner.details.empty?
+        contents.join("\n")
+      end
+
+      def cell_style
+        @cell_style ||= {
+          border_width: 0,
+          padding: 0,
+          font: options.font_name,
+          size: options.text_font_size
+        }
+      end
+
+      def text_cell_style(pad_left)
+        padding = pad_left ? [0, 0, 0, 10] : [0, 0, 0, 0]
+
+        cell_style.merge(
+          inline_format: true,
+          padding: padding
+        )
+      end
+    end
+  end
+end

data/lib/proforma/prawn_renderer/header_renderer.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+#
+# Copyright (c) 2019-present, Blue Marble Payroll, LLC
+#
+# This source code is licensed under the MIT license found in the
+# LICENSE file in the root directory of this source tree.
+#
+
+require_relative 'renderer'
+
+module Proforma
+  class PrawnRenderer
+    # This class understands how to ender a Proforma::Modeling::Header component.
+    class HeaderRenderer < Renderer
+      def render(text)
+        pdf.text(
+          text.value.to_s,
+          font: options.font_name,
+          size: options.header_font_size,
+          style: options.bold_font_style
+        )
+      end
+    end
+  end
+end

data/lib/proforma/prawn_renderer/options.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+#
+# Copyright (c) 2019-present, Blue Marble Payroll, LLC
+#
+# This source code is licensed under the MIT license found in the
+# LICENSE file in the root directory of this source tree.
+#
+
+module Proforma
+  class PrawnRenderer
+    # A list of options available for customizing the rendering engine.
+    class Options
+      DEFAULT_BOLD_FONT_STYLE   = :bold
+      DEFAULT_FONT_NAME         = ''
+      DEFAULT_TEXT_FONT_SIZE    = 10
+      DEFAULT_HEADER_FONT_SIZE  = DEFAULT_TEXT_FONT_SIZE + 5
+
+      attr_writer :bold_font_style,
+                  :header_font_size,
+                  :text_font_size
+
+      attr_accessor :font_name
+
+      def bold_font_style
+        @bold_font_style || DEFAULT_BOLD_FONT_STYLE
+      end
+
+      def header_font_size
+        @header_font_size ? @header_font_size.to_f : DEFAULT_HEADER_FONT_SIZE
+      end
+
+      def text_font_size
+        @text_font_size ? @text_font_size.to_f : DEFAULT_TEXT_FONT_SIZE
+      end
+    end
+  end
+end