gate 0.10.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 64401d6617c7ebcde128f5e283695475effec0be39a3089ed1a04cc9dd769ec3
-  data.tar.gz: 4f6192608d2110d1053d2cf1ab0b9afe1973cb65dc60bd556ac37d0d26defce7
+  metadata.gz: 3a060433f1f524041e43b2018c267f09296f33c9d62f9ca13fd2ca13d171f09d
+  data.tar.gz: e63df883e61a45ea42436cca24e53a750bfda2bea13a74351d55b005d251119a
 SHA512:
-  metadata.gz: 76c705ee8b4c09b172b73433487376781683fb1b6619168ad1972557046f2e6f4d831e776ffd91746f4b9b17a2f36a7b6831768453208a61857076602f991b8d
-  data.tar.gz: 0bf7be2a899cf05f60eeaea97703944ed563f4f7e5dd46565e77858455d65832ed21a11f50dd8b774ca56df8d3db3ae722e9554df47bd3d097349134c68c32a9
+  metadata.gz: b891269e835a23d6255fd3fd1fb6a5eceb7f65b933816e48832581fd306d52f6344dac5ff1dfb5da06e2be1e8901d6940d76889937d5174cc68628050bdfcc36
+  data.tar.gz: dcafe4902a3471e0eb0d40d14f74abc28775cddb67bbb6a6658c6f53cb9f9ab35029316f5ec29d1efd98e417a4af231160b7d63c94b2f937fc739b12b8849406

data/.circleci/config.yml

@@ -7,10 +7,6 @@ build_steps: &build_steps
 
 version: 2
 jobs:
-  test_ruby-2.3:
-    <<: *build_steps
-    docker:
-      - image: circleci/ruby:2.3
   test_ruby-2.4:
     <<: *build_steps
     docker:
@@ -19,9 +15,13 @@ jobs:
     <<: *build_steps
     docker:
       - image: circleci/ruby:2.5
+  test_ruby-2.6:
+    <<: *build_steps
+    docker:
+      - image: circleci/ruby:2.6
   release:
     docker:
-      - image: circleci/ruby:2.5
+      - image: circleci/ruby:2.6
     steps:
       - checkout
       - run:
@@ -39,23 +39,23 @@ workflows:
   version: 2
   test_and_release:
     jobs:
-      - test_ruby-2.3:
+      - test_ruby-2.4:
           filters:
             tags:
               only: /.*/
-      - test_ruby-2.4:
+      - test_ruby-2.5:
           filters:
             tags:
               only: /.*/
-      - test_ruby-2.5:
+      - test_ruby-2.6:
           filters:
             tags:
               only: /.*/
       - release:
           requires:
-            - test_ruby-2.3
             - test_ruby-2.4
             - test_ruby-2.5
+            - test_ruby-2.6
           filters:
             tags:
               only: /^v.*/

data/README.md

@@ -2,13 +2,10 @@
 
 [![Gem Version](https://badge.fury.io/rb/gate.svg)](http://badge.fury.io/rb/gate)
 [![Circle CI](https://circleci.com/gh/monterail/gate.svg?style=shield)](https://circleci.com/gh/monterail/gate)
-[![Dependency Status](https://gemnasium.com/monterail/gate.svg)](https://gemnasium.com/monterail/gate)
 [![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 wrapper on [dry-validation](http://dry-rb.org/gems/dry-validation/) that might be used as Command in CQRS pattern or replace [Strong Params](http://api.rubyonrails.org/classes/ActionController/Parameters.html) in [Ruby on Rails](https://rubyonrails.org/) applications.
-
-`Gate::Command` will raise `InvalidCommand` error for invalid input and provide simple struct with access to coerced input.
+**Gate** is a small wrapper on [dry-validation](http://dry-rb.org/gems/dry-validation/) that integrates it with [Ruby on Rails](https://rubyonrails.org/) and replaces [Strong Params](http://api.rubyonrails.org/classes/ActionController/Parameters.html).
 
 ## Installation
 
@@ -26,61 +23,33 @@ Or install it yourself as:
 
     $ gem install gate
 
-## Command Usage
+## Usage
 
-Define structure
-
-```ruby
-class DoSomethingCommand
-  include Gate::Command
-
-  schema do
-    required(:id).filled
-    required(:message).schema do
-      required(:title).filled
-      optional(:value).maybe(:decimal?)
-    end
-  end
-end
-```
-
-Use it
-
-```ruby
-begin
-  cmd = DoSomethingCommand.with(params)
-  cmd.id
-  cmd.message
-rescue DoSomethingCommand::InvalidCommand => e
-  e.errors # => hash { key => [errors] }
-end
-```
-
-## Rails Usage
-
-Define schemas per action
+Define [contract](https://dry-rb.org/gems/dry-validation) per action with controller DSL...
 
 ```ruby
 class ExampleController < ActionController::Base
   include Gate::Rails
 
-  before_action :validate_params, if: { |c| c.params_schema_registered? }
+  before_action :verify_contract, if: { |c| c.contract_registered? }
 
-  # Define schema just before action method
-  def_schema do
-    required(:id).filled
-    required(:message).schema do
-      required(:title).filled
-      optional(:value).maybe(:decimal?)
+  # Define contract just before action method
+  contract(handler: :handle_invalid_params) do
+    params do
+      required(:id).filled
+      required(:message).hash do
+        required(:title).filled
+        optional(:value).maybe(:decimal?)
+      end
     end
   end
 
   def foo
     # you can access Dry::Validation result with:
-    validated_params
+    claimed_params
   end
 
-  # default handler for invalid params which you can override
+  # handler for invalid params
   def handle_invalid_params(_errors)
     # errors is Dry::Validation messages hash
 
@@ -89,50 +58,43 @@ class ExampleController < ActionController::Base
 end
 ```
 
-## Configuration
-
-Gate gives a possibility to create global, inherited configuration and separated setup in each one schema definition.
-
-### Inheriting base setup
-
-In order to configure the library according to the whole application, create a file under `config/initializers/gate.rb`. There is a possibility of creating a base configuration, defining shared, custom predicates and a lot more useful things. The full list of supported configuration options is consistent with available options in [dry-validation](https://dry-rb.org/gems/dry-validation/) gem.
+... or as a separate class:
 
 ```ruby
-Gate::Rails.configure do
-  configure do |config|
-    config.messages_file = Rails.root.join("config", "locales" "en.yml")
-
-    predicates(SharedPredicates)
-
-    def foo?(value)
-      value == "FOO"
+class ExampleFooContract < Dry::Validation::Contract
+  params do
+    required(:id).filled
+    required(:message).hash do
+      required(:title).filled
+      optional(:value).maybe(:decimal?)
     end
   end
 end
-```
 
-### Separated setup
+class ExampleController < ActionController::Base
+  include Gate::Rails
 
-Sometimes there is a requirement to have a very specific configuration or behaviour in a one schema validation. The easiest way is to do it in a special `configure` block.
+  before_action :verify_contract, if: { |c| c.contract_registered? }
 
-```ruby
-class DoSomethingCommand
-  include Gate::Command
+  contract(ExampleFooContract)
+  def foo
+    # you can access Dry::Validation result with:
+    claimed_params
+  end
 
-  schema do
-    configure do
-      config.messages_file = Rails.root.join("config", "locales" "special_en.yml")
-      predicates(SharedPredicates)
-    end
-    required(:id).filled
-    required(:message).schema do
-      required(:title).filled
-      optional(:value).maybe(:decimal?)
-    end
+  # just use default handler
+  def handle_invalid_params(_errors)
+    # errors is Dry::Validation messages hash
+
+    head :bad_request
   end
 end
 ```
 
+## Configuration
+
+*TODO*
+
 ## 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

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.authors = ["Jan Dudulski"]
   spec.email = ["jan@dudulski.pl"]
 
-  spec.summary = "CQRS Command"
+  spec.summary = "Strong params replacement"
   spec.description = "Validate and coerce user input against defined structure."
   spec.homepage = "https://github.com/monterail/gate"
   spec.license = "MIT"
@@ -20,7 +20,7 @@ Gem::Specification.new do |spec|
 
   spec.metadata["allowed_push_host"] = "https://rubygems.org"
 
-  spec.add_runtime_dependency "dry-validation", "~> 0.12"
+  spec.add_runtime_dependency "dry-validation", "~> 1.0"
 
   spec.add_development_dependency "bundler", "~> 1.16"
   spec.add_development_dependency "codeclimate-test-reporter", "~> 1.0"
@@ -28,4 +28,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "pry", "~> 0.11"
   spec.add_development_dependency "rails", "~> 5.2"
   spec.add_development_dependency "rake", "~> 12.0"
+  spec.add_development_dependency "standardrb", ">= 1.0"
 end

data/lib/gate.rb

@@ -1,11 +1,9 @@
 # frozen_string_literal: true
 
 module Gate
-  InvalidCommand = Class.new(StandardError)
 end
 
 require "dry-validation"
 
-require "gate/command"
 require "gate/rails"
 require "gate/version"

data/lib/gate/rails.rb

@@ -2,49 +2,55 @@
 
 module Gate
   module Rails
-    attr_reader :validated_params
+    attr_reader :claimed_params
 
-    SchemaNotDefined = Class.new(StandardError)
-    @base_schema = nil
+    ContractNotDefined = Class.new(StandardError)
 
     def self.included(base)
       base.send(:extend, ClassMethods)
     end
 
-    def self.configure(&block)
-      @base_schema = Class.new(Dry::Validation::Schema, &block)
-    end
-
     module ClassMethods
-      def params_schemas
-        @params_schemas ||= {}
+      def _contracts
+        @_contracts ||= {}
       end
 
-      def fetch_params_schema(schema_name)
-        params_schemas.fetch(schema_name) do
-          raise SchemaNotDefined, "Missing `#{schema_name}` schema"
-        end
+      def contract_for(contract_name)
+        _contracts.fetch(contract_name) do
+          raise ContractNotDefined, "Missing `#{contract_name}` contract"
+        end.fetch(:contract)
+      end
+
+      def handler_for(contract_name)
+        _contracts.fetch(contract_name) do
+          raise ContractNotDefined, "Missing `#{contract_name}` contract"
+        end.fetch(:handler)
       end
 
-      def def_schema(&block)
-        @_schema = Dry::Validation.Params(Gate::Rails::instance_variable_get(:@base_schema), &block)
+      def contract(klass = nil, handler: :handle_invalid_params, &block)
+        @_contract = {
+          contract: klass ? klass.new : Dry::Validation.Contract(&block),
+          handler: handler,
+        }
       end
 
       def method_added(method_name)
-        return unless instance_variable_defined?(:@_schema)
+        if instance_variable_defined?(:@_contract)
+          _contracts[method_name] = @_contract
+          remove_instance_variable(:@_contract)
+        end
 
-        params_schemas[method_name] = @_schema
-        remove_instance_variable(:@_schema)
+        super
       end
     end
 
-    def validate_params
-      result = params_schema.call(request.params)
+    def verify_contract
+      result = self.class.contract_for(_contract_name).call(request.params)
 
       if result.success?
-        @validated_params = result.output
+        @claimed_params = result.to_h
       else
-        handle_invalid_params(result.messages)
+        send(self.class.handler_for(_contract_name), result.errors.to_h)
       end
     end
 
@@ -52,15 +58,11 @@ module Gate
       head :bad_request
     end
 
-    def params_schema_registered?
-      self.class.params_schemas.key?(params_schema_name)
-    end
-
-    def params_schema
-      self.class.fetch_params_schema(params_schema_name)
+    def contract_registered?
+      self.class._contracts.key?(_contract_name)
     end
 
-    def params_schema_name
+    def _contract_name
       action_name.to_sym
     end
   end

data/lib/gate/version.rb

@@ -1,3 +1,3 @@
 module Gate
-  VERSION = "0.10.0"
+  VERSION = "1.0.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gate
 version: !ruby/object:Gem::Version
-  version: 0.10.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Jan Dudulski
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-09-10 00:00:00.000000000 Z
+date: 2019-06-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-validation
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.12'
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.12'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -108,6 +108,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: standardrb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
 description: Validate and coerce user input against defined structure.
 email:
 - jan@dudulski.pl
@@ -119,7 +133,6 @@ files:
 - ".circleci/gem_credentials"
 - ".codeclimate.yml"
 - ".gitignore"
-- ".rubocop.yml"
 - ".travis.yml"
 - Gemfile
 - LICENSE.txt
@@ -129,7 +142,6 @@ files:
 - bin/setup
 - gate.gemspec
 - lib/gate.rb
-- lib/gate/command.rb
 - lib/gate/rails.rb
 - lib/gate/version.rb
 homepage: https://github.com/monterail/gate
@@ -152,9 +164,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.7
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
-summary: CQRS Command
+summary: Strong params replacement
 test_files: []

data/.rubocop.yml

@@ -1,19 +0,0 @@
-Style/Documentation:
-  Description: Document classes and non-namespace modules.
-  Enabled: false
-Style/StringLiterals:
-  Description: Checks if uses of quotes match the configured preference.
-  StyleGuide: https://github.com/bbatsov/ruby-style-guide#consistent-string-literals
-  Enabled: true
-  EnforcedStyle: double_quotes
-  SupportedStyles:
-  - single_quotes
-  - double_quotes
-Style/StringLiteralsInInterpolation:
-  Description: Checks if uses of quotes inside expressions in interpolated strings
-    match the configured preference.
-  Enabled: true
-  EnforcedStyle: single_quotes
-  SupportedStyles:
-  - single_quotes
-  - double_quotes

data/lib/gate/command.rb

@@ -1,62 +0,0 @@
-# frozen_string_literal: true
-
-require "forwardable"
-
-module Gate
-  module Command
-    extend Forwardable
-
-    def_delegator :result, :to_h
-
-    SchemaAlreadyRegistered = Class.new(StandardError)
-    SchemaNotDefined = Class.new(StandardError)
-
-    attr_reader :result
-
-    class InvalidCommand < StandardError
-      attr_reader :errors
-
-      def initialize(errors)
-        @errors = errors
-        super("Invalid command")
-      end
-
-      def full_message
-        errors.values.join(", ")
-      end
-    end
-
-    def self.included(base)
-      base.send(:extend, ClassMethods)
-    end
-
-    def initialize(data)
-      @result = data
-    end
-
-    module ClassMethods
-      # rubocop:disable Metrics/MethodLength
-      def schema(&block)
-        if block_given?
-          raise SchemaAlreadyRegistered if instance_variable_defined?(:@schema)
-          @schema = Dry::Validation.Params(&block)
-          @schema.rules.keys.each do |name|
-            define_method(name) do
-              result[name]
-            end
-          end
-        else
-          raise SchemaNotDefined unless @schema
-          @schema
-        end
-      end
-      # rubocop:enable Metrics/MethodLength
-
-      def with(input)
-        result = schema.call(input)
-        raise InvalidCommand, result.messages(full: true) if result.failure?
-        new result.output
-      end
-    end
-  end
-end