proforma 1.0.0.pre.alpha → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 99a81eae5ad4326d4a525793b02615f3bcd5b7ac9bf3dd2e77d06b39f6fafe62
-  data.tar.gz: 4c3a71da8fa80f4a93117153ffb2a72ff35bbb624233f814d1669f821e3656d5
+  metadata.gz: 817f85bba720714f1805a67d79a890f4c54348c5960b2bbe5ada6cf580dd9895
+  data.tar.gz: 40a77e4fe0c8db140eedaa3a1632abcb43a5e5f94fb366126dd9eda6b7324eb6
 SHA512:
-  metadata.gz: 1c77a46115ad3804aa9752ef9d118e2e068a7a4d446b59c93eb6184d8f6101dadedeae52e2764957443533549d275cdea8647c1c49cb5c5fc4dd802cba3b13c7
-  data.tar.gz: 3ef60250c4a60b014fe28ae9dc1917f01ef5cab6217ba1310c0662ac920172fa14c4599e9a502dcf6380b6aa70ed63d14e7f8cc38038417ba9aa15c4d5d0d9be
+  metadata.gz: ee6d3dc842c7c75a43df463508d61228adc55683b439f846f35adbf487be59cd45bb517773609f45f58ae7a4441707a02dd64fc6a468d1e945ac66a38575f206
+  data.tar.gz: ff63785b94954ab0e21a725d98279d384d3d39912cdaf2c2184116d45ded4d85cc888191947f3f15ad4d7ce9a0023fd487c5998879121bdedb45c527d86c47b6

data/CHANGELOG.md

@@ -1,6 +1,10 @@
-# 1.0.0 (April 20th, 2019)
+# 1.0.0 (April 24th, 2019)
 
-Initial implementation.
+Publishing first release.
+
+# 1.0.0-alpha (April 19th, 2019)
+
+Publishing first candidate of initial release.
 
 # 0.0.1 (March 14th, 2019)
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    proforma (1.0.0.pre.alpha)
+    proforma (1.0.0)
       acts_as_hashable (~> 1)
 
 GEM

data/README.md

@@ -8,25 +8,25 @@ Proforma is a Ruby-based document rendering framework with a focus on being:
 2. Simple: basic set of controls that limit flexibility but increase simplicity and standardization
 3. Extendable: different value resolvers and document rendering engines can be plugged in
 
-The basic premise is you input a dataset and a template and Proforma:
+The basic premise is you input a dataset and a template and Proforma will:
 
-1. Evaluate and data-bind each component
-2. Render as a file
+1. Evaluate and data-bind each component.
+2. Render given data and template as a file.
 
 When a component is in the process of being data-bound it will be evaluated against the current data being read.  The evaluator serves two purposes:
 
-1. Given a record and an expression, find me a raw value (resolving)
-2. Given a record and an expression, return me a formatted string-based value (text templating)
+1. Given a record and an expression, find me a raw value (resolving.)
+2. Given a record and an expression, return me a formatted string-based value (text templating.)
 
 The basic evaluator that comes with this library is Proforma::HashEvaluator.  It is limited to:
 
-1. only resolving values for hash objects and cannot handle nesting / recursion / dot notation.
-2. only text templating simple expressions: if the expression starts with a ```$:``` then it is noted as being a data-bound value.  The value proceeding the ```$:``` will be resolved and returned.  If it does not begin with this special string then it is deemed just a basic string and it will be returned verbatim.
+1. Only resolving values for hash objects and cannot handle nesting / recursion / dot notation.
+2. Only text templating simple expressions: if the expression starts with a `$` then it is noted as being a data-bound value.  The value proceeding the `$` will be resolved and returned.  If it does not begin with this special string then the value following the $ will be resolved and returned.
 
 Other libraries that can be plugged in, such as:
 
