Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jschwindt/likeable
This is a fork of the following missing repository: https://github.com/amrnt/Likeable
https://github.com/jschwindt/likeable
Last synced: about 1 month ago
JSON representation
This is a fork of the following missing repository: https://github.com/amrnt/Likeable
- Host: GitHub
- URL: https://github.com/jschwindt/likeable
- Owner: jschwindt
- License: other
- Created: 2013-09-17T15:10:48.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2013-09-17T15:11:14.000Z (over 11 years ago)
- Last Synced: 2024-04-08T15:57:37.799Z (9 months ago)
- Language: Ruby
- Size: 152 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: license.txt
Awesome Lists containing this project
README
Use Redis to Make your Ruby objects Likeable!
======
You like this
-------------
Likeable is the easiest way to allow your models to be liked by users, just drop a few lines of code into your model and you're good to go.
```ruby
class Comment
include Likeable
# ...
end
class User
include Likeable::UserMethods
# ...
end
Likeable.setup do |likeable|
likeable.redis = Redis.new
end
comment = Comment.find(15)
comment.like_count # => 0
current_user.like!(comment) # => #
comment.like_count # => 1
comment.likes # => [#]
comment.likes.last.user # => #
comment.likes.last.created_at # => Wed Jul 27 19:34:32 -0500 2011
comment.liked_by?(current_user) # => true
current_user.all_liked(Comment) # => [#, ...]
liked_comment = Likeable.find_by_resource_id("Comment", 15)
liked_comment == comment # => true
```
And it also allow your models to be disliked by users:
```ruby
comment = Comment.find(15)
comment.dislike_count # => 0
current_user.dislike!(comment) # => #
comment.dislike_count # => 1
comment.dislikes # => [#]
comment.dislikes.last.user # => #
comment.dislikes.last.created_at # => Thu Nov 10 06:16:14 +0200 2011
comment.disliked_by?(current_user) # => true
current_user.all_disliked(Comment) # => [#, ...]
# Notice `plusminus` method that equals to (like_count - dislike_count)
comment = Comment.find(15)
comment.plusminus # => 0
current_user.dislike!(comment)
comment.plusminus # => -1
comment.disliked_by?(current_user) # => true
current_user.like!(comment)
comment.plusminus # => 1
comment.liked_by?(current_user) # => true
current_user_2.like!(comment)
comment.plusminus # => 2
comment.liked_by?(current_user_2) # => true
# Notice `cancel_like!` method
current_user.cancel_like!(comment)
comment.plusminus # => 1
comment.liked_by?(current_user) # => false
comment.disliked_by?(current_user) # => false
```
## Screencast
You can view a [screencast of likeable in action on youtube](http://youtu.be/iJoMXUQ33Jw?hd=1). There is also an example [Likeable rails application](https://github.com/schneems/likeable_example) that you can use to follow along.
Setup
=======
Gemfile:
gem 'likeable'
Next set up your Redis connection in initializers/likeable.rb:
```ruby
Likeable.setup do |likeable|
likeable.redis = Redis.new
end
```
Then add the `Likeable::UserMethods` module to models/user.rb:
```ruby
class User
include Likeable::UserMethods
end
```
Finally add `Likeable` module to any model you want to be liked:
```ruby
class Comment
include Likeable
end
```
## Rails Info
If you're using Likeable in Rails this should help you get started
controllers/likes_controller.rb
```ruby
class LikesController < ApplicationController
def create_like
target = Likeable.find_by_resource_id(params[:resource_name], params[:resource_id])
current_user.like!(target)
redirect_to :back, :notice => 'successfully liked'
end
def create_dislike
target = Likeable.find_by_resource_id(params[:resource_name], params[:resource_id])
current_user.dislike!(target)
redirect_to :back, :notice => 'successfully disliked'
end
def cancel_like
target = Likeable.find_by_resource_id(params[:resource_name], params[:resource_id])
current_user.cancel_like!(target)
redirect_to :back, :notice => 'successfully canceled'
end
end
```
config/routes.rb
```ruby
match 'likes/:resource_name/:resource_id/like' => "likes#create_like", :as => :like
match 'likes/:resource_name/:resource_id/dislike' => "likes#create_dislike", :as => :dislike
match 'likes/:resource_name/:resource_id/cancel' => "likes#cancel_like", :as => :cancel_like
```
helpers/like_helper.rb
```ruby
def like_link_for(target)
link_to "like it!", like_path(:resource_name => target.class, :resource_id => target.id)
end
def dislike_link_for(target)
link_to "dislike it!", dislike_path(:resource_name => target.class, :resource_id => target.id)
end
def cancel_like_link_for(target)
link_to "cancel like!", cancel_like_path(:resource_name => target.class, :resource_id => target.id)
end
```
Then in any view you can simply call the helper methods to give your user a link
```ruby
<%- if @user.likes? @comment || @user.dislikes? @comment -%>
<%- if @user.likes? @comment -%>
<%= dislike_link_for @comment %>
<%- else -%>
<%= like_link_for @comment %>
<%- end -%>
<%= cancel_like_link_for @comment %>
<%- end -%>
```
Why
===
We chose Redis because it is screaming fast, and very simple to work with. By using redis for likeable we take load off of our relational database and speed up individual calls retrieve information about the "liked" state of an object. If you're not using redis in production, and don't want to, there are many other great liking/voting libraries out there such as [thumbs up](https://github.com/brady8/thumbs_up).
RedisRed RedisRedi
RedisRedisRedi RedisRedisRedisR
RedisRedisRedisRedi RedisRedisRedisRedi
RedisRedisRedisRedisRedisRedisRe Redi
RedisRedisRedisRedisRedisRedisRe Redi
RedisRedisRedisRedisRedisRedisRedisR Redi
RedisRedisRedisRedisRedisRedisRedisRedis R
RedisRedisRedisRedisRedisRedisRedisRedisRedi Red
RedisRedisRedisRedisRedisRedisRedisRedisRedisRe R
RedisRedisRedisRedisRedisRedisRedisRedisRedisRedi
RedisRedisRedisRedisRedisRedisRedisRedisRedisRedi
RedisRedisRedisRedisRedisRedisRedisRedisRedisRe
RedisRedisRedisRedisRedisRedisRedisRedisRedis
RedisRedisRedisRedisRedisRedisRedisRedisRe
RedisRedisRedisRedisRedisRedisRedisRe
RedisRedisRedisRedisRedisRedisR
RedisRedisRedisRedisRedis
RedisRedisRedisRedis
RedisRedisRed
RedisRedi
RedisR
Redi
Re
Authors
=======
[Richard Schneeman](http://schneems.com) for [Gowalla](http://gowalla.com) <3
Contribution
============
Fork away. If you want to chat about a feature idea, or a question you can find me on the twitters [@schneems](http://twitter.com/schneems). Put any major changes into feature branches. Make sure all tests stay green, and make sure your changes are covered.
licensed under MIT License
Copyright (c) 2011 Schneems. See LICENSE.txt for
further details.