activerecord-prunable 0.2.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7c50d3e6673eb120db96d247c7d868fc3c5d33f8
-  data.tar.gz: 9eb272a6c3208b92cbc3fe434e73b7b4172c493e
+  metadata.gz: 97a945f1fcb57b06d59c5153a1e134a91c38c76f
+  data.tar.gz: e32147dd1b243909a3fb972516ff22ff9c291d23
 SHA512:
-  metadata.gz: ec970da67f57befaa9fe22bd85cc67dc2a6cdc72d92dc1867f7a84d018210acc9f551dbba83891d4fb7e6590ba25f47cd7e0e5d4112db514a16fde872e6a9c68
-  data.tar.gz: 5d16df66278b8faabab8c6af9a960647e32b2d5834ac811147c777112771e2a8a561b0fd2ff7ff9ee591e938d5de83a10b49904198984d0a4312008d60efa8ce
+  metadata.gz: f27076f89b6decfa04c070d7cc6145b6e9c54c7c71a4903d82d6f8f8cc126eb0f5f3334252cc18cef590475acfd8410d2433594d0aa0793f6ed0a86354679a5b
+  data.tar.gz: 6dc95f9b93600595fe7188207d7c9aead81e3acef805fc2d98602bcc32bd5c2fb9e185ef789bccb9312b588d11b5e3709c38bdc65ccebb90d28db0aa3bfe2427

data/Gemfile.lock

@@ -8,41 +8,39 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activemodel (4.2.7.1)
-      activesupport (= 4.2.7.1)
+    activemodel (4.2.10)
+      activesupport (= 4.2.10)
       builder (~> 3.1)
-    activerecord (4.2.7.1)
-      activemodel (= 4.2.7.1)
-      activesupport (= 4.2.7.1)
+    activerecord (4.2.10)
+      activemodel (= 4.2.10)
+      activesupport (= 4.2.10)
       arel (~> 6.0)
-    activesupport (4.2.7.1)
+    activesupport (4.2.10)
       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.3)
-    builder (3.2.2)
-    byebug (9.0.5)
-    diff-lcs (1.2.5)
-    i18n (0.7.0)
-    json (1.8.3)
-    minitest (5.9.0)
-    rspec (3.5.0)
-      rspec-core (~> 3.5.0)
-      rspec-expectations (~> 3.5.0)
-      rspec-mocks (~> 3.5.0)
-    rspec-core (3.5.3)
-      rspec-support (~> 3.5.0)
-    rspec-expectations (3.5.0)
+    arel (6.0.4)
+    builder (3.2.3)
+    byebug (9.1.0)
+    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.0, < 2.0)
-      rspec-support (~> 3.5.0)
-    rspec-mocks (3.5.0)
+      rspec-support (~> 3.6.0)
+    rspec-mocks (3.6.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.5.0)
-    rspec-support (3.5.0)
-    thread_safe (0.3.5)
-    tzinfo (1.2.2)
+      rspec-support (~> 3.6.0)
+    rspec-support (3.6.0)
+    thread_safe (0.3.6)
+    tzinfo (1.2.3)
       thread_safe (~> 0.1)
 
 PLATFORMS
@@ -54,4 +52,4 @@ DEPENDENCIES
   rspec (~> 3.0)
 
 BUNDLED WITH
-   1.13.1
+   1.15.4

data/README.md

@@ -1,27 +1,31 @@
-[![Gem Version](https://badge.fury.io/rb/activerecord-prunable.svg)](https://badge.fury.io/rb/activerecord-prunable) [![Build Status](https://travis-ci.org/dr2m/activerecord-prunable.svg?branch=master)](https://travis-ci.org/dr2m/activerecord-prunable) [![Code Climate](https://codeclimate.com/github/dr2m/activerecord-prunable/badges/gpa.svg)](https://codeclimate.com/github/dr2m/activerecord-prunable)   
-
-# Description
+# Activerecord-prunable [![Gem Version](https://badge.fury.io/rb/activerecord-prunable.svg)](https://badge.fury.io/rb/activerecord-prunable) [![Build Status](https://travis-ci.org/dr2m/activerecord-prunable.svg?branch=master)](https://travis-ci.org/dr2m/activerecord-prunable) [![Code Climate](https://codeclimate.com/github/dr2m/activerecord-prunable/badges/gpa.svg)](https://codeclimate.com/github/dr2m/activerecord-prunable)  
 
 Convenient removal of obsolete ActiveRecord models.
 
-# Installation
+## Installation
 
-```ruby
-# Gemfile
+Add this line to your application's Gemfile:
 
-gem "activerecord-prunable"
+```ruby
+gem 'activerecord-prunable'
 ```
 
-# Usage
+And then execute:
 
-1. Include the `Prunable` module in the ActiveRecord model that needs to be pruned.
-2. Define the `:prunable` scope that returns models to prune.
+    $ bundle
 
-   Example:
+Or install it yourself as:
+
+    $ gem install activerecord-prunable
+
+
+## Usage
+
+1. Include the `Prunable` module in the ActiveRecord model which needs to be pruned.
+2. Define the `:prunable` scope which returns models to prune.
 
    ```ruby
    class Notification < ApplicationRecord
-
      include ActiveRecord::Prunable
 
      scope :prunable, -> { where("created_at > ?", 1.month.ago) }
@@ -29,10 +33,23 @@ gem "activerecord-prunable"
      # You can also set type of removing records (:destroy or :delete).
      # By default it's :destroy
      prune_method :delete
+   end
+   ```
+
+   or use one of the `prune_after`, `prune_created_after`, `prune_updated_after` methods  
 
+   ```ruby
+   class Notification < ApplicationRecord
+     include ActiveRecord::Prunable
+
+      prune_after 7.days
    end
    ```
 
+   `prune_after` is an alias for `prune_created_after`  
+   `prune_created_after(TTL)` defines `where('created_at < ?', current_time - TTL)` prunable scope  
+   `prune_updated_after(TTL)` defines `where('updated_at < ?', current_time - TTL)` prunable scope  
+
 3. Add a `Prunable.prune!` call to a periodic task.
 
    Example:
@@ -43,39 +60,41 @@ gem "activerecord-prunable"
    every(1.day, 'models.prune', at: '04:20', thread: true) { Prunable.prune! }
    ```
 
+   You can also inject current time `Prunable.prune!(current_time: Time.current)`
+
 # Advanced Usage
 
-Pruning a single model:
+__Pruning a single model:__
 
 ```ruby
 SomeModel.prune!
 ```
 
-Pruning multiple models:
+__Pruning multiple models:__  
+Note that the `Prunable.prune!` calls `Rails.application.eager_load!`. It can decrease free memory size.  
 
 ```ruby
 Prunable.prune!(SomeModel, AnotherModel)
 ```
 
-Set default method of pruning (:destroy or :delete):
+__Set default method of pruning (:destroy or :delete):__  
 
 ```ruby
 Prunable.prune!(prune_method: :delete)
 ```
 
-Call `:prunable` scope with params:
+__Call `:prunable` scope with params:__  
 
 ```ruby
 Prunable.prune!(params: [:foo, :bar])
 ```
 
-Getting an array of all models that include `ActiveRecord::Prunable`:
-
+__Getting an array of all the models which include `ActiveRecord::Prunable`:__  
 ```ruby
 Prunable.models
 ```
 
-Pruning all models that include `ActiveRecord::Prunable`:
+__Pruning all models which include `ActiveRecord::Prunable`:__  
 
 ```ruby
 Prunable.prune!

data/activerecord-prunable.gemspec

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

data/lib/active_record/prunable.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'active_support'
 require 'active_record'
 
@@ -19,68 +21,95 @@ module ActiveRecord
 
     module ClassMethods
       def prune_method(method)
-        return false unless check_prune_method(method)
+        unless check_prune_method(method)
+          logger.info "Incorrect prune method #{method} has been ignored for #{self}"
+          return false
+        end
 
         logger.info "Prune method #{method} has been set for #{self}"
         class_variable_set(:@@prune_method, method)
       end
 
-      def prune!(*params, prune_method: nil)
+      def prune_after(duration)
+        prune_created_after(duration)
+      end
+
+      def prune_created_after(duration)
+        class_variable_set(:@@prune_created_after, duration)
+      end
+
+      def prune_updated_after(duration)
+        class_variable_set(:@@prune_updated_after, duration)
+      end
+
+      def prune!(*params, prune_method: nil, current_time: nil)
         logger.info "Pruning old records of #{self}"
         return false unless check_scope(*params)
 
-        scope = prunable(*params)
-        destroyed = prune_by_method(scope, prune_method)
+        scope = resolve_scope(*params, current_time)
+        destroyed_records = prune_by_method(scope, prune_method)
 
-        if destroyed > 0
-          logger.info "#{destroyed} records have been pruned."
+        if destroyed_records > 0
+          logger.info "#{destroyed_records} records have been removed."
         else
-          logger.info "Nothing to prune."
+          logger.info 'Nothing to prune.'
         end
 
-        destroyed
+        destroyed_records
       end
 
       private
 
       def check_scope(*params)
-        unless respond_to?(:prunable)
-          logger.info "This model has no :prunable scope, nothing to prune."
+        pruning_means_count = [
+          respond_to?(:prunable),
+          class_variable_defined?(:@@prune_created_after),
+          class_variable_defined?(:@@prune_updated_after)
+        ].count(true)
+
+        if pruning_means_count.zero?
+          logger.info "The model hasn't got prunable scope or TTL, action is not allowed."
           return false
         end
 
-        unless prunable(*params).is_a?(::ActiveRecord::Relation)
-          logger.info ":prunable is not a relation, nothing to prune."
+        if pruning_means_count > 1
+          logger.info 'Ambiguity detected, action is not allowed.'
           return false
         end
 
         true
       end
 
-      def check_prune_method(method)
-        unless [:destroy, :delete].include?(method)
-          logger.info "Incorrect prune method #{method} will be ignored for #{self}"
-          return false
+      def resolve_scope(*params, current_time)
+        current_time ||= Time.current
+
+        case
+        when respond_to?(:prunable)
+          prunable(*params)
+        when class_variable_defined?(:@@prune_created_after)
+          where('created_at < ?', current_time - class_variable_get(:@@prune_created_after))
+        when class_variable_defined?(:@@prune_updated_after)
+          where('updated_at < ?', current_time - class_variable_get(:@@prune_updated_after))
         end
-        true
+      end
+
+      def check_prune_method(method)
+        %i[destroy delete].include?(method)
       end
 
       def prune_by_method(scope, prune_method)
-        unless class_variable_defined?(:@@prune_method)
-          prune_method = prune_method || :destroy
-        else
-          prune_method = class_variable_get(:@@prune_method)
-        end
+        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)
 
         logger.info "Prune method is #{prune_method}"
 
-        if prune_method == :delete
-          scope.delete_all
-        else
-          scope.destroy_all.size
-        end
+        return scope.delete_all if prune_method == :delete
+        scope.destroy_all.size
       end
     end
   end

data/lib/activerecord-prunable.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'active_record/prunable'
 
 module Prunable
@@ -11,6 +13,7 @@ module Prunable
 
     def prune!(*models, prune_method: nil, params: [])
       models = self.models if models.empty?
+
       models.each do |model|
         model.prune!(*params, prune_method: prune_method)
       end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: activerecord-prunable
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.0
 platform: ruby
 authors:
 - dr2m
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-09-24 00:00:00.000000000 Z
+date: 2017-10-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -115,7 +115,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.6
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Convenient removal of obsolete ActiveRecord models.