proforma 1.0.0.pre.alpha

data/spec/proforma/hash_evaluator_spec.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 'spec_helper'
+
+describe Proforma::HashEvaluator do
+  let(:hash) { { id: 1, 'first' => 'Matt' } }
+
+  describe '#value' do
+    it 'should work with string keys' do
+      expect(subject.value(hash, 'first')).to eq(hash['first'])
+      expect(subject.value(hash, :first)).to  eq(hash['first'])
+    end
+
+    it 'should work with symbol keys' do
+      expect(subject.value(hash, 'id')).to  eq(hash[:id])
+      expect(subject.value(hash, :id)).to   eq(hash[:id])
+    end
+  end
+end

data/spec/proforma/modeling/table/cell_spec.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 'spec_helper'
+
+describe Proforma::Modeling::Table::Cell do
+  it 'should use defaults for all null attributes' do
+    cell = described_class.new
+
+    expect(cell.align).to eq(Proforma::Modeling::Types::Align::LEFT)
+    expect(cell.text).to eq('')
+    expect(cell.width).to be nil
+  end
+
+  it 'should parse width to float if value is not null' do
+    expect(described_class.new(width: '34').width).to eq(34.0)
+    expect(described_class.new(width: '').width).to eq(0)
+    expect(described_class.new(width: '3a4').width).to eq(3.0)
+  end
+end

data/spec/proforma/modeling/table/row_spec.rb

@@ -0,0 +1,42 @@
+# 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::Modeling::Table::Row do
+  it 'should respond_to cells' do
+    expect(subject.respond_to?(:cells)).to be true
+  end
+
+  it 'should respond_to cells=' do
+    expect(subject.respond_to?('cells=')).to be true
+  end
+
+  it 'should not respond_to doesnt_exist' do
+    expect(subject.respond_to?(:doesnt_exist)).to be false
+  end
+
+  describe '#method_missing' do
+    it 'should get cells' do
+      expect(subject.cells).to eq([])
+    end
+
+    it 'should set cells' do
+      cell = Proforma::Modeling::Table::Cell.new
+
+      subject.cells = cell
+
+      expect(subject.cells).to eq([cell])
+    end
+
+    it 'should default to super' do
+      expect { subject.doesnt_exist }.to raise_error(NoMethodError)
+    end
+  end
+end

data/spec/proforma_spec.rb

@@ -0,0 +1,230 @@
+# 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 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)
+
+      expected_documents = Proforma::Document.array(contents['documents'])
+
+      actual_documents = described_class.render(
+        contents['data'],
+        contents['template'],
+        evaluator: contents['evaluator'] || Proforma::HashEvaluator.new,
+        renderer: contents['renderer'] || Proforma::PlainTextRenderer.new
+      )
+
+      expect(actual_documents).to eq(expected_documents)
+    end
+  end
+
+  describe 'README examples' do
+    specify 'Getting Started: Rendering a List' do
+      data = [
+        { id: 1, first: 'Matt', last: 'Smith' },
+        { id: 2, first: 'Katie', last: 'Rizzo' },
+        { id: 3, first: 'Nathan', last: 'Nathanson' }
+      ]
+
+      template = {
+        title: 'User List',
+        children: [
+          {
+            type: 'DataTable',
+            columns: [
+              { header: 'ID Number', body: '$:id' },
+              { header: 'First Name', body: '$:first' },
+              { header: 'Last Name', body: '$:last' }
+            ]
+          }
+        ]
+      }
+
+      actual_documents = described_class.render(data, template)
+
+      expected_documents = [
+        Proforma::Document.new(
+          contents: "ID Number, First Name, Last Name\n1, Matt, Smith"\
+                    "\n2, Katie, Rizzo\n3, Nathan, Nathanson\n",
+          extension: '.txt',
+          title: 'User List'
+        )
+      ]
+
+      expect(actual_documents).to eq(expected_documents)
+    end
+
+    specify 'Rendering Records' do
+      data = [
+        { id: 1, first: 'Matt', last: 'Smith' },
+        { id: 2, first: 'Katie', last: 'Rizzo' },
+        { id: 3, first: 'Nathan', last: 'Nathanson' }
+      ]
+
+      template = {
+        title: 'User Details',
+        split: true, # notice the split directive here.
+        children: [
+          {
+            type: 'Pane',
+            columns: [
+              {
+                lines: [
+                  { label: 'ID Number', value: '$:id' },
+                  { label: 'First Name', value: '$:first' }
+                ]
+              },
+              {
+                lines: [
+                  { label: 'Last Name', value: '$:last' }
+                ]
+              }
+            ]
+          }
+        ]
+      }
+
+      actual_documents = Proforma.render(data, template)
+
+      expected_documents = [
+        Proforma::Document.new(
+          contents: "ID Number: 1\nFirst Name: Matt\nLast Name: Smith\n",
+          extension: '.txt',
+          title: 'User Details'
+        ),
+        Proforma::Document.new(
+          contents: "ID Number: 2\nFirst Name: Katie\nLast Name: Rizzo\n",
+          extension: '.txt',
+          title: 'User Details'
+        ),
+        Proforma::Document.new(
+          contents: "ID Number: 3\nFirst Name: Nathan\nLast Name: Nathanson\n",
+          extension: '.txt',
+          title: 'User Details'
+        )
+      ]
+
+      expect(actual_documents).to eq(expected_documents)
+    end
+
+    specify 'Bringing It All Together' do
+      data = [
+        {
+          id: 1,
+          first: 'Matt',
+          last: 'Smith',
+          phone_numbers: [
+            { type: 'Mobile', number: '444-333-2222' },
+            { type: 'Home', number: '444-333-2222' }
+          ]
+        },
+        {
+          id: 2,
+          first: 'Katie',
+          last: 'Rizzo',
+          phone_numbers: [
+            { type: 'Fax', number: '888-777-6666' }
+          ]
+        },
+        {
+          id: 3,
+          first: 'Nathan',
+          last: 'Nathanson',
+          phone_numbers: []
+        }
+      ]
+
+      template = {
+        title: 'User Report',
+        children: [
+          {
+            type: 'Banner',
+            title: 'System A',
+            details: "555 N. Michigan Ave.\nChicago, IL 55555\n555-555-5555 ext. 5132"
+          },
+          { type: 'Header', value: 'User List' },
+          { type: 'Separator' },
+          { type: 'Spacer' },
+          {
+            type: 'DataTable',
+            columns: [
+              { header: 'ID Number', body: '$:id' },
+              { header: 'First Name', body: '$:first' },
+              { header: 'Last Name', body: '$:last' }
+            ]
+          },
+          { type: 'Spacer' },
+          {
+            type: 'Grouping',
+            children: [
+              { type: 'Header', value: 'User Details' },
+              { type: 'Separator' },
+              { type: 'Spacer' },
+              {
+                type: 'Pane',
+                columns: [
+                  {
+                    lines: [
+                      { label: 'ID Number', value: '$:id' },
+                      { label: 'First Name', value: '$:first' }
+                    ]
+                  },
+                  {
+                    lines: [
+                      { label: 'Last Name', value: '$:last' }
+                    ]
+                  }
+                ]
+              },
+              {
+                type: 'DataTable',
+                property: 'phone_numbers',
+                columns: [
+                  { header: 'Type', body: '$:type' },
+                  { header: 'Number', body: '$:number' }
+                ]
+              },
+              { type: 'Spacer' }
+            ]
+          }
+        ]
+      }
+
+      actual_documents = Proforma.render(data, template)
+
+      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",
+          extension: '.txt',
+          title: 'User Report'
+        )
+      ]
+
+      expect(actual_documents).to eq(expected_documents)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,25 @@
+# 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 'yaml'
+
+require 'pry'
+
+require 'simplecov'
+require 'simplecov-console'
+SimpleCov.formatter = SimpleCov::Formatter::Console
+SimpleCov.start
+
+require './lib/proforma'
+
+def yaml_read(file)
+  # rubocop:disable Security/YAMLLoad
+  YAML.load(File.open(file))
+  # rubocop:enable Security/YAMLLoad
+end

metadata

@@ -0,0 +1,211 @@
+--- !ruby/object:Gem::Specification
+name: proforma
+version: !ruby/object:Gem::Version
+  version: 1.0.0.pre.alpha
+platform: ruby
+authors:
+- Matthew Ruggio
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-04-19 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: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.7'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.63.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.63.1
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.16.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.16.1
+- !ruby/object:Gem::Dependency
+  name: simplecov-console
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.2
+description: |2
+      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.
+email:
+- mruggio@bluemarblepayroll.com
+executables:
+- console
+- render
+extensions: []
+extra_rdoc_files: []
+files:
+- ".editorconfig"
+- ".gitignore"
+- ".rubocop.yml"
+- ".ruby-version"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- Guardfile
+- LICENSE
+- README.md
+- bin/console
+- bin/render
+- lib/proforma.rb
+- lib/proforma/compiling.rb
+- 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/model_factory.rb
+- lib/proforma/modeling.rb
+- lib/proforma/modeling/banner.rb
+- lib/proforma/modeling/collection.rb
+- lib/proforma/modeling/data_table.rb
+- lib/proforma/modeling/data_table/aggregator.rb
+- lib/proforma/modeling/data_table/column.rb
+- lib/proforma/modeling/generic_container.rb
+- lib/proforma/modeling/grouping.rb
+- lib/proforma/modeling/header.rb
+- lib/proforma/modeling/pane.rb
+- lib/proforma/modeling/pane/column.rb
+- lib/proforma/modeling/pane/line.rb
+- lib/proforma/modeling/separator.rb
+- lib/proforma/modeling/spacer.rb
+- lib/proforma/modeling/table.rb
+- lib/proforma/modeling/table/cell.rb
+- lib/proforma/modeling/table/row.rb
+- lib/proforma/modeling/table/section.rb
+- lib/proforma/modeling/text.rb
+- lib/proforma/modeling/types.rb
+- lib/proforma/modeling/types/align.rb
+- lib/proforma/plain_text_renderer.rb
+- lib/proforma/prototype.rb
+- lib/proforma/template.rb
+- lib/proforma/type_factory.rb
+- lib/proforma/version.rb
+- proforma.gemspec
+- spec/fixtures/snapshots/custom_table.yml
+- spec/fixtures/snapshots/user_details.yml
+- spec/fixtures/snapshots/user_list.yml
+- spec/proforma/hash_evaluator_spec.rb
+- spec/proforma/modeling/table/cell_spec.rb
+- spec/proforma/modeling/table/row_spec.rb
+- spec/proforma_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/bluemarblepayroll/proforma
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.8
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubygems_version: 3.0.1
+signing_key: 
+specification_version: 4
+summary: Configurable and extendable document rendering engine for datasets
+test_files:
+- spec/fixtures/snapshots/custom_table.yml
+- spec/fixtures/snapshots/user_details.yml
+- spec/fixtures/snapshots/user_list.yml
+- spec/proforma/hash_evaluator_spec.rb
+- spec/proforma/modeling/table/cell_spec.rb
+- spec/proforma/modeling/table/row_spec.rb
+- spec/proforma_spec.rb
+- spec/spec_helper.rb