rspec-sequel 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f0ff2a3c8c1cb80b37128f84fa5708440e4c7257
+  data.tar.gz: b4cb8c94e9751b9f6b9c42c34bdaddb21238097c
+SHA512:
+  metadata.gz: 34dcb0569b1c3f07b4d575ccf2ee772ee1d03e332a70ccd3eb0a477b03d9ba2022fe3e1e6ff3dbebf377b88674fad9b891771167c8b02a4596040436b71ba662
+  data.tar.gz: 11f09fa00b5e8c3f532b1ea9455fbbc6fb16f6fe26fd492810fa55ee934d0a2244c7048acf328d01abddc406198142a85e53d286562bc9e7421e3ef26987cece

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.kateproject.d

data/.kateproject

@@ -0,0 +1,5 @@
+{
+  "name": "RSpec Sequel"
+, "files": [ { "git": 1 } ]
+}
+

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.0.0

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rspec-sequel.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Conjur Inc.
+
+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,47 @@
+# RSpec::Sequel
+
+Sometimes migrations are less than trivial, especially when they need to transform data instead of just reshaping the database.
+That makes one justifiably uneasy when it comes to running them; the comfort provided by unit tests wasn't usually present or easy to attain. Until now!
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'rspec-sequel'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rspec-sequel
+
+## Usage
+
+    $ cat spec/migrations/create_users_spec.rb
+    
+```ruby
+require 'spec_helper'
+
+describe 'db/migrations/001_create_users.rb' do
+  it "creates the users table" do
+    migrate! :up
+    db.table_exists?(:users).should be_true
+    migrate! :down
+    db.table_exists?(:users).should be_false
+  end
+end
+```
+
+## Credits
+
+`spec/support/{matchers,helpers}.rb` originally come from [rspec-rails](https://github.com/rspec/rspec-rails).
+
+## Contributing
+
+1. Fork it
+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 new Pull Request

data/Rakefile

@@ -0,0 +1,9 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+require "cucumber"
+require "cucumber/rake/task"
+
+RSpec::Core::RakeTask.new(:spec)
+Cucumber::Rake::Task.new(:features)
+
+task default: %i(spec features)

data/features/migration_specs.feature

@@ -0,0 +1,41 @@
+Feature: migration specs
+  In order to make sure migrations perform as intended
+  The developer should be able to easily spec them
+  
+  Scenario: simple passing spec
+    Given a file named "spec/migrations/001_create_users_spec.rb" with:
+      """ruby
+      require 'spec_helper'
+      
+      describe 'db/migrations/001_create_users.rb' do
+        it "creates the users table" do
+          db.table_exists?(:users).should be_false
+          migrate! :up
+          db.table_exists?(:users).should be_true
+          migrate! :down
+          db.table_exists?(:users).should be_false
+        end
+      end
+      """
+    When I run `rspec spec`
+    Then the example should pass
+
+  Scenario: several examples
+    Given a file named "spec/migrations/001_create_users_spec.rb" with:
+      """ruby
+      require 'spec_helper'
+      
+      describe 'db/migrations/001_create_users.rb' do
+        it "creates the users table" do
+          migrate! :up
+          db.table_exists?(:users).should be_true
+        end
+        
+        it "makes an id column in users table" do
+          migrate! :up
+          expect { db[:users].insert(id: 42) } .to_not raise_error
+        end
+      end
+      """
+    When I run `rspec spec`
+    Then the example should pass

data/features/postgres_schema.feature

@@ -0,0 +1,75 @@
+Feature: postgres schema
+  In order to easily make sure the migrations work in target environment
+  I want to run them on a Postgres database
+  With an explicitly defined schema
+
+  Scenario: schema isolation
+    Given an empty database
+    And a file named "spec/migrations/001_create_users_spec.rb" with:
+      """ruby
+      require 'spec_helper'
+      
+      describe 'db/migrations/001_create_users.rb' do
+        postgres_schema do
+          create_table :users do
+            primary_key :id
+          end
+        end
+      
+        describe "down" do
+          it "drops the table" do
+            db.table_exists?(:users).should be_true
+            migrate! :down
+            db.table_exists?(:users).should be_false
+          end
+
+          it "drops the table even when there are still records" do
+            db[:users].insert id: 42
+            migrate! :down
+            db.table_exists?(:users).should be_false
+          end
+        end
+      end
+      """
+    When I run `rspec spec`
+    Then the examples should pass
+
+  Scenario: different schemas in different contexts
+    Given an empty database
+    And a file named "spec/migrations/002_add_users_foo_spec.rb" with:
+      """ruby
+      require 'spec_helper'
+      
+      describe 'db/migrations/002_add_users_foo.rb' do
+        describe "up" do
+          postgres_schema do
+            create_table :users do
+              primary_key :id
+            end
+          end
+      
+          it "adds the foo column" do
+            migrate! :up
+            db[:users].columns.should include(:foo)
+          end
+        end
+
+        describe "down" do
+          postgres_schema do
+            create_table :users do
+              primary_key :id
+              String :foo
+            end
+          end
+      
+          it "removes the foo column" do
+            migrate! :down
+            db[:users].columns.should_not include(:foo)
+          end
+        end
+      end
+      """
+    When I run `rspec spec`
+    Then the examples should pass
+
+  

data/features/step_definitions/database_steps.rb

@@ -0,0 +1,4 @@
+Given(/^an empty database$/) do
+  RSpec::Sequel::Test.postgres.drop_schema :public, if_exists: true, cascade: true
+  RSpec::Sequel::Test.postgres.create_schema :public
+end

data/features/step_definitions/examples_passing_steps.rb

@@ -0,0 +1,5 @@
+Then /^the example(s)? should( all)? pass$/ do |_, _|
+  step %q{the output should match /^[^0][ 0-9]*examples?/}
+  step %q{the output should contain "0 failures"}
+  step %q{the exit status should be 0}
+end

data/features/support/env.rb

@@ -0,0 +1,37 @@
+require 'aruba/cucumber'
+require_relative 'postgres'
+
+Before do
+  step %q{a file named "spec/spec_helper.rb" with:}, %Q{
+    require 'rspec/sequel'
+    Sequel::connect '#{RSpec::Sequel::Test::postgres.uri}'
+  }
+  
+  step %q{a file named "db/migrations/001_create_users.rb" with:}, %q{
+    Sequel.migration do
+      up do
+        create_table :users do
+          primary_key :id
+        end
+      end
+      down do
+        drop_table :users
+      end
+    end
+  }
+
+  step %q{a file named "db/migrations/002_add_users_foo.rb" with:}, %q{
+    Sequel.migration do
+      up do
+        alter_table :users do
+          add_column :foo, String
+        end
+      end
+      down do
+        alter_table :users do
+          drop_column :foo
+        end
+      end
+    end
+  }
+end

data/features/support/postgres.rb

@@ -0,0 +1,21 @@
+require 'sequel'
+
+module RSpec::Sequel::Test
+  
+  def self.postgres
+    @pg_db ||= connect_to_postgres
+  end
+  
+  private
+  DEFAULT_TEST_DATABASE = 'postgres:///rspec-sequel-test'
+
+  def self.connect_to_postgres
+    test_database = unless ENV['TEST_DATABASE']
+      STDERR.puts "TEST_DATABASE environment variable not found, defaulting to #{DEFAULT_TEST_DATABASE}"
+      DEFAULT_TEST_DATABASE
+    end
+
+    Sequel::connect test_database
+  end
+
+end

data/lib/rspec/sequel.rb

@@ -0,0 +1,11 @@
+require "rspec/sequel/version"
+
+require "sequel"
+require "rspec/core"
+
+require "rspec/sequel/migration_example_group"
+
+RSpec::configure do |c|
+  c.include RSpec::Sequel::MigrationExampleGroup, type: :migration, 
+      example_group: { file_path: %r{spec/migration} }
+end

data/lib/rspec/sequel/migration_example_group.rb

@@ -0,0 +1,43 @@
+module RSpec::Sequel
+  module MigrationExampleGroup
+    
+    def self.included(base)
+      base.extend ClassMethods
+      base.class_eval do
+        let(:db) { Sequel::connect 'sqlite:/' }
+        let(:migration) { load_migration migration_path }
+        migration_example_group = self
+        basedir = if defined? Rails then Rails.root else Dir.pwd end
+        let(:migration_path) { File.expand_path(migration_example_group.description, basedir) }
+      end
+    end
+    
+    def migrate! direction
+      migration.apply db, direction
+    end
+    
+    module ClassMethods
+      def postgres_schema &block
+        db = Sequel::DATABASES.find { |db| db.database_type == :postgres }
+        raise "Please connect to a Postgres database (eg. in spec_helper) before using ::postgres_schema." unless db
+        db = Sequel.connect(db.opts.merge search_path: ['spec'])
+        db.drop_schema :spec, cascade: true, if_exists: true
+        before(:all) do
+          db.create_schema :spec
+          db.instance_eval &block if block
+        end
+        let(:db) { db }
+        after(:all) { db.drop_schema :spec, cascade: true, if_exists: true }
+        around(:each) { |ex|  db.transaction(rollback: :always) { ex.run  } }
+      end
+    end
+    
+    private
+    def load_migration path
+      Sequel.extension :migration
+      load path
+      Sequel::Migration.descendants.pop
+    end
+
+  end
+end

data/lib/rspec/sequel/version.rb

@@ -0,0 +1,5 @@
+module RSpec
+  module Sequel
+    VERSION = "0.0.1"
+  end
+end

data/rspec-sequel.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rspec/sequel/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rspec-sequel"
+  spec.version       = RSpec::Sequel::VERSION
+  spec.authors       = ["Rafał Rzepecki"]
+  spec.email         = ["rafal@conjur.net"]
+  spec.description   = %q{Ever wanted to actually test that tricky migration? rspec-sequel will make it easy.}
+  spec.summary       = %q{Easily spec Sequel migrations}
+  spec.homepage      = "https://github.com/conjurinc/rspec-sequel"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+  
+  spec.add_dependency "sequel", "~> 4.0"
+  spec.add_dependency "rspec", "~> 2.13"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake", "~> 10.1"
+  spec.add_development_dependency "cucumber", "~> 1.3"
+  spec.add_development_dependency "aruba", "~> 0.5"
+  spec.add_development_dependency "sqlite3", "~> 1.3"
+  spec.add_development_dependency "pg", "~> 0.16"
+end

data/spec/rspec/sequel/migration_example_group_spec.rb

@@ -0,0 +1,88 @@
+require 'spec_helper'
+
+module RSpec::Sequel
+  describe MigrationExampleGroup do
+    
+    it { should be_included_in_files_in('./spec/migrations/') }
+    
+    let :group do
+      RSpec::Core::ExampleGroup.describe do
+        include MigrationExampleGroup
+      end
+    end
+    
+    let(:instance) { group.new }
+    
+    describe '::db' do
+      it "is an in-memory sqlite db by default" do
+        instance.db.uri.should == 'sqlite:/'
+      end
+
+      it "can be overriden" do
+        group.let(:db) { 'notreallyadb' }
+        instance.db.should == 'notreallyadb'
+      end
+    end
+    
+    describe "#migrate!" do
+      it "applies the migration in the proper direction" do
+        migration = double "migration"
+        instance.stub migration: migration, db: 'notreallyadb'
+        
+        migration.should_receive(:apply).with('notreallyadb', :dir)
+        instance.migrate! :dir
+      end
+    end
+    
+    describe "::migration" do
+      it "loads the migration from the migration_path" do
+        instance.stub migration_path: File.expand_path("../test_migration.rb", __FILE__)
+        
+        instance.migration.up.call.should == "I'm up!"
+        instance.migration.down.call.should == "I'm down!"
+      end
+    end
+    
+    describe "::migration_path" do
+      it "defaults to the group title" do
+        group.stub description: 'some/migration/path'
+        instance.migration_path.should == "#{Dir.pwd}/some/migration/path"
+      end
+      
+      it "uses the Rails root if available" do
+        stub_const 'Rails', double(root: '/railroot')
+        group.stub description: 'some/migration/path'
+        instance.migration_path.should == "/railroot/some/migration/path"
+      end
+    end
+    
+    describe "::postgres_schema" do
+      let(:postgres) { RSpec::Sequel::Test::postgres }
+      
+      it "connects to the same database as the model, only with 'spec' schema" do
+        stub_const 'Sequel::DATABASES', [postgres]
+        group.postgres_schema
+        instance.db.opts.but(:orig_opts).should == postgres.opts.merge(search_path: %w(spec)).but(:orig_opts)
+      end
+      
+      it "runs the code inside on the database with a clean schema before running the context" do
+        stub_const 'Sequel::DATABASES', [postgres]
+        group.postgres_schema do
+          create_table :some_table do
+            primary_key :id
+          end
+        end
+        
+        postgres.table_exists?(:spec__some_table).should be_false
+        
+        group.example { postgres.table_exists?(:spec__some_table).should be_true }
+        reporter = RSpec::Core::Reporter.new
+        reporter.should_receive :example_passed
+        group.run(reporter)
+        
+        postgres.table_exists?(:spec__some_table).should be_false
+      end
+    end
+    
+  end
+end

data/spec/rspec/sequel/test_migration.rb

@@ -0,0 +1,9 @@
+Sequel.migration do
+  up do
+    "I'm up!"
+  end
+  
+  down do
+    "I'm down!"
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+Dir[File.expand_path '../support/**.rb', __FILE__].each {|f| require f}
+
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'rspec/sequel'

data/spec/support/helpers.rb

@@ -0,0 +1,26 @@
+module Helpers
+  def stub_metadata(additional_metadata)
+    stub_metadata = metadata_with(additional_metadata)
+    RSpec::Core::ExampleGroup.stub(:metadata) { stub_metadata }
+  end
+
+  def metadata_with(additional_metadata)
+    m = RSpec::Core::Metadata.new
+    m.process("example group")
+
+    group_metadata = additional_metadata.delete(:example_group)
+    if group_metadata
+      m[:example_group].merge!(group_metadata)
+    end
+    m.merge!(additional_metadata)
+    m
+  end
+
+  RSpec.configure {|c| c.include self}
+end
+
+class Hash
+  def but key
+    select {|k, _| k != key }
+  end
+end

data/spec/support/matchers.rb

@@ -0,0 +1,9 @@
+RSpec::Matchers::define :be_included_in_files_in do |path|
+  match do |mod|
+    stub_metadata(
+      :example_group => {:file_path => "#{path}whatever_spec.rb:15"}
+    )
+    group = RSpec::Core::ExampleGroup.describe
+    group.included_modules.include?(mod)
+  end
+end

data/spec/support/postgres.rb

@@ -0,0 +1,21 @@
+require 'sequel'
+
+module RSpec::Sequel::Test
+  
+  def self.postgres
+    @pg_db ||= connect_to_postgres
+  end
+  
+  private
+  DEFAULT_TEST_DATABASE = 'postgres:///rspec-sequel-test'
+
+  def self.connect_to_postgres
+    test_database = unless ENV['TEST_DATABASE']
+      STDERR.puts "TEST_DATABASE environment variable not found, defaulting to #{DEFAULT_TEST_DATABASE}"
+      DEFAULT_TEST_DATABASE
+    end
+
+    Sequel::connect test_database
+  end
+
+end

metadata

@@ -0,0 +1,193 @@
+--- !ruby/object:Gem::Specification
+name: rspec-sequel
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Rafał Rzepecki
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-09-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sequel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.13'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.13'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.1'
+- !ruby/object:Gem::Dependency
+  name: cucumber
+  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'
+- !ruby/object:Gem::Dependency
+  name: aruba
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.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'
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.16'
+description: Ever wanted to actually test that tricky migration? rspec-sequel will
+  make it easy.
+email:
+- rafal@conjur.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .kateproject
+- .rspec
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- features/migration_specs.feature
+- features/postgres_schema.feature
+- features/step_definitions/database_steps.rb
+- features/step_definitions/examples_passing_steps.rb
+- features/support/env.rb
+- features/support/postgres.rb
+- lib/rspec/sequel.rb
+- lib/rspec/sequel/migration_example_group.rb
+- lib/rspec/sequel/version.rb
+- rspec-sequel.gemspec
+- spec/rspec/sequel/migration_example_group_spec.rb
+- spec/rspec/sequel/test_migration.rb
+- spec/spec_helper.rb
+- spec/support/helpers.rb
+- spec/support/matchers.rb
+- spec/support/postgres.rb
+homepage: https://github.com/conjurinc/rspec-sequel
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: Easily spec Sequel migrations
+test_files:
+- features/migration_specs.feature
+- features/postgres_schema.feature
+- features/step_definitions/database_steps.rb
+- features/step_definitions/examples_passing_steps.rb
+- features/support/env.rb
+- features/support/postgres.rb
+- spec/rspec/sequel/migration_example_group_spec.rb
+- spec/rspec/sequel/test_migration.rb
+- spec/spec_helper.rb
+- spec/support/helpers.rb
+- spec/support/matchers.rb
+- spec/support/postgres.rb