Merge pull request #1961 from wairbut-m2c/mlucena-poll-comments

Poll comments

app/controllers/polls_controller.rb

@@ -1,10 +1,10 @@
 class PollsController < ApplicationController
-
   include PollsHelper
 
   load_and_authorize_resource
 
   has_filters %w{current expired incoming}
+  has_orders %w{most_voted newest oldest}, only: :show
 
   ::Poll::Answer # trigger autoload
 
@@ -15,11 +15,15 @@ class PollsController < ApplicationController
   def show
     @questions = @poll.questions.for_render.sort_for_list
     @token = poll_voter_token(@poll, current_user)
+
     @answers_by_question_id = {}
     poll_answers = ::Poll::Answer.by_question(@poll.question_ids).by_author(current_user.try(:id))
     poll_answers.each do |answer|
       @answers_by_question_id[answer.question_id] = answer.answer
     end
+
+    @commentable = @poll
+    @comment_tree = CommentTree.new(@commentable, params[:page], @current_order)
   end
 
 end

app/helpers/flags_helper.rb

@@ -12,7 +12,7 @@ module FlagsHelper
 
   def flagged?(flaggable)
     if flaggable.is_a? Comment
-      @comment_flags[flaggable.id]
+      @comment_flags[flaggable.id] unless flaggable.commentable_type == "Poll"
     else
       Flag.flagged?(current_user, flaggable)
     end

app/models/comment.rb

@@ -3,7 +3,7 @@ class Comment < ActiveRecord::Base
   include HasPublicAuthor
   include Graphqlable
 
-  COMMENTABLE_TYPES = %w(Debate Proposal Budget::Investment Poll::Question Legislation::Question Legislation::Annotation Topic).freeze
+  COMMENTABLE_TYPES = %w(Debate Proposal Budget::Investment Poll::Question Legislation::Question Legislation::Annotation Topic Poll).freeze
 
   acts_as_paranoid column: :hidden_at
   include ActsAsParanoidAliases

app/models/comment_notifier.rb

@@ -22,6 +22,7 @@ class CommentNotifier
   end
 
   def email_on_comment?
+    return false if @comment.commentable.is_a?(Poll)
     commentable_author = @comment.commentable.author
     commentable_author != @author && commentable_author.email_on_comment?
   end

app/models/poll.rb

@@ -1,6 +1,7 @@
 class Poll < ActiveRecord::Base
   include Imageable
-
+  acts_as_paranoid column: :hidden_at
+  include ActsAsParanoidAliases
   has_many :booth_assignments, class_name: "Poll::BoothAssignment"
   has_many :booths, through: :booth_assignments
   has_many :partial_results, through: :booth_assignments
@@ -9,8 +10,10 @@ class Poll < ActiveRecord::Base
   has_many :officer_assignments, through: :booth_assignments
   has_many :officers, through: :officer_assignments
   has_many :questions
+  has_many :comments, as: :commentable
 
   has_and_belongs_to_many :geozones
+  belongs_to :author, -> { with_hidden }, class_name: 'User', foreign_key: 'author_id'
 
   validates :name, presence: true
 

app/views/comments/show.html.erb

@@ -1,7 +1,7 @@
 <div class="row">
   <div class="small-12 column margin-top">
     <%= back_link_to commentable_path(@comment),
-                     t("comments.show.return_to_commentable") + @comment.commentable.title %>
+                     t("comments.show.return_to_commentable") + @comment.commentable.title unless @commentable.class == Poll %>
   </div>
 </div>
 

app/views/polls/_comments.html.erb

@@ -0,0 +1,24 @@
+<% cache [locale_and_user_status, @current_order, commentable_cache_key(@poll), @comment_tree.comments, @comment_tree.comment_authors, @poll.comments_count, @comment_flags] do %>
+  <div class="row comments">
+    <div id="comments" class="small-12 column">
+      <%= render 'shared/wide_order_selector', i18n_namespace: "comments" %>
+
+      <% if user_signed_in? %>
+        <%= render 'comments/form', {commentable: @poll, parent_id: nil, toggeable: false} %>
+      <% else %>
+      <br>
+
+      <div data-alert class="callout primary">
+        <%= t("polls.show.login_to_comment",
+            signin: link_to(t("votes.signin"), new_user_session_path),
+            signup: link_to(t("votes.signup"), new_user_registration_path)).html_safe %>
+        </div>
+      <% end %>
+
+      <% @comment_tree.root_comments.each do |comment| %>
+        <%= render 'comments/comment', comment: comment  %>
+      <% end %>
+      <%= paginate @comment_tree.root_comments %>
+    </div>
+  </div>
+<% end %>

app/views/polls/_filter_subnav.html.erb

@@ -0,0 +1,14 @@
+<div class="row">
+  <div class="small-12 column">
+    <ul class="tabs" data-tabs id="polls-tabs">
+      <li class="tabs-title is-active">
+        <%= link_to "#tab-comments" do %>
+          <h3>
+            <%= t("polls.show.comments_tab") %>
+            <span class="js-comments-count">(<%= @poll.comments_count %>)</span>
+          </h3>
+        <% end %>
+      </li>
+    </ul>
+  </div>
+</div>

app/views/polls/show.html.erb

@@ -128,5 +128,14 @@
         </div>
       <% end %>
     </div>
+    
   </div>
 </div>
+
+<div class="tabs-content" data-tabs-content="proposals-tabs" role="tablist">
+  <%= render "filter_subnav" %>
+
+  <div class="tabs-panel is-active" id="tab-comments">
+    <%= render "comments" %>
+  </div>
+</div>

config/locales/en/general.yml

@@ -482,6 +482,8 @@ en:
       already_voted_in_web: "You have already participated in this poll. If you vote again it will be overwritten."
       back: Back to voting
       cant_answer_not_logged_in: "You must %{signin} or %{signup} to participate."
+      comments_tab: Comments
+      login_to_comment: You must %{signin} or %{signup} to leave a comment.
       signin: Sign in
       signup: Sign up
       cant_answer_verify_html: "You must %{verify_link} in order to answer."

config/locales/es/general.yml

@@ -482,6 +482,8 @@ es:
       already_voted_in_web: "Ya has participado en esta votación. Si vuelves a votar se sobreescribirá tu resultado anterior."
       back: Volver a votaciones
       cant_answer_not_logged_in: "Necesitas %{signin} o %{signup} para participar."
+      comments_tab: Comentarios
+      login_to_comment: Necesitas %{signin} o %{signup} para comentar.
       signin: iniciar sesión
       signup: registrarte
       cant_answer_verify_html: "Por favor %{verify_link} para poder responder."

db/migrate/20171003143034_add_comments_count_to_polls.rb

@@ -0,0 +1,7 @@
+class AddCommentsCountToPolls < ActiveRecord::Migration
+  def change
+    add_column :polls, :comments_count, :integer, default: 0
+    add_column :polls, :author_id, :integer
+    add_column :polls, :hidden_at, :datetime
+  end
+end

db/schema.rb

@@ -801,6 +801,9 @@ ActiveRecord::Schema.define(version: 20171006145053) do
     t.boolean  "geozone_restricted", default: false
     t.text     "summary"
     t.text     "description"
+    t.integer  "comments_count",     default: 0
+    t.integer  "author_id"
+    t.datetime "hidden_at"
   end
 
   add_index "polls", ["starts_at", "ends_at"], name: "index_polls_on_starts_at_and_ends_at", using: :btree

spec/features/comments/polls_spec.rb

@@ -0,0 +1,522 @@
+require 'rails_helper'
+include ActionView::Helpers::DateHelper
+
+feature 'Commenting polls' do
+  let(:user) { create :user }
+  let(:poll) { create :poll }
+
+  scenario 'Index' do
+    3.times { create(:comment, commentable: poll) }
+
+    visit poll_path(poll)
+
+    expect(page).to have_css('.comment', count: 3)
+
+    comment = Comment.last
+    within first('.comment') do
+      expect(page).to have_content comment.user.name
+      expect(page).to have_content I18n.l(comment.created_at, format: :datetime)
+      expect(page).to have_content comment.body
+    end
+  end
+
+  scenario 'Show' do
+  	skip "Feature not implemented yet, review soon"
+
+    parent_comment = create(:comment, commentable: poll)
+    first_child    = create(:comment, commentable: poll, parent: parent_comment)
+    second_child   = create(:comment, commentable: poll, parent: parent_comment)
+
+    visit comment_path(parent_comment)
+
+    expect(page).to have_css(".comment", count: 3)
+    expect(page).to have_content parent_comment.body
+    expect(page).to have_content first_child.body
+    expect(page).to have_content second_child.body
+    expect(page).to have_link "Go back to #{poll.name}", href: poll_path(poll)
+
+    expect(page).to have_selector("ul#comment_#{parent_comment.id}>li", count: 2)
+    expect(page).to have_selector("ul#comment_#{first_child.id}>li", count: 1)
+    expect(page).to have_selector("ul#comment_#{second_child.id}>li", count: 1)
+  end
+
+  scenario 'Collapsable comments', :js do
+    parent_comment = create(:comment, body: "Main comment", commentable: poll)
+    child_comment  = create(:comment, body: "First subcomment", commentable: poll, parent: parent_comment)
+    grandchild_comment = create(:comment, body: "Last subcomment", commentable: poll, parent: child_comment)
+
+    visit poll_path(poll)
+
+    expect(page).to have_css('.comment', count: 3)
+
+    find("#comment_#{child_comment.id}_children_arrow").trigger('click')
+
+    expect(page).to have_css('.comment', count: 2)
+    expect(page).to_not have_content grandchild_comment.body
+
+    find("#comment_#{child_comment.id}_children_arrow").trigger('click')
+
+    expect(page).to have_css('.comment', count: 3)
+    expect(page).to have_content grandchild_comment.body
+
+    find("#comment_#{parent_comment.id}_children_arrow").trigger('click')
+
+    expect(page).to have_css('.comment', count: 1)
+    expect(page).to_not have_content child_comment.body
+    expect(page).to_not have_content grandchild_comment.body
+  end
+
+  scenario 'Comment order' do
+    c1 = create(:comment, :with_confidence_score, commentable: poll, cached_votes_up: 100,
+                                                  cached_votes_total: 120, created_at: Time.current - 2)
+    c2 = create(:comment, :with_confidence_score, commentable: poll, cached_votes_up: 10,
+                                                  cached_votes_total: 12, created_at: Time.current - 1)
+    c3 = create(:comment, :with_confidence_score, commentable: poll, cached_votes_up: 1,
+                                                  cached_votes_total: 2, created_at: Time.current)
+
+    visit poll_path(poll, order: :most_voted)
+
+    expect(c1.body).to appear_before(c2.body)
+    expect(c2.body).to appear_before(c3.body)
+
+    visit poll_path(poll, order: :newest)
+
+    expect(c3.body).to appear_before(c2.body)
+    expect(c2.body).to appear_before(c1.body)
+
+    visit poll_path(poll, order: :oldest)
+
+    expect(c1.body).to appear_before(c2.body)
+    expect(c2.body).to appear_before(c3.body)
+  end
+
+  scenario 'Creation date works differently in roots and in child comments, when sorting by confidence_score' do
+   old_root = create(:comment, commentable: poll, created_at: Time.current - 10)
+   new_root = create(:comment, commentable: poll, created_at: Time.current)
+   old_child = create(:comment, commentable: poll, parent_id: new_root.id, created_at: Time.current - 10)
+   new_child = create(:comment, commentable: poll, parent_id: new_root.id, created_at: Time.current)
+
+   visit poll_path(poll, order: :most_voted)
+
+   expect(new_root.body).to appear_before(old_root.body)
+   expect(old_child.body).to appear_before(new_child.body)
+
+   visit poll_path(poll, order: :newest)
+
+   expect(new_root.body).to appear_before(old_root.body)
+   expect(new_child.body).to appear_before(old_child.body)
+
+   visit poll_path(poll, order: :oldest)
+
+   expect(old_root.body).to appear_before(new_root.body)
+   expect(old_child.body).to appear_before(new_child.body)
+  end
+
+  scenario 'Turns links into html links' do
+    create :comment, commentable: poll, body: 'Built with http://rubyonrails.org/'
+
+    visit poll_path(poll)
+
+    within first('.comment') do
+      expect(page).to have_content 'Built with http://rubyonrails.org/'
+      expect(page).to have_link('http://rubyonrails.org/', href: 'http://rubyonrails.org/')
+      expect(find_link('http://rubyonrails.org/')[:rel]).to eq('nofollow')
+      expect(find_link('http://rubyonrails.org/')[:target]).to eq('_blank')
+    end
+  end
+
+  scenario 'Sanitizes comment body for security' do
+    create :comment, commentable: poll,
+                     body: "<script>alert('hola')</script> <a href=\"javascript:alert('sorpresa!')\">click me<a/> http://www.url.com"
+
+    visit poll_path(poll)
+
+    within first('.comment') do
+      expect(page).to have_content "click me http://www.url.com"
+      expect(page).to have_link('http://www.url.com', href: 'http://www.url.com')
+      expect(page).not_to have_link('click me')
+    end
+  end
+
+  scenario 'Paginated comments' do
+    per_page = 10
+    (per_page + 2).times { create(:comment, commentable: poll)}
+
+    visit poll_path(poll)
+
+    expect(page).to have_css('.comment', count: per_page)
+    within("ul.pagination") do
+      expect(page).to have_content("1")
+      expect(page).to have_content("2")
+      expect(page).to_not have_content("3")
+      click_link "Next", exact: false
+    end
+
+    expect(page).to have_css('.comment', count: 2)
+  end
+
+  feature 'Not logged user' do
+    scenario 'can not see comments forms' do
+      create(:comment, commentable: poll)
+      visit poll_path(poll)
+
+      expect(page).to have_content 'You must Sign in or Sign up to leave a comment'
+      within('#comments') do
+        expect(page).to_not have_content 'Write a comment'
+        expect(page).to_not have_content 'Reply'
+      end
+    end
+  end
+
+  scenario 'Create', :js do
+    login_as(user)
+    visit poll_path(poll)
+
+    fill_in "comment-body-poll_#{poll.id}", with: 'Have you thought about...?'
+    click_button 'Publish comment'
+
+    within "#comments" do
+      expect(page).to have_content 'Have you thought about...?'
+    end
+
+    within "#tab-comments-label" do
+      expect(page).to have_content 'Comments (1)'
+    end
+  end
+
+  scenario 'Errors on create', :js do
+    login_as(user)
+    visit poll_path(poll)
+
+    click_button 'Publish comment'
+
+    expect(page).to have_content "Can't be blank"
+  end
+
+  scenario 'Reply', :js do
+    citizen = create(:user, username: 'Ana')
+    manuela = create(:user, username: 'Manuela')
+    comment = create(:comment, commentable: poll, user: citizen)
+
+    login_as(manuela)
+    visit poll_path(poll)
+
+    click_link "Reply"
+
+    within "#js-comment-form-comment_#{comment.id}" do
+      fill_in "comment-body-comment_#{comment.id}", with: 'It will be done next week.'
+      click_button 'Publish reply'
+    end
+
+    within "#comment_#{comment.id}" do
+      expect(page).to have_content 'It will be done next week.'
+    end
+
+    expect(page).to_not have_selector("#js-comment-form-comment_#{comment.id}", visible: true)
+  end
+
+  scenario 'Errors on reply', :js do
+    comment = create(:comment, commentable: poll, user: user)
+
+    login_as(user)
+    visit poll_path(poll)
+
+    click_link "Reply"
+
+    within "#js-comment-form-comment_#{comment.id}" do
+      click_button 'Publish reply'
+      expect(page).to have_content "Can't be blank"
+    end
+
+  end
+
+  scenario "N replies", :js do
+    parent = create(:comment, commentable: poll)
+
+    7.times do
+      create(:comment, commentable: poll, parent: parent)
+      parent = parent.children.first
+    end
+
+    visit poll_path(poll)
+    expect(page).to have_css(".comment.comment.comment.comment.comment.comment.comment.comment")
+  end
+
+  scenario "Flagging as inappropriate", :js do
+  	skip "Feature not implemented yet, review soon"
+
+    comment = create(:comment, commentable: poll)
+
+    login_as(user)
+    visit poll_path(poll)
+
+    within "#comment_#{comment.id}" do
+      page.find("#flag-expand-comment-#{comment.id}").click
+      page.find("#flag-comment-#{comment.id}").click
+
+      expect(page).to have_css("#unflag-expand-comment-#{comment.id}")
+    end
+
+    expect(Flag.flagged?(user, comment)).to be
+  end
+
+  scenario "Undoing flagging as inappropriate", :js do
+  	skip "Feature not implemented yet, review soon"
+
+    comment = create(:comment, commentable: poll)
+    Flag.flag(user, comment)
+
+    login_as(user)
+    visit poll_path(poll)
+
+    within "#comment_#{comment.id}" do
+      page.find("#unflag-expand-comment-#{comment.id}").click
+      page.find("#unflag-comment-#{comment.id}").click
+
+      expect(page).to have_css("#flag-expand-comment-#{comment.id}")
+    end
+
+    expect(Flag.flagged?(user, comment)).to_not be
+  end
+
+  scenario "Flagging turbolinks sanity check", :js do
+  	skip "Feature not implemented yet, review soon"
+
+    poll = create(:poll, title: "Should we change the world?")
+    comment = create(:comment, commentable: poll)
+
+    login_as(user)
+    visit polls_path
+    click_link "Should we change the world?"
+
+    within "#comment_#{comment.id}" do
+      page.find("#flag-expand-comment-#{comment.id}").click
+      expect(page).to have_selector("#flag-comment-#{comment.id}")
+    end
+  end
+
+  scenario "Erasing a comment's author" do
+    poll = create(:poll)
+    comment = create(:comment, commentable: poll, body: "this should be visible")
+    comment.user.erase
+
+    visit poll_path(poll)
+    within "#comment_#{comment.id}" do
+      expect(page).to have_content('User deleted')
+      expect(page).to have_content('this should be visible')
+    end
+  end
+
+  feature "Moderators" do
+
+    scenario "can create comment as a moderator", :js do
+    	skip "Feature not implemented yet, review soon"
+
+      moderator = create(:moderator)
+
+      login_as(moderator.user)
+      visit poll_path(poll)
+
+      fill_in "comment-body-poll_#{poll.id}", with: "I am moderating!"
+      check "comment-as-moderator-poll_#{poll.id}"
+      click_button "Publish comment"
+
+      within "#comments" do
+        expect(page).to have_content "I am moderating!"
+        expect(page).to have_content "Moderator ##{moderator.id}"
+        expect(page).to have_css "div.is-moderator"
+        expect(page).to have_css "img.moderator-avatar"
+      end
+    end
+
+    scenario "can create reply as a moderator", :js do
+    	skip "Feature not implemented yet, review soon"
+
+      citizen = create(:user, username: "Ana")
+      manuela = create(:user, username: "Manuela")
+      moderator = create(:moderator, user: manuela)
+      comment = create(:comment, commentable: poll, user: citizen)
+
+      login_as(manuela)
+      visit poll_path(poll)
+
+      click_link "Reply"
+
+      within "#js-comment-form-comment_#{comment.id}" do
+        fill_in "comment-body-comment_#{comment.id}", with: "I am moderating!"
+        check "comment-as-moderator-comment_#{comment.id}"
+        click_button 'Publish reply'
+      end
+
+      within "#comment_#{comment.id}" do
+        expect(page).to have_content "I am moderating!"
+        expect(page).to have_content "Moderator ##{moderator.id}"
+        expect(page).to have_css "div.is-moderator"
+        expect(page).to have_css "img.moderator-avatar"
+      end
+
+      expect(page).to_not have_selector("#js-comment-form-comment_#{comment.id}", visible: true)
+    end
+
+    scenario "can not comment as an administrator" do
+    	skip "Feature not implemented yet, review soon"
+
+      moderator = create(:moderator)
+
+      login_as(moderator.user)
+      visit poll_path(poll)
+
+      expect(page).to_not have_content "Comment as administrator"
+    end
+  end
+
+  feature "Administrators" do
+    scenario "can create comment as an administrator", :js do
+    	skip "Feature not implemented yet, review soon"
+
+      admin = create(:administrator)
+
+      login_as(admin.user)
+      visit poll_path(poll)
+
+      fill_in "comment-body-poll_#{poll.id}", with: "I am your Admin!"
+      check "comment-as-administrator-poll_#{poll.id}"
+      click_button "Publish comment"
+
+      within "#comments" do
+        expect(page).to have_content "I am your Admin!"
+        expect(page).to have_content "Administrator ##{admin.id}"
+        expect(page).to have_css "div.is-admin"
+        expect(page).to have_css "img.admin-avatar"
+      end
+    end
+
+    scenario "can create reply as an administrator", :js do
+    	skip "Feature not implemented yet, review soon"
+
+      citizen = create(:user, username: "Ana")
+      manuela = create(:user, username: "Manuela")
+      admin   = create(:administrator, user: manuela)
+      comment = create(:comment, commentable: poll, user: citizen)
+
+      login_as(manuela)
+      visit poll_path(poll)
+
+      click_link "Reply"
+
+      within "#js-comment-form-comment_#{comment.id}" do
+        fill_in "comment-body-comment_#{comment.id}", with: "Top of the world!"
+        check "comment-as-administrator-comment_#{comment.id}"
+        click_button 'Publish reply'
+      end
+
+      within "#comment_#{comment.id}" do
+        expect(page).to have_content "Top of the world!"
+        expect(page).to have_content "Administrator ##{admin.id}"
+        expect(page).to have_css "div.is-admin"
+        expect(page).to have_css "img.admin-avatar"
+      end
+
+      expect(page).to_not have_selector("#js-comment-form-comment_#{comment.id}", visible: true)
+    end
+
+    scenario "can not comment as a moderator" do
+    	skip "Feature not implemented yet, review soon"
+
+      admin = create(:administrator)
+
+      login_as(admin.user)
+      visit poll_path(poll)
+
+      expect(page).to_not have_content "Comment as moderator"
+    end
+  end
+
+  feature 'Voting comments' do
+
+    background do
+      @manuela = create(:user, verified_at: Time.current)
+      @pablo = create(:user)
+      @poll = create(:poll)
+      @comment = create(:comment, commentable: @poll)
+
+      login_as(@manuela)
+    end
+
+    scenario 'Show' do
+      create(:vote, voter: @manuela, votable: @comment, vote_flag: true)
+      create(:vote, voter: @pablo, votable: @comment, vote_flag: false)
+
+      visit poll_path(@poll)
+
+      within("#comment_#{@comment.id}_votes") do
+        within(".in_favor") do
+          expect(page).to have_content "1"
+        end
+
+        within(".against") do
+          expect(page).to have_content "1"
+        end
+
+        expect(page).to have_content "2 votes"
+      end
+    end
+
+    scenario 'Create', :js do
+      visit poll_path(@poll)
+
+      within("#comment_#{@comment.id}_votes") do
+        find(".in_favor a").click
+
+        within(".in_favor") do
+          expect(page).to have_content "1"
+        end
+
+        within(".against") do
+          expect(page).to have_content "0"
+        end
+
+        expect(page).to have_content "1 vote"
+      end
+    end
+
+    scenario 'Update', :js do
+      visit poll_path(@poll)
+
+      within("#comment_#{@comment.id}_votes") do
+        find('.in_favor a').click
+        find('.against a').click
+
+        within('.in_favor') do
+          expect(page).to have_content "0"
+        end
+
+        within('.against') do
+          expect(page).to have_content "1"
+        end
+
+        expect(page).to have_content "1 vote"
+      end
+    end
+
+    scenario 'Trying to vote multiple times', :js do
+      visit poll_path(@poll)
+
+      within("#comment_#{@comment.id}_votes") do
+        find('.in_favor a').click
+        find('.in_favor a').click
+
+        within('.in_favor') do
+          expect(page).to have_content "1"
+        end
+
+        within('.against') do
+          expect(page).to have_content "0"
+        end
+
+        expect(page).to have_content "1 vote"
+      end
+    end
+  end
+
+end