schema_expectations 0.0.0 → 0.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7bcaa02aa13161953b36126a982156c8eb192aac
-  data.tar.gz: 3378e981d2f3325310f4ce37097f8cb217956562
+  metadata.gz: d089e8270a688859724aea6d9e3a117f0cc32154
+  data.tar.gz: bc468ef7199c0960ca1ad33c8f20ea18ec5431bb
 SHA512:
-  metadata.gz: a0d519d4a0c7a1439af4e0ac32802b98f520f65abb8c61be27344e9f4502e89e0a6716613f35f2a4f9c6e37697640a3bb2f9f41cfb91ccbefb26f978d45f6d48
-  data.tar.gz: e397d41a9aca63152a1b9052797f5cd116e8475f22f7a449beca78f5b5322fcd5f2cd0793744b2afd5ce9495f27aa65958f2b3302957ed18a08c61d5bf177f67
+  metadata.gz: 7be6b68419758bbb28a87033904c4721d42bb0db70d2029ac52ffcb3e284aa2794621c351cdb481f8dd40c9d64e4c2be9ad22eefe51dfbb9bccdac30485d2379
+  data.tar.gz: 56ec7dd5e2b85c9d05f02131c9603bfb59b5ef8f814922d4406ba2149a916a725bec39c0c1546b9916110418a989907a9c3e6c3a4764b38bc4ef1433a1595301

data/.gitignore

@@ -1 +1,4 @@
 Gemfile.lock
+/pkg
+/.yardoc
+/doc

data/CHANGELOG.md

@@ -0,0 +1,10 @@
+# Schema Expectations Changelog
+
+# git master
+
+- `validate_schema_nullable` supports being called on AR instances
+- documented `validate_schema_nullable`
+
+### 0.0.0 (February 12, 2015)
+
+- Added `validate_schema_nullable` matcher

data/lib/schema_expectations/rspec_matchers/validate_schema_nullable.rb

@@ -2,12 +2,46 @@ require 'rspec/expectations'
 
 module SchemaExpectations
   module RSpecMatchers
+    # The `validate_schema_nullable` matcher test that an ActiveRecord model
+    # has unconditional presence validation on columns with `NOT NULL` constraints,
+    # and vice versa.
+    #
+    # For example, we can assert that the model and database are consistent
+    # on whether `Record#name` should be present:
+    #
+    #     create_table :records do |t|
+    #       t.string :name, null: false
+    #     end
+
+    #     class Record < ActiveRecord::Base
+    #       validates :name, presence: true
+    #     end
+    #
+    #     # RSpec
+    #     describe Record do
+    #       it { should validate_schema_nullable }
+    #     end
+    #
+    # You can restrict the columns tested:
+    #
+    #     # RSpec
+    #     describe Record do
+    #       it { should validate_schema_nullable.only(:name) }
+    #       it { should validate_schema_nullable.except(:name) }
+    #     end
+    #
+    # The `id` column is automatically skipped.
+    #
+    # @return [ValidateSchemaNullableMatcher]
     def validate_schema_nullable
       ValidateSchemaNullableMatcher.new
     end
 
     class ValidateSchemaNullableMatcher
       def matches?(model)
+        model = model.class if model.is_a?(ActiveRecord::Base)
+        fail "#{model.inspect} does not inherit from ActiveRecord::Base" unless model.ancestors.include?(ActiveRecord::Base)
+
         @model = model
         @not_null_columns = filter_attributes(not_null_columns(model))
         @present_attributes = filter_attributes(present_attributes(model))
@@ -35,6 +69,9 @@ module SchemaExpectations
         errors.join(', ')
       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)
@@ -42,6 +79,9 @@ module SchemaExpectations
         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)

data/lib/schema_expectations/version.rb

@@ -1,3 +1,3 @@
 module SchemaExpectations
-  VERSION = '0.0.0'
+  VERSION = '0.0.1'
 end

data/schema_expectations.gemspec

@@ -26,6 +26,7 @@ Gem::Specification.new do |gem|
 
   gem.add_development_dependency 'pry'
   gem.add_development_dependency 'rake', '~> 10.4'
+  gem.add_development_dependency 'yard', '~> 0.8.7'
 
   # tests
   gem.add_development_dependency 'codeclimate-test-reporter'

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

