proforma-prawn-renderer 1.0.0.pre.alpha

data/lib/proforma/prawn_renderer/pane_renderer.rb

@@ -0,0 +1,102 @@
+# 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::Pane component.
+    class PaneRenderer < Renderer
+      def render(pane)
+        pdf.table(
+          make_rows(pane.columns),
+          column_widths: make_column_widths(pane.columns),
+          width: total_width
+        )
+      end
+
+      private
+
+      def make_rows_shell(columns)
+        total_columns = columns.length * 2
+        total_rows = columns.map(&:line_count).max
+
+        (0...total_rows).map { Array.new(total_columns) }
+      end
+
+      def value_cell_padding(column_index, total_columns)
+        if column_index < total_columns - 1
+          [2, 20, 2, 2]
+        else
+          [2, 0, 2, 2]
+        end
+      end
+
+      def value_cell_style(column, column_index, total_columns)
+        base_value_cell_style.merge(
+          align: column.align,
+          padding: value_cell_padding(column_index, total_columns)
+        )
+      end
+
+      def make_rows(columns)
+        rows = make_rows_shell(columns)
+
+        columns.each_with_index do |column, column_index|
+          value_cell_style = value_cell_style(column, column_index, columns.length)
+
+          populate_lines(column.lines, rows, column_index, value_cell_style)
+        end
+
+        rows
+      end
+
+      def populate_lines(lines, rows, column_index, value_cell_style)
+        label_cell_index = column_index * 2
+        value_cell_index = column_index * 2 + 1
+
+        lines.each_with_index do |line, line_index|
+          label = line.label
+          value = line.value
+          rows[line_index][label_cell_index] = pdf.make_cell(label, base_label_cell_style)
+          rows[line_index][value_cell_index] = pdf.make_cell(value, value_cell_style)
+        end
+      end
+
+      def make_column_widths(columns)
+        column_widths = {}
+
+        columns.each_with_index do |column, index|
+          label_width = column.label_width
+          next unless label_width
+
+          column_widths[index * 2] = calculate_width(label_width)
+        end
+
+        column_widths
+      end
+
+      def base_value_cell_style
+        @base_value_cell_style ||= {
+          border_width: 0,
+          font: options.font_name,
+          padding: [2, 0, 2, 2],
+          size: options.text_font_size
+        }
+      end
+
+      def base_label_cell_style
+        @base_label_cell_style ||= base_value_cell_style.merge(
+          padding: [2, 2, 2, 0],
+          font_style: options.bold_font_style
+        )
+      end
+    end
+  end
+end

data/lib/proforma/prawn_renderer/renderer.rb

@@ -0,0 +1,34 @@
+# 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
+    # The base class that contains common functionality across all sub-rendering components.
+    class Renderer
+      def initialize(pdf, options)
+        @options  = options
+        @pdf      = pdf
+      end
+
+      private
+
+      attr_reader :options, :pdf
+
+      def total_width
+        pdf.bounds.width
+      end
+
+      def calculate_width(percentage)
+        return 0 unless percentage
+
+        total_width * (percentage.to_f / 100)
+      end
+    end
+  end
+end

data/lib/proforma/prawn_renderer/separator_renderer.rb

@@ -0,0 +1,25 @@
+# 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::Separator component.
+    class SeparatorRenderer < Renderer
+      WIDTH = 0.5
+
+      def render(_separator)
+        pdf.line_width(WIDTH)
+        pdf.stroke_horizontal_rule
+        pdf.move_down(5)
+      end
+    end
+  end
+end

data/lib/proforma/prawn_renderer/spacer_renderer.rb

@@ -0,0 +1,23 @@
+# 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::Separator component.
+    class SpacerRenderer < Renderer
+      AMOUNT = 15
+
+      def render(_separator)
+        pdf.move_down(AMOUNT)
+      end
+    end
+  end
+end

data/lib/proforma/prawn_renderer/table_renderer.rb

@@ -0,0 +1,87 @@
+# 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::Table component.
+    class TableRenderer < Renderer
+      def render(table)
+        row_for_widths  = table.header.rows.first
+        column_widths   = row_for_widths ? make_column_widths(row_for_widths) : {}
+
+        pdf.table(
+          make_all_rows(table),
+          column_widths: column_widths,
+          width: total_width
+        )
+      end
+
+      private
+
+      def make_all_rows(table)
+        make_rows(table.header, header_cell_style) +
+          make_rows(table.body, body_cell_style) +
+          make_rows(table.footer, footer_cell_style)
+      end
+
+      def make_rows(section, cell_style)
+        section.rows.map do |row|
+          row.cells.map do |cell|
+            pdf.make_cell(cell.text.to_s, cell_style)
+          end
+        end
+      end
+
+      def make_column_widths(row)
+        column_widths = {}
+
+        row.cells.each_with_index do |cell, index|
+          next unless cell.width
+
+          column_widths[index] = calculate_width(cell.width)
+        end
+
+        column_widths
+      end
+
+      def cell_style
+        @cell_style ||= {
+          border_width: 0.5,
+          font: options.font_name,
+          padding: 3,
+          size: options.text_font_size
+        }
+      end
+
+      def body_cell_style
+        @body_cell_style ||= cell_style.merge(
+          borders: %i[top bottom]
+        )
+      end
+
+      def header_cell_style
+        @header_cell_style ||= cell_style.merge(
+          background_color: 'D3D3D3',
+          borders: [],
+          font_style: options.bold_font_style
+        )
+      end
+
+      def footer_cell_style
+        @footer_cell_style ||= cell_style.merge(
+          background_color: 'F4F4F4',
+          borders: [],
+          font_style: options.bold_font_style
+        )
+      end
+    end
+  end
+end

data/lib/proforma/prawn_renderer/text_renderer.rb

@@ -0,0 +1,25 @@
+# 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::Text component.
+    class TextRenderer < Renderer
+      def render(text)
+        pdf.text(
+          text.value.to_s,
+          font: options.font_name,
+          size: options.text_font_size
+        )
+      end
+    end
+  end
+end

data/lib/proforma/prawn_renderer/version.rb

@@ -0,0 +1,14 @@
+# 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
+    VERSION = '1.0.0-alpha'
+  end
+end

data/lib/proforma/prawn_renderer.rb

@@ -0,0 +1,89 @@
+# 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 'prawn'
+require 'prawn/table'
+require 'proforma'
+
+require_relative 'prawn_renderer/renderer'
+require_relative 'prawn_renderer/banner_renderer'
+require_relative 'prawn_renderer/header_renderer'
+require_relative 'prawn_renderer/options'
+require_relative 'prawn_renderer/pane_renderer'
+require_relative 'prawn_renderer/separator_renderer'
+require_relative 'prawn_renderer/spacer_renderer'
+require_relative 'prawn_renderer/table_renderer'
+require_relative 'prawn_renderer/text_renderer'
+
+module Proforma
+  # This main class to use as a Proforma renderer.
+  class PrawnRenderer
+    EXTENSION = '.pdf'
+
+    RENDERERS = {
+      Modeling::Banner => BannerRenderer,
+      Modeling::Header => HeaderRenderer,
+      Modeling::Pane => PaneRenderer,
+      Modeling::Separator => SeparatorRenderer,
+      Modeling::Spacer => SpacerRenderer,
+      Modeling::Table => TableRenderer,
+      Modeling::Text => TextRenderer
+    }.freeze
+
+    private_constant :RENDERERS
+
+    attr_reader :options
+
+    def initialize(options = Options.new)
+      @options = options || Options.new
+
+      clear
+    end
+
+    def render(prototype)
+      clear
+
+      render_children(prototype.children)
+
+      Proforma::Document.new(
+        contents: pdf.render,
+        extension: EXTENSION,
+        title: prototype.title
+      )
+    end
+
+    private
+
+    attr_reader :pdf, :renderers
+
+    def clear
+      @pdf = Prawn::Document.new
+
+      @renderers = RENDERERS.each_with_object({}) do |(model_class, renderer_class), hash|
+        hash[model_class] = renderer_class.new(pdf, options)
+      end
+    end
+
+    def render_children(children)
+      children.each do |child|
+        raise ArgumentError, "Cannot render: #{child.class.name}" unless renderable?(child)
+
+        renderer(child).render(child)
+      end
+    end
+
+    def renderable?(child)
+      renderers.key?(child.class)
+    end
+
+    def renderer(child)
+      renderers[child.class]
+    end
+  end
+end

