Added simple comments form to errors. (including tests)

Nathan Broadbent
1 parent d0e170ee
Showing 12 changed files with 191 additions and 9 deletions Show diff stats
app/controllers/errs_controller.rb
app/models/comment.rb
app/models/err.rb
app/views/errs/show.html.haml
app/views/layouts/application.html.haml
config/routes.rb
public/stylesheets/application.css
spec/controllers/errs_controller_spec.rb
spec/factories/comment_factories.rb
spec/factories/err_factories.rb
spec/models/comment_spec.rb
spec/views/errs/show.html.haml_spec.rb
@@ -27,6 +27,7 @@ class ErrsController &lt; ApplicationController
     page      = 1 if page.to_i.zero?
     @notices  = @err.notices.ordered.paginate(:page => page, :per_page => 1)
     @notice   = @notices.first
+    @comment = Comment.new
   end
  
   def create_issue
@@ -62,6 +63,30 @@ class ErrsController &lt; ApplicationController
     redirect_to app_path(@app)
   end
  
+
+  def create_comment
+    @comment = Comment.new(params[:comment].merge(:user_id => current_user.id))
+    if @comment.valid?
+      @err.comments << @comment
+      @err.save
+      flash[:success] = "Comment saved!"
+    else
+      flash[:error] = "I'm sorry, your comment was blank! Try again?"
+    end
+    redirect_to app_err_path(@app, @err)
+  end
+
+  def destroy_comment
+    @comment = Comment.find(params[:comment_id])
+    if @comment.destroy
+      flash[:success] = "Comment deleted!"
+    else
+      flash[:error] = "Sorry, I couldn't delete your comment for some reason. I hope you don't have any sensitive information in there!"
+    end
+    redirect_to app_err_path(@app, @err)
+  end
+
+
   protected
  
     def find_app
@@ -83,3 +108,4 @@ class ErrsController &lt; ApplicationController
     end
  
 end
+
@@ -0,0 +1,13 @@
+class Comment
+  include Mongoid::Document
+  include Mongoid::Timestamps
+
+  field :body, :type => String
+  index :user_id
+
+  belongs_to :err
+  belongs_to :user
+
+  validates_presence_of :body
+end
+
@@ -18,6 +18,7 @@ class Err
  
   belongs_to :app
   has_many :notices
+  has_many :comments, :inverse_of => :err, :dependent => :destroy
  
   validates_presence_of :klass, :environment
  
@@ -51,3 +52,4 @@ class Err
   end
  
 end
+
@@ -19,6 +19,23 @@
       = link_to 'unlink issue', unlink_issue_app_err_path(@app, @err), :method => :delete, :confirm => "Unlink err issues?", :class => "unlink-issue"
   - if @err.unresolved?
     %span= link_to 'resolve', resolve_app_err_path(@app, @err), :method => :put, :confirm => err_confirm, :class => 'resolve'
+- content_for :comments do
+  %h3 Comments on this Err
+  - @err.comments.each do |comment|
+    .window
+      %table.comment
+        %tr
+          %th
+            %span= link_to '&#10008;'.html_safe, destroy_comment_app_err_path(@app, @err) << "?comment_id=#{comment.id}", :method => :delete, :confirm => "Are sure you don't need this comment?", :class => "destroy-comment"
+            = time_ago_in_words(comment.created_at, true) << " ago by "
+            = link_to comment.user.email, user_path(comment.user)
+        %tr
+          %td= comment.body.gsub("\n", "<br>").html_safe
+
+  = form_for @comment, :url => create_comment_app_err_path(@app, @err) do |comment_form|
+    %p Add a comment
+    = comment_form.text_area :body, :style => "width: 420px; height: 80px;"
+    = comment_form.submit "Save Comment"
  
 %h4= @notice.try(:message)
  
@@ -53,3 +70,4 @@ viewing occurrence #{@notices.current_page} of #{@notices.total_pages}
   #session
     %h3 Session
     = render 'notices/session', :notice => @notice
+
@@ -28,5 +28,9 @@
       #content
         = render :partial => 'shared/flash_messages'
         = yield
+      - if content_for?(:comments)
+        #content-comments
+          = yield :comments
     #footer= "Powered by #{link_to 'Errbit', 'http://github.com/jdpace/errbit', :target => '_blank'}: the open source error catcher.".html_safe
     = yield :scripts
+
@@ -22,6 +22,8 @@ Errbit::Application.routes.draw do
         put :resolve
         post :create_issue
         delete :unlink_issue
+        post :create_comment
+        delete :destroy_comment
       end
     end
  
@@ -33,3 +35,4 @@ Errbit::Application.routes.draw do
   root :to => 'apps#index'
  
 end
+
@@ -139,14 +139,17 @@ a.action  { float: right; font-size: 0.9em;}
   border: 1px solid #C6C6C6;
 }
  
-/* Content Title */
-#content-title {
+/* Content Title and Comments */
+#content-title, #content-comments {
   padding: 30px 20px;
   border-top: 1px solid #FFF;
   border-bottom: 1px solid #FFF;
   background-color: #e2e2e2;
 }
-#content-title h1 {
+#content-comments {
+  background-color: #ffffff;
+}
+#content-title h1, #content-comments h3 {
   padding: 0; margin: 0;
   width: 85%;
   border: none;
@@ -154,6 +157,11 @@ a.action  { float: right; font-size: 0.9em;}
   font-size: 2em; line-height: 1em; font-weight: bold; font-family: arial, sans-serif;
   word-wrap: break-word;
 }
+#content-comments h3 {
+  font-size: 1.5em;
+  margin-bottom: 14px;
+}
+
 #content-title .meta { font-size: 0.9em; color: #787878; }
  
 /* Action Bar */
@@ -611,6 +619,7 @@ table.tally th.value {
   text-transform:none;
 }
  
+
 /* Resolve Errs */
 #action-bar a.resolve {
   background: transparent url(images/icons/thumbs-up.png) 6px 5px no-repeat;
@@ -695,3 +704,28 @@ span.click_span {
   display: none;
 }
  
+/* Comments */
+#content-comments form p {
+  margin: 30px 0 0 0;
+  text-transform: uppercase;
+}
+table.comment tbody th {
+  text-transform: none;
+  font-weight: normal;
+  height: 20px;
+  line-height: 0.5em;
+}
+table.comment tbody td {
+  background-color: #F9F9F9;
+}
+#content-comments a.destroy-comment {
+  color: #EE0000;
+  margin-right: 5px;
+}
+#content-comments a.destroy-comment:hover {
+  text-decoration: none;
+}
+#content-comments #comment_submit {
+  margin-top: 15px;
+}
+
@@ -437,4 +437,60 @@ describe ErrsController do
       end
     end
   end
+
+
+  describe "POST /apps/:app_id/errs/:id/create_comment" do
+    render_views
+
+    before(:each) do
+      sign_in Factory(:admin)
+    end
+
+    context "successful comment creation" do
+      let(:err) { Factory(:err) }
+      let(:user) { Factory(:user) }
+
+      before(:each) do
+        post :create_comment, :app_id => err.app.id, :id => err.id,
+             :comment => { :body => "One test comment", :user_id => user.id }
+        err.reload
+      end
+
+      it "should create the comment" do
+        err.comments.size.should == 1
+      end
+
+      it "should redirect to err page" do
+        response.should redirect_to( app_err_path(err.app, err) )
+      end
+    end
+  end
+
+  describe "DELETE /apps/:app_id/errs/:id/destroy_comment" do
+    render_views
+
+    before(:each) do
+      sign_in Factory(:admin)
+    end
+
+    context "successful comment deletion" do
+      let(:err) { Factory :err_with_comments }
+      let(:comment) { err.comments.first }
+
+      before(:each) do
+        delete :destroy_comment, :app_id => err.app.id, :id => err.id, :comment_id => comment.id
+        err.reload
+      end
+
+      it "should delete the comment" do
+        err.comments.detect{|c| c.id.to_s == comment.id }.should == nil
+      end
+
+      it "should redirect to err page" do
+        response.should redirect_to( app_err_path(err.app, err) )
+      end
+    end
+  end
+
 end
+
@@ -0,0 +1,5 @@
+Factory.define :comment do |c|
+  c.user       {|u| u.association :user}
+  c.body       'Test comment'
+end
+
@@ -4,6 +4,11 @@ Factory.define :err do |e|
   e.component     'foo'
   e.action        'bar'
   e.environment   'production'
+  e.comments      []
+end
+
+Factory.define(:err_with_comments, :parent => :err) do |ec|
+  ec.comments     { (1..3).map{Factory(:comment)} }
 end
  
 Factory.define :notice do |n|
@@ -22,4 +27,5 @@ def random_backtrace
     'method'  => ActiveSupport.methods.shuffle.first
   }}
   backtrace
-end
 \ No newline at end of file
+end
+
@@ -0,0 +1,12 @@
+require 'spec_helper'
+
+describe Comment do
+  context 'validations' do
+    it 'should require a body' do
+      comment = Factory.build(:comment, :body => nil)
+      comment.should_not be_valid
+      comment.errors[:body].should include("can't be blank")
+    end
+  end
+end
+
 require 'spec_helper'
  
-describe "errs/show.html.erb" do 
-  before do 
+describe "errs/show.html.erb" do
+  before do
     err = Factory(:err)
+    comment = Factory(:comment)
     assign :err, err
+    assign :comment, comment
     assign :app, err.app
     assign :notices, err.notices.ordered.paginate(:page => 1, :per_page => 1)
     assign :notice, err.notices.first
@@ -12,7 +14,7 @@ describe &quot;errs/show.html.erb&quot; do
   describe "content_for :action_bar" do
  
     it "should confirm the 'resolve' link by default" do
-      render 
+      render
       action_bar = String.new(view.instance_variable_get(:@_content_for)[:action_bar])
       resolve_link = action_bar.match(/(<a href.*?(class="resolve").*?>)/)[0]
       resolve_link.should =~ /data-confirm="Seriously\?"/
@@ -20,7 +22,7 @@ describe &quot;errs/show.html.erb&quot; do
  
     it "should confirm the 'resolve' link if configuration is unset" do
       Errbit::Config.stub(:confirm_resolve_err).and_return(nil)
-      render 
+      render
       action_bar = String.new(view.instance_variable_get(:@_content_for)[:action_bar])
       resolve_link = action_bar.match(/(<a href.*?(class="resolve").*?>)/)[0]
       resolve_link.should =~ /data-confirm="Seriously\?"/
@@ -28,7 +30,7 @@ describe &quot;errs/show.html.erb&quot; do
  
     it "should not confirm the 'resolve' link if configured not to" do
       Errbit::Config.stub(:confirm_resolve_err).and_return(false)
-      render 
+      render
       action_bar = String.new(view.instance_variable_get(:@_content_for)[:action_bar])
       resolve_link = action_bar.match(/(<a href.*?(class="resolve").*?>)/)[0]
       resolve_link.should_not =~ /data-confirm=/
@@ -37,3 +39,4 @@ describe &quot;errs/show.html.erb&quot; do
   end
  
 end
+
...	...	@@ -27,6 +27,7 @@ class ErrsController < ApplicationController
27	27	page = 1 if page.to_i.zero?
28	28	@notices = @err.notices.ordered.paginate(:page => page, :per_page => 1)
29	29	@notice = @notices.first
	30	+ @comment = Comment.new
30	31	end
31	32
32	33	def create_issue
...	...	@@ -62,6 +63,30 @@ class ErrsController < ApplicationController
62	63	redirect_to app_path(@app)
63	64	end
64	65
	66	+
	67	+ def create_comment
	68	+ @comment = Comment.new(params[:comment].merge(:user_id => current_user.id))
	69	+ if @comment.valid?
	70	+ @err.comments << @comment
	71	+ @err.save
	72	+ flash[:success] = "Comment saved!"
	73	+ else
	74	+ flash[:error] = "I'm sorry, your comment was blank! Try again?"
	75	+ end
	76	+ redirect_to app_err_path(@app, @err)
	77	+ end
	78	+
	79	+ def destroy_comment
	80	+ @comment = Comment.find(params[:comment_id])
	81	+ if @comment.destroy
	82	+ flash[:success] = "Comment deleted!"
	83	+ else
	84	+ flash[:error] = "Sorry, I couldn't delete your comment for some reason. I hope you don't have any sensitive information in there!"
	85	+ end
	86	+ redirect_to app_err_path(@app, @err)
	87	+ end
	88	+
	89	+
65	90	protected
66	91
67	92	def find_app
...	...	@@ -83,3 +108,4 @@ class ErrsController < ApplicationController
83	108	end
84	109
85	110	end
	111	+
...	...
...	...	@@ -0,0 +1,13 @@
	1	+class Comment
	2	+ include Mongoid::Document
	3	+ include Mongoid::Timestamps
	4	+
	5	+ field :body, :type => String
	6	+ index :user_id
	7	+
	8	+ belongs_to :err
	9	+ belongs_to :user
	10	+
	11	+ validates_presence_of :body
	12	+end
	13	+
