schema_expectations 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: de04e4a86866e356d2225b0b4236407b34a0795c
-  data.tar.gz: 5127ab4ef41da535ff54de06928081ca9c887e63
+  metadata.gz: 54b0e4a36d8ac008b802ecad39c008cc403cbdc5
+  data.tar.gz: 7f4d9f61aa0443b014e88f250453f16334ebea5f
 SHA512:
-  metadata.gz: 35aa646038fd59a9e88c76d6f8698a5669a0c602f37eaad56e95c772059bfe1de37087253726f15c7301c5b8f5abec6ba00fcedbb620dfe1480995008975d129
-  data.tar.gz: 71f5edb70e04ea2ab32c47c09ffd2132798ee8f57be0454481c2a7d0559a883051bb747a4ea65d9098fffbf495f22242deb3527410446ca1df583a1207988f49
+  metadata.gz: 776f30431891a3cac93548c7a91f33d5ad31729174d4930679e241e87368054bc78d00a03ed5a53ac3892f1fb49791a3247b7565334f665417d08261f2b42904
+  data.tar.gz: e7a11f3b6707033539922eed9323302c46bbb0663d45d5d42bfdd38bc9586e9edc9dec6f5457cb00e154bfc381b49fec63fb8dad1dbd505a2253a49000b1dedb

data/CHANGELOG.md

@@ -2,6 +2,10 @@
 
 ### git master
 
+### 0.5.0 (March 2, 2015)
+
+- absence validation absolves requiring uniqueness validation
+
 ### 0.4.0 (Febuary 20, 2015)
 
 - include matchers in non-model specs as well

data/README.md

@@ -8,6 +8,10 @@
 
 Allows you to test whether your database schema matches the validations in your ActiveRecord models.
 
+# Documentation
+
+You can find documentation at http://www.rubydoc.info/gems/schema_expectations
+
 # Installation
 
 Add `schema_expectations` to your Gemfile:
@@ -60,6 +64,8 @@ note: if you exclude a column, then every unique scope which includes it will be
 regardless of whether that scope includes other non-excluded columns. Only works similarly, in
 that it will ignore any scope which contains columns not in the list
 
+Absence validation on any attribute in a scope absolves requiring uniqueness validation.
+
 ## Validating presence constraints
 
 The `validate_schema_nullable` matcher tests that an ActiveRecord model

data/lib/schema_expectations/active_record/validation_reflector.rb

@@ -37,6 +37,10 @@ module SchemaExpectations
         new_with_validators validators_with_kind :presence
       end
 
+      def absence
+        new_with_validators validators_with_kind :absence
+      end
+
       def unconditional
         new_with_validators validators_without_options CONDITIONAL_OPTIONS
       end

data/lib/schema_expectations/rspec_matchers/base.rb

@@ -0,0 +1,45 @@
+require 'rspec/expectations'
+require 'schema_expectations/active_record/validation_reflector'
+require 'schema_expectations/active_record/column_reflector'
+
+module SchemaExpectations
+  module RSpecMatchers
+    class Base
+      # Specifies a list of columns to restrict matcher
+      #
+      # @return self
+      def only(*args)
+        fail 'cannot use only and except' if @except
+        @only = Array(args)
+        fail 'empty only list' if @only.empty?
+        self
+      end
+
+      # Specifies a list of columns for matcher to ignore
+      #
+      # @return self
+      def except(*args)
+        fail 'cannot use only and except' if @only
+        @except = Array(args)
+        fail 'empty except list' if @except.empty?
+        self
+      end
+
+      private
+
+      def setup(model)
+        @model = cast_model model
+        @validation_reflector = ActiveRecord::ValidationReflector.new(@model)
+        @column_reflector = ActiveRecord::ColumnReflector.new(@model)
+      end
+
+      def cast_model(model)
+        model = model.class if model.is_a?(::ActiveRecord::Base)
+        unless model.is_a?(Class) && model.ancestors.include?(::ActiveRecord::Base)
+          fail "#{model.inspect} does not inherit from ActiveRecord::Base"
+        end
+        model
+      end
+    end
+  end
+end

data/lib/schema_expectations/rspec_matchers/validate_schema_nullable.rb

@@ -1,6 +1,5 @@
 require 'rspec/expectations'
-require 'schema_expectations/active_record/validation_reflector'
-require 'schema_expectations/active_record/column_reflector'
+require 'schema_expectations/rspec_matchers/base'
 
 module SchemaExpectations
   module RSpecMatchers
@@ -39,13 +38,9 @@ module SchemaExpectations
       ValidateSchemaNullableMatcher.new
     end
 
-    class ValidateSchemaNullableMatcher
+    class ValidateSchemaNullableMatcher < Base
       def matches?(model)
-        @model = cast_model model
-        @validation_reflector = ActiveRecord::ValidationReflector.new(@model)
-        @column_reflector = ActiveRecord::ColumnReflector.new(@model)
-        @not_null_column_names = filter_column_names(not_null_column_names).sort
-        @present_column_names = filter_column_names(present_column_names).sort
+        setup(model)
         @not_null_column_names == @present_column_names
       end
 
@@ -77,34 +72,12 @@ module SchemaExpectations
         'validate NOT NULL columns are present'
       end
 
-      # Specifies a list of columns to restrict matcher
-      #
-      # @return [ValidateSchemaNullableMatcher] self
-      def only(*args)
-        fail 'cannot use only and except' if @except
-        @only = Array(args)
-        fail 'empty only list' if @only.empty?
-        self
-      end
-
-      # Specifies a list of columns for matcher to ignore
-      #
-      # @return [ValidateSchemaNullableMatcher] self
-      def except(*args)
-        fail 'cannot use only and except' if @only
-        @except = Array(args)
-        fail 'empty except list' if @except.empty?
-        self
-      end
-
       private
 
-      def cast_model(model)
-        model = model.class if model.is_a?(::ActiveRecord::Base)
-        unless model.is_a?(Class) && model.ancestors.include?(::ActiveRecord::Base)
-          fail "#{model.inspect} does not inherit from ActiveRecord::Base"
-        end
-        model
+      def setup(model)
+        super
+        @not_null_column_names = filter_column_names(not_null_column_names).sort
+        @present_column_names = filter_column_names(present_column_names).sort
       end
 
       def present_attributes

data/lib/schema_expectations/rspec_matchers/validate_schema_uniqueness.rb

@@ -1,6 +1,5 @@
 require 'rspec/expectations'
-require 'schema_expectations/active_record/validation_reflector'
-require 'schema_expectations/active_record/column_reflector'
+require 'schema_expectations/rspec_matchers/base'
 
 module SchemaExpectations
   module RSpecMatchers
@@ -16,7 +15,7 @@ module SchemaExpectations
     #       t.integer :record_id
     #       t.index [:record_type, :record_id], unique: true
     #     end
-
+    #
     #     class Record < ActiveRecord::Base
     #       validates :record_type, uniqueness: { scope: :record_id }
     #     end
@@ -38,19 +37,18 @@ module SchemaExpectations
     # regardless of whether that scope includes other non-excluded columns. Only works similarly, in
     # that it will ignore any scope which contains columns not in the list
     #
+    # Absence validation on any attribute in a scope absolves requiring uniqueness validation.
+    #
     # @return [ValidateSchemaUniquenessMatcher]
     def validate_schema_uniqueness
       ValidateSchemaUniquenessMatcher.new
     end
 
-    class ValidateSchemaUniquenessMatcher
+    class ValidateSchemaUniquenessMatcher < Base
       def matches?(model)
-        @model = cast_model model
-        @validation_reflector = ActiveRecord::ValidationReflector.new(@model)
-        @column_reflector = ActiveRecord::ColumnReflector.new(@model)
-        @validator_unique_scopes = filter_scopes(validator_unique_scopes).map(&:sort).sort
-        @schema_unique_scopes = filter_scopes(schema_unique_scopes).map(&:sort).sort
-        @validator_unique_scopes == @schema_unique_scopes
+        setup(model)
+        (@validator_unique_scopes - @schema_unique_scopes).empty? &&
+          (@schema_unique_scopes - @validator_unique_scopes - absent_scopes).empty?
       end
 
       def failure_message
@@ -60,7 +58,7 @@ module SchemaExpectations
           errors << "#{@model.name} scope #{scope.inspect} has unconditional uniqueness validation but is missing a unique database index"
         end
 
-        (@schema_unique_scopes - @validator_unique_scopes).each do |scope|
+        (@schema_unique_scopes - @validator_unique_scopes - absent_scopes).each do |scope|
           conditions = validator_conditions_for_scope(scope) ||
             validator_allow_empty_conditions_for_scope(scope)
           if conditions
@@ -81,38 +79,12 @@ module SchemaExpectations
         'validate unique indexes have uniqueness validation'
       end
 
-      # Specifies a list of columns to restrict matcher
-      #
-      # Any unique scope which includes a column not in this list will be ignored
-      #
-      # @return [ValidateSchemaUniquenessMatcher] self
-      def only(*args)
-        fail 'cannot use only and except' if @except
-        @only = Array(args)
-        fail 'empty only list' if @only.empty?
-        self
-      end
-
-      # Specifies a list of columns for matcher to ignore
-      #
-      # Any unique scope which includes one of these columns will be ignored
-      #
-      # @return [ValidateSchemaUniquenessMatcher] self
-      def except(*args)
-        fail 'cannot use only and except' if @only
-        @except = Array(args)
-        fail 'empty except list' if @except.empty?
-        self
-      end
-
       private
 
