visit_counter_updater 0.0.1 → 0.0.2

data/lib/visit_counter_updater/key.rb

@@ -0,0 +1,23 @@
+module VisitCounter
+  class Key
+
+    attr_reader :object, :method
+    def initialize(object, method)
+      @object = object
+      @method = method
+    end
+
+    def self.generate(method, obj_class, obj_id = nil)
+      ["visit_counter", obj_class, obj_id, method].compact.join("::")
+    end
+
+    def generate_from_instance
+      object_class = self.object_class
+      Key.generate(method,object_class, self.object.id)
+    end
+
+    def object_class
+      object.class.to_s
+    end
+  end
+end

data/lib/visit_counter_updater/store/redis_store.rb

@@ -0,0 +1,35 @@
+require "redis"
+
+module VisitCounter
+  class Store
+    class RedisStore < VisitCounter::Store::AbstractStore
+      class << self
+        ## adding keys to sorted sets, to allow searching by timstamp(score).
+        ## subsequent hits to the same key will only update the timestamp (and won't duplicate).
+        def incr(key, timestamp, set_name)
+          redis.zadd(set_name, timestamp, key)
+          redis.incr(key).to_i
+        end
+
+        def del(key)
+          redis.del(key)
+        end
+
+        def mget(keys)
+          redis.mget(*keys).map(&:to_i)
+        end
+
+        def mnullify(keys)
+          keys_with_0 = keys.flat_map {|k| [k,"0"]}
+          redis.mset(*keys_with_0)
+        end
+
+        ## Usage: to get all post#num_reads counters in the last hour, do:
+        ## redis.zrangebyscore("visit-counter::Post::num_reads", (Time.now - 3600).to_i, Time.now.to_i)
+        def get_all_by_range(sorted_set_key, min, max)
+          redis.zrangebyscore(sorted_set_key, min, max)
+        end
+      end
+    end
+  end
+end

data/lib/visit_counter_updater/version.rb

@@ -1,3 +1,3 @@
 module VisitCounterUpdater
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/lib/visit_counter_updater/visit_counter_updater.rb

@@ -0,0 +1,72 @@
+module VisitCounter
+  module InstanceMethods
+    def incr_counter(name)
+      key = VisitCounter::Key.new(self, name)
+      set_key = VisitCounter::Key.generate(key.method, key.object_class)
+      count = VisitCounter::Store.engine.incr(key.generate_from_instance, Time.now.to_i, set_key)
+
+      staged_count = self.send(:read_attribute, name).to_i
+      if Helper.passed_limit?(self, staged_count, count, name)
+        Helper.persist(self, staged_count, count, name)
+      end
+    end
+
+    def get_counter_delta(name)
+      key = VisitCounter::Key.new(self, name).generate_from_instance
+      VisitCounter::Store.engine.get(key)
+    end
+
+    def nullify_counter_cache(name, substract = nil)
+      key = VisitCounter::Key.new(self, name).generate_from_instance
+      if substract
+        VisitCounter::Store.engine.substract(key, substract)
+      else
+        VisitCounter::Store.engine.nullify(key)
+      end
+    end
+
+  end
+
+  module ClassMethods
+    ## override counter threshold. update method counters from the given Time
+    ## E.g. Post.update_counters(:num_reads, 1.hour.ago) will update all items that received hits in the last hour
+    def update_counters(name, from_time_ago)
+      set_name = VisitCounter::Key.generate(name, self)
+      counters_in_timeframe = VisitCounter::Store.engine.get_all_by_range(set_name, from_time_ago.to_i, Time.now.to_i)
+      obj_ids  = counters_in_timeframe.flat_map { |c| [c.split("::")[2].to_i] }
+      objects = self.where(id: obj_ids)
+
+      ## if no objects corresponding to the counters were found, remove them.
+      counters = Helper.reject_objectless_counters(counters_in_timeframe, objects, obj_ids)
+
+      hits, staged_count = Helper.get_count_stats(counters, objects, name)
+      self.transaction do
+        objects.zip(Helper.merge_array_values(hits, staged_count)).each do |o|
+          VisitCounter::Store.engine.with_lock(o[0]) do
+            o[0].class.update_all("#{name} = #{o[1]}", "id = #{o[0].id}")
+          end
+        end
+      end
+      VisitCounter::Store.engine.mnullify(counters)
+    end
+  end
+
+  class Helper
+    class << self
+      def merge_array_values(a1,a2)
+        a1.zip(a2).map {|i| i.inject(&:+)}
+      end
+
+      def reject_objectless_counters(counters, objects, counter_obj_ids)
+        delete_counter_ids = counter_obj_ids - objects.compact.map(&:id)
+        counters.reject {|c| delete_counter_ids.include?(c[2])}
+      end
+
+      def get_count_stats(counters, objects, name)
+        hits = VisitCounter::Store.engine.mget(counters).map(&:to_i)
+        staged_count = objects.map {|o| o.send(:read_attribute, name).to_i}
+        return hits, staged_count
+      end
+    end
+  end
+end

data/spec/visit_counter_updater_spec.rb

@@ -0,0 +1,60 @@
+require "spec_helper"
+
+class DummyObject
+  include VisitCounter
+
+  attr_accessor :counter
+
+  def update_attribute(attribute, value)
+    self.send("#{attribute}=", value)
+  end
+
+  def read_attribute(name)
+    #yeah, evals are evil, but it works and it's for testing purposes only. we assume read_attribute is defined the same as in AR wherever we include this module
+    eval("@#{name}")
+  end
+end
+
+VisitCounter::Store::RedisStore.redis = Redis.new(host: "localhost")
+VisitCounter::Store::RedisStore.redis.flushdb
+
+describe VisitCounter do
+  describe "updating counters for the given time-period (disregarding threshold)" do
+    let(:d_key) {"visit_counter::DummyObject::1::counter"}
+    let(:d1_key) {"visit_counter::DummyObject::2::counter"}
+    let(:set_name) {"visit_counter::DummyObject::counter"}
+
+    before :each do
+      @d, @d1 = DummyObject.new, DummyObject.new
+      @d.stub(:id).and_return(1)
+      @d1.stub(:id).and_return(2)
+      DummyObject.stub(:transaction).and_yield
+      @d.nullify_counter_cache(:counter)
+      VisitCounter::Store.engine.redis.del set_name
+      @d.increase_counter
+      @d1.increase_counter
+    end
+
+    it "should update multiple objects" do
+      DummyObject.stub(:where).and_return([@d, @d1])
+      DummyObject.should_receive(:update_all).once.with("counter = 1", "id = 1").ordered
+      DummyObject.should_receive(:update_all).once.with("counter = 1", "id = 2").ordered
+      DummyObject.update_counters(:counter, (Time.now - 4))
+    end
+
+    it "should only find counter hits from the given time-period" do
+      VisitCounter::Store.engine.redis.zincrby(set_name, -100000, d1_key)
+      VisitCounter::Store.engine.get_all_by_range(set_name, (Time.now - 20).to_i, Time.now.to_i).should == [d_key]
+    end
+
+    it "should not try to update counters without objects" do
+      VisitCounter::Store.engine.should_receive(:get_all_by_range).and_return([d_key, d1_key])
+      DummyObject.stub(:where).and_return([@d])
+      VisitCounter::Helper.stub(:merge_array_values).and_return([0])
+      DummyObject.should_receive(:update_all).once
+      DummyObject.update_counters(:counter, (Time.now - 4))
+    end
+  end
+
+end
+

data/visit_counter_updater.gemspec

@@ -3,10 +3,10 @@ require File.expand_path('../lib/visit_counter_updater/version', __FILE__)
 
 Gem::Specification.new do |gem|
   gem.authors       = ["Gilad Zohari"]
-  gem.email         = ["gilad@ftbpro.com"]
+  gem.email         = ["gilad@gmail.com"]
   gem.description   = %q{Extending VisitCounter to stage all data to DB}
-  gem.summary       = %q{This fucking sucks.}
-  gem.homepage      = ""
+  gem.summary       = %q{Tom Caspy is a lazi individual.}
+  gem.homepage      = "https://github.com/gzohari/visit-counter-updater"
 
   gem.files         = `git ls-files`.split($\)
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: visit_counter_updater
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -29,7 +29,7 @@ dependencies:
         version: '0'
 description: Extending VisitCounter to stage all data to DB
 email:
-- gilad@ftbpro.com
+- gilad@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -40,9 +40,13 @@ files:
 - README.md
 - Rakefile
 - lib/visit_counter_updater.rb
+- lib/visit_counter_updater/key.rb
+- lib/visit_counter_updater/store/redis_store.rb
 - lib/visit_counter_updater/version.rb
+- lib/visit_counter_updater/visit_counter_updater.rb
+- spec/visit_counter_updater_spec.rb
 - visit_counter_updater.gemspec
-homepage: ''
+homepage: https://github.com/gzohari/visit-counter-updater
 licenses: []
 post_install_message: 
 rdoc_options: []
@@ -65,5 +69,6 @@ rubyforge_project:
 rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
-summary: This fucking sucks.
-test_files: []
+summary: Tom Caspy is a lazi individual.
+test_files:
+- spec/visit_counter_updater_spec.rb