uniqueable 0.0.2

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

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

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Gary Rennie
+
+MIT License
+
+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.md

@@ -0,0 +1,88 @@
+# Uniqueable
+
+Uniqueable allows the checking of cross-model and cross-attribute uniqueness check.  For example, if you have users and organisations, both of which have a name that is used in the url, then you will want to check uniqueness across both of the models.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'uniqueable'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install uniqueable
+
+## Usage
+
+Uniqueable adds a uniqueable method and validator to your models.  Uniqueable is most useful when validating uniqueness across multiple Models and fields.
+
+    class User < ActiveRecord::Base
+      include Uniqueable
+      uniquable :username
+      validates :username, :uniqueable => true
+    end
+
+    class Organsation < ActiveRecord::Base
+      include Uniqueable
+      uniquable :alias
+      validates :alias, :uniqueable => true
+    end
+
+    user = User.create(:username => "gazler")                 # Works
+    organisation = Organisation.create(:alias => "gazler")    # Does not work
+    organisation.errors.messages                              # {:alias => ["has already been taken"]}
+
+### Groups
+In a large application, you may want to check uniqueness for multiple groups of things.  Uniqueable includes groups for this:
+
+    class User < ActiveRecord::Base
+      include Uniqueable
+      uniquable :username, :group => :names_for_stuff
+      validates :username, :uniqueable => {:group => :names_for_stuff}
+    end
+
+    class Organsation < ActiveRecord::Base
+      include Uniqueable
+      uniquable :alias, :group => :names_for_stuff
+      validates :alias, :uniqueable => {:group => :names_for_stuff}
+    end
+
+    class Organsation < ActiveRecord::Base
+      include Uniqueable
+      uniquable :alias, :group => :names_for_stuff
+      uniquable :alias
+      validates :uniquable
+    end
+
+
+    admin_user = AdminUser.create(:alias => "gazler")         # Works
+    user = User.create(:username => "gazler")                 # Does not work
+    organisation = Organisation.create(:alias => "gazler")    # Does not work
+    admin_user = AdminUser.create(:alias => "gazler")         # Does not work
+
+### Other options
+
+The `case_sensitive` option can be sent through with the validator.  It defaults to true.
+
+    class User < ActiveRecord::Base
+      include Uniqueable
+      uniquable :username, :group => :names_for_stuff
+      validates :username, :uniqueable => {:group => :names_for_stuff, :case_sensitive => false}
+    end
+
+### Notes
+
+If a group is not set then everything will act in the nil group.  That is, all uniqueables without a group will validate against all other uniqueables without a group.
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,7 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => [:spec]

data/lib/uniqueable/validates_uniqueable.rb

@@ -0,0 +1,30 @@
+module Uniqueable
+  class UniqueableValidator < ActiveModel::EachValidator
+    def initialize(options)
+      super(options.reverse_merge(:case_sensitive => true))
+    end
+
+    def validate_each(record, attribute, value)
+      checks = record.class.uniqueable_checks[options[:group]]
+      #Make the check atomic
+      return unless checks
+      checks.each do |klass, keys|
+        keys.each do |key|
+          #Check nothing exists with this pair
+          if options[:case_sensitive]
+            result = klass.where(key => value)
+          else
+            result = klass.find(:all, :conditions => ["lower(#{key}) = ?", value.downcase]) 
+          end
+
+          unless result.empty?
+            #Check that the result isn't the record we are validating
+            unless result.first == record
+              return record.errors.add(attribute, :taken)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/uniqueable/version.rb

@@ -0,0 +1,3 @@
+module Uniqueable
+  VERSION = "0.0.2"
+end

data/lib/uniqueable.rb

@@ -0,0 +1,31 @@
+require 'active_model'
+require "uniqueable/version"
+require "uniqueable/validates_uniqueable"
+
+module Uniqueable
+  class << self
+    attr_accessor :uniqueable_checks
+
+    def included(base)
+      base.extend(ClassMethods)
+      @uniqueable_checks ||= {}
+      base.uniqueable_checks = uniqueable_checks
+    end
+  end
+
+  module ClassMethods
+    attr_accessor :uniqueable_checks
+    def uniqueable(*values)
+      options = values.last.kind_of?(Hash) ? values.pop : {}
+      group = options[:group]
+      klass = self
+      uniqueable_checks[group] ||= {}
+      uniqueable_checks[group][klass] ||= []
+      values.each do |value|
+        uniqueable_checks[group][klass] << value
+      end
+      uniqueable_checks[group][klass].uniq!
+    end
+
+  end
+end

data/spec/schema.rb

@@ -0,0 +1,16 @@
+ActiveRecord::Schema.define(:version => 0) do
+  create_table :users do |t|
+    t.string :username
+    t.string :name
+  end
+
+  create_table :organisations do |t|
+    t.string :alias
+    t.string :name
+  end
+
+  create_table :admin_users do |t|
+    t.string :username
+    t.string :name
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+require "active_record"
+require './lib/uniqueable'
+
+ActiveRecord::Base.establish_connection :adapter => "sqlite3", :database => ":memory:"
+load "schema.rb"
+
+RSpec.configure do |config|
+  config.before do
+    ActiveRecord::Base.descendants.each do |model|
+      model.delete_all
+      Object.class_eval { remove_const model.name if const_defined?(model.name) }
+    end
+  end
+end

data/spec/uniqueable/module_spec.rb

@@ -0,0 +1,63 @@
+require 'spec_helper'
+
+describe Uniqueable do
+  before(:each) do
+    # Reset the value
+    Uniqueable.instance_variable_set(:@uniqueable_checks, nil)
+    class Tester
+      include Uniqueable
+    end
+
+    class AnotherTester
+      include Uniqueable
+    end
+  end
+    
+  context "when included" do
+    it "should default the checks variable to a hash" do
+      Tester.uniqueable_checks.should eql({}) 
+    end
+
+  end
+
+  context "uniqueable class method" do
+
+    context "without a group" do
+      
+      it "should add a uniqueable value when called" do
+        Tester.uniqueable(:name) 
+        Tester.uniqueable_checks.should eql({nil => {Tester => [:name]}})
+      end
+
+      it "should add multiple values when called" do
+        Tester.uniqueable(:name, :another)  
+        Tester.uniqueable_checks.should eql({nil => {Tester => [:name, :another]}})
+      end
+
+      it "should add multiple values from multiple classes" do
+        Tester.uniqueable(:name, :another)  
+        AnotherTester.uniqueable(:alias, :email)
+        Tester.uniqueable_checks.should eql({nil => {Tester => [:name, :another], AnotherTester => [:alias, :email]}})
+        AnotherTester.uniqueable_checks.should eql({nil => {Tester => [:name, :another], AnotherTester => [:alias, :email]}})
+      end
+
+      it "should not add the same value more than once" do
+        Tester.uniqueable(:name, :name) 
+        Tester.uniqueable(:name, :name)
+        Tester.uniqueable_checks.should eql({nil => {Tester => [:name]}})
+      end
+
+    end
+
+    it "should add a uniqueable with a group" do
+      Tester.uniqueable(:name, :group => :aliases) 
+      Tester.uniqueable_checks.should eql({:aliases => {Tester => [:name]}})
+    end
+
+    it "should add multiple values to the same group" do
+      Tester.uniqueable(:name, :group => :aliases) 
+      AnotherTester.uniqueable(:name, :group => :aliases) 
+      Tester.uniqueable_checks.should eql({:aliases => {Tester => [:name], AnotherTester=> [:name]}})
+    end
+  end
+end

data/spec/uniqueable/validates_uniqueable_spec.rb

