Merge branch 'master' into AI3205-comment-paragraph

Victor Costa
2 parents 584642a3 f5f1059d
Showing 16 changed files with 322 additions and 4 deletions Show diff stats
INSTALL.locales.md
app/controllers/application_controller.rb
app/helpers/layout_helper.rb
app/models/domain.rb
app/views/layouts/application-ng.html.erb
app/views/layouts/application.html.erb
lib/noosfero/i18n.rb
lib/noosfero/plugin.rb
plugins/classify_members/README
plugins/classify_members/controllers/classify_members_plugin_admin_controller.rb
plugins/classify_members/lib/classify_members_plugin.rb
plugins/classify_members/test/functional/classify_members_plugin_test.rb
plugins/classify_members/test/unit/classify_members_plugin_test.rb
plugins/classify_members/views/classify_members_plugin_admin/index.html.erb
script/noosfero-plugins
test/functional/home_controller_test.rb
@@ -0,0 +1,29 @@
+Using custom locales
+====================
+
+Personalized translations go into the `config/custom_locales/` directory.
+Custom locales can be identified by the rails environment, schema name in a
+multitenancy setup or domain name until the first dot (e.g env1.coop.br for the
+example below).
+
+Currently, the only filename prefix for the localization file which is
+processed is "environment". For instance, a POT file would be called
+"environment.pot".
+
+The structure of an environment named env1 with custom translations for both
+Portuguese and Spanish and an environment named env2 with custom Russian
+translation would be:
+
+    config/
+      custom_locales/
+        env1/
+          environment.pot
+          pt/
+            environment.po
+          es/
+            environment.po
+        env2/
+          environment.pot
+          ru/
+            environment.po
+
@@ -127,6 +127,9 @@ class ApplicationController &lt; ActionController::Base
  
   # TODO: move this logic somewhere else (Domain class?)
   def detect_stuff_by_domain
+    # Sets text domain based on request host for custom internationalization
+    FastGettext.text_domain = Domain.custom_locale(request.host)
+
     @domain = Domain.find_by_name(request.host)
     if @domain.nil?
       @environment = Environment.default
@@ -9,6 +9,24 @@ module LayoutHelper
     (!profile.nil? && profile.is_on_homepage?(request.path,@page) ? " profile-homepage" : "")
   end
  
+  def html_tag_classes
+    [
+      body_classes, (
+        profile.blank? ? nil : [
+          'profile-type-is-' + profile.class.name.downcase,
+          'profile-name-is-' + profile.identifier,
+        ]
+      ), 'theme-' + current_theme,
+      @plugins.dispatch(:html_tag_classes).map do |content|
+        if content.respond_to?(:call)
+          instance_exec(&content)
+        else
+          content.html_safe
+        end
+      end
+    ].flatten.compact.join(' ')
+  end
+
   def noosfero_javascript
     plugins_javascripts = @plugins.map { |plugin| [plugin.js_files].flatten.map { |js| plugin.class.public_path(js) } }.flatten
  
@@ -92,4 +92,11 @@ class Domain &lt; ActiveRecord::Base
     @hosting = {}
   end
  
+  # Detects a domain's custom text domain chain if available based on a domain
+  # served on multitenancy configuration or a registered domain.
+  def self.custom_locale(domainname)
+    domain = Noosfero::MultiTenancy.mapping[domainname] || domainname[/(.*?)\./,1]
+    FastGettext.translation_repositories.keys.include?(domain) ? domain : FastGettext.default_text_domain
+  end
+
 end
 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="<%= html_language %>" lang="<%= html_language %>">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="<%= html_language %>" lang="<%= html_language %>" class="<%= h html_tag_classes %>">
   <head>
     <title><%= h page_title %></title>
     <%= yield(:feeds) %>
 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="<%= html_language %>" lang="<%= html_language %>">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="<%= html_language %>" lang="<%= html_language %>" class="<%= h html_tag_classes %>">
   <head>
     <title><%= h page_title %></title>
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
@@ -9,7 +9,8 @@ class Object
 end
  
  
-custom_locale_dir = Rails.root.join('custom_locales', Rails.env)
+# Adds custom locales for a whole environment
+custom_locale_dir = Rails.root.join('config', 'custom_locales', Rails.env)
 repos = []
 if File.exists?(custom_locale_dir)
   repos << FastGettext::TranslationRepository.build('environment', :type => 'po', :path => custom_locale_dir)
@@ -29,3 +30,15 @@ end
  
 FastGettext.add_text_domain 'noosfero', :type => :chain, :chain => repos
 FastGettext.default_text_domain = 'noosfero'
+
+# Adds custom locales for specific domains; Domains are identified by the
+# sequence before the first dot, while tenants are identified by schema name
+hosted_environments = Noosfero::MultiTenancy.mapping.values
+hosted_environments += Domain.all.map { |domain| domain.name[/(.*?)\./,1] } if Domain.table_exists?
+
+hosted_environments.uniq.each do |env|
+  custom_locale_dir = Rails.root.join('config', 'custom_locales', env)
+  if File.exists?(custom_locale_dir)
+    FastGettext.add_text_domain(env, :type => :chain, :chain => [FastGettext::TranslationRepository.build('environment', :type => 'po', :path => custom_locale_dir)] + repos)
+  end
+end
@@ -560,6 +560,12 @@ class Noosfero::Plugin
     []
   end
  
+  # -> Adds css class to <html> tag
+  # returns = ['class1', 'class2']
+  def html_tag_classes
+    nil
+  end
+
   # -> Adds additional blocks to profiles and environments.
   # Your plugin must implements a class method called 'extra_blocks'
   # that returns a hash with the following syntax.
