discard 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2418547a70d311cc7d970ce492f505a0807db23a03eebe2ae1e1f7589a0edb8b
-  data.tar.gz: a45947c018416ee63a873fc0f94f143f20a6a5e34892420893bf3fe50b9a5406
+  metadata.gz: 1aa5617487d7e2fed08d3afbe5e88e92aaef5371c1678a7f3c4acf532341ab56
+  data.tar.gz: 4f4da23a43a04274325db950a05bbfb3ff478430bea166c5c9d941fb2181769e
 SHA512:
-  metadata.gz: 4111df84d2628abc622a64bcb730ef1acc1b5d509ed2c226a5f5b5ca96fecaaebf65bf39fa2f54392c9161198e496fd84aa78f72aebf921c21c9c3cdd18ac687
-  data.tar.gz: a881fee07ba21fbf6281f966ff51607a5f2acfb127a43fd35e3a9bfbc2c2dcdfec1962e14ba475e2c33dae81e0dca56f5de8172c4afe3e9536e5f36377d33b82
+  metadata.gz: 96650925ee2f6dd7c348059f17320decf4f26e6b4c942d046440d99bc23307059f48e2fc5792389bafc6cfa0594ff1382c671cc0f4e6ad5c312d83e964872a61
+  data.tar.gz: 2299ad7c8cdd56eddf50497351e2a654732aa72caca5d319cf6218185323a7cf9769113d0f62185ae7927acbbbeb4bec98b4963e5062590aadcc379b5581ec4a

data/.github/ISSUE_TEMPLATE/bug-report.md

@@ -0,0 +1,24 @@
+---
+name: Bug Report
+about: Is Discard not working correctly for you? Let us know!
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Additional context**
+Please tells us your Rails and Ruby versions, and anything else that might be helpful about the environment you encountered the issue.

data/.github/ISSUE_TEMPLATE/feature-proposal.md

@@ -0,0 +1,10 @@
+---
+name: Feature Proposal
+about: Discard is feature-complete, but we're happy to hear you out!
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Discard is feature-complete, but if you have an idea for a feature that will benefit all discard users and that won't offer a significant maintenance burden, we're happy to listen. Explain it as best you can and we'll let you know if it's something we'd like to have or if it's something that might be a better off as an extension or fork.**

data/.github/workflows/test.yml

@@ -0,0 +1,30 @@
+name: Test
+
+on:
+  push:
+    branches:
+    - master
+  pull_request:
+    branches:
+    - master
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    name: Test on Rails ${{ matrix.rails_version }}
+    strategy:
+      matrix:
+        rails_version:
+          - ~> 5.1.0
+          - ~> 5.2.0
+          - ~> 6.0.0
+    container: docker://ruby
+    steps:
+    - uses: actions/checkout@v1
+    - name: Build and test
+      run: |
+        gem install bundler
+        bundle install --jobs 4 --retry 3
+        bundle exec rake
+      env:
+        RAILS_VERSION:  ${{ matrix.rails_version }}

data/.travis.yml

@@ -1,24 +1,28 @@
-sudo: false
 language: ruby
+cache: bundler
 rvm:
-  - 2.2.10
-  - 2.3.8
-  - 2.4.6
-  - 2.5.5
-  - 2.6.3
+  - 2.2
+  - 2.3
+  - 2.4
+  - 2.5
+  - 2.6
+  - 2.7
 env:
   matrix:
     - RAILS_VERSION='~> 4.2.0' SQLITE_VERSION='~> 1.3.6'
     - RAILS_VERSION='~> 5.0.0' SQLITE_VERSION='~> 1.3.6'
     - RAILS_VERSION='~> 5.1.0'
-    - RAILS_VERSION='~> 5.2.x'
-    - RAILS_VERSION='~> 6.0.0.beta3'
+    - RAILS_VERSION='~> 5.2.0'
+    - RAILS_VERSION='~> 6.0.0'
 
 matrix:
   exclude:
-    - rvm: 2.2.10
-      env: RAILS_VERSION='~> 6.0.0.beta3'
-    - rvm: 2.3.8
-      env: RAILS_VERSION='~> 6.0.0.beta3'
-    - rvm: 2.4.6
-      env: RAILS_VERSION='~> 6.0.0.beta3'
+    - rvm: 2.2
+      env: RAILS_VERSION='~> 6.0.0'
+    - rvm: 2.3
+      env: RAILS_VERSION='~> 6.0.0'
+    - rvm: 2.4
+      env: RAILS_VERSION='~> 6.0.0'
+    # Rails 4.2 uses BigDecimal.new, which Ruby 2.7 removed
+    - rvm: 2.7
+      env: RAILS_VERSION='~> 4.2.0' SQLITE_VERSION='~> 1.3.6'

data/CHANGELOG.md

@@ -1,5 +1,8 @@
 ### Unreleased
 
+* Add `discard_all!` and `undiscard_all!`
+* Add `undiscarded?` and `kept?` to match the scopes of the same names
+
 ### Version 1.1.0
 Release date: 2019-05-03
 

data/README.md

