activerecord-prunable 0.3.3 → 0.4.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 98eed29b171fce5713dbc74ab812c8d6ccd4531a
-  data.tar.gz: 41bf6db4104667a2eff427332acdb4f6ee1423c1
+  metadata.gz: 8dd903bc39672f786b325d8907bfba3b4ba1d47e
+  data.tar.gz: 6377d77ab1c31b4d8ee4c38cd104c8e091df35a9
 SHA512:
-  metadata.gz: 531bf56a1a4e857af793da15fb681f90d93f549671872cdfbbef07805aa30fff9a45be76d8773d9b8cf0d0a9c2a834dedaf297cc05fee59d6928c85209e04510
-  data.tar.gz: 6aeceb2f4cc5cde6fe6634b6b1efeaec7bfa2c7eaed4da293a3f35190a431fce02ee5093f11d9fac02a0f2b3a2f8384c9d10714cd39cb23eb6f4d70d05cf3b65
+  metadata.gz: 502ae14d858b2b7f0997b70e1a752d165a1e553d511772a3412cbece5ce18b0b2becbc40e0a44238e6955241fa85ca5c19527da7ba12270d355ee5be245d194f
+  data.tar.gz: 5776ff5903da67cbf0b55c2b36f6c5b4c8605e9aa5ba6570e5160541bb2322ea7d2487fb79650a4d0d006e9a36a53d3645efc826f97a0c88e00402a859a1ba70

data/Gemfile.lock

@@ -1,45 +1,47 @@
 PATH
   remote: .
   specs:
