gate 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ca10961ba809a110a1fe5af46de9ff94b50a0134
-  data.tar.gz: 3f9ed5c3837ee371396248371202d80590aa141d
+  metadata.gz: 09c3db4ff831be9cbcee9a0fc5c4666cf25e0fd6
+  data.tar.gz: b8fe4ff7b05976382e00b91dca04496b330cd0a0
 SHA512:
-  metadata.gz: 0e8126657fe7a0624943d221a36706783aaa8876fc8f97fc64f7f3e305ce96e03e78e7509ae6f2df9294c690feb69f2b834f7389dc109c2a95451b6d21e49bb9
-  data.tar.gz: 4887dd75399c5962689a63c05dd1af62cd994df927d382f98b09ac6148c10b95548471859d23ed05077d42ae13d1f8429d530fcb81b15ae067ed6219fc2eee74
+  metadata.gz: f2e1837f27d8e33f1f73365c9a231f465b3e3abdcca1b036f22b7194dfd1d918341de980d492115b5e1feac1b797450d2b83356e303d4633ccd06414e77d50b1
+  data.tar.gz: 32fd22c8502b461615a89d6fe4b8edf6592218083ead3d796d627593b84b6fa990d1c23926c32eb557b41b8a04eba90eedff0f70446e8f439a060d16a1fa5ac6

data/.codeclimate.yml

@@ -0,0 +1,8 @@
+engines:
+  rubocop:
+    enabled: true
+  bundler-audit:
+    enabled: true
+ratings:
+  paths:
+    - "lib/**"

data/.rubocop.yml

@@ -0,0 +1,19 @@
+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/Gemfile

@@ -1,4 +1,4 @@
-source 'https://rubygems.org'
+source "https://rubygems.org"
 
 # Specify your gem's dependencies in gate.gemspec
 gemspec

data/README.md

@@ -1,13 +1,12 @@
 # Gate
 
+[![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)
 
-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/gate`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+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.
 
 ## Installation
 
@@ -27,7 +26,26 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+Define structure
+
+```ruby
+gate = Gate.rules do
+  required :id, :Integer
+  required :message do
+    required :title # :String by default
+    optional :value, :Decimal
+  end
+end
+```
+
+Verify it
+
+```ruby
+result = gate.verify(params)
+result.valid? # => true / false
+result.attributes # => hash with only allowed parameters
+result.errors # => hash { key => error }
+```
 
 ## Development
 

data/Rakefile

@@ -2,8 +2,8 @@ require "bundler/gem_tasks"
 require "rake/testtask"
 
 Rake::TestTask.new do |t|
-  t.libs << 'test'
-  t.pattern = 'test/**/test_*.rb'
+  t.libs << "test"
+  t.pattern = "test/**/test_*.rb"
 end
 
 task default: [:test]

data/bin/setup

@@ -0,0 +1,5 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install

data/gate.gemspec

@@ -1,7 +1,7 @@
 # coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path("../lib", __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'gate/version'
+require "gate/version"
 
 Gem::Specification.new do |spec|
   spec.name          = "gate"
@@ -9,12 +9,12 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Jan Dudulski"]
   spec.email         = ["jan@dudulski.pl"]
 
-  spec.summary       = %q{Handling user input with ease}
-  spec.description   = %q{Validate and coerce user input against defined structure.}
+  spec.summary       = "Handling user input with ease"
+  spec.description   = "Validate and coerce user input against defined structure."
   spec.homepage      = "https://github.com/monterail/gate"
   spec.license       = "MIT"
 
-  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  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"

data/lib/gate.rb

@@ -8,13 +8,13 @@ module Gate
   end
 end
 
-require 'axiom-types'
-require 'coercible'
-require 'forwardable'
-require 'set'
+require "axiom-types"
+require "coercible"
+require "forwardable"
+require "set"
 
-require 'gate/coercer'
-require 'gate/configuration'
-require 'gate/guard'
-require 'gate/result'
-require 'gate/version'
+require "gate/coercer"
+require "gate/configuration"
+require "gate/guard"
+require "gate/result"
+require "gate/version"

data/lib/gate/coercer.rb

@@ -1,7 +1,9 @@
 module Gate
   class Coercer
     def initialize(engine, type)
-      raise CoercionError, "Doesn't know how to coerce into #{type}" unless Axiom::Types.const_defined?(type)
+      unless Axiom::Types.const_defined?(type)
+        fail CoercionError, "Doesn't know how to coerce into #{type}"
+      end
 
       @engine = engine
       @type = type
@@ -9,7 +11,7 @@ module Gate
     end
 
     def coerce(input)
-      engine[String].public_send(coercion_method, 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
@@ -17,5 +19,14 @@ module Gate
     private
 
     attr_reader :engine, :type, :coercion_method
+
+    def detect_input_type(input)
+      case input
+      when TrueClass, FalseClass, Array, Hash
+        input.class
+      else
+        String
+      end
+    end
   end
 end

data/lib/gate/guard.rb

@@ -16,7 +16,7 @@ module Gate
 
     def _verify(input, name, rule, result)
       case
-      when input.has_key?(name)
+      when input.key?(name)
         coerced = handle(input[name], name, rule)
         update(result, coerced)
       when configuration.required?(name)
@@ -28,7 +28,7 @@ module Gate
     end
 
     def handle(input, name, rule)
-      if rule.kind_of?(Gate::Configuration)
+      if rule.is_a?(Gate::Configuration)
         result = Gate::Guard.new(rule).verify(input)
         { attributes: { name => result.attributes },
           errors: { name => result.errors } }

data/lib/gate/result.rb

@@ -25,18 +25,14 @@ module Gate
     private
 
     def _errors(hash)
-      hash.reduce({}) do |result, (k, v)|
-        if v.kind_of?(Hash)
+      hash.each_with_object({}) do |(k, v), result|
+        if v.is_a?(Hash)
           nested = _errors(v)
 
-          if nested.any?
-            result[k] = nested
-          end
+          result[k] = nested if nested.any?
         else
           result[k] = v
         end
-
-        result
       end
     end
   end

data/lib/gate/version.rb

@@ -1,3 +1,3 @@
 module Gate
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gate
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Jan Dudulski
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-23 00:00:00.000000000 Z
+date: 2015-09-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: coercible
@@ -115,13 +115,16 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".codeclimate.yml"
 - ".gitignore"
+- ".rubocop.yml"
 - ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - bin/console
+- bin/setup
 - circle.yml
 - gate.gemspec
 - lib/gate.rb
@@ -150,9 +153,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Handling user input with ease
 test_files: []
-has_rdoc: