Merging web2.0.yml and mail.yml into noosfero.yml

- new config entry: addthis_enabled - new Rails initializer to load config file (ActionItem1820)

Merging web2.0.yml and mail.yml into noosfero.yml
- new config entry: addthis_enabled - new Rails initializer to load config file (ActionItem1820)
Joenio Costa · Daniela Feitosa
1 parent 7590a7c4
Showing 14 changed files with 69 additions and 105 deletions Show diff stats
app/helpers/application_helper.rb
app/models/google_maps.rb
app/models/mail_conf.rb
app/views/content_viewer/view_page.rhtml
config/initializers/load_config.rb
config/mail.yml.dist
config/noosfero.yml
config/web2.0.yml.dist
gitignore.example
test/test_helper.rb
test/unit/application_helper_test.rb
test/unit/google_maps_test.rb
test/unit/load_config_test.rb
test/unit/mail_conf_test.rb
@@ -30,17 +30,6 @@ module ApplicationHelper
     (@page && !@page.language.blank?) ? @page.language : FastGettext.locale
   end
-  def load_web2_conf
-    if File.exists?( RAILS_ROOT + '/config/web2.0.yml')
-      YAML.load_file( RAILS_ROOT + '/config/web2.0.yml' )
-    else
-      {}
-    end
-  end
-  def web2_conf
-    @web_conf ||= load_web2_conf
-  end
-
   # Displays context help. You can pass the content of the help message as the
   # first parameter or using template code inside a block passed to this
   # method. *Note*: the block is ignored if <tt>content</tt> is not
@@ -570,12 +559,12 @@ module ApplicationHelper
                :protocol => 'http://',
                :only_path => false,
                :controller => 'avatar.php',
-               :d => web2_conf['gravatar'] ? web2_conf['gravatar']['default'] : nil
+               :d => NOOSFERO_CONF['gravatar'] ? NOOSFERO_CONF['gravatar'] : nil
              }.merge(options) )
   end
   def str_gravatar_url_for(email, options = {})
-    default = web2_conf['gravatar'] ? web2_conf['gravatar']['default'] : nil
+    default = NOOSFERO_CONF['gravatar'] ? NOOSFERO_CONF['gravatar'] : nil
     url = 'http://www.gravatar.com/avatar.php?gravatar_id=' +
            Digest::MD5.hexdigest(email)
     {
@@ -6,14 +6,6 @@ class GoogleMaps
     include ApplicationHelper
-    def erase_config
-      @config = nil
-    end
-
-    def config
-      @config ||= (web2_conf['googlemaps'] || {})
-    end
-
     def enabled?(domain)
       domain = Domain.find_by_name(domain)
       domain ? !domain.google_maps_key.nil? : false
@@ -25,7 +17,7 @@ class GoogleMaps
     end
     def initial_zoom
-      config['initial_zoom'] || 4
+      NOOSFERO_CONF['googlemaps_initial_zoom'] || 4
     end
     def api_url(domain)
 class MailConf
   class << self
-    def config_file
-      File.join(RAILS_ROOT, 'config', 'mail.yml')
-    end
-
-    def config
-      if File.exists?(config_file)
-        YAML.load_file(config_file)
-      else
-        { 'webmail_url' =>  'http://webmail.example.com' }
-      end
+    def default_webmail_url
+      'http://webmail.example.com'
     end
     def enabled?
-      config['enabled'] || false
+      NOOSFERO_CONF['mail_enabled'] || false
     end
     def webmail_url(username, domain)
-      config['webmail_url'] % [username, domain]
+      (NOOSFERO_CONF['webmail_url'] || default_webmail_url) % [username, domain]
     end
   end
@@ -101,21 +101,14 @@
 <%= display_source_info(@page) %>
-<%
-  # AddThis Button
-  if block_given? && web2_conf['addthis']
-      opts = web2_conf['addthis']
-%>
+<% if NOOSFERO_CONF['addthis_enabled'] %>
 <div id="addThis">
 <script type="text/javascript">
   addthis_brand = '<%= escape_javascript( @environment.name ) %>';
-<%=
-  str = ''
-  opts.each { |k, v|
-    str += '  addthis_'+ k +' = "'+ escape_javascript( v ) +"\";\n"
-  }
-  str
-%></script>
+  addthis_pub = '<%= escape_javascript( NOOSFERO_CONF['addthis_pub'] ) %>';
+  addthis_logo = '<%= escape_javascript( NOOSFERO_CONF['addthis_logo'] ) %>';
+  addthis_options = '<%= escape_javascript( NOOSFERO_CONF['addthis_options'] ) %>';
+</script>
 <a href="http://www.addthis.com/bookmark.php" id="bt_addThis" target="_blank" onmouseover="return addthis_open(this, '', '[URL]')" onmouseout="addthis_close()" onclick="return addthis_sendto()"><img src="/images/bt-bookmark.gif" width="53" height="16" border="0" alt="" /></a><script type="text/javascript" src="http://s7.addthis.com/js/152/addthis_widget.js"></script>
 </div>
 <% end %>
@@ -0,0 +1 @@
+NOOSFERO_CONF = YAML.load_file("#{RAILS_ROOT}/config/noosfero.yml")[RAILS_ENV]
@@ -1,2 +0,0 @@
-enabled: true
-webmail_url: "http://mail.yourdomain.net/"
@@ -0,0 +1,14 @@
+development: &DEVELOPMENT
+  mail_enabled: true
+  webmail_url: "http://localhost.localdomain/"
+  addthis_enabled: true
+  addthis_pub: your-user-name
+  addthis_logo: http://localhost:3000/images/logo-200x50.png
+  addthis_options: favorites, email, digg, delicious, technorati, slashdot, twitter, more
+  gravatar: wavatar
+  googlemaps_initial_zoom: 4
+
+test: &TEST
+  <<: *DEVELOPMENT
+
+production:
@@ -1,12 +0,0 @@
-# This file configures all Web 2.0 services used by this noosfero instalation
-
-# You can add (or remove) any addthis option here.
-# Know more: http://www.addthis.com/customization.php
-addthis:
-  pub: your-user-name
-  logo: http://localhost:3000/images/logo-200x50.png
-  options: favorites, email, digg, delicious, technorati, slashdot, twitter, more
-googlemaps:
-  key: <id google>
-gravatar:
-  default: wavatar
@@ -5,7 +5,7 @@ doc/plugins
 tmp
 config/database.yml
 config/session.secret
-config/mail.yml
+config/noosfero.yml
 config/ferret_server.yml
 config/mongrel_cluster.yml
 index
@@ -250,4 +250,16 @@ class ActionController::IntegrationTest
 end
+def with_constants(constants, &block)
+  old_constants = Hash.new
+  constants.each do |constant, val|
+    old_constants[constant] = Object.const_get(constant)
+    silence_stderr{ Object.const_set(constant, val) }
+  end
+  block.call
+  old_constants.each do |constant, val|
+    silence_stderr{ Object.const_set(constant, val) }
+  end
+end
+
 Profile
@@ -8,17 +8,6 @@ class ApplicationHelperTest &lt; Test::Unit::TestCase
     self.stubs(:session).returns({})
   end
-  should 'retrieve conf from "web2.0" config file' do
-    yml = RAILS_ROOT + '/config/web2.0.yml'
-    conf = {
-      'addthis'=>{'pub'=>'mylogin', 'options'=>'favorites, email'},
-      'gravatar'=>{'default'=>'wavatar'}
-    }
-    File.expects(:exists?).with(yml).returns(true)
-    YAML.expects(:load_file).with(yml).returns(conf)
-    assert_equal conf, web2_conf
-  end
-
   should 'calculate correctly partial for object' do
     self.stubs(:params).returns({:controller => 'test'})
@@ -436,12 +425,13 @@ class ApplicationHelperTest &lt; Test::Unit::TestCase
   end
   should 'generate a gravatar url' do
-    stubs(:web2_conf).returns({"gravatar" => {"default" => "wavatar"}})
-    url = str_gravatar_url_for( 'rms@gnu.org', :size => 50 )
-    assert_match(/^http:\/\/www\.gravatar\.com\/avatar\.php\?/, url)
-    assert_match(/(\?|&)gravatar_id=ed5214d4b49154ba0dc397a28ee90eb7(&|$)/, url)
-    assert_match(/(\?|&)d=wavatar(&|$)/, url)
-    assert_match(/(\?|&)size=50(&|$)/, url)
+    with_constants :NOOSFERO_CONF => {'gravatar' => 'crazyvatar'} do
+      url = str_gravatar_url_for( 'rms@gnu.org', :size => 50 )
+      assert_match(/^http:\/\/www\.gravatar\.com\/avatar\.php\?/, url)
+      assert_match(/(\?|&)gravatar_id=ed5214d4b49154ba0dc397a28ee90eb7(&|$)/, url)
+      assert_match(/(\?|&)d=crazyvatar(&|$)/, url)
+      assert_match(/(\?|&)size=50(&|$)/, url)
+    end
   end
   should 'use theme passed via param when in development mode' do
@@ -4,8 +4,6 @@ class GoogleMapsTest &lt; Test::Unit::TestCase
   def setup
     @domain = fast_create(Domain, :name => 'example-domain', :google_maps_key => 'DOMAIN_KEY')
-    # force loading of config at every test
-    GoogleMaps.erase_config
   end
   attr_reader :domain
@@ -19,18 +17,14 @@ class GoogleMapsTest &lt; Test::Unit::TestCase
     assert !GoogleMaps.enabled?('domain-without-key')
   end
-  should 'not crash if config not informed' do
-    GoogleMaps.stubs(:config).returns({})
-    assert_equal({}, GoogleMaps.config)
-  end
-
   should 'point correctly to google maps' do
     assert_equal 'http://maps.google.com/maps?file=api&amp;v=2&amp;key=DOMAIN_KEY', GoogleMaps.api_url(domain.name)
   end
   should 'provide initial_zoom setting' do
-    GoogleMaps.stubs(:config).returns({'initial_zoom' => 2})
-    assert_equal 2, GoogleMaps.initial_zoom
+    with_constants :NOOSFERO_CONF => {'googlemaps_initial_zoom' => 2} do
+      assert_equal 2, GoogleMaps.initial_zoom
+    end
   end
   should 'use 4 as default initial_zoom' do
@@ -0,0 +1,14 @@
+require File.dirname(__FILE__) + '/../test_helper'
+
+class LoadConfigTest < Test::Unit::TestCase
+
+  should 'ensure YAML file exists' do
+    assert File.exists?("#{RAILS_ROOT}/config/noosfero.yml")
+  end
+
+  should 'ensure YAML file was loaded' do
+    assert NOOSFERO_CONF
+    assert_kind_of Hash, NOOSFERO_CONF
+  end
+
+end
@@ -2,36 +2,23 @@ require File.dirname(__FILE__) + &#39;/../test_helper&#39;
 class MailConfTest < ActiveSupport::TestCase
-  CONFIG_FILE = '/not/existing.yml'
-
-  should 'use config/mail.yml as config' do
-    assert_equal RAILS_ROOT + '/config/mail.yml', MailConf.config_file
-  end
-
   should 'enable if told to' do
-    MailConf.stubs(:config_file).returns(CONFIG_FILE)
-    File.expects(:exists?).with(CONFIG_FILE).returns(true)
-    YAML.expects(:load_file).with(CONFIG_FILE).returns({ 'enabled' => true})
+    NOOSFERO_CONF['mail_enabled'] = true
     assert_equal true, MailConf.enabled?
   end
   should 'disable if told to' do
-    MailConf.stubs(:config_file).returns(CONFIG_FILE)
-    File.expects(:exists?).with(CONFIG_FILE).returns(true)
-    YAML.expects(:load_file).with(CONFIG_FILE).returns({ 'enabled' => false })
+    NOOSFERO_CONF['mail_enabled'] = false
     assert_equal false, MailConf.enabled?
   end
-  should 'disable if config file not present' do
-    MailConf.stubs(:config_file).returns(CONFIG_FILE)
-    File.expects(:exists?).with(CONFIG_FILE).returns(false)
+  should 'disable by default' do
+    NOOSFERO_CONF['mail_enabled'] = nil
     assert_equal false, MailConf.enabled?
   end
   should 'provide webmail url preference' do
-    MailConf.stubs(:config_file).returns(CONFIG_FILE)
-    File.expects(:exists?).with(CONFIG_FILE).returns(true)
-    YAML.expects(:load_file).with(CONFIG_FILE).returns({ 'enabled' => false, 'webmail_url' => 'http://some.url/webmail/%s/%s' })
+    NOOSFERO_CONF['webmail_url'] = 'http://some.url/webmail/%s/%s'
     assert_equal 'http://some.url/webmail/login/example.com', MailConf.webmail_url('login', 'example.com')
   end
	@@ -0,0 +1 @@		@@ -0,0 +1 @@
		1	+NOOSFERO_CONF = YAML.load_file("#{RAILS_ROOT}/config/noosfero.yml")[RAILS_ENV]
	@@ -1,2 +0,0 @@	@@ -1,2 +0,0 @@
1	-enabled: true
2	-webmail_url: "http://mail.yourdomain.net/"
@@ -0,0 +1,14 @@		@@ -0,0 +1,14 @@
	1	+development: &DEVELOPMENT
	2	+ mail_enabled: true
	3	+ webmail_url: "http://localhost.localdomain/"
	4	+ addthis_enabled: true
	5	+ addthis_pub: your-user-name
	6	+ addthis_logo: http://localhost:3000/images/logo-200x50.png
	7	+ addthis_options: favorites, email, digg, delicious, technorati, slashdot, twitter, more
	8	+ gravatar: wavatar
	9	+ googlemaps_initial_zoom: 4
	10	+
	11	+test: &TEST
	12	+ <<: *DEVELOPMENT
	13	+
	14	+production:
	@@ -1,12 +0,0 @@	@@ -1,12 +0,0 @@
1	-# This file configures all Web 2.0 services used by this noosfero instalation
2	-
3	-# You can add (or remove) any addthis option here.
4	-# Know more: http://www.addthis.com/customization.php
5	-addthis:
6	- pub: your-user-name
7	- logo: http://localhost:3000/images/logo-200x50.png
8	- options: favorites, email, digg, delicious, technorati, slashdot, twitter, more
9	-googlemaps:
10	- key: <id google>
11	-gravatar:
12	- default: wavatar
	@@ -5,7 +5,7 @@ doc/plugins		@@ -5,7 +5,7 @@ doc/plugins
5	tmp	5	tmp
6	config/database.yml	6	config/database.yml
7	config/session.secret	7	config/session.secret
8	-config/mail.yml	8	+config/noosfero.yml
9	config/ferret_server.yml	9	config/ferret_server.yml
10	config/mongrel_cluster.yml	10	config/mongrel_cluster.yml
11	index	11	index
	@@ -250,4 +250,16 @@ class ActionController::IntegrationTest		@@ -250,4 +250,16 @@ class ActionController::IntegrationTest
250		250
251	end	251	end
252		252
		253	+def with_constants(constants, &block)
		254	+ old_constants = Hash.new
		255	+ constants.each do \|constant, val\|
		256	+ old_constants[constant] = Object.const_get(constant)
		257	+ silence_stderr{ Object.const_set(constant, val) }
		258	+ end
		259	+ block.call
		260	+ old_constants.each do \|constant, val\|
		261	+ silence_stderr{ Object.const_set(constant, val) }
		262	+ end
		263	+end
		264	+
253	Profile	265	Profile
@@ -0,0 +1,14 @@		@@ -0,0 +1,14 @@
	1	+require File.dirname(__FILE__) + '/../test_helper'
	2	+
	3	+class LoadConfigTest < Test::Unit::TestCase
	4	+
	5	+ should 'ensure YAML file exists' do
	6	+ assert File.exists?("#{RAILS_ROOT}/config/noosfero.yml")
	7	+ end
	8	+
	9	+ should 'ensure YAML file was loaded' do
	10	+ assert NOOSFERO_CONF
	11	+ assert_kind_of Hash, NOOSFERO_CONF
	12	+ end
	13	+
	14	+end