gravatarify 1.2.0 → 1.2.1

data/README.md

@@ -60,7 +60,7 @@ When using Rails or HAML these should be automatically available, if not do some
 
 This then provides three helper methods: `gravatar_url`, `gravatar_attrs` and `gravatar_tag`.
 To just build a simple `<img/>` tag, pass in an object (if it responds to `email` or `mail`)
-or a string containg the e-mail address:
+or a string containing the e-mail address:
 
     <%= gravatar_tag @user %> # => assumes @user has email or mail field!
 
@@ -188,7 +188,7 @@ Need more control?
   </tr>
 </table>
 
-To options globally, access the `Gravatarify.options` hash and set any options which should apply to all
+To set the options globally, access the `Gravatarify.options` hash and set any options which should apply to all
 gravatar urls there. Of course all settings can be overridden locally:
 
     # disable suffix and set default size to 16x16px
@@ -197,7 +197,13 @@ gravatar urls there. Of course all settings can be overridden locally:
     
     gravatar_url(@user.email) # => http://0.gravatar.com/avatar/..f93ff1e?s=16
     gravatar_url(@user.email, :filetype => :png) # => http://0.gravatar.com/avatar/..f93ff1e.png?s=16
+    
+A pretty nifty option also exists to set options globally for `gravatar_tag` and `gravatar_attrs`, e.g.
+to always add a title attribute:
 
+    # add title attribute
+    Gravatarify::Helper.html_options[:title] = "Gravatar"
+    
 ### Not yet enough?
 
 The `:default` option can be passed in a `Proc`, so this is certainly useful to for example
@@ -228,7 +234,7 @@ it should evaluate against `request.ssl?` for example.
 About the code
 ==============
 
-Eventhough this library has less than 100 LOC, it's split into four files, maybe a bit
+Eventhough this library has about 100 LOC, it's split into four files, maybe a bit
 of an overkill, though I like neat and tidy classes :)
 
     lib/gravatarify.rb                      # loads the other files from lib/gravatarify
@@ -245,13 +251,17 @@ of an overkill, though I like neat and tidy classes :)
                                             # gravatarify class method to add a gravatar_url
                                             # to any object.
                                             
-    lib/gravatarify/helper.rb               # Defines those view helpers, mainly gravatar_tag
-    
+    lib/gravatarify/helper.rb               # Defines those view helpers, mainly gravatar_attrs
+                                            # and gravatar_tag
 ### Contribute
 
  1. Fork the project and hack away
  2. Ensure that the changes are well tested
  3. Send me a pull request
