valid_attribute 0.2.1 → 1.0.0.rc.1

data/README.markdown

@@ -1,79 +1,110 @@
 # ValidAttribute #
 
-ValidAttribute is a minimalist framework for validation BDD.
+ValidAttribute is a minimalist matcher for validation BDD.
+
+Supported ORMs
+
+* ActiveModel based (ActiveRecord >= 3.0, Mongoid >= 2.0, MongoMapper >= 0.9
+* ActiveRecord <= 2.3
+* DataMapper
+* Custom (with compatible API, see below)
 
 ## Installation ##
 
 If you're using `RSpec` just add the `valid_attribute` to your `Gemfile`
 
-    gem 'valid_attribute'
+```ruby
+gem 'valid_attribute'
+```
 
 Then add it to your `spec_helper.rb`
 
-    require 'valid_attribute'
+```ruby
+require 'valid_attribute'
+```
 
 or if you're using `Test::Unit`, you must use [Thoughtbot](http://thoughtbot.com)'s [shoulda-context](https://github.com/thoughtbot/shoulda-context)
 
-    # Gemfile
-    gem 'shoulda-context'
+```ruby
+# Gemfile
+gem 'shoulda-context'
 
-    # test_helper.rb
-    require 'shoulda-context'
-    require 'valid_attribute'
+# test_helper.rb
+require 'shoulda-context'
+require 'valid_attribute'
+```
 
 ## Usage ##
 
 Instead of having validation specific matchers `ValidAttribute` only cares if the attribute is valid under certain circumstances
 
-    class User
-      include ActiveModel::Validations
-
-      attr_accessor :email, :name, :password
-
-      validates :email,    :format => { :with => /\A([^@\s]+)@((?:[-a-z0-9]+\.)+[a-z]{2,})\Z/i }
-      validates :name,     :length => { :minimum => 5 }
-      validates :password, :confirmation => true, :presence => true
-    end
-
-    # RSpec
-    describe User do
-      # The .when method can take any number of values that you want to pass
-      it { should have_valid(:email).when('test@test.com', 'test+spam@gmail.com') }
-      it { should_not have_valid(:email).when('fail', 123) }
-      it { should have_valid(:name).when('TestName') }
-      it { should_not have_valid(:name).when('Test') }
-
-      # Because 'should' works off the the 'subject' in RSpec we can set other values if necessary for a given validation test
-      describe 'password' do
-        before { subject.password_confirmation = 'password' }
-        it { should have_valid(:password).when('password') }
-        it { should_not have_valid(:password).when(nil) }
-      end
-    end
-
-    # TestUnit
-    require 'should/context'
-    class UserTest < Test::Unit::TestCase
-      # The .when method can take any number of values that you want to pass
-      should have_valid(:email).when('test@test.com', 'test+spam@gmail.com')
-      should_not have_valid(:email).when('fail', 123)
-      should have_valid(:name).when('TestName')
-      should_not have_valid(:name).when('Test')
-
-      # Because 'shoulda-context' works off the the 'subject' we can set other values if necessary for a given validation test
-      context 'password' do
-        subject { User.new(:password_confirmation => 'password') }
-        should have_valid(:password).when('password')
-        should_not have_valid(:password).when(nil)
-      end
-    end
-
-## Non-ActiveModel models ##
+```ruby
+class User
+  include ActiveModel::Validations
+
+  attr_accessor :email, :name, :password
+
+  validates :email,    :format => { :with => /\A([^@\s]+)@((?:[-a-z0-9]+\.)+[a-z]{2,})\Z/i }
+  validates :name,     :length => { :minimum => 5 }
+  validates :password, :confirmation => true, :presence => true
+end
+
+# RSpec
+describe User do
+  # The .when method can take any number of values that you want to pass
+  it { should have_valid(:email).when('test@test.com', 'test+spam@gmail.com') }
+  it { should_not have_valid(:email).when('fail', 123) }
+  it { should have_valid(:name).when('TestName') }
+  it { should_not have_valid(:name).when('Test') }
+
+  # Because 'should' works off the the 'subject' in RSpec we can set other values if necessary for a given validation test
+  describe 'password' do
+    before { subject.password_confirmation = 'password' }
+    it { should have_valid(:password).when('password') }
+    it { should_not have_valid(:password).when(nil) }
+  end
+end
+
+# TestUnit
+require 'should/context'
+class UserTest < Test::Unit::TestCase
+  # The .when method can take any number of values that you want to pass
+  should have_valid(:email).when('test@test.com', 'test+spam@gmail.com')
+  should_not have_valid(:email).when('fail', 123)
+  should have_valid(:name).when('TestName')
+  should_not have_valid(:name).when('Test')
+
+  # Because 'shoulda-context' works off the the 'subject' we can set other values if necessary for a given validation test
+  context 'password' do
+    subject { User.new(:password_confirmation => 'password') }
+    should have_valid(:password).when('password')
+    should_not have_valid(:password).when(nil)
+  end
+end
+```
+
+## Custom Models ##
 
 Your model should respond to the following methods:
 
 * `valid?` - only used to generate errors on the model
-* `errors` - should be a collection of attributes that have validation errors.
+* `errors` - should be a Hash of attributes that have the invalid attributes as keys.
+
+The following would be a compatible (albeit unrealistic) model:
+
+```ruby
+class User
+  attr_accessor :name
+
+  def errors
+    {:name => ["can't be blank"]}
+  end
+
+  def valid?
+    false
+  end
+end
+```
 
 Other than that everything should work!
 

data/lib/valid_attribute/matcher.rb

@@ -55,7 +55,8 @@ module ValidAttribute
       values.each do |value|
         subject.send("#{attr}=", value)
         subject.valid?
-        if subject.errors.key?(attr)
+
+        if invalid_attribute?(subject, attr)
           self.failed_values << value
         else
           self.passed_values << value
@@ -63,6 +64,11 @@ module ValidAttribute
       end
     end
 
+    def invalid_attribute?(subject, attr)
+      errors = subject.errors[attr]
+      errors.respond_to?(:empty?) ? !errors.empty? : !!errors
+    end
+
     def quote_values(values)
       values.map { |value| value.inspect }.join(', ')
     end

data/lib/valid_attribute/version.rb

@@ -1,3 +1,3 @@
 module ValidAttribute
-  VERSION = "0.2.1"
+  VERSION = "1.0.0.rc.1"
 end

data/spec/user.rb

@@ -6,7 +6,7 @@ class User
     @error ||= {}
   end
 
-  def self.model_name
-    'User'
+  def valid?
+    errors.empty?
   end
 end

data/spec/valid_attribute_spec.rb

@@ -39,7 +39,7 @@ describe 'ValidAttribute' do
     context 'data is invalid' do
       before do
         @user.stubs(:valid?).returns(false)
-        @user.stubs(:errors).returns({:name => []})
+        @user.stubs(:errors).returns({:name => ["can't be blank"]})
         @matcher = @should.have_valid(:name).when(:abc, nil)
       end
 
@@ -62,7 +62,7 @@ describe 'ValidAttribute' do
     context 'data is valid then invalid' do
       before do
         @user.stubs(:valid?).returns(true).then.returns(false)
-        @user.stubs(:errors).returns({}).then.returns({:name => []})
+        @user.stubs(:errors).returns({}).then.returns({:name => ["can't be blank"]})
         @matcher = @should.have_valid(:name).when('abc', 123)
       end
 

data/valid_attribute.gemspec

@@ -9,8 +9,8 @@ Gem::Specification.new do |s|
   s.authors     = ["Brian Cardarella"]
   s.email       = ["bcardarella@gmail.com"]
   s.homepage    = "https://github.com/bcardarella/valid_attribute"
-  s.summary     = %q{Minimalist validation matcher framework}
-  s.description = %q{Minimalist validation matcher framework}
+  s.summary     = %q{Minimalist validation matcher}
+  s.description = %q{Minimalist validation matcher}
 
   s.rubyforge_project = "valid_attribute"
 

metadata

@@ -1,8 +1,8 @@
 --- !ruby/object:Gem::Specification 
 name: valid_attribute
 version: !ruby/object:Gem::Version 
-  prerelease: 
-  version: 0.2.1
+  prerelease: 6
+  version: 1.0.0.rc.1
 platform: ruby
 authors: 
 - Brian Cardarella
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-05-28 00:00:00 -04:00
+date: 2011-06-06 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -46,7 +46,7 @@ dependencies:
         version: "0"
   type: :development
   version_requirements: *id003
-description: Minimalist validation matcher framework
+description: Minimalist validation matcher
 email: 
 - bcardarella@gmail.com
 executables: []
@@ -92,16 +92,16 @@ required_ruby_version: !ruby/object:Gem::Requirement
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version 
-      version: "0"
+      version: 1.3.1
 requirements: []
 
 rubyforge_project: valid_attribute
-rubygems_version: 1.5.3
+rubygems_version: 1.3.8
 signing_key: 
 specification_version: 3
-summary: Minimalist validation matcher framework
+summary: Minimalist validation matcher
 test_files: 
 - spec/spec_helper.rb
 - spec/test_unit_spec.rb