nested_attributes_uniqueness 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d3ec8e669dac67be4f9161042d74a311a8e7b883
+  data.tar.gz: 4c21d4d03351bf18bdde71f987e5d76e1596035b
+SHA512:
+  metadata.gz: 0511876edbe34f270313b475024b624a94e6e9454cd2905b11788b500f582149ad4c44d3ad032c7ed1ba38bcf4b7c695073e13a1aab5424cd6947776b3fd2496
+  data.tar.gz: 317f3e6b4053c79f478b6d9e00d5cb3b3c508023e01cc3fb9bbf75ff46bd865916917937be8d332ae0a8aa778924afcce3423d81e3652512ba0db1d2b2bd6112

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.2
+before_install: gem install bundler -v 1.10.3

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 
+
+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,61 @@
+NestedAttributesUniqueness
+-------
+
+This gem provides two class methods `validates_uniqueness_in_memory` and `validates_uniqueness_in_memory_for_tree_polymorphism` which allows us to validate the uniqueness of nested attributes in memory.
+
+Installation
+-------
+
+Add this line to your application`s Gemfile:
+
+```shell
+gem 'nested_attributes_uniqueness', '~> 0.1.0'
+```
+
+And then execute:
+
+```shell
+$ bundle
+```
+
+Or install it yourself as:
+
+```shell
+$ gem install nested_attributes_uniqueness
+```
+
+Usage
+-------
+
+For _ActiveRecord:_
+
+```ruby
+  class User < ActiveRecord::Base
+    include NestedAttributesUniqueness
+
+    has_many :posts
+
+    validates_uniqueness_in_memory :posts, :name, { scope: user_id, case_sensitive: false }
+  end
+```
+
+
+Testing
+-------
+
+```shell
+$ bundle
+$ bundle exec rspec spec
+```
+
+Contributing
+-------
+
+```
+1. Fork it ( https://github.com/vinsol/nested_attributes_uniqueness/fork ).
+2. Create your feature branch (`git checkout -b my-new-feature`).
+3. Add test cases and verify all tests are green.
+4. Commit your changes (`git commit -am 'Add some feature'`).
+5. Push to the branch (`git push origin my-new-feature`).
+6. Create new Pull Request.
+```

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "nested_attributes_uniqueness"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/nested_attributes_uniqueness.rb

@@ -0,0 +1,10 @@
+require 'active_support'
+require "nested_attributes_uniqueness/version"
+require "nested_attributes_uniqueness/validator"
+
+
+module NestedAttributesUniqueness
+  if defined?(ActiveRecord)
+    ActiveRecord::Base.include NestedAttributesUniqueness::Validator
+  end
+end

data/lib/nested_attributes_uniqueness/validator.rb

@@ -0,0 +1,212 @@
+# This module provides uniqueness validation for nested_attributes.
+#
+# +USAGE+
+#
+# class User < ActiveRecord::Base
+#   include NestedAttributesUniqueness
+#
+#   has_many :posts
+#
+#   validates_uniqueness_in_memory :posts, :name
+# end
+#
+# class Post < ActiveRecord::Base
+#   belongs_to :user
+# end
+
+# This module also provides uniqueness validation for nested_attributes which are associated with a
+# tree polymorphic association.
+# It assumes that the tree polymorphic table uses container and component as the name of the
+# polymorphic attributes
+#
+# +USAGE+
+#
+# class Form < ActiveRecord::Base
+#   has_many :form_contents, as: :container
+#
+#   # Ensures replies have unique content across post
+#   validates_uniqueness_in_memory_for_polymorphism :form_contents, :sub_form_group, :sub_forms, :name
+# end
+#
+# class FormContent < ActiveRecord::Base
+#   belongs_to :container, polymorphic: true
+#   belongs_to :component, polymorphic: true
+# end
+#
+# class SubFormGroup < ActiveRecord::Base
+#   has_many :form_contents, as: :component
+#   has_many :sub_forms
+# end
+#
+# class SubForm < ActiveRecord::Base
+#   belongs_to :sub_form_group
+#   has_many form_components, as: :container
+# end
+module NestedAttributesUniqueness
+  module Validator
+    extend ::ActiveSupport::Concern
+
+    private
+      # Note - can be updated w.r.t. scoped attributes combination
+      def validate_unique_nested_attributes(parent, collection, attribute, options = {})
+        return true if collection.empty?
+
+        build_default_options(options)
+        validate_unique_attribute_in_collection(parent, attribute, collection, options)
+      end
+
+      # Note - can be updated w.r.t. scoped attributes combination
+      def validate_unique_nested_attributes_for_tree_polymorphism(parent, polymorphic_association_name, type, collection_name, attribute, options = {})
+        types_with_collection = find_types_and_all_collections(parent, polymorphic_association_name, type, collection_name)
+        return true if types_with_collection.blank?
+
+        build_default_options(options)
+
+        # Maintains unique values for complete collection
+        hash = {}
+
+        types_with_collection.each do |component, collection|
+          validate_unique_attribute_in_collection(parent, attribute, collection, options, hash)
+        end
+      end
+
+      def build_default_options(options = {})
+        options[:message] ||= "has already been taken"
+      end
+
+      def validate_unique_attribute_in_collection(parent, attribute, collection, options, hash = {})
+        collection_name = collection.first.class.name.pluralize
+        collection.each do |record|
+          if (!record.marked_for_destruction? && record.errors.get(attribute).blank?)
+            attribute_value = record.send(attribute)
+            attribute_value = attribute_value.downcase if options[:case_sensitive] == false
+            key = [attribute_value]
+            key += Array.wrap(options[:scope]).map { |attribute| record.public_send(attribute) }
+            if hash[key] || existing_record_with_attribute?(record, attribute, collection, options)
+              record.errors.add(attribute, options[:message])
+              add_error_to_base(parent, collection_name)
+            else
+              (hash[key] = record)
+            end
+          end
+        end
+      end
+
+      def existing_record_with_attribute?(record, attribute, collection, options)
+        record_id              = record.id
+        collection_ids         = collection.map(&:id).compact
+        record_attribute_value = record.public_send(attribute)
+
+        if record_attribute_value.is_a? Numeric
+          query = "#{ attribute.to_s } = #{ record_attribute_value }"
+        else
+          query = "#{ attribute.to_s } = '#{ record_attribute_value }'"
+        end
+        if record_id.present? && collection_ids.present?
+          ids_query_string = "(#{ collection_ids.join(',') })"
+          query += " AND id NOT IN #{ ids_query_string }"
+        end
+        existing_records = record.class.where(query)
+        records_exists   = existing_records.present?
+        if options[:scope]
+          scope_value = record.public_send(options[:scope])
+          existing_records = existing_records.where(:"#{ options[:scope] }" => scope_value)
+          records_exists = existing_records.present?
+        end
+        records_exists
+      end
+
+      def add_error_to_base(parent, collection_name)
+        message = "#{ collection_name } not valid"
+        existing_errors = parent.errors
+        existing_errors_on_base = (existing_errors.present? ? existing_errors.messages[:base] : nil)
+        return if existing_errors_on_base.present? && existing_errors_on_base.include?(message)
+
+        parent.errors.add(:base, message)
+      end
+
+      # Returns a hash with component as key and its collection as value.
+      # component can be at any level but in hash, it is at root level
+      def find_types_and_all_collections(parent, polymorphic_association_name, type, collection_name)
+        components = find_desired_components(parent, polymorphic_association_name, type.to_s.camelize.constantize)
+
+        components_with_collection = {}
+
+        components.each do |component|
+          components_with_collection[component] = component.send(collection_name)
+
+          components_with_collection[component].each do |collection_element|
+            components_with_collection.merge!(find_types_and_all_collections(collection_element, polymorphic_association_name, type, collection_name))
+          end
+        end
+        components_with_collection
+      end
+
+      def find_desired_components(parent, polymorphic_association_name, type)
+        components = parent.send(:try, polymorphic_association_name).to_a.map(&:component)
+        components.map do |component|
+          if component.is_a?(type)
+            component
+          else
+            find_desired_components(component, polymorphic_association_name, type)
+          end
+        end.flatten.compact
+      end
+
+    module ClassMethods
+      # This method adds an +after_validation+ callback.
+      #
+      # ==== Parameters
+      #
+      # * +collection_name+ - The association name that should be used for fetching
+      #   collection.
+      # * +attribute+ - The attribute name on the association that should be validated.
+      # * +options+ - It accepts all options that `UniqunessValidator` accepts.
+      #   Default to no options.
+      #
+      # ==== Example
+      #
+      #   # Without options
+      #   class User < ActiveRecord::Base
+      #     include NestedAttributesUniqueness
+      #
+      #     has_many :posts
+      #
+      #     validates_uniqueness_in_memory :posts, :name
+      #   end
+      #
+      #   # With options
+      #   class User < ActiveRecord::Base
+      #     include NestedAttributesUniqueness
+      #
+      #     has_many :posts
+      #
+      #     validates_uniqueness_in_memory :posts, :name, { case_sensitive: false }
+      #   end
+      def validates_uniqueness_in_memory(collection_name, attribute, options = {})
+        after_validation do
+          validate_unique_nested_attributes self, public_send(collection_name), attribute, options
+        end
+      end
+
+      # This method adds an +after_validation+ callback.
+      #
+      # ==== Parameters
+      #
+      # * +polymorphic_association_name+ - Name of the tree polumorphic association
+      #   with container and component as the name of polymorphic attributes
+      # * +type+ - The component type in which to look for collection
+      # * +collection_name+ - The association name that should be used for fetching
+      #   collection.
+      # * +attribute+ - The attribute name on the association that should be validated.
+      # * +options+ - It accepts all options that `UniqunessValidator` accepts.
+      #   Defaults to no options.
+      #   Supports scope and case_sensitive options
+      def validates_uniqueness_in_memory_for_tree_polymorphism(polymorphic_association_name, type, collection_name, attribute, options = {})
+        after_validation do
+          validate_unique_nested_attributes_for_tree_polymorphism self, polymorphic_association_name, type, collection_name, attribute, options
+        end
+      end
+    end
+  end
+end

data/lib/nested_attributes_uniqueness/version.rb

@@ -0,0 +1,3 @@
+module NestedAttributesUniqueness
+  VERSION = "0.1.0"
+end

data/nested_attributes_uniqueness.gemspec

@@ -0,0 +1,37 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'nested_attributes_uniqueness/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "nested_attributes_uniqueness"
+  spec.version       = NestedAttributesUniqueness::VERSION
+  spec.authors       = ["Akshay", "Ankit", "Udit"]
+  spec.email         = ["akshay.vishnoi@vinsol.com", "ankit.bansal@vinsol.com", "udit@vinsol.com"]
+
+  spec.summary       = %q{Checks for uniqueness vaidation in nested attributes for objects in memory .}
+  spec.description   = %q{Checks for uniqueness vaidation in nested attributes for objects in memory .}
+  spec.homepage      = "https://github.com/vinsol/nested_attributes_uniqueness"
+  spec.license       = 'MIT'
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+  else
+    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", ">= 1.5"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.3.0"
+  spec.add_development_dependency "coveralls", "~> 0.8.2"
+  spec.add_development_dependency "activerecord", ">=3.2.0"
+  spec.add_development_dependency "activesupport", ">=3.2.0"
+  spec.add_development_dependency "sqlite3"
+end

metadata

@@ -0,0 +1,164 @@
+--- !ruby/object:Gem::Specification
+name: nested_attributes_uniqueness
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Akshay
+- Ankit
+- Udit
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-09-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !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: 3.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.3.0
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.2
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Checks for uniqueness vaidation in nested attributes for objects in memory
+  .
+email:
+- akshay.vishnoi@vinsol.com
+- ankit.bansal@vinsol.com
+- udit@vinsol.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".DS_Store"
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- gem_development
+- lib/nested_attributes_uniqueness.rb
+- lib/nested_attributes_uniqueness/validator.rb
+- lib/nested_attributes_uniqueness/version.rb
+- nested_attributes_uniqueness.gemspec
+homepage: https://github.com/vinsol/nested_attributes_uniqueness
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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.4.5
+signing_key: 
+specification_version: 4
+summary: Checks for uniqueness vaidation in nested attributes for objects in memory
+  .
+test_files: []