discard 1.3.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 98ef1bd12f3edc82e8e50b429d39989473cf7b917225ce25068a60e09ef7bb06
-  data.tar.gz: 7762b63af8cd7aeeb848f9778242a02a02be7069586943542916ea3ac12e6d51
+  metadata.gz: c6e47444b3cac75169be133384030483a8ef0a7821a0ee91cce049f63887ebc3
+  data.tar.gz: 28ce8969c023827f43f63a84725291569bde03a0b8e25a8f453a1eed6d8b9dfa
 SHA512:
-  metadata.gz: a43ba463a29c4cd1e1b8c3a79a37b8d140925ef9fe2ee1d23b1aa347c86e746faa390a3a11c60818cf327fb81c0cacd8561a9005a3ddeb9ced016b64258c32ce
-  data.tar.gz: 1a3516836d8a2f21ef1e0385d6b126bec5f5ca380071f473a80ac8d8bd5dc9cd275954fff9052b9964f5d0763cbbd0b2ba4e8da9317e042dbbdd5cb42836cf56
+  metadata.gz: 2562f3ccf49e8622634e375d2cdcb3dd88099e22c311ca0410a979e183d66650b1cc57532ab0ed7f432d3b48facb5dc77892c4403d9dba9ebad26f88222559ed
+  data.tar.gz: c3bb81d6967865a8b66552d78e452016fcce882eb327bb0bb9c08a36db42f09becb88e4f6c98194e651fb579daef28d2ae426b3b4feb54deb770df78437151c4

data/.github/workflows/test.yml

@@ -13,27 +13,42 @@ jobs:
     runs-on: ubuntu-latest
     name: Test on Rails ${{ matrix.rails_version }} and Ruby ${{ matrix.ruby_version }}
     strategy:
+      fail-fast: false
       matrix:
         include:
+          - rails_version: ~> 8.1.0
+            ruby_version: '4.0'
+            sqlite_version: ~> 2.0
+          - rails_version: ~> 8.1.0
+            ruby_version: '3.4'
+            sqlite_version: ~> 2.0
+          - rails_version: ~> 8.0.0
+            ruby_version: '3.4'
+            sqlite_version: ~> 2.0
+          - rails_version: ~> 8.0.0
+            ruby_version: '3.3'
+            sqlite_version: ~> 2.0
+          - rails_version: ~> 7.2.0
+            ruby_version: '3.3'
+            sqlite_version: ~> 2.0
+          - rails_version: ~> 7.2.0
+            ruby_version: '3.2'
+            sqlite_version: ~> 2.0
+          - rails_version: ~> 7.1.0
+            ruby_version: '3.3'
+            sqlite_version: ~> 1.0
           - rails_version: ~> 7.0.0
-            ruby_version: 3.2
-          - rails_version: ~> 7.0.0
-            ruby_version: 3.1
-          - rails_version: ~> 6.1.0
-            ruby_version: '3.0'
-          - rails_version: ~> 6.0.0
-            ruby_version: 2.7
-          - rails_version: ~> 5.2.0
-            ruby_version: 2.6
-          - rails_version: ~> 5.1.0
-            ruby_version: 2.5
+            ruby_version: '3.2'
+            sqlite_version: ~> 1.0
     env:
       RAILS_VERSION: ${{ matrix.rails_version }}
+      SQLITE_VERSION: ${{ matrix.sqlite_version }}
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v6
     - uses: ruby/setup-ruby@v1
       with:
         ruby-version: ${{ matrix.ruby_version }}
-        bundler-cache: true
+    - name: Bundle install
+      run: bundle install
     - name: Test
       run: bundle exec rake 

data/.ruby-version

@@ -0,0 +1 @@
+4.0.1

data/CHANGELOG.md

