activeentity 0.0.1.beta9 → 0.0.1.beta10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 235dcb06f9c87deacf1304613128ad4deda0f285f3de546c19190b30c481e854
-  data.tar.gz: 651d6ef3448daf0d44efa992c6be53083a52d721bcc1ad4970b509479eb7e483
+  metadata.gz: 3c77d6daeebeba0865b5de31611679a61db4f94f3c5a89d70e33e52f1bcfcf92
+  data.tar.gz: 01c96c7a6e7580563fd4ddfa81e8864b2fb1fc0550d853fd92de3eb9baf4eb13
 SHA512:
-  metadata.gz: fe5eebc2fc256e1d9af297d3fd4dacdcfea331ce18d0d04f4a1f36d6637943a6dad76442047729e8e243920d0fd30b92a4218a6194333bdd729549ba3e5a3b95
-  data.tar.gz: 5eab0510837841a772317d375e2fe7367dce1d00dbfa8ef4dd37e09365af7dbe6f3f56406e0d1d0566356e03731f2d5e33861160f699582cdd7a70b5ff2edd87
+  metadata.gz: 6fe7aac59d6298f3b952064b78d83f4f566c9dd646e86617af567f3f6c78d0702544e5106f9c54ff8013a07d59f33b6992a703b142ee40e319eaf457ccc0ca30
+  data.tar.gz: 5586c053be18d9e9aeef3c91f8362974c98d1819173169f999c2988dca50dbc12c43b44420015594f1e7a4d1639da8e429a037ac47235b9a7c4eefc35f218c47

data/lib/active_entity/gem_version.rb

@@ -10,7 +10,7 @@ module ActiveEntity
     MAJOR = 0
     MINOR = 0
     TINY  = 1
-    PRE   = "beta9"
+    PRE   = "beta10"
 
     STRING = [MAJOR, MINOR, TINY, PRE].compact.join(".")
   end

data/lib/active_entity/validations.rb

@@ -48,3 +48,4 @@ require "active_entity/validations/absence"
 require "active_entity/validations/length"
 require "active_entity/validations/subset"
 require "active_entity/validations/uniqueness_in_embedding"
+require "active_entity/validations/uniqueness_on_active_record"

data/lib/active_entity/validations/uniqueness_on_active_record.rb

@@ -0,0 +1,239 @@
+# frozen_string_literal: true
+
+module ActiveEntity
+  module Validations
+    class UniquenessOnActiveRecordValidator < ActiveModel::EachValidator # :nodoc:
+      def initialize(options)
+        if options[:conditions] && !options[:conditions].respond_to?(:call)
+          raise ArgumentError, "#{options[:conditions]} was passed as :conditions but is not callable. " \
+                               "Pass a callable instead: `conditions: -> { where(approved: true) }`"
+        end
+        unless Array(options[:scope]).all? { |scope| scope.respond_to?(:to_sym) }
+          raise ArgumentError, "#{options[:scope]} is not supported format for :scope option. " \
+            "Pass a symbol or an array of symbols instead: `scope: :user_id`"
+        end
+
+        super
+
+        @finder_class =
+          if options[:ar_class_name].present?
+            options[:ar_class_name].safe_constantize
+          elsif options[:ar_class].present? && options[:ar_class].is_a?(Class)
+            options[:ar_class]
+          else
+            nil
+          end
+
+        unless @finder_class
+          raise ArgumentError, "Must provide one of option :class_name or :class."
+        end
+        unless @finder_class < ActiveRecord::Base
+          raise ArgumentError, "Class must be an Active Record model, but got #{@finder_class}."
+        end
+        if @finder_class.abstract_class?
+          raise ArgumentError, "Class can't be an abstract class."
+        end
+
+        @primary_key_attribute_name = options[:primary_key_attribute_name]
+        @present_only = options[:present_only]
+      end
+
+      def validate_each(record, attribute, value)
+        value = map_enum_attribute(@finder_class, attribute, value)
+        if @present_only && value.blank?
+          return
+        end
+
+        relation = build_relation(@finder_class, attribute, value)
+        if @primary_key_attribute_name.present?
+          primary_key_attribute = record.read_attribute(@primary_key_attribute_name)
+          if primary_key_attribute.present?
+            if @finder_class.primary_key
+              relation = relation.where.not(@finder_class.primary_key => primary_key_attribute)
+            else
+              raise ActiveRecord::UnknownPrimaryKey.new(@finder_class, "Can not validate uniqueness for persisted record without primary key.")
+            end
+          end
+        end
+        relation = scope_relation(record, relation)
+        relation = relation.merge(options[:conditions]) if options[:conditions]
+
+        if relation.exists?
+          error_options = options.except(:case_sensitive, :scope, :conditions, :ar_class, :ar_class_name, :primary_key_attribute_name)
+          error_options[:value] = value
+
+          record.errors.add(attribute, :taken, error_options)
+        end
+      end
+
+    private
+
+      def build_relation(klass, attribute, value)
+        relation = klass.unscoped
+        comparison = relation.bind_attribute(attribute, value) do |attr, bind|
+          return relation.none! if bind.unboundable?
+
+          if !options.key?(:case_sensitive) || bind.nil?
+            klass.connection.default_uniqueness_comparison(attr, bind, klass)
+          elsif options[:case_sensitive]
+            klass.connection.case_sensitive_comparison(attr, bind)
+          else
+            # will use SQL LOWER function before comparison, unless it detects a case insensitive collation
+            klass.connection.case_insensitive_comparison(attr, bind)
+          end
+        end
+
+        relation.where!(comparison)
+      end
+
+      def scope_relation(record, relation)
+        Array(options[:scope]).each do |scope_item|
+          scope_value = if record.class._reflect_on_association(scope_item)
+            record.association(scope_item).reader
+          else
+            record._read_attribute(scope_item)
+          end
+          relation = relation.where(scope_item => scope_value)
+        end
+
+        relation
+      end
+
+      def map_enum_attribute(klass, attribute, value)
+        mapping = klass.defined_enums[attribute.to_s]
+        value = mapping[value] if value && mapping
+        value
+      end
+    end
+
+    module ClassMethods
+      # Validates whether the value of the specified attributes are unique
+      # across the system. Useful for making sure that only one user
+      # can be named "davidhh".
+      #
+      #   class Person < ActiveRecord::Base
+      #     validates_uniqueness_of :user_name
+      #   end
+      #
+      # It can also validate whether the value of the specified attributes are
+      # unique based on a <tt>:scope</tt> parameter:
+      #
+      #   class Person < ActiveRecord::Base
+      #     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 < ActiveRecord::Base
+      #     validates_uniqueness_of :teacher_id, scope: [:semester_id, :class_id]
+      #   end
+      #
+      # It is also possible to limit the uniqueness constraint to a set of
+      # records matching certain conditions. In this example archived articles
+      # are not being taken into consideration when validating uniqueness
+      # of the title attribute:
+      #
+      #   class Article < ActiveRecord::Base
+      #     validates_uniqueness_of :title, conditions: -> { where.not(status: 'archived') }
+      #   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>:conditions</tt> - Specify the conditions to be included as a
+      #   <tt>WHERE</tt> SQL fragment to limit the uniqueness constraint lookup
+      #   (e.g. <tt>conditions: -> { where(status: 'active') }</tt>).
+      # * <tt>:case_sensitive</tt> - Looks for an exact match. Ignored by
+      #   non-text columns (+true+ by default).
+      # * <tt>:allow_nil</tt> - If set to +true+, skips this validation if the
+      #   attribute is +nil+ (default is +false+).
+      # * <tt>:allow_blank</tt> - If set to +true+, skips this validation if the
+      #   attribute is blank (default is +false+).
+      # * <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
+      # {ActiveRecord::Base#save}[rdoc-ref:Persistence#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 their title is unique.
+      #                                      | SELECT * FROM comments
+      #                                      | WHERE title = 'My Post'
+      #                                      |
+      #  # User 1 inserts their 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!
+      #
+      # The best way to work around this problem is to add a unique index to the database table using
+      # {connection.add_index}[rdoc-ref:ConnectionAdapters::SchemaStatements#add_index].
+      # In the rare case that a race condition occurs, the database will guarantee
+      # the field's uniqueness.
+      #
+      # When the database catches such a duplicate insertion,
+      # {ActiveRecord::Base#save}[rdoc-ref:Persistence#save] will raise an ActiveRecord::StatementInvalid
+      # exception. You can either choose to let this error propagate (which
+      # will result in the default Rails exception page being shown), or you
+      # can catch it and restart the transaction (e.g. by telling the user
+      # that the title already exists, and asking them to re-enter the title).
+      # This technique is also known as
+      # {optimistic concurrency control}[https://en.wikipedia.org/wiki/Optimistic_concurrency_control].
+      #
+      # The bundled ActiveRecord::ConnectionAdapters distinguish unique index
+      # constraint errors from other types of database errors by throwing an
+      # ActiveRecord::RecordNotUnique exception. For other adapters you will
+      # have to parse the (database-specific) exception message to detect such
+      # a case.
+      #
+      # The following bundled adapters throw the ActiveRecord::RecordNotUnique exception:
+      #
+      # * ActiveRecord::ConnectionAdapters::Mysql2Adapter.
+      # * ActiveRecord::ConnectionAdapters::SQLite3Adapter.
+      # * ActiveRecord::ConnectionAdapters::PostgreSQLAdapter.
+      def validates_uniqueness_on_active_record_of(*attr_names)
+        validates_with UniquenessOnActiveRecordValidator, _merge_attributes(attr_names)
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: activeentity
 version: !ruby/object:Gem::Version
-  version: 0.0.1.beta9
+  version: 0.0.1.beta10
 platform: ruby
 authors:
 - jasl
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-05-20 00:00:00.000000000 Z
+date: 2019-05-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -130,6 +130,7 @@ files:
 - lib/active_entity/validations/presence.rb
 - lib/active_entity/validations/subset.rb
 - lib/active_entity/validations/uniqueness_in_embedding.rb
+- lib/active_entity/validations/uniqueness_on_active_record.rb
 - lib/active_entity/version.rb
 - lib/core_ext/array_without_blank.rb
 - lib/tasks/active_entity_tasks.rake