kumolus-paranoia 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ac8ac01b3148db857444b0ae2b5619aa531c85aa
+  data.tar.gz: de73636aed4c8d9b8ee9ae5fe169d1b3fce87afa
+SHA512:
+  metadata.gz: 99b4bfbc02d21448be898b623aebd3498fa0b323a7b05c9652238957aa0b6b63ef09aed14428ef5dd6209185217ddea068dd5e4f3b9e8f4131b43d8887b8ecd7
+  data.tar.gz: 497b886d71951eaa9ed6b931187cc5a7e009fbf9198247316075462cff96cab85847933b914a7c866d38fdae87766a711570d90a15eeb41d8e37fd33388f426d

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.1
+before_install: gem install bundler -v 1.16.1

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+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, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at kumoas@kumolus.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in kumolus-paranoia.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 kumoas
+
+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,343 @@
+# Paranoia
+
+When your app is using Paranoia, calling `destroy` on an ActiveRecord object doesn't actually destroy the database record, but just *hides* it. Paranoia does this by setting a `deleted_at` field to the current time when you `destroy` a record, and hides it by scoping all queries on your model to only include records which do not have a `deleted_at` field.
+
+If you wish to actually destroy an object you may call `really_destroy!`. **WARNING**: This will also *really destroy* all `dependent: :destroy` records, so please aim this method away from face when using.
+
+If a record has `has_many` associations defined AND those associations have `dependent: :destroy` set on them, then they will also be soft-deleted if `acts_as_paranoid` is set, otherwise the normal destroy will be called. ***See [Destroying through association callbacks](#destroying-through-association-callbacks) for clarifying examples.***
+
+## Installation & Usage
+
+``` ruby
+gem "kumolus-paranoia"
+```
+Then run:
+
+``` shell
+bundle install
+```
+
+#### Run your migrations for the desired models
+
+Run:
+
+``` shell
+bin/rails generate migration AddDeletedAtToClients deleted_at:datetime:index
+```
+
+and now you have a migration
+
+``` ruby
+class AddDeletedAtToClients < ActiveRecord::Migration
+  def change
+    add_column :clients, :deleted_at, :datetime
+    add_index :clients, :deleted_at
+  end
+end
+```
+
+### Usage
+
+#### In your model:
+
+``` ruby
+class Client < ActiveRecord::Base
+  acts_as_paranoid
+
+  # ...
+end
+```
+
+Hey presto, it's there! Calling `destroy` will now set the `deleted_at` column:
+
+
+``` ruby
+>> client.deleted_at
+# => nil
+>> client.destroy
+# => client
+>> client.deleted_at
+# => [current timestamp]
+```
+
+If you really want it gone *gone*, call `really_destroy!`:
+
+``` ruby
+>> client.deleted_at
+# => nil
+>> client.really_destroy!
+# => client
+```
+
+If you want to use a column other than `deleted_at`, you can pass it as an option:
+
+``` ruby
+class Client < ActiveRecord::Base
+  acts_as_paranoid column: :destroyed_at
+
+  ...
+end
+```
+
+
+If you want to skip adding the default scope:
+
+``` ruby
+class Client < ActiveRecord::Base
+  acts_as_paranoid without_default_scope: true
+
+  ...
+end
+```
+
+If you want to access soft-deleted associations, override the getter method:
+
+``` ruby
+def product
+  Product.unscoped { super }
+end
+```
+
+If you want to include associated soft-deleted objects, you can (un)scope the association:
+
+``` ruby
+class Person < ActiveRecord::Base
+  belongs_to :group, -> { with_deleted }
+end
+
+Person.includes(:group).all
+```
+
+If you want to find all records, even those which are deleted:
+
+``` ruby
+Client.with_deleted
+```
+
+If you want to exclude deleted records, when not able to use the default_scope (e.g. when using without_default_scope):
+
+``` ruby
+Client.without_deleted
+```
+
+If you want to find only the deleted records:
+
+``` ruby
+Client.only_deleted
+```
+
+If you want to check if a record is soft-deleted:
+
+``` ruby
+client.paranoia_destroyed?
+# or
+client.is_deleted?
+```
+
+If you want to restore a record:
+
+``` ruby
+Client.restore(id)
+# or
+client.restore
+```
+
+If you want to restore a whole bunch of records:
+
+``` ruby
+Client.restore([id1, id2, ..., idN])
+```
+
+If you want to restore a record and their dependently destroyed associated records:
+
+``` ruby
+Client.restore(id, :recursive => true)
+# or
+client.restore(:recursive => true)
+```
+
+If you want to restore a record and only those dependently destroyed associated records that were deleted within 2 minutes of the object upon which they depend:
+
+``` ruby
+Client.restore(id, :recursive => true. :recovery_window => 2.minutes)
+# or
+client.restore(:recursive => true, :recovery_window => 2.minutes)
+```
+
+Note that by default paranoia will not prevent that a soft destroyed object can't be associated with another object of a different model.
+A Rails validator is provided should you require this functionality:
+  ``` ruby
+validates :some_assocation, association_not_soft_destroyed: true
+```
+This validator makes sure that `some_assocation` is not soft destroyed. If the object is soft destroyed the main object is rendered invalid and an validation error is added.
+
+For more information, please look at the tests.
+
+#### About indexes:
+
+Beware that you should adapt all your indexes for them to work as fast as previously.
+For example,
+
+``` ruby
+add_index :clients, :group_id
+add_index :clients, [:group_id, :other_id]
+```
+
+should be replaced with
+
+``` ruby
+add_index :clients, :group_id, where: "deleted_at IS NULL"
+add_index :clients, [:group_id, :other_id], where: "deleted_at IS NULL"
+```
+
+Of course, this is not necessary for the indexes you always use in association with `with_deleted` or `only_deleted`.
+
+##### Unique Indexes
+
+Because NULL != NULL in standard SQL, we can not simply create a unique index
+on the deleted_at column and expect it to enforce that there only be one record
+with a certain combination of values.
+
+If your database supports them, good alternatives include partial indexes
+(above) and indexes on computed columns. E.g.
+
+``` ruby
+add_index :clients, [:group_id, 'COALESCE(deleted_at, false)'], unique: true
+```
+
+If not, an alternative is to create a separate column which is maintained
+alongside deleted_at for the sake of enforcing uniqueness. To that end,
+paranoia makes use of two method to make its destroy and restore actions:
+paranoia_restore_attributes and paranoia_destroy_attributes.
+
+``` ruby
+add_column :clients, :active, :boolean
+add_index :clients, [:group_id, :active], unique: true
+
+class Client < ActiveRecord::Base
+  # optionally have paranoia make use of your unique column, so that
+  # your lookups will benefit from the unique index
+  acts_as_paranoid column: :active, sentinel_value: true
+
+  def paranoia_restore_attributes
+    {
+      deleted_at: nil,
+      active: true
+    }
+  end
+
+  def paranoia_destroy_attributes
+    {
+      deleted_at: current_time_from_proper_timezone,
+      active: nil
+    }
+  end
+end
+```
+
+##### Destroying through association callbacks
+
+When dealing with `dependent: :destroy` associations and `acts_as_paranoid`, it's important to remember that whatever method is called on the parent model will be called on the child model. For example, given both models of an association have `acts_as_paranoid` defined:
+
+``` ruby
+class Client < ActiveRecord::Base
+  acts_as_paranoid
+
+  has_many :emails, dependent: :destroy
+end
+
+class Email < ActiveRecord::Base
+  acts_as_paranoid
+
+  belongs_to :client
+end
+```
+
+When we call `destroy` on the parent `client`, it will call `destroy` on all of its associated children `emails`:
+
+``` ruby
+>> client.emails.count
+# => 5
+>> client.destroy
+# => client
+>> client.deleted_at
+# => [current timestamp]
+>> Email.where(client_id: client.id).count
+# => 0
+>> Email.with_deleted.where(client_id: client.id).count
+# => 5
+```
+
+Similarly, when we call `really_destroy!` on the parent `client`, then each child `email` will also have `really_destroy!` called:
+
+``` ruby
+>> client.emails.count
+# => 5
+>> client.id
+# => 12345
+>> client.really_destroy!
+# => client
+>> Client.find 12345
+# => ActiveRecord::RecordNotFound
+>> Email.with_deleted.where(client_id: client.id).count
+# => 0
+```
+
+However, if the child model `Email` does not have `acts_as_paranoid` set, then calling `destroy` on the parent `client` will also call `destroy` on each child `email`, thereby actually destroying them:
+
+``` ruby
+class Client < ActiveRecord::Base
+  acts_as_paranoid
+
+  has_many :emails, dependent: :destroy
+end
+
+class Email < ActiveRecord::Base
+  belongs_to :client
+end
+
+>> client.emails.count
+# => 5
+>> client.destroy
+# => client
+>> Email.where(client_id: client.id).count
+# => 0
+>> Email.with_deleted.where(client_id: client.id).count
+# => NoMethodError: undefined method `with_deleted' for #<Class:0x0123456>
+```
+
+## Acts As Paranoid Migration
+
+You can replace the older `acts_as_paranoid` methods as follows:
+
+| Old Syntax                 | New Syntax                     |
+|:-------------------------- |:------------------------------ |
+|`find_with_deleted(:all)`   | `Client.with_deleted`          |
+|`find_with_deleted(:first)` | `Client.with_deleted.first`    |
+|`find_with_deleted(id)`     | `Client.with_deleted.find(id)` |
+
+
+The `recover` method in `acts_as_paranoid` runs `update` callbacks.  Paranoia's
+`restore` method does not do this.
+
+## Callbacks
+
+Paranoia provides several callbacks. It triggers `destroy` callback when the record is marked as deleted and `real_destroy` when the record is completely removed from database. It also calls `restore` callback when the record is restored via paranoia
+
+For example if you want to index your records in some search engine you can go like this:
+
+```ruby
+class Product < ActiveRecord::Base
+  acts_as_paranoid
+
+  after_destroy      :update_document_in_search_engine
+  after_restore      :update_document_in_search_engine
+  after_real_destroy :remove_document_from_search_engine
+end
+```
+
+You can use these events just like regular Rails callbacks with before, after and around hooks.
+
+## License
+
+This gem is released under the MIT license.

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "kumolus/paranoia"
+
+# 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(__FILE__)

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/kumolus-paranoia.gemspec

@@ -0,0 +1,50 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "kumolus/paranoia/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "kumolus-paranoia"
+  spec.version       = Kumolus::Paranoia::VERSION
+  spec.authors       = ["kumoas"]
+  spec.email         = ["kumoas@kumolus.com"]
+
+  spec.summary       = "This gem is use for soft delete of active record object"
+  spec.description   = <<-DSC
+    You would use this Paranoia gem if you
+    wished that when you called destroy on an Active Record object that it
+    didn't actually destroy it, but just "hide" the record. Paranoia does this
+    by setting a deleted_at field to the current time when you destroy a record,
+    and hides it by scoping all queries on your model to only include records
+    which do not have a deleted_at field.
+  DSC
+  spec.homepage      = "https://github.com/kumoas/kumolus-paranoia"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["allowed_push_host"] = "https://rubygems.org/"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+
+  spec.required_rubygems_version = ">= 1.3.6"
+
+  spec.required_ruby_version = '>= 2.0'
+  spec.add_dependency 'activerecord', '>= 4.0', '>= 5.1'
+
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+
+  spec.require_path = 'lib'
+end

data/lib/kumolus/paranoia.rb

@@ -0,0 +1,329 @@
+require "kumolus/paranoia/version"
+require 'active_record' unless defined? ActiveRecord
+
+module Kumolus
+  module Paranoia
+    @@default_sentinel_value = nil
+
+    # Change default_sentinel_value in a rails initializer
+    def self.default_sentinel_value=(val)
+      @@default_sentinel_value = val
+    end
+
+    def self.default_sentinel_value
+      @@default_sentinel_value
+    end
+
+    def self.included(klazz)
+      klazz.extend Query
+      klazz.extend Callbacks
+    end
+
+    module Query
+      def paranoid? ; true ; end
+
+      def with_deleted
+        if ActiveRecord::VERSION::STRING >= "4.1"
+          return unscope where: paranoia_column
+        end
+        all.tap { |x| x.default_scoped = false }
+      end
+
+      def only_deleted
+        if paranoia_sentinel_value.nil?
+          return with_deleted.where.not(paranoia_column => paranoia_sentinel_value)
+        end
+        # if paranoia_sentinel_value is not null, then it is possible that
+        # some deleted rows will hold a null value in the paranoia column
+        # these will not match != sentinel value because "NULL != value" is
+        # NULL under the sql standard
+        # Scoping with the table_name is mandatory to avoid ambiguous errors when joining tables.
+        scoped_quoted_paranoia_column = "#{self.table_name}.#{connection.quote_column_name(paranoia_column)}"
+        with_deleted.where("#{scoped_quoted_paranoia_column} IS NULL OR #{scoped_quoted_paranoia_column} != ?", paranoia_sentinel_value)
+      end
+      alias_method :deleted, :only_deleted
+
+      def restore(id_or_ids, opts = {})
+        ids = Array(id_or_ids).flatten
+        any_object_instead_of_id = ids.any? { |id| ActiveRecord::Base === id }
+        if any_object_instead_of_id
+          ids.map! { |id| ActiveRecord::Base === id ? id.id : id }
+          ActiveSupport::Deprecation.warn("You are passing an instance of ActiveRecord::Base to `restore`. " \
+                                          "Please pass the id of the object by calling `.id`")
+        end
+        ids.map { |id| only_deleted.find(id).restore!(opts) }
+      end
+    end
+
+    module Callbacks
+      def self.extended(klazz)
+        [:restore, :real_destroy].each do |callback_name|
+          klazz.define_callbacks callback_name
+
+          klazz.define_singleton_method("before_#{callback_name}") do |*args, &block|
+            set_callback(callback_name, :before, *args, &block)
+          end
+
+          klazz.define_singleton_method("around_#{callback_name}") do |*args, &block|
+            set_callback(callback_name, :around, *args, &block)
+          end
+
+          klazz.define_singleton_method("after_#{callback_name}") do |*args, &block|
+            set_callback(callback_name, :after, *args, &block)
+          end
+        end
+      end
+    end
+
+    def destroy
+      transaction do
+        run_callbacks(:destroy) do
+          @_disable_counter_cache = deleted?
+          result = delete
+          next result unless result && ActiveRecord::VERSION::STRING >= '4.2'
+          each_counter_cached_associations do |association|
+            foreign_key = association.reflection.foreign_key.to_sym
+            next if destroyed_by_association && destroyed_by_association.foreign_key.to_sym == foreign_key
+            next unless send(association.reflection.name)
+            association.decrement_counters
+          end
+          @_disable_counter_cache = false
+          result
+        end
+      end
+    end
+
+    def delete
+      raise ActiveRecord::ReadOnlyRecord, "#{self.class} is marked as readonly" if readonly?
+      if persisted?
+        # if a transaction exists, add the record so that after_commit
+        # callbacks can be run
+        add_to_transaction
+        update_columns(paranoia_destroy_attributes)
+      elsif !frozen?
+        assign_attributes(paranoia_destroy_attributes)
+      end
+      self
+    end
+
+    def restore!(opts = {})
+      self.class.transaction do
+        run_callbacks(:restore) do
+          recovery_window_range = get_recovery_window_range(opts)
+          # Fixes a bug where the build would error because attributes were frozen.
+          # This only happened on Rails versions earlier than 4.1.
+          noop_if_frozen = ActiveRecord.version < Gem::Version.new("4.1")
+          if within_recovery_window?(recovery_window_range) && ((noop_if_frozen && !@attributes.frozen?) || !noop_if_frozen)
+            @_disable_counter_cache = !deleted?
+            write_attribute paranoia_column, paranoia_sentinel_value
+            update_columns(paranoia_restore_attributes)
+            each_counter_cached_associations do |association|
+              if send(association.reflection.name)
+                association.increment_counters
+              end
+            end
+            @_disable_counter_cache = false
+          end
+          restore_associated_records(recovery_window_range) if opts[:recursive]
+        end
+      end
+
+      self
+    end
+    alias :restore :restore!
+
+    def get_recovery_window_range(opts)
+      return opts[:recovery_window_range] if opts[:recovery_window_range]
+      return unless opts[:recovery_window]
+      (deleted_at - opts[:recovery_window]..deleted_at + opts[:recovery_window])
+    end
+
+    def within_recovery_window?(recovery_window_range)
+      return true unless recovery_window_range
+      recovery_window_range.cover?(deleted_at)
+    end
+
+    def paranoia_destroyed?
+      send(paranoia_column) != paranoia_sentinel_value
+    end
+    alias :is_deleted? :paranoia_destroyed?
+
+    def really_destroy!
+      transaction do
+        run_callbacks(:real_destroy) do
+          @_disable_counter_cache = deleted?
+          dependent_reflections = self.class.reflections.select do |name, reflection|
+            reflection.options[:dependent] == :destroy
+          end
+          if dependent_reflections.any?
+            dependent_reflections.each do |name, reflection|
+              association_data = self.send(name)
+              # has_one association can return nil
+              # .paranoid? will work for both instances and classes
+              next unless association_data && association_data.paranoid?
+              if reflection.collection?
+                next association_data.with_deleted.each(&:really_destroy!)
+              end
+              association_data.really_destroy!
+            end
+          end
+          write_attribute(paranoia_column, current_time_from_proper_timezone)
+          destroy_without_paranoia
+        end
+      end
+    end
+
+    private
+
+    def each_counter_cached_associations
+      !@_disable_counter_cache && defined?(super) ? super : []
+    end
+
+    def paranoia_restore_attributes
+      {
+        paranoia_column => paranoia_sentinel_value
+      }.merge(timestamp_attributes_with_current_time)
+    end
+
+    def paranoia_destroy_attributes
+      {
+        paranoia_column => current_time_from_proper_timezone
+      }.merge(timestamp_attributes_with_current_time)
+    end
+
+    def timestamp_attributes_with_current_time
+      timestamp_attributes_for_update_in_model.each_with_object({}) { |attr,hash| hash[attr] = current_time_from_proper_timezone }
+    end
+
+    # restore associated records that have been soft deleted when
+    # we called #destroy
+    def restore_associated_records(recovery_window_range = nil)
+      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.paranoid?
+            if association.collection?
+              association_data.only_deleted.each do |record|
+                record.restore(:recursive => true, :recovery_window_range => recovery_window_range)
+              end
+            else
+              association_data.restore(:recursive => true, :recovery_window_range => recovery_window_range)
+            end
+          end
+        end
+
+        if association_data.nil? && association.macro.to_s == "has_one"
+          association_class_name = association.klass.name
+          association_foreign_key = association.foreign_key
+
+          if association.type
+            association_polymorphic_type = association.type
+            association_find_conditions = { association_polymorphic_type => self.class.name.to_s, association_foreign_key => self.id }
+          else
+            association_find_conditions = { association_foreign_key => self.id }
+          end
+
+          association_class = association_class_name.constantize
+          if association_class.paranoid?
+            association_class.only_deleted.where(association_find_conditions).first
+            .try!(:restore, recursive: true, :recovery_window_range => recovery_window_range)
+          end
+        end
+      end
+
+      clear_association_cache if destroyed_associations.present?
+    end
+  end
+
+  ActiveSupport.on_load(:active_record) do
+    class ActiveRecord::Base
+      def self.acts_as_paranoid(options={})
+        alias_method :really_destroyed?, :destroyed?
+        alias_method :really_delete, :delete
+        alias_method :destroy_without_paranoia, :destroy
+
+        include Paranoia
+        class_attribute :paranoia_column, :paranoia_sentinel_value
+
+        self.paranoia_column = (options[:column] || :deleted_at).to_s
+        self.paranoia_sentinel_value = options.fetch(:sentinel_value) { Paranoia.default_sentinel_value }
+        def self.paranoia_scope
+          where(paranoia_column => paranoia_sentinel_value)
+        end
+        class << self; alias_method :without_deleted, :paranoia_scope end
+
+        unless options[:without_default_scope]
+          default_scope { paranoia_scope }
+        end
+
+        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
+
+      # Please do not use this method in production.
+      # Pretty please.
+      def self.I_AM_THE_DESTROYER!
+        # TODO: actually implement spelling error fixes
+        puts %Q{
+      Sharon: "There should be a method called I_AM_THE_DESTROYER!"
+      Ryan:   "What should this method do?"
+      Sharon: "It should fix all the spelling errors on the page!"
+}
+    end
+
+    def self.paranoid? ; false ; end
+    def paranoid? ; self.class.paranoid? ; end
+
+    private
+
+    def paranoia_column
+      self.class.paranoia_column
+    end
+
+    def paranoia_sentinel_value
+      self.class.paranoia_sentinel_value
+    end
+  end
+end
+
+require 'kumolus/paranoia/rspec' if defined? RSpec
+
+module ActiveRecord
+  module Validations
+    module UniquenessParanoiaValidator
+      def build_relation(klass, *args)
+        relation = super
+        return relation unless klass.respond_to?(:paranoia_column)
+        arel_paranoia_scope = klass.arel_table[klass.paranoia_column].eq(klass.paranoia_sentinel_value)
+        if ActiveRecord::VERSION::STRING >= "5.0"
+          relation.where(arel_paranoia_scope)
+        else
+          relation.and(arel_paranoia_scope)
+        end
+      end
+    end
+
+    class UniquenessValidator < ActiveModel::EachValidator
+      prepend UniquenessParanoiaValidator
+    end
+    
+    class AssociationNotSoftDestroyedValidator < ActiveModel::EachValidator
+      def validate_each(record, attribute, value)
+        # if association is soft destroyed, add an error
+        if value.present? && value.deleted?
+          record.errors[attribute] << 'has been soft-deleted'
+        end
+      end
+    end
+  end
+end
+end

data/lib/kumolus/paranoia/rspec.rb

@@ -0,0 +1,23 @@
+require 'rspec/expectations'
+
+# Validate the subject's class did call "acts_as_paranoid"
+RSpec::Matchers.define :act_as_paranoid do
+  match { |subject| subject.class.ancestors.include?(Paranoia) }
+
+  failure_message_proc = lambda do
+    "expected #{subject.class} to use `acts_as_paranoid`"
+  end
+
+  failure_message_when_negated_proc = lambda do
+    "expected #{subject.class} not to use `acts_as_paranoid`"
+  end
+
+  if respond_to?(:failure_message_when_negated)
+    failure_message(&failure_message_proc)
+    failure_message_when_negated(&failure_message_when_negated_proc)
+  else
+    # RSpec 2 compatibility:
+    failure_message_for_should(&failure_message_proc)
+    failure_message_for_should_not(&failure_message_when_negated_proc)
+  end
+end

data/lib/kumolus/paranoia/version.rb

@@ -0,0 +1,5 @@
+module Kumolus
+  module Paranoia
+    VERSION = "0.1.0"
+  end
+end

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: kumolus-paranoia
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- kumoas
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-11-13 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'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.1'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: |2
+      You would use this Paranoia gem if you
+      wished that when you called destroy on an Active Record object that it
+      didn't actually destroy it, but just "hide" the record. Paranoia does this
+      by setting a deleted_at field to the current time when you destroy a record,
+      and hides it by scoping all queries on your model to only include records
+      which do not have a deleted_at field.
+email:
+- kumoas@kumolus.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- kumolus-paranoia.gemspec
+- lib/kumolus/paranoia.rb
+- lib/kumolus/paranoia/rspec.rb
+- lib/kumolus/paranoia/version.rb
+homepage: https://github.com/kumoas/kumolus-paranoia
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org/
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.3.6
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: This gem is use for soft delete of active record object
+test_files: []