-      def cast_model(model)
-        model = model.class if model.is_a?(::ActiveRecord::Base)
-        unless model.is_a?(Class) && model.ancestors.include?(::ActiveRecord::Base)
-          fail "#{model.inspect} does not inherit from ActiveRecord::Base"
-        end
-        model
+      def setup(model)
+        super
+        @validator_unique_scopes = deep_sort(filter_scopes(validator_unique_scopes))
+        @schema_unique_scopes = deep_sort(filter_scopes(schema_unique_scopes))
       end
 
       def validator_unique_scopes
@@ -133,21 +105,40 @@ module SchemaExpectations
         end
       end
 
+      def deep_sort(scopes)
+        scopes.map(&:sort).sort
+      end
+
       def validator_conditions_for_scope(scope)
-        reflector = @validation_reflector.for_unique_scope(scope)
-        conditions = reflector.attributes.map do |attribute|
+        validator_conditions(scope) do |reflector, attribute|
           reflector.conditions_for_attribute attribute
         end
-        conditions.compact.first
       end
 
       def validator_allow_empty_conditions_for_scope(scope)
+        validator_conditions(scope) do |reflector, attribute|
+          reflector.allow_empty_conditions_for_attribute attribute
+        end
+      end
+
+      def validator_conditions(scope)
         reflector = @validation_reflector.for_unique_scope(scope)
         conditions = reflector.attributes.map do |attribute|
-          reflector.allow_empty_conditions_for_attribute attribute
+          yield reflector, attribute
         end
         conditions.compact.first
       end
+
+      def absent_scopes
+        scopes = @validator_unique_scopes + @schema_unique_scopes
+        absent_attributes = @validation_reflector.
+          absence.unconditional.disallow_empty.attributes
+        absent_columns = @column_reflector.for_attributes(*absent_attributes).column_names
+
+        scopes.reject do |scope|
+          (scope & absent_columns).empty?
+        end
+      end
     end
   end
 end

data/lib/schema_expectations/version.rb

@@ -1,3 +1,3 @@
 module SchemaExpectations
-  VERSION = '0.4.0'
+  VERSION = '0.5.0'
 end

data/spec/lib/schema_expectations/active_record/validation_reflector_spec.rb

@@ -41,6 +41,16 @@ module SchemaExpectations
         expect(validation_reflector.presence.unconditional.disallow_nil.attributes).to eq %i(present)
       end
 
+      specify '#absence', active_record_version: '>= 4.0' do
+        Record.instance_eval do
+          validates :absent, absence: true
+          validates :not_absent, length: { minimum: 1 }
+        end
+
+        expect(validation_reflector.attributes).to eq %i(absent not_absent)
+        expect(validation_reflector.absence.attributes).to eq %i(absent)
+      end
+
       specify '#for_unique_scope' do
         Record.instance_eval do
           validates :a, uniqueness: true

data/spec/lib/schema_expectations/rspec_matchers/validate_schema_uniqueness_spec.rb

@@ -122,6 +122,30 @@ describe SchemaExpectations::RSpecMatchers::ValidateSchemaUniquenessMatcher, :ac
       end
     end
 
+    context 'with absence validation on a unique column', active_record_version: '>= 4.0' do
+      before do
+        validates unique_scope.first, absence: true
+      end
+
+      it { is_expected.to validate_schema_uniqueness }
+    end
+
+    context 'with conditional absence validation on a unique column', active_record_version: '>= 4.0' do
+      before do
+        validates unique_scope.first, absence: true, if: -> { false }
+      end
+
+      it { is_expected.to_not validate_schema_uniqueness }
+    end
+
+    context 'with allow_blank absence validation on a unique column', active_record_version: '>= 4.0' do
+      before do
+        validates unique_scope.first, absence: true, allow_blank: true
+      end
+
+      it { is_expected.to_not validate_schema_uniqueness }
+    end
+
     specify '#failure_message_when_negated' do
       validates unique_scope.first, uniqueness: { scope: unique_scope.drop(1) }
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: schema_expectations
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Emma Borhanian
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-21 00:00:00.000000000 Z
+date: 2015-03-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -262,7 +262,6 @@ files:
 - MIT-LICENSE
 - README.md
 - Rakefile
-- TODO.md
 - gemfiles/activerecord_3.1.gemfile
 - gemfiles/activerecord_3.2.gemfile
 - gemfiles/activerecord_4.0.gemfile
@@ -278,6 +277,7 @@ files:
 - lib/schema_expectations/config.rb
 - lib/schema_expectations/rspec.rb
 - lib/schema_expectations/rspec_matchers.rb
+- lib/schema_expectations/rspec_matchers/base.rb
 - lib/schema_expectations/rspec_matchers/validate_schema_nullable.rb
 - lib/schema_expectations/rspec_matchers/validate_schema_uniqueness.rb
 - lib/schema_expectations/util.rb

data/TODO.md

@@ -1,2 +0,0 @@
-- `validates :attribute, if: :attribute_changed?` should have an exception as not conditional
-- `:absence` validation should absolve a model of needing uniqueness validation on the relevant column