visit-counter 0.0.3 → 0.1.0

data/README.md

@@ -35,6 +35,22 @@ You can also do something like this:
 
 this will override the counter_name method to read the live counter (from both database and the NoSQL storage) and add a increase_counter_name method for upping the counter by 1 (in the NoSQL and/or persist to DB when needed)
 
+##Thresholds
+
+the default behaviour of visit counter is that once the visits pass 30% of the staged number, the visit counter stages the changes and nullifies the delta. You can, however, tweak that method. including VisitCounter in a class creates two class attribute_accessors, one named visit_counter_threshold_method, the other visit_counter_threshold.
+visit_counter_threshold_method accepts either :static or :percent (the default), the threshold is either the decimal percent (0.1 for 10%) or an integer for :static. in case of the :static method you will percist to the DB once every (threshold) times the counter goes up.
+
+so you might want to do something like that:
+
+    class Foo < ActiveRecord::Base
+       include VisitCounter
+       cached_counter :counter_name
+       visit_counter_threshold_method = :static
+       visit_counter_threshold = 100
+    end
+
+if you want the counter to persist to database once every 100 views.
+
 ## Contributing
 
 1. Fork it

data/lib/visit-counter/version.rb

@@ -1,3 +1,3 @@
 module VisitCounter
-  VERSION = "0.0.3"
+  VERSION = "0.1.0"
 end

data/lib/visit-counter/visit_counter.rb

@@ -1,6 +1,12 @@
 module VisitCounter
 
   def self.included(base)
+    base.class_eval do
+      class << self
+        #defining class instance attributes
+        attr_accessor :visit_counter_threshold, :visit_counter_threshold_method
+      end
+    end
     base.send(:include, InstanceMethods)
     base.send(:extend, ClassMethods)
   end
@@ -9,10 +15,9 @@ module VisitCounter
     def incr_counter(name)
       key = VisitCounter::Key.key(self, name)
       count = VisitCounter::Store.engine.incr(key)
-      current_count = self.send(:read_attribute, name).to_i
-      if current_count / (current_count + count).to_f < 0.7
-        self.update_attribute(name, current_count + count)
-        nullify_counter_cache(name)
+      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
 
@@ -46,6 +51,34 @@ module VisitCounter
         incr_counter(name)
       end
     end
+  end
+
+  class Helper
+    class << self
+      def passed_limit?(object, staged_count, diff, name)
+        method = object.class.visit_counter_threshold_method || :percent
+        threshold = object.class.visit_counter_threshold || default_threshold(method)
 
+        if method.to_sym == :static
+          diff >= threshold
+        elsif method.to_sym == :percent
+          return true if staged_count.to_i == 0
+          diff.to_f / staged_count.to_f >= threshold
+        end
+      end
+
+      def persist(object, staged_count, diff, name)
+        object.update_attribute(name, staged_count + diff)
+        object.nullify_counter_cache(name)
+      end
+
+      def default_threshold(method)
+        if method.to_sym == :static
+          10
+        elsif method.to_sym == :percent
+          0.3
+        end
+      end
+    end
   end
 end

data/spec/lib/visit_counter_spec.rb

@@ -35,16 +35,16 @@ describe VisitCounter do
       @d.counter = 100
       @d.incr_counter(:counter)
       @d.counter.should == 100
-      43.times do
+      30.times do
         @d.incr_counter(:counter)
       end
-      @d.counter.should == 143
+      @d.counter.should == 130
 
       #should still be 143, because of the percentage thingie
-      43.times do
+      30.times do
         @d.incr_counter(:counter)
       end
-      @d.counter.should == 143
+      @d.counter.should == 130
     end
   end
 
@@ -68,6 +68,48 @@ describe VisitCounter do
     end
   end
 
+  describe "static threshold" do
+    before :each do
+      @d = DummyObject.new
+      @d.stub!(:id).and_return(1)
+      @d.nullify_counter_cache(:counter)
+      DummyObject.visit_counter_threshold_method = :static
+    end
+
+    it "should persist after setting a static threshold of 1" do
+      DummyObject.visit_counter_threshold = 1
+      @d.counter = 10
+      @d.incr_counter(:counter)
+      @d.counter.should == 11
+    end
+
+    it "should not persist after setting a static threshold of 2" do
+      DummyObject.visit_counter_threshold = 2
+      @d.counter = 10
+      @d.incr_counter(:counter)
+      @d.counter.should == 10
+
+      @d.incr_counter(:counter)
+      @d.counter.should == 12
+    end
+  end
+
+  describe "percent threshold" do
+    before :each do
+      @d = DummyObject.new
+      @d.stub!(:id).and_return(1)
+      @d.nullify_counter_cache(:counter)
+      DummyObject.visit_counter_threshold_method = :percent
+    end
+
+    it "should persist when passing a percent" do
+      DummyObject.visit_counter_threshold = 0.1
+      @d.counter = 10
+      @d.incr_counter(:counter)
+      @d.counter.should == 11
+    end
+  end
+
   describe "overriding the getter" do
     before :all do
       DummyObject.cached_counter :counter

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: visit-counter
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-23 00:00:00.000000000 Z
+date: 2012-09-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec