More Beauty around web2.0conf code

- Remove unnecessary config file tests for GoogleMaps - Also add the default gravatar configuration (ActionItem1324)

More Beauty around web2.0conf code
- Remove unnecessary config file tests for GoogleMaps - Also add the default gravatar configuration (ActionItem1324)
Aurelio A. Heckert · Antonio Terceiro
1 parent 73f9889f
Showing 6 changed files with 53 additions and 51 deletions Show diff stats
app/helpers/application_helper.rb
app/models/google_maps.rb
app/views/content_viewer/view_page.rhtml
config/web2.0.yml.dist
test/unit/application_helper_test.rb
test/unit/google_maps_test.rb
@@ -26,6 +26,17 @@ module ApplicationHelper
   include AccountHelper
+  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
@@ -500,18 +511,21 @@ module ApplicationHelper
                :host => 'www.gravatar.com',
                :protocol => 'http://',
                :only_path => false,
-               :controller => 'avatar.php'
+               :controller => 'avatar.php',
+               :d => web2_conf['gravatar'] ? web2_conf['gravatar']['default'] : nil
              }.merge(options) )
   end
-    
+
   def str_gravatar_url_for(email, options = {})
+    default = web2_conf['gravatar'] ? web2_conf['gravatar']['default'] : nil
     url = 'http://www.gravatar.com/avatar.php?gravatar_id=' +
            Digest::MD5.hexdigest(email)
-    { :only_path => false }.merge(options).each { |k,v|
+    {
+      :only_path => false,
+      :d => default
+    }.merge(options).each { |k,v|
       url += ( '&%s=%s' % [ k,v ] )
     }
-    # we can set the default imgage with this:
-    # :default => 'DOMAIN/images/icons-app/gravatar-minor.gif'
     url
   end
@@ -4,22 +4,14 @@ class GoogleMaps
   class << self
+    include ApplicationHelper
+
     def erase_config
       @config = nil
     end
-    def config_file
-      File.join(RAILS_ROOT, 'config', 'web2.0.yml')
-    end
-
     def config
-      if @config.nil?
-        if File.exists?(config_file)
-          yaml = YAML.load_file(config_file)
-          @config = yaml['googlemaps']
-        end
-      end
-
+      @config = web2_conf['googlemaps'] if @config.nil?
       @config ||= {}
     end
@@ -2,10 +2,8 @@
 <%
   # AddThis Button
-  if block_given? and File.exists?( RAILS_ROOT + '/config/web2.0.yml')
-    opts = YAML.load_file( RAILS_ROOT + '/config/web2.0.yml' )
-    if opts['addthis']
-      opts = opts['addthis']
+  if block_given? and web2_conf['addthis']
+      opts = web2_conf['addthis']
 %>
 <div id="addThis">
 <script type="text/javascript">
@@ -19,7 +17,7 @@
 %></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; end %>
+<% end %>
 <div>
   <%= article_title(@page, :no_link => true) %>
@@ -8,3 +8,5 @@ addthis:
   options: favorites, email, digg, delicious, technorati, slashdot, twitter, more
 googlemaps:
   key: <id google>
+gravatar:
+  default: wavatar
@@ -8,6 +8,18 @@ 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'}
+    }
+    # does not work!
+    File.stubs(:exists?).with(yml).returns(true)
+    YAML.stubs(: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'})
@@ -518,6 +530,14 @@ class ApplicationHelperTest &lt; Test::Unit::TestCase
     assert_match(/Community nickname/, page_title)
   end
+  should 'generate a gravatar url' 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=wavatar(&|$)/, url)
+    assert_match(/(\?|&)size=50(&|$)/, url)
+  end
+
   protected
   def url_for(args = {})
@@ -2,45 +2,23 @@ require File.dirname(__FILE__) + &#39;/../test_helper&#39;
 class GoogleMapsTest < Test::Unit::TestCase
-  CONFIG_FILE = '/not/existing.yml'
-
   def setup
     # force loading of config at every test
     GoogleMaps.erase_config
-    GoogleMaps.stubs(:config_file).returns(CONFIG_FILE)
-  end
-
-  should 'retrieve key from "web2.0" config file' do
-    File.expects(:exists?).with(CONFIG_FILE).returns(true)
-    YAML.expects(:load_file).with(CONFIG_FILE).returns({'googlemaps' => { 'key' => 'MYKEY' }})
-    assert_equal 'MYKEY', GoogleMaps.key
   end
   should 'enable when key is defined' do
-    File.expects(:exists?).with(CONFIG_FILE).returns(true)
-    YAML.expects(:load_file).with(CONFIG_FILE).returns({'googlemaps' => { 'key' => 'MYKEY' }})
+    GoogleMaps.stubs(:config).returns({ 'key' => 'MYKEY' })
     assert GoogleMaps.enabled?
   end
-  should 'disable if config file not present' do
-    File.expects(:exists?).with(CONFIG_FILE).returns(false)
-    assert !GoogleMaps.enabled?
-  end
-
   should 'disable if key not defined' do
-    File.expects(:exists?).with(CONFIG_FILE).returns(true)
-    YAML.expects(:load_file).with(CONFIG_FILE).returns({})
+    GoogleMaps.stubs(:config).returns({})
     assert !GoogleMaps.enabled?
   end
-  
-  should 'not crash if config not informed' do
-    File.expects(:exists?).with(CONFIG_FILE).returns(true)
-    YAML.expects(:load_file).with(CONFIG_FILE).returns({})
-    assert_equal '', GoogleMaps.key
-  end
-  should 'not crash if config file not found' do
-    GoogleMaps.expects(:config_file).returns('/not/present.yml')
+  should 'not crash if config not informed' do
+    GoogleMaps.stubs(:config).returns({})
     assert_equal '', GoogleMaps.key
   end
@@ -50,14 +28,12 @@ class GoogleMapsTest &lt; Test::Unit::TestCase
   end
   should 'provide initial_zoom setting' do
-    File.expects(:exists?).with(CONFIG_FILE).returns(true)
-    YAML.expects(:load_file).with(CONFIG_FILE).returns({'googlemaps' => { 'initial_zoom' => 2}})
+    GoogleMaps.stubs(:config).returns({'initial_zoom' => 2})
     assert_equal 2, GoogleMaps.initial_zoom
   end
   should 'use 4 as default initial_zoom' do
-    File.expects(:exists?).with(CONFIG_FILE).returns(true)
-    YAML.expects(:load_file).with(CONFIG_FILE).returns({'googlemaps' => { }})
+    GoogleMaps.stubs(:config).returns({})
     assert_equal 4, GoogleMaps.initial_zoom
   end
	@@ -8,3 +8,5 @@ addthis:		@@ -8,3 +8,5 @@ addthis:
8	options: favorites, email, digg, delicious, technorati, slashdot, twitter, more	8	options: favorites, email, digg, delicious, technorati, slashdot, twitter, more
9	googlemaps:	9	googlemaps:
10	key: <id google>	10	key: <id google>
		11	+gravatar:
		12	+ default: wavatar
	@@ -8,6 +8,18 @@ class ApplicationHelperTest < Test::Unit::TestCase		@@ -8,6 +8,18 @@ class ApplicationHelperTest < Test::Unit::TestCase
8	self.stubs(:session).returns({})	8	self.stubs(:session).returns({})
9	end	9	end
10		10
		11	+ should 'retrieve conf from "web2.0" config file' do
		12	+ yml = RAILS_ROOT + '/config/web2.0.yml'
		13	+ conf = {
		14	+ 'addthis'=>{'pub'=>'mylogin', 'options'=>'favorites, email'},
		15	+ 'gravatar'=>{'default'=>'wavatar'}
		16	+ }
		17	+ # does not work!
		18	+ File.stubs(:exists?).with(yml).returns(true)
		19	+ YAML.stubs(:load_file).with(yml).returns(conf)
		20	+ assert_equal conf, web2_conf
		21	+ end
		22	+
11	should 'calculate correctly partial for object' do	23	should 'calculate correctly partial for object' do
12	self.stubs(:params).returns({:controller => 'test'})	24	self.stubs(:params).returns({:controller => 'test'})
13		25
	@@ -518,6 +530,14 @@ class ApplicationHelperTest < Test::Unit::TestCase		@@ -518,6 +530,14 @@ class ApplicationHelperTest < Test::Unit::TestCase
518	assert_match(/Community nickname/, page_title)	530	assert_match(/Community nickname/, page_title)
519	end	531	end
520		532
		533	+ should 'generate a gravatar url' do
		534	+ url = str_gravatar_url_for( 'rms@gnu.org', :size => 50 )
		535	+ assert_match(/^http:\/\/www\.gravatar\.com\/avatar\.php\?/, url)
		536	+ assert_match(/(\?\|&)gravatar_id=ed5214d4b49154ba0dc397a28ee90eb7(&\|$)/, url)
		537	+ assert_match(/(\?\|&)d=wavatar(&\|$)/, url)
		538	+ assert_match(/(\?\|&)size=50(&\|$)/, url)
		539	+ end
		540	+
521	protected	541	protected
522		542
523	def url_for(args = {})	543	def url_for(args = {})