running_count 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 281c3126d219fffe217bea334f4ee81b040bb875ea1d5b120a5443eff7db48fa
-  data.tar.gz: b236cc36eaec448d824371484cb1c0505d7fc1170324ba105cd04722de566a15
+  metadata.gz: 17316e1fc11a06d992f032a266cfdd460e2398d9f2ea2cd012e12ccda8d6e6bf
+  data.tar.gz: 6c2c23a38cf332a8a164642b595b78bcbc7b895a26513b2244b2b4c2c3489089
 SHA512:
-  metadata.gz: 0ce7b753f6c6d2a2a8b6334bb17aaed7b3856a499716a85a01d4c6af6df24896b043f6af381fc2d314c5c548dc191777ee186cb19fe9d9462e44ee4e4416f725
-  data.tar.gz: afe63389d76ee143a0df841d4c6480e23e3560e913bddf7603c4f6f6555710f61fc62fe4ac993a677c7d2c7e7a5f21a45f210c99cabc17b6550497497fbcf944
+  metadata.gz: b2081c854ebba5b361c9c7e40fbc73a51de2201d76cb28a91efa4b70a508d71e88dc74bd516d770fa7c6d10deb05ab1bd8842c466b5c1c542f123adf178fd650
+  data.tar.gz: e8a44b425b3726484fd246bf171149329dffcd2da868573ce9e9ccac10b916c98e28b5ba1ff7c50cff9fc5eac98e4a36c2e9d7f62c6cd7cc9515f789b8ec037b

data/Gemfile.lock

@@ -1,10 +1,10 @@
 PATH
   remote: .
   specs:
-    running_count (0.1.0)
-      activesupport
+    running_count (0.2.0)
+      activesupport (~> 4.2.11)
       pg (= 0.20.0)
-      redis-rails
+      redis-rails (~> 5.0)
 
 GEM
   remote: https://rubygems.org/
@@ -74,8 +74,6 @@ GEM
     pry-byebug (3.6.0)
       byebug (~> 10.0)
       pry (~> 0.10)
-    pry-rails (0.3.9)
-      pry (>= 0.10.4)
     rack (1.6.11)
     rack-test (0.6.3)
       rack (>= 1.0)
@@ -150,9 +148,8 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
-  database_cleaner
-  pry-byebug
-  pry-rails
+  database_cleaner (~> 1.7.0)
+  pry-byebug (~> 3.6.0)
   rails (~> 4.0)
   rake (~> 10.0)
   rspec (~> 3.0)

data/README.md

@@ -1,28 +1,45 @@
-# RunningCount
+# running_count
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/running_count`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+Counter caches for Rails applications, including cached running counts.
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'running_count'
+gem 'running_count', '~> 0.2`
 ```
 
 And then execute:
 
     $ bundle
 
-Or install it yourself as:
+## Usage
 
-    $ gem install running_count
+```
+class Course < ActiveRecord::Base
+  belongs_to :user
 
-## Usage
+  keep_running_count :user
+end
+
+class User
+  has_many :courses
+end
+```
+
+Tracks the number of Course records associated with the User model, saving them to the `courses_count` field in the 'users' table.
+
+Also tracks a dynamic running count in the `running_courses_count` method on the `User` model.
+
+## Reconciling changes
+
+```
+Course.reconcile_changes
+```
+
+Will update the 'users' table with the number of associated courses in the `courses_count` field, and clear the dynamic cache.
 
-TODO: Write usage instructions here
 
 ## Development
 

data/lib/running_count/callbacks.rb

@@ -5,28 +5,33 @@ module RunningCount
 
     extend ActiveSupport::Concern
 
-    def enqueue_count
-      Counter.enqueue_change(self, self.class._counter_data)
+    def enqueue_changes
+      Counter.enqueue_changes(self, self.class._counter_data)
     end
 
-    def enqueue_sum
-      Counter.enqueue_sum(self, self.class._counter_data)
+    def enqueue_deletion
+      Counter.enqueue_deletion(self, self.class._counter_data)
     end
 
     module ClassMethods
 
       def keep_running_count(relation, opts = {})
-        Counter.add_callbacks(self, opts)
+        data = Counter.counter_data(self.name, self.table_name, relation, opts)
+        counter_column = data[:counter_column]
+
+        _counter_data[counter_column] = data
 
-        @counter_data = Counter.counter_data(self.name, self.table_name, relation, opts)
+        Counter.add_callbacks(self, opts)
       end
 
       def reconcile_changes
-        Counter.reconcile_changes(self._counter_data)
+        self._counter_data.values.each do |data|
+          Counter.reconcile_changes(data)
+        end
       end
 
       def _counter_data
-        @counter_data
+        @counter_data ||= {}
       end
 
     end

data/lib/running_count/counter.rb

@@ -5,6 +5,16 @@ module RunningCount
 
     class << self
 
+      def enqueue_changes(record, counter_data)
+        counter_data
+          .values
+          .partition { |data| data[:aggregated_field].present? }
+          .tap do |sums, counts|
+            sums.each { |data| Counter.enqueue_sum(record, data) }
+            counts.each { |data| Counter.enqueue_count(record, data) }
+        end
+      end
+
       def enqueue_sum(record, counter_data)
         aggregated_field = counter_data[:aggregated_field]
 
@@ -13,17 +23,35 @@ module RunningCount
         diff = record.previous_changes[aggregated_field].last.to_i - record.previous_changes[aggregated_field].first.to_i
 
         if diff != 0
-          Counter.enqueue_change(record, counter_data.merge(amount: diff))
+          Counter.enqueue_count(record, counter_data.merge(amount: diff))
         end
       end
 
-      def enqueue_change(record, counter_data)
+      def enqueue_count(record, counter_data)
+        if changed_field = counter_data[:changed_field]
+          return true unless record.previous_changes.has_key?(changed_field) && counter_data[:if].call(record)
+        end
+
         destination = record.send(counter_data[:relation])
         item = Format.item(destination)
 
         Storage.add_item(item, counter_data[:running_set_name], counter_data.fetch(:amount, 1))
-      rescue StandardError => e
-        binding.pry
+      end
+
+      def enqueue_deletion(record, counter_data)
+        counter_data
+          .values
+          .each do |data|
+            Counter.enqueue_single_delete(record, data)
+          end
+      end
+
+      def enqueue_single_delete(record, data)
+        destination = record.send(data[:relation])
+        item = Format.item(destination)
+        amount = amount_from_deleted_record(record, data)
+
+        Storage.add_item(item, data[:running_set_name], 0 - amount)
       end
 
       def reconcile_changes(counter_data)
@@ -73,21 +101,27 @@ module RunningCount
           statement: statement,
           release_sql: Statement.release_sql(statement),
           aggregated_field: opts[:aggregated_field],
+          changed_field: opts[:changed_field],
           statement_sql: sql,
           if: opts[:if],
         }
       end
 
       def add_callbacks(klass, opts)
-        if opts[:aggregated_field]
-          klass.after_commit :enqueue_sum, on: [:create, :update], if: opts[:if]
-        else
-          klass.after_commit :enqueue_count, on: [:create, :update], if: opts[:if]
-        end
+        klass.after_commit :enqueue_changes, on: [:create, :update], if: opts[:if]
+        klass.after_commit :enqueue_deletion, on: [:destroy], if: opts[:if]
       end
 
       private
 
+      def amount_from_deleted_record(record, counter_data)
+        if counter_data[:aggregated_field]
+          record.send(counter_data[:aggregated_field])
+        else
+          counter_data.fetch(:amount, 1)
+        end
+      end
+
       def destination_class_name(relation, opts)
         opts[:class_name] ? opts[:class_name].to_s.constantize : relation.to_s.camelcase.constantize
       end

data/lib/running_count/statement.rb

@@ -31,7 +31,6 @@ module RunningCount
 
         destination_id = Format.parse(item)
         ActiveRecord::Base.connection.exec_query("EXECUTE #{counter_data[:statement]}(#{destination_id})")
-      rescue StandardError => e
       end
 
       private
@@ -56,7 +55,7 @@ module RunningCount
 
       def sum_inner_sql(table_name, relation, opts)
         %(
-          SELECT SUM(#{opts[:aggregated_field]}) FROM "#{table_name}"
+          SELECT COALESCE(SUM(#{opts[:aggregated_field]}), 0) FROM "#{table_name}"
           WHERE "#{table_name}"."#{relation}_id" = $1
           #{extra_sql(opts)}
         )

data/lib/running_count/version.rb

@@ -1,3 +1,3 @@
 module RunningCount
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/running_count.gemspec

@@ -36,14 +36,13 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "activesupport"
-  spec.add_dependency "redis-rails"
+  spec.add_dependency "activesupport", "~> 4.2.11"
+  spec.add_dependency "redis-rails",  "~> 5.0"
   spec.add_dependency "pg", "0.20.0"
 
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "rails", "~> 4.0"
-  spec.add_development_dependency "database_cleaner"
-  spec.add_development_dependency "pry-rails"
-  spec.add_development_dependency "pry-byebug"
+  spec.add_development_dependency "database_cleaner", "~> 1.7.0"
+  spec.add_development_dependency "pry-byebug", "~> 3.6.0"
 end

metadata

@@ -1,43 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: running_count
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Isaac Priestley
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-01-31 00:00:00.000000000 Z
+date: 2019-02-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 4.2.11
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 4.2.11
 - !ruby/object:Gem::Dependency
   name: redis-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '5.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: pg
   requirement: !ruby/object:Gem::Requirement
@@ -98,44 +98,30 @@ dependencies:
   name: database_cleaner
   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-rails
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.7.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.7.0
 - !ruby/object:Gem::Dependency
   name: pry-byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.6.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.6.0
 description: Write a longer description or delete this line.
 email:
 - isaac@teachable.com