counter-cache 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 65f431cac9a84b8abe458919608c07c66501c68e
-  data.tar.gz: c0582fc1f4d829fc50162ce50746b33fdf06f2c8
+  metadata.gz: 5cac236244f5fa2812dc3ba95405240ff016fce4
+  data.tar.gz: e2281ca37f31cc531cb2bba1aa1f9ec3438ca5d1
 SHA512:
-  metadata.gz: db21a9548ac98191ddf559ff962c78f221656998efbe5f1a0c2af14e153e7256647fa3f54bc4f00faa8b3d34b9feabd9f94d6f82410805b241eb3384593ba1a9
-  data.tar.gz: 8b4abafb442cbdedef2ddffae83ebc7d71a418dedbef791ad3f963abc7c039b45e44fa8d4d2d992514da60091e8d555932439555c319f33923ac0fc12271f5a4
+  metadata.gz: 38f9a282a897f6790147ea80dd9198db5bf27fb39aeec1339916480297a02182d1e11066304ef674339103070f0d6bc874f0d3ef0f3f1d19bcff59389e339941
+  data.tar.gz: afc080f77508a700108aa7ea37687a5c509633efd2048c693b60a3fa2894f52e5b6b2ebd358e0ebd7578d6006b5ac7ec81474ad13d45c724824600ce3290c422

data/README.md

@@ -98,6 +98,19 @@ Counter caches are configured on the models from the perspective of the child mo
 
 #### Basic Counter with recalculation:
 
+```ruby
+class Post
+  include Counter::Cache
+
+  counter_cache_on column: :posts_count, # users.posts_count
+                   relation: :user,
+                   relation_class_name: "User",
+                   method: :calculate_posts_count # This is a method on the user.
+end
+```
+
+#### To allow a timestamp to be updated:
+
 ```ruby
 class Post
   include Counter::Cache
@@ -106,6 +119,7 @@ class Post
                    relation: :user,
                    relation_class_name: "User",
                    method: :calculate_posts_count, # This is a method on the user.
+                   touch_column: :posts_updated_at
 end
 ```
 

data/gemfiles/activerecord_3.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ../
   specs:
-    counter-cache (0.0.2)
+    counter-cache (0.1.0)
       activerecord (>= 3.0)
 
 GEM
@@ -90,3 +90,6 @@ DEPENDENCIES
   rake
   rspec (>= 3.0)
   sqlite3
+
+BUNDLED WITH
+   1.10.6

data/gemfiles/activerecord_4.0.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ../
   specs:
-    counter-cache (0.0.2)
+    counter-cache (0.1.0)
       activerecord (>= 3.0)
 
 GEM
@@ -96,3 +96,6 @@ DEPENDENCIES
   rake
   rspec (>= 3.0)
   sqlite3
+
+BUNDLED WITH
+   1.10.6

data/gemfiles/activerecord_4.1.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ../
   specs:
-    counter-cache (0.0.2)
+    counter-cache (0.1.0)
       activerecord (>= 3.0)
 
 GEM
@@ -95,3 +95,6 @@ DEPENDENCIES
   rake
   rspec (>= 3.0)
   sqlite3
+
+BUNDLED WITH
+   1.10.6

data/lib/counter/cache/counters/buffer_counter/enqueuer.rb

@@ -11,14 +11,16 @@ module Counter
           private
 
           def create_and_enqueue(delay, cached)
+            parameters = { relation_class_name: relation_class,
+                           relation_id: relation_id,
+                           column: options.column,
+                           method: options.method,
+                           cache: cached,
+                           counter: counter_class_name }
+            parameters[:touch_column] = options.touch_column unless options.touch_column.nil?
             options.worker_adapter.enqueue(delay,
                                            source_object_class_name,
-                                           { relation_class_name: relation_class,
-                                             relation_id: relation_id,
-                                             column: options.column,
-                                             method: options.method,
-                                             cache: cached,
-                                             counter: counter_class_name })
+                                           parameters)
           end
         end
       end

data/lib/counter/cache/counters/buffer_counter/saver.rb

@@ -18,6 +18,7 @@ module Counter
 
           def save_new_value!(value)
             relation_object.send("#{options.column}=", value)
+            relation_object.send("#{options.touch_column}=", DateTime.now) if options.touch_column
             relation_object.save!(validate: false)
           end
 

data/lib/counter/cache/options_parser.rb

@@ -13,6 +13,10 @@ module Counter
         options[:column]
       end
 
+      def touch_column
+        options[:touch_column]
+      end
+
       def relation
         options[:relation]
       end

data/lib/counter/cache/version.rb

@@ -1,5 +1,5 @@
 module Counter
   module Cache
-    VERSION = "0.1.0"
+    VERSION = "0.2.0"
   end
 end

data/spec/lib/counter/cache/buffer_counter/enqueuer_spec.rb

@@ -2,52 +2,106 @@ require 'spec_helper'
 
 RSpec.describe Counter::Cache::Counters::BufferCounter::Enqueuer do
   let(:worker_adapter) { double }
-  let(:options) { double(worker_adapter: worker_adapter,
-                         wait: 10,
-                         column: "boo",
-                         method: "calculate_boo",
-                         cached?: true,
-                         recalculation?: false,
-                         recalculation_delay: 20) }
 
   let(:source_object_class_name) { "BooUser" }
   let(:relation_id) { 1 }
   let(:relation_type) { "Boo" }
 
-  let(:enqueuer) { Counter::Cache::Counters::BufferCounter::Enqueuer.new(options, source_object_class_name, relation_id, relation_type, "SuperCounter") }
-
   describe '#enqueue' do
-    before do
-      expect(worker_adapter).to receive(:enqueue).with(10,
-                                                       "BooUser",
-                                                       { relation_class_name: "Boo",
-                                                         relation_id: 1,
-                                                         column: "boo",
-                                                         method: "calculate_boo",
-                                                         cache: true,
-                                                         counter: "SuperCounter" })
-    end
-
-    describe 'when recalculation is true' do
+    context "without touch column" do
       before do
-        expect(options).to receive(:recalculation?).and_return(true)
-      end
+        @options =  double(worker_adapter: worker_adapter,
+                           wait: 10,
+                           column: "boo",
+                           method: "calculate_boo",
+                           cached?: true,
+                           recalculation?: false,
+                           recalculation_delay: 20)
+
+        @enqueuer = Counter::Cache::Counters::BufferCounter::Enqueuer.new(@options, source_object_class_name, relation_id, relation_type, "SuperCounter")
 
