avatar 0.0.4 → 0.0.5

data/History.txt

@@ -1,3 +1,13 @@
+== 0.0.5 2008-04-01
+* 4 major enhancements:
+  * added PaperclipSource for use with the Paperclip plugin
+  * added AbstractSourceWrapper
+  * changed StringSubstitutionSource to a SourceWrapper
+  * changed RailsAssetSource to a SourceWrapper
+
+* 1 minor change:
+  * moved StringSubstitution out of separate module and into new StringSubstitutionSourceWrapper
+
 == 0.0.4 2008-03-28
 * 2 major fixes:
   * GravatarSource downcases email to comply with Gravatar standards

data/Manifest.txt

@@ -13,11 +13,13 @@ 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/rails_asset_source.rb
+lib/avatar/source/paperclip_source.rb
 lib/avatar/source/source_chain.rb
 lib/avatar/source/static_url_source.rb
-lib/avatar/source/string_substitution_source.rb
-lib/avatar/string_substitution.rb
+lib/avatar/source/wrapper.rb
+lib/avatar/source/wrapper/abstract_source_wrapper.rb
+lib/avatar/source/wrapper/rails_asset_source_wrapper.rb
+lib/avatar/source/wrapper/string_substitution_source_wrapper.rb
 lib/avatar/version.rb
 lib/avatar/view.rb
 lib/avatar/view/abstract_view_support.rb
@@ -57,6 +59,30 @@ 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/paperclip/README
+test/lib/paperclip/Rakefile
+test/lib/paperclip/generators/paperclip/USAGE
+test/lib/paperclip/generators/paperclip/paperclip_generator.rb
+test/lib/paperclip/generators/paperclip/templates/paperclip_migration.rb
+test/lib/paperclip/init.rb
+test/lib/paperclip/lib/paperclip.rb
+test/lib/paperclip/lib/paperclip/attachment.rb
+test/lib/paperclip/lib/paperclip/geometry.rb
+test/lib/paperclip/lib/paperclip/iostream.rb
+test/lib/paperclip/lib/paperclip/thumbnail.rb
+test/lib/paperclip/lib/paperclip/upfile.rb
+test/lib/paperclip/tasks/paperclip_tasks.rake
+test/lib/paperclip/test/database.yml
+test/lib/paperclip/test/fixtures/12k.png
+test/lib/paperclip/test/fixtures/5k.png
+test/lib/paperclip/test/fixtures/bad.png
+test/lib/paperclip/test/helper.rb
+test/lib/paperclip/test/test_attachment.rb
+test/lib/paperclip/test/test_geometry.rb
+test/lib/paperclip/test/test_integration.rb
+test/lib/paperclip/test/test_iostream.rb
+test/lib/paperclip/test/test_paperclip.rb
+test/lib/paperclip/test/test_thumbnail.rb
 test/lib/schema.rb
 test/lib/user_suit.png
 test/test_abstract_view_support.rb
@@ -66,11 +92,11 @@ test/test_file_column_source.rb
 test/test_gravatar_source.rb
 test/test_helper.rb
 test/test_nil_source.rb
-test/test_rails_asset_source.rb
+test/test_paperclip_source.rb
+test/test_rails_asset_source_wrapper.rb
 test/test_source_chain.rb
 test/test_static_url_source.rb
-test/test_string_substitution.rb
-test/test_string_substitution_source.rb
+test/test_string_substitution_source_wrapper.rb
 website/index.html
 website/index.txt
 website/javascripts/rounded_corners_lite.inc.js

data/lib/avatar.rb

@@ -8,7 +8,7 @@ require 'avatar/source/gravatar_source'
 #   include Avatar::ActionView::Support
 #
 #   # in app/views/profiles/show.html.erb:
-#   <%= avatar_for @person =>
+#   <%= avatar_for @person => current_person %>
 #
 # By default, Avatar::source is a GravatarSource
 module Avatar

data/lib/avatar/source/gravatar_source.rb

@@ -56,7 +56,9 @@ module Avatar # :nodoc:
         
         returning(self.class.base_url) do |url|
           url << Digest::MD5::hexdigest(email).strip
-          options.each do |k, v|
+          # default must be last or the other options will be parameters to that URL, not the Gravatar one
+          [:size, :rating, :default].each do |k|
+            v = options[k]
             next if v.nil?
             url << (url.include?('?') ? '&' : '?')
             url << "#{k}=#{v}"
