valid_attribute 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/.rspec

@@ -0,0 +1 @@
+--color

data/.rvmrc

@@ -0,0 +1 @@
+rvm --create default@valid_attribute > /dev/null

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in valid_attribute.gemspec
+gemspec

data/README.markdown

@@ -0,0 +1,61 @@
+# ValidAttribute #
+
+ValidAttribute is a minimalist framework for validation BDD.
+
+## Installation ##
+
+If you're using Rails just add the library to your Gemfile
+
+    gem 'valid_attribute'
+
+Then add it to your spec_helper
+
+    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, :message => 'invalid email format' }
+      validates :name,     :length => { :minimum => 5 }
+      validates :password, :confirmation => true, :presence => true
+    end
+
+    describe User do
+      # The .with method can take any number of values that you want to pass
+      it { should have_valid(:email).with('test@test.com', 'test+spam@gmail.com') }
+      it { should_not have_valid(:email).with('fail', 123).message('invalid email format') }
+      it { should have_valid(:name).with('TestName')
+      it { should_not have_valid(:name).with('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).with('password') }
+        # Not providing '.with' defaults to nil
+        it { should_not have_valid(:password) }
+      end
+    end
+
+## Non-ActiveModel models ##
+
+As long as your model responds to the following methods:
+
+* valid? - only used to generate errors on the model
+* errors - should be a Hash of errors, the keys being the attribute with errors and the value for each key being an array of error messages
+* model_name - used in the failure messages. Class level method
+
+Other than that everything should work!
+
+## Legal ##
+
+Brian Cardarella © 2011
+
+[@bcardarella](http://twitter.com/bcardarella)
+
+[Licensed under the MIT license](http://www.opensource.org/licenses/mit-license.php)

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/lib/valid_attribute/version.rb

@@ -0,0 +1,3 @@
+module ValidAttribute
+  VERSION = "0.0.1"
+end

data/lib/valid_attribute.rb

@@ -0,0 +1,73 @@
+module ValidAttribute
+
+  def have_valid(attr)
+    ValidAttributeMatcher.new(attr)
+  end
+
+  class ValidAttributeMatcher
+    attr_accessor :attr, :values, :validation_message, :subject, :failed_value
+
+    def initialize(attr)
+      self.attr   = attr
+      self.values = [nil]
+    end
+
+    def with(*values)
+      self.values = values
+      self
+    end
+
+    def message(message)
+      self.validation_message = message
+      self
+    end
+
+    def negative_failure_message
+      failure_message = " expected #{subject.class.model_name}##{attr} to not accept a value of #{value_message}"
+
+      if validation_message
+        failure_message = "#{failure_message} with a message of '#{validation_message}'"
+      end
+
+      failure_message
+    end
+
+    def failure_message
+      " expected #{subject.class.model_name}##{attr} to accept a value of #{value_message}"
+    end
+
+    def value_message
+      if failed_value.is_a?(String)
+        "'#{failed_value}'"
+      else
+        failed_value
+      end
+    end
+
+    def matches?(subject)
+      self.subject = subject
+
+      values.each do |value|
+        subject.send("#{attr}=", value)
+        subject.valid?
+
+        if subject.errors.include?(attr)
+          self.failed_value = value
+          if validation_message
+            return !subject.errors[attr].include?(validation_message)
+          else
+            return false
+          end
+        end
+      end
+
+      true
+    end
+
+  end
+end
+
+module RSpec::Matchers
+  include ValidAttribute
+end if defined?(RSpec)
+

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+require 'rubygems'
+require 'bundler'
+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'
+
+RSpec.configure do |config|
+  config.mock_with :mocha
+end
+
+

data/spec/valid_attribute_spec.rb

@@ -0,0 +1,120 @@
+require 'spec_helper'
+
+class Should
+  include ValidAttribute
+end
+
+class User
+  attr_accessor :name
+
+  def errors
+    @error ||= {}
+  end
+
+  def self.model_name
+    'User'
+  end
+end
+
+describe 'ValidAttribute' do
+
+  before do
+    @should = Should.new
+    @user   = User.new
+  end
+
+  describe 'valid data' do
+    before do
+      @user.stubs(:valid?).returns(true)
+    end
+
+    it 'passes with no value set' do
+      matcher = @should.have_valid(:name)
+      matcher.matches?(@user).should be_true
+    end
+
+    it 'passes with values set' do
+      matcher = @should.have_valid(:name).with('Brian', 'Stephanie')
+      matcher.matches?(@user).should be_true
+    end
+  end
+
+  describe 'invalid data' do
+    before do
+      @user.stubs(:valid?).returns(false)
+      @user.errors[:name] = ['is not valid']
+    end
+
+    it 'returns false when no message passed' do
+      matcher = @should.have_valid(:name)
+      matcher.matches?(@user).should be_false
+    end
+
+    it 'returns true when wrong message is passed' do
+      matcher = @should.have_valid(:name).message('wrong message')
+      matcher.matches?(@user).should_not be_false
+    end
+
+    it 'returns false when correct message is passed' do
+      matcher = @should.have_valid(:name).message('is not valid')
+      matcher.matches?(@user).should be_false
+    end
+  end
+
+  describe 'data is first valid then invalid' do
+    before do
+      @user.stubs(:valid?).returns(true).then.returns(false)
+      @user.errors[:name] = ['is not valid']
+    end
+
+    it 'returns false' do
+      matcher = @should.have_valid(:name).with('true', 'false')
+      matcher.matches?(@user).should be_false
+    end
+  end
+
+  describe 'failure message' do
+    before do
+      @user.stubs(:valid?).returns(false)
+      @user.errors[:name] = ['is not valid']
+    end
+
+    it 'has a message for string values' do
+      matcher = @should.have_valid(:name).with('Brian')
+      matcher.matches?(@user)
+      matcher.failure_message.should == " expected User#name to accept a value of 'Brian'"
+    end
+
+    it 'has a message for non string values' do
+      matcher = @should.have_valid(:name).with(123)
+      matcher.matches?(@user)
+      matcher.failure_message.should == " expected User#name to accept a value of 123"
+    end
+  end
+
+  describe 'negative failure message' do
+    before do
+      @user.stubs(:valid?).returns(false)
+      @user.errors[:name] = ['is not valid']
+    end
+
+    it 'has a message for string values' do
+      matcher = @should.have_valid(:name).with('Brian')
+      matcher.matches?(@user)
+      matcher.negative_failure_message.should == " expected User#name to not accept a value of 'Brian'"
+    end
+
+    it 'has a message for non string values' do
+      matcher = @should.have_valid(:name).with(123)
+      matcher.matches?(@user)
+      matcher.negative_failure_message.should == " expected User#name to not accept a value of 123"
+    end
+
+    it 'includes the validation message' do
+      matcher = @should.have_valid(:name).with('Brian').message('is not valid')
+      matcher.matches?(@user)
+      matcher.negative_failure_message.should == " expected User#name to not accept a value of 'Brian' with a message of 'is not valid'"
+    end
+  end
+
+end

data/valid_attribute.gemspec

@@ -0,0 +1,29 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "valid_attribute/version"
+
+Gem::Specification.new do |s|
+  s.name        = "valid_attribute"
+  s.version     = ValidAttribute::VERSION
+  s.platform    = Gem::Platform::RUBY
+  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.rubyforge_project = "valid_attribute"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_development_dependency 'rspec'
+  s.add_development_dependency 'bourne'
+  if RUBY_VERSION >= '1.9'
+    s.add_development_dependency 'ruby-debug19'
+  else
+    s.add_development_dependency 'ruby-debug'
+  end
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification 
+name: valid_attribute
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Brian Cardarella
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-04-04 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: bourne
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: ruby-debug19
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id003
+description: Minimalist validation matcher framework
+email: 
+- bcardarella@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- .rspec
+- .rvmrc
+- Gemfile
+- README.markdown
+- Rakefile
+- lib/valid_attribute.rb
+- lib/valid_attribute/version.rb
+- spec/spec_helper.rb
+- spec/valid_attribute_spec.rb
+- valid_attribute.gemspec
+has_rdoc: true
+homepage: https://github.com/bcardarella/valid_attribute
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: valid_attribute
+rubygems_version: 1.5.3
+signing_key: 
+specification_version: 3
+summary: Minimalist validation matcher framework
+test_files: 
+- spec/spec_helper.rb
+- spec/valid_attribute_spec.rb