proforma 1.0.0.pre.alpha

data/lib/proforma/prototype.rb

@@ -0,0 +1,28 @@
+# 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
+  # A prototype is a compiled template that has been flattened and ready for rendering.
+  class Prototype
+    attr_writer :children, :title
+
+    def initialize(children: [], title: '')
+      @children = ModelFactory.array(children)
+      @title    = title
+    end
+
+    def children
+      Array(@children)
+    end
+
+    def title
+      @title.to_s
+    end
+  end
+end

data/lib/proforma/template.rb

@@ -0,0 +1,65 @@
+# 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
+  # A Template instance is a set of modeling objects with directions on how to compile it into
+  # a Prototype object.  The prototype instance can then be rendered into an end-result such as
+  # a text, pdf, or spreadsheet file.
+  class Template < Prototype
+    include Compiling::Compilable
+    acts_as_hashable
+
+    attr_writer :split
+
+    def initialize(children: [], split: false, title: '')
+      @split = split
+
+      super(children: children, title: title)
+    end
+
+    def split
+      @split || false
+    end
+    alias split? split
+
+    def compile(data, evaluator)
+      if split?
+        compile_record(data, evaluator)
+      else
+        compile_collection(data, evaluator)
+      end
+    end
+
+    private
+
+    def compile_collection(data, evaluator)
+      compiled_children = Modeling::Collection.new(children: children).compile(data, evaluator)
+
+      [
+        Prototype.new(
+          children: compiled_children,
+          title: evaluator.text({}, title)
+        )
+      ]
+    end
+
+    def compile_record(data, evaluator)
+      default_grouping = Modeling::Grouping.new(children: children)
+
+      array(data).map do |record|
+        compiled_children = default_grouping.compile(record, evaluator)
+
+        Prototype.new(
+          children: compiled_children,
+          title: evaluator.text(record, title)
+        )
+      end
+    end
+  end
+end

data/lib/proforma/type_factory.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
+  # A TypeFactory object understands how to build objects using a special designated '$type' key.
+  class TypeFactory
+    DEFAULT_TYPE_KEY = :type
+
+    attr_reader :registry, :type_key
+
+    def initialize(registry = {}, type_key = DEFAULT_TYPE_KEY)
+      @registry = registry.symbolize_keys
+      @type_key = type_key
+
+      freeze
+    end
+
+    def array(objects = [])
+      objects = objects.is_a?(Hash) ? [objects] : Array(objects)
+
+      objects.map do |object|
+        object.is_a?(Hash) ? make(object) : object
+      end
+    end
+
+    def make(config = {})
+      config        = (config || {}).symbolize_keys
+      type          = config[type_key].to_s.to_sym
+      object_class  = registry[type]
+
+      raise ArgumentError, "cannot find section from type: #{type}" unless object_class
+
+      config_without_type = config.reject { |k| k == type_key }
+
+      object_class.new(config_without_type)
+    end
+  end
+end

data/lib/proforma/version.rb

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

data/proforma.gemspec

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require './lib/proforma/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'proforma'
+  s.version     = Proforma::VERSION
+  s.summary     = 'Configurable and extendable document rendering engine for datasets'
+
+  s.description = <<-DESCRIPTION
+    Provide a simple, configurable, and standardized document generation object model.
+    The basic premise is to pass in a dataset and configuration and this library will return rendered documents.
+    The rendering engines can be plugged in so it leaves this as an extendable/open framework.
+  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'
+  s.license     = 'MIT'
+
+  s.required_ruby_version = '>= 2.3.8'
+
+  s.add_dependency('acts_as_hashable', '~>1')
+
+  s.add_development_dependency('guard-rspec', '~>4.7')
+  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/custom_table.yml

@@ -0,0 +1,55 @@
+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:
+  title: Custom Table
+  children:
+  - type: Grouping
+    children:
+    - type: Table
+      body:
+        rows:
+        - cells:
+          - text: ID Number
+          - text: $:id
+          - text: Username
+          - text: $:username
+        - cells:
+          - text: First Name
+          - text: $:first
+          - text: Last Name
+          - text: $:last
+
+documents:
+- title: Custom Table
+  contents: |+
+    ID Number, 1, Username, will_smith
+    First Name, Will, Last Name, Smith
+    ID Number, 2, Username, mlaw10
+    First Name, Martin, Last Name, Lawrence
+    ID Number, 3, Username, will.ferrell
+    First Name, Will, Last Name, Ferrell
+  extension: '.txt'

data/spec/fixtures/snapshots/user_details.yml

@@ -0,0 +1,101 @@
+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: 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
+
+documents:
+- title: User Details
+  contents: |+
+    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
+
+  extension: '.txt'
+- title: User Details
+  contents: |+
+    USER DETAILS
+    ----------------------------------------
+    The following is user details
+    ID Number: 2
+    First Name: Martin
+    Last Name: Lawrence
+
+    PHONE NUMBERS
+    Type, Number
+    home, 999-888-7777
+
+  extension: '.txt'
+- title: User Details
+  contents: |+
+    USER DETAILS
+    ----------------------------------------
+    The following is user details
+    ID Number: 3
+    First Name: Will
+    Last Name: Ferrell
+
+    PHONE NUMBERS
+    No phone numbers.
+
+  extension: '.txt'

data/spec/fixtures/snapshots/user_list.yml

@@ -0,0 +1,143 @@
+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:
+  title: User List
+  children:
+  - type: Banner
+    details: "555 N. Michigan Ave.\nChicago, IL 62626\n555-555-5555 ext. 55555"
+    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
+    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.
+    - header: First Name
+      body: $:first
+      footer: $:login_count_ave
+    - header: Last Name
+      body: $:last
+    - header: Username
+      body: $:username
+      footer: Login Count Sum
+    - header: Login Count
+      footer: $:login_count_sum
+      body: $:login_count
+  - 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
+
+documents:
+- title: User List
+  contents: |+
+    ========================================
+    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.333333333333333333, , 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.
+
+  extension: '.txt'