visit-counter 0.0.1 → 0.0.2

data/README.md

@@ -1,6 +1,7 @@
-# Visit::Counter
+# VisitCounter
 
-TODO: Write a gem description
+VisitCounter is a gem which solves the annoying problem of counting visits and displaying them in real time. In an SQL database, for a site with a lot of hits, this can cause quite a lot of overhead. VisitCounter aims to solve this by using a quick key-value store to keep a delta, and only persist to the SQL DB when the delta crosses a certain percent of the saved counter.
+It can be used transparently, by overriding the accessor to the counter, or simply by using the helper functions it defines - incr_counter, read_counter, get_counter_delta and nullify_counter.
 
 ## Installation
 
@@ -18,7 +19,21 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+a. the default storage engine is redis. If you have a global $redis for your redis connection, we default to using that. Otherwise, or if you want to specify a different connection, in an initializer you should define it by:
+
+    VisitCounter::Store::RedisStore.redis = Redis.new(host: "your_redis_host", port: port)
+
+b. in the class you wish to have a visit counter simply declare
+    include VisitCounter
+from this moment on, you can use the incr_counter(:counter_name), nullify_counter(:counter_name) and read_counter(:counter_name) methods
+You can also do something like this:
+
+    class Foo < ActiveRecord::Base
+       include VisitCounter
+       cached_counter :counter_name
+    end
+
+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)
 
 ## Contributing
 

data/lib/visit-counter/store/abstract_store.rb

@@ -0,0 +1,21 @@
+module VisitCounter
+  class Store
+    class AbstractStore
+      class << self
+        #placeholders
+
+        def incr(key)
+          raise NotImplementedError
+        end
+
+        def get(key)
+          raise NotImplementedError
+        end
+
+        def nullify(key)
+          raise NotImplementedError
+        end
+      end
+    end
+  end
+end

data/lib/visit-counter/store/rails_store.rb

@@ -0,0 +1,6 @@
+module VisitCounter
+  class Store
+    class RailsStore < VisitCounter::Store::AbstractStore
+    end
+  end
+end

data/lib/visit-counter/store/redis_store.rb

@@ -0,0 +1,40 @@
+require "redis"
+
+module VisitCounter
+  class Store
+    class RedisStore < VisitCounter::Store::AbstractStore
+      @@redis = nil
+      class << self
+
+        def redis=(r)
+          if r.is_a?(Redis)
+            @@redis = r
+          else
+            @@redis = Redis.new(r)
+          end
+        end
+
+        def redis
+          if @@redis.nil? && defined?($redis)
+            @@redis = $redis
+          else
+            @@redis
+          end
+        end
+
+        def incr(key)
+          redis.incr(key).to_i
+        end
+
+        def get(key)
+          redis.get(key).to_i
+        end
+
+        def nullify(key)
+          redis.set(key, 0)
+        end
+
+      end
+    end
+  end
+end

data/lib/visit-counter/version.rb

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

data/lib/visit-counter/visit_counter.rb

@@ -1,16 +1,52 @@
 module VisitCounter
-  def incr_counter(name)
-    key = VisitCounter::Key.key(self, name)
-    count = VisitCounter::Store.engine.incr(key)
-    current_count = self.send(name).to_i
-    if current_count / (current_count + count).to_f < 0.7
-      self.update_attribute(name, current_count + count)
-      nullify_counter_cache(name)
+
+  def self.included(base)
+    base.send(:include, InstanceMethods)
+    base.send(:extend, ClassMethods)
+  end
+
+  module InstanceMethods
+    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)
+      end
+    end
+
+    def get_counter_delta(name)
+      key = VisitCounter::Key.key(self, name)
+      VisitCounter::Store.engine.get(key)
+    end
+
+    def read_counter(name)
+      current_count = self.send(:read_attribute, name).to_i
+      count = get_counter_delta(name)
+
+      current_count + count
+    end
+
+    def nullify_counter_cache(name)
+      key = VisitCounter::Key.key(self, name)
+      VisitCounter::Store.engine.nullify(key)
     end
   end
 
