Rails mountable Notification for any applications.
# Gemfile
gem 'notifications'And then run bundle install.
Now you have notifications generator in Rails application:
$ rails g notifications:installAnd, you can generate views, controller if you need custom them:
$ rails g notifications:views
$ rails g notifications:controllersclass User
def follow(user)
Notification.create(notify_type: 'follow', actor: self, user: user)
end
end
class Comment
belongs_to :post
belongs_user :user
after_commit :create_notifications, on: [:create]
def create_notifications
Notification.create(
notify_type: 'comment',
actor: self.user,
user: self.post.user,
target: self)
end
endGet user unread count:
count = Notification.unread_count(current_user)If you create a notify_type, you need add a partial view in app/views/notifications/ path, for example:
# There have two notify_type
Notification.create(notify_type: 'follow' ....)
Notification.create(notify_type: 'mention', target: @reply, second_target: @topic, ....)You app must be have:
- app/views/notifications/_follow.html.erb
- app/views/notifications/_mention.html.erb
# app/views/notifications/_follow.html.erb
<div class="media-heading">
<%= link_to notification.actor.title, notification.actor %> just followed you.
</div># app/views/notifications/_mention.html.erb
<div class="media-heading">
<%= link_to notification.actor.title, notification.actor %> has mention you in
<%= link_to notification.second_target.title, topic_path(notification.second_target) %>
</div>
<div class="media-content">
<%= notification.target.body %>
</div>We suggest use second_level_cached for solve N+1 performance issue.
Contribution directions go here.
The gem is available as open source under the terms of the MIT License.