ROAD-546: Add comments to stories (#304)

* Adds comment model and controller

* Adds routes

* Adds view

* Adds empty comment and comments to stories controller

* Adds has_many comment association

* ROAD-547 adjusting edit and delete actions for comments

* cleanup of controller due to test failures

* Adds specs for comments

* ROAD-548 add support to export comments optionally

* [wip] adding controller specs

* Add user to comment

* Adds specs to test that a user cannot edit, delete, or update another user's comments

* Address review's feedback

* Add flash for delete - add redirect projects when not found

* Removes respond_to blocks

* adds comments_headers to avoid appending headers to constant

* ROAD-546 comment_headers

* Fix partial usage with local variables, and fix csv export - add spec with more than one comment

* Adjust partials

* Fixes typo

* fix issue of comments containing comments of previous story

* improve csv export test case

* ROAD-548 adjust csv header comment loop

* Remove unused comment_id

* Undisables the submit button

---------

Co-authored-by: Henrique Medeiros <[email protected]>

app/assets/stylesheets/stories.scss

@@ -126,3 +126,36 @@
   border: 1px solid #9b054d;
   padding: 5px;
 }
+
+.comments-section {
+  margin: 16px 0;
+
+  .comment-card {
+    margin: 8px 0;
+
+    .bold {
+      font-weight: bold;
+    }
+
+    .link-blue {
+      color: blue;
+    }
+  }
+}
+
+.comment-form-container {
+  margin: 8px 0;
+  width: 50%;
+
+  .bold {
+    font-weight: bold;
+  }
+}
+
+#comment_body {
+  margin: 10px 0;
+}
+
+input.button.green {
+  width: auto;
+}

app/controllers/comments_controller.rb

@@ -0,0 +1,59 @@
+class CommentsController < ApplicationController
+  before_action :authenticate_user!
+  before_action :load_story_and_project
+  before_action :find_comment, only: [:edit, :update, :destroy]
+
+  def edit
+  end
+
+  def create
+    @comment = current_user.comments.build(story: @story)
+    @comment.attributes = comment_params
+    saved = @comment.save
+    if saved
+      flash[:success] = "Comment created!"
+    else
+      flash[:error] = @comment.errors.full_messages
+    end
+
+    redirect_to project_story_path(@comment.story.project_id, @comment.story_id)
+  end
+
+  def update
+    updated = @comment.update(comment_params)
+    if updated
+      flash[:success] = "Comment updated!"
+      redirect_to project_story_path(@comment.story.project_id, @comment.story_id)
+    else
+      flash[:error] = @comment.errors.full_messages
+      render :edit
+    end
+  end
+
+  def destroy
+    @comment.destroy
+    flash[:success] = "Comment deleted!"
+    redirect_to project_story_path(@comment.story.project_id, @comment.story_id)
+  end
+
+  private
+
+  def find_comment
+    @comment = current_user.comments.where(story_id: params[:story_id]).find(params[:id])
+  rescue ActiveRecord::RecordNotFound
+    flash[:error] = "Comment not found"
+    redirect_to project_story_path(params[:project_id], params[:story_id])
+  end
+
+  def load_story_and_project
+    @project = Project.find(params[:project_id])
+    @story = Story.find(params[:story_id])
+  rescue ActiveRecord::RecordNotFound
+    flash[:error] = "Project or Story not found"
+    redirect_to projects_path
+  end
+
+  def comment_params
+    params.require(:comment).permit(:body)
+  end
+end

app/controllers/stories_controller.rb

@@ -46,6 +46,8 @@ def bulk_destroy
 
   def show
     @estimate = Estimate.find_by(story: @story, user: current_user)
+    @comments = @story.comments.includes(:user).order(:created_at)
+    @comment = Comment.new
   end
 
   def update
@@ -85,12 +87,25 @@ def import
   end
 
   def export
-    csv = CSV.generate(headers: true) { |csv|
-      csv << CSV_HEADERS
-      @project.stories.by_position.each do |story|
-        csv << story.attributes.slice(*CSV_HEADERS)
+    csv = if params[:export_with_comments] == "1"
+      CSV.generate(headers: true) do |csv|
+        csv << CSV_HEADERS + ["comment"]
+        @project.stories.includes(:comments).by_position.each do |story|
+          comments = []
+          story.comments.each do |comment|
+            comments << "#{comment.user.name}: #{comment.body}"
+          end
+          csv << [story.id, story.title, story.description, story.position] + comments
+        end
       end
-    }
+    else
+      CSV.generate(headers: true) do |csv|
+        csv << CSV_HEADERS
+        @project.stories.by_position.each do |story|
+          csv << story.attributes.slice(*CSV_HEADERS)
+        end
+      end
+    end
     filename = "#{@project.title.gsub(/[^\w]/, "_")}-#{Time.now.to_formatted_s(:short).tr(" ", "_")}.csv"
     send_data csv, filename: filename
   end

app/models/comment.rb

@@ -0,0 +1,5 @@
+class Comment < ApplicationRecord
+  belongs_to :story
+  belongs_to :user
+  validates :body, presence: true
+end

app/models/story.rb

@@ -4,6 +4,7 @@ class Story < ApplicationRecord
   belongs_to :project
   has_many :estimates
   has_many :users, through: :estimates
+  has_many :comments
 
   before_create :add_position
 

app/models/user.rb

@@ -2,4 +2,5 @@ class User < ApplicationRecord
   include OmbuLabsAuthenticable
 
   has_many :estimates
+  has_many :comments
 end

app/views/comments/_comment.html.erb

@@ -0,0 +1,7 @@
+<div class="comment-card">
+  <p class="bold"><%= comment.user.name %>: <%= markdown(comment.body) %> <%= comment.created_at %><p>
+  <% if current_user == comment.user %>
+    <%= link_to "Edit Comment", edit_project_story_comment_path(project, story, comment), class: "link-blue" %> |
+    <%= link_to "Delete", project_story_comment_path(project, story, comment), method: :delete, data: { confirm: "Are you sure?" }, title: "Delete" %>
+  <% end %>
+</div>

app/views/comments/_form.html.erb

@@ -0,0 +1,5 @@
+<%= form_with model: [project, story, comment] do |form| %>
+  <%= form.text_area :body, rows: 6 %>
+  <%= form.submit class: "button green"%>
+  <%= link_to "Back", project_story_path(project, story), id: "back", class: "button" if ["edit", "update"].include?(action_name) %>
+<% end %>

app/views/comments/edit.html.erb

@@ -0,0 +1,4 @@
+<div class="container">
+  <h2 class="new-edit-title">Edit Comment</h2>
+  <%= render partial: "form", locals: {story: @story, comment: @comment, project: @project} %>
+</div>

app/views/projects/_import_export.html.erb

@@ -31,7 +31,14 @@
           <h4 class="my-0 font-weight-normal">Export CSV</h4>
         </div>
         <div class="card-body">
-          <%= link_to 'Export', export_project_stories_path(@project), class: "button green" %>
+          <%= form_with url: export_project_stories_path(@project), method: :get do |f| %>
+            <%= f.submit "Export", class: "button green", data: { disable_with: false } %>
+            <br/>
+            <%= f.label :export_with_comments do %>
+              <%= f.check_box :export_with_comments %>
+              Export with comments
+            <% end %>
+          <% end %>
         </div>
       </div>
     </div>

app/views/stories/show.html.erb

@@ -1,7 +1,7 @@
 <div class="container">
   <h1 class="dashboard-title"><%= render "shared/project_title", project: @project %></h1>
 
-  <%= render "shared/story", story: @story %>
+  <%= render partial: "shared/story", locals: { story: @story } %>
 
   <div class="btn-group">
     <%= link_to 'Back', project_path(@project), id: "back", class: "button" %>
@@ -10,4 +10,16 @@
       <%= link_to "Delete", project_story_path(@project.id, @story), method: :delete, data: { confirm: "Are you sure?", story_id: @story.id }, class: "button red", remote: true , title: "Delete" %>
     <% end %>
   </div>
+
+  <div class="comments-section">
+    <h4>Comments</h4>
+    <% @comments.each do |comment| %>
+      <%= render partial: "comments/comment", locals: { story: @story, project: @project, comment: comment } %>
+    <% end %>
+  </div>
+
+  <div class="comment-form-container">
+    <p class="bold">Add a new comment</p>
+    <%= render partial: "comments/form", locals: { story: @story, project: @project, comment: @comment } %>
+  </div>
 </div>

config/routes.rb

@@ -38,6 +38,7 @@
       get :export, on: :collection
       resources :estimates, except: [:index, :show]
       put :move
+      resources :comments, only: [:create, :edit, :update, :destroy]
     end
     resource :action_plan, only: [:show]
   end

db/migrate/20230908142819_create_comments.rb

@@ -0,0 +1,10 @@
+class CreateComments < ActiveRecord::Migration[7.0]
+  def change
+    create_table :comments do |t|
+      t.text :body
+      t.integer :story_id
+      t.integer :user_id
+      t.timestamps
+    end
+  end
+end

