tartarus-rb 0.4.1 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2a9a2ee5b7e8889bc07acdb01d4bf1fad93cf412fe3a0109cb63ab547ccb1255
-  data.tar.gz: 4a4f1ede48123fa774e7ccbd55d1eadd19476292558f73ed09b1dee0234c2e4b
+  metadata.gz: f7669ce816882e4f9607e41afde316cbe50027291a0dd89008d3baaa9ca6b308
+  data.tar.gz: d03d89b04491a2dce92820674e94c895cac9cad706b790927aab9129f8c15b26
 SHA512:
-  metadata.gz: d59b03b2a163d831bee9766892fe59c3a19c6b771f297bbbf564d30f5c007bd94f2e96357f0ec6b30d602572b8d4de636c3124eebcba2b46f86ffabc69d545dc
-  data.tar.gz: 24a9efa3d116ed97a6113e855457a7f13ac41d8ea6669010794b973615c425ce6b1aef5fbfc327e76156b909cb52035747fe28cdc70ed4d817431a2bf34a4563
+  metadata.gz: e3906591489650a6e4f9ce9f3b0eaa17ab2a95797096abcf8bba9f50855a7463f0a2f1354017f3df512519775765e807ece44b4c75cbc2b3b3bd326f67a6ffcf
+  data.tar.gz: 48d503bc4bbea2be0196778d5dca18b9d9770cf069685128860f4567fdc1727f46042e009b43a86dc9697b217c8a6b5816a45eae1ed935f362ce63b42c2301e2

data/Changelog.md

@@ -2,6 +2,10 @@
 
 ## Master
 
+## 0.5.0
+
+- Provide ability to explicitly set the name of archivable item to have multiple ways of archiving the same model
+
 ## 0.4.1
 
 - Do not make Glacier a required dependency if not used

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    tartarus-rb (0.4.1)
+    tartarus-rb (0.5.0)
       sidekiq (>= 5)
       sidekiq-cron (~> 1)
 
@@ -57,7 +57,7 @@ GEM
     erubi (1.10.0)
     et-orbi (1.2.4)
       tzinfo
-    fugit (1.4.2)
+    fugit (1.4.5)
       et-orbi (~> 1.1, >= 1.1.8)
       raabro (~> 1.4)
     hashdiff (1.0.0)

data/README.md

@@ -82,6 +82,31 @@ end
 
 You can use the following config params:
 - `model` - a name of the ActiveReord model you want to archive, required
+- `name` - name of your strategy, optional. It fallbacks `model.to_s`. It's important to set in in cases when you have several strategies for the same model:
+```rb
+  tartarus.register do |item|
+    item.model = InternalEvent
+    item.name = "archive_account_and_user_internal_events"
+    item.cron = "5 5 * * *"
+    item.queue = "default"
+    item.tenants_range = -> { ["Account", "User"] }
+    item.tenant_id_field = :model_type
+    item.archive_items_older_than = -> { 30.days.ago }
+    item.timestamp_field = :created_at
+  end
+
+  tartarus.register do |item|
+    item.model = InternalEvent
+    item.name = "archive_post_and_comment_internal_events"
+    item.cron = "5 15 * * *"
+    item.queue = "default"
+    item.tenants_range = -> { ["Post", "Comment"] }
+    item.tenant_id_field = :model_type
+    item.archive_items_older_than = -> { 10.days.ago }
+    item.timestamp_field = :created_at
+  end
+```
+
 - `cron` - cron syntax, required
 - `queue` - name of the sidekiq queue you want to use for execution of the jobs, required
 - `tenants_range` - optional, use if you want to scope items by a tenant (or any field that can be used for partitioning). It doesn't have to be ActiveRecord collection, could be just an array. Must be a proc/lambda/object responding to `call` method. For ActvieRecord collection, `find_each` loop will be used for optimization.
@@ -91,7 +116,7 @@ You can use the following config params:
 - `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`, `delete_all_using_limit_in_batches`
 - `batch_size` - optional (defaults to `10_000`, used with `delete_all_using_limit_in_batches` strategy)
