decanter 3.1.2 → 3.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fb694b13aa7696d65c4608fcf10a1d1d23af16f00be59d8728596c126d97bf31
-  data.tar.gz: 233c7c16256e602b0cb1e9307f2ca4b9fadc91539ddb69d71ce1e68ba71f90c3
+  metadata.gz: 91c0d17331090df0653fd6750102bddf1506bd74f73920e8a4281d61cf3190b0
+  data.tar.gz: 620711a2e9819afe1a66055b41e70afdfb113b637362053784d53cc79df4f541
 SHA512:
-  metadata.gz: 9509797f7e4c1c9000c5d0bb1c500ad91bfefd51d2c8e06975bace2010bd944b21c02eedeccd9d3d76b9deb0a55843875473478ed5f188ab439b5778f29df605
-  data.tar.gz: 83372fc430c9fad63051ad53405bb922c9f8f451e4902b095c2a3feaa1440069400154064c5da8f0b331a494d89baed54e2de0c7ed122338ab1f6d7721095c48
+  metadata.gz: 2da563150e6a55e066f08200245175b69e8d404e4a56a99af1ea9a211ff4d3f140feec4658d97c0e09ea8f7e73f42e08d819f36e2fbac0815852fb629142bce1
+  data.tar.gz: a03440c46bb573f6e42692b2eea31d576e57495bdb0d54f6cc1b1722b973496c251de053e92c0ed56614fa35d912c5b14f2e1782ffe879c3b17c0891bbc4dbf0

data/CONTRIBUTING.md

