database_cleaner-redis 1.8.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2b28c562a0dd611490e0dba780bc50817b58cad8a8a7abc29b54e89fb2736540
-  data.tar.gz: d7eb8549c64e317b8405a5abc40993d910adfa666e0d5010c67ebf2b547c83ac
+  metadata.gz: 34cf05b7cd63a56e99575e17ac1c55ac5798260b53487a96206366360a22b83b
+  data.tar.gz: 9bb36fddce39ba5dbfcd2737fd9cbaa9d8c87ee6991d78fc79fdef20bf19d0ea
 SHA512:
-  metadata.gz: b75e902e4541c16b986669dfbdc2139b9b603ef214c732f3a539e3cba6fb7af6a27b6933d416eb3b4af8bd3e98d69e283c3c444385ad60a647bc5416b1face30
-  data.tar.gz: f17eb577d40e43bc3a11f69a2b81f035346d0e102f72c8bb0eaa76a21da5798ddd0a05976ef076c39ee2658aa85977863ef87752a6f792ebb85b7c9ab0be2149
+  metadata.gz: dbe641bedad651831fb743459c5b8ebd53d05f2c6d8605c026056b0dfa3f763d0d52b2262bea9a007694d7e2e9ba687e27d0cb0072211bb146cbb46151474208
+  data.tar.gz: e546420735bbc0c804efa4768d4e9d90b21abfc6fe12a44ec67bf8ceccc557cf072f63efeaa8a0518b2f1a5b96a8b7a5f27387dcdf65b947d76c69dd070400f1

data/.gitignore

@@ -6,6 +6,9 @@
 /pkg/
 /spec/reports/
 /tmp/
+/.ruby-version
+/.byebug_history
+/Gemfile.lock
 
 # rspec failure tracking
 .rspec_status

data/.travis.yml

@@ -1,5 +1,9 @@
-sudo: false
 language: ruby
