proforma-extended-evaluator 1.0.0.pre.alpha → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 39f0512316231d5d6072f4a26afa88b956d2ae6f1a4b8cf2aa9d45fed2beaba0
-  data.tar.gz: f960a2c8956402fd065466c06468d8e8a3b8103a2f5274c72d35c7f8cbf62eec
+  metadata.gz: 3f978fa2a4a04564213b30c11f6b1353734dd8df889c047b989a385857aade8e
+  data.tar.gz: 75f683c4fb9689f6b081aa2b3f1d634cf3111d3c22c23d26481d82da8b6175e5
 SHA512:
-  metadata.gz: 7de610f73e925ab605818eb5db4472d2aa5c93f95772c8a4f90040301c6ba80929734a5196d19a6766991c3fdf42e78d0e991d4304fccb3d9f19705f5c820f9b
-  data.tar.gz: 98ad38935c497f6c3742d944a5084c6161ea8033a52095ea68d45a491553da3deba260da85b8b306fc8856fe085734c4c60b4b9ae27acf66b01c0fbbbab754d7
+  metadata.gz: 5da22925132f972ebf226007b8b0b191336db4fc6a1e91d7b1ecb26401eeb5baa9f02c97abc3c87ce4bd4622611a191f826b28295184c1e870fa2bbed2e9be03
+  data.tar.gz: f4e482ce9399c495a1ffd08bb5f81c000fb0ba2256c5d370de1ddcbae9fbc9c7b7feb37e056cd610187a25f2bce76db4ec1bdcadad6ff230205ffa93939b41b7

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+# 1.0.0 (April 24th, 2019)
+
+Publishing first release.
+
 # 1.0.0-alpha (April 19th, 2019)
 
 Publishing first candidate of initial release.

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    proforma-extended-evaluator (1.0.0.pre.alpha)
+    proforma-extended-evaluator (1.0.0)
       stringento (~> 2)
 
 GEM
@@ -46,7 +46,7 @@ GEM
     parser (2.6.0.0)
       ast (~> 2.4.0)
     powerpack (0.1.2)
-    proforma (1.0.0.pre.alpha)
+    proforma (1.0.0)
       acts_as_hashable (~> 1)
     pry (0.12.2)
       coderay (~> 1.1.0)
@@ -97,7 +97,7 @@ PLATFORMS
 
 DEPENDENCIES
   guard-rspec (~> 4.7)
-  proforma (>= 1.0.0.pre.alpha)
+  proforma (~> 1)
   proforma-extended-evaluator!
   pry (~> 0)
   rspec (~> 3.8)

data/README.md

@@ -2,7 +2,7 @@
 
 [![Gem Version](https://badge.fury.io/rb/proforma-extended-evaluator.svg)](https://badge.fury.io/rb/proforma-extended-evaluator) [![Build Status](https://travis-ci.org/bluemarblepayroll/proforma-extended-evaluator.svg?branch=master)](https://travis-ci.org/bluemarblepayroll/proforma-extended-evaluator) [![Maintainability](https://api.codeclimate.com/v1/badges/79e66b596906f633bc95/maintainability)](https://codeclimate.com/github/bluemarblepayroll/proforma-extended-evaluator/maintainability) [![Test Coverage](https://api.codeclimate.com/v1/badges/79e66b596906f633bc95/test_coverage)](https://codeclimate.com/github/bluemarblepayroll/proforma-extended-evaluator/test_coverage) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 
-The core Proforma library intentionally ships with a very weak evaluator.  Custom text templating and value resolution is not part of the core library's domain.  This library fills that void.  The goals of this library are to provide:
+The core [Proforma](https://github.com/bluemarblepayroll/proforma) library intentionally ships with a very weak evaluator.  Custom text templating and value resolution is not part of the core library's domain.  This library fills that void.  The goals of this library are to provide:
 
 1. Nested value resolution using dot-notation: `demographics.contact.first_name`
 2. Indifferent object types for value resolution: Hash, OpenStruct, any Object subclass, etc.
@@ -34,9 +34,9 @@ bundle add proforma-extended-evaluator
 
 ### Connecting to Proforma Rendering Pipeline
 
-To use this plugin within Proforma:
+To use this plugin within [Proforma](https://github.com/bluemarblepayroll/proforma):
 
-1. Install Proforma
+1. Install [Proforma](https://github.com/bluemarblepayroll/proforma)
 2. Install this library
 3. Require both libraries
 4. Pass in an instance of Proforma::ExtendedEvaluator into the Proforma#render method

data/lib/proforma/extended_evaluator.rb

@@ -8,6 +8,7 @@
 #
 
 require 'bigdecimal'
+require 'forwardable'
 require 'stringento'
 
 require_relative 'extended_evaluator/formatter'

data/lib/proforma/extended_evaluator/formatter.rb

@@ -13,47 +13,51 @@ module Proforma
     # plugged into Stringento to provide formatting for data types, such as: strings, dates,
     # currency, numbers, etc.
     class Formatter < Stringento::Formatter
+      extend Forwardable
+
       DEFAULTS = {
         currency_code: 'USD',
         currency_round: 2,
         currency_symbol: '$',
         date_format: '%m/%d/%Y',
+        decimal_separator: '.',
+        iso_date_format: '%Y-%m-%d',
         mask_char: 'X',
         false_value: 'No',
         null_value: 'Unknown',
-        true_value: 'Yes'
+        nullish_regex: /\A(nil|null)\z/i.freeze,
+        thousands_regex: /[0-9](?=(?:[0-9]{3})+(?![0-9]))/.freeze,
+        thousands_separator: ',',
+        true_value: 'Yes',
+        truthy_regex: /\A(true|t|yes|y|1)\z/i.freeze
       }.freeze
 
-      ISO_DATE_FORMAT           = '%Y-%m-%d'
-      NULLISH                   = /(nil|null)$/i.freeze
-      THOUSANDS_WITH_DECIMAL    = /(\d)(?=\d{3}+\.)/.freeze
-      THOUSANDS_WITHOUT_DECIMAL = /(\d)(?=\d{3}+$)/.freeze
-      TRUTHY                    = /(true|t|yes|y|1)$/i.freeze
-
-      attr_reader :currency_code,
-                  :currency_round,
-                  :currency_symbol,
-                  :date_format,
-                  :false_value,
-                  :mask_char,
-                  :null_value,
-                  :true_value
+      attr_reader :options
+
+      def_delegators  :options,
+                      :currency_code,
+                      :currency_round,
+                      :currency_symbol,
+                      :date_format,
+                      :decimal_separator,
+                      :iso_date_format,
+                      :false_value,
+                      :mask_char,
+                      :null_value,
+                      :nullish_regex,
+                      :thousands_regex,
+                      :thousands_separator,
+                      :truthy_regex,
+                      :true_value
 
       def initialize(opts = {})
-        opts = DEFAULTS.merge(opts)
-
-        @currency_code   = opts[:currency_code]
-        @currency_round  = opts[:currency_round]
-        @currency_symbol = opts[:currency_symbol]
-        @date_format     = opts[:date_format]
-        @false_value     = opts[:false_value]
-        @mask_char       = opts[:mask_char]
-        @null_value      = opts[:null_value]
-        @true_value      = opts[:true_value]
+        @options = OpenStruct.new(DEFAULTS.merge(opts))
       end
 
-      def left_mask_formatter(value, arg)
-        keep_last = arg.to_s.empty? ? 4 : arg.to_s.to_i
+      def left_mask_formatter(value, keep_last)
+        keep_last = keep_last.to_s.empty? ? 4 : keep_last.to_s.to_i
+
+        raise ArgumentError, "keep_last cannot be negative (#{keep_last})" if keep_last.negative?
 
         string_value = value.to_s
 
@@ -66,7 +70,7 @@ module Proforma
       def date_formatter(value, _arg)
         return '' if null_or_empty?(value)
 
-        date = Date.strptime(value.to_s, ISO_DATE_FORMAT)
+        date = Date.strptime(value.to_s, iso_date_format)
 
         date.strftime(date_format)
       end
@@ -82,16 +86,16 @@ module Proforma
         "#{prefix}#{formatted_value}#{suffix}"
       end
 
-      def number_formatter(value, arg)
-        decimal_places = arg.to_s.empty? ? 6 : arg.to_s.to_i
-
-        regex = decimal_places.positive? ? THOUSANDS_WITH_DECIMAL : THOUSANDS_WITHOUT_DECIMAL
+      def number_formatter(value, decimal_places)
+        decimal_places = decimal_places.to_s.empty? ? 6 : decimal_places.to_s.to_i
 
-        format("%0.#{decimal_places}f", value || 0).gsub(regex, '\1,')
+        format("%0.#{decimal_places}f", value || 0)
+          .gsub(thousands_regex, "\\0#{thousands_separator}")
+          .gsub('.', decimal_separator)
       end
 
-      def boolean_formatter(value, arg)
-        nullable = arg.to_s == 'nullable'
+      def boolean_formatter(value, nullable)
+        nullable = nullable.to_s == 'nullable'
 
         if nullable && nully?(value)
           null_value
@@ -117,11 +121,11 @@ module Proforma
 
       # rubocop:disable Style/DoubleNegation
       def nully?(val)
-        null_or_empty?(val) || !!(val.to_s =~ NULLISH)
+        null_or_empty?(val) || !!(val.to_s =~ nullish_regex)
       end
 
       def truthy?(val)
-        !!(val.to_s =~ TRUTHY)
+        !!(val.to_s =~ truthy_regex)
       end
       # rubocop:enable Style/DoubleNegation
     end

data/lib/proforma/extended_evaluator/resolver.rb

@@ -11,14 +11,26 @@ module Proforma
   class ExtendedEvaluator
     # This class is also meant to be plugged into Stringento to provide value resolution.
     class Resolver
-      DOT_NOTATION_SEPARATOR = '.'
+      DEFAULT_SEPARATOR = '.'
+
+      attr_reader :separator
+
+      def initialize(separator: DEFAULT_SEPARATOR)
+        @separator = separator.to_s
+      end
 
       def resolve(value, input)
-        traverse(input, value.to_s.split(DOT_NOTATION_SEPARATOR))
+        traverse(input, key_path(value))
       end
 
       private
 
+      def key_path(value)
+        return Array(value.to_s) if separator.empty?
+
+        value.to_s.split(separator)
+      end
+
       def traverse(object, through)
         pointer = object
 
@@ -35,7 +47,7 @@ module Proforma
         if object.is_a?(Hash)
           indifferent_hash_get(object, key)
         elsif object.respond_to?(key)
-          object.send(key)
+          object.public_send(key)
         end
       end
 

data/lib/proforma/extended_evaluator/version.rb

@@ -9,6 +9,6 @@
 
 module Proforma
   class ExtendedEvaluator
-    VERSION = '1.0.0-alpha'
+    VERSION = '1.0.0'
   end
 end

data/proforma-extended-evaluator.gemspec

@@ -25,7 +25,7 @@ Gem::Specification.new do |s|
   s.add_dependency('stringento', '~>2')
 
   s.add_development_dependency('guard-rspec', '~>4.7')
-  s.add_development_dependency('proforma', '>=1.0.0-alpha')
+  s.add_development_dependency('proforma', '~>1')
   s.add_development_dependency('pry', '~>0')
   s.add_development_dependency('rspec', '~> 3.8')
   s.add_development_dependency('rubocop', '~>0.63.1')

data/spec/proforma/extended_evaluator/formatter_spec.rb

@@ -10,6 +10,18 @@
 require 'spec_helper'
 
 describe Proforma::ExtendedEvaluator::Formatter do
+  let(:usa_formatter) { described_class.new }
+
+  let(:france_formatter) do
+    described_class.new(
+      currency_code: '€',
+      currency_round: 2,
+      currency_symbol: '',
+      decimal_separator: ',',
+      thousands_separator: ' '
+    )
+  end
+
   describe '#left_mask_formatter' do
     specify 'returns empty string if value is null' do
       expect(subject.left_mask_formatter(nil, '')).to eq('')
@@ -43,6 +55,10 @@ describe Proforma::ExtendedEvaluator::Formatter do
         expect(subject.left_mask_formatter('abcde',   arg)).to eq('XXXde')
         expect(subject.left_mask_formatter('abcdef',  arg)).to eq('XXXXef')
       end
+
+      specify 'raises ArgumentError for negative arg' do
+        expect { subject.left_mask_formatter(nil, -1) }.to raise_error(ArgumentError)
+      end
     end
   end
 
@@ -68,51 +84,63 @@ describe Proforma::ExtendedEvaluator::Formatter do
     end
   end
 
-  describe '#currency_formatter' do
-    subject do
-      described_class.new(
-        currency_code: 'USD',
-        currency_round: 2,
-        currency_symbol: '$'
-      )
-    end
+  describe '#number_formatter' do
+    context 'localized for USA (default)' do
+      subject { usa_formatter }
 
-    let(:arg) { '' }
+      let(:arg) { '3' }
 
-    specify 'returns empty string if value is null' do
-      expect(subject.currency_formatter(nil, '')).to eq('')
+      specify 'returns formatted number' do
+        expect(subject.number_formatter('12345.67899', arg)).to eq('12,345.679')
+        expect(subject.number_formatter('12345', arg)).to eq('12,345.000')
+      end
     end
 
-    specify 'returns empty string if value is empty string' do
-      expect(subject.currency_formatter('', '')).to eq('')
-    end
+    context 'localized for France' do
+      subject { france_formatter }
 
-    specify 'returns formatted currency' do
-      expect(subject.currency_formatter('12345.67', arg)).to eq('$12,345.67 USD')
+      let(:arg) { '3' }
+
+      specify 'returns formatted number' do
+        expect(subject.number_formatter('12345.67899', arg)).to eq('12 345,679')
+        expect(subject.number_formatter('12345', arg)).to eq('12 345,000')
+      end
     end
   end
 
-  describe '#number_formatter' do
-    subject do
-      described_class.new(
-        currency_code: 'USD',
-        currency_round: 2,
-        currency_symbol: '$'
-      )
-    end
+  describe '#currency_formatter' do
+    let(:arg) { '' }
 
-    let(:arg) { '3' }
+    context 'localized for USA (default)' do
+      subject { usa_formatter }
 
-    specify 'returns empty string if value is null' do
-      expect(subject.currency_formatter(nil, '')).to eq('')
-    end
+      specify 'returns empty string if value is null' do
+        expect(subject.currency_formatter(nil, arg)).to eq('')
+      end
 
-    specify 'returns empty string if value is empty string' do
-      expect(subject.currency_formatter('', '')).to eq('')
+      specify 'returns empty string if value is empty string' do
+        expect(subject.currency_formatter('', arg)).to eq('')
+      end
+
+      specify 'returns formatted currency' do
+        expect(subject.currency_formatter('12345.67', arg)).to eq('$12,345.67 USD')
+      end
     end
 
-    specify 'returns formatted number' do
-      expect(subject.number_formatter('12345.67899', arg)).to eq('12,345.679')
+    context 'localized for France' do
+      subject { france_formatter }
+
+      specify 'returns empty string if value is null' do
+        expect(subject.currency_formatter(nil, arg)).to eq('')
+      end
+
+      specify 'returns empty string if value is empty string' do
+        expect(subject.currency_formatter('', arg)).to eq('')
+      end
+
+      specify 'returns formatted currency' do
+        expect(subject.currency_formatter('12345.67', arg)).to eq('12 345,67 €')
+      end
     end
   end
 

data/spec/proforma/extended_evaluator_spec.rb

@@ -115,11 +115,20 @@ describe Proforma::ExtendedEvaluator do
 
     actual_documents = Proforma.render(data, template, evaluator: Proforma::ExtendedEvaluator.new)
 
+    expected_contents = <<~CONTENTS
+      DETAILS FOR: BOND, JAMES (1)
+      ID #: 1
+      First Name: James
+      Last Name: Bond
+      Social Security #: XXXXXXX6789
+      Birthdate: 05/14/1960
+      Smoker: No
+      Balance: $123.45 USD
+    CONTENTS
+
     expected_documents = [
       Proforma::Document.new(
-        contents: "DETAILS FOR: BOND, JAMES (1)\nID #: 1\nFirst Name: James\nLast Name:"\
-                  " Bond\nSocial Security #: XXXXXXX6789\nBirthdate: 05/14/1960\nSmoker:"\
-                  " No\nBalance: $123.45 USD\n",
+        contents: expected_contents,
         extension: '.txt',
         title: ''
       )

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: proforma-extended-evaluator
 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: stringento
@@ -42,16 +42,16 @@ dependencies:
   name: proforma
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.0.pre.alpha
+        version: '1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.0.pre.alpha
+        version: '1'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -168,9 +168,9 @@ 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: