typed-parameter 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 27016542e3178c6385e4fdfe27f3520f6f37f5afc49572e04f701a0b261eba92
-  data.tar.gz: 991f39290e89d92ede9ae33df068712f3e90fc545e4282ccd7cf5e0bf82fdc4b
+  metadata.gz: 85aaf512215b5dd4abc568b69190dde93d0894befac1a1f1b6c9097cd468a9f1
+  data.tar.gz: 51d58c512d2f057b6ce7071876a8b01ad6360fd9d9d70aaa323ce56e96ecdaca
 SHA512:
-  metadata.gz: 557509df857bfc89d385cabce59a11296fc0ce54751d9060f3da267fc72bd77b5ff4a98e65c488127d83fe0cbe01b2aa18b723325da36819657f5f0615ea4867
-  data.tar.gz: 676c8fc68a53c6923407bf104cf54a1825d27db20b40377f4f0c2d0800fe5910843c6e775c6cea5b862c30d92b50faf0656e4631dbe1164981a3f957d2c9bfa0
+  metadata.gz: 26b48a740e5f53583003ef50f9c2a3c016cb19a8146b74e90660865fa224f8de9e01bbe150e83c379091f069021281f394d36e7ec204e40f4b586c15126c2034
+  data.tar.gz: 144a0dab8ec0676cdb4fb3d0447769df7d8c0cc007d38830f2499fd16cba1cf78a194b64644b5e223a3e3a82188ccc30f0e7b5cdb5fa3f2d60b0f2d47bc1a426

data/README.md

@@ -163,10 +163,85 @@ end
 ~~~
 Example 4. CustomType
 ------
-...
+If You want to use your custom type like Email, just create two file.
+- your type file. like "Email"
+- yout type constant. like "EmailConstrant"
+
+~~~ruby
+class Email
+  def initialize(value)
+    @email = value
+  end
+end
+
+class EmailConstrant
+ class << self
+  EMAIL_REGREX = //
+
+  # using convert value to your type
+  def value(value)
+    raise ArgumentError unless EMAIL_REGREX.match? value
+
+    Email.new(value)
+  end
+ end
+end
+
+class EmailSwaggerType
+  class << self
+    def value
+      { type: :string }
+    end
+  end
+end
+
+# Register your type to typed-parameter when application initialize.
+TypedParameter::ParameterTypes.register Email
+TypedParameter::Constants.register :Email, EmailConstrant
+TypedParameter::Swagger::Types.register :Email, EmailSwaggerType
+~~~
 
 Example 5. Swaggerize
 ------