-      it "enqueues two jobs" do
-        expect(worker_adapter).to receive(:enqueue).with(20,
+        expect(worker_adapter).to receive(:enqueue).with(10,
                                                          "BooUser",
                                                          { relation_class_name: "Boo",
                                                            relation_id: 1,
                                                            column: "boo",
                                                            method: "calculate_boo",
-                                                           cache: false,
+                                                           cache: true,
                                                            counter: "SuperCounter" })
-        enqueuer.enqueue!(double)
+      end
+
+      describe 'when recalculation is true' do
+        before do
+          expect(@options).to receive(:recalculation?).and_return(true)
+        end
+
+        it "enqueues two jobs" do
+          expect(@options).to receive(:touch_column).twice
+          expect(worker_adapter).to receive(:enqueue).with(20,
+                                                           "BooUser",
+                                                           { relation_class_name: "Boo",
+                                                             relation_id: 1,
+                                                             column: "boo",
+                                                             method: "calculate_boo",
+                                                             cache: false,
+                                                             counter: "SuperCounter" })
+          @enqueuer.enqueue!(double)
+        end
+      end
+
+      it 'enqueues one job' do
+        expect(@options).to receive(:touch_column)
+        @enqueuer.enqueue!(double)
       end
     end
 
-    it 'enqueues one job' do
-      enqueuer.enqueue!(double)
+    context "with touch column" do
+      before(:each) do
+        @options = double(worker_adapter: worker_adapter,
+                          wait: 10,
+                          column: "boo",
+                          touch_column: "boo_updated_at",
+                          method: "calculate_boo",
+                          cached?: true,
+                          recalculation?: false,
+                          recalculation_delay: 20)
+        @enqueuer = Counter::Cache::Counters::BufferCounter::Enqueuer.new(@options, source_object_class_name, relation_id, relation_type, "SuperCounter")
+
+        expect(worker_adapter).to receive(:enqueue).with(10,
+                                                         "BooUser",
+                                                         { relation_class_name: "Boo",
+                                                           relation_id: 1,
+                                                           column: "boo",
+                                                           touch_column: "boo_updated_at",
+                                                           method: "calculate_boo",
+                                                           cache: true,
+                                                           counter: "SuperCounter" })
+      end
+
+      describe 'when recalculation is true' do
+        before do
+          expect(@options).to receive(:recalculation?).and_return(true)
+        end
+
+        it "enqueues two jobs" do
+          expect(@options).to receive(:touch_column).exactly(4).times
+          expect(worker_adapter).to receive(:enqueue).with(20,
+                                                           "BooUser",
+                                                           { relation_class_name: "Boo",
+                                                             relation_id: 1,
+                                                             column: "boo",
+                                                             touch_column: "boo_updated_at",
+                                                             method: "calculate_boo",
+                                                             cache: false,
+                                                             counter: "SuperCounter" })
+          @enqueuer.enqueue!(double)
+        end
+      end
+
+      it 'enqueues one job' do
+        expect(@options).to receive(:touch_column)
+        @enqueuer.enqueue!(double)
+      end
     end
   end
 end

data/spec/lib/counter/cache/buffer_counter/saver_spec.rb

@@ -4,7 +4,7 @@ RSpec.describe Counter::Cache::Counters::BufferCounter::Saver do
   class Boo
   end
 
-  let(:relation_object) { double(boo_count: 2) }
+  let(:relation_object) { double(boo_count: 2, boo_updated_at: DateTime.now) }
   let(:options) { double(relation_class_name: "Boo", relation_id: 1, column: "boo_count", method: nil, source_object_class_name: Boo) }
   let(:saver) { Counter::Cache::Counters::BufferCounter::Saver.new(options) }
 
@@ -21,6 +21,7 @@ RSpec.describe Counter::Cache::Counters::BufferCounter::Saver do
 
       before do
         allow(options).to receive(:cached?).and_return(true)
+        allow(options).to receive(:touch_column).and_return(nil)
         expect(relation_object).to receive(:boo_count=).with(4)
         expect(relation_object).to receive(:save!)
         expect(counting_store).to receive(:del)
@@ -41,15 +42,29 @@ RSpec.describe Counter::Cache::Counters::BufferCounter::Saver do
         expect(counting_store).to receive(:del)
       end
 
-      it 'saves the value' do
-        expect(relation_object).to receive(:boo_count=).with(4)
-        expect(relation_object).to receive(:save!)
-        saver.save!
+      context "with touch column" do
+        it 'saves the value' do
+          allow(options).to receive(:touch_column).and_return(:boo_updated_at)
+          expect(relation_object).to receive(:boo_count=).with(4)
+          expect(relation_object).to receive(:boo_updated_at=).with(DateTime.now)
+          expect(relation_object).to receive(:save!)
+          saver.save!
+        end
+      end
+
+      context "without touch column" do
+        it 'saves the value' do
+          allow(options).to receive(:touch_column).and_return(nil)
+          expect(relation_object).to receive(:boo_count=).with(4)
+          expect(relation_object).to receive(:save!)
+          saver.save!
+        end
       end
     end
 
     describe 'when cached? is false' do
       before do
+        allow(options).to receive(:touch_column).and_return(nil)
         allow(options).to receive(:cached?).and_return(false)
       end
 

data/spec/lib/counter/cache/options_parser_spec.rb

@@ -34,6 +34,13 @@ RSpec.describe Counter::Cache::OptionsParser do
     end
   end
 
+  describe "#touch_column" do
+    let(:options) { { touch_column: "touch_column_name" } }
+    it "returns option if set" do
+      expect(parser.touch_column).to eq("touch_column_name")
+    end
+  end
+
   describe "#method" do
     let(:options) { { method: "method" } }
     it "returns option if set" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: counter-cache
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Paul Henry & Matt Camuto
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-16 00:00:00.000000000 Z
+date: 2015-12-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -207,7 +207,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.2.3
 signing_key: 
 specification_version: 4
 summary: Counting is hard.