@@ -33,4 +33,4 @@ For any non-trivial change, we prefer an issue to be created first. This helps u
 ### Sending a Pull Request
 If this is your first Pull Request, we recommend learning how to navigate GitHub via this free video tutorial: [How to Contribute to an Open Source Project on GitHub](https://egghead.io/courses/how-to-contribute-to-an-open-source-project-on-github).
 
-The LaunchPad Lab team monitors this repository for pull requests. Once a pull request has been created from a forked repository that **meets all the guidelines** outlined in the [Pull Request Checklist](.github/PULL_REQUEST_TEMPLATE.md), we will review the request and either merge it, request changes, or close it with an explanation. We aim to respond to pull requests within 48 hours. 
+The LaunchPad Lab team monitors this repository for pull requests. Once a pull request has been created from a forked repository that **meets all the guidelines** outlined in the [Pull Request Checklist](.github/PULL_REQUEST_TEMPLATE.md), we will review the request and either merge it, request changes, or close it with an explanation. We aim to respond to pull requests within 48 hours.

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,7 +1,7 @@
 PATH
   remote: .
   specs:
-    decanter (3.1.2)
+    decanter (3.4.1)
       actionpack (>= 4.2.10)
       activesupport
       rails-html-sanitizer (>= 1.0.4)
@@ -9,82 +9,82 @@ PATH
 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

@@ -15,6 +15,7 @@ gem 'decanter', '~> 3.0'
 - [Basic Usage](#basic-usage)
   - [Decanters](#decanters)
   - [Generators](#generators)
+  - [Decanting Collections](#decanting-collections)
   - [Nested resources](#nested-resources)
   - [Default parsers](#default-parsers)
   - [Parser options](#parser-options)
@@ -70,6 +71,37 @@ rails g decanter Trip name:string start_date:date end_date:date
 rails g parser TruncatedString
 ```
 
+### Decanting Collections
+
+Decanter can decant a collection of a resource, applying the patterns used in the [fast JSON API gem](https://github.com/Netflix/fast_jsonapi#collection-serialization):
+
+```rb
+# app/controllers/trips_controller.rb
+
+  def create
+    trip_params = {
+      trips: [
+        { name: 'Disney World', start_date: '12/24/2018', end_date: '12/28/2018' },
+        { name: 'Yosemite', start_date: '5/1/2017', end_date: '5/4/2017' }
+      ]
+    }
+    decanted_trip_params = TripDecanter.decant(trip_params[:trips])
+    Trip.create(decanted_trip_params) # bulk create trips with decanted params
+  end
+```
+
+#### Control Over Decanting Collections
+
+You can use the `is_collection` option for explicit control over decanting collections.
+
+`decanted_trip_params = TripDecanter.decant(trip_params[:trips], is_collection: true)`
+
+If this option is not provided, autodetect logic is used to determine if the providing incoming params holds a single object or collection of objects.
+
+- `nil` or not provided: will try to autodetect single vs collection
+- `true` will always treat the incoming params args as *collection*
+- `false` will always treat incoming params args as *single object*
+
 ### Nested resources
 
 Decanters can declare relationships using `ActiveRecord`-style declarators:
@@ -220,6 +252,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

@@ -33,7 +33,7 @@ Gem::Specification.new do |spec|
 
   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,24 @@
 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)
+        # Convert all input names to symbols to correctly calculate handled vs. unhandled keys
+        input_names = [name].flatten.map(&:to_sym)
 
-        _name = [name].flatten
-
-        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 +46,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 +57,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 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    
+      def handle_empty_args
         any_inputs_required? ? empty_args_error : {}
       end
 
@@ -73,7 +91,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 +118,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 +203,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 +229,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/extensions.rb

@@ -20,7 +20,6 @@ module Decanter
     end
 
     module ClassMethods
-
       def decant_create(args, **options)
         self.new(decant(args, options))
             .save(context: options[:context])
@@ -36,12 +35,28 @@ module Decanter
       end
 
       def decant(args, options={})
+        is_collection?(args, options[:is_collection]) ? decant_collection(args, options) : decant_args(args, options)
+      end
+
+      def decant_collection(args, options)
+        args.map { |resource| decant_args(resource, options) }
+      end
+
+      def decant_args(args, options)
         if specified_decanter = options[:decanter]
           Decanter.decanter_from(specified_decanter)
         else
           Decanter.decanter_for(self)
         end.decant(args)
       end
+
+      private
+
+      # leveraging the approach used in the [fast JSON API gem](https://github.com/Netflix/fast_jsonapi#collection-serialization)
+      def is_collection?(args, collection_option=nil)
+        return collection_option[:is_collection] unless collection_option.nil?
+        args.respond_to?(:size) && !args.respond_to?(:each_pair)
+      end
     end
 
     module ActiveRecordExtensions

data/lib/decanter/version.rb

@@ -1,3 +1,3 @@
 module Decanter
-  VERSION = '3.1.2'.freeze
+  VERSION = '3.4.1'.freeze
 end

data/lib/generators/rails/decanter_generator.rb

@@ -2,12 +2,12 @@ module Rails
   module Generators
     class DecanterGenerator < NamedBase
       source_root File.expand_path('../templates', __FILE__)
-      check_class_collision :suffix => 'Decanter'
+      check_class_collision suffix: 'Decanter'
       ASSOCIATION_TYPES = [:has_many, :has_one, :belongs_to]
 
-      argument :attributes, :type => :array, :default => [], :banner => 'field:type field:type'
+      argument :attributes, type: :array, default: [], banner: 'field:type field:type'
 
-      class_option :parent, :type => :string, :desc => 'The parent class for the generated decanter'
+      class_option :parent, type: :string, desc: 'The parent class for the generated decanter'
 
       def create_decanter_file
         template 'decanter.rb.erb', File.join('app/decanters', class_path, "#{file_name}_decanter.rb")

data/lib/generators/rails/parser_generator.rb

@@ -2,9 +2,9 @@ module Rails
   module Generators
     class ParserGenerator < NamedBase
       source_root File.expand_path('../templates', __FILE__)
-      check_class_collision :suffix => 'Parser'
+      check_class_collision suffix: 'Parser'
 
-      class_option :parent, :type => :string, :desc => 'The parent class for the generated parser'
+      class_option :parent, type: :string, desc: 'The parent class for the generated parser'
 
       def create_parser_file
         template 'parser.rb.erb', File.join('lib/decanter/parsers', class_path, "#{file_name}_parser.rb")

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: decanter
 version: !ruby/object:Gem::Version
-  version: 3.1.2
+  version: 3.4.1
 platform: ruby
 authors:
 - Ryan Francis
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-10-05 00:00:00.000000000 Z
+date: 2020-11-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -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