+With Rswag(https://github.com/rswag/rswag), you can swaggerize your parameter types.
+
+~~~ruby
+class SwaggerParameter < TypedParameter::Base
+  field :string, String, enum: ["one", "two"], description: "String Field"
+  field :integer, Integer, description: "Integer Field"
+  field :ref_field, SwaggerRefParameter
+end
+
+class SwaggerRefParameter < TypedParameter::Base
+  field :string, String, description: "Ref String Field"
+end
+
+SwaggerParameter.swagger_properties
+# =>
+# { 
+#  string: { type: :string, enum: ["one", "two" ], description: "String Field" }, 
+#  integer: { type: :integer, description: "Integer Field" },
+#  ref_field: { "$ref": "#/components/schemas/SwaggerRefParamter" }
+# }
+# 
+
+# Add Components in your swagger
+# in swagger_helper
+components = TypedParameter::Swagger::ComponentGenerator.generate_all!
+
+config.swagger_docs = {
+    'v1/swagger.yaml' => {
+      openapi:    '3.0.1',
+      # ..., 
+      components: {
+        schemas: {
+          **components
+        }
+      }
+      #...
+    }
+  }
+~~~
 ...
 
 

data/lib/typed_parameter.rb

@@ -13,6 +13,5 @@ require 'typed_parameter/swagger/type_generator'
 require 'typed_parameter/swagger/property_generator'
 require 'typed_parameter/swagger/component_generator'
 
-module TypedParameter
-  class Error < StandardError; end
-end
+require 'typed_parameter/errors'
+module TypedParameter; end

data/lib/typed_parameter/base.rb

@@ -2,7 +2,7 @@ module TypedParameter
   class Base
     class << self
       def field(name, type, **kargs)
-        initialize_permitted_fields(name, type)
+        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
@@ -10,7 +10,7 @@ module TypedParameter
       def permit(params)
         raise ArgumentError unless params.class <= ActionController::Parameters
 
-        use_constraints params.permit(fields)
+        use_constraints(params).permit! # will change to use_constraints(params).permit!
       end
 
       def fields
@@ -46,16 +46,18 @@ module TypedParameter
       end
 
       def use_constraints(params)
+        paramters = ActionController::Parameters.new
+
         __constraints.each do |name, type, options|
           value = params[name]
-          raise ArgumentError, "(#{self.name}) #{name} is required" if options[:required] && !value.present?
+          raise RequiredFieldError, "(#{self.name}) #{name} is required" if options[:required] && !value.present?
           next unless value.present?
 
-          params[name] = TypeConstraint.value(type, value)
-          params[name] = EnumConstraint.value(value, options[:enum]) if options[:enum]
+          paramters[name] = TypeConstraint.value(type, value)
+          paramters[name] = EnumConstraint.value(value, options[:enum]) if options[:enum]
         end
 
-        params
+        paramters
       end
 
       def __fields

data/lib/typed_parameter/constraints.rb

@@ -3,7 +3,7 @@ require 'typed_parameter/constraints/integer_constraint'
 require 'typed_parameter/constraints/float_constraint'
 require 'typed_parameter/constraints/string_constraint'
 require 'typed_parameter/constraints/date_constraint'
-require 'typed_parameter/constraints/datetime_constraint'
+require 'typed_parameter/constraints/date_time_constraint'
 require 'typed_parameter/constraints/boolean_constraint'
 
 module TypedParameter
@@ -14,7 +14,7 @@ module TypedParameter
         @constraints[key] = constraint
       end
 
-      def get(name)
+      def [](name)
         @constraints[name].freeze
       end
     end

data/lib/typed_parameter/enum_constraint.rb

@@ -2,7 +2,7 @@ module TypedParameter
   module EnumConstraint
     def self.value(value, enums)
       enums = enums.map(&:to_s) if value.is_a? String
-      raise ArgumentError, "#{value} must be in #{enums.join(', ')}" unless value.in? enums
+      raise EnumFieldError, "#{value} must be in #{enums.join(', ')}" unless value.in? enums
 
       value
     end

data/lib/typed_parameter/errors.rb

@@ -0,0 +1,7 @@
+module TypedParameter
+  class Error < StandardError; end
+
+  class RequiredFieldError < Error; end
+
+  class EnumFieldError < Error; end
+end

data/lib/typed_parameter/permit_field_generator.rb

@@ -5,7 +5,7 @@ module TypedParameter
         type_class = [type].flatten.first
 
         props = if type.is_a? Array
-                  type_class.in? TypedParameter::ParameterTypes.types ? [] : generate_properties(type_class)
+                  type_class.in?(TypedParameter::ParameterTypes.types) ? [] : generate_properties(type_class)
                 else
                   generate_properties(type_class)
                 end

data/lib/typed_parameter/swagger/component_generator.rb

@@ -8,6 +8,12 @@ module TypedParameter
 
           { "#{key}": { type: :object, properties: properties } }
         end
+
+        def generate_all!
+          parameter_classes = TypedParameter::Base.descendants.reject { |c| c.fields.empty? }
+
+          parameter_classes.reduce({}) { |prev, curr| prev.merge(generate(curr)) }
+        end
       end
     end
   end

data/lib/typed_parameter/swagger/type_generator.rb

@@ -6,7 +6,7 @@ module TypedParameter
           return array_generate(type) if type.is_a? Array
           return hash_generate(type) if type.is_a? Hash
 
-          swagger_type = "TypedParameter::Swagger::Types::#{type.name}Type".safe_constantize
+          swagger_type = Swagger::Types[type.name.to_sym]
           swagger_type&.value || { ref: type }
         end
 

data/lib/typed_parameter/swagger/types.rb

@@ -5,3 +5,27 @@ require 'typed_parameter/swagger/types/string_type'
 require 'typed_parameter/swagger/types/date_type'
 require 'typed_parameter/swagger/types/date_time_type'
 require 'typed_parameter/swagger/types/boolean_type'
+
+module TypedParameter
+  module Swagger
+    module Types
+      class << self
+        def register(key, type)
+          @swagger_types ||= {}
+          @swagger_types[key] = type
+        end
+
+        def [](key)
+          @swagger_types[key].freeze
+        end
+      end
+    end
+  end
+end
+
+TypedParameter::Swagger::Types.register :Integer, TypedParameter::Swagger::Types::IntegerType
+TypedParameter::Swagger::Types.register :String, TypedParameter::Swagger::Types::StringType
+TypedParameter::Swagger::Types.register :Float, TypedParameter::Swagger::Types::FloatType
+TypedParameter::Swagger::Types.register :Date, TypedParameter::Swagger::Types::DateType
+TypedParameter::Swagger::Types.register :DateTime, TypedParameter::Swagger::Types::DateTimeType
+TypedParameter::Swagger::Types.register :Boolean, TypedParameter::Swagger::Types::BooleanType

data/lib/typed_parameter/type_constraint.rb

@@ -7,7 +7,7 @@ module TypedParameter
         if type_class < TypedParameter::Base
           type.is_a?(Array) ? parameter_array(type_class, value) : type.permit(value)
         else
-          constraint = TypedParameter::Constraints.get type_class.name.to_sym
+          constraint = TypedParameter::Constraints[type_class.name.to_sym]
           constraint ||= TypedParameter::Constraints::StringConstraint # Default
 
           type.is_a?(Array) ? constraint_array(constraint, value) : constraint.value(value)

data/lib/typed_parameter/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: typed-parameter
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Minwoo Jo
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-03-07 00:00:00.000000000 Z
+date: 2021-03-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -66,6 +66,7 @@ files:
 - lib/typed_parameter/constraints/integer_constraint.rb
 - lib/typed_parameter/constraints/string_constraint.rb
 - lib/typed_parameter/enum_constraint.rb
+- lib/typed_parameter/errors.rb
 - lib/typed_parameter/parameter_types.rb
 - lib/typed_parameter/permit_field_generator.rb
 - lib/typed_parameter/swagger/component_generator.rb