adva_comments 0.1.0

data/test/functional/admin/comments_controller_test.rb

@@ -0,0 +1,200 @@
+require File.expand_path(File.dirname(__FILE__) + "/../../test_helper")
+
+class AdminCommentsControllerTest < ActionController::TestCase
+  include ContentHelper, ResourceHelper, BlogHelper
+  tests Admin::CommentsController
+  attr_reader :controller
+
+  with_common [:a_page, :a_blog], :a_published_article, [:an_approved_comment, :an_unapproved_comment], :is_superuser
+
+  def default_params
+    { :site_id => @site.id, :return_to => 'return/to/here' }
+  end
+
+  view :comment do
+    has_text @comment.body
+
+    comment_path = show_path(@article, :anchor => "comment_#{@comment.id}", :namespace => nil)
+    has_tag 'a[href=?]', comment_path, 'View'              # displays a link to the comment on the frontend view
+    has_tag 'a', 'Edit'                                    # displays a link to edit the comment
+    has_tag 'a', 'Delete'                                  # displays a link to delete the comment
+    has_tag 'a', 'Approve'   if within :unapproved_comment # displays a link to approve comment
+    has_tag 'a', 'Unapprove' if within :approved_comment   # displays a link to unapprove comment
+    # has_tag 'a', 'Reply'   if with? :approved_comment    # displays a link to reply to the comment
+  end
+
+  test "is an Admin::BaseController" do
+    @controller.should be_kind_of(Admin::BaseController)
+  end
+
+  # FIXME in theory the admin comments controller should also work with scoping
+  # to a content or a section (currently only tested scoping to a site)
+
+  describe "routing" do
+    with_options :path_prefix => '/admin/sites/1/', :site_id => '1' do |r|
+      r.it_maps :get,    'comments',        :action => 'index'
+      # r.it_maps :get,    'comments/new',    :action => 'new'
+      # r.it_maps :post,   'comments',        :action => 'create'
+      r.it_maps :get,    'comments/1',      :action => 'show',    :id => '1'
+      r.it_maps :get,    'comments/1/edit', :action => 'edit',    :id => '1'
+      r.it_maps :put,    'comments/1',      :action => 'update',  :id => '1'
+      r.it_maps :delete, 'comments/1',      :action => 'destroy', :id => '1'
+    end
+  end
+
+  describe "GET to :index" do
+    action { get :index, default_params }
+    it_guards_permissions :show, :comment
+
+    with :access_granted do
+      it_assigns :comments
+      it_renders :template, :index do
+        # has_tag 'select[id=filter_list]' # displays a filter for filtering the comments list
+        has_tag 'ul[id=comments_list]'  # displays a list of comments
+        shows :comment
+      end
+    end
+  end
+
+  # describe "GET to :show" do
+  #   action { get :show, default_params.merge(:id => @comment.id) }
+  #   it_guards_permissions :show, :comment
+  # 
+  #   with :access_granted do
+  #     it_assigns :comment
+  #     it_renders :template, :show do
+  #       has_tag 'h3', 'Comment'
+  #       has_text @comment.body
+  #       shows :comment
+  #       # FIXME shows a reply form
+  #     end
+  #   end
+  # end
+
+  # FIXME ... implement these
+  #
+  # describe "GET to :new" do
+  #   action { get :new, default_params }
+  #   it_guards_permissions :create, :comment
+  #   with :access_granted do
+  #     it_assigns :comment
+  #     it_renders :template, :new
+  #   end
+  # end
+  #
+  # describe "POST to :create" do
+  #   action { post :create, @params }
+  #   it_guards_permissions :create, :comment
+  #
+  #   with :valid_comment_params do
+  #     it_changes '@site.reload.comments.count' => 1
+  #     it_redirects_to admin_comment_url(@site, assigns(:comment))
+  #     it_assigns_flash_cookie :notice => :not_nil
+  #   end
+  #
+  #   with :invalid_comment_params do
+  #     it_does_not_change '@site.reload.comments.count'
+  #     it_renders :template, :new
+  #     it_assigns_flash_cookie :error => :not_nil
+  #   end
+  # end
+
+  describe "GET to :edit" do
+    action { get :edit, default_params.merge(:id => @comment.id) }
+    it_guards_permissions :update, :comment
+
+    with :access_granted do
+      it_assigns :comment
+      it_renders :template, :edit do
+        # FIXME assert form rendered
+      end
+    end
+  end
+
+  describe "PUT to :update" do
+    action { put :update, default_params.merge(:id => @comment.id).merge(@params || {}) }
+    it_guards_permissions :update, :comment
+
+    with :access_granted do
+      it_assigns :comment
+
+      with "valid comment params" do
+        before { @params = { :comment => { :body => 'updated comment body' } } }
+        it_updates :comment
+        it_redirects_to 'return/to/here'
+        it_assigns_flash_cookie :notice => :not_nil
+        it_triggers_event :comment_updated
+      end
+
+      with "invalid comment params" do
+        before { @params = { :comment => { :body => '' } } }
+        it_does_not_update :comment
+        it_assigns_flash_cookie :error => :not_nil
+        it_does_not_trigger_any_event
+      end
+    end
+  end
+
+  describe "DELETE to :destroy" do
+    action { delete :destroy, default_params.merge(:id => @comment.id) }
+    it_guards_permissions :destroy, :comment
+
+    with :access_granted do
+      it_assigns :comment
+      it_destroys :comment
+      it_redirects_to 'return/to/here'
+      it_assigns_flash_cookie :notice => :not_nil
+      it_triggers_event :comment_deleted
+    end
+  end
+
+  # def filter_conditions
+  #   @controller.send(:filter_options)[:conditions]
+  # end
+  # 
+  # describe "filter_options" do
+  #   before { @controller.instance_variable_set :@section, @section }
+  # 
+  #   it "sets :order, :per_page and :page parameters defaults" do
+  #     @controller.params = { :filter => 'all' }
+  #     @controller.send(:filter_options).should == { :per_page => nil, :page => 1, :order => 'created_at DESC' }
+  #     assert_nothing_raised { @controller.send :set_comments }
+  #   end
+  # 
+  #   it "fetches approved comments when :filter == state and :state == approved" do
+  #     @controller.params = { :filter => 'state', :state => 'approved' }
+  #     filter_conditions.should == "approved = '1'"
+  #     assert_nothing_raised { @controller.send :set_comments }
+  #   end
+  # 
+  #   it "fetches unapproved comments when :filter == state and :state == unapproved" do
+  #     @controller.params = { :filter => 'state', :state => 'unapproved' }
+  #     filter_conditions.should == "approved = '0'"
+  #     assert_nothing_raised { @controller.send :set_comments }
+  #   end
+  # 
+  #   it "fetches comments by matching the body when :filter == body" do
+  #     @controller.params = { :filter => 'body', :query => 'foo' }
+  #     filter_conditions.should == "LOWER(body) LIKE '%foo%'"
+  #     assert_nothing_raised { @controller.send :set_comments }
+  #   end
+  # 
+  #   it "fetches comments by matching the author name when :filter == author_name" do
+  #     @controller.params = { :filter => 'author_name', :query => 'foo' }
+  #     filter_conditions.should == "LOWER(author_name) LIKE '%foo%'"
+  #     assert_nothing_raised { @controller.send :set_comments }
+  #   end
+  # 
+  #   it "fetches comments by matching the author email when :filter == author_email" do
+  #     @controller.params = { :filter => 'author_email', :query => 'foo@bar.baz' }
+  #     filter_conditions.should == "LOWER(author_email) LIKE '%foo@bar.baz%'"
+  #     assert_nothing_raised { @controller.send :set_comments }
+  #   end
+  # 
+  #   it "fetches comments by matching the author homepage when :filter == author_homepage" do
+  #     @controller.params = { :filter => 'author_homepage', :query => 'homepage.com' }
+  #     filter_conditions.should == "LOWER(author_homepage) LIKE '%homepage.com%'"
+  #     assert_nothing_raised { @controller.send :set_comments }
+  #   end
+  # end
+end

data/test/functional/comments_controller_test.rb

@@ -0,0 +1,133 @@
+require File.expand_path(File.dirname(__FILE__) + "/../test_helper")
+
+# FIXME should also test comments on section articles and wikipages
+
+class CommentsControllerTest < ActionController::TestCase
+  with_common :a_blog, :a_published_article, :an_approved_comment, :is_superuser
+
+  def default_params
+    { :comment => { :commentable_type => 'Article', :commentable_id => @article.id } }
+  end
+
+  test "is a BaseController" do
+    @controller.should be_kind_of(BaseController)
+  end
+
+  describe "routing" do
+    it_maps :get,    'comments',         :action => 'index'
+    it_maps :get,    'comments/new',     :action => 'new'
+    it_maps :post,   'comments/preview', :action => 'preview'
+    it_maps :post,   'comments',         :action => 'create'
+    it_maps :get,    'comments/1',       :action => 'show',    :id => '1'
+    it_maps :get,    'comments/1/edit',  :action => 'edit',    :id => '1'
+    it_maps :put,    'comments/1',       :action => 'update',  :id => '1'
+    it_maps :delete, 'comments/1',       :action => 'destroy', :id => '1'
+  end
+
+  describe "GET to :show" do
+    action { get :show, :id => @comment.id }
+    # it_guards_permissions :show, :comment do # FIXME
+      it_assigns :section, :comment, :commentable
+      it_renders :template, :show do
+        has_text @comment.body
+      end
+
+      # FIXME displays a message when the comment is not approved yet: /under review/
+    # end
+  end
+
+  describe "POST to preview" do
+    action { post :preview, default_params.merge(@params || {}) }
+    it_guards_permissions :create, :comment do
+      with :valid_comment_params do
+        it_assigns :comment => :not_nil
+        it_renders :template, :preview do
+          has_text 'the comment body'
+        end
+      end
+
+      # FIXME
+      # with "invalid comment params" do
+      # end
+    end
+  end
+
+  describe "POST to :create" do
+    action do
+      Comment.with_observers :comment_sweeper do
+        post :create, default_params.merge(@params || {})
+      end
+    end
+    
+    it_guards_permissions :create, :comment do
+      with :valid_comment_params do
+        it_assigns :commentable => :article, :comment => :not_nil
+        it_saves :comment
+        it_assigns_flash_cookie :notice => :not_nil
+        it_triggers_event :comment_created
+        it_sweeps_page_cache :by_reference => :article
+        it_redirects_to { comment_url(assigns(:comment)) }
+
+        # FIXME
+        # it "checks the comment's spaminess" do
+        #   expect do
+        #     url = "http://test.host/sections/1/articles/an-article"
+        #     mock(@comment).check_approval(:permalink => url, :authenticated => false)
+        #     mock(Article).find { @article }
+        #     mock(@article).comments.build { @comment }
+        #   end
+        # end
+      end
+
+      with :invalid_comment_params do
+        it_renders :template, :show
+        it_assigns_flash_cookie :error => :not_nil
+        it_does_not_trigger_any_event
+      end
+    end
+  end
+
+  describe "PUT to :update" do
+    action do
+      Comment.with_observers :comment_sweeper do
+        post :update, (@params || {}).merge(:id => @comment.id)
+      end
+    end
+    
+    it_guards_permissions :update, :comment do
+      with "valid comment params" do
+        before { @params = { :comment => { :body => 'the updated comment body' } } }
+
+        it_updates :comment
+        it_redirects_to { comment_url(assigns(:comment)) }
+        it_assigns_flash_cookie :notice => :not_nil
+        it_triggers_event :comment_updated
+        it_sweeps_page_cache :by_reference => :article
+      end
+
+      with :invalid_comment_params do
+        it_does_not_update :comment
+        it_renders_template :show
+        it_assigns_flash_cookie :error => :not_nil
+        it_does_not_trigger_any_event
+      end
+    end
+  end
+
+  describe "DELETE to :destroy" do
+    action do
+      Comment.with_observers :comment_sweeper do
+        delete :destroy,:id => @comment.id
+      end
+    end
+    
+    it_guards_permissions :destroy, :comment do
+      it_assigns :comment
+      it_destroys :comment
+      it_triggers_event :comment_deleted
+      it_redirects_to { '/' }
+      it_assigns_flash_cookie :notice => :not_nil
+      it_sweeps_page_cache :by_reference => :article
+    end
+  end
+end

