likes_tracker 0.0.1 → 0.0.3

data/.gitignore

@@ -20,3 +20,4 @@ spec/dummy/log/*.log
 spec/dummy/tmp/
 .rspec
 coverage/*
+*.rdb

data/Gemfile

@@ -4,6 +4,7 @@ source 'https://rubygems.org'
 gemspec
 
 group :development, :test do
+  gem 'simplecov', require: false
   gem 'sqlite3'
   gem 'rspec-rails', '~> 2.10.0'
   gem 'factory_girl_rails', '~> 3.5.0'

data/README.md

@@ -23,8 +23,14 @@ Or install it yourself as:
 
 ## Usage
 
-Given you have two models, say User and Post, and you want to track the *likes* a given Post receives by User(s). Include the LikesTracker
-module and use the methods it offers to setup models as *liker* and *liked*:
+First of all, you need a ```$redis``` in your app, you might achieve this using an initializer:
+
+```
+# config/initializers/redis.rb
+$redis = Redis.new(host: 'localhost', port: '6379', db: '1')
+```
+
+Given you have two models, say User and Post, and you want to track the *likes* a given Post receives by User(s). Include the LikesTracker module and use the methods it offers to setup models as *liker* and *liked*:
 
 ```
 # app/models/post.rb
@@ -63,8 +69,7 @@ Now your models will have some methods to manage the likes a model *gives* to an
  => true
 ```
 
-As you can see, the methods' names reflect model names (and they'll be properly namespaced on Redis). This means, that the same models can like
-several others, for example User might like another model called Photo or Comment.
+As you can see, the methods' names reflect model names (and they'll be properly namespaced on Redis). This means, that the same models can like several others, for example User might like another model called Photo or Comment, so you'll have methods like ```#like_comment!``` or ```#likes_photo?``` and so on.
 
 How to find Posts liked by a User? There's a method for this, of course ;-)
 
@@ -72,10 +77,7 @@ How to find Posts liked by a User? There's a method for this, of course ;-)
 > user.liked_posts
  => [#<Post id: 1, ...>]
 ```
-It returns a *relation*, such as ```ActiveRecord::Relation```. Even if I
-haven't tested it yet, this *should* work with other ORMs like Mongoid.
-
-However, this method has an experimental feature: it accepts a block to operate custom queries. I'm still not sure I will expand it to other methods.
+It returns a *relation*, such as ```ActiveRecord::Relation```. Even if I haven't tested it yet, this *should* work with other ORMs like Mongoid.
 
 ```
 # a silly example to show how it works
@@ -90,10 +92,18 @@ However, this method has an experimental feature: it accepts a block to operate
 Last but not least, here there're the remaining methods and examples:
 
 ```
-# you should provide a *limit* parameter
+# you can provide a *limit* parameter, if omitted it defaults to 5
 > Post.most_liked(5)
  => [#<Post id: 1, ...>]
 
+# and it also accepts an  *offset* parameter, if omitted it defaults to 0
+> Post.most_liked(5, 0)
+ => [#<Post id: 1, ...>]
+
+# last but not least, it accepts a block, like you've already seen in above examples
+> Post.most_liked(5, 0) {|model, ids| p [model, ids] }
+ => [Post(id: integer, ...), ["1"]]
+
 > post.likes_users_count
  => 1
 
@@ -126,4 +136,4 @@ Last but not least, here there're the remaining methods and examples:
 
 
 ## License
-Copyright (c) 2012 Andrea Pavoni http://andreapavoni.com
+Copyright (c) 2012 Andrea Pavoni http://andreapavoni.com

data/lib/likes_tracker.rb

@@ -65,11 +65,17 @@ module LikesTracker
       end
 
       # find the first <limit> <object>s with more likes
-      define_singleton_method :most_liked do |limit|
+      define_singleton_method :most_liked do |limit=5, offset=0, &block|
         limit -= 1 if (limit > 0)
         most_liked_key = "#{self.name.downcase.pluralize}:like_scores"
-        most_liked_ids = $redis.zrevrange(most_liked_key, 0, limit)
-        self.where(id: most_liked_ids)
+        most_liked_ids = $redis.zrevrange(most_liked_key, offset, limit)
+
+        if block
+          blk = ->(klass, params) { block.call(klass, params) }
+          blk.call(self, most_liked_ids)
+        else
+          self.where(id: most_liked_ids)
+        end
       end
 
     end # acts_as_liked_by

data/lib/likes_tracker/version.rb

@@ -1,3 +1,3 @@
 module LikesTracker
-  VERSION = "0.0.1"
+  VERSION = "0.0.3"
 end

data/spec/likes_tracker_spec.rb

@@ -61,15 +61,25 @@ describe LikesTracker do
     end # likes_post?
 
     describe "#liked_posts" do
+      before(:each) do
+        user.like_post! post
+      end
+
       it "returns an ActiveRecord::Relation" do
         user.liked_posts.should be_a(ActiveRecord::Relation)
       end
 
       it "return posts liked by user" do
-        user.like_post! post
         user.liked_posts.should include(post)
       end
 
+      it "accepts a block to make custom queries" do
+        klass, id_list = user.liked_posts {|model, ids| [model, ids]}
+
+        klass.should == Post
+        id_list.should == [post.id.to_s]
+      end
+
     end # liked_posts
 
   end # .acts_as_liker_for
@@ -90,25 +100,46 @@ describe LikesTracker do
     end # likes_users_count
 
     describe ".most_liked" do
-      it "returns an ActiveRecord::Relation" do
-        Post.most_liked(5).should be_a(ActiveRecord::Relation)
-      end
+      let(:user2) { FactoryGirl.create :user }
+      let(:post2) { FactoryGirl.create :post }
 
-      it "return most liked posts" do
+      before(:each) do
         user.like_post! post
 
-        user2 = FactoryGirl.create :user
-        post2 = FactoryGirl.create :post
-
         user.like_post! post2
         user2.like_post! post
 
         post.likes_users_count.should == 2
         post2.likes_users_count.should == 1
+      end
 
+      it "returns an ActiveRecord::Relation" do
+        Post.most_liked(5).should be_a(ActiveRecord::Relation)
+      end
+
+      it "accepts a limit parameter" do
         Post.most_liked(5).should == [post, post2]
       end
 
+      it "accepts an offset parameter" do
+        Post.most_liked(5, 1).should == [post2]
+      end
+
+      it "defaults limit to 5" do
+        Post.most_liked.should == [post, post2]
+      end
+
+      it "defaults offset to 0" do
+        Post.most_liked.should == [post, post2]
+      end
+
+      it "accepts a block to make custom queries" do
+        klass, id_list = Post.most_liked {|model, ids| [model, ids]}
+
+        klass.should == Post
+        id_list.should == [post.id.to_s, post2.id.to_s]
+      end
+
     end # .most_liked
 
   end # .acts_as_liked_by

data/spec/spec_helper.rb

@@ -1,3 +1,8 @@
+if ENV['COV']
+  require 'simplecov'
+  SimpleCov.start 'rails'
+end
+
 ENV["RAILS_ENV"] = "test"
 
 require File.expand_path("../dummy/config/environment.rb",  __FILE__)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: likes_tracker
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-26 00:00:00.000000000 Z
+date: 2012-07-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails