Added plugin for mark comment as read

Signed-off-by: Leandro Nunes dos Santos <leandro.santos@serpro.gov.br> (ActionItem2670)

Added plugin for mark comment as read
Signed-off-by: Leandro Nunes dos Santos <leandro.santos@serpro.gov.br> (ActionItem2670)
Victor Costa · Joenio Costa
1 parent 50f90482
Showing 14 changed files with 334 additions and 0 deletions Show diff stats
app/helpers/comment_helper.rb
app/views/content_viewer/view_page.rhtml
lib/noosfero/plugin.rb
plugins/mark_comment_as_read/controllers/mark_comment_as_read_plugin_profile_controller.rb
plugins/mark_comment_as_read/db/migrate/20130509184338_create_mark_comment_as_read_plugin.rb
plugins/mark_comment_as_read/lib/mark_comment_as_read_plugin.rb
plugins/mark_comment_as_read/lib/mark_comment_as_read_plugin/ext/comment.rb
plugins/mark_comment_as_read/lib/mark_comment_as_read_plugin/read_comments.rb
plugins/mark_comment_as_read/public/mark_comment_as_read.js
plugins/mark_comment_as_read/public/style.css
plugins/mark_comment_as_read/test/functional/mark_comment_as_read_plugin_profile_controller_test.rb
plugins/mark_comment_as_read/test/unit/mark_comment_as_read_plugin/comment_test.rb
plugins/mark_comment_as_read/test/unit/mark_comment_as_read_test.rb
test/unit/plugin_test.rb
@@ -22,6 +22,12 @@ module CommentHelper
     title
   end
+  def comment_extra_contents(comment)
+    @plugins.dispatch(:comment_extra_contents, comment).collect do |extra_content|
+      extra_content.kind_of?(Proc) ? self.instance_eval(&extra_content) : extra_content
+    end.join('\n')
+  end
+
   def comment_actions(comment)
     url = url_for(:profile => profile.identifier, :controller => :comment, :action => :check_actions, :id => comment.id)
     links = links_for_comment_actions(comment)
@@ -84,6 +84,8 @@
 <%= display_source_info(@page) %>
+<%= @plugins.dispatch(:article_extra_contents, @page).collect { |content| instance_eval(&content) }.join("") %>
+
 <div class="comments" id="comments_list">
   <% if @page.accept_comments? || @comments_count > 0 %>
@@ -349,6 +349,12 @@ class Noosfero::Plugin
     []
   end
+  # -> Adds adicional content to article
+  # returns = lambda block that creates html code
+  def article_extra_contents(article)
+    nil
+  end
+
   # -> Adds fields to the signup form
   # returns = lambda block that creates html code
   def signup_extra_contents
@@ -0,0 +1,17 @@
+class MarkCommentAsReadPluginProfileController < ProfileController
+
+  append_view_path File.join(File.dirname(__FILE__) + '/../views')
+
+  def mark_as_read
+    comment = Comment.find(params[:id])
+    comment.mark_as_read(user)
+    render :text => {'ok' => true}.to_json, :content_type => 'application/json'
+  end
+
+  def mark_as_not_read
+    comment = Comment.find(params[:id])
+    comment.mark_as_not_read(user)
+    render :text => {'ok' => true}.to_json, :content_type => 'application/json'
+  end
+
+end
@@ -0,0 +1,13 @@
+class CreateMarkCommentAsReadPlugin < ActiveRecord::Migration
+  def self.up
+    create_table :mark_comment_as_read_plugin do |t|
+      t.integer :comment_id
+      t.integer :person_id
+    end
+    add_index :mark_comment_as_read_plugin, [:comment_id, :person_id], :unique => true
+  end
+
+  def self.down
+    drop_table :mark_comment_as_read_plugin
+  end
+end
@@ -0,0 +1,45 @@
+require_dependency 'mark_comment_as_read_plugin/ext/comment'
+
+class MarkCommentAsReadPlugin < Noosfero::Plugin
+
+  def self.plugin_name
+    "MarkCommentAsReadPlugin"
+  end
+
+  def self.plugin_description
+    _("Provide a button to mark a comment as read.")
+  end
+
+  def js_files
+    'mark_comment_as_read.js'
+  end
+
+  def stylesheet?
+    true
+  end
+
+  def comment_actions(comment)
+    lambda do
+      [{:link => link_to_function(_('Mark as not read'), 'toggle_comment_read(this, %s, false);' % url_for(:controller => 'mark_comment_as_read_plugin_profile', :profile => profile.identifier, :action => 'mark_as_not_read', :id => comment.id).to_json, :class => 'comment-footer comment-footer-link comment-footer-hide comment-action-extra', :style => 'display: none', :id => "comment-action-mark-as-not-read-#{comment.id}")},
+      {:link => link_to_function(_('Mark as read'), 'toggle_comment_read(this, %s, true);' % url_for(:controller => 'mark_comment_as_read_plugin_profile', :profile => profile.identifier, :action => 'mark_as_read', :id => comment.id).to_json, :class => 'comment-footer comment-footer-link comment-footer-hide comment-action-extra', :style => 'display: none', :id => "comment-action-mark-as-read-#{comment.id}")}] if user
+    end
+  end
+
+  def check_comment_actions(comment)
+    lambda do
+      if user
+        comment.marked_as_read?(user) ? "#comment-action-mark-as-not-read-#{comment.id}" : "#comment-action-mark-as-read-#{comment.id}"
+      end
+    end
+  end
+
+  def article_extra_contents(article)
+    lambda do
+      if user
+        ids = article.comments.marked_as_read(user).collect { |comment| comment.id}
+        "<script type=\"text/javascript\">mark_comments_as_read(#{ids.to_json});</script>" if !ids.empty?
+      end
+    end
+  end
+
+end
@@ -0,0 +1,24 @@
+require_dependency 'comment'
+
+class Comment
+
+  has_many :read_comments, :class_name => 'MarkCommentAsReadPlugin::ReadComments'
+  has_many :people, :through => :read_comments
+
+  def mark_as_read(person)
+    people << person
+  end
+
+  def mark_as_not_read(person)
+    people.delete(person)
+  end
+
+  def marked_as_read?(person)
+    person && people.find(:first, :conditions => {:id => person.id})
+  end
+
+  def self.marked_as_read(person)
+    find(:all, :joins => [:read_comments], :conditions => {:author_id => person.id})
+  end
+
+end
@@ -0,0 +1,7 @@
+class MarkCommentAsReadPlugin::ReadComments < Noosfero::Plugin::ActiveRecord
+  set_table_name 'mark_comment_as_read_plugin'
+  belongs_to :comment
+  belongs_to :person
+
+  validates_presence_of :comment, :person
+end
@@ -0,0 +1,28 @@
+function mark_comments_as_read(comments) {
+  jQuery(document).ready(function($) {
+    for(var i=0; i<comments.length; i++) {
+      $comment = jQuery('#comment-'+comments[i]);
+      $comment.find('.comment-content').first().addClass('comment-mark-read');
+    }
+  });
+}
+
+function toggle_comment_read(button, url, mark) {
+  var $ = jQuery;
+  var $button = $(button);
+  $button.addClass('comment-button-loading');
+  $.post(url, function(data) {
+    if (data.ok) {
+      var $comment = $button.closest('.article-comment');
+      var $content = $comment.find('.comment-content').first();
+      if(mark)
+        $content.addClass('comment-mark-read');
+      else
+        $content.removeClass('comment-mark-read');
+      $button.hide();
+      $button.removeClass('comment-button-loading');
+      return;
+    }
+  });
+}
+
@@ -0,0 +1,3 @@
+.article-comments-list .comment-mark-read .comment-text, .article-comments-list .comment-mark-read h4, .article-comments-list .comment-mark-read .comment-picture {
+  opacity: 0.2;
+}
@@ -0,0 +1,33 @@
+require File.dirname(__FILE__) + '/../../../../test/test_helper'
+require File.dirname(__FILE__) + '/../../controllers/mark_comment_as_read_plugin_profile_controller'
+
+# Re-raise errors caught by the controller.
+class MarkCommentAsReadPluginProfileController; def rescue_action(e) raise e end; end
+
+class MarkCommentAsReadPluginProfileControllerTest < ActionController::TestCase
+  def setup
+    @controller = MarkCommentAsReadPluginProfileController.new
+    @request    = ActionController::TestRequest.new
+    @response   = ActionController::TestResponse.new
+    @profile = create_user('profile').person
+    @article = TinyMceArticle.create!(:profile => @profile, :name => 'An article')
+    @comment = Comment.new(:source => @article, :author => @profile, :body => 'test')
+    @comment.save!
+    login_as(@profile.identifier)
+    environment = Environment.default
+    environment.enable_plugin(MarkCommentAsReadPlugin)
+    self.stubs(:user).returns(@profile)
+  end
+
+  attr_reader :profile, :comment
+
+  should 'mark comment as read' do
+    xhr :post, :mark_as_read, :profile => profile.identifier, :id => comment.id
+    assert_match /\{\"ok\":true\}/, @response.body
+  end
+
+  should 'mark comment as not read' do
+    xhr :post, :mark_as_not_read, :profile => profile.identifier, :id => comment.id
+    assert_match /\{\"ok\":true\}/, @response.body
+  end
+end
@@ -0,0 +1,38 @@
+require File.dirname(__FILE__) + '/../../../../../test/test_helper'
+
+class MarkCommentAsReadPlugin::CommentTest < ActiveSupport::TestCase
+
+  def setup
+    @person = create_user('user').person
+    @article = TinyMceArticle.create!(:profile => @person, :name => 'An article')
+    @comment = Comment.create!(:title => 'title', :body => 'body', :author_id => @person.id, :source => @article)
+  end
+
+  should 'mark comment as read' do
+    assert !@comment.marked_as_read?(@person)
+    @comment.mark_as_read(@person)
+    assert @comment.marked_as_read?(@person)
+  end
+
+  should 'do not mark a comment as read again' do
+    @comment.mark_as_read(@person)
+    assert_raise ActiveRecord::StatementInvalid do
+      @comment.mark_as_read(@person)
+    end
+  end
+
+  should 'mark comment as not read' do
+    @comment.mark_as_read(@person)
+    assert @comment.marked_as_read?(@person)
+    @comment.mark_as_not_read(@person)
+    assert !@comment.marked_as_read?(@person)
+  end
+
+  should 'return comments marked as read for a user' do
+    person2 = create_user('user2').person
+    @comment.mark_as_read(@person)
+    assert_equal [], @article.comments.marked_as_read(@person) - [@comment]
+    assert_equal [], @article.comments.marked_as_read(person2)
+  end
+
+end
@@ -0,0 +1,87 @@
+require File.dirname(__FILE__) + '/../../../../test/test_helper'
+
+class MarkCommentAsReadPluginTest < ActiveSupport::TestCase
+
+  include ActionView::Helpers::TagHelper
+  include NoosferoTestHelper
+
+  def setup
+    @plugin = MarkCommentAsReadPlugin.new
+    @person = create_user('user').person
+    @article = TinyMceArticle.create!(:profile => @person, :name => 'An article')
+    @comment = Comment.create!(:source => @article, :author => @person, :body => 'test')
+    self.stubs(:user).returns(@person)
+    self.stubs(:profile).returns(@person)
+  end
+
+  attr_reader :plugin, :comment
+
+  should 'show link when person is logged in' do
+    action = @plugin.comment_actions(@comment)
+    link = self.instance_eval(&action)
+    assert link
+  end
+
+  should 'do not show link when person is not logged in' do
+    self.stubs(:user).returns(nil)
+    action = @plugin.comment_actions(@comment)
+    link = self.instance_eval(&action)
+    assert !link
+  end
+
+  should 'return actions when comment is not read' do
+    action = @plugin.comment_actions(@comment)
+    links = self.instance_eval(&action)
+    assert_equal 2, links.size
+  end
+
+  should 'return actions when comment is read' do
+    @comment.mark_as_read(@person)
+    action = @plugin.comment_actions(@comment)
+    links = self.instance_eval(&action)
+    assert_equal 2, links.size
+  end
+
+  should 'do not return any id when user is not logged in' do
+    self.stubs(:user).returns(nil)
+    action = @plugin.check_comment_actions(@comment)
+    id = self.instance_eval(&action)
+    assert !id
+  end
+
+  should 'return id of mark as not read link when comment is read' do
+    @comment.mark_as_read(@person)
+    action = @plugin.check_comment_actions(@comment)
+    id = self.instance_eval(&action)
+    assert_equal "#comment-action-mark-as-not-read-#{@comment.id}", id
+  end
+
+  should 'return id of mark as read link when comment is not read' do
+    action = @plugin.check_comment_actions(@comment)
+    id = self.instance_eval(&action)
+    assert_equal "#comment-action-mark-as-read-#{@comment.id}", id
+  end
+
+  should 'return javascript to mark comment as read' do
+    @comment.mark_as_read(@person)
+    content = @plugin.article_extra_contents(@article)
+    assert self.instance_eval(&content)
+  end
+
+  should 'do not return extra content if comment is not marked as read' do
+    content = @plugin.article_extra_contents(@article)
+    assert !self.instance_eval(&content)
+  end
+
+  should 'do not return extra content if user is not logged in' do
+    @comment.mark_as_read(@person)
+    self.stubs(:user).returns(nil)
+    content = @plugin.article_extra_contents(@article)
+    assert !self.instance_eval(&content)
+  end
+
+  def link_to_function(content, url, options = {})
+    link_to(content, url, options)
+  end
+
+end
@@ -496,4 +496,29 @@ class PluginTest &lt; ActiveSupport::TestCase
     end
   end
+  should 'comment_actions be nil if the comment is nil' do
+    class SomePlugin < Noosfero::Plugin; end
+    plugin = SomePlugin.new
+    assert_nil plugin.comment_actions(nil)
+  end
+
+  should 'comment_actions be nil by default' do
+    class SomePlugin < Noosfero::Plugin; end
+    plugin = SomePlugin.new
+    assert_nil plugin.comment_actions(Comment.new)
+  end
+
+  should 'check_comment_actions be an empty array if the comment is nil' do
+    class SomePlugin < Noosfero::Plugin; end
+    plugin = SomePlugin.new
+    assert_equal [], plugin.check_comment_actions(nil)
+  end
+
+
+  should 'check_comment_actions be  an empty array by default' do
+    class SomePlugin < Noosfero::Plugin; end
+    plugin = SomePlugin.new
+    assert_equal [], plugin.check_comment_actions(Comment.new)
+  end
+
 end
	@@ -22,6 +22,12 @@ module CommentHelper		@@ -22,6 +22,12 @@ module CommentHelper
22	title	22	title
23	end	23	end
24		24
		25	+ def comment_extra_contents(comment)
		26	+ @plugins.dispatch(:comment_extra_contents, comment).collect do \|extra_content\|
		27	+ extra_content.kind_of?(Proc) ? self.instance_eval(&extra_content) : extra_content
		28	+ end.join('\n')
		29	+ end
		30	+
25	def comment_actions(comment)	31	def comment_actions(comment)
26	url = url_for(:profile => profile.identifier, :controller => :comment, :action => :check_actions, :id => comment.id)	32	url = url_for(:profile => profile.identifier, :controller => :comment, :action => :check_actions, :id => comment.id)
27	links = links_for_comment_actions(comment)	33	links = links_for_comment_actions(comment)
	@@ -84,6 +84,8 @@		@@ -84,6 +84,8 @@
84		84
85	<%= display_source_info(@page) %>	85	<%= display_source_info(@page) %>
86		86
		87	+<%= @plugins.dispatch(:article_extra_contents, @page).collect { \|content\| instance_eval(&content) }.join("") %>
		88	+
87	<div class="comments" id="comments_list">	89	<div class="comments" id="comments_list">
88		90
89	<% if @page.accept_comments? \|\| @comments_count > 0 %>	91	<% if @page.accept_comments? \|\| @comments_count > 0 %>
	@@ -349,6 +349,12 @@ class Noosfero::Plugin		@@ -349,6 +349,12 @@ class Noosfero::Plugin
349	[]	349	[]
350	end	350	end
351		351
		352	+ # -> Adds adicional content to article
		353	+ # returns = lambda block that creates html code
		354	+ def article_extra_contents(article)
		355	+ nil
		356	+ end
		357	+
352	# -> Adds fields to the signup form	358	# -> Adds fields to the signup form
353	# returns = lambda block that creates html code	359	# returns = lambda block that creates html code
354	def signup_extra_contents	360	def signup_extra_contents
@@ -0,0 +1,17 @@		@@ -0,0 +1,17 @@
	1	+class MarkCommentAsReadPluginProfileController < ProfileController
	2	+
	3	+ append_view_path File.join(File.dirname(__FILE__) + '/../views')
	4	+
	5	+ def mark_as_read
	6	+ comment = Comment.find(params[:id])
	7	+ comment.mark_as_read(user)
	8	+ render :text => {'ok' => true}.to_json, :content_type => 'application/json'
	9	+ end
	10	+
	11	+ def mark_as_not_read
	12	+ comment = Comment.find(params[:id])
	13	+ comment.mark_as_not_read(user)
	14	+ render :text => {'ok' => true}.to_json, :content_type => 'application/json'
	15	+ end
	16	+
	17	+end
@@ -0,0 +1,13 @@		@@ -0,0 +1,13 @@
	1	+class CreateMarkCommentAsReadPlugin < ActiveRecord::Migration
	2	+ def self.up
	3	+ create_table :mark_comment_as_read_plugin do \|t\|
	4	+ t.integer :comment_id
	5	+ t.integer :person_id
	6	+ end
	7	+ add_index :mark_comment_as_read_plugin, [:comment_id, :person_id], :unique => true
	8	+ end
	9	+
	10	+ def self.down
	11	+ drop_table :mark_comment_as_read_plugin
	12	+ end
	13	+end
@@ -0,0 +1,45 @@		@@ -0,0 +1,45 @@
	1	+require_dependency 'mark_comment_as_read_plugin/ext/comment'
	2	+
	3	+class MarkCommentAsReadPlugin < Noosfero::Plugin
	4	+
	5	+ def self.plugin_name
	6	+ "MarkCommentAsReadPlugin"
	7	+ end
	8	+
	9	+ def self.plugin_description
	10	+ _("Provide a button to mark a comment as read.")
	11	+ end
	12	+
	13	+ def js_files
	14	+ 'mark_comment_as_read.js'
	15	+ end
	16	+
	17	+ def stylesheet?
	18	+ true
	19	+ end
	20	+
	21	+ def comment_actions(comment)
	22	+ lambda do
	23	+ [{:link => link_to_function(_('Mark as not read'), 'toggle_comment_read(this, %s, false);' % url_for(:controller => 'mark_comment_as_read_plugin_profile', :profile => profile.identifier, :action => 'mark_as_not_read', :id => comment.id).to_json, :class => 'comment-footer comment-footer-link comment-footer-hide comment-action-extra', :style => 'display: none', :id => "comment-action-mark-as-not-read-#{comment.id}")},
	24	+ {:link => link_to_function(_('Mark as read'), 'toggle_comment_read(this, %s, true);' % url_for(:controller => 'mark_comment_as_read_plugin_profile', :profile => profile.identifier, :action => 'mark_as_read', :id => comment.id).to_json, :class => 'comment-footer comment-footer-link comment-footer-hide comment-action-extra', :style => 'display: none', :id => "comment-action-mark-as-read-#{comment.id}")}] if user
	25	+ end
	26	+ end
	27	+
	28	+ def check_comment_actions(comment)
	29	+ lambda do
	30	+ if user
	31	+ comment.marked_as_read?(user) ? "#comment-action-mark-as-not-read-#{comment.id}" : "#comment-action-mark-as-read-#{comment.id}"
	32	+ end
	33	+ end
	34	+ end
	35	+
	36	+ def article_extra_contents(article)
	37	+ lambda do
	38	+ if user
	39	+ ids = article.comments.marked_as_read(user).collect { \|comment\| comment.id}
	40	+ "<script type=\"text/javascript\">mark_comments_as_read(#{ids.to_json});</script>" if !ids.empty?
	41	+ end
	42	+ end
	43	+ end
	44	+
	45	+end
@@ -0,0 +1,24 @@		@@ -0,0 +1,24 @@
	1	+require_dependency 'comment'
	2	+
	3	+class Comment
	4	+
	5	+ has_many :read_comments, :class_name => 'MarkCommentAsReadPlugin::ReadComments'
	6	+ has_many :people, :through => :read_comments
	7	+
	8	+ def mark_as_read(person)
	9	+ people << person
	10	+ end
	11	+
	12	+ def mark_as_not_read(person)
	13	+ people.delete(person)
	14	+ end
	15	+
	16	+ def marked_as_read?(person)
	17	+ person && people.find(:first, :conditions => {:id => person.id})
	18	+ end
	19	+
	20	+ def self.marked_as_read(person)
	21	+ find(:all, :joins => [:read_comments], :conditions => {:author_id => person.id})
	22	+ end
	23	+
	24	+end
@@ -0,0 +1,7 @@		@@ -0,0 +1,7 @@
	1	+class MarkCommentAsReadPlugin::ReadComments < Noosfero::Plugin::ActiveRecord
	2	+ set_table_name 'mark_comment_as_read_plugin'
	3	+ belongs_to :comment
	4	+ belongs_to :person
	5	+
	6	+ validates_presence_of :comment, :person
	7	+end
@@ -0,0 +1,28 @@		@@ -0,0 +1,28 @@
	1	+function mark_comments_as_read(comments) {
	2	+ jQuery(document).ready(function($) {
	3	+ for(var i=0; i<comments.length; i++) {
	4	+ $comment = jQuery('#comment-'+comments[i]);
	5	+ $comment.find('.comment-content').first().addClass('comment-mark-read');
	6	+ }
	7	+ });
	8	+}
	9	+
	10	+function toggle_comment_read(button, url, mark) {
	11	+ var $ = jQuery;
	12	+ var $button = $(button);
	13	+ $button.addClass('comment-button-loading');
	14	+ $.post(url, function(data) {
	15	+ if (data.ok) {
	16	+ var $comment = $button.closest('.article-comment');
	17	+ var $content = $comment.find('.comment-content').first();
	18	+ if(mark)
	19	+ $content.addClass('comment-mark-read');
	20	+ else
	21	+ $content.removeClass('comment-mark-read');
	22	+ $button.hide();
	23	+ $button.removeClass('comment-button-loading');
	24	+ return;
	25	+ }
	26	+ });
	27	+}
	28	+
@@ -0,0 +1,3 @@		@@ -0,0 +1,3 @@
	1	+.article-comments-list .comment-mark-read .comment-text, .article-comments-list .comment-mark-read h4, .article-comments-list .comment-mark-read .comment-picture {
	2	+ opacity: 0.2;
	3	+}