decanter 3.2.1 → 3.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8bcc235910fd86ed830c20f5c07f53b3154911cb26aec56d45fece483207d4bd
-  data.tar.gz: a9db5721c34fdd0c9857ce8647ad84b2a4bbfdb6b1b76f67fe4e5a8b1650d9d2
+  metadata.gz: 47761a57539196c1be8d4de3b4f18a78a0e133bdace720e4363dfc2a4ab5776c
+  data.tar.gz: caccc39b0926d5f39a29673a912fab356079fb67357b868cc4f803b325988890
 SHA512:
-  metadata.gz: 170e5256eda3f2b36f259f6f475420218c1a04aa360f553a0fb0f74479c28469a521e32fbfb852521d8c84e5dc22d754f7455e66e18702493b303b285cb1f7a6
-  data.tar.gz: 35a01b51460f2f831a40e52fc5f11a8e800b5e50eeb08d0623f8241d72f00b5f20e1543235904083e793b0be76a02c1378c4f31edbb4b3934fa155b01f409b92
+  metadata.gz: d7ee0004606f84e64e0b94697d1ff035f54b96ceb3dddc1f0a77c716ad17c566b9b959f78a67cfa6c40598c337db4464c62c26d2d394a749183bec915cad3d44
+  data.tar.gz: 6aecb9eb64b1bd282de2d29a3828fe131fa01227c50b8b5ff69049cb08184497435d9f67ab95f71dacf8120e072ff813b00dac497e81772396f249b0e8a74327

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.lock

@@ -1,9 +1,9 @@
 PATH
   remote: .
   specs:
-    decanter (3.2.1)
+    decanter (3.5.0)
       actionpack (>= 4.2.10)
-      activesupport (~> 5.2)
+      activesupport
       rails-html-sanitizer (>= 1.0.4)
 
 GEM

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:
@@ -112,7 +144,11 @@ input :start_date, :date, parse_format: '%Y-%m-%d'
 
 ### Exceptions
 
-By default, `Decanter#decant` will raise an exception when unexpected parameters are passed. To override this behavior, you can disable strict mode:
+By default, `Decanter#decant` will raise an exception when unexpected parameters are passed. To override this behavior, you can change the strict mode option to one of:
+
+- `true` (default): unhandled keys will raise an unexpected parameters exception
+- `false`: all parameter key-value pairs will be included in the result
+- `:ignore`: unhandled keys will be excluded from the decanted result
 
 ```ruby
 class TripDecanter <  Decanter::Base

data/decanter.gemspec

@@ -28,7 +28,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_dependency 'actionpack', '>= 4.2.10'
-  spec.add_dependency 'activesupport', '~> 5.2'
+  spec.add_dependency 'activesupport'
   spec.add_dependency 'rails-html-sanitizer', '>= 1.0.4'
 
   spec.add_development_dependency 'bundler', '~> 1.9'

data/lib/decanter.rb

@@ -13,7 +13,7 @@ module Decanter
           klass_or_sym.to_s.singularize.camelize
         else
           raise ArgumentError.new("cannot lookup decanter for #{klass_or_sym} with class #{klass_or_sym.class}")
-        end.concat('Decanter')
+        end + 'Decanter'
       begin
         decanter_name.constantize
       rescue
@@ -62,4 +62,4 @@ require 'decanter/base'
 require 'decanter/extensions'
 require 'decanter/exceptions'
 require 'decanter/parser'
-require 'decanter/railtie' if defined?(::Rails)
+require 'decanter/railtie' if defined?(::Rails)

data/lib/decanter/core.rb

@@ -1,24 +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
@@ -46,21 +46,23 @@ module Decanter
       end
 
       def ignore(*args)
-        keys_to_ignore.push(*args)
+        keys_to_ignore.push(*args).map!(&:to_sym)
       end
 
       def strict(mode)
-        raise(ArgumentError, "#{self.name}: Unknown strict value #{mode}") unless [true, false].include? mode
+        raise(ArgumentError, "#{self.name}: Unknown strict value #{mode}") unless [:ignore, true, false].include? mode
         @strict_mode = mode
       end
 
       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'
+
+        # 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(args) )
-          .merge( handled_keys(args) )
+          .merge( unhandled_keys(accessible_args) )
+          .merge( handled_keys(accessible_args) )
       end
 
       def default_keys
@@ -69,8 +71,9 @@ module Decanter
           .map { |input| [input[:key], input[:options][DEFAULT_VALUE_KEY]] }
           .to_h
 
-        # parse default values
-        handled_keys(default_result)
+        # parse handled default values, including keys
+        # with defaults not already managed by handled_keys
+        default_result.merge(handled_keys(default_result))
       end
 
       def default_value_inputs
@@ -119,14 +122,21 @@ module Decanter
             .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 }
+
+        case strict_mode
+        when :ignore
+          p "#{self.name} ignoring unhandled keys: #{unhandled_keys.join(', ')}."
+          {}
+        when true
+          raise(UnhandledKeysError, "#{self.name} received unhandled keys: #{unhandled_keys.join(', ')}.")
+        else
+          args.select { |key| unhandled_keys.include? key.to_sym }
+        end
       end
 
       def handled_keys(args)
         arg_keys = args.keys.map(&:to_sym)
         inputs, assocs = handlers.values.partition { |handler| handler[:type] == :input }
-
         {}.merge(
           # Inputs
           inputs.select     { |handler| (arg_keys & handler[:name]).any? }
@@ -227,6 +237,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.2.1'.freeze
+  VERSION = '3.5.0'.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.2.1
+  version: 3.5.0
 platform: ruby
 authors:
 - Ryan Francis
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-11-03 00:00:00.000000000 Z
+date: 2021-01-23 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: '5.2'
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rails-html-sanitizer
   requirement: !ruby/object:Gem::Requirement