gravatar_image_tag 0.1.0 → 1.0.0.pre1

data/MIT-LICENSE

@@ -1,5 +1,5 @@
-Copyright (c) 2009 Michael Deering
- 
+Copyright (c) 2010 Michael Deering
+
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the
 "Software"), to deal in the Software without restriction, including
@@ -7,10 +7,10 @@ without limitation the rights to use, copy, modify, merge, publish,
 distribute, sublicense, and/or sell copies of the Software, and to
 permit persons to whom the Software is furnished to do so, subject to
 the following conditions:
- 
+
 The above copyright notice and this permission notice shall be
 included in all copies or substantial portions of the Software.
- 
+
 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND

data/README.textile

@@ -6,26 +6,31 @@ Rails view helper for grabbing "Gravatar":http://en.gravatar.com/ images.  The g
 
 h2. Install as a Ruby Gem
 
-<pre>sudo gem install gravatar_image_tag</pre>
+h3. Rails 2
 
 p. Include the following line in your Rails environment
 
-<pre>config.gem 'gravatar_image_tag'</pre>
+<pre># config/environment
+  config.gem 'gravatar_image_tag'</pre>
 
-p. Then ensure the gem is installed if you did not already run the gem install as noted above.
+p. Then ensure the gem is installed by running the following rake task from the your application root.
 
 <pre>rake gems:install</pre>
 
-h2. Install as a Ruby on Rails Plugin
+h3. Rails 3
 
-The traditional way.
-<pre>./script/plugin install git://github.com/mdeering/gravatar_image_tag.git</pre>
+p. Include the following line in your Rails environment
 
-or the old-school but still c00l way!
-<pre>piston import git://github.com/mdeering/gravatar_image_tag.git vendor/plugins/gravatar_image_tag</pre>
+<pre># Gemfile
+  gem 'gravatar_image_tag'</pre>
 
-or for all you hip gitsters.
-<pre>git submodule add git://github.com/mdeering/gravatar_image_tag.git vendor/plugins/gravatar_image_tag git submodule init</pre>
+p. Then ensure the gem is installed by running the following command from the your application root.
+
+<pre>bundle install</pre>
+
+h2. Install as a Ruby on Rails Plugin
+
+<pre>./script/plugin install git://github.com/mdeering/gravatar_image_tag.git</pre>
 
 h2. Usage
 
@@ -35,28 +40,32 @@ Once you have installed it as a plugin for your rails app usage is simple.
 
 *Boom* here is my gravatar !http://www.gravatar.com/avatar/4da9ad2bd4a2d1ce3c428e32c423588a(Michael Deering)!
 
-h2. Configuration Points
-
-h3. Setting the default image
+h2. Configuration
 
-If no default image is given in either an initializer or through the options passed to the gravatar_image_tag then the default image from the gravatar site will be displayed.
+h3. Global configuration points
 
-<pre>gravatar_image_tag('junk', :alt => 'Default Gravatar Image')</pre>
+<pre># config/initializers/gravatar_image_tag.rb
+GravatarImageTag.configure do |config|
+  config.default_image = nil   # Set this to use your own default gravatar image rather then serving up Gravatar's default image [ 'http://example.com/images/default_gravitar.jpg', :identicon, :monsterid, :wavatar, 404 ].
+  config.filetype      = nil   # Set this if you require a specific image file format ['gif', 'jpg' or 'png'].  Gravatar's default is png
+  config.rating        = nil   # Set this if you change the rating of the images that will be returned ['G', 'PG', 'R', 'X']. Gravatar's default is G
+  config.size          = nil   # Set this to globally set the size of the gravatar image returned (1..512). Gravatar's default is 80
+  config.secure        = false # Set this to true if you require secure images on your pages.
+end
+</pre>
 
-*Splat* the default gravatar image !http://www.gravatar.com/avatar/0c821f675f132d790b3f25e79da739a7(Default Gravatar Image)!
+h3. Setting the default image inline
 
-You can specify the default image through an initializer as follows:
+p. *Splat* the default gravatar image !http://www.gravatar.com/avatar/0c821f675f132d790b3f25e79da739a7(Default Gravatar Image)!
 
-<pre># config/initializers/gravatar_defaults.rb
-ActionView::Base.default_gravatar_image  = 'http://assets.yourhost.com/images/default_gravatar.png'</pre>
-
-You can also specify the default image to fallback to or override the one set in the above initializer by passing the _:gravatar => { :default => 'http://assets.yourhost.com/images/override_gravatar.png' }_ option to the gravatar_image_tag call.  All other options will be forwarded onto the image_tag.
+p. You can set the default gravatar image inline as follows:
 
 <pre>gravatar_image_tag('junk', :alt => 'Github Default Gravatar', :gravatar => { :default => 'http://github.com/images/gravatars/gravatar-80.png' })</pre>
 
