typed-parameter 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8e0f46ef3693b82ba2c85964aba75468b69971855dbe6cff28e8b6c7c66d2f74
-  data.tar.gz: 2a3d91c2d8d229bb89336bd891db8169494619d996f6ec2553a14ffc213733b6
+  metadata.gz: d5a39f98f145cc8ca6739aaa4bf0a729264be875ed09ba6308f7f3064870245c
+  data.tar.gz: 9ada066d064730b375493ead65ba4c594eecd690f2dca4be89bbb12232bcb3fd
 SHA512:
-  metadata.gz: 798e72cc8eefdd41e684ab5e9df6c0513a4bdaed0559136e8c0839a51113e2c696f229d751dbae83f664d7a642e5cb6d1df7ab3fa5a9bae00ac4dbc976d11a1b
-  data.tar.gz: a1d9565b84129234acf6cb683c10762751b62b2de77e4dc15842c71e413881e0d4c5e6d3ddaef9d4f3cd8a877de8a68cb3deb677079f54af838796d2c62aa17d
+  metadata.gz: 4b3165b35201ee612aca228d6ea55ac271bae117333cec8a6b5028b4c5bbc7021964618e6f94b4724b63893afc594906e9d8f135ae0feb5e99edadd61a2e4947
+  data.tar.gz: 815563901ab5685a3122caf11a280070d63da903cac667784e826721df94c58dabae3f3e115723819082f67ecb67923fd67a57501911060c4a710658aea81e31

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+- 2021-03-06
+	- 
+	- Release TypedParameter 

data/README.md

@@ -1,9 +1,6 @@
 # TypedParameter
