awesome_counter_cache 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a438135d0099fbe7652b5f754180b2f396650129a62066e364dee2fd69666bc4
-  data.tar.gz: 27ce6f7009265b2a1022793a1ff43af3e57a9f9dd6340d660299dbe1afbc78a1
+  metadata.gz: da9f3b10f0b3d3f91d23585c3cbb6234b585987d7d4ba4704026de6871830e66
+  data.tar.gz: '09a7a1388a4d93709e10712d8dd3d8a9c7ad0af76a456d4b2b2b674a1f697d6b'
 SHA512:
-  metadata.gz: 1420eddc1824fc764e9f2a62a8d6464860366b945bd8112ef94d28082fd718cb6fecc617d32b7c50a67a9c0f5f79e593d007e1c2f3ec4e5609b34388cca3e6a7
-  data.tar.gz: ef5c2e47f810091cb35a302f1a738bbdf93336efb6a72969fc6116f0cdfc361cb4c103d13f6cfcc6f8ba809433c22243485246cd8b82be44347fd604a904de82
+  metadata.gz: 635c8b6ba277428198ab978addf81aa9723b713d26f4dcf6a6a26bdc84ef84a444c7450be3cb4b1419afbb699be7f60fbaafcca92a7c8bb328f5d794cfcd274b
+  data.tar.gz: ccd61848475acd36066de42204772e0ea8d0778e4a4ebda7b7dc26f3fe1de0f13cdc4f91d083e63a770a2df61328b2ddfe15cc15049a04e805f20fa1d703ba8e

data/README.md

@@ -1,3 +1,9 @@
 # AwesomeCounterCache
 
-This project rocks and uses MIT-LICENSE.
+This project rocks and uses MIT-LICENSE.
+
+## Testing
+
+```bash
+DATABASE_URL=sqlite3://db/home/build/project/spec/dummy/db/test.sqlite3 bundle exec rspec
+```

data/lib/awesome_counter_cache/class_methods.rb

@@ -1,28 +1,32 @@
 module AwesomeCounterCache::ClassMethods
   def awesome_counter_cache_for(relation_name, args = {})
     id = awesome_counter_caches.length
-
     args[:column_name] ||= "#{model_name.plural}_count"
     args[:delta_magnitude] ||= proc { 1 }
+    args[:relation_foreign_key] = reflections.fetch(relation_name.to_s).foreign_key
     args[:relation_name] = relation_name
     args[:id] = id
 
-    awesome_counter_caches[id] = args
+    counter_cache = AwesomeCounterCache::CounterCache.new(**args)
+    awesome_counter_caches[id] = counter_cache
+    awesome_counter_cache_init_callbacks(counter_cache)
+  end
 
+  def awesome_counter_cache_init_callbacks(counter_cache)
     after_initialize do |model|
-      awesome_counter_cache_after_initialize(args, model)
+      awesome_counter_cache_after_initialize(counter_cache, model)
     end
 
     after_commit on: :create do |model|
-      awesome_counter_cache_after_commit_on_create(args, model, relation_name)
+      awesome_counter_cache_after_commit_on_create(counter_cache, model)
     end
 
     after_commit on: :destroy do |model|
-      awesome_counter_cache_after_commit_on_destroy(args, model, relation_name)
+      awesome_counter_cache_after_commit_on_destroy(counter_cache, model)
     end
 
     after_commit on: :update do |model|
-      awesome_counter_cache_after_commit_on_update(args, model, relation_name)
+      awesome_counter_cache_after_commit_on_update(counter_cache, model)
     end
   end
 

data/lib/awesome_counter_cache/counter_cache.rb

@@ -0,0 +1,11 @@
+class AwesomeCounterCache::CounterCache
+  attr_accessor :column_name, :delta_magnitude, :id, :relation_foreign_key, :relation_name
+
+  def initialize(column_name:, delta_magnitude:, id:, relation_foreign_key:, relation_name:)
+    @column_name = column_name
+    @delta_magnitude = delta_magnitude
+    @id = id
+    @relation_foreign_key = relation_foreign_key
+    @relation_name = relation_name
+  end
+end

data/lib/awesome_counter_cache/instance_methods.rb

@@ -1,49 +1,55 @@
 module AwesomeCounterCache::InstanceMethods
