tomyum 0.1.0.a

data/lib/tomyum/validator.rb

@@ -0,0 +1,205 @@
+require_relative "validators/proxy"
+
+module Tomyum
+  # A validator (can validate any kind of {Attribute}).
+  #
+  # @example Validate simple {Attribute}
+  #   attribute = Attributes.create(:string, :username, required: true)
+  #   payload   = { username: nil }
+  #
+  #   validator = Validator.new(resolver)
+  #   validator.validate(attribute, payload) # => { username: ["can't be blank"] }
+  #
+  # @example Validate compound type (e.g. Object, Array).
+  #   attribute = Attributes.create(:object, :user) do
+  #     string :username, min: 5
+  #     array  :pets, of: :string
+  #   end
+  #   payload   = { username: "john", pets: ["jay", 1] }
+  #
+  #   validator.validate(attribute, payload) # =>
+  #   # {
+  #   #   username: ["is too short (minimum is 5 characters)"]
+  #   #   pets: { 1: ["is not string"] }
+  #   # }
+  class Validator < Tomyum::Attributes::Visitor
+    include Tomyum::Resolvable
+    include Functions
+
+    def initialize(resolver = nil)
+      @resolver = resolver
+    end
+
+    # Overrides to make it accepts 3 arguments
+    def normalize_attribute(attribute, value, options = {})
+      super(attribute, options)
+    end
+
+    # Overrides to make it normalizes value before validating attribute
+    #
+    # @return [Result]
+    def visit(attribute, value, options = {})
+      method, attribute = find_method!(attribute, value, options)
+      value = attribute.normalize(attribute.value(value))
+
+      send(method, attribute, value, options)
+    end
+
+    alias :validate :visit
+
+    # catch-all
+    def visit_attribute(attribute, value, options = {})
+      run(attribute, options, value)
+    end
+
+    def visit_string(attribute, value, options = {})
+      compose(
+        curry(:is_valid?, :string),
+        curry(:run, attribute, options)
+      ).(value)
+    end
+
+    def visit_boolean(attribute, value, options = {})
+      compose(
+        curry(:is_valid?, :boolean),
+        curry(:run, attribute, options),
+      ).(value)
+    end
+
+    def visit_number(attribute, value, options = {})
+      compose(
+        curry(:is_valid?, :number),
+        curry(:run, attribute, options)
+      ).(value)
+    end
+
+    def visit_integer(attribute, value, options = {})
+      compose(
+        curry(:is_valid?, :integer),
+        curry(:run, attribute, options)
+      ).(value)
+    end
+
+    def visit_float(attribute, value, options = {})
+      compose(
+        curry(:is_valid?, :float),
+        curry(:run, attribute, options)
+      ).(value)
+    end
+
+    def visit_array(attribute, value, options = {})
+      compose(
+        curry(:is_valid?, :array),
+        curry(:iterate, value || [], lambda { |(item, v), i|
+
+          # when of: is not specified, item can be any type
+          next result(item) unless attribute.of
+
+          # validate each item
+          visit(attribute.of, item, options)
+        })
+      ).(value)
+    end
+
+    def visit_object(attribute, value, options = {})
+      compose(
+        curry(:is_valid?, :object),
+        curry(:iterate, attribute.attributes, lambda { |(key, attr), i|
+
+          # validate each attribute
+          data = get(value, attr.method)
+          options[:context] = value
+
+          visit(attr, data, options)
+        })
+      ).(value)
+    end
+
+    def visit_schema(attribute, value, options = {})
+      attr = resolver.schema(attribute.of)
+
+      visit_object(attr, value, options)
+    end
+
+    private
+
+    def create_proxy(attr, value, options = {})
+      Tomyum::Validators::Proxy.new(attr, value, options)
+    end
+
+    def get(object, name)
+      return unless object
+
+      object.respond_to?(name) ? object.send(name) : object[name]
+    end
+
+    def run(attribute, options, value)
+      proxy = create_proxy(attribute, value, options)
+      return result(value, proxy.messages) unless proxy.valid?
+
+      result(value)
+    end
+
+    # Iterates through Hash/Array
+    #
+    # @param target Hash|Array
+    # @return [Result]
+    def iterate(target, proc, value)
+      is_hash = target.is_a?(Hash)
+      errors  = {}
+      values  = is_hash ? {} : []
+
+      # When target is a Hash. k = name, v = Attribute.
+      # When it's an Array. k = value, v = nil.
+      target.each.with_index do |(k, v), i|
+        name   = is_hash ? v&.name : i
+        result = proc.([k, v], i)
+
+        if result.errors
+          errors[name] = result.errors
+        else
+          values[name] = result.value
+        end
+      end
+
+      return result(nil, errors) if errors.any?
+
+      result(values)
+    end
+
+    def is_valid?(type, value)
+      return result(value) if value.nil?
+      return result(value, ["is not #{type}"]) unless send("is_#{type}?", value)
+
+      result(value)
+    end
+
+    def is_boolean?(v)
+      [true, false].include?(v)
+    end
+
+    def is_string?(v)
+      v.is_a?(String)
+    end
+
+    def is_number?(v)
+      is_integer?(v) || is_float?(v)
+    end
+
+    def is_integer?(v)
+      v.is_a?(Integer)
+    end
+
+    def is_float?(v)
+      v.is_a?(Float)
+    end
+
+    def is_array?(v)
+      v.is_a?(Array)
+    end
+
+    def is_object?(v)
+      v.is_a?(Hash) || v.is_a?(ActionController::Parameters)
+    end
+  end
+end