...	...
...	...	@@ -18,6 +18,7 @@ class Err
18	18
19	19	belongs_to :app
20	20	has_many :notices
	21	+ has_many :comments, :inverse_of => :err, :dependent => :destroy
21	22
22	23	validates_presence_of :klass, :environment
23	24
...	...	@@ -51,3 +52,4 @@ class Err
51	52	end
52	53
53	54	end
	55	+
...	...
...	...	@@ -19,6 +19,23 @@
19	19	= link_to 'unlink issue', unlink_issue_app_err_path(@app, @err), :method => :delete, :confirm => "Unlink err issues?", :class => "unlink-issue"
20	20	- if @err.unresolved?
21	21	%span= link_to 'resolve', resolve_app_err_path(@app, @err), :method => :put, :confirm => err_confirm, :class => 'resolve'
	22	+- content_for :comments do
	23	+ %h3 Comments on this Err
	24	+ - @err.comments.each do \|comment\|
	25	+ .window
	26	+ %table.comment
	27	+ %tr
	28	+ %th
	29	+ %span= link_to '✘'.html_safe, destroy_comment_app_err_path(@app, @err) << "?comment_id=#{comment.id}", :method => :delete, :confirm => "Are sure you don't need this comment?", :class => "destroy-comment"
	30	+ = time_ago_in_words(comment.created_at, true) << " ago by "
	31	+ = link_to comment.user.email, user_path(comment.user)
	32	+ %tr
	33	+ %td= comment.body.gsub("\n", "<br>").html_safe
	34	+
	35	+ = form_for @comment, :url => create_comment_app_err_path(@app, @err) do \|comment_form\|
	36	+ %p Add a comment
	37	+ = comment_form.text_area :body, :style => "width: 420px; height: 80px;"
	38	+ = comment_form.submit "Save Comment"
22	39
23	40	%h4= @notice.try(:message)
24	41
...	...	@@ -53,3 +70,4 @@ viewing occurrence #{@notices.current_page} of #{@notices.total_pages}
53	70	#session
54	71	%h3 Session
55	72	= render 'notices/session', :notice => @notice
	73	+
...	...
...	...	@@ -28,5 +28,9 @@
28	28	#content
29	29	= render :partial => 'shared/flash_messages'
30	30	= yield
	31	+ - if content_for?(:comments)
	32	+ #content-comments
	33	+ = yield :comments
31	34	#footer= "Powered by #{link_to 'Errbit', 'http://github.com/jdpace/errbit', :target => '_blank'}: the open source error catcher.".html_safe
32	35	= yield :scripts
	36	+
...	...
...	...	@@ -22,6 +22,8 @@ Errbit::Application.routes.draw do
22	22	put :resolve
23	23	post :create_issue
24	24	delete :unlink_issue
	25	+ post :create_comment
	26	+ delete :destroy_comment
25	27	end
26	28	end
27	29
...	...	@@ -33,3 +35,4 @@ Errbit::Application.routes.draw do
33	35	root :to => 'apps#index'
34	36
35	37	end
	38	+
...	...
...	...	@@ -139,14 +139,17 @@ a.action { float: right; font-size: 0.9em;}
139	139	border: 1px solid #C6C6C6;
140	140	}
141	141
142		-/* Content Title */
143		-#content-title {
	142	+/* Content Title and Comments */
	143	+#content-title, #content-comments {
144	144	padding: 30px 20px;
145	145	border-top: 1px solid #FFF;
146	146	border-bottom: 1px solid #FFF;
147	147	background-color: #e2e2e2;
148	148	}
149		-#content-title h1 {
	149	+#content-comments {
	150	+ background-color: #ffffff;
	151	+}
	152	+#content-title h1, #content-comments h3 {
150	153	padding: 0; margin: 0;
151	154	width: 85%;
152	155	border: none;
...	...	@@ -154,6 +157,11 @@ a.action { float: right; font-size: 0.9em;}
154	157	font-size: 2em; line-height: 1em; font-weight: bold; font-family: arial, sans-serif;
155	158	word-wrap: break-word;
156	159	}
	160	+#content-comments h3 {
	161	+ font-size: 1.5em;
	162	+ margin-bottom: 14px;
	163	+}
	164	+
157	165	#content-title .meta { font-size: 0.9em; color: #787878; }
158	166
159	167	/* Action Bar */
...	...	@@ -611,6 +619,7 @@ table.tally th.value {
611	619	text-transform:none;
612	620	}
613	621
	622	+
614	623	/* Resolve Errs */
615	624	#action-bar a.resolve {
616	625	background: transparent url(images/icons/thumbs-up.png) 6px 5px no-repeat;
...	...	@@ -695,3 +704,28 @@ span.click_span {
695	704	display: none;
696	705	}
697	706
	707	+/* Comments */
	708	+#content-comments form p {
	709	+ margin: 30px 0 0 0;
	710	+ text-transform: uppercase;
	711	+}
	712	+table.comment tbody th {
	713	+ text-transform: none;
	714	+ font-weight: normal;
	715	+ height: 20px;
	716	+ line-height: 0.5em;
	717	+}
	718	+table.comment tbody td {
	719	+ background-color: #F9F9F9;
	720	+}
	721	+#content-comments a.destroy-comment {
	722	+ color: #EE0000;
	723	+ margin-right: 5px;
	724	+}
	725	+#content-comments a.destroy-comment:hover {
	726	+ text-decoration: none;
	727	+}
	728	+#content-comments #comment_submit {
	729	+ margin-top: 15px;
	730	+}
	731	+
...	...
...	...	@@ -437,4 +437,60 @@ describe ErrsController do
437	437	end
438	438	end
439	439	end
	440	+
	441	+
	442	+ describe "POST /apps/:app_id/errs/:id/create_comment" do
	443	+ render_views
	444	+
	445	+ before(:each) do
	446	+ sign_in Factory(:admin)
	447	+ end
	448	+
	449	+ context "successful comment creation" do
	450	+ let(:err) { Factory(:err) }
	451	+ let(:user) { Factory(:user) }
	452	+
	453	+ before(:each) do
	454	+ post :create_comment, :app_id => err.app.id, :id => err.id,
	455	+ :comment => { :body => "One test comment", :user_id => user.id }
	456	+ err.reload
	457	+ end
	458	+
	459	+ it "should create the comment" do
	460	+ err.comments.size.should == 1
	461	+ end
	462	+
	463	+ it "should redirect to err page" do
	464	+ response.should redirect_to( app_err_path(err.app, err) )
	465	+ end
	466	+ end
	467	+ end
	468	+
	469	+ describe "DELETE /apps/:app_id/errs/:id/destroy_comment" do
	470	+ render_views
	471	+
	472	+ before(:each) do
	473	+ sign_in Factory(:admin)
	474	+ end
	475	+
	476	+ context "successful comment deletion" do
	477	+ let(:err) { Factory :err_with_comments }
	478	+ let(:comment) { err.comments.first }
	479	+
	480	+ before(:each) do
	481	+ delete :destroy_comment, :app_id => err.app.id, :id => err.id, :comment_id => comment.id
	482	+ err.reload
	483	+ end
	484	+
	485	+ it "should delete the comment" do
	486	+ err.comments.detect{\|c\| c.id.to_s == comment.id }.should == nil
	487	+ end
	488	+
	489	+ it "should redirect to err page" do
	490	+ response.should redirect_to( app_err_path(err.app, err) )
	491	+ end
	492	+ end
	493	+ end
	494	+
440	495	end
	496	+
...	...
...	...	@@ -0,0 +1,5 @@
	1	+Factory.define :comment do \|c\|
	2	+ c.user {\|u\| u.association :user}
	3	+ c.body 'Test comment'
	4	+end
	5	+
...	...
...	...	@@ -4,6 +4,11 @@ Factory.define :err do \|e\|
4	4	e.component 'foo'
5	5	e.action 'bar'
6	6	e.environment 'production'
	7	+ e.comments []
	8	+end
	9	+
	10	+Factory.define(:err_with_comments, :parent => :err) do \|ec\|
	11	+ ec.comments { (1..3).map{Factory(:comment)} }
7	12	end
8	13
9	14	Factory.define :notice do \|n\|
...	...	@@ -22,4 +27,5 @@ def random_backtrace
22	27	'method' => ActiveSupport.methods.shuffle.first
23	28	}}
24	29	backtrace
25		-end
26	30	\ No newline at end of file
	31	+end
	32	+
...	...