proforma-extended-evaluator 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3f978fa2a4a04564213b30c11f6b1353734dd8df889c047b989a385857aade8e
-  data.tar.gz: 75f683c4fb9689f6b081aa2b3f1d634cf3111d3c22c23d26481d82da8b6175e5
+  metadata.gz: '0766348b86e6e72ebfa8e2cdc687305197d7d43cef2a490383c31fadc89194d7'
+  data.tar.gz: e6eaa3c6a0409e215b07550c9a584d3e705a44dd51877ccb890ade25fb4c6bb0
 SHA512:
-  metadata.gz: 5da22925132f972ebf226007b8b0b191336db4fc6a1e91d7b1ecb26401eeb5baa9f02c97abc3c87ce4bd4622611a191f826b28295184c1e870fa2bbed2e9be03
-  data.tar.gz: f4e482ce9399c495a1ffd08bb5f81c000fb0ba2256c5d370de1ddcbae9fbc9c7b7feb37e056cd610187a25f2bce76db4ec1bdcadad6ff230205ffa93939b41b7
+  metadata.gz: 5db01296ddeaf818e7323c765f49be7c632cdbfdf83b42231b6eaec82d44200f49e4f590be898943e05862a127cf6646ebba0d3ede76b71ee4c964e226eb6d90
+  data.tar.gz: 759bdaabe85547aa1047f4ff5218c0dcb5673f9867d3fd51bcf73afb0e5ad0f5a06ebcdea173205a9d2cb44a16d981183a18c78996f5ea7beafd4525b5ed279f

data/.rubocop.yml

@@ -3,6 +3,8 @@ Metrics/LineLength:
 
 Metrics/BlockLength:
   ExcludedMethods: ['let', 'it', 'describe', 'context', 'specify']
+  Exclude:
+    - proforma-extended-evaluator.gemspec
 
 Metrics/MethodLength:
   Max: 25

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+# 1.1.0 (May 7th, 2019)
+
+* Replaced resolver value resolution with Objectable library.
+
 # 1.0.0 (April 24th, 2019)
 
 Publishing first release.

data/Gemfile.lock

@@ -1,7 +1,8 @@
 PATH
   remote: .
   specs:
-    proforma-extended-evaluator (1.0.0)
+    proforma-extended-evaluator (1.1.0)
+      objectable (~> 1)
       stringento (~> 2)
 
 GEM
@@ -10,6 +11,7 @@ GEM
     acts_as_hashable (1.0.5)
     ansi (1.5.0)
     ast (2.4.0)
+    byebug (11.0.1)
     coderay (1.1.2)
     diff-lcs (1.3)
     docile (1.3.1)
@@ -42,6 +44,7 @@ GEM
     notiffany (0.1.1)
       nenv (~> 0.1)
       shellany (~> 0.0)
+    objectable (1.0.0)
     parallel (1.13.0)
     parser (2.6.0.0)
       ast (~> 2.4.0)
@@ -51,7 +54,11 @@ GEM
     pry (0.12.2)
       coderay (~> 1.1.0)
       method_source (~> 0.9.0)
+    pry-byebug (3.7.0)
+      byebug (~> 11.0)
+      pry (~> 0.10)
     rainbow (3.0.0)
+    rake (10.5.0)
     rb-fsevent (0.10.3)
     rb-inotify (0.9.10)
       ffi (>= 0.5.0, < 2)
@@ -100,6 +107,8 @@ DEPENDENCIES
   proforma (~> 1)
   proforma-extended-evaluator!
   pry (~> 0)
+  pry-byebug (~> 3)
+  rake (~> 10.0)
   rspec (~> 3.8)
   rubocop (~> 0.63.1)
   simplecov (~> 0.16.1)

data/Guardfile

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-guard :rspec, cmd: 'bundle exec rspec' do
+guard :rspec, cmd: 'DISABLE_SIMPLECOV=true bundle exec rspec --format=documentation' do
   require 'guard/rspec/dsl'
   dsl = Guard::RSpec::Dsl.new(self)
 

data/README.md

@@ -30,6 +30,12 @@ You can also add this to your Gemfile:
 bundle add proforma-extended-evaluator
 ````
 
+Note: If you are using bundler for auto-requiring then you need to specify as:
+
+```
+gem 'proforma-extended-evaluator', require: 'proforma/extended_evaluator'
+```
+
 ## Examples
 
 ### Connecting to Proforma Rendering Pipeline
@@ -116,16 +122,18 @@ Notice how all strings are properly formatted as prescribed in the template.
 
 Formatter options are biased towards USA localization.  You can override any of the options of the Formatter class, here are the options and their defaults:
 
-Option           | Default
----------------- | -------
-currency_code    | 'USD'
-currency_round   | 2
-currency_symbol  | '$'
-date_format      | '%m/%d/%Y'
-mask_char        | 'X'
-false_value      | 'No'
-null_value       | 'Unknown'
-true_value       | 'Yes'
+Option              | Default
+------------------- | -------
+currency_code       | 'USD'
+currency_round      | 2
+currency_symbol     | '$'
+date_format         | '%m/%d/%Y'
+decimal_separator   | '.'
+mask_char           | 'X'
+false_value         | 'No'
+null_value          | 'Unknown'
+thousands_separator | ','
+true_value          | 'Yes'
 
 ## Contributing
 
@@ -170,10 +178,7 @@ After code changes have successfully gone through the Pull Request review proces
 3. Install dependencies: `bundle`
 4. Update `CHANGELOG.md` with release notes
 5. Commit & push master to remote and ensure CI builds master successfully