-1. [![proforma-extended-evaluator](https://github.com/bluemarblepayroll/proforma-extended-evaluator): adds nested dot-notation object value resolution and rich text templating.
-2. [![proforma-prawn-renderer](https://github.com/bluemarblepayroll/proforma-prawn-renderer)]: adds PDF rendering.
+1. [proforma-extended-evaluator](https://github.com/bluemarblepayroll/proforma-extended-evaluator): adds nested dot-notation object value resolution and rich text templating.
+2. [proforma-prawn-renderer](https://github.com/bluemarblepayroll/proforma-prawn-renderer): adds PDF rendering.
 
 See the libraries respective README files for more information.
 
@@ -80,9 +80,9 @@ template = {
     {
       type: 'DataTable',
       columns: [
-        { header: 'ID Number', body: '$:id' },
-        { header: 'First Name', body: '$:first' },
-        { header: 'Last Name', body: '$:last' }
+        { header: 'ID Number', body: '$id' },
+        { header: 'First Name', body: '$first' },
+        { header: 'Last Name', body: '$last' }
       ]
     }
   ]
@@ -125,13 +125,13 @@ template = {
       columns: [
         {
           lines: [
-            { label: 'ID Number', value: '$:id' },
-            { label: 'First Name', value: '$:first' }
+            { label: 'ID Number', value: '$id' },
+            { label: 'First Name', value: '$first' }
           ]
         },
         {
           lines: [
-            { label: 'Last Name', value: '$:last' }
+            { label: 'Last Name', value: '$last' }
           ]
         }
       ]
@@ -211,9 +211,9 @@ template = {
     {
       type: 'DataTable',
       columns: [
-        { header: 'ID Number', body: '$:id' },
-        { header: 'First Name', body: '$:first' },
-        { header: 'Last Name', body: '$:last' }
+        { header: 'ID Number', body: '$id' },
+        { header: 'First Name', body: '$first' },
+        { header: 'Last Name', body: '$last' }
       ]
     },
     { type: 'Spacer' },
@@ -228,13 +228,13 @@ template = {
           columns: [
             {
               lines: [
-                { label: 'ID Number', value: '$:id' },
-                { label: 'First Name', value: '$:first' }
+                { label: 'ID Number', value: '$id' },
+                { label: 'First Name', value: '$first' }
               ]
             },
             {
               lines: [
-                { label: 'Last Name', value: '$:last' }
+                { label: 'Last Name', value: '$last' }
               ]
             }
           ]
@@ -243,8 +243,8 @@ template = {
           type: 'DataTable',
           property: 'phone_numbers',
           columns: [
-            { header: 'Type', body: '$:type' },
-            { header: 'Number', body: '$:number' }
+            { header: 'Type', body: '$type' },
+            { header: 'Number', body: '$number' }
           ]
         },
         { type: 'Spacer' }
@@ -275,6 +275,8 @@ The `contents` attribute will now contain:
 * user details pane (one per user)
 * user phone numbers table (one per user)
 
+The full contents can be seen in [this fixture file](https://github.com/bluemarblepayroll/proforma/blob/master/spec/fixtures/bringing_it_all_together.txt).
+
 ## Contributing
 
 ### Development Environment Configuration

data/bin/console

@@ -1,6 +1,13 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
+#
+# Copyright (c) 2018-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 'bundler/setup'
 require 'proforma'
 

data/bin/render

@@ -1,6 +1,13 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
+#
+# Copyright (c) 2018-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 'bundler/setup'
 require 'proforma'
 require 'fileutils'
@@ -8,9 +15,7 @@ require 'yaml'
 require 'pry'
 
 def read_yaml(filename)
-  # rubocop:disable Security/YAMLLoad
-  YAML.load(read(filename))
-  # rubocop:enable Security/YAMLLoad
+  YAML.safe_load(read(filename))
 end
 
 def read(filename)

data/lib/proforma.rb

@@ -12,19 +12,16 @@ require 'bigdecimal'
 require 'forwardable'
 require 'stringio'
 
-# Monkey-patching core libaries
-require_relative 'proforma/core_ext/hash'
-Hash.include ::Proforma::CoreExt::Hash
-
 require_relative 'proforma/compiling'
 require_relative 'proforma/document'
 require_relative 'proforma/hash_evaluator'
+require_relative 'proforma/hash_refinements'
+require_relative 'proforma/model_factory'
 require_relative 'proforma/modeling'
 require_relative 'proforma/plain_text_renderer'
 require_relative 'proforma/prototype'
 require_relative 'proforma/template'
 require_relative 'proforma/type_factory'
-require_relative 'proforma/model_factory'
 
 # The top-level API that should be seen as the main entry point into this library.
 module Proforma

data/lib/proforma/compiling/aggregation.rb

@@ -19,6 +19,8 @@ module Proforma
         @aggregators  = Array(aggregators)
         @counters     = {}
         @evaluator    = evaluator
+
+        freeze
       end
 
       def add(records)
@@ -35,7 +37,7 @@ module Proforma
         self
       end
 
-      def to_hash
+      def to_h
         aggregators.map { |aggregator| execute(aggregator) }.to_h
       end
 

data/lib/proforma/compiling/counter.rb

@@ -28,6 +28,8 @@ module Proforma
       end
 
       def ave
+        return BigDecimal(0) if count.zero?
+
         sum / count
       end
     end

data/lib/proforma/hash_evaluator.rb

@@ -14,24 +14,20 @@ module Proforma
   # This, being a prototype for customizable evaluators, just provides basic evaluation:
   # - it can only handle hashes for value extraction
   # - if text is prefixed with a dollar sign and colon then it means it will be dynamically
-  #   evaluated against the record.  For example: $:id
+  #   evaluated against the record.  For example: $id
   class HashEvaluator
-    PROPERTY_PREFIX = '$:'
+    PROPERTY_PREFIX = '$'
 
     def value(object, expression)
       return object if expression.to_s.empty?
       return nil    unless object.is_a?(Hash)
 
-      if object.key?(expression.to_s)
-        object[expression.to_s]
-      elsif object.key?(expression.to_s.to_sym)
-        object[expression.to_s.to_sym]
-      end
+      object[expression.to_s] || object[expression.to_s.to_sym]
     end
 
     def text(object, expression)
       if expression.to_s.start_with?(PROPERTY_PREFIX)
-        value(object, expression.to_s[2..-1])
+        value(object, expression.to_s[PROPERTY_PREFIX.length..-1])
       else
         expression
       end

data/lib/proforma/hash_refinements.rb

@@ -0,0 +1,20 @@
+# 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
+  # Let's provide a refinenment instead of monkey-patching Hash.  That way we can stop
+  # polluting other libraries and internalize our specific needs.
+  module HashRefinements
+    refine Hash do
+      def symbolize_keys
+        map { |k, v| [k.to_sym, v] }.to_h
+      end
+    end
+  end
+end

data/lib/proforma/model_factory.rb

@@ -7,6 +7,8 @@
 # LICENSE file in the root directory of this source tree.
 #
 
+require_relative 'modeling'
+
 module Proforma
   # This class serves as a singleton that can make Proforma::Modeling components.
   class ModelFactory

data/lib/proforma/modeling.rb

@@ -9,6 +9,7 @@
 
 require_relative 'modeling/generic_container'
 require_relative 'modeling/types'
+
 require_relative 'modeling/banner'
 require_relative 'modeling/collection'
 require_relative 'modeling/data_table'

data/lib/proforma/modeling/data_table.rb

@@ -64,7 +64,7 @@ module Proforma
       private
 
       def make_aggregator_meta_data(records, evaluator)
-        Compiling::Aggregation.new(aggregators, evaluator).add(records).to_hash
+        Compiling::Aggregation.new(aggregators, evaluator).add(records).to_h
       end
 
       def footer?

data/lib/proforma/modeling/generic_container.rb

@@ -40,9 +40,7 @@ module Proforma
       def compile(data, evaluator)
         compiled_children = children.map { |child| child.compile(data, evaluator) }
 
-        args = {}.tap { |hash| hash[child_key] = compiled_children }
-
-        self.class.new(args)
+        self.class.new(child_key => compiled_children)
       end
 
       private

data/lib/proforma/type_factory.rb

@@ -10,6 +10,8 @@
 module Proforma
   # A TypeFactory object understands how to build objects using a special designated '$type' key.
   class TypeFactory
+    using HashRefinements
+
     DEFAULT_TYPE_KEY = :type
 
     attr_reader :registry, :type_key

data/lib/proforma/version.rb

@@ -8,5 +8,5 @@
 #
 
 module Proforma
-  VERSION = '1.0.0-alpha'
+  VERSION = '1.0.0'
 end

data/spec/fixtures/bringing_it_all_together.txt

@@ -0,0 +1,42 @@
+========================================
+System A
+========================================
+555 N. Michigan Ave.
+Chicago, IL 55555
+555-555-5555 ext. 5132
+========================================
+USER LIST
+----------------------------------------
+
+ID Number, First Name, Last Name
+1, Matt, Smith
+2, Katie, Rizzo
+3, Nathan, Nathanson
+
+USER DETAILS
+----------------------------------------
+
+ID Number: 1
+First Name: Matt
+Last Name: Smith
+Type, Number
+Mobile, 444-333-2222
+Home, 444-333-2222
+
+USER DETAILS
+----------------------------------------
+
+ID Number: 2
+First Name: Katie
+Last Name: Rizzo
+Type, Number
+Fax, 888-777-6666
+
+USER DETAILS
+----------------------------------------
+
+ID Number: 3
+First Name: Nathan
+Last Name: Nathanson
+Type, Number
+

data/spec/fixtures/snapshots/custom_table.yml

@@ -34,14 +34,14 @@ template:
         rows:
         - cells:
           - text: ID Number
-          - text: $:id
+          - text: $id
           - text: Username
-          - text: $:username
+          - text: $username
         - cells:
           - text: First Name
-          - text: $:first
+          - text: $first
           - text: Last Name
-          - text: $:last
+          - text: $last
 
 documents:
 - title: Custom Table

data/spec/fixtures/snapshots/user_details.yml

@@ -38,11 +38,11 @@ template:
     - label_width: 25.0
       lines:
       - label: ID Number
-        value: $:id
+        value: $id
       - label: First Name
-        value: $:first
+        value: $first
       - label: Last Name
-        value: $:last
+        value: $last
   - type: Spacer
   - type: Header
     value: Phone Numbers
@@ -51,9 +51,9 @@ template:
     empty_message: No phone numbers.
     columns:
     - header: Type
-      body: $:type
+      body: $type
     - header: Number
-      body: $:number
+      body: $number
   - type: Spacer
 
 documents:

data/spec/fixtures/snapshots/user_list.yml

@@ -47,19 +47,19 @@ template:
         name: login_count_ave
     columns:
     - header: ID Number
-      body: $:id
+      body: $id
       footer: Login Count Ave.
     - header: First Name
-      body: $:first
-      footer: $:login_count_ave
+      body: $first
+      footer: $login_count_ave
     - header: Last Name
-      body: $:last
+      body: $last
     - header: Username
-      body: $:username
+      body: $username
       footer: Login Count Sum
     - header: Login Count
-      footer: $:login_count_sum
-      body: $:login_count
+      footer: $login_count_sum
+      body: $login_count
   - type: Spacer
   - type: Grouping
     children:
@@ -71,11 +71,11 @@ template:
       - label_width: 25.0
         lines:
         - label: ID Number
-          value: $:id
+          value: $id
         - label: First Name
-          value: $:first
+          value: $first
         - label: Last Name
-          value: $:last
+          value: $last
     - type: Spacer
     - type: Header
       value: Phone Numbers
@@ -84,9 +84,9 @@ template:
       empty_message: No phone numbers.
       columns:
       - header: Type
-        body: $:type
+        body: $type
       - header: Number
-        body: $:number
+        body: $number
     - type: Spacer
 
 documents:

data/spec/proforma/compiling/counter_spec.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+#
+# Copyright (c) 2018-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::Compiling::Counter do
+  specify '#ave returns 0 if count is 0' do
+    expect(subject.ave).to eq(0)
+  end
+end

data/spec/proforma_spec.rb

@@ -45,9 +45,9 @@ describe ::Proforma do
           {
             type: 'DataTable',
             columns: [
-              { header: 'ID Number', body: '$:id' },
-              { header: 'First Name', body: '$:first' },
-              { header: 'Last Name', body: '$:last' }
+              { header: 'ID Number', body: '$id' },
+              { header: 'First Name', body: '$first' },
+              { header: 'Last Name', body: '$last' }
             ]
           }
         ]
@@ -83,13 +83,13 @@ describe ::Proforma do
             columns: [
               {
                 lines: [
-                  { label: 'ID Number', value: '$:id' },
-                  { label: 'First Name', value: '$:first' }
+                  { label: 'ID Number', value: '$id' },
+                  { label: 'First Name', value: '$first' }
                 ]
               },
               {
                 lines: [
-                  { label: 'Last Name', value: '$:last' }
+                  { label: 'Last Name', value: '$last' }
                 ]
               }
             ]
@@ -161,9 +161,9 @@ describe ::Proforma do
           {
             type: 'DataTable',
             columns: [
-              { header: 'ID Number', body: '$:id' },
-              { header: 'First Name', body: '$:first' },
-              { header: 'Last Name', body: '$:last' }
+              { header: 'ID Number', body: '$id' },
+              { header: 'First Name', body: '$first' },
+              { header: 'Last Name', body: '$last' }
             ]
           },
           { type: 'Spacer' },
@@ -178,13 +178,13 @@ describe ::Proforma do
                 columns: [
                   {
                     lines: [
-                      { label: 'ID Number', value: '$:id' },
-                      { label: 'First Name', value: '$:first' }
+                      { label: 'ID Number', value: '$id' },
+                      { label: 'First Name', value: '$first' }
                     ]
                   },
                   {
                     lines: [
-                      { label: 'Last Name', value: '$:last' }
+                      { label: 'Last Name', value: '$last' }
                     ]
                   }
                 ]
@@ -193,8 +193,8 @@ describe ::Proforma do
                 type: 'DataTable',
                 property: 'phone_numbers',
                 columns: [
-                  { header: 'Type', body: '$:type' },
-                  { header: 'Number', body: '$:number' }
+                  { header: 'Type', body: '$type' },
+                  { header: 'Number', body: '$number' }
                 ]
               },
               { type: 'Spacer' }
@@ -207,18 +207,7 @@ describe ::Proforma do
 
       expected_documents = [
         Proforma::Document.new(
-          contents: "========================================\nSystem A\n=================="\
-                    "======================\n555 N. Michigan Ave.\nChicago, IL 55555\n"\
-                    "555-555-5555 ext. 5132\n========================================\nUSER"\
-                    " LIST\n----------------------------------------\n\nID Number, First Name,"\
-                    " Last Name\n1, Matt, Smith\n2, Katie, Rizzo\n3, Nathan, Nathanson\n\nUSER"\
-                    " DETAILS\n----------------------------------------\n\nID Number: "\
-                    "1\nFirst Name: Matt\nLast Name: Smith\nType, Number\nMobile, 444-333-2222"\
-                    "\nHome, 444-333-2222\n\nUSER DETAILS\n-----------------------------------"\
-                    "-----\n\nID Number: 2\nFirst Name: Katie\nLast Name: Rizzo\nType, Number\n"\
-                    "Fax, 888-777-6666\n\nUSER DETAILS\n----------------------------------"\
-                    "------\n\nID Number: 3\nFirst Name: Nathan\nLast Name: "\
-                    "Nathanson\nType, Number\n\n",
+          contents: fixture('bringing_it_all_together.txt'),
           extension: '.txt',
           title: 'User Report'
         )

data/spec/spec_helper.rb

@@ -19,7 +19,9 @@ SimpleCov.start
 require './lib/proforma'
 
 def yaml_read(file)
-  # rubocop:disable Security/YAMLLoad
-  YAML.load(File.open(file))
-  # rubocop:enable Security/YAMLLoad
+  YAML.safe_load(File.open(file))
+end
+
+def fixture(file)
+  File.open(File.join('spec', 'fixtures', file)).read
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: proforma
 version: !ruby/object:Gem::Version
-  version: 1.0.0.pre.alpha
+  version: 1.0.0
 platform: ruby
 authors:
 - Matthew Ruggio
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-04-19 00:00:00.000000000 Z
+date: 2019-04-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: acts_as_hashable
@@ -138,9 +138,9 @@ files:
 - lib/proforma/compiling/aggregation.rb
 - lib/proforma/compiling/compilable.rb
 - lib/proforma/compiling/counter.rb
-- lib/proforma/core_ext/hash.rb
 - lib/proforma/document.rb
 - lib/proforma/hash_evaluator.rb
+- lib/proforma/hash_refinements.rb
 - lib/proforma/model_factory.rb
 - lib/proforma/modeling.rb
 - lib/proforma/modeling/banner.rb
@@ -169,9 +169,11 @@ files:
 - lib/proforma/type_factory.rb
 - lib/proforma/version.rb
 - proforma.gemspec
+- spec/fixtures/bringing_it_all_together.txt
 - spec/fixtures/snapshots/custom_table.yml
 - spec/fixtures/snapshots/user_details.yml
 - spec/fixtures/snapshots/user_list.yml
+- spec/proforma/compiling/counter_spec.rb
 - spec/proforma/hash_evaluator_spec.rb
 - spec/proforma/modeling/table/cell_spec.rb
 - spec/proforma/modeling/table/row_spec.rb
@@ -192,18 +194,20 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.3.8
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubygems_version: 3.0.1
 signing_key: 
 specification_version: 4
 summary: Configurable and extendable document rendering engine for datasets
 test_files:
+- spec/fixtures/bringing_it_all_together.txt
 - spec/fixtures/snapshots/custom_table.yml
 - spec/fixtures/snapshots/user_details.yml
 - spec/fixtures/snapshots/user_list.yml
+- spec/proforma/compiling/counter_spec.rb
 - spec/proforma/hash_evaluator_spec.rb
 - spec/proforma/modeling/table/cell_spec.rb
 - spec/proforma/modeling/table/row_spec.rb

data/lib/proforma/core_ext/hash.rb

@@ -1,21 +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
-  module CoreExt
-    # Monkey-patches for the core Hash class.  These will be manually mixed in separately.
-    module Hash
-      unless method_defined?(:symbolize_keys)
-        def symbolize_keys
-          map { |k, v| [k.to_sym, v] }.to_h
-        end
-      end
-    end
-  end
-end