-
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/typed-parameter`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
-
+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
 
 Add this line to your application's Gemfile:
@@ -22,7 +19,156 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+Example 1. Type convert
+-----
+~~~ruby
+class UserCreateParams < TypedParamter::Base
+  field :name, String
+  field :age, Integer
+  field :email, String
+end
+-----------------------------------------------
+############
+## before ##
+############
+# method for params
+def user_create_params
+  params.permit(:name, :age, :email)
+end
+
+# in action
+def create
+  raise UserAgeTooYoung if user_create_params[:age].to_i < 20 
+  # You need to convert your parameter type
+end
+
+############
+## after ###
+############
+# method for params
+def user_create_params
+  UserCreateParams.permit(params)
+end
+
+# in action
+def create
+  raise UserAgeTooYoung if user_create_params[:age] < 20 
+  # paramters are converted as your type
+end
+~~~
+
+
+Example 2. More Types
+------
+~~~ruby
+class CustomParameter < TypedParameter::Base
+  field :string_field, String
+  field :integer_field, Integer
+  field :float_field, Float
+  field :date_field, Date
+  field :datetime_field, DateTime
+  field :boolean_field, Boolean
+end
+
+############
+## before ##
+############
+def custom_params
+  params.permit(
+   :string_field,  # => is_a? String
+   :integer_field, # => is_a? String. You need to &:to_i
+   :fload_field,   # => is_a? String. You need to &:to_f
+   :date_field,    # => is_a? String. You need to &:to_date
+   :datetime_field # => is_a? String. You need to &:to_datetime
+   :boolean_field  # => is_a? Boolean. If paramter is string (like "false") then String
+  )
+end
+
+############
+## after ##
+############
+def custom_params
+  CustomParamter.permit(params)
+end
+
+custom_params[:string_field] # => is_a? String
+custom_params[:integer_field] # => is_a? Integer
+custom_params[:float_field] # => is_a? Float
+custom_params[:date_field] # => is_a? Date
+custom_params[:datetime_field] # => is_a? DateTime
+custom_params[:boolean] # => is_a? Boolean, If parameter is string (like "false", "true" "False", "True") then convert true or false
+~~~
+
+Example 3. Enum & Required
+---
+~~~ruby
+class EnumAndRequiredParameter < TypedParameter::base
+  field :enum_field, Integer, enum: [10, 20, 30, 40]
+  field :required_field, String, required: true
+end
+
+def enum_and_required_params
+  EnumAndRequiredParameter.permit(params)
+end
+
+# If params[:enum_field] has 25 ( not in 10, 20, 30, 40)
+# => ArgumentError, "enum_field must be in 10, 20, 30, 40"
+
+# if params[:required_field] is Nil
+# => ArgumentError, "required_field is required"
+~~~
+
+Example 4. array & nested parameters 
+---
+~~~ruby
+class ParentParameter < TypedParameter::Base
+  field :name, String
+  field :integers, [Integer]
+  field :child, ChildParameter
+  field :childs, [ChildParamter]
+end
+
+class ChildParameter < TypedParameter::Base
+  field :name, String
+end
+
+
+example_params = { 
+  name: "Name", 
+  integers: ['1','2','3','4'], 
+  child: { name: "child" },
+  childs: [ 
+    { name: "child1", age: "10" },
+    { name: "child2", age: "12" },
+    { name: "child3", age: "15" }
+  ]
+}
+
+def parent_and_childs_params
+  ParentParams.permit(example_params)
+end
+
+# Result
+{
+  name: "Name",
+  integers: [1,2,3,4],
+  child: { name: "child" },
+  childs: [ 
+    { name: "child1" },
+    { name: "child2" },
+    { name: "child3" }
+  ]
+}
+
+~~~
+Example 4. CustomType
+------
+...
+
+Example 5. Swaggerize
+------
+...
+
 
 ## Development
 

data/lib/typed_parameter.rb

@@ -12,6 +12,7 @@ require 'typed_parameter/swagger/types'
 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

data/lib/typed_parameter/constraints.rb

@@ -1,49 +1,7 @@
-# frozen_string_literal: true
-
-module TypedParameter
-  class Constraints
-    def self.value(_v)
-      nil
-    end
-
-    class IntegerConstraint < self
-      def self.value(value)
-        value.to_i
-      end
-    end
-
-    class FloatConstraint < self
-      def self.value(value)
-        value.to_f
-      end
-    end
-
-    class StringConstraint < self
-      def self.value(value)
-        value.to_s
-      end
-    end
-
-    class BooleanConstraint < self
-      TRUE_VALUES  = [true, 'true', '1', 1].freeze
-      FALSE_VALUES = [false, 'false', '0', 0].freeze
-
-      def self.value(value)
-        return true if TRUE_VALUES.include?(value)
-        return false if FALSE_VALUES.include?(value)
-      end
-    end
-
-    class DateConstraint < self
-      def self.value(value)
-        value.to_date
-      end
-    end
-
-    class DateTimeConstraint < self
-      def self.value(value)
-        value.to_datetime
-      end
-    end
-  end
-end
+require 'typed_parameter/constraints/base'
+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/boolean_constraint'

data/lib/typed_parameter/constraints/base.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module TypedParameter
+  module Constraints
+    class Base
+      def self.value(value)
+        raise NotImplementedError, "need to implement"
+      end
+    end
+  end
+end

data/lib/typed_parameter/constraints/boolean_constraint.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module TypedParameter
+  module Constraints
+    class BooleanConstraint < Base
+      TRUE_VALUES  = [true, 'true', '1', 1].freeze
+      FALSE_VALUES = [false, 'false', '0', 0].freeze
+
+      def self.value(value)
+        return true if TRUE_VALUES.include?(value)
+        return false if FALSE_VALUES.include?(value)
+      end
+    end
+  end
+end

data/lib/typed_parameter/constraints/date_constraint.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module TypedParameter
+  module Constraints
+    class DateConstraint < Base
+      def self.value(value)
+        value.to_date
+      end
+    end
+  end
+end

data/lib/typed_parameter/constraints/datetime_constraint.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module TypedParameter
+  module Constraints
+    class DateTimeConstraint < Base
+      def self.value(value)
+        value.to_datetime
+      end
+    end
+  end
+end

data/lib/typed_parameter/constraints/float_constraint.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module TypedParameter
+  module Constraints
+    class FloatConstraint < Base
+      def self.value(value)
+        value.to_f
+      end
+    end
+  end
+end

data/lib/typed_parameter/constraints/integer_constraint.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module TypedParameter
+  module Constraints
+    class IntegerConstraint < Base
+      def self.value(value)
+        value.to_i
+      end
+    end
+  end
+end

data/lib/typed_parameter/constraints/string_constraint.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module TypedParameter
+  module Constraints
+    class StringConstraint < Base
+      def self.value(value)
+        value.to_s
+      end
+    end
+  end
+end

data/lib/typed_parameter/parameter_types.rb

@@ -1,6 +1,21 @@
 module TypedParameter
   module ParameterTypes
-    BASE_TYPES = [Integer, Float, String, Date, DateTime, Boolean].freeze
-    CUSTOM_TYPES = [].freeze
+    class << self
+      def register(type)
+        @types ||= []
+        @types << type
+      end
+
+      def types
+        @types.freeze
+      end
+    end
   end
-end
+end
+
+TypedParameter::ParameterTypes.register Integer
+TypedParameter::ParameterTypes.register String
+TypedParameter::ParameterTypes.register Float
+TypedParameter::ParameterTypes.register Date
+TypedParameter::ParameterTypes.register DateTime
+TypedParameter::ParameterTypes.register Boolean

data/lib/typed_parameter/permit_field_generator.rb

@@ -1,7 +1,7 @@
 module TypedParameter
   module PermitFieldGenerator
     class << self
-      BASE_TYPES = TypedParameter::ParameterTypes::BASE_TYPES
+      BASE_TYPES = TypedParameter::ParameterTypes.types
 
       def generate(name, type)
         props = generate_properties(type)

data/lib/typed_parameter/swagger/type_generator.rb

@@ -2,9 +2,6 @@ module TypedParameter
   module Swagger
     module TypeGenerator
       class << self
-        BASE_TYPES = TypedParameter::ParameterTypes::BASE_TYPES
-        CUSTOM_TYPES = TypedParameter::ParameterTypes::CUSTOM_TYPES
-
         def generate(type)
           return array_generate(type) if type.is_a? Array
           return hash_generate(type) if type.is_a? Hash

data/lib/typed_parameter/swagger/types.rb

@@ -1,45 +1,7 @@
-module TypedParameter
-  module Swagger
-    class Types
-      def self.value
-        raise NotImplementedError, 'You need to implement this method'
-      end
-
-      class IntegerType
-        def self.value
-          { type: :integer }
-        end
-      end
-
-      class FloatType
-        def self.value
-          { type: :number, format: :float }
-        end
-      end
-
-      class StringType
-        def self.value
-          { type: :string }
-        end
-      end
-
-      class BooleanType
-        def self.value
-          { type: :boolean }
-        end
-      end
-
-      class DateTimeType
-        def self.value
-          { type: :string, format: :datetime }
-        end
-      end
-
-      class DateType
-        def self.value
-          { type: :string, format: :date }
-        end
-      end
-    end
-  end
-end
+require 'typed_parameter/swagger/types/base'
+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/boolean_type'

data/lib/typed_parameter/swagger/types/base.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module TypedParameter
+  module Swagger
+    module Types
+      class Base
+        def self.value
+          raise NotImplementedError, 'You need to implement this method'
+        end
+      end
+    end
+  end
+end

data/lib/typed_parameter/swagger/types/boolean_type.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module TypedParameter
+  module Swagger
+    module Types
+      class BooleanType < Base
+        def self.value
+          { type: :boolean }
+        end
+      end
+    end
+  end
+end

data/lib/typed_parameter/swagger/types/date_type.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module TypedParameter
+  module Swagger
+    module Types
+      class DateType < Base
+        def self.value
+          { type: :string, format: :date }
+        end
+      end
+    end
+  end
+end

data/lib/typed_parameter/swagger/types/datetime_type.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module TypedParameter
+  module Swagger
+    module Types
+      class DateTimeType < Base
+        def self.value
+          { type: :string, format: :datetime }
+        end
+      end
+    end
+  end
+end

data/lib/typed_parameter/swagger/types/float_type.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module TypedParameter
+  module Swagger
+    module Types
+      class FloatType < Base
+        def self.value
+          { type: :number, format: :float }
+        end
+      end
+    end
+  end
+end

data/lib/typed_parameter/swagger/types/integer_type.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module TypedParameter
+  module Swagger
+    module Types
+      class IntegerType < Base
+        def self.value
+          { type: :integer }
+        end
+      end
+    end
+  end
+end

data/lib/typed_parameter/swagger/types/string_type.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module TypedParameter
+  module Swagger
+    module Types
+      class StringType < Base
+        def self.value
+          { type: :string }
+        end
+      end
+    end
+  end
+end

data/lib/typed_parameter/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: typed-parameter
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Minwoo Jo
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-03-06 00:00:00.000000000 Z
+date: 2021-03-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -48,6 +48,7 @@ files:
 - ".gitignore"
 - ".rubocop.yml"
 - ".ruby-version"
+- CHANGELOG.md
 - Gemfile
 - README.md
 - Rakefile
@@ -57,6 +58,13 @@ files:
 - lib/typed_parameter/base.rb
 - lib/typed_parameter/boolean.rb
 - lib/typed_parameter/constraints.rb
+- 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/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/parameter_types.rb
 - lib/typed_parameter/permit_field_generator.rb
@@ -64,6 +72,13 @@ files:
 - lib/typed_parameter/swagger/property_generator.rb
 - lib/typed_parameter/swagger/type_generator.rb
 - 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_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
 - lib/typed_parameter/type_constraint.rb
 - lib/typed_parameter/version.rb
 - typed_parameter.gemspec