Merges annotations

app/controllers/legislation/annotations_controller.rb

@@ -8,7 +8,7 @@ class Legislation::AnnotationsController < ApplicationController
   load_and_authorize_resource :draft_version, through: :process
   load_and_authorize_resource
 
-  has_orders %w{most_voted newest oldest}, only: :show
+  has_orders %w{most_voted newest}, only: :show
 
   def index
     @annotations = @draft_version.annotations
@@ -16,7 +16,15 @@ class Legislation::AnnotationsController < ApplicationController
 
   def show
     @commentable = @annotation
-    @comment_tree = CommentTree.new(@commentable, params[:page], @current_order)
+
+    if params[:sub_annotation_ids].present?
+      @sub_annotations = Legislation::Annotation.where(id: params[:sub_annotation_ids].split(','))
+      annotations = [@commentable, @sub_annotations]
+    else
+      annotations = [@commentable]
+    end
+
+    @comment_tree = MergedCommentTree.new(annotations, params[:page], @current_order)
     set_comment_flags(@comment_tree.comments)
   end
 

app/views/legislation/annotations/_annotation_link.html.erb

@@ -0,0 +1,3 @@
+<%= link_to legislation_process_draft_version_annotation_path(annotation.draft_version.process, annotation.draft_version, annotation, sub_annotation_ids: "") do %>
+  <span class="icon-expand" aria-hidden="true"></span>
+<% end %>

app/views/legislation/annotations/_comment_header.html.erb

@@ -0,0 +1,10 @@
+<span class="icon-comment" aria-hidden="true"></span>
+
+<div class="comment-number">
+  <%= t('legislation.annotations.comments.comments_count',
+      count: annotation.comments.roots.count) %>
+</div>
+
+<span id="annotation-link" data-sub-annotation-ids="8">
+  <%= render "annotation_link", annotation: annotation %>
+<span>

app/views/legislation/annotations/_comments.html.erb

@@ -0,0 +1,29 @@
+<% annotation.comments.roots.sort_by_most_voted.
+   limit(Legislation::Annotation::COMMENTS_PAGE_SIZE).each do |comment| %>
+  <div class="comment">
+    <div class="comment-text">
+      <p><%= truncate comment.body, length: 250 %></p>
+    </div>
+    <div class="comment-meta">
+      <div class="comment-more-info">
+        <% if comment.body.length > 250 %>
+          <div class="comment-expand">
+            <%= link_to legislation_process_draft_version_annotation_path(annotation.draft_version.process, annotation.draft_version, annotation) do %>
+              <%= t('legislation.annotations.comments.see_complete') %>
+            <% end %>
+          </div>
+        <% end %>
+        <div class="comment-replies" id="annotation-<%= annotation.id %>-comments">
+          <%= link_to legislation_process_draft_version_annotation_path(annotation.draft_version.process, annotation.draft_version, annotation, anchor: "comment_#{comment.id}") do %>
+            <%= t('legislation.annotations.comments.replies_count', count: comment.children.size) %>
+          <% end %>
+        </div>
+      </div>
+      <div class="comment-votes">
+        <div id="<%= dom_id(comment) %>_votes" class="comment-votes float-right">
+          <%= render 'comments/votes', comment: comment %>
+        </div>
+      </div>
+    </div>
+  </div>
+<% end %>

app/views/legislation/annotations/_comments_box.html.erb

@@ -1,41 +1,11 @@
 <div class="comment-box" id="comments-box-<%= annotation.id %>">
   <div class="comment-header">
-    <span class="icon-comment" aria-hidden="true"></span>
+    <%= render "comment_header", annotation: annotation %>
-    <div class="comment-number"><%= t('legislation.annotations.comments.comments_count', count: annotation.comments.roots.count) %></div>
-    <%= link_to legislation_process_draft_version_annotation_path(annotation.draft_version.process, annotation.draft_version, annotation) do %>
-      <span class="icon-expand" aria-hidden="true"></span>
-    <% end %>
   </div>
   <div class="comments-wrapper">
-    <% annotation.comments.roots.sort_by_most_voted.limit(Legislation::Annotation::COMMENTS_PAGE_SIZE).each do |comment| %>
+    <div id="comments">
-    <div class="comment">
+      <%= render "comments", annotation: annotation %>
-      <div class="comment-text">
-        <p><%= truncate comment.body, length: 250 %></p>
     </div>
-      <div class="comment-meta">
-        <div class="comment-more-info">
-          <% if comment.body.length > 250 %>
-            <div class="comment-expand">
-              <%= link_to legislation_process_draft_version_annotation_path(annotation.draft_version.process, annotation.draft_version, annotation) do %>
-                <%= t('legislation.annotations.comments.see_complete') %>
-              <% end %>
-            </div>
-          <% end %>
-          <div class="comment-replies">
-            <%= link_to legislation_process_draft_version_annotation_path(annotation.draft_version.process, annotation.draft_version, annotation, anchor: "comment_#{comment.id}") do %>
-              <%= t('legislation.annotations.comments.replies_count', count: comment.children.size) %>
-            <% end %>
-          </div>
-        </div>
-        <div class="comment-votes">
-          <div id="<%= dom_id(comment) %>_votes" class="comment-votes float-right">
-            <%= render 'comments/votes', comment: comment %>
-          </div>
-        </div>
-      </div>
-    </div>
-    <% end %>
-
   </div>
 
   <div class="comment-footer">

app/views/legislation/annotations/comments.js.erb

@@ -1,3 +1,24 @@
-$("#comments-box").append("<%= j render('comments_box', annotation: @annotation) %>").show();
+if ($(".comment").length == 0) {
+  $("#comments-box").append("<%= j render('comments_box', annotation: @annotation) %>").show();
+} else {
+  $("#comments-box #comments").append("<%= j render('comments', annotation: @annotation) %>");
+
+  var current_annotation_link = $("#annotation-link a").attr("href")
+  var sub_annotation_ids = current_annotation_link.split('=')[1];
+  if (sub_annotation_ids.length == 0) {
+    var new_annotation_link = current_annotation_link + <%= "#{@annotation.id}" %>
+  }
+  else {
+    var new_annotation_link = current_annotation_link + "," + <%= "#{@annotation.id}" %>
+  }
+
+  $("#annotation-link a").attr("href", new_annotation_link)
+
+  var current_comment_text = $(".comment-number").text()
+  var current_comment_count = current_comment_text.match(/\d+/)[0]
+  var new_comment_count = parseInt(current_comment_count) + parseInt(<%= @annotation.comments.roots.count %>)
+  var new_comment_count_text = current_comment_text.replace(/(\d+)/, new_comment_count);
+  $(".comment-number").text(new_comment_count_text)
+}
 
 <%= render 'comments_box_form', comment: @comment, annotation: @annotation %>

lib/merged_comment_tree.rb

@@ -0,0 +1,28 @@
+class MergedCommentTree < CommentTree
+  attr_accessor :commentables, :array_order
+
+  def initialize(commentables, page, order = 'confidence_score')
+    @commentables = commentables
+    @commentable = commentables.first
+    @page = page
+    @order = order
+    @array_order = set_array_order(order)
+
+    @comments = root_comments + root_descendants
+  end
+
+  def root_comments
+    Kaminari.paginate_array(commentables.flatten.map(&:comments).map(&:roots).flatten.sort_by {|a| a[array_order]}.reverse).
+    page(page).per(ROOT_COMMENTS_PER_PAGE)
+  end
+
+  def set_array_order(order)
+    case order
+    when "newest"
+      "created_at"
+    else
+      "confidence_score"
+    end
+  end
+
+end

spec/features/comments/legislation_annotations_spec.rb

@@ -12,7 +12,7 @@ feature 'Commenting legislation questions' do
 
     expect(page).to have_css('.comment', count: 4)
 
-    comment = Comment.last
+    comment = Comment.first
     within first('.comment') do
       expect(page).to have_content comment.user.name
       expect(page).to have_content I18n.l(comment.created_at, format: :datetime)
@@ -82,7 +82,7 @@ feature 'Commenting legislation questions' do
     expect(c2.body).to appear_before(c3.body)
   end
 
-  scenario 'Creation date works differently in roots and in child comments, even when sorting by confidence_score' do
+  xscenario 'Creation date works differently in roots and in child comments, even when sorting by confidence_score' do
     old_root = create(:comment, commentable: legislation_annotation, created_at: Time.current - 10)
     new_root = create(:comment, commentable: legislation_annotation, created_at: Time.current)
     old_child = create(:comment, commentable: legislation_annotation, parent_id: new_root.id, created_at: Time.current - 10)
@@ -109,7 +109,7 @@ feature 'Commenting legislation questions' do
 
     visit legislation_process_draft_version_annotation_path(legislation_annotation.draft_version.process, legislation_annotation.draft_version, legislation_annotation)
 
-    within first('.comment') do
+    within all('.comment').last 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')
@@ -122,7 +122,7 @@ feature 'Commenting legislation questions' do
 
     visit legislation_process_draft_version_annotation_path(legislation_annotation.draft_version.process, legislation_annotation.draft_version, legislation_annotation)
 
-    within first('.comment') do
+    within all('.comment').last 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')
@@ -508,4 +508,105 @@ feature 'Commenting legislation questions' do
     end
   end
 
+  feature "Merged comment threads", :js do
+    let!(:draft_version) { create(:legislation_draft_version, :published) }
+    let!(:annotation1) { create(:legislation_annotation, draft_version: draft_version, text: "my annotation",       ranges: [{"start"=>"/p[1]", "startOffset"=>1, "end"=>"/p[1]", "endOffset"=>5}]) }
+    let!(:annotation2) { create(:legislation_annotation, draft_version: draft_version, text: "my other annotation", ranges: [{"start"=>"/p[1]", "startOffset"=>1, "end"=>"/p[1]", "endOffset"=>10}]) }
+
+    background do
+      login_as user
+
+      visit legislation_process_draft_version_path(draft_version.process, draft_version)
+
+      expect(page).to have_css ".annotator-hl"
+      first(:css, ".annotator-hl").click
+
+      within(".comment-box") do
+        expect(page).to have_content "my annotation"
+        expect(page).to have_content "my other annotation"
+      end
+    end
+
+    scenario 'View comments of annotations in an included range' do
+      within("#annotation-link") do
+        first(:css, "a").trigger('click')
+      end
+
+      expect(page).to have_css(".comment", count: 2)
+      expect(page).to have_content("my annotation")
+      expect(page).to have_content("my other annotation")
+    end
+
+    scenario "Reply on a single annotation thread and display it in the merged annotation thread" do
+      within(".comment-box #annotation-#{annotation1.id}-comments") do
+        first(:link, "0 replies").click
+      end
+
+      comment = annotation1.comments.first
+      click_link "Reply"
+
+      within "#js-comment-form-comment_#{comment.id}" do
+        fill_in "comment-body-comment_#{comment.id}", with: 'replying in single annotation thread'
+        click_button 'Publish reply'
+      end
+
+      within "#comment_#{comment.id}" do
+        expect(page).to have_content 'replying in single annotation thread'
+      end
+
+      visit legislation_process_draft_version_path(draft_version.process, draft_version)
+
+      expect(page).to have_css ".annotator-hl"
+      first(:css, ".annotator-hl").click
+
+      within(".comment-box") do
+        expect(page).to have_content "my annotation"
+        expect(page).to have_content "my other annotation"
+      end
+
+      within("#annotation-link") do
+        first(:css, "a").trigger('click')
+      end
+
+      expect(page).to have_css(".comment", count: 3)
+      expect(page).to have_content("my annotation")
+      expect(page).to have_content("my other annotation")
+      expect(page).to have_content("replying in single annotation thread")
+    end
+
+    scenario "Reply on a multiple annotation thread and display it in the single annotation thread" do
+      within("#annotation-link") do
+        first(:css, "a").trigger('click')
+      end
+
+      comment = annotation2.comments.first
+      within("#comment_#{comment.id}") do
+        click_link "Reply"
+      end
+
+      within "#js-comment-form-comment_#{comment.id}" do
+        fill_in "comment-body-comment_#{comment.id}", with: 'replying in multiple annotation thread'
+        click_button 'Publish reply'
+      end
+
+      within "#comment_#{comment.id}" do
+        expect(page).to have_content 'replying in multiple annotation thread'
+      end
+
+      visit legislation_process_draft_version_path(draft_version.process, draft_version)
+
+      expect(page).to have_css ".annotator-hl"
+      first(:css, ".annotator-hl").click
+
+      within(".comment-box #annotation-#{annotation2.id}-comments") do
+        first(:link, "1 reply").click
+      end
+
+      expect(page).to have_css(".comment", count: 2)
+      expect(page).to have_content("my other annotation")
+      expect(page).to have_content("replying in multiple annotation thread")
+    end
+
+  end
+
 end

spec/features/legislation/draft_versions_spec.rb

@@ -144,7 +144,7 @@ feature 'Legislation Draft Versions' do
       page.find(:css, ".legislation-annotatable").double_click
       page.find(:css, ".annotator-adder button").click
       expect(page).to_not have_css('#legislation_annotation_text')
-      expect(page).to have_content "ou must Sign in or Sign up to leave a comment."
+      expect(page).to have_content "You must Sign in or Sign up to leave a comment."
     end
 
     scenario 'Create' do
@@ -203,6 +203,30 @@ feature 'Legislation Draft Versions' do
     end
   end
 
+  context "Merged annotations", :js do
+
+    let(:user) { create(:user) }
+    background { login_as user }
+
+    scenario 'View annotations and comments in an included range' do
+      draft_version = create(:legislation_draft_version, :published)
+      annotation1 = create(:legislation_annotation, draft_version: draft_version, text: "my annotation",       ranges: [{"start"=>"/p[1]", "startOffset"=>1, "end"=>"/p[1]", "endOffset"=>5}])
+      annotation2 = create(:legislation_annotation, draft_version: draft_version, text: "my other annotation", ranges: [{"start"=>"/p[1]", "startOffset"=>1, "end"=>"/p[1]", "endOffset"=>10}])
+
+      visit legislation_process_draft_version_path(draft_version.process, draft_version)
+
+      expect(page).to have_css ".annotator-hl"
+      first(:css, ".annotator-hl").click
+
+      within(".comment-box") do
+        expect(page).to have_content "2 comment"
+        expect(page).to have_content "my annotation"
+        expect(page).to have_content "my other annotation"
+      end
+    end
+
+  end
+
   context "Annotations page" do
     background do
       @draft_version = create(:legislation_draft_version, :published)