database_cleaner-core 2.0.0.beta2 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eacd8a1e863364bb678724f33c44ba361e1fbdc77066da69b4b92794e3528c14
-  data.tar.gz: 978fd0a42dd410ee1bb8282fdd29654582a88afe1a6709b4b23fa33c418ff0bc
+  metadata.gz: 10b3a62dc4a34477c00150b01b020e1c8b3a36bfff77674e66c281b6a101187d
+  data.tar.gz: 0894cd2cf9a69c054ef04138fba09ec20a995e11aedbfa64b40177d8fb45d238
 SHA512:
-  metadata.gz: 0eb27aff631629df80bcf9234c8fd923f8946727592688372233c101f9ae2c839b00d74c12dd3c847047d4fab95694a74d492378cc73aec1bb8cf55a5704fc04
-  data.tar.gz: aeb081d591c2619f37575b6b4e714cac728c0de01de73de416ecc641782e3ccf3a1b7d1abdf61a19983258cf95b47e719409154747a31a456ee5a6e85158567f
+  metadata.gz: e4bdb0c48d6e51c3f7ff56284de6ddca71943fb0e93b90a51990b66e575b9175292afac2e778e6d815b969cb31a1522ce96ee75af7e16ec016081de4f9d8ab8d
+  data.tar.gz: 26e519e860c44e520feb51245ca44d3c4c0f1b7e8ef6d8af76dcbc8bd8dad35b0e6625855e98e07bd7d94dcccda9728c1bec443d139dbefdfe2f304a157d4e14

data/ADAPTERS.md

@@ -26,8 +26,6 @@ You need to add a couple of dependecies to `.gemspec`:
   spec.add_dependency "orm_name", "some version if required"
 ```
 
-#### 
-
 ### File structure
 
 Inside the `lib/database_cleaner/orm_name` directory, you will need to create a few files:

data/History.rdoc

@@ -1,3 +1,15 @@
+== Development (unreleased)
+
+== 2.0.0 2021-01-31
+
+=== Changes
+  * Rename `url_whitelist` to `url_allowlist`
+  * Allowlist now supports regular expressions
+  * Fixed Ruby 2.7 deprecation warnings
+
+=== Breaking changes
+  * Failed checks against the allowlist now raise `UrlNotAllowed` rather than `NotWhitelistedUrl`
+
 == 2.0.0.beta2 2020-05-30
 
 === Features
@@ -17,7 +29,7 @@
   * remove all deprecated code and get the specs passing again.
   * Split off all adapter gems into their own repos: https://github.com/DatabaseCleaner/database_cleaner/pull/620
 
-== 1.99.0.beta 2020-05-30
+== 1.99.0 2021-01-31
 
 == Changes
   * Remove unnecessary dependency on database_cleaner-mongo from database_cleaner-mongoid: @botandrose

data/README.markdown

@@ -137,7 +137,7 @@ So what is fastest out of `:deletion` and `:truncation`? Well, it depends on you
 
 Some people report much faster speeds with `:deletion` while others say `:truncation` is faster for them. The best approach therefore is it try all options on your test suite and see what is faster.
 
-If you are using ActiveRecord then take a look at the [additional options](#additional-activerecord-options-for-truncation) available for `:truncation`.
+If you are using ActiveRecord then take a look at the [additional options](https://github.com/DatabaseCleaner/database_cleaner-active_record#strategy-configuration-options) available for `:truncation`.
 
 Database Cleaner also includes a `null` strategy (that does no cleaning at all) which can be used with any ORM library.
 You can also explicitly use it by setting your strategy to `nil`.
@@ -323,7 +323,7 @@ After copying and pasting code to do this several times I decided to package it
 
 DatabaseCleaner comes with safeguards against:
 
-* Running in production (checking for `ENV`, `RACK_ENV`, and `RAILS_ENV`)
+* Running in production (checking for `ENV`, `APP_ENV`, `RACK_ENV`, and `RAILS_ENV`)
 * Running against a remote database (checking for a `DATABASE_URL` that does not include `localhost`, `.local` or `127.0.0.1`)
 
 Both safeguards can be disabled separately as follows.
@@ -342,11 +342,20 @@ DatabaseCleaner.allow_production = true
 DatabaseCleaner.allow_remote_database_url = true
 ```
 
-In Ruby, a URL whitelist can be specified. When specified, DatabaseCleaner will only allow `DATABASE_URL` to be equal
-to one of the values specified in the url whitelist like so:
+In Ruby, a URL allowlist can be specified. When specified, DatabaseCleaner will only allow `DATABASE_URL` to be equal
+to one of the values specified in the url allowlist like so:
 
 ```ruby
-DatabaseCleaner.url_whitelist = ['postgres://postgres@localhost', 'postgres://foo@bar']
+DatabaseCleaner.url_allowlist = ['postgres://postgres@localhost', 'postgres://foo@bar']
+```
+
+Allowlist elements are matched with case equality (`===`), so regular expressions or procs may be used:
+
+```ruby
+DatabaseCleaner.url_allowlist = [
+  %r{^postgres://postgres@localhost},         # match any db with this prefix
+  proc {|uri| URI.parse(uri).user == "test" } # match any db authenticating with the 'test' user
+]
 ```
 
 ## COPYRIGHT

data/database_cleaner-core.gemspec

@@ -24,7 +24,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "listen"
   spec.add_development_dependency "rspec"
 
-  spec.add_development_dependency "cucumber"
+  spec.add_development_dependency "cucumber", "~>3.0"
   spec.add_development_dependency "activesupport"
   spec.add_development_dependency "database_cleaner-active_record"
   spec.add_development_dependency "sqlite3"

data/database_cleaner.gemspec

@@ -2,9 +2,7 @@ require_relative "./lib/database_cleaner/version"
 
 Gem::Specification.new do |spec|
   spec.name        = "database_cleaner"
-# FIXME temporarily hardcode to different version since core is at 2.0.0.beta2, but this gem only is at 2.0.0.beta
-# spec.version     = DatabaseCleaner::VERSION
-  spec.version     = "2.0.0.beta"
+  spec.version     = DatabaseCleaner::VERSION
   spec.authors     = ["Ben Mabey", "Ernesto Tagwerker", "Micah Geisel"]
   spec.email       = ["ernesto@ombulabs.com"]
 
@@ -18,5 +16,5 @@ Gem::Specification.new do |spec|
   spec.files       = ["lib/database_cleaner.rb"]
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "database_cleaner-active_record", "~>2.0.0.beta2"
+  spec.add_dependency "database_cleaner-active_record", "~>2.0.0"
 end

data/lib/database_cleaner/cleaners.rb

@@ -7,10 +7,10 @@ module DatabaseCleaner
     end
 
     # FIXME this method conflates creation with lookup... both a command and a query. yuck.
-    def [](orm, opts = {})
+    def [](orm, **opts)
       raise ArgumentError if orm.nil?
-      fetch([orm, opts]) { add_cleaner(orm, opts) }
-    end 
+      fetch([orm, opts]) { add_cleaner(orm, **opts) }
+    end
 
     def strategy=(strategy)
       values.each { |cleaner| cleaner.strategy = strategy }
@@ -37,8 +37,8 @@ module DatabaseCleaner
 
     private
 
-    def add_cleaner(orm, opts = {})
-      self[[orm, opts]] = Cleaner.new(orm, opts)
+    def add_cleaner(orm, **opts)
+      self[[orm, opts]] = Cleaner.new(orm, **opts)
     end
 
     def remove_duplicates

data/lib/database_cleaner/core.rb

@@ -14,7 +14,10 @@ module DatabaseCleaner
       :cleaning,
     ] => :cleaners
 
-    attr_accessor :allow_remote_database_url, :allow_production, :url_whitelist
+    attr_accessor :allow_remote_database_url, :allow_production, :url_allowlist
+
+    alias :url_whitelist :url_allowlist
+    alias :url_whitelist= :url_allowlist=
 
     def cleaners
       @cleaners ||= Cleaners.new

data/lib/database_cleaner/null_strategy.rb

@@ -3,11 +3,11 @@ module DatabaseCleaner
     def start
       # no-op
     end
-    
+
     def db=(db)
       # no-op
     end
-     
+
     def clean
       # no-op
     end

data/lib/database_cleaner/safeguard.rb

@@ -13,27 +13,27 @@ module DatabaseCleaner
         end
       end
 
-      class NotWhitelistedUrl < Error
+      class UrlNotAllowed < Error
         def initialize
-          super("ENV['DATABASE_URL'] is set to a URL that is not on the whitelist. Please refer to https://github.com/DatabaseCleaner/database_cleaner#safeguards")
+          super("ENV['DATABASE_URL'] is set to a URL that is not on the allowlist. Please refer to https://github.com/DatabaseCleaner/database_cleaner#safeguards")
         end
       end
     end
 
-    class WhitelistedUrl
+    class AllowedUrl
       def run
         return if skip?
-        raise Error::NotWhitelistedUrl if database_url_not_whitelisted?
+        raise Error::UrlNotAllowed if database_url_not_allowed?
       end
 
       private
 
-        def database_url_not_whitelisted?
-          !DatabaseCleaner.url_whitelist.include?(ENV['DATABASE_URL'])
+        def database_url_not_allowed?
+          !DatabaseCleaner.url_allowlist.any? {|allowed| allowed === ENV['DATABASE_URL'] }
         end
 
         def skip?
-          !DatabaseCleaner.url_whitelist
+          !DatabaseCleaner.url_allowlist
         end
     end
 
@@ -67,12 +67,12 @@ module DatabaseCleaner
         def skip?
           ENV['DATABASE_CLEANER_ALLOW_REMOTE_DATABASE_URL'] ||
             DatabaseCleaner.allow_remote_database_url ||
-            DatabaseCleaner.url_whitelist
+            DatabaseCleaner.url_allowlist
         end
     end
 
     class Production
-      KEYS = %w(ENV RACK_ENV RAILS_ENV)
+      KEYS = %w(ENV APP_ENV RACK_ENV RAILS_ENV)
 
       def run
         raise Error::ProductionEnv.new(key) if !skip? && given?
@@ -97,7 +97,7 @@ module DatabaseCleaner
     CHECKS = [
       RemoteDatabaseUrl,
       Production,
-      WhitelistedUrl
+      AllowedUrl
     ]
 
     def run

data/lib/database_cleaner/version.rb

@@ -1,3 +1,3 @@
 module DatabaseCleaner
-  VERSION = "2.0.0.beta2"
+  VERSION = "2.0.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: database_cleaner-core
 version: !ruby/object:Gem::Version
-  version: 2.0.0.beta2
+  version: 2.0.0
 platform: ruby
 authors:
 - Ben Mabey
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-05-30 00:00:00.000000000 Z
+date: 2021-01-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -85,16 +85,16 @@ dependencies:
   name: cucumber
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
@@ -204,11 +204,11 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.0.8
 signing_key: 
 specification_version: 4
 summary: Strategies for cleaning databases. Can be used to ensure a clean slate for