Add notifications for ActiveRecord objects

⚠️ This is still under development

Add in your Gemfile

gem 'acts_as_notificable'

And then run

bundle install

To copy the Notification model to your application and create the migration use

rails generate acts_as_notificable:install

And then migrate with

rake db:migrate

Add acts_as_notificable for the model that you want to add notifications

class User < ActiveRecord::Base
  acts_as_notificable
end

This will add a has_many assocition called notifications

user = User.first
user.notifications.size # => 0

To create a new notification template, add a file like you would do for a controller action, but in the app/views/notifications directory

app/views/notifications/hello.html.erb

<h1>Hello <%= message %></h1>

Create a new notification based on this template using

user = User.first
user.notifications << Notification.create_notification(:hello, message: "World")
user.notifications.first.render # => "<h1>Hello World</h1>"

You can also pass a layout, which will be lookup in app/views/layouts directory

app/views/layouts/notification_layout.html.erb

<div class="notification-actions">
  <%= link_to("Mark as read", ...) %>
  <%= link_to("Remove this message", ...) %>
</div>
<%= yield %>

And then use :layout option to pass the layout name

notification.render(layout: "notification_layout")

1. Fork it
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Add some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create new Pull Request