tartarus-rb 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ff59ebb52771abf8d4f7725d842592c3b5cb9c62e9a2dd263bdce6e4ef433fdf
-  data.tar.gz: a34ed59c2f0d5fd405e1b55a8537cd91d10f55782e4884c22fc327dfa5eca324
+  metadata.gz: ffb5cafa941ec43d2c07a6745ef9b75b91c31784649bbf04187e90f6960812e0
+  data.tar.gz: 9615766c2064a4e127c836ca4cf6ad9b0f2925d08246e4486b9f9fd382884e4f
 SHA512:
-  metadata.gz: 76f1a2a3567fb8eaacdf244c0ced23d41ac8eb98a5a52e3ce83a48c0650ac6ad0156947665611401d70598502bd4c7ede9c4b4e8729a052c69122260a99c7a0b
-  data.tar.gz: 0a985afc6e833ef31f08a70b3e4f4479c47b2763ce9266e77eafe6a47cf639d2ae47485a662f71bc8b1fcc09909a7682581aef39a3b93628b183769ad2a8f990
+  metadata.gz: a97481429cc2c5faa977d75baae80c78e17f56cfa0323b76e613a91a57586bbfb6890442e340b7d9aff88eb7a155f694174109a92317d77e7b8c4c367224ae50
+  data.tar.gz: 143dc43864c453873d6154f52d1504eff11f0f88e406e69893fd62937ea8b59899e4c1fdd344adc65fab4e4d6f15c8dcee4cd5c09c14e86a19d47be2e17d403d

data/.gitignore

@@ -6,6 +6,7 @@
 /pkg/
 /spec/reports/
 /tmp/
+/spec/test.db
 
 # rspec failure tracking
 .rspec_status

data/Changelog.md

@@ -1,4 +1,9 @@
 # Changelog
 
+## 0.2.0
+- Add support for deleting and destroying in batches
+- Add integration tests with a real database and ActiveRecord
+- Better docs
+
 ## 0.1.0
 - Initial release

data/Gemfile.lock

@@ -1,21 +1,35 @@
 PATH
   remote: .
   specs:
-    tartarus-rb (0.1.0)
+    tartarus-rb (0.2.0)
       sidekiq (>= 5)
       sidekiq-cron (~> 1)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    activemodel (6.1.0.rc1)
+      activesupport (= 6.1.0.rc1)
+    activerecord (6.1.0.rc1)
+      activemodel (= 6.1.0.rc1)
+      activesupport (= 6.1.0.rc1)
+    activesupport (6.1.0.rc1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
     concurrent-ruby (1.1.7)
     connection_pool (2.2.3)
     diff-lcs (1.4.4)
     et-orbi (1.2.4)
       tzinfo
-    fugit (1.3.9)
+    fugit (1.4.0)
       et-orbi (~> 1.1, >= 1.1.8)
-      raabro (~> 1.3)
+      raabro (~> 1.4)
+    i18n (1.8.5)
+      concurrent-ruby (~> 1.0)
+    minitest (5.14.2)
     raabro (1.4.0)
     rack (2.2.3)
     rake (13.0.1)
@@ -43,16 +57,20 @@ GEM
     sidekiq-cron (1.2.0)
       fugit (~> 1.1)
       sidekiq (>= 4.2.1)
+    sqlite3 (1.4.2)
     tzinfo (2.0.2)
       concurrent-ruby (~> 1.0)
+    zeitwerk (2.4.1)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
+  activerecord (~> 6)
   rake (~> 13.0)
   rspec (~> 3.0)
   rspec-sidekiq
+  sqlite3
   tartarus-rb!
 
 BUNDLED WITH

data/README.md

@@ -43,6 +43,7 @@ if File.exist?(schedule_file) && Sidekiq.server?
     item.tenant_id_field = :account_uuid
     item.archive_items_older_than = -> { 30.days.ago }
     item.timestamp_field = :created_at
+    item.archive_with = :destroy_all
   end
 
   tartarus.register do |item|
@@ -77,6 +78,17 @@ You can use the following config params:
 - `tenant_id_field` - required when using tenant_value_source/tenant_value_source. It's a DB column that will be used for scoping records by a tenant. For example, here it would be: `ModelThatYouWantToArchive.where(account_uuid: value_of_uuid_from_some_active_account)`
 - `archive_items_older_than` - required, for defining retention policy
 - `timestamp_field` - required, used for performing a query using the value from `archive_items_older_than`
+- `archive_with` - optional (defaults to `delete_all`). Could be `delete_all`, `destroy_all`, `delete_all_without_batches`, `destroy_all_without_batches`
+
+### Testing before actually using it
+
+You might want to verify that the gem works in the way you expect it to work. For that, you will be mostly interested in 2 usecases:
+
+1. scheduling/enqueueing: use `Tartarus::ScheduleArchivingModel#schedule` - for example, `Tartarus::ScheduleArchivingModel.new.schedule("PaperTrailVersion")`, it's going to enqueue either `Tartarus::Sidekiq::ArchiveModelWithTenantJob` or `Tartarus::Sidekiq::ArchiveModelWithoutTenantJob`, depending on the config.
+2. execution of the archiving logic: use `Tartarus::ArchiveModelWithTenant#archive` (for example, `Tartarus::ArchiveModelWithTenant.new.archive("PaperTrailVersion", "User")`) or `Tartarus::ArchiveModelWithoutTenant#archive` (for example, `Tartarus::ArchiveModelWithoutTenant.new.archive("PaperTrailVersion")`)
+
+
+You might also want to check `spec/integration` to get an idea how the integration tests were written.
 
 ## Development
 

data/lib/tartarus.rb

@@ -3,7 +3,10 @@ require "tartarus/archivable_item"
 require "tartarus/archivable_item/sidekiq_cron_job_serializer"
 require "tartarus/archive_strategy"
 require "tartarus/archive_strategy/delete_all"
+require "tartarus/archive_strategy/delete_all_without_batches"
 require "tartarus/archive_strategy/destroy_all"
+require "tartarus/archive_strategy/destroy_all_without_batches"
+require "tartarus/archive_strategy/extract_batch"
 require "tartarus/sidekiq"
 require "tartarus/sidekiq/archive_model_with_tenant_job"
 require "tartarus/sidekiq/archive_model_without_tenant_job"

data/lib/tartarus/archivable_collection_repository.rb

@@ -25,7 +25,7 @@ class Tartarus
     private
 
     def collection_for(model_name)
-      const_resolver.const_get(model_name)
+      const_resolver.const_get(model_name.to_s)
     end
 
     def ensure_column_exists(collection, model_name, column)

data/lib/tartarus/archive_strategy.rb

@@ -5,6 +5,10 @@ class Tartarus::ArchiveStrategy
       Tartarus::ArchiveStrategy::DeleteAll.new
     when :destroy_all
       Tartarus::ArchiveStrategy::DestroyAll.new
+    when :delete_all_without_batches
+      Tartarus::ArchiveStrategy::DeleteAllWithoutBatches.new
+    when :destroy_all_without_batches
+      Tartarus::ArchiveStrategy::DestroyAllWithoutBatches.new
     else
       raise "unknown strategy: #{strategy_name}"
     end

data/lib/tartarus/archive_strategy/delete_all.rb

@@ -2,7 +2,9 @@ class Tartarus
   class ArchiveStrategy
     class DeleteAll
       def call(collection)
-        collection.delete_all
+        Tartarus::ArchiveStrategy::ExtractBatch.new.call(collection) do |batch|
+          batch.delete_all
+        end
       end
     end
   end

data/lib/tartarus/archive_strategy/delete_all_without_batches.rb

@@ -0,0 +1,9 @@
+class Tartarus
+  class ArchiveStrategy
+    class DeleteAllWithoutBatches
+      def call(collection)
+        collection.delete_all
+      end
+    end
+  end
+end

data/lib/tartarus/archive_strategy/destroy_all.rb

@@ -2,7 +2,9 @@ class Tartarus
   class ArchiveStrategy
     class DestroyAll
       def call(collection)
-        collection.destroy_all
+        Tartarus::ArchiveStrategy::ExtractBatch.new.call(collection) do |batch|
+          batch.destroy_all
+        end
       end
     end
   end

data/lib/tartarus/archive_strategy/destroy_all_without_batches.rb

@@ -0,0 +1,9 @@
+class Tartarus
+  class ArchiveStrategy
+    class DestroyAllWithoutBatches
+      def call(collection)
+        collection.destroy_all
+      end
+    end
+  end
+end

data/lib/tartarus/archive_strategy/extract_batch.rb

@@ -0,0 +1,28 @@
+class Tartarus
+  class ArchiveStrategy
+    class ExtractBatch
+      attr_reader :config
+      private     :config
+
+      def initialize(config: Thread.current)
+        @config = config
+      end
+
+      def call(collection)
+        if collection.respond_to?(:in_batches) && !suppressed_in_batches?
+          yield collection.in_batches
+        else
+          primary_key = collection.primary_key
+
+          collection.select(primary_key).find_in_batches do |group|
+            yield collection.where(primary_key => group)
+          end
+        end
+      end
+
+      def suppressed_in_batches?
+        !!config["__TARTARUS__SUPPRESSED_IN_BATCHES"]
+      end
+    end
+  end
+end

data/lib/tartarus/rb/version.rb

@@ -1,5 +1,5 @@
 class Tartarus
   module Rb
-    VERSION = "0.1.0"
+    VERSION = "0.2.0"
   end
 end

data/lib/tartarus/schedule_archiving_model.rb

@@ -24,9 +24,7 @@ class Tartarus::ScheduleArchivingModel
     collection = archivable_item.tenants_range.call
 
     if collection.respond_to?(:find_each)
-      archivable_item.tenants_range
-        .call
-        .find_each { |element| yield element.public_send(archivable_item.tenant_value_source) }
+      collection.find_each { |element| yield element.public_send(archivable_item.tenant_value_source) }
     else
       collection.each { |element| yield element }
     end

data/tartarus-rb.gemspec

@@ -33,4 +33,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake", "~> 13.0"
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "rspec-sidekiq"
+
+  spec.add_development_dependency "activerecord", "~> 6"
+  spec.add_development_dependency "sqlite3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tartarus-rb
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Karol Galanciak
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-10-21 00:00:00.000000000 Z
+date: 2020-11-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sidekiq
@@ -80,6 +80,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  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: A gem for archving (deleting) old records you no longer need. Send them
   straight to tartarus!
 email:
@@ -108,7 +136,10 @@ files:
 - lib/tartarus/archive_model_without_tenant.rb
 - lib/tartarus/archive_strategy.rb
 - lib/tartarus/archive_strategy/delete_all.rb
+- lib/tartarus/archive_strategy/delete_all_without_batches.rb
 - lib/tartarus/archive_strategy/destroy_all.rb
+- lib/tartarus/archive_strategy/destroy_all_without_batches.rb
+- lib/tartarus/archive_strategy/extract_batch.rb
 - lib/tartarus/rb.rb
 - lib/tartarus/rb/version.rb
 - lib/tartarus/registry.rb
@@ -139,7 +170,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.1.2
 signing_key:
 specification_version: 4
 summary: A gem for archving (deleting) old records you no longer need. Send them straight