gravtastic 2.2.0 → 3.0.0

data/README.md

@@ -12,9 +12,9 @@ The best way to learn more about Gravtastic is to [look at the source](http://gi
 
 ## Usage
 
-Add this to your `environment.rb`:
+Add this to your `Gemfile`:
 
-    config.gem 'gravtastic', :version => '>= 2.1.0'
+    gem 'gravtastic'
 
 Next, say that you want a Gravatar for your model:
 
@@ -40,20 +40,6 @@ Now all your Gravatars will come from a secure connection, be a GIF and be 120x1
 
 _Note: You can use either `is_gravtastic!` or `is_gravtastic`, they both do the same thing._
 
-### Plain Ruby
-
-So you just have a regular ol' Ruby app? No Rails and ActiveRecord?
-
-    require 'gravtastic'
-    class BoringUser
-      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!`_
-
 ### Complete List of Options
 
 <table>
@@ -95,6 +81,58 @@ _Note: the `#gravatar_url` methods don't get included until you specify the clas
   </tr>
 </table>
 
+## Other ORM
+
+### Plain Ruby
+
+So you just have a regular ol' Ruby app? No Rails and ActiveRecord?
+
+    require 'gravtastic'
+    class BoringUser
+      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
+    end
+
+### Sequel
+
+    require 'sequel'
+    require 'gravtastic'
+    class User < Sequel::Model
+      plugin Gravtastic
+    end
+
+### MongoMapper
+
+    require 'mongo_mapper'
+    require 'gravtastic'
+    class User
+      include MongoMapper::Document
+      plugin Gravtastic
+    end
+
+### Mongoid
+
+    require 'mongoid'
+    require 'gravtastic'
+    class User
+      include Mongoid::Document
+      is_gravtastic
+    end
+
+
 ## 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:
@@ -104,10 +142,14 @@ Fork the project, submit a pull request and I'll get to it straight away. Or you
 ## Thanks
 
 * [Xavier Shay](http://rhnh.net) and others for [Enki](http://enkiblog.com) (the reason this was originally written)
-* [Matthew Moore](http://www.matthewpaulmoore.com)
-* [Vincent Charles](http://vincentcharles.com)
-* [Paul Farnell](http://litmusapp.com/blog)
-* [Jeff Kreeftmeijer](http://jeffkreeftmeijer.nl/)
+* [Matthew Moore](http://github.com/moorage)
+* [Galen O'Hanlon](http://github.com/gohanlon)
+* [Jason Cheow](http://jasoncheow.com)
+* [Paul Farnell](http://github.com/salted)
+* [Jeff Kreeftmeijer](http://github.com/jeffkreeftmeijer)
+* [Ryan Lewis](http://github.com/c00lryguy)
+* [Arthur Chiu](http://github.com/achiu)
+
 
 ## License
 

data/Rakefile

@@ -11,7 +11,6 @@ begin
   end
   Jeweler::GemcutterTasks.new
 rescue LoadError
-  puts "Install jeweler to build gem"
 end
 
 require 'spec/rake/spectask'

data/VERSION

@@ -1 +1 @@
-2.2.0
+3.0.0

data/lib/gravtastic.rb

@@ -4,73 +4,73 @@ require 'uri'
 
 module Gravtastic
 
-  def self.included(base)
-    base.extend(SingletonMethods)
-  end
-
   def self.version
     File.read(__FILE__.sub('lib/gravtastic.rb','VERSION')).strip
   end
+  
+  def self.included(model)
+    model.extend ManualConfigure
+  end
+  
+  def self.apply(model, *args, &blk)
+  end
+  
+  def self.configure(model, *args, &blk)
+    options = args.last.is_a?(Hash) ? args.pop : {}
+
+    model.gravatar_defaults = {
+      :rating => 'PG',
+      :secure => false,
+      :filetype => :png
+    }.merge(options)
+    
+    model.gravatar_source = args.first || :email
+  end
 
-  module SingletonMethods
-
-    def is_gravtastic(*args)
+  module ManualConfigure
+    def is_gravtastic(*args, &blk)
       extend ClassMethods
       include InstanceMethods
-
-      options = args.last.is_a?(Hash) ? args.pop : {}
-      source = args.first || :email
-
-      @gravatar_defaults = {
-        :rating => 'PG',
-        :secure => false,
-        :filetype => :png
-      }.merge(options)
-      @gravatar_source = source
+      Gravtastic.configure(self, *args, &blk)
+      self
     end
 
     alias_method :has_gravatar, :is_gravtastic
     alias_method :is_gravtastic!, :is_gravtastic
-
   end
 
   module ClassMethods
+    attr_accessor :gravatar_source, :gravatar_defaults
 
-    def gravatar_source
-      @gravatar_source
-    end
-
-    def gravatar_defaults
-      @gravatar_defaults
-    end
-
-    def gravatar_options
+    def gravatar_abbreviations
       { :size => 's',
         :default => 'd',
         :rating => 'r'
       }
     end
-
   end
 
   module InstanceMethods
-
+    
     def gravatar_id
       Digest::MD5.hexdigest(send(self.class.gravatar_source).to_s.downcase)
     end
 
     def gravatar_url(options={})
       options = self.class.gravatar_defaults.merge(options)
-      gravatar_hostname(options.delete(:secure)) +
+      path = 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
 
     def url_params_from_hash(hash)
       '?' + hash.map do |key, val|
-        [self.class.gravatar_options[key.to_sym] || key.to_s, CGI::escape(val.to_s) ].join('=')
+        [self.class.gravatar_abbreviations[key.to_sym] || key.to_s, CGI::escape(val.to_s) ].join('=')
       end.sort.join('&')
     end
 
@@ -81,11 +81,15 @@ module Gravtastic
     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::Resource.append_inclusions(Gravtastic) if defined?(DataMapper) # :nodoc:
-MongoMapper::Document.append_inclusions(Gravtastic) if defined?(MongoMapper) && MongoMapper::Document.respond_to?(:append_inclusions) # :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_integration_spec.rb

@@ -1,38 +1,52 @@
-require File.dirname(__FILE__) + '/spec_helper'
-require 'rubygems'
-
 require 'active_record'
-# require 'dm-core'
+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 User
-#   include DataMapper::Resource
-#   is_gravtastic
-# end
-
-describe ActiveRecord::Base do
+    # Class.new(ActiveRecord::Base) do
+    #   is_gravtastic
+    # end.new.should respond_to(:gravatar_url)
+  end
+end
 
+describe DataMapper do
   it "includes Gravtastic" do
-    ActiveRecord::Base.included_modules.should include(Gravtastic)
+    Class.new do
+      include DataMapper::Resource
+      is :gravtastic
+    end.new.should respond_to(:gravatar_url)
   end
+end
 
-  it "responds to .is_gravtastic" do
-    ActiveRecord::Base.should respond_to(:is_gravtastic)
+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 DataMapper::Resource do
-#
-#   it "includes Gravtastic::Resource" do
-#     User.included_modules.should include(Gravtastic)
-#   end
-#
-#   it "responds to .is_gravtastic" do
-#     User.should respond_to(:is_gravtastic)
-#   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

data/spec/gravtastic_spec.rb

@@ -1,6 +1,3 @@
-require File.dirname(__FILE__) + '/spec_helper'
-require File.dirname(__FILE__) + '/../lib/gravtastic'
-
 describe Gravtastic do
 
   before(:each) do

data/spec/helper.rb

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

metadata

@@ -1,7 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: gravtastic
 version: !ruby/object:Gem::Version 
-  version: 2.2.0
+  prerelease: false
+  segments: 
+  - 3
+  - 0
+  - 0
+  version: 3.0.0
 platform: ruby
 authors: 
 - Chris Lloyd
@@ -9,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-01-03 00:00:00 +11:00
+date: 2010-10-11 00:00:00 +02:00
 default_executable: 
 dependencies: []
 
@@ -29,7 +34,7 @@ files:
 - lib/gravtastic.rb
 - spec/gravtastic_integration_spec.rb
 - spec/gravtastic_spec.rb
-- spec/spec_helper.rb
+- spec/helper.rb
 has_rdoc: true
 homepage: http://github.com/chrislloyd/gravtastic
 licenses: []
@@ -40,25 +45,29 @@ rdoc_options:
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: gravtastic
-rubygems_version: 1.3.5
+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/spec_helper.rb
+- spec/helper.rb

data/spec/spec_helper.rb

@@ -1,15 +0,0 @@
-$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
-
-Spec::Runner.configure do |config|
-  config.mock_with :rr
-end
-
-class Class
-  def to_sym; name.to_sym end
-end