@@ -13,7 +13,7 @@ A simple ActiveRecord mixin to add conventions for flagging records as discarded
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'discard', '~> 1.0'
+gem 'discard', '~> 1.2'
 ```
 
 And then execute:
@@ -57,7 +57,10 @@ Post.discarded       # => []
 
 post = Post.first   # => #<Post id: 1, ...>
 post.discard        # => true
+post.discard!       # => Discard::RecordNotDiscarded: Failed to discard the record
 post.discarded?     # => true
+post.undiscarded?   # => false
+post.kept?          # => false
 post.discarded_at   # => 2017-04-18 18:49:49 -0700
 
 Post.all             # => [#<Post id: 1, ...>]
@@ -82,6 +85,8 @@ end
 ```ruby
 post = Post.first   # => #<Post id: 1, ...>
 post.undiscard      # => true
+post.undiscard!     # => Discard::RecordNotUndiscarded: Failed to undiscard the record
+post.discarded_at   # => nil
 ```
 
 ***From a controller***
@@ -123,6 +128,10 @@ class Comment < ActiveRecord::Base
 
   include Discard::Model
   scope :kept, -> { undiscarded.joins(:post).merge(Post.kept) }
+
+  def kept?
+    undiscarded? && post.kept?
+  end
 end
 
 Comment.kept
@@ -220,6 +229,12 @@ end
 * Recursive discards (like AR's dependent: destroy) - This can be avoided using queries (See "Working with associations") or emulated using callbacks.
 * Recursive restores - This concept is fundamentally broken, but not necessary if the recursive discards are avoided.
 
+## Extensions
+
+Discard provides the smallest subset of soft-deletion features that we think are useful to all users of the gem. We welcome the addition of gems that work with Discard to provide additional features.
+
+- [discard-rails-observers](https://github.com/pelargir/discard-rails-observers) integrates discard with the [rails-observers gem](https://github.com/rails/rails-observers)
+
 ## Why not paranoia or acts_as_paranoid?
 
 I've worked with and have helped maintain
@@ -256,7 +271,11 @@ After checking out the repo, run `bin/setup` to install dependencies. Then, run
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/jhawthorn/discard.
+Please consider filing an issue with the details of any features you'd like to see before implementing them. Discard is feature-complete and we are only interested in adding additional features that won't require substantial maintenance burden and that will benefit all users of the gem. We encourage anyone that needs additional or different behaviour to either create their own gem that builds off of discard or implement a new package with the different behaviour.
+
+Discard is very simple and we like it that way. Creating your own clone or fork with slightly different behaviour may not be that much work!
+
+If you find a bug in discard, please report it! We try to keep up with any issues and keep the gem running smoothly for everyone! You can report issues [here](https://github.com/jhawthorn/discard/issues).
 
 ## License
 

data/lib/discard/model.rb

@@ -43,6 +43,25 @@ module Discard
         kept.each(&:discard)
       end
 
+      # Discards the records by instantiating each
+      # record and calling its {#discard!} method.
+      # Each object's callbacks are executed.
+      # Returns the collection of objects that were discarded.
+      #
+      # Note: Instantiation, callback execution, and update of each
+      # record can be time consuming when you're discarding many records at
+      # once. It generates at least one SQL +UPDATE+ query per record (or
+      # possibly more, to enforce your callbacks). If you want to discard many
+      # rows quickly, without concern for their associations or callbacks, use
+      # #update_all!(discarded_at: Time.current) instead.
+      #
+      # ==== Examples
+      #
+      #   Person.where(age: 0..18).discard_all!
+      def discard_all!
+        kept.each(&:discard!)
+      end
+
       # Undiscards the records by instantiating each
       # record and calling its {#undiscard} method.
       # Each object's callbacks are executed.
@@ -61,6 +80,25 @@ module Discard
       def undiscard_all
         discarded.each(&:undiscard)
       end
+
+      # Undiscards the records by instantiating each
+      # record and calling its {#undiscard!} method.
+      # Each object's callbacks are executed.
+      # Returns the collection of objects that were undiscarded.
+      #
+      # Note: Instantiation, callback execution, and update of each
+      # record can be time consuming when you're undiscarding many records at
+      # once. It generates at least one SQL +UPDATE+ query per record (or
+      # possibly more, to enforce your callbacks). If you want to undiscard many
+      # rows quickly, without concern for their associations or callbacks, use
+      # #update_all!(discarded_at: nil) instead.
+      #
+      # ==== Examples
+      #
+      #   Person.where(age: 0..18).undiscard_all!
+      def undiscard_all!
+        discarded.each(&:undiscard!)
+      end
     end
 
     # @return [Boolean] true if this record has been discarded, otherwise false
@@ -68,11 +106,17 @@ module Discard
       self[self.class.discard_column].present?
     end
 
+    # @return [Boolean] false if this record has been discarded, otherwise true
+    def undiscarded?
+      !discarded?
+    end
+    alias kept? undiscarded?
+
     # Discard the record in the database
     #
     # @return [Boolean] true if successful, otherwise false
     def discard
-      return if discarded?
+      return false if discarded?
       run_callbacks(:discard) do
         update_attribute(self.class.discard_column, Time.current)
       end

data/lib/discard/version.rb

@@ -2,5 +2,5 @@
 
 module Discard
   # Discard version
-  VERSION = "1.1.0".freeze
+  VERSION = "1.2.0".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: discard
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - John Hawthorn
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-05-03 00:00:00.000000000 Z
+date: 2020-02-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -122,6 +122,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/ISSUE_TEMPLATE/bug-report.md"
+- ".github/ISSUE_TEMPLATE/feature-proposal.md"
+- ".github/workflows/test.yml"
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
@@ -158,7 +161,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.1
+rubygems_version: 3.1.0.pre2
 signing_key: 
 specification_version: 4
 summary: ActiveRecord soft-deletes done right