@@ -1,4 +1,15 @@
-### Unreleased
+### Version 2.0.0
+Release date: 2026-05-27
+
+* Require ActiveRecord >= 7.0; drop support for Rails 6.x and earlier
+* Wrap `#discard` / `#undiscard` in a transaction so callback exceptions roll back the DB write (#84, #77)
+
+### Version 1.4.0
+Release date: 2024-11-05
+
+* Support Rails 8.0 and 8.1 (#110, #111)
+
+* More descriptive error messages (#108)
 
 ### Version 1.3.0
 Release date: 2023-08-17

data/Gemfile

@@ -3,6 +3,10 @@ source 'https://rubygems.org'
 rails_version = ENV['RAILS_VERSION']
 gem 'activerecord', rails_version
 
+if rails_version == '~> 6.1.0'
+  gem 'concurrent-ruby', '1.3.4'
+end
+
 if sqlite_version = ENV['SQLITE_VERSION']
   gem 'sqlite3', sqlite_version
 end

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.2'
+gem 'discard', '~> 2.0'
 ```
 
 And then execute:
@@ -33,6 +33,7 @@ end
 ```
 
 You can either generate a migration using:
+
 ```
 rails generate migration add_discarded_at_to_posts discarded_at:datetime:index
 ```
@@ -47,7 +48,6 @@ class AddDiscardToPosts < ActiveRecord::Migration[5.0]
 end
 ```
 
-
 #### Discard a record
 
 ```ruby
@@ -200,10 +200,15 @@ class Post < ActiveRecord::Base
 end
 ```
 
-*Warning:* Please note that callbacks for save and update are run when discarding/undiscarding a record
+Some important things to note:
+
+- Callbacks for save and update are run when discarding/undiscarding a record.
+- Validations are not run during `#discard` or `#undiscard`. The column is updated via `update_attribute`, which skips validations.
+- The discard column is also flipped *between* the `before_` and `after_` callbacks, so `before_discard` sees `discarded?` as `false` while `after_discard` sees it as `true` (and symmetrically for undiscard). Callbacks gated on `if: :discarded?` will fire accordingly, which is useful when a callback should only run on one side of the transition.
 
 
 #### Performance tuning
+
 `discard_all` and `undiscard_all` is intended to behave like `destroy_all` which has callbacks, validations, and does one query per record. If performance is a big concern, you may consider replacing it with:
 
 `scope.update_all(discarded_at: Time.current)`
@@ -269,7 +274,7 @@ You can find more information about the history and purpose of Discard in [this
 
 ## 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.
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake rspec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
 ## Contributing
 

data/discard.gemspec

@@ -22,10 +22,10 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "activerecord", ">= 4.2", "< 8"
+  spec.add_dependency "activerecord", ">= 7.0", "< 9.0"
   spec.add_development_dependency "bundler"
   spec.add_development_dependency "rake", ">= 10.0"
-  spec.add_development_dependency "rspec", "~> 3.5.0"
+  spec.add_development_dependency "rspec", "~> 3.13"
   spec.add_development_dependency "database_cleaner", "~> 1.5"
   spec.add_development_dependency "with_model", "~> 2.0"
   spec.add_development_dependency "sqlite3"

data/lib/discard/model.rb

@@ -117,8 +117,11 @@ module Discard
     # @return [Boolean] true if successful, otherwise false
     def discard
       return false if discarded?
-      run_callbacks(:discard) do
-        update_attribute(self.class.discard_column, Time.current)
+
+      with_transaction_returning_status do
+        run_callbacks(:discard) do
+          update_attribute(self.class.discard_column, Time.current)
+        end
       end
     end
 
@@ -139,12 +142,15 @@ module Discard
     # @return [Boolean] true if successful, otherwise false
     def undiscard
       return false unless discarded?
-      run_callbacks(:undiscard) do
-        update_attribute(self.class.discard_column, nil)
+
+      with_transaction_returning_status do
+        run_callbacks(:undiscard) do
+          update_attribute(self.class.discard_column, nil)
+        end
       end
     end
 
-    # Discard the record in the database
+    # Undiscard the record in the database
     #
     # There's a series of callbacks associated with #undiscard!. If the
     # <tt>before_undiscard</tt> callback throws +:abort+ the action is cancelled
@@ -159,11 +165,23 @@ module Discard
     private
 
     def _raise_record_not_discarded
-      raise ::Discard::RecordNotDiscarded.new("Failed to discard the record", self)
+      raise ::Discard::RecordNotDiscarded.new(discarded_fail_message, self)
     end
 
     def _raise_record_not_undiscarded
-      raise ::Discard::RecordNotUndiscarded.new("Failed to undiscard the record", self)
+      raise ::Discard::RecordNotUndiscarded.new(undiscarded_fail_message, self)
+    end
+
+    def discarded_fail_message
+      return "A discarded record cannot be discarded" if discarded?
+
+      "Failed to discard the record"
+    end
+
+    def undiscarded_fail_message
+      return "An undiscarded record cannot be undiscarded" if undiscarded?
+
+      "Failed to undiscard the record"
     end
   end
 end

data/lib/discard/version.rb

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

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: discard
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 2.0.0
 platform: ruby
 authors:
 - John Hawthorn
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-08-17 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -16,20 +15,20 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '7.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '8'
+        version: '9.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '7.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '8'
+        version: '9.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -64,14 +63,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.5.0
+        version: '3.13'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.5.0
+        version: '3.13'
 - !ruby/object:Gem::Dependency
   name: database_cleaner
   requirement: !ruby/object:Gem::Requirement
@@ -128,7 +127,7 @@ files:
 - ".github/workflows/test.yml"
 - ".gitignore"
 - ".rspec"
-- ".travis.yml"
+- ".ruby-version"
 - ".yardopts"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
@@ -147,7 +146,6 @@ homepage: https://github.com/jhawthorn/discard
 licenses:
 - MIT
 metadata: {}
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -162,8 +160,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
-signing_key:
+rubygems_version: 3.6.9
 specification_version: 4
 summary: ActiveRecord soft-deletes done right
 test_files: []

data/.travis.yml

@@ -1,28 +0,0 @@
-language: ruby
-cache: bundler
-rvm:
-  - 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.0'
-    - RAILS_VERSION='~> 6.0.0'
-
-matrix:
-  exclude:
-    - 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'