twin_validator 0.1

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,5 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg

data/.rspec

@@ -0,0 +1,2 @@
+--colour
+--format documentation

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Nathan Kleyn
+
+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.rdoc

@@ -0,0 +1,24 @@
+= twin_validator
+
+A simple twin field validator for Rails 3.
+
+  gem sources -a http://gemcutter.org/
+  gem install twin_validator
+
+== What is a twin field?
+
+A twin field is a field that has a useless value unless a previous field has been set. This often manifiests itself as checkbox/text field or select/text field pair. Think in terms of a select box with one option for 'Other'; the 'Other' option should show a text box, validated only when it it set as such.
+
+You can validate the text field only when the previous field is set to your chosen value. Jump into your model and validate like so:
+
+  validates :field, :inclusion => { :in => [true, false }
+  validates :other_field, :twin => { :twins => [:field] }
+
+For now, the only options you can use are:
+
+  :twins # An Enumerable of symbols to resolve as attributes of the model.
+  :check_against # A value that, if the twins are set to, this model should be validated as a result.
+
+== Copyright
+
+Copyright (c) 2010 Nathan Kleyn. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,48 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "twin_validator"
+    gem.summary = "A simple twin field validator for Rails 3."
+    gem.description = "A simple twin field validator for Rails 3."
+    gem.email = "nathan@unfinitydesign.com"
+    gem.homepage = "http://github.com/nathankleyn/twin_validator"
+    gem.authors = ["Nathan Kleyn"]
+
+    gem.add_dependency 'activemodel', '>= 3.0.0.beta4'
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+
+# Rake RSpec2 task stuff
+gem 'rspec', '>= 2.0.0.beta.12'
+gem 'rspec-expectations'
+
+require 'rspec/core/rake_task'
+
+desc "Run the specs under spec"
+RSpec::Core::RakeTask.new do |t|
+
+end
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION')
+    version = File.read('VERSION')
+  else
+    version = ""
+  end
+
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "twin_validator #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1

data/lib/twin_validator.rb

@@ -0,0 +1,28 @@
+require 'active_model'
+
+module ActiveModel
+  module Validations
+    class TwinValidator < ActiveModel::EachValidator
+      def check_validity!
+        raise ArgumentError, "An Enumerable object is required and must be supplied as the " <<
+                              ":twins option of the configuration hash" unless options[:twins].respond_to?(:each)
+      end
+
+      def validate_each(record, attribute, value)
+        options[:twins].each do |twin|
+          value = record.send(:read_attribute_for_validation, twin)
+          record.errors.add_on_blank(attribute, options[:message]) if value
+        end
+      end
+
+      module HelperMethods
+
+        def validates_twin_of(*attr_names)
+          validates_with TwinValidator, _merge_attributes(attr_names)
+        end
+
+      end
+
+    end
+  end
+end

data/locales/en.yml

@@ -0,0 +1,6 @@
+# Sample localization file for English. Add more files in this directory for other locales.
+# See http://github.com/svenfuchs/rails-i18n/tree/master/rails%2Flocale for starting points.
+
+en:
+  errors:
+    messages:

data/spec/spec_helper.rb

@@ -0,0 +1,20 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require 'rubygems'
+require 'active_model'
+
+require 'lib/date_validator'
+require 'rspec'
+require 'rspec/autorun'
+
+I18n.load_path += Dir[File.join('locales', '*.{rb,yml}')]
+
+class TestRecord
+  include ActiveModel::Validations
+  attr_accessor :expiration_date
+
+  def initialize(expiration_date)
+    @expiration_date = expiration_date
+  end
+end

data/spec/twin_validator_spec.rb

@@ -0,0 +1,109 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+require 'active_support/time' # For testing Date and TimeWithZone objects
+
+describe "DateValidator" do
+
+  before(:each) do
+    TestRecord.reset_callbacks(:validate)
+  end
+
+  it "should check validity of the arguments" do
+    [3, "foo", 1..6].each do |wrong_argument|
+      expect {
+        TestRecord.validates :expiration_date, :date => {:before => wrong_argument}
+      }.to raise_error(ArgumentError, ":before must be a time, a date, a time_with_zone, a symbol or a proc")
+    end
+  end
+
+  [:valid,:invalid].each do |should_be|
+
+    _context = should_be == :valid ? 'when value validates correctly' : 'when value does not match validation requirements'
+
+    context _context do
+
+      [:after, :before, :after_or_equal_to, :before_or_equal_to].each do |check|
+
+          now = Time.now.to_datetime
+
+          model_date = case check
+            when :after then should_be == :valid ? now + 21000 : now - 1
+            when :before then should_be == :valid ? now - 21000 : now + 1
+            when :after_or_equal_to then should_be == :valid ? now : now - 21000
+            when :before_or_equal_to then should_be == :valid ? now : now + 21000
+          end
+
+          it "should ensure that an attribute is #{should_be} when #{should_be == :valid ? 'respecting' : 'offending' } the #{check} check" do
+            TestRecord.validates :expiration_date, :date => {:"#{check}" => Time.now}
+            model = TestRecord.new(model_date)
+            should_be == :valid ? model.should(be_valid, "an attribute should be valid when respecting the #{check} check") : model.should_not(be_valid, "an attribute should be invalidwhen offending the #{check} check")
+          end
+
+          if _context == 'when value does not match validation requirements'
+
+            it "should yield a default error message indicating that value must be #{check} validation requirements" do
+              TestRecord.validates :expiration_date, :date => {:"#{check}" => Time.now}
+              model = TestRecord.new(model_date)
+              model.should_not be_valid
+              model.errors[:expiration_date].should == ["must be " + check.to_s.gsub('_',' ') + " #{Time.now}"]
+            end
+            
+          end
+
+      end
+
+      if _context == 'when value does not match validation requirements'
+
+        it "should allow for a custom validation message" do
+          TestRecord.validates :expiration_date, :date => {:before_or_equal_to => Time.now, :message => 'must be after Christmas'}
+          model = TestRecord.new(Time.now + 21000)
+          model.should_not be_valid
+          model.errors[:expiration_date].should == ["must be after Christmas"]
+        end
+
+      end
+
+    end
+
+  end
+
+  extra_types = [:proc, :symbol]
+  extra_types.push(:date) if defined?(Date) and defined?(DateTime)
+  extra_types.push(:time_with_zone) if defined?(ActiveSupport::TimeWithZone)
+
+  extra_types.each do |type|
+    it "should accept a #{type} as an argument to a check" do
+      case type
+        when :proc then
+          expect {
+            TestRecord.validates :expiration_date, :date => {:after => Proc.new{Time.now + 21000}}
+          }.to_not raise_error
+        when :symbol then
+          expect {
+            TestRecord.send(:define_method, :min_date, lambda { Time.now + 21000 })
+            TestRecord.validates :expiration_date, :date => {:after => :min_date}
+          }.to_not raise_error
+        when :date then
+          expect {
+            TestRecord.validates :expiration_date, :date => {:after => Time.now.to_date}
+          }.to_not raise_error
+        when :time_with_zone then
+          expect {
+            Time.zone = "Hawaii"
+            TestRecord.validates :expiration_date, :date => {:before => Time.zone.parse((Time.now + 21000).to_s)}
+          }.to_not raise_error
+      end
+    end
+  end
+
+  it "should gracefully handle an unexpected result from a proc argument evaluation" do
+    TestRecord.validates :expiration_date, :date => {:after => Proc.new{ nil }}
+    TestRecord.new(Time.now).should_not be_valid
+  end
+
+  it "should gracefully handle an unexpected result from a symbol argument evaluation" do
+    TestRecord.send(:define_method, :min_date, lambda { nil })
+    TestRecord.validates :expiration_date, :date => {:after => :min_date}
+    TestRecord.new(Time.now).should_not be_valid
+  end
+end

data/twin_validator.gemspec

@@ -0,0 +1,56 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{twin_validator}
+  s.version = "0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Nathan Kleyn"]
+  s.date = %q{2010-07-19}
+  s.description = %q{A simple twin field validator for Rails 3.}
+  s.email = %q{nathan@unfinitydesign.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     ".rspec",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "twin_validator.gemspec",
+     "lib/twin_validator.rb",
+     "locales/en.yml",
+     "spec/twin_validator_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/nathankleyn/twin_validator}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{A simple twin field validator for Rails 3.}
+  s.test_files = [
+    "spec/twin_validator_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<activemodel>, [">= 3.0.0.beta4"])
+    else
+      s.add_dependency(%q<activemodel>, [">= 3.0.0.beta4"])
+    end
+  else
+    s.add_dependency(%q<activemodel>, [">= 3.0.0.beta4"])
+  end
+end
+

metadata

@@ -0,0 +1,95 @@
+--- !ruby/object:Gem::Specification 
+name: twin_validator
+version: !ruby/object:Gem::Version 
+  hash: 9
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  version: "0.1"
+platform: ruby
+authors: 
+- Nathan Kleyn
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-07-19 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activemodel
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 299253624
+        segments: 
+        - 3
+        - 0
+        - 0
+        - beta4
+        version: 3.0.0.beta4
+  type: :runtime
+  version_requirements: *id001
+description: A simple twin field validator for Rails 3.
+email: nathan@unfinitydesign.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- .rspec
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- twin_validator.gemspec
+- lib/twin_validator.rb
+- locales/en.yml
+- spec/twin_validator_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/nathankleyn/twin_validator
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: A simple twin field validator for Rails 3.
+test_files: 
+- spec/twin_validator_spec.rb
+- spec/spec_helper.rb