persistent_record 0.1.3

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    ZGYzNzA2ZDc4Yjk3OWE3OTAwNzNkNGI2MGJkMDBmMDBmYjI1NzM5NA==
+  data.tar.gz: !binary |-
+    MmRjZTlhYzFiNTU1ZjU3ZDQ2ZjRhODM4NmY5ZTgyYzRmNTkxYzc2Zg==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    ZTk3ZGEwNTU1MTk4YzJiZTQzNjY0MjA3Y2YzNDQyMzA4NzUzYjRhNjUzYmEy
+    Njg2NTgxZDQ3MzQ3ZWNhODY2MDNiNjlhMjQ4Yjc1N2ZiMDNlYjIxMmQwYjYx
+    MTBiZjRmNDgwMTEzMTFhOGE0MTk3MDMwZDAxYzIxYmRiODhlODM=
+  data.tar.gz: !binary |-
+    MTc5YzRkYTA4ZjAxNDVhZDI1MjBjN2NkZTQwNDE0ZWE2YjJhNjU4MWJiZjk0
+    Y2M3ZmMxMTNjMGZmMWMzYjk0ODUxMTg2NTZhNzAyNTlkNDE1ZDQ4ODliMDVj
+    ZGQ1MjkzMjhiMGIwNzFjNmQ5NmFiOTdhZTg4N2JmMTFjZmM2YjY=

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/DOCUMENTATION.md

@@ -0,0 +1,26 @@
+# Documentation
+
+---
+
+## Fetching records
+
+### `with_discarded`
+Returns records including discarded records. Has an alias; `discarded`.
+
+### `only_discarded`
+Returns only discarded records. Has an alias; `discarded!`.
+
+### `discarded?`
+Validates whether or not record is discarded.
+
+### `discard`
+Discards record, alias of `destroy`.
+
+### `restore!`
+Restores current discarded record.
+
+### `restore` (*int|array* id, *hash* options = {})
+Restores one or several records.
+
+### `zap!`
+Deletes record entierly; **removes it from the database**.

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Robin Grass
+
+MIT License
+
+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,17 @@
+# PersistentRecord
+
+Introduces soft deletions for ActiveRecord. Heavily inspired by [radar/paranoia](https://github.com/radar/paranoia).
+
+## Installation
+
+	gem 'persistent_record', github: 'lessthanthree/persistent_record'
+
+## Usage
+
+Migrate your models by adding a "deleted_at" timestamp, `rails generate migration AddDeletedAtColumnToModels deleted_at:datetime:index`
+
+	class YourModel < ActiveRecord::Base
+
+		acts_as_persistent
+	
+	end

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/persistent_record/version.rb

@@ -0,0 +1,3 @@
+module PersistentRecord
+  VERSION = '0.1.3'
+end

data/lib/persistent_record.rb

@@ -0,0 +1,188 @@
+require "persistent_record/version"
+require 'active_record' unless defined? ActiveRecord
+
+
+
+module PersistentRecord
+
+  def self.included(source)
+    source.extend Query
+    source.extend Callbacks
+  end
+
+  module Query
+
+    def persistent?
+      true
+    end
+
+    def with_discarded
+      if ActiveRecord::VERSION::STRING >= "4.1"
+        unscope where: record_deleted_at_column
+      else
+        all.tap { |x| x.default_scoped = false }
+      end
+    end
+
+    def only_discarded
+      with_discarded.where.not(record_deleted_at_column => nil)
+    end
+
+    alias :discarded :with_discarded
+    alias :discarded! :only_discarded
+
+    def restore(id, options = {})
+      if id.is_a?(Array)
+        id.map { |one_id| restore(one_id, options) }
+      else
+        only_discarded.find(id).restore!(options)
+      end
+    end
+
+  end
+
+  module Callbacks
+
+    def self.extended(source)
+
+      source.define_callbacks :restore
+
+      source.define_singleton_method("before_restore") do |*args, &block|
+        set_callback(:restore, :before, *args, &block)
+      end
+
+      source.define_singleton_method("around_restore") do |*args, &block|
+        set_callback(:restore, :around, *args, &block)
+      end
+
+      source.define_singleton_method("after_restore") do |*args, &block|
+        set_callback(:restore, :after, *args, &block)
+      end
+
+    end
+
+  end
+
+  def destroy
+    callbacks_result = run_callbacks(:destroy) { touch_record_deleted_at_column(true) }
+    callbacks_result ? self : false
+  end
+
+  if ActiveRecord::VERSION::STRING >= "4.1"
+    def destroy!
+      discarded? ? super : destroy || raise(ActiveRecord::RecordNotDestroyed)
+    end
+  end
+
+  def delete
+    return if new_record?
+    touch_record_deleted_at_column(false)
+  end
+
+  alias :discard :destroy
+
+  def restore!(options = {})
+    ActiveRecord::Base.transaction do
+      run_callbacks(:restore) do
+        update_column record_deleted_at_column, nil
+        restore_associated_records if options[:recursive]
+      end
+    end
+  end
+
+  def discarded?
+    !!send(record_deleted_at_column)
+  end
+
+  private
+
+  def touch_record_deleted_at_column(with_transaction = false)
+    unless self.frozen?
+      if with_transaction
+        with_transaction_returning_status { touch(record_deleted_at_column) }
+      else
+        touch(record_deleted_at_column)
+      end
+    end
+  end
+
+  def restore_associated_records
+
+    destroyed_associations = self.class.reflect_on_all_associations.select do |association|
+      association.options[:dependent] == :destroy
+    end
+
+    destroyed_associations.each do |association|
+      association_data = send(association.name)
+      unless association_data.nil?
+        if association_data.persistent?
+          if association.collection?
+            association_data.only_discarded.each { |record| record.restore(:recursive => true) }
+          else
+            association_data.restore(:recursive => true)
+          end
+        end
+      end
+    end
+
+  end
+
+end
+
+class ActiveRecord::Base
+
+  def self.acts_as_persistent(options = {})
+
+    alias :destroy! :destroy
+    alias :delete! :delete
+
+    def zap!
+      dependent_reflections = self.reflections.select do |name, reflection|
+        reflection.options[:dependent] == :destroy
+      end
+      if dependent_reflections.any?
+        dependent_reflections.each do |name|
+          associated_records = self.send(name)
+          associated_records = associated_records.with_discarded if associated_records.respond_to?(:with_discarded)
+          associated_records.each(&:zap!)
+        end
+      end
+      destroy!
+    end
+
+    include PersistentRecord
+
+    class_attribute :record_deleted_at_column
+
+    self.record_deleted_at_column = options[:column] || :deleted_at
+    default_scope { where(record_deleted_at_column => nil) }
+
+    before_restore {
+      self.class.notify_observers(:before_restore, self) if self.class.respond_to?(:notify_observers)
+    }
+
+    after_restore {
+      self.class.notify_observers(:after_restore, self) if self.class.respond_to?(:notify_observers)
+    }
+
+  end
+
+  def self.persistent?
+    false
+  end
+
+  def persistent?
+    self.class.persistent?
+  end
+
+  def persisted?
+    persistent? ? !new_record? : super
+  end
+
+  private
+
+  def record_deleted_at_column
+    self.class.record_deleted_at_column
+  end
+
+end

data/persistent_record.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'persistent_record/version'
+
+Gem::Specification.new do |spec|
+
+  spec.name          = "persistent_record"
+  spec.version       = PersistentRecord::VERSION
+  spec.authors       = ["Robin Grass"]
+  spec.email         = ["hej@carbin.se"]
+  spec.description   = %q{Introduces soft deletions for ActiveRecord.}
+  spec.summary       = %q{Introduces soft deletions for ActiveRecord.}
+  spec.homepage      = "http://carbin.se/"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "activerecord", "~> 4.0"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+
+end

metadata

@@ -0,0 +1,95 @@
+--- !ruby/object:Gem::Specification
+name: persistent_record
+version: !ruby/object:Gem::Version
+  version: 0.1.3
+platform: ruby
+authors:
+- Robin Grass
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-06-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !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'
+description: Introduces soft deletions for ActiveRecord.
+email:
+- hej@carbin.se
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- DOCUMENTATION.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/persistent_record.rb
+- lib/persistent_record/version.rb
+- persistent_record.gemspec
+homepage: http://carbin.se/
+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.0.7
+signing_key: 
+specification_version: 4
+summary: Introduces soft deletions for ActiveRecord.
+test_files: []