simple_unique 0.0.1

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Jeremy Green
+
+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,36 @@
+# SimpleUnique 
+
+A simple gem to add `validates_uniqueness_of` to `AWS::Record::Model`
+supplied by `aws-sdk`.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'simple_unique'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install simple_unique 
+
+## Usage
+
+```ruby
+    def Person < AWS::Record::Model
+      string_attr :name
+      validates_uniqueness_of :name
+    end
+```
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/simple_unique/validations/uniqueness.rb

@@ -0,0 +1,45 @@
+require 'aws/record/validator'
+
+module AWS
+  module Record
+    class UniquenessValidator < Validator
+
+      ACCEPTED_OPTIONS = [:message, :scope, :allow_nil, :allow_blank, :if, :unless]
+
+      def validate_attribute record, attribute_name, value
+
+        # @TODO - Model the initial relation setup after the setup
+        # found in ActiveRecord::Validations::UniquenessValidator.
+        # Not sure it we have to go to such lengths or not...
+        relation = record.class
+
+        scope_array(options[:scope]).each do |scope_item|
+          scope_value = record.send(scope_item.to_sym)
+          relation = relation.where(scope_item.to_sym => scope_value)
+        end
+
+        existing_record = relation.where(attribute_name.to_sym => value).first
+        taken = !existing_record.nil?
+
+        record.errors.add(attribute_name, message) if taken #blank
+
+      end
+
+      def message
+        options[:message] || 'has already been taken'
+      end
+
+      protected
+      def scope_array(scope)
+        if scope.nil?
+          []
+        elsif scope.is_a? Array
+          scope
+        else
+          [scope]
+        end
+      end
+
+    end
+  end
+end

data/lib/simple_unique/validations.rb

@@ -0,0 +1,93 @@
+require 'simple_unique/validations/uniqueness'
+
+module AWS
+  module Record
+
+    module Validations
+
+      # Validates whether the value of the specified attributes are unique across 
+      # the system. Useful for making sure that only one user can be named “foo”.
+      #
+      #   class Person < AWS::Record::Model
+      #     validates_uniqueness_of :user_name
+      #   end
+      #
+      # It can also validate whether the value of the specified attributes are unique based on a scope parameter:
+      #
+      #   class Person < AWS::Record::Model
+      #     validates_uniqueness_of :user_name, :scope => :account_id
+      #   end
+      #
+      # Or even multiple scope parameters. For example, making sure that a teacher can only be on the schedule once
+      # per semester for a particular class.
+      #
+      #   class TeacherSchedule < AWS::Record::Model
+      #     validates_uniqueness_of :teacher_id, :scope => [:semester_id, :class_id]
+      #   end
+      #
+      # When the record is created, a check is performed to make sure that no record exists in the database
+      # with the given value for the specified attribute (that maps to a column). When the record is updated,
+      # the same check is made but disregarding the record itself.
+      #
+      # Configuration options:
+      # * <tt>:message</tt> - Specifies a custom error message (default is: "has already been taken").
+      # * <tt>:scope</tt> - One or more columns by which to limit the scope of the uniqueness constraint.
+      # * <tt>:case_sensitive</tt> - Always +true+.  SimpleDB does not support case insensitive search.
+      # * <tt>:allow_nil</tt> - Always +true+.
+      # * <tt>:allow_blank</tt> - Always +true+.
+      # * <tt>:if</tt> - Specifies a method, proc or string to call to determine if the validation should
+      #   occur (e.g. <tt>:if => :allow_validation</tt>, or <tt>:if => Proc.new { |user| user.signup_step > 2 }</tt>).
+      #   The method, proc or string should return or evaluate to a true or false value.
+      # * <tt>:unless</tt> - Specifies a method, proc or string to call to determine if the validation should
+      #   not occur (e.g. <tt>:unless => :skip_validation</tt>, or
+      #   <tt>:unless => Proc.new { |user| user.signup_step <= 2 }</tt>). The method, proc or string should
+      #   return or evaluate to a true or false value.
+      #
+      # === Concurrency and integrity
+      #
+      # Using this validation method in conjunction with AWS::Record::Model#save
+      # does not guarantee the absence of duplicate record insertions, because
+      # uniqueness checks on the application level are inherently prone to race
+      # conditions. For example, suppose that two users try to post a Comment at
+      # the same time, and a Comment's title must be unique. At the database-level,
+      # the actions performed by these users could be interleaved in the following manner:
+      #
+      #               User 1                 |               User 2
+      #  ------------------------------------+--------------------------------------
+      #  # User 1 checks whether there's     |
+      #  # already a comment with the title  |
+      #  # 'My Post'. This is not the case.  |
+      #  SELECT * FROM comments              |
+      #  WHERE title = 'My Post'             |
+      #                                      |
+      #                                      | # User 2 does the same thing and also
+      #                                      | # infers that his title is unique.
+      #                                      | SELECT * FROM comments
+      #                                      | WHERE title = 'My Post'
+      #                                      |
+      #  # User 1 inserts his comment.       |
+      #  INSERT INTO comments                |
+      #  (title, content) VALUES             |
+      #  ('My Post', 'hi!')                  |
+      #                                      |
+      #                                      | # User 2 does the same thing.
+      #                                      | INSERT INTO comments
+      #                                      | (title, content) VALUES
+      #                                      | ('My Post', 'hello!')
+      #                                      |
+      #                                      | # ^^^^^^
+      #                                      | # Boom! We now have a duplicate
+      #                                      | # title!
+      #
+      # To guard against duplicates you should create a process to periodically
+      # scan your data and take appropriate action when duplicates are found.  (Ick!)
+      # This means that this validation is useful only in systems where the data creation
+      # events that trigger it are few and far between (relatively speaking).
+      def validates_uniqueness_of *args
+        validators << UniquenessValidator.new(self, *args)
+      end
+
+    end
+
+  end
+end

