visit-counter 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in visit-counter.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Tom Caspy
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,29 @@
+# Visit::Counter
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'visit-counter'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install visit-counter
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/lib/visit-counter.rb

@@ -0,0 +1,7 @@
+require "visit-counter/version"
+require "visit-counter/key"
+require "visit-counter/visit_counter"
+require "visit-counter/store/abstract_store"
+require "visit-counter/store/redis_store"
+require "visit-counter/store/rails_store"
+require "visit-counter/store"

data/lib/visit-counter/key.rb

@@ -0,0 +1,7 @@
+module VisitCounter
+  class Key
+    def self.key(object, method)
+      "visit_counter::#{object.class.to_s}::#{object.id}::#{method}"
+    end
+  end
+end

data/lib/visit-counter/store.rb

@@ -0,0 +1,18 @@
+module VisitCounter
+  class Store
+    @@engine ||= VisitCounter::Store::RedisStore
+
+    class << self
+
+      def set_engine(store)
+        @@engine = store
+      end
+
+      def engine
+        @@engine
+      end
+
+    end
+    
+  end
+end

data/lib/visit-counter/version.rb

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

data/lib/visit-counter/visit_counter.rb

@@ -0,0 +1,16 @@
+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)
+    end
+  end
+
+  def nullify_counter_cache(name)
+    key = VisitCounter::Key.key(self, name)
+    VisitCounter::Store.engine.nullify(key)
+  end
+end

data/spec/lib/store_spec.rb

@@ -0,0 +1,19 @@
+require "spec_helper"
+
+describe VisitCounter::Store do
+  
+  describe "engine" do
+    it "should have the redis store by default" do
+      VisitCounter::Store.engine.should == VisitCounter::Store::RedisStore
+    end
+
+    it "should be able to change the storage engine" do
+      VisitCounter::Store.set_engine(VisitCounter::Store::RailsStore)
+      VisitCounter::Store.engine.should == VisitCounter::Store::RailsStore
+
+      #switching back
+      VisitCounter::Store.set_engine(VisitCounter::Store::RedisStore)
+    end
+  end
+
+end

data/spec/lib/visit_counter_spec.rb

@@ -0,0 +1,46 @@
+require "spec_helper"
+
+class DummyObject
+  include VisitCounter
+
+  attr_accessor :counter
+
+  def update_attribute(attribute, value)
+    self.send("#{attribute}=", value)
+  end
+end
+
+VisitCounter::Store::RedisStore.redis = {host: "localhost"}
+
+describe VisitCounter do
+  describe "incrementing counters" do
+    before :each do
+      @d = DummyObject.new
+      @d.stub!(:id).and_return(1)
+      @d.nullify_counter_cache(:counter)
+    end
+
+    it "should increase the counter from nil / zero using the incr_counter method" do
+      @d.counter.should be_nil
+      @d.incr_counter(:counter)
+      @d.counter.should == 1
+    end
+
+    it "should not increase the counter if not passing the threshold" do
+      @d.counter = 100
+      @d.incr_counter(:counter)
+      @d.counter.should == 100
+      43.times do
+        @d.incr_counter(:counter)
+      end
+      @d.counter.should == 143
+
+      #should still be 143, because of the percentage thingie
+      43.times do
+        @d.incr_counter(:counter)
+      end
+      @d.counter.should == 143
+    end
+
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+require 'rubygems'
+require "visit-counter"
+
+  RSpec.configure do |config|
+    # config.mock_with :mocha
+    # config.mock_with :flexmock
+    # config.mock_with :rr
+    config.mock_with :rspec
+  end

data/visit-counter.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/visit-counter/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Tom Caspy"]
+  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.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.name          = "visit-counter"
+  gem.require_paths = ["lib"]
+  gem.version       = VisitCounter::VERSION
+  
+  gem.add_development_dependency(%q<rspec>, [">= 0"])
+  gem.add_development_dependency(%q<rake>, ["~> 0.9.2"])
+  gem.add_dependency(%q<redis>, [">= 0"])
+end

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: visit-counter
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Tom Caspy
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-07-25 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70131008040560 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70131008040560
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70131008040040 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+  type: :development
+  prerelease: false
+  version_requirements: *70131008040040
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: &70131008039560 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70131008039560
+description: Simple counter increment which only writes to DB once in a while
+email:
+- tcaspy@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/visit-counter.rb
+- lib/visit-counter/key.rb
+- lib/visit-counter/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: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: 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
+test_files:
+- spec/lib/store_spec.rb
+- spec/lib/visit_counter_spec.rb
+- spec/spec_helper.rb