consul/nairobi
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Extend notifications to be marked as read and unread

Browse Source
This commit is contained in:
rgarcia
2018-02-27 14:47:52 +01:00
parent c4ad9b940c
commit 09c44ee583
22 changed files with 445 additions and 141 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
app/controllers/comments_controller.rb
View File

@@ -86,7 +86,7 @@ class CommentsController < ApplicationController
notifiable = comment.reply? ? comment.parent : comment.commentable
notifiable_author_id = notifiable.try(:author_id)
if notifiable_author_id.present? && notifiable_author_id != comment.author_id
Notification.add(notifiable.author_id, notifiable)
Notification.add(notifiable.author, notifiable)
end
end

22
app/controllers/notifications_controller.rb
View File

@@ -2,29 +2,41 @@ class NotificationsController < ApplicationController
include CustomUrlsHelper
before_action :authenticate_user!
after_action :mark_as_read, only: :show
skip_authorization_check
respond_to :html, :js
def index
@notifications = current_user.notifications.unread.recent.for_render
@notifications = current_user.notifications.unread
end
def show
@notification = current_user.notifications.find(params[:id])
@notification.mark_as_read
redirect_to linkable_resource_path(@notification)
end
def read
@notifications = current_user.notifications.read
end
def mark_all_as_read
current_user.notifications.each { |notification| notification.mark_as_read }
current_user.notifications.unread.each { |notification| notification.mark_as_read }
redirect_to notifications_path
end
private
def mark_as_read
@notification = current_user.notifications.find(params[:id])
@notification.mark_as_read
end
def mark_as_unread
@notification = current_user.notifications.find(params[:id])
@notification.mark_as_unread
end
private
def linkable_resource_path(notification)
case notification.linkable_resource.class.name
when "Budget::Investment"

2
app/controllers/proposal_notifications_controller.rb
View File

@@ -12,7 +12,7 @@ class ProposalNotificationsController < ApplicationController
@proposal = Proposal.find(proposal_notification_params[:proposal_id])
if @notification.save
@proposal.users_to_notify.each do |user|
Notification.add(user.id, @notification)
Notification.add(user, @notification)
end
redirect_to @notification, notice: I18n.t("flash.actions.create.proposal_notification")
else

44
app/models/notification.rb
View File

@@ -3,32 +3,50 @@ class Notification < ActiveRecord::Base
belongs_to :user, counter_cache: true
belongs_to :notifiable, polymorphic: true
scope :unread, -> { all }
scope :recent, -> { order(id: :desc) }
validates :user, presence: true
scope :read, -> { where.not(read_at: nil).recent.for_render }
scope :unread, -> { where(read_at: nil).recent.for_render }
scope :not_emailed, -> { where(emailed_at: nil) }
scope :recent, -> { order(id: :desc) }
scope :for_render, -> { includes(:notifiable) }
delegate :notifiable_title, :notifiable_available?, :check_availability, :linkable_resource,
to: :notifiable, allow_nil: true
delegate :notifiable_title, :notifiable_available?, :check_availability,
:linkable_resource, to: :notifiable, allow_nil: true
def mark_as_read
update(read_at: Time.current)
end
def mark_as_unread
update(read_at: nil)
end
def read?
read_at.present?
end
def unread?
read_at.nil?
end
def timestamp
notifiable.created_at
end
def mark_as_read
destroy
end
def self.add(user_id, notifiable)
notification = Notification.find_by(user_id: user_id, notifiable: notifiable)
def self.add(user, notifiable)
notification = Notification.existent(user, notifiable)
if notification.present?
Notification.increment_counter(:counter, notification.id)
increment_counter(:counter, notification.id)
else
Notification.create!(user_id: user_id, notifiable: notifiable)
create!(user: user, notifiable: notifiable)
end
end
def self.existent(user, notifiable)
unread.where(user: user, notifiable: notifiable).first
end
def notifiable_action
case notifiable_type
when "ProposalNotification"

23
app/views/devise/menu/_login_items.html.erb
View File

@@ -1,22 +1,11 @@
<% if user_signed_in? %>
<li id="notifications">
<%= link_to notifications_path, rel: "nofollow", class: "notifications" do %>
<span class="show-for-sr"><%= t("layouts.header.notifications") %></span>
<% if current_user.notifications_count > 0 %>
<span class="icon-circle" aria-hidden="true"></span>
<span class="icon-notification" aria-hidden="true" title="<%= t('layouts.header.new_notifications', count: current_user.notifications_count).html_safe %>">
</span>
<small class="show-for-small-only">
<%= t('layouts.header.new_notifications', count: current_user.notifications_count).html_safe %>
</small>
<% else %>
<span class="icon-no-notification" aria-hidden="true" title="<%= t('layouts.header.no_notifications') %>"></span>
<small class="show-for-small-only">
<%= t('layouts.header.no_notifications') %>
</small>
<% end %>
<% end %>
<% if current_budget %>
<li>
<%= link_to(t("layouts.header.delegation"),
new_budget_recommendation_path(budget_id: current_budget.slug),
accesskey: "d") %>
</li>
<% end %>
<li>
<%= layout_menu_link_to t("layouts.header.my_activity_link"),
user_path(current_user),

1
app/views/layouts/_header.html.erb
View File

@@ -30,6 +30,7 @@
<div class="top-bar-right">
<ul class="menu" data-responsive-menu="medium-dropdown">
<%= render "shared/admin_login_items" %>
<%= render "layouts/notification_item" %>
<%= render "devise/menu/login_items" %>
</ul>

30
app/views/layouts/_notification_item.html.erb Normal file
View File

@@ -0,0 +1,30 @@
<% if user_signed_in? %>
<li id="notifications">
<%= link_to notifications_path, rel: "nofollow",
class: "notifications" do %>
<span class="show-for-sr">
<%= t("layouts.header.notification_item.notifications") %>
</span>
<% if current_user.notifications.unread.count > 0 %>
<span class="icon-circle" aria-hidden="true"></span>
<span class="icon-notification" aria-hidden="true"
title="<%= t('layouts.header.notification_item.new_notifications',
count: current_user.notifications_count).html_safe %>">
</span>
<small class="show-for-small-only">
<%= t('layouts.header.notification_item.new_notifications',
count: current_user.notifications_count).html_safe %>
</small>
<% else %>
<span class="icon-no-notification" aria-hidden="true"
title="<%= t('layouts.header.notification_item.no_notifications') %>">
</span>
<small class="show-for-small-only">
<%= t('layouts.header.notification_item.no_notifications') %>
</small>
<% end %>
<% end %>
</li>
<% end %>

26
app/views/notifications/_notification.html.erb
View File

@@ -3,19 +3,37 @@
<%= link_to notification do %>
<p>
<em>
<%= t("notifications.index.#{notification.notifiable_action}",
<%= t("notifications.notification.action.#{notification.notifiable_action}",
count: notification.counter) %>
</em>
<strong><%= notification.notifiable_title %></strong>
<strong id="<%= dom_id(notification) %>_title">
<%= notification.notifiable_title %>
</strong>
</p>
<p class="time"><%= l notification.timestamp, format: :datetime %></p>
<p class="time">
<%= l notification.timestamp, format: :datetime %>
</p>
<% end %>
<% else %>
<p>
<strong>
<%= t("notifications.index.notifiable_hidden") %>
<%= t("notifications.notification.notifiable_hidden") %>
</strong>
</p>
<% end %>
<div>
<% if notification.unread? %>
<%= link_to t("notifications.notification.mark_as_read"),
mark_as_read_notification_path(notification),
method: :put,
remote: true %>
<% else %>
<%= link_to t("notifications.notification.mark_as_unread"),
mark_as_unread_notification_path(notification),
method: :put,
remote: true %>
<% end %>
</div>
</li>

7
app/views/notifications/index.html.erb
View File

@@ -3,15 +3,22 @@
<h1 class="float-left"><%= t("notifications.index.title") %></h1>
<h4>
<%= link_to t("notifications.index.unread"), notifications_path %>
<%= link_to t("notifications.index.read"), read_notifications_path %>
</h4>
<% if @notifications.empty? %>
<div data-alert class="callout primary margin-top clear">
<%= t("notifications.index.empty_notifications") %>
</div>
<% else %>
<% if action_name == "index" %>
<div class="float-right margin-top">
<%= link_to t("notifications.index.mark_all_as_read"),
mark_all_as_read_notifications_path, method: :put %>
</div>
<% end %>
<ul class="no-bullet clear notifications-list">
<%= render @notifications %>

1
app/views/notifications/mark_as_read.js.erb Normal file
View File

@@ -0,0 +1 @@
$("#notification_<%= @notification.id %>").hide()

1
app/views/notifications/mark_as_unread.js.erb Normal file
View File

@@ -0,0 +1 @@
$("#notification_<%= @notification.id %>").hide()

1
app/views/notifications/read.html.erb Normal file
View File

@@ -0,0 +1 @@
<%= render template: "notifications/index" %>

4
config/i18n-tasks.yml
View File

@@ -164,9 +164,7 @@ ignore_unused:
- 'proposals.index.section_header.*'
- 'spending_proposals.index.search_form.*'
- '*.index.search_form.*'
- 'notifications.index.comments_on*'
- 'notifications.index.replies_to*'
- 'notifications.index.proposal_notification*'
- 'notifications.notification.action.*'
- 'legislation.processes.index.filter*'
- 'legislation.processes.index.section_header.*'
- 'helpers.page_entries_info.*' # kaminari

25
config/locales/en/general.yml
View File

@@ -234,11 +234,6 @@ en:
help: Help
my_account_link: My account
my_activity_link: My activity
notifications: Notifications
new_notifications:
one: You have a new notification
other: You have %{count} new notifications
no_notifications: "You don't have new notifications"
open: open
open_city_slogan_html: There are cities that are governed directly by their inhabitants, who <b>discuss</b> the topics they are concerned about, <b>propose</b> ideas to improve their lives and <b>decide</b> among themselves which ones will be carried out.
open_city_title: Love the city, and it will become a city you love
@@ -247,6 +242,12 @@ en:
poll_questions: Voting
budgets: Participatory budgeting
spending_proposals: Spending Proposals
notification_item:
new_notifications:
one: You have a new notification
other: You have %{count} new notifications
notifications: Notifications
no_notifications: "You don't have new notifications"
admin:
watch_form_message: 'You have unsaved changes. Do you confirm to leave the page?'
legacy_legislation:
@@ -259,19 +260,25 @@ en:
locale: English
notifications:
index:
empty_notifications: You don't have new notifications.
mark_all_as_read: Mark all as read
read: All notifications
title: Notifications
unread: Unread
notification:
action:
comments_on:
one: Someone commented on
other: There are %{count} new comments on
empty_notifications: You don't have new notifications.
notifiable_hidden: This resource is not available anymore.
mark_all_as_read: Mark all as read
proposal_notification:
one: There is one new notification on
other: There are %{count} new notifications on
replies_to:
one: Someone replied to your comment on
other: There are %{count} new replies to your comment on
title: Notifications
mark_as_read: Mark as read
mark_as_unread: Mark as unread
notifiable_hidden: This resource is not available anymore.
map:
title: "Districts"
proposal_for_district: "Start a proposal for your district"

25
config/locales/es/general.yml
View File

@@ -234,11 +234,6 @@ es:
help: Ayuda
my_account_link: Mi cuenta
my_activity_link: Mi actividad
notifications: Notificaciones
new_notifications:
one: Tienes una nueva notificación
other: Tienes %{count} notificaciones nuevas
no_notifications: "No tienes notificaciones nuevas"
open: abierto
open_city_slogan_html: Existen ciudades gobernadas directamente por sus habitantes, que <strong>debaten</strong> sobre temas que les preocupan, <strong>proponen</strong> ideas para mejorar sus vidas y <strong>deciden</strong> entre todas y todos las que se llevan a cabo.
open_city_title: La ciudad que quieres será la ciudad que quieras
@@ -247,6 +242,12 @@ es:
poll_questions: Votaciones
budgets: Presupuestos participativos
spending_proposals: Propuestas de inversión
notification_item:
new_notifications:
one: Tienes una nueva notificación
other: Tienes %{count} notificaciones nuevas
notifications: Notificaciones
no_notifications: "No tienes notificaciones nuevas"
admin:
watch_form_message: 'Has realizado cambios que no han sido guardados. ¿Seguro que quieres abandonar la página?'
legacy_legislation:
@@ -259,19 +260,25 @@ es:
locale: Español
notifications:
index:
empty_notifications: No tienes notificaciones nuevas.
mark_all_as_read: Marcar todas como leídas
read: Todas
title: Notificaciones
unread: Nuevas
notification:
action:
comments_on:
one: Hay un nuevo comentario en
other: Hay %{count} comentarios nuevos en
empty_notifications: No tienes notificaciones nuevas.
notifiable_hidden: Este elemento ya no está disponible.
mark_all_as_read: Marcar todas como leídas
proposal_notification:
one: Hay una nueva notificación en
other: Hay %{count} nuevas notificaciones en
replies_to:
one: Hay una respuesta nueva a tu comentario en
other: Hay %{count} nuevas respuestas a tu comentario en
title: Notificaciones
mark_as_read: Marcar como leída
mark_as_unread: Marcar como no leída
notifiable_hidden: Este elemento ya no está disponible.
map:
title: "Distritos"
proposal_for_district: "Crea una propuesta para tu distrito"

3
config/routes/notification.rb
View File

@@ -1,5 +1,8 @@
resources :notifications, only: [:index, :show] do
put :mark_as_read, on: :member
put :mark_all_as_read, on: :collection
put :mark_as_unread, on: :member
get :read, on: :collection
end
resources :proposal_notifications, only: [:new, :create, :show]

5
db/migrate/20180222120017_add_read_at_to_notifications.rb Normal file
View File

@@ -0,0 +1,5 @@
class AddReadAtToNotifications < ActiveRecord::Migration
def change
add_column :notifications, :read_at, :timestamp
end
end

2
db/schema.rb
View File

@@ -12,7 +12,6 @@
# It's strongly recommended that you check this file into your version control system.
ActiveRecord::Schema.define(version: 20180320104823) do
# These are extensions that must be enabled in order to support this database
enable_extension "plpgsql"
enable_extension "unaccent"
@@ -640,6 +639,7 @@ ActiveRecord::Schema.define(version: 20180320104823) do
t.string "notifiable_type"
t.integer "counter", default: 1
t.datetime "emailed_at"
t.datetime "read_at"
end
add_index "notifications", ["user_id"], name: "index_notifications_on_user_id", using: :btree

4
spec/factories.rb
View File

@@ -705,6 +705,10 @@ FactoryBot.define do
factory :notification do
user
association :notifiable, factory: :proposal
trait :read do
read_at Time.current
end
end
factory :geozone do

120
spec/features/notifications_spec.rb
View File

@@ -4,42 +4,128 @@ feature "Notifications" do
let(:user) { create :user }
context "mark as read" do
background do
login_as(user)
visit root_path
end
scenario "mark a single notification as read" do
notification = create :notification, user: user
scenario "View all" do
read1 = create(:notification, :read, user: user)
read2 = create(:notification, :read, user: user)
unread = create(:notification, user: user)
login_as user
visit notifications_path
click_notifications_icon
click_link "All notifications"
expect(page).to have_css ".notification", count: 1
expect(page).to have_css(".notification", count: 2)
expect(page).to have_content(read1.notifiable_title)
expect(page).to have_content(read2.notifiable_title)
expect(page).to_not have_content(unread.notifiable_title)
end
scenario "View unread" do
unread1 = create(:notification, user: user)
unread2 = create(:notification, user: user)
read = create(:notification, :read, user: user)
click_notifications_icon
click_link "Unread"
expect(page).to have_css(".notification", count: 2)
expect(page).to have_content(unread1.notifiable_title)
expect(page).to have_content(unread2.notifiable_title)
expect(page).to_not have_content(read.notifiable_title)
end
scenario "View single notification" do
proposal = create(:proposal)
notification = create(:notification, user: user, notifiable: proposal)
click_notifications_icon
first(".notification a").click
visit notifications_path
expect(page).to have_current_path(proposal_path(proposal))
visit notifications_path
expect(page).to have_css ".notification", count: 0
visit read_notifications_path
expect(page).to have_css ".notification", count: 1
end
scenario "mark all notifications as read" do
2.times { create :notification, user: user }
scenario "Mark as read", :js do
notification1 = create(:notification, user: user)
notification2 = create(:notification, user: user)
login_as user
visit notifications_path
click_notifications_icon
expect(page).to have_css ".notification", count: 2
within("#notification_#{notification1.id}") do
click_link "Mark as read"
end
expect(page).to have_css(".notification", count: 1)
expect(page).to have_content(notification2.notifiable_title)
expect(page).to_not have_content(notification1.notifiable_title)
end
scenario "Mark all as read" do
notification1 = create(:notification, user: user)
notification2 = create(:notification, user: user)
click_notifications_icon
expect(page).to have_css(".notification", count: 2)
click_link "Mark all as read"
expect(page).to have_css ".notification", count: 0
expect(page).to have_current_path(notifications_path)
expect(page).to have_css(".notification", count: 0)
end
scenario "Mark as unread", :js do
notification1 = create(:notification, :read, user: user)
notification2 = create(:notification, user: user)
click_notifications_icon
click_link "All notifications"
expect(page).to have_css(".notification", count: 1)
within("#notification_#{notification1.id}") do
click_link "Mark as unread"
end
scenario "no notifications" do
login_as user
expect(page).to have_css(".notification", count: 0)
visit notifications_path
expect(page).to have_css(".notification", count: 2)
expect(page).to have_content(notification1.notifiable_title)
expect(page).to have_content(notification2.notifiable_title)
end
expect(page).to have_content "You don't have new notifications"
scenario "Bell" do
create(:notification, user: user)
visit root_path
within("#notifications") do
expect(page).to have_css(".icon-circle")
end
click_notifications_icon
first(".notification a").click
within("#notifications") do
expect(page).to_not have_css(".icon-circle")
end
end
scenario "No notifications" do
click_notifications_icon
expect(page).to have_content "You don't have new notifications."
end
scenario "User not logged in" do
logout
visit root_path
expect(page).to_not have_css("#notifications")
end
end

137
spec/models/notification_spec.rb
View File

@@ -2,14 +2,48 @@ require 'rails_helper'
describe Notification do
describe "#unread (scope)" do
it "returns only unread notifications" do
2.times { create :notification }
expect(described_class.unread.size).to be 2
let(:notification) { build(:notification) }
context "validations" do
it "should be valid" do
expect(notification).to be_valid
end
it "should not be valid without a user" do
notification.user = nil
expect(notification).to_not be_valid
end
end
context "scopes" do
describe "#read" do
it "returns only read notifications" do
read_notification1 = create(:notification, :read)
read_notification2 = create(:notification, :read)
unread_notification = create(:notification)
expect(described_class.read).to include read_notification1
expect(described_class.read).to include read_notification2
expect(described_class.read).not_to include unread_notification
end
end
describe "#recent (scope)" do
describe "#unread" do
it "returns only unread notifications" do
read_notification = create(:notification, :read)
unread_notification1 = create(:notification)
unread_notification2 = create(:notification)
expect(described_class.unread).to include unread_notification1
expect(described_class.unread).to include unread_notification2
expect(described_class.unread).not_to include read_notification
end
end
describe "#recent" do
it "returns notifications sorted by id descendant" do
old_notification = create :notification
new_notification = create :notification
@@ -21,13 +55,39 @@ describe Notification do
end
end
describe "#for_render (scope)" do
describe "#for_render" do
it "returns notifications including notifiable and user" do
allow(described_class).to receive(:includes).with(:notifiable).exactly(:once)
described_class.for_render
end
end
end
describe "#mark_as_read" do
it "destroys notification" do
notification = create(:notification)
expect(described_class.read.size).to eq 0
expect(described_class.unread.size).to eq 1
notification.mark_as_read
expect(described_class.read.size).to eq 1
expect(described_class.unread.size).to eq 0
end
end
describe "#mark_as_unread" do
it "destroys notification" do
notification = create(:notification, :read)
expect(described_class.unread.size).to eq 0
expect(described_class.read.size).to eq 1
notification.mark_as_unread
expect(described_class.unread.size).to eq 1
expect(described_class.read.size).to eq 0
end
end
describe "#timestamp" do
it "returns the timestamp of the trackable object" do
comment = create :comment
@@ -37,13 +97,66 @@ describe Notification do
end
end
describe "#mark_as_read" do
it "destroys notification" do
notification = create :notification
expect(described_class.unread.size).to eq 1
describe "#existent" do
it "returns the notifiable when there is an existent notification of that notifiable" do
user = create(:user)
comment = create(:comment)
notification = create(:notification, user: user, notifiable: comment)
notification.mark_as_read
expect(described_class.unread.size).to eq 0
expect(described_class.existent(user, comment)).to eq(notification)
end
it "returns nil when there are no notifications of that notifiable for a user" do
user = create(:user)
comment1 = create(:comment)
comment2 = create(:comment)
create(:notification, user: user, notifiable: comment1)
expect(described_class.existent(user, comment2)).to eq(nil)
end
it "returns nil when there are notifications of a notifiable for another user" do
user1 = create(:user)
user2 = create(:user)
comment = create(:comment)
notification = create(:notification, user: user1, notifiable: comment)
expect(described_class.existent(user2, comment)).to eq(nil)
end
end
describe "#add" do
it "creates a new notification" do
user = create(:user)
comment = create(:comment)
described_class.add(user, comment)
expect(user.notifications.count).to eq(1)
end
it "increments the notification counter for an unread notification of the same notifiable" do
user = create(:user)
comment = create(:comment)
described_class.add(user, comment)
described_class.add(user, comment)
expect(user.notifications.count).to eq(1)
expect(user.notifications.first.counter).to eq(2)
end
it "creates a new notification for a read notification of the same notifiable" do
user = create(:user)
comment = create(:comment)
first_notification = described_class.add(user, comment)
first_notification.update(read_at: Time.current)
second_notification = described_class.add(user, comment)
expect(user.notifications.count).to eq(2)
expect(first_notification.counter).to eq(1)
expect(second_notification.counter).to eq(1)
end
end

3
spec/support/common_actions.rb
View File

@@ -353,4 +353,7 @@ module CommonActions
fill_in "newsletter_body", with: (options[:body] || "This is a different body")
end
def click_notifications_icon
find("#notifications a").click
end
end