compel 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 20943c4ee705f920a1d316a9028b0ddc7e26cfc7
-  data.tar.gz: e9071ee624b81b8efe30b1747eacc3d00426339b
+  metadata.gz: 68ba3b85759b0fddf7579d70d30d62f311ce365e
+  data.tar.gz: a250017bbdf6de848efcbdae5cd4664bd6261501
 SHA512:
-  metadata.gz: 638f760fe8ea31a6545101cf48923ed2d835cf4f449d4f29bbf64610945eb78013d4aaedb5ea0724946846235b490741712b12d7dbd8cc09ac2c60127734aa0f
-  data.tar.gz: cf70bca72fc84dbc3e4c3434a16bb49569a659188e1be6049e20d058027ac33be2f0361b12f240a9d1b5e0a3b6572a7b5ae295735445cf29628f09f28558d1b9
+  metadata.gz: 5ce4e60243142f7f0b6312c4e80ff5e09068b029c54e989fc8149f84740d62383ed952a1db685e1a97f62a2842efa221c14562d67d8692260ca76fc97f545eb8
+  data.tar.gz: 728d7340542f63acea00f5e40da20c90ff93b591c07f132a2a18ff8c85bca7176df4527a2d83944455d1b603bbe742f8cfacf399e8014e4bdbc8bfa61bf287a4

data/README.md

@@ -11,16 +11,6 @@ The motivation was to create an integration for [RestMyCase](https://github.com/
 
 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.
 
-###Installation
-
-Add this line to your application's Gemfile:
-
-    gem 'compel'
-
-And then execute:
-
-    $ bundle
-
 ### Example
 
 ```ruby
@@ -68,15 +58,13 @@ Will return an [Hashie::Mash](https://github.com/intridea/hashie) object:
 }
 ```
 
-There are 3 ways run validations:
+There are 3 ways to run validations:
 
-- `#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 returns true or false.
-  
+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 returns true or false.
 
 ### Types
 
@@ -103,7 +91,7 @@ class App < Sinatra::Base
   ...
   
   def compel(&block)
-    Compel::run!(params, &block)
+    params.merge! Compel::run!(params, &block)
   end
 
   error Compel::InvalidParamsError do |exception|
@@ -116,9 +104,32 @@ class App < Sinatra::Base
     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]      
+  end
+  
+  ...
+
 end
 ```
+###Installation
 
+Add this line to your application's Gemfile:
+
+    gem 'compel'
+
+And then execute:
+
+    $ bundle
+    
 ### TODO
 
 - Write more Documentation (check specs for now ;)

data/lib/compel/contract.rb

@@ -4,7 +4,6 @@ module Compel
 
     attr_reader :errors,
                 :conditions,
-                :coerced_params,
                 :serialized_errors
 
     def initialize(params, &block)
@@ -44,7 +43,7 @@ module Compel
           # raise exception to avoid validation
 
           # If the param value has already been coerced from digging into child Hash
-          # use that value instead, so we don't loose the previous coerced values
+          # use that value instead, so we don't lose the previous coerced values
 
           coerced_value = Coercion.coerce! \
             (@coerced_params[param.name].nil? ? param.value : @coerced_params[param.name]), param.type, param.options
@@ -67,7 +66,12 @@ module Compel
 
     def param(name, type, options = {}, &block)
       @conditions[name] = \
-        Param.new(name, type, @params[name], options, &block)
+        Param.new(name, type, @params.delete(name), options, &block)
+    end
+
+    def coerced_params
+      # @params has all params that are not affected by the validation
+      @params.merge(@coerced_params)
     end
 
     def serialize
@@ -94,6 +98,8 @@ module Compel
 
         raise exception, 'params are invalid'
       end
+
+      coerced_params
     end
 
   end

data/lib/compel/version.rb

@@ -1,3 +1,3 @@
 module Compel
-  VERSION = '0.1.1'
+  VERSION = '0.1.2'
 end

data/spec/compel/compel_spec.rb

@@ -19,7 +19,7 @@ describe Compel do
         raise_error Compel::InvalidParamsError, 'params are invalid'
     end
 
-    it 'shoudl raise InvalidParamsError exception with errors' do
+    it 'should raise InvalidParamsError exception with errors' do
       params = {
         first_name: 'Joaquim'
       }
@@ -61,38 +61,66 @@ describe Compel do
 
     def make_the_call(method, params)
       Compel.send(method, params) do
-        param :first_name, String, required: true
-        param :last_name, String, required: true
-        param :birth_date, DateTime
-        param :age, Integer
-        param :admin, Compel::Boolean
-        param :blog_role, Hash do
-          param :admin, Compel::Boolean, required: true
+        param :user, Hash, required: true do
+          param :first_name, String, required: true
+          param :last_name, String, required: true
+          param :birth_date, DateTime
+          param :age, Integer
+          param :admin, Compel::Boolean
+          param :blog_role, Hash do
+            param :admin, Compel::Boolean, required: true
+          end
         end
       end
     end
 
     it 'should compel returning coerced values' do
       params = {
-        first_name: 'Joaquim',
-        last_name: 'Adráz',
-        birth_date: '1989-08-06T09:00:00',
-        age: '26',
-        admin: 'f',
-        blog_role: {
-          admin: '0'
+        user: {
+          first_name: 'Joaquim',
+          last_name: 'Adráz',
+          birth_date: '1989-08-06T09:00:00',
+          age: '26',
+          admin: 'f',
+          blog_role: {
+            admin: '0'
+          }
         }
       }
 
       expect(make_the_call(:run, params)).to eq \
         Hashie::Mash.new({
-          first_name: 'Joaquim',
-          last_name: 'Adráz',
-          birth_date: DateTime.parse('1989-08-06T09:00:00'),
-          age: 26,
-          admin: false,
-          blog_role: {
-            admin: false
+          user: {
+            first_name: 'Joaquim',
+            last_name: 'Adráz',
+            birth_date: DateTime.parse('1989-08-06T09:00:00'),
+            age: 26,
+            admin: false,
+            blog_role: {
+              admin: false
+            }
+          }
+        })
+    end
+
+    it 'should not compel and leave other params untouched' do
+      params = {
+        other_param: 1,
+        user: {
+          first_name: 'Joaquim'
+        }
+      }
+
+      expect(make_the_call(:run, params)).to eq \
+        Hashie::Mash.new({
+          other_param: 1,
+          user: {
+            first_name: 'Joaquim',
+          },
+          errors: {
+            user: {
+              last_name: ['is required']
+            }
           }
         })
     end
@@ -109,14 +137,20 @@ describe Compel do
 
     it 'should not compel'  do
       params = {
-        first_name: 'Joaquim'
+        user: {
+          first_name: 'Joaquim'
+        }
       }
 
       expect(make_the_call(:run, params)).to eq \
         Hashie::Mash.new({
-          first_name: 'Joaquim',
+          user:{
+            first_name: 'Joaquim',
+          },
           errors: {
-            last_name: ['is required']
+            user: {
+              last_name: ['is required']
+            }
           }
         })
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: compel
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Joaquim Adráz