proforma-prawn-renderer 1.0.3 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 023bb2b06bdf92d4065a6c52bf6e6e522e21bf20ffe1c058797a68c8c83455bc
-  data.tar.gz: 9553acd72e862cff0b2d1b186bffd646187f51b17a9cf543f2ae3add94a3d3d6
+  metadata.gz: e102e10642ac6d4cd56c0d2be9143dcf646f58a8eecd5fa27e870f38e7635539
+  data.tar.gz: 21e212f81d1a5941f5b14ac8a769e9b598b574ef614f2235b19e152e13229ca7
 SHA512:
-  metadata.gz: 204cabc54005e2f46ea269a8de1a4353ceffb952bb75af3de0051239bb78ff20f2d37bbcbdc3687b2a134f455dcb2c99fb3067ca296feda338d630eb7ad0c18a
-  data.tar.gz: e789d0114fa922808f7b373e0c2cae1044a53fb102a1a838a5e179d440fb2e7f123aa4016b536c509ad2d88e8d3529d4fb3920779aa10dde9b754d167d8f29b8
+  metadata.gz: 031420d94dc6a34f808fa04e7e05ce91f04397306378d2b6429026aee6b0c5bb548d47f5a6827419aceab97af0bedcd8e72b2a88206fca089c6e1361259d85c8
+  data.tar.gz: b6839ef41b244af0e93dd2f66a0cac51f7e3b70a3720892a357c4f464eebae85472bdee938fcc196a62633c0399d1b5e49112cf821a09474bd0b0606c745cd61

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+# 1.1.0 (July 25th, 2019)
+
+* Added support for external font loading.
+
 # 1.0.3 (July 7th, 2019)
 
 * Added better pane width balancing algorithm that fixes some width assignment bugs.

data/Gemfile.lock

@@ -1,7 +1,8 @@
 PATH
   remote: .
   specs:
-    proforma-prawn-renderer (1.0.3)
+    proforma-prawn-renderer (1.1.0)
+      acts_as_hashable (~> 1)
       prawn (~> 2)
       prawn-table (~> 0)
       proforma (~> 1)

data/README.md

@@ -79,16 +79,45 @@ The `contents` attribute will contain the native PDF data.
 
 ### Prawn Customization
 
-All options for Prawn are passed through the Proforma::PrawnRenderer::Options object:
+All options for Prawn are passed through the Util::Options object:
 
-Name             | Default
----------------- | -------
-bold_font_style  | bold
-header_font_size | 15
-text_font_size   | 10
-font_name        | null
+Name             | Default | Type
+---------------- | ------- | -----------------
+bold_font_style  | bold    | symbol or string
+header_font_size | 15      | number
+text_font_size   | 10      | number
+font_name        | nil     | nil or string
+fonts            | []      | array of Util::Font objects or hashes with same attribute keys.
 
-These options will be used during the PDF rendering process.
+You can choose to pass in either a Util::Options instance or a hash with the same attribute keys.  These options will be used during the PDF rendering process.
+
+### Custom Fonts
+
+The fonts option above allows you to specify different fonts to use.  This is particularly useful if you wish to use fonts that better support internationalization.  Here is an example of defining and using a custom font:
+
+````
+options = {
+  font_name: 'Tuffy',
+  fonts: [
+    {
+      bold_path: File.join('fonts', 'Tuffy_Bold.ttf'),
+      name: 'Tuffy',
+      normal_path: File.join('fonts', 'Tuffy.ttf')
+    }
+  ]
+}
+
+renderer = Proforma::PrawnRenderer.new(options)
+
+# ...
+# Omitted data declaration
+# Omitted template declaration
+# ...
+
+documents = Proforma.render(data, template, renderer: renderer)
+````
+
+Note: Update the paths to reflect the actual locations on your machine/server.
 
 ## Contributing
 

data/lib/proforma/prawn_renderer.rb

@@ -7,6 +7,7 @@
 # LICENSE file in the root directory of this source tree.
 #
 
+require 'acts_as_hashable'
 require 'forwardable'
 require 'prawn'
 require 'prawn/table'
@@ -20,19 +21,14 @@ require_relative 'prawn_renderer/separator_renderer'
 require_relative 'prawn_renderer/spacer_renderer'
 require_relative 'prawn_renderer/table_renderer'
 require_relative 'prawn_renderer/text_renderer'
+require_relative 'prawn_renderer/util/font'
+require_relative 'prawn_renderer/util/options'
 
 module Proforma
   # This main class to use as a Proforma renderer.
   class PrawnRenderer
     EXTENSION = '.pdf'
 
-    DEFAULT_OPTIONS = {
-      bold_font_style: :bold,
-      font_name: nil,
-      text_font_size: 10,
-      header_font_size: 15
-    }.freeze
-
     RENDERERS = {
       Modeling::Banner => BannerRenderer,
       Modeling::Header => HeaderRenderer,
@@ -48,7 +44,7 @@ module Proforma
     attr_reader :options
 
     def initialize(options = {})
-      @options = OpenStruct.new(DEFAULT_OPTIONS.merge(options))
+      @options = Util::Options.make(options)
 
       clear
     end
@@ -70,13 +66,23 @@ module Proforma
     attr_reader :pdf, :renderers
 
     def clear
-      @pdf = Prawn::Document.new
+      @pdf = fresh_pdf
 
       @renderers = RENDERERS.each_with_object({}) do |(model_class, renderer_class), hash|
         hash[model_class] = renderer_class.new(pdf, options)
       end
     end
 
+    def fresh_pdf
+      Prawn::Document.new.tap do |p|
+        options.fonts.each do |font|
+          p.font_families.update(font.prawn_config)
+        end
+
+        p.font(options.font_name)
+      end
+    end
+
     def render_children(children)
       children.each do |child|
         raise ArgumentError, "Cannot render: #{child.class.name}" unless renderable?(child)

data/lib/proforma/prawn_renderer/banner_renderer.rb

@@ -13,6 +13,9 @@ module Proforma
   class PrawnRenderer
     # This class understands how to ender a Proforma::Modeling::Banner component.
     class BannerRenderer < Renderer
+      PAD_LEFT    = [0, 0, 0, 10].freeze
+      NO_PADDING  = [0, 0, 0, 0].freeze
+
       def render(banner)
         pdf.table(
           make_rows(banner),
@@ -64,7 +67,6 @@ module Proforma
       def cell_style
         @cell_style ||= {
           border_width: 0,
-          font: font_name,
           min_font_size: 1,
           overflow: :shrink_to_fit,
           padding: 0,
@@ -73,7 +75,7 @@ module Proforma
       end
 
       def text_cell_style(pad_left)
-        padding = pad_left ? [0, 0, 0, 10] : [0, 0, 0, 0]
+        padding = pad_left ? PAD_LEFT : NO_PADDING
 
         cell_style.merge(
           inline_format: true,

data/lib/proforma/prawn_renderer/header_renderer.rb

@@ -16,7 +16,6 @@ module Proforma
       def render(text)
         pdf.text(
           text.value.to_s,
-          font: font_name,
           size: header_font_size,
           style: bold_font_style
         )

data/lib/proforma/prawn_renderer/pane_renderer.rb

@@ -7,7 +7,7 @@
 # LICENSE file in the root directory of this source tree.
 #
 
-require_relative 'balanced_set'
+require_relative 'util/balanced_set'
 require_relative 'renderer'
 
 module Proforma
@@ -81,16 +81,15 @@ module Proforma
       def make_column_widths(columns)
         widths = columns.map { |col| [col.label_width, col.value_width] }.flatten
 
-        BalancedSet.calculate(widths, 100)
-                   .map
-                   .with_index { |v, i| [i, calculate_width(v)] }
-                   .to_h
+        Util::BalancedSet.calculate(widths, 100)
+                         .map
+                         .with_index { |v, i| [i, calculate_width(v)] }
+                         .to_h
       end
 
       def base_value_cell_style
         @base_value_cell_style ||= {
           border_width: 0,
-          font: font_name,
           min_font_size: 1,
           overflow: :shrink_to_fit,
           padding: [2, 0, 2, 2],

data/lib/proforma/prawn_renderer/table_renderer.rb

@@ -59,7 +59,6 @@ module Proforma
       def cell_style
         @cell_style ||= {
           border_width: 0.5,
-          font: font_name,
           min_font_size: 1,
           overflow: :shrink_to_fit,
           padding: 3,

data/lib/proforma/prawn_renderer/text_renderer.rb

@@ -16,7 +16,6 @@ module Proforma
       def render(text)
         pdf.text(
           text.value.to_s,
-          font: font_name,
           size: text_font_size
         )
       end

data/lib/proforma/prawn_renderer/util/balanced_set.rb

@@ -0,0 +1,53 @@
+# 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
+    module Util
+      # This class can balance out an un-even set of values.
+      class BalancedSet
+        class << self
+          def calculate(values, sum, round: 2)
+            free_spots = values.count(&:nil?)
+
+            if free_spots.positive?
+              available_value = sum - values.map(&:to_f).reduce(0, :+)
+
+              new_values = divide(free_spots, available_value, round)
+
+              values = values.map { |v| v || new_values.shift }
+            end
+
+            balance(values, sum, round)
+          end
+
+          private
+
+          def balance(values, sum, round)
+            difference = sum - values.map(&:to_f).reduce(0, :+)
+
+            return values if difference.zero?
+
+            diff_spots = divide(values.length, difference, round)
+
+            values.map.with_index { |value, index| value + diff_spots[index] }
+          end
+
+          def divide(count, sum, round)
+            spot_value = (sum / count.to_f).round(round)
+
+            remainder = sum - (spot_value * count)
+
+            Array.new(count) { |i| i.zero? ? spot_value + remainder : spot_value }
+          end
+        end
+      end
+    end
+  end
+end

data/lib/proforma/prawn_renderer/util/font.rb

@@ -0,0 +1,44 @@
+# 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
+    module Util
+      # Defines what we & prawn need in a font.
+      class Font
+        acts_as_hashable
+
+        attr_reader :bold_path,
+                    :name,
+                    :normal_path
+
+        def initialize(bold_path:, name:, normal_path:)
+          raise ArgumentError, 'bold_path is required'    if bold_path.to_s.empty?
+          raise ArgumentError, 'name is required'         if name.to_s.empty?
+          raise ArgumentError, 'normal_path is required'  if normal_path.to_s.empty?
+
+          @bold_path    = bold_path
+          @name         = name
+          @normal_path  = normal_path
+
+          freeze
+        end
+
+        def prawn_config
+          {
+            name.to_s => {
+              normal: normal_path.to_s,
+              bold: bold_path.to_s
+            }
+          }
+        end
+      end
+    end
+  end
+end

data/lib/proforma/prawn_renderer/util/options.rb

@@ -0,0 +1,41 @@
+# 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
+    module Util
+      # Defines what is allowed to be customized per rendering.
+      class Options
+        acts_as_hashable
+
+        attr_reader :bold_font_style,
+                    :font_name,
+                    :fonts,
+                    :header_font_size,
+                    :text_font_size
+
+        def initialize(
+          bold_font_style: :bold,
+          font_name: nil,
+          fonts: [],
+          text_font_size: 10,
+          header_font_size: 15
+        )
+          @bold_font_style  = bold_font_style
+          @font_name        = font_name
+          @fonts            = Font.array(fonts)
+          @text_font_size   = text_font_size
+          @header_font_size = header_font_size
+
+          freeze
+        end
+      end
+    end
+  end
+end

data/lib/proforma/prawn_renderer/version.rb

@@ -9,6 +9,6 @@
 
 module Proforma
   class PrawnRenderer
-    VERSION = '1.0.3'
+    VERSION = '1.1.0'
   end
 end

data/proforma-prawn-renderer.gemspec

@@ -21,6 +21,7 @@ Gem::Specification.new do |s|
 
   s.required_ruby_version = '>= 2.3.8'
 
+  s.add_dependency('acts_as_hashable', '~>1')
   s.add_dependency('prawn', '~>2')
   s.add_dependency('prawn-table', '~>0')
   s.add_dependency('proforma', '~>1')

data/spec/proforma/prawn_renderer/{balanced_set_spec.rb → util/balanced_set_spec.rb}

@@ -9,7 +9,7 @@
 
 require './spec/spec_helper'
 
-describe ::Proforma::PrawnRenderer::BalancedSet do
+describe ::Proforma::PrawnRenderer::Util::BalancedSet do
   describe '#calculate' do
     specify 'with no explicit values' do
       expect(described_class.calculate([nil], 100)).to            eq([100])

data/spec/proforma/prawn_renderer_spec.rb

@@ -112,6 +112,43 @@ describe ::Proforma::PrawnRenderer do
       ]
     }
 
-    Proforma.render(data, template, renderer: Proforma::PrawnRenderer.new)
+    actual_documents = Proforma.render(data, template, renderer: Proforma::PrawnRenderer.new)
+
+    expect(actual_documents.length).to eq(1)
+  end
+
+  specify 'Custom fonts can be used' do
+    data = [{ name: '井友' }]
+
+    template = {
+      children: [
+        { type: 'Header', value: '井友' },
+        { type: 'Header', value: 'Text - 井友' },
+        { type: 'Separator' },
+        {
+          type: 'DataTable',
+          columns: [
+            { header: '井友', body: '$name' }
+          ]
+        }
+      ]
+    }
+
+    options = {
+      font_name: 'Tuffy',
+      fonts: [
+        {
+          bold_path: File.join(Dir.pwd, 'spec', 'fixtures', 'fonts', 'Tuffy_Bold.ttf'),
+          name: 'Tuffy',
+          normal_path: File.join(Dir.pwd, 'spec', 'fixtures', 'fonts', 'Tuffy.ttf')
+        }
+      ]
+    }
+
+    renderer = Proforma::PrawnRenderer.new(options)
+
+    actual_documents = Proforma.render(data, template, renderer: renderer)
+
+    expect(actual_documents.length).to eq(1)
   end
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: proforma-prawn-renderer
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.1.0
 platform: ruby
 authors:
 - Matthew Ruggio
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-07-08 00:00:00.000000000 Z
+date: 2019-07-25 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: acts_as_hashable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
 - !ruby/object:Gem::Dependency
   name: prawn
   requirement: !ruby/object:Gem::Requirement
@@ -203,7 +217,6 @@ files:
 - bin/console
 - bin/render
 - lib/proforma/prawn_renderer.rb
-- lib/proforma/prawn_renderer/balanced_set.rb
 - lib/proforma/prawn_renderer/banner_renderer.rb
 - lib/proforma/prawn_renderer/header_renderer.rb
 - lib/proforma/prawn_renderer/pane_renderer.rb
@@ -212,13 +225,18 @@ files:
 - lib/proforma/prawn_renderer/spacer_renderer.rb
 - lib/proforma/prawn_renderer/table_renderer.rb
 - lib/proforma/prawn_renderer/text_renderer.rb
+- lib/proforma/prawn_renderer/util/balanced_set.rb
+- lib/proforma/prawn_renderer/util/font.rb
+- lib/proforma/prawn_renderer/util/options.rb
 - lib/proforma/prawn_renderer/version.rb
 - proforma-prawn-renderer.gemspec
 - spec/fixtures/component_test.pdf
 - spec/fixtures/component_test.yml
+- spec/fixtures/fonts/Tuffy.ttf
+- spec/fixtures/fonts/Tuffy_Bold.ttf
 - spec/fixtures/snapshots/user_details.yml
 - spec/fixtures/snapshots/user_list.yml
-- spec/proforma/prawn_renderer/balanced_set_spec.rb
+- spec/proforma/prawn_renderer/util/balanced_set_spec.rb
 - spec/proforma/prawn_renderer_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/bluemarblepayroll/proforma-prawn-renderer
@@ -247,8 +265,10 @@ summary: Proforma renderer plugin for generating PDFs using Prawn
 test_files:
 - spec/fixtures/component_test.pdf
 - spec/fixtures/component_test.yml
+- spec/fixtures/fonts/Tuffy.ttf
+- spec/fixtures/fonts/Tuffy_Bold.ttf
 - spec/fixtures/snapshots/user_details.yml
 - spec/fixtures/snapshots/user_list.yml
-- spec/proforma/prawn_renderer/balanced_set_spec.rb
+- spec/proforma/prawn_renderer/util/balanced_set_spec.rb
 - spec/proforma/prawn_renderer_spec.rb
 - spec/spec_helper.rb

data/lib/proforma/prawn_renderer/balanced_set.rb

@@ -1,51 +0,0 @@
-# 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 can balance out an un-even set of values.
-    class BalancedSet
-      class << self
-        def calculate(values, sum, round: 2)
-          free_spots = values.count(&:nil?)
-
-          if free_spots.positive?
-            available_value = sum - values.map(&:to_f).reduce(0, :+)
-
-            new_values = divide(free_spots, available_value, round)
-
-            values = values.map { |v| v || new_values.shift }
-          end
-
-          balance(values, sum, round)
-        end
-
-        private
-
-        def balance(values, sum, round)
-          difference = sum - values.map(&:to_f).reduce(0, :+)
-
-          return values if difference.zero?
-
-          diff_spots = divide(values.length, difference, round)
-
-          values.map.with_index { |value, index| value + diff_spots[index] }
-        end
-
-        def divide(count, sum, round)
-          spot_value = (sum / count.to_f).round(round)
-
-          remainder = sum - (spot_value * count)
-
-          Array.new(count) { |i| i.zero? ? spot_value + remainder : spot_value }
-        end
-      end
-    end
-  end
-end