typed-parameter 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 85aaf512215b5dd4abc568b69190dde93d0894befac1a1f1b6c9097cd468a9f1
-  data.tar.gz: 51d58c512d2f057b6ce7071876a8b01ad6360fd9d9d70aaa323ce56e96ecdaca
+  metadata.gz: ff83851eec45e830cd251fa2a886722d6968373ce94f3a84eef45b47b3c67351
+  data.tar.gz: 47f08d63b04dad171ff357ca3ce31433d586bd5da1adc95560395783e687a80b
 SHA512:
-  metadata.gz: 26b48a740e5f53583003ef50f9c2a3c016cb19a8146b74e90660865fa224f8de9e01bbe150e83c379091f069021281f394d36e7ec204e40f4b586c15126c2034
-  data.tar.gz: 144a0dab8ec0676cdb4fb3d0447769df7d8c0cc007d38830f2499fd16cba1cf78a194b64644b5e223a3e3a82188ccc30f0e7b5cdb5fa3f2d60b0f2d47bc1a426
+  metadata.gz: c3ceb0d67668c8f4b02a3269c450c9800b9c63821b1904d14992b50d06475bc911b0bb6b5b3a5fe7d26db97aa03e164fe877ec533058c7426eea520027e90d6f
+  data.tar.gz: c505148ce9101eebf71c145f000abd8e45aa6501c4832cc39e03d43b0a734890d70cdf53a13226c8653ba4bee847d566672d4f139075d003b046a944b6fa54a4

data/README.md

@@ -1,4 +1,4 @@
-# TypedParameter
+# typed_parameter
 Create typed parameter class using strong paramter in rails.
 You can cleanup parameter code for permit in your controller and convert it to the type you want.
 ## Installation
@@ -145,7 +145,7 @@ example_params = {
 }
 
 def parent_and_childs_params
-  ParentParams.permit(example_params)
+  ParentParameter.permit(example_params)
 end
 
 # Result

data/lib/typed_parameter/base.rb

@@ -2,25 +2,46 @@ module TypedParameter
   class Base
     class << self
       def field(name, type, **kargs)
-        initialize_permitted_fields(name, type) # Need to remove! we don't need strong_parameter's filter
-        initialize_swagger_properties(name, type, kargs)
-        initialize_constraints(name, type, kargs)
-      end
+        if block_given? 
+          raise Error::InvalidBlockParameter unless [type].flatten[0].in?([Hash, Object])
+          
+          block_param_name = "#{self.to_s}_Partial_#{name.to_s.camelize}" 
+          class_eval("class ::#{block_param_name} < ::TypedParameter::Base; end")
+          block_param = block_param_name.constantize
+          yield(block_param)
+
+          if type.is_a?(Array)
+            target = [block_param]
+          else
+            target = block_param
+          end
+        else
+          target = type
+        end
 
-      def permit(params)
-        raise ArgumentError unless params.class <= ActionController::Parameters
 
-        use_constraints(params).permit! # will change to use_constraints(params).permit!
+        initialize_constraints(name, target, kargs)
+        initialize_swagger_properties(name, target, kargs)
       end
 
-      def fields
-        __fields.freeze
+      def permit(params)
+        raise Error::ParameterError unless params.class <= ActionController::Parameters
+
+        use_constraints(params).permit!
       end
 
       def swagger_properties
         __swagger_properties.freeze
       end
 
+      def swagger_requirements
+        __swagger_requirements.freeze
+      end
+
+      def constraints
+        __constraints.freeze
+      end
+
       alias key name
 
       def ref
@@ -31,43 +52,45 @@ module TypedParameter
 
       def initialize_swagger_properties(name, type, kargs)
         swagger_type = TypedParameter::Swagger::TypeGenerator.generate(type)
-        swagger_options = swagger_type.merge(kargs)
+        swagger_options = swagger_type.merge(kargs.slice(:enum, :description))
         __swagger_properties[name] = swagger_options
-      end
-
-      def initialize_permitted_fields(name, type)
-        __fields << PermitFieldGenerator.generate(name, type)
+        __swagger_requirements << name if kargs[:required]
       end
 
       def initialize_constraints(name, type, kargs)
         options = kargs.slice(:enum, :required)
-
+        options[:enum] = options[:enum].map(&:to_s) if options[:enum]
         __constraints << [name, type, options]
       end
 
       def use_constraints(params)
-        paramters = ActionController::Parameters.new
+        typed_params = ActionController::Parameters.new
 
         __constraints.each do |name, type, options|
           value = params[name]
-          raise RequiredFieldError, "(#{self.name}) #{name} is required" if options[:required] && !value.present?
+          raise Error::RequiredFieldError, "(#{self.name}) #{name} is required" if options[:required] && empty_value?(value)
+
           next unless value.present?
 
-          paramters[name] = TypeConstraint.value(type, value)
-          paramters[name] = EnumConstraint.value(value, options[:enum]) if options[:enum]
+          typed_params[name] = TypeConstraint.value(type, value)
+          typed_params[name] = EnumConstraint.value(value, options[:enum]) if options[:enum]
         end
 
-        paramters
+        typed_params
       end
 
-      def __fields
-        @__fields ||= []
+      def empty_value?(value)
+        value.nil? || value == '' || (value.is_a?(Array) && value.empty?)
       end
 
       def __constraints
         @__constraints ||= []
       end
 
+      def __swagger_requirements
+        @__swagger_requirements ||= []
+      end
+
       def __swagger_properties
         @__swagger_properties ||= {}
       end

data/lib/typed_parameter/boolean.rb

@@ -4,16 +4,12 @@ class Boolean; end
 
 class TrueClass
   def is_a?(type)
-    return true if type == Boolean
-
-    super(type)
+    type == Boolean || super(type)
   end
 end
 
 class FalseClass
   def is_a?(type)
-    return true if type == Boolean
-
-    super(type)
+    type == Boolean || super(type)
   end
 end

data/lib/typed_parameter/constraints/date_constraint.rb

@@ -4,7 +4,7 @@ module TypedParameter
   module Constraints
     class DateConstraint < Base
       def self.value(value)
-        value.to_date
+        value.to_time.to_date
       end
     end
   end

data/lib/typed_parameter/constraints/date_time_constraint.rb

@@ -4,7 +4,7 @@ module TypedParameter
   module Constraints
     class DateTimeConstraint < Base
       def self.value(value)
-        value.to_datetime
+        value.to_time.to_datetime
       end
     end
   end

data/lib/typed_parameter/enum_constraint.rb

@@ -1,10 +1,20 @@
 module TypedParameter
   module EnumConstraint
     def self.value(value, enums)
-      enums = enums.map(&:to_s) if value.is_a? String
-      raise EnumFieldError, "#{value} must be in #{enums.join(', ')}" unless value.in? enums
+      return array_value(value, enums) if value.is_a? Array
+      return value if value.to_s.in? enums
 
-      value
+      raise EnumFieldError, "#{value} must be in #{enums.join(', ')}"
+    end
+
+    def self.array_value(values, enums)
+      values.each do |value|
+        next if value.to_s.in? enums
+
+        raise EnumFieldError, "#{value} must be in #{enums.join(', ')}"
+      end
+
+      values
     end
   end
 end

data/lib/typed_parameter/errors.rb

@@ -4,4 +4,6 @@ module TypedParameter
   class RequiredFieldError < Error; end
 
   class EnumFieldError < Error; end
+
+  class InvalidBlockParameter < Error; end
 end

data/lib/typed_parameter/swagger/component_generator.rb

@@ -6,11 +6,13 @@ module TypedParameter
           key = parameter_class.key
           properties = Swagger::PropertyGenerator.generate(parameter_class.swagger_properties)
 
-          { "#{key}": { type: :object, properties: properties } }
+          swagger = { type: :object, properties: properties }
+          swagger[:required] = parameter_class.swagger_requirements if parameter_class.swagger_requirements.present?
+          { "#{key}": swagger }
         end
 
         def generate_all!
-          parameter_classes = TypedParameter::Base.descendants.reject { |c| c.fields.empty? }
+          parameter_classes = TypedParameter::Base.descendants.reject { |c| c.swagger_properties.empty? }
 
           parameter_classes.reduce({}) { |prev, curr| prev.merge(generate(curr)) }
         end

data/lib/typed_parameter/swagger/type_generator.rb

@@ -5,9 +5,9 @@ module TypedParameter
         def generate(type)
           return array_generate(type) if type.is_a? Array
           return hash_generate(type) if type.is_a? Hash
+          return { ref: type } if type < TypedParameter::Base
 
-          swagger_type = Swagger::Types[type.name.to_sym]
-          swagger_type&.value || { ref: type }
+          Swagger::Types[type.name.to_sym]&.value
         end
 
         def hash_generate(hash)
@@ -17,7 +17,7 @@ module TypedParameter
         end
 
         def array_generate(type)
-          { type: :array, items: generate(type[0]) } 
+          { type: :array, items: generate(type[0]) }
         end
       end
     end

data/lib/typed_parameter/version.rb

@@ -1,3 +1,3 @@
 module TypedParameter
-  VERSION = '0.4.0'.freeze
+  VERSION = '0.5.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: typed-parameter
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Minwoo Jo
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-03-08 00:00:00.000000000 Z
+date: 2022-02-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails