schema_expectations 0.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7bcaa02aa13161953b36126a982156c8eb192aac
+  data.tar.gz: 3378e981d2f3325310f4ce37097f8cb217956562
+SHA512:
+  metadata.gz: a0d519d4a0c7a1439af4e0ac32802b98f520f65abb8c61be27344e9f4502e89e0a6716613f35f2a4f9c6e37697640a3bb2f9f41cfb91ccbefb26f978d45f6d48
+  data.tar.gz: e397d41a9aca63152a1b9052797f5cd116e8475f22f7a449beca78f5b5322fcd5f2cd0793744b2afd5ce9495f27aa65958f2b3302957ed18a08c61d5bf177f67

data/.gitignore

@@ -0,0 +1 @@
+Gemfile.lock

data/.rspec

@@ -0,0 +1 @@
+--color

data/.ruby-version

@@ -0,0 +1 @@
+2.2.0

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+rvm:
+  - 2.0.0
+  - 2.1.5
+  - 2.2.0
+  - ruby-head
+script: 'bundle exec rake'

data/Gemfile

@@ -0,0 +1,3 @@
+source 'http://rubygems.org'
+
+gemspec

data/Guardfile

@@ -0,0 +1,6 @@
+guard :rspec, cmd: 'bundle exec rspec' do
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^spec/support})      { 'spec' }
+  watch('spec/spec_helper.rb')  { 'spec' }
+end

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Emma Borhanian
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,7 @@
+[![Build Status](https://travis-ci.org/emma-borhanian/schema_expectations.svg?branch=master)](https://travis-ci.org/emma-borhanian/schema_expectations)
+
+# Work in progress
+
+# Schema Expectations
+
+Allows you to test whether your database schema matches the validations in your ActiveRecord models.

data/Rakefile

@@ -0,0 +1,12 @@
+require 'bundler/gem_tasks'
+require 'bundler/setup'
+
+begin
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new(:spec)
+
+  task :default => :spec
+rescue LoadError
+  # no rspec available
+end

data/lib/schema_expectations.rb

@@ -0,0 +1,7 @@
+require 'schema_expectations/version'
+
+begin
+  require 'rspec/core'
+rescue LoadError
+end
+require 'schema_expectations/rspec' if defined?(RSpec)

data/lib/schema_expectations/rspec.rb

@@ -0,0 +1,6 @@
+require 'rspec/core'
+require 'schema_expectations/rspec_matchers'
+
+RSpec.configure do |config|
+  config.include SchemaExpectations::RSpecMatchers, type: :model
+end

data/lib/schema_expectations/rspec_matchers.rb

@@ -0,0 +1 @@
+require 'schema_expectations/rspec_matchers/validate_schema_nullable'

data/lib/schema_expectations/rspec_matchers/validate_schema_nullable.rb

@@ -0,0 +1,109 @@
+require 'rspec/expectations'
+
+module SchemaExpectations
+  module RSpecMatchers
+    def validate_schema_nullable
+      ValidateSchemaNullableMatcher.new
+    end
+
+    class ValidateSchemaNullableMatcher
+      def matches?(model)
+        @model = model
+        @not_null_columns = filter_attributes(not_null_columns(model))
+        @present_attributes = filter_attributes(present_attributes(model))
+        @not_null_columns == @present_attributes
+      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"
+        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}"
+          else
+            errors << "#{attribute} is NOT NULL but has no presence validation"
+          end
+        end
+
+        errors.join(', ')
+      end
+
+      def only(*args)
+        fail 'cannot use only and except' if @except
+        @only = Array(args)
+        fail 'empty only list' if @only.empty?
+        self
+      end
+
+      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 presence_validators(model)
+        presence_validators = model.validators.select do |validator|
+          validator.kind == :presence
+        end
+      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
+      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
+      end
+
+      def not_null_columns(model)
+        model.columns.select { |column| !column.null }.map(&:name).map(&:to_sym)
+      end
+
+      def filter_attributes(attributes)
+        attributes &= @only if @only
+        attributes -= @except if @except
+        attributes -= [:id]
+        attributes
+      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
+
+        nil
+      end
+    end
+  end
+end

data/lib/schema_expectations/version.rb

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

data/schema_expectations.gemspec

@@ -0,0 +1,35 @@
+require File.expand_path('../lib/schema_expectations/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.platform      = Gem::Platform::RUBY
+  gem.name          = 'schema_expectations'
+  gem.version       = SchemaExpectations::VERSION
+  gem.summary       = 'Database Schema Expectations'
+  gem.description   = %q(
+    Allows you to test whether your database schema
+    matches the validations in your ActiveRecord models.'
+  )
+  gem.license       = 'MIT'
+
+  gem.authors       = ['Emma Borhanian']
+  gem.email         = 'emma.borhanian+schema_expectations@gmail.com'
+  gem.homepage      = 'https://github.com/emma-borhanian/schema_expectations'
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^spec/})
+  gem.require_paths = %w(lib)
+
+  gem.required_ruby_version = '>= 2.0.0'
+
+  gem.add_dependency 'activerecord', '~> 4.2'
+
+  gem.add_development_dependency 'pry'
+  gem.add_development_dependency 'rake', '~> 10.4'
+
+  # tests
+  gem.add_development_dependency 'codeclimate-test-reporter'
+  gem.add_development_dependency 'rspec', '~> 3.2'
+  gem.add_development_dependency 'guard-rspec', '~> 4.5'
+  gem.add_development_dependency 'sqlite3', '~> 1.3'
+end

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

@@ -0,0 +1,78 @@
+require 'spec_helper'
+
+describe :validate_schema_nullable do
+  specify 'asserts that presence validations match NOT NULL', :active_record do
+    create_table :records do |t|
+      t.string :not_null, null: false
+      t.string :not_null_present, null: false
+
+      t.string :nullable
+      t.string :nullable_present
+    end
+
+    class Record < ActiveRecord::Base
+      validates :not_null_present, presence: true
+      validates :nullable_present, presence: true
+    end
+
+    expect(Record).to validate_schema_nullable.only(:not_null_present, :nullable)
+    expect(Record).to validate_schema_nullable.except(:not_null, :nullable_present)
+
+    expect(Record).to_not validate_schema_nullable
+    expect(Record).to_not validate_schema_nullable.only(:not_null)
+    expect(Record).to_not validate_schema_nullable.only(:nullable_present)
+
+    expect do
+      expect(Record).to validate_schema_nullable.only(:not_null)
+    end.to raise_error 'not_null is NOT NULL but has no presence validation'
+
+    expect 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
+      clear_validators!
+      validates :not_null_present, presence: true, on: :create
+    end
+    expect(Record).to_not validate_schema_nullable.only(:not_null_present)
+    expect 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
+      clear_validators!
+      validates :not_null_present, presence: true, if: ->{ false }
+    end
+    expect(Record).to_not validate_schema_nullable.only(:not_null_present)
+    expect 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
+      clear_validators!
+      validates :not_null_present, presence: true, unless: ->{ true }
+    end
+    expect(Record).to_not validate_schema_nullable.only(:not_null_present)
+    expect 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
+      clear_validators!
+      validates :not_null_present, presence: true, allow_nil: true
+    end
+    expect(Record).to_not validate_schema_nullable.only(:not_null_present)
+    expect 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
+      clear_validators!
+      validates :not_null_present, presence: true, allow_blank: true
+    end
+    expect(Record).to_not validate_schema_nullable.only(:not_null_present)
+    expect 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_blank=>true}'
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+require 'codeclimate-test-reporter'
+CodeClimate::TestReporter.start
+
+require 'rspec'
+require 'pry'
+
+require 'schema_expectations'
+
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each do |file|
+  require file
+end
+
+RSpec.configure do |config|
+  config.raise_errors_for_deprecations!
+
+  config.include SchemaExpectations::RSpecMatchers
+end

data/spec/support/active_record.rb

@@ -0,0 +1,26 @@
+require 'active_record'
+
+module ActiveRecordHelpers
+  extend Forwardable
+
+  CONNECTION_DELEGATES = %i(create_table)
+
+  def connection
+    ActiveRecord::Base.connection
+  end
+
+  delegate CONNECTION_DELEGATES => :connection
+end
+
+RSpec.configure do |config|
+  config.before(:each, active_record: true) do |example|
+    ActiveRecord::Base.establish_connection(
+      adapter: 'sqlite3', database: ':memory:')
+  end
+
+  config.after(:each, active_record: true) do
+    ActiveRecord::Base.remove_connection
+  end
+
+  config.include ActiveRecordHelpers, active_record: true
+end

metadata

@@ -0,0 +1,163 @@
+--- !ruby/object:Gem::Specification
+name: schema_expectations
+version: !ruby/object:Gem::Version
+  version: 0.0.0
+platform: ruby
+authors:
+- Emma Borhanian
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.4'
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.5'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+description: "\n    Allows you to test whether your database schema\n    matches the
+  validations in your ActiveRecord models.'\n  "
+email: emma.borhanian+schema_expectations@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- Guardfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/schema_expectations.rb
+- lib/schema_expectations/rspec.rb
+- lib/schema_expectations/rspec_matchers.rb
+- lib/schema_expectations/rspec_matchers/validate_schema_nullable.rb
+- lib/schema_expectations/version.rb
+- schema_expectations.gemspec
+- spec/lib/schema_expectations/rspec_matchers/validate_schema_nullable_spec.rb
+- spec/spec_helper.rb
+- spec/support/active_record.rb
+homepage: https://github.com/emma-borhanian/schema_expectations
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Database Schema Expectations
+test_files:
+- spec/lib/schema_expectations/rspec_matchers/validate_schema_nullable_spec.rb
+- spec/spec_helper.rb
+- spec/support/active_record.rb