database_cleaner-sequel 1.99.0.beta → 2.0.0.beta

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 30fe6242af0bde30204ef4b711aa8d28d2a8d20b82dfcc94881ae330f0563ed8
-  data.tar.gz: c0d41a18b9100cea90e407ec664e22939a81d71eb03b0c1140b6fb4c5cf7a672
+  metadata.gz: e24b91d918b8069ebdd520d9c18819dd4510bf86be4e4c57f5fdc5b4db0139ab
+  data.tar.gz: 24f698fd0cbc73c3fddcd880ff19113ef9fbc18e8bfe55239ed1dd5e2dc6fefb
 SHA512:
-  metadata.gz: 94949b189b1c1e7fe2cb00d7e8dfb85b2ee23ed2dd1b8716b708ef167d3e96c72f285e53641fdff8501a0f42340c7d0a9317b674d074e0b67680c3b36412a593
-  data.tar.gz: 2bd37e335b111c12f2c5579210cfd4fa3a3dafd8ae9251fff8d2349b028061f7c6b1b883fde203f33edbb7621295ed39aae79678d96d1de5d1862d5481563fb3
+  metadata.gz: 59e1da73beffd21c0cb434a9ff1652843163e93c49c243ae74557ee719724c3ace97efdd89d8745b0bb98101e9215550841cdf107bb6e6e419f84ed504267ee4
+  data.tar.gz: 446c42ee8814a6ad9bbb72cfb1ef712af626d33adf3a76e4d05ada473615663f09ac00d74fb5cf5ea06cbc31be83d0dd295fae23948ca68fa4cca9fcf7aff3d0

data/.gitignore

@@ -8,6 +8,9 @@
 /spec/support/config.yml
 /tmp/
 !/tmp/.keep
+/.ruby-version
+/.byebug_history
+/Gemfile.lock
 
 # rspec failure tracking
 .rspec_status

data/.travis.yml

@@ -1,4 +1,11 @@
 language: ruby
+services:
+  - mysql
+  - postgresql
 rvm:
-  - 2.2.9
-before_install: gem install bundler -v 1.17.2
+  - 2.5
+  - 2.6
+  - 2.7
+before_script:
+  - bin/setup
+

data/Gemfile

@@ -1,8 +1,12 @@
 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: "../.."
+gem "database_cleaner-core", git: "https://github.com/DatabaseCleaner/database_cleaner"
+gem "byebug"
+
+group :test do
+  gem "simplecov", require: false
+  gem "codecov", require: false
+end

data/README.md

@@ -2,6 +2,7 @@
 
 [![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)
+[![codecov](https://codecov.io/gh/DatabaseCleaner/database_cleaner-sequel/branch/master/graph/badge.svg)](https://codecov.io/gh/DatabaseCleaner/database_cleaner-sequel)
 
 Clean your Sequel databases with Database Cleaner.
 
@@ -16,50 +17,62 @@ group :test do
 end
 ```
 
+```ruby
+# test_helper.rb
+DatabaseCleaner[:sequel].strategy = :transaction
+
+class Minitest::Spec
+  before :each do
+    DatabaseCleaner[:sequel].start
+  end
+
+  after :each do
+    DatabaseCleaner[:sequel].clean
+  end
+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, {:db =&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.
+Three strategies are supported:
+
+* Transaction (default)
+* Truncation
+* Deletion
+
+## Strategy configuration options
+
+The transaction strategy accepts no options.
+
+The truncation and deletion strategies may accept the following options:
+
+* `:only` and `:except` may take a list of table names:
 
+```ruby
+# Only truncate the "users" table.
+DatabaseCleaner[:sequel].strategy = :truncation, { only: ["users"] }
+
+# Delete all tables except the "users" table.
+DatabaseCleaner[:sequel].strategy = :deletion, { except: ["users"] }
+```
+
+* `:pre_count` - When set to `true`, this will check each table for existing rows before truncating or deleting it. This can speed up test suites when many of the tables are never populated. Defaults to `false`.
+
+## Adapter configuration options
+
+`#db` defaults to the default Sequel database, but can be specified manually in a few ways:
+
+```ruby
+# Sequel connection object
+DatabaseCleaner[:sequel].db = Sequel.connect(uri)
+
+# Back to default:
+DatabaseCleaner[:sequel].db = :default
+
+# Multiple Sequel databases can be specified:
+DatabaseCleaner[:sequel, connection: :default]
+DatabaseCleaner[:sequel, connection: Sequel.connect(uri)]
+```
 ## COPYRIGHT
 
-See [LICENSE] for details.
+See [LICENSE](LICENSE) for details.

data/bin/setup

@@ -1,8 +1,44 @@
 #!/usr/bin/env bash
 set -euo pipefail
 IFS=$'\n\t'
-set -vx
+
+NAME=$0
+DOCKER=NO
+
+usage() {
+  cat <<EOF
+Usage:
+  $NAME
+
+OPTIONS
+  -d|--docker  copy example config that works with docker-composed test
+               databases, copy  default otherwise.
+  -h|--help    display this message and exit.
+EOF
+}
+
+while [[ $# -gt 0 ]]
+do
+
+opt="$1"
+case $opt in
+  -d|--docker)
+    DOCKER=YES
+    shift
+    ;;
+  -h|--help)
+    usage
+    exit
+    ;;
+esac
+done
 
 bundle check || bundle install
-cp spec/support/sample.config.yml spec/support/config.yml
 
+if [[ $DOCKER = "YES" ]]
+then
+  cp spec/support/sample-docker.config.yml spec/support/config.yml
+  echo "Run \`docker-compose up\` to setup databases"
+else
+  cp spec/support/sample.config.yml spec/support/config.yml
+fi

data/database_cleaner-sequel.gemspec

@@ -1,12 +1,9 @@
-
-lib = File.expand_path("../lib", __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "database_cleaner/sequel/version"
+require_relative "./lib/database_cleaner/sequel/version"
 
 Gem::Specification.new do |spec|
   spec.name          = "database_cleaner-sequel"
   spec.version       = DatabaseCleaner::Sequel::VERSION
-  spec.authors       = ["Ernesto Tagwerker"]
+  spec.authors       = ["Ernesto Tagwerker", "Micah Geisel"]
   spec.email         = ["ernesto@ombulabs.com"]
 
   spec.summary       = "Strategies for cleaning databases using Sequel. Can be used to ensure a clean state for testing."
@@ -14,9 +11,6 @@ Gem::Specification.new do |spec|
   spec.homepage      = "https://github.com/DatabaseCleaner/database_cleaner-sequel"
   spec.license       = "MIT"
 
-  spec.add_dependency "database_cleaner", "~> 1.99.0.beta"
-  spec.add_dependency "sequel"
-
   spec.files         = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})
   end
@@ -24,12 +18,13 @@ Gem::Specification.new do |spec|
   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_dependency "database_cleaner-core", "~>2.0.0.beta2"
+  spec.add_dependency "sequel"
 
-  spec.add_development_dependency 'mysql', '~> 2.9.1'
-  spec.add_development_dependency 'mysql2'
-  spec.add_development_dependency 'pg'
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "mysql2"
+  spec.add_development_dependency "pg"
   spec.add_development_dependency "sqlite3"
 end

data/docker-compose.yml

@@ -0,0 +1,29 @@
+version: '3.1'
+
+services:
+  mysql:
+    image: mysql:8
+    ports:
+      - 3307:3306
+    environment:
+      MYSQL_ROOT_PASSWORD: root-password
+      MYSQL_DATABASE: database_cleaner_test
+      MYSQL_USER: database_cleaner
+      MYSQL_PASSWORD: database_cleaner
+    volumes:
+      - mydata:/var/lib/mysql
+
+  postgres:
+    image: postgres:12
+    ports:
+      - 5433:5432
+    environment:
+      POSTGRES_DB: database_cleaner_test
+      POSTGRES_USER: database_cleaner
+      POSTGRES_PASSWORD: database_cleaner
+    volumes:
+      - pgdata:/var/lib/postgresql/data
+
+volumes:
+  mydata:
+  pgdata:

data/lib/database_cleaner/sequel.rb

@@ -1,6 +1,7 @@
 require "database_cleaner/sequel/version"
-require "database_cleaner"
-require "database_cleaner/sequel/truncation"
+require "database_cleaner/core"
 require "database_cleaner/sequel/transaction"
+require "database_cleaner/sequel/truncation"
 require "database_cleaner/sequel/deletion"
 
+DatabaseCleaner[:sequel].strategy = :transaction

data/lib/database_cleaner/sequel/base.rb

@@ -1,21 +1,8 @@
-require 'database_cleaner/generic/base'
+require "database_cleaner/strategy"
+
 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
-
+    class Base < Strategy
       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

data/lib/database_cleaner/sequel/deletion.rb

@@ -1,45 +1,45 @@
-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")
+module DatabaseCleaner
+  module 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
-      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")
+        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
-      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
+      def delete_tables(db, tables)
+        tables.each do |table|
+          db[table.to_sym].delete
+        end
       end
-    end
 
-    def clean
-      return unless dirty?
+      def clean
+        return unless dirty?
 
-      tables = tables_to_truncate(db)
-      db.transaction do
-        disable_referential_integrity(tables) do
-          delete_tables(db, tables)
+        tables = tables_to_truncate(db)
+        db.transaction do
+          disable_referential_integrity(tables) do
+            delete_tables(db, tables)
+          end
         end
       end
     end

data/lib/database_cleaner/sequel/transaction.rb

@@ -1,25 +1,13 @@
 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
-
+    class Transaction < Base
       def start
-        self.class.check_fiber_brokenness
-
         @fibers ||= []
         db = self.db
         f = Fiber.new do
-          db.transaction(:rollback => :always, :savepoint => true) do
+          db.transaction(:rollback => :always, :savepoint => true, :auto_savepoint => true) do
             Fiber.yield
           end
         end
@@ -31,10 +19,6 @@ module DatabaseCleaner
         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

@@ -1,11 +1,13 @@
-require 'database_cleaner/generic/truncation'
 require 'database_cleaner/sequel/base'
 
 module DatabaseCleaner
   module Sequel
-    class Truncation
-      include ::DatabaseCleaner::Sequel::Base
-      include ::DatabaseCleaner::Generic::Truncation
+    class Truncation < Base
+      def initialize only: [], except: [], pre_count: false
+        @only = only
+        @except = except
+        @pre_count = pre_count
+      end
 
       def start
         @last_txid = txid
@@ -63,7 +65,7 @@ module DatabaseCleaner
       end
 
       def tables_to_truncate(db)
-        (@only || db.tables.map(&:to_s)) - @tables_to_exclude
+        (@only.any? ? @only : db.tables.map(&:to_s)) - @except - migration_storage_names
       end
 
       # overwritten

data/lib/database_cleaner/sequel/version.rb

@@ -1,5 +1,5 @@
 module DatabaseCleaner
   module Sequel
-    VERSION = "1.99.0.beta"
+    VERSION = "2.0.0.beta"
   end
 end

metadata

@@ -1,29 +1,30 @@
 --- !ruby/object:Gem::Specification
 name: database_cleaner-sequel
 version: !ruby/object:Gem::Version
-  version: 1.99.0.beta
+  version: 2.0.0.beta
 platform: ruby
 authors:
 - Ernesto Tagwerker
+- Micah Geisel
 autorequire: 
 bindir: exe
 cert_chain: []
 date: 2020-05-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: database_cleaner
+  name: database_cleaner-core
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.99.0.beta
+        version: 2.0.0.beta2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.99.0.beta
+        version: 2.0.0.beta2
 - !ruby/object:Gem::Dependency
   name: sequel
   requirement: !ruby/object:Gem::Requirement
@@ -42,58 +43,44 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '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
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 2.9.1
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: mysql2
   requirement: !ruby/object:Gem::Requirement
@@ -148,13 +135,13 @@ files:
 - ".rspec"
 - ".travis.yml"
 - Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
 - bin/console
 - bin/setup
 - database_cleaner-sequel.gemspec
+- docker-compose.yml
 - lib/database_cleaner-sequel.rb
 - lib/database_cleaner/sequel.rb
 - lib/database_cleaner/sequel/base.rb
@@ -182,7 +169,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 1.3.1
 requirements: []
-rubygems_version: 3.0.8
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Strategies for cleaning databases using Sequel. Can be used to ensure a clean

data/Gemfile.lock

@@ -1,52 +0,0 @@
-PATH
-  remote: ../..
-  specs:
-    database_cleaner (1.99.0.beta)
-
-PATH
-  remote: .
-  specs:
-    database_cleaner-sequel (1.99.0.beta)
-      database_cleaner (~> 1.99.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