valid_attribute 0.1.0 → 0.2.0

data/HISTORY

@@ -1,3 +1,7 @@
+== 0.2.0
+  Test::Unit::TestCase support. You should use shoulda-context
+  Fixed logic bug with #does_not_match?
+
 == 0.1.0
   Version bump. API is stable
 

data/README.markdown

@@ -4,17 +4,26 @@ ValidAttribute is a minimalist framework for validation BDD.
 
 ## Installation ##
 
-If you're using Rails just add the library to your Gemfile
+If you're using `RSpec` just add the `valid_attribute` to your `Gemfile`
 
     gem 'valid_attribute'
 
-Then add it to your spec_helper
+Then add it to your `spec_helper.rb`
 
     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'
+
+    # 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
+Instead of having validation specific matchers `ValidAttribute` only cares if the attribute is valid under certain circumstances
 
     class User
       include ActiveModel::Validations
@@ -26,12 +35,13 @@ Instead of having validation specific matchers ValidAttribute only cares if the
       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')
+      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
@@ -41,12 +51,29 @@ Instead of having validation specific matchers ValidAttribute only cares if the
       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 ##
 
-As long as your model responds to the following methods:
+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.
+* `valid?` - only used to generate errors on the model
+* `errors` - should be a collection of attributes that have validation errors.
 
 Other than that everything should work!
 

data/lib/valid_attribute/matcher.rb

@@ -0,0 +1,71 @@
+module ValidAttribute
+  class Matcher
+    attr_accessor :attr, :values, :subject, :failed_values, :passed_values
+
+    def initialize(attr)
+      self.attr = attr
+    end
+
+    def when(*values)
+      self.values = values
+      self
+    end
+
+    def failure_message
+      if failed_values.size == 1
+        " expected #{subject.class}##{attr} to accept the value: #{quote_values(failed_values)}"
+      else
+        " expected #{subject.class}##{attr} to accept the values: #{quote_values(failed_values)}"
+      end
+    end
+
+    def negative_failure_message
+      if passed_values.size == 1
+        " expected #{subject.class}##{attr} to not accept the value: #{quote_values(passed_values)}"
+      else
+        " expected #{subject.class}##{attr} to not accept the values: #{quote_values(passed_values)}"
+      end
+    end
+
+    def description
+      "be valid when: #{quote_values(values)}"
+    end
+
+    def matches?(subject)
+      check_values(subject)
+      failed_values.empty?
+    end
+
+    def does_not_match?(subject)
+      check_values(subject)
+      !failed_values.empty? && passed_values.empty?
+    end
+
+    private
+
+    def check_values(subject)
+      unless values
+        raise ::ValidAttribute::NoValues, "you need to set the values with .when on the matcher. Example: have_valid(:name).when('Brian')"
+      end
+
+      self.subject       = subject
+      self.failed_values = []
+      self.passed_values = []
+
+      values.each do |value|
+        subject.send("#{attr}=", value)
+        subject.valid?
+        if subject.errors.key?(attr)
+          self.failed_values << value
+        else
+          self.passed_values << value
+        end
+      end
+    end
+
+    def quote_values(values)
+      values.map { |value| value.is_a?(String) ? "'#{value}'" : value }.join(', ')
+    end
+
+  end
+end

data/lib/valid_attribute/method.rb

@@ -0,0 +1,38 @@
+module ValidAttribute
+  module Method
+    # Assert an attribute is valid with any number of test values
+    #
+    # examples:
+    #  describe User do
+    #    it { should have_valid(:name).when('Brian') }
+    #    it { should_not have_valid(:name).when(nil) }
+    #
+    #    # if we want to test uniqueness we need to setup an existing value
+    #    context 'email' do
+    #      before { User.create(:email => 'brian@test.com') }
+    #      it { should have_valid(:email).when('test@test.com', 'test+spam@gmail.com') }
+    #      it { should_not have_valid(:email).when('abc', 123, 'brian@test.com') }
+    #    end
+    #  end
+    #
+    # If you are using Test::Unit you should use {http://thoughtbot.com Thoughtbot}'s {https://github.com/thoughtbot/shoulda-context shoulda-context}:
+    #  class UserTest < Test::Unit::TestCase
+    #    should have_valid(:name).when('Brian')
+    #    should_not have_valid(:name).when('nil')
+    #
+    #    # if we want to test uniqueness we need to setup an existing value
+    #    context 'email' do
+    #      setup { User.create(:email => 'brian@test.com') }
+    #      should have_valid(:email).when('test@test.com', 'test+spam@gmail.com')
+    #      should_not have_valid(:email).when('abc', 123, 'brian@test.com')
+    #    end
+    #  end
+    #
+    # @param [Symbol]
+    #
+    # @return [ValidAttribute::Matcher]
+    def have_valid(attr)
+      ::ValidAttribute::Matcher.new(attr)
+    end
+  end
+end

data/lib/valid_attribute/rspec.rb

@@ -0,0 +1,3 @@
+module RSpec::Matchers
+  include ValidAttribute::Method
+end

data/lib/valid_attribute/test_unit.rb

@@ -0,0 +1,3 @@
+class Test::Unit::TestCase
+  extend ::ValidAttribute::Method
+end

data/lib/valid_attribute/version.rb

@@ -1,3 +1,3 @@
 module ValidAttribute
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/lib/valid_attribute.rb

@@ -1,88 +1,12 @@
+require 'valid_attribute/matcher'
+require 'valid_attribute/method'
+
 module ValidAttribute
   class NoValues < StandardError; end
-  # Test if an attribute is valid
-  #
-  # examples:
-  #  it { should have_valid(:name).when('Brian') }
-  #  it { should_not have_valid(:name).when(nil) }
-  #  it { should have_valid(:email).when('test@test.com', 'test+spam@gmail.com') }
-  #  it { should_not have_valid(:email).when('abc', 123) }
-  #
-  # @param [Symbol]
-  #
-  # @return [ValidAttribute::ValidAttributeMatcher]
-  def have_valid(attr)
-    ValidAttributeMatcher.new(attr)
-  end
-
-  class ValidAttributeMatcher
-    attr_accessor :attr, :values, :subject, :failed_values, :passed_values
-
-    def initialize(attr)
-      self.attr = attr
-    end
-
-    def when(*values)
-      self.values = values
-      self
-    end
-
-    def failure_message
-      if failed_values.size == 1
-        " expected #{subject.class.model_name}##{attr} to accept the value: #{quote_values(failed_values)}"
-      else
-        " expected #{subject.class.model_name}##{attr} to accept the values: #{quote_values(failed_values)}"
-      end
-    end
-
-    def negative_failure_message
-      if passed_values.size == 1
-        " expected #{subject.class.model_name}##{attr} to not accept the value: #{quote_values(passed_values)}"
-      else
-        " expected #{subject.class.model_name}##{attr} to not accept the values: #{quote_values(passed_values)}"
-      end
-    end
-
-    def matches?(subject)
-      check_values(subject)
-      failed_values.empty?
-    end
-
-    def does_not_match?(subject)
-      check_values(subject)
-      passed_values.empty?
-    end
-
-    private
-
-    def check_values(subject)
-      unless values
-        raise ::ValidAttribute::NoValues, "you need to set the values with .when on the matcher (ex. it { should have_valid(:name).when('Brian') })"
-      end
-
-      self.subject       = subject
-      self.failed_values = []
-      self.passed_values = []
-
-      values.each do |value|
-        subject.send("#{attr}=", value)
-        subject.valid?
-        if subject.errors.key?(attr)
-          self.failed_values << value
-        else
-          self.passed_values << value
-        end
-      end
-    end
-
-    def quote_values(values)
-      values.map { |value| value.is_a?(String) ? "'#{value}'" : value }.join(', ')
-    end
-
-  end
 end
 
-module RSpec::Matchers
-  include ValidAttribute
-end if defined?(RSpec)
-
+if defined?(RSpec)
+  require 'valid_attribute/rspec'
+else
+  require 'valid_attribute/test_unit'
+end

data/spec/spec_helper.rb

@@ -5,10 +5,10 @@ Bundler.setup
 $LOAD_PATH.unshift(File.dirname(__FILE__))
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 require 'ruby-debug'
-require 'valid_attribute'
 require 'rspec'
 require 'rspec/autorun'
 require 'bourne'
+require 'valid_attribute'
 
 RSpec.configure do |config|
   config.mock_with :mocha

data/spec/test_unit_spec.rb

@@ -0,0 +1,12 @@
+# This is a RSpec spec to test TestUnit... yeah that's right
+
+require 'spec_helper'
+require 'test/unit'
+require 'valid_attribute/test_unit'
+
+describe 'Test::Unit::TestCase' do
+  it '.have_valid' do
+    Test::Unit::TestCase.have_valid(:name).should be_instance_of(ValidAttribute::Matcher)
+  end
+end
+

data/spec/user.rb

@@ -0,0 +1,12 @@
+class User
+  attr_accessor :name
+  attr_accessor :email
+
+  def errors
+    @error ||= {}
+  end
+
+  def self.model_name
+    'User'
+  end
+end

data/spec/valid_attribute_spec.rb

@@ -1,20 +1,8 @@
 require 'spec_helper'
+require 'user'
 
 class Should
-  include ValidAttribute
-end
-
-class User
-  attr_accessor :name
-  attr_accessor :email
-
-  def errors
-    @error ||= {}
-  end
-
-  def self.model_name
-    'User'
-  end
+  include ValidAttribute::Method
 end
 
 describe 'ValidAttribute' do
@@ -24,66 +12,83 @@ describe 'ValidAttribute' do
     @user   = User.new
   end
 
-  describe 'valid data' do
-    before do
-      @user.stubs(:valid?).returns(true)
-    end
-
-    it 'passes with values' do
-      matcher = @should.have_valid(:name).when('Brian', 'Stephanie')
-      matcher.matches?(@user).should be_true
-    end
-  end
-
-  describe 'data is first invalid then invalid' do
-    before do
-      @user.stubs(:valid?).returns(false).then.returns(true).then.returns(false).then.returns(true)
-      @user.stubs(:errors).returns({:name => []}).then.returns({}).then.returns({:name => []}).then.returns({})
-      @matcher        = @should.have_valid(:name).when('abc', 123)
-      @matches        = @matcher.matches?(@user)
-      @does_not_match = @matcher.does_not_match?(@user)
-    end
-
-    it 'matches? returns false' do
-      @matches.should be_false
-    end
-
-    it 'does_not_match? returns false' do
-      @does_not_match.should be_false
-    end
-
-    it 'has a failure message of the failed values' do
-      @matcher.failure_message.should == " expected User#name to accept the value: 'abc'"
-    end
-
-    it 'has a negative failure message of the passed values' do
-      @matcher.negative_failure_message.should == " expected User#name to not accept the value: 123"
-    end
-  end
-
-  describe 'data is first invalid then valid then invalid then valid' do
-    before do
-      @user.stubs(:valid?).returns(false).then.returns(true).then.returns(false).then.returns(false).then.returns(true).then.returns(false)
-      @user.stubs(:errors).returns({:name => []}).then.returns({}).then.returns({:name => []}).then.returns({}).then.returns({:name => []}).then.returns({}).then.returns({:name => []}).then.returns({})
-      @matcher        = @should.have_valid(:name).when('abc', 123, 456, 'def')
-      @matches        = @matcher.matches?(@user)
-      @does_not_match = @matcher.does_not_match?(@user)
-    end
-
-    it 'matches? returns false' do
-      @matches.should be_false
-    end
-
-    it 'does_not_match? returns true' do
-      @does_not_match.should be_false
+  describe 'matcher result' do
+    context 'data is valid' do
+      before do
+        @user.stubs(:valid?).returns(true)
+        @user.stubs(:errors).returns({})
+        @matcher = @should.have_valid(:name).when('abc', 123)
+      end
+
+      it 'matches? returns true' do
+        @matcher.matches?(@user).should be_true
+      end
+
+      it 'does_not_match? returns false' do
+        @matcher.does_not_match?(@user).should be_false
+      end
+
+      describe 'messages' do
+        it '#negative_failue_message' do
+          @matcher.matches?(@user)
+          @matcher.negative_failure_message.should == " expected User#name to not accept the values: 'abc', 123"
+        end
+      end
     end
 
-    it 'has a failure message of the failed values' do
-      @matcher.failure_message.should == " expected User#name to accept the values: 'abc', 456"
+    context 'data is invalid' do
+      before do
+        @user.stubs(:valid?).returns(false)
+        @user.stubs(:errors).returns({:name => []})
+        @matcher = @should.have_valid(:name).when('abc', 123)
+      end
+
+      it 'matches? returns false' do
+        @matcher.matches?(@user).should be_false
+      end
+
+      it 'does_not_match? returns true' do
+        @matcher.does_not_match?(@user).should be_true
+      end
+
+      describe 'messages' do
+        it '#failue_message' do
+          @matcher.matches?(@user)
+          @matcher.failure_message.should == " expected User#name to accept the values: 'abc', 123"
+        end
+      end
     end
 
-    it 'has a negative failure message of the passed values' do
-      @matcher.negative_failure_message.should == " expected User#name to not accept the values: 123, 'def'"
+    context 'data is valid then invalid' do
+      before do
+        @user.stubs(:valid?).returns(true).then.returns(false)
+        @user.stubs(:errors).returns({}).then.returns({:name => []})
+        @matcher = @should.have_valid(:name).when('abc', 123)
+      end
+
+      it 'matches? returns false' do
+        @matcher.matches?(@user).should be_false
+      end
+
+      it 'does_not_match? returns false' do
+        @matcher.does_not_match?(@user).should be_false
+      end
+
+      describe 'messages' do
+        it '#failure_message' do
+          @matcher.matches?(@user)
+          @matcher.failure_message.should == " expected User#name to accept the value: 123"
+        end
+
+        it '#negative_failure_message' do
+          @matcher.matches?(@user)
+          @matcher.negative_failure_message.should == " expected User#name to not accept the value: 'abc'"
+        end
+
+        it '#description' do
+          @matcher.description.should == "be valid when: 'abc', 123"
+        end
+      end
     end
   end
 
@@ -91,7 +96,7 @@ describe 'ValidAttribute' do
     matcher = @should.have_valid(:name)
     expect do
       matcher.matches?(@user)
-    end.to raise_error ValidAttribute::NoValues, "you need to set the values with .when on the matcher (ex. it { should have_valid(:name).when('Brian') })"
+    end.to raise_error ValidAttribute::NoValues, "you need to set the values with .when on the matcher. Example: have_valid(:name).when('Brian')"
   end
 
 end

metadata

@@ -2,7 +2,7 @@
 name: valid_attribute
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Brian Cardarella
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-05-07 00:00:00 -04:00
+date: 2011-05-28 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -64,8 +64,14 @@ files:
 - README.markdown
 - Rakefile
 - lib/valid_attribute.rb
+- lib/valid_attribute/matcher.rb
+- lib/valid_attribute/method.rb
+- lib/valid_attribute/rspec.rb
+- lib/valid_attribute/test_unit.rb
 - lib/valid_attribute/version.rb
 - spec/spec_helper.rb
+- spec/test_unit_spec.rb
+- spec/user.rb
 - spec/valid_attribute_spec.rb
 - valid_attribute.gemspec
 has_rdoc: true
@@ -98,4 +104,6 @@ specification_version: 3
 summary: Minimalist validation matcher framework
 test_files: 
 - spec/spec_helper.rb
+- spec/test_unit_spec.rb
+- spec/user.rb
 - spec/valid_attribute_spec.rb