discard 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: '05822379b2886d4ccb77a0a4d949360995765ac9'
+  data.tar.gz: e91766d115a3a52bc92c7f8a11caaa8ae07b0025
+SHA512:
+  metadata.gz: 8d056bd501e220739f73021bb2054fc0b127a3f33b96eee7b570d0e4c8f5b133d8fc5522c58747517cbe84b82097b2d408285ad256174ed5fac8460db7644c1f
+  data.tar.gz: f5012b9b5af4c812b52376635e64581c7ae7f403cfd4214b68769abdafc4d49ef2988b4e4874bcdbe57603b363b2f6c871ffbe4cd060c54d059711868deee555

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,12 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.2.7
+  - 2.3.4
+  - 2.4.1
+env:
+  matrix:
+    - RAILS_VERSION='~> 4.2.0'
+    - RAILS_VERSION='~> 5.0.0'
+    - RAILS_VERSION='~> 5.1.x'
+before_install: gem install bundler -v 1.14.6

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 john.hawthorn@gmail.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,7 @@
+source 'https://rubygems.org'
+
+rails_version = ENV['RAILS_VERSION']
+gem 'activerecord', rails_version
+
+# Specify your gem's dependencies in discard.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 John Hawthorn
+
+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,198 @@
+# Discard [![Build Status](https://travis-ci.org/jhawthorn/discard.svg?branch=master)](https://travis-ci.org/jhawthorn/discard)
+
+Soft deletes for ActiveRecord done right.
+
+<img src="http://i.hawth.ca/u/ron-swanson-computer-trash.gif" width="800" />
+
+## What does this do?
+
+A simple ActiveRecord mixin to add conventions for flagging records as discarded.
+
+## Why should I use this?
+
+I've worked with and have helped maintain
+[paranoia](https://github.com/rubysherpas/paranoia) for a while. I'm convinced
+it does the wrong thing for most cases.
+
+Paranoia and
+[acts_as_paranoid](https://github.com/ActsAsParanoid/acts_as_paranoid) both
+attempt to emulate deletes by setting a column and adding a default scope on the
+model. This requires some ActiveRecord hackery, and leads to some surprising
+and awkward behaviour.
+
+* A default scope is added to hide soft-deleted records, which necessitates
+  adding `.with_deleted` to associations or anywhere soft-deleted records
+  should be found. :disappointed:
+  * Adding `belongs_to :child, -> { with_deleted }` helps, but doesn't work for
+    joins and eager-loading.
+* `delete` is overridden (`really_delete` will actually delete the record) :unamused:
+* `destroy` is overridden (`really_destroy` will actually delete the record) :pensive:
+* `dependent: :destroy` associations are deleted when performing soft-destroys :scream:
+  * requiring any dependent records to also be `acts_as_paranoid` to avoid losing data. :grimacing:
+
+There are some use cases where these behaviours make sense: if you really did
+want to _almost_ delete the record. More often developers are just looking to
+hide some records, or mark them as inactive.
+
+Discard takes a different approach. It doesn't override any ActiveRecord
+methods and instead simply provides convenience methods and scopes for
+discarding (hiding), restoring, and querying records.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'discard'
+```
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+**Declare a record as discardable**
+
+Declare the record as being discardable
+
+``` ruby
+class Post < ActiveRecord::Base
+  include Discard::Model
+end
+```
+
+
+``` ruby
+class AddDiscardToPosts < ActiveRecord::Migration[5.0]
+  def up
+    add_column :posts, :discarded_at, :datetime
+  end
+end
+```
+
+
+**Discard a record**
+```
+Post.all             # => [#<Post id: 1, ...>]
+Post.kept            # => [#<Post id: 1, ...>]
+Post.discarded       # => []
+
+@post = Post.first   # => #<Post id: 1, ...>
+@post.discard!
+@post.discarded?     # => true
+@post.discarded_at   # => 2017-04-18 18:49:49 -0700
+
+Post.all             # => [#<Post id: 1, ...>]
+Post.kept            # => []
+Post.discarded       # => [#<Post id: 1, ...>]
+```
+
+**From a controller**
+
+Controller actions need a small modification to discard records instead of deleting them. Just replace `destroy` with `discard`.
+
+``` ruby
+def destroy
+  @post.discard
+  redirect_to users_url, notice: "Post removed"
+end
+```
+
+**Working with associations**
+
+Under paranoia, soft deleting a record will destroy any `dependent: :destroy`
+associations. Probably not what you want! This leads to all dependent records
+also needing to be `acts_as_paranoid`, which makes restoring awkward: paranoia
+handles this by restoring any records which have their deleted_at set to a
+similar timestamp. Also, it doesn't always make sense to mark these records as
+deleted, it depends on the application.
+
+A better approach is to simply mark the one record as discarded, and use SQL
+joins to restrict finding these if that's desired.
+
+For example, in a blog comment system, with `Post`s and `Comment`s, you might
+want to discard the records independently. A user's comment history could
+include comments on deleted posts.
+
+``` ruby
+Post.kept # SELECT * FROM posts WHERE discarded_at IS NULL
+Comment.kept # SELECT * FROM comments WHERE discarded_at IS NULL
+```
+
+Or you could decide that comments are dependent on their posts not being
+discarded. Just override the `kept` scope on the Comment model.
+
+``` ruby
+class Comment < ActiveRecord::Base
+  has_many :posts
+
+  include Discard::Model
+  scope :kept, -> { undiscarded.joins(:posts).merge(Post.kept) }
+end
+
+Comment.kept
+# SELECT * FROM comments
+#    INNER JOIN posts ON comments.post_id = posts.id
+# WHERE
+#    comments.discarded_at IS NULL AND
+#       posts.discarded_at IS NULL
+```
+
+SQL databases are very good at this, and performance should not be an issue.
+
+In both of these cases restoring either of these records will do right thing!
+
+
+**Default scope**
+
+It's usually undesirable to add a default scope. It will take more effort to
+work around and will cause more headaches. If you know you need a default scope, it's easy to add yourself ❤.
+
+``` ruby
+class Post < ActiveRecord::Base
+  include Discard::Model
+  default_scope -> { kept }
+end
+
+Post.all                       # Only kept posts
+Post.with_discarded            # All Posts
+Post.with_discarded.discarded  # Only discarded posts
+```
+
+**Custom column**
+
+If you're migrating from paranoia, you might want to continue using the same
+column.
+
+``` ruby
+class Post < ActiveRecord::Base
+  include Discard::Model
+  self.discard_column = :deleted_at
+end
+```
+
+## Non-features
+
+* Restoring records (this will probably be added)
+* Discarding dependent records (this will likely be added)
+* Callbacks (this will probably be added)
+* Special handling of AR counter cache columns - The counter cache counts the total number of records, both kept and discarded.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/jhawthorn/discard.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+## Acknowledgments
+
+* [Ben Morgan](https://github.com/BenMorganIO) who has done a great job maintaining paranoia
+* [Ryan Bigg](http://github.com/radar), the original author of paranoia (and many things), as a simpler replacement of acts_as_paranoid
+* All paranoia users and contributors

data/Rakefile

@@ -0,0 +1,9 @@
+require "bundler/gem_tasks"
+
+begin
+  require 'rspec/core/rake_task'
+  RSpec::Core::RakeTask.new(:spec)
+rescue LoadError
+end
+
+task :default => :spec

data/bin/console

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

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'discard/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "discard"
+  spec.version       = Discard::VERSION
+  spec.authors       = ["John Hawthorn"]
+  spec.email         = ["john.hawthorn@gmail.com"]
+
+  spec.summary       = %q{ActiveRecord soft-deletes done right}
+  spec.description   = %q{Allows marking ActiveRecord objects as discarded, and provides scopes for filtering.}
+  spec.homepage      = "https://github.com/jhawthorn/discard"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |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', '< 6'
+  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.5.0"
+  spec.add_development_dependency "database_cleaner", "~> 1.5"
+  spec.add_development_dependency "with_model", "~> 2.0"
+  spec.add_development_dependency "sqlite3"
+end

data/lib/discard.rb

@@ -0,0 +1,4 @@
+require "active_record"
+
+require "discard/version"
+require "discard/model"

data/lib/discard/model.rb

@@ -0,0 +1,23 @@
+module Discard
+  module Model
+    extend ActiveSupport::Concern
+
+    included do
+      class_attribute :discard_column
+      self.discard_column = :discarded_at
+
+      scope :kept, ->{ undiscarded }
+      scope :undiscarded, ->{ where(discard_column => nil) }
+      scope :discarded, ->{ where.not(discard_column => nil) }
+      scope :with_discarded, ->{ unscope(where: discard_column) }
+    end
+
+    def discarded?
+      !!self[self.class.discard_column]
+    end
+
+    def discard
+      touch(self.class.discard_column) unless discarded?
+    end
+  end
+end

data/lib/discard/version.rb

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

metadata

@@ -0,0 +1,163 @@
+--- !ruby/object:Gem::Specification
+name: discard
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- John Hawthorn
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-04-28 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: '6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !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'
+- !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: 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: 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'
+- !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'
+description: Allows marking ActiveRecord objects as discarded, and provides scopes
+  for filtering.
+email:
+- john.hawthorn@gmail.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
+- discard.gemspec
+- lib/discard.rb
+- lib/discard/model.rb
+- lib/discard/version.rb
+homepage: https://github.com/jhawthorn/discard
+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.6.11
+signing_key: 
+specification_version: 4
+summary: ActiveRecord soft-deletes done right
+test_files: []