stronger_parameters 2.10.1 → 2.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8fd58b7c7abd50d4c49328bd4c1ed5f394a30d0e713605ef853772cbb3a48d65
-  data.tar.gz: 755ada7e832133b1c797df0265e5e3b765af8106866c031f8de738a46f84f7d5
+  metadata.gz: 598d8d30678b80a1fff8224887b69dacd1975b8c3849f123961b3514a643e6e3
+  data.tar.gz: d80b6fa97333c507ab7e2282ed78e22260c352f528d50f434340afdd206b2c3a
 SHA512:
-  metadata.gz: 196c792377887933facef2fb25632bb5d6641e848786a821b4f4cfb254a5b04dfe2f12f9ebbb66928ada0a1ed69a6001f725708c7b9f2e2d613e14d5f83db489
-  data.tar.gz: d0bb7384ec7ad0a419564c42f4610867dae7948ac630261b63fd73ac32c1d22661bffe2577be5f1fa82669fe9c8b5fd401b2f23a6848272d17003b2b42c120fa
+  metadata.gz: b8f5201eeb8a1eb53a58f6eaacae23d40f08dcdb28da8ba9c650f607c19d126e5eea951a788fedc6cd82f0b4e9a020385952662ea6f44655f65e0c992e89b6e4
+  data.tar.gz: 932b7e76c8d86afefe1aa9d5cfdbf9af19ea2f784ed678e469bebde5761cd6317fd39075e86a029cc13ed5f2ce1a4fe3221775c48f4ff765db30e86e74593bfe

data/README.md

@@ -1,5 +1,5 @@
 # stronger_parameters
-[![Build Status](https://travis-ci.org/zendesk/stronger_parameters.svg?branch=master)](https://travis-ci.org/zendesk/stronger_parameters)
+![CI](https://github.com/zendesk/stronger_parameters/workflows/CI/badge.svg)
 
 This is an extension of `strong_parameters` with added type checking and conversion.
 
@@ -32,6 +32,27 @@ Rails converts empty arrays to nil, so often `Parameters.array | Parameters.nil`
 It can be convenient to allow nil for all attributes since ActiveRecord converts it to false/0.
 `ActionController::Parameters.allow_nil_for_everything = true`
 
+### Rejecting nils
+
+You can reject a request that fails to supply certain parameters by marking them
+as required with the `.required` operator:
+
+```ruby
+params.permit(
+  name: Parameters.string.required, # will not accept a nil or a non-String
+  email: Parameters.string          # optional, may be omitted
+)
+```
+
+This also works in conjunction with the `&` and `|` constraints. For example, to
+express that a `uid` must be either a string or a number:
+
+```ruby
+params.permit(
+  uid: (Parameters.string | Parameters.integer).required
+)
+```
+
 ## Nested Parameters
 
 ```ruby
@@ -228,6 +249,7 @@ curl -I 'http://localhost/api/users/1.json' -X POST -d '{ "user": { "id": 1 } }'
 | Parameters.integer             | value.is_a?(Fixnum) or '-1'                                                                |
 | Parameters.float               | value.is_a?(Float) or '-1.2'                                                               |
 | Parameters.datetime            | value.is_a?(DateTime) or '2014-05-13' or '2015-03-31T14:34:56Z'                            |
+| Parameters.datetime_iso8601    | value is a date that conforms to ISO8601: '2014-05-13' or '2015-03-31T14:34:56Z'           |
 | Parameters.regexp(/foo/)       | value =~ regexp                                                                            |
 | Parameters.enum('asc', 'desc') | ['asc', 'desc'].include?(value)                                                            |
 | Parameters.lt(10)              | value < 10                                                                                 |

data/lib/stronger_parameters.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 require 'stronger_parameters/version'
 require 'action_pack'
-require 'strong_parameters' if ActionPack::VERSION::MAJOR == 3
 require 'stronger_parameters/parameters'
 require 'stronger_parameters/constraints'
 require 'stronger_parameters/controller_support/permitted_parameters'

data/lib/stronger_parameters/constraint.rb

@@ -18,6 +18,14 @@ module StrongerParameters
     def ==(other)
       self.class == other.class
     end
+
+    def required
+      RequiredConstraint.new(self)
+    end
+
+    def required?
+      false
+    end
   end
 
   class OrConstraint < Constraint
@@ -50,6 +58,10 @@ module StrongerParameters
     def ==(other)
       super && constraints == other.constraints
     end
+
+    def required?
+      constraints.all?(&:required?)
+    end
   end
 
   class AndConstraint < Constraint
@@ -75,5 +87,23 @@ module StrongerParameters
     def ==(other)
       super && constraints == other.constraints
     end
+
+    def required?
+      constraints.any?(&:required?)
+    end
+  end
+
+  class RequiredConstraint < Constraint
+    def initialize(other)
+      @other = other
+    end
+
+    def value(v)
+      @other.value(v)
+    end
+
+    def required?
+      true
+    end
   end
 end

data/lib/stronger_parameters/constraints.rb

@@ -3,6 +3,7 @@ require 'stronger_parameters/constraint'
 require 'stronger_parameters/constraints/string_constraint'
 require 'stronger_parameters/constraints/float_constraint'
 require 'stronger_parameters/constraints/date_time_constraint'
+require 'stronger_parameters/constraints/date_time_iso8601_constraint'
 require 'stronger_parameters/constraints/regexp_constraint'
 require 'stronger_parameters/constraints/integer_constraint'
 require 'stronger_parameters/constraints/nil_constraint'

data/lib/stronger_parameters/constraints/array_constraint.rb

@@ -14,6 +14,7 @@ module StrongerParameters
         return v.map do |item|
           result = item_constraint.value(item)
           return result if result.is_a?(InvalidValue)
+
           result
         end
       end

data/lib/stronger_parameters/constraints/date_time_constraint.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:disable Style/DateTime
 require 'stronger_parameters/constraint'
 
 module StrongerParameters
@@ -15,4 +14,3 @@ module StrongerParameters
     end
   end
 end
-# rubocop:enable Style/DateTime

data/lib/stronger_parameters/constraints/date_time_iso8601_constraint.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+require 'stronger_parameters/constraint'
+
+module StrongerParameters
+  class DateTimeIso8601Constraint < Constraint
+    def value(v)
+      DateTime.iso8601 v
+    rescue ArgumentError, TypeError
+      StrongerParameters::InvalidValue.new(v, "must be an iso8601 date")
+    end
+  end
+end

data/lib/stronger_parameters/constraints/regexp_constraint.rb

@@ -13,6 +13,7 @@ module StrongerParameters
     def value(v)
       v = @string.value(v)
       return v if v.is_a?(InvalidValue)
+
       if v =~ regexp
         v
       else

data/lib/stronger_parameters/parameters.rb

@@ -1,12 +1,8 @@
 # frozen_string_literal: true
 require 'action_pack'
 
-if ActionPack::VERSION::MAJOR == 3
-  require 'action_controller/parameters'
-else
-  require 'action_controller/base'
-  require 'action_controller/metal/strong_parameters'
-end
+require 'action_controller/base'
+require 'action_controller/metal/strong_parameters'
 
 require 'stronger_parameters/constraints'
 require 'stronger_parameters/errors'
@@ -112,6 +108,10 @@ module StrongerParameters
         DateTimeConstraint.new
       end
 
+      def datetime_iso8601
+        DateTimeIso8601Constraint.new
+      end
+
       def file
         FileConstraint.new
       end
@@ -139,14 +139,25 @@ module StrongerParameters
 
       hash_filter_without_stronger_parameters(params, other_filter)
 
-      slice(*stronger_filter.keys).each do |key, value|
+      stronger_filter.keys.each do |key|
+        value = fetch(key, nil)
+        result = nil
+
         if value.nil? && self.class.allow_nil_for_everything
-          params[key] = nil
+          params[key] = nil if key?(key)
           next
         end
 
         constraint = stronger_filter[key]
-        result = constraint.value(value)
+
+        if key?(key)
+          result = constraint.value(value)
+        elsif constraint.required?
+          result = InvalidValue.new(nil, 'must be present')
+        else
+          next
+        end
+
         if result.is_a?(InvalidValue)
           name = "invalid_parameter.action_controller"
           ActiveSupport::Notifications.publish(name, key: key, value: value, message: result.message)

data/lib/stronger_parameters/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module StrongerParameters
-  VERSION = '2.10.1'
+  VERSION = '2.13.0'
 end

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: stronger_parameters
 version: !ruby/object:Gem::Version
-  version: 2.10.1
+  version: 2.13.0
 platform: ruby
 authors:
 - Mick Staugaard
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-04-10 00:00:00.000000000 Z
+date: 2020-12-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - "<="
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - "<="
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '3'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -94,20 +94,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: wwtd
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: bump
   requirement: !ruby/object:Gem::Requirement
@@ -170,20 +156,20 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '4.2'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '5.3'
+        version: '6.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '4.2'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '5.3'
+        version: '6.2'
 description: 
 email:
 - mick@zendesk.com
@@ -199,6 +185,7 @@ files:
 - lib/stronger_parameters/constraints/boolean_constraint.rb
 - lib/stronger_parameters/constraints/comparison_constraints.rb
 - lib/stronger_parameters/constraints/date_time_constraint.rb
+- lib/stronger_parameters/constraints/date_time_iso8601_constraint.rb
 - lib/stronger_parameters/constraints/decimal_constraint.rb
 - lib/stronger_parameters/constraints/enumeration_constraint.rb
 - lib/stronger_parameters/constraints/file_constraint.rb
@@ -226,15 +213,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.2.0
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.1.3
 signing_key: 
 specification_version: 4
 summary: Type checking and type casting of parameters for Action Pack