ar_soft_delete 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e58284abe54c1cf091ef6c7d9a64c27c0c620f4c1428e9370caa58a9e88c5b6e
+  data.tar.gz: 12a8f3b5d7d48652adc6d8bb661bc58a297d90eedb632c0d5a27514c3fa7fe31
+SHA512:
+  metadata.gz: 9d230ddf0015381f9b52dcf48be2884c0bf62f5facd3e146547a0cfde6edfe38a98909a2598385e68fddf25661c0b94ef9df6a559de77f9c4de112c47c092f95
+  data.tar.gz: 3e6f45ae18bd79522691fb4992d99efffdea755837aee251409f7da57dd8f9ac27ab02cac041dcb9ef1c9151c6696d51252d32e1c904fcc7a5c55765c94a38c5

data/.gitignore

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

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.8
+before_install: gem install bundler -v 2.1.4

data/Gemfile

@@ -0,0 +1,8 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in soft_delete.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"
+gem "activerecord"

data/Gemfile.lock

@@ -0,0 +1,63 @@
+PATH
+  remote: .
+  specs:
+    soft_delete (0.1.0)
+      activerecord (>= 4.2, < 7)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (6.0.3.2)
+      activesupport (= 6.0.3.2)
+    activerecord (6.0.3.2)
+      activemodel (= 6.0.3.2)
+      activesupport (= 6.0.3.2)
+    activesupport (6.0.3.2)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.2, >= 2.2.2)
+    concurrent-ruby (1.1.6)
+    database_cleaner (1.8.5)
+    diff-lcs (1.4.4)
+    i18n (1.8.5)
+      concurrent-ruby (~> 1.0)
+    minitest (5.14.1)
+    rake (12.3.3)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
+    sqlite3 (1.4.2)
+    thread_safe (0.3.6)
+    tzinfo (1.2.7)
+      thread_safe (~> 0.1)
+    with_model (2.1.4)
+      activerecord (>= 5.2, < 6.1)
+    zeitwerk (2.4.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord
+  bundler
+  database_cleaner (~> 1.5)
+  rake (~> 12.0)
+  rspec (~> 3.0)
+  soft_delete!
+  sqlite3
+  with_model (~> 2.0)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 TODO: Write your name
+
+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,115 @@
+# SoftDelete
+
+(Yet another) Soft delete active_record models.  
+
+Why another soft delete?  Soft deleting is a relatively common pattern which lets you hide records instead of deleting them.  Some gems are heavy handed and override normal deleting.  Most of them make a lot of decisions or assumptions about how you will be soft deleting.  This gem takes an open approach and lets you decide how little or how much your project will be using the soft delete pattern.  It can be configured on a per-model level to use whichever features are appropriate at the time.  This makes it especially easy to introduce soft delete into existing projects.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ar_soft_delete'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install ar_soft_delete
+
+## Usage
+
+SoftDelete works by setting `deleted_at` to Time.now.  Make sure your model has a datetime `deleted_at` column.  And include the module into your active_record class:
+
+```ruby
+class Author < ApplicationRecord
+  include SoftDelete::SoftDeletable
+
+  ...
+end
+```
+
+`myModel.soft_delete` returns `true|false`.
+
+`myModel.soft_delete!` raises `ActiveRecord::RecordInvalid` on failure.
+
+You can also pass an optional `validate: false` argument to ignore validations on save.  This can be useful if you want to soft delete a record that would normally not save because it is invalid.
+
+Exa:
+
+```ruby
+foo.valid?
+> false
+foo.soft_delete(validate: false)
+> true
+```
+
+## Dependency Behavior
+
+In general, SoftDelete considers "soft deleting" and "normal deleting" to be two separate things.  Under this philosophy, SoftDelete's default behavior is to do as little as possible (just set the `deleted_at` column).  There are no callbacks fired off, associations are not updated, etc.
+
+However, sometimes you want to handle soft deletes as if they are real deletes.  To that end, SoftDelete allows you to set a dependency behavior
+`include SoftDelete::SoftDeletable.dependent(:ignore|:default|:soft_delete)`
+* `:ignore`: The default.  Do nothing with associated records.  Useful if you want to soft delete specific records with no other side effects.  Example use case:
+I have identified bad data.  I want to be able to delete the data, see the ramifications and potentially quickly restore the data if the delete was a mistake.
+* `:default`: Fire off the same action that is described by the active_record dsl in the model.  Exa (`has_many :enemies, default: :destroy`) would destroy the enemies when the model is soft deleted.  This is useful if you are incrementally adding soft delete to certain models and want the rest of the behavior to remain the same.
+* `:soft_delete`: overrides the `:destroy` association option to invoke a `soft_delete` on the associated records.  This comes the closest to automatically replacing normal deletes with soft deletes.  It runs before|around|after destroy hooks when it soft deletes.
+
+Exa:
+
+```ruby
+class Author < ApplicationRecord
+  include SoftDelete::SoftDeletable.dependent(:soft_delete)
+
+  has_many :notes, dependent: :destroy
+  ...
+end
+```
+
+## Default Scope
+
+By default, SoftDelete uses a default_scope.  Do you feel strongly that a default scope is not for you?  SoftDelete can be included without a default scope:
+`include SoftDelete::SoftDeletable.not_scoped`
+
+This will skip adding a default scope to the model and instead will add an `active` scope that you can use to filter the records.
+
+## SoftDelete Restorable
+
+You can also include the `SoftDelete::Restorable` module to include a `deleted` scope which overrides the default `deleted_at` scope if it exists.  It also mixes in `restore_soft_delete` and `restore_soft_delete!`.  They both can take an optional `validate` param to restore an otherwise invalid record.
+
+exa:
+```ruby
+note = Note.deleted.find_by(id: 2)
+note.valid?
+> false
+note.restore_soft_delete(validate: false)
+> true
+```
+
+## Caveats
+
+SoftDelete uses a class var to hold the dependency behavior.  This has implications if you subclass a model that includes SoftDelete.  All subclasses share the same class variable and therefore would share the same soft delete dependency behavior.  Changing it in a subclass changes it for the ancestors as well as any children.
+
+SoftDelete does not currently support updating cache counters when a record is soft deleted.
+
+## Roadmap
+
+* before|after soft_delete hooks.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/swelltrain/soft_delete.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

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 "soft_delete"
+
+# 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/lib/soft_delete.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+require 'active_record'
+require 'soft_delete/version'
+require 'soft_delete/soft_deletable'
+require 'soft_delete/restorable'

data/lib/soft_delete/restorable.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module SoftDelete
+  module Restorable
+    extend ActiveSupport::Concern
+
+    included do
+      scope :deleted, -> { unscope(where: :deleted_at).where.not(deleted_at: nil) }
+    end
+
+    def restore_soft_delete(validate: true)
+      restore_soft_delete!(validate: validate)
+    rescue ActiveRecord::RecordInvalid
+      false
+    end
+
+    def restore_soft_delete!(validate: true)
+      self.deleted_at = nil
+      save!(validate: validate)
+    end
+  end
+end

data/lib/soft_delete/soft_deletable.rb

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+module SoftDelete
+  # TODO: wrap in a transaction
+  module SoftDeletable
+    extend ActiveSupport::Concern
+    @@soft_delete_dependency_behavior = nil
+    @@include_default_scope = true
+
+    included do
+      if @@include_default_scope
+        default_scope { where(deleted_at: nil) }
+      else
+        scope :active, -> { where(deleted_at: nil) }
+      end
+    end
+
+    def self.not_scoped
+      @@include_default_scope = false
+
+      self
+    end
+
+    # descibes how soft delete should handle dependencies
+    # ignore
+    # ignore dependencies and do nothing. this is the default behavior
+    # default
+    # fire off the same action that is described by ar dsl
+    # soft_delete
+    # if dsl is :destroy, then override with a soft_delete
+    def self.dependent(behavior = :ignore)
+      raise ArgumentError unless %i[ignore default soft_delete].include? behavior
+
+      @@soft_delete_dependency_behavior = behavior
+      self
+    end
+
+    def soft_delete(validate: true)
+      soft_delete!(validate: validate)
+    rescue ActiveRecord::RecordInvalid
+      false
+    end
+
+    def soft_delete!(validate: true)
+      ActiveRecord::Base.transaction do
+        handle_soft_delete_dependency_behavior
+        run_callbacks(:destroy) do
+          self.deleted_at = Time.now
+          save!(validate: validate)
+        end
+      end
+    end
+
+    private
+
+    def handle_soft_delete_dependency_behavior
+      return unless @@soft_delete_dependency_behavior.present?
+
+      case @@soft_delete_dependency_behavior
+      when :soft_delete
+        handle_overridden_soft_delete_dependencies
+      when :default
+        handle_normal_dependencies
+      end
+    end
+
+    def handle_normal_dependencies
+      soft_delete_dependent_associations.each(&:handle_dependency)
+    end
+
+    def handle_overridden_soft_delete_dependencies
+      soft_delete_dependent_associations.each do |assn|
+        next unless assn.options[:dependent] == :destroy
+
+        # TODO: pass in validate
+        assn.load_target.each(&:soft_delete!)
+
+        # see:
+        # https://github.com/rails/rails/blob/master/activerecord/lib/active_record/associations/collection_association.rb#L174
+        assn.reset
+        assn.loaded!
+      end
+      handle_normal_dependencies
+    end
+
+    def soft_delete_dependent_associations
+      @soft_delete_dependent_associations ||=
+        _reflections.select { |_k, v| v.options[:dependent].present? }.map { |_k, v| association(v.name) }
+    end
+  end
+end

data/lib/soft_delete/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module SoftDelete
+  VERSION = '0.1.1'
+end

data/soft_delete.gemspec

@@ -0,0 +1,37 @@
+require_relative 'lib/soft_delete/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "ar_soft_delete"
+  spec.version       = SoftDelete::VERSION
+  spec.authors       = ["Stephen Philp"]
+  spec.email         = ["swelltrain@gmail.com"]
+
+  spec.summary       = %q(Soft delete active_record models.)
+  spec.description   = %q(This gem takes an open approach and lets you decide
+    how little or how much your project will be using the soft delete pattern.
+    It can be configured on a per-model level to use whichever features
+    are appropriate at the time.  This makes it especially easy to introduce
+    soft delete into existing projects.)
+  # spec.homepage      = "TODO: Put your gem's website or public repo URL here."
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["source_code_uri"] = "https://github.com/swelltrain/soft_delete"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'activerecord', '>= 4.2', '<7'
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'database_cleaner', '~> 1.5'
+  spec.add_development_dependency 'rake', '>= 12.3.3'
+  spec.add_development_dependency 'rspec', '~> 3.5.0'
+  spec.add_development_dependency 'sqlite3'
+  spec.add_development_dependency 'with_model', '~> 2.0'
+end

metadata

@@ -0,0 +1,169 @@
+--- !ruby/object:Gem::Specification
+name: ar_soft_delete
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Stephen Philp
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-08-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7'
+- !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: database_cleaner
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.3.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.3.3
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.5.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.5.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: with_model
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: |-
+  This gem takes an open approach and lets you decide
+      how little or how much your project will be using the soft delete pattern.
+      It can be configured on a per-model level to use whichever features
+      are appropriate at the time.  This makes it especially easy to introduce
+      soft delete into existing projects.
+email:
+- swelltrain@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/soft_delete.rb
+- lib/soft_delete/restorable.rb
+- lib/soft_delete/soft_deletable.rb
+- lib/soft_delete/version.rb
+- soft_delete.gemspec
+homepage: 
+licenses:
+- MIT
+metadata:
+  source_code_uri: https://github.com/swelltrain/soft_delete
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6.2
+signing_key: 
+specification_version: 4
+summary: Soft delete active_record models.
+test_files: []