data/lib/simple_unique/version.rb

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

data/lib/simple_unique.rb

@@ -0,0 +1,6 @@
+require "simple_unique/version"
+require "simple_unique/validations"
+
+module SimpleUnique 
+  # Your code goes here...
+end

data/simple_unique.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'simple_unique/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "simple_unique"
+  gem.version       = SimpleUnique::VERSION
+  gem.authors       = ["Jeremy Green"]
+  gem.email         = ["jeremy@octolabs.com"]
+  gem.description   = %q{Validations for AWS::Record::Model}
+  gem.summary       = %q{Validations for AWS::Record::Model}
+  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.require_paths = ["lib"]
+
+  gem.add_dependency "aws-sdk", "~> 1.8.0"
+  gem.add_development_dependency "rspec", ">= 2.0.0"
+
+end

data/spec/simple_unique/validations_spec.rb

@@ -0,0 +1,101 @@
+require 'spec_helper'
+
+describe 'model validations' do
+
+  let(:klass) { Class.new(AWS::Record::Base) }
+
+  before(:each) do
+    klass.create_domain
+    klass.each{|u| u.destroy }
+    sleep(2)
+  end
+
+  describe 'validates_uniqueness_of' do
+    it 'should only allow one record with a given attribute value' do
+      klass.string_attr :name
+      klass.validates_uniqueness_of :name
+      widg = klass.new(:name => "Turd Furguson")
+      widg.valid?.should be_true
+      widg.save
+      sleep(2) # Allow a couple of seconds for SimpleDB to catch up
+
+      widg = klass.new(:name => "Turd Furguson")
+      widg.valid?.should be_false
+      widg.errors[:name].should == ['has already been taken']
+    end
+
+    it 'should only allow one record with a given attribute value within a given scope' do
+      klass.string_attr :name
+      klass.string_attr :category
+      klass.validates_uniqueness_of :name, :scope => :category
+      widg = klass.new(:name => "Turd Furguson", :category => "Funny name")
+      widg.valid?.should be_true
+      widg.save
+      sleep(2) # Allow a couple of seconds for SimpleDB to catch up
+
+      widg = klass.new(:name => "Turd Furguson", :category => "Funny name")
+      widg.valid?.should be_false
+      widg.errors[:name].should == ['has already been taken']
+
+      widg.category = "Silly name"
+      widg.valid?.should be_true
+    end
+
+
+    it 'should skip the validation if the given attribute is nil when :allow_nil => true' do
+      klass.string_attr :name
+      klass.string_attr :category # need to avoid the "can't save empty record" error
+      klass.validates_uniqueness_of :name#, :allow_nil => true
+      widg = klass.new(:name => nil, :category => "A cat")
+      widg.valid?.should be_true
+      widg.save
+      sleep(2) # Allow a couple of seconds for SimpleDB to catch up
+
+      widg = klass.new(:name => nil, :category => "A cat")
+      widg.valid?.should be_true
+    end
+
+    it 'should skip the validation if the given attribute is blank when :allow_blank => true' do
+      klass.string_attr :name
+      klass.string_attr :category # need to avoid the "can't save empty record" error
+      klass.validates_uniqueness_of :name#, :allow_blank => true
+      widg = klass.new(:name => "", :category => "A cat")
+      widg.valid?.should be_true
+      widg.save
+      sleep(2) # Allow a couple of seconds for SimpleDB to catch up
+
+      widg = klass.new(:name => "", :category => "A cat")
+      widg.valid?.should be_true
+    end
+
+    it 'should skip the validation if the :if option evaluates to false' do
+      klass.string_attr :name
+      klass.boolean_attr :should_validate
+      klass.validates_uniqueness_of :name, :if => :should_validate
+      widg = klass.new(:name => "Turd Furguson")
+      widg.valid?.should be_true
+      widg.save
+      sleep(2) # Allow a couple of seconds for SimpleDB to catch up
+
+      widg = klass.new(:name => "Turd Furguson",:should_validate => false)
+      widg.valid?.should be_true
+    end
+
+    it 'should skip the validation if the :unless option evaluates to true' do
+      klass.string_attr :name
+      klass.boolean_attr :should_not_validate
+      klass.validates_uniqueness_of :name, :unless => :should_not_validate
+      widg = klass.new(:name => "Turd Furguson")
+      widg.valid?.should be_true
+      widg.save
+      sleep(2) # Allow a couple of seconds for SimpleDB to catch up
+
+      widg = klass.new(:name => "Turd Furguson",:should_not_validate => true)
+      widg.valid?.should be_true
+    end
+
+  end
+
+end
+
+

