avatar 0.0.2 → 0.0.3

data/History.txt

@@ -1,3 +1,12 @@
+== 0.0.3 2008-03-27
+* 2 minor fixes:
+  * GravatarSource now takes parameter :gravatar_field instead of :field for compatibility with other sources
+  * FileColumnSource now takes parameter :file_column_field instead of :field for compatibility with other sources
+
+* 2 minor enhancements:
+  * broke out options parsing in FileColumnSource to allow overriding
+  * added :gravatar_xxx versions to allowed options for GravatarSource
+
 == 0.0.2 2008-03-24
 * 1 major fix:
   * SourceChain duplicates options before passing to elements

data/lib/avatar/source/abstract_source.rb

@@ -1,3 +1,12 @@
+unless Object.method_defined?(:returning)
+  Object.class_eval do
+    def returning(value)
+      yield(value)
+      value
+    end
+  end
+end
+
 module Avatar # :nodoc:
   module Source # :nodoc:
     # To be included by classes that generate avatar URLs from profiles.

data/lib/avatar/source/file_column_source.rb

@@ -16,20 +16,24 @@ module Avatar # :nodoc:
       end
       
       # Returns nil if person is nil; otherwise, returns the (possibly nil) result of
-      # <code>url_for_image_column</code>, passing in all of +options+ except :field.
+      # <code>url_for_image_column</code>, passing in all of +options+ except :file_column_field.
       # Options:
-      # * <code>:field</code> - the image file column within +person+; by default, :avatar
+      # * <code>:file_column_field</code> - the image file column within +person+; by default, :avatar
       # * <code>:file_column_version</code> - one of the versions of the file_column; no default
       # If :file_column_version is not specified, all other options are passed to
       # <code>url_for_image_column</code> as +options+ (see FileColumnHelper)
       def avatar_url_for(person, options = {})
         return nil if person.nil?
-        field = options.delete(:field) || default_field
+        options = parse_options(person, options)
+        field = options.delete(:file_column_field) || default_field
         return nil if field.nil? || person.send(field).nil?
         options = options[:file_column_version] || options
         url_for_image_column(person, field, options)
       end
       
+      def parse_options(person, options)
+        options
+      end
     end
   end
 end

data/lib/avatar/source/gravatar_source.rb

@@ -3,15 +3,6 @@ require 'avatar/source/static_url_source'
 require 'avatar/source/nil_source'
 require 'digest/md5'
 
-unless Object.method_defined?(:returning)
-  Object.class_eval do
-    def returning(value)
-      yield(value)
-      value
-    end
-  end
-end
-
 module Avatar # :nodoc:
   module Source # :nodoc:
     # NOTE: since Gravatar always returns a URL (never a 404), instances of this
@@ -48,16 +39,16 @@ module Avatar # :nodoc:
       
       # Generates a Gravatar URL.  Returns nil if person is nil.
       # Options: 
-      # * <code>:field (Symbol)</code> - the field to call from person.  By default, <code>:email</code>.
+      # * <code>:gravatar_field (Symbol)</code> - the field to call from person.  By default, <code>:email</code>.
       # * <code>:default (String)</code> - override the default generated by <code>default_source</code>.
-      # * <code>:size or :s</code> - the size in pixels of the avatar to render.
-      # * <code>:rating or :r</code> - the maximum rating; one of ['G', 'PG', 'R', 'X']
+      # * <code>:gravatar_size or size or :s</code> - the size in pixels of the avatar to render.
+      # * <code>:gravatar_rating or rating or :r</code> - the maximum rating; one of ['G', 'PG', 'R', 'X']
       def avatar_url_for(person, options = {})
         return nil if person.nil?
-        field = options.delete(:field) || default_field
-        raise ArgumentError.new('No field specified; either specify a default field or pass in a value for :field (probably :email)') unless field
-        
         options = parse_options(person, options)
+        field = options.delete(:gravatar_field)
+        raise ArgumentError.new('No field specified; either specify a default field or pass in a value for :gravatar_field (probably :email)') unless field
+        
         returning(self.class.base_url) do |url|
           url << Digest::MD5::hexdigest(person.send(field)).strip
           options.each do |k, v|
@@ -68,14 +59,21 @@ module Avatar # :nodoc:
         end
       end
       
+      # Returns a Hash containing
+      # * :field - passed through; defaults to <code>self.default_field</code>
+      # * :default - passed through; defaults to <code>self.default_avatar_url_for(+person+, +options+)</code>
+      # * :size - :gravatar_size or :size or :s passed through <em>only if a number</em>
+      # * :rating - :gravatar_rating or :rating or :r passed through <em>only if one of <code>self.class.allowed_ratings</code></em>
       def parse_options(person, options)
         returning({}) do |result|
+          result[:gravatar_field] = options[:gravatar_field] || default_field
+          
           result[:default] = options[:default] || default_avatar_url_for(person, options)
 
-          size = options[:size] || options[:s]
+          size = options[:gravatar_size] || options[:size] || options[:s]
           result[:size] = size if size.to_s =~ /^\d*/
 
-          rating = options[:rating] || options[:r]
+          rating = options[:gravatar_rating] || options[:rating] || options[:r]
           result[:rating] = rating.upcase if rating and self.class.allowed_ratings.include?(rating.to_s)
         end
       end

data/lib/avatar/source/string_substitution_source.rb

@@ -15,8 +15,8 @@ module Avatar # :nodoc:
       # Create a new source with static url +url+, which can contain any number
       # of variables to be subsituted through +options+.  Strings should
       # be of the form '...#{variable_a}...#{variable_b}...'.  <em>note the
-      # single quotes</em>; double quotes will cause the variables to be
-      # substituted at Source-creation (when #new is called); this is almost
+      # single quotes</em>.  Double quotes will cause the variables to be
+      # substituted at Source-creation (when #new is called), which is almost
       # certainly <strong>not</strong> what you want.
       def initialize(url)
         raise ArgumentError.new("URL cannot be nil") if url.nil?

data/lib/avatar/version.rb

@@ -2,7 +2,7 @@ module Avatar #:nodoc:
   module VERSION #:nodoc:
     MAJOR = 0
     MINOR = 0
-    TINY  = 2
+    TINY  = 3
 
     STRING = [MAJOR, MINOR, TINY].join('.')
   end

data/test/test_file_column_source.rb

@@ -4,6 +4,7 @@ require 'avatar/source/file_column_source'
 
 class User < ActiveRecord::Base
   file_column :avatar
+  file_column :icon
 end
 
 class TestFileColumnSource < Test::Unit::TestCase
@@ -12,6 +13,7 @@ class TestFileColumnSource < Test::Unit::TestCase
     @source = Avatar::Source::FileColumnSource.new
     png = File.new(File.join(File.dirname(__FILE__), ['lib', 'user_suit.png']))
     @user_with_avatar = User.create!(:email => 'joe@example.com', :avatar => png)
+    @user_with_icon = User.create!(:email => 'terry@example.com', :icon => png)
     @user_without_avatar = User.create!(:email => 'sue@example.com')
   end
   
@@ -27,4 +29,8 @@ class TestFileColumnSource < Test::Unit::TestCase
     assert_equal "/user/avatar/#{@user_with_avatar.id}/0/user_suit.png", @source.avatar_url_for(@user_with_avatar)
   end
   
+  def test_avatar_url_for_person_with_icon_and_custom_file_column_field
+    assert_equal "/user/icon/#{@user_with_icon.id}/0/user_suit.png", @source.avatar_url_for(@user_with_icon, :file_column_field => :icon)
+  end
+  
 end

data/test/test_gravatar_source.rb

@@ -21,7 +21,7 @@ class TestGravatarSource < Test::Unit::TestCase
   
   def test_field
     name_hash = Digest::MD5::hexdigest(@gary.name)
