gate 0.8.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 31bc2ddaaad2763723a6461081c9af24bf28638bf1a65508ee78c161fc59ea8b
-  data.tar.gz: 2d1996e71c376ce3b20798c57bbeaf158144cbeced2823f34ba3864906ffa0b9
+  metadata.gz: c22d3f53ed88e1d283f720231af1c4a8021a1be6e0a622344b6060cf5b205f21
+  data.tar.gz: d796d15296a46a91024811b362338d35c53dca326955f561609861518a0844ec
 SHA512:
-  metadata.gz: 1ceccd09976e8a763273033318bc5b6db8a740155d4d75f3badc06793f51fe9f37a955baed090f96b7e229b2d3fc46b39d32e6ee9ba9fc76636d61184fc6bbf5
-  data.tar.gz: 4a578fb794d00e413e4114eb7463f14307313d73f286cd644d6308b388e7fc5a38c7407be7ac03498a43c9402c00730ad542524a0209342592047778e9b59d18
+  metadata.gz: d3ec912ce725441be96af00f68272dc069be63c035e26999d2d8c63ae3376402b9960d66646ae0891b87614d8c28c7f96f95ed77cba38b85965e73f25cb43fa2
+  data.tar.gz: 4e9eaf0e4c2bde5ed8ae01815e62737622f4bfba29ef6e045e1c9ae3fc163224996d213c35feb5ff1d695cb9ee50d47b25ad2cbf65e905e5feb79cc6ce97ccf1

data/.gitignore

@@ -7,3 +7,4 @@
 /pkg/
 /spec/reports/
 /tmp/
+/test/dummy/log/*

data/README.md

@@ -6,7 +6,9 @@
 [![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. It 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 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.
 
 ## Installation
 
@@ -24,7 +26,7 @@ Or install it yourself as:
 
     $ gem install gate
 
-## Usage
+## Command Usage
 
 Define structure
 
@@ -54,6 +56,39 @@ rescue DoSomethingCommand::InvalidCommand => e
 end
 ```
 
+## Rails Usage
+
+Define schemas per action
+
+```ruby
+class ExampleController < ActionController::Base
+  include Gate::Rails
+
+  before_action :validate_params, if: { |c| c.params_schema_registered? }
+
+  # Define schema just before action method
+  def_schema do
+    required(:id).filled
+    required(:message).schema do
+      required(:title).filled
+      optional(:value).maybe(:decimal?)
+    end
+  end
+
+  def foo
+    # you can access Dry::Validation result with:
+    validated_params
+  end
+
+  # default handler for invalid params which you can override
+  def handle_invalid_params(_errors)
+    # errors is Dry::Validation messages hash
+
+    head :bad_request
+  end
+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

@@ -26,5 +26,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "codeclimate-test-reporter", "~> 1.0"
   spec.add_development_dependency "minitest", "~> 5.11"
   spec.add_development_dependency "pry", "~> 0.11"
+  spec.add_development_dependency "rails", "~> 5.2"
   spec.add_development_dependency "rake", "~> 12.0"
 end

data/lib/gate.rb

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

data/lib/gate/rails.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+module Gate
+  module Rails
+    attr_reader :validated_params
+
+    SchemaNotDefined = Class.new(StandardError)
+
+    def self.included(base)
+      base.send(:extend, ClassMethods)
+    end
+
+    module ClassMethods
+      def params_schemas
+        @params_schemas ||= {}
+      end
+
+      def fetch_params_schema(schema_name)
+        params_schemas.fetch(schema_name) do
+          raise SchemaNotDefined, "Missing `#{schema_name}` schema"
+        end
+      end
+
+      def def_schema(&block)
+        @_schema = Dry::Validation.Params(&block)
+      end
+
+      def method_added(method_name)
+        return unless instance_variable_defined?(:@_schema)
+
+        params_schemas[method_name] = @_schema
+        remove_instance_variable(:@_schema)
+      end
+    end
+
+    def validate_params
+      result = params_schema.call(request.params)
+
+      if result.success?
+        @validated_params = result.output
+      else
+        handle_invalid_params(result.messages)
+      end
+    end
+
+    def handle_invalid_params(_errors)
+      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)
+    end
+
+    def params_schema_name
+      action_name.to_sym
+    end
+  end
+end

data/lib/gate/version.rb

@@ -1,3 +1,3 @@
 module Gate
-  VERSION = "0.8.0"
+  VERSION = "0.9.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gate
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.9.0
 platform: ruby
 authors:
 - Jan Dudulski
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-06-12 00:00:00.000000000 Z
+date: 2018-06-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-validation
@@ -80,6 +80,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.11'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.2'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -116,6 +130,7 @@ files:
 - gate.gemspec
 - lib/gate.rb
 - lib/gate/command.rb
+- lib/gate/rails.rb
 - lib/gate/version.rb
 homepage: https://github.com/monterail/gate
 licenses: