decanter 3.1.2 → 3.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fb694b13aa7696d65c4608fcf10a1d1d23af16f00be59d8728596c126d97bf31
-  data.tar.gz: 233c7c16256e602b0cb1e9307f2ca4b9fadc91539ddb69d71ce1e68ba71f90c3
+  metadata.gz: bb1e68fce23331df62b4e65bbdb40368a80bf077dd0b7685aa7486be180da948
+  data.tar.gz: 01b15f9d9c510b58575045fa1a726519a8729db05cf330dfc4f100de57a2b3f0
 SHA512:
-  metadata.gz: 9509797f7e4c1c9000c5d0bb1c500ad91bfefd51d2c8e06975bace2010bd944b21c02eedeccd9d3d76b9deb0a55843875473478ed5f188ab439b5778f29df605
-  data.tar.gz: 83372fc430c9fad63051ad53405bb922c9f8f451e4902b095c2a3feaa1440069400154064c5da8f0b331a494d89baed54e2de0c7ed122338ab1f6d7721095c48
+  metadata.gz: c1a36d91c8ba49a573c0b40caf11a45a7f2ea7c8b2891e69d314cee7564f463fe165db76acc9a0e8e77e1f5850e01e06c7f8153ac7dd48e41c1513acabe1e9af
+  data.tar.gz: c57d191795ed8fe7209b058b526aee19d0441360475448245e57119d56177681e3c0e351be2101ecce37d1ad0e4b3e6f33b5a60af86df253cefe902292851da0

data/Gemfile.lock

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

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/lib/decanter/core.rb

@@ -1,12 +1,13 @@
 module Decanter
   module Core
-    
+    DEFAULT_VALUE_KEY = :default_value
+
     def self.included(base)
       base.extend(ClassMethods)
     end
 
     module ClassMethods
-      
+
       def input(name, parsers=nil, **options)
 
         _name = [name].flatten
@@ -57,11 +58,26 @@ module Decanter
         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( default_keys )
+          .merge( unhandled_keys(args) )
           .merge( handled_keys(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 +89,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,7 +116,7 @@ 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
@@ -185,13 +201,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
 

data/lib/decanter/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: decanter
 version: !ruby/object:Gem::Version
-  version: 3.1.2
+  version: 3.2.0
 platform: ruby
 authors:
 - Ryan Francis