compel 0.3.2 → 0.3.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dd41d8ef8ee213b7c02d1ba4d465fa3d9e3afbca
-  data.tar.gz: 7443f067c1f523c1b455b68f1257eda3abc1df06
+  metadata.gz: bef1b2e1274aa8234be2702abb7267fb7663de84
+  data.tar.gz: 2a5d3146d9b59f2aaf54c8e552b721434774011c
 SHA512:
-  metadata.gz: 44c69252f56c16deb155cdfdc75f4da36bbf212f3cf114959f7b9d69eb9449c38bb9d3769aeb0ad10351ef6ae18362d3e1696a80bdfbe8ca9fc85e53953a01a6
-  data.tar.gz: e66cda22c5cb242fbe548667dde04529fdd37b48c5049be7311420d03a2209fb3e2e5a5f7da1d6617b603bfa7b96ab536708d5ac1250e5d627dfb7b8272bfef2
+  metadata.gz: 6b29767783dd35c1c9783499ae9f9c26dc773f7e09d37fba395ebe1d83d5fa167f496d39de056a45d7217578a973d86101a63580415cc716dcbeafb1b9af9d94
+  data.tar.gz: 645a9ea31ccce72d524e38f98567d3153630af64475b0c0ad506fe85b7977bc93ce5bd76cd452e6276aecba09316f019736e852f3defb1fc9a80e5e34459e936

data/README.md

@@ -4,13 +4,13 @@ Compel
 [![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/coverage)
 
-Ruby Hash Coercion and Validation
+Ruby Object Coercion and Validation
 
-This is a straight forward way to validate a Ruby Hash: just give an object and the schema.
+This is a straight forward way to validate any Ruby object: just give an object and the schema.
 
-The motivation was to create an integration for [RestMyCase](https://github.com/goncalvesjoao/rest_my_case) and have validations before any business logic execution.
+The motivation was to create an integration for [RestMyCase](https://github.com/goncalvesjoao/rest_my_case) to have validations before any business logic execution and to build a easy way coerce and validate params on [Sinatra](https://github.com/sinatra/sinatra).
 
-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).
+The schema builder is based on [Joi](https://github.com/hapijs/joi).
 
 ### Usage
 
@@ -66,7 +66,7 @@ There are 4 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 returns a `Compel::Result` (see below)
 `#run!` | Validates and raises `Compel::InvalidObjectError` exception with the coerced params and errors.
 `#run?` | Validates and returns true or false.
 `schema#validate` | Check below
@@ -74,57 +74,111 @@ Method  | Behaviour
 ==========================
 
 ### Schema Builder API
-- `Compel#array` *
-  - `is(``array``)`
-  - `#items(``schema``)`
-  ```ruby
-  * ex: [1, 2, 3], [{ a: 1, b: 2}, { a: 3, b: 4 }]
-  ```
-
-- `Compel#hash` *
-  - `#keys(``schema_hash``)`
-  ```ruby
-  * ex: { a: 1,  b: 2, c: 3 }
-  ```
-
-- `Compel.date` *
-  - `#format(``ruby_date_format``)`
-  - `iso8601`, set format to: `%Y-%m-%d`
-
-- `Compel.datetime & Compel.time` *
-  - `#format(``ruby_date_format``)`
-  - `#iso8601`, set format to: `%FT%T`
-
-- `Compel#string` **
-  - `#format(``regexp``)` 
-  - `#min_length(``integer``)`
-  - `#max_length(``integer``)`
-
-- `Compel#json` *
-  ```ruby
-  * ex: "{\"a\":1,\"b\":2,\"c\":3}"
-  ```
-
-- `Compel#boolean` *
-  ```ruby
-  * ex: 1/0, true/false, 't'/'f', 'yes'/'no', 'y'/'n'
-  ```
-  
-- `Compel#integer` **
-
-- `Compel#float` **
-
-(\*) **Common methods**
-  - `required`
-  - `default(``value``)`
-
-(\*\*) **Common value methods**
-  - `is(``value``)`
-  - `in(``array``)`
-  - `length(``integer``)`
-  - `min(``value``)`
-  - `max(``value``)`
 
+#### Compel#any
+`Any` referes to any type that is available to coerce with Compel.
+
+**Methods**:
+- `is(``value``)`
+- `required`
+- `default(``value``)`
+- `length(``integer``)`
+- `min_length(``integer``)`
+- `max_length(``integer``)`
+
+==========================
+
+#### Compel#array
+
+**Methods**:
+- `#items(``schema``)`
+
+**Examples**:
+```ruby
+. [1, 2, 3]
+. [{ a: 1, b: 2}
+. { a: 3, b: 4 }]
+```
+
+==========================
+
+#### Compel#hash
+
+**Methods**:
+- `keys(``schema_hash``)`
+
+**Examples**:
+```ruby
+. { a: 1,  b: 2, c: 3 }
+```
+
+==========================
+
+#### Compel#date
+
+**Methods**:
+- `format(``ruby_date_format``)`
+- `iso8601`, set format to: `%Y-%m-%d`
+
+==========================
+
+#### Compel#datetime & Compel#time
+
+**Methods**:
+- `format(``ruby_date_format``)`
+- `iso8601`, set format to: `%FT%T`
+
+==========================
+
+#### Compel#json
+
+**Examples**:
+```ruby
+. "{\"a\":1,\"b\":2,\"c\":3}"
+```
+
+==========================
+
+#### Compel#boolean
+
+**Examples**:
+```ruby
+. 1/0
+. true/false
+. 't'/'f'
+. 'yes'/'no'
+. 'y'/'n'
+```
+
+==========================
+
+#### Compel#string
+
+**Methods**:
+- `in(``array``)`
+- `min(``value``)`
+- `max(``value``)`
+- `format(``regexp``)`
+
+==========================
+
+#### Compel#integer
+
+**Methods**:
+- `in(``array``)`
+- `min(``value``)`
+- `max(``value``)`
+
+==========================
+
+#### Compel#float
+
+**Methods**:
+- `in(``array``)`
+- `min(``value``)`
+- `max(``value``)`
+
+==========================
 
 ### Schema Validate
 
@@ -199,23 +253,18 @@ class App < Sinatra::Base
 
 end
 ```
+
 ###Installation
 
 Add this line to your application's Gemfile:
 
-    gem 'compel', '~> 0.2.0'
+    gem 'compel', '~> 0.3.4'
 
 And then execute:
 
     $ bundle
 
-### TODO
-
-- Write Advanced Documentation (check specs for now ;)
-- Rails integration
-- [RestMyCase](https://github.com/goncalvesjoao/rest_my_case) integration
-
-
 ### Get in touch
+
 If you have any questions, write an issue or get in touch [@joaquimadraz](https://twitter.com/joaquimadraz)
 

data/compel.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |gem|
   gem.authors       = ['Joaquim Adráz']
   gem.email         = ['joaquim.adraz@gmail.com']
   gem.description   = %q{Compel}
-  gem.summary       = %q{Ruby Hash Coercion and Validation}
+  gem.summary       = %q{Ruby Object Coercion and Validation}
   gem.homepage      = 'https://github.com/joaquimadraz/compel'
 
   gem.files         = `git ls-files`.split($/)

data/lib/compel/builder/any.rb

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

data/lib/compel/builder/array.rb

@@ -17,14 +17,10 @@ module Compel
       end
 
       def is(value)
-        options[:is] = Coercion.coerce!(value, ::Array)
+        options[:is] = Coercion.coerce!(value, Coercion::Array)
         self
       end
 
-      def validate(object)
-        Contract.new(object, self).validate
-      end
-
     end
 
   end

data/lib/compel/builder/common.rb

@@ -3,8 +3,8 @@ module Compel
 
     module Common
 
-      def length(value)
-        options[:length] = Coercion.coerce!(value, ::Integer)
+      def is(value)
+        options[:is] = value
         self
       end
 
@@ -18,6 +18,21 @@ module Compel
         self
       end
 
+      def length(value)
+        options[:length] = Coercion.coerce!(value, Coercion::Integer)
+        self
+      end
+
+      def min_length(value)
+        options[:min_length] = Coercion.coerce!(value, Coercion::Integer)
+        self
+      end
+
+      def max_length(value)
+        options[:max_length] = Coercion.coerce!(value, Coercion::Integer)
+        self
+      end
+
     end
 
   end

data/lib/compel/builder/common_value.rb

@@ -3,11 +3,6 @@ module Compel
 
     module CommonValue
 
-      def is(value)
-        options[:is] = value
-        self
-      end
-
       def in(value)
         options[:in] = value
         self

data/lib/compel/builder/hash.rb

@@ -14,10 +14,6 @@ module Compel
         self
       end
 
-      def validate(object)
-        Contract.new(object, self).validate
-      end
-
     end
 
   end

data/lib/compel/builder/methods.rb

@@ -11,6 +11,7 @@ require 'compel/builder/time'
 require 'compel/builder/date'
 require 'compel/builder/boolean'
 require 'compel/builder/array'
+require 'compel/builder/any'
 
 module Compel
   module Builder
@@ -57,6 +58,10 @@ module Compel
         Builder::Array.new
       end
 
+      def any
+        Builder::Any.new
+      end
+
       extend self
 
     end

data/lib/compel/builder/string.rb

@@ -10,17 +10,7 @@ module Compel
       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)
+        options[:format] = Coercion.coerce!(regex, Coercion::Regexp)
         self
       end
 

data/lib/compel/coercion/coercion.rb

@@ -10,6 +10,7 @@ require 'compel/coercion/types/json'
 require 'compel/coercion/types/boolean'
 require 'compel/coercion/types/regexp'
 require 'compel/coercion/types/array'
+require 'compel/coercion/types/any'
 
 require 'compel/coercion/result'
 require 'compel/coercion/nil_result'
@@ -18,10 +19,6 @@ module Compel
 
   module Coercion
 
-    def valid?(value, type, options = {})
-      coerce(value, type, options).valid?
-    end
-
     def coerce!(value, type, options = {})
       result = coerce(value, type, options)
 
@@ -33,11 +30,9 @@ module Compel
     end
 
     def coerce(value, type, options = {})
-      return NilResult.new if value.nil?
-
-      coercion_klass = Compel::Coercion.const_get("#{type}")
+      return Coercion::NilResult.new if value.nil?
 
-      coercion_klass.new(value, options).coerce
+      type.coerce(value, options)
     end
 
     extend self

data/lib/compel/coercion/types/any.rb

@@ -0,0 +1,13 @@
+module Compel
+  module Coercion
+
+    class Any < Type
+
+      def coerce_value
+        value
+      end
+
+    end
+
+  end
+end

data/lib/compel/coercion/types/json.rb

@@ -1,3 +1,5 @@
+require 'json'
+
 module Compel
   module Coercion
 

data/lib/compel/coercion/types/type.rb

@@ -6,6 +6,10 @@ module Compel
       attr_accessor :value,
                     :options
 
+      def self.coerce(value, options)
+        new(value, options).coerce
+      end
+
       def initialize(value, options = {})
         @value = value
         @options = options
@@ -20,7 +24,7 @@ module Compel
           return result
         end
 
-        Result.new(result, value, self.class)
+        Coercion::Result.new(result, value, self.class)
       end
 
     end

data/lib/compel/errors.rb

@@ -7,7 +7,7 @@ module Compel
     end
 
     def add(key, error)
-      if error.empty?
+      if error.nil? || error.empty?
         return
       end
 

data/lib/compel/validation/conditions/condition.rb

@@ -0,0 +1,31 @@
+module Compel
+  module Validation
+
+    class Condition
+
+      attr_reader :value,
+                  :options,
+                  :value_type,
+                  :option_value
+
+      def self.validate(value, option_value, options = {})
+        new(value, option_value, options).validate
+      end
+
+      def initialize(value, option_value, options = {})
+        @value = value
+        @value_type = options.delete(:type) || Coercion::Types::Any
+        @option_value = option_value
+      end
+
+      def validate
+        # result is an error message
+        result = validate_value
+
+        Validation::Result.new(value, value_type, result)
+      end
+
+    end
+
+  end
+end

data/lib/compel/validation/conditions/format.rb

@@ -0,0 +1,19 @@
+module Compel
+  module Validation
+
+    class Format < Condition
+
+      def validate_value
+        if value_type == Coercion::String && !valid?
+          "must match format #{option_value.source}"
+        end
+      end
+
+      def valid?
+        !value.nil? && value =~ option_value
+      end
+
+    end
+
+  end
+end

data/lib/compel/validation/conditions/in.rb

@@ -0,0 +1,25 @@
+module Compel
+  module Validation
+
+    class In < Condition
+
+      def validate_value
+        unless valid?
+          "must be within #{option_value}"
+        end
+      end
+
+      private
+
+      def valid?
+        option_value.include?(value)
+      end
+
+    end
+
+    class Within < In; end
+
+    class Range < In; end
+
+  end
+end

data/lib/compel/validation/conditions/is.rb

@@ -0,0 +1,29 @@
+module Compel
+  module Validation
+
+    class Is < Condition
+
+      def option_value
+        if value_type == Coercion::Hash
+          return @option_value.to_hash
+        end
+
+        @option_value
+      end
+
+      def validate_value
+        unless valid?
+          "must be #{option_value}"
+        end
+      end
+
+      private
+
+      def valid?
+        value == option_value
+      end
+
+    end
+
+  end
+end

data/lib/compel/validation/conditions/length.rb

@@ -0,0 +1,21 @@
+module Compel
+  module Validation
+
+    class Length < Condition
+
+      def validate_value
+        unless valid?
+          "cannot have length different than #{option_value}"
+        end
+      end
+
+      private
+
+      def valid?
+        !value.nil? && option_value == "#{value}".length
+      end
+
+    end
+
+  end
+end

data/lib/compel/validation/conditions/max.rb

@@ -0,0 +1,21 @@
+module Compel
+  module Validation
+
+    class Max < Condition
+
+      def validate_value
+        unless valid?
+          "cannot be greater than #{option_value}"
+        end
+      end
+
+      private
+
+      def valid?
+        !value.nil? && value <= option_value
+      end
+
+    end
+
+  end
+end

data/lib/compel/validation/conditions/max_length.rb

@@ -0,0 +1,21 @@
+module Compel
+  module Validation
+
+    class MaxLength < Condition
+
+      def validate_value
+        unless valid?
+          "cannot have length greater than #{option_value}"
+        end
+      end
+
+      private
+
+      def valid?
+        !value.nil? && "#{value}".length <= option_value
+      end
+
+    end
+
+  end
+end

data/lib/compel/validation/conditions/min.rb

@@ -0,0 +1,21 @@
+module Compel
+  module Validation
+
+    class Min < Condition
+
+      def validate_value
+        unless valid?
+          "cannot be less than #{option_value}"
+        end
+      end
+
+      private
+
+      def valid?
+        !value.nil? && value >= option_value
+      end
+
+    end
+
+  end
+end

data/lib/compel/validation/conditions/min_length.rb

@@ -0,0 +1,21 @@
+module Compel
+  module Validation
+
+    class MinLength < Condition
+
+      def validate_value
+        unless valid?
+          "cannot have length less than #{option_value}"
+        end
+      end
+
+      private
+
+      def valid?
+        !value.nil? && option_value <= "#{value}".length
+      end
+
+    end
+
+  end
+end

data/lib/compel/validation/result.rb

@@ -0,0 +1,23 @@
+ module Compel
+  module Validation
+
+    class Result
+
+      attr_reader :value,
+                  :klass,
+                  :error_message
+
+      def initialize(value, klass, error_message = nil)
+        @value = value
+        @klass = klass
+        @error_message = error_message
+      end
+
+      def valid?
+        @error_message.nil?
+      end
+
+    end
+
+  end
+end