database_validations 0.8.0 → 0.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 047eabab521a0b04f0385213e7b20a34cb192576935d3e9c2f70aeab28df6ca0
-  data.tar.gz: 61fe8cac30624557d22ff059b2738ccdddbf0bbaa99eb9ac67a74f943fe39abf
+  metadata.gz: d49b81e66a19302fc586225b0b9b53d307daacc5da01b876bdb882c2b2be3c8e
+  data.tar.gz: 52aac6177166296c0500d2a60b9e7fba9c5ed5215a31db57feec17d6fe7b0937
 SHA512:
-  metadata.gz: c99d04c4d975a9f50781422c409fa2e08fe3cc0fbc2ec8bdc015ab766b8c7e45ed646de43cf30c3c23512cc01877462cd16896034b03e390c3fb7309242c0fc0
-  data.tar.gz: '098fa9d49805b3379fa0fa5b95d3c93771be64b709c7cda5c42aecdf2fa33945bf59d3076a7035f548d1dd0de362d9684053330db5118635a1fef60bc1124f57'
+  metadata.gz: 1776e46980f98dc20f4a68da11f0a24a540b41d63721425fc8c3d31a9985f86a98143862b822925ec3695a03ccd8de027b6e4b7ea0261732a74d8deba10bc096
+  data.tar.gz: c7e121bb64826de63415dbbb5a385d3f85c2862dd20f5ed2678bfa7b02e63442c277faa68d1f3bc6d3babe2ad88b0626391748478647ea13bda47735a8034f5e

data/lib/database_validations.rb

@@ -20,6 +20,4 @@ module DatabaseValidations
   extend ActiveSupport::Concern
 end
 
-if defined?(ActiveRecord::Base)
-  ActiveRecord::Base.include(DatabaseValidations)
-end
+ActiveRecord::Base.include(DatabaseValidations) if defined?(ActiveRecord::Base)

data/lib/database_validations/rspec/uniqueness_validator_matcher.rb

@@ -17,10 +17,10 @@
 #
 # is the same as
 #
-#```ruby
+# ```ruby
 # it { expect(Model.new).to validate_db_uniqueness_of(:field) }
 # ```
-RSpec::Matchers.define :validate_db_uniqueness_of do |field|
+RSpec::Matchers.define :validate_db_uniqueness_of do |field| # rubocop:disable Metrics/BlockLength
   chain(:with_message) do |message|
     @message = message
   end
@@ -48,11 +48,11 @@ RSpec::Matchers.define :validate_db_uniqueness_of do |field|
 
     DatabaseValidations::Helpers.each_uniqueness_validator(model) do |validator|
       @validators << {
-        field:          validator.field,
-        scope:          validator.scope,
-        where:          validator.where_clause,
-        message:        validator.message,
-        index_name:     validator.index_name,
+        field: validator.field,
+        scope: validator.scope,
+        where: validator.where_clause,
+        message: validator.message,
+        index_name: validator.index_name,
         case_sensitive: validator.case_sensitive
       }
     end
@@ -69,18 +69,18 @@ RSpec::Matchers.define :validate_db_uniqueness_of do |field|
 
   description do
     desc = "validate database uniqueness of #{field}. "
-    desc += "With options - " if @message || @scope || @where
+    desc += 'With options - ' if @message || @scope || @where
     desc += "message: '#{@message}'; " if @message
     desc += "scope: #{@scope}; " if @scope
     desc += "where: '#{@where}'; " if @where
     desc += "index_name: '#{@index_name}'; " if @index_name
-    desc += "be case insensitive." if @case_sensitive === false
+    desc += 'be case insensitive.' unless @case_sensitive
     desc
   end
 
   failure_message do
     <<-TEXT
-      There is no such database uniqueness validator. 
+      There is no such database uniqueness validator.
       Available validators are: #{@validators}.
     TEXT
   end

data/lib/database_validations/rubocop/cop/belongs_to.rb

@@ -0,0 +1,46 @@
+module RuboCop
+  module Cop
+    module DatabaseValidations
+      # Use `db_belongs`_to instead of `belongs_to`.
+      #
+      # @example
+      #   # bad
+      #   belongs_to :company
+      #
+      #   # good
+      #   db_belongs_to :company
+      #
+      class BelongsTo < Cop
+        MSG = 'Use `db_belongs_to`.'.freeze
+
+        NON_SUPPORTED_OPTIONS = %i[
+          optional
+          required
+          polymorphic
+          foreign_type
+        ].freeze
+
+        def_node_matcher :belongs_to?, '(send nil? :belongs_to ...)'
+        def_node_matcher :option_name, '(pair (sym $_) ...)'
+
+        def on_send(node)
+          return unless belongs_to?(node)
+          return unless supported?(node)
+
+          add_offense(node, location: :selector)
+        end
+
+        private
+
+        def supported?(node)
+          options = node.arguments.last
+          return true unless options.hash_type?
+
+          options.each_child_node.none? do |option|
+            NON_SUPPORTED_OPTIONS.include? option_name(option)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/database_validations/rubocop/cop/uniqueness_of.rb

