typed-parameter 0.2.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d5a39f98f145cc8ca6739aaa4bf0a729264be875ed09ba6308f7f3064870245c
-  data.tar.gz: 9ada066d064730b375493ead65ba4c594eecd690f2dca4be89bbb12232bcb3fd
+  metadata.gz: 8deba22f3280f1a4c5f01b83121402cd83822afb8602504a319faeb20ec10d8d
+  data.tar.gz: 9723defcab7d274fd354d00d8d60f0a1c04bd4e3de0750ee932fe4b6237c7456
 SHA512:
-  metadata.gz: 4b3165b35201ee612aca228d6ea55ac271bae117333cec8a6b5028b4c5bbc7021964618e6f94b4724b63893afc594906e9d8f135ae0feb5e99edadd61a2e4947
-  data.tar.gz: 815563901ab5685a3122caf11a280070d63da903cac667784e826721df94c58dabae3f3e115723819082f67ecb67923fd67a57501911060c4a710658aea81e31
+  metadata.gz: d8fbe3cfcdfcd1b3c5b30ee074cd958a9a38c3c2fb0b94545e9badd7f1757e7fce0378d6adec90058a70257b218f3b9c3ebc4bcd873900a18e7012837cafbb2c
+  data.tar.gz: 0acdee06d0c4458b0f229b8898a72d9ae624328954715de6a2702d281b425f9be88a0d129a7b5616a963e71d7214d5a6a34c241aba9e3d0244e841eda50e9355

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
@@ -163,10 +163,103 @@ 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
 
-Example 5. Swaggerize
+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. Use Inline Block
 ------
+You can use parameter class by block
+
+~~~ruby
+class BlockParameter < TypedParameter::Base
+  field :some_object, Object do |i|
+    i.field :name, String
+    i.field :type, String
+  end
+  
+  field :other_hash_list, [Hash] do |i|
+    i.field :index, Integer
+    i.field :value, Float
+  end
+end
+~~~
+
+Example 6. 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/base.rb

@@ -2,25 +2,46 @@ module TypedParameter
   class Base
     class << self
       def field(name, type, **kargs)
-        initialize_permitted_fields(name, type)
-        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(fields)
+        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,41 +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)
+        typed_params = 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 Error::RequiredFieldError, "(#{self.name}) #{name} is required" if options[:required] && empty_value?(value)
+
           next unless value.present?
 
