gate 0.4.1 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 534592273859c465d6782fd466fe95b2c3a43950
-  data.tar.gz: 0737964adad3f9807f9886faae5ebb28ca26a3e0
+  metadata.gz: 0c5b6793497535f1a64c445c3dc79f96d51ab755
+  data.tar.gz: 8cb64c61b215efbb182cf7a8bc830d1c0d2e5f66
 SHA512:
-  metadata.gz: f974fec5ea5b17c290b3c018ef20b5e42469caafb206cc67912c1d400b2cbdc5902d6e6708e3cbf50a1f7356af1e55c97d6bf7e13d12bc5892bc3fb90c2fb5cd
-  data.tar.gz: 12d81ec727fd3f7063622daf3b4043f6fe5ba9d5ec51c186751932dce367e7c5a341bebfb854538df2b00a75e024c3fcf0f0c2e72f3fed595949071996786a42
+  metadata.gz: 522271efbce236d5a3b71fd5c695dd59fe2a21b823482bba9979481636dafe3247b4dbd5462998500a7e0df74f0546669d7886df80c3e5765dedb26de8b139c0
+  data.tar.gz: e6d172ccbee95ec78413c106a6c7fac857f092e11d6eaeaa353e5dc3b9d0a303ee264f2b2bcf42e771c869528682f95f0883ad0cf0704b4c4dd22ca873191c59

data/.circleci/config.yml

@@ -0,0 +1,9 @@
+version: 2
+jobs:
+  build:
+    docker:
+      - image: circleci/ruby:2.5.0
+    steps:
+      - checkout
+      - run: gem install bundler
+      - run: bundle exec rake

data/.codeclimate.yml

@@ -1,8 +1,4 @@
-engines:
+version: 2
+plugins:
   rubocop:
     enabled: true
-  bundler-audit:
-    enabled: true
-ratings:
-  paths:
-    - "lib/**"

data/README.md

@@ -6,7 +6,7 @@
 [![Code Climate](https://codeclimate.com/github/monterail/gate/badges/gpa.svg)](https://codeclimate.com/github/monterail/gate)
 [![Test Coverage](https://codeclimate.com/github/monterail/gate/badges/coverage.svg)](https://codeclimate.com/github/monterail/gate/coverage)
 
-Gate is a small library which allows you to define allowed structure for user input with required and optional parameters and to coerce them into defined types.
+Gate is a small wrapper on [dry-validation](http://dry-rb.org/gems/dry-validation/) that might be used as Command in CQRS pattern. It will raise `InvalidCommand` error for invalid input and provide simple struct with access to coerced input.
 
 ## Installation
 
@@ -29,38 +29,31 @@ Or install it yourself as:
 Define structure
 
 ```ruby
-gate = Gate.rules do
-  required :id, :Integer
-  required :message do
-    required :title # :String by default
-    optional :value, :Decimal
-    optional :anything, :Any # Just pass through original value
+class DoSomethingCommand
+  include Gate::Command
+
+  schema do
+    required(:id).filled
+    required(:message).schema do
+      required(:title).filled
+      optional(:value).maybe(:decimal?)
+    end
   end
 end
 ```
 
-Verify it
+Use it
 
 ```ruby
-result = gate.verify(params)
-result.valid? # => true / false
-result.attributes # => hash with only allowed parameters
-result.errors # => hash { key => error }
-```
-
-If you need to handle `nil` values you can use `allow_nil` flag:
-
-```ruby
-gate = Gate.rules do
-  required :id, :Integer, allow_nil: true
-  required :message, allow_nil: true do
-    required :title
-    optional :value, :Decimal
-  end
+begin
+  cmd = DoSomethingCommand.with(params)
+  cmd.id
+  cmd.message
+rescue DoSomethingCommand::InvalidCommand => e
+  e.errors # => hash { key => [errors] }
 end
 ```
 
-
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment.

data/gate.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Jan Dudulski"]
   spec.email         = ["jan@dudulski.pl"]
 
-  spec.summary       = "Handling user input with ease"
+  spec.summary       = "CQRS Command"
   spec.description   = "Validate and coerce user input against defined structure."
   spec.homepage      = "https://github.com/monterail/gate"
   spec.license       = "MIT"
@@ -17,12 +17,11 @@ Gem::Specification.new do |spec|
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^test/}) }
   spec.require_paths = ["lib"]
 
-  spec.add_runtime_dependency "coercible", "~> 1.0"
-  spec.add_runtime_dependency "axiom-types", "~> 0.1"
+  spec.add_runtime_dependency "dry-validation", "~> 0.11"
 
-  spec.add_development_dependency "bundler", "~> 1.9"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "pry", "~> 0.10"
-  spec.add_development_dependency "minitest", "~> 5.7"
-  spec.add_development_dependency "codeclimate-test-reporter", "~> 0.4"
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 12.0"
+  spec.add_development_dependency "pry", "~> 0.11"
+  spec.add_development_dependency "minitest", "~> 5.11"
+  spec.add_development_dependency "codeclimate-test-reporter", "~> 1.0"
 end

data/lib/gate.rb

@@ -1,21 +1,8 @@
 module Gate
-  class CoercionError < StandardError; end
-
-  def self.rules(&block)
-    configuration = Configuration.new(&block)
-
-    Guard.new(configuration)
-  end
+  InvalidCommand = Class.new(StandardError)
 end
 
-require "axiom-types"
-require "coercible"
-require "forwardable"
-require "set"
+require "dry-validation"
 
-require "gate/coercer"
-require "gate/coercer/any"
-require "gate/configuration"
-require "gate/guard"
-require "gate/result"
+require "gate/command"
 require "gate/version"

data/lib/gate/command.rb

@@ -0,0 +1,47 @@
+module Gate
+  module Command
+    SchemaAlreadyRegistered = Class.new(StandardError)
+    SchemaNotDefined = Class.new(StandardError)
+
+    class InvalidCommand < StandardError
+      attr_reader :errors
+
+      def initialize(errors)
+        @errors = errors
+        super("Invalid command")
+      end
+    end
+
+    def self.included(base)
+      base.send(:extend, ClassMethods)
+      base.send(:attr_reader, :result)
+    end
+
+    def initialize(data)
+      @result = data
+    end
+
+    module ClassMethods
+      def schema(&block)
+        if block_given?
+          raise SchemaAlreadyRegistered if @schema
+          @schema = Dry::Validation.Form(&block)
+          @schema.rules.keys.each do |name|
+            define_method(name) do
+              result[name]
+            end
+          end
+        else
+          raise SchemaNotDefined unless @schema
+          @schema
+        end
+      end
+
+      def with(input)
+        result = schema.(input)
+        raise InvalidCommand, result.messages if result.failure?
+        new result.output
+      end
+    end
+  end
+end

data/lib/gate/version.rb

@@ -1,3 +1,3 @@
 module Gate
-  VERSION = "0.4.1"
+  VERSION = "0.5.0"
 end

metadata

@@ -1,113 +1,99 @@
 --- !ruby/object:Gem::Specification
 name: gate
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.5.0
 platform: ruby
 authors:
 - Jan Dudulski
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-23 00:00:00.000000000 Z
+date: 2018-03-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: coercible
+  name: dry-validation
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '0.11'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
-- !ruby/object:Gem::Dependency
-  name: axiom-types
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.1'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '0.11'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.9'
+        version: '1.16'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.9'
+        version: '1.16'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.0'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.10'
+        version: '0.11'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.10'
+        version: '0.11'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.7'
+        version: '5.11'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.7'
+        version: '5.11'
 - !ruby/object:Gem::Dependency
   name: codeclimate-test-reporter
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.4'
+        version: '1.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.4'
+        version: '1.0'
 description: Validate and coerce user input against defined structure.
 email:
 - jan@dudulski.pl
@@ -115,6 +101,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".circleci/config.yml"
 - ".codeclimate.yml"
 - ".gitignore"
 - ".rubocop.yml"
@@ -125,14 +112,9 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
-- circle.yml
 - gate.gemspec
 - lib/gate.rb
-- lib/gate/coercer.rb
-- lib/gate/coercer/any.rb
-- lib/gate/configuration.rb
-- lib/gate/guard.rb
-- lib/gate/result.rb
+- lib/gate/command.rb
 - lib/gate/version.rb
 homepage: https://github.com/monterail/gate
 licenses:
@@ -154,8 +136,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.6.14
 signing_key: 
 specification_version: 4
-summary: Handling user input with ease
+summary: CQRS Command
 test_files: []

data/circle.yml

@@ -1,3 +0,0 @@
-machine:
-  ruby:
-    version: 2.2.0

data/lib/gate/coercer.rb

@@ -1,48 +0,0 @@
-module Gate
-  class Coercer
-    PRIMITIVES = [TrueClass, FalseClass, Array, Hash, Numeric]
-
-    def initialize(engine, type, allow_nil: false)
-      unless coercible?(type)
-        fail CoercionError, "Doesn't know how to coerce into #{type}"
-      end
-
-      @engine = engine
-      @type = type
-      @allow_nil = allow_nil
-    end
-
-    def coerce(input)
-      engine[detect_input_type(input)].public_send(coercion_method, input)
-    rescue Coercible::UnsupportedCoercion
-      raise CoercionError, "Doesn't know how to coerce #{input} into #{type}"
-    end
-
-    def allow_nil?
-      @allow_nil
-    end
-
-    private
-
-    attr_reader :engine, :type
-
-    def coercible?(type)
-      type == :Any or Axiom::Types.const_defined?(type)
-    end
-
-    def detect_input_type(input)
-      case input
-      when *PRIMITIVES, Any
-        input.class
-      else
-        String
-      end
-    end
-
-    def coercion_method
-      return :to_any if type == :Any
-
-      Axiom::Types.const_get(type).coercion_method
-    end
-  end
-end

data/lib/gate/coercer/any.rb

@@ -1,7 +0,0 @@
-require 'coercible'
-
-class Gate::Coercer::Any < Coercible::Coercer::Object
-  def to_any(value)
-    value
-  end
-end

data/lib/gate/configuration.rb

@@ -1,55 +0,0 @@
-module Gate
-  class Configuration
-    extend Forwardable
-
-    attr_reader :coercer
-    attr_reader :required_set, :optional_set, :nested_set
-    attr_reader :rules
-
-    def_delegator :@rules, :reduce
-
-    def initialize(coercer: Coercible::Coercer.new, allow_nil: false, &block)
-      @coercer = coercer
-      @required_set = Set.new
-      @optional_set = Set.new
-      @nested_set = Set.new
-      @rules = {}
-      @allow_nil = allow_nil
-
-      instance_eval(&block)
-    end
-
-    def required?(name)
-      required_set.include?(name)
-    end
-
-    def allow_nil?
-      @allow_nil
-    end
-
-    private
-
-    def required(name, type = :String, allow_nil: false, &block)
-      required_set.add(name)
-      register(name, type, allow_nil: allow_nil, &block)
-    end
-
-    def optional(name, type = :String, allow_nil: false,  &block)
-      optional_set.add(name)
-      register(name, type, allow_nil: allow_nil, &block)
-    end
-
-    def register(name, type, allow_nil:, &block)
-      @rules[name] = setup_rule(name, type, allow_nil: allow_nil, &block)
-    end
-
-    def setup_rule(name, type, allow_nil:, &block)
-      if block_given?
-        nested_set.add(name)
-        Configuration.new(coercer: coercer, allow_nil: allow_nil, &block)
-      else
-        Coercer.new(coercer, type, allow_nil: allow_nil)
-      end
-    end
-  end
-end

data/lib/gate/guard.rb

@@ -1,67 +0,0 @@
-module Gate
-  class Guard
-    attr_reader :configuration
-
-    def initialize(configuration)
-      @configuration = configuration
-    end
-
-    def verify(input)
-      configuration.reduce(Result.new) do |result, (name, rule)|
-        Result.new(_verify(input, name, rule, result))
-      end
-    end
-
-    private
-
-    def _verify(input, name, rule, result)
-      case
-      when input.key?(name)
-        coerced = handle(input[name], name, rule)
-        update(result, coerced)
-      when configuration.required?(name)
-        errors = result.errors.merge(name => :missing)
-        update(result, errors: errors)
-      else
-        result.to_h
-      end
-    end
-
-    def handle(input, name, rule)
-      case
-      when input.nil?
-        coerce_nil(name, rule)
-      when rule.is_a?(Gate::Configuration)
-        coerce_nested(input, name, rule)
-      else
-        coerce(input, name, rule)
-      end
-    end
-
-    def coerce(input, name, rule)
-      { attributes: { name => rule.coerce(input) } }
-    rescue CoercionError
-      # TODO: log error
-      { errors: { name => :coercion_error } }
-    end
-
-    def coerce_nested(input, name, rule)
-      result = Gate::Guard.new(rule).verify(input)
-      { attributes: { name => result.attributes },
-        errors: { name => result.errors } }
-    end
-
-    def coerce_nil(name, rule)
-      if rule.allow_nil?
-        { attributes: { name => nil } }
-      else
-        { errors: { name => :nil_not_allowed } }
-      end
-    end
-
-    def update(result, attributes: {}, errors: {})
-      { attributes: result.attributes.merge(attributes),
-        errors: result.errors.merge(errors) }
-    end
-  end
-end

data/lib/gate/result.rb

@@ -1,39 +0,0 @@
-module Gate
-  class Result
-    attr_reader :attributes
-
-    def initialize(attributes: {}, errors: {})
-      @attributes = attributes
-      @errors = errors
-    end
-
-    def valid?
-      errors.empty?
-    end
-
-    def errors
-      _errors(@errors)
-    end
-
-    def to_h
-      {
-        attributes: attributes,
-        errors: @errors
-      }
-    end
-
-    private
-
-    def _errors(hash)
-      hash.each_with_object({}) do |(k, v), result|
-        if v.is_a?(Hash)
-          nested = _errors(v)
-
-          result[k] = nested if nested.any?
-        else
-          result[k] = v
-        end
-      end
-    end
-  end
-end