decanter 3.1.0 → 3.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1518df774602ffe66ea5fe6b9ee101f74644876b9ae8417f575828c8b9ffc961
-  data.tar.gz: a9e2201a3df589f2664b565313f1c74d70ae9c4cd3e9c9836aad4507e8a11418
+  metadata.gz: b7ee762570171d13eede776ea7715f54e3daa9228e09b8a83f278c857eaeb04c
+  data.tar.gz: 4dee8cfa404faeb3362925832d53b4e55c0f82cddd2427416c0fdf79a66ff85e
 SHA512:
-  metadata.gz: ae0d8395af236b8487af2812fd05a778f806055e1167d6635f2d91a4f25d07ccc62067423375fbb3e4da1d58c01d4affb4861b62c9a0a2220c30bae709ef7125
-  data.tar.gz: 935eab7ccb2ef88db8e01b4faefae22b84d65c5264925432684ae5d67e222bddb0c796672de0d9e4606176f3c321654a220246e889565819cc9116e01a4ce5b5
+  metadata.gz: dd1b076ac0cbe78783ab19b4ae43d8fb7d87bd46b76155ec08dcbdfb55638415667c1ad19ccdeff4f81e0b0482c2ef32292a1686df648ee52e0b3ce4824ea069
+  data.tar.gz: d34c06b627f4c1b4773829cd9e3003f3a8eb167a97acfa55be361628078d8230d8be1664d576d49eb6de9705d56f95c478ff52c56c2c656b1882d167df69e499

data/.github/CODEOWNERS

@@ -0,0 +1,2 @@
+# These owners will be the default owners for everything in the repo.
+* @chawes13

data/.github/PULL_REQUEST_TEMPLATE.md

@@ -4,5 +4,5 @@
 ## Author Checklist
 - [ ] Add unit test(s)
 - [ ] Update documentation (if necessary)
-- [ ] Update version in `version.rb` following [versioning guidelines](https://github.com/LaunchPadLab/opex/blob/master/gists/gem-guidelines.md#pull-requests-and-deployments)
+- [ ] Update version in `version.rb` following [versioning guidelines](https://github.com/LaunchPadLab/opex-public/blob/master/gists/gem-guidelines.md#pull-requests-and-deployments)
 

data/CONTRIBUTING.md

@@ -1,6 +1,6 @@
 # Contributing
 
-Thanks for your interest in contributing! This project follows our [Gem guidelines](https://github.com/LaunchPadLab/opex/blob/master/gists/gem-guidelines.md).
+Thanks for your interest in contributing! This project follows our [Gem guidelines](https://github.com/LaunchPadLab/opex-public/blob/master/gists/gem-guidelines.md).
 
 ## Code of Conduct
 

data/Gemfile

@@ -1,4 +1,4 @@
 source 'https://rubygems.org'
 
-# Specify your gem's dependencies in goaltender.gemspec
+# Specify your gem's dependencies in decanter.gemspec
 gemspec

data/Gemfile.lock

@@ -1,90 +1,90 @@
 PATH
   remote: .
   specs:
-    decanter (3.1.0)
+    decanter (3.3.0)
       actionpack (>= 4.2.10)
-      activesupport
+      activesupport (~> 5.2)
       rails-html-sanitizer (>= 1.0.4)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    actionpack (5.1.4)
-      actionview (= 5.1.4)
-      activesupport (= 5.1.4)
-      rack (~> 2.0)
+    actionpack (5.2.4.4)
+      actionview (= 5.2.4.4)
+      activesupport (= 5.2.4.4)
+      rack (~> 2.0, >= 2.0.8)
       rack-test (>= 0.6.3)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.0, >= 1.0.2)
-    actionview (5.1.4)
-      activesupport (= 5.1.4)
+    actionview (5.2.4.4)
+      activesupport (= 5.2.4.4)
       builder (~> 3.1)
       erubi (~> 1.4)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.0, >= 1.0.3)
-    activesupport (5.1.4)
+    activesupport (5.2.4.4)
       concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (~> 0.7)
+      i18n (>= 0.7, < 2)
       minitest (~> 5.1)
       tzinfo (~> 1.1)
-    builder (3.2.3)
-    concurrent-ruby (1.0.5)
-    crass (1.0.4)
-    diff-lcs (1.3)
+    builder (3.2.4)
+    concurrent-ruby (1.1.7)
+    crass (1.0.6)
+    diff-lcs (1.4.4)
     docile (1.1.5)
     dotenv (2.2.1)
-    erubi (1.7.0)
-    i18n (0.9.3)
+    erubi (1.9.0)
+    i18n (1.8.5)
       concurrent-ruby (~> 1.0)
-    json (2.1.0)
-    loofah (2.2.2)
+    json (2.3.0)
+    loofah (2.7.0)
       crass (~> 1.0.2)
       nokogiri (>= 1.5.9)
-    method_source (0.9.0)
-    mini_portile2 (2.3.0)
-    minitest (5.11.3)
-    nokogiri (1.8.5)
-      mini_portile2 (~> 2.3.0)
-    rack (2.0.4)
-    rack-test (0.8.2)
+    method_source (1.0.0)
+    mini_portile2 (2.4.0)
+    minitest (5.14.2)
+    nokogiri (1.10.10)
+      mini_portile2 (~> 2.4.0)
+    rack (2.2.3)
+    rack-test (1.1.0)
       rack (>= 1.0, < 3)
     rails-dom-testing (2.0.3)
       activesupport (>= 4.2.0)
       nokogiri (>= 1.6)
-    rails-html-sanitizer (1.0.4)
-      loofah (~> 2.2, >= 2.2.2)
-    railties (5.1.4)
-      actionpack (= 5.1.4)
-      activesupport (= 5.1.4)
+    rails-html-sanitizer (1.3.0)
+      loofah (~> 2.3)
+    railties (5.2.4.4)
+      actionpack (= 5.2.4.4)
+      activesupport (= 5.2.4.4)
       method_source
       rake (>= 0.8.7)
-      thor (>= 0.18.1, < 2.0)
-    rake (10.5.0)
-    rspec-core (3.7.1)
-      rspec-support (~> 3.7.0)
-    rspec-expectations (3.7.0)
+      thor (>= 0.19.0, < 2.0)
+    rake (12.3.3)
+    rspec-core (3.9.3)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.3)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.7.0)
-    rspec-mocks (3.7.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.7.0)
-    rspec-rails (3.7.2)
+      rspec-support (~> 3.9.0)
+    rspec-rails (3.9.1)
       actionpack (>= 3.0)
       activesupport (>= 3.0)
       railties (>= 3.0)
-      rspec-core (~> 3.7.0)
-      rspec-expectations (~> 3.7.0)
-      rspec-mocks (~> 3.7.0)
-      rspec-support (~> 3.7.0)
-    rspec-support (3.7.1)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.4)
     simplecov (0.15.1)
       docile (~> 1.1.0)
       json (>= 1.8, < 3)
       simplecov-html (~> 0.10.0)
     simplecov-html (0.10.2)
-    thor (0.20.0)
+    thor (1.0.1)
     thread_safe (0.3.6)
-    tzinfo (1.2.5)
+    tzinfo (1.2.7)
       thread_safe (~> 0.1)
 
 PLATFORMS
@@ -94,8 +94,8 @@ DEPENDENCIES
   bundler (~> 1.9)
   decanter!
   dotenv
-  rake (~> 10.0)
-  rspec-rails
+  rake (~> 12.0)
+  rspec-rails (~> 3.9)
   simplecov (~> 0.15.1)
 
 BUNDLED WITH

data/README.md

@@ -220,6 +220,25 @@ end
 
 _Note: we recommend using [Active Record validations](https://guides.rubyonrails.org/active_record_validations.html) to check for presence of an attribute, rather than using the `required` option. This method is intended for use in non-RESTful routes or cases where Active Record validations are not available._
 
+
+### Default values
+
+If you provide the option `:default_value` for an input in your decanter, the input key will be initialized with the given default value. Input keys not found in the incoming data parameters will be set to the provided default rather than ignoring the missing key. Note: `nil` and empty keys will not be overridden.
+
+```ruby
+class TripDecanter <  Decanter::Base
+  input :name, :string
+  input :destination, :string, default_value: 'Chicago'
+end
+
+```
+
+```
+TripDecanter.decant({ name: 'Vacation 2020' })
+=> { name: 'Vacation 2020', destination: 'Chicago' }
+
+```
+
 ### Global configuration
 
 You can generate a local copy of the default configuration with `rails generate decanter:install`. This will create an initializer where you can do global configuration:

data/decanter.gemspec

@@ -28,12 +28,12 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_dependency 'actionpack', '>= 4.2.10'
-  spec.add_dependency 'activesupport'
+  spec.add_dependency 'activesupport', '~> 5.2'
   spec.add_dependency 'rails-html-sanitizer', '>= 1.0.4'
 
   spec.add_development_dependency 'bundler', '~> 1.9'
   spec.add_development_dependency 'dotenv'
-  spec.add_development_dependency 'rake', '~> 10.0'
-  spec.add_development_dependency 'rspec-rails'
+  spec.add_development_dependency 'rake', '~> 12.0'
+  spec.add_development_dependency 'rspec-rails', '~> 3.9'
   spec.add_development_dependency 'simplecov', '~> 0.15.1'
 end

data/lib/decanter/core.rb

@@ -1,23 +1,25 @@
 module Decanter
   module Core
-    
+    DEFAULT_VALUE_KEY = :default_value
+    ACTION_CONTROLLER_PARAMETERS_CLASS_NAME = 'ActionController::Parameters'
+
     def self.included(base)
       base.extend(ClassMethods)
     end
 
     module ClassMethods
-      
-      def input(name, parsers=nil, **options)
 
-        _name = [name].flatten
+      def input(name, parsers=nil, **options)
+        # Convert all input names to symbols to correctly calculate handled vs. unhandled keys
+        input_names = [name].flatten.map(&:to_sym)
 
-        if _name.length > 1 && parsers.blank?
+        if input_names.length > 1 && parsers.blank?
           raise ArgumentError.new("#{self.name} no parser specified for input with multiple values.")
         end
 
-        handlers[_name] = {
-          key:     options.fetch(:key, _name.first),
-          name:    _name,
+        handlers[input_names] = {
+          key:     options.fetch(:key, input_names.first),
+          name:    input_names,
           options: options,
           parsers:  parsers,
           type:    :input
@@ -45,7 +47,7 @@ module Decanter
       end
 
       def ignore(*args)
-        keys_to_ignore.push(*args)
+        keys_to_ignore.push(*args).map!(&:to_sym)
       end
 
       def strict(mode)
@@ -56,12 +58,29 @@ module Decanter
       def decant(args)
         return handle_empty_args if args.blank?
         return empty_required_input_error unless required_input_keys_present?(args)
-        args = args.to_unsafe_h.with_indifferent_access if args.class.name == 'ActionController::Parameters'
-        {}.merge( unhandled_keys(args) )
-          .merge( handled_keys(args) )
+
+        # Convert all params passed to a decanter to a hash with indifferent access to mitigate accessor ambiguity
+        accessible_args = to_indifferent_hash(args)
+        {}.merge( default_keys )
+          .merge( unhandled_keys(accessible_args) )
+          .merge( handled_keys(accessible_args) )
       end
 
-      def handle_empty_args    
+      def default_keys
+        # return keys with provided default value when key is not defined within incoming args
+        default_result = default_value_inputs
+          .map { |input| [input[:key], input[:options][DEFAULT_VALUE_KEY]] }
+          .to_h
+
+        # parse default values
+        handled_keys(default_result)
+      end
+
+      def default_value_inputs
+        handlers.values.select { |input| input[:options].key?(DEFAULT_VALUE_KEY) }
+      end
+
+      def handle_empty_args
         any_inputs_required? ? empty_args_error : {}
       end
 
@@ -73,7 +92,7 @@ module Decanter
         handlers.map do |h|
           options = h.last[:options]
           h.first.first if options && options[:required]
-        end  
+        end
       end
 
       def required_input_keys_present?(args={})
@@ -100,11 +119,11 @@ module Decanter
           keys_to_ignore -
           handlers.values
             .select { |handler| handler[:type] != :input }
-            .map { |handler| "#{handler[:name]}_attributes".to_sym }            
+            .map { |handler| "#{handler[:name]}_attributes".to_sym }
 
         return {} unless unhandled_keys.any?
         raise(UnhandledKeysError, "#{self.name} received unhandled keys: #{unhandled_keys.join(', ')}.") if strict_mode
-        args.select { |key| unhandled_keys.include? key }
+        args.select { |key| unhandled_keys.include? key.to_sym }
       end
 
       def handled_keys(args)
@@ -185,13 +204,13 @@ module Decanter
       def parse(key, parsers, value, options)
         return { key => value } unless parsers
         if options[:required] && value_missing?(value)
-          raise ArgumentError.new("No value for required argument: #{key}") 
+          raise ArgumentError.new("No value for required argument: #{key}")
         end
         parser_classes = Parser.parsers_for(parsers)
         Parser.compose_parsers(parser_classes).parse(key, value, options)
       end
 
-      def handlers        
+      def handlers
         @handlers ||= {}
       end
 
@@ -211,6 +230,10 @@ module Decanter
         value.nil? || value == ""
       end
 
+      def to_indifferent_hash(args)
+        return args.to_unsafe_h if args.class.name == ACTION_CONTROLLER_PARAMETERS_CLASS_NAME
+        args.to_h.with_indifferent_access
+      end
     end
   end
 end

data/lib/decanter/version.rb

@@ -1,3 +1,3 @@
 module Decanter
-  VERSION = '3.1.0'.freeze
+  VERSION = '3.3.0'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: decanter
 version: !ruby/object:Gem::Version
-  version: 3.1.0
+  version: 3.3.0
 platform: ruby
 authors:
 - Ryan Francis
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-04-16 00:00:00.000000000 Z
+date: 2020-11-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -29,16 +29,16 @@ dependencies:
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '5.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '5.2'
 - !ruby/object:Gem::Dependency
   name: rails-html-sanitizer
   requirement: !ruby/object:Gem::Requirement
@@ -87,28 +87,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.0'
 - !ruby/object:Gem::Dependency
   name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.9'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -132,6 +132,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".codeclimate.yml"
+- ".github/CODEOWNERS"
 - ".github/ISSUE_TEMPLATE/BUG_REPORT.md"
 - ".github/ISSUE_TEMPLATE/FEATURE_REQUEST.md"
 - ".github/PULL_REQUEST_TEMPLATE.md"