gravatarify 1.0.0 → 1.1.0

data/README.md

@@ -4,11 +4,11 @@ Removes any hassles building those pesky gravatar urls, it's not there arent any
 [there](http://github.com/chrislloyd/gravtastic), but none seem to support stuff like `Proc`s for the default picture url, or
 the multiple host names supported by gravatar.com (great when displaying lots of avatars).
 
-And it integrates seamlessly with Rails, Merb and even plain old Ruby.
+And it integrates seamlessly with Rails, DataMapper and even plain old Ruby.
 
-- **Source**: [http://github.com/lwe/gravatarify](http://github.com/lwe/gravatarify)
-- **Docs**:   [http://rdoc.info/projects/lwe/gravatarify](http://rdoc.info/projects/lwe/gravatarify)
-- **Gem**:    [http://gemcutter.org/gems/gravatarify](http://gemcutter.org/gems/gravatarify)
+- **Source**: <http://github.com/lwe/gravatarify>
+- **Docs**:   <http://rdoc.info/projects/lwe/gravatarify>
+- **Gem**:    <http://gemcutter.org/gems/gravatarify>
 
 ## Install
 
@@ -31,13 +31,12 @@ and then `require 'gravatarify'` it.
 
 This library provides...
 
- * ...object/model helpers, so that an object responds to `gravatar_url`, see [using the model helpers](#l_model_helpers).
+ * ...object/model helpers, so that an object responds to `gravatar_url`, see "Using the model helpers"
    Works also very well with plain old ruby objects.
- * ...Rails view helpers, namely `gravatar_url` and `gravatar_tag`, see [using the view helpers](#l_view_helpers). This is rails only though!
+ * ...Rails view helpers, namely `gravatar_url` and `gravatar_tag`, see "Using the view helpers". This is rails only though!
  * ...and finally, a base module which provides the gravatar url generation, ready to be integrated into
-   custom helpers, plain ruby code or whatever, see [back to the roots](#l_roots)
+   custom helpers, plain ruby code or whatever, see "Back to the roots".
 
-<a id="l_view_helpers"/>
 ## Using the view helpers (Rails only!)
 
 Probably one of the easiest ways to add support for gravatar images is with the included view helpers:
@@ -58,7 +57,6 @@ Using rails `image_tag` to create an `<img/>`-tag with `gravatar_url`. It's impo
 also an object can be passed to `gravatar_url`, if it responds to either `email` or `mail`. If not (like
 in the example above), the email address must be passed in.
 
-<a id="l_model_helpers"/>
 ## Using the model helpers
 
 A very simple method to add `gravatar_url` support to models is by using the `gravatarify` class method.
@@ -108,7 +106,6 @@ class:
 Tadaaa! Works exactly like the model helpers, so it's now possible to call `gravatar_url` on instances
 of `PoroUser`.
 
-<a id="l_roots"/>
 ## Back to the roots?
 
 No need for sophisticated stuff like view helpers and ActiveRecord integration, want to go back to the roots?
@@ -187,8 +184,13 @@ to generate an image url, based on the request size:
     @user.gravatar_url(:size => 16)
     # => "http://0.gravatar.com/...jpg?d=http%3A%2F%2Fexample.com%2Fgravatar-16.jpg&s=16"
     
-Into the block is passed the options hash and as second parameter the object itself, so in the example above
-`object` would be `@user`, might be useful!? Never used it, so I might remove the second argument...
+Into the block is passed the options hash and as second parameter the object itself, so it's possible to do stuff like
+
+    # doing stuff like showing default avatar based on gender...
+    @user = User.new(:gender => :female, :email => 'bella@gmail.com') # => @user.female? = true
+    
+    @user.gravatar_url :default => Proc.new { |opts, obj| "http://example.com/avatar#{obj.respond_to?(:female) && obj.female? ? '_female' : ''}.jpg" }
+    # => http://0.gravatar.com/...jpg?d=http%3A%2F%2Fexample.com%2Fgravatar_female.jpg
 
 Not only the `:default` option accepts a Proc, but also `:secure`, can be useful to handle cases where
 it should evaluate against `request.ssl?` for example.

data/VERSION.yml

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

data/init.rb

@@ -1,2 +1 @@
-# Include hook code here
-require File.join(File.dirname(__FILE__), 'lib', 'gravatarify')
+require File.join(File.dirname(__FILE__), 'rails', 'init')

data/lib/gravatarify.rb

@@ -3,13 +3,9 @@
 # Base -> provides the basic gravatar_url method, can also be used for
 # custom implementations, just include Gravatarify::Base.
 require 'gravatarify/base'
-require 'gravatarify/view_helper'
 require 'gravatarify/object_support'
 
-# include helper for rails
-ActionView::Base.send(:include, Gravatarify::ViewHelper) if defined?(ActionView)
-
 # setup for AR und DataMapper, note: DataMapper yet untested :) but I suppose it works, because
 # it works as expected on plain old ruby objects!
 ActiveRecord::Base.send(:include, Gravatarify::ObjectSupport) if defined?(ActiveRecord)
-DataMapper::Model.append_inclusions(Gravatarify::ObjectSupport) if defined?(DataMapper)
+DataMapper::Model.append_inclusions(Gravatarify::ObjectSupport) if defined?(DataMapper)

data/lib/gravatarify/base.rb

@@ -1,5 +1,5 @@
 require 'digest/md5'
-require 'cgi'
+begin; require 'rack/utils'; rescue LoadError; require 'cgi' end
 
 module Gravatarify
   # Subdomains used for balancing
@@ -56,6 +56,8 @@ module Gravatarify
     # Get subdomain for supplied string or returns +GRAVATAR_DEFAULT_SUBDOMAIN+ if none is
     # defined.
     def subdomain(str); subdomains[str.hash % subdomains.size] || GRAVATAR_DEFAULT_SUBDOMAIN end
+    
+    def escape(str); defined?(Rack::Utils) ? Rack::Utils.escape(str) : CGI.escape(str) end
   end
   
   # Provides core support to build gravatar urls based on supplied e-mail strings.
@@ -101,21 +103,32 @@ module Gravatarify
       # 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)
-      build_gravatar_host(email_hash, url_options.delete(:secure)) << "/avatar/#{email_hash}.#{url_options.delete(:filetype) || GRAVATAR_DEFAULT_FILETYPE}#{build_gravatar_options(url_options)}"
+      
+      build_gravatar_host(email_hash, url_options.delete(:secure)) <<
+            "/avatar/#{email_hash}.#{url_options.delete(:filetype) || GRAVATAR_DEFAULT_FILETYPE}#{build_gravatar_options(email, url_options)}"
     end
   
     private
+      # Builds gravatar host name from supplied e-mail hash.
+      # Ensures that for the same +str_hash+ always the same subdomain is used.
+      #
+      # @param [String] str_hash email, as hashed string as described in gravatar.com implementation specs
+      # @param [Boolean, Proc] secure if set to +true+ then uses gravatars secure host (<tt>https://secure.gravatar.com</tt>),
+      #        else that subdomain magic. If it's passed in a +Proc+, it's evaluated and the result (+true+/+false+) is used
+      #        for the same decicion.
+      # @return [String] Protocol and hostname (like <tt>http://www.gravatar.com</tt>), without trailing slash.
       def build_gravatar_host(str_hash, secure = false)
         secure = secure.call(self) if secure.respond_to?(:call)
         secure ? "https://secure.gravatar.com" : "http://#{Gravatarify.subdomain(str_hash)}.gravatar.com"        
       end
     
-      def build_gravatar_options(url_options = {})
+      # Builds a query string from all passed in options.
+      def build_gravatar_options(source, url_options = {})
         params = []
         url_options.each_pair do |key, value|
           key = GRAVATAR_ABBREV_OPTIONS[key] if GRAVATAR_ABBREV_OPTIONS.include?(key) # shorten key!
-          value = value.call(url_options, self) if key.to_s == 'd' and value.respond_to?(:call)
-          params << "#{CGI.escape(key.to_s)}=#{CGI.escape(value.to_s)}" if value
+          value = value.call(url_options, source.is_a?(String) ? self : source) if key.to_s == 'd' and value.respond_to?(:call)
+          params << "#{Gravatarify.escape(key.to_s)}=#{Gravatarify.escape(value.to_s)}" if value
         end
         "?#{params.sort * '&'}" unless params.empty?
       end

data/rails/init.rb

@@ -0,0 +1,7 @@
+require 'gravatarify'
+
+# load view helpers only if ActionView is available
+if defined?(ActionView)
+  require 'gravatarify/view_helper'
+  ActionView::Base.send(:include, Gravatarify::ViewHelper)
+end

data/test/gravatarify_base_test.rb

@@ -83,6 +83,19 @@ class GravatarifyBaseTest < Test::Unit::TestCase
       
       assert_equal "http://0.gravatar.com/avatar/1cacf1bc403efca2e7a58bcfa9574e4d.jpg", build_gravatar_url(obj)      
     end
+    
+    should "handle Procs as :default and pass in the 'object' as second parameter" do
+      default = Proc.new { |options, object| "http://example.com/gravatar#{object.respond_to?(:female?) && object.female? ? '_girl' : ''}.jpg" }
+      girl = Object.new
+      mock(girl).email { "bella@gmail.com" }
+      mock(girl).female? { true }      
+      assert_equal "http://0.gravatar.com/avatar/1cacf1bc403efca2e7a58bcfa9574e4d.jpg?d=http%3A%2F%2Fexample.com%2Fgravatar_girl.jpg", build_gravatar_url(girl, :default => default)
+      
+      boy = Object.new
+      mock(boy).email { "hans@gmail.com" }
+      mock(boy).female? { false }
+      assert_equal "http://www.gravatar.com/avatar/b6987c8f1d734e684cf9721970b906e5.jpg?d=http%3A%2F%2Fexample.com%2Fgravatar.jpg", build_gravatar_url(boy, :default => default)      
+    end    
   end
   
   context "Gravatar hosts support" do

data/test/gravatarify_object_support_test.rb

@@ -2,70 +2,62 @@ require 'test_helper'
 require 'gravatarify/base'
 require 'gravatarify/object_support'
 
+class PoroUser
+  include Gravatarify::ObjectSupport
+  attr_accessor :email, :gender
+  def initialize(attributes = {})
+    attributes.each do |key, value|
+      self.send "#{key}=", value
+    end
+  end
+end
+
 class GravatarifyObjectSupportTest < Test::Unit::TestCase
   def setup; reset_gravatarify! end
   
   context "#gravatarify" do
     should "add support for #gravatar_url to POROs (plain old ruby objects, yeah POJO sounds better!)" do
-      poro = Class.new do
-        include Gravatarify::ObjectSupport
-        gravatarify
-        def email; "mike@shiva.ch" end
-      end
-      assert_equal "http://0.gravatar.com/avatar/1b2818d77eadd6c9dbbe7f3beb1492c3.jpg", poro.new.gravatar_url
-      assert_equal "https://secure.gravatar.com/avatar/1b2818d77eadd6c9dbbe7f3beb1492c3.jpg", poro.new.gravatar_url(:secure => true)
-      assert_equal "http://0.gravatar.com/avatar/1b2818d77eadd6c9dbbe7f3beb1492c3.gif?r=x&s=16", poro.new.gravatar_url(:filetype => :gif, :rating => :x, :size => 16)
+      poro = Class.new(PoroUser) { gravatarify }
+      mike_shiva = poro.new(:email => 'mike@shiva.ch')
+      assert_equal "http://0.gravatar.com/avatar/1b2818d77eadd6c9dbbe7f3beb1492c3.jpg", mike_shiva.gravatar_url
+      assert_equal "https://secure.gravatar.com/avatar/1b2818d77eadd6c9dbbe7f3beb1492c3.jpg", mike_shiva.gravatar_url(:secure => true)
+      assert_equal "http://0.gravatar.com/avatar/1b2818d77eadd6c9dbbe7f3beb1492c3.gif?r=x&s=16", mike_shiva.gravatar_url(:filetype => :gif, :rating => :x, :size => 16)
     end
     
     should "allow some default options to be passed, which can be overriden locally, though" do
-      poro = Class.new do
-        include Gravatarify::ObjectSupport
-        gravatarify :secure => true, :filetype => :gif
-        def email; "mike@shiva.ch" end
-      end
-      assert_equal "https://secure.gravatar.com/avatar/1b2818d77eadd6c9dbbe7f3beb1492c3.gif", poro.new.gravatar_url
-      assert_equal "http://0.gravatar.com/avatar/1b2818d77eadd6c9dbbe7f3beb1492c3.gif", poro.new.gravatar_url(:secure => false)
-      assert_equal "https://secure.gravatar.com/avatar/1b2818d77eadd6c9dbbe7f3beb1492c3.jpg?r=x&s=16", poro.new.gravatar_url(:filetype => :jpg, :rating => :x, :size => 16)      
+      poro = Class.new(PoroUser) { gravatarify :secure => true, :filetype => :gif }
+      mike_shiva = poro.new(:email => 'mike@shiva.ch')
+      assert_equal "https://secure.gravatar.com/avatar/1b2818d77eadd6c9dbbe7f3beb1492c3.gif", mike_shiva.gravatar_url
+      assert_equal "http://0.gravatar.com/avatar/1b2818d77eadd6c9dbbe7f3beb1492c3.gif", mike_shiva.gravatar_url(:secure => false)
+      assert_equal "https://secure.gravatar.com/avatar/1b2818d77eadd6c9dbbe7f3beb1492c3.jpg?r=x&s=16", mike_shiva.gravatar_url(:filetype => :jpg, :rating => :x, :size => 16)      
     end
     
     should "still respect options set by Gravatarify#options" do
       Gravatarify.options[:size] = 20
-      poro = Class.new do
-        include Gravatarify::ObjectSupport
-        gravatarify
-        def email; "mike@shiva.ch" end
-      end
-      assert_equal "http://0.gravatar.com/avatar/1b2818d77eadd6c9dbbe7f3beb1492c3.jpg?s=20", poro.new.gravatar_url
+      poro = Class.new(PoroUser) { gravatarify }      
+      assert_equal "http://0.gravatar.com/avatar/1b2818d77eadd6c9dbbe7f3beb1492c3.jpg?s=20", poro.new(:email => 'mike@shiva.ch').gravatar_url
     end
     
     should "be able to override options set by Gravatarify#options" do
       Gravatarify.options[:size] = 20
-      poro = Class.new do
-        include Gravatarify::ObjectSupport
-        gravatarify :size => 25
-        def email; "mike@shiva.ch" end
-      end
-      assert_equal "http://0.gravatar.com/avatar/1b2818d77eadd6c9dbbe7f3beb1492c3.jpg?s=25", poro.new.gravatar_url
+      poro = Class.new(PoroUser) { gravatarify :size => 25 }
+      assert_equal "http://0.gravatar.com/avatar/1b2818d77eadd6c9dbbe7f3beb1492c3.jpg?s=25", poro.new(:email => 'mike@shiva.ch').gravatar_url
     end    
   end
   
   context "#gravatarify with custom fields" do
     should "detect and use the 'email' field automatically" do
-      poro = Class.new do
-        include Gravatarify::ObjectSupport
-        gravatarify
-        def email; "mike@shiva.ch" end
-      end
-      assert_equal "http://0.gravatar.com/avatar/1b2818d77eadd6c9dbbe7f3beb1492c3.jpg", poro.new.gravatar_url
+      poro = Class.new(PoroUser) { gravatarify }
+      assert_equal "http://0.gravatar.com/avatar/1b2818d77eadd6c9dbbe7f3beb1492c3.jpg", poro.new(:email => 'mike@shiva.ch').gravatar_url
     end
     
     should "fallback to 'mail' if 'email' is not defined" do
-      poro = Class.new do
-        include Gravatarify::ObjectSupport
+      poro = Class.new(PoroUser) do
         gravatarify
-        def mail; "mike@shiva.ch" end
+        undef :email, :email=
+        attr_accessor :mail
       end
-      assert_equal "http://0.gravatar.com/avatar/1b2818d77eadd6c9dbbe7f3beb1492c3.jpg", poro.new.gravatar_url      
+      assert_equal "http://0.gravatar.com/avatar/1b2818d77eadd6c9dbbe7f3beb1492c3.jpg", poro.new(:mail => 'mike@shiva.ch').gravatar_url      
     end
     
     should "raise NoMethodError if object does not respond to source" do
@@ -77,23 +69,41 @@ class GravatarifyObjectSupportTest < Test::Unit::TestCase
     end
     
     should "allow to set custom source, like author_email" do
-      poro = Class.new do
-        include Gravatarify::ObjectSupport
+      poro = Class.new(PoroUser) do
         gravatarify :author_email
-        def author_email; "mike@shiva.ch" end
+        attr_accessor :author_email
       end
-      assert_equal "http://0.gravatar.com/avatar/1b2818d77eadd6c9dbbe7f3beb1492c3.jpg", poro.new.gravatar_url      
+      assert_equal "http://0.gravatar.com/avatar/1b2818d77eadd6c9dbbe7f3beb1492c3.jpg", poro.new(:author_email => 'mike@shiva.ch').gravatar_url      
     end
     
     should "allow multiple sources to be defined, yet still handle options!" do
-      poro = Class.new do
-        include Gravatarify::ObjectSupport
+      poro = Class.new(PoroUser) do
         gravatarify :email, :employee_email, :default => Proc.new { |*args| "http://initech.com/avatar-#{args.first[:size] || 80}.jpg" }
-        def email; "info@initech.com" end
-        def employee_email; "peter.gibbons@initech.com" end
+        attr_accessor :employee_email
+      end
+      peter_gibbons = poro.new(:email => 'info@initech.com', :employee_email => 'peter.gibbons@initech.com')
+      assert_equal "http://2.gravatar.com/avatar/4979dd9653e759c78a81d4997f56bae2.jpg?d=http%3A%2F%2Finitech.com%2Favatar-20.jpg&s=20", peter_gibbons.gravatar_url(:size => 20)
+      assert_equal "http://0.gravatar.com/avatar/cb7865556d41a3d800ae7dbb31d51d54.jpg?d=http%3A%2F%2Finitech.com%2Favatar-25.jpg&s=25", peter_gibbons.employee_gravatar_url(:size => 25)
+    end
+    
+    should "use full prefix, if not suffixed by email" do
+      poro = Class.new(PoroUser) do
+        gravatarify :email, :employee_login
+        attr_accessor :employee_login
+      end
+      peter_gibbons = poro.new(:email => 'peter.gibbons@initech.com', :employee_login => 'peter.gibbons@initech.com')
+      assert_respond_to peter_gibbons, :employee_login_gravatar_url
+      assert_equal "http://0.gravatar.com/avatar/cb7865556d41a3d800ae7dbb31d51d54.jpg?s=25", peter_gibbons.employee_login_gravatar_url(:size => 25)      
+    end
+    
+    should "pass in object as second parameter, not supplied string" do
+      poro = Class.new(PoroUser) do
+        gravatarify :default => Proc.new { |opts, obj| "http://initech.com/avatar#{obj.respond_to?(:gender) && obj.gender == :female ? '_girl' : ''}.jpg" }
       end
-      assert_equal "http://2.gravatar.com/avatar/4979dd9653e759c78a81d4997f56bae2.jpg?d=http%3A%2F%2Finitech.com%2Favatar-20.jpg&s=20", poro.new.gravatar_url(:size => 20)
-      assert_equal "http://0.gravatar.com/avatar/cb7865556d41a3d800ae7dbb31d51d54.jpg?d=http%3A%2F%2Finitech.com%2Favatar-25.jpg&s=25", poro.new.employee_gravatar_url(:size => 25)
+      peter_gibbons = poro.new(:email => 'peter.gibbons@initech.com', :gender => :male)
+      jane = poro.new(:email => 'jane@initech.com', :gender => :female)
+      assert_equal "http://0.gravatar.com/avatar/cb7865556d41a3d800ae7dbb31d51d54.jpg?d=http%3A%2F%2Finitech.com%2Favatar.jpg&s=25", peter_gibbons.gravatar_url(:s => 25)
+      assert_equal "http://1.gravatar.com/avatar/9b78f3f45cf32d7c52d304a63f6aef06.jpg?d=http%3A%2F%2Finitech.com%2Favatar_girl.jpg&s=35", jane.gravatar_url(:s => 35)
     end
   end
 end

data/test/gravatarify_rack_vs_cgi_test.rb

@@ -0,0 +1,25 @@
+require 'test_helper'
+require 'gravatarify/base'
+
+class GravatarifyRackVsCgiTest < Test::Unit::TestCase
+  include Gravatarify::Base
+  
+  # Reload Rack::Utils
+  def teardown
+    begin; require('rack/utils'); rescue LoadError; end
+  end
+
+  context "if Rack::Utils is not available, #gravatarify" do
+    setup do
+      # Remove Rack if defined
+      Object.send(:remove_const, :Rack) if defined?(Rack)
+    end
+    
+    should "fallback to CGI#escape" do
+      assert !defined?(Rack::Utils), 'Rack::Utils should no longer be defined'
+      assert defined?(CGI), "CGI should be defined"
+      assert_equal "http://0.gravatar.com/avatar/1cacf1bc403efca2e7a58bcfa9574e4d.jpg?escaped%2Fme=escaped%2Fme",
+                   build_gravatar_url('bella@gmail.com', 'escaped/me' => 'escaped/me')
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: gravatarify
 version: !ruby/object:Gem::Version 
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors: 
 - Lukas Westermann
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-10-02 00:00:00 +02:00
+date: 2009-10-09 00:00:00 +02:00
 default_executable: 
 dependencies: []
 
@@ -34,9 +34,11 @@ files:
 - lib/gravatarify/base.rb
 - lib/gravatarify/object_support.rb
 - lib/gravatarify/view_helper.rb
+- rails/init.rb
 - test/gravatarify_base_test.rb
 - test/gravatarify_integration_test.rb
 - test/gravatarify_object_support_test.rb
+- test/gravatarify_rack_vs_cgi_test.rb
 - test/gravatarify_subdomain_test.rb
 - test/gravatarify_view_helper_test.rb
 - test/test_helper.rb
@@ -72,6 +74,7 @@ test_files:
 - test/gravatarify_base_test.rb
 - test/gravatarify_integration_test.rb
 - test/gravatarify_object_support_test.rb
+- test/gravatarify_rack_vs_cgi_test.rb
 - test/gravatarify_subdomain_test.rb
 - test/gravatarify_view_helper_test.rb
 - test/test_helper.rb