rspec-sequel_expectations 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 758f1cf23d10f38246e347bf38abdb55f6a88710
+  data.tar.gz: 2b9f2554615ac7ff91d8152fc2af937044661343
+SHA512:
+  metadata.gz: 6c7926ba67c720199dfef2c2868054289206810ad5c3a8e3140fcfc7784f7e74f3b8cf2f810cd278004e483d3fa535a49f71b26e996683bb2aae24fe17ba0cc1
+  data.tar.gz: f9425b101ce337c03998da126e08f032b6ff703d4139eaa112adfbaa4eccf078f2cb4a811c1228a3325133c84073a1950cd48d7b0016d72c8781444b0a83eea4

data/.gitignore

@@ -0,0 +1,23 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+config/database.yml

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--format documentation
+--require spec_helper

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rspec-sequel_expectations.gemspec
+gemspec
+
+gem 'sequelize', github: 'Ptico/sequelize'

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Andrey Savchenko
+
+MIT License
+
+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,49 @@
+# Rspec Sequel expectations
+
+RSpec matchers for Sequel which tests database, not model
+
+## Using
+
+```ruby
+RSpec.configure do |config|
+  config.include RSpec::Matchers::Sequel
+end
+
+describe DB do 
+  it { expect(DB).to have_enum('role_types').with_values(%w(admin manager user)) }
+end
+
+describe 'companies table' do
+  let(:table) { :companies }
+
+  it { expect(table).to have_primary_keys(:id, :city_id) }
+  it { expect(table).to have_column(:name).of_type(String).not_null.with_default('') }
+
+  it { expect(table).to have_unique_index_on(:email) }
+  it { expect(table).to have_index_on([:password, :email]).named('companies_credentials') }
+
+  it { expect(table).to refer_to(:city).from_fk(:city_id).to_pk(:id).on_update(:cascade).on_delete(:set_null) }
+end
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'rspec-sequel_expectations'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rspec-sequel_expectations
+
+## Contributing
+
+1. Fork it ( https://github.com/Ptico/rspec-sequel_expectations/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/Thorfile.thor

@@ -0,0 +1,6 @@
+# DB tasks
+require 'sequelize/thor/db'
+require File.join(File.dirname(__FILE__), 'db.rb')
+
+# Generators
+require 'sequelize/thor/generate'

data/config/database.yml.example

@@ -0,0 +1,12 @@
+# For available adapters and connection options
+# see: https://github.com/Ptico/sequelize/wiki/Database-configuration
+#
+default: &default
+  adapter: postgres
+  encoding: utf8
+
+development:
+  database: myapp_development
+  user: postgres
+  password: secret
+  <<: *default

data/db.rb

@@ -0,0 +1,12 @@
+require 'sequelize'
+
+Sequelize.configure do
+  root            File.expand_path('.', File.dirname(__FILE__))
+  config_file    'config/database.yml'
+end
+
+Sequelize.setup(ENV['DB_ENV'] || 'test')
+
+DB = Sequelize.connection
+
+DB.extension(:pg_enum)

data/lib/rspec/sequel_expectations.rb

@@ -0,0 +1,7 @@
+require 'rspec/sequel_expectations/version'
+
+require 'rspec/sequel_expectations/matchers/have_primary_key'
+require 'rspec/sequel_expectations/matchers/have_column'
+require 'rspec/sequel_expectations/matchers/have_index_on'
+require 'rspec/sequel_expectations/matchers/refer_to'
+require 'rspec/sequel_expectations/matchers/have_enum'

data/lib/rspec/sequel_expectations/matchers/have_column.rb

@@ -0,0 +1,121 @@
+module RSpec
+  module Matchers
+    module Sequel
+
+      class HaveColumn
+
+        def matches?(subject)
+          get_column_from(subject)
+
+          have_column? && correct_type? && correct_default? && correct_null?
+        end
+
+        def of_type(type)
+          @type = type
+          self
+        end
+
+        def with_default(val)
+          @default = val
+          self
+        end
+
+        def allow_null
+          @null = true
+          self
+        end
+
+        def not_null
+          @null = false
+          self
+        end
+
+        def description
+          text = [%(have column named "#{@name}")]
+          text << "of type #{@type}" if @type
+          text << %(with default value "#{@default}") unless @default == false
+          text << 'allowing null' if @null == true
+          text << 'not allowing null' if @null == false
+          text.join(' ')
+        end
+
+        def failure_message
+          %(expected #{@table} to #{description} but #{@error})
+        end
+
+        def failure_message_when_negated
+          %(did not expect #{@table} to #{description})
+        end
+
+      private
+
+        def initialize(column_name)
+          @name    = column_name
+          @type    = nil
+          @null    = nil
+          @default = false
+          @table   = nil
+          @error   = nil
+        end
+
+        def get_column_from(table)
+          column  = DB.schema(table.to_sym).detect { |tuple| tuple.first == @name }
+
+          @table  = table
+          @column = column ? column.last : nil
+        end
+
+        def have_column?
+          if @column.nil?
+            @error = %(#{@table} does not have a column named "#{@name}")
+            false
+          else
+            true
+          end
+        end
+
+        def correct_type?
+          return true unless @type
+
+          expected = DB.send(:type_literal, { type: @type }).to_s
+          actual   = [@column[:type].to_s, @column[:db_type].to_s]
+
+          if actual.include?(expected)
+            true
+          else
+            @error = %(it have type [#{actual.join(', ')}])
+            false
+          end
+        end
+
+        def correct_null?
+          return true if @null.nil?
+
+          if @column[:allow_null] == @null
+            true
+          else
+            @error = %(it #{"does not " if @null == true}allow null)
+            false
+          end
+        end
+
+        def correct_default?
+          return true if @default == false
+
+          if [@column[:default], @column[:ruby_default]].include?(@default)
+            true
+          else
+            @error = %(it has default value "#{@column[:ruby_default] || @column[:default]}")
+            false
+          end
+        end
+
+      end
+
+      def have_column(name)
+        HaveColumn.new(name)
+      end
+
+    end
+  end
+end

data/lib/rspec/sequel_expectations/matchers/have_enum.rb

@@ -0,0 +1,71 @@
+
+module RSpec
+  module Matchers
+    module Sequel
+      # TODO: refactor with Sequel API
+      # http://www.rubydoc.info/gems/sequel/4.13.0/Sequel/Postgres/EnumDatabaseMethods
+      class HaveEnum
+        def matches?(db)
+          @db = db
+          enum_exists? &&  with_valid_values?
+        end
+
+        def failure_message_when_negated
+          "expected database not to #{@description} #{@error}"
+        end
+
+        def failure_message
+          "expected database to #{description} #{@error}"
+        end
+
+        def with_values(*values)
+          @enum_values = values.flatten
+          self
+        end
+
+      private
+
+        def description
+          text = [%(have enum named "#{@enum_name}")]
+          text << %(with values "#{@enum_values}") unless @enum_values.empty?
+          text.join(' ')
+        end
+
+        def enum_exists?
+          !!@db.fetch("SELECT '#{@enum_name}'::regtype;").first
+        rescue ::Sequel::DatabaseError => e 
+          
+          if e.message[0..18] == 'PG::UndefinedObject'
+            @error = "but it doesn't exist"
+            return false
+          end
+          
+          raise e
+        end
+
+        def with_valid_values?
+          return true if @enum_values.empty?
+
+          sql = "SELECT e.enumlabel FROM pg_enum e JOIN pg_type t ON t.oid = e.enumtypid WHERE t.typname = '#{@enum_name}';"
+          values = @db.fetch(sql).map { |enum| enum[:enumlabel] }
+
+          if @enum_values.sort == values.sort
+            true
+          else
+            @error = "but got #{values}"
+            false
+          end
+        end
+
+        def initialize(enum_name)
+          @enum_values = []
+          @enum_name   = enum_name
+        end
+      end
+
+      def have_enum(enum_name)
+        HaveEnum.new(enum_name)
+      end
+    end
+  end
+end

data/lib/rspec/sequel_expectations/matchers/have_index_on.rb

@@ -0,0 +1,105 @@
+module RSpec
+  module Matchers
+    module Sequel
+
+      class HaveIndexOn
+
+        def named(name)
+          @name = name.to_sym
+          self
+        end
+
+        def matches?(table)
+          @table = table
+
+          get_required_index
+
+          index_present? && correct_name? && unique?
+        end
+
+        def description
+          text = %w(have)
+          text << 'unique' if @unique
+          text << %(index on #{@columns.inspect})
+          text << %(named "#{@name}") if @name
+          text.join(' ')
+        end
+
+        def failure_message
+          %(expected #{@table} to #{description} but #{@error})
+        end
+
+        def failure_message_when_negated
+          %(did not expect #{@table} to #{description})
+        end
+
+      private
+
+        def initialize(column, unique=false)
+          @columns = Array(column)
+          @unique = unique
+        end
+
+        def get_required_index
+          @index = DB.indexes(@table).each_pair.detect { |index, opts|
+            index.to_s.split('_').last != 'key' && opts[:columns] == @columns
+          }
+        end
+
+        # PostgreSQL adapter returns index and constraints as separate objects,
+        # each with an appropriate postfix.
+        # Other case is when constaint name is defined manually and
+        # following method must take that in account too.
+        def get_required_key
+          key = DB.indexes(@table).each_pair.detect do |key, opts|
+            if @name
+              key == @name
+            else
+              key.to_s.split('_').last == 'key' && opts[:columns] == @columns
+            end
+          end
+          @key = key.nil? ? {} : key.last
+        end
+
+        def index_present?
+          if @index.nil?
+            @error = 'none exists'
+            false
+          else
+            true
+          end
+        end
+
+        def correct_name?
+          if @name && @index.first != @name
+            @error = %(index have name "#{@index.first}")
+            false
+          else
+            true
+          end
+        end
+
+        def unique?
+          get_required_key
+          if @index.last[:unique] == @unique || @key.fetch(:unique, false) == @unique
+            true
+          else
+            @error = 'index is non-unique'
+            false
+          end
+        end
+
+      end
+
+      def have_index_on(column)
+        HaveIndexOn.new(column)
+      end
+
+      def have_unique_index_on(column)
+        HaveIndexOn.new(column, true)
+      end
+      alias :have_uniq_index_on :have_unique_index_on
+
+    end
+  end
+end