database_validations 0.5.1 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4817334b7a4a7ae57f43e69be04b5969dbb35dcbb39f4bd2ebc52603cf149a15
-  data.tar.gz: b899b604b2f72021269c39372c60acf0fb4a6805e4d3e2b5f606320aa165bb9a
+  metadata.gz: 34f55425dd0da6279bd235d760df174ac1f028365f00d88be653b601207b526d
+  data.tar.gz: 8ef9de8f18ba558c5c1cfb9be9af9f0257cd188df35b05545fc479490f799316
 SHA512:
-  metadata.gz: d2b50fd0375c72c71ce1a443131a3c16f84118153947a373280ee9b28f6d6572abf3576acbf4be0660e3d436f30abce62d0072c2297c47e557dc894c002ceb74
-  data.tar.gz: 53e6a6363cc2d64763e9ba3c6089911dc09950c799ffcdbfd51f7d792e48c04f82cb8fc47435b01fad64567ba7ba625c865788ccaf73e79a3745e734f752fed9
+  metadata.gz: 8ad092489894f94f52ac4ed99b83dedb383bd0643af8f938c8225c3d1f1cf69d625d2b687346492f45980851a93b45489c76043f5c98be836fcc3739d4f4e1aa
+  data.tar.gz: ee668b15d32473eda6b01fc18ab4c9d7336dfd415ee42e33e2e27168f444a3bef7fc4067b6c59793ef5c065cccd5ddca28469439d3c53bb213bc4468e6c42bdb

data/README.md

@@ -125,6 +125,8 @@ The list of options to add support:
 - `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`).
 
+**Note**: For `PosgreSQL`, it is possible to replace these options with combination of other supported options.
+
 ### Benchmark ([code](https://github.com/toptal/database_validations/blob/master/benchmarks/uniqueness_validator_benchmark.rb))
 
 | Case                             | Validator                  | SQLite                                     | PostgreSQL                                 | MySQL                                      |
@@ -136,6 +138,26 @@ The list of options to add support:
 | Each hundredth item is duplicate | validates_db_uniqueness_of | 3.534k (± 5.6%) i/s - 17.748k in 5.039277s | 1.351k  (± 6.5%) i/s - 6.750k in 5.017280s | 1.436k  (±11.6%) i/s - 7.154k in 5.062644s |
 |                                  | validates_uniqueness_of    | 2.121k (± 6.8%) i/s - 10.653k in 5.049739s | 658.199 (± 6.1%) i/s - 3.350k in 5.110176s | 596.024 (± 6.7%) i/s - 2.989k in 5.041497s |
 
+## Testing (RSpec)
+
+Add `require database_validations/rspec/matchers'` to your `spec` file.
+
+### validate_db_uniqueness_of
+
+Example: 
+
+```ruby
+class User < ActiveRecord::Base
+  validates_db_uniqueness_of :field, message: 'duplicate', where: '(some_field IS NULL)', scope: :another_field
+end
+
+describe 'validations' do
+  subject { User }
+  
+  it { is_expected.to validate_db_uniqueness_of(:field).with_message('duplicate').with_where('(some_field IS NULL)').scoped_to(:another_field) }
+end
+```
+
 ## Development
 
 You need to have installed and running `postgresql` and `mysql`. 

data/lib/database_validations.rb

@@ -1,13 +1,15 @@
 require 'active_record'
 
 require 'database_validations/version'
-require 'database_validations/railtie' if defined?(Rails)
-require 'database_validations/uniqueness_validator'
-require 'database_validations/uniqueness_options'
-require 'database_validations/uniqueness_options_storage'
-require 'database_validations/errors'
-require 'database_validations/helpers'
-require 'database_validations/adapters'
+
+require 'database_validations/rails/railtie' if defined?(Rails)
+
+require 'database_validations/validations/uniqueness_validator'
+require 'database_validations/validations/uniqueness_options'
+require 'database_validations/validations/uniqueness_options_storage'
+require 'database_validations/validations/errors'
+require 'database_validations/validations/helpers'
+require 'database_validations/validations/adapters'
 
 module DatabaseValidations
   extend ActiveSupport::Concern

data/lib/database_validations/{railtie.rb → rails/railtie.rb}

@@ -3,7 +3,7 @@ require 'active_record/railtie'
 module DatabaseValidations
   class Railtie < Rails::Railtie
     rake_tasks do
-      load 'tasks/database_validations.rake'
+      load 'database_validations/tasks/database_validations.rake'
 
       Rake.application.in_namespace(:db) do |namespace|
         namespace.tasks.each do |task|

data/lib/database_validations/rspec/matchers.rb

@@ -0,0 +1 @@
+require 'database_validations/rspec/uniqueness_validator_matcher'

data/lib/database_validations/rspec/uniqueness_validator_matcher.rb

@@ -0,0 +1,58 @@
+# @scope Models
+#
+# Matches when model validate database uniqueness of some field.
+#
+# Modifiers:
+# * `with_message(message)` -- specifies a message of the error;
+# * `scoped_to(scope)` -- specifies a scope for the validator;
+# * `with_where(where)` -- specifies a where condition for the validator;
+#
+# Example:
+#
+# ```ruby
+# it { expect(Model).to validate_db_uniqueness_of(:field) }
+# ```
+RSpec::Matchers.define :validate_db_uniqueness_of do |field|
+  chain(:with_message) do |message|
+    @message = message
+  end
+
+  chain(:scoped_to) do |*scope|
+    @scope = scope.flatten
+  end
+
+  chain(:with_where) do |where|
+    @where = where
+  end
+
+  match do |model|
+    @validators = []
+
+    DatabaseValidations::Helpers.each_validator(model) do |validator|
+      @validators << {
+        field:   validator.field,
+        scope:   validator.scope,
+        where:   validator.where_clause,
+        message: validator.message
+      }
+    end
+
+    @validators.include?(field: field, scope: Array.wrap(@scope), where: @where, message: @message)
+  end
+
+  description do
+    desc = "validate database uniqueness of #{field}. "
+    desc += "With options - " if @message || @scope || @where
+    desc += "message: '#{@message}'; " if @message
+    desc += "scope: #{@scope}; " if @scope
+    desc += "where: '#{@where}'. " if @where
+    desc
+  end
+
+  failure_message do
+    <<-TEXT
+      There is no such database uniqueness validator. 
+      Available validators are: #{@validators}.
+    TEXT
+  end
+end

data/lib/database_validations/tasks/database_validations.rake

@@ -0,0 +1,9 @@
+module DatabaseValidations
+  module Tasks
+    namespace :database_validations do
+      task :skip_db_uniqueness_validator_index_check do
+        ENV['SKIP_DB_UNIQUENESS_VALIDATOR_INDEX_CHECK'] = 'true'
+      end
+    end
+  end
+end

data/lib/database_validations/{adapters.rb → validations/adapters.rb}

@@ -1,7 +1,7 @@
-require 'database_validations/adapters/base_adapter'
-require 'database_validations/adapters/sqlite_adapter'
-require 'database_validations/adapters/postgresql_adapter'
-require 'database_validations/adapters/mysql_adapter'
+require 'database_validations/validations/adapters/base_adapter'
+require 'database_validations/validations/adapters/sqlite_adapter'
+require 'database_validations/validations/adapters/postgresql_adapter'
+require 'database_validations/validations/adapters/mysql_adapter'
 
 module DatabaseValidations
   module Adapters

data/lib/database_validations/{helpers.rb → validations/helpers.rb}

@@ -27,7 +27,7 @@ module DatabaseValidations
     end
 
     def unify_columns(*columns)
-      columns.flatten.map(&:to_s).sort
+      columns.flatten.compact.map(&:to_s).sort
     end
 
     def generate_key(*columns)

data/lib/database_validations/{uniqueness_options.rb → validations/uniqueness_options.rb}

@@ -1,5 +1,7 @@
 module DatabaseValidations
   class UniquenessOptions
+    attr_reader :field
+
     def initialize(field, options, adapter)
       @field = field
       @options = options
@@ -34,16 +36,24 @@ module DatabaseValidations
     end
 
     def columns
-      @columns ||= Helpers.unify_columns(field, Array.wrap(options[:scope]))
+      @columns ||= Helpers.unify_columns(field, scope)
     end
 
     def where_clause
       @where_clause ||= options[:where]
     end
 
+    def message
+      @message ||= options[:message]
+    end
+
+    def scope
+      @scope ||= Array.wrap(options[:scope])
+    end
+
     private
 
-    attr_reader :adapter, :field, :options
+    attr_reader :adapter, :options
 
     def condition_passes?(condition, instance)
       if condition.is_a?(Symbol)

data/lib/database_validations/version.rb

@@ -1,3 +1,3 @@
 module DatabaseValidations
-  VERSION = "0.5.1"
+  VERSION = '0.6.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: database_validations
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.6.0
 platform: ruby
 authors:
 - Evgeniy Demin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-09-25 00:00:00.000000000 Z
+date: 2018-09-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -128,6 +128,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: climate_control
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
 description: |-
   ActiveRecord provides validations on app level but it won't guarantee the
   consistent. In some cases, like `validates_uniqueness_of` it executes
@@ -144,19 +158,21 @@ files:
 - LICENSE.txt
 - README.md
 - lib/database_validations.rb
-- lib/database_validations/adapters.rb
-- lib/database_validations/adapters/base_adapter.rb
-- lib/database_validations/adapters/mysql_adapter.rb
-- lib/database_validations/adapters/postgresql_adapter.rb
-- lib/database_validations/adapters/sqlite_adapter.rb
-- lib/database_validations/errors.rb
-- lib/database_validations/helpers.rb
-- lib/database_validations/railtie.rb
-- lib/database_validations/uniqueness_options.rb
-- lib/database_validations/uniqueness_options_storage.rb
-- lib/database_validations/uniqueness_validator.rb
+- lib/database_validations/rails/railtie.rb
+- lib/database_validations/rspec/matchers.rb
+- lib/database_validations/rspec/uniqueness_validator_matcher.rb
+- lib/database_validations/tasks/database_validations.rake
+- lib/database_validations/validations/adapters.rb
+- lib/database_validations/validations/adapters/base_adapter.rb
+- lib/database_validations/validations/adapters/mysql_adapter.rb
+- lib/database_validations/validations/adapters/postgresql_adapter.rb
+- lib/database_validations/validations/adapters/sqlite_adapter.rb
+- lib/database_validations/validations/errors.rb
+- lib/database_validations/validations/helpers.rb
+- lib/database_validations/validations/uniqueness_options.rb
+- lib/database_validations/validations/uniqueness_options_storage.rb
+- lib/database_validations/validations/uniqueness_validator.rb
 - lib/database_validations/version.rb
-- lib/tasks/database_validations.rake
 homepage: https://github.com/toptal/database_validations
 licenses:
 - MIT

data/lib/tasks/database_validations.rake

@@ -1,5 +0,0 @@
-namespace :database_validations do
-  task :skip_db_uniqueness_validator_index_check do
-    ENV['SKIP_DB_UNIQUENESS_VALIDATOR_INDEX_CHECK'] = 'true'
-  end
-end