database_cleaner-sequel 1.8.0.beta

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1253a731c343a4cfa702e0af053515520d99be4d117b67e849701034dbb622fe
+  data.tar.gz: 59066a7d47bc23bdcf68023247422839b0aae9a39b3bac48e1101d2d0e677765
+SHA512:
+  metadata.gz: de0085bab712fa412e5552c229460ba3785a172bf53e70da654ee6519673b60091ca9cd1d3297633cde9cbb8f4eaff1d1bde4555e2ffcee9d077970f5538b4b0
+  data.tar.gz: 06690a46bb8ad0945b86706f9195e298afa61a9b2cff2c63dc387b690ed28848729251fa526a05e2a171c45cbe9584cdf1ff56442c8a738019f3e9a7e3e711cb

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/spec/support/config.yml
+/tmp/
+!/tmp/.keep
+
+# rspec failure tracking
+.rspec_status

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.2.9
+before_install: gem install bundler -v 1.17.2

data/Gemfile

@@ -0,0 +1,8 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in database_cleaner-sequel.gemspec
+gemspec
+
+gem "database_cleaner", path: "../.."

data/Gemfile.lock

@@ -0,0 +1,52 @@
+PATH
+  remote: ../..
+  specs:
+    database_cleaner (1.8.0.beta)
+
+PATH
+  remote: .
+  specs:
+    database_cleaner-sequel (1.8.0.beta)
+      database_cleaner (~> 1.8.0.beta)
+      sequel
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    mysql (2.9.1)
+    mysql2 (0.3.18)
+    pg (0.18.2)
+    rake (10.4.2)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+    sequel (5.28.0)
+    sqlite3 (1.3.10)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  database_cleaner!
+  database_cleaner-sequel!
+  mysql (~> 2.9.1)
+  mysql2
+  pg
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  sqlite3
+
+BUNDLED WITH
+   1.17.3

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2009 Ben Mabey
+
+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,65 @@
+# Database Cleaner Adapter for Sequel
+
+[![Build Status](https://travis-ci.org/DatabaseCleaner/database_cleaner-sequel.svg?branch=master)](https://travis-ci.org/DatabaseCleaner/database_cleaner-sequel)
+[![Code Climate](https://codeclimate.com/github/DatabaseCleaner/database_cleaner-sequel/badges/gpa.svg)](https://codeclimate.com/github/DatabaseCleaner/database_cleaner-sequel)
+
+Clean your Sequel databases with Database Cleaner.
+
+See https://github.com/DatabaseCleaner/database_cleaner for more information.
+
+## Installation
+
+```ruby
+# Gemfile
+group :test do
+  gem 'database_cleaner-sequel'
+end
+```
+
+## Supported Strategies
+
+Here is an overview of the supported strategies:
+
+<table>
+  <tbody>
+    <tr>
+      <th>Truncation</th>
+      <th>Transaction</th>
+      <th>Deletion</th>
+    </tr>
+    <tr>
+      <td> Yes</td>
+      <td> <b>Yes</b></td>
+      <td> Yes</td>
+    </tr>
+  </tbody>
+</table>
+
+(Default strategy is denoted in bold)
+
+## Configuration options
+
+<table>
+  <tbody>
+    <tr>
+      <th>ORM</th>
+      <th>How to access</th>
+      <th>Notes</th>
+    </tr>
+    <tr>
+      <td> Sequel</td>
+      <td> <code>DatabaseCleaner[:sequel]</code></td>
+      <td> Multiple databases supported; specify <code>DatabaseCleaner[:sequel, {:connection =&gt; Sequel.connect(uri)}]</code></td>
+    </tr>
+  </tbody>
+</table>
+
+## Common Errors
+
+### Nothing happens in JRuby with Sequel using transactions
+
+Due to an inconsistency in JRuby's implementation of Fibers, Sequel gives a different connection to `DatabaseCleaner.start` than is used for tests run between `.start` and `.clean`. This can be worked around by running your tests in a block like `DatabaseCleaner.cleaning { run_my_tests }` instead, which does not use Fibers.
+
+## COPYRIGHT
+
+See [LICENSE] for details.

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "database_cleaner/sequel"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle check || bundle install
+cp spec/support/sample.config.yml spec/support/config.yml
+

data/database_cleaner-sequel.gemspec

@@ -0,0 +1,35 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "database_cleaner/sequel/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "database_cleaner-sequel"
+  spec.version       = DatabaseCleaner::Sequel::VERSION
+  spec.authors       = ["Ernesto Tagwerker"]
+  spec.email         = ["ernesto@ombulabs.com"]
+
+  spec.summary       = "Strategies for cleaning databases using Sequel. Can be used to ensure a clean state for testing."
+  spec.description   = "Strategies for cleaning databases using Sequel. Can be used to ensure a clean state for testing."
+  spec.homepage      = "https://github.com/DatabaseCleaner/database_cleaner-sequel"
+  spec.license       = "MIT"
+
+  spec.add_dependency "database_cleaner", "~> 1.8.0.beta"
+  spec.add_dependency "sequel"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+
+  spec.add_development_dependency 'mysql', '~> 2.9.1'
+  spec.add_development_dependency 'mysql2'
+  spec.add_development_dependency 'pg'
+  spec.add_development_dependency "sqlite3"
+end

data/lib/database_cleaner-sequel.rb

@@ -0,0 +1 @@
+require "database_cleaner/sequel"

data/lib/database_cleaner/sequel.rb

@@ -0,0 +1,6 @@
+require "database_cleaner/sequel/version"
+require "database_cleaner"
+require "database_cleaner/sequel/truncation"
+require "database_cleaner/sequel/transaction"
+require "database_cleaner/sequel/deletion"
+

data/lib/database_cleaner/sequel/base.rb

@@ -0,0 +1,26 @@
+require 'database_cleaner/generic/base'
+module DatabaseCleaner
+  module Sequel
+    def self.available_strategies
+      %w(truncation transaction deletion)
+    end
+
+    def self.default_strategy
+      :transaction
+    end
+
+    module Base
+      include ::DatabaseCleaner::Generic::Base
+
+      def db=(desired_db)
+        @db = desired_db
+      end
+
+      def db
+        return @db if @db && @db != :default
+        raise "As you have more than one active sequel database you have to specify the one to use manually!" if ::Sequel::DATABASES.count > 1
+        ::Sequel::DATABASES.first || :default
+      end
+    end
+  end
+end

data/lib/database_cleaner/sequel/deletion.rb

@@ -0,0 +1,47 @@
+require 'database_cleaner/sequel/base'
+require 'database_cleaner/generic/truncation'
+require 'database_cleaner/sequel/truncation'
+
+module DatabaseCleaner::Sequel
+  class Deletion < Truncation
+    def disable_referential_integrity(tables)
+      case db.database_type
+      when :postgres
+        db.run('SET CONSTRAINTS ALL DEFERRED')
+        tables_to_truncate(db).each do |table|
+          db.run("ALTER TABLE \"#{table}\" DISABLE TRIGGER ALL")
+        end
+      when :mysql
+        old = db.fetch('SELECT @@FOREIGN_KEY_CHECKS').first[:@@FOREIGN_KEY_CHECKS]
+        db.run('SET FOREIGN_KEY_CHECKS = 0')
+      end
+      yield
+    ensure
+      case db.database_type
+      when :postgres
+        tables.each do |table|
+          db.run("ALTER TABLE \"#{table}\" ENABLE TRIGGER ALL")
+        end
+      when :mysql
+        db.run("SET FOREIGN_KEY_CHECKS = #{old}")
+      end
+    end
+
+    def delete_tables(db, tables)
+      tables.each do |table|
+        db[table.to_sym].delete
+      end
+    end
+
+    def clean
+      return unless dirty?
+
+      tables = tables_to_truncate(db)
+      db.transaction do
+        disable_referential_integrity(tables) do
+          delete_tables(db, tables)
+        end
+      end
+    end
+  end
+end

data/lib/database_cleaner/sequel/transaction.rb

@@ -0,0 +1,40 @@
+require 'database_cleaner/sequel/base'
+module DatabaseCleaner
+  module Sequel
+    class Transaction
+      include ::DatabaseCleaner::Sequel::Base
+
+      def self.check_fiber_brokenness
+        if !@checked_fiber_brokenness && Fiber.new { Thread.current }.resume != Thread.current
+          raise RuntimeError, "This ruby engine's Fibers are not compatible with Sequel's connection pool. " +
+            "To work around this, please use DatabaseCleaner.cleaning with a block instead of " +
+            "DatabaseCleaner.start and DatabaseCleaner.clean"
+        end
+        @checked_fiber_brokenness = true
+      end
+
+      def start
+        self.class.check_fiber_brokenness
+
+        @fibers ||= []
+        db = self.db
+        f = Fiber.new do
+          db.transaction(:rollback => :always, :savepoint => true) do
+            Fiber.yield
+          end
+        end
+        f.resume
+        @fibers << f
+      end
+
+      def clean
+        f = @fibers.pop
+        f.resume
+      end
+
+      def cleaning
+        self.db.transaction(:rollback => :always, :savepoint => true) { yield }
+      end
+    end
+  end
+end

data/lib/database_cleaner/sequel/truncation.rb

@@ -0,0 +1,79 @@
+require 'database_cleaner/generic/truncation'
+require 'database_cleaner/sequel/base'
+
+module DatabaseCleaner
+  module Sequel
+    class Truncation
+      include ::DatabaseCleaner::Sequel::Base
+      include ::DatabaseCleaner::Generic::Truncation
+
+      def start
+        @last_txid = txid
+      end
+
+      def clean
+        return unless dirty?
+
+        tables = tables_to_truncate(db)
+
+        # Count rows before truncating
+        if pre_count?
+          tables = pre_count_tables(tables)
+        end
+
+        case db.database_type
+        when :postgres
+          # PostgreSQL requires all tables with FKs to be truncates in the same command, or have the CASCADE keyword
+          # appended. Bulk truncation without CASCADE is:
+          # * Safer. Tables outside of tables_to_truncate won't be affected.
+          # * Faster. Less roundtrips to the db.
+          unless tables.empty?
+            tables_sql = tables.map { |t| %("#{t}") }.join(',')
+            db.run "TRUNCATE TABLE #{tables_sql} RESTART IDENTITY;"
+          end
+        else
+          truncate_tables(db, tables)
+        end
+      end
+
+      private
+
+      def pre_count_tables tables
+        tables.reject { |table| db[table.to_sym].count == 0 }
+      end
+
+      def truncate_tables(db, tables)
+        tables.each do |table|
+          db[table.to_sym].truncate
+          if db.database_type == :sqlite && db.table_exists?(:sqlite_sequence)
+            db[:sqlite_sequence].where(name: table).delete
+          end
+        end
+      end
+
+      def dirty?
+        @last_txid != txid || @last_txid.nil?
+      end
+
+      def txid
+        case db.database_type
+        when :postgres
+          db.fetch('SELECT txid_snapshot_xmax(txid_current_snapshot()) AS txid').first[:txid]
+        end
+      end
+
+      def tables_to_truncate(db)
+        (@only || db.tables.map(&:to_s)) - @tables_to_exclude
+      end
+
+      # overwritten
+      def migration_storage_names
+        %w(schema_info schema_migrations)
+      end
+
+      def pre_count?
+        @pre_count == true
+      end
+    end
+  end
+end

data/lib/database_cleaner/sequel/version.rb

@@ -0,0 +1,5 @@
+module DatabaseCleaner
+  module Sequel
+    VERSION = "1.8.0.beta"
+  end
+end

metadata

@@ -0,0 +1,190 @@
+--- !ruby/object:Gem::Specification
+name: database_cleaner-sequel
+version: !ruby/object:Gem::Version
+  version: 1.8.0.beta
+platform: ruby
+authors:
+- Ernesto Tagwerker
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-01-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: database_cleaner
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.8.0.beta
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.8.0.beta
+- !ruby/object:Gem::Dependency
+  name: sequel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: mysql
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.9.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.9.1
+- !ruby/object:Gem::Dependency
+  name: mysql2
+  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: pg
+  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: sqlite3
+  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'
+description: Strategies for cleaning databases using Sequel. Can be used to ensure
+  a clean state for testing.
+email:
+- ernesto@ombulabs.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- database_cleaner-sequel.gemspec
+- lib/database_cleaner-sequel.rb
+- lib/database_cleaner/sequel.rb
+- lib/database_cleaner/sequel/base.rb
+- lib/database_cleaner/sequel/deletion.rb
+- lib/database_cleaner/sequel/transaction.rb
+- lib/database_cleaner/sequel/truncation.rb
+- lib/database_cleaner/sequel/version.rb
+- tmp/.keep
+homepage: https://github.com/DatabaseCleaner/database_cleaner-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: 1.3.1
+requirements: []
+rubygems_version: 3.0.4
+signing_key: 
+specification_version: 4
+summary: Strategies for cleaning databases using Sequel. Can be used to ensure a clean
+  state for testing.
+test_files: []