@@ -0,0 +1,127 @@
+require 'spec_helper'
+
+
+describe Uniqueable::UniqueableValidator do
+  context "without a group identifier" do
+    before(:each) do
+      Uniqueable.instance_variable_set(:@uniqueable_checks, nil)
+      class User < ActiveRecord::Base
+        include Uniqueable
+        uniqueable :username
+        validates :username, :uniqueable => true
+      end
+
+      class Organisation < ActiveRecord::Base
+        include Uniqueable
+        uniqueable :alias
+        validates :alias, :uniqueable => true
+      end
+      User.delete_all
+      Organisation.delete_all
+
+      user = User.create(:name => "Gazler", :username => "gazler")
+      user.should be_valid
+    end
+    
+    it "should validate against the global group (nil)" do
+      user2 = User.create(:name => "Gazler2", :username => "gazler")
+      user2.should_not be_valid
+    end
+
+    it "should not affect an organisation with a unique alias" do
+      organisation = Organisation.create(:name => "Organisation", :alias => "org")
+      organisation.should be_valid
+    end
+
+    it "should affect an organistion that clashes with a user" do
+      organisation = Organisation.create(:name => "Organisation", :alias => "gazler")
+      organisation.should_not be_valid
+    end
+  
+  end
+
+  context "with a group identifier" do
+    before(:each) do
+      Uniqueable.instance_variable_set(:@uniqueable_checks, nil)
+      class User < ActiveRecord::Base
+        include Uniqueable
+        uniqueable :username, :group => :aliases
+        validates :username, :uniqueable => {:group => :aliases}
+      end
+
+      class Organisation < ActiveRecord::Base
+        include Uniqueable
+        uniqueable :alias, :group => :aliases
+        validates :alias, :uniqueable => {:group => :aliases} 
+      end
+
+      class AdminUser < ActiveRecord::Base
+        include Uniqueable
+        uniqueable :username, :group => :aliases
+        validates :username, :uniqueable => true
+      end
+      User.delete_all
+      Organisation.delete_all
+
+      user = User.create(:name => "Gazler", :username => "gazler")
+      user.should be_valid
+    end
+
+    it "should validate against the aliases group" do
+      user2 = User.create(:name => "Gazler2", :username => "gazler")
+      user2.should_not be_valid
+    end
+
+    it "should not affect an organisation with a unique alias" do
+      organisation = Organisation.create(:name => "Organisation", :alias => "org")
+      organisation.should be_valid
+    end
+
+    it "should affect an organistion that clashes with a user" do
+      organisation = Organisation.create(:name => "Organisation", :alias => "gazler")
+      organisation.should_not be_valid
+    end
+
+    it "should not affect items validated against a different group" do
+      admin_user = AdminUser.create(:name => "Gazler", :username => "gazler")
+      admin_user.should be_valid
+    end
+
+  end
+
+  context "case insensitivity" do
+    before(:each) do
+      Uniqueable.instance_variable_set(:@uniqueable_checks, nil)
+      class User < ActiveRecord::Base
+        include Uniqueable
+        uniqueable :username
+        validates :username, :uniqueable => {:case_sensitive => false}
+      end
+
+      class Organisation < ActiveRecord::Base
+        include Uniqueable
+        uniqueable :alias
+        validates :alias, :uniqueable => true
+      end
+      User.delete_all
+      Organisation.delete_all
+    end
+
+    it "should be case sensitive by default" do
+      user = User.create(:name => "Gazler", :username => "Gazler") 
+      user.should be_valid
+      organisation = Organisation.create(:name => "gazler", :alias => "Gazler") 
+      organisation.should_not be_valid
+      organisation = Organisation.create(:name => "gazler", :alias => "gazler") 
+      organisation.should be_valid
+    end
+
+    it "should allow for case insensitivity" do
+      user = User.create(:name => "Gazler", :username => "Gazler") 
+      user.should be_valid
+      user = User.create(:name => "gazler", :username => "gazler") 
+      user.should_not be_valid
+    end
+  end
+    
+end

data/uniqueable.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/uniqueable/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Gary Rennie"]
+  gem.email         = ["webmaster@gazler.com"]
+  gem.description   = %q{Check uniqueness across models}
+  gem.summary       = %q{Check uniqueness across models}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "uniqueable"
+  gem.require_paths = ["lib"]
+  gem.version       = Uniqueable::VERSION
+
+  gem.add_development_dependency "rspec", "~>2.8.0"
+  gem.add_development_dependency "activemodel", ">3.0.0"
+  gem.add_development_dependency "activerecord", ">3.0.0"
+  gem.add_development_dependency "sqlite3"
+  gem.add_development_dependency "rake"
+end

metadata

@@ -0,0 +1,149 @@
+--- !ruby/object:Gem::Specification
+name: uniqueable
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+  prerelease: 
+platform: ruby
+authors:
+- Gary Rennie
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-10-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.8.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.8.0
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>'
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>'
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>'
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>'
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Check uniqueness across models
+email:
+- webmaster@gazler.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/uniqueable.rb
+- lib/uniqueable/validates_uniqueable.rb
+- lib/uniqueable/version.rb
+- spec/schema.rb
+- spec/spec_helper.rb
+- spec/uniqueable/module_spec.rb
+- spec/uniqueable/validates_uniqueable_spec.rb
+- uniqueable.gemspec
+homepage: ''
+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'
+      segments:
+      - 0
+      hash: 1837060293483589432
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 1837060293483589432
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Check uniqueness across models
+test_files:
+- spec/schema.rb
+- spec/spec_helper.rb
+- spec/uniqueable/module_spec.rb
+- spec/uniqueable/validates_uniqueable_spec.rb