valcro 0.0.1 → 0.0.2

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - 1.9.2
+  - 1.9.3
+  - jruby-19mode
+  - rbx-19mode

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (C) 2012 Harold Giménez
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
+of the Software, and to permit persons to whom the Software is furnished to do
+so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,82 @@
+# Valcro
+
+[![Build Status](https://secure.travis-ci.org/hgimenez/valcro.png?branch=master)](http://travis-ci.org/hgimenez/valcro)
+
+Valcro is the simple validation library for Ruby. It provides 
+
+* A declarative way to describe what makes an object valid
+* A way to declare validator classes encapsulating validations to be shared
+  across objects
+* A method for running validations against an instance of your class
+* A method for checking whether an object is valid
+* Visibility into what validations failed
+
+It is similar in spirit to ActiveModel's or Sequel's validations, but far
+simpler and with a slightly different API. It does not provide validation
+helpers such as `validates_presence_of` or similar.
+
+## Example
+
+```ruby
+require 'valcro'
+
+class Dog
+  include Valcro
+
+  attr_accessor :name
+
+  def validate
+    super
+    errors.add(:name, 'must be great') unless name =~ /super|great|cool/
+  end
+end
+
+dog = Dog.new
+dog.name = 'spike'
+dog.validate
+dog.valid?
+ => false 
+dog.errors[:name]
+ => ["must be great"]
+dog.error_messages
+ => "name must be great"
+```
+
+Unlike other ruby validation libraries, you must call validate explicitely to
+check for validity of objects.
+
+### Sharing validators
+
+You may also have Cats in your system, which share the same validation. Valcro lets you encapsulate validations in an object with the following contract:
+
+* It is constructed with the object being validated
+* It responds to `call`, which receives a `Valcro::ErrorList`. Add validation errors to this object.
+
+```ruby
+class GreatNameValidator
+  def initialize(thing_with_name)
+    @thing_with_name = thing_with_name
+  end
+
+  def call(errors)
+    errors.add(:name, 'must be great') unless @thing_with_name.name =~ /super|great|cool/
+  end
+end
+
+class Dog
+  include Valcro
+  attr_accessor :name
+  validates_with GreatNameValidator
+end
+
+class Cat
+  include Valcro
+  attr_accessor :name
+  validates_with GreatNameValidator
+end
+```
+
+## License
+
+Valcro is copyright (c) Harold Giménez and is released under the terms of the
+MIT License found in the LICENSE file.

data/Rakefile

@@ -1 +1,20 @@
 require "bundler/gem_tasks"
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+task default: :spec
+
+namespace :gem do
+  desc "Release to rubygems"
+  task :release do
+    require File.expand_path('lib/valcro/version', File.dirname(__FILE__))
+    version = Valcro::VERSION
+    message = "Bump to version #{version}"
+    system "git tag -a -m '#{message}' v#{version}"
+    system "git push origin master"
+    system "git push origin $(git tag | tail -1)"
+    system "gem build valcro.gemspec"
+    system "gem push valcro-#{version}.gem"
+    system "rm valcro-#{version}.gem"
+  end
+end

data/lib/valcro.rb

@@ -20,6 +20,7 @@ module Valcro
   end
 
   def validate
+    errors.clear!
     self.class.validators.each do |validator_class|
       validation_runner.add_validator validator_class.new(self)
     end

data/lib/valcro/error_list.rb

@@ -17,6 +17,10 @@ module Valcro
       @errors.select { |error| error.property == prop }.map(&:message) || []
     end
 
+    def clear!
+      @errors = []
+    end
+
     def full_messages
       @errors.map(&:to_s)
     end

data/lib/valcro/version.rb

@@ -1,3 +1,3 @@
 module Valcro
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/spec/error_list_spec.rb

@@ -57,3 +57,14 @@ describe Valcro::ErrorList, '#any?' do
     list.any?.should be_true
   end
 end
+
+describe Valcro::ErrorList, '#clear!' do
+  it 'removes all errors' do
+    list = Valcro::ErrorList.new
+    list.add :prop, 'some error'
+    list.any?.should be_true
+
+    list.clear!
+    list.any?.should be_false
+  end
+end

data/spec/runner_spec.rb

@@ -4,12 +4,12 @@ describe Valcro::Runner do
   it 'can store validators' do
     runner = Valcro::Runner.new
     runner.add_validator :some_validator
-    runner.validators.should have(1).proc
+    runner.validators.should have(1).validator
   end
 
   it 'runs validators' do
     error_list = Valcro::ErrorList.new
-    runner = Valcro::Runner.new(error_list)
+    runner     = Valcro::Runner.new(error_list)
     runner.add_validator lambda { |errors| errors.add :foo, 'Huge mistake' }
 
     runner.validate

data/spec/valcro_spec.rb

@@ -38,8 +38,9 @@ describe Valcro, 'validators' do
 
   class TestClass
     include Valcro
+    attr_accessor :status
     def status
-      "fail"
+      @status ||= "fail"
     end
     validates_with StatusFail
   end
@@ -50,6 +51,17 @@ describe Valcro, 'validators' do
     test_instance.validate
     test_instance.should_not be_valid
   end
+
+  it 'clears validations on subsequent runs' do
+    test_instance = TestClass.new
+
+    test_instance.validate
+    test_instance.should_not be_valid
+
+    test_instance.status = 'win'
+    test_instance.validate
+    test_instance.should be_valid
+  end
 end
 
 describe Valcro, '#error_messages' do

data/valcro.gemspec

@@ -8,8 +8,8 @@ Gem::Specification.new do |s|
   s.authors     = ["Harold Giménez"]
   s.email       = ["harold.gimenez@gmail.com"]
   s.homepage    = ""
-  s.summary     = %q{Validation so simple you probably don't need this}
-  s.description = %q{Validation so simple you probably don't need this}
+  s.summary     = %q{The simplest possible validation library for ruby}
+  s.description = %q{The simplest possible validation library for ruby}
 
   s.rubyforge_project = "valcro"
 
@@ -19,4 +19,5 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
 
   s.add_development_dependency "rspec"
+  s.add_development_dependency "rake"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: valcro
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-02-08 00:00:00.000000000Z
+date: 2012-02-22 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70333795201320 !ruby/object:Gem::Requirement
+  requirement: &70251622748220 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,8 +21,19 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70333795201320
-description: Validation so simple you probably don't need this
+  version_requirements: *70251622748220
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70251622747460 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70251622747460
+description: The simplest possible validation library for ruby
 email:
 - harold.gimenez@gmail.com
 executables: []
@@ -30,7 +41,10 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .travis.yml
 - Gemfile
+- LICENSE
+- README.md
 - Rakefile
 - lib/valcro.rb
 - lib/valcro/error.rb
@@ -55,18 +69,24 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -250877099063039284
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -250877099063039284
 requirements: []
 rubyforge_project: valcro
 rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
-summary: Validation so simple you probably don't need this
+summary: The simplest possible validation library for ruby
 test_files:
 - spec/error_list_spec.rb
 - spec/error_spec.rb