data/test/functional/comments_routes_test.rb

@@ -0,0 +1,17 @@
+require File.expand_path(File.dirname(__FILE__) + "/../test_helper")
+
+class CommentsRoutesTest < ActionController::TestCase
+  tests CommentsController
+  
+  paths = %W( /comments
+              /comments/1 )
+
+  paths.each do |path|
+    test "regenerates the original path from the recognized params for #{path}" do
+      without_routing_filters do
+        params = ActionController::Routing::Routes.recognize_path(path, :method => :get)
+        assert_equal path, @controller.url_for(params.merge(:only_path => true))
+      end
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,4 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../adva_cms/test/test_helper')
+
+
+

data/test/unit/helpers/admin/comments_helper_test.rb

@@ -0,0 +1,23 @@
+require File.dirname(__FILE__) + '/../../../test_helper'
+
+class AdminCommentsHelperTest < ActionView::TestCase
+  include Admin::CommentsHelper
+  
+  test "translates comment_expiration_options" do
+    expected = [ ['Are not allowed',                     -1],
+                 ['Never expire',                         0],
+                 ['Expire 24 hours after publishing',     1],
+                 ['Expire 1 week after publishing',       7],
+                 ['Expire 1 month after publishing',      30],
+                 ['Expire 3 months after publishing',     90] ]
+    comment_expiration_options.should == expected
+  end
+  
+  test "translates comments_filter_options" do
+    lambda { comments_filter_options }.should_not raise_error
+  end
+  
+  test "translates comments_state_options" do
+    lambda { comments_state_options }.should_not raise_error
+  end
+end

data/test/unit/helpers/comments_helper_test.rb

@@ -0,0 +1,147 @@
+require File.dirname(__FILE__) + '/../../test_helper'
+
+class CommentsHelperTest < ActionView::TestCase
+  include CommentsHelper
+
+  attr_accessor :request
+
+  def setup
+    super
+    @section = Section.first
+    @article = @section.articles.first
+    @site = @section.site
+
+    stub(self).protect_against_forgery?.returns false
+
+    TestController.send :include, CommentsHelper
+    @controller = TestController.new
+    @request = ActionController::TestRequest.new
+  end
+
+  test '#comments_feed_title joins the titles of site, section and commentable' do
+    comments_feed_title(@site, @section, @article).should ==
+      "Comments: #{@site.title} &raquo; #{@section.title} &raquo; #{@article.title}"
+  end
+
+  # test '#link_to_remote_comment_preview returns a rote link to preview_comments_path' do
+  #   mock(self).preview_comments_path.returns '/path/to/comments/preview'
+  #   link_to_remote_comment_preview.should =~ /Ajax.Updater/
+  # end
+
+  # comment_form_hidden_fields
+
+  test '#comment_form_hidden_fields includes a hidden return_to field' do
+    result = comment_form_hidden_fields(@article)
+    result.should have_tag('input[type=?][name=?]', 'hidden', 'return_to')
+  end
+
+  test 'including comment[commentable_type]' do
+    result = comment_form_hidden_fields(@article)
+    result.should have_tag('input[type=?][name=?]', 'hidden', 'comment[commentable_type]')
+  end
+
+  test 'including comment[commentable_id]' do
+    result = comment_form_hidden_fields(@article)
+    result.should have_tag('input[type=?][name=?]', 'hidden', 'comment[commentable_id]')
+  end
+
+  test "#admin_comment_path with no :section_id param given and with no :content_id param given
+        it returns the admin_site_comment_path with no further params" do
+    @controller.params = { :site_id => 1 }
+    @controller.admin_comments_path(@site).should_not have_url_params
+  end
+
+  test "#admin_comment_path  with no :section_id param given and with a :content_id param given
+        it returns the admin_site_comment_path with the :content_id param" do
+    @controller.params = { :site_id => 1, :content_id => 1 }
+    @controller.admin_comments_path(@site).should have_url_params(:content_id)
+  end
+
+  test "#admin_comment_path with a :section_id param given and with no :content_id param given
+        it returns the admin_site_comment_path with the :section_id param" do
+    @controller.params = { :site_id => 1, :section_id => 1 }
+    @controller.admin_comments_path(@site).should have_url_params(:section_id)
+  end
+
+  test "#admin_comment_path with a :section_id param given and with a :content_id param given
+        it returns the admin_site_comment_path with the :content_id param" do
+    @controller.params = { :site_id => 1, :section_id => 1, :content_id => 1 }
+    @controller.admin_comments_path(@site).should have_url_params(:content_id)
+  end
+end
+
+class LinkToCommentsHelperTest < ActionView::TestCase
+  include ContentHelper, ResourceHelper
+  tests CommentsHelper
+
+  def setup
+    super
+    @section = Section.first
+    @article = @section.articles.find_by_title 'a page article'
+    @category = @section.categories.first
+    @tag = Tag.new :name => 'foo'
+
+    stub(self).current_controller_namespace.returns(nil) # yuck
+    @article_path = show_path(@article)
+  end
+
+  # link_to_content_comments_count
+
+  test "#link_to_content_comments_count returns a link_to_content_comments" do
+    link_to_content_comments_count(@article).should have_tag('a[href=?]', "#{@article_path}#comments")
+  end
+
+  test "#link_to_content_comments_count given the option :total is set
+        it returns a link_to_content_comments with the approved and total comments counts as a link text" do
+    link_to_content_comments_count(@article, :total => true).should =~ /\d{2} \(\d{2}\)/
+  end
+
+  test "#link_to_content_comments_count given the option :total is not set
+        it returns a link_to_content_comments with the total comments count as a link text" do
+    link_to_content_comments_count(@article).should =~ /\d{2}/
+  end
+
+  test "#link_to_content_comments_count given the content has no comments
+        it returns the option :alt as plain text" do
+    stub(@article).approved_comments_count.returns 0
+    link_to_content_comments_count(@article, :alt => 'no comments').should == 'no comments'
+  end
+
+  test "#link_to_content_comments_count given the content has no comments and no option :alt was passed
+        it returns 'none' as plain text" do
+    stub(@article).approved_comments_count.returns 0
+    link_to_content_comments_count(@article).should == 'none'
+  end
+
+  # link_to_content_comments
+
+  test "#link_to_content_comments given a content it returns a link to show_path" do
+    link_to_content_comments(@article).should have_tag('a[href=?]', "#{@article_path}#comments", '1 Comment')
+  end
+
+  test "#link_to_content_comments given a content and a comment it returns a link to show_path + comment anchor" do
+    comment = @article.comments.first
+    anchor = dom_id(comment)
+    link_to_content_comments(@article, comment).should == %(<a href="#{@article_path}##{anchor}">1 Comment</a>)
+  end
+
+  test "#link_to_content_comments given the first arg is a String it uses the String as link text" do
+    path = show_path(@article)
+    link_to_content_comments('link text', @article).should == %(<a href="#{path}#comments">link text</a>)
+  end
+
+  test "#link_to_content_comments given the content has no approved comments and the content does not accept comments
+        it returns nil" do
+    mock(@article).approved_comments_count.returns 0
+    mock(@article).accept_comments?.returns false
+    link_to_content_comments(@article).should be_nil
+  end
+
+  # link_to_content_comment
+
+  test "#link_to_content_comment inserts the comment's commentable to the args and calls link_to_content_comments" do
+    comment = @article.comments.first
+    anchor = dom_id(comment)
+    link_to_content_comment(comment).should == %(<a href="#{@article_path}##{anchor}">1 Comment</a>)
+  end
+end

data/test/unit/models/comment_test.rb

@@ -0,0 +1,150 @@
+require File.dirname(__FILE__) + '/../../test_helper'
+
+class CommentTest < ActiveSupport::TestCase
+  def setup
+    super
+    @section = Section.first
+    @article = @section.articles.first
+    @comment = @article.comments.first
+  end
+
+  test 'acts as a role context for the author role' do
+    Comment.should act_as_role_context(:roles => :author)
+  end
+
+  test 'sanitizes the body_html attribute' do
+    Comment.should filter_attributes(:sanitize => :body_html)
+  end
+
+  test "filters the body column" do
+    @comment.should filter_column(:body)
+  end
+
+  # ASSOCIATIONS
+
+  test "belongs to a site" do
+    @comment.should belong_to(:site)
+  end
+
+  test "belongs to a section" do
+    @comment.should belong_to(:section)
+  end
+
+  test "belongs to a commentable" do
+    @comment.should belong_to(:commentable)
+  end
+
+  # VALIDATIONS
+
+  test "validates presence of author (through belongs_to_author)" do
+    @comment.should validate_presence_of(:author)
+  end
+
+  test "validates presence of body" do
+    @comment.should validate_presence_of(:body)
+  end
+
+  test "validates presence of commentable" do
+    @comment.should validate_presence_of(:commentable)
+  end
+
+  # CALLBACKS
+
+  test 'sets owners (site + section) before validation' do
+    Comment.before_validation.should include(:set_owners)
+  end
+
+  test 'authorizes commenting before create' do
+    Comment.before_create.should include(:authorize_commenting)
+  end
+
+  # INSTANCE METHODS
+
+  test '#owner returns the commentable' do
+    @comment.owner.should == @article
+  end
+
+  test '#filter returns the comment_filter attribute of the commentable' do
+    mock(@comment.commentable.target).comment_filter.returns :filter
+    @comment.filter.should == :filter
+  end
+
+  # approved?
+
+  test '#approved? returns true if the approved attribute is not 0' do
+    @comment.approved = 1
+    @comment.should be_approved
+  end
+
+  test '#approved? returns true if the approved attribute is 0' do
+    @comment.approved = 0
+    @comment.should_not be_approved
+  end
+
+  # state_changes
+
+  test "#state_changes returns :updated, :approved when the comment was just approved" do
+    @comment.approved = 0
+    @comment.clear_changes!
+    @comment.approved = 1
+    @comment.state_changes.should == [:updated, :approved]
+  end
+
+  test "#state_changes returns :updated, :unapproved when the comment was just unapproved" do
+    @comment.approved = 1
+    @comment.clear_changes!
+    @comment.approved = 0
+    @comment.state_changes.should == [:updated, :unapproved]
+  end
+
+  # authorize_commenting
+
+  test '#authorize_commenting checks if the commentable accepts comments' do
+    mock(@comment.commentable.target).accept_comments?.returns(true)
+    @comment.send(:authorize_commenting)
+  end
+
+  test '#authorize_commenting raises CommentNotAllowed if the commentable does not accept comments' do
+    mock(@comment.commentable.target).accept_comments?.returns(false)
+    lambda { @comment.send(:authorize_commenting) }.should raise_error
+  end
+
+  # set_owners
+
+  test '#set_owners sets site and section from the commentable' do
+    @comment.site, @comment.section = nil, nil
+    @comment.send(:set_owners)
+    @comment.site.should == @comment.commentable.site
+    @comment.section.should == @comment.commentable.section
+  end
+
+  # author_link
+
+  test "#author_link returns a link when author_url is present" do
+    stub(@comment).author_homepage.returns 'http://somewhere.com'
+    @comment.author_link.should == %(<a href="http://somewhere.com">#{@comment.author.name}</a>)
+  end
+
+  test "#author_link returns author_name when author_url is not present" do
+    stub(@comment).author_homepage.returns nil
+    @comment.author_link.should == @comment.author.name
+  end
+
+  # comment creation
+
+  test "raises Comment::CommentNotAllowed when commentable.accept_comments? returns false" do
+    mock(@article).accept_comments?.returns(false)
+    comment = Comment.new(:body => 'body', :author => User.first, :commentable => @article)
+    lambda { comment.save! }.should raise_error(Comment::CommentNotAllowed)
+  end
+
+  # filtering
+
+  test "it does not allow html in the comment body" do
+    @article.site.comment_filter = 'textile_filter'
+    html = 'p{position:absolute; top:50px; left:10px; width:150px; height:150px}. secure html'
+    @comment = Comment.new(:body => html, :commentable => @article)
+    @comment.save(false)
+    @comment.body_html.should == %(<p>secure html</p>)
+  end
+end