+ 
+### Thanks
+
+ - [gudleik](http://github.com/gudleik) for his work on allowing an empty `:filetype`
 
 Licence
 =======

data/Rakefile

@@ -30,10 +30,11 @@ begin
   require 'jeweler'
   Jeweler::Tasks.new do |gemspec|
     gemspec.name = "gravatarify"
-    gemspec.summary = "Awesome gravatar support for ruby (and rails)."
+    gemspec.summary = "Awesome gravatar support for Ruby (and Rails, DataMapper, Haml)."
     description = <<-DESC
-    Yet another ruby/rails gravatar plugin - though, one with unique options like 
-    `Proc`s for default images, or support for gravatar.com's multiple host names.
+    Awesome gravatar support for Ruby (and Rails, DataMapper, Haml) -
+    with unique options like Proc's for default images, or
+    support for gravatar.com's multiple host names.
     DESC
     gemspec.description = description.strip
     gemspec.email = "lukas.westermann@gmail.com"

data/VERSION.yml

@@ -1,4 +1,4 @@
 --- 
 :major: 1
 :minor: 2
-:patch: 0
+:patch: 1

data/lib/gravatarify/base.rb

@@ -1,19 +1,7 @@
 require 'digest/md5'
 begin; require 'rack/utils'; rescue LoadError; require 'cgi' end
 
-module Gravatarify
-  # Subdomains used for balancing
-  GRAVATAR_SUBDOMAINS = %w{ 0 1 2 www } 
-  
-  # Fallback if no subdomain is found
-  GRAVATAR_DEFAULT_SUBDOMAIN = 'www'
-  
-  # If no size is specified, gravatar.com returns 80x80px images
-  GRAVATAR_DEFAULT_SIZE = 80
-  
-  # Default filetype is JPG
-  GRAVATAR_DEFAULT_FILETYPE = :jpg
-
+module Gravatarify  
   # List of known and valid gravatar options (includes shortened options).
   GRAVATAR_OPTIONS = [ :default, :d, :rating, :r, :size, :s, :secure, :filetype ]
 
@@ -35,7 +23,7 @@ module Gravatarify
     #     # or disable adding an extension
     #     Gravatarify.options[:filetype] = false
     #
-    def options; @options ||= {} end
+    def options; @options ||= { :filetype => :jpg } end
   
     # Globally overide subdomains used to build gravatar urls, normally
     # +gravatarify+ picks from either +0.gravatar.com+, +1.gravatar.com+,
@@ -53,16 +41,16 @@ module Gravatarify
     # i.e. disable host balancing!
     def use_www_only!; self.subdomains = %w{ www } end
 
-    # Access currently defined subdomains, defaults are +GRAVTAR_SUBDOMAINS+.
-    def subdomains; @subdomains ||= GRAVATAR_SUBDOMAINS end
+    # Access currently defined subdomains, defaults are +%w{ 0 1 2 www }+.
+    def subdomains; @subdomains ||= %w{ 0 1 2 www } end
     
-    # Get subdomain for supplied string or returns +GRAVATAR_DEFAULT_SUBDOMAIN+ if none is
+    # Get subdomain for supplied string or returns +www+ if none is
     # defined.
-    def subdomain(str); subdomains[str.hash % subdomains.size] || GRAVATAR_DEFAULT_SUBDOMAIN end
+    def subdomain(str); subdomains[str.hash % subdomains.size] || 'www' end
     
-    # Helper method to escape string using either <tt>Rack::Utils</tt> if available or else
+    # Helper method to URI escape a string using either <tt>Rack::Utils#escape</tt> if available or else
     # fallback to <tt>CGI#escape</tt>.
-    def escape(str)
+    def escape(str) #:nodoc:
       str = str.to_s unless str.is_a?(String) # convert to string!
       defined?(Rack::Utils) ? Rack::Utils.escape(str) : CGI.escape(str)
     end
@@ -104,14 +92,14 @@ module Gravatarify
     # @option url_options [Integer] :size (80) The size of the (square) image.
     # @option url_options [Boolean, Proc] :secure (false) If set to +true+, then uses the secure gravatar.com URL. If a Proc is
     #                                     supplied it's evaluated, the Proc should evaluate to +true+ or +false+.
-    # @option url_options [String, Symbol] :filetype (:jpg) Gravatar.com supports only <tt>:gif</tt>, <tt>:jpg</tt> and <tt>:png</tt>
+    # @option url_options [String, Symbol] :filetype (:jpg) Gravatar.com supports only <tt>:gif</tt>, <tt>:jpg</tt> and <tt>:png</tt>.
+    #                                      if an set to +false+, +nil+ or an empty string no extension is added.
     # @return [String] In any case (even if supplied +email+ is +nil+) returns a fully qualified gravatar.com URL.
     #                  The returned string is not yet HTML escaped, *but* all +url_options+ have been URI escaped.
     def build_gravatar_url(email, url_options = {})
-      # FIXME: add symbolize_keys again, maybe just write custom method, so we do not depend on ActiveSupport magic...
       url_options = Gravatarify.options.merge(url_options)
       email_hash = Digest::MD5.hexdigest(Base.get_smart_email_from(email).strip.downcase)
-      extension = url_options[:filetype] == false ? '' : ".#{url_options.delete(:filetype) || GRAVATAR_DEFAULT_FILETYPE}"
+      extension = (ext = url_options.delete(:filetype) and ext != '') ? ".#{ext || 'jpg'}" : '' # slightly adapted from gudleik's implementation
       build_gravatar_host(email_hash, url_options.delete(:secure)) << "/avatar/#{email_hash}#{extension}#{build_gravatar_options(email, url_options)}"
     end
   
@@ -140,7 +128,9 @@ module Gravatarify
         "?#{params.sort * '&'}" unless params.empty?
       end
       
-      def self.get_smart_email_from(obj)
+      # Tries first to call +email+, then +mail+ then +to_s+ on supplied
+      # object.
+      def self.get_smart_email_from(obj) #:nodoc:
         (obj.respond_to?(:email) ? obj.email : (obj.respond_to?(:mail) ? obj.mail : obj)).to_s
       end
   end

data/lib/gravatarify/helper.rb

@@ -2,7 +2,15 @@ module Gravatarify::Helper
   # so that it's possible to access that build_gravatar_url method
   include Gravatarify::Base
   
-  # to simplify things a bit and have a neat-o naming
+  # Allow HTML options to be overriden globally as well, useful
+  # to e.g. define a common alt attribute, or class.
+  #
+  #    Gravatarify::Helper.html_options[:title] = "Gravatar"
+  #
+  # @return [Hash] globally defined html attributes  
+  def self.html_options; @html_options ||= { :alt => '' } end
+  
+  # To simplify things a bit and have a neat-o naming
   alias_method :gravatar_url, :build_gravatar_url
   
   # Helper method for HAML to return a neat hash to be used as attributes in an image tag.
@@ -11,17 +19,28 @@ module Gravatarify::Helper
   #
   #    %img{ gravatar_attrs(@user.mail, :size => 20) }/
   #
+  # This is also the base method for +gravatar_tag+.
+  #
+  # @param [String, #email, #mail, #gravatar_url] email a string or an object used
+  #        to generate to gravatar url for.
+  # @param [Hash] options other gravatar or html options for building the resulting
+  #        hash.
+  # @return [Hash] all html attributes required to build an +img+ tag.
   def gravatar_attrs(email, options = {})
-    url_options = options.reject { |key, value| !Gravatarify::GRAVATAR_OPTIONS.include?(key) }
-    options = options.delete_if { |key, value| Gravatarify::GRAVATAR_OPTIONS.include?(key) }
-    options[:alt] ||= Gravatarify::Base.get_smart_email_from(email) # use email as :alt attribute
-    options[:width] = options[:height] = (url_options[:size] || Gravatarify::GRAVATAR_DEFAULT_SIZE) # customize size
+    url_options = options.inject({}) { |hsh, (key, value)| hsh[key] = options.delete(key) if Gravatarify::GRAVATAR_OPTIONS.include?(key.to_sym); hsh }
+    options[:width] = options[:height] = (url_options[:size] || 80) # customize size
     options[:src] = email.respond_to?(:gravatar_url) ? email.gravatar_url(url_options) : build_gravatar_url(email, url_options)
-    options
+    Gravatarify::Helper.html_options.merge(options)
   end
   
   # Takes care of creating an <tt><img/></tt>-tag based on a gravatar url, it no longer
   # makes use of any Rails helper, so is totally useable in any other library.
+  #
+  # @param [String, #email, #mail, #gravatar_url] email a string or an object used
+  #        to generate the gravatar url from
+  # @param [Hash] options other gravatar or html options for building the resulting
+  #        image tag.
+  # @return [String] a complete and hopefully valid +img+ tag.
   def gravatar_tag(email, options = {})
     html_attrs = gravatar_attrs(email, options).map do |key,value|
       escaped = defined?(Rack::Utils) ? Rack::Utils.escape_html(value) : CGI.escapeHTML(value)

data/lib/gravatarify/object_support.rb

@@ -16,8 +16,9 @@
 #      include DataMapper::Resource
 #      property ...
 #      property :author_email, String
+#      gravatarify :author_email
 #    end
-#    @user.gravatar_url :author_email # that's it, using the specified field!
+#    @user.gravatar_url # that's it, using the specified field!
 #
 # And finally, using a plain old ruby object:
 #

data/test/test_helper.rb

@@ -13,7 +13,13 @@ Test::Unit::TestCase.send :include, RR::Adapters::TestUnit
 # Reset +Gravatarify+ to default hosts and cleared options
 def reset_gravatarify!
   Gravatarify.options.clear
-  Gravatarify.subdomains = Gravatarify::GRAVATAR_SUBDOMAINS
+  Gravatarify.options[:filetype] = :jpg
+  Gravatarify.subdomains = %w{ 0 1 2 www }
+  
+  if defined?(Gravatarify::Helper)
+    Gravatarify::Helper.html_options.clear
+    Gravatarify::Helper.html_options[:alt] = ''
+  end
 end
 
 # some often used values...

data/test/unit/gravatarify_base_test.rb

@@ -46,9 +46,12 @@ class GravatarifyBaseTest < Test::Unit::TestCase
       assert_equal "#{BELLA_AT_GMAIL}.png", build_gravatar_url('bella@gmail.com', :filetype => :png)
     end
   
-    should "skip :filetype if set to false" do
-      assert_equal "#{BELLA_AT_GMAIL}", build_gravatar_url('bella@gmail.com', :filetype => false)      
-      assert_equal "#{BELLA_AT_GMAIL_JPG}", build_gravatar_url('bella@gmail.com', :filetype => nil)      
+    should "skip :filetype if set to false, nil or ''" do
+      assert_equal "#{BELLA_AT_GMAIL}", build_gravatar_url('bella@gmail.com', :filetype => false)
+      assert_equal "#{BELLA_AT_GMAIL}", build_gravatar_url('bella@gmail.com', :filetype => nil)
+      assert_equal "#{BELLA_AT_GMAIL}", build_gravatar_url('bella@gmail.com', :filetype => '')
+      assert_equal "#{BELLA_AT_GMAIL}.foobar", build_gravatar_url('bella@gmail.com', :filetype => 'foobar')
+      assert_equal "#{BELLA_AT_GMAIL}.gif", build_gravatar_url('bella@gmail.com', :filetype => :gif)
     end
     
     should "handle Procs as :default, to easily generate default urls based on supplied :size" do

data/test/unit/gravatarify_helper_test.rb

@@ -19,22 +19,18 @@ class GravatarifyHelpersTest < Test::Unit::TestCase
   context "#gravatar_attrs" do
     should "return hash with :height, :width, :alt and :src defined" do
       hash = gravatar_attrs('bella@gmail.com', :size => 16)
-      assert_equal "#{BELLA_AT_GMAIL_JPG}?s=16", hash[:src]
-      assert_equal 16, hash[:width]
-      assert_equal 16, hash[:height]
-      assert_equal 'bella@gmail.com', hash[:alt]
+      expected = { :alt => "", :src => "#{BELLA_AT_GMAIL_JPG}?s=16", :width => 16, :height => 16 }
+      assert_equal expected, hash
       assert_nil hash[:size]
     end
     
     should "allow any param to be defined/overridden, except src, width and heigth" do
       hash = gravatar_attrs('bella@gmail.com', :size => 20, :r => :x, :height => 40, :alt => 'bella', :id => 'test', :title => 'something', :class => 'gravatar')
-      assert_equal "#{BELLA_AT_GMAIL_JPG}?r=x&s=20", hash[:src]
-      assert_equal 20, hash[:width]
-      assert_equal 20, hash[:height]
-      assert_equal 'bella', hash[:alt]
-      assert_equal 'test', hash[:id]
-      assert_equal 'something', hash[:title]
-      assert_equal 'gravatar', hash[:class]
+      expected = {
+        :alt => 'bella', :src => "#{BELLA_AT_GMAIL_JPG}?r=x&s=20", :width => 20, :height => 20,
+        :id => 'test', :title => 'something', :class => 'gravatar'
+      }
+      assert_equal expected, hash
       assert_nil hash[:size]
       assert_nil hash[:r]
     end
@@ -42,18 +38,18 @@ class GravatarifyHelpersTest < Test::Unit::TestCase
   
   context "#gravatar_tag helper" do
     should "create <img/> tag with correct gravatar urls" do
-      assert_equal '<img alt="bella@gmail.com" height="80" src="http://0.gravatar.com/avatar/1cacf1bc403efca2e7a58bcfa9574e4d.jpg" width="80" />', gravatar_tag('bella@gmail.com')
+      assert_equal '<img alt="" height="80" src="http://0.gravatar.com/avatar/1cacf1bc403efca2e7a58bcfa9574e4d.jpg" width="80" />', gravatar_tag('bella@gmail.com')
     end
     
     should "create <img/> tags and handle all options correctly, other options should be passed to Rails' image_tag" do
-      assert_equal '<img alt="bella@gmail.com" height="16" src="http://0.gravatar.com/avatar/1cacf1bc403efca2e7a58bcfa9574e4d.jpg?s=16" width="16" />',
+      assert_equal '<img alt="" height="16" src="http://0.gravatar.com/avatar/1cacf1bc403efca2e7a58bcfa9574e4d.jpg?s=16" width="16" />',
               gravatar_tag('bella@gmail.com', :size => 16)
-      assert_equal '<img alt="bella@gmail.com" class="gravatar" height="16" src="http://0.gravatar.com/avatar/1cacf1bc403efca2e7a58bcfa9574e4d.jpg?d=x&amp;s=16" width="16" />',
+      assert_equal '<img alt="" class="gravatar" height="16" src="http://0.gravatar.com/avatar/1cacf1bc403efca2e7a58bcfa9574e4d.jpg?d=x&amp;s=16" width="16" />',
               gravatar_tag('bella@gmail.com', :class => "gravatar", :size => 16, :d => "x")
     end
     
     should "ensure that all values are correctly html-esacped!" do
-      assert_equal '<img alt="bella@gmail.com" height="80" src="http://0.gravatar.com/avatar/1cacf1bc403efca2e7a58bcfa9574e4d.jpg" title="&lt;&gt;" width="80" />',
+      assert_equal '<img alt="" height="80" src="http://0.gravatar.com/avatar/1cacf1bc403efca2e7a58bcfa9574e4d.jpg" title="&lt;&gt;" width="80" />',
               gravatar_tag('bella@gmail.com', :title => '<>')
     end
   end
@@ -61,18 +57,53 @@ class GravatarifyHelpersTest < Test::Unit::TestCase
   context "#gravatar_tag when passed in an object" do
     should "create <img/>-tag based on :email field" do
       obj = Object.new
-      mock(obj).email.times(2) { "bella@gmail.com" }
+      mock(obj).email { "bella@gmail.com" }
       
-      assert_equal '<img alt="bella@gmail.com" height="80" src="http://0.gravatar.com/avatar/1cacf1bc403efca2e7a58bcfa9574e4d.jpg" width="80" />',
+      assert_equal '<img alt="" height="80" src="http://0.gravatar.com/avatar/1cacf1bc403efca2e7a58bcfa9574e4d.jpg" width="80" />',
                       gravatar_tag(obj)      
     end
     
     should "create <img/>-tag based on gravatar_url from object if object responds to gravatar_url" do
       obj = Object.new
+      mock(obj).name { "Mr. X" }
       mock(obj).gravatar_url({ :size => 16 }) { "http://0.gravatar.com/avatar/1cacf1bc403efca2e7a58bcfa9574e4d.jpg?s=16" }
       
-      assert_equal '<img alt="Gravatar" height="16" src="http://0.gravatar.com/avatar/1cacf1bc403efca2e7a58bcfa9574e4d.jpg?s=16" width="16" />',
-                      gravatar_tag(obj, :size => 16, :alt => "Gravatar")
+      assert_equal '<img alt="Gravatar for Mr. X" height="16" src="http://0.gravatar.com/avatar/1cacf1bc403efca2e7a58bcfa9574e4d.jpg?s=16" width="16" />',
+                      gravatar_tag(obj, :size => 16, :alt => "Gravatar for #{obj.name}")
     end
-  end  
+  end
+  
+  context "Gravatarify::Helper#html_options" do
+    should "add be added to all tags/hashes created by gravatar_tag or gravatar_attrs" do
+      Gravatarify::Helper.html_options[:title] = "Gravatar" # add a title attribute, yeah neat-o!
+      Gravatarify::Helper.html_options[:class] = "gravatar"
+      
+      assert_equal '<img alt="" class="gravatar" height="80" src="http://0.gravatar.com/avatar/1cacf1bc403efca2e7a58bcfa9574e4d.jpg" title="Gravatar" width="80" />',
+                      gravatar_tag('bella@gmail.com')
+      hash = gravatar_attrs('bella@gmail.com', :size => 20, :title => "Gravatar for Bella", :id => "test")
+      expected = {
+        :alt => "", :width => 20, :height => 20, :src => "http://0.gravatar.com/avatar/1cacf1bc403efca2e7a58bcfa9574e4d.jpg?s=20",
+        :title => "Gravatar for Bella", :id => "test", :class => "gravatar"
+      }
+      assert_equal expected, hash
+    end
+    
+    should "not allow :src, :height or :width to be set via global options and all local options should override!" do
+      Gravatarify::Helper.html_options[:src] = "avatar-30.jpg"
+      Gravatarify::Helper.html_options[:width] = 30
+      Gravatarify::Helper.html_options[:title] = "Avatar"
+      
+      assert_equal '<img alt="" height="25" src="http://0.gravatar.com/avatar/1cacf1bc403efca2e7a58bcfa9574e4d.jpg?s=25" title="Gravatar" width="25" />',
+                   gravatar_tag('bella@gmail.com', :size => 25, :title => 'Gravatar')
+    end
+    
+    should "allow :alt to be set globally" do
+      Gravatarify::Helper.html_options[:alt] = "Gravatar"
+      
+      assert_equal '<img alt="Gravatar" height="80" src="http://0.gravatar.com/avatar/1cacf1bc403efca2e7a58bcfa9574e4d.jpg" width="80" />',
+                   gravatar_tag('bella@gmail.com')
+      assert_equal '<img alt="Avatar" height="80" src="http://0.gravatar.com/avatar/1cacf1bc403efca2e7a58bcfa9574e4d" width="80" />',
+                   gravatar_tag('bella@gmail.com', :filetype => false, :alt => 'Avatar')
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: gravatarify
 version: !ruby/object:Gem::Version 
-  version: 1.2.0
+  version: 1.2.1
 platform: ruby
 authors: 
 - Lukas Westermann
@@ -9,13 +9,14 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-10-23 00:00:00 +02:00
+date: 2009-10-27 00:00:00 +01:00
 default_executable: 
 dependencies: []
 
 description: |-
-  Yet another ruby/rails gravatar plugin - though, one with unique options like 
-      `Proc`s for default images, or support for gravatar.com's multiple host names.
+  Awesome gravatar support for Ruby (and Rails, DataMapper, Haml) -
+      with unique options like Proc's for default images, or
+      support for gravatar.com's multiple host names.
 email: lukas.westermann@gmail.com
 executables: []
 
@@ -69,7 +70,7 @@ rubyforge_project:
 rubygems_version: 1.3.5
 signing_key: 
 specification_version: 3
-summary: Awesome gravatar support for ruby (and rails).
+summary: Awesome gravatar support for Ruby (and Rails, DataMapper, Haml).
 test_files: 
 - test/test_helper.rb
 - test/unit/gravatarify_ar_dm_test.rb