activerecord-prunable 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 45b9f545fee642c67289799871a2d5da4054d84c
+  data.tar.gz: 5f1ee266dd3ede0271215b9fb0461d8c03d4ebbc
+SHA512:
+  metadata.gz: eb2e391664238c813f99c1741c43a060c5d9970f72b770079acceeba8bba911fe9ce2a4695cc6a82663a5e93307782c52ee618ea3354be9481b231bc6af7dfdc
+  data.tar.gz: b6d61ba7d11befb1d65bbda2e61be368ea638f3cd6c3ccc85d3302dd502567edd8a8b1764aec5c2d61ca1081f18276488487ea48fdd249977e76d930aaa5c729

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in pruner.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,55 @@
+PATH
+  remote: .
+  specs:
+    activerecord-prunable (0.1.0)
+      activerecord
+      activesupport
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (4.2.6)
+      activesupport (= 4.2.6)
+      builder (~> 3.1)
+    activerecord (4.2.6)
+      activemodel (= 4.2.6)
+      activesupport (= 4.2.6)
+      arel (~> 6.0)
+    activesupport (4.2.6)
+      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)
+    diff-lcs (1.2.5)
+    i18n (0.7.0)
+    json (1.8.3)
+    minitest (5.9.0)
+    rspec (3.4.0)
+      rspec-core (~> 3.4.0)
+      rspec-expectations (~> 3.4.0)
+      rspec-mocks (~> 3.4.0)
+    rspec-core (3.4.4)
+      rspec-support (~> 3.4.0)
+    rspec-expectations (3.4.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-mocks (3.4.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-support (3.4.1)
+    thread_safe (0.3.5)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord-prunable!
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.12.5

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 n.maletin
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,64 @@
+# Description
+
+Convenient removal of obsolete ActiveRecord models.
+
+# Installation
+
+```ruby
+# Gemfile
+
+gem "activerecord-prunable"
+```
+
+# Usage
+
+1. Include the `Prunable` module in the ActiveRecord model that needs to be pruned.
+2. Define the `:prunable` scope that returns models to prune.
+
+   Example:
+
+   ```ruby
+   class Notification < ApplicationRecord
+
+     include ActiveRecord::Prunable
+
+     scope :prunable, -> { where("created_at > ?", 1.month.ago) }
+
+   end
+   ```
+
+3. Add a `Prunable.prune!` call to a periodic task.
+
+   Example:
+
+   ```ruby
+   # clockwork configuration file
+
+   every(1.day, 'models.prune', at: '04:20', thread: true) { Prunable.prune! }
+   ```
+
+# Advanced Usage
+
+Pruning a single model:
+
+```ruby
+SomeModel.prune!
+```
+
+Pruning multiple models:
+
+```ruby
+Prunable.prune!(SomeModel, AnotherModel)
+```
+
+Getting an array of all models that include `ActiveRecord::Prunable`:
+
+```ruby
+Prunable.models
+```
+
+Pruning all models that include `ActiveRecord::Prunable`:
+
+```ruby
+Prunable.prune!
+```

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/activerecord-prunable.gemspec

@@ -0,0 +1,16 @@
+Gem::Specification.new do |spec|
+  spec.name          = "activerecord-prunable"
+  spec.version       = "0.1.1"
+  spec.authors       = ["dr2m"]
+  spec.email         = ["maletin@maletin.work"]
+
+  spec.summary       = "Convenient removal of obsolete ActiveRecord models."
+  spec.license       = "MIT"
+
+  spec.files         = Dir.glob('**/*').reject{|f| f.match(%r{^(spec)/}) }
+
+  spec.add_development_dependency "rspec", "~> 3.0"
+
+  spec.add_dependency "activerecord"
+  spec.add_dependency "activesupport"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "prunable"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/active_record/prunable.rb

@@ -0,0 +1,46 @@
+require 'active_support'
+require 'active_record'
+
+module ActiveRecord
+  module Prunable
+    extend ActiveSupport::Concern
+
+    @@models = []
+
+    class << self
+      def included(model)
+        @@models << model
+      end
+
+      def includes
+        @@models
+      end
+    end
+
+    module ClassMethods
+      def prune!
+        logger.info "Pruning old records of #{self}"
+
+        unless respond_to?(:prunable)
+          logger.info "This model has no :prunable scope, nothing to prune."
+          return
+        end
+
+        unless prunable.is_a?(::ActiveRecord::Relation)
+          logger.info ":prunable is not a relation, nothing to prune."
+          return
+        end
+
+        destroyed = prunable.destroy_all
+
+        if destroyed.any?
+          logger.info "#{destroyed.size} records have been pruned."
+        else
+          logger.info "Nothing to prune."
+        end
+
+        destroyed
+      end
+    end
+  end
+end

data/lib/activerecord-prunable.rb

@@ -0,0 +1,17 @@
+require 'active_record/prunable'
+
+module Prunable
+  @@eager_load = nil
+
+  class << self
+    def models
+      @@eager_load ||= Rails.application.eager_load!
+      ActiveRecord::Prunable.includes
+    end
+
+    def prune!(*models)
+      models = self.models if models.empty?
+      models.each(&:prune!)
+    end
+  end
+end

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification
+name: activerecord-prunable
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- dr2m
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-07-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- maletin@maletin.work
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- activerecord-prunable.gemspec
+- bin/console
+- bin/setup
+- lib/active_record/prunable.rb
+- lib/activerecord-prunable.rb
+homepage: 
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Convenient removal of obsolete ActiveRecord models.
+test_files: []
+has_rdoc: