compel 0.1.3 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: babd567c6c66e9826606f628417eb16599a30f43
-  data.tar.gz: 3abbd9005a7aeb99146677491cd5a9d9b59add3a
+  metadata.gz: 4ca24b865ca3552e7fb66b3b5fa3cb54522c69f6
+  data.tar.gz: 06342b5d60518ad7f05fc4fcd380ad6dce9b1017
 SHA512:
-  metadata.gz: b326bc4046b7844f027a5cde2ed1316dfe32180a5b2a804a93b368221740f05f88cb43d1c9781080aa80ea00391845ac16f1602fc94c637d7e51bba9daee352f
-  data.tar.gz: 77f93f863cd71d5779d7e76d0d658c41f47ca9e0766fc38fbfd8ba08a1a390c946c75bd3621549cff20708711a6c24101c4e7f2ea04b7f0c34a7a0dec09d7dc1
+  metadata.gz: eadd3a9cf227017eb8ed57431ba6b6b687ef2e76cee95de5dc89c9691201ff8cb2ce6afb96e7061314f07b2bc3fda5d0660bb3345e2784086f9e28d31ad90ad8
+  data.tar.gz: d2adaa09f03406c98f87bdc0b816b30a3983a65bf306bab7ef8fc7cd6873302d024173d3cf3ca3122c0595d903962fa154a763e66e31c8f5e7c434927e214b08

data/Gemfile

@@ -1,3 +1,10 @@
 source 'https://rubygems.org'
 
 gemspec
+
+group :test do
+  gem 'codeclimate-test-reporter'
+  gem 'simplecov', require: false
+  gem 'rack-test'
+  gem 'sinatra', require: false
+end

data/README.md