+services:
+  - redis
 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-redis.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-redis.svg?branch=master)](https://travis-ci.org/DatabaseCleaner/database_cleaner-redis)
 [![Code Climate](https://codeclimate.com/github/DatabaseCleaner/database_cleaner-redis/badges/gpa.svg)](https://codeclimate.com/github/DatabaseCleaner/database_cleaner-redis)
+[![codecov](https://codecov.io/gh/DatabaseCleaner/database_cleaner-redis/branch/master/graph/badge.svg)](https://codecov.io/gh/DatabaseCleaner/database_cleaner-redis)
 
 Clean your Redis databases with Database Cleaner.
 
@@ -18,42 +19,35 @@ end
 
 ## Supported Strategies
 
-<table>
-  <tbody>
-    <tr>
-      <th>Truncation</th>
-      <th>Transaction</th>
-      <th>Deletion</th>
-    </tr>
-    <tr>
-      <td> <b>Yes</b></td>
-      <td> No</td>
-      <td> No</td>
-    </tr>
-  </tbody>
-</table>
-
-(Default strategy is denoted in bold)
-
-## Configuration options
-
-`:only` and `:except` take a list of strings to be passed to [`keys`](https://redis.io/commands/keys)).
-
-<table>
-  <tbody>
-    <tr>
-      <th>ORM</th>
-      <th>How to access</th>
-      <th>Notes</th>
-    </tr>
-    <tr>
-      <td>Redis</td>
-      <td><code>DatabaseCleaner[:redis]</code></td>
-      <td>Connection specified as Redis URI</td>
-    </tr>
-  </tbody>
-</table>
+The redis adapter only has one strategy: the deletion strategy.
+
+## Strategy configuration options
+
+`:only` and `:except` may take a list of strings to be passed to [`keys`](https://redis.io/commands/keys)):
+
+```ruby
+# Only delete the "users" key, and keys that start with "cache".
+DatabaseCleaner[:redis].strategy = :deletion, { only: ["users", "cache*"] }
+
+# Delete all keys except the "users" key.
+DatabaseCleaner[:redis].strategy = :deletion, { except: ["users"] }
+```
+
+## Adapter configuration options
+
+`#db` defaults to `Redis.new`, but can be specified manually in a few ways:
+
+```ruby
+# Redis URI string:
+DatabaseCleaner[:redis].db = "redis://localhost:6379/0"
+
+# Redis connection object:
+DatabaseCleaner[:redis].db = Redis.new(url: "redis://localhost:6379/0")
+
+# Back to default:
+DatabaseCleaner[:redis].db = :default
+```
 
 ## COPYRIGHT
 
-See [LICENSE] for details.
+See [LICENSE](LICENSE) for details.

data/database_cleaner-redis.gemspec

@@ -1,12 +1,9 @@
-
-lib = File.expand_path("../lib", __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "database_cleaner/redis/version"
+require_relative "./lib/database_cleaner/redis/version"
 
 Gem::Specification.new do |spec|
   spec.name          = "database_cleaner-redis"
   spec.version       = DatabaseCleaner::Redis::VERSION
-  spec.authors       = ["Ernesto Tagwerker"]
+  spec.authors       = ["Ernesto Tagwerker", "Micah Geisel"]
   spec.email         = ["ernesto@ombulabs.com"]
 
   spec.summary       = "Strategies for cleaning databases using Redis. Can be used to ensure a clean state for testing."
@@ -21,10 +18,10 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "database_cleaner", "~> 1.8.0"
+  spec.add_dependency "database_cleaner-core", "~>2.0.0"
   spec.add_dependency "redis"
 
-  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 "bundler"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
 end

data/lib/database_cleaner/redis.rb

@@ -1,4 +1,5 @@
 require "database_cleaner/redis/version"
-require "database_cleaner"
-require "database_cleaner/redis/truncation"
+require "database_cleaner/core"
+require "database_cleaner/redis/deletion"
 
+DatabaseCleaner[:redis].strategy = :deletion

data/lib/database_cleaner/redis/deletion.rb

@@ -0,0 +1,49 @@
+require "database_cleaner/strategy"
+
+module DatabaseCleaner
+  module Redis
+    class Deletion < Strategy
+      def initialize only: [], except: []
+        @only = only
+        @except = except
+      end
+
+      def clean
+        if @only.none? && @except.none?
+          connection.flushdb
+        else
+          keys_to_delete.each do |key|
+            connection.del key
+          end
+        end
+
+        connection.quit unless db == :default
+      end
+
+      private
+
+      def keys_to_delete
+        only = expand_keys(@only)
+        except = expand_keys(@except)
+        only = connection.keys if only.none?
+        (only - except)
+      end
+
+      def expand_keys keys
+        keys.flat_map { |key| connection.keys(key) }
+      end
+
+      def connection
+        @connection ||= begin
+          if db == :default
+            ::Redis.new
+          elsif db.is_a?(::Redis) # pass directly the connection
+            db
+          else
+            ::Redis.new(url: db)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/database_cleaner/redis/version.rb

@@ -1,5 +1,5 @@
 module DatabaseCleaner
   module Redis
-    VERSION = "1.8.0"
+    VERSION = "2.0.0"
   end
 end

metadata

@@ -1,29 +1,30 @@
 --- !ruby/object:Gem::Specification
 name: database_cleaner-redis
 version: !ruby/object:Gem::Version
-  version: 1.8.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Ernesto Tagwerker
+- Micah Geisel
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-01-30 00:00:00.000000000 Z
+date: 2021-01-31 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.8.0
+        version: 2.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.8.0
+        version: 2.0.0
 - !ruby/object:Gem::Dependency
   name: redis
   requirement: !ruby/object:Gem::Requirement
@@ -42,44 +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'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
 description: Strategies for cleaning databases using Redis. Can be used to ensure
   a clean state for testing.
 email:
@@ -92,7 +93,6 @@ files:
 - ".rspec"
 - ".travis.yml"
 - Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -101,8 +101,7 @@ files:
 - database_cleaner-redis.gemspec
 - lib/database_cleaner-redis.rb
 - lib/database_cleaner/redis.rb
-- lib/database_cleaner/redis/base.rb
-- lib/database_cleaner/redis/truncation.rb
+- lib/database_cleaner/redis/deletion.rb
 - lib/database_cleaner/redis/version.rb
 homepage: https://github.com/DatabaseCleaner/database_cleaner-redis
 licenses:
@@ -123,7 +122,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.4
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Strategies for cleaning databases using Redis. Can be used to ensure a clean

data/Gemfile.lock

@@ -1,44 +0,0 @@
-PATH
-  remote: ../..
-  specs:
-    database_cleaner (1.8.0)
-
-PATH
-  remote: .
-  specs:
-    database_cleaner-redis (1.8.0)
-      database_cleaner (~> 1.8.0)
-      redis
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    diff-lcs (1.3)
-    rake (10.4.2)
-    redis (4.1.1)
-    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)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  bundler (~> 1.16)
-  database_cleaner!
-  database_cleaner-redis!
-  rake (~> 10.0)
-  rspec (~> 3.0)
-
-BUNDLED WITH
-   1.17.3

data/lib/database_cleaner/redis/base.rb

@@ -1,41 +0,0 @@
-require 'database_cleaner/generic/base'
-
-module DatabaseCleaner
-  module Redis
-    def self.available_strategies
-      %w{truncation}
-    end
-
-    def self.default_strategy
-      :truncation
-    end
-
-    module Base
-      include ::DatabaseCleaner::Generic::Base
-
-      def db=(desired_db)
-        @db = desired_db
-      end
-
-      def db
-        @db ||= :default
-      end
-
-      alias url db
-
-      private
-
-      def connection
-        @connection ||= begin
-          if url == :default
-            ::Redis.new
-          elsif db.is_a?(::Redis) # pass directly the connection
-            db
-          else
-            ::Redis.new(:url => url)
-          end
-        end
-      end
-    end
-  end
-end

data/lib/database_cleaner/redis/truncation.rb

@@ -1,26 +0,0 @@
-require 'database_cleaner/redis/base'
-require 'database_cleaner/generic/truncation'
-
-module DatabaseCleaner
-  module Redis
-    class Truncation
-      include ::DatabaseCleaner::Redis::Base
-      include ::DatabaseCleaner::Generic::Truncation
-
-      def clean
-        if @only
-          @only.each do |term|
-            connection.keys(term).each { |k| connection.del k }
-          end
-        elsif @tables_to_exclude
-          keys_except = []
-          @tables_to_exclude.each { |term| keys_except += connection.keys(term) }
-          connection.keys.each { |k| connection.del(k) unless keys_except.include?(k) }
-        else
-          connection.flushdb
-        end
-        connection.quit unless url == :default
-      end
-    end
-  end
-end