-6. Build the project locally: `gem build proforma-extended-evaluator`
-7. Publish package to RubyGems: `gem push proforma-extended-evaluator-X.gem` where X is the version to push
-8. Tag master with new version: `git tag <version>`
-9. Push tags remotely: `git push origin --tags`
+6. Run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
 ## License
 

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/lib/proforma/extended_evaluator.rb

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

data/lib/proforma/extended_evaluator/resolver.rb

@@ -13,50 +13,14 @@ module Proforma
     class Resolver
       DEFAULT_SEPARATOR = '.'
 
-      attr_reader :separator
+      attr_reader :objectable_resolver
 
       def initialize(separator: DEFAULT_SEPARATOR)
-        @separator = separator.to_s
+        @objectable_resolver = Objectable.resolver(separator: separator)
       end
 
       def resolve(value, input)
-        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
-
-        through.each do |t|
-          next unless pointer
-
-          pointer = get(pointer, t)
-        end
-
-        pointer
-      end
-
-      def get(object, key)
-        if object.is_a?(Hash)
-          indifferent_hash_get(object, key)
-        elsif object.respond_to?(key)
-          object.public_send(key)
-        end
-      end
-
-      def indifferent_hash_get(hash, key)
-        if hash.key?(key.to_s)
-          hash[key.to_s]
-        elsif hash.key?(key.to_s.to_sym)
-          hash[key.to_s.to_sym]
-        end
+        objectable_resolver.get(input, value)
       end
     end
   end

data/lib/proforma/extended_evaluator/version.rb

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

data/proforma-extended-evaluator.gemspec

@@ -22,11 +22,14 @@ Gem::Specification.new do |s|
 
   s.required_ruby_version = '>= 2.3.8'
 
+  s.add_dependency('objectable', '~>1')
   s.add_dependency('stringento', '~>2')
 
   s.add_development_dependency('guard-rspec', '~>4.7')
   s.add_development_dependency('proforma', '~>1')
   s.add_development_dependency('pry', '~>0')
+  s.add_development_dependency('pry-byebug', '~> 3')
+  s.add_development_dependency 'rake', '~> 10.0'
   s.add_development_dependency('rspec', '~> 3.8')
   s.add_development_dependency('rubocop', '~>0.63.1')
   s.add_development_dependency('simplecov', '~>0.16.1')

data/spec/spec_helper.rb

@@ -7,13 +7,19 @@
 # LICENSE file in the root directory of this source tree.
 #
 
-require 'yaml'
-require 'pry'
 require 'proforma'
+require 'pry'
+require 'pry-byebug'
+require 'yaml'
+
+unless ENV['DISABLE_SIMPLECOV'] == 'true'
+  require 'simplecov'
+  require 'simplecov-console'
 
-require 'simplecov'
-require 'simplecov-console'
-SimpleCov.formatter = SimpleCov::Formatter::Console
-SimpleCov.start
+  SimpleCov.formatter = SimpleCov::Formatter::Console
+  SimpleCov.start do
+    add_filter %r{\A/spec/}
+  end
+end
 
 require './lib/proforma/extended_evaluator'

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: proforma-extended-evaluator
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Matthew Ruggio
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-04-25 00:00:00.000000000 Z
+date: 2019-05-07 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: objectable
+  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: stringento
   requirement: !ruby/object:Gem::Requirement
@@ -66,6 +80,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -143,6 +185,7 @@ files:
 - Guardfile
 - LICENSE
 - README.md
+- Rakefile
 - bin/console
 - lib/proforma/extended_evaluator.rb
 - lib/proforma/extended_evaluator/formatter.rb
@@ -150,7 +193,6 @@ files:
 - lib/proforma/extended_evaluator/version.rb
 - proforma-extended-evaluator.gemspec
 - spec/proforma/extended_evaluator/formatter_spec.rb
-- spec/proforma/extended_evaluator/resolver_spec.rb
 - spec/proforma/extended_evaluator_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/bluemarblepayroll/proforma-extended-evaluator
@@ -178,6 +220,5 @@ specification_version: 4
 summary: Proforma evaluator plugin for nested object value resolution and text templating
 test_files:
 - spec/proforma/extended_evaluator/formatter_spec.rb
-- spec/proforma/extended_evaluator/resolver_spec.rb
 - spec/proforma/extended_evaluator_spec.rb
 - spec/spec_helper.rb

data/spec/proforma/extended_evaluator/resolver_spec.rb

@@ -1,43 +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.
-#
-
-require 'spec_helper'
-
-describe Proforma::ExtendedEvaluator::Resolver do
-  subject { described_class.new }
-
-  context 'when input is a hash' do
-    let(:input) { { 'id' => 1, demographics: { 'first' => 'Matt' } } }
-
-    specify '#resolve gets correct value' do
-      expect(subject.resolve(:id, input)).to  eq(input['id'])
-      expect(subject.resolve('id', input)).to eq(input['id'])
-
-      expect(subject.resolve('demographics.first', input)).to eq(input.dig(:demographics, 'first'))
-    end
-  end
-
-  context 'when input is an OpenStruct' do
-    let(:input) do
-      OpenStruct.new(
-        id: 1,
-        demographics: OpenStruct.new(
-          first: 'Matt'
-        )
-      )
-    end
-
-    specify '#resolve gets correct value' do
-      expect(subject.resolve(:id, input)).to  eq(input.id)
-      expect(subject.resolve('id', input)).to eq(input.id)
-
-      expect(subject.resolve('demographics.first', input)).to eq(input.demographics.first)
-    end
-  end
-end