-  def awesome_counter_cache_after_commit_on_create(args, model, relation_name)
-    id = args.fetch(:id)
-    @awesome_counter_cache_data.fetch(id)[:delta_current] = args.fetch(:delta_magnitude).call(model)
-    model.create_awesome_counter_cache_for(relation_name, @awesome_counter_cache_data.fetch(id), args)
-    @awesome_counter_cache_data[id][:delta_original] = @awesome_counter_cache_data[id].delete(:delta_current)
+  def awesome_counter_cache_after_commit_on_create(counter_cache, model)
+    id = counter_cache.id
+    state = @awesome_counter_cache_data.fetch(id)
+    state.delta_current = counter_cache.delta_magnitude.call(model)
+    model.create_awesome_counter_cache_for(counter_cache.relation_name, @awesome_counter_cache_data.fetch(id), counter_cache)
+    state.delta_original = state.delta_current
+    state.delta_current = nil
   end
 
-  def awesome_counter_cache_after_commit_on_destroy(args, model, relation_name)
-    id = args.fetch(:id)
-    @awesome_counter_cache_data.fetch(id)[:delta_current] = args.fetch(:delta_magnitude).call(model)
-    model.destroy_awesome_counter_cache_for(relation_name, @awesome_counter_cache_data.fetch(id), args)
-    @awesome_counter_cache_data[id][:delta_original] = @awesome_counter_cache_data[id].delete(:delta_current)
+  def awesome_counter_cache_after_commit_on_destroy(counter_cache, model)
+    id = counter_cache.id
+    state = @awesome_counter_cache_data.fetch(id)
+    state.delta_current = counter_cache.delta_magnitude.call(model)
+    model.destroy_awesome_counter_cache_for(counter_cache.relation_name, @awesome_counter_cache_data.fetch(id), counter_cache)
+    state.delta_original = state.delta_current
+    state.delta_current = nil
   end
 
-  def awesome_counter_cache_after_commit_on_update(args, model, relation_name)
-    id = args.fetch(:id)
-    @awesome_counter_cache_data.fetch(id)[:delta_current] = args.fetch(:delta_magnitude).call(model)
-    model.update_awesome_counter_cache_for(relation_name, @awesome_counter_cache_data.fetch(id), args)
-    @awesome_counter_cache_data[id][:delta_original] = @awesome_counter_cache_data[id].delete(:delta_current)
+  def awesome_counter_cache_after_commit_on_update(counter_cache, model)
+    id = counter_cache.id
+    state = @awesome_counter_cache_data.fetch(id)
+    state.delta_current = counter_cache.delta_magnitude.call(model)
+    model.update_awesome_counter_cache_for(counter_cache.relation_name, @awesome_counter_cache_data.fetch(id), counter_cache)
+    state.delta_original = state.delta_current
+    state.delta_current = nil
   end
 
-  def awesome_counter_cache_after_initialize(args, model)
-    id = args.fetch(:id)
+  def awesome_counter_cache_after_initialize(counter_cache, model)
+    id = counter_cache.id
 
     @awesome_counter_cache_data ||= {}
-    @awesome_counter_cache_data[id] ||= {}
+    @awesome_counter_cache_data[id] ||= AwesomeCounterCache::State.new
 
     primary_key_column = self.class.primary_key
 
     if read_attribute(primary_key_column).nil? # `new_record?` always returns false so check if primary key is nil instead - kaspernj
-      @awesome_counter_cache_data.fetch(id)[:delta_original] ||= 0
+      @awesome_counter_cache_data.fetch(id).delta_original ||= 0
     else
-      @awesome_counter_cache_data.fetch(id)[:delta_original] ||= args.fetch(:delta_magnitude).call(model)
+      @awesome_counter_cache_data.fetch(id).delta_original ||= counter_cache.delta_magnitude.call(model)
     end
   end
 
-  def create_awesome_counter_cache_for(relation_name, state_data, args)
+  def create_awesome_counter_cache_for(relation_name, state, counter_cache)
     relation_model = __send__(relation_name)
     return if relation_model.blank?
 
-    addition = state_data.fetch(:delta_current)
+    addition = state.delta_current
 
     if addition != 0
       primary_key_value = relation_model.read_attribute(relation_model.class.primary_key)
-      relation_model.class.update_counters(primary_key_value, args.fetch(:column_name) => addition)
+      relation_model.class.update_counters(primary_key_value, counter_cache.column_name => addition) # rubocop:disable Rails/SkipsModelValidations
     end
   end
 
@@ -54,32 +60,45 @@ module AwesomeCounterCache::InstanceMethods
   end
 
   def awesome_counter_cache_reset_original_values
-    self.class.awesome_counter_caches.each do |id, args|
-      @awesome_counter_cache_data.fetch(id)[:delta_original] = args.fetch(:delta_magnitude).call(self)
+    self.class.awesome_counter_caches.each do |id, counter_cache|
+      state = @awesome_counter_cache_data.fetch(id)
+      state.delta_original = counter_cache.delta_magnitude.call(self)
     end
   end
 
-  def destroy_awesome_counter_cache_for(relation_name, state_data, args)
+  def destroy_awesome_counter_cache_for(relation_name, state, counter_cache)
     relation_model = __send__(relation_name)
     return if relation_model.blank?
 
-    addition = -state_data.fetch(:delta_original)
+    addition = -state.delta_original
 
     if addition != 0
       primary_key_value = relation_model.read_attribute(relation_model.class.primary_key)
-      relation_model.class.update_counters(primary_key_value, args.fetch(:column_name) => addition)
+      relation_model.class.update_counters(primary_key_value, counter_cache.column_name => addition) # rubocop:disable Rails/SkipsModelValidations
     end
   end
 
-  def update_awesome_counter_cache_for(relation_name, state_data, args)
-    relation_model = __send__(relation_name)
-    return if relation_model.blank?
-
-    addition = state_data.fetch(:delta_current) - state_data.fetch(:delta_original)
-
-    if addition != 0
-      primary_key_value = relation_model.read_attribute(relation_model.class.primary_key)
-      relation_model.class.update_counters(primary_key_value, args.fetch(:column_name) => addition)
+  def update_awesome_counter_cache_for(relation_name, state, counter_cache) # rubocop:disable Metrics/AbcSize
+    addition = state.delta_current - state.delta_original
+    relation_model_class = self.class.reflections.fetch(relation_name.to_s).klass
+    primary_key_value = read_attribute(counter_cache.relation_foreign_key)
+
+    if saved_changes.key?(counter_cache.relation_foreign_key)
+      # Record change from one to another - reduce and increase based on previously recorded values
+      old_record_id = saved_changes.fetch(counter_cache.relation_foreign_key).first
+
+      if old_record_id && !state.delta_original.zero?
+        # Reduce the count of the previous record
+        relation_model_class.update_counters(old_record_id, counter_cache.column_name => -state.delta_original) # rubocop:disable Rails/SkipsModelValidations
+      end
+
+      unless state.delta_current.zero?
+        # Increase the count of the new record
+        relation_model_class.update_counters(primary_key_value, counter_cache.column_name => state.delta_current) # rubocop:disable Rails/SkipsModelValidations
+      end
+    elsif !addition.zero?
+      # Add to the current record
+      relation_model_class.update_counters(primary_key_value, counter_cache.column_name => addition) # rubocop:disable Rails/SkipsModelValidations
     end
   end
 end

data/lib/awesome_counter_cache/state.rb

@@ -0,0 +1,3 @@
+class AwesomeCounterCache::State
+  attr_accessor :delta_current, :delta_original
+end

data/lib/awesome_counter_cache/version.rb

@@ -1,3 +1,3 @@
 module AwesomeCounterCache
-  VERSION = "0.0.1".freeze
+  VERSION = "0.0.2".freeze
 end

data/lib/awesome_counter_cache.rb

@@ -2,7 +2,9 @@ module AwesomeCounterCache
   extend ActiveSupport::Autoload
 
   autoload :ClassMethods
+  autoload :CounterCache
   autoload :InstanceMethods
+  autoload :State
 
   def self.included(base)
     base.extend AwesomeCounterCache::ClassMethods

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: awesome_counter_cache
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - kaspernj
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-02-07 00:00:00.000000000 Z
+date: 2023-06-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: factory_bot_rails
@@ -38,6 +38,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: mysql2
+  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: pg
+  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: pry
   requirement: !ruby/object:Gem::Requirement
@@ -100,6 +128,48 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  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: rubocop-rails
+  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: rubocop-rspec
+  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: sqlite3
   requirement: !ruby/object:Gem::Requirement
@@ -140,13 +210,16 @@ files:
 - Rakefile
 - lib/awesome_counter_cache.rb
 - lib/awesome_counter_cache/class_methods.rb
+- lib/awesome_counter_cache/counter_cache.rb
 - lib/awesome_counter_cache/instance_methods.rb
+- lib/awesome_counter_cache/state.rb
 - lib/awesome_counter_cache/version.rb
 - lib/tasks/awesome_counter_cache_tasks.rake
 homepage: https://github.com/kaspernj/awesome_counter_cache
 licenses:
 - MIT
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -155,14 +228,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
+rubygems_version: 3.0.8
 signing_key: 
 specification_version: 4
 summary: Counter caching with a bit more for Rails