tartarus-rb 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ffb5cafa941ec43d2c07a6745ef9b75b91c31784649bbf04187e90f6960812e0
-  data.tar.gz: 9615766c2064a4e127c836ca4cf6ad9b0f2925d08246e4486b9f9fd382884e4f
+  metadata.gz: f1336e4444881135833d1d1784514a523a9abce37fe911683398b3f2b2bac0c6
+  data.tar.gz: 82ec19e8f7ea7bde9df2d8d9c75c218f152832bfb977963489e07e3ffbff6cb3
 SHA512:
-  metadata.gz: a97481429cc2c5faa977d75baae80c78e17f56cfa0323b76e613a91a57586bbfb6890442e340b7d9aff88eb7a155f694174109a92317d77e7b8c4c367224ae50
-  data.tar.gz: 143dc43864c453873d6154f52d1504eff11f0f88e406e69893fd62937ea8b59899e4c1fdd344adc65fab4e4d6f15c8dcee4cd5c09c14e86a19d47be2e17d403d
+  metadata.gz: 13139b7f8b5d5397cd0bd5d7104ed676c26345197875824eab50b7eebd3a50a4a983e44c73788da33490c2f5ba610422b643104c55e23b004817a016c4d56f44
+  data.tar.gz: 4622b5a42e74f7802e27f8bcb48959f9d6957a334ec7647f184b85bc09736718fc1e653da2a416d5c8d08417372eebeb89f869b099bb732085fffaa86fbb9506

data/Changelog.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## 0.3.0
+
+- Add `delete_all_using_limit_in_batches` strategy
+
 ## 0.2.0
 - Add support for deleting and destroying in batches
 - Add integration tests with a real database and ActiveRecord

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    tartarus-rb (0.2.0)
+    tartarus-rb (0.3.0)
       sidekiq (>= 5)
       sidekiq-cron (~> 1)
 
@@ -24,7 +24,7 @@ GEM
     diff-lcs (1.4.4)
     et-orbi (1.2.4)
       tzinfo
-    fugit (1.4.0)
+    fugit (1.4.1)
       et-orbi (~> 1.1, >= 1.1.8)
       raabro (~> 1.4)
     i18n (1.8.5)

data/README.md

@@ -78,7 +78,8 @@ 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`
+- `archive_with` - optional (defaults to `delete_all`). Could be `delete_all`, `destroy_all`, `delete_all_without_batches`, `destroy_all_without_batches`, `delete_all_using_limit_in_batches`
+- `batch_size` - optional (defaults to `10_000`, used with `delete_all_using_limit_in_batches` strategy)
 
 ### Testing before actually using it
 

data/lib/tartarus.rb

@@ -4,6 +4,7 @@ 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/delete_all_using_limit_in_batches"
 require "tartarus/archive_strategy/destroy_all"
 require "tartarus/archive_strategy/destroy_all_without_batches"
 require "tartarus/archive_strategy/extract_batch"

data/lib/tartarus/archivable_collection_repository.rb

@@ -13,6 +13,7 @@ class Tartarus
       ensure_column_exists(collection, model_name, tenant_id_field)
 
       collection.where("#{timestamp_field} < ?", timestamp).where(tenant_id_field => tenant_id)
+                .order(tenant_id_field, timestamp_field)
     end
 
     def items_older_than(model_name, timestamp_field, timestamp)

data/lib/tartarus/archivable_item.rb

@@ -1,7 +1,7 @@
 class Tartarus::ArchivableItem
   REQUIRED_ATTRIBUTES_NAMES = %i(model cron queue archive_items_older_than timestamp_field active_job
     archive_with tenant_value_source).freeze
-  OPTIONAL_ATTRIBUTES_NAMES = %i(tenants_range tenant_id_field).freeze
+  OPTIONAL_ATTRIBUTES_NAMES = %i(tenants_range tenant_id_field batch_size).freeze
 
   attr_accessor *(REQUIRED_ATTRIBUTES_NAMES + OPTIONAL_ATTRIBUTES_NAMES)
 
@@ -45,6 +45,12 @@ class Tartarus::ArchivableItem
     @archive_with ||= :delete_all
   end
 
+  def batch_size
+    return @batch_size if defined?(@batch_size)
+
+    @batch_size ||= 10_000
+  end
+
   def validate!
     validate_presence
   end
@@ -54,7 +60,7 @@ class Tartarus::ArchivableItem
   end
 
   def archive_strategy(factory: Tartarus::ArchiveStrategy.new)
-    factory.for(archive_with)
+    factory.for(archive_with, batch_size: batch_size)
   end
 
   def for_model?(provided_model_name)

data/lib/tartarus/archive_strategy.rb

@@ -1,5 +1,5 @@
 class Tartarus::ArchiveStrategy
-  def for(strategy_name)
+  def for(strategy_name, batch_size: 0)
     case strategy_name.to_sym
     when :delete_all
       Tartarus::ArchiveStrategy::DeleteAll.new
@@ -9,6 +9,8 @@ class Tartarus::ArchiveStrategy
       Tartarus::ArchiveStrategy::DeleteAllWithoutBatches.new
     when :destroy_all_without_batches
       Tartarus::ArchiveStrategy::DestroyAllWithoutBatches.new
+    when :delete_all_using_limit_in_batches
+      Tartarus::ArchiveStrategy::DeleteAllUsingLimitInBatches.new(batch_size: batch_size)
     else
       raise "unknown strategy: #{strategy_name}"
     end

data/lib/tartarus/archive_strategy/delete_all_using_limit_in_batches.rb

@@ -0,0 +1,20 @@
+class Tartarus
+  class ArchiveStrategy
+    class DeleteAllUsingLimitInBatches
+      attr_reader :batch_size
+      private     :batch_size
+
+      def initialize(batch_size:)
+        @batch_size = batch_size
+      end
+
+      def call(collection)
+        num = 1
+
+        while num > 0
+          num = collection.limit(batch_size).delete_all
+        end
+      end
+    end
+  end
+end

data/lib/tartarus/rb/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tartarus-rb
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Karol Galanciak
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-11-04 00:00:00.000000000 Z
+date: 2021-01-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sidekiq
@@ -136,6 +136,7 @@ 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_using_limit_in_batches.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