va 0.0.5 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b9ebf46848bd833c96256fac55089f6bdce797d3
-  data.tar.gz: bb14d921880db063a2f08083fd35fe5ee56e5b63
+  metadata.gz: ed2280383b5979b1328c2ad7c89e8b957d2aaea5
+  data.tar.gz: a1b6a523e79f3bfd85c039b3797bc3c65b262b3e
 SHA512:
-  metadata.gz: 3a86ef475bc99f931a54fef45562f01873cc69f5dceb309137cd15581e8269eda0f6d8e9fb8f2e84dc52603ebaafcf8b004e7596cbc5eb89fd8d5bc099bbbda4
-  data.tar.gz: 46e078c1071d3b8c4d7155d0a8f6fa311782f410c602e2ab7c5a60e563313e70a0534408b735ef7619556ff7bf7b7d314d0a823b39456b1abd5c0fe496df3dca
+  metadata.gz: 5cf04a3feeac74cc8b7c666c07a348704d6720b4d615cef8993f3d6477bdafce054b86f80e83fed8af7a80e8f9c33488819cdda93f391fb73fdc29b5623daf92
+  data.tar.gz: 2654139e9d6b4c614089c3de4950c3fe0ee928ad830fbace45256bddd719a4b3a14d9d8d82fe97ac332c265f5d857209255c2d800f75fb5350bf5288c2e325db

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+rvm:
+  - 1.9.2
+  - 1.9.3
+  - 2.1.0
+  - 2.1.1
+  - 2.1.2
+  - ruby-head

data/README.md

@@ -1,12 +1,106 @@
 # Va
 
-Va is a minimalistic,  framework agnostic, validation library.
+Va is a minimalistic validation library.
 
 It is meant to be used as a first line of defense from external imputs.
 
+Va doesnn't care what framework you're using, it just provides a good way to set and validate attributes in a model.
+
 ## Usage
 
-TODO: Write usage instructions here
+### Attributes
+
+Say you need a signup form validator that only allows an email, a password and the password confirmation.
+The first thing to do is to create the corresponding model
+
+```ruby
+  class Signup < Va::Model
+    attribute :email
+    attribute :password
+    attribute :password_confirmation
+  end
+```
+
+And then you can instantiate it like this:
+
+```ruby
+  s = Signup.new(email: "fede@example.com", password: "123456", password_confirmation: "123456")
+  # => #<Signup:0x00000001cc90d8
+  #     @attributes=
+  #      {:email=>"fede@example.com",
+  #       :password=>"123456",
+  #       :password_confirmation=>"123456"}>
+```
+
+As you can see, you can use either Strings or Symbols as keys (to be fair, it allows any object that responds to the `#to_sym` method)
+
+You can check the values of the attributes using the `#attributes` method.
+
+```ruby
+  s.attributes
+  # => {:email=>"fede@example.com",
+  #     :password=>"123456",
+  #     :password_confirmation=>"123456"}
+```
+
+If you miss an argument, it won't appear on the attributes list:
+
+```ruby
+  s = Signup.new(email: "fede@example.com", "password_confirmation" => "123456")
+  s.attributes
+  # => {:email=>"fede@example.com",
+  #     :password_confirmation=>"123456"}
+```
+
+And if you pass a non-declared attribute, it will be ignored:
+
+```ruby
+  s = Signup.new(email: "fede@example.com", phone_number: "987654321")
+  # => #<Signup:0x000000015f8dd0 @attributes={:email=>"fede@example.com"}>
+```
+
+### Custom Validations
+
+
+Up until here, we haven't talked about validations.
+
+Va allows you to write generic validations.
+
+For example, if we need the email to be present and the password and password validation to match, we can do it as it follows:
+
+```ruby
+  s = Signup.new(email: "fede@example.com", password: "a", password_confirmation: "a")
+  s.valid?
+  # => true
+  
+  t = Signup.new(password: "a", password_confirmation: "a")
+  t.valid?
+  # => false
+  
+  u = Signup.new(email: "fede@example.com", password: "a", password_confirmation: "b")
+  u.valid?
+  # => false
+```
+
+### Predefined Validations
+
+#### Blank
+
+If you want to validate that a field is not blank, you can just say:
+
+```ruby
+  class Person < Va::Model
+    attribute :name
+    attribute :age
+    validate_present(:name, :age)
+  end
+```
+
+And if any of those attributes is either nil or an empty string, the validation will fail.
+
+#### More Validations
+
+TODO: Add more validations
 
 ## Installation
 

data/lib/va.rb

@@ -30,6 +30,14 @@ module Va
       validations << [attrs, block]
     end
 
+    def self.validate_present(*attrs)
+      attrs.each do |attr|
+        validate(attr) do |a|
+          a && a != ""
+        end
+      end
+    end
+    
     def self.keys
       @keys ||= []
     end

data/lib/va/version.rb

@@ -1,3 +1,3 @@
 module Va
-  VERSION = "0.0.5"
+  VERSION = "0.1.0"
 end

data/spec/va_spec.rb

@@ -29,7 +29,7 @@ scope do
     end
   end
 end
-scope "validations" do
+scope "custom validations" do
   test "basic passing validation" do
     class VeryValid < Va::Model
       validate do
@@ -90,3 +90,4 @@ scope "validations" do
     end
   end
 end
+

data/spec/validations_spec.rb

@@ -0,0 +1,30 @@
+require "./spec/spec_helper"
+
+scope "basic validations" do
+  scope "non-blank" do
+    class ANonBlankAttribute < Va::Model
+      attribute :name
+      attribute :age
+      validate_present(:name, :age)
+    end
+    test "passing" do
+      va = ANonBlankAttribute.new(name: "Fede", age: :of_ultron)
+      assert_equal va.valid?, true
+    end
+
+    test "one empty string" do
+      va = ANonBlankAttribute.new(name: "", age: :of_ultron)
+      assert_equal va.valid?, false
+    end
+
+    test "one nil" do
+      va = ANonBlankAttribute.new(name: "Fede", age: nil)
+      assert_equal va.valid?, false
+    end
+
+    test "both empty" do
+      va = ANonBlankAttribute.new(name: nil, age: "")
+      assert_equal va.valid?, false
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: va
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.1.0
 platform: ruby
 authors:
 - Federico Iachetti
@@ -61,6 +61,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -69,6 +70,7 @@ files:
 - lib/va/version.rb
 - spec/spec_helper.rb
 - spec/va_spec.rb
+- spec/validations_spec.rb
 - va.gemspec
 homepage: ''
 licenses:
@@ -97,3 +99,4 @@ summary: Minimalistic framework agnostic Validator.
 test_files:
 - spec/spec_helper.rb
 - spec/va_spec.rb
+- spec/validations_spec.rb