avatar 0.0.1

data/.gitignore

@@ -0,0 +1,11 @@
+#ignore all .diff files
+/*.diff
+
+#ignore coverage reports
+/coverage
+
+#ignore logs
+/log/*.log
+
+#ignore packaged local gem:
+/pkg

data/History.txt

@@ -0,0 +1,14 @@
+== 0.0.1 2008-03-24
+
+* 1 major enhancement:
+  * Initial release
+  * AbstractSource
+  * FileColumnSource
+  * GravatarSource
+  * NilSource
+  * SourceChain
+  * StaticUrlSource
+  * StringSubstitutionSource
+  * AbstractViewSupport
+  * ActionViewSupport
+  * tests

data/License.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2008 Universal Presence, Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Manifest.txt

@@ -0,0 +1,73 @@
+.gitignore
+History.txt
+License.txt
+Manifest.txt
+README.txt
+Rakefile
+config/hoe.rb
+config/requirements.rb
+lib/avatar.rb
+lib/avatar/source.rb
+lib/avatar/source/abstract_source.rb
+lib/avatar/source/file_column_source.rb
+lib/avatar/source/gravatar_source.rb
+lib/avatar/source/nil_source.rb
+lib/avatar/source/source_chain.rb
+lib/avatar/source/static_url_source.rb
+lib/avatar/source/string_substitution_source.rb
+lib/avatar/version.rb
+lib/avatar/view.rb
+lib/avatar/view/abstract_view_support.rb
+lib/avatar/view/action_view_support.rb
+script/destroy
+script/generate
+script/txt2html
+setup.rb
+tasks/deployment.rake
+tasks/environment.rake
+tasks/testing.rake
+tasks/website.rake
+test/.gitignore
+test/lib/database.rb
+test/lib/database.yml
+test/lib/file_column/CHANGELOG
+test/lib/file_column/README
+test/lib/file_column/Rakefile
+test/lib/file_column/TODO
+test/lib/file_column/init.rb
+test/lib/file_column/lib/file_column.rb
+test/lib/file_column/lib/file_column_helper.rb
+test/lib/file_column/lib/file_compat.rb
+test/lib/file_column/lib/magick_file_column.rb
+test/lib/file_column/lib/rails_file_column.rb
+test/lib/file_column/lib/test_case.rb
+test/lib/file_column/lib/validations.rb
+test/lib/file_column/test/abstract_unit.rb
+test/lib/file_column/test/connection.rb
+test/lib/file_column/test/file_column_helper_test.rb
+test/lib/file_column/test/file_column_test.rb
+test/lib/file_column/test/fixtures/entry.rb
+test/lib/file_column/test/fixtures/invalid-image.jpg
+test/lib/file_column/test/fixtures/kerb.jpg
+test/lib/file_column/test/fixtures/mysql.sql
+test/lib/file_column/test/fixtures/schema.rb
+test/lib/file_column/test/fixtures/skanthak.png
+test/lib/file_column/test/magick_test.rb
+test/lib/file_column/test/magick_view_only_test.rb
+test/lib/schema.rb
+test/lib/user_suit.png
+test/test_abstract_view_support.rb
+test/test_action_view_support.rb
+test/test_avatar.rb
+test/test_file_column_source.rb
+test/test_gravatar_source.rb
+test/test_helper.rb
+test/test_nil_source.rb
+test/test_source_chain.rb
+test/test_static_url_source.rb
+test/test_string_substitution_source.rb
+website/index.html
+website/index.txt
+website/javascripts/rounded_corners_lite.inc.js
+website/stylesheets/screen.css
+website/template.rhtml

data/README.txt

@@ -0,0 +1,65 @@
+= avatar
+
+* http://avatar.rubyforge.org
+
+== DESCRIPTION:
+Avatar is a collection of Ruby utilities for displaying avatars.
+
+== FEATURES/PROBLEMS:
+
+Avatar currently supports the following sources:
+* Gravatar (see http://www.gravatar.com)
+* a constant URL (e.g. http://mysite.com/images/default_icon.png)
+* parameterized URLs (e.g. http://mysite.com/images/famfamfam/user_#{color}.png)
+* file_column (see http://www.kanthak.net/opensource/file_column/)
+* chains of sources (e.g. file_column if exists; otherwise default constant URL)
+
+Avatar currently supports the following views:
+* ActionView (Rails), through avatar_tag
+* AbstractView (any framework), through avatar_url_for
+
+== SYNOPSIS:
+
+in RAILS_ROOT/app/helpers/people_helper.rb
+require 'avatar/view/action_view_support'
+class PeopleHelper
+	include Avatar::View::ActionViewSupport
+end  
+
+in RAILS_ROOT/app/views/people/show.html.erb:
+<%= avatar_tag(@current_user, :size => 40) %>
+
+== REQUIREMENTS:
+
+* none for basic functionality
+* will integrate with ActionView
+* will integrate with the file_column Rails plugin
+
+== INSTALL:
+
+* sudo gem install avatar
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2008 Universal Presenece, Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,10 @@
+require 'config/requirements'
+require 'config/hoe' # setup Hoe + all gem configuration
+
+Rake::TaskManager.class_eval do
+  def remove_task(task_name)
+    @tasks.delete(task_name.to_s)
+  end
+end
+
+Dir['tasks/**/*.rake'].each { |rake| load rake }

data/config/hoe.rb

@@ -0,0 +1,70 @@
+require 'avatar/version'
+
+AUTHOR = 'James Rosen'  # can also be an array of Authors
+EMAIL = "james@u-presence.com"
+DESCRIPTION = "helpers for displaying avatars"
+GEM_NAME = 'avatar' # what ppl will type to install your gem
+RUBYFORGE_PROJECT = 'avatar' # The unix name for your project
+HOMEPATH = "http://#{RUBYFORGE_PROJECT}.rubyforge.org"
+DOWNLOAD_PATH = "http://rubyforge.org/projects/#{RUBYFORGE_PROJECT}"
+
+@config_file = "~/.rubyforge/user-config.yml"
+@config = nil
+RUBYFORGE_USERNAME = "unknown"
+def rubyforge_username
+  unless @config
+    begin
+      @config = YAML.load(File.read(File.expand_path(@config_file)))
+    rescue
+      puts <<-EOS
+ERROR: No rubyforge config file found: #{@config_file}
+Run 'rubyforge setup' to prepare your env for access to Rubyforge
+ - See http://newgem.rubyforge.org/rubyforge.html for more details
+      EOS
+      exit
+    end
+  end
+  RUBYFORGE_USERNAME.replace @config["username"]
+end
+
+
+REV = nil 
+# UNCOMMENT IF REQUIRED: 
+# REV = `svn info`.each {|line| if line =~ /^Revision:/ then k,v = line.split(': '); break v.chomp; else next; end} rescue nil
+VERS = Avatar::VERSION::STRING + (REV ? ".#{REV}" : "")
+RDOC_OPTS = ['--quiet', '--title', 'avatar documentation',
+    "--opname", "index.html",
+    "--line-numbers", 
+    "--main", "README",
+    "--inline-source"]
+
+class Hoe
+  def extra_deps 
+    @extra_deps.reject! { |x| Array(x).first == 'hoe' } 
+    @extra_deps
+  end 
+end
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+hoe = Hoe.new(GEM_NAME, VERS) do |p|
+  p.developer(AUTHOR, EMAIL)
+  p.description = DESCRIPTION
+  p.summary = DESCRIPTION
+  p.url = HOMEPATH
+  p.rubyforge_name = RUBYFORGE_PROJECT if RUBYFORGE_PROJECT
+  p.test_globs = ["test/**/test_*.rb"]
+  p.clean_globs |= ['coverage', 'test/public', '**/.*.sw?', '*.gem', '.config', '**/.DS_Store']  #An array of file patterns to delete on clean.
+  
+  # == Optional
+  p.changes = p.paragraphs_of("History.txt", 0..1).join("\n\n")
+  #p.extra_deps = []     # An array of rubygem dependencies [name, version], e.g. [ ['active_support', '>= 1.3.1'] ]
+  
+  #p.spec_extras = {}    # A hash of extra values to set in the gemspec.
+  
+end
+
+CHANGES = hoe.paragraphs_of('History.txt', 0..1).join("\\n\\n")
+PATH    = (RUBYFORGE_PROJECT == GEM_NAME) ? RUBYFORGE_PROJECT : "#{RUBYFORGE_PROJECT}/#{GEM_NAME}"
+hoe.remote_rdoc_dir = File.join(PATH.gsub(/^#{RUBYFORGE_PROJECT}\/?/,''), 'rdoc')
+hoe.rsync_args = '-av --delete --ignore-errors'

data/config/requirements.rb

@@ -0,0 +1,17 @@
+require 'fileutils'
+include FileUtils
+
+require 'rubygems'
+%w[rake hoe newgem rubigen].each do |req_gem|
+  begin
+    require req_gem
+  rescue LoadError
+    puts "This Rakefile requires the '#{req_gem}' RubyGem."
+    puts "Installation: gem install #{req_gem} -y"
+    exit
+  end
+end
+
+$:.unshift(File.join(File.dirname(__FILE__), %w[.. lib]))
+
+require 'avatar'

data/lib/avatar.rb

@@ -0,0 +1,44 @@
+$:.unshift File.expand_path(File.dirname(__FILE__))
+require 'avatar/source/abstract_source'
+require 'avatar/source/gravatar_source'
+require 'avatar/source/static_url_source'
+require 'avatar/source/nil_source'
+
+# Helpers for displaying avatars.
+# Usage in Rails:
+#   # in app/helpers/ProfileHelper.rb:
+#   include Avatar::ActionView::Support
+#
+#   # in app/views/profiles/show.html.erb:
+#   <%= avatar_for @person =>
+#
+# By default, Avatar::source is a GravatarSource with
+# StaticUrlSource as its default.
+# The latter has the url '/images/default_avatar.png'.
+module Avatar
+  
+  @@source = Avatar::Source::NilSource.new
+  @@default_avatar_options = {}
+  
+  def self.source
+    @@source.dup
+  end
+  
+  def self.source=(source)
+    raise ArgumentError.new("#{source} is not an Avatar::Source::AbstractSource") unless source.kind_of?(Avatar::Source::AbstractSource)
+    @@source = source
+  end
+  
+  def self.default_avatar_options
+    @@default_avatar_options.dup
+  end
+  
+  def self.default_avatar_options=(options)
+    raise ArgumentError.new("#{options} is not a Hash") unless options.kind_of?(Hash)
+    @@options = options
+  end
+  
+end
+
+url_source = Avatar::Source::StaticUrlSource.new('/images/default_avatar.png')
+Avatar.source = Avatar::Source::GravatarSource.new(url_source)

data/lib/avatar/source.rb

@@ -0,0 +1,4 @@
+module Avatar # :nodoc:
+  module Source # :nodoc:
+  end
+end

data/lib/avatar/source/abstract_source.rb

@@ -0,0 +1,15 @@
+module Avatar # :nodoc:
+  module Source # :nodoc:
+    # To be included by classes that generate avatar URLs from profiles.
+    module AbstractSource
+      
+      # Return an avatar URL for the person, or nil if this source cannot generate one.
+      # Including classes <em>must</em> override this method.  In general, implementations
+      # should return nil if +person+ is nil.
+      def avatar_url_for(person, options = {})
+        raise NotImplementedError.new('including class must define avatar_url_for(person, options = {})')
+      end
+      
+    end
+  end
+end

data/lib/avatar/source/file_column_source.rb

@@ -0,0 +1,35 @@
+require 'avatar/source/abstract_source'
+require 'file_column_helper'
+
+module Avatar # :nodoc:
+  module Source # :nodoc:
+    # For use with the FileColumn Rails plugin.
+    class FileColumnSource
+      include AbstractSource
+      include FileColumnHelper
+      
+      attr_accessor :default_field
+      
+      def initialize(default_field = :avatar)
+        raise ArgumentError.new('default_field cannot be nil') if default_field.nil?
+        @default_field = default_field
+      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.
+      # Options:
+      # * <code>: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
+        return nil if field.nil? || person.send(field).nil?
+        options = options[:file_column_version] || options
+        url_for_image_column(person, field, options)
+      end
+      
+    end
+  end
+end

data/lib/avatar/source/gravatar_source.rb

@@ -0,0 +1,78 @@
+require 'avatar/source/abstract_source'
+require 'avatar/source/static_url_source'
+require 'avatar/source/nil_source'
+require 'digest/md5'
+
+module Avatar # :nodoc:
+  module Source # :nodoc:
+    # NOTE: since Gravatar always returns a URL (never a 404), instances of this
+    # class should only be placed at the end of a SourceChain.
+    # (see link:classes/Avatar/Source/SourceChain.html)
+    # Alternatively, use <code>default_source = ...</code> to generate a site-wide
+    # default to be passed to Gravatar.  (In fact, since <code>default_source</code>
+    # is an instance of Avatar::Source::AbstractSource, it can generate a different
+    # default for each person.)
+    class GravatarSource
+      include AbstractSource
+      
+      attr_accessor :default_field
+      attr_reader :default_source
+      
+      # 'http://www.gravatar.com/avatar/'
+      def self.base_url
+        'http://www.gravatar.com/avatar/'
+      end
+      
+      # :nodoc:
+      def initialize(default_source = nil, default_field = :email)
+        self.default_source = default_source #not @default_source = ... b/c want to use the setter function below
+        @default_field = default_field
+        raise "There's a bug in the code" if @default_source.nil?
+      end
+      
+      # 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>: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']
+      def avatar_url_for(person, options = {})
+        return nil if person.nil?
+        options[:default] ||= default_avatar_url_for(person, options)
+        field = options[: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
+        url = self.class.base_url
+        url << Digest::MD5::hexdigest(person.send(field)).strip
+        [:size, :s, :rating, :r, :default].each do |x|
+          next unless options[x]
+          url << (url.include?('?') ? '&' : '?')
+          url << "#{x}=#{options[x]}"
+        end
+        url
+      end
+      
+      # Set the default source for all people.
+      # If +default+ is a String, it will be converted to an instance of Avatar::Source::StaticUrlSource.
+      # If +default+ is nil, sets the default to a NilSource.
+      def default_source=(default)
+        case default
+        when String
+          @default_source = StaticUrlSource.new(default)
+        when AbstractSource
+          @default_source = default
+        when NilClass
+          @default_source = NilSource.new
+        else
+          raise ArgumentError.new("#{default} must be either a String or an instance of #{AbstractSource}")
+        end
+      end
+      
+      private
+      
+      def default_avatar_url_for(person, options)
+        @default_source.avatar_url_for(person, options)
+      end
+      
+    end
+  end
+end