@@ -1,7 +1,8 @@
-Compel 
+Compel
 ==========================
 ![](https://travis-ci.org/joaquimadraz/compel.svg)
 [![Code Climate](https://codeclimate.com/github/joaquimadraz/compel/badges/gpa.svg)](https://codeclimate.com/github/joaquimadraz/compel)
+[![Test Coverage](https://codeclimate.com/github/joaquimadraz/compel/badges/coverage.svg)](https://codeclimate.com/github/joaquimadraz/compel)
 
 Ruby Hash Coercion and Validation
 
@@ -9,32 +10,34 @@ This is a straight forward way to validate a Ruby Hash: just give an object and
 
 The motivation was to create an integration for [RestMyCase](https://github.com/goncalvesjoao/rest_my_case) and have validations before any business logic execution.
 
-Based on the same principle from [Grape](https://github.com/ruby-grape/grape) framework and [sinatra-param](https://github.com/mattt/sinatra-param) gem to validate request params.
+Based on the same principle from [Grape](https://github.com/ruby-grape/grape) framework and [sinatra-param](https://github.com/mattt/sinatra-param) gem to validate request params. The schema builder is based on [Joi](https://github.com/hapijs/joi).
 
 ### Example
 
 ```ruby
-params= {
+object = {
   first_name: 'Joaquim',
   birth_date: '1989-0',
   address: {
     line_one: 'Lisboa',
     post_code: '1100',
-    country: 'PT'
+    country_code: 'PT'
   }
 }
 
-Compel.run(params) do
-  param :first_name, String, required: true
-  param :last_name, String, required: true
-  param :birth_date, DateTime
-  param :address, Hash do
-    param :line_one, String, required: true
-    param :line_two, String, default: '-'
-    param :post_code, String, required: true, format: /^\d{4}-\d{3}$/
-    param :country_code, String, in: ['PT', 'GB'], default: 'PT'
-  end
-end
+schema = Compel.hash.keys({
+  first_name: Compel.string.required,
+  last_name: Compel.string.required,
+  birth_date: Compel.datetime,
+  address: Compel.hash.keys({
+    line_one: Compel.string.required,
+    line_two: Compel.string.default('-'),
+    post_code: Compel.string.format(/^\d{4}-\d{3}$/).required,
+    country_code: Compel.string.in(['PT', 'GB']).default('PT')
+  })
+})
+
+Compel.run(object, schema)
 ```
 
 Will return an [Hashie::Mash](https://github.com/intridea/hashie) object:
@@ -42,17 +45,18 @@ Will return an [Hashie::Mash](https://github.com/intridea/hashie) object:
 ```ruby
 {
   "first_name" => "Joaquim",
+  "birth_date" => "1989-0",
   "address" => {
-    "line_one" => "Lisboa", 
-    "line_two" => "-", # default value
-    "post_code_pfx" => 1100, # Already an Integer
-    "country_code"=> "PT"
+    "line_one" => "Lisboa",
+    "line_two" => "-",
+    "post_code" => "1100",
+    "country_code" => "PT"
   },
   "errors" => {
     "last_name" => ["is required"],
-    "birth_date" => ["'1989-0' is not a valid DateTime"],
+    "birth_date" => ["'1989-0' is not a parsable date with format: %Y-%m-%d"],
     "address" => {
-      "post_code_sfx" => ["is required"]
+      "post_code" => ["must match format ^\d{4}-\d{3}$"]
     }
   }
 }
@@ -63,60 +67,67 @@ There are 3 ways to run validations:
 Method  | Behaviour
 ------------- | -------------
 `#run`  | Validates and returns an Hash with coerced params plus a `:errors` key with a _Rails like_ Hash of errors if any.
-`#run!` | Validates and raises `Compel::InvalidParamsError` exception with the coerced params and errors.
+`#run!` | Validates and raises `Compel::InvalidHashError` exception with the coerced params and errors.
 `#run?` | Validates and returns true or false.
 
 ### Types
 
-- `Integer`
-- `Float`
-- `String`
-- `JSON`
+- `#integer`
+- `#float`
+- `#string`
+- `#json`
   - ex: `"{\"a\":1,\"b\":2,\"c\":3}"`
-- `Hash`
+- `#hash`
   - ex: `{ a: 1,  b: 2, c: 3 }`
-- `Date`
-- `Time`
-- `DateTime`
-- `Compel::Boolean`, 
+- `#date`
+- `#time`
+- `#datetime`
+- `#boolean`,
   - ex: `1`/`0`, `true`/`false`, `t`/`f`, `yes`/`no`, `y`/`n`
 
 ### Sinatra Integration
 
-If you want to use with `Sinatra`, just add the following code to your Sinatra app:
+If you want to use with `Sinatra`, here's an example:
 
 ```ruby
 class App < Sinatra::Base
-  
-  ...
-  
-  def compel(&block)
-    params.merge! Compel::run!(params, &block)
+
+  set :show_exceptions, false
+  set :raise_errors, true
+
+  before do
+    content_type :json
   end
 
-  error Compel::InvalidParamsError do |exception|
+  helpers do
+
+    def compel(schema)
+      params.merge! Compel.run!(params, Compel.hash.keys(schema))
+    end
+
+  end
+
+  error Compel::InvalidHashError do |exception|
     status 400
-    json errors: exception.errors
+    { errors: exception.errors }.to_json
   end
-  
+
   configure :development do
     set :show_exceptions, false
     set :raise_errors, true
   end
-  
-  ...
-  
+
   post '/api/posts' do
-    compel do
-      param :post, Hash, required: true do
-        param :title, String, required: true
-      end
-    end
-  
-    puts params[:post]      
+    compel({
+      post: Compel.hash.keys({
+        title: Compel.string.required,
+        body: Compel.string,
+        published: Compel.boolean.default(false)
+      }).required
+    })
+
+    params.to_json
   end
-  
-  ...
 
 end
 ```
@@ -124,12 +135,12 @@ end
 
 Add this line to your application's Gemfile:
 
-    gem 'compel'
+    gem 'compel', '~> 0.2.0'
 
 And then execute:
 
     $ bundle
-    
+
 ### TODO
 
 - Write more Documentation (check specs for now ;)

data/lib/compel/builder/boolean.rb

@@ -0,0 +1,13 @@
+module Compel
+  module Builder
+
+    class Boolean < Schema
+
+      def initialize
+        super(Coercion::Boolean)
+      end
+
+    end
+
+  end
+end

data/lib/compel/builder/common.rb

@@ -0,0 +1,24 @@
+module Compel
+  module Builder
+
+    module Common
+
+      def is(value)
+        options[:is] = value
+        self
+      end
+
+      def required
+        options[:required] = true
+        self
+      end
+
+      def default(value)
+        options[:default] = value
+        self
+      end
+
+    end
+
+  end
+end

data/lib/compel/builder/common_value.rb

@@ -0,0 +1,34 @@
+module Compel
+  module Builder
+
+    module CommonValue
+
+      def in(value)
+        options[:in] = value
+        self
+      end
+
+      def length(value)
+        options[:length] = Coercion.coerce!(value, ::Integer)
+        self
+      end
+
+      def range(value)
+        options[:range] = value
+        self
+      end
+
+      def min(value)
+        options[:min] = value
+        self
+      end
+
+      def max(value)
+        options[:max] = value
+        self
+      end
+
+    end
+
+  end
+end

data/lib/compel/builder/date.rb

@@ -0,0 +1,23 @@
+module Compel
+  module Builder
+
+    class Date < Schema
+
+      def initialize
+        super(Coercion::Date)
+      end
+
+      def format(value)
+        options[:format] = value
+        self
+      end
+
+      def iso8601
+        options[:format] = '%Y-%m-%d'
+        self
+      end
+
+    end
+
+  end
+end

data/lib/compel/builder/datetime.rb

@@ -0,0 +1,23 @@
+module Compel
+  module Builder
+
+    class DateTime < Schema
+
+      def initialize
+        super(Coercion::DateTime)
+      end
+
+      def format(value)
+        options[:format] = value
+        self
+      end
+
+      def iso8601
+        options[:format] = '%FT%T'
+        self
+      end
+
+    end
+
+  end
+end

data/lib/compel/builder/float.rb

@@ -0,0 +1,15 @@
+module Compel
+  module Builder
+
+    class Float < Schema
+
+      include CommonValue
+
+      def initialize
+        super(Coercion::Float)
+      end
+
+    end
+
+  end
+end

data/lib/compel/builder/hash.rb

@@ -0,0 +1,22 @@
+module Compel
+  module Builder
+
+    class Hash < Schema
+
+      def initialize
+        super(Coercion::Hash)
+      end
+
+      def keys(hash)
+        options[:keys] = hash
+        self
+      end
+
+      def validate(object)
+        Contract.new(object, self).validate.serialize
+      end
+
+    end
+
+  end
+end

data/lib/compel/builder/integer.rb

@@ -0,0 +1,15 @@
+module Compel
+  module Builder
+
+    class Integer < Schema
+
+      include CommonValue
+
+      def initialize
+        super(Coercion::Integer)
+      end
+
+    end
+
+  end
+end

data/lib/compel/builder/json.rb

@@ -0,0 +1,13 @@
+module Compel
+  module Builder
+
+    class JSON < Schema
+
+      def initialize
+        super(Coercion::JSON)
+      end
+
+    end
+
+  end
+end

data/lib/compel/builder/methods.rb

@@ -0,0 +1,60 @@
+require 'compel/builder/common'
+require 'compel/builder/common_value'
+require 'compel/builder/schema'
+require 'compel/builder/hash'
+require 'compel/builder/json'
+require 'compel/builder/string'
+require 'compel/builder/integer'
+require 'compel/builder/float'
+require 'compel/builder/datetime'
+require 'compel/builder/time'
+require 'compel/builder/date'
+require 'compel/builder/boolean'
+
+module Compel
+  module Builder
+
+    module Methods
+
+      def hash
+        Builder::Hash.new
+      end
+
+      def json
+        Builder::JSON.new
+      end
+
+      def string
+        Builder::String.new
+      end
+
+      def integer
+        Builder::Integer.new
+      end
+
+      def float
+        Builder::Float.new
+      end
+
+      def datetime
+        Builder::DateTime.new
+      end
+
+      def time
+        Builder::Time.new
+      end
+
+      def date
+        Builder::Date.new
+      end
+
+      def boolean
+        Builder::Boolean.new
+      end
+
+      extend self
+
+    end
+
+  end
+end

data/lib/compel/builder/schema.rb

@@ -0,0 +1,27 @@
+module Compel
+  module Builder
+
+    class Schema
+
+      include Builder::Common
+
+      attr_reader :type,
+                  :options
+
+      def initialize(type)
+        @type = type
+        @options = Hashie::Mash.new
+      end
+
+      def required?
+        !!options[:required]
+      end
+
+      def default_value
+        options[:default]
+      end
+
+    end
+
+  end
+end

data/lib/compel/builder/string.rb

@@ -0,0 +1,30 @@
+module Compel
+  module Builder
+
+    class String < Schema
+
+      include CommonValue
+
+      def initialize
+        super(Coercion::String)
+      end
+
+      def format(regex)
+        options[:format] = Coercion.coerce!(regex, ::Regexp)
+        self
+      end
+
+      def min_length(value)
+        options[:min_length] = Coercion.coerce!(value, ::Integer)
+        self
+      end
+
+      def max_length(value)
+        options[:max_length] = Coercion.coerce!(value, ::Integer)
+        self
+      end
+
+    end
+
+  end
+end

data/lib/compel/builder/time.rb

@@ -0,0 +1,23 @@
+module Compel
+  module Builder
+
+    class Time < Schema
+
+      def initialize
+        super(Coercion::Time)
+      end
+
+      def format(value)
+        options[:format] = value
+        self
+      end
+
+      def iso8601
+        options[:format] = '%FT%T'
+        self
+      end
+
+    end
+
+  end
+end

data/lib/compel/coercion/boolean.rb

@@ -3,7 +3,7 @@ module Compel
 
     class Boolean < Type
 
-      def coerce
+      def coerce!
         if /(false|f|no|n|0)$/i === "#{value}"
           return false
         end

data/lib/compel/coercion/date.rb

@@ -3,8 +3,25 @@ module Compel
 
     class Date < Type
 
-      def coerce
-        ::Date.parse(value)
+      def coerce!
+        format = options[:format] || '%Y-%m-%d'
+
+        if value.is_a?(::Date)
+          @value = value.strftime(format)
+        end
+
+        coerced = ::Date.strptime(value, format)
+
+        if coerced.strftime(format) == value
+          return coerced
+        end
+
+        fail
+
+        rescue
+          raise \
+            Compel::TypeError,
+            "'#{value}' is not a parsable date with format: #{format}"
       end
 
     end

data/lib/compel/coercion/datetime.rb

@@ -3,8 +3,25 @@ module Compel
 
     class DateTime < Type
 
-      def coerce
-        ::DateTime.parse(value)
+      def coerce!
+        format = options[:format] || '%FT%T'
+
+        if value.is_a?(::DateTime)
+          @value = value.strftime(format)
+        end
+
+        coerced = ::DateTime.strptime(value, format)
+
+        if coerced.strftime(format) == value
+          return coerced
+        end
+
+        fail
+
+        rescue
+          raise \
+            Compel::TypeError,
+            "'#{value}' is not a parsable datetime with format: #{format}"
       end
 
     end

data/lib/compel/coercion/float.rb

@@ -3,7 +3,7 @@ module Compel
 
     class Float < Type
 
-      def coerce
+      def coerce!
         Float(value)
       end
 

data/lib/compel/coercion/hash.rb

@@ -3,7 +3,7 @@ module Compel
 
     class Hash < Type
 
-      def coerce
+      def coerce!
         Hashie::Mash.new(value).to_hash
       end
 

data/lib/compel/coercion/integer.rb

@@ -3,7 +3,7 @@ module Compel
 
     class Integer < Type
 
-      def coerce
+      def coerce!
         Integer(value)
       end
 

data/lib/compel/coercion/json.rb

@@ -3,7 +3,7 @@ module Compel
 
     class JSON < Type
 
-      def coerce
+      def coerce!
         ::JSON.parse(value)
       end
 

data/lib/compel/coercion/regexp.rb

@@ -0,0 +1,17 @@
+module Compel
+  module Coercion
+
+    class Regexp < Type
+
+      def coerce!
+        if value.is_a?(::Regexp)
+          return value
+        end
+
+        fail
+      end
+
+    end
+
+  end
+end