-  def nullify_counter_cache(name)
-    key = VisitCounter::Key.key(self, name)
-    VisitCounter::Store.engine.nullify(key)
+  module ClassMethods
+
+    def cached_counter(name)
+      self.send(:alias_method, "real_#{name}", name)
+
+      self.send(:define_method, name) do
+        read_counter(name)
+      end
+
+      self.send(:define_method, "increase_#{name}") do
+        incr_counter(name)
+      end
+    end
+
   end
 end

data/spec/lib/visit_counter_spec.rb

@@ -8,9 +8,14 @@ class DummyObject
   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 = {host: "localhost"}
+VisitCounter::Store::RedisStore.redis = Redis.new(host: "localhost")
 
 describe VisitCounter do
   describe "incrementing counters" do
@@ -41,6 +46,49 @@ describe VisitCounter do
       end
       @d.counter.should == 143
     end
+  end
+
+  describe "reading counters" do
+
+    before :each do
+      @d = DummyObject.new
+      @d.stub!(:id).and_return(1)
+      @d.nullify_counter_cache(:counter)
+    end
+
+    it "should allow to read an unchanged counter" do
+      @d.counter = 10
+      @d.read_counter(:counter).should == 10
+    end
+
+    it "should read an updated counter" do
+      @d.counter = 10
+      @d.incr_counter(:counter)
+      @d.read_counter(:counter).should == 11
+    end
+  end
+
+  describe "overriding the getter" do
+    before :all do
+      DummyObject.cached_counter :counter
+    end
+
+    before :each do
+      @d = DummyObject.new
+      @d.stub!(:id).and_return(1)
+      @d.nullify_counter_cache(:counter)
+    end
 
+    it "should define the methods" do
+      @d.should respond_to(:real_counter)
+      @d.should respond_to(:increase_counter)
+    end
+
+    it "should set the counter" do
+      @d.counter = 10
+      @d.increase_counter
+      @d.counter.should == 11
+    end
   end
+
 end

data/visit-counter.gemspec

@@ -6,7 +6,7 @@ Gem::Specification.new do |gem|
   gem.email         = ["tcaspy@gmail.com"]
   gem.description   = %q{Simple counter increment which only writes to DB once in a while}
   gem.summary       = %q{No need to write to db each visit, save the visits to a quick DB like redis or memcached, and write to the SQL db once reads exeeded a certain threshold}
-  gem.homepage      = ""
+  gem.homepage      = "https://github.com/KensoDev/visit-counter"
 
   gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   gem.files         = `git ls-files`.split("\n")

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: visit-counter
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-25 00:00:00.000000000Z
+date: 2012-08-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70131008040560 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70131008040560
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70131008040040 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +37,15 @@ dependencies:
         version: 0.9.2
   type: :development
   prerelease: false
-  version_requirements: *70131008040040
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.2
 - !ruby/object:Gem::Dependency
   name: redis
-  requirement: &70131008039560 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,7 +53,12 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70131008039560
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Simple counter increment which only writes to DB once in a while
 email:
 - tcaspy@gmail.com
@@ -59,13 +74,16 @@ files:
 - lib/visit-counter.rb
 - lib/visit-counter/key.rb
 - lib/visit-counter/store.rb
+- lib/visit-counter/store/abstract_store.rb
+- lib/visit-counter/store/rails_store.rb
+- lib/visit-counter/store/redis_store.rb
 - lib/visit-counter/version.rb
 - lib/visit-counter/visit_counter.rb
 - spec/lib/store_spec.rb
 - spec/lib/visit_counter_spec.rb
 - spec/spec_helper.rb
 - visit-counter.gemspec
-homepage: ''
+homepage: https://github.com/KensoDev/visit-counter
 licenses: []
 post_install_message: 
 rdoc_options: []
@@ -85,7 +103,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.10
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: No need to write to db each visit, save the visits to a quick DB like redis