decanter 3.4.2 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c49220d0b25ab5f09d58aded4f247e71793d1f98129efebe336651c1e58303dd
-  data.tar.gz: b28b971df1dba14570abfcb9cb6116e13512afcb3412656be1c169af1ecef69a
+  metadata.gz: fa10b029acfb863227bd9b42b915f32ce94d65dd0a82955bc13b530d3278fe87
+  data.tar.gz: c22c844568de79508809ceb5609e8166cc547bfc26fa4a293085baae56ce6ade
 SHA512:
-  metadata.gz: 911b7de4eaf39749fbb1029016e00da3d72a7b0f46d828d6c1d9f9f49f945c51ab91bbefc4ef2fd45b1e69e2d488ec07b09358c29a5009d7222122047cf24785
-  data.tar.gz: 6acdf1923faec6984bb42884c47afb0574f94b65a12c1275953eb583c61a77b860074b3ef7b03bd157f3fa37e10fea8abf6bd358872fdce3dc614f3d16626323
+  metadata.gz: 1df6bc91a47bc1dbbf9a528b895407fed1d84cdf733121aff44440d03b4fe82a8871143d1b2d0bb87b6c9cfb1467c0a839cb394ac0bd813e5df7230faa00b9a4
+  data.tar.gz: 9e26fe9068e2f58d4ae8b1987a05fde413e9edac2bd0f123add82c7dfcb18f50a9d08629b71fb2c1d2d0387668f32ecfc53bda6a7e5a93d07289d96f8bbc5eaf

data/Gemfile.lock

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

data/README.md

@@ -3,7 +3,7 @@
 Decanter is a Ruby gem that makes it easy to transform incoming data before it hits the model. You can think of Decanter as the opposite of Active Model Serializers (AMS). While AMS transforms your outbound data into a format that your frontend consumes, Decanter transforms your incoming data into a format that your backend consumes.
 
 ```ruby
-gem 'decanter', '~> 3.0'
+gem 'decanter', '~> 4.0'
 ```
 
 ## Migration Guides
@@ -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/parser/float_parser.rb

@@ -1,7 +1,7 @@
 module Decanter
   module Parser
     class FloatParser < ValueParser
-      REGEX = /(\d|[.])/
+      REGEX = /(\d|[.]|[-])/
 
       allow Float, Integer
 

data/lib/decanter/parser/integer_parser.rb

@@ -1,7 +1,7 @@
 module Decanter
   module Parser
     class IntegerParser < ValueParser
-      REGEX = /(\d|[.])/
+      REGEX = /(\d|[.]|[-])/
 
       allow Integer
 

data/lib/decanter/version.rb

@@ -1,3 +1,3 @@
 module Decanter
-  VERSION = '3.4.2'.freeze
+  VERSION = '4.0.0'.freeze
 end

data/lib/decanter.rb

@@ -57,7 +57,6 @@ end
 
 require 'decanter/version'
 require 'decanter/configuration'
-require 'decanter/core'
 require 'decanter/base'
 require 'decanter/extensions'
 require 'decanter/exceptions'

data/migration-guides/v4.0.0.md

@@ -0,0 +1,35 @@
+# v4.0.0 Migration Guide
+
+_Note: this guide assumes you are upgrading from decanter v3 to v4._
+
+This version contains the following breaking changes:
+
+1. `FloatParser` and `IntegerParser` have been updated to address a bug where negative numbers were being parsed as positive. In the (unlikely) event that your project was relying on the previous behavior, you can pin the gem version to `v3.6.0` or include the legacy version(s) of the parsers as custom parsers in your project.
+
+To add a custom parser, add the new parser class to your project:
+
+```rb
+# app/parsers/postive_float_parser.rb
+
+class PositiveFloatParser < Decanter::Parser::ValueParser
+  REGEX = /(\d|[.])/
+
+  allow Float, Integer
+
+  parser do |val, options|
+    raise Decanter::ParseError.new 'Expects a single value' if val.is_a? Array
+    next if (val.nil? || val === '')
+    val.scan(REGEX).join.try(:to_f)
+  end
+end
+```
+
+Then, use the appropriate key to look up the parser in your decanter:
+
+```rb
+# app/decanters/product_decanter.rb
+
+class ProductDecanter <  Decanter::Base
+  input :price, :positive_float #=> PositiveFloatParser
+end
+```

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: decanter
 version: !ruby/object:Gem::Version
-  version: 3.4.2
+  version: 4.0.0
 platform: ruby
 authors:
 - Ryan Francis
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-01-05 00:00:00.000000000 Z
+date: 2021-11-23 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
@@ -182,6 +183,7 @@ files:
 - lib/generators/rails/templates/decanter.rb.erb
 - lib/generators/rails/templates/parser.rb.erb
 - migration-guides/v3.0.0.md
+- migration-guides/v4.0.0.md
 homepage: https://github.com/launchpadlab/decanter
 licenses:
 - MIT