assent 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2b52124be104c1cc804575ecf7ccd64d10a19344
-  data.tar.gz: 35d85119557e5d1bd50d6e4e856104909dbb04d5
+  metadata.gz: 9c0c29bf9a81d516278a384e5ecbda23491a59c3
+  data.tar.gz: d364f35bc2511854c46d8a2daf3ddad6d44d6b9f
 SHA512:
-  metadata.gz: 22e0145cca7875097063146a46fcc3a816230c2ad2693bcb7ab1d040a403cd383e9457b50ad1411e9ae500fafcc69d8d0b56519785c54c239e77ce88ca1ccff4
-  data.tar.gz: 175aa27110bcfaf38311a65ec3eaa6cf94d079ee3a267438fbe139388cb7de1139185d0283a0c7a070ec2955f8a82a91a3218732c81ecc5020e4b987aa0eccaf
+  metadata.gz: 3f486a3fb8eae727e2df5fa63daaf23cb55687c37338044af86c886702a4acfbbfcc875358ae429583d97d424873198fce28e3f44800ac0b60c7704c8f2fca97
+  data.tar.gz: 224178c48484dac53302fe4800aff637f1d417a7954ba015b0ae1a659c24661f2c3f76fd07e195d32cfe3e5b0b125f3b4e2d8056347342eaee85ae186da22d74

data/README.md

@@ -26,24 +26,88 @@ Or install it yourself as:
 
 **NOTE:** This gem is still under heavy development.
 
-#### Basic Usage
+### Basic Usage
 
 ```ruby
   require 'assent'
 
+  # Define a validator that inherits from the assent validator
   class LoginValidator < Assent::Validator
 
     field :email, presence: true
     field :password, presence: true
   end
+
+  # instantiate a new instance of the LoginValidator, f.e. in your controller
+  class LoginController < ApplicationController
+    def index
+      validator = LoginValidator.new
+      if validator.validate(params) #this will return a boolean
+        # render something
+      else
+        #handle validation errors
+      end
+    end
+  end
+```
+
+As you can see above, the ```validate``` method accepts the input. Right now, it only accepts a ```Hash```.
+
+#### Supported validations
+
+* presence
+* accepted
+* date
+* ip
+
+### Accessing errors
+
+If the validation failed, you might want to show what went wrong. In that case you can access the errors as follows:
+
+```ruby
+
+  class LoginValidator < Assent::Validator
+
+    field :email, presence: true
+    field :password, presence: true
+  end
+
+  input = Hash.new
+  input[:email] = ''
+
+  validator = LoginValidator.new
+  validator.validate(input)
+  validator.errors # This will return {:email => ['The email is required']}
 ```
 
-## Development
 
-**TODO**
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+### Setting custom error messages
+
+You might want to create your own error messages and luckily you can override the defaults. All you need to do is creating a YAML language file and tell us where to find it.
+
+Inside the YAML file you have access to the ```field``` variable. This variable will automatically be replaced with the field the validation is for.
+
+The YAML file should look like this:
+
+```yaml
+  presence: This is my custom message for :field
+```
 
-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`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+Supported overrides are:
+
+* presence
+* accepted
+* date
+* ip
+
+To load your configuration file, just use the ```config_file``` method on ```Assent::Config```:
+
+```ruby
+  #some place where your configuration lives
+
+  Assent::Config.config_file 'path/to/yaml/file'
+
+```
 
 ## Contributing
 

data/lib/assent/validator.rb

@@ -10,17 +10,25 @@ module Assent
     include Options
     include Config
 
-    def errors
+    def errors_class
       @errors ||= Errors.new
     end
 
+    def errors
+      errors_class.errors
+    end
+
+    # This validate method will validate the input against the rules. At the end it returns true or false.
+    # If the errors are empty, it means the validation passed
     def validate(input)
       @@validations.each do |field, validations|
         value = input[field]
         value = input[field].to_s if value.nil?
-        validate = Validate.new(field, value, validations, errors)
+        validate = Validate.new(field, value, validations, errors_class)
         validate.validate
       end
+
+      errors.empty?
     end
 
   end

data/lib/assent/version.rb

@@ -1,3 +1,3 @@
 module Assent
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/spec/validator_spec.rb

@@ -1,5 +1,33 @@
 require 'spec_helper'
 
+class LoginValidator < Assent::Validator
+  field :name, presence: true
+end
+
+describe Assent::Validator do
+  let(:validator) { LoginValidator.new }
+
+  describe '.validate' do
+    it 'validates the input against the rules and returns true when valid' do
+      input = Hash.new
+      input[:name] = 'Frank'
+      expect(validator.validate(input)).to eq(true)
+    end
+
+    it 'returns false when the input is not valid' do
+      input = Hash.new
+      expect(validator.validate(input)).to eq(false)
+    end
+
+    it 'fills the errors when the input is not valid' do
+      input = Hash.new
+      validator.validate(input)
+      expect(validator.errors).not_to be_empty
+      expect(validator.errors).to eq({:name => ["The name is required."]})
+    end
+  end
+end
+
 describe Assent::Validate do
   let(:error) { Assent::Errors.new { include Assent::Config }}
   let(:validator) { Assent::Validate }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: assent
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Frank
@@ -88,7 +88,7 @@ files:
 - spec/validator_spec.rb
 - spec/version_spec.rb
 - test.rb
-homepage: https://rubygems.org
+homepage: https://www.github.com/frankieleef/assent
 licenses:
 - MIT
 metadata: