range_validator 0.2.1

data/.rspec

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

data/Gemfile

@@ -0,0 +1,10 @@
+source :rubygems
+
+gem "activemodel", ">= 3.0.0"
+gem "activesupport", ">= 3.0.0"
+
+group :development do
+  gem "jeweler"
+  gem "rspec", ">= 2.5.0"
+  gem "ruby-debug"
+end

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Chris Baker
+
+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,105 @@
+= range_validator
+
+Range validator for ActiveModel
+
+  validates :field, :range => true
+  validates :field, :range => { :overlapping => :other_records }
+  validates :field, :range => { :not_overlapping => Proc.new{ |record| record.other_records } }
+
+== Examples
+
+Suppose we have an Event model and want to ensure its duration is a range.
+  
+  class Event
+    include ActiveModel::Validations
+    attr_accessor :duration
+    
+    validates :duration, :range => true
+  end
+  
+  event = Event.new
+  event.valid? # => false
+  event.errors # => #<OrderedHash {:duration=>["is not a range"]}>
+  
+  event.duration = 1..10
+  event.valid? # => true
+  
+We can also validate that the range does or does not overlap with other 
+records. This is easiest to demonstrate using ActiveRecord. First we create a
+migration for a Meeting model.
+
+  class CreateMeetings < ActiveRecord::Migration
+    def self.up
+      create_table :meetings do |t|
+        t.datetime :meeting_start
+        t.datetime :meeting_end
+        t.integer :room
+      end
+    end
+
+    def self.down
+      drop_table :meetings
+    end
+  end
+  
+We can use the range validator to ensure that two meetings cannot be booked in 
+the same room at the same time.
+
+  class Meeting < ActiveRecord::Base
+    validates :duration, :range => { :not_overlapping => Proc.new{ |m| Meeting.where(:room => m.room) } }
+  
+    def duration
+      meeting_start..meeting_end
+    end
+  end
+
+Now meetings will validate like so:
+
+  meeting = Meeting.new
+  meeting.meeting_start = DateTime.now
+  meeting.meeting_end = DateTime.now + 1.hour
+  meeting.room = 12
+  
+  meeting.valid? # => true
+  meeting.save
+  
+  other_meeting = Meeting.new
+  other_meeting.meeting_start = DateTime.now
+  other_meeting.meeting_end = DateTime.now + 1.hour
+  other_meeting.room = 12
+  
+  other_meeting.valid? # => false
+  other_meeting.errors # => #<OrderedHash {:duration=>["overlaps"]}>
+  
+  other_meeting.room = 4
+  other_meeting.valid? # => true
+
+Constructing complex procs in the validates method can become messy fast. We
+can move that logic into an instance method on the Meeting class and pass
+a symbol to the range validator instead.
+
+  class Meeting < ActiveRecord::Base
+    validates :duration, :range => { :not_overlapping => :meetings_in_same_room }
+
+    def duration
+      meeting_start..meeting_end
+    end
+
+    def meetings_in_same_room
+      Meeting.where :room => room
+    end
+  end
+
+== Contributing to range_validator
+
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2011 Chris Baker. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,45 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  gem.name = "range_validator"
+  gem.homepage = "http://github.com/chrisb87/range_validator"
+  gem.license = "MIT"
+  gem.summary = %Q{ActiveModel validator for ranges}
+  gem.description = %Q{ActiveModel validator for ranges}
+  gem.email = "baker.chris.3@gmail.com"
+  gem.authors = ["Chris Baker"]
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "range_validator #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.2.1

data/lib/range_validator.rb

@@ -0,0 +1,79 @@
+require 'active_model'
+require 'active_support/core_ext'
+require 'active_support/i18n'
+
+I18n.load_path += Dir[File.expand_path(File.join(File.dirname(__FILE__), '../locales', '*.yml')).to_s]
+
+module ActiveModel
+
+  # == Active Model Range Validator
+  module Validations
+    class RangeValidator < ActiveModel::EachValidator
+      OPTIONS = [:overlapping, :not_overlapping].freeze
+
+      def check_validity!
+        options.each do |option, option_value|
+          next if option_value.is_a?(Symbol) || option_value.is_a?(Proc)
+          raise ArgumentError, ":#{option} must be a symbol or a proc"
+        end
+      end
+
+      def validate_each(record, attribute, value)
+        unless value.is_a? Range
+          record.errors.add(attribute, :not_a_range)
+          return
+        end
+
+        options.slice(*OPTIONS).each do |option, option_value|
+          other_records = retrieve_other_records(record, option_value)
+
+          if option == :overlapping && other_records.blank?
+            record.errors.add(attribute, :no_overlap)
+          end
+
+          other_records.each do |other_record|
+            overlap = value.overlaps? other_record.send(attribute)
+
+            if option == :overlapping && !overlap
+              record.errors.add(attribute, :no_overlap)
+            elsif option == :not_overlapping && overlap
+              record.errors.add(attribute, :overlap)
+            end
+          end
+        end
+      end
+
+      protected
+
+      def retrieve_other_records(record, lookup)
+        if lookup.is_a?(Symbol)
+          other_records = record.send(lookup)
+        elsif lookup.is_a?(Proc)
+          other_records = lookup.call(record)
+        end
+
+        responds_to_key = record.respond_to?(:to_key) && !record.to_key.blank?
+
+        (other_records || []).reject do |other_record| 
+          other_record.equal?(record) || (responds_to_key && other_record.to_key == record.to_key)
+        end
+      end
+    end
+
+    module HelperMethods
+      # Validates that the specified attributes are valid ranges and, optionally, that they do
+      # or do not overlap with ranges in other models. Examples:
+      #
+      #   validates :field, :range => true
+      #   validates :field, :range => { :overlapping => Proc.new{ |record| record.other_records } }
+      #   validates :field, :range => { :not_overlapping => :other_records }
+      #
+      # When passing a symbol to :overlapping or :not_overlapping, the object must respond_to that
+      # message with a (possibly empty) list of objects that have the same fields.
+      #
+      def validates_range_of(*attr_names)
+        validates_with RangeValidator, _merge_attributes(attr_names)
+      end
+    end
+  end
+end

data/locales/en.yml

@@ -0,0 +1,6 @@
+en:
+  errors:
+    messages:
+      not_a_range: "is not a range"
+      overlap: "overlaps"
+      no_overlap: "does not overlap"

data/range_validator.gemspec

@@ -0,0 +1,67 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{range_validator}
+  s.version = "0.2.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Chris Baker"]
+  s.date = %q{2011-03-25}
+  s.description = %q{ActiveModel validator for ranges}
+  s.email = %q{baker.chris.3@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".rspec",
+    "Gemfile",
+    "LICENSE",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "lib/range_validator.rb",
+    "locales/en.yml",
+    "range_validator.gemspec",
+    "spec/range_validator_spec.rb",
+    "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/chrisb87/range_validator}
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{ActiveModel validator for ranges}
+  s.test_files = [
+    "spec/range_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"])
+      s.add_runtime_dependency(%q<activesupport>, [">= 3.0.0"])
+      s.add_development_dependency(%q<jeweler>, [">= 0"])
+      s.add_development_dependency(%q<rspec>, [">= 2.5.0"])
+      s.add_development_dependency(%q<ruby-debug>, [">= 0"])
+    else
+      s.add_dependency(%q<activemodel>, [">= 3.0.0"])
+      s.add_dependency(%q<activesupport>, [">= 3.0.0"])
+      s.add_dependency(%q<jeweler>, [">= 0"])
+      s.add_dependency(%q<rspec>, [">= 2.5.0"])
+      s.add_dependency(%q<ruby-debug>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<activemodel>, [">= 3.0.0"])
+    s.add_dependency(%q<activesupport>, [">= 3.0.0"])
+    s.add_dependency(%q<jeweler>, [">= 0"])
+    s.add_dependency(%q<rspec>, [">= 2.5.0"])
+    s.add_dependency(%q<ruby-debug>, [">= 0"])
+  end
+end
+

data/spec/range_validator_spec.rb

@@ -0,0 +1,117 @@
+require 'range_validator'
+require 'spec_helper'
+
+describe "RangeValidator" do
+
+  before(:each) do
+    TestModel.reset_callbacks(:validate)
+    @ranges = { :january             => Date.civil(2011,1,1)..Date.civil(2011,1,31),
+                :february            => Date.civil(2011,2,1)..Date.civil(2011,2,28),
+                :january_to_february => Date.civil(2011,1,1)..Date.civil(2011,2,28)}
+  end
+
+  it "should be valid when the field is a range" do
+    TestModel.validates :duration, :range => true
+    record = TestModel.new({:duration => 0..1})
+  
+    record.should be_valid
+  end
+  
+  it "should not be valid when the field is not a range" do
+    TestModel.validates :name, :range => true
+    record = TestModel.new({:name => "name"})
+  
+    record.should_not be_valid
+    record.errors.should == {:name => ["is not a range"]}
+  end
+
+  describe "overlapping" do
+
+    before(:each) do
+      TestModel.validates :date_range, :range => { :overlapping => :other_records }
+    end
+
+    it "should be valid when there is overlap" do
+      record1 = TestModel.new({:date_range => @ranges[:january]})
+      record2 = TestModel.new({:date_range => @ranges[:january_to_february], :other_records => [record1]})
+
+      record2.should be_valid
+    end
+
+    it "should not be valid when there is no overlap" do
+      record1 = TestModel.new({:date_range => @ranges[:january]})
+      record2 = TestModel.new({:date_range => @ranges[:february], :other_records => [record1]})
+
+      record2.should_not be_valid
+      record2.errors.should == {:date_range => ["does not overlap"]}
+    end
+    
+    it "should not be valid when overlapping an empty set" do
+      record = TestModel.new({:date_range => @ranges[:january], :other_records => []})
+      record.should_not be_valid
+      record.errors.should == {:date_range => ["does not overlap"]}
+    end
+    
+    it "should not be valid when overlapping nil" do
+      record = TestModel.new({:date_range => @ranges[:january], :other_records => nil})
+      record.should_not be_valid
+      record.errors.should == {:date_range => ["does not overlap"]}
+    end
+    
+    it "should throw an error when given a bad argument" do
+      expect {
+        TestModel.validates :duration, :range => { :overlapping => nil }
+      }.to raise_error ArgumentError, ":overlapping must be a symbol or a proc"
+    end
+
+  end
+
+  describe "not_overlapping" do
+
+    before(:each) do
+      TestModel.validates :date_range, :range => { :not_overlapping => :other_records }
+    end
+
+    it "should be valid when there is no overlap" do
+      record1 = TestModel.new({:date_range => @ranges[:january]})
+      record2 = TestModel.new({:date_range => @ranges[:february], :other_records => [record1]})
+
+      record2.should be_valid
+    end
+
+    it "should not be valid when there is an overlap" do
+      record1 = TestModel.new({:date_range => @ranges[:january]})
+      record2 = TestModel.new({:date_range => @ranges[:january_to_february], :other_records => [record1]})
+
+      record2.should_not be_valid
+      record2.errors.should == {:date_range => ["overlaps"]}
+    end
+    
+    it "should be valid when overlapping nil" do
+      record = TestModel.new({:date_range => @ranges[:january], :other_records => nil})
+      record.should be_valid
+    end
+    
+    it "should be valid when overlapping an empty set" do
+      record = TestModel.new({:date_range => @ranges[:january], :other_records => []})
+      record.should be_valid
+    end
+
+    it "should not detect overlap with other records with the same object_id" do
+      record = TestModel.new({:date_range => @ranges[:january]})
+      record.other_records = [record]
+
+      record.should be_valid
+    end
+
+    it "should not detect overlap with other records with the same to_key value" do
+      record1 = TestModel.new({:date_range => @ranges[:january], :to_key => [1]})
+      record2 = TestModel.new({:date_range => @ranges[:january], :to_key => [1]})
+      record2.other_records = [record1]
+
+      record2.should be_valid
+    end
+
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+require 'ostruct'
+require 'active_model'
+
+class TestModel < OpenStruct
+  include ActiveModel::Validations
+end
+

metadata

@@ -0,0 +1,154 @@
+--- !ruby/object:Gem::Specification 
+name: range_validator
+version: !ruby/object:Gem::Version 
+  hash: 21
+  prerelease: false
+  segments: 
+  - 0
+  - 2
+  - 1
+  version: 0.2.1
+platform: ruby
+authors: 
+- Chris Baker
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-03-25 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  type: :runtime
+  prerelease: false
+  name: activemodel
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 3
+        - 0
+        - 0
+        version: 3.0.0
+  requirement: *id001
+- !ruby/object:Gem::Dependency 
+  type: :runtime
+  prerelease: false
+  name: activesupport
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 3
+        - 0
+        - 0
+        version: 3.0.0
+  requirement: *id002
+- !ruby/object:Gem::Dependency 
+  type: :development
+  prerelease: false
+  name: jeweler
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id003
+- !ruby/object:Gem::Dependency 
+  type: :development
+  prerelease: false
+  name: rspec
+  version_requirements: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 27
+        segments: 
+        - 2
+        - 5
+        - 0
+        version: 2.5.0
+  requirement: *id004
+- !ruby/object:Gem::Dependency 
+  type: :development
+  prerelease: false
+  name: ruby-debug
+  version_requirements: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id005
+description: ActiveModel validator for ranges
+email: baker.chris.3@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .rspec
+- Gemfile
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/range_validator.rb
+- locales/en.yml
+- range_validator.gemspec
+- spec/range_validator_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/chrisb87/range_validator
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+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: ActiveModel validator for ranges
+test_files: 
+- spec/range_validator_spec.rb
+- spec/spec_helper.rb