acts_as_scrubbable 1.4.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8d5dd99dfeaccd8c11b9eb2125c5dc9e16aba2f8f5d02eb5fc9fba59d7c36f02
-  data.tar.gz: 3551737a717372941339f0a81e95f6142a87a1ebb006437465d458c0fee0ea07
+  metadata.gz: 21f5d280a1785c5fa8107fa5d7a0f53939c00cb4426ac0bf1fdf22dc91e09c2c
+  data.tar.gz: d4d78fba1d4274380b77f090fe6673c0f07ccd97ed785ab7eefcb26f4a96bf29
 SHA512:
-  metadata.gz: eca9d4ca0de33ea806a4e8c28e7eb97d832c9859ee00f984342d6b041aa31393742942ebee345123459f484fd1a7f157164115afbf5e67070df2c990e9bc5d2d
-  data.tar.gz: be3873e9f173fbf7058aa0c5328397465264117f627afbfdd92f527a5f8a7f1e637722b13e2be9d4dce9adf3133182c93c988f324cf3e046c8a0382a015dd891
+  metadata.gz: ff835f166087c1bdf1e950a3fbec2e7c618773af25e271714faba04ccd5860626228fdc6fc4c18521d9ac58f0b960d8a142edb8cab0adca42a6878e1d22ef7cc
+  data.tar.gz: 34862f07b833fbe839b8838b628e6eb6ba4305fe06f1c5bb8d4ba2b41de193c9248a2dc8800fd6abe887351e7df64583134dd7f7a12c719d06e7ee9121822ab9

data/.gitignore

@@ -1,3 +1,4 @@
+.bundle
 Gemfile.lock
 
-.idea/*
+.idea/*

data/acts_as_scrubbable.gemspec

@@ -13,9 +13,9 @@ Gem::Specification.new do |s|
   s.license     = "MIT"
   s.required_ruby_version = '~> 2.0'
 
-  s.add_runtime_dependency 'activesupport'    , '>= 4.1', '< 8'
-  s.add_runtime_dependency 'activerecord'     , '>= 4.1', '< 8'
-  s.add_runtime_dependency 'railties'         , '>= 4.1', '< 8'
+  s.add_runtime_dependency 'activesupport'    , '>= 6.1', '< 8'
+  s.add_runtime_dependency 'activerecord'     , '>= 6.1', '< 8'
+  s.add_runtime_dependency 'railties'         , '>= 6.1', '< 8'
   s.add_runtime_dependency 'faker'            , '>= 1.4'
   s.add_runtime_dependency 'highline'         , '>= 1.7'
   s.add_runtime_dependency 'term-ansicolor'   , '>= 1.3'

data/lib/acts_as_scrubbable/task_runner.rb

@@ -13,8 +13,8 @@ module ActsAsScrubbable
     end
 
     def prompt_db_configuration
-      db_host = ActiveRecord::Base.connection_config[:host]
-      db_name = ActiveRecord::Base.connection_config[:database]
+      db_host = ActiveRecord::Base.connection_db_config.host
+      db_name = ActiveRecord::Base.connection_db_config.database
 
       ActsAsScrubbable.logger.warn Term::ANSIColor.red("Please verify the information below to continue")
       ActsAsScrubbable.logger.warn Term::ANSIColor.red("Host: ") + Term::ANSIColor.white(" #{db_host}")
@@ -22,10 +22,10 @@ module ActsAsScrubbable
     end
 
     def confirmed_configuration?
-      db_host = ActiveRecord::Base.connection_config[:host]
+      db_host = ActiveRecord::Base.connection_db_config.host
 
       unless ENV["SKIP_CONFIRM"] == "true"
-        answer = ask("Type '#{db_host}' to continue. \n".red + '-> '.white)
+        answer = ask(Term::ANSIColor.red("Type '#{db_host}' to continue. \n") + Term::ANSIColor.white("-> "))
         unless answer == db_host
           ActsAsScrubbable.logger.error Term::ANSIColor.red("exiting ...")
           return false

data/lib/acts_as_scrubbable/version.rb

@@ -1,3 +1,3 @@
 module ActsAsScrubbable
-  VERSION = '1.4.0'
+  VERSION = '2.0.0'
 end

data/spec/lib/acts_as_scrubbable/task_runner_spec.rb

@@ -0,0 +1,143 @@
+require "spec_helper"
+
+RSpec.describe ActsAsScrubbable::TaskRunner do
+  subject(:runner) { described_class.new }
+
+  let(:logger) { instance_double("Logger", error: nil, info: nil, warn: nil) }
+  before do
+    allow(ActsAsScrubbable).to receive(:logger).and_return(logger)
+  end
+
+  describe "#prompt_db_configuration" do
+    it "reports database host and name" do
+      runner.prompt_db_configuration
+      expect(logger).to have_received(:warn).with(/Host:/)
+      expect(logger).to have_received(:warn).with(/Database:/)
+    end
+  end
+
+  describe "#confirmed_configuration?" do
+    before do
+      allow(runner).to receive(:ask).and_return(answer)
+    end
+
+    context "when answer matches database host" do
+      let(:answer) { ActiveRecord::Base.connection_db_config.host }
+
+      it "is true" do
+        expect(runner).to be_confirmed_configuration
+      end
+    end
+
+    context "when answer does not match database host" do
+      let(:answer) { "anything else" }
+
+      it "is false" do
+        expect(runner).not_to be_confirmed_configuration
+      end
+    end
+  end
+
+  describe "#scrub" do
+    let(:application) { instance_double("Rails::Application", eager_load!: nil) }
+    let(:processor) { instance_double("ActsAsScrubbable::ArClassProcessor", process: nil) }
+    before do
+      allow(Rails).to receive(:application).and_return(application)
+      allow(ActsAsScrubbable::ArClassProcessor).to receive(:new).and_return(processor)
+      # RSpec mocks are not tracking calls across the forks that Parallel creates, so stub it out
+      allow(Parallel).to receive(:each) do |array, &block|
+        array.each(&block)
+      end
+    end
+
+    it "scrubs all scrubbable classes", :aggregate_failures do
+      runner.extract_ar_classes
+      runner.scrub(num_of_batches: 1)
+      expect(processor).to have_received(:process).with(1).exactly(3).times
+      expect(ActsAsScrubbable::ArClassProcessor).to have_received(:new).with(ScrubbableModel)
+      expect(ActsAsScrubbable::ArClassProcessor).to have_received(:new).with(AnotherScrubbableModel)
+      expect(ActsAsScrubbable::ArClassProcessor).to have_received(:new).with(AThirdScrubbableModel)
+      expect(ActsAsScrubbable::ArClassProcessor).not_to have_received(:new).with(NonScrubbableModel)
+    end
+
+    context "if SCRUB_CLASSES is set" do
+      before do
+        allow(ENV).to receive(:[]).and_call_original
+        allow(ENV).to receive(:[]).with("SCRUB_CLASSES").and_return(
+          "NonScrubbableModel,ScrubbableModel,AThirdScrubbableModel",
+        )
+        runner.extract_ar_classes
+      end
+
+      it "only scrubs specified scrubbable classes" do
+        runner.scrub
+        expect(processor).to have_received(:process).twice
+        expect(ActsAsScrubbable::ArClassProcessor).to have_received(:new).with(ScrubbableModel)
+        expect(ActsAsScrubbable::ArClassProcessor).to have_received(:new).with(AThirdScrubbableModel)
+        expect(ActsAsScrubbable::ArClassProcessor).not_to have_received(:new).with(AnotherScrubbableModel)
+        expect(ActsAsScrubbable::ArClassProcessor).not_to have_received(:new).with(NonScrubbableModel)
+      end
+    end
+
+    context "if a specific class is set" do
+      before do
+        runner.set_ar_class(AnotherScrubbableModel)
+      end
+
+      it "only scrubs the specified class" do
+        runner.scrub
+        expect(processor).to have_received(:process).once
+        expect(ActsAsScrubbable::ArClassProcessor).to have_received(:new).with(AnotherScrubbableModel)
+        expect(ActsAsScrubbable::ArClassProcessor).not_to have_received(:new).with(ScrubbableModel)
+        expect(ActsAsScrubbable::ArClassProcessor).not_to have_received(:new).with(AThirdScrubbableModel)
+        expect(ActsAsScrubbable::ArClassProcessor).not_to have_received(:new).with(NonScrubbableModel)
+      end
+    end
+  end
+
+  describe "#before_hooks" do
+    before do
+      allow(ActsAsScrubbable).to receive(:execute_before_hook)
+    end
+
+    it "executes before hook" do
+      runner.before_hooks
+      expect(ActsAsScrubbable).to have_received(:execute_before_hook)
+    end
+
+    context "if SKIP_BEFOREHOOK is set" do
+      before do
+        allow(ENV).to receive(:[]).and_call_original
+        allow(ENV).to receive(:[]).with("SKIP_BEFOREHOOK").and_return("true")
+      end
+
+      it "does nothing" do
+        runner.before_hooks
+        expect(ActsAsScrubbable).not_to have_received(:execute_before_hook)
+      end
+    end
+  end
+
+  describe "#after_hooks" do
+    before do
+      allow(ActsAsScrubbable).to receive(:execute_after_hook)
+    end
+
+    it "executes after hook" do
+      runner.after_hooks
+      expect(ActsAsScrubbable).to have_received(:execute_after_hook)
+    end
+
+    context "if SKIP_AFTERHOOK is set" do
+      before do
+        allow(ENV).to receive(:[]).and_call_original
+        allow(ENV).to receive(:[]).with("SKIP_AFTERHOOK").and_return("true")
+      end
+
+      it "does nothing" do
+        runner.after_hooks
+        expect(ActsAsScrubbable).not_to have_received(:execute_after_hook)
+      end
+    end
+  end
+end

data/spec/support/database.rb

@@ -1,14 +1,10 @@
-require 'nulldb/rails'
-require 'nulldb_rspec'
+require "nulldb/rails"
+require "nulldb_rspec"
 
-if ActiveRecord::Base.configurations.respond_to?(:merge!)
-  ActiveRecord::Base.configurations.merge!("test" => {adapter: 'nulldb'})
-else
-  ActiveRecord::Base.configurations = ActiveRecord::DatabaseConfigurations.new(test: {adapter: 'nulldb'})
-end
+ActiveRecord::Base.configurations = ActiveRecord::DatabaseConfigurations.new(test: {adapter: "nulldb"})
 
 NullDB.configure do |c|
-  c.project_root = './spec'
+  c.project_root = "./spec"
 end
 
 RSpec.configure do |config|
@@ -49,3 +45,11 @@ class ScrubbableModel < ActiveRecord::Base
     self.scrubbing_finished = true
   end
 end
+
+class AnotherScrubbableModel < ActiveRecord::Base
+  acts_as_scrubbable :active => :boolean
+end
+
+class AThirdScrubbableModel < ActiveRecord::Base
+  acts_as_scrubbable :active => :boolean
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: acts_as_scrubbable
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Samer Masry
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-07-19 00:00:00.000000000 Z
+date: 2022-08-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -16,7 +16,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.1'
+        version: '6.1'
     - - "<"
       - !ruby/object:Gem::Version
         version: '8'
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.1'
+        version: '6.1'
     - - "<"
       - !ruby/object:Gem::Version
         version: '8'
@@ -36,7 +36,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.1'
+        version: '6.1'
     - - "<"
       - !ruby/object:Gem::Version
         version: '8'
@@ -46,7 +46,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.1'
+        version: '6.1'
     - - "<"
       - !ruby/object:Gem::Version
         version: '8'
@@ -56,7 +56,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.1'
+        version: '6.1'
     - - "<"
       - !ruby/object:Gem::Version
         version: '8'
@@ -66,7 +66,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.1'
+        version: '6.1'
     - - "<"
       - !ruby/object:Gem::Version
         version: '8'
@@ -236,12 +236,12 @@ files:
 - lib/acts_as_scrubbable/tasks.rb
 - lib/acts_as_scrubbable/update_processor.rb
 - lib/acts_as_scrubbable/version.rb
-- spec/db/database.yml
 - spec/db/schema.rb
 - spec/lib/acts_as_scrubbable/ar_class_processor_spec.rb
 - spec/lib/acts_as_scrubbable/import_processor_spec.rb
 - spec/lib/acts_as_scrubbable/scrub_spec.rb
 - spec/lib/acts_as_scrubbable/scrubbable_spec.rb
+- spec/lib/acts_as_scrubbable/task_runner_spec.rb
 - spec/lib/acts_as_scrubbable/update_processor_spec.rb
 - spec/spec_helper.rb
 - spec/support/database.rb
@@ -269,12 +269,12 @@ signing_key:
 specification_version: 4
 summary: Scrubbing data made easy
 test_files:
-- spec/db/database.yml
 - spec/db/schema.rb
 - spec/lib/acts_as_scrubbable/ar_class_processor_spec.rb
 - spec/lib/acts_as_scrubbable/import_processor_spec.rb
 - spec/lib/acts_as_scrubbable/scrub_spec.rb
 - spec/lib/acts_as_scrubbable/scrubbable_spec.rb
+- spec/lib/acts_as_scrubbable/task_runner_spec.rb
 - spec/lib/acts_as_scrubbable/update_processor_spec.rb
 - spec/spec_helper.rb
 - spec/support/database.rb

data/spec/db/database.yml

@@ -1,2 +0,0 @@
-test:
-  adapter: nulldb