counter_culture 1.11.0 → 1.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b8e94799083d30c0bd97dbcdd70290c18bcfcd68
-  data.tar.gz: 49074978dffb068623ecf6aec34483d84d4f3704
+  metadata.gz: f9d98f26efe6fc7cba57f168e7da8b2d9714df7c
+  data.tar.gz: 6b0b08fef2199be674313c4bac316b16cc40ac8d
 SHA512:
-  metadata.gz: 12d07d5c17e2f17eaadf865f180849b2a140f5d6a59cf074fdcbd98ac27dae74c0a340052a4bf1ea444029d592be2270d5b93985d599c7615287bafa31c8edd3
-  data.tar.gz: e5c827862773bb11853e2ee918b3b6559af9fcc087db6ec5bfd50cf428efed0d4fdd7560f0e3099e4e2237af6c17c7e31cce7a951af26c879953d11912638924
+  metadata.gz: f5174d35328f38ace6423f37c183a9d9f377508b50ee31d6e8c13a9af0fe39e563711898176e8c2911ae7e7b8c669c5e32dc9901b1d55d346bb3a3ba0437706a
+  data.tar.gz: 053cb5c12961aaf86a6bd0dbb43e23ebd1d5a05b2d18c39fac6e741518286ca4509e209a171fa84d1ee411c860228f535e11a7eedf1ff97c5d54a3dc92178d59

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## 1.12.0 (June 8, 2018)
+
+Improvements:
+  - Adds support for the [Discard](https://github.com/jhawthorn/discard) soft-delete gem (#220)
+
 ## 1.11.0 (May 4, 2018)
 
 Bugfixes:

data/Gemfile

@@ -26,8 +26,18 @@ group :development, :test do
   gem "awesome_print"
   gem "timecop"
 
-  # to test the integration
-  gem "paranoia"
+  # To test integrations
+
+  # Both the paranoia and discard integrations require Rails > 4.2
+  # Actually parsing the resolved rails version is complicated, so
+  # we're basing this on the incompatible Rails version strings from
+  # .travis.yml
+
+  unless ['~> 3.2.0', '~> 4.0.0', '~> 4.1.0'].include?(rails)
+    gem "discard"
+    gem "paranoia"
+  end
+
   if RUBY_VERSION < "2.3.0"
     gem "paper_trail", "< 9.0.0"
   else

data/README.md

@@ -313,13 +313,16 @@ Product.counter_culture_fix_counts skip_unsupported: true
 
 Manually populating counter caches with dynamically over-written foreign keys (```:foreign_key_values``` option) is not supported. You will have to write code to handle this case yourself.
 
-### Soft-deletes / `paranoia` gem
+### Soft-deletes with `paranoia` or `discard`
 
-This gem will keep counters correctly updated when using the
-[`paranoia` gem](https://github.com/rubysherpas/paranoia)
-for soft-delete support. However, to ensure that counts are incremented after a
-restore you have to make sure that the call to `acts_as_paranoid` comes before
-the call to `counter_culture` in your model:
+This gem will keep counters correctly updated in Rails 4.2 or later when using
+[paranoia](https://github.com/rubysherpas/paranoia) or
+[discard](https://github.com/jhawthorn/discard) for soft-delete support.
+However, to ensure that counts are incremented after a restore you have
+to make sure to set up soft deletion (via `acts_as_paranoid` or
+`include Discard::Model`) before the call to `counter_culture` in your model:
+
+#### Paranoia
 
 ```ruby
 class SoftDelete < ActiveRecord::Base
@@ -330,6 +333,17 @@ class SoftDelete < ActiveRecord::Base
 end
 ```
 
+#### Discard
+
+```ruby
+class SoftDelete < ActiveRecord::Base
+  include Discard::Model
+
+  belongs_to :company
+  counter_culture :company
+end
+```
+
 ### PaperTrail integration
 
 If you are using the [`paper_trail` gem](https://github.com/airblade/paper_trail)

data/VERSION

@@ -1 +1 @@
-1.11.0
+1.12.0

data/counter_culture.gemspec

@@ -2,16 +2,16 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: counter_culture 1.11.0 ruby lib
+# stub: counter_culture 1.12.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "counter_culture"
-  s.version = "1.11.0"
+  s.version = "1.12.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib"]
   s.authors = ["Magnus von Koeller"]
-  s.date = "2018-05-07"
+  s.date = "2018-06-08"
   s.description = "counter_culture provides turbo-charged counter caches that are kept up-to-date not just on create and destroy, that support multiple levels of indirection through relationships, allow dynamic column names and that avoid deadlocks by updating in the after_commit callback."
   s.email = "magnus@vonkoeller.de"
   s.extra_rdoc_files = [
@@ -60,7 +60,8 @@ Gem::Specification.new do |s|
     "spec/models/simple_dependent.rb",
     "spec/models/simple_main.rb",
     "spec/models/simple_review.rb",
-    "spec/models/soft_delete.rb",
+    "spec/models/soft_delete_discard.rb",
+    "spec/models/soft_delete_paranoia.rb",
     "spec/models/subcateg.rb",
     "spec/models/transaction.rb",
     "spec/models/twitter_review.rb",
@@ -134,6 +135,7 @@ Gem::Specification.new do |s|
       s.add_development_dependency(%q<rspec>, ["~> 3.0"])
       s.add_development_dependency(%q<awesome_print>, [">= 0"])
       s.add_development_dependency(%q<timecop>, [">= 0"])
+      s.add_development_dependency(%q<discard>, [">= 0"])
       s.add_development_dependency(%q<paranoia>, [">= 0"])
       s.add_development_dependency(%q<paper_trail>, [">= 0"])
       s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
@@ -148,6 +150,7 @@ Gem::Specification.new do |s|
       s.add_dependency(%q<rspec>, ["~> 3.0"])
       s.add_dependency(%q<awesome_print>, [">= 0"])
       s.add_dependency(%q<timecop>, [">= 0"])
+      s.add_dependency(%q<discard>, [">= 0"])
       s.add_dependency(%q<paranoia>, [">= 0"])
       s.add_dependency(%q<paper_trail>, [">= 0"])
       s.add_dependency(%q<rdoc>, ["~> 3.12"])
@@ -163,6 +166,7 @@ Gem::Specification.new do |s|
     s.add_dependency(%q<rspec>, ["~> 3.0"])
     s.add_dependency(%q<awesome_print>, [">= 0"])
     s.add_dependency(%q<timecop>, [">= 0"])
+    s.add_dependency(%q<discard>, [">= 0"])
     s.add_dependency(%q<paranoia>, [">= 0"])
     s.add_dependency(%q<paper_trail>, [">= 0"])
     s.add_dependency(%q<rdoc>, ["~> 3.12"])

data/lib/counter_culture/extensions.rb

@@ -19,6 +19,7 @@ module CounterCulture
 
           # initialize callbacks only once
           after_create :_update_counts_after_create
+
           before_destroy :_update_counts_after_destroy, if: -> (model) do
             if model.respond_to?(:paranoia_destroyed?)
               !model.paranoia_destroyed?
@@ -26,12 +27,22 @@ module CounterCulture
               true
             end
           end
+
           after_update :_update_counts_after_update
+
           if respond_to?(:before_restore)
             before_restore :_update_counts_after_create,
               if: -> (model) { model.deleted? }
           end
 
+          if defined?(Discard::Model) && include?(Discard::Model)
+            before_discard :_update_counts_after_destroy,
+              if: ->(model) { !model.discarded? }
+
+            before_undiscard :_update_counts_after_create,
+              if: ->(model) { model.discarded? }
+          end
+
           # we keep a list of all counter caches we must maintain
           @after_commit_counter_cache = []
         end

data/lib/counter_culture/reconciler.rb

@@ -226,6 +226,14 @@ module CounterCulture
             if model.column_names.include?('deleted_at')
               joins_sql += " AND #{target_table_alias}.deleted_at IS NULL"
             end
+
+            # respect the discard column if it exists
+            if defined?(Discard::Model) &&
+               model.include?(Discard::Model) &&
+               model.column_names.include?(model.discard_column.to_s)
+
+              joins_sql += " AND #{target_table_alias}.#{model.discard_column} IS NULL"
+            end
           end
           joins_sql
         end

data/spec/counter_culture_spec.rb

@@ -21,7 +21,8 @@ require 'models/another_post'
 require 'models/another_post_comment'
 require 'models/person'
 require 'models/transaction'
-require 'models/soft_delete'
+require 'models/soft_delete_discard'
+require 'models/soft_delete_paranoia'
 require 'models/conversation'
 require 'models/candidate_profile'
 require 'models/candidate'
@@ -1699,59 +1700,115 @@ describe "CounterCulture" do
     end
   end
 
-  describe "when using acts_as_paranoia" do
+  describe "when using discard for soft deletes" do
     it "works" do
       skip("Unsupported in this version of Rails") if Rails.version < "4.2.0"
       company = Company.create!
-      expect(company.soft_deletes_count).to eq(0)
-      sd = SoftDelete.create!(company_id: company.id)
-      expect(company.reload.soft_deletes_count).to eq(1)
+      expect(company.soft_delete_discards_count).to eq(0)
+      sd = SoftDeleteDiscard.create!(company_id: company.id)
+      expect(company.reload.soft_delete_discards_count).to eq(1)
+
+      sd.discard
+      sd.reload
+      expect(sd).to be_discarded
+      expect(company.reload.soft_delete_discards_count).to eq(0)
+
+      company.update_attributes(soft_delete_discards_count: 100)
+      expect(company.reload.soft_delete_discards_count).to eq(100)
+      SoftDeleteDiscard.counter_culture_fix_counts
+      expect(company.reload.soft_delete_discards_count).to eq(0)
+
+      sd.undiscard
+      expect(company.reload.soft_delete_discards_count).to eq(1)
+    end
+
+    it "runs destroy callback only once" do
+      skip("Unsupported in this version of Rails") if Rails.version < "4.2.0"
+
+      company = Company.create!
+      sd = SoftDeleteDiscard.create!(company_id: company.id)
+
+      expect(company.reload.soft_delete_discards_count).to eq(1)
+
+      sd.discard
+      expect(company.reload.soft_delete_discards_count).to eq(0)
+
+      sd.discard
+      expect(company.reload.soft_delete_discards_count).to eq(0)
+    end
+
+    it "runs restore callback only once" do
+      skip("Unsupported in this version of Rails") if Rails.version < "4.2.0"
+
+      company = Company.create!
+      sd = SoftDeleteDiscard.create!(company_id: company.id)
+
+      expect(company.reload.soft_delete_discards_count).to eq(1)
+
+      sd.discard
+      expect(company.reload.soft_delete_discards_count).to eq(0)
+
+      sd.undiscard
+      expect(company.reload.soft_delete_discards_count).to eq(1)
+
+      sd.undiscard
+      expect(company.reload.soft_delete_discards_count).to eq(1)
+    end
+  end
+
+  describe "when using paranoia for soft deletes" do
+    it "works" do
+      skip("Unsupported in this version of Rails") if Rails.version < "4.2.0"
+      company = Company.create!
+      expect(company.soft_delete_paranoia_count).to eq(0)
+      sd = SoftDeleteParanoia.create!(company_id: company.id)
+      expect(company.reload.soft_delete_paranoia_count).to eq(1)
 
       sd.destroy
       sd.reload
       expect(sd.deleted_at).to be_truthy
-      expect(company.reload.soft_deletes_count).to eq(0)
+      expect(company.reload.soft_delete_paranoia_count).to eq(0)
 
-      company.update_attributes(soft_deletes_count: 100)
-      expect(company.reload.soft_deletes_count).to eq(100)
-      SoftDelete.counter_culture_fix_counts
-      expect(company.reload.soft_deletes_count).to eq(0)
+      company.update_attributes(soft_delete_paranoia_count: 100)
+      expect(company.reload.soft_delete_paranoia_count).to eq(100)
+      SoftDeleteParanoia.counter_culture_fix_counts
+      expect(company.reload.soft_delete_paranoia_count).to eq(0)
 
       sd.restore
-      expect(company.reload.soft_deletes_count).to eq(1)
+      expect(company.reload.soft_delete_paranoia_count).to eq(1)
     end
 
     it "runs destroy callback only once" do
       skip("Unsupported in this version of Rails") if Rails.version < "4.2.0"
 
       company = Company.create!
-      sd = SoftDelete.create!(company_id: company.id)
+      sd = SoftDeleteParanoia.create!(company_id: company.id)
 
-      expect(company.reload.soft_deletes_count).to eq(1)
+      expect(company.reload.soft_delete_paranoia_count).to eq(1)
 
       sd.destroy
-      expect(company.reload.soft_deletes_count).to eq(0)
+      expect(company.reload.soft_delete_paranoia_count).to eq(0)
 
       sd.destroy
-      expect(company.reload.soft_deletes_count).to eq(0)
+      expect(company.reload.soft_delete_paranoia_count).to eq(0)
     end
 
     it "runs restore callback only once" do
       skip("Unsupported in this version of Rails") if Rails.version < "4.2.0"
 
       company = Company.create!
-      sd = SoftDelete.create!(company_id: company.id)
+      sd = SoftDeleteParanoia.create!(company_id: company.id)
 
-      expect(company.reload.soft_deletes_count).to eq(1)
+      expect(company.reload.soft_delete_paranoia_count).to eq(1)
 
       sd.destroy
-      expect(company.reload.soft_deletes_count).to eq(0)
+      expect(company.reload.soft_delete_paranoia_count).to eq(0)
 
       sd.restore
-      expect(company.reload.soft_deletes_count).to eq(1)
+      expect(company.reload.soft_delete_paranoia_count).to eq(1)
 
       sd.restore
-      expect(company.reload.soft_deletes_count).to eq(1)
+      expect(company.reload.soft_delete_paranoia_count).to eq(1)
     end
   end
 

data/spec/models/soft_delete_discard.rb

@@ -0,0 +1,6 @@
+class SoftDeleteDiscard < ActiveRecord::Base
+  include Discard::Model if defined?(Discard::Model)
+
+  belongs_to :company
+  counter_culture :company
+end

data/spec/models/soft_delete_paranoia.rb

@@ -0,0 +1,6 @@
+class SoftDeleteParanoia < ActiveRecord::Base
+  acts_as_paranoid if respond_to?(:acts_as_paranoid)
+
+  belongs_to :company
+  counter_culture :company
+end

data/spec/schema.rb

@@ -24,7 +24,8 @@ ActiveRecord::Schema.define(:version => 20120522160158) do
     t.integer  "review_approvals_count",      :default => 0, :null => false
     t.integer  "parent_id"
     t.integer  "children_count",      :default => 0, :null => false
-    t.integer  "soft_deletes_count",  :default => 0, :null => false
+    t.integer  "soft_delete_paranoia_count",  :default => 0, :null => false
+    t.integer  "soft_delete_discards_count",  :default => 0, :null => false
     t.datetime "created_at"
     t.datetime "updated_at"
   end
@@ -176,11 +177,16 @@ ActiveRecord::Schema.define(:version => 20120522160158) do
     t.integer "monetary_value", :null => false
   end
 
-  create_table "soft_deletes", :force => true do |t|
+  create_table "soft_delete_paranoia", :force => true do |t|
     t.integer "company_id", :null => false
     t.timestamp "deleted_at"
   end
 
+  create_table "soft_delete_discards", :force => true do |t|
+    t.integer "company_id", :null => false
+    t.timestamp "discarded_at"
+  end
+
   #polymorphic
   create_table "poly_images", :force => true do |t|
     t.integer "imageable_id", :null => true

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: counter_culture
 version: !ruby/object:Gem::Version
-  version: 1.11.0
+  version: 1.12.0
 platform: ruby
 authors:
 - Magnus von Koeller
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-07 00:00:00.000000000 Z
+date: 2018-06-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: after_commit_action
@@ -122,6 +122,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: discard
+  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: paranoia
   requirement: !ruby/object:Gem::Requirement
@@ -244,7 +258,8 @@ files:
 - spec/models/simple_dependent.rb
 - spec/models/simple_main.rb
 - spec/models/simple_review.rb
-- spec/models/soft_delete.rb
+- spec/models/soft_delete_discard.rb
+- spec/models/soft_delete_paranoia.rb
 - spec/models/subcateg.rb
 - spec/models/transaction.rb
 - spec/models/twitter_review.rb

data/spec/models/soft_delete.rb

@@ -1,6 +0,0 @@
-class SoftDelete < ActiveRecord::Base
-  acts_as_paranoid
-
-  belongs_to :company
-  counter_culture :company
-end