-    assert_equal "http://www.gravatar.com/avatar/#{name_hash}", @source.avatar_url_for(@gary, :field => :name)
+    assert_equal "http://www.gravatar.com/avatar/#{name_hash}", @source.avatar_url_for(@gary, :gravatar_field => :name)
   end
   
   def test_site_wide_default_string
@@ -46,11 +46,13 @@ class TestGravatarSource < Test::Unit::TestCase
   end
   
   def test_size
-    assert_equal "http://www.gravatar.com/avatar/#{@email_hash}?size=70", @source.avatar_url_for(@gary, :size => 70)
+    assert_equal "http://www.gravatar.com/avatar/#{@email_hash}?size=70", @source.avatar_url_for(@gary, :gravatar_size => 70)
+    assert_equal "http://www.gravatar.com/avatar/#{@email_hash}?size=109", @source.avatar_url_for(@gary, :size => 109)
     assert_equal "http://www.gravatar.com/avatar/#{@email_hash}?size=62", @source.avatar_url_for(@gary, :s => 62)
   end
   
   def test_rating
+    assert_equal "http://www.gravatar.com/avatar/#{@email_hash}?rating=G", @source.avatar_url_for(@gary, :gravatar_rating => 'G')
     assert_equal "http://www.gravatar.com/avatar/#{@email_hash}?rating=R", @source.avatar_url_for(@gary, :rating => 'R')
     assert_equal "http://www.gravatar.com/avatar/#{@email_hash}?rating=PG", @source.avatar_url_for(@gary, :r => 'PG')
   end

data/website/index.html

@@ -33,7 +33,7 @@
     <h1>Avatar</h1>
     <div id="version" class="clickable" onclick='document.location = "http://rubyforge.org/projects/avatar"; return false'>
       <p>Get Version</p>
-      <a href="http://rubyforge.org/projects/avatar" class="numbers">0.0.2</a>
+      <a href="http://rubyforge.org/projects/avatar" class="numbers">0.0.3</a>
     </div>
     <h1>&#x2192; &#8216;Avatar&#8217;</h1>
 
@@ -55,14 +55,17 @@ Set up Avatar::source (by default, a Gravatar with a StaticUrl as the default)</
 	<h2>Demonstration of usage</h2>
 
 
-	<p>class PeopleHelper
+app/helpers/people_helper.rb:
+<pre><code class='ruby'>
+class PeopleHelper
     include Avatar::View::ActionViewSupport
-end</p>
-
-
-	<p>app/views/people/show.html.erb:
-&lt;%= avatar_tag(@current_user, :size =&gt; 40) %&gt;</p>
+end
+</code></pre>
 
+app/views/people/show.html.erb:
+<pre><code class='ruby erb'>
+&lt;%= avatar_tag(@current_user, :size =&gt; 40) %&gt;
+</code></pre>
 
 	<h2>Forum</h2>
 
@@ -90,7 +93,7 @@ end</p>
 
 	<p>Comments are welcome. Put them on the <a href="http://groups.google.com/group/ruby-avatar">forum</a></p>
     <p class="coda">
-      <a href="FIXME email">FIXME full name</a>, 26th March 2008<br>
+      <a href="FIXME email">FIXME full name</a>, 27th March 2008<br>
       Theme extended from <a href="http://rb2js.rubyforge.org/">Paul Battley</a>
     </p>
 </div>

data/website/index.txt

@@ -16,12 +16,17 @@ Set up Avatar::source (by default, a Gravatar with a StaticUrl as the default)
 
 h2. Demonstration of usage
 
+app/helpers/people_helper.rb:
+<pre><code class='ruby'>
 class PeopleHelper
 	include Avatar::View::ActionViewSupport
-end  
+end
+</code></pre>
 
 app/views/people/show.html.erb:
+<pre><code class='ruby erb'>
 <%= avatar_tag(@current_user, :size => 40) %>
+</code></pre>
 
 
 h2. Forum

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: avatar
 version: !ruby/object:Gem::Version 
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors: 
 - James Rosen
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-03-26 00:00:00 -04:00
+date: 2008-03-27 00:00:00 -04:00
 default_executable: 
 dependencies: []