paramore 3.2.0 → 3.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b8620a326873694bcc720cd186b9f4998fde3ab3fc102e2cb81b55822accc1e1
-  data.tar.gz: '07288ff15f31bb8480fc30662da17cd6aba34617afff96cd488c205b2c4c4660'
+  metadata.gz: 0e3e663f7752add2ed7c167643bdc789c5aec5421455440f094942b06ca49c57
+  data.tar.gz: 9ccdaec01fdd4e5ce1b337d3e8ca7a84c812acd38b817d015b980d279b0d43c9
 SHA512:
-  metadata.gz: 753ede1706d8dc9563bfa8cfad77683586ac319aefd4f84f80b6247d0daa7054710809a4ae24f812196402a83628d0760992ba8f281de79197e9b69cd39f9570
-  data.tar.gz: '078b73a5da242dc7fb75d1175232af4d52928d1cd5db1af9366ca2e95fec990c7ec0e37eaf48c3560e8f27f47a351d03bd448589354bd1f335cc3951763702f5'
+  metadata.gz: a571718b5125d6d7f6078b85cb0ef4d201c33731ad8a4eb4255550746562bdd6824a5207a11ec6a3a58a044e0cc5c5a78f0acd33246f7e419e1be1049f3c4eee
+  data.tar.gz: 3966ac01cadb45e454b001fbd0044778794dc437af95a6c3faeefe0663a9412a910ffa4fdede25b7508c4f029185ace67af5975630bde5d970b55311df7e1a38

data/lib/paramore/cast_parameters.rb

@@ -9,7 +9,7 @@ module Paramore
 
     def cast(field, value, name = nil)
       if value.nil?
-        if field.nullable? || field.default
+        if field.nullable? || field.default?
           return field.default
         else
           raise Paramore::NilParameter, name
@@ -18,32 +18,53 @@ module Paramore
 
       case field.type
       when Hash
-        typecast_hash(field.type, value || {})
+        typecast_hash(field, value || {}, name)
       when Array
-        typecast_array(field, value)
+        typecast_array(field, value, name)
       else
         if value == '' && !field.allow_empty? && field.nullable?
           nil
         else
-          typecast_value(field.type, value)
+          typecast_value(field.type, value, name)
         end
       end
     end
 
-    def typecast_hash(field, hash)
-      field.to_h { |name, field| [name, cast(field, hash[name], name)] }
+    def typecast_hash(field, hash, name)
+      raise Paramore::HashExpected.new(name, hash) unless hash.is_a?(Hash)
+
+      result =
+        if field.wildly_keyed_hash?
+          value_field = field.type.values.first
+          key_type = field.type.keys.first
+          hash.to_h do |name, value|
+            [typecast_value(key_type, name, nil), cast(value_field, value, name)]
+          end
+        else
+          field
+            .type
+            .reject { |name, value_field| missing_and_optional?(hash, name, value_field) }
+            .to_h { |name, value_field| [name, cast(value_field, hash[name], name)] }
+        end
+
+
+      field.compact? ? result.compact : result
     end
 
-    def typecast_array(field, array)
+    def typecast_array(field, array, name)
+      raise Paramore::ArrayExpected.new(name, array) unless array.is_a?(Array)
+
       array
         .reject { |unit| unit.to_s == '' && field.compact? }
-        .map do |unit|
-          cast(Paramore.field(field.type.first, null: true), unit)
-        end
+        .map { |unit| cast(Paramore.field(field.type.first, null: true), unit) }
     end
 
-    def typecast_value(type, value)
+    def typecast_value(type, value, name)
       type.send(Paramore.configuration.type_method_name, value)
     end
+
+    def missing_and_optional?(hash, name, field)
+      !hash.key?(name) && !field.required?
+    end
   end
 end

data/lib/paramore/errors.rb

@@ -9,3 +9,21 @@ class Paramore::NonField < StandardError
     super("`#{param_name}` defined as a `#{type.class}`, expected a call of `Paramore.field()`! Perhaps you declared a plain hash instead of Paramore.field({})?")
   end
 end
+
+class Paramore::HashExpected < StandardError
+  def initialize(param_name, param)
+    super("Expected `#{param_name}` to be a hash, received #{param.class} instead!")
+  end
+end
+
+class Paramore::ArrayExpected < StandardError
+  def initialize(param_name, param)
+    super("Expected `#{param_name}` to be an array, received #{param.class} instead!")
+  end
+end
+
+class Paramore::HashTooWild < StandardError
+  def initialize(hash)
+    super("A hash field with a type as key may not contain any more entries! (so, eg.: { String => field } is ok, but { String => field, user_id: field } is not)")
+  end
+end

data/lib/paramore/extension.rb

@@ -1,4 +1,3 @@
-require_relative 'validate'
 require_relative 'cast_parameters'
 require_relative 'permitted_parameter_argument'
 
@@ -8,6 +7,10 @@ module Paramore
       default
     ].freeze
 
+    def field(*args)
+      Paramore.field(*args)
+    end
+
     def param_schema(accessor_name, parameter_configuration)
       unless parameter_configuration.keys.size == 1
         raise ArgumentError,
@@ -17,8 +20,6 @@ module Paramore
       required_parameter_name = parameter_configuration.keys.first
       types_definition = parameter_configuration.values.first
 
-      Paramore::Validate.run(types_definition) if types_definition.is_a?(Paramore::Field)
-
       permitted_parameter_argument =
         if types_definition.is_a?(Paramore::Field)
           Paramore::PermittedParameterArgument.parse(types_definition)
@@ -41,7 +42,7 @@ module Paramore
         parameter_values =
           if types_definition.is_a?(Paramore::Field)
             permitted_params.merge(
-              Paramore::CastParameters.run(types_definition, permitted_params)
+              Paramore::CastParameters.run(types_definition, permitted_params.to_hash.with_indifferent_access)
             ).permit!
           else
             permitted_params.permit!

data/lib/paramore/field.rb

@@ -1,3 +1,5 @@
+require_relative 'validate'
+
 module Paramore
   class Field
     DEFAULT_OPTIONS = {
@@ -5,22 +7,32 @@ module Paramore
       compact: false,
       default: nil,
       empty: true,
+      required: true,
     }.freeze
 
-    def initialize(given_type, null:, compact:, default:, empty:)
+    def initialize(given_type, null:, compact:, default:, empty:, required:)
       @given_type = given_type
       @nullable = null
       @compact = compact
       @allow_empty = empty
       @default = default
+      @required = required
+    end
+
+    def required?
+      @required
     end
 
     def allow_empty?
       @allow_empty
     end
 
+    def default?
+      !@default.nil?
+    end
+
     def default
-      @default
+      @default.is_a?(Proc) ? @default.call : @default
     end
 
     def compact?
@@ -34,5 +46,17 @@ module Paramore
     def type
       @given_type
     end
+
+    def wildly_keyed_hash?
+      type.is_a?(Hash) && self.class.wildly_keyed_hash?(type)
+    end
+
+    def validate!
+      Paramore::Validate.run(self)
+    end
+
+    def self.wildly_keyed_hash?(hash)
+      hash.keys.any? { |key| [Class, Module].include?(key.class) }
+    end
   end
 end

data/lib/paramore/types.rb

@@ -49,4 +49,11 @@ module Paramore
       Paramore::StrippedString[input].squeeze(' ')
     end
   end
+
+  module Date
+    module_function
+    def [](input)
+      input.to_date
+    end
+  end
 end

data/lib/paramore/validate.rb

@@ -26,11 +26,23 @@ module Paramore
     end
 
     def hash_types(hash)
+      validate_wildly_keyed_hash!(hash)
+
       hash.flat_map do |param_name, field|
         raise Paramore::NonField.new(param_name, field) unless field.is_a?(Paramore::Field)
 
         field.type.is_a?(Hash) ? types(field.type) : field.type
       end.uniq
     end
+
+    def validate_wildly_keyed_hash!(hash)
+      if Paramore::Field.wildly_keyed_hash?(hash) && hash.keys.map(&:class).count > 1
+        raise Paramore::HashTooWild.new(hash)
+      end
+    end
+
+    def wildly_keyed_hash?(hash)
+      [Class, Module].include?(hash.keys.first.class)
+    end
   end
 end

data/lib/paramore.rb

@@ -20,6 +20,6 @@ module Paramore
     Paramore::Field.new(
       given_type,
       **Paramore::Field::DEFAULT_OPTIONS.merge(options)
-    )
+    ).validate!
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: paramore
 version: !ruby/object:Gem::Version
-  version: 3.2.0
+  version: 3.6.0
 platform: ruby
 authors:
 - Lukas Kairevičius
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-09-20 00:00:00.000000000 Z
+date: 2021-09-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec-rails
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: rails
   requirement: !ruby/object:Gem::Requirement
@@ -101,7 +115,7 @@ licenses:
 - MIT
 metadata: {}
 post_install_message: |
-  Thank you for installing Paramore 3.2.0 !
+  Thank you for installing Paramore 3.6.0 !
   From the command line you can run `paramore` to generate a configuration file
 
   More details here         : https://github.com/lumzdas/paramore/blob/master/README.md
@@ -120,7 +134,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.8
+rubygems_version: 3.2.3
 signing_key: 
 specification_version: 4
 summary: A declarative approach to Rails' strong parameter typing and sanitizing