-          params[name] = TypeConstraint.value(type, value)
-          params[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
 
-        params
+        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/{datetime_constraint.rb → 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/constraints.rb

@@ -3,5 +3,27 @@ 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
+  module Constraints
+    class << self
+      def register(key, constraint)
+        @constraints ||= {}
+        @constraints[key] = constraint
+      end
+
+      def [](name)
+        @constraints[name].freeze
+      end
+    end
+  end
+end
+
+TypedParameter::Constraints.register :Integer, TypedParameter::Constraints::IntegerConstraint
+TypedParameter::Constraints.register :String, TypedParameter::Constraints::StringConstraint
+TypedParameter::Constraints.register :Float, TypedParameter::Constraints::FloatConstraint
+TypedParameter::Constraints.register :Date, TypedParameter::Constraints::DateConstraint
+TypedParameter::Constraints.register :DateTime, TypedParameter::Constraints::DateTimeConstraint
+TypedParameter::Constraints.register :Boolean, TypedParameter::Constraints::BooleanConstraint

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 ArgumentError, "#{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

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

data/lib/typed_parameter/permit_field_generator.rb

@@ -1,20 +1,20 @@
 module TypedParameter
   module PermitFieldGenerator
     class << self
-      BASE_TYPES = TypedParameter::ParameterTypes.types
-
       def generate(name, type)
-        props = generate_properties(type)
+        type_class = [type].flatten.first
 
-        props = [] if type.is_a?(Array) && type[0].in?(BASE_TYPES)
-        return name unless props
+        props = if type.is_a? Array
+                  type_class.in?(TypedParameter::ParameterTypes.types) ? [] : generate_properties(type_class)
+                else
+                  generate_properties(type_class)
+                end
 
-        [[name, props]].to_h
+        props ? [[name, props]].to_h : name
       end
 
       def generate_properties(type)
-        return if type.in? BASE_TYPES
-        return generate_properties(type[0]) if type.is_a? Array
+        return if type.in? TypedParameter::ParameterTypes.types
         return type.keys if type.is_a? Hash
 
         type.fields

data/lib/typed_parameter/swagger/component_generator.rb

@@ -6,7 +6,15 @@ 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.swagger_properties.empty? }
+
+          parameter_classes.reduce({}) { |prev, curr| prev.merge(generate(curr)) }
         end
       end
     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 = "TypedParameter::Swagger::Types::#{type.name}Type".safe_constantize
-          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/swagger/types.rb

@@ -3,5 +3,29 @@ require 'typed_parameter/swagger/types/integer_type'
 require 'typed_parameter/swagger/types/float_type'
 require 'typed_parameter/swagger/types/string_type'
 require 'typed_parameter/swagger/types/date_type'
-require 'typed_parameter/swagger/types/datetime_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

@@ -3,19 +3,19 @@ module TypedParameter
     class << self
       def value(type, value)
         type_class = [type].flatten.first
-        array_type = type.is_a?(Array)
-        parameter_type = type_class < TypedParameter::Base
 
-        if parameter_type
-          array_type ? parameter_array(type_class, value) : type.permit(value)
+        if type_class < TypedParameter::Base
+          type.is_a?(Array) ? parameter_array(type_class, value) : type.permit(value)
         else
-          constraint = "TypedParameter::Constraints::#{type_class}Constraint".safe_constantize
+          constraint = TypedParameter::Constraints[type_class.name.to_sym]
           constraint ||= TypedParameter::Constraints::StringConstraint # Default
 
-          array_type ? constraint_array(constraint, value) : constraint.value(value)
+          type.is_a?(Array) ? constraint_array(constraint, value) : constraint.value(value)
         end
       end
 
+      private
+
       def parameter_array(parameter_class, values)
         values.map { |value| parameter_class.permit(value) }
       end

data/lib/typed_parameter/version.rb

@@ -1,3 +1,3 @@
 module TypedParameter
-  VERSION = '0.2.0'.freeze
+  VERSION = '0.6.0'.freeze
 end

data/lib/typed_parameter.rb

@@ -1,4 +1,4 @@
-require 'typed_parameter/boolean' # For Booelan Class Define
+require 'typed_parameter/boolean.rb' # For Booelan Class Define
 
 require 'typed_parameter/version'
 require 'typed_parameter/parameter_types'
@@ -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/typed_parameter.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.homepage              = 'https://github.com/tranquilthink/typed-parameter'
   spec.license               = 'MIT'
   spec.platform              = Gem::Platform::RUBY
-  spec.required_ruby_version = '>= 3.0.0'
+  spec.required_ruby_version = '>= 2.7.0'
 
   # spec.metadata['allowed_push_host'] = "https://github.com/tranquilthink/typed-parameter"
   spec.metadata['homepage_uri'] = spec.homepage
@@ -27,7 +27,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   # Dependencies
-  spec.add_dependency 'rails', '~> 6.1'
+  spec.add_dependency 'rails'
 
   # Test Dependencies
   spec.add_development_dependency 'rspec'

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: typed-parameter
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Minwoo Jo
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-03-07 00:00:00.000000000 Z
+date: 2022-02-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -61,11 +61,12 @@ files:
 - lib/typed_parameter/constraints/base.rb
 - lib/typed_parameter/constraints/boolean_constraint.rb
 - lib/typed_parameter/constraints/date_constraint.rb
-- lib/typed_parameter/constraints/datetime_constraint.rb
+- lib/typed_parameter/constraints/date_time_constraint.rb
 - lib/typed_parameter/constraints/float_constraint.rb
 - 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
@@ -74,8 +75,8 @@ files:
 - lib/typed_parameter/swagger/types.rb
 - lib/typed_parameter/swagger/types/base.rb
 - lib/typed_parameter/swagger/types/boolean_type.rb
+- lib/typed_parameter/swagger/types/date_time_type.rb
 - lib/typed_parameter/swagger/types/date_type.rb
-- lib/typed_parameter/swagger/types/datetime_type.rb
 - lib/typed_parameter/swagger/types/float_type.rb
 - lib/typed_parameter/swagger/types/integer_type.rb
 - lib/typed_parameter/swagger/types/string_type.rb
@@ -97,7 +98,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.0.0
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="