db/schema.rb

@@ -10,10 +10,18 @@
 #
 # It's strongly recommended that you check this file into your version control system.
 
-ActiveRecord::Schema[7.0].define(version: 2023_08_31_175732) do
+ActiveRecord::Schema[7.0].define(version: 2023_09_08_142819) do
   # These are extensions that must be enabled in order to support this database
   enable_extension "plpgsql"
 
+  create_table "comments", force: :cascade do |t|
+    t.text "body"
+    t.integer "story_id"
+    t.integer "user_id"
+    t.datetime "created_at", null: false
+    t.datetime "updated_at", null: false
+  end
+
   create_table "estimates", force: :cascade do |t|
     t.integer "best_case_points"
     t.integer "worst_case_points"

spec/controllers/comments_controller_spec.rb

@@ -0,0 +1,113 @@
+require "rails_helper"
+
+RSpec.describe CommentsController, type: :controller do
+  render_views
+
+  let!(:user) { FactoryBot.create(:user) }
+  let!(:project) { FactoryBot.create(:project) }
+  let!(:story) { FactoryBot.create(:story, project: project) }
+  let!(:comment) { FactoryBot.create(:comment, story: story, user: user) }
+
+  before do
+    @request.env["devise.mapping"] = Devise.mappings[:user]
+    sign_in user
+  end
+
+  describe "#create" do
+    context "with valid attributes" do
+      let(:valid_params) { FactoryBot.attributes_for(:comment) }
+
+      it "creates a new comment" do
+        expect {
+          post :create, params: {project_id: project.id, story_id: story.id, comment: valid_params}
+        }.to change(Comment, :count).by(1)
+      end
+
+      it "redirects to the story path" do
+        post :create, params: {project_id: project.id, story_id: story.id, comment: valid_params}
+
+        expect(response).to redirect_to project_story_path(project.id, story.id)
+      end
+    end
+
+    context "with invalid attributes" do
+      let(:invalid_params) { {body: ""} }
+
+      it "redirects back to the story page" do
+        post :create, params: {project_id: project.id, story_id: story.id, comment: invalid_params}
+        expect(response).to redirect_to project_story_path(project.id, story.id)
+      end
+    end
+  end
+
+  describe "#destroy" do
+    it "deletes the comment" do
+      delete :destroy, params: {project_id: project.id, story_id: story.id, id: comment.id}
+      expect(Comment.exists?(comment.id)).to be_falsey
+      expect(response).to redirect_to project_story_path(project.id, story.id)
+    end
+
+    it "disallows destroying another users' comment" do
+      user2 = FactoryBot.create(:user)
+      comment2 = FactoryBot.create(:comment, story: story, user: user2)
+
+      delete :destroy, params: {id: comment2.id, story_id: story.id, project_id: project.id}
+
+      expect(response).to redirect_to project_story_path(project.id, story.id)
+      expect(flash[:error]).to eq "Comment not found"
+    end
+  end
+
+  describe "#edit" do
+    before do
+      get :edit, params: {id: comment.id, story_id: story.id, project_id: project.id}
+    end
+
+    it "redirects to the edit page" do
+      expect(response).to render_template :edit
+    end
+
+    it "shows the fields for the comment" do
+      expect(assigns(:comment)).to eq comment
+    end
+  end
+
+  describe "#edit as other user" do
+    it "disallows editing another users' comment" do
+      user2 = FactoryBot.create(:user)
+      comment2 = FactoryBot.create(:comment, story: story, user: user2)
+
+      get :edit, params: {id: comment2.id, story_id: story.id, project_id: project.id}
+
+      expect(response).to redirect_to project_story_path(project.id, story.id)
+      expect(flash[:error]).to eq "Comment not found"
+    end
+  end
+
+  describe "#update" do
+    it "updates the body for the comment" do
+      put :update, params: {
+        id: comment.id,
+        story_id: story.id,
+        project_id: project.id,
+        comment: {
+          body: "test123"
+        }
+      }
+      expect(comment.reload.body).to eq "test123"
+    end
+
+    it "disallows updating another users' comment" do
+      user2 = FactoryBot.create(:user)
+      comment2 = FactoryBot.create(:comment, story: story, user: user2)
+
+      put :update, params: {id: comment2.id,
+                            story_id: story.id,
+                            project_id: project.id,
+                            comment: {body: "test123"}}
+
+      expect(response).to redirect_to project_story_path(project.id, story.id)
+      expect(flash[:error]).to eq "Comment not found"
+    end
+  end
+end