data/proforma-prawn-renderer.gemspec

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require './lib/proforma/prawn_renderer/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'proforma-prawn-renderer'
+  s.version     = Proforma::PrawnRenderer::VERSION
+  s.summary     = 'Proforma renderer plugin for generating PDFs using Prawn'
+
+  s.description = <<-DESCRIPTION
+
+  DESCRIPTION
+
+  s.authors     = ['Matthew Ruggio']
+  s.email       = ['mruggio@bluemarblepayroll.com']
+  s.files       = `git ls-files`.split("\n")
+  s.test_files  = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
+  s.homepage    = 'https://github.com/bluemarblepayroll/proforma-prawn-renderer'
+  s.license     = 'MIT'
+
+  s.required_ruby_version = '>= 2.3.8'
+
+  s.add_dependency('prawn', '~>2')
+  s.add_dependency('prawn-table', '~>0')
+
+  s.add_development_dependency('guard-rspec', '~>4.7')
+  s.add_development_dependency('pdf-inspector', '~>1')
+  s.add_development_dependency('proforma', '>=1.0.0-alpha')
+  s.add_development_dependency('pry', '~>0')
+  s.add_development_dependency('rspec', '~> 3.8')
+  s.add_development_dependency('rubocop', '~>0.63.1')
+  s.add_development_dependency('simplecov', '~>0.16.1')
+  s.add_development_dependency('simplecov-console', '~>0.4.2')
+end

data/spec/fixtures/snapshots/user_details.yml

@@ -0,0 +1,69 @@
+data:
+- id: 1
+  first: Will
+  last: Smith
+  username: will_smith
+  login_count: 9219
+  phone_numbers:
+  - type: cell
+    number: 555-444-3333
+  - type: fax
+    number: 333-444-2222
+- id: 2
+  first: Martin
+  last: Lawrence
+  username: mlaw10
+  login_count: 8077
+  phone_numbers:
+  - type: home
+    number: 999-888-7777
+- id: 3
+  first: Will
+  last: Ferrell
+  username: will.ferrell
+  login_count: 190890
+  phone_numbers:
+
+template:
+  split: true
+  title: User Details
+  children:
+  - type: Header
+    value: User Details
+  - type: Separator
+  - type: Text
+    value: 'The following is user details'
+  - type: Pane
+    columns:
+    - label_width: 20.0
+      lines:
+      - label: ID Number
+        value: $:id
+    - label_width: 20.0
+      lines:
+      - label: First Name
+        value: $:first
+    - label_width: 20.0
+      lines:
+      - label: Last Name
+        value: $:last
+  - type: Spacer
+  - type: Header
+    value: Phone Numbers
+  - type: DataTable
+    property: phone_numbers
+    empty_message: No phone numbers.
+    columns:
+    - header: Type
+      body: $:type
+    - header: Number
+      body: $:number
+  - type: Spacer
+
+strings:
+- User Details The following is user details ID Number 1 First Name Will
+  Last Name Smith Phone Numbers Type Number cell 555-444-3333 fax 333-444-2222
+- User Details The following is user details ID Number 2 First Name
+  Martin Last Name Lawrence Phone Numbers Type Number home 999-888-7777
+- User Details The following is user details ID Number 3
+  First Name Will Last Name Ferrell Phone Numbers No phone numbers.

data/spec/fixtures/snapshots/user_list.yml

