base.rb in gravatarify-2.0.3

- old
+ new

@@ -1,18 +1,15 @@
 require 'digest/md5'
-begin; require 'rack/utils'; rescue LoadError; require 'cgi' end
 
-module Gravatarify  
-  # List of known and valid gravatar options (includes shortened options).
-  GRAVATAR_OPTIONS = [ :default, :d, :rating, :r, :size, :s, :secure, :filetype ]
-
-  # Hash of :ultra_long_option_name => 'abbrevated option'
-  GRAVATAR_ABBREV_OPTIONS = { :default => 'd', :rating => 'r', :size => 's' }
+module Gravatarify
+  # Hash of 'ultra_long_option_name' => 'abbrevated option'
+  # :nodoc:
+  GRAVATAR_ABBREV_OPTIONS = { 'default' => 'd', 'rating' => 'r', 'size' => 's' }
   
   class << self
     # Globally define options which are then merged on every call to
-    # +build_gravatar_url+, this is useful to e.g. define the default image.
+    # +gravatar_url+, this is useful to e.g. define the default image.
     #
     # Setting global options should be done (for Rails apps) in an initializer:
     #
     #     # set the default image using a Proc
     #     Gravatarify.options[:default] = Proc.new { |*args| "http://example.com/avatar-#{args.first[:size] || 80}.jpg" }
@@ -23,69 +20,64 @@
     #     # or disable adding an extension
     #     Gravatarify.options[:filetype] = false
     #
     def options; @options ||= { :filetype => :jpg } end
   
+    # Allows to define some styles, makes it simpler to call by name, instead of always giving a size etc.
+    # 
+    #   Gravatarify.styles[:mini] => { :size => 30, :default => "http://example.com/gravatar-mini.jpg" }
+    # 
+    #   # in the views, it will then use the stuff defined by styles[:mini]:
+    #   <%= gravatar_tag @user, :mini %>
+    #
+    def styles; @styles ||= {} end
+    
     # Globally overide subdomains used to build gravatar urls, normally
     # +gravatarify+ picks from either +0.gravatar.com+, +1.gravatar.com+,
     # +2.gravatar.com+ or +www.gravatar.com+ when building hosts, to use a custom
     # set of subdomains (or none!) do something like:
     #
     #     Gravatarify.subdomains = %w{ 0 www } # only use 0.gravatar.com and www.gravatar.com
     #
-    #     Gravatarify.subdomain = 'www' # only use www! (PS: subdomain= is an alias)
-    #
     def subdomains=(subdomains) @subdomains = [*subdomains] end
-    alias_method :subdomain=, :subdomains=
     
-    # Shortcut method to reset subdomains to only build +www.gravatar.com+ urls,
-    # i.e. disable host balancing!
-    def use_www_only!; self.subdomains = %w{ www } 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 +www+ if none is
     # defined.
-    def subdomain(str); subdomains[str.hash % subdomains.size] || 'www' end
-    
-    # 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) #:nodoc:
-      str = str.to_s unless str.is_a?(String) # convert to string!
-      defined?(Rack::Utils) ? Rack::Utils.escape(str) : CGI.escape(str)
+    def subdomain(str) #:nodoc:
+      @subdomains ||= %w{ 0 1 2 www }
+      @subdomains[str.hash % @subdomains.size] || 'www'
     end
   end
   
   # Provides core support to build gravatar urls based on supplied e-mail strings.
   module Base
     
     # Method which builds a gravatar url based on a supplied email and options as
     # defined by gravatar.com (http://en.gravatar.com/site/implement/url).
     #
-    #    build_gravatar_url('peter.gibbons@initech.com', :size => 16) # => "http://0.gravatar.com/avatar/cb7865556d41a3d800ae7dbb31d51d54.jpg?s=16"
+    #    gravatar_url('peter.gibbons@initech.com', :size => 16) # => "http://0.gravatar.com/avatar/cb7865556d41a3d800ae7dbb31d51d54.jpg?s=16"
     #
     # It supports multiple gravatar hosts (based on email hash), i.e. depending
     # on the hash, either <tt>0.gravatar.com</tt>, <tt>1.gravatar.com</tt>, <tt>2.gravatar.com</tt> or <tt>www.gravatar.com</tt>
     # is used.
     #
     # If supplied +email+ responds to either a method named +email+ or +mail+, the value of that method
     # is used instead to build the gravatar hash. Very useful to just pass in ActiveRecord object for instance:
     #    
     #    @user = User.find_by_email("samir@initech.com")
-    #    build_gravatar_url(@user) # => "http://2.gravatar.com/avatar/58cf31c817d76605d5180ce1a550d0d0.jpg"
-    #    build_gravatar_url(@user.email) # same as above!
+    #    gravatar_url(@user) # => "http://2.gravatar.com/avatar/58cf31c817d76605d5180ce1a550d0d0.jpg"
+    #    gravatar_url(@user.email) # same as above!
     # 
     # Among all options as defined by gravatar.com's specification, there also exist some special options:
     #
-    #    build_gravatar_url(@user, :secure => true) # => https://secure.gravatar.com/ava....
+    #    gravatar_url(@user, :secure => true) # => https://secure.gravatar.com/ava....
     #
     # Useful when working on SSL enabled sites. Of course often used options should be set through
     # +Gravatarify.options+.
     #
     # @param [String, #email, #mail] email a string representing an email, or object which responds to +email+ or +mail+
-    # @param [Hash] url_options customize generated gravatar.com url
+    # @param [Symbol, Hash] *params customize generated gravatar.com url. First argument can also be a style.
     # @option url_options [String, Proc] :default (nil) URL of an image to use as default when no gravatar exists. Gravatar.com
     #                                    also accepts special values like +identicon+, +monsterid+ or +wavater+ which just displays
     #                                    a generic icon based on the hash or <tt>404</tt> which return a HTTP Status 404.
     # @option url_options [String, Symbol] :rating (:g) Specify the rating, gravatar.com supports <tt>:g</tt>, <tt>:pg</tt>,
     #                                     <tt>:r</tt> or <tt>:x</tt>, they correspond to movie ratings :)
@@ -94,16 +86,19 @@
     #                                     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>.
     #                                      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 = {})
-      url_options = Gravatarify.options.merge(url_options)
-      email_hash = Digest::MD5.hexdigest(Base.get_smart_email_from(email).strip.downcase)
+    def gravatar_url(email, *params)
+      url_options = Utils.merge_gravatar_options(*params)
+      email_hash = Digest::MD5.hexdigest(Utils.smart_email(email))
       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)}"
+      build_gravatar_host(email_hash, url_options.delete(:secure)) + "/avatar/#{email_hash}#{extension}#{build_gravatar_options(email, url_options)}"
     end
+    
+    # For backwards compatibility.
+    alias_method :build_gravatar_url, :gravatar_url
   
     private
       # Builds gravatar host name from supplied e-mail hash.
       # Ensures that for the same +str_hash+ always the same subdomain is used.
       #
@@ -114,24 +109,21 @@
       # @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
-    
+          
       # 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, source.is_a?(String) ? self : source) if key.to_s == 'd' and value.respond_to?(:call)
-          params << "#{Gravatarify.escape(key)}=#{Gravatarify.escape(value)}" if value
+        params = url_options.inject([]) do |params, (key, value)|
+          key = key.to_s
+          if key != 'html'
+            key = GRAVATAR_ABBREV_OPTIONS[key] if GRAVATAR_ABBREV_OPTIONS.include?(key) # shorten key!
+            value = value.call(url_options, source) if key == 'd' and value.respond_to?(:call)
+            params << "#{Utils.escape(key)}=#{Utils.escape(value)}" if value
+          end
+          params
         end
         "?#{params.sort * '&'}" unless params.empty?
-      end
-      
-      # 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
+      end      
+    end
 end
\ No newline at end of file