gravatar_image_tag 0.0.1

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 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
+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
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.textile

@@ -0,0 +1,78 @@
+!http://s.gravatar.com/images/logo.png(Gravatar Logo)!
+
+h1. Gravatar Image Tag Plugin
+
+Rails view helper for grabbing "Gravatar":http://en.gravatar.com/ images.  The goal here is to be configurable and have those configuration points documented!
+
+h2. Install as a Ruby Gem
+
+<pre>sudo gem install gravatar_image_tag</pre>
+
+p. Include the following line in your Rails environment
+
+<pre>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.
+
+<pre>rake gems:install</pre>
+
+h2. Install as a Ruby on Rails Plugin
+
+The traditional way.
+<pre>./script/plugin install git://github.com/mdeering/gravatar_image_tag.git</pre>
+
+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>
+
+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>
+
+h2. Usage
+
+Once you have installed it as a plugin for your rails app usage is simple.
+
+<pre>gravatar_image_tag('spam@spam.com'.gsub('spam', 'mdeering'), :alt => 'Michael Deering')</pre>
+
+*Boom* here is my gravatar !http://www.gravatar.com/avatar.php?gravatar_id=4da9ad2bd4a2d1ce3c428e32c423588a(Michael Deering)!
+
+h2. Configuration Points
+
+h3. Setting the default image
+
+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.
+
+<pre>gravatar_image_tag('junk', :alt => 'Default Gravatar Image')</pre>
+
+*Splat* the default gravatar image !http://www.gravatar.com/avatar.php?gravatar_id=0c821f675f132d790b3f25e79da739a7(Default Gravatar Image)!
+
+You can specify the default image through an initializer as follows:
+
+<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.
+
+<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.php?default=http%3A%2F%2Fgithub.com%2Fimages%2Fgravatars%2Fgravatar-80.png&gravatar_id=0c821f675f132d790b3f25e79da739a7(Github Default Gravatar)!
+
+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.
+
+<pre>gravatar_image_tag('spam@spam.com'.gsub('spam', 'mdeering'), :alt => 'Michael Deering', :class => 'some-class', :gravatar => { :size => 15 })</pre>
+
+*Mini Me!* !(some-class)http://www.gravatar.com/avatar.php?gravatar_id=4da9ad2bd4a2d1ce3c428e32c423588a&size=15(Michael Deering)!
+
+h2. Credits
+
+The ideas an methods for this plugin are from expanding upon my original blog post "Adding Gravatar To Your Website Or Blog (Gravatar Rails)":http://mdeering.com/posts/005-adding-gravitar-to-your-website-or-blog
+
+Copyright (c) 2009 "Michael Deering(Ruby on Rails Development Edmonton)":http://mdeering.com, released under the MIT license

data/Rakefile

@@ -0,0 +1,50 @@
+require 'rake'
+require 'rake/rdoctask'
+require 'spec/rake/spectask'
+
+begin
+  AUTHOR   = "Michael Deering"
+  EMAIL    = "mdeering@mdeering.com"  
+  GEM      = "gravatar_image_tag"
+  HOMEPAGE = "http://github.com/mdeering/gravatar_image_tag"  
+  SUMMARY  = "A configurable and documented Rails view helper for adding gravatars into your Rails application."
+  
+  require 'jeweler'
+  Jeweler::Tasks.new do |s|
+    s.author       = AUTHOR
+    s.email        = EMAIL
+    s.files        = %w(install.rb install.txt MIT-LICENSE README.textile Rakefile) + Dir.glob("{rails,lib,spec}/**/*")        
+    s.homepage     = HOMEPAGE 
+    s.name         = GEM    
+    s.require_path = 'lib'       
+    s.summary      = SUMMARY
+  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"
+end
+
+desc 'Default: spec tests.'
+task :default => :spec
+
+desc 'Test the attribute_normalizer plugin.'
+Spec::Rake::SpecTask.new('spec') do |t|
+  t.spec_files = FileList['spec/**/*_spec.rb']
+  t.spec_opts = ["-c"]
+end
+
+desc "Run all examples with RCov"
+Spec::Rake::SpecTask.new('examples_with_rcov') do |t|
+  t.spec_files = FileList['spec/**/*_spec.rb']
+  t.rcov = true
+  t.rcov_opts = ['--exclude', '/opt,spec,Library']
+end
+
+desc 'Generate documentation for the attribute_normalizer plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'AttributeNormalizer'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README.textile')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/lib/gravatar_image_tag.rb

@@ -0,0 +1,32 @@
+module GravatarImageTag
+
+  GRAVATAR_BASE_URL = 'http://www.gravatar.com/avatar.php'
+
+  def self.included(base)
+    base.cattr_accessor :default_gravatar_image, :default_gravatar_size
+    base.send :include, InstanceMethods
+  end
+
+  module InstanceMethods
+
+    def gravatar_image_tag(email, options = {})
+      options[:src] = gravatar_url( email, options.delete( :gravatar ) )
+      options[:alt] ||= File.basename(options[:src], '.*').split('.').first.to_s.capitalize
+      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 ||= {}
+      url_params = {
+        :default     => ActionView::Base.default_gravatar_image,
+        :gravatar_id => Digest::MD5.hexdigest(email),
+        :size        => ActionView::Base.default_gravatar_size
+      }.merge(overrides).delete_if { |key, value| value.nil? }
+      "#{GRAVATAR_BASE_URL}?#{url_params.map { |key, value| "#{key}=#{URI.escape(value.is_a?(String) ? value : value.to_s, Regexp.new("[^#{URI::PATTERN::UNRESERVED}]"))}"}.join('&')}"
+    end
+
+  end
+
+end
+
+ActionView::Base.send(:include, GravatarImageTag)

data/spec/gravatar_image_tag_spec.rb

@@ -0,0 +1,57 @@
+require File.dirname(__FILE__) + '/test_helper'
+
+require 'gravatar_image_tag'
+
+ActionView::Base.send(:include, GravatarImageTag)
+
+describe GravatarImageTag do
+
+  email                 = 'mdeering@mdeering.com'
+  md5                   = '4da9ad2bd4a2d1ce3c428e32c423588a'
+  default_image         = 'http://mdeering.com/images/default_gravatar.png'
+  default_image_escaped = 'http%3A%2F%2Fmdeering.com%2Fimages%2Fdefault_gravatar.png'
+  default_size          = 50
+  other_image           = 'http://mdeering.com/images/other_gravatar.png'
+  other_image_escaped   = 'http%3A%2F%2Fmdeering.com%2Fimages%2Fother_gravatar.png'
+
+  view = ActionView::Base.new
+
+  {
+    { :gravatar_id => md5 } => {},
+    { :gravatar_id => md5, :size => 30 } => { :gravatar => {:size => 30 } },
+    { :gravatar_id => md5, :default => other_image_escaped } => { :gravatar => {:default => other_image } },
+    { :gravatar_id => md5, :default => other_image_escaped, :size => 30 } => { :gravatar => {:default => other_image, :size => 30 } }
+  }.each do |params, options|
+    it "#gravatar_image_tag should create the provided url with the provided options #{options}"  do
+      view = ActionView::Base.new
+      image_tag = view.gravatar_image_tag(email, options)
+      params.all? {|key, value| image_tag.include?("#{key}=#{value}")}.should be_true
+    end
+  end
+
+  {
+    :default_gravatar_image => default_image,
+    :default_gravatar_size  => default_size
+  }.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
+      ActionView::Base.send("#{singleton_variable}=", value)
+      ActionView::Base.send(singleton_variable).should == value
+    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 => 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 }},
+  }.each do |params, options|
+    it "#gravatar_image_tag 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)
+      params.all? {|key, value| image_tag.include?("#{key}=#{value}")}.should be_true
+    end
+  end
+
+end

data/spec/test_helper.rb

@@ -0,0 +1,11 @@
+require 'rubygems'
+require 'spec'
+require 'active_support'
+require 'action_view'
+require 'digest/md5'
+require 'uri'
+
+Spec::Runner.configure do |config|
+end
+
+$LOAD_PATH.unshift(File.dirname(__FILE__) + '/../lib')

metadata

@@ -0,0 +1,61 @@
+--- !ruby/object:Gem::Specification 
+name: gravatar_image_tag
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Michael Deering
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-01-04 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: 
+email: mdeering@mdeering.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.textile
+files: 
+- MIT-LICENSE
+- README.textile
+- Rakefile
+- lib/gravatar_image_tag.rb
+- spec/gravatar_image_tag_spec.rb
+- spec/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/mdeering/gravatar_image_tag
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: A configurable and documented Rails view helper for adding gravatars into your Rails application.
+test_files: 
+- spec/gravatar_image_tag_spec.rb
+- spec/test_helper.rb