@@ -0,0 +1,124 @@
+data:
+  users:
+  - id: 1
+    first: Will
+    last: Smith
+    username: will_smith
+    login_count: 9219
+    phone_numbers:
+    - type: cell
+      number: 555-444-3333
+    - type: fax
+      number: 333-444-2222
+  - id: 2
+    first: Martin
+    last: Lawrence
+    username: mlaw10
+    login_count: 8077
+    phone_numbers:
+    - type: home
+      number: 999-888-7777
+  - id: 3
+    first: Will
+    last: Ferrell
+    username: will.ferrell
+    login_count: 190890
+    phone_numbers:
+
+renderer: !ruby/object:Proforma::PrawnRenderer
+  options: !ruby/object:Proforma::PrawnRenderer::Options
+    bold_font_style: :bold
+    font_name: Helvetica
+    header_font_size: 12
+    text_font_size: 9
+
+template: !ruby/object:Proforma::Template
+  output: :collection
+  title: User List
+  children:
+  - type: Banner
+    details: "555 N. Michigan Ave.\nChicago, IL 62626\n555-555-5555 ext. 55555"
+    image: logo
+    image_width: 60
+    image_height: 48
+    title: Some Random System
+  - type: Spacer
+  - type: Header
+    value: User List
+  - type: Separator
+  - type: Text
+    value: The following is a list of users
+  - type: Spacer
+  - type: DataTable
+    property: users
+    aggregators:
+      - property: login_count
+        function: sum
+        name: login_count_sum
+      - property: login_count
+        function: ave
+        name: login_count_ave
+    columns:
+    - header: ID Number
+      body: $:id
+      footer: Login Count Ave.
+      width: 20
+    - header: First Name
+      body: $:first
+      footer: $:login_count_ave
+      width: 20
+    - header: Last Name
+      body: $:last
+      width: 20
+    - header: Username
+      body: $:username
+      footer: Login Count Sum
+      width: 20
+    - header: Login Count
+      footer: $:login_count_sum
+      body: $:login_count
+      width: 20
+  - type: Grouping
+    property: users
+    children:
+    - type: Spacer
+    - type: Grouping
+      children:
+      - type: Header
+        value: 'User Details'
+      - type: Separator
+      - type: Pane
+        columns:
+        - label_width: 25.0
+          lines:
+          - label: ID Number
+            value: $:id
+          - label: First Name
+            value: $:first
+          - label: Last Name
+            value: $:last
+      - type: Spacer
+      - type: Header
+        value: Phone Numbers
+      - type: DataTable
+        property: phone_numbers
+        empty_message: No phone numbers.
+        columns:
+        - header: Type
+          body: $:type
+        - header: Number
+          body: $:number
+      - type: Spacer
+
+strings:
+- >-
+  Some Random System 555 N. Michigan Ave. Chicago, IL 62626 555-555-5555 ext. 55555
+  User List The following is a list of users ID Number First Name Last Name Username
+  Login Count
+  1 Will Smith will_smith 9219 2 Martin Lawrence mlaw10 8077
+  3 Will Ferrell will.ferrell 190890
+  Login Count Ave. 69395.333333333333333 333 Login Count Sum 208186.0
+  User Details ID Number 1 First Name Will Last Name Smith Phone Numbers Type Number
+  cell 555-444-3333 fax 333-444-2222 User Details ID Number 2 First Name Martin Last Name
+  Lawrence Phone Numbers Type Number home 999-888-7777 User Details ID Number 3 First Name
+  Will Last Name Ferrell Phone Numbers No phone numbers.

data/spec/proforma/prawn_renderer_spec.rb

@@ -0,0 +1,71 @@
+# 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 'spec_helper'
+
+describe ::Proforma::PrawnRenderer do
+  let(:snapshot_dir) { File.join('spec', 'fixtures', 'snapshots', '*.yml') }
+
+  let(:snapshot_filenames) { Dir[snapshot_dir] }
+
+  it 'should process each snapshot successfully' do
+    snapshot_filenames.each do |file|
+      contents = yaml_read(file)
+
+      documents = Proforma.render(
+        contents['data'],
+        contents['template'],
+        evaluator: contents['evaluator'] || Proforma::HashEvaluator.new,
+        renderer: contents['renderer'] || Proforma::PrawnRenderer.new
+      )
+
+      documents.each_with_index do |document, index|
+        expected_strings = contents['strings'][index]
+
+        actual_strings = pdf_strings(document.contents)
+
+        expect(actual_strings).to eq(expected_strings)
+      end
+    end
+  end
+
+  specify 'Proforma Rendering Example' do
+    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' }
+          ]
+        }
+      ]
+    }
+
+    actual_documents = Proforma.render(data, template, renderer: Proforma::PrawnRenderer.new)
+
+    actual_document = actual_documents.first
+
+    expected_strings = 'NBA Teams Team ID # Team Name 1'\
+                       ' Chicago Bulls 2 Indiana Pacers 3 Boston Celtics'
+
+    expect(pdf_strings(actual_document.contents)).to eq(expected_strings)
+    expect(actual_document.title).to                 eq('nba_team_list')
+    expect(actual_document.extension).to             eq('.pdf')
+  end
+end