-    activerecord-prunable (0.3.2)
+    activerecord-prunable (0.4.2)
       activerecord (>= 3.0, < 6.0)
       activesupport (>= 3.0, < 6.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activemodel (4.2.10)
-      activesupport (= 4.2.10)
+    activemodel (4.2.7.1)
+      activesupport (= 4.2.7.1)
       builder (~> 3.1)
-    activerecord (4.2.10)
-      activemodel (= 4.2.10)
-      activesupport (= 4.2.10)
+    activerecord (4.2.7.1)
+      activemodel (= 4.2.7.1)
+      activesupport (= 4.2.7.1)
       arel (~> 6.0)
-    activesupport (4.2.10)
+    activesupport (4.2.7.1)
       i18n (~> 0.7)
+      json (~> 1.7, >= 1.7.7)
       minitest (~> 5.1)
       thread_safe (~> 0.3, >= 0.3.4)
       tzinfo (~> 1.1)
-    arel (6.0.4)
+    arel (6.0.3)
     builder (3.2.3)
-    diff-lcs (1.3)
-    i18n (0.8.6)
-    minitest (5.10.3)
-    rspec (3.6.0)
-      rspec-core (~> 3.6.0)
-      rspec-expectations (~> 3.6.0)
-      rspec-mocks (~> 3.6.0)
-    rspec-core (3.6.0)
-      rspec-support (~> 3.6.0)
-    rspec-expectations (3.6.0)
+    diff-lcs (1.2.5)
+    i18n (0.8.1)
+    json (1.8.6)
+    minitest (5.10.1)
+    rspec (3.5.0)
+      rspec-core (~> 3.5.0)
+      rspec-expectations (~> 3.5.0)
+      rspec-mocks (~> 3.5.0)
+    rspec-core (3.5.4)
+      rspec-support (~> 3.5.0)
+    rspec-expectations (3.5.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.6.0)
-    rspec-mocks (3.6.0)
+      rspec-support (~> 3.5.0)
+    rspec-mocks (3.5.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.6.0)
-    rspec-support (3.6.0)
+      rspec-support (~> 3.5.0)
+    rspec-support (3.5.0)
     thread_safe (0.3.6)
-    tzinfo (1.2.3)
+    tzinfo (1.2.2)
       thread_safe (~> 0.1)
 
 PLATFORMS
@@ -50,4 +52,4 @@ DEPENDENCIES
   rspec (~> 3.0)
 
 BUNDLED WITH
-   1.15.4
+   1.16.1

data/README.md

@@ -34,6 +34,10 @@ __2. Define the `:prunable` scope which returns models to prune.__
      # You can also set type of removing records (:destroy or :delete).
      # By default it's :destroy
      prune_method :delete
+     
+     # Additional method to set removing in batches.
+     # You're also able to specify batch size with number
+     batch_removal
    end
    ```
 
@@ -43,7 +47,7 @@ __2. Define the `:prunable` scope which returns models to prune.__
    class Notification < ApplicationRecord
      include ActiveRecord::Prunable
 
-      prune_after 7.days
+     prune_after 7.days
    end
    ```
 
@@ -84,6 +88,12 @@ __Set default method of pruning (:destroy or :delete):__
 Prunable.prune!(prune_method: :delete)
 ```
 
+__Batch removal:__
+```ruby
+Prunable.prune!(in_batches: true)
+```
+You're also able to specify the batch size: `Prunable.prune!(batch_size: 100)`
+
 __Call `:prunable` scope with params:__
 
 ```ruby

data/activerecord-prunable.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |spec|
   spec.name          = "activerecord-prunable"
-  spec.version       = "0.3.3"
+  spec.version       = "0.4.3"
   spec.authors       = ["dr2m"]
   spec.email         = ["maletin@maletin.work"]
 

data/lib/active_record/prunable.rb

@@ -21,7 +21,7 @@ module ActiveRecord
 
     module ClassMethods
       def prune_method(method)
-        unless check_prune_method(method)
+        unless valid_prune_method?(method)
           logger.info "Incorrect prune method #{method} has been ignored for #{self}"
           return false
         end
@@ -30,37 +30,41 @@ module ActiveRecord
         class_variable_set(:@@prune_method, method)
       end
 
-      def prune_after(duration)
-        prune_created_after(duration)
-      end
-
       def prune_created_after(duration)
         class_variable_set(:@@prune_created_after, duration)
       end
 
+      alias prune_after prune_created_after
+
       def prune_updated_after(duration)
         class_variable_set(:@@prune_updated_after, duration)
       end
 
-      def prune!(*params, prune_method: nil, current_time: nil)
+      def prune!(*params, prune_method: nil, current_time: nil, batch_size: nil, in_batches: false)
         logger.info "Pruning old records of #{self}"
-        return false unless check_scope(*params)
+        return false unless prunable_model?
 
         scope = resolve_scope(*params, current_time)
-        destroyed_records = prune_by_method(scope, prune_method)
+        batch_size ||= class_variable_get(:@@prunable_batch_size) if class_variable_defined?(:@@prunable_batch_size)
+        batch_size ||= 1000 if in_batches
+        destroyed_records = prune(scope, prune_method, batch_size)
 
-        if destroyed_records > 0
-          logger.info "#{destroyed_records} records have been removed."
-        else
+        if destroyed_records.zero?
           logger.info 'Nothing to prune.'
+        else
+          logger.info "#{destroyed_records} records have been removed."
         end
 
         destroyed_records
       end
 
+      def batch_removal(batch_size = 1000)
+        class_variable_set(:@@prunable_batch_size, batch_size)
+      end
+
       private
 
-      def check_scope(*params)
+      def prunable_model?
         pruning_means_count = [
           respond_to?(:prunable),
           class_variable_defined?(:@@prune_created_after),
@@ -83,33 +87,50 @@ module ActiveRecord
       def resolve_scope(*params, current_time)
         current_time ||= Time.current
 
-        case
-        when respond_to?(:prunable)
+        if respond_to?(:prunable)
           prunable(*params)
-        when class_variable_defined?(:@@prune_created_after)
+        elsif class_variable_defined?(:@@prune_created_after)
           where('created_at < ?', current_time - class_variable_get(:@@prune_created_after))
-        when class_variable_defined?(:@@prune_updated_after)
+        elsif class_variable_defined?(:@@prune_updated_after)
           where('updated_at < ?', current_time - class_variable_get(:@@prune_updated_after))
         end
       end
 
-      def check_prune_method(method)
+      def valid_prune_method?(method)
         %i[destroy delete].include?(method)
       end
 
-      def prune_by_method(scope, prune_method)
-        prune_method = if class_variable_defined?(:@@prune_method)
-                         class_variable_get(:@@prune_method)
-                       else
-                         prune_method || :destroy
-                       end
-
-        return false unless check_prune_method(prune_method)
+      def prune(scope, prune_method, batch_size)
+        prune_method = resolve_prune_method(prune_method)
+        return false unless valid_prune_method?(prune_method)
 
         logger.info "Prune method is #{prune_method}"
 
-        return scope.delete_all if prune_method == :delete
-        scope.destroy_all.size
+        pruner = pruner_for(prune_method)
+        return pruner.call(scope) unless batch_size
+
+        logger.info "Removing in batches, batch_size: #{batch_size}"
+
+        batch_results = scope.find_in_batches(batch_size: batch_size) do |batch|
+          batch_ids = batch.map(&:id)
+          relation = scope.model.where(id: batch_ids)
+          pruner.call(relation)
+        end
+
+        batch_results.present? ? batch_results.sum : 0
+      end
+
+      def resolve_prune_method(prune_method)
+        return class_variable_get(:@@prune_method) if class_variable_defined?(:@@prune_method)
+        prune_method || :destroy
+      end
+
+      def pruner_for(prune_method)
+        if prune_method == :delete
+          :delete_all.to_proc
+        else
+          ->(scope) { scope.destroy_all.size }
+        end
       end
     end
   end

data/lib/activerecord-prunable.rb

@@ -11,29 +11,47 @@ module Prunable
       ActiveRecord::Prunable.includes
     end
 
-    def prune!(*models, prune_method: nil, current_time: nil, params: [])
-      models = self.models if models.empty?
+    def prune!(*args)
+      models, params = resolve_args(args)
 
       models.each_with_object({}) do |model, pruned|
-        pruned[model.table_name] = model.prune!(*params, prune_method: prune_method, current_time: current_time)
+        pruned[model.table_name] = prune_model!(model, params)
       end
     end
 
-    def prune(*models, prune_method: nil, current_time: nil, params: [])
-      models = self.models if models.empty?
+    def prune(*args)
+      models, params = resolve_args(args)
 
       pruned = {}
       errors = []
 
       models.each do |model|
         begin
-          pruned[model.table_name] = model.prune!(*params, prune_method: prune_method, current_time: current_time)
-        rescue => e
+          pruned[model.table_name] = prune_model!(model, params)
+        rescue StandardError => e
           errors << e
         end
       end
 
       [pruned, errors]
     end
+
+    private
+
+    def resolve_args(args)
+      params = args.last.is_a?(Hash) ? args.pop : {}
+      models = args.any? ? args : self.models
+      [models, params]
+    end
+
+    def prune_model!(model, prune_method: nil, current_time: nil, params: [], batch_size: nil, in_batches: false)
+      model.prune!(
+        *params,
+        prune_method: prune_method,
+        current_time: current_time,
+        batch_size: batch_size,
+        in_batches: in_batches
+      )
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: activerecord-prunable
 version: !ruby/object:Gem::Version
-  version: 0.3.3
+  version: 0.4.3
 platform: ruby
 authors:
 - dr2m
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-12-13 00:00:00.000000000 Z
+date: 2018-02-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec