Adding macro support for TinyMCE articles and a plugin called CommentGroupMacro …

…that uses the macro support

Adding macro support for TinyMCE articles and a plugin called CommentGroupMacro …
…that uses the macro support
Leandro Nunes dos Santos
1 parent 3e4b7e40
Showing 29 changed files with 1007 additions and 56 deletions Show diff stats
app/controllers/public/content_viewer_controller.rb
app/helpers/application_helper.rb
app/helpers/boxes_helper.rb
app/helpers/macros_helper.rb
app/models/comment.rb
app/models/environment.rb
app/views/comment/_comment_form.rhtml
app/views/content_viewer/view_page.rhtml
app/views/shared/tiny_mce.rhtml
lib/noosfero/plugin.rb
lib/noosfero/plugin/manager.rb
plugins/comment_group_macro/controllers/profile/comment_group_macro_plugin_profile_controller.rb
plugins/comment_group_macro/db/migrate/20121220201629_add_group_id_to_comment.rb
plugins/comment_group_macro/lib/comment_group_macro_plugin.rb
plugins/comment_group_macro/lib/comment_group_macro_plugin/ext/article.rb
plugins/comment_group_macro/lib/comment_group_macro_plugin/ext/comment.rb
plugins/comment_group_macro/public/comment_group.css
plugins/comment_group_macro/public/comment_group.js
plugins/comment_group_macro/public/images/comments.gif
plugins/comment_group_macro/test/functional/comment_group_macro_plugin_profile_controller_test.rb
@@ -98,10 +98,13 @@ class ContentViewerController &lt; ApplicationController
         session[:notice] = _("Notification of new comments to '%s' was successfully canceled") % params[:email]
       end
     end
+   
+    @comments = @plugins.dispatch_first(:load_comments, @page)
+    @comments ||= @page.comments.without_spam.as_thread
+    @comments = [@comments] unless @comments.is_a?(Array)
+
+    @comments_count = Comment.count_thread(@comments)
  
-    comments = @page.comments.without_spam
-    @comments = comments.as_thread
-    @comments_count = comments.count
     if params[:slideshow]
       render :action => 'slideshow', :layout => 'slideshow'
     end
@@ -988,10 +988,7 @@ module ApplicationHelper
     options.merge!(:page => params[:npage])
     content = article.to_html(options)
     content = content.kind_of?(Proc) ? self.instance_eval(&content) : content
-    @plugins && @plugins.each do |plugin|
-      content = plugin.parse_content(content)
-    end
-    content
+    filter_html(content, article)
   end
  
   def colorpicker_field(object_name, method, options = {})
@@ -1425,4 +1422,36 @@ module ApplicationHelper
     @no_design_blocks = true
   end
  
+  def filter_html(html, source)
+    if @plugins
+      html = convert_macro(html, source)
+    end
+    html
+  end
+
+  def convert_macro(html, source)
+    doc = Hpricot(html)
+    while element = doc.search('.macro').first
+      macro_name = element['data-macro']
+      method_name = "macro_#{macro_name}"
+      attrs = collect_macro_attributes(element)
+      plugin_instance = Environment.macros[environment.id][method_name]
+      if plugin_instance
+        result = plugin_instance.send(method_name, attrs, element.inner_html, source)
+        element.inner_html = result.kind_of?(Proc) ? self.instance_eval(&result) : result
+        element['class'] = "parsed-macro #{macro_name}"
+      else
+        element.inner_html = _("Unsupported macro %s!") % macro_name
+        element['class'] = "failed-macro #{macro_name}"
+      end
+      attrs.each {|key, value| element.remove_attribute("data-macro-#{key}")}
+    end
+    doc.html
+  end
+
+  def collect_macro_attributes(element)
+    element.attributes.to_hash.select {|key, value| key[0..10] == 'data-macro-'}.
+                       inject({}){|result, a| result.merge({a[0][11..-1] => a[1]})}.with_indifferent_access
+  end
+
 end
@@ -99,8 +99,8 @@ module BoxesHelper
     unless block.visible?
       options[:title] = _("This block is invisible. Your visitors will not see it.")
     end
-    @controller.send(:content_editor?) || @plugins.each do |plugin|
-      result = plugin.parse_content(result)
+    if @controller.send(:content_editor?)
+      result = filter_html(result, block)
     end
     box_decorator.block_target(block.box, block) +
       content_tag('div',
@@ -0,0 +1,96 @@
+module MacrosHelper
+
+  def macros_in_menu
+    Environment.macros[@environment.id].reject{ |macro_name, plugin_instance| macro_configuration(macro_name)[:icon_path] }
+  end
+
+  def macros_with_buttons
+    Environment.macros[@environment.id].reject{ |macro_name, plugin_instance| !macro_configuration(macro_name)[:icon_path] }
+  end
+
+  def macro_configuration(macro_name)
+    plugin_instance = Environment.macros[@environment.id][macro_name]
+    plugin_instance.send("config_#{macro_name}")
+  end
+
+  def macro_title(macro_name)
+    macro_configuration(macro_name)[:title] || macro_name.to_s.humanize
+  end
+  
+  def generate_macro_config_dialog(macro_name)
+    if macro_configuration(macro_name)[:skip_dialog]
+      "function(){#{macro_generator(macro_name)}}"
+    else
+      "function(){
+        jQuery('<div>'+#{macro_configuration_dialog(macro_name).to_json}+'</div>').dialog({
+          title: #{macro_title(macro_name).to_json},
+          modal: true,
+          buttons: [
+            {text: #{_('Ok').to_json}, click: function(){
+              tinyMCE.activeEditor.execCommand('mceInsertContent', false,
+              (function(dialog){ #{macro_generator(macro_name)} })(this));
+              jQuery(this).dialog('close');
+            }},
+            {text: #{_('Cancel').to_json}, click: function(){jQuery(this).dialog('close');}}
+          ]
+        });
+      }"
+    end
+  end
+
+  def include_macro_js_files
+    plugins_javascripts = []
+    Environment.macros[environment.id].map do |macro_name, plugin_instance|
+      if macro_configuration(macro_name)[:js_files]
+        macro_configuration(macro_name)[:js_files].map { |js| plugins_javascripts << plugin_instance.class.public_path(js) } 
+      end
+    end
+    javascript_include_tag(plugins_javascripts, :cache => 'cache/plugins-' + Digest::MD5.hexdigest(plugins_javascripts.to_s)) unless plugins_javascripts.empty?
+  end
+
+  def macro_css_files
+    plugins_css = []
+    Environment.macros[environment.id].map do |macro_name, plugin_instance|
+      if macro_configuration(macro_name)[:css_files]
+        macro_configuration(macro_name)[:css_files].map { |css| plugins_css << plugin_instance.class.public_path(css) } 
+      end
+    end
+    plugins_css.join(',')
+  end
+
+  protected
+  
+  def macro_generator(macro_name)
+    if macro_configuration(macro_name)[:generator]
+      macro_configuration(macro_name)[:generator]
+    else
+      macro_default_generator(macro_name)
+    end
+  end
+  
+  def macro_default_generator(macro_name)
+    code = "var params = {};"
+    configuration = macro_configuration(macro_name)
+    configuration[:params].map do |field|
+      code += "params.#{field[:name]} = jQuery('*[name=#{field[:name]}]', dialog).val();"
+    end
+    code + "
+      var html = jQuery('<div class=\"macro mceNonEditable\" data-macro=\"#{macro_name[6..-1]}\">'+#{macro_title(macro_name).to_json}+'</div>')[0];
+      for(key in params) html.setAttribute('data-macro-'+key,params[key]);
+      return html.outerHTML;
+    "
+  end
+
+  def macro_configuration_dialog(macro_name)
+    macro_configuration(macro_name)[:params].map do |field|
+      label_name = field[:label] || field[:name].to_s.humanize
+      case field[:type]
+      when 'text'
+        labelled_form_field(label_name, text_field_tag(field[:name], field[:default]))
+      when 'select'
+        labelled_form_field(label_name, select_tag(field[:name], options_for_select(field[:values], field[:default])))
+      end
+    end.join("\n")
+  end
+
+end
@@ -157,6 +157,14 @@ class Comment &lt; ActiveRecord::Base
     @replies = comments_list
   end
  
+  def self.count_thread(comments)
+    count = comments.length
+    comments.each do |c|
+      count+=count_thread(c.replies)
+    end
+    count
+  end
+
   def self.as_thread
     result = {}
     root = []
@@ -16,6 +16,10 @@ class Environment &lt; ActiveRecord::Base
     filename
   end
  
+  class << self
+    attr_accessor :macros
+  end
+
   PERMISSIONS['Environment'] = {
     'view_environment_admin_panel' => N_('View environment admin panel'),
     'edit_environment_features' => N_('Edit environment features'),
@@ -89,6 +89,8 @@ function check_captcha(button, confirm_action) {
   <%= required labelled_form_field(_('Enter your comment'), f.text_area(:body, :rows => 5)) %>
   <%= f.hidden_field(:reply_of_id) %>
  
+  <%= @plugins.dispatch(:comment_form_extra_contents, local_assigns).collect { |content| instance_eval(&content) }.join("") %>
+
   <% button_bar do %>
       <%= submit_button('add', _('Post comment'), :onclick => "if(check_captcha(this)) { save_comment(this) } else { check_captcha(this, save_comment)};return false;") %>
       <%= button_to_function :cancel, _('Cancel'), "jQuery.colorbox.close();f=jQuery(this).parents('.post_comment_box'); f.removeClass('opened'); f.addClass('closed'); return false" %>
@@ -91,7 +91,7 @@
  
   <% if @page.accept_comments? || @comments_count > 0 %>
     <h3 <%= 'class="no-comments-yet"' if @comments_count == 0 %>>
-      <%= number_of_comments(@page) %>
+      <%= display_number_of_comments(@comments_count) %>
     </h3>
   <% end %>
  
+<% extend MacrosHelper %>
 <%= javascript_include_tag 'tinymce/jscripts/tiny_mce/tiny_mce.js' %>
+<%= include_macro_js_files %>
 <script type="text/javascript">
-  var myplugins = "searchreplace,print,table,contextmenu";
+  var myplugins = "searchreplace,print,table,contextmenu,-macrosPlugin";
   var first_line, second_line;
   var mode = '<%= mode ||= false %>'
   <% if mode %>
@@ -8,36 +10,82 @@
     second_line = ""
   <% else %>
     first_line = "print,separator,copy,paste,separator,undo,redo,separator,search,replace,separator,forecolor,fontsizeselect,formatselect"
-    second_line = "bold,italic,underline,strikethrough,separator,bullist,numlist,separator,justifyleft,justifycenter,justifyright,justifyfull,separator,link,unlink,image,table,separator,cleanup,code"
+    second_line = "bold,italic,underline,strikethrough,separator,bullist,numlist,separator,justifyleft,justifycenter,justifyright,justifyfull,separator,link,unlink,image,table,separator,cleanup,code,macros"
+    <% Environment.macros[environment.id].each do |macro_name, plugin_instance| %>
+      <% if macro_configuration(macro_name)[:icon_path] %>
+        second_line += ',<%=macro_name %>'
+      <% end %>
+    <% end %>
   <% end %>
  
   if (tinymce.isIE) {
     // the paste plugin is only useful in Internet Explorer
     myplugins = "paste," + myplugins;
   }
+
+tinymce.create('tinymce.plugins.MacrosPlugin', {
+  createControl: function(n, cm) {
+    switch (n) {
+       case 'macros':
+         <% unless macros_in_menu.empty? %>
+           var c = cm.createMenuButton('macros', {
+             title : 'Macros',
+             image : '/designs/icons/tango/Tango/16x16/emblems/emblem-system.png',
+             icons : false
+           });
+  
+           <% macros_in_menu.each do |macro_name, plugin_instance| %>
+             c.onRenderMenu.add(function(c, m) {
+               m.add({
+                 title: <%= macro_title(macro_name).to_json %>,
+                 onclick: <%= generate_macro_config_dialog(macro_name) %>
+               });
+             });
+           <% end %>
+  
+           // Return the new menu button instance
+           return c;
+         <% end %>
+    }
+    return null;
+  }
+});
+
+// Register plugin with a short name
+tinymce.PluginManager.add('macrosPlugin', tinymce.plugins.MacrosPlugin);
+
 tinyMCE.init({
-        mode : "textareas",
-        editor_selector : "mceEditor",
-        theme : "advanced",
-        relative_urls : false,
-        remove_script_host : true,
-        document_base_url : <%= environment.top_url.to_json %>,
-        plugins: myplugins,
-        theme_advanced_toolbar_location : "top",
-        theme_advanced_layout_manager: 'SimpleLayout',
-        theme_advanced_buttons1 : first_line,
-        theme_advanced_buttons2 : second_line,
-        theme_advanced_buttons3 : "",
-        theme_advanced_blockformats :"p,address,pre,h2,h3,h4,h5,h6",
-        paste_auto_cleanup_on_paste : true,
-        paste_insert_word_content_callback : "convertWord",
-        paste_use_dialog: false,
-        apply_source_formatting : true,
-        extended_valid_elements : "applet[style|archive|codebase|code|height|width],comment,iframe[src|style|allowtransparency|frameborder|width|height|scrolling],embed[title|src|type|height|width]",
-        content_css: '/stylesheets/tinymce.css',
-        language: <%= tinymce_language.inspect %>,
-        entity_encoding: 'raw'
-        });
+  mode : "textareas",
+  editor_selector : "mceEditor",
+  theme : "advanced",
+  relative_urls : false,
+  remove_script_host : true,
+  document_base_url : <%= environment.top_url.to_json %>,
+  plugins: myplugins,
+  theme_advanced_toolbar_location : "top",
+  theme_advanced_layout_manager: 'SimpleLayout',
+  theme_advanced_buttons1 : first_line,
+  theme_advanced_buttons2 : second_line,
+  theme_advanced_buttons3 : "",
+  theme_advanced_blockformats :"p,address,pre,h2,h3,h4,h5,h6",
+  paste_auto_cleanup_on_paste : true,
+  paste_insert_word_content_callback : "convertWord",
+  paste_use_dialog: false,
+  apply_source_formatting : true,
+  extended_valid_elements : "applet[style|archive|codebase|code|height|width],comment,iframe[src|style|allowtransparency|frameborder|width|height|scrolling],embed[title|src|type|height|width]",
+  content_css: '/stylesheets/tinymce.css,<%= macro_css_files %>',
+  language: <%= tinymce_language.inspect %>,
+  entity_encoding: 'raw',
+  setup : function(ed) {
+    <% macros_with_buttons.each do |macro_name, plugin_instance| %>
+           ed.addButton('<%= macro_name %>', {
+               title: <%= macro_title(macro_name).to_json %>,
+               onclick: <%= generate_macro_config_dialog(macro_name) %>,
+               image : '<%= macro_configuration(macro_name)[:icon_path]%>'
+             });
+    <% end %>
+  }
+});
  
 function convertWord(type, content) {
   switch (type) {
@@ -5,6 +5,13 @@ class Noosfero::Plugin
  
   attr_accessor :context
  
+  def initialize(context=nil)
+    self.context = context
+    macro_methods.each do |method|
+      Environment.macros[context.environment.id][method] = self unless context.nil?
+    end
+  end
+
   class << self
  
     def klass(dir)
@@ -199,8 +206,8 @@ class Noosfero::Plugin
  
   # -> Parse and possibly make changes of content (article, block, etc) during HTML rendering
   # returns = content as string after parser and changes
-  def parse_content(raw_content)
-    raw_content
+  def parse_content(args)
+    args
   end
  
   # -> Adds links to the admin panel
@@ -236,6 +243,18 @@ class Noosfero::Plugin
   def filter_comment(comment)
   end
  
+  # Define custom logic to load the article comments.
+  #
+  # Example:
+  #
+  #   def load_comments(article)
+  #     article.comments.find(:all, :conditions => ['spam IS NULL OR spam = ?', false])
+  #   end
+  #
+  def load_comments(article)
+    nil
+  end
+
   # This method is called by the CommentHandler background job before sending
   # the notification email. If the comment is marked as spam (i.e. by calling
   # <tt>comment.spam!</tt>), then the notification email will *not* be sent.
@@ -288,7 +307,7 @@ class Noosfero::Plugin
   def profile_info_extra_contents
     nil
   end
-
+  
   # -> Removes the invite friend button from the friends controller
   # returns = boolean
   def remove_invite_friends_button
@@ -350,6 +369,18 @@ class Noosfero::Plugin
   def login_extra_contents
     nil
   end
+  
+  # -> Adds adicional content to comment form
+  # returns = lambda block that creates html code
+  def comment_form_extra_contents(args)
+    nil
+  end
+
+  # -> Register macro methods in environment
+  # returns  = ['method1', 'method2', ...]
+  def macro_methods
+    []
+  end
  
   def method_missing(method, *args, &block)
     # This is a generic hotspot for all controllers on Noosfero.
@@ -376,6 +407,11 @@ class Noosfero::Plugin
     # returns = string with reason of expiration
     elsif method.to_s =~ /^content_expire_(#{content_actions.join('|')})$/
       nil
+    # -> Answers to a specific macro
+    # expects: params, inner_html, content 
+    # returns = html_code
+    elsif method.to_s =~ /^macro_(.+)$/
+      nil
     else
       super
     end
@@ -6,6 +6,7 @@ class Noosfero::Plugin::Manager
   def initialize(environment, context)
     @environment = environment
     @context = context
+    Environment.macros = {environment.id => {}}
   end
  
   delegate :each, :to => :enabled_plugins
@@ -27,13 +28,20 @@ class Noosfero::Plugin::Manager
     map { |plugin| plugin.send(event, *args) }.compact
   end
  
+  def dispatch_first(event, *args)
+    value = nil
+    map do |plugin| 
+      value = plugin.send(event, *args) 
+      break if value
+    end
+    value
+  end
+
   alias :dispatch_scopes :dispatch_without_flatten
  
   def enabled_plugins
     @enabled_plugins ||= (Noosfero::Plugin.all & environment.enabled_plugins).map do |plugin|
-      p = plugin.constantize.new
-      p.context = context
-      p
+      plugin.constantize.new(context)
     end
   end
  
@@ -0,0 +1,16 @@
+class CommentGroupMacroPluginProfileController < ProfileController
+  append_view_path File.join(File.dirname(__FILE__) + '/../views')
+
+  def view_comments
+    article_id = params[:article_id]
+    group_id = params[:group_id]
+    
+    article = profile.articles.find(article_id)
+    comments = article.group_comments.without_spam.in_group(group_id)
+    render :update do |page|
+      page.replace_html "comments_list_group_#{group_id}", :partial => 'comment/comment.rhtml', :collection => comments.as_thread
+      page.replace_html "comment-count-#{group_id}", comments.count
+    end
+  end
+
+end
@@ -0,0 +1,9 @@
+class AddGroupIdToComment < ActiveRecord::Migration
+  def self.up
+    add_column :comments, :group_id, :integer
+  end
+
+  def self.down
+    remove_column :comments, :group_id
+  end
+end
@@ -0,0 +1,44 @@
+require_dependency 'comment_group_macro_plugin/ext/article'
+require_dependency 'comment_group_macro_plugin/ext/comment'
+
+#FIXME See a better way to generalize this parameter.
+ActionView::Base.sanitized_allowed_attributes += ['data-macro', 'data-macro-group_id']
+
+class CommentGroupMacroPlugin < Noosfero::Plugin
+
+  def self.plugin_name
+    "Comment Group"
+  end
+
+  def self.plugin_description
+    _("A plugin that display comment groups.")
+  end
+
+  def load_comments(article)
+    article.comments.without_spam.without_group.as_thread
+  end
+
+  #FIXME make this test
+  def macro_display_comments(params, inner_html, source)
+    group_id = params[:group_id].to_i
+    article = source
+    count = article.group_comments.without_spam.in_group(group_id).count
+
+    lambda {render :partial => 'plugins/comment_group_macro/views/comment_group.rhtml', :locals => {:group_id => group_id, :article_id => article.id, :inner_html => inner_html, :count => count }}
+  end
+
+  def macro_methods
+    'macro_display_comments'
+  end
+
+  def config_macro_display_comments
+    { :params => [], :skip_dialog => true, :generator => 'makeCommentable();', :js_files => 'comment_group.js', :icon_path => '/designs/icons/tango/Tango/16x16/emblems/emblem-system.png', :css_files => 'comment_group.css' }
+  end
+
+  def comment_form_extra_contents(args)
+    lambda {
+      hidden_field_tag('comment[group_id]', args[:group_id]) if args.has_key?(:group_id)
+    }
+  end
+
+end
@@ -0,0 +1,21 @@
+require_dependency 'article'
+
+class Article
+
+  #FIXME make this test 
+  has_many :group_comments, :class_name => 'Comment', :foreign_key => 'source_id', :dependent => :destroy, :order => 'created_at asc', :conditions => [ 'group_id IS NOT NULL']
+
+  #FIXME make this test 
+  validate :not_empty_group_comments_removed
+
+  #FIXME make this test 
+  def not_empty_group_comments_removed
+    if body
+      groups_with_comments = group_comments.collect {|comment| comment.group_id}.uniq
+      groups = Hpricot(body.to_s).search('.macro').collect{|element| element['data-macro-group_id'].to_i}
+      errors.add_to_base(N_('Not empty group comment cannot be removed')) unless (groups_with_comments-groups).empty?
+    end
+  end
+
+end
+
@@ -0,0 +1,12 @@
+require_dependency 'comment'
+
+class Comment
+
+  named_scope :without_group, :conditions => {:group_id => nil }
+
+  named_scope :in_group, lambda { |group_id| {
+      :conditions => ['group_id = ?', group_id]
+    }
+  }
+
+end
@@ -0,0 +1,6 @@
+div.article_comments {
+  background-color:#dddddd;
+  border-style: solid;
+  border-color:#bbbbbb;
+  border-width:2px;
+}
@@ -0,0 +1,47 @@
+function getNextGroupId() {
+  max = -1;
+  groups = jQuery('#article_body_ifr').contents().find('.article_comments');
+  groups.each(function(key, value) {
+    value = jQuery(value).attr('data-macro-group_id');
+    if(value>max) max = parseInt(value);
+  });
+  return max+1;
+}
+
+function makeCommentable() {
+  tinyMCE.activeEditor.focus();
+  start = jQuery(tinyMCE.activeEditor.selection.getStart()).closest('p');
+  end = jQuery(tinyMCE.activeEditor.selection.getEnd()).closest('p');
+
+  //text = start.parent().children();
+  text = jQuery('#article_body_ifr').contents().find('*');
+  selection = text.slice(text.index(start), text.index(end)+1);
+  
+  hasTag = false;
+  selection.each(function(key, value) {
+    commentTag = jQuery(value).closest('.article_comments');
+    if(commentTag.length) {
+      commentTag.children().unwrap('<div class=\"article_comments\"/>');
+      hasTag = true;
+    }
+  });
+
+  if(!hasTag) {
+    tags = start.siblings().add(start);
+    tags = tags.slice(tags.index(start), tags.index(end)>=0?tags.index(end)+1:tags.index(start)+1);
+    tags.wrapAll('<div class=\"macro article_comments\" data-macro=\"display_comments\" data-macro-group_id=\"'+getNextGroupId()+'\"/>');
+
+    contents = jQuery('#article_body_ifr').contents();
+    lastP = contents.find('p.article_comments_last_paragraph');
+    if(lastP.text().trim().length > 0) {
+      lastP.removeClass('article_comments_last_paragraph');
+    } else {
+      lastP.remove();
+    }
+    lastDiv = contents.find('div.article_comments').last();
+    if(lastDiv.next().length==0) {
+      lastDiv.after("<p class='article_comments_last_paragraph'>&nbsp;</p>");
+    }
+  }
+}
+
@@ -0,0 +1,38 @@
+require File.dirname(__FILE__) + '/../../../../test/test_helper'
+require File.dirname(__FILE__) + '/../../controllers/profile/comment_group_macro_plugin_profile_controller'
+
+# Re-raise errors caught by the controller.
+class CommentGroupMacroPluginProfileController; def rescue_action(e) raise e end; end
+
+class CommentGroupMacroPluginProfileControllerTest < ActionController::TestCase
+
+  def setup
+    @controller = CommentGroupMacroPluginProfileController.new
+    @request    = ActionController::TestRequest.new
+    @response   = ActionController::TestResponse.new
+
+    @profile = create_user('testuser').person
+    @article = profile.articles.build(:name => 'test')
+    @article.save!
+  end
+  attr_reader :article
+  attr_reader :profile
+
+  should 'be able to show group comments' do
+    comment = fast_create(Comment, :source_id => article, :author_id => profile, :title => 'a comment', :body => 'lalala', :group_id => 0)
+    xhr :get, :view_comments, :profile => @profile.identifier, :article_id => article.id, :group_id => 0
+    assert_template 'comment/_comment.rhtml'
+    assert_match /comments_list_group_0/, @response.body
+    assert_match /\"comment-count-0\", \"1\"/, @response.body
+  end
+  
+  should 'do not show global comments' do
+    comment = fast_create(Comment, :source_id => article, :author_id => profile, :title => 'global comment', :body => 'global', :group_id => nil)
+    comment = fast_create(Comment, :source_id => article, :author_id => profile, :title => 'a comment', :body => 'lalala', :group_id => 0)
+    xhr :get, :view_comments, :profile => @profile.identifier, :article_id => article.id, :group_id => 0
+    assert_template 'comment/_comment.rhtml'
+    assert_match /comments_list_group_0/, @response.body
+    assert_match /\"comment-count-0\", \"1\"/, @response.body
+  end
+  
+end
@@ -0,0 +1,81 @@
+require File.dirname(__FILE__) + '/../../../../test/test_helper'
+
+class CommentGroupMacroPluginTest < ActiveSupport::TestCase
+
+  include Noosfero::Plugin::HotSpot
+
+  def setup
+    @environment = Environment.default
+  end
+ 
+  attr_reader :environment
+
+  should 'register comment_group_macro in environment' do
+    Environment.macros = {}
+    Environment.macros[environment.id] = {}
+    macros = Environment.macros[environment.id]
+    context = mock()
+    context.stubs(:environment).returns(environment)
+    plugin = CommentGroupMacroPlugin.new(context)
+    assert_equal ['macro_display_comments'], macros.keys
+  end
+
+  should 'load_comments returns all the comments wihout group of an article passed as parameter' do
+    article = fast_create(Article)
+    c1 = fast_create(Comment, :source_id => article.id, :group_id => 1)
+    c2 = fast_create(Comment, :source_id => article.id)
+    c3 = fast_create(Comment, :source_id => article.id)
+
+    plugin = CommentGroupMacroPlugin.new
+    assert_equal [], [c2, c3] - plugin.load_comments(article)
+    assert_equal [], plugin.load_comments(article) - [c2, c3]
+  end
+ 
+  should 'load_comments not returns spam comments' do
+    article = fast_create(Article)
+    c1 = fast_create(Comment, :source_id => article.id, :group_id => 1)
+    c2 = fast_create(Comment, :source_id => article.id)
+    c3 = fast_create(Comment, :source_id => article.id, :spam => true)
+
+    plugin = CommentGroupMacroPlugin.new
+    assert_equal [], [c2] - plugin.load_comments(article)
+    assert_equal [], plugin.load_comments(article) - [c2]
+  end
+ 
+  should 'load_comments returns only root comments of article' do
+    article = fast_create(Article)
+    c1 = fast_create(Comment, :source_id => article.id, :group_id => 1)
+    c2 = fast_create(Comment, :source_id => article.id)
+    c3 = fast_create(Comment, :source_id => article.id, :reply_of_id => c2.id)
+
+    plugin = CommentGroupMacroPlugin.new
+    assert_equal [], [c2] - plugin.load_comments(article)
+    assert_equal [], plugin.load_comments(article) - [c2]
+  end
+
+  should 'params of macro display comments configuration be an empty array' do
+    plugin = CommentGroupMacroPlugin.new
+    assert_equal [], plugin.config_macro_display_comments[:params]
+  end
+
+  should 'skip_dialog of macro display comments configuration be true' do
+    plugin = CommentGroupMacroPlugin.new
+    assert plugin.config_macro_display_comments[:skip_dialog]
+  end
+
+  should 'generator of macro display comments configuration be the makeCommentable function' do
+    plugin = CommentGroupMacroPlugin.new
+    assert_equal 'makeCommentable();', plugin.config_macro_display_comments[:generator]
+  end
+ 
+  should 'js_files of macro display comments configuration return comment_group.js' do
+    plugin = CommentGroupMacroPlugin.new
+    assert_equal 'comment_group.js', plugin.config_macro_display_comments[:js_files]
+  end
+  
+  should 'css_files of macro display comments configuration return comment_group.css' do
+    plugin = CommentGroupMacroPlugin.new
+    assert_equal 'comment_group.css', plugin.config_macro_display_comments[:css_files]
+  end
+ 
+end
@@ -0,0 +1,47 @@
+<div class="comments">
+  <div class="comment_group_<%= group_id %>" style="float: left">
+    <div style="float: left">
+    <%= link_to_remote(image_tag("/plugins/comment_group_macro/images/comments.gif"),
+        :url => { :controller => 'comment_group_macro_plugin_profile', :action => 'view_comments', :group_id => group_id, :article_id => article_id},
+        :loaded => visual_effect(:highlight, "comments_list_group_#{group_id}"),
+        :method => :post,
+        :condition => "!groupVisible(#{group_id})",
+        :complete => "jQuery('div.comment-group-loading-#{group_id}').removeClass('comment-button-loading')")%>
+    </div>
+    <!-- FIXME: css file -->
+    <div id="comments_group_count_<%= group_id %>" style="float: right; vertical-align: middle; padding-left: 3px; padding-right: 5px; color: #5AC1FC"><span id="comment-count-<%= group_id %>" class='comment-count'><%= count %></span></div>
+
+  </div>
+
+  <div>
+    <%= inner_html %>
+  </div>
+
+  <div class="comment-group-loading-<%= group_id %>"/>
+
+  <div class="comments_list_toggle_group_<%= group_id %>" style="display:none">
+    <div class="article-comments-list">
+      <div id="comments_list_group_<%= group_id %>"></div>
+    </div>
+
+    <div id="page-comment-form-<%= group_id %>" class='post_comment_box closed'><%= render :partial => 'comment/comment_form', :locals => {:comment => Comment.new, :display_link => true, :cancel_triggers_hide => true, :group_id => group_id}%></div>
+
+  </div>
+
+  <script type="text/javascript">
+    function groupVisible(group) {
+      return jQuery('div.comments_list_toggle_group_'+group).is(':visible');
+    }
+
+    (function($) {
+      var button = $('div.comment_group_<%= group_id %> a');
+      button.click(function() {
+        var div = $('div.comments_list_toggle_group_<%= group_id %>')
+        if(!div.is(':visible')) 
+          $('div.comment-group-loading-<%= group_id %>').addClass('comment-button-loading');
+        div.toggle('fast');
+      });
+    })(jQuery) 
+  </script>
+</div>
+
@@ -12,12 +12,14 @@ class SendEmailPlugin &lt; Noosfero::Plugin
     true
   end
  
-  def parse_content(raw_content)
+  def parse_content(args)
+    raw_content = args[:html]
     if context.profile
       raw_content.gsub(/\{sendemail\}/, "/profile/#{context.profile.identifier}/plugins/send_email/deliver")
     else
       raw_content.gsub(/\{sendemail\}/, '/plugin/send_email/deliver')
     end
+    args.clone.merge({:html => raw_content})
   end
  
 end
@@ -1229,4 +1229,118 @@ class ContentViewerControllerTest &lt; ActionController::TestCase
     assert_equal 1, assigns(:comments_count)
   end
  
+  should 'add extra content on comment form from plugins' do
+    class Plugin1 < Noosfero::Plugin
+      def comment_form_extra_contents(args)
+        lambda {
+          hidden_field_tag('comment[some_field_id]', 1)
+         }
+      end
+    end
+    class Plugin2 < Noosfero::Plugin
+      def comment_form_extra_contents(args)
+        lambda {
+          hidden_field_tag('comment[another_field_id]', 1)
+         }
+      end
+    end
+
+    Environment.default.enable_plugin(Plugin1.name)
+    Environment.default.enable_plugin(Plugin2.name)
+
+    page = profile.articles.create!(:name => 'myarticle', :body => 'the body of the text')
+
+    get :view_page, :profile => profile.identifier, :page => [ 'myarticle' ]
+
+    assert_tag :tag => 'input', :attributes => {:name => 'comment[some_field_id]', :type => 'hidden'}
+    assert_tag :tag => 'input', :attributes => {:name => 'comment[another_field_id]', :type => 'hidden'}
+  end
+
+  should 'collect comments as plugin definition' do
+    class Plugin1 < Noosfero::Plugin
+      def load_comments(page)
+        [page.comments.find(4)]
+      end
+    end
+    Environment.default.enable_plugin(Plugin1.name)
+    Comment.delete_all
+    page = profile.articles.create!(:name => 'myarticle', :body => 'the body of the text')
+    page.comments.build(:author => profile, :title => 'hi', :body => 'hello 1' ).save!
+    page.comments.build(:author => profile, :title => 'hi', :body => 'hello 2' ).save!
+    page.comments.build(:author => profile, :title => 'hi', :body => 'hello 3' ).save!
+    c = page.comments.build(:author => profile, :title => 'hi', :body => 'hello 4' )
+    c.save!
+
+
+    get :view_page, :profile => profile.identifier, :page => [ 'myarticle' ]
+
+    assert_equal [c],  assigns(:comments)
+  end
+
+  should 'not be a problem if loaded comments of plugins not be an array' do
+    class Plugin1 < Noosfero::Plugin
+      def load_comments(page)
+        page.comments.find(4)
+      end
+    end
+    Environment.default.enable_plugin(Plugin1.name)
+    Comment.delete_all
+    page = profile.articles.create!(:name => 'myarticle', :body => 'the body of the text')
+    page.comments.build(:author => profile, :title => 'hi', :body => 'hello 1' ).save!
+    page.comments.build(:author => profile, :title => 'hi', :body => 'hello 2' ).save!
+    page.comments.build(:author => profile, :title => 'hi', :body => 'hello 3' ).save!
+    c = page.comments.build(:author => profile, :title => 'hi', :body => 'hello 4' )
+    c.save!
+
+
+    get :view_page, :profile => profile.identifier, :page => [ 'myarticle' ]
+
+    assert_equal [c],  assigns(:comments)
+  end
+
+
+  should 'take in consideration only the first plugin comments definition' do
+    class Plugin1 < Noosfero::Plugin
+      def load_comments(page)
+        page.comments.first
+      end
+    end
+    class Plugin2 < Noosfero::Plugin
+      def load_comments(page)
+        page.comments.last
+      end
+    end
+    Environment.default.enable_plugin(Plugin1.name)
+    Environment.default.enable_plugin(Plugin2.name)
+
+    page = profile.articles.create!(:name => 'myarticle', :body => 'the body of the text')
+    c1 = page.comments.build(:author => profile, :title => 'hi', :body => 'hello 1' )
+    c1.save!
+    page.comments.build(:author => profile, :title => 'hi', :body => 'hello 2' ).save!
+    page.comments.build(:author => profile, :title => 'hi', :body => 'hello 3' ).save!
+    c2 = page.comments.build(:author => profile, :title => 'hi', :body => 'hello 4' )
+    c2.save!
+
+    get :view_page, :profile => profile.identifier, :page => [ 'myarticle' ]
+
+    assert_equal [c1],  assigns(:comments)
+  end
+
+  should 'empty array of comments collected by plugin make the comments variable be an empty array' do
+    class Plugin1 < Noosfero::Plugin
+      def load_comments(page)
+        []
+      end
+    end
+    Environment.default.enable_plugin(Plugin1.name)
+
+    page = profile.articles.create!(:name => 'myarticle', :body => 'the body of the text')
+    page.comments.build(:author => profile, :title => 'hi', :body => 'hello 1' ).save!
+    page.comments.build(:author => profile, :title => 'hi', :body => 'hello 2' ).save!
+
+
+    get :view_page, :profile => profile.identifier, :page => [ 'myarticle' ]
+
+    assert_equal [],  assigns(:comments)
+  end
 end
@@ -3,6 +3,7 @@ require File.dirname(__FILE__) + &#39;/../test_helper&#39;
 class ApplicationHelperTest < ActiveSupport::TestCase
  
   include ApplicationHelper
+  include Noosfero::Plugin::HotSpot
  
   def setup
     self.stubs(:session).returns({})
@@ -657,6 +658,45 @@ class ApplicationHelperTest &lt; ActiveSupport::TestCase
     assert_not_nil add_zoom_to_images
   end
  
+  should 'parse macros' do
+    class Plugin1 < Noosfero::Plugin
+      def macro_test1(params, inner_html, source)
+        'Test1'
+      end
+      def macro_test2(params, inner_html, source)
+        'Test2'
+      end
+
+      def macro_methods
+        ['macro_test1', 'macro_test2']
+      end
+    end
+
+    @environment = Environment.default
+    Environment.macros = {@environment.id => {}}
+    context = mock()
+    context.stubs(:environment).returns(@environment)
+    Plugin1.new(context)
+    html = '
+      <div class="macro nonEdit" data-macro="test1" data-macro-param="123"></div>
+      <div class="macro nonEdit" data-macro="test2"></div>
+      <div class="macro nonEdit" data-macro="unexistent" data-macro-param="987"></div>
+    '
+    parsed_html = convert_macro(html, mock())
+    parsed_divs = Hpricot(parsed_html).search('div')
+    expected_divs = Hpricot('
+      <div data-macro="test1" class="parsed-macro test1">Test1</div>
+      <div data-macro="test2" class="parsed-macro test2">Test2</div>
+      <div data-macro="unexistent" class="failed-macro unexistent">Unsupported macro unexistent!</div>
+    ').search('div')
+
+    # comparing div attributes between parsed and expected html 
+    parsed_divs.each_with_index do |div, i|
+      assert_equal expected_divs[i].attributes.to_hash, div.attributes.to_hash
+      assert_equal expected_divs[i].inner_text, div.inner_text
+    end
+  end
+
   protected
   include NoosferoTestHelper
  
@@ -571,6 +571,21 @@ class CommentTest &lt; ActiveSupport::TestCase
     SpammerLogger.clean_log
   end
  
+  should 'count a thread of comments' do
+    Comment.delete_all
+    comments = []
+    comments.push(create_comment)
+    c1 = create_comment
+    comments.push(c1)
+    create_comment(:reply_of_id => c1.id)
+    create_comment(:reply_of_id => c1.id)
+    c2 = create_comment
+    comments.push(c2)
+    create_comment(:reply_of_id => c2.id)
+   
+    assert_equal 6, Comment.count_thread(comments)
+  end
+
   private
  
   def create_comment(args = {})
@@ -0,0 +1,124 @@
+require File.dirname(__FILE__) + '/../test_helper'
+
+class MacrosHelperTest < ActiveSupport::TestCase
+  include MacrosHelper
+  include ApplicationHelper
+  include ActionView::Helpers::FormOptionsHelper
+  include ActionView::Helpers::FormTagHelper
+  include ActionView::Helpers::TagHelper
+
+  CONFIG = {
+    :params => [
+      { :name => :identifier, :type => 'text'},
+      { :name => :size, :type => 'select',
+        :values => [
+          [_('Big'), :big],
+          [_('Icon'), :icon],
+          [_('Minor'), :minor],
+          [_('Portrait'), :portrait],
+          [_('Thumb'), :thumb]
+        ],
+        :default => :portrait
+      }
+    ],
+    :title => _('Profile Image Link')
+  }
+
+  should 'generate html for macro configuration' do
+    @environment = Environment.default
+    Environment.macros = {}
+    macros = Environment.macros[@environment.id] = {}
+    plugin_instance = mock
+    plugin_instance.stubs('config_macro_example').returns(CONFIG)
+    macros['macro_example'] = plugin_instance
+    html = macro_configuration_dialog('macro_example')
+    assert_tag_in_string html, :tag => 'label', :content => _('Identifier')
+    assert_tag_in_string html, :tag => 'input', :attributes => {:name => 'identifier'}
+    assert_tag_in_string html, :tag => 'label', :content => 'size'.humanize
+    assert_tag_in_string html, :tag => 'select', :attributes => {:name => 'size'}, :descendant => {:tag => 'option', :attributes => {:value => 'big'}, :content => _('Big')}
+    assert_tag_in_string html, :tag => 'select', :attributes => {:name => 'size'}, :descendant => {:tag => 'option', :attributes => {:value => 'icon'}, :content => _('Icon')}
+    assert_tag_in_string html, :tag => 'select', :attributes => {:name => 'size'}, :descendant => {:tag => 'option', :attributes => {:value => 'minor'}, :content => _('Minor')}
+    assert_tag_in_string html, :tag => 'select', :attributes => {:name => 'size'}, :descendant => {:tag => 'option', :attributes => {:value => 'portrait', :selected => true}, :content => _('Portrait')}
+    assert_tag_in_string html, :tag => 'select', :attributes => {:name => 'size'}, :descendant => {:tag => 'option', :attributes => {:value => 'thumb'}, :content => _('Thumb')}
+  end
+
+  should 'get macro title' do
+    @environment = Environment.default
+    Environment.macros = {}
+    macros = Environment.macros[@environment.id] = {}
+    plugin_instance = mock
+    plugin_instance.stubs('config_macro_example').returns(CONFIG)
+    macros['macro_example'] = plugin_instance
+    title = macro_title('macro_example')
+    assert _('Profile Image Link'), title
+  end
+
+  should 'get only macros in menu' do
+    @environment = Environment.default
+    Environment.macros = {}
+    macros = Environment.macros[@environment.id] = {}
+    plugin_instance = mock
+    plugin_instance.stubs('config_macro_example').returns({})
+    macros['macro_example'] = plugin_instance
+    plugin_instance_other = mock
+    plugin_instance_other.stubs('config_macro_example_other').returns({:icon_path => 'icon.png'})
+    macros['macro_example_other'] = plugin_instance_other
+    assert_equal [plugin_instance], macros_in_menu.values
+  end
+
+  should 'get only macros with buttons' do
+    @environment = Environment.default
+    Environment.macros = {}
+    macros = Environment.macros[@environment.id] = {}
+    plugin_instance = mock
+    plugin_instance.stubs('config_macro_example').returns({})
+    macros['macro_example'] = plugin_instance
+    plugin_instance_other = mock
+    plugin_instance_other.stubs('config_macro_example_other').returns({:icon_path => 'icon.png'})
+    macros['macro_example_other'] = plugin_instance_other
+    assert_equal [plugin_instance_other], macros_with_buttons.values
+  end
+
+  should 'skip macro config dialog and call generator directly' do
+    @environment = Environment.default
+    Environment.macros = {}
+    macros = Environment.macros[@environment.id] = {}
+    plugin_instance = mock
+    plugin_instance.stubs('config_macro_example').returns({:skip_dialog => true, :generator => '', :params => [] })
+    macros['macro_example'] = plugin_instance
+    assert_equal 'function(){}', generate_macro_config_dialog('macro_example')
+  end
+
+  should 'include js files' do
+    @environment = Environment.default
+    Environment.macros = {}
+    macros = Environment.macros[@environment.id] = {}
+    plugin_instance = mock
+    plugin_instance.stubs('config_macro_example').returns({:js_files => 'macro.js' })
+    plugin_instance.class.stubs(:public_path).with('macro.js').returns('macro.js')
+    macros['macro_example'] = plugin_instance
+    assert_equal '<script src="/javascripts/macro.js" type="text/javascript"></script>', include_macro_js_files
+  end
+  
+  should 'get macro css files' do
+    @environment = Environment.default
+    Environment.macros = {}
+    macros = Environment.macros[@environment.id] = {}
+    plugin_instance = mock
+    plugin_instance.stubs('config_macro_example').returns({:css_files => 'macro.css' })
+    plugin_instance.class.stubs(:public_path).with('macro.css').returns('macro.css')
+    macros['macro_example'] = plugin_instance
+    assert_equal 'macro.css', macro_css_files
+  end
+  
+  should 'get macro specific generator' do
+    @environment = Environment.default
+    Environment.macros = {}
+    macros = Environment.macros[@environment.id] = {}
+    plugin_instance = mock
+    plugin_instance.stubs('config_macro_example').returns({:generator => 'macro_generator' })
+    macros['macro_example'] = plugin_instance
+    assert_equal 'macro_generator', macro_generator('macro_example')
+  end
+
+end
@@ -2,22 +2,12 @@ require File.dirname(__FILE__) + &#39;/../test_helper&#39;
  
 class PluginManagerTest < ActiveSupport::TestCase
  
+  include Noosfero::Plugin::HotSpot
+
   def setup
     @environment = Environment.default
-    @controller = mock()
-    @controller.stubs(:profile).returns()
-    @controller.stubs(:request).returns()
-    @controller.stubs(:response).returns()
-    @controller.stubs(:params).returns()
-    @manager = Noosfero::Plugin::Manager.new(@environment, @controller)
   end
   attr_reader :environment
-  attr_reader :manager
-
-  should 'give access to environment and context' do
-    assert_same @environment, @manager.environment
-    assert_same @controller, @manager.context
-  end
  
   should 'return the intersection between environment\'s enabled plugins and system available plugins' do
     class Plugin1 < Noosfero::Plugin; end;
@@ -26,8 +16,8 @@ class PluginManagerTest &lt; ActiveSupport::TestCase
     class Plugin4 < Noosfero::Plugin; end;
     environment.stubs(:enabled_plugins).returns([Plugin1.to_s, Plugin2.to_s, Plugin4.to_s])
     Noosfero::Plugin.stubs(:all).returns([Plugin1.to_s, Plugin3.to_s, Plugin4.to_s])
-    plugins = manager.enabled_plugins.map { |instance| instance.class.to_s }
-    assert_equal [Plugin1.to_s, Plugin4.to_s], plugins
+    results = plugins.enabled_plugins.map { |instance| instance.class.to_s }
+    assert_equal [Plugin1.to_s, Plugin4.to_s], results
   end
  
   should 'map events to registered plugins' do
@@ -55,8 +45,62 @@ class PluginManagerTest &lt; ActiveSupport::TestCase
     p1 = Plugin1.new
     p2 = Plugin2.new
  
-    assert_equal [p1.random_event, p2.random_event], manager.dispatch(:random_event)
+    assert_equal [p1.random_event, p2.random_event], plugins.dispatch(:random_event)
+  end
+
+  should 'dispatch_first method returns the first plugin response if there is many plugins to responde the event' do
+
+    class Plugin1 < Noosfero::Plugin
+      def random_event
+        'Plugin 1 action.'
+      end
+    end
+
+    class Plugin2 < Noosfero::Plugin
+      def random_event
+        'Plugin 2 action.'
+      end
+    end
+
+    class Plugin3 < Noosfero::Plugin
+      def random_event
+        'Plugin 3 action.'
+      end
+    end
+
+    environment.stubs(:enabled_plugins).returns([Plugin1.to_s, Plugin2.to_s, Plugin3.to_s])
+    p1 = Plugin1.new
+
+    assert_equal p1.random_event, plugins.dispatch_first(:random_event)
   end
  
+  should 'dispatch_first method returns the first plugin response if there is many plugins to responde the event and the first one respond nil' do
+
+    class Plugin1 < Noosfero::Plugin
+      def random_event
+        nil
+      end
+    end
+
+    class Plugin2 < Noosfero::Plugin
+      def random_event
+        'Plugin 2 action.'
+      end
+    end
+
+    class Plugin3 < Noosfero::Plugin
+      def random_event
+        'Plugin 3 action.'
+      end
+    end
+
+    environment.stubs(:enabled_plugins).returns([Plugin1.to_s, Plugin2.to_s, Plugin3.to_s])
+
+    p2 = Plugin2.new
+
+    assert_equal p2.random_event, plugins.dispatch_first(:random_event)
+  end
+
+
 end
  
@@ -7,6 +7,8 @@ class PluginTest &lt; ActiveSupport::TestCase
   end
   attr_reader :environment
  
+  include Noosfero::Plugin::HotSpot
+
   should 'keep the list of all loaded subclasses' do
     class Plugin1 < Noosfero::Plugin
     end
@@ -26,4 +28,59 @@ class PluginTest &lt; ActiveSupport::TestCase
     assert_equal({:controller => 'plugin_test/plugin1_admin', :action => 'index'}, Plugin1.admin_url)
   end
  
+  should 'register its macros in the environment when instantiated' do
+    class Plugin1 < Noosfero::Plugin
+      def macro_example1(params, inner_html, source)
+      end
+
+      def example2(params, inner_html, source)
+      end
+
+      def not_macro
+      end
+
+      def macro_methods
+        ['macro_example1', 'example2']
+      end
+    end
+    
+    Environment.macros = {}
+    Environment.macros[environment.id] = {}
+    macros = Environment.macros[environment.id]
+    context = mock()
+    context.stubs(:environment).returns(environment)
+
+    plugin_instance = Plugin1.new(context)
+
+    assert_equal plugin_instance, macros['macro_example1']
+    assert_equal plugin_instance, macros['example2']
+    assert_nil macros['not_macro']
+  end
+
+  should 'load_comments return nil by default' do
+
+    class Plugin1 < Noosfero::Plugin; end;
+
+    environment.stubs(:enabled_plugins).returns([Plugin1.to_s])
+
+    profile = fast_create(Profile, :name => 'test profile', :identifier => 'test_profile')
+    a = fast_create(Article, :name => 'my article', :profile_id => profile.id)
+    assert_nil plugins.dispatch_first(:load_comments, a)
+  end
+
+  should 'load_comments return the value defined by plugin' do
+
+    class Plugin1 < Noosfero::Plugin
+      def load_comments(page)
+        'some value'
+      end
+    end
+
+    environment.stubs(:enabled_plugins).returns([Plugin1.to_s])
+
+    profile = fast_create(Profile, :name => 'test profile', :identifier => 'test_profile')
+    a = fast_create(Article, :name => 'my article', :profile_id => profile.id)
+    assert_equal 'some value', plugins.dispatch_first(:load_comments, a)
+  end
+
 end
...	...	@@ -98,10 +98,13 @@ class ContentViewerController < ApplicationController
98	98	session[:notice] = _("Notification of new comments to '%s' was successfully canceled") % params[:email]
99	99	end
100	100	end
	101	+
	102	+ @comments = @plugins.dispatch_first(:load_comments, @page)
	103	+ @comments \|\|= @page.comments.without_spam.as_thread
	104	+ @comments = [@comments] unless @comments.is_a?(Array)
	105	+
	106	+ @comments_count = Comment.count_thread(@comments)
101	107
102		- comments = @page.comments.without_spam
103		- @comments = comments.as_thread
104		- @comments_count = comments.count
105	108	if params[:slideshow]
106	109	render :action => 'slideshow', :layout => 'slideshow'
107	110	end
...	...
...	...	@@ -988,10 +988,7 @@ module ApplicationHelper
988	988	options.merge!(:page => params[:npage])
989	989	content = article.to_html(options)
990	990	content = content.kind_of?(Proc) ? self.instance_eval(&content) : content
991		- @plugins && @plugins.each do \|plugin\|
992		- content = plugin.parse_content(content)
993		- end
994		- content
	991	+ filter_html(content, article)
995	992	end
996	993
997	994	def colorpicker_field(object_name, method, options = {})
...	...	@@ -1425,4 +1422,36 @@ module ApplicationHelper
1425	1422	@no_design_blocks = true
1426	1423	end
1427	1424
	1425	+ def filter_html(html, source)
	1426	+ if @plugins
	1427	+ html = convert_macro(html, source)
	1428	+ end
	1429	+ html
	1430	+ end
	1431	+
	1432	+ def convert_macro(html, source)
	1433	+ doc = Hpricot(html)
	1434	+ while element = doc.search('.macro').first
	1435	+ macro_name = element['data-macro']
	1436	+ method_name = "macro_#{macro_name}"
	1437	+ attrs = collect_macro_attributes(element)
	1438	+ plugin_instance = Environment.macros[environment.id][method_name]
	1439	+ if plugin_instance
	1440	+ result = plugin_instance.send(method_name, attrs, element.inner_html, source)
	1441	+ element.inner_html = result.kind_of?(Proc) ? self.instance_eval(&result) : result
	1442	+ element['class'] = "parsed-macro #{macro_name}"
	1443	+ else
	1444	+ element.inner_html = _("Unsupported macro %s!") % macro_name
	1445	+ element['class'] = "failed-macro #{macro_name}"
	1446	+ end
	1447	+ attrs.each {\|key, value\| element.remove_attribute("data-macro-#{key}")}
	1448	+ end
	1449	+ doc.html
	1450	+ end
	1451	+
	1452	+ def collect_macro_attributes(element)
	1453	+ element.attributes.to_hash.select {\|key, value\| key[0..10] == 'data-macro-'}.
	1454	+ inject({}){\|result, a\| result.merge({a[0][11..-1] => a[1]})}.with_indifferent_access
	1455	+ end
	1456	+
1428	1457	end
...	...
...	...	@@ -99,8 +99,8 @@ module BoxesHelper
99	99	unless block.visible?
100	100	options[:title] = _("This block is invisible. Your visitors will not see it.")
101	101	end
102		- @controller.send(:content_editor?) \|\| @plugins.each do \|plugin\|
103		- result = plugin.parse_content(result)
	102	+ if @controller.send(:content_editor?)
	103	+ result = filter_html(result, block)
104	104	end
105	105	box_decorator.block_target(block.box, block) +
106	106	content_tag('div',
...	...
...	...	@@ -0,0 +1,96 @@
	1	+module MacrosHelper
	2	+
	3	+ def macros_in_menu
	4	+ Environment.macros[@environment.id].reject{ \|macro_name, plugin_instance\| macro_configuration(macro_name)[:icon_path] }
	5	+ end
	6	+
	7	+ def macros_with_buttons
	8	+ Environment.macros[@environment.id].reject{ \|macro_name, plugin_instance\| !macro_configuration(macro_name)[:icon_path] }
	9	+ end
	10	+
	11	+ def macro_configuration(macro_name)
	12	+ plugin_instance = Environment.macros[@environment.id][macro_name]
	13	+ plugin_instance.send("config_#{macro_name}")
	14	+ end
	15	+
	16	+ def macro_title(macro_name)
	17	+ macro_configuration(macro_name)[:title] \|\| macro_name.to_s.humanize
	18	+ end
	19	+
	20	+ def generate_macro_config_dialog(macro_name)
	21	+ if macro_configuration(macro_name)[:skip_dialog]
	22	+ "function(){#{macro_generator(macro_name)}}"
	23	+ else
	24	+ "function(){
	25	+ jQuery('<div>'+#{macro_configuration_dialog(macro_name).to_json}+'</div>').dialog({
	26	+ title: #{macro_title(macro_name).to_json},
	27	+ modal: true,
	28	+ buttons: [
	29	+ {text: #{_('Ok').to_json}, click: function(){
	30	+ tinyMCE.activeEditor.execCommand('mceInsertContent', false,
	31	+ (function(dialog){ #{macro_generator(macro_name)} })(this));
	32	+ jQuery(this).dialog('close');
	33	+ }},
	34	+ {text: #{_('Cancel').to_json}, click: function(){jQuery(this).dialog('close');}}
	35	+ ]
	36	+ });
	37	+ }"
	38	+ end
	39	+ end
	40	+
	41	+ def include_macro_js_files
	42	+ plugins_javascripts = []
	43	+ Environment.macros[environment.id].map do \|macro_name, plugin_instance\|
	44	+ if macro_configuration(macro_name)[:js_files]
	45	+ macro_configuration(macro_name)[:js_files].map { \|js\| plugins_javascripts << plugin_instance.class.public_path(js) }
	46	+ end
	47	+ end
	48	+ javascript_include_tag(plugins_javascripts, :cache => 'cache/plugins-' + Digest::MD5.hexdigest(plugins_javascripts.to_s)) unless plugins_javascripts.empty?
	49	+ end
	50	+
	51	+ def macro_css_files
	52	+ plugins_css = []
	53	+ Environment.macros[environment.id].map do \|macro_name, plugin_instance\|
	54	+ if macro_configuration(macro_name)[:css_files]
	55	+ macro_configuration(macro_name)[:css_files].map { \|css\| plugins_css << plugin_instance.class.public_path(css) }
	56	+ end
	57	+ end
	58	+ plugins_css.join(',')
	59	+ end
	60	+
	61	+ protected
	62	+
	63	+ def macro_generator(macro_name)
	64	+ if macro_configuration(macro_name)[:generator]
	65	+ macro_configuration(macro_name)[:generator]
	66	+ else
	67	+ macro_default_generator(macro_name)
	68	+ end
	69	+ end
	70	+
	71	+ def macro_default_generator(macro_name)
	72	+ code = "var params = {};"
	73	+ configuration = macro_configuration(macro_name)
	74	+ configuration[:params].map do \|field\|
	75	+ code += "params.#{field[:name]} = jQuery('*[name=#{field[:name]}]', dialog).val();"
	76	+ end
	77	+ code + "
	78	+ var html = jQuery('<div class=\"macro mceNonEditable\" data-macro=\"#{macro_name[6..-1]}\">'+#{macro_title(macro_name).to_json}+'</div>')[0];
	79	+ for(key in params) html.setAttribute('data-macro-'+key,params[key]);
	80	+ return html.outerHTML;
	81	+ "
	82	+ end
	83	+
	84	+ def macro_configuration_dialog(macro_name)
	85	+ macro_configuration(macro_name)[:params].map do \|field\|
	86	+ label_name = field[:label] \|\| field[:name].to_s.humanize
	87	+ case field[:type]
	88	+ when 'text'
	89	+ labelled_form_field(label_name, text_field_tag(field[:name], field[:default]))
	90	+ when 'select'
	91	+ labelled_form_field(label_name, select_tag(field[:name], options_for_select(field[:values], field[:default])))
	92	+ end
	93	+ end.join("\n")
	94	+ end
	95	+
	96	+end
...	...
...	...	@@ -157,6 +157,14 @@ class Comment < ActiveRecord::Base
157	157	@replies = comments_list
158	158	end
159	159
	160	+ def self.count_thread(comments)
	161	+ count = comments.length
	162	+ comments.each do \|c\|
	163	+ count+=count_thread(c.replies)
	164	+ end
	165	+ count
	166	+ end
	167	+
160	168	def self.as_thread
161	169	result = {}
162	170	root = []
...	...
...	...	@@ -16,6 +16,10 @@ class Environment < ActiveRecord::Base
16	16	filename
17	17	end
18	18
	19	+ class << self
	20	+ attr_accessor :macros
	21	+ end
	22	+
19	23	PERMISSIONS['Environment'] = {
20	24	'view_environment_admin_panel' => N_('View environment admin panel'),
21	25	'edit_environment_features' => N_('Edit environment features'),
...	...
...	...	@@ -89,6 +89,8 @@ function check_captcha(button, confirm_action) {
89	89	<%= required labelled_form_field(_('Enter your comment'), f.text_area(:body, :rows => 5)) %>
90	90	<%= f.hidden_field(:reply_of_id) %>
91	91
	92	+ <%= @plugins.dispatch(:comment_form_extra_contents, local_assigns).collect { \|content\| instance_eval(&content) }.join("") %>
	93	+
92	94	<% button_bar do %>
93	95	<%= submit_button('add', _('Post comment'), :onclick => "if(check_captcha(this)) { save_comment(this) } else { check_captcha(this, save_comment)};return false;") %>
94	96	<%= button_to_function :cancel, _('Cancel'), "jQuery.colorbox.close();f=jQuery(this).parents('.post_comment_box'); f.removeClass('opened'); f.addClass('closed'); return false" %>
...	...
...	...	@@ -91,7 +91,7 @@
91	91
92	92	<% if @page.accept_comments? \|\| @comments_count > 0 %>
93	93	<h3 <%= 'class="no-comments-yet"' if @comments_count == 0 %>>
94		- <%= number_of_comments(@page) %>
	94	+ <%= display_number_of_comments(@comments_count) %>
95	95	</h3>
96	96	<% end %>
97	97
...	...
	1	+<% extend MacrosHelper %>
1	2	<%= javascript_include_tag 'tinymce/jscripts/tiny_mce/tiny_mce.js' %>
	3	+<%= include_macro_js_files %>
2	4	<script type="text/javascript">
3		- var myplugins = "searchreplace,print,table,contextmenu";
	5	+ var myplugins = "searchreplace,print,table,contextmenu,-macrosPlugin";
4	6	var first_line, second_line;
5	7	var mode = '<%= mode \|\|= false %>'
6	8	<% if mode %>
...	...	@@ -8,36 +10,82 @@
8	10	second_line = ""
9	11	<% else %>
10	12	first_line = "print,separator,copy,paste,separator,undo,redo,separator,search,replace,separator,forecolor,fontsizeselect,formatselect"
11		- second_line = "bold,italic,underline,strikethrough,separator,bullist,numlist,separator,justifyleft,justifycenter,justifyright,justifyfull,separator,link,unlink,image,table,separator,cleanup,code"
	13	+ second_line = "bold,italic,underline,strikethrough,separator,bullist,numlist,separator,justifyleft,justifycenter,justifyright,justifyfull,separator,link,unlink,image,table,separator,cleanup,code,macros"
	14	+ <% Environment.macros[environment.id].each do \|macro_name, plugin_instance\| %>
	15	+ <% if macro_configuration(macro_name)[:icon_path] %>
	16	+ second_line += ',<%=macro_name %>'
	17	+ <% end %>
	18	+ <% end %>
12	19	<% end %>
13	20
14	21	if (tinymce.isIE) {
15	22	// the paste plugin is only useful in Internet Explorer
16	23	myplugins = "paste," + myplugins;
17	24	}
	25	+
	26	+tinymce.create('tinymce.plugins.MacrosPlugin', {
	27	+ createControl: function(n, cm) {
	28	+ switch (n) {
	29	+ case 'macros':
	30	+ <% unless macros_in_menu.empty? %>
	31	+ var c = cm.createMenuButton('macros', {
	32	+ title : 'Macros',
	33	+ image : '/designs/icons/tango/Tango/16x16/emblems/emblem-system.png',
	34	+ icons : false
	35	+ });
	36	+
	37	+ <% macros_in_menu.each do \|macro_name, plugin_instance\| %>
	38	+ c.onRenderMenu.add(function(c, m) {
	39	+ m.add({
	40	+ title: <%= macro_title(macro_name).to_json %>,
	41	+ onclick: <%= generate_macro_config_dialog(macro_name) %>
	42	+ });
	43	+ });
	44	+ <% end %>
	45	+
	46	+ // Return the new menu button instance
	47	+ return c;
	48	+ <% end %>
	49	+ }
	50	+ return null;
	51	+ }
	52	+});
	53	+
	54	+// Register plugin with a short name
	55	+tinymce.PluginManager.add('macrosPlugin', tinymce.plugins.MacrosPlugin);
	56	+
18	57	tinyMCE.init({
19		- mode : "textareas",
20		- editor_selector : "mceEditor",
21		- theme : "advanced",
22		- relative_urls : false,
23		- remove_script_host : true,
24		- document_base_url : <%= environment.top_url.to_json %>,
25		- plugins: myplugins,
26		- theme_advanced_toolbar_location : "top",
27		- theme_advanced_layout_manager: 'SimpleLayout',
28		- theme_advanced_buttons1 : first_line,
29		- theme_advanced_buttons2 : second_line,
30		- theme_advanced_buttons3 : "",
31		- theme_advanced_blockformats :"p,address,pre,h2,h3,h4,h5,h6",
32		- paste_auto_cleanup_on_paste : true,
33		- paste_insert_word_content_callback : "convertWord",
34		- paste_use_dialog: false,
35		- apply_source_formatting : true,
36		- extended_valid_elements : "applet[style\|archive\|codebase\|code\|height\|width],comment,iframe[src\|style\|allowtransparency\|frameborder\|width\|height\|scrolling],embed[title\|src\|type\|height\|width]",
37		- content_css: '/stylesheets/tinymce.css',
38		- language: <%= tinymce_language.inspect %>,
39		- entity_encoding: 'raw'
40		- });
	58	+ mode : "textareas",
	59	+ editor_selector : "mceEditor",
	60	+ theme : "advanced",
	61	+ relative_urls : false,
	62	+ remove_script_host : true,
	63	+ document_base_url : <%= environment.top_url.to_json %>,
	64	+ plugins: myplugins,
	65	+ theme_advanced_toolbar_location : "top",
	66	+ theme_advanced_layout_manager: 'SimpleLayout',
	67	+ theme_advanced_buttons1 : first_line,
	68	+ theme_advanced_buttons2 : second_line,
	69	+ theme_advanced_buttons3 : "",
	70	+ theme_advanced_blockformats :"p,address,pre,h2,h3,h4,h5,h6",
	71	+ paste_auto_cleanup_on_paste : true,
	72	+ paste_insert_word_content_callback : "convertWord",
	73	+ paste_use_dialog: false,
	74	+ apply_source_formatting : true,
	75	+ extended_valid_elements : "applet[style\|archive\|codebase\|code\|height\|width],comment,iframe[src\|style\|allowtransparency\|frameborder\|width\|height\|scrolling],embed[title\|src\|type\|height\|width]",
	76	+ content_css: '/stylesheets/tinymce.css,<%= macro_css_files %>',
	77	+ language: <%= tinymce_language.inspect %>,
	78	+ entity_encoding: 'raw',
	79	+ setup : function(ed) {
	80	+ <% macros_with_buttons.each do \|macro_name, plugin_instance\| %>
	81	+ ed.addButton('<%= macro_name %>', {
	82	+ title: <%= macro_title(macro_name).to_json %>,
	83	+ onclick: <%= generate_macro_config_dialog(macro_name) %>,
	84	+ image : '<%= macro_configuration(macro_name)[:icon_path]%>'
	85	+ });
	86	+ <% end %>
	87	+ }
	88	+});
41	89
42	90	function convertWord(type, content) {
43	91	switch (type) {
...	...
...	...	@@ -5,6 +5,13 @@ class Noosfero::Plugin
5	5
6	6	attr_accessor :context
7	7
	8	+ def initialize(context=nil)
	9	+ self.context = context
	10	+ macro_methods.each do \|method\|
	11	+ Environment.macros[context.environment.id][method] = self unless context.nil?
	12	+ end
	13	+ end
	14	+
8	15	class << self
9	16
10	17	def klass(dir)
...	...	@@ -199,8 +206,8 @@ class Noosfero::Plugin
199	206
200	207	# -> Parse and possibly make changes of content (article, block, etc) during HTML rendering
201	208	# returns = content as string after parser and changes
202		- def parse_content(raw_content)
203		- raw_content
	209	+ def parse_content(args)
	210	+ args
204	211	end
205	212
206	213	# -> Adds links to the admin panel
...	...	@@ -236,6 +243,18 @@ class Noosfero::Plugin
236	243	def filter_comment(comment)
237	244	end
238	245
	246	+ # Define custom logic to load the article comments.
	247	+ #
	248	+ # Example:
	249	+ #
	250	+ # def load_comments(article)
	251	+ # article.comments.find(:all, :conditions => ['spam IS NULL OR spam = ?', false])
	252	+ # end
	253	+ #
	254	+ def load_comments(article)
	255	+ nil
	256	+ end
	257	+
239	258	# This method is called by the CommentHandler background job before sending
240	259	# the notification email. If the comment is marked as spam (i.e. by calling
241	260	# <tt>comment.spam!</tt>), then the notification email will not be sent.
...	...	@@ -288,7 +307,7 @@ class Noosfero::Plugin
288	307	def profile_info_extra_contents
289	308	nil
290	309	end
291		-
	310	+
292	311	# -> Removes the invite friend button from the friends controller
293	312	# returns = boolean
294	313	def remove_invite_friends_button
...	...	@@ -350,6 +369,18 @@ class Noosfero::Plugin
350	369	def login_extra_contents
351	370	nil
352	371	end
	372	+
	373	+ # -> Adds adicional content to comment form
	374	+ # returns = lambda block that creates html code
	375	+ def comment_form_extra_contents(args)
	376	+ nil
	377	+ end
	378	+
	379	+ # -> Register macro methods in environment
	380	+ # returns = ['method1', 'method2', ...]
	381	+ def macro_methods
	382	+ []
	383	+ end
353	384
354	385	def method_missing(method, *args, &block)
355	386	# This is a generic hotspot for all controllers on Noosfero.
...	...	@@ -376,6 +407,11 @@ class Noosfero::Plugin
376	407	# returns = string with reason of expiration
377	408	elsif method.to_s =~ /^content_expire_(#{content_actions.join('\|')})$/
378	409	nil
	410	+ # -> Answers to a specific macro
	411	+ # expects: params, inner_html, content
	412	+ # returns = html_code
	413	+ elsif method.to_s =~ /^macro_(.+)$/
	414	+ nil
379	415	else
380	416	super
381	417	end
...	...