stronger_parameters 2.11.1 → 2.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 46343e25829800aec85852ba31fbbf040dce9b6071ff53acb04475e524f64cef
-  data.tar.gz: c4fd41f9cfef6bcfa16d350ca41e00981f583d92697b081afa121e12114a8454
+  metadata.gz: ca4cebd1c17a7cb7e68ae01c2fa676c492ab16cbf11998e563e0520c7c0f3bc5
+  data.tar.gz: 5a2b40548e74d16db1cdc99426bc44db551c2430a1c1bad8e2425566e18cff43
 SHA512:
-  metadata.gz: 5d51dcdbfbaf4a60af24536aedce0f0be8a2ba8da5f8d7cf9b517bc25113645623302a630688bd8d20f82cf1a34a42a8fabd1d9a75982451324bbb83a81a2bd7
-  data.tar.gz: 7332fac5079c83ac64df9e08b3a6b1abaceba349c99cb4b0c6936089d7928f39f0181c1c444316f8b6577b3c6b267d3e68c60a5a6385680beaebda09d34544ee
+  metadata.gz: 13c0e6268b1a9e6567f874c131a038b947047f277db0f581d8f775da9da23ff2170fc1a3a8df8bcd1bedb21cfbbb030f89a4ec55685956be3e4e48176ee20f72
+  data.tar.gz: 0eee3ab73de87a06429c6a86242261fc3344d267de36aa26c2921c594aeed36866ac939b303254927cafd284edca2f05408a81b04ea2393fbc89621dd9a07a19

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

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/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

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

data/lib/stronger_parameters/constraints/integer_constraint.rb

@@ -6,7 +6,7 @@ module StrongerParameters
     def value(v)
       if v.is_a?(Integer)
         return v
-      elsif v.is_a?(String) && v =~ /\A-?\d+\Z/
+      elsif v.is_a?(String) && v.strip =~ /\A-?\d+\Z/
         return v.to_i
       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/controller_support/permitted_parameters.rb

@@ -15,9 +15,7 @@ module StrongerParameters
         when Array
           ActionController::Parameters.array(*value.map { |v| sugar(v) })
         when Hash
-          constraints = value.each_with_object({}) do |(key, v), memo|
-            memo[key] = sugar(v)
-          end
+          constraints = value.transform_values { |v| sugar(v) }
           ActionController::Parameters.map(constraints)
         else
           value
@@ -63,8 +61,7 @@ module StrongerParameters
           return :skip if for_action == :skip
 
           # FYI: we should be able to call sugar on the result of deep_merge, but it breaks tests
-          permit_parameters[:all].deep_merge(for_action).
-            each_with_object({}) { |(k, v), a| a[k] = PermittedParameters.sugar(v) }
+          permit_parameters[:all].deep_merge(for_action).transform_values { |v| PermittedParameters.sugar(v) }
         end
 
         private

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'
@@ -143,14 +139,24 @@ module StrongerParameters
 
       hash_filter_without_stronger_parameters(params, other_filter)
 
-      slice(*stronger_filter.keys).each do |key, value|
+      stronger_filter.each_key do |key|
+        value = fetch(key, 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)
@@ -191,5 +197,5 @@ module StrongerParameters
   end
 end
 
-ActionController::Parameters.send :include, StrongerParameters::Parameters
-ActionController::Base.send :include, StrongerParameters::ControllerSupport
+ActionController::Parameters.include StrongerParameters::Parameters
+ActionController::Base.include StrongerParameters::ControllerSupport

data/lib/stronger_parameters/version.rb

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

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'

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: stronger_parameters
 version: !ruby/object:Gem::Version
-  version: 2.11.1
+  version: 2.14.0
 platform: ruby
 authors:
 - Mick Staugaard
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-05-29 00:00:00.000000000 Z
+date: 2021-11-10 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
@@ -38,20 +38,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: minitest
-  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: minitest-rails
   requirement: !ruby/object:Gem::Requirement
@@ -67,21 +53,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: minitest-around
-  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: minitest-rg
+  name: maxitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -95,7 +67,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: wwtd
+  name: bump
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -109,7 +81,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: bump
+  name: single_cov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -123,7 +95,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: single_cov
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -137,7 +109,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: mocha
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -151,7 +123,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: mocha
+  name: forking_test_runner
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -170,20 +142,20 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '4.2'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6.1'
+        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: '6.1'
+        version: '6.2'
 description: 
 email:
 - mick@zendesk.com
@@ -227,15 +199,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.0.3.1
 signing_key: 
 specification_version: 4
 summary: Type checking and type casting of parameters for Action Pack