awesome_counter_cache 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a438135d0099fbe7652b5f754180b2f396650129a62066e364dee2fd69666bc4
+  data.tar.gz: 27ce6f7009265b2a1022793a1ff43af3e57a9f9dd6340d660299dbe1afbc78a1
+SHA512:
+  metadata.gz: 1420eddc1824fc764e9f2a62a8d6464860366b945bd8112ef94d28082fd718cb6fecc617d32b7c50a67a9c0f5f79e593d007e1c2f3ec4e5609b34388cca3e6a7
+  data.tar.gz: ef5c2e47f810091cb35a302f1a738bbdf93336efb6a72969fc6116f0cdfc361cb4c103d13f6cfcc6f8ba809433c22243485246cd8b82be44347fd604a904de82

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2015 kaspernj
+
+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,3 @@
+# AwesomeCounterCache
+
+This project rocks and uses MIT-LICENSE.

data/Rakefile

@@ -0,0 +1,17 @@
+begin
+  require "bundler/setup"
+rescue LoadError
+  puts "You must `gem install bundler` and `bundle install` to run rake tasks"
+end
+
+require "rdoc/task"
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = "rdoc"
+  rdoc.title    = "AwesomeCounterCache"
+  rdoc.options << "--line-numbers"
+  rdoc.rdoc_files.include("README.rdoc")
+  rdoc.rdoc_files.include("lib/**/*.rb")
+end
+
+Bundler::GemHelper.install_tasks

data/lib/awesome_counter_cache.rb

@@ -0,0 +1,11 @@
+module AwesomeCounterCache
+  extend ActiveSupport::Autoload
+
+  autoload :ClassMethods
+  autoload :InstanceMethods
+
+  def self.included(base)
+    base.extend AwesomeCounterCache::ClassMethods
+    base.include AwesomeCounterCache::InstanceMethods
+  end
+end

data/lib/awesome_counter_cache/class_methods.rb

@@ -0,0 +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_name] = relation_name
+    args[:id] = id
+
+    awesome_counter_caches[id] = args
+
+    after_initialize do |model|
+      awesome_counter_cache_after_initialize(args, model)
+    end
+
+    after_commit on: :create do |model|
+      awesome_counter_cache_after_commit_on_create(args, model, relation_name)
+    end
+
+    after_commit on: :destroy do |model|
+      awesome_counter_cache_after_commit_on_destroy(args, model, relation_name)
+    end
+
+    after_commit on: :update do |model|
+      awesome_counter_cache_after_commit_on_update(args, model, relation_name)
+    end
+  end
+
+  def awesome_counter_caches
+    @awesome_counter_caches ||= {}
+  end
+end

data/lib/awesome_counter_cache/instance_methods.rb

@@ -0,0 +1,85 @@
+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)
+  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)
+  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)
+  end
+
+  def awesome_counter_cache_after_initialize(args, model)
+    id = args.fetch(:id)
+
+    @awesome_counter_cache_data ||= {}
+    @awesome_counter_cache_data[id] ||= {}
+
+    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
+    else
+      @awesome_counter_cache_data.fetch(id)[:delta_original] ||= args.fetch(:delta_magnitude).call(model)
+    end
+  end
+
+  def create_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)
+
+    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)
+    end
+  end
+
+  def reload(*args, &blk)
+    result = super
+    awesome_counter_cache_reset_original_values
+    result
+  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)
+    end
+  end
+
+  def destroy_awesome_counter_cache_for(relation_name, state_data, args)
+    relation_model = __send__(relation_name)
+    return if relation_model.blank?
+
+    addition = -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)
+    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)
+    end
+  end
+end

data/lib/awesome_counter_cache/version.rb

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

data/lib/tasks/awesome_counter_cache_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :awesome_counter_cache do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,169 @@
+--- !ruby/object:Gem::Specification
+name: awesome_counter_cache
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- kaspernj
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-02-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: factory_bot_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: forgery
+  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
+    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: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 7.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 7.0.0
+- !ruby/object:Gem::Dependency
+  name: rspec-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
+  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
+    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: tzinfo-data
+  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: Counter caching with a bit more for Rails
+email:
+- k@spernj.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/awesome_counter_cache.rb
+- lib/awesome_counter_cache/class_methods.rb
+- lib/awesome_counter_cache/instance_methods.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: {}
+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: []
+rubygems_version: 3.0.6
+signing_key: 
+specification_version: 4
+summary: Counter caching with a bit more for Rails
+test_files: []