acts_as_scrubbable 2.1.3 → 2.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0b7213a56a968fe06418cb0639712b173b05a51694c4bd1cc87403998d23850c
-  data.tar.gz: 638e8280f0f658e0923d961a0e8421f9413ba6cca907520ca22a24a0a24de7ee
+  metadata.gz: 78c5e20c000ca44b2113629dd0bd1f2b17f1e0f0fc02235b769a81e5d2522f14
+  data.tar.gz: 42fadcfbaecf25abde3745e41aea33672f8cfa8250b60b8d8a321210dd0be8ac
 SHA512:
-  metadata.gz: e10d3afaa5741048ab4202ebcb68bfe06277854b88a2ce7ed0b4674686b77a051a3969d58c57bb52430c45da9cd36ec66760a80fa4c0d019be380774b42521b7
-  data.tar.gz: d97258aa692015c1683d50805e1437f55fd8babfec9753ed4ac05a5f5543dd9f5fb701d102ccc40c19ea5449ef02370fc394a0f0dc85e3f7e6173c2648736819
+  metadata.gz: 7077e06618544ec4e97888b15bf375fa7547ba6b090d7b16068940d421275c0751133e45147765ebe4cee922e2dd82fd5c80be036d516b320f956cff7d52a0d9
+  data.tar.gz: 4edf71dd76d658eb1c92ee2ea77351ab748bc18042b3a6286210bade096ef1712e6a1508f76cce6667f96d0051ff6694985abb40df6852d591893cf5d69c1c37

data/.circleci/config.yml

@@ -0,0 +1,109 @@
+version: 2.1
+
+_references:
+  ruby_versions: &ruby_versions
+    ruby-version:
+      - "3.3.0"
+      - "3.2.2"
+      - "3.1.4"
+      - "3.0.6"
+  rails_version_prefixess: &rails_version_prefixes
+    rails-version-prefix:
+      - "7.1"
+      - "7.0"
+      - "6.1"
+
+orbs:
+  ruby: circleci/ruby@2.1.0
+
+jobs:
+  test:
+    parameters:
+      ruby-version:
+        type: string
+      rails-version-prefix:
+        type: string
+
+    executor:
+      name: ruby/default
+      tag: <<parameters.ruby-version>>
+    environment:
+      RAILS_VERSION_PREFIX: <<parameters.rails-version-prefix>>
+    steps:
+      - checkout
+      - ruby/install-deps:
+          # Have to set this since there's no lockfile
+          bundler-version: ">2"
+          # Do not use deployment mode, because we don't have a lockfile
+          path: "bundle"
+          # Always install the latest versions available
+          with-cache: false
+      - ruby/rspec-test
+  test-ruby-head:
+    parameters:
+      rails-version-prefix:
+        type: string
+    docker:
+      - image: cimg/base:stable
+    environment:
+      RAILS_VERSION: <<parameters.rails-version-prefix>>
+    steps:
+      - checkout
+      - ruby/install:
+          # RVM wants Ruby 2 for some reason to install Ruby head.
+          # But then it will use 2.7.8 by default in the future;
+          # we must use `rvm use ruby-head` before every command that matters
+          version: "2.7.8"
+      - ruby/install:
+          version: ruby-head
+      - restore_cache:
+          keys:
+            - v1-{{ arch }}-ruby-head-bundler
+      - run:
+          name: Install Ruby dependencies
+          command: |
+            rvm use ruby-head
+            ruby --version
+            gem install bundler
+            bundle config set path bundle
+            bundle update
+      - save_cache:
+          key: v1-{{ arch }}-ruby-head-bundler
+          paths:
+            - ./bundle
+      - run:
+          name: RSpec tests
+          command: |
+            rvm use ruby-head
+            ruby --version
+            mkdir -p /tmp/test-results/rspec
+            bundle exec rspec --profile 10 --format RspecJunitFormatter --out /tmp/test-results/rspec/results.xml --format progress
+      - store_test_results:
+          path: /tmp/test-results/rspec
+
+workflows:
+  test:
+    jobs:
+      - test:
+          name: "test-ruby-<<matrix.ruby-version>>-rails-<<matrix.rails-version-prefix>>"
+          matrix:
+            parameters:
+              <<: *ruby_versions
+              <<: *rails_version_prefixes
+  test-head:
+    jobs:
+      - test:
+          name: "test-ruby-<<matrix.ruby-version>>-rails-main"
+          matrix:
+            parameters:
+              <<: *ruby_versions
+              rails-version-prefix:
+                - main
+            exclude:
+              - ruby-version: 3.0.6
+                rails-version-prefix: main
+      - test-ruby-head:
+          name: "test-ruby-head-rails-<<matrix.rails-version-prefix>>"
+          matrix:
+            parameters:
+              <<: *rails_version_prefixes

data/Gemfile

@@ -1,5 +1,15 @@
-ruby '3.2.2'
-
 source 'https://rubygems.org'
 
 gemspec
+
+# Lock Rails down in the matrix build, but not by default
+rails_version_prefix = ENV.fetch("RAILS_VERSION_PREFIX", nil)
+if rails_version_prefix == "main"
+  gem "activesupport", github: "rails/rails", branch: "main"
+  gem "activerecord", github: "rails/rails", branch: "main"
+  gem "railties", github: "rails/rails", branch: "main"
+elsif rails_version_prefix
+  gem "activesupport", "~> #{rails_version_prefix}.0"
+  gem "activerecord", "~> #{rails_version_prefix}.0"
+  gem "railties", "~> #{rails_version_prefix}.0"
+end

data/acts_as_scrubbable.gemspec

@@ -27,6 +27,7 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'pry-byebug'   , '~> 3.2'
   s.add_development_dependency 'terminal-notifier-guard' , '~> 1.6'
   s.add_development_dependency 'activerecord-nulldb-adapter', '~> 1.0'
+  s.add_development_dependency 'rspec_junit_formatter'
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- spec/*`.split("\n")

data/lib/acts_as_scrubbable/scrub.rb

@@ -4,24 +4,22 @@ module ActsAsScrubbable
     def scrubbed_values
       return unless self.class.scrubbable?
 
-      run_callbacks(:scrub) do
-        _updates = {}
+      _updates = {}
 
-        scrubbable_fields.each do |_field, value|
-          unless self.respond_to?(_field)
-            raise ArgumentError, "#{self.class} do not respond to #{_field}"
-          end
-          next if self.send(_field).blank?
-
-          if ActsAsScrubbable.scrub_map.keys.include?(value)
-            _updates[_field] = ActsAsScrubbable.scrub_map[value].call
-          else
-            puts "Undefined scrub: #{value} for #{self.class}#{_field}"
-           end
+      scrubbable_fields.each do |_field, value|
+        unless self.respond_to?(_field)
+          raise ArgumentError, "#{self.class} do not respond to #{_field}"
         end
+        next if self.send(_field).blank?
 
-        _updates
+        if ActsAsScrubbable.scrub_map.keys.include?(value)
+          _updates[_field] = ActsAsScrubbable.scrub_map[value].call
+        else
+          puts "Undefined scrub: #{value} for #{self.class}.#{_field}"
+          end
       end
+
+      _updates
     end
   end
 end

data/lib/acts_as_scrubbable/update_processor.rb

@@ -8,8 +8,10 @@ module ActsAsScrubbable
     def handle_batch(batch)
       scrubbed_count = 0
       batch.each do |obj|
-        _updates = obj.scrubbed_values
-        obj.update_columns(_updates) unless _updates.empty?
+        obj.run_callbacks(:scrub) do
+          _updates = obj.scrubbed_values
+          obj.update_columns(_updates) unless _updates.empty?
+        end
         scrubbed_count += 1
       end
       scrubbed_count

data/lib/acts_as_scrubbable/version.rb

@@ -1,3 +1,3 @@
 module ActsAsScrubbable
-  VERSION = '2.1.3'
+  VERSION = '2.1.5'
 end

data/spec/lib/acts_as_scrubbable/scrub_spec.rb

@@ -57,10 +57,29 @@ RSpec.describe ActsAsScrubbable::Scrub do
       expect(_updates[:address1]).to be_nil
     end
 
-    it 'runs scrub callbacks' do
-      subject.scrubbed_values
-      expect(subject.scrubbing_begun).to be(true)
-      expect(subject.scrubbing_finished).to be(true)
+    it 'output no information when all scrubbers found' do
+      expect(STDOUT).to_not receive(:puts)
+
+      _updates = subject.scrubbed_values
+    end
+
+    context "scrubbable" do
+      subject { MissingScrubbableModel.new }
+
+      it 'outputs warning message' do
+        subject.first_name = "Johnny"
+        subject.last_name = "Frank"
+
+        allow(Faker::Name).to receive(:first_name).and_return("Larry")
+        allow(Faker::Name).to receive(:last_name).and_return("Baker")
+
+        expect(STDOUT).to receive(:puts).with('Undefined scrub: fake_first_name for MissingScrubbableModel.first_name')
+        expect(Faker::Name).to_not receive(:first_name)
+
+        _updates = subject.scrubbed_values
+        expect(_updates[:last_name]).to eq('Baker')
+        expect(_updates[:first_name]).to be_nil
+      end
     end
   end
 end

data/spec/lib/acts_as_scrubbable/task_runner_spec.rb

@@ -53,10 +53,11 @@ RSpec.describe ActsAsScrubbable::TaskRunner do
     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(processor).to have_received(:process).with(1).exactly(4).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).to have_received(:new).with(MissingScrubbableModel)
       expect(ActsAsScrubbable::ArClassProcessor).not_to have_received(:new).with(NonScrubbableModel)
     end
 

data/spec/lib/acts_as_scrubbable/update_processor_spec.rb

@@ -15,5 +15,11 @@ RSpec.describe ActsAsScrubbable::UpdateProcessor do
 
       expect(subject.send(:handle_batch, [model])).to eq 1
     end
+
+    it "runs scrub callbacks" do
+      subject.send(:handle_batch, [model])
+      expect(model.scrubbing_begun).to be(true)
+      expect(model.scrubbing_finished).to be(true)
+    end
   end
-end
+end

data/spec/support/database.rb

@@ -53,3 +53,7 @@ end
 class AThirdScrubbableModel < ActiveRecord::Base
   acts_as_scrubbable :active => :boolean
 end
+
+class MissingScrubbableModel < ScrubbableModel
+  acts_as_scrubbable :last_name, :first_name => :fake_first_name
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: acts_as_scrubbable
 version: !ruby/object:Gem::Version
-  version: 2.1.3
+  version: 2.1.5
 platform: ruby
 authors:
 - Samer Masry
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-12-15 00:00:00.000000000 Z
+date: 2024-07-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -210,6 +210,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rspec_junit_formatter
+  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: ActsAsScrubbable helps you scrub your database the easy way with mock
   data at the ActiveRecord level
 email:
@@ -218,7 +232,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".github/workflows/pr-security.yaml"
+- ".circleci/config.yml"
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"

data/.github/workflows/pr-security.yaml

@@ -1,32 +0,0 @@
----
-# onemedical/<repo>/.github/workflows/pr-security.yaml
-#
-# This is the workflow for distribution to repositories across the organization.
-# It will call the reusable PR security workflow, and run scans against each PR.
-name: PR Security
-
-
-# yamllint disable-line rule:truthy
-on:
-  pull_request:
-    branches: [main, master]
-
-
-permissions:
-  # Required for workflows in private repositories.
-  contents: read
-
-  # Required for SARIF results upload to GHAS.
-  security-events: write
-  actions: read
-
-
-jobs:
-  # Run the reusable workflow.
-  run-workflow:
-    name: Run Workflow
-    # yamllint disable-line rule:line-length
-    uses: onemedical/github-reusable-workflows/.github/workflows/reusable-pr-security.yaml@main
-    # The detect-secrets tool is used in some repositories, and generates false
-    # positives like the one below. Add comment to ignore.
-    secrets: inherit  # pragma: allowlist secret