data/lib/tomyum/validators/normalizable.rb

@@ -0,0 +1,24 @@
+module Tomyum
+  module Validators
+    module Normalizable
+      extend Tomyum::Support
+
+      included do
+        class << self
+          # Normalizes value before passing it to validator
+          attr_accessor :normalizer
+
+          def normalizer
+            @normalizer || superclass.normalizer
+          end
+        end
+
+        self.normalizer = ->(v) { v }
+      end
+
+      def normalize(value)
+        self.class.normalizer.(value)
+      end
+    end
+  end
+end

data/lib/tomyum/validators/proxy.rb

@@ -0,0 +1,77 @@
+module Tomyum
+  module Validators
+    # Proxy will act as a wrapper for a pair of attribute and value.
+    # It internally creates anonymous model with single attribute.
+    # This will simplify validation process for nested attributes
+    # (let's Visitor handles traversal instead).
+    #
+    # @example
+    #   attribute = String.new(:username)
+    #   value     = "john"
+    #
+    #   proxy = Proxy.new(attribute, value)
+    #   proxy.username # => "john"
+    #   proxy.valid?   # => true|false
+    #   proxy.errors
+    class Proxy
+      include Tomyum::Assertions
+      include ActiveModel::Validations
+
+      attr_reader :value, :validators
+
+      # rails requires this for anonymous model
+      def self.model_name
+        ActiveModel::Name.new(self, nil, name)
+      end
+
+      def initialize(attribute, value = nil, options = {})
+        @attribute = attribute
+        @value     = attribute.value(value)
+        @params    = { attribute.name.to_sym => @value }
+        @context   = options[:context] || {}
+      end
+
+      def valid?
+        # clear validators
+        self.class.clear_validators!
+
+        register(@attribute.validators.dup)
+
+        super
+      end
+
+      # Register validators to model
+      #
+      #   register(presense: true, ..., validators: [Validator1, Validator2, ...])
+      def register(validators)
+        customs = validators.delete(:validators) || []
+
+        # register custom validators (requires :attributes)
+        self.class.validates_with(*customs, attributes: [@attribute.name]) if customs.any?
+
+        # register ActiveModel's validations e.g. presence: true
+        self.class.validates(@attribute.name, validators) if validators.any?
+      end
+
+      def messages
+        errors.messages.values.flatten
+      end
+
+      private
+
+      # Delegates method call to hash accessor e.g. `a.name` will become `a[:name]`
+      # and return `nil` for all undefined attributes e.g. `a.non_exists` => `nil`
+      def method_missing(m, *args, &block)
+        normalize_missing_value m
+      end
+
+      def respond_to_missing?(method, *)
+        @params.key?(method) || super
+      end
+
+      def normalize_missing_value(method)
+        @params.key?(method) ? @value : @context[method]
+      end
+    end
+  end
+end

data/lib/tomyum/validators/validatable.rb

@@ -0,0 +1,48 @@
+module Tomyum
+  module Validators
+    module Validatable
+      extend Tomyum::Support
+
+      included do
+        RULES = {}.freeze
+      end
+
+      # Returns validation rules (rails compatible)
+      def validators
+        rules(self.class::RULES, @options).tap do |rules|
+          rules[:if]         = self.if if self.if
+          rules[:unless]     = self.unless if self.unless
+          rules[:allow_nil]  = true if null
+          rules[:presence]   = true if required
+          rules[:inclusion]  = { in: self.in, allow_blank: true } if self.in
+          rules[:validators] = @options[:validators] if @options[:validators]
+        end
+      end
+
+      private
+
+      # Build validation rules
+      #
+      # @example
+      #   rules = {
+      #     min: { name: :minimum, group: :length }
+      #   }
+      #
+      #   # will be converted to
+      #   {
+      #     length: { minimum: {value} }
+      #   }
+      def rules(rules, options)
+        rules.keys.each_with_object({}) do |name, hash|
+          next if options[name].nil?
+
+          rule = OpenStruct.new rules[name]
+          (hash[rule.group] ||= {}).tap do |r|
+            r[:allow_blank] = true
+            r[rule.name]    = options[name]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/tomyum/version.rb

@@ -0,0 +1,3 @@
+module Tomyum
+  VERSION = "0.1.0.a"
+end

data/lib/tomyum.rb

@@ -0,0 +1,28 @@
+require 'active_model'
+
+require_relative "tomyum/version"
+require_relative "tomyum/support"
+require_relative "tomyum/functions"
+require_relative "tomyum/assertions"
+require_relative "tomyum/error"
+
+require_relative "tomyum/registry"
+require_relative "tomyum/resolvable"
+
+# attributes
+require_relative "tomyum/attributes"
+
+# endpoint
+require_relative "tomyum/endpoint"
+
+# serializer
+require_relative "tomyum/serializer"
+
+# generators
+require_relative "tomyum/generators"
+
+# validators
+require_relative "tomyum/validator"
+
+# resolver
+require_relative "tomyum/resolver"

metadata

@@ -0,0 +1,202 @@
+--- !ruby/object:Gem::Specification
+name: tomyum
+version: !ruby/object:Gem::Version
+  version: 0.1.0.a
+platform: ruby
+authors:
+- Marut K
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-01-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: puma
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+description: A DSL for defining API schemas/endpoints, validating, serializing and
+  generating Open API v3
+email:
+- me@rezigned.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+files:
+- README.md
+- lib/tomyum.rb
+- lib/tomyum/assertions.rb
+- lib/tomyum/attributes.rb
+- lib/tomyum/attributes/array.rb
+- lib/tomyum/attributes/attribute.rb
+- lib/tomyum/attributes/boolean.rb
+- lib/tomyum/attributes/currency.rb
+- lib/tomyum/attributes/date.rb
+- lib/tomyum/attributes/float.rb
+- lib/tomyum/attributes/integer.rb
+- lib/tomyum/attributes/ip_address.rb
+- lib/tomyum/attributes/number.rb
+- lib/tomyum/attributes/object.rb
+- lib/tomyum/attributes/schema.rb
+- lib/tomyum/attributes/string.rb
+- lib/tomyum/attributes/time.rb
+- lib/tomyum/attributes/uri.rb
+- lib/tomyum/attributes/visitor.rb
+- lib/tomyum/endpoint.rb
+- lib/tomyum/endpoints/method.rb
+- lib/tomyum/endpoints/params.rb
+- lib/tomyum/error.rb
+- lib/tomyum/functions.rb
+- lib/tomyum/generators.rb
+- lib/tomyum/generators/generator.rb
+- lib/tomyum/generators/grpc/generator.rb
+- lib/tomyum/generators/open_api/generator.rb
+- lib/tomyum/generators/open_api/property_generator.rb
+- lib/tomyum/registry.rb
+- lib/tomyum/resolvable.rb
+- lib/tomyum/resolver.rb
+- lib/tomyum/serializer.rb
+- lib/tomyum/serializers/serializable.rb
+- lib/tomyum/server/app.rb
+- lib/tomyum/server/document.rb
+- lib/tomyum/server/documents/redoc.rb
+- lib/tomyum/server/documents/swagger.rb
+- lib/tomyum/server/routes.rb
+- lib/tomyum/support.rb
+- lib/tomyum/validator.rb
+- lib/tomyum/validators/normalizable.rb
+- lib/tomyum/validators/proxy.rb
+- lib/tomyum/validators/validatable.rb
+- lib/tomyum/version.rb
+homepage: https://github.com/rezigned/tomyum
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubygems_version: 3.3.3
+signing_key:
+specification_version: 4
+summary: A DSL for defining API schemas/endpoints
+test_files: []