data/spec/spec_helper.rb

@@ -0,0 +1,22 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+require 'aws-sdk'
+require 'support/aws_init'
+
+require "#{File.dirname(__FILE__)}/../lib/simple_unique"
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

data/spec/support/aws_init.rb.example

@@ -0,0 +1,4 @@
+AWS_SECRET_KEY_ID='abc'
+AWS_SECRET_KEY   ='123'
+AWS.config({:access_key_id => AWS_SECRET_KEY_ID, :secret_access_key => AWS_SECRET_KEY})
+AWS::Record.domain_prefix = "aws-model-validations-test-"

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification
+name: simple_unique
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Jeremy Green
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-01-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: aws-sdk
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+description: Validations for AWS::Record::Model
+email:
+- jeremy@octolabs.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/simple_unique.rb
+- lib/simple_unique/validations.rb
+- lib/simple_unique/validations/uniqueness.rb
+- lib/simple_unique/version.rb
+- simple_unique.gemspec
+- spec/simple_unique/validations_spec.rb
+- spec/spec_helper.rb
+- spec/support/aws_init.rb.example
+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'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Validations for AWS::Record::Model
+test_files:
+- spec/simple_unique/validations_spec.rb
+- spec/spec_helper.rb
+- spec/support/aws_init.rb.example