schema_expectations 0.0.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d089e8270a688859724aea6d9e3a117f0cc32154
-  data.tar.gz: bc468ef7199c0960ca1ad33c8f20ea18ec5431bb
+  metadata.gz: 18218491d35e976cf13367e3d30d60e952886de6
+  data.tar.gz: fa58281615fdda22fefb031a987f85001c8fe672
 SHA512:
-  metadata.gz: 7be6b68419758bbb28a87033904c4721d42bb0db70d2029ac52ffcb3e284aa2794621c351cdb481f8dd40c9d64e4c2be9ad22eefe51dfbb9bccdac30485d2379
-  data.tar.gz: 56ec7dd5e2b85c9d05f02131c9603bfb59b5ef8f814922d4406ba2149a916a725bec39c0c1546b9916110418a989907a9c3e6c3a4764b38bc4ef1433a1595301
+  metadata.gz: 1eb5dc8161b1b91c08d40225bbd03d58e4153a6ea51af88420afbb91549837ca861849e486bb8e41f703097e5566ff6a344785829ac772a24c5a36995aa3992d
+  data.tar.gz: 8cc5ba8420797a7d5b10e8c25ca2ca309b2b8ecd7204f804296960988d7b835fc99ced2ff607f8b32c384ab5f407de6cf1d37cd3b103cc53fc1c23e0ba2052a9

data/.gitignore

@@ -1,4 +1,7 @@
 Gemfile.lock
+*.gemfile.lock
 /pkg
 /.yardoc
 /doc
+/coverage
+/tmp

data/.travis.yml

@@ -1,7 +1,21 @@
+---
 language: ruby
 rvm:
-  - 2.0.0
-  - 2.1.5
-  - 2.2.0
-  - ruby-head
-script: 'bundle exec rake'
+- 2.0.0
+- 2.1.5
+- 2.2.0
+env:
+- DB=sqlite3
+- DB=postgresql
+- DB=mysql2
+script: bundle exec rake
+gemfile:
+- gemfiles/activerecord_3.1.gemfile
+- gemfiles/activerecord_3.2.gemfile
+- gemfiles/activerecord_4.0.gemfile
+- gemfiles/activerecord_4.1.gemfile
+- gemfiles/activerecord_4.2.gemfile
+- gemfiles/default.gemfile
+- gemfiles/rspec_3.0.gemfile
+- gemfiles/rspec_3.1.gemfile
+- gemfiles/rspec_3.2.gemfile

data/Appraisals

@@ -0,0 +1,33 @@
+appraise 'activerecord-3.1' do
+  gem 'activerecord', '~> 3.1'
+end
+
+appraise 'activerecord-3.2' do
+  gem 'activerecord', '~> 3.2'
+end
+
+appraise 'activerecord-4.0' do
+  gem 'activerecord', '~> 4.0'
+end
+
+appraise 'activerecord-4.1' do
+  gem 'activerecord', '~> 4.1'
+end
+
+appraise 'activerecord-4.2' do
+  gem 'activerecord', '~> 4.2'
+end
+
+appraise 'rspec-3.0' do
+  gem 'rspec', '~> 3.0'
+end
+
+appraise 'rspec-3.1' do
+  gem 'rspec', '~> 3.1'
+end
+
+appraise 'rspec-3.2' do
+  gem 'rspec', '~> 3.2'
+end
+
+appraise('default') {}

data/CHANGELOG.md

@@ -1,6 +1,22 @@
 # Schema Expectations Changelog
 
-# git master
+### git master
+
+### 0.2.0 (Febuary 18, 2015)
+
+- support activerecord 3.1 to 4.2
+- support rspec 3.0 to 3.2
+- `validate_schema_nullable` #failure_message_when_negated works
+- `validate_schema_nullable` #description works
+- `validate_schema_nullable` supports belongs_to association validators
+- `validate_schema_nullable` supports polymorphic belongs_to association validators
+- `validate_schema_nullable` skips primary key and timestamps
+- `validate_schema_nullable` is aware of columns with default values
+- `validate_schema_nullable` is aware of columns with default functions
+- postgres support
+- mysql support
+
+### 0.0.1 (February 12, 2015)
 
 - `validate_schema_nullable` supports being called on AR instances
 - documented `validate_schema_nullable`

data/README.md

@@ -1,4 +1,8 @@
+[![Gem Version](https://badge.fury.io/rb/schema_expectations.svg)](https://rubygems.org/gems/schema_expectations)
 [![Build Status](https://travis-ci.org/emma-borhanian/schema_expectations.svg?branch=master)](https://travis-ci.org/emma-borhanian/schema_expectations)
+[![Code Climate](https://codeclimate.com/github/emma-borhanian/schema_expectations/badges/gpa.svg)](https://codeclimate.com/github/emma-borhanian/schema_expectations)
+[![Test Coverage](https://codeclimate.com/github/emma-borhanian/schema_expectations/badges/coverage.svg)](https://codeclimate.com/github/emma-borhanian/schema_expectations)
+[![Dependency Status](https://gemnasium.com/emma-borhanian/schema_expectations.svg)](https://gemnasium.com/emma-borhanian/schema_expectations)
 
 # Work in progress
 

data/Rakefile

@@ -10,3 +10,15 @@ begin
 rescue LoadError
   # no rspec available
 end
+
+task :refresh do
+  require 'yaml'
+
+  `appraisal install`
+
+  travis_file = File.expand_path('../.travis.yml', __FILE__)
+  travis_config = YAML.load(File.read(travis_file))
+  travis_config['gemfile'] = Dir.glob("#{File.dirname(__FILE__)}/gemfiles/*.gemfile").
+    map { |path| "gemfiles/#{File.basename(path)}" }
+  File.open(travis_file, 'w') { |f| f.write YAML.dump(travis_config) }
+end

data/gemfiles/activerecord_3.1.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "http://rubygems.org"
+
+gem "activerecord", "~> 3.1"
+
+gemspec :path => "../"

data/gemfiles/activerecord_3.2.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "http://rubygems.org"
+
+gem "activerecord", "~> 3.2"
+
+gemspec :path => "../"

data/gemfiles/activerecord_4.0.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "http://rubygems.org"
+
+gem "activerecord", "~> 4.0"
+
+gemspec :path => "../"

data/gemfiles/activerecord_4.1.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "http://rubygems.org"
+
+gem "activerecord", "~> 4.1"
+
+gemspec :path => "../"

data/gemfiles/activerecord_4.2.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "http://rubygems.org"
+
+gem "activerecord", "~> 4.2"
+
+gemspec :path => "../"

data/gemfiles/default.gemfile

@@ -0,0 +1,5 @@
+# This file was generated by Appraisal
+
+source "http://rubygems.org"
+
+gemspec :path => "../"

data/gemfiles/rspec_3.0.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "http://rubygems.org"
+
+gem "rspec", "~> 3.0"
+
+gemspec :path => "../"

data/gemfiles/rspec_3.1.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "http://rubygems.org"
+
+gem "rspec", "~> 3.1"
+
+gemspec :path => "../"

data/gemfiles/rspec_3.2.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "http://rubygems.org"
+
+gem "rspec", "~> 3.2"
+
+gemspec :path => "../"

data/lib/schema_expectations/active_record/column_reflector.rb

@@ -0,0 +1,92 @@
+require 'active_support/core_ext/object/blank'
+
+module SchemaExpectations
+  module ActiveRecord
+    class ColumnReflector # :nodoc:
+      def initialize(model, columns = nil)
+        @model = model
+        @columns = columns || model.columns
+      end
+
+      def column_names
+        @columns.map { |column| column.name.to_sym }
+      end
+
+      def not_null
+        new_with_columns @columns.reject(&:null)
+      end
+
+      def for_attributes(*attributes)
+        new_with_columns attributes_to_columns(*attributes)
+      end
+
+      def without_present_default
+        new_with_columns @columns.reject(&method(:present_default_column?))
+      end
+
+      private
+
+      def new_with_columns(columns)
+        ColumnReflector.new(@model, columns)
+      end
+
+      def attributes_to_columns(*attributes)
+        column_names = attributes.flat_map(&method(:attribute_to_column_names))
+        @columns.select do |column|
+          column_names.include? column.name.to_sym
+        end
+      end
+
+      def attribute_to_column_names(attribute)
+        association = @model.reflect_on_association(attribute)
+
+        if association && association.belongs_to? && association.options.key?(:polymorphic)
+          [association.foreign_key.to_sym, association.foreign_type.to_sym]
+        elsif association && association.belongs_to?
+          [association.foreign_key.to_sym]
+        else
+          [attribute]
+        end
+      end
+
+      def present_default_column?(column)
+        column.default.present? ||
+          primary_key?(column) ||
+          default_timestamp?(column) ||
+          default_function?(column)
+      end
+
+      def primary_key?(column)
+        column.name.to_s == @model.primary_key.to_s
+      end
+
+      def default_timestamp?(column)
+        @model.record_timestamps && all_timestamp_attributes.include?(column.name.to_sym)
+      end
+
+      def default_function?(column)
+        column.respond_to?(:default_function) &&
+          column.default_function &&
+          function_produces_present_value?(column.default_function)
+      end
+
+      def function_produces_present_value?(function)
+        query = "SELECT #{function}"
+        begin
+          result = @model.connection.execute query
+          result.first.values.first.present?
+        rescue => e
+          message = "SchemaExpectations: encountered error running #{query}"
+          message << "\n" << e.message
+          message << "\n" << e.backtrace.join('\n')
+          SchemaExpectations.error_logger.error message
+          false
+        end
+      end
+
+      def all_timestamp_attributes
+        @all_timestamp_attributes ||= Record.new.send(:all_timestamp_attributes).map(&:to_sym)
+      end
+    end
+  end
+end

data/lib/schema_expectations/active_record/validation_reflector.rb

@@ -0,0 +1,59 @@
+require 'schema_expectations/util'
+
+module SchemaExpectations
+  module ActiveRecord
+    class ValidationReflector # :nodoc:
+      CONDITIONAL_OPTIONS = %i(on if unless allow_nil allow_blank)
+
+      def initialize(model, validators = nil)
+        @model = model
+        @validators = validators || model.validators
+      end
+
+      def attributes
+        @validators.flat_map(&:attributes).uniq
+      end
+
+      def conditions_for_attribute(attribute)
+        validators = validators_for_attribute(attribute)
+        validators -= validators_without_options CONDITIONAL_OPTIONS
+        Util.slice_hash(validators.first.options, *CONDITIONAL_OPTIONS) if validators.first
+      end
+
+      def presence
+        new_with_validators validators_with_kind :presence
+      end
+
+      def unconditional
+        new_with_validators validators_without_options CONDITIONAL_OPTIONS
+      end
+
+      private
+
+      def new_with_validators(validators)
+        ValidationReflector.new(@model, validators)
+      end
+
+      def validators_with_kind(kind)
+        @validators.select do |validator|
+          validator.kind == kind
+        end
+      end
+
+      def validators_without_options(options)
+        @validators.select do |validator|
+          options.all? do |option_key|
+            !validator.options[option_key] ||
+              Array(validator.options[option_key]).empty?
+          end
+        end
+      end
+
+      def validators_for_attribute(attribute)
+        @validators.select do |validator|
+          validator.attributes.include? attribute
+        end
+      end
+    end
+  end
+end

data/lib/schema_expectations/config.rb

@@ -0,0 +1,25 @@
+require 'logger'
+
+module SchemaExpectations
+  def self.configure(&block)
+    @config.instance_eval(&block)
+  end
+
+  def self.error_logger
+    @config.error_logger
+  end
+
+  class Config
+    attr_accessor :error_logger
+
+    def initialize
+      reset!
+    end
+
+    def reset!
+      @error_logger = Logger.new($stderr)
+    end
+  end
+
+  @config = Config.new
+end

data/lib/schema_expectations/rspec_matchers/validate_schema_nullable.rb

@@ -1,8 +1,10 @@
 require 'rspec/expectations'
+require 'schema_expectations/active_record/validation_reflector'
+require 'schema_expectations/active_record/column_reflector'
 
 module SchemaExpectations
   module RSpecMatchers
-    # The `validate_schema_nullable` matcher test that an ActiveRecord model
+    # The `validate_schema_nullable` matcher tests that an ActiveRecord model
     # has unconditional presence validation on columns with `NOT NULL` constraints,
     # and vice versa.
     #
@@ -30,7 +32,7 @@ module SchemaExpectations
     #       it { should validate_schema_nullable.except(:name) }
     #     end
     #
-    # The `id` column is automatically skipped.
+    # The primary key and timestamp columns are automatically skipped.
     #
     # @return [ValidateSchemaNullableMatcher]
     def validate_schema_nullable
@@ -39,36 +41,40 @@ module SchemaExpectations
 
     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))
-        @not_null_columns == @present_attributes
+        @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
+        @not_null_column_names == @present_column_names
       end
 
       def failure_message
-        @not_null_columns.sort!
-        @present_attributes.sort!
-
         errors = []
 
-        (@present_attributes - @not_null_columns).each do |attribute|
-          errors << "#{attribute} has unconditional presence validation but is missing NOT NULL"
+        (@present_column_names - @not_null_column_names).each do |column_name|
+          errors << "#{column_name} has unconditional presence validation but is missing NOT NULL"
         end
 
-        (@not_null_columns - @present_attributes).each do |attribute|
-          if condition = validator_condition(@model, attribute)
-            errors << "#{attribute} is NOT NULL but its presence validator was conditional: #{condition.inspect}"
+        (@not_null_column_names - @present_column_names).each do |column_name|
+          if conditions = validator_conditions_for_column_name(column_name)
+            errors << "#{column_name} is NOT NULL but its presence validator was conditional: #{conditions.inspect}"
           else
-            errors << "#{attribute} is NOT NULL but has no presence validation"
+            errors << "#{column_name} is NOT NULL but has no presence validation"
           end
         end
 
         errors.join(', ')
       end
 
+      def failure_message_when_negated
+        'should not match NOT NULL with its presence validation but does'
+      end
+
+      def description
+        'validate NOT NULL columns are present'
+      end
+
       # Specifies a list of columns to restrict matcher
       #
       # @return [ValidateSchemaNullableMatcher] self
@@ -91,58 +97,43 @@ module SchemaExpectations
 
       private
 
-      def presence_validators(model)
-        presence_validators = model.validators.select do |validator|
-          validator.kind == :presence
+      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
 
-      def unconditional_presence_validators(model)
-        presence_validators(model).select do |validator|
-          keep = %i(on if unless).all? do |option_key|
-            Array(validator.options[option_key]).empty?
-          end
-
-          keep && !validator.options[:allow_nil] && !validator.options[:allow_blank]
-        end
+      def present_attributes
+        @validation_reflector.presence.unconditional.attributes
       end
 
-      def present_attributes(model)
-        present_attributes = unconditional_presence_validators(model).
-          flat_map(&:attributes).uniq
-        present_attributes &= model.columns.map(&:name).map(&:to_sym)
-        present_attributes
+      def present_column_names
+        @column_reflector.for_attributes(*present_attributes).
+          without_present_default.column_names
       end
 
-      def not_null_columns(model)
-        model.columns.select { |column| !column.null }.map(&:name).map(&:to_sym)
+      def column_name_to_attribute(column_name)
+        @validation_reflector.attributes.detect do |attribute|
+          @column_reflector.for_attributes(attribute).column_names.
+            include? column_name
+        end
       end
 
-      def filter_attributes(attributes)
-        attributes &= @only if @only
-        attributes -= @except if @except
-        attributes -= [:id]
-        attributes
+      def not_null_column_names
+        @column_reflector.not_null.
+          without_present_default.column_names
       end
 
-      def validator_condition(model, attribute)
-        validators = presence_validators(model).select do |validator|
-          validator.attributes.include? attribute
-        end
-
-        validators.each do |validator|
-          condition = [:on, :if, :unless].detect do |option_key|
-            !Array(validator.options[option_key]).empty?
-          end
-
-          condition ||= [:allow_nil, :allow_blank].detect do |option_key|
-            validator.options[option_key]
-          end
-
-          return { condition => validator.options[condition] } if condition
-        end
+      def filter_column_names(column_names)
+        column_names &= @only if @only
+        column_names -= @except if @except
+        column_names
+      end
 
-        nil
+      def validator_conditions_for_column_name(column_name)
+        @validation_reflector.conditions_for_attribute column_name_to_attribute column_name
       end
     end
   end

data/lib/schema_expectations/util.rb

@@ -0,0 +1,9 @@
+module SchemaExpectations
+  module Util # :nodoc:
+    def self.slice_hash(hash, *keys)
+      keys.each_with_object(hash.class.new) do |key, memo|
+        memo[key] = hash[key] if hash.has_key?(key)
+      end
+    end
+  end
+end

data/lib/schema_expectations/version.rb

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

data/lib/schema_expectations.rb

@@ -1,4 +1,5 @@
 require 'schema_expectations/version'
+require 'schema_expectations/config'
 
 begin
   require 'rspec/core'

data/schema_expectations.gemspec

@@ -22,15 +22,24 @@ Gem::Specification.new do |gem|
 
   gem.required_ruby_version = '>= 2.0.0'
 
-  gem.add_dependency 'activerecord', '~> 4.2'
+  gem.add_dependency 'activerecord', '>= 3.1', '< 4.3'
+  gem.add_dependency 'activesupport', '>= 3.1', '< 4.3'
+
+  # optional dependency
+  gem.add_development_dependency 'rspec', '>= 3.0', '< 3.3'
 
   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'
-  gem.add_development_dependency 'rspec', '~> 3.2'
+  gem.add_development_dependency 'wwtd'
+  gem.add_development_dependency 'appraisal', '~> 1.0'
+  gem.add_development_dependency 'codeclimate-test-reporter', '~> 0.4', '>= 0.4.6'
+  gem.add_development_dependency 'simplecov'
   gem.add_development_dependency 'guard-rspec', '~> 4.5'
   gem.add_development_dependency 'sqlite3', '~> 1.3'
+  gem.add_development_dependency 'pg', '~> 0.18'
+  gem.add_development_dependency 'mysql2', '~> 0.3.18'
+  gem.add_development_dependency 'database_cleaner', '~> 1.4'
 end

data/spec/db/database.yml

@@ -0,0 +1,13 @@
+sqlite3:
+  adapter: sqlite3
+  database: ':memory:'
+postgresql:
+  adapter: postgresql
+  encoding: unicode
+  database: schema_expectations_test
+  username: postgres
+mysql2:
+  adapter: mysql2
+  encoding: utf8
+  database: schema_expectations_test
+  username: root