acts_as_favoritor is a Rubygem to allow any ActiveRecord model to associate any other model including the option for multiple relationships per association with scopes.
You are able to differentiate followers, favorites, watchers, votes and whatever else you can imagine through a single relationship. This is accomplished by a double polymorphic relationship on the Favorite model. There is also built in support for blocking/un-blocking favorite records as well as caching.
acts_as_favoritor works with Rails 5.0 onwards. You can add it to your Gemfile
with:
gem 'acts_as_favoritor'
And then execute:
$ bundle
Or install it yourself as:
$ gem install acts_as_favoritor
If you always want to be up to date fetch the latest from GitHub in your Gemfile
:
gem 'acts_as_favoritor', github: 'jonhue/acts_as_favoritor'
Now run the generator:
$ rails g acts_as_favoritor
To wrap things up, migrate the changes into your database:
$ rails db:migrate
Add acts_as_favoritable
to the models you want to be able to get favorited:
class User < ActiveRecord::Base
acts_as_favoritable
end
class Book < ActiveRecord::Base
acts_as_favoritable
end
Specify which models can favorite other models by adding acts_as_favoritor
:
class User < ActiveRecord::Base
acts_as_favoritor
end
book = Book.find(1)
user = User.find(1)
# `user` favorites `book`.
user.favorite(book)
# `user` removes `book` from favorites.
user.unfavorite(book)
# Whether `user` has marked `book` as his favorite. Returns `true` or `false`.
user.favorited?(book)
# Returnes `user`'s favorites that have not been blocked as an array of `Favorite` records.
user.all_favorites
# Returns all favorited objects of `user` as an array (unblocked). This can be a collection of different object types, e.g.: `User`, `Book`.
user.all_favorited
# Returns an array of `Favorite` records where the `favoritable_type` is `Book`.
user.favorites_by_type('Book')
# Returns an array of all favorited objects of `user` where `favoritable_type` is 'Book', this can be a collection of different object types, e.g.: `User`, `Book`.
user.favorited_by_type('Book')
# Returns the exact same result as `user.favorited_by_type 'User'`.
user.favorited_users
# Whether `user` has been blocked by `book`. Returns `true` or `false`.
user.blocked_by?(book)
# Returns an array including all blocked Favorite records.
user.blocked_by
These methods take an optional hash parameter of ActiveRecord options (:limit
, :order
, etc...)
favorites_by_type, all_favorites, all_favorited, favorited_by_type
# Returns all favoritors of a model that `acts_as_favoritable`
book.favoritors
# Returns an array of records with type `User` following `book`.
book.favoritors_by_type('User')
# Returns the exact same as `book.favoritors_by_type 'User'`.
book.user_favoritors
# Whether `book` has been favorited by `user`. Returns `true` or `false`.
book.favorited_by?(user)
# Block a favoritor
book.block(user)
# Unblock a favoritor
book.unblock(user)
# Whether `book` has blocked `user` as favoritor. Returns `true` or `false`.
book.blocked?(user)
# Returns an array including all blocked Favoritor records.
book.blocked
These methods take an optional hash parameter of ActiveRecord options (:limit
, :order
, etc...)
favoritors_by_type, favoritors, blocks
# Returns all `Favorite` records where `blocked` is `false`.
Favorite.unblocked
# Returns all `Favorite` records where `blocked` is `true`.
Favorite.blocked
# Returns all favorites of `user`, including those who were blocked.
Favorite.for_favoritor(user)
# Returns all favoritors of `book`, including those who were blocked.
Favorite.for_favoritable(book)
Using scopes with acts_as_favoritor
enables you to Follow, Watch, Favorite, [...] between any of your models. This way you can separate distinct functionalities in your app between user states. For example: A user sees all his favorited books in a dashboard ('favorite'
), but he only receives notifications for those, he is watching ('watch'
). Just like YouTube or GitHub do it. Options are endless. You could also integrate a voting / star system similar to YouTube or GitHub
By default all of your favorites are scoped to 'favorite'
.
You can create new scopes on the fly. Every single method takes scope
as an option which expexts an array containing your scopes as strings.
So lets see how this works:
user.favorite(book, scopes: [:favorite, :watching])
user.unfavorite(book, scopes: [:watching])
second_user = User.find(2)
user.favorite(second_user, scopes: [:follow])
That's simple!
When you call a method which returns something while specifying multiple scopes, the method returns the results in a hash with the scopes as keys:
user.favorited?(book, scopes: [:favorite, :watching]) # => { favorite: true, watching: false }
user.favorited?(book, scopes: [:favorite]) # => true
acts_as_favoritor
also provides some handy scopes for you to call on the Favorite
model:
# Returns all `Favorite` records where `scope` is `my_scope`
Favorite.send("#{my_scope}_list")
## Examples
### Returns all `Favorite` records where `scope` is `favorites`
Favorite.favorite_list
### Returns all `Favorite` records where `scope` is `watching`
Favorite.watching_list
When you set the option cache
in config/initializers/acts_as_favoritor.rb
to true, you are able to cache the amount of favorites/favoritables an instance has regarding a scope.
For that you need to add some database columns:
acts_as_favoritor
add_column :users, :favoritor_score, :text
add_column :users, :favoritor_total, :text
acts_as_favoritable
add_column :users, :favoritable_score, :text
add_column :users, :favoritable_total, :text
add_column :books, :favoritable_score, :text
add_column :books, :favoritable_total, :text
Caches are stored as hashes with scopes as keys:
user.favoritor_score # => { favorite: 1 }
user.favoritor_total # => { favorite: 1, watching: 1 }
second_user.favoritable_score # => { follow: 1 }
book.favoritable_score # => { favorite: 1 }
Note: Only scopes who have favorites are included.
acts_as_favoritor
makes it even simpler to access cached values:
user.favoritor_favorite_cache # => 1
second_user.favoritable_follow_cache # => 1
book.favoritable_favorite_cache # => 1
Note: These methods are available for every scope you are using.
You can configure acts_as_favoritor by passing a block to configure
. This can be done in config/initializers/acts_as_favoritor.rb
:
ActsAsFavoritor.configure do |config|
config.default_scope = :follow
end
default_scope
Specify your default scope. Takes a string. Defaults to :favorite
. Learn more about scopes here.
cache
Whether acts_as_favoritor
uses caching or not. Takes a boolean. Defaults to false
. Learn more about caching here.
Tests are written with Shoulda on top of Test::Unit
with Factory Girl being used instead of fixtures. Tests are run using rake.
-
Fork this repository
-
Clone your forked git locally
-
Install dependencies
$ bundle install
-
Run tests
$ bundle exec rspec
-
Run RuboCop
$ bundle exec rubocop
We use GitHub projects to coordinate the work on this project.
To propose your ideas, initiate the discussion by adding a new issue.
We hope that you will consider contributing to acts_as_favoritor. Please read this short overview for some information about how to get started:
Learn more about contributing to this repository, Code of Conduct
acts_as_favoritor follows Semantic Versioning 2.0 as defined at http://semver.org.