img_gravatar 0.1.1 → 0.2.0

data/.gitignore

@@ -0,0 +1,7 @@
+.idea/*
+coverage/*
+pkg/*
+doc/*
+rdoc/*
+Manifest
+img_gravatar-*.gem

data/README.rdoc

@@ -4,7 +4,11 @@ A simple plugin adding the +img_gravatar+ image link helper to ActionViews.
 
 == Install
 
-  gem install tsalzer-img_gravatar --source http://gems.github.com
+The gem is hosted on http://gemcutter.org, which is the default Ruby gem
+hoster at this time (November 2009). All you need to install the latest
+version is run the following command:
+
+  gem install img_gravatar
 
 
 == What is a Gravatar?
@@ -13,8 +17,9 @@ A gravatar is a globally recognized avatar. It is an image hosted on the site
 http://site.gravatar.com, uploaded by the user and referred to on base of
 an eMail address. News on gravatar can be found at http://blog.gravatar.com.
 
-Each gravatar image can be rated with respect to its content being suiteable to
-audience.
+Each gravatar image can be rated with respect to its content being suitable
+for a given audience. You might want to use the rating feature if you run a
+public site.
 
 == Usage
 
@@ -38,7 +43,7 @@ A more complex szenario would include a size definition, and an alt image tag:
 This would render a downsized image of 40x40 with the alt-tag "That's me.".
 
 For a complete description of available parameters see
-Gravatar::InstanceMethods#gravatar in the Gravatar::InstanceMethods.
+ImgGravatar::InstanceMethods#gravatar in the ImgGravatar::InstanceMethods.
 
 === Configuration Options
 
@@ -50,7 +55,7 @@ You can modify the following aspects of the displayed gravatar image:
 
 == Building a new Gem
 
-To create a new gem, you need to install the echoe gem (see
+To create a new gem, you need to install the jeweler gem (see
 http://blog.evanweaver.com/files/doc/fauna/echoe/files/README.html).
 Next, edit the Rakefile to reflect your changes, then run:
 
@@ -61,6 +66,11 @@ Next, edit the Rakefile to reflect your changes, then run:
 Now, you can either publish the gem, or build a gem package. See rake -T for
 available targets.
 
+== Ruby 1.9
+
+ImgGravatar version 0.2.0 and above runs on Ruby 1.9; older version will work
+only on Ruby 1.8.
+
 == License
 
 The img_gravatar gem comes to you under the MIT License. You should find the

data/Rakefile

@@ -1,16 +1,53 @@
-# Rakefile for img_gravatar
 require 'rubygems'
 require 'rake'
-require 'echoe'
-
-Echoe.new('img_gravatar', '0.1.1') do |p|
-  p.description = "Add a img_gravatar helper to ActiveView."
-  p.url = "http://github.com/tsalzer/img_gravatar"
-  p.author = "Till Salzer"
-  p.email = "till.salzer@googlemail.com"
-  p.ignore_pattern = ["tmp/*", "script/*", "rdoc/*", "pkg/*", "gravatar.tmproj"]
-  p.development_dependencies = []
-  p.rdoc_pattern = /^(lib|bin|tasks|ext)|^README.rdoc|^CHANGELOG|^TODO|^MIT-LICENSE|^COPYING$/
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "img_gravatar"
+    gem.summary = %Q{Gravatar image helper}
+    gem.description = %Q{Add a img_gravatar helper to ActiveView.}
+    gem.email = "till.salzer@googlemail.com"
+    gem.homepage = "http://github.com/tsalzer/minimapper"
+    gem.authors = ["Till Salzer", "Jon Wood"]
+    gem.add_development_dependency 'rspec', '>= 1.2.9'
+    gem.add_development_dependency 'rcov', '>= 0.9.6'
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION.yml')
+    config = YAML.load(File.read('VERSION.yml'))
+    version = "#{config[:major]}.#{config[:minor]}.#{config[:patch]}"
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'doc'
+  rdoc.title = "img_gravatar #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('MIT-LICENSE')
+  rdoc.rdoc_files.include('lib/**/*.rb')
 end
 
-Dir["#{File.dirname(__FILE__)}/tasks/*.rake"].sort.each { |ext| load ext }

data/VERSION.yml

@@ -0,0 +1,5 @@
+--- 
+:minor: 2
+:build: 
+:patch: 0
+:major: 0

data/img_gravatar.gemspec