-*Ka-Pow* !http://www.gravatar.com/avatar/0c821f675f132d790b3f25e79da739a7?default=http%3A%2F%2Fgithub.com%2Fimages%2Fgravatars%2Fgravatar-80.png(Github Default Gravatar)!
+p. *Ka-Pow* !http://www.gravatar.com/avatar/0c821f675f132d790b3f25e79da739a7?default=http%3A%2F%2Fgithub.com%2Fimages%2Fgravatars%2Fgravatar-80.png(Github Default Gravatar)!
 
 p. Other options supported besides an image url to fall back on include the following:
+
 * :identicon !http://www.gravatar.com/avatar/0c821f675f132d790b3f25e79da739a7?default=identicon(Identicon Avatar)!
 * :monsterid !http://www.gravatar.com/avatar/0c821f675f132d790b3f25e79da739a7?default=monsterid(Monster Id Avatar)!
 * :wavatar !http://www.gravatar.com/avatar/0c821f675f132d790b3f25e79da739a7?default=wavatar(Wavatar Avatar)!
@@ -64,14 +73,7 @@ p. Other options supported besides an image url to fall back on include the foll
 
 h3. Setting the default image size
 
-If no default image size is given in either the plugin configuration or through the options passed to the gravatar_image_tag then the default image size from the gravatar site will be displayed (80px x 80px at the time of this writing).
-
-You can specify your default image size through the plugin configuration by adding the following line to your rails environment.
-
-<pre># config/initializers/gravatar_defaults.rb
-ActionView::Base.default_gravatar_size  = 120</pre>
-
-You can also specify the image size or override the one set in the plugin configuration by passing the _:gravatar => { :size => 50 }_ option to the gravatar_image_tag call.  All other options will be forwarded on to the image_tag call.
+p. You can set the gravatar image size inline as follows:
 
 <pre>gravatar_image_tag('spam@spam.com'.gsub('spam', 'mdeering'), :alt => 'Michael Deering', :class => 'some-class', :gravatar => { :size => 15 })</pre>
 
@@ -85,32 +87,19 @@ p. You can make a request for a gravatar from the secure server at https://secur
 
 Delivered by a secure url! !https://secure.gravatar.com/avatar/4da9ad2bd4a2d1ce3c428e32c423588a(Michael Deering)!
 
-p. You globally set the gravatar image tag to always use the secure server by setting the following.  By default this is set to false.
-
-<pre># config/initializers/gravatar_defaults.rb
-ActionView::Base.secure_gravatar  = true</pre>
-
 h3. Using Gravatar's built in rating system
 
-p. By default only those gravatars that have a rating of 'g' are returned.  You can change this by passing in the rating parameter as follows.  Possible options for ratings are _g, pg, r, or x_.
+p. You can set the gravatar rating inline as follows:
 
 <pre>gravatar_image_tag('spam@spam.com'.gsub('spam', 'mdeering'), :alt => 'Michael Deering', :gravatar => { :rating => 'pg' } )</pre>
 
-p. You can globally set the gravatar image tag rating by setting the following.  There is no default value, the default of 'g' is being set by the gravatar service itself.
-
-<pre># config/initializers/gravatar_defaults.rb
-ActionView::Base.default_gravatar_rating  = 'r'</pre>
 
 h3. Specifying a filetype
 
-p. By default no filetype extension is given in the produced gravatar urls but of your application requires it you can specify one to be added to the generated url.
+p. You can set the gravatar filetype inline as follows:
 
 <pre>gravatar_image_tag('spam@spam.com'.gsub('spam', 'mdeering'), :alt => 'Michael Deering', :gravatar => { :filetype => :gif } )</pre>
 
-p. You can globally set the filetype extension as follows.
-
-<pre># config/initializers/gravatar_defaults.rb
-ActionView::Base.default_gravatar_filetype  = :gif</pre>
 
 h2. Credits
 

data/Rakefile

@@ -21,7 +21,7 @@ begin
   end
   Jeweler::GemcutterTasks.new
 rescue LoadError
-  puts "Jeweler, or one of its dependencies, is not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+  puts "Jeweler, or one of its dependencies, is not available. Install it with: gem install jeweler"
 end
 
 desc 'Default: spec tests.'

data/lib/gravatar_image_tag.rb

@@ -1,48 +1,94 @@
 module GravatarImageTag
 
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.configure
+    self.configuration ||= Configuration.new
+    yield(configuration)
+  end
+
+  class Configuration
+     attr_accessor :default_image, :filetype, :rating, :size, :secure
+   end
+
   def self.included(base)
-    base.cattr_accessor :default_gravatar_filetype, :default_gravatar_image,
-      :default_gravatar_rating, :default_gravatar_size,  :secure_gravatar
+    GravatarImageTag.configure { |c| nil }
+    base.extend ClassMethods
     base.send :include, InstanceMethods
   end
 
+  module ClassMethods
+    def default_gravatar_filetype=(value)
+      warn "DEPRECATION WARNING: configuration of filetype= through this method is deprecated! Use the block configuration instead. http://github.com/mdeering/gravatar_image_tag"
+      GravatarImageTag.configure do |c|
+        c.filetype = value
+      end
+    end
+    def default_gravatar_image=(value)
+      warn "DEPRECATION WARNING: configuration of default_gravatar_image= through this method is deprecated! Use the block configuration instead. http://github.com/mdeering/gravatar_image_tag"
+      GravatarImageTag.configure do |c|
+        c.default_image = value
+      end
+    end
+    def default_gravatar_rating=(value)
+      warn "DEPRECATION WARNING: configuration of default_gravatar_rating= through this method is deprecated! Use the block configuration instead. http://github.com/mdeering/gravatar_image_tag"
+      GravatarImageTag.configure do |c|
+        c.rating = value
+      end
+    end
+    def default_gravatar_size=(value)
+      warn "DEPRECATION WARNING: configuration of default_gravatar_size= through this method is deprecated! Use the block configuration instead. http://github.com/mdeering/gravatar_image_tag"
+      GravatarImageTag.configure do |c|
+        c.size = value
+      end
+    end
+    def secure_gravatar=(value)
+      warn "DEPRECATION WARNING: configuration of secure_gravatar= through this method is deprecated! Use the block configuration instead. http://github.com/mdeering/gravatar_image_tag"
+      GravatarImageTag.configure do |c|
+        c.secure = value
+      end
+    end
+  end
+
   module InstanceMethods
 
     def gravatar_image_tag(email, options = {})
-      options[:src] = gravatar_url( email, options.delete( :gravatar ) )
+      options[:src] = GravatarImageTag::gravatar_url( email, options.delete( :gravatar ) )
       options[:alt] ||= 'Gravatar'
       tag 'img', options, false, false # Patch submitted to rails to allow image_tag here https://rails.lighthouseapp.com/projects/8994/tickets/2878-image_tag-doesnt-allow-escape-false-option-anymore
     end
 
-    def gravatar_url(email, overrides)
-      overrides ||= {}
-      gravatar_params = {
-        :default     => ActionView::Base.default_gravatar_image,
-        :filetype    => ActionView::Base.default_gravatar_filetype,
-        :rating      => ActionView::Base.default_gravatar_rating,
-        :secure      => ActionView::Base.secure_gravatar,
-        :size        => ActionView::Base.default_gravatar_size
-      }.merge(overrides).delete_if { |key, value| value.nil? }
-      "#{gravatar_url_base(gravatar_params.delete(:secure))}/#{gravatar_id(email, gravatar_params.delete(:filetype))}#{url_params(gravatar_params)}"
-    end
+  end
 
-    private
+  def self.gravatar_url(email, overrides = {})
+    overrides ||= {}
+    gravatar_params = {
+      :default     => GravatarImageTag.configuration.default_image,
+      :filetype    => GravatarImageTag.configuration.filetype,
+      :rating      => GravatarImageTag.configuration.rating,
+      :secure      => GravatarImageTag.configuration.secure,
+      :size        => GravatarImageTag.configuration.size
+    }.merge(overrides).delete_if { |key, value| value.nil? }
+    "#{gravatar_url_base(gravatar_params.delete(:secure))}/#{gravatar_id(email, gravatar_params.delete(:filetype))}#{url_params(gravatar_params)}"
+  end
 
-      def gravatar_url_base(secure = false)
-        'http' + (!!secure ? 's://secure.' : '://') + 'gravatar.com/avatar'
-      end
+  private
 
-      def gravatar_id(email, filetype = nil)
-        "#{ Digest::MD5.hexdigest(email) }#{ ".#{filetype}" unless filetype.nil? }"
-      end
+    def self.gravatar_url_base(secure = false)
+      'http' + (!!secure ? 's://secure.' : '://') + 'gravatar.com/avatar'
+    end
 
-      def url_params(gravatar_params)
-        return nil if gravatar_params.keys.size == 0
-        "?#{gravatar_params.map { |key, value| "#{key}=#{URI.escape(value.is_a?(String) ? value : value.to_s, Regexp.new("[^#{URI::PATTERN::UNRESERVED}]"))}"}.join('&')}"
-      end
+    def self.gravatar_id(email, filetype = nil)
+      "#{ Digest::MD5.hexdigest(email) }#{ ".#{filetype}" unless filetype.nil? }" unless email.nil?
+    end
 
-  end
+    def self.url_params(gravatar_params)
+      return nil if gravatar_params.keys.size == 0
+      "?#{gravatar_params.map { |key, value| "#{key}=#{URI.escape(value.is_a?(String) ? value : value.to_s, Regexp.new("[^#{URI::PATTERN::UNRESERVED}]"))}"}.join('&')}"
+    end
 
 end
 
-ActionView::Base.send(:include, GravatarImageTag)
+ActionView::Base.send(:include, GravatarImageTag) if defined?(ActionView::Base)

data/spec/gravatar_image_tag_spec.rb

@@ -15,6 +15,7 @@ describe GravatarImageTag do
   default_size          = 50
   other_image           = 'http://mdeering.com/images/other_gravatar.png'
   other_image_escaped   = 'http%3A%2F%2Fmdeering.com%2Fimages%2Fother_gravatar.png'
+  secure                = false
 
   view = ActionView::Base.new
 
@@ -37,23 +38,28 @@ describe GravatarImageTag do
     :default_gravatar_image    => default_image,
     :default_gravatar_filetype => default_filetype,
     :default_gravatar_rating   => default_rating,
-    :default_gravatar_size     => default_size
+    :default_gravatar_size     => default_size,
+    :secure_gravatar           => secure
   }.each do |singleton_variable, value|
-    it "should create gravatar class (singleton) variable #{singleton_variable} on its included class" do
-      ActionView::Base.send(singleton_variable).should == nil
+    it "should give a deprication warning for assigning to #{singleton_variable} and passthrough to set the new variable" do
+      ActionView::Base.should_receive(:warn)
       ActionView::Base.send("#{singleton_variable}=", value)
-      ActionView::Base.send(singleton_variable).should == value
+      GravatarImageTag.configuration.default_image == value if singleton_variable == :default_gravatar_image
+      GravatarImageTag.configuration.filetype      == value if singleton_variable == :default_gravatar_filetype
+      GravatarImageTag.configuration.rating        == value if singleton_variable == :default_gravatar_rating
+      GravatarImageTag.configuration.size          == value if singleton_variable == :default_gravatar_size
+      GravatarImageTag.configuration.secure        == value if singleton_variable == :secure_gravatar
     end
   end
 
   # Now that the defaults are set...
   {
     { :gravatar_id => md5, :size => default_size, :default => default_image_escaped } => {},
-    { :gravatar_id => md5, :size => 30, :default => default_image_escaped } => { :gravatar => { :size => 30 }},
+    { :gravatar_id => md5, :size => 30, :default => default_image_escaped } => { :gravatar => { :size => 30 } },
     { :gravatar_id => md5, :size => default_size, :default => other_image_escaped } => { :gravatar => {:default => other_image } },
-    { :gravatar_id => md5, :size => 30, :default => other_image_escaped } => { :gravatar => { :default => other_image, :size => 30 }},
+    { :gravatar_id => md5, :size => 30, :default => other_image_escaped } => { :gravatar => { :default => other_image, :size => 30 } },
   }.each do |params, options|
-    it "#gravatar_image_tag should create the provided url when defaults have been set with the provided options #{options}"  do
+    it "#gravatar_image_tag #{params} should create the provided url when defaults have been set with the provided options #{options}"  do
       view = ActionView::Base.new
       image_tag = view.gravatar_image_tag(email, options)
       image_tag.include?("#{params.delete(:gravatar_id)}.#{default_filetype}").should be_true
@@ -69,4 +75,8 @@ describe GravatarImageTag do
     (!!view.gravatar_image_tag(email, { :gravatar => { :secure => true } }).match(/src="https:\/\/secure.gravatar.com\/avatar\//)).should be_true
   end
 
+  it 'GravatarImageTag#gravitar_id should not error out when email is nil' do
+    lambda { GravatarImageTag::gravatar_id(nil) }.should_not  raise_error(TypeError)
+  end
+
 end

metadata

@@ -1,7 +1,14 @@
 --- !ruby/object:Gem::Specification 
 name: gravatar_image_tag
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  hash: -1876988176
+  prerelease: true
+  segments: 
+  - 1
+  - 0
+  - 0
+  - pre1
+  version: 1.0.0.pre1
 platform: ruby
 authors: 
 - Michael Deering
@@ -9,7 +16,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-01-19 00:00:00 -07:00
+date: 2010-07-11 00:00:00 -06:00
 default_executable: 
 dependencies: []
 
@@ -38,21 +45,29 @@ rdoc_options:
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version 
-      version: "0"
-  version: 
+      hash: 25
+      segments: 
+      - 1
+      - 3
+      - 1
+      version: 1.3.1
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.5
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: A configurable and documented Rails view helper for adding gravatars into your Rails application.