ancestry_uniqueness 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0a3f1f849df54eb960d1d4da01069b45f241f4ce
+  data.tar.gz: 0e4894046ab5b51c882d7c8cb1efcb6c3a632632
+SHA512:
+  metadata.gz: 97205f2e2cdbc80699af274a3f550b71d0c5deb96c28b950c65b1349ba23e9bd71690077fa898c1db4644c46cf8db587f75bbf065c838a24f61ce6224d559455
+  data.tar.gz: c7119403f2b09d188b86e4822d977d0b1e96d97e6612bc8464b6c0bf638f6a04027bcff93a6faa2447832cbfce7b8b58549d467d9db08dbcdbafa9b0c749b7af

data/.gitignore

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

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 flauwekeul
+
+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,38 @@
+# Ancestry uniqueness
+
+Provides an activerecord uniqueness validator for objects that are ordered in a tree using the [ancestry](https://github.com/stefankroes/ancestry) gem.
+
+The gem is just a custom validator as described in the [Rails guides](http://edgeguides.rubyonrails.org/active_record_validations.html#custom-validators).
+
+## Usage
+After adding the gem to your project simply add `ancestry_uniqueness: true` as a parameter to the `validates` class method. E.g.:
+
+```ruby
+class Page < ActiveRecord::Base
+  has_ancestry
+
+  validates :slug, ancestry_uniqueness: true
+end
+```
+
+This makes sure the object doesn't pass validation when the attribute (`slug` in this case) isn't unique among the object's siblings (i.e. within the same parent).
+
+### With scope
+
+If you want to scope your attribute pass a hash to `ancestry_uniqueness` like so:
+
+```ruby
+class Page < ActiveRecord::Base
+  has_ancestry
+
+  validates :slug, ancestry_uniqueness: {scope: :some_attribute}
+end
+```
+
+## Compatibility
+The gem depends on [ancestry](https://github.com/stefankroes/ancestry) 2 or greater. It should work in Rails 3 and Rails 4 apps.
+
+Currently it's only tested in a Rails 4.0.1 app.
+
+## Credits
+I really should mention [groe](https://github.com/groe) as I based this gem heavily on his [code snippet](https://github.com/stefankroes/ancestry/issues/72#issuecomment-18242566).

data/Rakefile

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

data/ancestry_uniqueness.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ancestry_uniqueness/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "ancestry_uniqueness"
+  spec.version       = Ancestry::Uniqueness::VERSION
+  spec.authors       = ["Abbe Keultjes"]
+  spec.email         = ["abbe.keultjes@gmail.com"]
+  spec.description   = %q{Uniqueness validator when using the ancestry gem.}
+  spec.summary       = %q{Provides an activerecord uniqueness validator for objects that are ordered in a tree using the ancestry gem.}
+  spec.homepage      = "https://github.com/flauwekeul/ancestry_uniqueness"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 2.0"
+  spec.add_development_dependency "sqlite3", "~> 1.3"
+
+  spec.add_dependency "ancestry", "~> 2.0"
+end

data/lib/ancestry_uniqueness/version.rb

@@ -0,0 +1,5 @@
+module Ancestry
+  module Uniqueness
+    VERSION = "0.0.1"
+  end
+end

data/lib/ancestry_uniqueness.rb

@@ -0,0 +1,18 @@
+require "ancestry_uniqueness/version"
+
+class AncestryUniquenessValidator < ActiveRecord::Validations::UniquenessValidator
+
+  def validate_each(record, attribute, value)
+    exclude_self = record.try(:id) ? ['id <> ?', record.id] : []
+    scope_opts = [*options[:scope]]
+
+    scope = scope_opts.inject({}) do |s, attr|
+      s.merge({attr.to_sym => record.send(attr)})
+    end
+
+    if record.siblings.where(exclude_self).where(scope.merge({attribute.to_sym => record.send(attribute)})).any?
+      record.errors.add(attribute, options[:message] || :taken)
+    end
+  end
+
+end

data/spec/lib/ancestry_uniqueness_spec.rb

@@ -0,0 +1,116 @@
+require "spec_helper"
+
+describe AncestryUniquenessValidator do
+  
+  # set default value if undefined
+  let(:scope_attr) { defined?(super) ? super() : nil }
+
+  shared_examples_for "a valid validatable" do
+    it "is valid" do
+      subject.provider = provider
+      subject.scope_attr = scope_attr
+      expect(subject).to be_valid
+    end
+  end
+
+  shared_examples_for "an invalid validatable" do
+    it "is invalid" do
+      subject.provider = provider
+      subject.scope_attr = scope_attr
+      expect(subject).not_to be_valid
+    end
+  end
+
+  # If this ever needs to be DRYed up: https://www.envygeeks.com/blog/mocking-activerecord-to-test-concerns
+  before :all do
+    migration = ActiveRecord::Migration.new
+    migration.verbose = false
+    
+    migration.create_table :validatables do |t|
+      t.string :ancestry
+      t.string :provider
+      t.string :scope_attr
+    end
+  end
+
+  after :all do
+    migration = ActiveRecord::Migration.new
+    migration.verbose = false
+
+    migration.drop_table :validatables
+  end
+
+  context "without scope" do
+    class Validatable < ActiveRecord::Base
+      has_ancestry
+      validates_with AncestryUniquenessValidator, attributes: :provider
+    end
+
+    let(:a_record) { Validatable.create!(provider: 'provider', parent: nil) }
+
+    context "when record has no siblings" do
+      subject { Validatable.new(parent: a_record) }
+      let(:provider) { a_record.provider }
+      it_behaves_like "a valid validatable"
+    end
+
+    context "when record has a sibling" do
+      subject { Validatable.new(parent: a_record.parent) }
+
+      context "with unique provider among siblings" do
+        let(:provider) { 'different provider' }
+        it_behaves_like "a valid validatable"
+      end
+
+      context "with existing provider among siblings" do
+        let(:provider) { a_record.provider }
+        it_behaves_like "an invalid validatable"
+      end
+    end
+  end
+
+  context "with scope" do
+    class Validatable < ActiveRecord::Base
+      has_ancestry
+      validates_with AncestryUniquenessValidator, attributes: :provider, scope: :scope_attr
+    end
+
+    let(:a_record) { Validatable.create!(provider: 'provider', parent: nil, scope_attr: 'some scope') }
+
+    context "when record has no siblings" do
+      subject { Validatable.new(parent: a_record, scope_attr: a_record.scope_attr) }
+      let(:provider)    { a_record.provider }
+      let(:scope_attr)  { a_record.scope_attr }
+      it_behaves_like "a valid validatable"
+    end
+
+    context "when record has a sibling" do
+      subject { Validatable.new(parent: a_record.parent) }
+
+      context "with unique provider among siblings and scope" do
+        let(:provider)    { 'different provider' }
+        let(:scope_attr)  { 'different scope' }
+        it_behaves_like "a valid validatable"
+      end
+
+      context "with existing provider among siblings and unique provider among scope" do
+        let(:provider)    { a_record.provider }
+        let(:scope_attr)  { 'different scope' }
+        it_behaves_like "an invalid validatable"
+      end
+
+      context "with unique provider among siblings and existing provider among scope" do
+        let(:provider)    { 'different provider' }
+        let(:scope_attr)  { a_record.scope_attr }
+        it_behaves_like "a valid validatable"
+      end
+
+      context "with existing provider among siblings and scope" do
+        let(:provider)    { a_record.provider }
+        let(:scope_attr)  { a_record.scope_attr }
+        it_behaves_like "an invalid validatable"
+      end
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,18 @@
+require 'active_record'
+require 'ancestry'
+require 'ancestry_uniqueness'
+
+ActiveRecord::Base.establish_connection(
+  adapter: 'sqlite3',
+  database: ':memory:')
+
+RSpec.configure do |config|
+  config.order = 'random'
+
+  config.around do |example|
+    ActiveRecord::Base.transaction do
+      example.run
+      raise ActiveRecord::Rollback
+    end
+  end
+end

metadata

@@ -0,0 +1,127 @@
+--- !ruby/object:Gem::Specification
+name: ancestry_uniqueness
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Abbe Keultjes
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-01-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: ancestry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: Uniqueness validator when using the ancestry gem.
+email:
+- abbe.keultjes@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- ancestry_uniqueness.gemspec
+- lib/ancestry_uniqueness.rb
+- lib/ancestry_uniqueness/version.rb
+- spec/lib/ancestry_uniqueness_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/flauwekeul/ancestry_uniqueness
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.1
+signing_key: 
+specification_version: 4
+summary: Provides an activerecord uniqueness validator for objects that are ordered
+  in a tree using the ancestry gem.
+test_files:
+- spec/lib/ancestry_uniqueness_spec.rb
+- spec/spec_helper.rb