@@ -1,6 +1,32 @@
 require 'spec_helper'
 
 describe :validate_schema_nullable do
+  specify 'works on instances', :active_record do
+    create_table :records do |t|
+      t.string :name, null: false
+      t.string :wrong
+    end
+
+    stub_const('Record', Class.new(ActiveRecord::Base))
+
+    Record.instance_eval do
+      validates :name, :wrong, presence: true
+    end
+
+    expect(Record.new).to validate_schema_nullable.only(:name)
+    expect(Record.new).to_not validate_schema_nullable.only(:wrong)
+  end
+
+  specify 'doesnt raise extraneous exceptions from timestamps', :active_record do
+    create_table :records do |t|
+      t.timestamps
+    end
+
+    stub_const('Record', Class.new(ActiveRecord::Base))
+
+    expect(Record.new).to validate_schema_nullable
+  end
+
   specify 'asserts that presence validations match NOT NULL', :active_record do
     create_table :records do |t|
       t.string :not_null, null: false
@@ -10,7 +36,9 @@ describe :validate_schema_nullable do
       t.string :nullable_present
     end
 
-    class Record < ActiveRecord::Base
+    stub_const('Record', Class.new(ActiveRecord::Base))
+
+    Record.instance_eval do
       validates :not_null_present, presence: true
       validates :nullable_present, presence: true
     end
@@ -30,7 +58,7 @@ describe :validate_schema_nullable do
       expect(Record).to validate_schema_nullable.only(:nullable_present)
     end.to raise_error 'nullable_present has unconditional presence validation but is missing NOT NULL'
 
-    class Record < ActiveRecord::Base
+    Record.instance_eval do
       clear_validators!
       validates :not_null_present, presence: true, on: :create
     end
@@ -39,7 +67,7 @@ describe :validate_schema_nullable do
       expect(Record).to validate_schema_nullable.only(:not_null_present)
     end.to raise_error 'not_null_present is NOT NULL but its presence validator was conditional: {:on=>:create}'
 
-    class Record < ActiveRecord::Base
+    Record.instance_eval do
       clear_validators!
       validates :not_null_present, presence: true, if: ->{ false }
     end
@@ -48,7 +76,7 @@ describe :validate_schema_nullable do
       expect(Record).to validate_schema_nullable.only(:not_null_present)
     end.to raise_error /\Anot_null_present is NOT NULL but its presence validator was conditional: {:if=>\#<Proc:.*>}\z/
 
-    class Record < ActiveRecord::Base
+    Record.instance_eval do
       clear_validators!
       validates :not_null_present, presence: true, unless: ->{ true }
     end
@@ -57,7 +85,7 @@ describe :validate_schema_nullable do
       expect(Record).to validate_schema_nullable.only(:not_null_present)
     end.to raise_error /\Anot_null_present is NOT NULL but its presence validator was conditional: {:unless=>\#<Proc:.*>}\z/
 
-    class Record < ActiveRecord::Base
+    Record.instance_eval do
       clear_validators!
       validates :not_null_present, presence: true, allow_nil: true
     end
@@ -66,7 +94,7 @@ describe :validate_schema_nullable do
       expect(Record).to validate_schema_nullable.only(:not_null_present)
     end.to raise_error 'not_null_present is NOT NULL but its presence validator was conditional: {:allow_nil=>true}'
 
-    class Record < ActiveRecord::Base
+    Record.instance_eval do
       clear_validators!
       validates :not_null_present, presence: true, allow_blank: true
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: schema_expectations
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 0.0.1
 platform: ruby
 authors:
 - Emma Borhanian
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.4'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.7
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.7
 - !ruby/object:Gem::Dependency
   name: codeclimate-test-reporter
   requirement: !ruby/object:Gem::Requirement
@@ -119,6 +133,7 @@ files:
 - ".rspec"
 - ".ruby-version"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - Guardfile
 - LICENSE
@@ -161,3 +176,4 @@ test_files:
 - spec/lib/schema_expectations/rspec_matchers/validate_schema_nullable_spec.rb
 - spec/spec_helper.rb
 - spec/support/active_record.rb
+has_rdoc: