active_archive 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ec93dcaf2dd6ab61b15e9eb92855956144bfadf3
+  data.tar.gz: 31fa6290e019bb71d717fdc8d0a6051d19e760f0
+SHA512:
+  metadata.gz: ebb06526a83603e60d51f9d64d6dc9995ae8856ade8ecc5ae55fd5060a03c05daf111e8a4c86192c692d1ff2f710ba314792bc0ec45c504815c8a77f7d9d27f0
+  data.tar.gz: 07044a0805397f2732b6fc68f2e357300efd121e9f8a9fc952291fe4a6a0b30c75469727e9ac3359a34b8909ecf3e8ca89f166d076dacf5c87b6c172a3ddbe60

data/.coveralls.yml

@@ -0,0 +1 @@
+service_name: travis-ci

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,4 @@
+--backtrace
+--color
+--format progress
+--order random

data/.travis.yml

@@ -0,0 +1,13 @@
+before_install:
+  - sudo apt-get install libxml2-dev
+cache: bundler
+language: ruby
+notifications:
+  email:
+    recipients:
+      - j.gomez@drexed.com
+    on_failure: change
+    on_success: never
+rvm:
+  - ruby-head
+script: 'bundle exec rake'

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http:contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

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

data/README.md

@@ -0,0 +1,91 @@
+# ActiveArchive
+
+[![Gem Version](https://badge.fury.io/rb/active_archive.svg)](http://badge.fury.io/rb/active_archive)
+[![Build Status](https://travis-ci.org/drexed/active_archive.svg?branch=master)](https://travis-ci.org/drexed/active_archive)
+[![Coverage Status](https://coveralls.io/repos/drexed/active_archive/badge.png)](https://coveralls.io/r/drexed/active_archive)
+
+ActiveArchive is a library for preventing database records from being destroyed.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'active_archive'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install active_archive
+
+## Table of Contents
+
+* [Configurations](#configurations)
+* [Methods](#methods)
+* [Scopes](#scopes)
+
+## Configurations
+
+**Options:**
+ * all_records_archivable
+ * dependent_record_window
+
+```ruby
+ActiveArchive.configure do |config|
+  # option = default
+
+  config.all_records_archivable  = false
+  config.dependent_record_window = 3.seconds
+end
+```
+
+## Methods
+
+**Options:**
+ * archive
+ * destroy
+ * destroy_all
+ * delete
+ * delete_all
+ * unarchive
+ * unarchive_all
+
+```ruby
+User.first.archive         #=> archives User record and dependents
+User.first.destroy         #=> archives User record and dependents
+User.first.delete          #=> deletes User record and dependents
+User.first.unarchive       #=> unarchives User record and dependents
+
+User.first.archive(:force) #=> destroys User record and dependents
+User.first.destroy(:force) #=> destroys User record and dependents
+
+User.archive_all           #=> archives all User records and dependents
+User.destroy_all           #=> archives all User records and dependents
+User.delete_all            #=> deletes all User records and dependents
+User.unarchive_all         #=> unarchives all User record and dependents
+```
+
+## Scopes
+
+**Options:**
+ * default
+ * archived
+ * unarchived
+
+```ruby
+User.all            #=> returns all records
+User.archived.all   #=> returns only archived record
+User.unarchived.all #=> returns only unarchived record
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/active_archive/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,3 @@
+require "bundler/gem_tasks"
+
+task default: :spec

data/active_archive.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'active_archive/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "active_archive"
+  spec.version       = ActiveArchive::VERSION
+  spec.authors       = ["Juan Gomez"]
+  spec.email         = ["j.gomez@drexed.com"]
+
+  spec.summary       = %q{Soft-delete ActiveRecord records.}
+  spec.description   = %q{Prevent database records from being destroyed.}
+  spec.homepage      = "https://github.com/drexed/active_archive"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib", "support"]
+
+  spec.add_runtime_dependency "activerecord"
+  spec.add_runtime_dependency "activesupport"
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "coveralls"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "sqlite3"
+  spec.add_development_dependency "database_cleaner"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "active_archive"
+
+# 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/rake

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'rake' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('rake', 'rake')

data/bin/setup

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

data/lib/active_archive/base.rb

@@ -0,0 +1,165 @@
+module ActiveArchive
+  module Base
+
+    def self.included(base)
+      base.extend Methods
+      base.extend Scopes
+
+      base.instance_eval do
+        define_model_callbacks :unarchive
+
+        before_unarchive :unarchive_destroyed_dependent_records
+      end
+    end
+
+    def archived?
+      archivable? ? !!archived_at : destroyed?
+    end
+
+    def archivable?
+      respond_to?(:archived_at)
+    end
+
+    def destroy(force=nil)
+      with_transaction_returning_status do
+        if unarchivable? || should_force_destroy?(force)
+          permanently_delete_records_after { super() }
+        else
+          destroy_with_permanent_records(force)
+        end
+      end
+    end
+
+    alias_method(:archive, :destroy)
+
+    def unarchive(validate=nil)
+      with_transaction_returning_status do
+        run_callbacks(:unarchive) { set_archived_at(nil, validate) }
+        self
+      end
+    end
+
+    def unarchived?
+      !archived?
+    end
+
+    def unarchivable?
+      !archivable?
+    end
+
+    private
+
+    def attempt_notifying_observers(callback)
+      begin
+        notify_observers(callback)
+      rescue NoMethodError => e
+        # RETURN
+      end
+    end
+
+    def destroy_with_permanent_records(force=nil)
+      run_callbacks(:destroy) { archived? || (new_record? ? save : set_archived_at(Time.now, force)) }
+      archived? ? self : false
+    end
+
+    def get_dependent_records
+      dependent_records = {}
+      self.class.reflections.each do |key, reflection|
+        if reflection.options[:dependent] == :destroy
+          next unless records = self.send(key)
+          if records.respond_to?(:size)
+            next unless records.size > 0
+          else
+            records = [] << records
+          end
+          dependent_record = records.first
+          next if dependent_record.nil?
+          dependent_records[dependent_record.class] = records.map(&:id)
+        end
+      end
+      return(dependent_records)
+    end
+
+    def permanently_delete_records(dependent_records)
+      dependent_records.each do |klass, ids|
+        ids.each do |id|
+          record = begin
+            klass.unscoped.find(id)
+          rescue ::ActiveRecord::RecordNotFound
+            next
+          end
+          record.archived_at = nil
+          record.destroy(:force)
+        end
+      end
+    end
+
+    def permanently_delete_records_after(&block)
+      dependent_records = get_dependent_records
+      dependent_results = block.call
+      permanently_delete_records(dependent_records) if dependent_results
+      return(dependent_results)
+    end
+
+    def unarchive_destroyed_dependent_records
+      self.class.reflections
+                .select { |name, reflection| (reflection.options[:dependent].to_s == "destroy") && reflection.klass.archivable? }
+                .each do |name, reflection|
+                  cardinality = reflection.macro.to_s.gsub('has_', '')
+
+                  if cardinality == 'many'
+                    records = archived_at.nil? ? send(name).unscoped : send(name).unscoped.where(
+                        [
+                          "#{reflection.quoted_table_name}.archived_at > ? AND #{reflection.quoted_table_name}.archived_at < ?",
+                          archived_at - ActiveArchive.configuration.dependent_record_window,
+                          archived_at + ActiveArchive.configuration.dependent_record_window
+                        ]
+                      )
+                  elsif cardinality == 'one' or cardinality == 'belongs_to'
+                    self.class.unscoped do
+                      records = [] << send(name)
+                    end
+                  end
+
+                  [records].flatten.compact.each { |d| d.unarchive }
+                  send(name, :reload)
+                end
+    end
+
+    def set_archived_at(value, force=nil)
+      return self unless archivable?
+      record = self.class.unscoped.find(id)
+      record.archived_at = value
+
+      begin
+        should_ignore_validations?(force) ? record.save(validate: false) : record.save!
+
+        if ::Gem::Version.new(::ActiveRecord::VERSION::STRING) < ::Gem::Version.new('4.2.0')
+          @attributes       = record.attributes
+          @attributes_cache = record.attributes.except(record.class.serialized_attributes.keys)
+
+          if defined?(::ActiveRecord::AttributeMethods::Serialization::Attribute)
+            serialized_attribute_class = ::ActiveRecord::AttributeMethods::Serialization::Attribute
+            self.class.serialized_attributes.each do |key, coder|
+              @attributes[key] = serialized_attribute_class.new(coder, @attributes[key], :unserialized) if @attributes.key?(key)
+            end
+          end
+        else
+          @attributes = record.instance_variable_get('@attributes')
+        end
+      rescue Exception => e
+        record.destroy
+        raise(e)
+      end
+    end
+
+    def should_force_destroy?(force)
+      (Hash === force) ? force[:force] : (:force == force)
+    end
+
+    def should_ignore_validations?(force)
+      (Hash === force) && (false == force[:validate])
+    end
+
+  end
+end

data/lib/active_archive/configuration.rb

@@ -0,0 +1,10 @@
+class ActiveArchive::Configuration
+
+  attr_accessor :all_records_archivable, :dependent_record_window
+
+  def initialize
+    @all_records_archivable  = false
+    @dependent_record_window = 3.seconds
+  end
+
+end

data/lib/active_archive/methods.rb

@@ -0,0 +1,17 @@
+module ActiveArchive
+  module Methods
+
+    def archivable?
+      columns.detect { |c| c.name == "archived_at" }
+    end
+
+    def archive_all(conditions=nil)
+      conditions ? where(conditions).destroy_all : destroy_all
+    end
+
+    def unarchive_all(conditions=nil)
+      (conditions ? where(conditions) : all).to_a.each { |r| r.unarchive }
+    end
+
+  end
+end

data/lib/active_archive/scopes.rb

@@ -0,0 +1,13 @@
+module ActiveArchive
+  module Scopes
+
+    def archived
+      where(arel_table[:archived_at].not_eq(nil))
+    end
+
+    def unarchived
+      where(arel_table[:archived_at].eq(nil))
+    end
+
+  end
+end

data/lib/active_archive/table_definition.rb

@@ -0,0 +1,16 @@
+module ActiveRecord
+  module ConnectionAdapters
+    class TableDefinition
+
+      def timestamps_with_archived_at(options)
+        if ActiveArchive.configuration.all_records_archivable
+          timestamps_without_archived_at(options)
+          column(:archived_at, :datetime)
+        end
+      end
+
+      alias_method_chain(:timestamps, :archived_at)
+
+    end
+  end
+end

data/lib/active_archive/version.rb

@@ -0,0 +1,3 @@
+module ActiveArchive
+  VERSION = "0.1.0"
+end

data/lib/active_archive.rb

@@ -0,0 +1,28 @@
+require "active_archive/version"
+require "active_archive/configuration"
+require "active_archive/table_definition"
+require "active_archive/methods"
+require "active_archive/scopes"
+require "active_archive/base"
+
+module ActiveArchive
+
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.configuration=(config)
+    @configuration = config
+  end
+
+  def self.configure
+    yield(configuration)
+  end
+
+end
+
+ActiveRecord::Base.send(:include, ActiveArchive::Base)

metadata

@@ -0,0 +1,175 @@
+--- !ruby/object:Gem::Specification
+name: active_archive
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Juan Gomez
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-08-10 00:00:00.000000000 Z
+dependencies:
+- !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'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: database_cleaner
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Prevent database records from being destroyed.
+email:
+- j.gomez@drexed.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".coveralls.yml"
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- README.md
+- Rakefile
+- active_archive.gemspec
+- bin/console
+- bin/rake
+- bin/setup
+- lib/active_archive.rb
+- lib/active_archive/base.rb
+- lib/active_archive/configuration.rb
+- lib/active_archive/methods.rb
+- lib/active_archive/scopes.rb
+- lib/active_archive/table_definition.rb
+- lib/active_archive/version.rb
+homepage: https://github.com/drexed/active_archive
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+- support
+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.4.8
+signing_key: 
+specification_version: 4
+summary: Soft-delete ActiveRecord records.
+test_files: []