Notifications
Mountable notifications for any Rails applications.
Example:
Installation
# Gemfile
gem 'notifications'
And then run bundle install
.
You now have a notifications generator in your Rails application:
$ rails g notifications:install
You can generate views, controllers if you need to customize them:
$ rails g notifications:views
$ rails g notifications:controllers
Usage
Create a Notification
class 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
end
Get unread notifications count for a user:
count = Notification.unread_count(current_user)
Write your custom Notification partial view for notify_types:
If you create a notify_type, you need to 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 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 mentioned you in
<%= link_to notification.second_target.title, topic_path(notification.second_target) %>
</div>
<div class="media-content">
<%= notification.target.body %>
</div>
About Notification template N+1 performance
It is recommended that you use second_level_cache for solving N+1 performance issues.
Contributing
Contribution directions go here.
Site Used
License
The gem is available as open source under the terms of the MIT License.