@@ -65,10 +67,10 @@ module Avatar # :nodoc:
       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>
+      # * :field - value of :gravatar_field; defaults to <code>self.default_field</code>
+      # * :default - value of :gravatar_default_url; defaults to <code>self.default_avatar_url_for(+person+, +options+)</code>
+      # * :size - value of :gravatar_size or :size or :s passed through <em>only if a number</em>
+      # * :rating - value of :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

data/lib/avatar/source/paperclip_source.rb

@@ -0,0 +1,52 @@
+require 'avatar/object_support'
+require 'avatar/source/abstract_source'
+
+module Avatar # :nodoc:
+  module Source # :nodoc:
+    # Source for a file attachment using Paperclip.
+    # See http://giantrobots.thoughtbot.com/2008/3/18/for-attaching-files-use-paperclip
+    class PaperclipSource
+      include AbstractSource
+    
+      attr_accessor :default_field, :default_style
+      
+      # Create a new FileColumnSource with a +default_field+ (by default, :avatar),
+      # and a +default_style+ (by default, nil)
+      def initialize(default_field = :avatar, default_style = nil)
+        @default_field = default_field
+        @default_style = default_style
+      end
+    
+      # Returns a URL for a has_attached_file attribute, via
+      # <code>person.<paperclip_field>.url</code>, passing in :paperclip_style if present.
+      # Returns nil under any of the following circumstances:
+      # * person is nil
+      # * person.<paperclip_field> is nil
+      # * person.<paperclip_field>? returns false
+      # * person.<paperclip_field>.styles does not include :paperclip_style (if present)
+      # Options:
+      # * <code>:paperclip_field</code> - the has_attached_file column within +person+; by default, self.default_field
+      # * <code>:paperclip_style</code> - one of the styles of the has_attached_file; by default, self.default_style
+      def avatar_url_for(person, options = {})
+        return nil if person.nil?
+        options = parse_options(person, options)
+        field = options[:paperclip_field]
+        return nil if field.nil?
+        return nil unless person.send("#{field}?".to_sym)
+        avatar = person.send(field)
+        style = options[:paperclip_style]
+        return nil if style && !avatar.styles.keys.include?(style)
+        avatar.url(style)
+      end
+    
+      # Copies :paperclip_field and :paperclip_style from +options+, adding defaults if necessary.
+      def parse_options(person, options)
+        returning({}) do |result|
+          result[:paperclip_field] = options[:paperclip_field] || default_field
+          result[:paperclip_style] = options[:paperclip_style] || default_style
+        end
+      end
+      
+    end
+  end
+end

data/lib/avatar/source/wrapper.rb

@@ -0,0 +1,6 @@
+module Avatar
+  module Source
+    module Wrapper
+    end
+  end
+end

data/lib/avatar/source/wrapper/abstract_source_wrapper.rb

@@ -0,0 +1,33 @@
+require 'avatar/source/abstract_source'
+
+module Avatar
+  module Source
+    module Wrapper
+      class AbstractSourceWrapper
+        include Avatar::Source::AbstractSource
+        
+        attr_reader :underlying_source
+        
+        # Create a new Wrapper
+        def initialize(underlying_source)
+          raise ArgumentError.new("underlying_source must be Source") unless underlying_source.kind_of?(Avatar::Source::AbstractSource)
+          @underlying_source = underlying_source
+        end
+        
+        # Return nil if the underlying_source does; otherwise, calls <code>wrap</code>,
+        # passing the returned URL and the person and options passed.
+        def avatar_url_for(person, options = {})
+          url = @underlying_source.avatar_url_for(person, options)
+          url.nil? ? nil : wrap(url, person, options)
+        end
+        
+        # Apply appropriate wrapping of the +url+ returned by <code>underlying_source</code>.
+        # Will never be called with a nil +url+.
+        def wrap(url, person, options)
+          raise NotImplementedError('subclasses must override wrap(url, person, options)')
+        end
+        
+      end
+    end
+  end
+end

data/lib/avatar/source/wrapper/rails_asset_source_wrapper.rb

@@ -0,0 +1,36 @@
+require 'avatar/source/wrapper/abstract_source_wrapper'
+require 'action_view/helpers/asset_tag_helper'
+
+module Avatar # :nodoc:
+  module Source # :nodoc:
+    module Wrapper
+      # Wraps a Source using Rails' <code>AssetTagHelper#image_path</code>,
+      # which can turn path URLs (e.g. '/images/my_avatar.png')
+      # into absolute URLs( e.g. 'http://assets.mysite.com/images/my_avatar.png').
+      class RailsAssetSourceWrapper < AbstractSourceWrapper
+      
+        attr_reader :url_helper
+      
+        private :url_helper
+      
+        def initialize(source)
+          super
+          @url_helper = Object.new
+          @url_helper.extend(ActionView::Helpers::AssetTagHelper)
+        end
+      
+        # Passes +url+ to <code>AssetTagHelper#image_path</code>.  Raises
+        # an error if it cannot generate a fully-qualified URI.  Try
+        # setting <code>ActionController::Base.asset_host</code> to
+        # avoid this error.
+        def wrap(url, person, options = {})
+          # url will never be nil b/c of guarantee in AbstractSourceWrapper
+          result = url_helper.image_path(url)
+          raise "could not generate protocol and host for #{url}.  Have you set ActionController::Base.asset_host?" unless result =~ /^http[s]?\:\/\//
+          result
+        end
+      
+      end
+    end
+  end
+end

data/lib/avatar/source/wrapper/string_substitution_source_wrapper.rb

@@ -0,0 +1,55 @@
+require 'avatar/source/wrapper/abstract_source_wrapper'
+require 'action_view/helpers/asset_tag_helper'
+
+module Avatar # :nodoc:
+  module Source # :nodoc:
+    module Wrapper
+      # Wraps a Source using Rails' <code>AssetTagHelper#image_path</code>,
+      # which can turn path URLs (e.g. '/images/my_avatar.png')
+      # into absolute URLs( e.g. 'http://assets.mysite.com/images/my_avatar.png').
+      class StringSubstitutionSourceWrapper < AbstractSourceWrapper
+      
+        attr_accessor :default_options
+      
+        def initialize(source, default_options = {})
+          super(source)
+          self.default_options = default_options || {}
+        end
+      
+        # Passes +url+ to <code>AssetTagHelper#image_path</code>.  Raises
+        # an error if it cannot generate a fully-qualified URI.  Try
+        # setting <code>ActionController::Base.asset_host</code> to
+        # avoid this error.
+        def wrap(url, person, options = {})
+          # url will never be nil b/c of guarantee in AbstractSourceWrapper
+          result = apply_substitution(url, self.default_options.merge(options))
+          substitution_needed?(result) ? nil : result
+        end
+
+        def default_options=(opts)
+          @default_options = opts || {}
+        end
+        
+        # For each key in +options+ replaces '#{key}' in +string+ with the
+        # corresponding value in +options+.
+        # +string+ should
+        # be of the form '...#{variable_a}...#{variable_b}...'.  <em>Note the
+        # single quotes</em>.  Double quotes will cause the variables to be
+        # substituted before this method is run, which is almost
+        # certainly <strong>not</strong> what you want.
+        def apply_substitution(string, options)
+          returning(string.dup) do |result|
+            options.each do |k,v|
+              result.gsub!(Regexp.new('#\{' + "#{k}" + '\}'), "#{v}")
+            end
+          end
+        end
+
+        def substitution_needed?(string)
+          string =~ /#\{.*\}/
+        end
+      
+      end
+    end
+  end
+end

data/lib/avatar/version.rb

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

data/test/lib/paperclip/README

@@ -0,0 +1,32 @@
+=Paperclip
+
+Paperclip is intended as an easy file attachment library for ActiveRecord. The intent behind it was to keep setup as easy as possible and to treat files as much like other attributes as possible. This means they aren't saved to their final locations on disk, nor are they deleted if set to nil, until ActiveRecord::Base#save is called. It manages validations based on size and presence, if required. It can transform its assigned image into thumbnails if needed, and the prerequisites are as simple as installing ImageMagick (which, for most modern Unix-based systems, is as easy as installing the right packages). Attached files are saved to the filesystem and referenced in the browser by an easily understandable specification, which has sensible and useful defaults.
+
+See the documentation for the +has_attached_file+ method for options.
+
+==Usage
+
+In your model:
+
+  class User < ActiveRecord::Base
+    has_attached_file :avatar, :styles => { :medium => "300x300>", :thumb => "100x100>" }
+  end
+
+In your edit and new views:
+
+  <% form_for :user, @user, :url => user_path, :html => { :multipart => true } do |form| %>
+    <%= form.file_field :avatar %>
+  <% end %>
+
+In your controller:
+
+  def create
+    @user = User.create( params[:user] )
+  end
+
+In your show view:
+
+  <%= image_tag @user.avatar.url %>
+  <%= image_tag @user.avatar.url(:medium) %>
+  <%= image_tag @user.avatar.url(:thumb) %>
+

data/test/lib/paperclip/Rakefile

@@ -0,0 +1,41 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+desc 'Default: run unit tests.'
+task :default => [:clean, :test]
+
+desc 'Test the paperclip plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib' << 'profile'
+  t.pattern = 'test/**/test_*.rb'
+  t.verbose = true
+end
+
+desc 'Start an IRB session with all necessary files required.'
+task :shell do |t|
+  chdir File.dirname(__FILE__)
+  exec 'irb -I lib/ -I lib/paperclip -r rubygems -r active_record -r tempfile -r init'
+end
+
+desc 'Generate documentation for the paperclip plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'doc'
+  rdoc.title    = 'Paperclip'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+desc 'Update documentation on website'
+task :sync_docs => 'rdoc' do
+  `rsync -ave ssh doc/ dev@dev.thoughtbot.com:/home/dev/www/dev.thoughtbot.com/paperclip`
+end
+
+desc 'Clean up files.'
+task :clean do |t|
+  FileUtils.rm_rf "doc"
+  FileUtils.rm_rf "tmp"
+  FileUtils.rm "test/debug.log" rescue nil
+  FileUtils.rm "test/paperclip.db" rescue nil
+end

data/test/lib/paperclip/generators/paperclip/USAGE

@@ -0,0 +1,5 @@
+Usage:
+
+  script/generate attachment Class attachment1 attachment2
+  
+This will create a migration that will add the proper columns to your class's table.

data/test/lib/paperclip/generators/paperclip/paperclip_generator.rb

@@ -0,0 +1,27 @@
+class PaperclipGenerator < Rails::Generator::NamedBase
+  attr_accessor :attachments, :migration_name
+ 
+  def initialize(args, options = {})
+    super
+    @class_name, @attachments = args[0], args[1..-1]
+  end
+ 
+  def manifest    
+    file_name = generate_file_name
+    @migration_name = file_name.camelize
+    record do |m|
+      m.migration_template "paperclip_migration.rb",
+                           File.join('db', 'migrate'),
+                           :migration_file_name => file_name
+    end
+  end 
+  
+  private 
+  
+  def generate_file_name
+    names = attachments.map{|a| a.underscore }
+    names = names[0..-2] + ["and", names[-1]] if names.length > 1
+    "add_attachments_#{names.join("_")}_to_#{@class_name.underscore}"
+  end
+ 
+end

data/test/lib/paperclip/generators/paperclip/templates/paperclip_migration.rb

@@ -0,0 +1,17 @@
+class <%= migration_name %> < ActiveRecord::Migration
+  def self.up
+<% attachments.each do |attachment| -%>
+    add_column :<%= class_name.underscore.camelize.tableize %>, :<%= attachment %>_file_name, :string
+    add_column :<%= class_name.underscore.camelize.tableize %>, :<%= attachment %>_content_type, :string
+    add_column :<%= class_name.underscore.camelize.tableize %>, :<%= attachment %>_file_size, :integer
+<% end -%>
+  end
+
+  def self.down
+<% attachments.each do |attachment| -%>
+    remove_column :<%= class_name.underscore.camelize.tableize %>, :<%= attachment %>_file_name
+    remove_column :<%= class_name.underscore.camelize.tableize %>, :<%= attachment %>_content_type
+    remove_column :<%= class_name.underscore.camelize.tableize %>, :<%= attachment %>_file_size
+<% end -%>
+  end
+end

data/test/lib/paperclip/init.rb

@@ -0,0 +1,3 @@
+require File.join(File.dirname(__FILE__), "lib", "paperclip")
+ActiveRecord::Base.extend( Paperclip::ClassMethods )
+File.send :include, Paperclip::Upfile