@@ -1,32 +1,61 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
 # -*- encoding: utf-8 -*-
 
 Gem::Specification.new do |s|
   s.name = %q{img_gravatar}
-  s.version = "0.1.1"
+  s.version = "0.2.0"
 
-  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Till Salzer"]
-  s.date = %q{2009-02-18}
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Till Salzer", "Jon Wood"]
+  s.date = %q{2009-11-26}
   s.description = %q{Add a img_gravatar helper to ActiveView.}
   s.email = %q{till.salzer@googlemail.com}
-  s.extra_rdoc_files = ["lib/img_gravatar.rb", "MIT-LICENSE", "README.rdoc", "tasks/img_gravatar_tasks.rake"]
-  s.files = ["img_gravatar.gemspec", "init.rb", "install.rb", "lib/img_gravatar.rb", "Manifest", "MIT-LICENSE", "Rakefile", "README.rdoc", "tasks/img_gravatar_tasks.rake", "test/img_gravatar_test.rb", "test/module_gravatar_test.rb", "uninstall.rb"]
-  s.has_rdoc = true
-  s.homepage = %q{http://github.com/tsalzer/img_gravatar}
-  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Img_gravatar", "--main", "README.rdoc"]
+  s.extra_rdoc_files = [
+    "README.rdoc"
+  ]
+  s.files = [
+    ".gitignore",
+     "MIT-LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION.yml",
+     "img_gravatar.gemspec",
+     "init.rb",
+     "install.rb",
+     "lib/img_gravatar.rb",
+     "spec/img_gravatar_spec.rb",
+     "spec/module_gravatar_spec.rb",
+     "spec/spec_helper.rb",
+     "tasks/img_gravatar_tasks.rake",
+     "uninstall.rb"
+  ]
+  s.homepage = %q{http://github.com/tsalzer/minimapper}
+  s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
-  s.rubyforge_project = %q{img_gravatar}
-  s.rubygems_version = %q{1.3.1}
-  s.summary = %q{Add a img_gravatar helper to ActiveView.}
-  s.test_files = ["test/img_gravatar_test.rb", "test/module_gravatar_test.rb"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Gravatar image helper}
+  s.test_files = [
+    "spec/img_gravatar_spec.rb",
+     "spec/module_gravatar_spec.rb",
+     "spec/spec_helper.rb"
+  ]
 
   if s.respond_to? :specification_version then
     current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
-    s.specification_version = 2
+    s.specification_version = 3
 
     if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, [">= 1.2.9"])
+      s.add_development_dependency(%q<rcov>, [">= 0.9.6"])
     else
+      s.add_dependency(%q<rspec>, [">= 1.2.9"])
+      s.add_dependency(%q<rcov>, [">= 0.9.6"])
     end
   else
+    s.add_dependency(%q<rspec>, [">= 1.2.9"])
+    s.add_dependency(%q<rcov>, [">= 0.9.6"])
   end
 end
+

data/lib/img_gravatar.rb

@@ -1,13 +1,18 @@
-require 'md5'
+DIGEST_INTERFACE = begin
+  require 'md5'
+  :ruby18
+rescue LoadError
+  require 'digest/md5'
+  :ruby19
+end
+
 require 'uri'
 require 'action_view'
 
-# = Gravatar
+# = ImgGravatar
 # 
 # Adds the +gravatar+ method to ActionViews.
-#
-# $Id$
-module ImgGravatar #:nodoc:
+module ImgGravatar
   mattr_reader :gravatar_host
   @@gravatar_host = 'www.gravatar.com'
   # gravatar.com base URL.
@@ -36,22 +41,24 @@ module ImgGravatar #:nodoc:
   ############################################################################
   # get the Gravatar image.
   # options:
-  #   :alt          - the alternative text for this image
+  #   :alt          - the alternative text for this image (img attribute)
   #   :default_url  - the default URL for this gravatar
-  #   :size         - the requested gravatar size
+  #   :size         - the requested gravatar size (img attribute, gravatar-attribute)
   #   :rating       - the requested maximum rating
   def self.link_gravatar(email, opts={})
     # the defaults
-    alt = nil
-    alt = opts[:alt] if opts[:alt]
-    
-    if alt then
-      "<img src=\"%s\" alt=\"%s\" />" % [image_url(email, opts), alt]
+    tag_options = {}
+    tag_options[:alt] =opts[:alt]   if opts[:alt]
+    tag_options[:size] =opts[:size] if opts[:size] && (opts[:size] >= 1 && opts[:size] <= 512)
+
+    unless tag_options.empty?
+      attributes = tag_options.collect {|key, value| "#{key}=\"#{value}\"" }.join(" ")
+      "<img src=\"%s\" %s />" % [image_url(email, opts), attributes]
     else
       "<img src=\"%s\" />" % image_url(email, opts)
     end
   end
-  
+
   ############################################################################
   # get the default Gravatar image.
   # options:
@@ -75,10 +82,25 @@ module ImgGravatar #:nodoc:
     
     #uri = URI::HTTP.new(Gravatar.gravatar_base_url)
     uri = URI::HTTP.build(:host => ImgGravatar.gravatar_host,
-      :path => "/avatar/%s" % MD5.md5(email.downcase.strip),
+      :path => "/avatar/%s" % encode_md5(email),
       :query => query)
   end
-  
+
+  # encode an EMail for Gravatar.
+  # This will basically take any string, strip is, and hash the result
+  # using MD5.
+  def self.encode_md5(email)
+    value = email.downcase.strip
+    case DIGEST_INTERFACE
+      when :ruby18
+        return MD5.md5(value)
+      when :ruby19
+        return Digest::MD5.hexdigest(value)
+      else
+        raise "unknown Ruby Digest interface."
+    end
+  end
+
   # Methods injected in all ActionView classes.
   module Base #:nodoc:
     def self.included(mod) #:nodoc:
@@ -94,7 +116,8 @@ module ImgGravatar #:nodoc:
       end
     end
   end
-  
+
+  # Methods available in ActionView.
   module InstanceMethods
     ############################################################################
     # get the Gravatar image.

data/spec/img_gravatar_spec.rb

@@ -0,0 +1,60 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe ImgGravatar, "ActionView integration" do
+  subject do
+    class TestView < ActionView::Base ; end
+    TestView.new
+  end
+
+  it "should respond to img_gravatar" do
+    subject.should respond_to(:img_gravatar)
+  end
+
+  it "should produce the defined image URL" do
+    # the reference data from http://en.gravatar.com/site/implement/url
+    link_url = subject.img_gravatar(REF_MAIL)
+    link_url.should =~ /^<img src="#{BASE_URL}\/#{REF_HASH}\" \/>/
+    # just to have the regexp at hand...
+    link_url.should =~ /^<img src="#{BASE_URL}\/[a-z0-9]{32}\" \/>/
+  end
+
+  it "should produce the minimal URL if no further arguments are given" do
+    link_url = subject.img_gravatar(REF_MAIL)
+    link_url.should =~ /^<img src="#{BASE_URL}\/#{REF_HASH}\" \/>/
+  end
+
+  ['g', 'r', 'x'].each do |rating|
+    it "should generate a specific URL for rating #{rating} when requested" do
+      link_url = subject.img_gravatar(REF_MAIL, {:rating => rating})
+      link_url.should =~ /^<img src="#{BASE_URL}\/#{REF_HASH}\?r=#{rating}\" \/>/
+    end
+  end
+
+  it "should generate specific size URLs for any dimension in 1..512" do
+    (1..512).each do |size|
+      link_url = subject.img_gravatar(REF_MAIL, {:size => size})
+      link_url.should =~ /^<img src="#{BASE_URL}\/#{REF_HASH}\?s=#{size}\" size="#{size}" \/>/
+    end
+  end
+
+  [0, -1 -10, -65535, -65536, 513, 640, 1024, 65535, 65536, 10000000].each do |size|
+    it "should generate a default URL if the illegal size #{size} is given" do
+      link_url = subject.img_gravatar(REF_MAIL, {:size => size})
+      link_url.should =~ /^<img src="#{BASE_URL}\/#{REF_HASH}\" \/>/
+    end
+  end
+
+  it "should generate a URL pointing to a custom default URL if requested" do
+    default_url = "http://example.com/images/example.jpg"
+    link_url = subject.img_gravatar(REF_MAIL, {:default_url => default_url})
+    link_url.should =~ /^<img src="#{BASE_URL}\/[a-z0-9]{32}\?d=#{default_url}\" \/>/
+  end
+
+  ['identicon', 'monsterid', 'wavatar'].each do |dflt|
+    it "should use a URL for #{dflt} if requested" do
+      link_url = subject.img_gravatar(REF_MAIL, {:default_url => dflt})
+      link_url.should =~ /^<img src="#{BASE_URL}\/#{REF_HASH}\?d=#{dflt}\" \/>/
+    end
+  end
+
+end

data/spec/module_gravatar_spec.rb

@@ -0,0 +1,11 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe ImgGravatar, "module methods" do
+  subject { ImgGravatar }
+
+  [:image_url, :link_gravatar].each do |method|
+    it "should respond to #{method}" do
+      subject.should respond_to(method)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'img_gravatar'
+require 'spec'
+require 'spec/autorun'
+
+Spec::Runner.configure do |config|
+  
+end
+
+GRAVATAR_HOST = "www.gravatar.com"
+BASE_URL = "http://#{GRAVATAR_HOST}/avatar"
+REF_MAIL = "iHaveAn@email.com"
+REF_HASH = "3b3be63a4c2a439b013787725dfce802"

metadata

@@ -1,18 +1,38 @@
 --- !ruby/object:Gem::Specification 
 name: img_gravatar
 version: !ruby/object:Gem::Version 
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors: 
 - Till Salzer
+- Jon Wood
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2009-02-18 00:00:00 +01:00
+date: 2009-11-26 00:00:00 +01:00
 default_executable: 
-dependencies: []
-
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.2.9
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: rcov
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.9.6
+    version: 
 description: Add a img_gravatar helper to ActiveView.
 email: till.salzer@googlemail.com
 executables: []
@@ -20,35 +40,29 @@ executables: []
 extensions: []
 
 extra_rdoc_files: 
-- lib/img_gravatar.rb
-- MIT-LICENSE
 - README.rdoc
-- tasks/img_gravatar_tasks.rake
 files: 
+- .gitignore
+- MIT-LICENSE
+- README.rdoc
+- Rakefile
+- VERSION.yml
 - img_gravatar.gemspec
 - init.rb
 - install.rb
 - lib/img_gravatar.rb
-- Manifest
-- MIT-LICENSE
-- Rakefile
-- README.rdoc
+- spec/img_gravatar_spec.rb
+- spec/module_gravatar_spec.rb
+- spec/spec_helper.rb
 - tasks/img_gravatar_tasks.rake
-- test/img_gravatar_test.rb
-- test/module_gravatar_test.rb
 - uninstall.rb
 has_rdoc: true
-homepage: http://github.com/tsalzer/img_gravatar
+homepage: http://github.com/tsalzer/minimapper
 licenses: []
 
 post_install_message: 
 rdoc_options: 
-- --line-numbers
-- --inline-source
-- --title
-- Img_gravatar
-- --main
-- README.rdoc
+- --charset=UTF-8
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -61,15 +75,16 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      version: "1.2"
+      version: "0"
   version: 
 requirements: []
 
-rubyforge_project: img_gravatar
-rubygems_version: 1.3.4
+rubyforge_project: 
+rubygems_version: 1.3.5
 signing_key: 
-specification_version: 2
-summary: Add a img_gravatar helper to ActiveView.
+specification_version: 3
+summary: Gravatar image helper
 test_files: 
-- test/img_gravatar_test.rb
-- test/module_gravatar_test.rb
+- spec/img_gravatar_spec.rb
+- spec/module_gravatar_spec.rb
+- spec/spec_helper.rb

data/Manifest

@@ -1,12 +0,0 @@
-img_gravatar.gemspec
-init.rb
-install.rb
-lib/img_gravatar.rb
-Manifest
-MIT-LICENSE
-Rakefile
-README.rdoc
-tasks/img_gravatar_tasks.rake
-test/img_gravatar_test.rb
-test/module_gravatar_test.rb
-uninstall.rb

data/test/img_gravatar_test.rb

@@ -1,88 +0,0 @@
-# Unit tests for ImgGravatar
-require 'test/unit'
-require 'img_gravatar'
-
-class TestView < ActionView::Base
-end
-
-class ImgGravatarTest < Test::Unit::TestCase
-  @@gravatar_host = "www.gravatar.com"
-  @@base_url = "http://#{@@gravatar_host}/avatar"
-  @@ref_mail = "iHaveAn@email.com"
-  @@ref_hash = "3b3be63a4c2a439b013787725dfce802"
-  
-    
-  def test_actionview_integration
-    myview = TestView.new
-    assert myview.respond_to?('img_gravatar'), "integration into ActionView failed"
-  end
-  
-  def test_reference_data
-    myview = TestView.new
-    # the reference data from http://en.gravatar.com/site/implement/url
-    link_url = myview.img_gravatar(@@ref_mail)
-    assert_match(/^<img src="#{@@base_url}\/#{@@ref_hash}\" \/>/, link_url)
-    #assert_match(/^<img src="http:\/\/www\.gravatar\.com\/avatar\/#{ref_hash}\" \/>/, link_url)
-  end
-  
-  def test_actionview_url
-    myview = TestView.new
-    link_url = myview.img_gravatar(@@ref_mail)
-    assert_match(/^<img src="#{@@base_url}\/[a-z0-9]{32}\" \/>/, link_url)
-  end
-  
-  def test_defaults
-    myview = TestView.new
-    link_url = myview.img_gravatar(@@ref_mail)
-    assert_match(/^<img src="#{@@base_url}\/[a-z0-9]{32}\" \/>/, link_url)
-  end
-  
-  def test_actionview_ratings
-    myview = TestView.new
-    ['g', 'r', 'x'].each do |rating|
-      link_url = myview.img_gravatar(@@ref_mail, {:rating => rating})
-      assert_match(/^<img src="#{@@base_url}\/[a-z0-9]{32}\?r=#{rating}\" \/>/, link_url)
-    end
-  end
-  
-  def test_actionview_size
-    myview = TestView.new
-    (1..512).each do |size|
-      link_url = myview.img_gravatar(@@ref_mail, {:size => size})
-      assert_match(/^<img src="#{@@base_url}\/[a-z0-9]{32}\?s=#{size}\" \/>/, link_url)
-    end
-  end
-  
-  def test_illegal_small_sizes
-    myview = TestView.new
-    (-10..0).each do |size|
-      link_url = myview.img_gravatar(@@ref_mail, {:size => size})
-      assert_match(/^<img src="#{@@base_url}\/[a-z0-9]{32}\" \/>/, link_url)
-    end
-  end
-  
-  def test_illegal_large_sizes
-    myview = TestView.new
-    (513..10000).each do |size|
-      link_url = myview.img_gravatar(@@ref_mail, {:size => size})
-      assert_match(/^<img src="#{@@base_url}\/[a-z0-9]{32}\" \/>/, link_url)
-    end
-  end
-  
-  def test_default_image_encoding
-    myview = TestView.new
-    unencoded = "http://example.com/images/example.jpg"
-    encoded = 'http%3A%2F%2Fexample.com%2Fimages%2Fexample.jpg'
-    link_url = myview.img_gravatar(@@ref_mail, {:default_url => unencoded})
-    assert_match(/^<img src="#{@@base_url}\/[a-z0-9]{32}\?d=#{encoded}\" \/>/, link_url)
-  end
-  
-  def test_default_image_specials
-    myview = TestView.new
-    ['identicon', 'monsterid', 'wavatar'].each do |dflt|
-      link_url = myview.img_gravatar(@@ref_mail, {:default_url => dflt})
-      assert_match(/^<img src="#{@@base_url}\/[a-z0-9]{32}\?d=#{dflt}\" \/>/, link_url)
-    end
-  end
-  
-end

data/test/module_gravatar_test.rb

@@ -1,22 +0,0 @@
-# Unit tests for ImgGravatar
-require 'test/unit'
-require 'img_gravatar'
-
-class ModuleGravatarTest < Test::Unit::TestCase
-  @@gravatar_host = "www.gravatar.com"
-  @@base_url = "http://#{@@gravatar_host}/avatar"
-  @@ref_mail = "iHaveAn@email.com"
-  @@ref_hash = "3b3be63a4c2a439b013787725dfce802"
-  
-  def test_module_functions
-    assert(ImgGravatar.respond_to?('image_url'), 'Module ImgGravatar does not respond to image_url')
-    assert(ImgGravatar.respond_to?('link_gravatar'), 'Module ImgGravatar does not respond to link_grevatar')
-  end
-  
-  def test_reference_data
-    # the reference data from http://en.gravatar.com/site/implement/url
-    link_url = ImgGravatar.link_gravatar(@@ref_mail)
-    assert_match(/^<img src="#{@@base_url}\/#{@@ref_hash}\" \/>/, link_url)
-    #assert_match(/^<img src="http:\/\/www\.gravatar\.com\/avatar\/#{ref_hash}\" \/>/, link_url)
-  end
-end