monocle 0.2.0 → 0.2.1

data/Guardfile

@@ -1,6 +1,5 @@
 guard :rspec, version: 2, all_after_pass: true, all_on_start: false, keep_failed: false, cli: '--tty --color --format nested' do
   watch(%r{^spec/.+_spec\.rb})
-  watch(%r{^app/(.+)\.rb}) { |m| "spec/#{m[1]}_spec.rb" }
-  watch(%r{^lib/(.+)\.rb}) { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch(%r{^lib/(.+)\.rb}) { |m| "spec/#{m[1]}_spec.rb" }
   watch('spec/spec_helper.rb') { 'spec' }
 end

data/lib/monocle.rb

@@ -13,7 +13,9 @@ module Monocle
                     :_monocle_redis_connection
 
     self._monocle_options = {
-      cache_view_counts: false
+      cache_view_counts: false,
+      cache_threshold: 15.minutes,
+      cache_threshold_check_field: :updated_at
     }
 
     self._monocle_view_types = {
@@ -52,23 +54,55 @@ module Monocle
       end
     end
 
-    def most_viewed_since(since, limit = 1000)
-      objects = self._monocle_redis_connection.zrevrangebyscore(self.monocle_key, Time.now.to_i, since.to_i, limit: [0, limit])
-      objects.collect { |o| self.find(o[0]) }
+    def recently_viewed_since(since, options = {})
+      options[:limit] ||= 1000
+      options[:with_objects] = options.has_key?(:with_objects) ? options[:with_objects] : true
+
+      results = self._monocle_redis_connection.zrevrangebyscore(self.monocle_key('recently_viewed'), Time.now.to_i, since.to_i, limit:[0, options[:limit]])
+      options[:with_objects] ? results.map { |id| self.find(id) } : results
+    end
+
+    def most_viewed_since(since, options = {})
+      options[:limit] ||= 1000
+      options[:with_objects] = options.has_key?(:with_objects) ? options[:with_objects] : true
+
+      viewed_by_score = self._monocle_redis_connection.zrevrangebyscore(self.monocle_key('view_counts'), '+inf', '-inf', limit: [0, options[:limit]])
+      results = viewed_by_score & recently_viewed_since(since, with_objects: false, limit: options[:limit])
+      options[:with_objects] ? results.map { |id| self.find(id) } : results
     end
   end
 
   def view!
-    self._monocle_view_types.keys.each do |view_type|
-      cache_field = "#{view_type}_views".to_sym
-      count = self._monocle_redis_connection.hincrby(self.class.monocle_key(id), self.send("#{view_type}_views_field"), 1)
-      if self._monocle_options[:cache_view_counts] && respond_to?(cache_field)
-        update_column(cache_field, count) if respond_to?(:update_column)
-        set(cache_field, count) if respond_to?(:set)
+    results = self._monocle_redis_connection.pipelined do
+      self._monocle_view_types.keys.each do |view_type|
+        self._monocle_redis_connection.hincrby(self.class.monocle_key(id), self.send("#{view_type}_views_field"), 1)
+      end
+      self._monocle_redis_connection.zadd(self.class.monocle_key('recently_viewed'), Time.now.to_i, id)
+      self._monocle_redis_connection.zincrby(self.class.monocle_key('view_counts'), 1, id)
+    end
+
+    if should_cache_view_count?
+      self._monocle_view_types.keys.each_with_index do |view_type, i|
+        cache_view_count(view_type, results[i])
       end
     end
+  end
+
+  def cache_field_for_view(view_type)
+    :"#{view_type}_views"
+  end
+
+  def should_cache_view_count?
+    if self._monocle_options[:cache_view_counts]
+      self.send(self._monocle_options[:cache_threshold_check_field]) < (Time.now - self._monocle_options[:cache_threshold])
+    else
+      false
+    end
+  end
 
-    self._monocle_redis_connection.zadd(self.class.monocle_key, Time.now.to_i, id)
+  def cache_view_count(view_type, count)
+    update_column(cache_field_for_view(view_type), count) if respond_to?(:update_column)
+    set(cache_field_for_view(view_type), count) if respond_to?(:set)
   end
 
   def destroy_views

data/lib/monocle/version.rb

@@ -1,3 +1,3 @@
 module Monocle
-  VERSION = '0.2.0'
+  VERSION = '0.2.1'
 end

data/spec/monocle_spec.rb

@@ -3,15 +3,17 @@ require 'spec_helper'
 class TestObject
   include Monocle
 
-  monocle_options cache_view_counts: true
+  monocle_options cache_view_counts: true,
+                  cache_threshold: 15.minutes,
+                  cache_threshold_check_field: :updated_at
 
   monocle_views overall:   -> { 'overall' },
                 yearly:    -> { Time.now.beginning_of_year },
+                quarterly: -> { Time.now.beginning_of_quarter },
                 monthly:   -> { Time.now.beginning_of_month },
                 weekly:    -> { Time.now.beginning_of_week },
                 daily:     -> { Time.now.beginning_of_day },
-                hourly:    -> { Time.now.beginning_of_hour },
-                quarterly: -> { Time.now.beginning_of_quarter }
+                hourly:    -> { Time.now.beginning_of_hour }
 
   attr_accessor :id
   attr_accessor :overall_views, :yearly_views, :monthly_views
@@ -32,26 +34,47 @@ class TestObject
   def update_column(field, count)
     self.send("#{field}=", count)
   end
+
+  def updated_at
+    Time.now - 1.hour
+  end
+end
+
+def make_viewed_objects(number_of_objects_to_make)
+  number_of_objects_to_make.times do |i|
+    o = TestObject.new
+    o.id = i
+    o.view!
+  end
 end
 
 describe Monocle do
+
   let(:object) { TestObject.new }
 
+  describe '#recently_viewed' do
+    before { make_viewed_objects(10) }
+    let(:recently_viewed) { TestObject.recently_viewed_since(1.day.ago) }
+
+    it 'returns the most recently viewed object at the top of the list' do
+      recently_viewed.first.id.should == 9
+    end
+
+    it 'returns the last recently viewed object at the bottom of the list' do
+      recently_viewed.last.id.should == 0
+    end
+  end
+
   describe '#most_viewed_since' do
     before do
-      10.times do |i|
-        o = TestObject.new
-        o.id = i
-        (i + 10).times do
-          o.view!
-        end
-      end
+      make_viewed_objects(10)
+      10.times { TestObject.find(3).view! }
     end
 
     it 'returns top viewed objects since a given time' do
       viewed = TestObject.most_viewed_since(Time.now.beginning_of_day)
       viewed.class.should == Array
-      viewed.first.id.should == TestObject.find(9).id
+      viewed.first.id.should == 3
     end
   end
 
@@ -63,14 +86,39 @@ describe Monocle do
     end
   end
 
-  describe '#view!' do
-    before do
-      50.times { object.view! }
+  describe '#cache_field_for_view' do
+    it 'returns the cache field for the given view type' do
+      object.cache_field_for_view('overall').should == :overall_views
     end
+  end
 
-    after do
-      object.destroy_views
+  describe '#should_cache_view_count?' do
+    context 'the class has cache_view_counts set to true' do
+      context 'the objects last updated time is greater than the threshold' do
+        it 'returns true' do
+          object.should_cache_view_count?.should == true
+        end
+      end
+
+      context 'the objects last updated time is less than the threshold' do
+        it 'returns true' do
+          object.stub(:updated_at).and_return(Time.now)
+          object.should_cache_view_count?.should == false
+        end
+      end
+    end
+
+    context 'the class has cache_view_counts set to false' do
+      it 'returns false' do
+        object.class.stub(:_monocle_options).and_return({cache_view_counts:false})
+        object.should_cache_view_count?.should == false
+      end
     end
+  end
+
+  describe '#view!' do
+    before { 50.times { object.view! }}
+    after { object.destroy_views }
 
     %w(overall yearly monthly weekly daily hourly quarterly).each do |view_type|
       it "sets #{view_type} views count" do

data/spec/spec_helper.rb

@@ -17,5 +17,6 @@ RSpec.configure do |config|
     REDIS.keys('monocle*').each do |key|
       REDIS.del(key)
     end
+    sleep(0.5)
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: monocle
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
   prerelease: 
 platform: ruby
 authors: