paramore 3.4.0 → 3.6.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8e8663a895e1498608035c7717e8a881617d1ba889e67e6115472117717963fc
-  data.tar.gz: 3e6b5675baeae13d31abee6f1ed4b77261ed233be87e42a5277ce803f5801c0e
+  metadata.gz: fca99d33c8a3b32eb98a7d4594ca566d7a5c2a114b4c6b29b3d5067416760739
+  data.tar.gz: e42a6eb5ddb69906005d91ff8e22aa0928062c01e9e00ce7a6b4d50599d4c18e
 SHA512:
-  metadata.gz: b51afaf562c8671afadd367cdb9388d50b77939d5aaf939cc54f3b00e0046ee8ff218a54c04e29db3979edfb46635a2fb387643dc726c61c513a658c821c9a2a
-  data.tar.gz: 24528d33bbb924bfb1c75f7ee24a9c0853ae0c6af357695df0a3e29771a2e6084df26a4259e494d548bac1e26c781b862a5d0b4e1df9a480cdeb515d3e1ceaeb
+  metadata.gz: e64d230fa1408afe666295e454431aeef715d9a4fdcdc9a3284feff7bd5b57a1da33a9455d6179f9da14d65c6a09c3aa39d82ff066947bf172df5d42424bac1b
+  data.tar.gz: d179870cc3a1eb6013bebbf12868a4d377228d0c62899c17886cbf5d08809aa96704da6f888473989cd39e7091bc36e306464f0fce5f331bcec0d1b0f0baf38d

data/lib/paramore/cast_parameters.rb

@@ -18,36 +18,53 @@ module Paramore
 
       case field.type
       when Hash
-        typecast_hash(field, 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)
-      result = field
-        .type
-        .reject { |name, inner_field| !hash.key?(name) && !inner_field.required? }
-        .to_h { |name, inner_field| [name, cast(inner_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 = {
@@ -44,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/permitted_parameter_argument.rb

@@ -13,11 +13,15 @@ module Paramore
           parse_type(type.first)
         when Hash
           type.map do |name, field|
-            case field.type
-            when Array, Hash
-              { name => parse_type(field.type) }
+            if field.wildly_keyed_hash?
+              { name => {} }
             else
-              name
+              case field.type
+              when Array, Hash
+                { name => parse_type(field.type) }
+              else
+                name
+              end
             end
           end
         else

data/lib/paramore/types.rb

@@ -49,4 +49,11 @@ module Paramore
       Paramore::StrippedString[input].squeeze(' ')
     end
   end
+
+  module Date
+    module_function
+    def [](input)
+      Date.parse(input)
+    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.4.0
+  version: 3.6.2
 platform: ruby
 authors:
 - Lukas Kairevičius
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-09-27 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.4.0 !
+  Thank you for installing Paramore 3.6.2 !
   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