parameters_schema 1.0.2 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 14b2e93c33b07b2beb454f9b604f4f77e96da0e6
-  data.tar.gz: 64bb0eaf552948ddb687625ece733d4f8a08fe38
+  metadata.gz: 27f563b75284363c989baf6b54a932ff2297d4d0
+  data.tar.gz: 56f396dfe522de312289f5ab44dd638cde52e53f
 SHA512:
-  metadata.gz: a2eb862ee2b536e377f0177b70ca983f6b618fab0222fe89bf423ae4228eef6f5db87e4d8cde5defec8814d7a5180e6997198abe0ed016b0b3037573ff5ccdbc
-  data.tar.gz: 269810eec92651bbd6701a9df474cbd394b87a1428f2e417091aef4896ddc409d8baf1f9a5c05096901e821441564667ad540475679a67e73c09657dead4e605
+  metadata.gz: a3da599edadcc20dcc772b9ec3c4ac9d71d21653e49e49d6c97f6d13c359854424f4e03bfdd93fbd8861727ca494508c8b3cbd6a22ed6a2f5b97786e470a47e8
+  data.tar.gz: 29d4d87b1e4a17c948b7f9caaf691e96a0ce92d0823e4a8196cb301c1de0fedbedd336dbfc03c1afa97215c4991fbebb5d5971d6ab7600b527225f784511e41b

data/README.md

@@ -96,10 +96,17 @@ The valid options for a parameter are:
 * required  # Whether the parameter is required. Default: true.
 * type      # The type of the parameter. Default: String.
 * allow     # The allowed values of the parameter. Default: :any.
-* deny     # The denied values of the parameter. Default: :none.
+* deny      # The denied values of the parameter. Default: :none.
 * array     # Whether the parameter is an array. Default: false.
+* default   # Default value when the parameter is missing. Default: nil.
 ```
 
+Notes on `default` option:
+
+* When set, the `required` option becomes automatically `false`.
+* When set, the provided value is always kept in sanitized hash, even if the value is `nil`.
+* Cannot be used on a `array` or `hash` type (but can be used on the fields of an hash!).
+
 ### Parameter types
 
 The available types are:

data/lib/parameters_schema/schema.rb

@@ -19,7 +19,8 @@ module ParametersSchema
     private
 
     def param(name, options = {}, &inner_params)
-      options[:required] = !options.has_key?(:required) || options[:required].present?
+      options[:required] = (!options.has_key?(:required) || options[:required].present?) && !options.has_key?(:default)
+      options[:default_is_nil] = options.has_key?(:default) && options[:default].nil?
 
       options[:type] = [options[:type] || String].flatten
       options[:allow] = [options[:allow].present? ? options[:allow] : ParametersSchema::Options.any_keyword].flatten
@@ -119,8 +120,10 @@ module ParametersSchema
 
       if options[:required] && !options[:parent].has_key?(name)
         error = ParametersSchema::ErrorCode::MISSING
-      elsif options[:parent].has_key?(name)
+      elsif options[:parent].has_key?(name) && !options[:parent][name].nil?
         value = options[:parent][name]
+      else
+        value = options[:default]
       end
 
       [value, error]
@@ -129,7 +132,7 @@ module ParametersSchema
     def __validate_param_value_nil(value, options)
       error = nil
 
-      if !options[:allow].include?(ParametersSchema::Options.nil_keyword) && value.nil?
+      if !options[:default_is_nil] && !options[:allow].include?(ParametersSchema::Options.nil_keyword) && value.nil?
         error = ParametersSchema::ErrorCode::NIL
       end
 
@@ -227,13 +230,13 @@ module ParametersSchema
         error = ParametersSchema::ErrorCode::DISALLOWED unless value.respond_to?(:to_sym)
         value = value.to_sym if error.blank? # cast to right type.
       elsif type == Date
-        begin 
+        begin
           value = value.kind_of?(String) ? Date.parse(value) : value.to_date
         rescue
           error = ParametersSchema::ErrorCode::DISALLOWED
         end
       elsif type == DateTime
-        begin 
+        begin
           value = value.kind_of?(String) ? DateTime.parse(value) : value.to_datetime
         rescue
           error = ParametersSchema::ErrorCode::DISALLOWED
@@ -268,7 +271,14 @@ module ParametersSchema
     end
 
     def __stop_validation(name, value, error, options)
-      { param: name, error: error, value: value, keep_if_nil: options[:allow].include?(ParametersSchema::Options.nil_keyword) }
+      {
+        param: name,
+        error: error,
+        value: value,
+        keep_if_nil:
+          options[:allow].include?(ParametersSchema::Options.nil_keyword) ||
+          (value.nil? && options[:default_is_nil] )
+      }
     end
 
     def __handle_errors
@@ -293,4 +303,4 @@ module ParametersSchema
         end
     end
   end
-end
+end

data/test/test_schema_default_value.rb

@@ -0,0 +1,78 @@
+require 'minitest/autorun'
+require 'parameters_schema'
+require_relative 'helpers'
+
+describe 'Default value' do
+  before do
+    ParametersSchema::Options.reset_defaults
+  end
+
+  it 'doesnt keep the parameter when not explicitly set to nil' do
+    ParametersSchema::Schema.new do
+      param :potatoe, required: false
+    end
+      .validate!({})
+      .must_equal_hash({})
+  end
+
+  it 'keeps the parameter when explicitly set to nil' do
+    ParametersSchema::Schema.new do
+      param :potatoe, default: nil
+    end
+      .validate!({})
+      .must_equal_hash({ potatoe: nil })
+  end
+
+  it 'must be set to a value of the same type' do
+    ParametersSchema::Schema.new do
+      param :potatoe, default: 'Eramosa'
+    end
+      .validate!({})
+      .must_equal_hash({ potatoe: 'Eramosa' })
+
+    Proc.new do
+      ParametersSchema::Schema.new do
+        param :potatoe, type: Fixnum, default: 'Eramosa'
+      end
+        .validate!({})
+        .must_equal_hash({ potatoe: 'Eramosa' })
+    end
+      .must_raise(ParametersSchema::InvalidParameters)
+      .errors.must_equal_hash(potatoe: ParametersSchema::ErrorCode::DISALLOWED)
+  end
+
+  it 'keeps the value provided' do
+    ParametersSchema::Schema.new do
+      param :potatoe, default: nil
+    end
+      .validate!(potatoe: 'Eramosa')
+      .must_equal_hash({ potatoe: 'Eramosa' })
+  end
+
+  it 'works with complex values - array of hashes' do
+    ParametersSchema::Schema.new do
+      param :potatoes, array: true do
+        param :variety, default: 'Eramosa'
+        param :origin
+      end
+    end
+      .validate!(potatoes: [{ origin: 'NB' }, { origin: 'Canada' }])
+      .must_equal_hash(potatoes: [
+        { variety: 'Eramosa', origin: 'NB' },
+        { variety: 'Eramosa', origin: 'Canada' }
+      ])
+  end
+
+  it 'works with complex values - fields of hash' do
+    default_value = { variety: 'Eramosa', origin: 'New Brunswick' }
+
+    ParametersSchema::Schema.new do
+      param :potatoe do
+        param :variety, default: 'Eramosa'
+        param :origin, default: 'New Brunswick'
+      end
+    end
+      .validate!(potatoe: { origin: 'Canada' })
+      .must_equal_hash(potatoe: { variety: 'Eramosa', origin: 'Canada' })
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: parameters_schema
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.3
 platform: ruby
 authors:
 - Jodi Giordano
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-24 00:00:00.000000000 Z
+date: 2016-07-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -44,6 +44,7 @@ files:
 - test/test_schema_allow.rb
 - test/test_schema_allow_empty.rb
 - test/test_schema_allow_nil.rb
+- test/test_schema_default_value.rb
 - test/test_schema_hash.rb
 - test/test_schema_required.rb
 - test/test_schema_simple.rb