likes_tracker 0.0.1

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,10 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in likes_tracker.gemspec
+gemspec
+
+group :development, :test do
+  gem 'sqlite3'
+  gem 'rspec-rails', '~> 2.10.0'
+  gem 'factory_girl_rails', '~> 3.5.0'
+end

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Andrea Pavoni - http://andreapavoni.com
+
+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,129 @@
+# LikesTracker
+
+A Rails gem to track *likes* between two ```ActiveModel``` compliant models.  A common use case might be that a User likes a Post.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```gem 'likes_tracker'```
+
+And then execute:
+
+```$ bundle install```
+
+Or install it yourself as:
+
+```$ gem install likes_tracker```
+
+### Dependencies
+
+* [redis](http://redis.io)
+* ruby 1.9+ (it uses some 1.9's syntax)
+
+## 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*:
+
+```
+# app/models/post.rb
+class Post < ActiveRecord::Base
+  include LikesTracker
+  acts_as_liked_by :users
+
+  # rest of the code
+end
+
+# app/models/user.rb
+class User < ActiveRecord::Base
+  include LikesTracker
+  acts_as_liker_for :posts
+
+  # rest of the code
+end
+```
+
+Now your models will have some methods to manage the likes a model *gives* to another. Following the above example:
+
+```
+> user.likes_post? post
+ => false
+
+> user.liked_posts
+ => []
+
+> post.likes_users_count
+ => 0
+
+> user.like_post! post
+ => [true, true, 1.0]
+
+> user.likes_post? post
+ => 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.
+
+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.
+
+```
+# a silly example to show how it works
+> user.liked_posts {|model, ids| p [model, ids] }
+ => [Post(id: integer, ...), ["1"]]
+
+# the query executed by default
+> user.liked_posts {|model, ids| model.where(id: ids) }
+ => [#<Post id: 1, ...>]
+```
+
+Last but not least, here there're the remaining methods and examples:
+
+```
+# you should provide a *limit* parameter
+> Post.most_liked(5)
+ => [#<Post id: 1, ...>]
+
+> post.likes_users_count
+ => 1
+
+> user.unlike_post! post
+ => [true, true, 0.0]
+
+> user.likes_post? post
+ => false
+
+> user.liked_posts
+ => []
+
+> post.likes_users_count
+ => 0
+```
+
+## 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
+
+### Testing
+
+* clone this repo
+* run `bundle install`
+* run `rspec spec`
+
+
+## License
+Copyright (c) 2012 Andrea Pavoni http://andreapavoni.com

data/Rakefile

@@ -0,0 +1,9 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require 'rspec/core'
+require 'rspec/core/rake_task'
+
+Bundler::GemHelper.install_tasks
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/likes_tracker.rb

@@ -0,0 +1,84 @@
+require "likes_tracker/version"
+
+module LikesTracker
+  extend ActiveSupport::Concern
+
+  module ClassMethods
+    def acts_as_liker_for(model)
+      model_name = model.to_s.singularize.downcase
+      model_class = model.to_s.singularize.capitalize.constantize
+
+      model_table = model_name.pluralize
+      self_table = self.name.downcase.pluralize
+
+      liker_key = "#{model_table}:likes"
+      liked_key = "#{self_table}:likers"
+
+      # like <object>
+      define_method "like_#{model_name}!" do |obj|
+        $redis.multi do
+          $redis.sadd(self.redis_key(liker_key), obj.id)
+          $redis.sadd(obj.redis_key(liked_key), self.id)
+          $redis.zincrby("#{model_table}:like_scores", 1, obj.id)
+        end unless self.send("likes_#{model_name}?", obj)
+      end
+
+      # remove like from <object>
+      define_method "unlike_#{model_name}!" do |obj|
+        $redis.multi do
+          $redis.srem(self.redis_key(liker_key), obj.id)
+          $redis.srem(obj.redis_key(liked_key), self.id)
+          $redis.zincrby("#{model_table}:like_scores", -1, obj.id)
+        end if self.send("likes_#{model_name}?", obj)
+      end
+
+      # checks if <object> is liked or not
+      define_method "likes_#{model_name}?" do |obj|
+        $redis.sismember(self.redis_key(liker_key), obj.id)
+      end
+
+      # find liked <object>s
+      define_method "liked_#{model_name.pluralize}" do |&block|
+        liked_ids = $redis.smembers self.redis_key(liker_key)
+
+        if block
+          blk = ->(klass, params) { block.call(klass, params) }
+          blk.call(model_class, liked_ids)
+        else
+          model_class.where(id: liked_ids)
+        end
+      end
+
+    end # acts_as_liker_for
+
+    def acts_as_liked_by(model)
+      model_name = model.to_s.singularize.downcase
+      model_class = model.to_s.singularize.capitalize.constantize
+
+      model_table = model_name.pluralize
+
+      liker_key = "#{model_table}:likers"
+
+      # count received likes
+      define_method "likes_#{model_name.pluralize}_count" do
+        $redis.scard self.redis_key(liker_key)
+      end
+
+      # find the first <limit> <object>s with more likes
+      define_singleton_method :most_liked do |limit|
+        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)
+      end
+
+    end # acts_as_liked_by
+
+  end
+
+  # generate a redis key, based on class name and an optional string
+  def redis_key(key)
+    "#{self.class.name.downcase.pluralize}:#{self.id}:#{key}"
+  end
+
+end

data/lib/likes_tracker/version.rb

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

data/likes_tracker.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/likes_tracker/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Andrea Pavoni"]
+  gem.email         = ["andrea.pavoni@gmail.com"]
+  gem.description   = %q{track likes between rails models using Redis backend}
+  gem.summary       = %q{LikesTracker tracks likes between ActiveModel compliant models using a Redis backend. Once you include this lib, you can add/remove likes from an object to another (eg: a User likes a Post), plus a bunch of useful method helpers.}
+  gem.homepage      = "http://github.com/apeacox/likes_tracker"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "likes_tracker"
+  gem.require_paths = ["lib"]
+  gem.version       = LikesTracker::VERSION
+
+  gem.add_dependency 'rails', '>= 3.0.0'
+  gem.add_dependency 'redis', '~> 3.0.1'
+
+  gem.add_development_dependency 'factory_girl_rails', '~> 3.5.0'
+  gem.add_development_dependency 'rspec-rails', '~> 2.10.0'
+
+
+end

data/spec/dummy/README.rdoc

@@ -0,0 +1,261 @@
+== Welcome to Rails
+
+Rails is a web-application framework that includes everything needed to create
+database-backed web applications according to the Model-View-Control pattern.
+
+This pattern splits the view (also called the presentation) into "dumb"
+templates that are primarily responsible for inserting pre-built data in between
+HTML tags. The model contains the "smart" domain objects (such as Account,
+Product, Person, Post) that holds all the business logic and knows how to
+persist themselves to a database. The controller handles the incoming requests
+(such as Save New Account, Update Product, Show Post) by manipulating the model
+and directing data to the view.
+
+In Rails, the model is handled by what's called an object-relational mapping
+layer entitled Active Record. This layer allows you to present the data from
+database rows as objects and embellish these data objects with business logic
+methods. You can read more about Active Record in
+link:files/vendor/rails/activerecord/README.html.
+
+The controller and view are handled by the Action Pack, which handles both
+layers by its two parts: Action View and Action Controller. These two layers
+are bundled in a single package due to their heavy interdependence. This is
+unlike the relationship between the Active Record and Action Pack that is much
+more separate. Each of these packages can be used independently outside of
+Rails. You can read more about Action Pack in
+link:files/vendor/rails/actionpack/README.html.
+
+
+== Getting Started
+
+1. At the command prompt, create a new Rails application:
+       <tt>rails new myapp</tt> (where <tt>myapp</tt> is the application name)
+
+2. Change directory to <tt>myapp</tt> and start the web server:
+       <tt>cd myapp; rails server</tt> (run with --help for options)
+
+3. Go to http://localhost:3000/ and you'll see:
+       "Welcome aboard: You're riding Ruby on Rails!"
+
+4. Follow the guidelines to start developing your application. You can find
+the following resources handy:
+
+* The Getting Started Guide: http://guides.rubyonrails.org/getting_started.html
+* Ruby on Rails Tutorial Book: http://www.railstutorial.org/
+
+
+== Debugging Rails
+
+Sometimes your application goes wrong. Fortunately there are a lot of tools that
+will help you debug it and get it back on the rails.
+
+First area to check is the application log files. Have "tail -f" commands
+running on the server.log and development.log. Rails will automatically display
+debugging and runtime information to these files. Debugging info will also be
+shown in the browser on requests from 127.0.0.1.
+
+You can also log your own messages directly into the log file from your code
+using the Ruby logger class from inside your controllers. Example:
+
+  class WeblogController < ActionController::Base
+    def destroy
+      @weblog = Weblog.find(params[:id])
+      @weblog.destroy
+      logger.info("#{Time.now} Destroyed Weblog ID ##{@weblog.id}!")
+    end
+  end
+
+The result will be a message in your log file along the lines of:
+
+  Mon Oct 08 14:22:29 +1000 2007 Destroyed Weblog ID #1!
+
+More information on how to use the logger is at http://www.ruby-doc.org/core/
+
+Also, Ruby documentation can be found at http://www.ruby-lang.org/. There are
+several books available online as well:
+
+* Programming Ruby: http://www.ruby-doc.org/docs/ProgrammingRuby/ (Pickaxe)
+* Learn to Program: http://pine.fm/LearnToProgram/ (a beginners guide)
+
+These two books will bring you up to speed on the Ruby language and also on
+programming in general.
+
+
+== Debugger
+
+Debugger support is available through the debugger command when you start your
+Mongrel or WEBrick server with --debugger. This means that you can break out of
+execution at any point in the code, investigate and change the model, and then,
+resume execution! You need to install ruby-debug to run the server in debugging
+mode. With gems, use <tt>sudo gem install ruby-debug</tt>. Example:
+
+  class WeblogController < ActionController::Base
+    def index
+      @posts = Post.all
+      debugger
+    end
+  end
+
+So the controller will accept the action, run the first line, then present you
+with a IRB prompt in the server window. Here you can do things like:
+
+  >> @posts.inspect
+  => "[#<Post:0x14a6be8
+          @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>,
+       #<Post:0x14a6620
+          @attributes={"title"=>"Rails", "body"=>"Only ten..", "id"=>"2"}>]"
+  >> @posts.first.title = "hello from a debugger"
+  => "hello from a debugger"
+
+...and even better, you can examine how your runtime objects actually work:
+
+  >> f = @posts.first
+  => #<Post:0x13630c4 @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>
+  >> f.
+  Display all 152 possibilities? (y or n)
+
+Finally, when you're ready to resume execution, you can enter "cont".
+
+
+== Console
+
+The console is a Ruby shell, which allows you to interact with your
+application's domain model. Here you'll have all parts of the application
+configured, just like it is when the application is running. You can inspect
+domain models, change values, and save to the database. Starting the script
+without arguments will launch it in the development environment.
+
+To start the console, run <tt>rails console</tt> from the application
+directory.
+
+Options:
+
+* Passing the <tt>-s, --sandbox</tt> argument will rollback any modifications
+  made to the database.
+* Passing an environment name as an argument will load the corresponding
+  environment. Example: <tt>rails console production</tt>.
+
+To reload your controllers and models after launching the console run
+<tt>reload!</tt>
+
+More information about irb can be found at:
+link:http://www.rubycentral.org/pickaxe/irb.html
+
+
+== dbconsole
+
+You can go to the command line of your database directly through <tt>rails
+dbconsole</tt>. You would be connected to the database with the credentials
+defined in database.yml. Starting the script without arguments will connect you
+to the development database. Passing an argument will connect you to a different
+database, like <tt>rails dbconsole production</tt>. Currently works for MySQL,
+PostgreSQL and SQLite 3.
+
+== Description of Contents
+
+The default directory structure of a generated Ruby on Rails application:
+
+  |-- app
+  |   |-- assets
+  |       |-- images
+  |       |-- javascripts
+  |       `-- stylesheets
+  |   |-- controllers
+  |   |-- helpers
+  |   |-- mailers
+  |   |-- models
+  |   `-- views
+  |       `-- layouts
+  |-- config
+  |   |-- environments
+  |   |-- initializers
+  |   `-- locales
+  |-- db
+  |-- doc
+  |-- lib
+  |   `-- tasks
+  |-- log
+  |-- public
+  |-- script
+  |-- test
+  |   |-- fixtures
+  |   |-- functional
+  |   |-- integration
+  |   |-- performance
+  |   `-- unit
+  |-- tmp
+  |   |-- cache
+  |   |-- pids
+  |   |-- sessions
+  |   `-- sockets
+  `-- vendor
+      |-- assets
+          `-- stylesheets
+      `-- plugins
+
+app
+  Holds all the code that's specific to this particular application.
+
+app/assets
+  Contains subdirectories for images, stylesheets, and JavaScript files.
+
+app/controllers
+  Holds controllers that should be named like weblogs_controller.rb for
+  automated URL mapping. All controllers should descend from
+  ApplicationController which itself descends from ActionController::Base.
+
+app/models
+  Holds models that should be named like post.rb. Models descend from
+  ActiveRecord::Base by default.
+
+app/views
+  Holds the template files for the view that should be named like
+  weblogs/index.html.erb for the WeblogsController#index action. All views use
+  eRuby syntax by default.
+
+app/views/layouts
+  Holds the template files for layouts to be used with views. This models the
+  common header/footer method of wrapping views. In your views, define a layout
+  using the <tt>layout :default</tt> and create a file named default.html.erb.
+  Inside default.html.erb, call <% yield %> to render the view using this
+  layout.
+
+app/helpers
+  Holds view helpers that should be named like weblogs_helper.rb. These are
+  generated for you automatically when using generators for controllers.
+  Helpers can be used to wrap functionality for your views into methods.
+
+config
+  Configuration files for the Rails environment, the routing map, the database,
+  and other dependencies.
+
+db
+  Contains the database schema in schema.rb. db/migrate contains all the
+  sequence of Migrations for your schema.
+
+doc
+  This directory is where your application documentation will be stored when
+  generated using <tt>rake doc:app</tt>
+
+lib
+  Application specific libraries. Basically, any kind of custom code that
+  doesn't belong under controllers, models, or helpers. This directory is in
+  the load path.
+
+public
+  The directory available for the web server. Also contains the dispatchers and the
+  default HTML files. This should be set as the DOCUMENT_ROOT of your web
+  server.
+
+script
+  Helper scripts for automation and generation.
+
+test
+  Unit and functional tests along with fixtures. When using the rails generate
+  command, template test files will be generated for you and placed in this
+  directory.
+
+vendor
+  External libraries that the application depends on. Also includes the plugins
+  subdirectory. If the app has frozen rails, those gems also go here, under
+  vendor/rails/. This directory is in the load path.