Disable/hide things for closed discussion state

Summary: The hidden state is handled pretty well, but closed needed some attention.

Test Plan:
- Set a documents discussion state to "closed"
- Support buttons, comment likes/flags should all be present, but disabled
- New comment and reply forms should be hidden

Reviewers: sethetter

Reviewed By: sethetter

Maniphest Tasks: T284

Differential Revision: https://phabricator.opengovfoundation.org/D174

Author: doshitan

app/Models/Doc.php

@@ -667,4 +667,9 @@ public function scopeOrderByRelevance($query, $dir = 'DESC')
             ->orderByRaw("(title_relevance + content_relevance) $dir")
             ;
     }
+
+    public function isDiscussionOpen()
+    {
+        return $this->discussion_state === static::DISCUSSION_STATE_OPEN;
+    }
 }

resources/assets/js/annotator-madison.js

@@ -29,6 +29,10 @@ $.extend(Annotator.Plugin.Madison.prototype, new Annotator.Plugin(), {
         _token: window.Laravel.csrfToken
       };
 
+      if (this.annotator.options.discussionClosed) {
+        return;
+      }
+
       if (this.options.userId) {
         $.post('/documents/' + this.options.docId + '/comments/' + annotationId + '/' + action, data)
           .done(function (data) {

resources/assets/js/document.js

@@ -1,6 +1,6 @@
 window.loadAnnotations = function (contentElem, annotationContainerElem, docId, userId, discussionClosed) {
   var ann = $(contentElem).annotator({
-    readOnly: !!userId,
+    readOnly: !!!userId,
     discussionClosed: discussionClosed
   });
   ann.annotator('addPlugin', 'Unsupported');

resources/views/documents/partials/comment-base.blade.php

@@ -19,7 +19,8 @@
             <button class="btn btn-simple like-btn thumbs-up" onclick="$(this).trigger('madison.addAction')"
                 data-action-type="likes" data-annotation-id="{{ $comment->str_id }}"
                 title="{{ trans('messages.document.like') }}"
-                aria-label="{{ trans('messages.document.like') }}">
+                aria-label="{{ trans('messages.document.like') }}"
+                {{ !$comment->rootAnnotatable->isDiscussionOpen() ? 'disabled' : '' }}>
 
                 <i class="fa fa-thumbs-o-up" aria-hidden="true"></i>
                 <span class="action-count">{{ $comment->likes_count }}</span>
@@ -56,13 +57,14 @@
     <button class="btn btn-simple flag pull-right {{ $comment->flags_count ? 'active' : ''}}" onclick="$(this).trigger('madison.addAction')"
         data-action-type="flags" data-annotation-id="{{ $comment->str_id }}"
         title="{{ trans('messages.document.flag') }}"
-        aria-label="{{ trans('messages.document.flag') }}">
+        aria-label="{{ trans('messages.document.flag') }}"
+        {{ !$comment->rootAnnotatable->isDiscussionOpen() ? 'disabled' : '' }}>
 
         <i class="fa fa-flag" aria-hidden="true"></i>
     </button>
 </div>
 
-@if ($comment->annotatable_type === \App\Models\Doc::ANNOTATABLE_TYPE)
+@if ($comment->annotatable_type === \App\Models\Doc::ANNOTATABLE_TYPE && $comment->rootAnnotatable->isDiscussionOpen())
     @if (Auth::user())
         <div class="clearfix"></div>
 

resources/views/documents/partials/support-btns.blade.php

@@ -6,7 +6,9 @@
                     {{ Form::open(['route' => ['documents.support', $document], 'method' => 'put']) }}
                         <input type="hidden" name="support" value="1">
 
-                        <button type="submit" class="support {{ $userSupport === true ? 'active' : '' }}">
+                        <button type="submit" class="btn support {{ $userSupport === true ? 'active' : '' }}"
+                        {{ !$document->isDiscussionOpen() ? 'disabled' : '' }}>
+
                             <i class="fa fa-thumbs-up" aria-hidden="true"></i>
                             {{ trans('messages.document.support') }}
                             <span class="count">{{ $supportCount }}</span>
@@ -17,7 +19,8 @@
                 <div class="oppose-btn" role="group">
                     {{ Form::open(['route' => ['documents.support', $document], 'method' => 'put']) }}
                         <input type="hidden" name="support" value="0">
-                        <button type="submit" class="oppose {{ $userSupport === false ? 'active' : '' }}">
+                        <button type="submit" class="btn oppose {{ $userSupport === false ? 'active' : '' }}"
+                        {{ !$document->isDiscussionOpen() ? 'disabled' : '' }}>
                             <i class="fa fa-thumbs-down" aria-hidden="true"></i>
                             {{ trans('messages.document.oppose') }}
                             <span class="count">{{ $opposeCount }}</span>

resources/views/documents/show.blade.php

@@ -89,7 +89,7 @@
                         @choice('messages.document.comments_with_count', $document->all_comments_count)
                     </div>
 
-                    @if ($document->discussion_state === \App\Models\Doc::DISCUSSION_STATE_OPEN)
+                    @if ($document->isDiscussionOpen())
                         <div class="floating-card">
                             @if (Auth::user())
                                 @include('documents.partials.new-comment-form', ['route' => ['documents.comments.store', $document], 'message' => 'messages.document.add_comment'])

tests/Browser/DocumentPageTest.php

@@ -128,9 +128,32 @@ public function testDiscussionHiddenHidesAllTheThings()
         $this->browse(function ($browser) {
             $browser
                 ->visit($this->page)
-                ->assertDontSee('@supportBtn')
-                ->assertDontSee('@opposeBtn')
-                ->assertDontSee('@annotationGroups')
+                ->assertMissing('@supportBtn')
+                ->assertMissing('@opposeBtn')
+                ->assertMissing('@noteBubble')
+                ->assertMissing('@newCommentForm')
+                ->assertMissing('@likeBtn')
+                ->assertMissing('@flagBtn')
+                ->assertMissing('@commentsDiv')
+                ;
+        });
+    }
+
+    public function testDiscussionClosedDisablesThings()
+    {
+        $this->document->update(['discussion_state' => Document::DISCUSSION_STATE_CLOSED]);
+
+        $this->browse(function ($browser) {
+            $browser
+                ->visit($this->page)
+                ->assertVisible('@supportBtnDisabled')
+                ->assertVisible('@opposeBtnDisabled')
+                ->waitFor('@noteBubble')
+                ->assertVisible('@noteBubble')
+                ->assertMissing('@newCommentForm')
+                ->assertVisible('@likeBtnDisabled')
+                ->assertVisible('@flagBtnDisabled')
+                ->assertSeeComment($this->comment1)
                 ;
         });
     }

tests/Browser/Pages/DocumentPage.php

@@ -37,14 +37,18 @@ public function elements()
             '@sponsorList' => '#doc-header .sponsors',
             '@stats' => '.document-stats',
             '@supportBtn' => '.support-btn button',
+            '@supportBtnDisabled' => '.support-btn button[disabled]',
             '@opposeBtn' => '.oppose-btn button',
+            '@opposeBtnDisabled' => '.oppose-btn button[disabled]',
             '@outline' => '#document-outline',
             '@noteBubble' => '.annotation-group',
             '@notesPane' => '.annotation-list',
             '@commentsDiv' => '#comments.comments',
             '@contentDiv' => '#content #page_content',
             '@likeBtn' => '[data-action-type="likes"]',
+            '@likeBtnDisabled' => '[data-action-type="likes"][disabled]',
             '@flagBtn' => '[data-action-type="flags"]',
+            '@flagBtnDisabled' => '[data-action-type="flags"][disabled]',
             '@newCommentForm' => '.new-comment-form',
             '@addCommentForm' => '.comment-form',
             '@noteReplyForm' => '.add-subcomment-form',