database_validations 0.3.7 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: aefb40cecf33b68606f21a491cd41ffa3e1bc4ffcf891b837b9b8693e04f2239
-  data.tar.gz: ec3c2ab6955ec4f5da93804bcb6f2382d577331553b9d710af75a62cf9e8ccea
+  metadata.gz: 0a94ceacef368255d4e55eaf4ac852a839b78238ca47a0d3bceac249e4a1ded3
+  data.tar.gz: a38b1061a9c345543aa353c5048b2472026c4cb806991c64c5e2b23e48ac6fd7
 SHA512:
-  metadata.gz: 1c341fa892d214a3fce105e683c90b5633c7c8ccc5917c675762e710cde2443e332bf66768831b772436c6eb6bfd823136411f409e0c16ef58cb85347f8b87c8
-  data.tar.gz: c6a838adc69c1558acede0e38df24d30bac20d7c348951c8059966daf59e649ae7887879810e68f88df88d69b277451a7fe476bca8a237842c970103184c073b
+  metadata.gz: 3f1543f0a6b04ce50064e74bc56fa059153f7660774932008c5ef50699bb02c31b88f9cee8fa01ef519128932caefe770364536867a5c108ec42fee3e6a31984
+  data.tar.gz: b0d74dc13be3a54b9bc95c20f5ce24673e5a586392f3d63d3e5f4ad171fadf49bf3b202e4e3e12480af5bf3eba4ed935c9a4cb75a2638248e09c1ae835a634a2

data/README.md

@@ -77,7 +77,7 @@ User.create!(email: 'email@mail.com')
 
 We want to provide full compatibility with existing `validates_uniqueness_of` validator. 
 
-This list of supported options from `validates_uniqueness_of` validator: 
+List of supported options from `validates_uniqueness_of` validator: 
 
 - `scope`: One or more columns by which to limit the scope of the uniqueness constraint.
 - `message`: Specifies a custom error message (default is: "has already been taken").
@@ -88,16 +88,21 @@ This list of supported options from `validates_uniqueness_of` validator:
 validates_db_uniqueness_of :email
 ```
 
-Is the same by default as following 
+Is the same by default as the following 
 
 ```ruby
 validates_uniqueness_of :email, allow_nil: true, allow_blank: false, case_sensitive: true
 ``` 
 
+List of supported options for `PostgreSQL` only:
+
+- `where`: Specify the conditions to be included as a <tt>WHERE</tt> SQL fragment to 
+limit the uniqueness constraint lookup (e.g. <tt>where: "(status = 'active')"</tt>).
+For backward compatibility, this will be converted automatically 
+to <tt>conditions: -> { where("(status = 'active')") }</tt> for `valid?` method.
+
 The list of options to add support:
 
-- `conditions`: 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>).
 - `case_sensitive`: Looks for an exact match. Ignored by non-text columns (`true` by default).
 - `allow_nil`: If set to `true`, skips this validation if the attribute is `nil` (default is `false`).
 - `allow_blank`: If set to `true`, skips this validation if the attribute is blank (default is `false`).

data/lib/database_validations/adapters/base_adapter.rb

@@ -12,8 +12,8 @@ module DatabaseValidations
         indexes.find { |index| index.name == index_name }
       end
 
-      def find_index_by_columns(index_columns)
-        indexes.find { |index| index.columns.map(&:to_s).sort == index_columns }
+      def find_index(columns, where)
+        indexes.find { |index| index.columns.map(&:to_s).sort == columns && index.where == where }
       end
 
       def indexes

data/lib/database_validations/adapters/postgresql_adapter.rb

@@ -1,7 +1,7 @@
 module DatabaseValidations
   module Adapters
     class PostgresqlAdapter < BaseAdapter
-      SUPPORTED_OPTIONS = %i[scope message].freeze
+      SUPPORTED_OPTIONS = %i[scope message where].freeze
       ADAPTER = :postgresql
 
       def error_columns(error_message)

data/lib/database_validations/errors.rb

@@ -3,14 +3,22 @@ module DatabaseValidations
     class Base < StandardError; end
 
     class IndexNotFound < Base
-      attr_reader :columns
+      attr_reader :columns, :where_clause, :available_indexes
 
-      def initialize(columns)
+      def initialize(columns, where_clause, available_indexes)
         @columns = columns.map(&:to_s)
-        super "No unique index found with columns: #{self.columns}. "\
+        @where_clause = where_clause
+        @available_indexes = available_indexes
+
+        super "No unique index found with #{columns_and_where_text(columns, where_clause)}. "\
+              "Available indexes are: [#{self.available_indexes.map { |ind| columns_and_where_text(ind.columns, ind.where) }.join(', ')}]. "\
               "Use ENV['SKIP_DB_UNIQUENESS_VALIDATOR_INDEX_CHECK']=true in case you want to skip the check. "\
               "For example, when you run migrations."
       end
+
+      def columns_and_where_text(columns, where)
+        "columns: #{columns}#{" and where: #{where}" if where}"
+      end
     end
 
     class UnknownDatabase < Base

data/lib/database_validations/helpers.rb

@@ -6,7 +6,6 @@ module DatabaseValidations
       key = generate_key(Adapters.factory(instance.class).error_columns(error.message))
 
       each_options_storage(instance.class) do |storage|
-        # storage has this then return
         return storage[key].handle_unique_error(instance) if storage[key]
       end
 

data/lib/database_validations/uniqueness_options.rb

@@ -10,14 +10,18 @@ module DatabaseValidations
     end
 
     def handle_unique_error(instance)
-      error_options = options.except(:case_sensitive, :scope, :conditions, :attributes)
+      error_options = options.except(:case_sensitive, :scope, :conditions, :attributes, :where)
       error_options[:value] = instance.public_send(options[:attributes])
 
       instance.errors.add(options[:attributes], :taken, error_options)
     end
 
     def validates_uniqueness_options
-      options.merge(allow_nil: true, case_sensitive: true, allow_blank: false)
+      where_clause_str = where_clause
+
+      options.except(:where)
+        .merge(allow_nil: true, case_sensitive: true, allow_blank: false)
+        .tap { |opts| opts[:conditions] = -> { where(where_clause_str) } if where_clause }
     end
 
     def key
@@ -28,6 +32,10 @@ module DatabaseValidations
       @columns ||= Helpers.unify_columns(field, Array.wrap(options[:scope]))
     end
 
+    def where_clause
+      @where_clause ||= options[:where]
+    end
+
     def raise_if_unsupported_options!
       options.except(:attributes).each_key do |option|
         unless adapter.support_option?(option)
@@ -37,7 +45,7 @@ module DatabaseValidations
     end
 
     def raise_if_index_missed!
-      raise Errors::IndexNotFound.new(columns) unless adapter.find_index_by_columns(columns)
+      raise Errors::IndexNotFound.new(columns, where_clause, adapter.indexes) unless adapter.find_index(columns, where_clause)
     end
 
     private

data/lib/database_validations/version.rb

@@ -1,3 +1,3 @@
 module DatabaseValidations
-  VERSION = "0.3.7"
+  VERSION = "0.4.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: database_validations
 version: !ruby/object:Gem::Version
-  version: 0.3.7
+  version: 0.4.0
 platform: ruby
 authors:
 - Evgeniy Demin