-- `remote_storage` - optional (defaults to `Tartarus::RemoteStorage::Null` which does nothing). Use this option if you want store the data somewhere before deleting it. 
+- `remote_storage` - optional (defaults to `Tartarus::RemoteStorage::Null` which does nothing). Use this option if you want store the data somewhere before deleting it.
 
 ### Remote Storage
 
@@ -171,7 +196,7 @@ class Glacier
     @configuration = configuration
   end
 
-  def store(collection, archivable_model, tenant_id: nil, tenant_id_field: nil) 
+  def store(collection, archivable_model, tenant_id: nil, tenant_id_field: nil)
   end
 end
 ```

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 batch_size remote_storage).freeze
+  OPTIONAL_ATTRIBUTES_NAMES = %i(tenants_range tenant_id_field batch_size remote_storage name).freeze
 
   attr_accessor *(REQUIRED_ATTRIBUTES_NAMES + OPTIONAL_ATTRIBUTES_NAMES)
 
@@ -51,6 +51,10 @@ class Tartarus::ArchivableItem
     @batch_size ||= 10_000
   end
 
+  def name
+    @name || @model.to_s
+  end
+
   def validate!
     validate_presence
   end
@@ -63,10 +67,6 @@ class Tartarus::ArchivableItem
     factory.for(archive_with, batch_size: batch_size)
   end
 
-  def for_model?(provided_model_name)
-    model.to_s == provided_model_name.to_s
-  end
-
   def remote_storage
     @remote_storage || Tartarus::RemoteStorage::Null
   end

data/lib/tartarus/archivable_item/sidekiq_cron_job_serializer.rb

@@ -7,7 +7,7 @@ class Tartarus
           description: description_for_item(archivable_item),
           cron: archivable_item.cron,
           class: Tartarus::Sidekiq::ScheduleArchivingModelJob,
-          args: [archivable_item.model],
+          args: [archivable_item.name],
           queue: archivable_item.queue,
           active_job: archivable_item.active_job
         }
@@ -16,7 +16,7 @@ class Tartarus
       private
 
       def name_for_item(archivable_item)
-        "TARTARUS_#{archivable_item.model}"
+        "TARTARUS_#{archivable_item.name}"
       end
 
       def description_for_item(archivable_item)

data/lib/tartarus/archive_model_with_tenant.rb

@@ -7,20 +7,20 @@ class Tartarus::ArchiveModelWithTenant
     @repository = repository
   end
 
-  def archive(model_name, tenant_id)
-    archivable_item = registry.find_by_model(model_name)
-    collection = collection_to_archive(model_name, archivable_item, tenant_id)
-    archivable_item.remote_storage.store(collection, model_name, tenant_id: tenant_id,
+  def archive(archivable_item_name, tenant_id)
+    archivable_item = registry.find_by_name(archivable_item_name)
+    collection = collection_to_archive(archivable_item, tenant_id)
+    archivable_item.remote_storage.store(collection, archivable_item.name, tenant_id: tenant_id,
       tenant_id_field: archivable_item.tenant_id_field)
     archivable_item.archive_strategy.call(collection)
   end
 
   private
 
-  def collection_to_archive(model_name, archivable_item, tenant_id)
+  def collection_to_archive(archivable_item, tenant_id)
     repository
       .items_older_than_for_tenant(
-        model_name,
+        archivable_item.model,
         archivable_item.timestamp_field, archivable_item.archive_items_older_than.call,
         archivable_item.tenant_id_field, tenant_id
       )

data/lib/tartarus/archive_model_without_tenant.rb

@@ -7,19 +7,19 @@ class Tartarus::ArchiveModelWithoutTenant
     @repository = repository
   end
 
-  def archive(model_name)
-    archivable_item = registry.find_by_model(model_name)
-    collection = collection_to_archive(model_name, archivable_item)
-    archivable_item.remote_storage.store(collection, model_name)
+  def archive(archivable_item_name)
+    archivable_item = registry.find_by_name(archivable_item_name)
+    collection = collection_to_archive(archivable_item)
+    archivable_item.remote_storage.store(collection, archivable_item.name)
     archivable_item.archive_strategy.call(collection)
   end
 
   private
 
-  def collection_to_archive(model_name, archivable_item)
+  def collection_to_archive(archivable_item)
     repository
       .items_older_than(
-        model_name,
+        archivable_item.model,
         archivable_item.timestamp_field, archivable_item.archive_items_older_than.call
       )
   end

data/lib/tartarus/rb/version.rb

@@ -1,5 +1,5 @@
 class Tartarus
   module Rb
-    VERSION = "0.4.1"
+    VERSION = "0.5.0"
   end
 end

data/lib/tartarus/registry.rb

@@ -16,8 +16,8 @@ class Tartarus::Registry
     @storage << item
   end
 
-  def find_by_model(model)
-    storage.find(->{ raise "#{model} not found in registry" }) { |item| item.for_model?(model) }
+  def find_by_name(name)
+    storage.find(->{ raise "#{name} not found in registry" }) { |item| item.name == name }
   end
 
   def reset

data/lib/tartarus/schedule_archiving_model.rb

@@ -6,15 +6,15 @@ class Tartarus::ScheduleArchivingModel
     @registry = registry
   end
 
-  def schedule(model_name)
-    archivable_item = registry.find_by_model(model_name)
+  def schedule(archivable_item_name)
+    archivable_item = registry.find_by_name(archivable_item_name)
 
     if archivable_item.scope_by_tenant?
       each_tenant(archivable_item) do |tenant|
-        enqueue(Tartarus::Sidekiq::ArchiveModelWithTenantJob, archivable_item.queue, model_name, tenant)
+        enqueue(Tartarus::Sidekiq::ArchiveModelWithTenantJob, archivable_item.queue, archivable_item.name, tenant)
       end
     else
-      enqueue(Tartarus::Sidekiq::ArchiveModelWithoutTenantJob, archivable_item.queue, model_name)
+      enqueue(Tartarus::Sidekiq::ArchiveModelWithoutTenantJob, archivable_item.queue, archivable_item.name)
     end
   end
 

data/lib/tartarus/sidekiq/archive_model_with_tenant_job.rb

@@ -4,8 +4,8 @@ class Tartarus
   class Sidekiq::ArchiveModelWithTenantJob
     include ::Sidekiq::Worker
 
-    def perform(model_name, tenant_id)
-      Tartarus::ArchiveModelWithTenant.new.archive(model_name, tenant_id)
+    def perform(archivable_item_name, tenant_id)
+      Tartarus::ArchiveModelWithTenant.new.archive(archivable_item_name, tenant_id)
     end
   end
 end

data/lib/tartarus/sidekiq/archive_model_without_tenant_job.rb

@@ -4,8 +4,8 @@ class Tartarus
   class Sidekiq::ArchiveModelWithoutTenantJob
     include ::Sidekiq::Worker
 
-    def perform(model_name)
-      Tartarus::ArchiveModelWithoutTenant.new.archive(model_name)
+    def perform(archivable_item_name)
+      Tartarus::ArchiveModelWithoutTenant.new.archive(archivable_item_name)
     end
   end
 end

data/lib/tartarus/sidekiq/schedule_archiving_model_job.rb

@@ -4,8 +4,8 @@ class Tartarus
   class Sidekiq::ScheduleArchivingModelJob
     include ::Sidekiq::Worker
 
-    def perform(model_name)
-      Tartarus::ScheduleArchivingModel.new.schedule(model_name)
+    def perform(archivable_item_name)
+      Tartarus::ScheduleArchivingModel.new.schedule(archivable_item_name)
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tartarus-rb
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.5.0
 platform: ruby
 authors:
 - Karol Galanciak
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-03-10 00:00:00.000000000 Z
+date: 2021-07-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sidekiq