decanter 3.4.1 → 3.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 91c0d17331090df0653fd6750102bddf1506bd74f73920e8a4281d61cf3190b0
-  data.tar.gz: 620711a2e9819afe1a66055b41e70afdfb113b637362053784d53cc79df4f541
+  metadata.gz: 697f969bd6cdcac1487d237135cd4f1860ff9aa79abece975305d7ca7f0d5504
+  data.tar.gz: 7ab9d647d3c90e9c5186f4f0b486115b3d17f3107990a7984827d87e2f4843f8
 SHA512:
-  metadata.gz: 2da563150e6a55e066f08200245175b69e8d404e4a56a99af1ea9a211ff4d3f140feec4658d97c0e09ea8f7e73f42e08d819f36e2fbac0815852fb629142bce1
-  data.tar.gz: a03440c46bb573f6e42692b2eea31d576e57495bdb0d54f6cc1b1722b973496c251de053e92c0ed56614fa35d912c5b14f2e1782ffe879c3b17c0891bbc4dbf0
+  metadata.gz: 286e79ac8ebdbd3b75cc667fadd77b2fc6966f54274f06e282fc9d94250cf3075eb2f6a9e31295f1d51efb50b1b5757507de98cc6816a23b9871af7c3e32ab2a
+  data.tar.gz: b4cfff1c6ba4acc7f3244674e6d2a741dfbee1d5e03cdf392365bcbe4ba684f4592e1921143e7041e28d600b67cc1814110ac973c809bbea5c076a872092c652

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    decanter (3.4.1)
+    decanter (3.6.0)
       actionpack (>= 4.2.10)
       activesupport
       rails-html-sanitizer (>= 1.0.4)

data/README.md

@@ -101,6 +101,7 @@ If this option is not provided, autodetect logic is used to determine if the pro
 - `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*
+- `truthy` will raise an error
 
 ### Nested resources
 
@@ -144,7 +145,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
@@ -275,11 +280,14 @@ TripDecanter.decant({ name: 'Vacation 2020' })
 
 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:
 
+Setting strict mode to :ignore will log out any unhandled keys. To avoid excessive logging, the global configuration can be set to `log_unhandled_keys = false`
+
 ```ruby
 # ./config/initializers/decanter.rb
 
 Decanter.config do |config|
   config.strict = false
+  config.log_unhandled_keys = false
 end
 ```
 

data/lib/decanter/base.rb

@@ -1,7 +1,9 @@
 require 'decanter/core'
+require 'decanter/collection_detection'
 
 module Decanter
   class Base
     include Core
+    include CollectionDetection
   end
 end

data/lib/decanter/collection_detection.rb

@@ -0,0 +1,26 @@
+module Decanter
+  module CollectionDetection
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+
+    module ClassMethods
+      def decant(args, **options)
+        return super(args) unless collection?(args, options[:is_collection])
+
+        args.map { |resource| super(resource) }
+      end
+
+      private
+
+      # leveraging the approach used in the [fast JSON API gem](https://github.com/Netflix/fast_jsonapi#collection-serialization)
+      def collection?(args, collection_option = nil)
+        raise(ArgumentError, "#{name}: Unknown collection option value: #{collection_option}") unless [true, false, nil].include? collection_option
+
+        return collection_option unless collection_option.nil?
+
+        args.respond_to?(:size) && !args.respond_to?(:each_pair)
+      end
+    end
+  end
+end

data/lib/decanter/configuration.rb

@@ -1,10 +1,11 @@
 module Decanter
   class Configuration
 
-    attr_accessor :strict
+    attr_accessor :strict, :log_unhandled_keys
 
     def initialize
       @strict = true
+      @log_unhandled_keys = true
     end
   end
 end

data/lib/decanter/core.rb

@@ -50,10 +50,15 @@ module Decanter
       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 log_unhandled_keys(mode)
+        raise(ArgumentError, "#{self.name}: Unknown log_unhandled_keys value #{mode}") unless [true, false].include? mode
+        @log_unhandled_keys_mode = mode
+      end
+
       def decant(args)
         return handle_empty_args if args.blank?
         return empty_required_input_error unless required_input_keys_present?(args)
@@ -71,8 +76,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
@@ -121,14 +127,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.to_sym }
+
+        case strict_mode
+        when :ignore
+          p "#{self.name} ignoring unhandled keys: #{unhandled_keys.join(', ')}." if log_unhandled_keys_mode
+          {}
+        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? }
@@ -221,6 +234,11 @@ module Decanter
         @strict_mode.nil? ? Decanter.configuration.strict : @strict_mode
       end
 
+      def log_unhandled_keys_mode
+        return !!(Decanter.configuration.log_unhandled_keys) if @log_unhandled_keys_mode.nil?
+        !!@log_unhandled_keys_mode
+      end
+
       # Helpers
 
       private

data/lib/decanter/extensions.rb

@@ -1,6 +1,5 @@
 module Decanter
   module Extensions
-
     def self.included(base)
       base.extend(ClassMethods)
     end
@@ -34,29 +33,13 @@ module Decanter
             .save!(context: options[:context])
       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]
+      def decant(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.4.1'.freeze
+  VERSION = '3.6.0'.freeze
 end

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
@@ -57,9 +57,8 @@ end
 
 require 'decanter/version'
 require 'decanter/configuration'
-require 'decanter/core'
 require 'decanter/base'
 require 'decanter/extensions'
 require 'decanter/exceptions'
 require 'decanter/parser'
-require 'decanter/railtie' if defined?(::Rails)
+require 'decanter/railtie' if defined?(::Rails)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: decanter
 version: !ruby/object:Gem::Version
-  version: 3.4.1
+  version: 3.6.0
 platform: ruby
 authors:
 - Ryan Francis
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-11-18 00:00:00.000000000 Z
+date: 2021-09-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -152,6 +152,7 @@ files:
 - decanter.gemspec
 - lib/decanter.rb
 - lib/decanter/base.rb
+- lib/decanter/collection_detection.rb
 - lib/decanter/configuration.rb
 - lib/decanter/core.rb
 - lib/decanter/exceptions.rb