gravtastic 3.0.0 → 3.1.0

data/Gemfile

@@ -0,0 +1,2 @@
+gem 'rspec'
+gem 'rr'

data/README.md

@@ -1,49 +1,70 @@
-# Gravtastic
+                  _____                 _            _   _
+                 / ____|               | |          | | (_)
+                | |  __ _ __ __ ___   _| |_ __ _ ___| |_ _  ___
+                | | |_ | '__/ _` \ \ / / __/ _` / __| __| |/ __|
+                | |__| | | | (_| |\ V /| || (_| \__ \ |_| | (__
+                 \_____|_|  \__,_| \_/  \__\__,_|___/\__|_|\___|
 
-<small>The super fantastic way of getting Gravatars. By [Chris](http://chrislloyd.com.au).</small>
 
-In less than 5 minutes you can add Gravatars to your Ruby project. It works in Rails, Merb _and_ plain ol' Ruby.
+<center><small>The super fantastic way of getting Gravatars. By [The Poacher](http://thelincolnshirepoacher.com).</small></center>
+
+In less than a minute you can add Gravatars to your Ruby project. It works in Rails, Merb & Sinatra.
+
+The best way to learn more about Gravtastic is to [look through the annotated source](http://chrislloyd.github.com/gravtastic). It's one file, about 80 LOC and really pretty simple. If that isn't for you, then follow the instructions below!
 
-The best way to learn more about Gravtastic is to [look at the source](http://github.com/chrislloyd/gravtastic/blob/master/lib/gravtastic.rb). It's one file, about 80 LOC and really pretty simple. If that isn't for you, then follow the instructions below!
 
 ## Install
 
     sudo gem install gravtastic
 
+
 ## Usage
 
-Add this to your `Gemfile`:
+For this example I'm going to assume you are using Rails. Don't worry if you arn't, the concepts are still the same.
+
+First off, add this to your `Gemfile`:
 
     gem 'gravtastic'
 
-Next, say that you want a Gravatar for your model:
+Next, in your model:
 
     class User < ActiveRecord::Base
-      is_gravtastic!
+      include Gravtastic
+      gravtastic
     end
 
-And you are done! In your views you can now use the `#gravatar_url` method:
+<small>_Note: You can use either `is_gravtastic!`, `is_gravtastic` or `has_gravatar`, they all do the same thing._</small>
+
+And you are done! In your views you can now use the `#gravatar_url` method on instances of `User`:
 
     <%= image_tag @user.gravatar_url %>
 
-If you want to change the image, you can do this:
+Gravatar gives you some options. You can use them like this:
 
     <%= image_tag @user.gravatar_url(:rating => 'R', :secure => true) %>
 
-That will show R rated Gravatars over a secure connection. If you find yourself repeating that all around your app, you can set the Gravatar defaults. In your model, just change the `is_gravtastic!` line to something like this:
+That will show R rated Gravatars over a secure connection. If you find yourself using the same options over and over again, you can set the Gravatar defaults. In your model, just change the `is_gravtastic` line to something like this:
+
+    gravtastic :secure => true,
+                  :filetype => :gif,
+                  :size => 120
+
+Now all your Gravatars will come from a secure connection, be a GIF and be 120x120px.
 
-    is_gravtastic :author_email, :secure => true,
-                                 :filetype => :gif,
-                                 :size => 120
+Gravatar needs an email address to find the person's avatar. By default, Gravtastic calls the `#email` method to find this. You can customise this.
 
-Now all your Gravatars will come from a secure connection, be a GIF and be 120x120px. The email will also come from the `author_email` field, not the default `email` field. Don't worry, you arn't locked into these defaults (you can override them by passing options to `#gravatar_url` like before).
+    gravtastic :author_email
 
-_Note: You can use either `is_gravtastic!` or `is_gravtastic`, they both do the same thing._
+### Defaults
+
+A common question is "how do I detect wether the user has an avatar or not?" People usually write code to perform a HTTP request to Gravatar to see wether the gravatar exists. This is certainly a solution, but not a very good one. If you have page where you show 50 users, the client will have to wait for 50 HTTP requests before they even get the page. Slooww.
+
+The best way to do this is to set the `:default` option when using `#gravatr_url`. If the user doesn't have an avatar, Gravatar essentially redirects to the "default" url you provide.
 
 ### Complete List of Options
 
-<table>
-  <tr>
+<table width="100%">
+  <thead>
     <th>Option</th>
     <th>Description</th>
     <th>Default</th>
@@ -65,7 +86,7 @@ _Note: You can use either `is_gravtastic!` or `is_gravtastic`, they both do the
     <td><b>default</b></td>
     <td>The default avatar image</td>
     <td><i>none</i></td>
-    <td>Any URL, or "identicon", "monsterid", "wavatar"</td>
+    <td>"identicon", "monsterid", "wavatar" or an absolute URL.</td>
   </tr>
   <tr>
     <td><b>rating</b></td>
@@ -81,67 +102,43 @@ _Note: You can use either `is_gravtastic!` or `is_gravtastic`, they both do the
   </tr>
 </table>
 
-## Other ORM
 
-### Plain Ruby
+### Other ORMs
 
-So you just have a regular ol' Ruby app? No Rails and ActiveRecord?
+Gravatar is really just simple Ruby. There is no special magic which ties it to one ORM (like ActiveRecord or MongoMapper). You can use the following pattern to include it anywhere:
 
     require 'gravtastic'
-    class BoringUser
+    class MyClass
       include Gravtastic
-      is_gravtastic!
-    end
-
-And wallah! That works exactly the same as in Rails! Now all instances of the BoringUser class will have `#gravatar_url` methods.
-
-_Note: the `#gravatar_url` methods don't get included until you specify the class `is_gravtastic!`_
-
-### DataMapper
-
-    require 'dm-core'
-    require 'gravtastic'
-    class User
-      include DataMapper::Resource
-      is :gravtastic
+      is_gravtastic
     end
 
-### Sequel
+For instance, with the excellent [MongoMapper](http://github.com/jnunemaker/mongomapper) you can use do this:
 
-    require 'sequel'
-    require 'gravtastic'
-    class User < Sequel::Model
-      plugin Gravtastic
-    end
+    class Person
+      include MongoMapper::Document
+      include Gravtastic
 
-### MongoMapper
+      is_gravtastic
 
-    require 'mongo_mapper'
-    require 'gravtastic'
-    class User
-      include MongoMapper::Document
-      plugin Gravtastic
+      key :email
     end
 
-### Mongoid
+And wallah! It's exactly the same as with ActiveRecord! Now all instances of the `Person` class will have `#gravatar_url` methods.
 
-    require 'mongoid'
-    require 'gravtastic'
-    class User
-      include Mongoid::Document
-      is_gravtastic
-    end
+_Note: the `#gravatar_url` methods don't get included until you specify the class `is_gravtastic!`_
 
 
 ## Making Changes Yourself
 
-Fork the project, submit a pull request and I'll get to it straight away. Or you can just view the source like:
+Gravtastic is a mature project. There isn't any active work which needs to be done on it, but I do continue to maintain it. Just don't expect same day fixes. If you find something that needs fixing, the best way to contribute is to fork the repo and submit a pull request.
 
     git clone git://github.com/chrislloyd/gravtastic.git
 
+
 ## Thanks
 
-* [Xavier Shay](http://rhnh.net) and others for [Enki](http://enkiblog.com) (the reason this was originally written)
+* [Xavier Shay](http://github.com/xaviershay) and others for [Enki](http://enkiblog.com) (the reason this was originally written)
 * [Matthew Moore](http://github.com/moorage)
 * [Galen O'Hanlon](http://github.com/gohanlon)
 * [Jason Cheow](http://jasoncheow.com)

data/Rakefile

@@ -1,20 +1,31 @@
-begin
-  require 'jeweler'
-  Jeweler::Tasks.new do |gs|
-    gs.name              = 'gravtastic'
-    gs.homepage          = 'http://github.com/chrislloyd/gravtastic'
-    gs.description       = 'Add Gravatars to your Rubies/Rails!'
-    gs.summary           = 'Ruby/Gravatar'
-    gs.email             = 'christopher.lloyd@gmail.com'
-    gs.author            = 'Chris Lloyd'
-    gs.rubyforge_project = 'gravtastic'
-  end
-  Jeweler::GemcutterTasks.new
-rescue LoadError
+require 'rake/gempackagetask'
+require 'rake/clean'
+require 'rspec/core/rake_task'
+
+def name
+  @name ||= File.basename(Dir['*.gemspec'].first, '.gemspec')
+end
+
+def gemspec_file
+  "#{name}.gemspec"
+end
+
+load(gemspec_file)
+
+Rake::GemPackageTask.new(@spec) do |t|
+  t.need_tar = true
+  t.need_zip = true
 end
+CLEAN.add 'pkg'
 
 require 'spec/rake/spectask'
-Spec::Rake::SpecTask.new('spec') do |t|
-  t.spec_opts = ['--color']
-  t.spec_files = FileList['spec/*.rb']
+RSpec::Core::RakeTask.new do |t|
+  t.rspec_opts = ['--color', '--require ./spec/helper']
+  # t.files = FileList['spec/*.rb']
+end
+
+desc 'Build documentation'
+task :doc do
+  sh 'docco lib/gravtastic.rb'
 end
+CLEAN.add 'docs'

data/lib/gravtastic/version.rb

@@ -0,0 +1,10 @@
+module Gravtastic
+
+  VERSION = '3.1.0'
+
+  # Returns the version of Gravtastic
+  def self.version
+    VERSION
+  end
+
+end

data/lib/gravtastic.rb

@@ -1,20 +1,21 @@
+# Gravtastic is a small module which quickly generates a Gravatar URL. Just
+# include in your class!
+
+# Gravatar uses an MD5 hash of the users email to locate their avatar.
 require 'digest/md5'
-require 'cgi'
-require 'uri'
+require 'gravtastic/version'
 
 module Gravtastic
-
-  def self.version
-    File.read(__FILE__.sub('lib/gravtastic.rb','VERSION')).strip
-  end
   
+  # When you `include Gravtastic`, Ruby automatically calls this method
+  # with the class you called it in. It allows us extend the class with the
+  # `#gravtastic` method.
   def self.included(model)
-    model.extend ManualConfigure
-  end
-  
-  def self.apply(model, *args, &blk)
+    model.extend StageOne
   end
   
+  # Sets the model's default attributes. It is called when you use 
+  # `#gravtastic` in your model.
   def self.configure(model, *args, &blk)
     options = args.last.is_a?(Hash) ? args.pop : {}
 
@@ -24,24 +25,36 @@ module Gravtastic
       :filetype => :png
     }.merge(options)
     
+    # The method where Gravtastic get the users' email from defaults to `#email`.
     model.gravatar_source = args.first || :email
   end
 
-  module ManualConfigure
-    def is_gravtastic(*args, &blk)
+  # We include Gravtastic in multiple stages. This is mainly so that if you 
+  # include Gravastic in a superclass (something like `ActiveRecord::Base`) 
+  # then it only adds the relevant methods to the classes which _actually_ use 
+  # it.
+  module StageOne
+    def gravtastic(*args, &blk)
       extend ClassMethods
       include InstanceMethods
       Gravtastic.configure(self, *args, &blk)
       self
     end
-
-    alias_method :has_gravatar, :is_gravtastic
-    alias_method :is_gravtastic!, :is_gravtastic
+    
+    # All these aliases deal with pervious bad design decisions. Let that be a 
+    # lesson, name things simply, try not to follow fads and try not to break 
+    # backwards compatibility.
+    alias_method :gravtastic!,    :gravtastic
+    alias_method :has_gravatar,   :gravtastic
+    alias_method :is_gravtastic,  :gravtastic
+    alias_method :is_gravtastic!, :gravtastic
   end
 
   module ClassMethods
     attr_accessor :gravatar_source, :gravatar_defaults
-
+    
+    # Gravtastic abbreviates certain params so that it produces the smallest
+    # possible URL. Every byte counts.
     def gravatar_abbreviations
       { :size => 's',
         :default => 'd',
@@ -52,44 +65,41 @@ module Gravtastic
 
   module InstanceMethods
     
+    # The raw MD5 hash of the users' email. Gravatar is particularly tricky as
+    # it downcases all emails. This is really the guts of the module, 
+    # everything else is just convenience.
     def gravatar_id
       Digest::MD5.hexdigest(send(self.class.gravatar_source).to_s.downcase)
     end
-
+    
+    # Constructs the full Gravatar url.
     def gravatar_url(options={})
       options = self.class.gravatar_defaults.merge(options)
-      path = gravatar_hostname(options.delete(:secure)) +
+      gravatar_hostname(options.delete(:secure)) +
         gravatar_filename(options.delete(:filetype)) +
         url_params_from_hash(options)
-      
-      # This would be alot cleaner with .try(:html_safe)
-      path.respond_to?(:html_safe) ? path.html_safe : path
     end
 
   private
-
+    
+    # Creates a params hash like "?foo=bar" from a hash like {'foo' => 'bar'}.
+    # The values are sorted so it produces deterministic output (and can 
+    # therefore be tested easily).
     def url_params_from_hash(hash)
       '?' + hash.map do |key, val|
-        [self.class.gravatar_abbreviations[key.to_sym] || key.to_s, CGI::escape(val.to_s) ].join('=')
-      end.sort.join('&')
+        [self.class.gravatar_abbreviations[key.to_sym] || key.to_s, val.to_s ].join('=')
+      end.sort.join('&')
     end
 
+    # Returns either Gravatar's secure hostname or not.
     def gravatar_hostname(secure)
       'http' + (secure ? 's://secure.' : '://') + 'gravatar.com/avatar/'
     end
-
+    
+    # Munges the ID and the filetype into one. Like "abc123.png"
     def gravatar_filename(filetype)
       "#{gravatar_id}.#{filetype}"
     end
   end
 
 end
-
-# All these ORMs suck balls. See Sequel or MongoMapper for examples of good
-# plugin systems.
-
-ActiveRecord::Base.send(:include, Gravtastic) if defined?(ActiveRecord) # :nodoc:
-DataMapper::Model.append_extensions(Gravtastic::ManualConfigure) if defined?(DataMapper) # :nodoc:
-Mongoid::Document.included do
-  include Gravtastic
-end if defined?(Mongoid) # :nodoc:

data/spec/gravtastic_spec.rb

@@ -31,9 +31,9 @@ describe Gravtastic do
 
     it "downcases email" do
       a = @g.new
-      stub(a).email{ 'USER@EXAMPLE.COM' }
+      stub(a).email do 'USER@EXAMPLE.COM' end
       b = @g.new
-      stub(b).email{ 'user@example.com' }
+      stub(b).email do 'user@example.com' end
       a.gravatar_id.should == b.gravatar_id
     end
 
@@ -63,12 +63,12 @@ describe Gravtastic do
     end
 
     it "abides to some new fancy feature" do
-      @user.gravatar_url(:extreme => true).should == 'http://gravatar.com/avatar/b58996c504c5638798eb6b511e6f49af.png?extreme=true&r=PG'
+      @user.gravatar_url(:extreme => true).should == 'http://gravatar.com/avatar/b58996c504c5638798eb6b511e6f49af.png?extreme=true&r=PG'
     end
 
     it "makes a URL from the defaults" do
       stub(@user.class).gravatar_defaults{ {:size => 20, :rating => 'R18', :secure => true, :filetype => :png} }
-      @user.gravatar_url.should == 'https://secure.gravatar.com/avatar/b58996c504c5638798eb6b511e6f49af.png?r=R18&s=20'
+      @user.gravatar_url.should == 'https://secure.gravatar.com/avatar/b58996c504c5638798eb6b511e6f49af.png?r=R18&s=20'
     end
 
   end

data/spec/helper.rb

@@ -1,5 +1,7 @@
 $:.push File.join(File.dirname(__FILE__), '..', 'lib')
 
-Spec::Runner.configure do |config|
+require 'gravtastic'
+
+RSpec.configure do |config|
   config.mock_with :rr
 end

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 3
+  - 1
   - 0
-  - 0
-  version: 3.0.0
+  version: 3.1.0
 platform: ruby
 authors: 
 - Chris Lloyd
@@ -14,34 +14,33 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-10-11 00:00:00 +02:00
+date: 2010-10-18 00:00:00 +02:00
 default_executable: 
 dependencies: []
 
-description: Add Gravatars to your Rubies/Rails!
+description: A Ruby wrapper for Gravatar URLs
 email: christopher.lloyd@gmail.com
 executables: []
 
 extensions: []
 
-extra_rdoc_files: 
-- README.md
+extra_rdoc_files: []
+
 files: 
-- .gitignore
 - README.md
 - Rakefile
-- VERSION
+- Gemfile
+- lib/gravtastic/version.rb
 - lib/gravtastic.rb
-- spec/gravtastic_integration_spec.rb
 - spec/gravtastic_spec.rb
 - spec/helper.rb
-has_rdoc: true
+has_rdoc: false
 homepage: http://github.com/chrislloyd/gravtastic
 licenses: []
 
 post_install_message: 
-rdoc_options: 
-- --charset=UTF-8
+rdoc_options: []
+
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -66,8 +65,6 @@ rubyforge_project: gravtastic
 rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
-summary: Ruby/Gravatar
-test_files: 
-- spec/gravtastic_integration_spec.rb
-- spec/gravtastic_spec.rb
-- spec/helper.rb
+summary: A Ruby wrapper for Gravatar URLs
+test_files: []
+

data/.gitignore

@@ -1,6 +0,0 @@
-coverage
-html
-pkg
-doc
-.ditz-config
-dist

data/VERSION

@@ -1 +0,0 @@
-3.0.0

data/spec/gravtastic_integration_spec.rb

@@ -1,52 +0,0 @@
-require 'active_record'
-require 'dm-core'
-require 'sequel'
-require 'mongo_mapper'
-require 'mongoid'
-require 'gravtastic'
-
-describe ActiveRecord do
-  it "includes Gravtastic" do
-    ActiveRecord::Base.should respond_to(:is_gravtastic)
-
-    # Class.new(ActiveRecord::Base) do
-    #   is_gravtastic
-    # end.new.should respond_to(:gravatar_url)
-  end
-end
-
-describe DataMapper do
-  it "includes Gravtastic" do
-    Class.new do
-      include DataMapper::Resource
-      is :gravtastic
-    end.new.should respond_to(:gravatar_url)
-  end
-end
-
-describe Sequel do
-  it "includes Gravtastic" do
-    Sequel::Model.plugin Gravtastic
-    # Class.new(Sequel::Model) do
-    #   plugin Gravtastic      
-    # end.new.should respond_to(:gravatar_url)
-  end
-end
-
-describe MongoMapper do
-  it "includes Gravtastic" do
-    Class.new do
-      include MongoMapper::Document
-      plugin Gravtastic
-    end.new.should respond_to(:gravatar_url)
-  end
-end
-
-describe Mongoid do
-  it "includes Gravtastic" do
-    Class.new do
-      include Mongoid::Document
-      is_gravtastic
-    end.new.should respond_to(:gravatar_url)
-  end
-end