stronger_parameters 2.17.0 → 2.20.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 29a714a242ff378f5bf21a4a131c2c1e985e07d99a6698ec74a9c09009d201c6
-  data.tar.gz: eb48fa058692ca09457c04f2dd29ddb0addeb90cf40d17496c1eb62f7b2a53b3
+  metadata.gz: f186917c03263aba1f50d3e3ac7ff3acd4926655f8e9112b7385b34918fdb099
+  data.tar.gz: 863fc50ff7e443536ad62de00470439b3b4cfa4288174100db0e154bba9064c9
 SHA512:
-  metadata.gz: bc0642f85f672bf56faf7e139e1ea895206a6985f7b8b7a4c5034e1bd023696af0796307fa478007c462c39f2d3dc47fdc769269990e4b0c5be51691709e0d54
-  data.tar.gz: 133a07b885c0a2d7612e5a8b46c9c53b05534a9be921738a571f910ea6de9c166bebb1891640537e707aa5c6b96fec234cddccde2a860b03d6e0cbff9d5da3d6
+  metadata.gz: ccafbf30f5050cc5eb2f3d9340d295197cffe2e183e382a2c16f3acd291f4529695ed5ef110fa742f9e19e3ce6ab950fa8a4364fc5557808c16b3635791a8418
+  data.tar.gz: b1bbeb6bb9368094ed661f35eb2d4fbabe719ee81e004b7a6abf40b2dd7d45de4904a1d2ebd52ed780ba230c2c50db6e094a7f50b0cdeb6a009de4ca045e1b91

data/README.md

@@ -240,7 +240,6 @@ curl -I 'http://localhost/api/users/1.json' -X POST -d '{ "user": { "id": 1 } }'
 => X-StrongerParameters-API-Warn: Removed restricted keys ["user.id"] from parameters
 ```
 
-
 ## Types
 
 | Syntax                         | (Simplified) Definition                                                                    |
@@ -248,6 +247,10 @@ curl -I 'http://localhost/api/users/1.json' -X POST -d '{ "user": { "id": 1 } }'
 | Parameters.string              | value.is_a?(String)                                                                        |
 | Parameters.integer             | value.is_a?(Fixnum) or '-1'                                                                |
 | Parameters.float               | value.is_a?(Float) or '-1.2'                                                               |
+| Parameters.date                | value.is_a?(Date) or '2014-05-13' or '13.05.2014'                                          |
+| Parameters.date_iso8601        | value is a date that conforms to ISO8601: '2014-05-13'                                     |
+| Parameters.time                | value.is_a?(Time) or '2014-05-13' or '2015-03-31 14:34:56 +0000'                           |
+| Parameters.time_iso8601        | value is a time that conforms to ISO8601: '2014-05-13' or '2015-03-31T14:34:56Z'           |
 | 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                                                                            |
@@ -268,3 +271,16 @@ curl -I 'http://localhost/api/users/1.json' -X POST -d '{ "user": { "id": 1 } }'
 | Parameters.file                | File, StringIO, Rack::Test::UploadedFile, ActionDispatch::Http::UploadedFile or subclasses |
 | Parameters.decimal(8,2)        | value is a String, Integer or Float with a precision of 9 and scale of 2                   |
 | Parameters.hex                  | value is a String that matches the hexadecimal format |
+| Parameters.ulid                 | value is a String of length 26 with only Crockford Base32 symbols |
+
+## Development
+
+### Releasing a new version
+
+```
+git checkout master && git fetch origin && git reset --hard origin/master
+bundle exec rake bump:<patch|minor|major>
+bundle exec rake release
+```
+
+[github action](.github/workflows/ruby-gem-publication.yml) will release a new version to rubygems.org

data/lib/stronger_parameters/constraints/date_constraint.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+require 'stronger_parameters/constraint'
+
+module StrongerParameters
+  class DateConstraint < Constraint
+    def value(v)
+      return v if v.is_a?(Date)
+
+      begin
+        Date.parse v
+      rescue ArgumentError, TypeError
+        StrongerParameters::InvalidValue.new(v, "must be a date")
+      end
+    end
+  end
+end

data/lib/stronger_parameters/constraints/date_iso8601_constraint.rb

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

data/lib/stronger_parameters/constraints/date_time_constraint.rb

@@ -9,7 +9,7 @@ module StrongerParameters
       begin
         DateTime.parse v
       rescue ArgumentError, TypeError
-        StrongerParameters::InvalidValue.new(v, "must be a date")
+        StrongerParameters::InvalidValue.new(v, "must be a datetime")
       end
     end
   end

data/lib/stronger_parameters/constraints/date_time_iso8601_constraint.rb

@@ -6,7 +6,7 @@ module StrongerParameters
     def value(v)
       DateTime.iso8601 v
     rescue ArgumentError, TypeError
-      StrongerParameters::InvalidValue.new(v, "must be an iso8601 date")
+      StrongerParameters::InvalidValue.new(v, "must be an iso8601 datetime")
     end
   end
 end

data/lib/stronger_parameters/constraints/time_constraint.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+require 'stronger_parameters/constraint'
+
+module StrongerParameters
+  class TimeConstraint < Constraint
+    def value(v)
+      return v if v.is_a?(Time)
+
+      begin
+        Time.parse v
+      rescue ArgumentError, TypeError
+        StrongerParameters::InvalidValue.new(v, "must be a time")
+      end
+    end
+  end
+end

data/lib/stronger_parameters/constraints/time_iso8601_constraint.rb

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

data/lib/stronger_parameters/constraints/ulid_constraint.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+require 'stronger_parameters/constraint'
+
+module StrongerParameters
+  class UlidConstraint < Constraint
+    # https://www.crockford.com/base32.html
+    INVALID_CHAR_REGEX = /[ilou]|[^a-z0-9]/i.freeze
+    ULID_LENGTH = 26
+
+    def value(v)
+      return invalid_value(v) unless v.is_a?(String)
+      return invalid_value(v) unless v.length == ULID_LENGTH
+      return invalid_value(v) if v =~ INVALID_CHAR_REGEX
+
+      v
+    end
+
+    private
+
+    def invalid_value(v)
+      StrongerParameters::InvalidValue.new(v, "must be a ULID")
+    end
+  end
+end

data/lib/stronger_parameters/constraints.rb

@@ -2,6 +2,10 @@
 require 'stronger_parameters/constraint'
 require 'stronger_parameters/constraints/string_constraint'
 require 'stronger_parameters/constraints/float_constraint'
+require 'stronger_parameters/constraints/date_constraint'
+require 'stronger_parameters/constraints/date_iso8601_constraint'
+require 'stronger_parameters/constraints/time_constraint'
+require 'stronger_parameters/constraints/time_iso8601_constraint'
 require 'stronger_parameters/constraints/date_time_constraint'
 require 'stronger_parameters/constraints/date_time_iso8601_constraint'
 require 'stronger_parameters/constraints/regexp_constraint'
@@ -16,3 +20,4 @@ require 'stronger_parameters/constraints/nil_string_constraint'
 require 'stronger_parameters/constraints/file_constraint'
 require 'stronger_parameters/constraints/decimal_constraint'
 require 'stronger_parameters/constraints/hex_constraint'
+require 'stronger_parameters/constraints/ulid_constraint'

data/lib/stronger_parameters/parameters.rb

@@ -105,6 +105,22 @@ module StrongerParameters
         NilStringConstraint.new
       end
 
+      def date
+        DateConstraint.new
+      end
+
+      def date_iso8601
+        DateIso8601Constraint.new
+      end
+
+      def time
+        TimeConstraint.new
+      end
+
+      def time_iso8601
+        TimeIso8601Constraint.new
+      end
+
       def datetime
         DateTimeConstraint.new
       end
@@ -124,6 +140,10 @@ module StrongerParameters
       def hex
         HexConstraint.new
       end
+
+      def ulid
+        UlidConstraint.new
+      end
     end
 
     def hash_filter_with_stronger_parameters(params, filter)
@@ -160,7 +180,7 @@ module StrongerParameters
 
         if result.is_a?(InvalidValue)
           name = "invalid_parameter.action_controller"
-          ActiveSupport::Notifications.publish(name, key: key, value: value, message: result.message)
+          ActiveSupport::Notifications.instrument(name, key: key, value: value, message: result.message)
 
           action = self.class.action_on_invalid_parameters
           case action

data/lib/stronger_parameters/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stronger_parameters
 version: !ruby/object:Gem::Version
-  version: 2.17.0
+  version: 2.20.0
 platform: ruby
 authors:
 - Mick Staugaard
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-05-10 00:00:00.000000000 Z
+date: 2023-03-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -108,20 +108,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: mocha
-  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: forking_test_runner
   requirement: !ruby/object:Gem::Requirement
@@ -170,6 +156,8 @@ files:
 - lib/stronger_parameters/constraints/array_constraint.rb
 - lib/stronger_parameters/constraints/boolean_constraint.rb
 - lib/stronger_parameters/constraints/comparison_constraints.rb
+- lib/stronger_parameters/constraints/date_constraint.rb
+- lib/stronger_parameters/constraints/date_iso8601_constraint.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
@@ -183,6 +171,9 @@ files:
 - lib/stronger_parameters/constraints/nil_string_constraint.rb
 - lib/stronger_parameters/constraints/regexp_constraint.rb
 - lib/stronger_parameters/constraints/string_constraint.rb
+- lib/stronger_parameters/constraints/time_constraint.rb
+- lib/stronger_parameters/constraints/time_iso8601_constraint.rb
+- lib/stronger_parameters/constraints/ulid_constraint.rb
 - lib/stronger_parameters/controller_support/permitted_parameters.rb
 - lib/stronger_parameters/errors.rb
 - lib/stronger_parameters/parameters.rb
@@ -207,7 +198,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.0.3.1
 signing_key: 
 specification_version: 4
 summary: Type checking and type casting of parameters for Action Pack