@@ -0,0 +1,41 @@
+module RuboCop
+  module Cop
+    module DatabaseValidations
+      # Use `validates_db_uniqueness_of` for uniqueness validation.
+      #
+      # @example
+      #   # bad
+      #   validates :slug, uniqueness: true
+      #   validates :address, uniqueness: { scope: :user_id }
+      #
+      #   # good
+      #   validates_db_uniqueness_of :slug
+      #   validates_db_uniqueness_of :address, scope: :user_id
+      #
+      class UniquenessOf < Cop
+        MSG = 'Use `validates_db_uniqueness_of`.'.freeze
+
+        def_node_matcher :uniquness_validation?, '(pair (sym :uniqueness) $_)'
+
+        def on_send(node)
+          return unless node.method_name == :validates
+
+          uniqueness(node) do |option|
+            add_offense(option)
+          end
+        end
+
+        private
+
+        def uniqueness(node)
+          options = node.arguments.last
+          return unless options.hash_type?
+
+          options.each_child_node do |child|
+            yield child if uniquness_validation?(child)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/database_validations/rubocop/cops.rb

@@ -0,0 +1,2 @@
+require 'database_validations/rubocop/cop/belongs_to'
+require 'database_validations/rubocop/cop/uniqueness_of'

data/lib/database_validations/validations/adapters.rb

@@ -13,7 +13,7 @@ module DatabaseValidations
       when PostgresqlAdapter::ADAPTER then PostgresqlAdapter.new(model)
       when MysqlAdapter::ADAPTER then MysqlAdapter.new(model)
       else
-        raise Errors::UnknownDatabase.new(database)
+        raise Errors::UnknownDatabase, database
       end
     end
   end

data/lib/database_validations/validations/adapters/base_adapter.rb

@@ -47,6 +47,11 @@ module DatabaseValidations
         self.class::SUPPORTED_OPTIONS
       end
 
+      # @return [String]
+      def table_name
+        model.table_name
+      end
+
       private
 
       attr_reader :model

data/lib/database_validations/validations/adapters/sqlite_adapter.rb

@@ -4,8 +4,7 @@ module DatabaseValidations
       SUPPORTED_OPTIONS = %i[scope message if unless].freeze
       ADAPTER = :sqlite3
 
-      def index_name(_error_message)
-      end
+      def index_name(_error_message); end
 
       def find_foreign_key_by_column(column)
         foreign_keys.find { |foreign_key| foreign_key.column.to_s == column.to_s }

data/lib/database_validations/validations/belongs_to_options.rb

@@ -23,21 +23,17 @@ module DatabaseValidations
     end
 
     def validates_presence_options
-      {attributes: relation, message: :required}
+      { attributes: relation, message: :required }
     end
 
     private
 
     def raise_if_foreign_key_missed!
-      unless adapter.find_foreign_key_by_column(column)
-        raise Errors::ForeignKeyNotFound.new(column, adapter.foreign_keys)
-      end
+      raise Errors::ForeignKeyNotFound.new(column, adapter.foreign_keys) unless adapter.find_foreign_key_by_column(column)
     end
 
     def raise_if_unsupported_database!
-      if adapter.adapter_name == :sqlite3
-        raise Errors::UnsupportedDatabase.new(:db_belongs_to, adapter.adapter_name)
-      end
+      raise Errors::UnsupportedDatabase.new(:db_belongs_to, adapter.adapter_name) if adapter.adapter_name == :sqlite3
     end
   end
 end

data/lib/database_validations/validations/errors.rb

@@ -7,20 +7,21 @@ module DatabaseValidations
     end
 
     class IndexNotFound < Base
-      attr_reader :columns, :where_clause, :index_name, :available_indexes
+      attr_reader :columns, :where_clause, :index_name, :available_indexes, :table_name
 
-      def initialize(columns, where_clause, index_name, available_indexes)
+      def initialize(columns, where_clause, index_name, available_indexes, table_name)
         @columns = columns
         @where_clause = where_clause
         @available_indexes = available_indexes
         @index_name = index_name
 
         text = if index_name
-                 "No unique index found with name: \"#{index_name}\". "\
+                 "No unique index found with name: \"#{index_name}\" in table \"#{table_name}\". "\
                  "Available indexes are: #{self.available_indexes.map(&:name)}. "
                else
-                 "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(', ')}]. "
+                 available_indexes = self.available_indexes.map { |ind| columns_and_where_text(ind.columns, ind.where) }.join(', ')
+                 "No unique index found with #{columns_and_where_text(columns, where_clause)} in table \"#{table_name}\". "\
+                 "Available indexes are: [#{available_indexes}]. "
                end
 
         super text + env_message

data/lib/database_validations/validations/helpers.rb

@@ -2,7 +2,7 @@ module DatabaseValidations
   module Helpers
     module_function
 
-    def handle_unique_error!(instance, error)
+    def handle_unique_error!(instance, error) # rubocop:disable Metrics/AbcSize
       adapter = Adapters.factory(instance.class)
       index_key = generate_key_for_uniqueness_index(adapter.index_name(error.message))
       column_key = generate_key_for_uniqueness(adapter.unique_error_columns(error.message))

data/lib/database_validations/validations/options_storage.rb

@@ -1,6 +1,5 @@
 module DatabaseValidations
   class OptionsStorage
-
     def initialize(klass)
       @adapter = Adapters.factory(klass)
       @storage = {}

data/lib/database_validations/validations/uniqueness_options.rb

@@ -1,7 +1,7 @@
 module DatabaseValidations
   class UniquenessOptions
     CUSTOM_OPTIONS = %i[where index_name].freeze
-    DEFAULT_OPTIONS = {allow_nil: true, case_sensitive: true, allow_blank: false}.freeze
+    DEFAULT_OPTIONS = { allow_nil: true, case_sensitive: true, allow_blank: false }.freeze
 
     attr_reader :field
 
@@ -79,7 +79,7 @@ module DatabaseValidations
     def condition_passes?(condition, instance)
       if condition.is_a?(Symbol)
         instance.__send__(condition)
-      elsif condition.is_a?(Proc) && condition.arity == 0
+      elsif condition.is_a?(Proc) && condition.arity.zero?
         instance.instance_exec(&condition)
       else
         instance.instance_eval(&condition)
@@ -94,10 +94,10 @@ module DatabaseValidations
       end
     end
 
-    def raise_if_index_missed!
+    def raise_if_index_missed! # rubocop:disable Metrics/AbcSize
       unless (index_name && adapter.find_index_by_name(index_name.to_s)) ||
-        (!index_name && adapter.find_index(columns, where_clause))
-        raise Errors::IndexNotFound.new(columns, where_clause, index_name, adapter.indexes)
+             (!index_name && adapter.find_index(columns, where_clause))
+        raise Errors::IndexNotFound.new(columns, where_clause, index_name, adapter.indexes, adapter.table_name)
       end
     end
   end

data/lib/database_validations/version.rb

@@ -1,3 +1,3 @@
 module DatabaseValidations
-  VERSION = '0.8.0'
+  VERSION = '0.8.1'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: database_validations
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.8.1
 platform: ruby
 authors:
 - Evgeniy Demin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-11-30 00:00:00.000000000 Z
+date: 2019-01-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -45,19 +45,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '2.7'
 - !ruby/object:Gem::Dependency
-  name: sqlite3
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '1.16'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: mysql2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
 - !ruby/object:Gem::Dependency
   name: pg
   requirement: !ruby/object:Gem::Requirement
@@ -73,75 +87,75 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.1'
 - !ruby/object:Gem::Dependency
-  name: mysql2
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: '10.0'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0.60'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0.60'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '1.30'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '1.30'
 - !ruby/object:Gem::Dependency
-  name: climate_control
+  name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.2'
+        version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.2'
+        version: '1.3'
 description: |-
   ActiveRecord provides validations on app level but it won't guarantee the
   consistent. In some cases, like `validates_uniqueness_of` it executes
@@ -159,6 +173,9 @@ files:
 - lib/database_validations/rails/railtie.rb
 - lib/database_validations/rspec/matchers.rb
 - lib/database_validations/rspec/uniqueness_validator_matcher.rb
+- lib/database_validations/rubocop/cop/belongs_to.rb
+- lib/database_validations/rubocop/cop/uniqueness_of.rb
+- lib/database_validations/rubocop/cops.rb
 - lib/database_validations/tasks/database_validations.rake
 - lib/database_validations/validations/adapters.rb
 - lib/database_validations/validations/adapters/base_adapter.rb