typed-parameter 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8e0f46ef3693b82ba2c85964aba75468b69971855dbe6cff28e8b6c7c66d2f74
+  data.tar.gz: 2a3d91c2d8d229bb89336bd891db8169494619d996f6ec2553a14ffc213733b6
+SHA512:
+  metadata.gz: 798e72cc8eefdd41e684ab5e9df6c0513a4bdaed0559136e8c0839a51113e2c696f229d751dbae83f664d7a642e5cb6d1df7ab3fa5a9bae00ac4dbc976d11a1b
+  data.tar.gz: a1d9565b84129234acf6cb683c10762751b62b2de77e4dc15842c71e413881e0d4c5e6d3ddaef9d4f3cd8a877de8a68cb3deb677079f54af838796d2c62aa17d

data/.gitignore

@@ -0,0 +1,13 @@
+*.gem
+coverage/*
+Gemfile.lock
+*~
+.bundle
+.rvmrc
+log/*
+measurement/*
+pkg/*
+.DS_Store
+.env
+spec/dummy/tmp/*
+spec/dummy/log/*.log

data/.rubocop.yml

@@ -0,0 +1,53 @@
+# inherit_from: .rubocop_todo.yml
+
+AllCops:
+  NewCops: enable
+  SuggestExtensions: false
+Layout/SpaceBeforeBrackets: # (new in 1.7)
+  Enabled: true
+Layout/HashAlignment:
+  Enabled: true
+  EnforcedColonStyle: table
+Lint/AmbiguousAssignment: # (new in 1.7)
+  Enabled: true
+Lint/DuplicateBranch: # (new in 1.3)
+  Enabled: true
+Lint/DuplicateRegexpCharacterClassElement: # (new in 1.1)
+  Enabled: true
+Lint/EmptyBlock: # (new in 1.1)
+  Enabled: true
+Lint/EmptyClass: # (new in 1.3)
+  Enabled: true
+Lint/NoReturnInBeginEndBlocks: # (new in 1.2)
+  Enabled: true
+Lint/ToEnumArguments: # (new in 1.1)
+  Enabled: true
+Lint/UnexpectedBlockArity: # (new in 1.5)
+  Enabled: true
+Lint/UnmodifiedReduceAccumulator: # (new in 1.1)
+  Enabled: true
+Style/ArgumentsForwarding: # (new in 1.1)
+  Enabled: true
+Style/CollectionCompact: # (new in 1.2)
+  Enabled: true
+Style/DocumentDynamicEvalDefinition: # (new in 1.1)
+  Enabled: true
+Style/HashExcept: # (new in 1.7)
+  Enabled: true
+Style/NegatedIfElseCondition: # (new in 1.2)
+  Enabled: true
+Style/NilLambda: # (new in 1.3)
+  Enabled: true
+Style/RedundantArgument: # (new in 1.4)
+  Enabled: true
+Style/SwapValues: # (new in 1.1)
+  Enabled: true
+Style/StringLiterals:
+  Enabled: true
+Style/AsciiComments:
+  Enabled: false
+Style/Documentation:
+  Enabled: false
+Style/FrozenStringLiteralComment:
+  Enabled: true
+  EnforcedStyle: always_true

data/.ruby-version

@@ -0,0 +1 @@
+3.0.0

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in typed_parameter.gemspec
+gemspec
+
+gem 'rake', '~> 12.0'

data/README.md

@@ -0,0 +1,36 @@
+# 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
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'typed-parameter'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install typed-parameter
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/typed-parameter.
+

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "typed_parameter"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/typed_parameter.rb

@@ -0,0 +1,17 @@
+require 'typed_parameter/boolean' # For Booelan Class Define
+
+require 'typed_parameter/version'
+require 'typed_parameter/parameter_types'
+require 'typed_parameter/constraints'
+require 'typed_parameter/enum_constraint'
+require 'typed_parameter/type_constraint'
+require 'typed_parameter/permit_field_generator'
+require 'typed_parameter/base'
+
+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/base.rb

@@ -0,0 +1,74 @@
+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
+
+      def permit(params)
+        raise ArgumentError unless params.class <= ActionController::Parameters
+
+        use_constraints params.permit(fields)
+      end
+
+      def fields
+        __fields.freeze
+      end
+
+      def swagger_properties
+        __swagger_properties.freeze
+      end
+
+      alias key name
+
+      def ref
+        "#/components/schemas/#{key}"
+      end
+
+      private
+
+      def initialize_swagger_properties(name, type, kargs)
+        swagger_type = TypedParameter::Swagger::TypeGenerator.generate(type)
+        swagger_options = swagger_type.merge(kargs)
+        __swagger_properties[name] = swagger_options
+      end
+
+      def initialize_permitted_fields(name, type)
+        __fields << PermitFieldGenerator.generate(name, type)
+      end
+
+      def initialize_constraints(name, type, kargs)
+        options = kargs.slice(:enum, :required)
+
+        __constraints << [name, type, options]
+      end
+
+      def use_constraints(params)
+        __constraints.each do |name, type, options|
+          value = params[name]
+          raise ArgumentError, "(#{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]
+        end
+
+        params
+      end
+
+      def __fields
+        @__fields ||= []
+      end
+
+      def __constraints
+        @__constraints ||= []
+      end
+
+      def __swagger_properties
+        @__swagger_properties ||= {}
+      end
+    end
+  end
+end

data/lib/typed_parameter/boolean.rb

@@ -0,0 +1,19 @@
+return if defined? Boolean
+
+class Boolean; end
+
+class TrueClass
+  def is_a?(type)
+    return true if type == Boolean
+
+    super(type)
+  end
+end
+
+class FalseClass
+  def is_a?(type)
+    return true if type == Boolean
+
+    super(type)
+  end
+end

data/lib/typed_parameter/constraints.rb

@@ -0,0 +1,49 @@
+# 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

data/lib/typed_parameter/enum_constraint.rb

@@ -0,0 +1,10 @@
+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
+
+      value
+    end
+  end
+end

data/lib/typed_parameter/parameter_types.rb

@@ -0,0 +1,6 @@
+module TypedParameter
+  module ParameterTypes
+    BASE_TYPES = [Integer, Float, String, Date, DateTime, Boolean].freeze
+    CUSTOM_TYPES = [].freeze
+  end
+end

data/lib/typed_parameter/permit_field_generator.rb

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

data/lib/typed_parameter/swagger/component_generator.rb

@@ -0,0 +1,14 @@
+module TypedParameter
+  module Swagger
+    module ComponentGenerator
+      class << self
+        def generate(parameter_class)
+          key = parameter_class.key
+          properties = Swagger::PropertyGenerator.generate(parameter_class.swagger_properties)
+
+          { "#{key}": { type: :object, properties: properties } }
+        end
+      end
+    end
+  end
+end

data/lib/typed_parameter/swagger/property_generator.rb

@@ -0,0 +1,28 @@
+module TypedParameter
+  module Swagger
+    module PropertyGenerator
+      class << self
+        def generate(swagger_properties)
+          swagger_properties.transform_values do |options|
+            next { "$ref": ref(options[:ref]) } if options[:ref].present?
+
+            if options[:type] == :array
+              items = options[:items].dup
+              if items[:ref].present?
+                ref = items.delete(:ref)
+                items['$ref'] = ref(ref)
+                options[:items] = items
+              end
+            end
+
+            options
+          end
+        end
+
+        def ref(ref_component)
+          "#/components/schemas/#{ref_component.key}"
+        end
+      end
+    end
+  end
+end

data/lib/typed_parameter/swagger/type_generator.rb

@@ -0,0 +1,28 @@
+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
+
+          swagger_type = "TypedParameter::Swagger::Types::#{type.name}Type".safe_constantize
+          swagger_type&.value || { ref: type }
+        end
+
+        def hash_generate(hash)
+          h = hash.transform_values { |value| generate(value) }
+
+          { type: :object, properties: h }
+        end
+
+        def array_generate(type)
+          { type: :array, items: generate(type[0]) } 
+        end
+      end
+    end
+  end
+end

data/lib/typed_parameter/swagger/types.rb

@@ -0,0 +1,45 @@
+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

data/lib/typed_parameter/type_constraint.rb

@@ -0,0 +1,28 @@
+module TypedParameter
+  module TypeConstraint
+    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)
+        else
+          constraint = "TypedParameter::Constraints::#{type_class}Constraint".safe_constantize
+          constraint ||= TypedParameter::Constraints::StringConstraint # Default
+
+          array_type ? constraint_array(constraint, value) : constraint.value(value)
+        end
+      end
+
+      def parameter_array(parameter_class, values)
+        values.map { |value| parameter_class.permit(value) }
+      end
+
+      def constraint_array(constraint, values)
+        values.map { |value| constraint.value(value) }
+      end
+    end
+  end
+end

data/lib/typed_parameter/version.rb

@@ -0,0 +1,3 @@
+module TypedParameter
+  VERSION = '0.1.0'
+end

data/typed_parameter.gemspec

@@ -0,0 +1,34 @@
+require File.expand_path('lib/typed_parameter/version', __dir__)
+
+Gem::Specification.new do |spec|
+  spec.name                  = 'typed-parameter'
+  spec.version               = TypedParameter::VERSION
+  spec.authors               = ['Minwoo Jo']
+  spec.email                 = ['tranquilthink@example.com']
+  spec.summary               = 'Typed Paramter For Rails'
+  spec.description           = 'Create typed parameter class using strong paramter in rails'
+  spec.homepage              = 'https://github.com/tranquilthink/typed-parameter'
+  spec.license               = 'MIT'
+  spec.platform              = Gem::Platform::RUBY
+  spec.required_ruby_version = '>= 3.0.0'
+
+  # spec.metadata['allowed_push_host'] = "https://github.com/tranquilthink/typed-parameter"
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/tranquilthink/typed-parameter'
+  spec.metadata['changelog_uri'] = 'https://github.com/tranquilthink/typed-parameter/blob/master/CHANGELOG.md'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  # Dependencies
+  spec.add_dependency 'rails', '~> 6.1'
+
+  # Test Dependencies
+  spec.add_development_dependency 'rspec'
+end

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: typed-parameter
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Minwoo Jo
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-03-06 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'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.1'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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'
+description: Create typed parameter class using strong paramter in rails
+email:
+- tranquilthink@example.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".ruby-version"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/typed_parameter.rb
+- lib/typed_parameter/base.rb
+- lib/typed_parameter/boolean.rb
+- lib/typed_parameter/constraints.rb
+- lib/typed_parameter/enum_constraint.rb
+- lib/typed_parameter/parameter_types.rb
+- lib/typed_parameter/permit_field_generator.rb
+- lib/typed_parameter/swagger/component_generator.rb
+- lib/typed_parameter/swagger/property_generator.rb
+- lib/typed_parameter/swagger/type_generator.rb
+- lib/typed_parameter/swagger/types.rb
+- lib/typed_parameter/type_constraint.rb
+- lib/typed_parameter/version.rb
+- typed_parameter.gemspec
+homepage: https://github.com/tranquilthink/typed-parameter
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/tranquilthink/typed-parameter
+  source_code_uri: https://github.com/tranquilthink/typed-parameter
+  changelog_uri: https://github.com/tranquilthink/typed-parameter/blob/master/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.3
+signing_key:
+specification_version: 4
+summary: Typed Paramter For Rails
+test_files: []