gate 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ca10961ba809a110a1fe5af46de9ff94b50a0134
+  data.tar.gz: 3f9ed5c3837ee371396248371202d80590aa141d
+SHA512:
+  metadata.gz: 0e8126657fe7a0624943d221a36706783aaa8876fc8f97fc64f7f3e305ce96e03e78e7509ae6f2df9294c690feb69f2b834f7389dc109c2a95451b6d21e49bb9
+  data.tar.gz: 4887dd75399c5962689a63c05dd1af62cd994df927d382f98b09ac6148c10b95548471859d23ed05077d42ae13d1f8429d530fcb81b15ae067ed6219fc2eee74

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.1.5

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Jan Dudulski
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,44 @@
+# 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
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'gate'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install gate
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/gate/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

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

data/bin/console

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "gate"
+
+require "pry"
+Pry.start

data/circle.yml

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

data/gate.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'gate/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "gate"
+  spec.version       = Gate::VERSION
+  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.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.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "coercible", "~> 1.0"
+  spec.add_runtime_dependency "axiom-types", "~> 0.1"
+
+  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"
+end

data/lib/gate.rb

@@ -0,0 +1,20 @@
+module Gate
+  class CoercionError < StandardError; end
+
+  def self.rules(&block)
+    configuration = Configuration.new(&block)
+
+    Guard.new(configuration)
+  end
+end
+
+require 'axiom-types'
+require 'coercible'
+require 'forwardable'
+require 'set'
+
+require 'gate/coercer'
+require 'gate/configuration'
+require 'gate/guard'
+require 'gate/result'
+require 'gate/version'

data/lib/gate/coercer.rb

@@ -0,0 +1,21 @@
+module Gate
+  class Coercer
+    def initialize(engine, type)
+      raise CoercionError, "Doesn't know how to coerce into #{type}" unless Axiom::Types.const_defined?(type)
+
+      @engine = engine
+      @type = type
+      @coercion_method = Axiom::Types.const_get(type).coercion_method
+    end
+
+    def coerce(input)
+      engine[String].public_send(coercion_method, input)
+    rescue Coercible::UnsupportedCoercion
+      raise CoercionError, "Doesn't know how to coerce #{input} into #{type}"
+    end
+
+    private
+
+    attr_reader :engine, :type, :coercion_method
+  end
+end

data/lib/gate/configuration.rb

@@ -0,0 +1,50 @@
+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, &block)
+      @coercer = coercer
+      @required_set = Set.new
+      @optional_set = Set.new
+      @nested_set = Set.new
+      @rules = {}
+
+      instance_eval(&block)
+    end
+
+    def required?(name)
+      required_set.include?(name)
+    end
+
+    private
+
+    def required(name, type = :String, &block)
+      required_set.add(name)
+      register(name, type, &block)
+    end
+
+    def optional(name, type = :String, &block)
+      optional_set.add(name)
+      register(name, type, &block)
+    end
+
+    def register(name, type, &block)
+      @rules[name] = setup_rule(name, type, &block)
+    end
+
+    def setup_rule(name, type, &block)
+      if block_given?
+        nested_set.add(name)
+        Configuration.new(coercer, &block)
+      else
+        Coercer.new(coercer, type)
+      end
+    end
+  end
+end

data/lib/gate/guard.rb

@@ -0,0 +1,52 @@
+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.has_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)
+      if rule.kind_of?(Gate::Configuration)
+        result = Gate::Guard.new(rule).verify(input)
+        { attributes: { name => result.attributes },
+          errors: { name => result.errors } }
+      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 update(result, attributes: {}, errors: {})
+      { attributes: result.attributes.merge(attributes),
+        errors: result.errors.merge(errors) }
+    end
+  end
+end

data/lib/gate/result.rb

@@ -0,0 +1,43 @@
+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.reduce({}) do |result, (k, v)|
+        if v.kind_of?(Hash)
+          nested = _errors(v)
+
+          if nested.any?
+            result[k] = nested
+          end
+        else
+          result[k] = v
+        end
+
+        result
+      end
+    end
+  end
+end

data/lib/gate/version.rb

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

metadata

@@ -0,0 +1,158 @@
+--- !ruby/object:Gem::Specification
+name: gate
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jan Dudulski
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-06-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: coercible
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  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'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.7'
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+description: Validate and coerce user input against defined structure.
+email:
+- jan@dudulski.pl
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- circle.yml
+- gate.gemspec
+- lib/gate.rb
+- lib/gate/coercer.rb
+- lib/gate/configuration.rb
+- lib/gate/guard.rb
+- lib/gate/result.rb
+- lib/gate/version.rb
+homepage: https://github.com/monterail/gate
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Handling user input with ease
+test_files: []
+has_rdoc: