gravtastic 1.7.1 → 2.0.0

data/README.textile

@@ -12,17 +12,21 @@ Somewhere in your application you need to @require 'gravtastic'@. In Rails >= 2.
 
     config.gem 'gravtastic'
 
-The next step is to give your model a Gravatar:
+If you are using Merb & DataMapper you can add do the same by adding the following to your init.rb file:
+
+  dependency 'gravtastic'
+
+Make sure you add this after either the @use_orm :datamapper@ line or after a DataMapper extension. The next step is to give your model a Gravatar:
 
   class User
-    has_gravatar
+    is_gravtastic
   end
 
-If you are using a standard Ruby class or Datamapper resource you have to add the line @include Gravtastic::Model@ before @has_gravatar@.
+If you are using a standard Ruby class you have to add the line @include Gravtastic::Resource@ before @is_gravtastic@.
   
 This defaults to looking for the gravatar ID on the @email@ method. So, if your @User@ has an @email@ then it will send that to Gravatar to get their picture. You can change the default gravatar source like this:
 
-  has_gravatar :on => :author_email
+  is_gravtastic :with => :author_email
 
 Now, you can access your object's gravatar with the @gravatar_url@ method:
 
@@ -39,9 +43,9 @@ Note that it defaults to a PG rating. You can specify extra options with a hash:
   
 However, to DRY things up you can specify defaults in the class declaration.
 
-  has_gravatar :author_email, :defaults => { :rating => 'R18', :size => 20 }
+  is_gravtastic :with => :author_email, :rating => 'R18', :size => 20
 
-Nice, now all the calls to gravatar_url will have the defaults you have specified.
+Nice, now all the calls to gravatar_url will have the defaults you have specified. Any options that you pass when you use @gravatar_url@ will over-ride these class-defaults.
 
 PS.  Bonus points for anybody who can tell me what that users email is!
 

data/Rakefile

@@ -1,11 +1,12 @@
 require 'rubygems'
 require 'rake/gempackagetask'
+require 'rake/rdoctask'
 require 'rubygems/specification'
 require 'spec/rake/spectask'
 require 'date'
 
 GEM = "gravtastic"
-GEM_VERSION = "1.7.1"
+GEM_VERSION = "2.0.0"
 AUTHOR = "Chris Lloyd"
 EMAIL = "christopher.lloyd@gmail.com"
 HOMEPAGE = "http://github.com/chrislloyd/gravtastic"
@@ -31,10 +32,19 @@ spec = Gem::Specification.new do |s|
   s.files = %w(LICENSE README.textile Rakefile) + Dir.glob("{lib,spec}/**/*")
 end
 
+desc "Run Specs"
 Rake::GemPackageTask.new(spec) do |pkg|
   pkg.gem_spec = spec
 end
 
+desc "Generate Documentation"
+Rake::RDocTask.new do |rdoc|
+  rdoc.rdoc_dir = 'doc'
+  rdoc.title = 'Gravtastic'
+  rdoc.options << '--line-numbers' << '--inline-source' << '--main' << 'Gravtastic'
+  rdoc.rdoc_files.include(FileList[ 'lib/**/*.rb', 'README.textile', 'LICENSE'])
+end
+
 task :default => :spec
 task :specs => :spec
 

data/lib/gravtastic.rb

@@ -12,19 +12,23 @@ require 'cgi'
 # 
 # Somewhere in your application you need to <tt>require 'gravtastic'</tt>. In Rails >= 2.1 you can forego this and just add a dependency gem dependency for Gravtastic.
 # 
-#     config.gem 'gravtastic', :source => 'http://gems.github.com/'
+#   config.gem 'gravtastic'
 # 
-# The next step is to give your model a Gravatar:
+# If you are using Merb & DataMapper you can add do the same by adding the following to your init.rb file:
+# 
+#   dependency 'gravtastic'
+# 
+# Make sure you add this after either the <tt>use_orm :datamapper</tt> line or after a DataMapper extension. The next step is to give your model a Gravatar:
 # 
 #   class User
-#     has_gravatar
+#     is_gravtastic
 #   end
 # 
-# If you are using a standard Ruby class or Datamapper resource you have to add the line <tt>include Gravtastic::Model</tt> before <tt>has_gravatar</tt>.
-# 
+# If you are using a standard Ruby class you have to add the line <tt>include Gravtastic::Resource</tt> before <tt>is_gravtastic</tt>.
+#   
 # This defaults to looking for the gravatar ID on the <tt>email</tt> method. So, if your <tt>User</tt> has an <tt>email</tt> then it will send that to Gravatar to get their picture. You can change the default gravatar source like this:
 # 
-#   has_gravatar :on => :author_email
+#   is_gravtastic :with => :author_email
 # 
 # Now, you can access your object's gravatar with the <tt>gravatar_url</tt> method:
 # 
@@ -35,53 +39,62 @@ require 'cgi'
 # 
 #   current_user.gravatar_url(:rating => 'R18', :size => 512)
 #   => "http://gravatar.com/e9e719b44653a9300e1567f09f6b2e9e.png?r=R18&s=512"
-# 
+#   
 #   current_user.gravatar_url(:secure => true)
 #   => "https://secure.gravatar.com/e9e719b44653a9300e1567f09f6b2e9e.png?r=PG"
+#   
+# However, to DRY things up you can specify defaults in the class declaration.
+# 
+#   is_gravtastic :with => :author_email, :rating => 'R18', :size => 20
+# 
+# Nice, now all the calls to gravatar_url will have the defaults you have specified. Any options that you pass when you use <tt>gravatar_url</tt> will over-ride these class-defaults.
 # 
 module Gravtastic
-  module Model
+  module Resource
 
     def self.included(base) # :nodoc:
       base.extend(ClassMethods)
     end
-
+    
     module ClassMethods
-      
+
       # 
       # Sets the gravatar_source. Basically starts this whole shindig.
       # 
       # Examples:
       # 
-      #   has_gravatar
+      #   is_gravtastic
       # 
-      #   has_gravatar :on => :author_email
+      #   is_gravtastic :with => :author_email
       # 
-      #   has_gravatar :defaults => { :rating => 'R18' }
+      #   is_gravtastic :with => :author_email, :rating => 'R18', :secure => true
       # 
-      def has_gravatar(options={})
-        @gravatar_source = options[:on] || :email
-        options[:defaults] ||= {}
-        @gravatar_defaults = {:rating => 'PG', :secure => false}.merge(options[:defaults])
+      def is_gravtastic(options={})
+        @gravatar_source = options[:with] || :email
+
+        options.delete_if {|key,_| ![:size, :rating, :default, :secure].include?(key) }
+        @gravatar_defaults = {:rating => 'PG', :secure => false}.merge(options)
       end
 
+      alias :has_gravatar :is_gravtastic
+
       # 
       # Returns a symbol of the instance method where the Gravatar is pulled from.
       # 
       # For example, if your users email is returned by the method <tt>#gobagaldy_gook</tt> then it
-      # will return the symbol <tt>:'gobagaldy_gook'</tt>.
+      # will return the symbol <tt>:gobagaldy_gook</tt>.
       # 
       def gravatar_source
         @gravatar_source
       end
-      
+
       # 
       # Returns a hash of all the default gravtastic options.
       # 
       def gravatar_defaults
         @gravatar_defaults
       end
-      
+
       # 
       # Returns <tt>true</tt> if the gravatar_source is set. <tt>false</tt> if not. Easy!
       # 
@@ -119,16 +132,16 @@ module Gravtastic
     def gravatar_url(options={})      
       options = self.class.gravatar_defaults.merge(options)
       
-      @gravatar_url = gravatar_url_base(options[:secure]) + gravatar_filename + parse_url_options_hash(options)
+      @gravatar_url = gravatar_hostname(options[:secure]) + gravatar_filename + parse_url_options_hash(options)
     end
 
     private
     
-    GRAVTASTIC_VALID_PARAMS = [:size, :rating, :default]
-    
+    # 
+    # Parses a hash options for the image parameters. Returns a CGI escaped string.
+    # 
     def parse_url_options_hash(options)
-      
-      options.delete_if { |key,_| ![:size,:rating,:default].include?(key) }
+      options.delete_if { |key,_| ![:size, :rating, :default].include?(key) }
       
       unless options.empty?
         '?' + options.map do |pair|
@@ -140,10 +153,16 @@ module Gravtastic
       end
     end
     
-    def gravatar_url_base(secure)
+    # 
+    # Returns the Gravatar.com hostname
+    # 
+    def gravatar_hostname(secure)
       'http' + (secure ? 's://secure.' : '://') + 'gravatar.com/avatar/'
     end
-    
+
+    # 
+    # Returns the filename of the gravatar image.
+    # 
     def gravatar_filename
       if gravatar_id
         gravatar_id + '.png'
@@ -151,8 +170,13 @@ module Gravtastic
         ''
       end
     end
-    
+
   end
 end
 
-ActiveRecord::Base.send(:include, Gravtastic::Model) if defined?(ActiveRecord) # :nodoc:
+ActiveRecord::Base.send(:include, Gravtastic::Resource) if defined?(ActiveRecord) # :nodoc:
+
+if defined?(DataMapper) # :nodoc:
+  DataMapper::Resource.append_inclusions Gravtastic::Resource
+  DataMapper::Model.append_extensions Gravtastic::Resource::ClassMethods
+end

data/spec/gravtastic_integration_spec.rb

@@ -0,0 +1,38 @@
+require File.dirname(__FILE__) + '/spec_helper'
+require 'rubygems'
+
+require 'activerecord'
+require 'dm-core'
+
+reload_gravtastic!
+
+class User
+  include DataMapper::Resource
+  is_gravtastic
+end
+
+describe ActiveRecord::Base do
+  
+  it "includes Gravtastic::Resource" do
+    ActiveRecord::Base.included_modules.should include(Gravtastic::Resource)
+  end
+  
+  it "responds to .is_gravtastic" do
+    ActiveRecord::Base.should respond_to(:is_gravtastic)
+  end
+  
+end
+
+describe DataMapper::Resource do
+  
+  it "includes Gravtastic::Resource" do
+    User.included_modules.should include(Gravtastic::Resource)
+  end
+  
+  it "responds to .is_gravtastic" do
+    User.should respond_to(:is_gravtastic)
+  end
+  
+end
+
+

data/spec/gravtastic_spec.rb

@@ -1,10 +1,10 @@
 require File.dirname(__FILE__) + '/spec_helper'
 
-describe "Gravtastic::Model" do
+describe Gravtastic::Resource do
 
   before(:each) do
     @user = mock('User')
-    @user.class.send(:include, Gravtastic::Model)
+    @user.class.send(:include, Gravtastic::Resource)
     @klass = @user.class
   end
   
@@ -34,47 +34,47 @@ describe "Gravtastic::Model" do
     
   end
   
-  describe ".has_gravatar" do
+  describe ".is_gravtastic" do
     
     it "sets .gravatar_source to :email by default" do
-      @klass.has_gravatar
+      @klass.is_gravtastic
       @klass.gravatar_source.should == :email
     end
     
     it "sets .gravatar_defaults to { :rating => 'PG', :secure => false } by default" do
-      @klass.has_gravatar
+      @klass.is_gravtastic
       @klass.gravatar_defaults.should == { :rating => 'PG', :secure => false }
     end
     
-    it "sets .gravatar_source to :email by default, even when :defaults are supplied" do
-      @klass.has_gravatar :defaults => { :secure => true }
+    it "sets .gravatar_source to :email by default, even when defaults are supplied" do
+      @klass.is_gravtastic :secure => true
       @klass.gravatar_source.should == :email
     end
     
     it "keeps either :rating or :secure if only the other is passed as a default" do
-      @klass.has_gravatar :defaults => { :secure => true }
+      @klass.is_gravtastic :secure => true
       @klass.gravatar_defaults.should == { :rating => 'PG', :secure => true }
     end
     
     it "changes .gravatar_source" do
       lambda {
-        @klass.has_gravatar :on => :other_method
+        @klass.is_gravtastic :with => :other_method
       }.should change(@klass, :gravatar_source)
     end
     
     it "changes .gravatar_defaults" do
       lambda {
-        @klass.has_gravatar :defaults => { :rating => 'R18' }
+        @klass.is_gravtastic :rating => 'R18'
       }.should change(@klass, :gravatar_defaults)
     end
     
     it "sets .gravatar_source to the value of :on" do
-      @klass.has_gravatar :on => :other_method
+      @klass.is_gravtastic :with => :other_method
       @klass.gravatar_source.should == :other_method
     end
     
     it "sets .gravatar_defaults to the value of :defaults" do
-      @klass.has_gravatar :defaults => { :rating => 'R18'}
+      @klass.is_gravtastic :rating => 'R18'
       @klass.gravatar_defaults.should == { :rating => 'R18', :secure => false }
     end
     

data/spec/spec_helper.rb

@@ -1,4 +1,9 @@
 $TESTING=true
 $:.push File.join(File.dirname(__FILE__), '..', 'lib')
 
+def reload_gravtastic!
+  Object.class_eval { remove_const :Gravtastic } if defined? Gravtastic
+  require File.join(File.dirname(__FILE__),'../lib/gravtastic')
+end
+
 require 'gravtastic'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: gravtastic
 version: !ruby/object:Gem::Version 
-  version: 1.7.1
+  version: 2.0.0
 platform: ruby
 authors: 
 - Chris Lloyd
@@ -27,6 +27,7 @@ files:
 - README.textile
 - Rakefile
 - lib/gravtastic.rb
+- spec/gravtastic_integration_spec.rb
 - spec/gravtastic_spec.rb
 - spec/spec.opts
 - spec/spec_helper.rb