@@ -0,0 +1,7 @@
+Classify Members
+Plugin that allows the association of communities with types of user profiles to classify and highlight them within the environment.
+
+ * In a school env we want to visit a profile and know it is a teacher or a student.
+ * In a enterprise env we want to view a forum comment and know it comes from a director or a lawyer.
+
+This plugin will allow the admin to select communities for classification. When the user enter in one of these communities, its profile pages comes with a community related class allowing the theme to adapt it. Also the picture block and other places where the user picture is displayed will have labels like "Teacher" or "Lawyer", also themable with css.
@@ -0,0 +1,12 @@
+class ClassifyMembersPluginAdminController < PluginsController
+  def index
+    @settings ||= Noosfero::Plugin::Settings.new(
+      environment, ClassifyMembersPlugin, params[:settings]
+    )
+
+    if request.post?
+      @settings.save!
+      redirect_to :controller => 'plugins', :action => 'index'
+    end
+  end
+end
@@ -0,0 +1,78 @@
+class ClassifyMembersPlugin < Noosfero::Plugin
+  def self.plugin_name
+    _("Classify Members")
+  end
+
+  def self.plugin_description
+    _("Allows the association of communities with types of user profiles to classify and highlight them within the environment.")
+  end
+
+  def html_tag_classes
+    plugin = self
+    lambda do
+      if profile && profile.person?
+        plugin.find_community(profile).map do |community, community_label|
+          'member-of-' + community.identifier
+        end
+      end
+    end
+  end
+
+  def body_beginning
+    plugin = self
+    lambda do
+      if profile && profile.person?
+        javascript_tag("
+          jQuery(function(){
+            jQuery('<div class=\"cmm-member-tags\"><ul class=\"cmm-member-list\"></ul></div>').insertBefore(
+              '.profile-image-block .vcard .profile-info-options'
+            );
+          });\n" +
+          plugin.find_community(profile).map do |community, community_label|
+          "jQuery(function(){
+            jQuery('.cmm-member-list').prepend(
+              '<li>' + '#{link_to '<i></i>' + community_label,
+                {:profile => community.identifier, :controller => 'profile', :action => 'members'},
+                :class => 'member-of-' + community.identifier}' + '</li>'
+            );
+          });"
+          end.join("\n")
+        )
+      else
+        '<!-- ClassCommunityPlugin not in a profile -->'
+      end
+    end
+  end
+
+  def settings
+    @settings ||= Noosfero::Plugin::Settings.new(
+      context.environment, ClassifyMembersPlugin
+    )
+  end
+
+  def communities
+    communities = settings.communities
+
+    return [] if communities.blank?
+
+    communities.split(/\s*\n\s*/).map do |community|
+      community = community.split(/\s*:\s*/)
+      community[0] = Profile[community[0].to_s.strip]
+      community[1] = community[1].to_s.strip
+
+      if community[0].blank?
+        nil
+      else
+        community[1] = community[0].name if community[1].blank?
+        community
+      end
+    end.compact
+  end
+
+  def find_community(profile)
+    communities.map do |community|
+      profile.is_member_of?(community[0]) ? community : nil
+    end.compact
+  end
+
+end
@@ -0,0 +1,45 @@
+require File.dirname(__FILE__) + '/../../../../test/test_helper'
+
+# Re-raise errors caught by the controller.
+class HomeController
+  def rescue_action(e)
+    raise e
+  end
+end
+
+class ProfileControllerTest < ActionController::TestCase
+  def setup
+    @env = Environment.default
+    @env.enable_plugin('ClassifyMembersPlugin')
+
+    @p1  = fast_create(Person, :environment_id => @env.id)
+    @p2  = fast_create(Person, :environment_id => @env.id)
+    @c1  = fast_create(Community, :environment_id => @env.id)
+    @c2  = fast_create(Community, :environment_id => @env.id)
+
+    # Register cassification communities:
+    ClassifyMembersPlugin.new(self).settings.communities = "#{@c1.identifier}: Test-Tag"
+    @env.save!
+
+    @c1.add_member @p1
+    @c2.add_member @p1
+    @c2.add_member @p2
+  end
+
+  def environment
+    @env
+  end
+
+  should 'add classification to the <html>' do
+    get :index, :profile => @p1.identifier
+
+    assert_select 'html.member-of-' + @c1.identifier
+    assert_select 'html.member-of-' + @c2.identifier, false
+  end
+
+  should 'not add classification to a non member' do
+    get :index, :profile=>@p2.identifier
+
+    assert_select 'html.member-of-' + @c1.identifier, false
+  end
+end
@@ -0,0 +1,46 @@
+require File.dirname(__FILE__) + '/../../../../test/test_helper'
+
+class ClassifyMembersPluginTest < ActiveSupport::TestCase
+  def setup
+    @env = fast_create(Environment)
+    @p1  = fast_create(Person, :environment_id => @env.id)
+    @c1  = fast_create(Community, :environment_id => @env.id)
+    @c2  = fast_create(Community, :environment_id => @env.id)
+    @c3  = fast_create(Community, :environment_id => @env.id)
+    @plugin = ClassifyMembersPlugin.new self
+  end
+
+  def environment
+    @env
+  end
+
+  should 'not crash for nil setting' do
+    assert_equal [], @plugin.find_community(@p1)
+  end
+
+  should 'list all classification communities' do
+    @plugin.settings.communities = "
+    #{@c1.identifier}: Tag1
+    #{@c2.identifier}
+    "
+    @env.save!
+
+    assert_equal [[@c1, 'Tag1'], [@c2, @c2.name]], @plugin.communities
+  end
+
+  should 'list the classification communities for a person' do
+    @c1.add_member @p1
+    @c2.add_member @p1
+    @p1.stubs(:is_member_of?).returns(false)
+    @p1.stubs(:is_member_of?).with(@c1).returns(true)
+    @p1.stubs(:is_member_of?).with(@c2).returns(true)
+    @plugin.settings.communities = "
+    #{@c1.identifier}: Tag1
+    #{@c2.identifier}: Tag2
+    #{@c3.identifier}: Tag3
+    "
+    @env.save!
+
+    assert_equal [[@c1, 'Tag1'], [@c2, 'Tag2']], @plugin.find_community(@p1)
+  end
+end
@@ -0,0 +1,22 @@
+<h1><%= _("Classify Members Plugin's config") %></h1>
+
+<%= form_for(:settings) do |f| %>
+
+  <%= labelled_form_field _('Communities to classify people:'), f.text_area(:communities) %>
+
+  <p><%=
+    _('List of community identifiers and the applicable person label, line by line.')
+  %></p>
+
+  <fieldset>
+    <legend><%=_('Example:')%></legend>
+    <%=_('teachers: Teacher')%> <br>
+    <%=_('office-lawyers: Lawyer')%> <br>
+    <%=_('salvador-ba: Soteropolitano')%>
+  </fieldset>
+
+  <% button_bar do %>
+    <%= submit_button(:save, _('Save'), :cancel => {:controller => 'plugins', :action => 'index'}) %>
+  <% end %>
+
+<% end %>
@@ -177,7 +177,7 @@ _new(){
     mkdir "$target"
  
     plugin_name=$(echo "$plugin" | sed -e 's/^./\u&/; s/_\(.\)/\u\1/g')
-    for source_file in $(find "$template" -type f); do
+    for source_file in $(find "$template" -type f -and '(' -not -name '*.po' -and -not -name '*.mo' ')'); do
       target_file=$(echo "$source_file" | sed -e "s/template/$plugin/g")
       mkdir -p $(dirname "$target_file")
       sed "s/TemplatePlugin/${plugin_name}Plugin/g" "$source_file" > "$target_file"
@@ -130,4 +130,36 @@ class HomeControllerTest &lt; ActionController::TestCase
     assert_no_tag :tag => 'a', :attributes => {:href => '/account/signup'}
   end
  
+  should 'add class to the <html>' do
+    get :index
+
+    # Where am i?
+    assert_select 'html.controller-home.action-home-index'
+    # What is the current layout?
+    assert_select 'html.template-default.theme-noosfero'
+  end
+
+  should 'plugins add class to the <html>' do
+    class Plugin1 < Noosfero::Plugin
+      def html_tag_classes
+        lambda { ['t1', 't2'] }
+      end
+    end
+
+    class Plugin2 < Noosfero::Plugin
+      def html_tag_classes
+        'test'
+      end
+    end
+
+    Noosfero::Plugin.stubs(:all).returns([Plugin1.name, Plugin2.name])
+    Noosfero::Plugin::Manager.any_instance.stubs(:enabled_plugins).returns([Plugin1.new, Plugin2.new])
+
+    get :index
+
+    # Where am i?
+    assert_select 'html.controller-home.action-home-index'
+    # There are plugin classes?
+    assert_select 'html.t1.t2.test'
+  end
 end
...	...	@@ -0,0 +1,29 @@
	1	+Using custom locales
	2	+====================
	3	+
	4	+Personalized translations go into the `config/custom_locales/` directory.
	5	+Custom locales can be identified by the rails environment, schema name in a
	6	+multitenancy setup or domain name until the first dot (e.g env1.coop.br for the
	7	+example below).
	8	+
	9	+Currently, the only filename prefix for the localization file which is
	10	+processed is "environment". For instance, a POT file would be called
	11	+"environment.pot".
	12	+
	13	+The structure of an environment named env1 with custom translations for both
	14	+Portuguese and Spanish and an environment named env2 with custom Russian
	15	+translation would be:
	16	+
	17	+ config/
	18	+ custom_locales/
	19	+ env1/
	20	+ environment.pot
	21	+ pt/
	22	+ environment.po
	23	+ es/
	24	+ environment.po
	25	+ env2/
	26	+ environment.pot
	27	+ ru/
	28	+ environment.po
	29	+
...	...
...	...	@@ -127,6 +127,9 @@ class ApplicationController < ActionController::Base
127	127
128	128	# TODO: move this logic somewhere else (Domain class?)
129	129	def detect_stuff_by_domain
	130	+ # Sets text domain based on request host for custom internationalization
	131	+ FastGettext.text_domain = Domain.custom_locale(request.host)
	132	+
130	133	@domain = Domain.find_by_name(request.host)
131	134	if @domain.nil?
132	135	@environment = Environment.default
...	...
...	...	@@ -9,6 +9,24 @@ module LayoutHelper
9	9	(!profile.nil? && profile.is_on_homepage?(request.path,@page) ? " profile-homepage" : "")
10	10	end
11	11
	12	+ def html_tag_classes
	13	+ [
	14	+ body_classes, (
	15	+ profile.blank? ? nil : [
	16	+ 'profile-type-is-' + profile.class.name.downcase,
	17	+ 'profile-name-is-' + profile.identifier,
	18	+ ]
	19	+ ), 'theme-' + current_theme,
	20	+ @plugins.dispatch(:html_tag_classes).map do \|content\|
	21	+ if content.respond_to?(:call)
	22	+ instance_exec(&content)
	23	+ else
	24	+ content.html_safe
	25	+ end
	26	+ end
	27	+ ].flatten.compact.join(' ')
	28	+ end
	29	+
12	30	def noosfero_javascript
13	31	plugins_javascripts = @plugins.map { \|plugin\| [plugin.js_files].flatten.map { \|js\| plugin.class.public_path(js) } }.flatten
14	32
...	...
...	...	@@ -92,4 +92,11 @@ class Domain < ActiveRecord::Base
92	92	@hosting = {}
93	93	end
94	94
	95	+ # Detects a domain's custom text domain chain if available based on a domain
	96	+ # served on multitenancy configuration or a registered domain.
	97	+ def self.custom_locale(domainname)
	98	+ domain = Noosfero::MultiTenancy.mapping[domainname] \|\| domainname[/(.*?)\./,1]
	99	+ FastGettext.translation_repositories.keys.include?(domain) ? domain : FastGettext.default_text_domain
	100	+ end
	101	+
95	102	end
...	...
1	1	<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2		-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="<%= html_language %>" lang="<%= html_language %>">
	2	+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="<%= html_language %>" lang="<%= html_language %>" class="<%= h html_tag_classes %>">
3	3	<head>
4	4	<title><%= h page_title %></title>
5	5	<%= yield(:feeds) %>
...	...
...	...	@@ -9,7 +9,8 @@ class Object
9	9	end
10	10
11	11
12		-custom_locale_dir = Rails.root.join('custom_locales', Rails.env)
	12	+# Adds custom locales for a whole environment
	13	+custom_locale_dir = Rails.root.join('config', 'custom_locales', Rails.env)
13	14	repos = []
14	15	if File.exists?(custom_locale_dir)
15	16	repos << FastGettext::TranslationRepository.build('environment', :type => 'po', :path => custom_locale_dir)
...	...	@@ -29,3 +30,15 @@ end
29	30
30	31	FastGettext.add_text_domain 'noosfero', :type => :chain, :chain => repos
31	32	FastGettext.default_text_domain = 'noosfero'
	33	+
	34	+# Adds custom locales for specific domains; Domains are identified by the
	35	+# sequence before the first dot, while tenants are identified by schema name
	36	+hosted_environments = Noosfero::MultiTenancy.mapping.values
	37	+hosted_environments += Domain.all.map { \|domain\| domain.name[/(.*?)\./,1] } if Domain.table_exists?
	38	+
	39	+hosted_environments.uniq.each do \|env\|
	40	+ custom_locale_dir = Rails.root.join('config', 'custom_locales', env)
	41	+ if File.exists?(custom_locale_dir)
	42	+ FastGettext.add_text_domain(env, :type => :chain, :chain => [FastGettext::TranslationRepository.build('environment', :type => 'po', :path => custom_locale_dir)] + repos)
	43	+ end
	44	+end
...	...
...	...	@@ -560,6 +560,12 @@ class Noosfero::Plugin
560	560	[]
561	561	end
562	562
	563	+ # -> Adds css class to <html> tag
	564	+ # returns = ['class1', 'class2']
	565	+ def html_tag_classes
	566	+ nil
	567	+ end
	568	+
563	569	# -> Adds additional blocks to profiles and environments.
564	570	# Your plugin must implements a class method called 'extra_blocks'
565	571	# that returns a hash with the following syntax.
...	...
...	...	@@ -0,0 +1,7 @@
	1	+Classify Members
	2	+Plugin that allows the association of communities with types of user profiles to classify and highlight them within the environment.
	3	+
	4	+ * In a school env we want to visit a profile and know it is a teacher or a student.
	5	+ * In a enterprise env we want to view a forum comment and know it comes from a director or a lawyer.
	6	+
	7	+This plugin will allow the admin to select communities for classification. When the user enter in one of these communities, its profile pages comes with a community related class allowing the theme to adapt it. Also the picture block and other places where the user picture is displayed will have labels like "Teacher" or "Lawyer", also themable with css.
...	...
...	...	@@ -0,0 +1,12 @@
	1	+class ClassifyMembersPluginAdminController < PluginsController
	2	+ def index
	3	+ @settings \|\|= Noosfero::Plugin::Settings.new(
	4	+ environment, ClassifyMembersPlugin, params[:settings]
	5	+ )
	6	+
	7	+ if request.post?
	8	+ @settings.save!
	9	+ redirect_to :controller => 'plugins', :action => 'index'
	10	+ end
	11	+ end
	12	+end
...	...
...	...	@@ -0,0 +1,78 @@
	1	+class ClassifyMembersPlugin < Noosfero::Plugin
	2	+ def self.plugin_name
	3	+ _("Classify Members")
	4	+ end
	5	+
	6	+ def self.plugin_description
	7	+ _("Allows the association of communities with types of user profiles to classify and highlight them within the environment.")
	8	+ end
	9	+
	10	+ def html_tag_classes
	11	+ plugin = self
	12	+ lambda do
	13	+ if profile && profile.person?
	14	+ plugin.find_community(profile).map do \|community, community_label\|
	15	+ 'member-of-' + community.identifier
	16	+ end
	17	+ end
	18	+ end
	19	+ end
	20	+
	21	+ def body_beginning
	22	+ plugin = self
	23	+ lambda do
	24	+ if profile && profile.person?
	25	+ javascript_tag("
	26	+ jQuery(function(){
	27	+ jQuery('<div class=\"cmm-member-tags\"><ul class=\"cmm-member-list\"></ul></div>').insertBefore(
	28	+ '.profile-image-block .vcard .profile-info-options'
	29	+ );
	30	+ });\n" +
	31	+ plugin.find_community(profile).map do \|community, community_label\|
	32	+ "jQuery(function(){
	33	+ jQuery('.cmm-member-list').prepend(
	34	+ '<li>' + '#{link_to '<i></i>' + community_label,
	35	+ {:profile => community.identifier, :controller => 'profile', :action => 'members'},
	36	+ :class => 'member-of-' + community.identifier}' + '</li>'
	37	+ );
	38	+ });"
	39	+ end.join("\n")
	40	+ )
	41	+ else
	42	+ '<!-- ClassCommunityPlugin not in a profile -->'
	43	+ end
	44	+ end
	45	+ end
	46	+
	47	+ def settings
	48	+ @settings \|\|= Noosfero::Plugin::Settings.new(
	49	+ context.environment, ClassifyMembersPlugin
	50	+ )
	51	+ end
	52	+
	53	+ def communities
	54	+ communities = settings.communities
	55	+
	56	+ return [] if communities.blank?
	57	+
	58	+ communities.split(/\s\n\s/).map do \|community\|
	59	+ community = community.split(/\s:\s/)
	60	+ community[0] = Profile[community[0].to_s.strip]
	61	+ community[1] = community[1].to_s.strip
	62	+
	63	+ if community[0].blank?
	64	+ nil
	65	+ else
	66	+ community[1] = community[0].name if community[1].blank?
	67	+ community
	68	+ end
	69	+ end.compact
	70	+ end
	71	+
	72	+ def find_community(profile)
	73	+ communities.map do \|community\|
	74	+ profile.is_member_of?(community[0]) ? community : nil
	75	+ end.compact
	76	+ end
	77	+
	78	+end
...	...