为 ActiveRecord 模型添加收藏、关注、投票等功能
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.
This Medium article gives a good introduction to this gem.
You can add acts_as_favoritor to your Gemfile with:
gem 'acts_as_favoritor'And then run:
$ bundle installOr install it yourself as:
$ gem install acts_as_favoritorIf 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_favoritorTo wrap things up, migrate the changes into your database:
$ rails db:migrateAdd acts_as_favoritable to the models you want to be able to get favorited:
class User { favorite: true, watching: false }
user.favorited?(book, scopes: [:favorite]) # => { favorite: true }
user.favorited?(book, scope: :favorite) # => trueacts_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_listWhen 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, :textacts_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, :textCaches 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 # => 1Note: These methods are available for every scope you are using.
The total counts all favorites that were recorded, while the score factors in favorites that were removed. In most use cases the score is the most useful.
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
enddefault_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.
To start development you first have to fork this repository and locally clone your fork.
Install the projects dependencies by running:
$ bundle installTests are written with RSpec and can be found in /spec.
To run tests:
$ bundle exec rspecTo run RuboCop:
$ bundle exec rubocopWe warmly welcome everyone who is intersted in contributing. Please reference our contributing guidelines and our Code of Conduct.
Here you can find details on all past releases. Unreleased breaking changes that are on the current main can be found here.
acts_as_favoritor follows Semantic Versioning 2.0 as defined at http://semver.org. Reference our security policy.
CHANGELOG.md.lib/acts_as_favoritor/version.rb.CHANGELOG.md.main.main since the last release.暂无开放 Issues,或尚未同步最近议题。