atd-attachment_fu 1.0.20080507

data/lib/technoweenie/attachment_fu/processors/gd2_processor.rb

@@ -0,0 +1,54 @@
+require 'rubygems'
+require 'gd2'
+module Technoweenie # :nodoc:
+  module AttachmentFu # :nodoc:
+    module Processors
+      module Gd2Processor
+        def self.included(base)
+          base.send :extend, ClassMethods
+          base.alias_method_chain :process_attachment, :processing
+        end
+        
+        module ClassMethods
+          # Yields a block containing a GD2 Image for the given binary data.
+          def with_image(file, &block)
+            im = GD2::Image.import(file)
+            block.call(im)
+          end
+        end
+
+        protected
+          def process_attachment_with_processing
+            return unless process_attachment_without_processing && image?
+            with_image do |img|
+              resize_image_or_thumbnail! img
+              self.width  = img.width
+              self.height = img.height
+              callback_with_args :after_resize, img
+            end
+          end
+
+          # Performs the actual resizing operation for a thumbnail
+          def resize_image(img, size)
+            size = size.first if size.is_a?(Array) && size.length == 1
+            if size.is_a?(Fixnum) || (size.is_a?(Array) && size.first.is_a?(Fixnum))
+              if size.is_a?(Fixnum)
+                # Borrowed from image science's #thumbnail method and adapted 
+                # for this.
+                scale = size.to_f / (img.width > img.height ? img.width.to_f : img.height.to_f)
+                img.resize!((img.width * scale).round(1), (img.height * scale).round(1), false)
+              else
+                img.resize!(size.first, size.last, false) 
+              end
+            else
+              w, h = [img.width, img.height] / size.to_s
+              img.resize!(w, h, false)
+            end
+            temp_paths.unshift random_tempfile_filename
+            self.size = img.export(self.temp_path)
+          end
+
+      end
+    end
+  end
+end

data/lib/technoweenie/attachment_fu/processors/image_science_processor.rb

@@ -0,0 +1,61 @@
+require 'image_science'
+module Technoweenie # :nodoc:
+  module AttachmentFu # :nodoc:
+    module Processors
+      module ImageScienceProcessor
+        def self.included(base)
+          base.send :extend, ClassMethods
+          base.alias_method_chain :process_attachment, :processing
+        end
+
+        module ClassMethods
+          # Yields a block containing an Image Science image for the given binary data.
+          def with_image(file, &block)
+            ::ImageScience.with_image file, &block
+          end
+        end
+
+        protected
+          def process_attachment_with_processing
+            return unless process_attachment_without_processing && image?
+            with_image do |img|
+              self.width  = img.width  if respond_to?(:width)
+              self.height = img.height if respond_to?(:height)
+              resize_image_or_thumbnail! img
+            end
+          end
+
+          # Performs the actual resizing operation for a thumbnail
+          def resize_image(img, size)
+            # create a dummy temp file to write to
+            # ImageScience doesn't handle all gifs properly, so it converts them to
+            # pngs for thumbnails.  It has something to do with trying to save gifs
+            # with a larger palette than 256 colors, which is all the gif format
+            # supports.
+            filename.sub! /gif$/, 'png'
+            content_type.sub!(/gif$/, 'png')
+            temp_paths.unshift write_to_temp_file(filename)
+            grab_dimensions = lambda do |img|
+              self.width  = img.width  if respond_to?(:width)
+              self.height = img.height if respond_to?(:height)
+              img.save self.temp_path
+              self.size = File.size(self.temp_path)
+              callback_with_args :after_resize, img
+            end
+
+            size = size.first if size.is_a?(Array) && size.length == 1
+            if size.is_a?(Fixnum) || (size.is_a?(Array) && size.first.is_a?(Fixnum))
+              if size.is_a?(Fixnum)
+                img.thumbnail(size, &grab_dimensions)
+              else
+                img.resize(size[0], size[1], &grab_dimensions)
+              end
+            else
+              new_size = [img.width, img.height] / size.to_s
+              img.resize(new_size[0], new_size[1], &grab_dimensions)
+            end
+          end
+      end
+    end
+  end
+end

data/lib/technoweenie/attachment_fu/processors/mini_magick_processor.rb

@@ -0,0 +1,132 @@
+require 'mini_magick'
+module Technoweenie # :nodoc:
+  module AttachmentFu # :nodoc:
+    module Processors
+      module MiniMagickProcessor
+        def self.included(base)
+          base.send :extend, ClassMethods
+          base.alias_method_chain :process_attachment, :processing
+        end
+ 
+        module ClassMethods
+          # Yields a block containing an MiniMagick Image for the given binary data.
+          def with_image(file, &block)
+            begin
+              binary_data = file.is_a?(MiniMagick::Image) ? file : MiniMagick::Image.from_file(file) unless !Object.const_defined?(:MiniMagick)
+            rescue
+              # Log the failure to load the image.
+              logger.debug("Exception working with image: #{$!}")
+              binary_data = nil
+            end
+            block.call binary_data if block && binary_data
+          ensure
+            !binary_data.nil?
+          end
+        end
+ 
+      protected
+        def process_attachment_with_processing
+          return unless process_attachment_without_processing
+          with_image do |img|
+            resize_image_or_thumbnail! img
+            self.width = img[:width] if respond_to?(:width)
+            self.height = img[:height] if respond_to?(:height)
+            callback_with_args :after_resize, img
+          end if image?
+        end
+ 
+        # Performs the actual resizing operation for a thumbnail
+        def resize_image(img, size)
+          size = size.first if size.is_a?(Array) && size.length == 1
+          img.combine_options do |commands|
+            commands.strip unless attachment_options[:keep_profile]
+
+            # gif are not handled correct, this is a hack, but it seems to work.
+            if img.output =~ / GIF /
+              img.format("png")
+            end           
+            
+            if size.is_a?(Fixnum) || (size.is_a?(Array) && size.first.is_a?(Fixnum))
+              if size.is_a?(Fixnum)
+                size = [size, size]
+                commands.resize(size.join('x'))
+              else
+                commands.resize(size.join('x') + '!')
+              end
+            # extend to thumbnail size
+            elsif size.is_a?(String) and size =~ /e$/
+              size = size.gsub(/e/, '')
+              commands.resize(size.to_s + '>')
+              commands.background('#ffffff')
+              commands.gravity('center')
+              commands.extent(size)
+            # crop thumbnail, the smart way
+            elsif size.is_a?(String) and size =~ /c$/
+               size = size.gsub(/c/, '')
+              
+              # calculate sizes and aspect ratio
+              thumb_width, thumb_height = size.split("x")
+              thumb_width   = thumb_width.to_f
+              thumb_height  = thumb_height.to_f
+              
+              thumb_aspect = thumb_width.to_f / thumb_height.to_f
+              image_width, image_height = img[:width].to_f, img[:height].to_f
+              image_aspect = image_width / image_height
+              
+              # only crop if image is not smaller in both dimensions
+              unless image_width < thumb_width and image_height < thumb_height
+                command = calculate_offset(image_width,image_height,image_aspect,thumb_width,thumb_height,thumb_aspect)
+
+                # crop image
+                commands.extract(command)
+              end
+
+              # don not resize if image is not as height or width then thumbnail
+              if image_width < thumb_width or image_height < thumb_height                   
+                  commands.background('#ffffff')
+                  commands.gravity('center')
+                  commands.extent(size)
+              # resize image
+              else
+                commands.resize("#{size.to_s}")
+              end
+            # crop end
+            else
+              commands.resize(size.to_s)
+            end
+          end
+          temp_paths.unshift img
+        end
+
+        def calculate_offset(image_width,image_height,image_aspect,thumb_width,thumb_height,thumb_aspect)
+        # only crop if image is not smaller in both dimensions
+
+          # special cases, image smaller in one dimension then thumbsize
+          if image_width < thumb_width
+            offset = (image_height / 2) - (thumb_height / 2)
+            command = "#{image_width}x#{thumb_height}+0+#{offset}"
+          elsif image_height < thumb_height
+            offset = (image_width / 2) - (thumb_width / 2)
+            command = "#{thumb_width}x#{image_height}+#{offset}+0"
+
+          # normal thumbnail generation
+          # calculate height and offset y, width is fixed                 
+          elsif (image_aspect <= thumb_aspect or image_width < thumb_width) and image_height > thumb_height
+            height = image_width / thumb_aspect
+            offset = (image_height / 2) - (height / 2)
+            command = "#{image_width}x#{height}+0+#{offset}"
+          # calculate width and offset x, height is fixed
+          else
+            width = image_height * thumb_aspect
+            offset = (image_width / 2) - (width / 2)
+            command = "#{width}x#{image_height}+#{offset}+0"
+          end
+          # crop image
+          command
+        end
+
+
+      end
+    end
+  end
+end

data/lib/technoweenie/attachment_fu/processors/rmagick_processor.rb

@@ -0,0 +1,54 @@
+require 'RMagick'
+module Technoweenie # :nodoc:
+  module AttachmentFu # :nodoc:
+    module Processors
+      module RmagickProcessor
+        def self.included(base)
+          base.send :extend, ClassMethods
+          base.alias_method_chain :process_attachment, :processing
+        end
+
+        module ClassMethods
+          # Yields a block containing an RMagick Image for the given binary data.
+          def with_image(file, &block)
+            begin
+              binary_data = file.is_a?(Magick::Image) ? file : Magick::Image.read(file).first unless !Object.const_defined?(:Magick)
+            rescue
+              # Log the failure to load the image.  This should match ::Magick::ImageMagickError
+              # but that would cause acts_as_attachment to require rmagick.
+              logger.debug("Exception working with image: #{$!}")
+              binary_data = nil
+            end
+            block.call binary_data if block && binary_data
+          ensure
+            !binary_data.nil?
+          end
+        end
+
+      protected
+        def process_attachment_with_processing
+          return unless process_attachment_without_processing
+          with_image do |img|
+            resize_image_or_thumbnail! img
+            self.width  = img.columns if respond_to?(:width)
+            self.height = img.rows    if respond_to?(:height)
+            callback_with_args :after_resize, img
+          end if image?
+        end
+
+        # Performs the actual resizing operation for a thumbnail
+        def resize_image(img, size)
+          size = size.first if size.is_a?(Array) && size.length == 1 && !size.first.is_a?(Fixnum)
+          if size.is_a?(Fixnum) || (size.is_a?(Array) && size.first.is_a?(Fixnum))
+            size = [size, size] if size.is_a?(Fixnum)
+            img.thumbnail!(*size)
+          else
+            img.change_geometry(size.to_s) { |cols, rows, image| image.resize!(cols<1 ? 1 : cols, rows<1 ? 1 : rows) }
+          end
+          img.strip! unless attachment_options[:keep_profile]
+          temp_paths.unshift write_to_temp_file(img.to_blob)
+        end
+      end
+    end
+  end
+end

data/rails/init.rb

@@ -0,0 +1,16 @@
+require 'tempfile'
+
+Tempfile.class_eval do
+  # overwrite so tempfiles use the extension of the basename.  important for rmagick and image science
+  def make_tmpname(basename, n)
+    ext = nil
+    sprintf("%s%d-%d%s", basename.to_s.gsub(/\.\w+$/) { |s| ext = s; '' }, $$, n, ext)
+  end
+end
+
+require 'geometry'
+ActiveRecord::Base.send(:extend, Technoweenie::AttachmentFu::ActMethods)
+Technoweenie::AttachmentFu.tempfile_path = ATTACHMENT_FU_TEMPFILE_PATH if Object.const_defined?(:ATTACHMENT_FU_TEMPFILE_PATH)
+FileUtils.mkdir_p Technoweenie::AttachmentFu.tempfile_path
+
+$:.unshift(File.dirname(__FILE__) + '/../vendor')

data/test/backends/db_file_test.rb

@@ -0,0 +1,16 @@
+require File.expand_path(File.join(File.dirname(__FILE__), '..', 'test_helper'))
+
+class DbFileTest < Test::Unit::TestCase
+  include BaseAttachmentTests
+  attachment_model Attachment
+
+  def test_should_call_after_attachment_saved(klass = Attachment)
+    attachment_model.saves = 0
+    assert_created do
+      upload_file :filename => '/files/rails.png'
+    end
+    assert_equal 1, attachment_model.saves
+  end
+  
+  test_against_subclass :test_should_call_after_attachment_saved, Attachment
+end

data/test/backends/file_system_test.rb

@@ -0,0 +1,80 @@
+require File.expand_path(File.join(File.dirname(__FILE__), '..', 'test_helper'))
+
+class FileSystemTest < Test::Unit::TestCase
+  include BaseAttachmentTests
+  attachment_model FileAttachment
+
+  def test_filesystem_size_for_file_attachment(klass = FileAttachment)
+    attachment_model klass
+    assert_created 1 do
+      attachment = upload_file :filename => '/files/rails.png'
+      assert_equal attachment.size, File.open(attachment.full_filename).stat.size
+    end
+  end
+  
+  test_against_subclass :test_filesystem_size_for_file_attachment, FileAttachment
+
+  def test_should_not_overwrite_file_attachment(klass = FileAttachment)
+    attachment_model klass
+    assert_created 2 do
+      real = upload_file :filename => '/files/rails.png'
+      assert_valid real
+      assert !real.new_record?, real.errors.full_messages.join("\n")
+      assert !real.size.zero?
+      
+      fake = upload_file :filename => '/files/fake/rails.png'
+      assert_valid fake
+      assert !fake.size.zero?
+      
+      assert_not_equal File.open(real.full_filename).stat.size, File.open(fake.full_filename).stat.size
+    end
+  end
+  
+  test_against_subclass :test_should_not_overwrite_file_attachment, FileAttachment
+
+  def test_should_store_file_attachment_in_filesystem(klass = FileAttachment)
+    attachment_model klass
+    attachment = nil
+    assert_created do
+      attachment = upload_file :filename => '/files/rails.png'
+      assert_valid attachment
+      assert File.exists?(attachment.full_filename), "#{attachment.full_filename} does not exist"    
+    end
+    attachment
+  end
+  
+  test_against_subclass :test_should_store_file_attachment_in_filesystem, FileAttachment
+  
+  def test_should_delete_old_file_when_updating(klass = FileAttachment)
+    attachment_model klass
+    attachment   = upload_file :filename => '/files/rails.png'
+    old_filename = attachment.full_filename
+    assert_not_created do
+      use_temp_file 'files/rails.png' do |file|
+        attachment.filename        = 'rails2.png'
+        attachment.temp_paths.unshift File.join(fixture_path, file)
+        attachment.save!
+        assert  File.exists?(attachment.full_filename), "#{attachment.full_filename} does not exist"    
+        assert !File.exists?(old_filename),             "#{old_filename} still exists"
+      end
+    end
+  end
+  
+  test_against_subclass :test_should_delete_old_file_when_updating, FileAttachment
+  
+  def test_should_delete_old_file_when_renaming(klass = FileAttachment)
+    attachment_model klass
+    attachment   = upload_file :filename => '/files/rails.png'
+    old_filename = attachment.full_filename
+    assert_not_created do
+      attachment.filename        = 'rails2.png'
+      attachment.save
+      assert  File.exists?(attachment.full_filename), "#{attachment.full_filename} does not exist"    
+      assert !File.exists?(old_filename),             "#{old_filename} still exists"
+      assert !attachment.reload.size.zero?
+      assert_equal 'rails2.png', attachment.filename
+    end
+  end
+  
+  test_against_subclass :test_should_delete_old_file_when_renaming, FileAttachment
+end

data/test/backends/remote/s3_test.rb

@@ -0,0 +1,119 @@
+require File.expand_path(File.join(File.dirname(__FILE__), '..', '..', 'test_helper'))
+require 'net/http'
+
+class S3Test < Test::Unit::TestCase
+  def self.test_S3?
+    true unless ENV["TEST_S3"] == "false"
+  end
+  
+  if test_S3? && File.exist?(File.join(File.dirname(__FILE__), '../../amazon_s3.yml'))
+    include BaseAttachmentTests
+    attachment_model S3Attachment
+
+    def test_should_create_correct_bucket_name(klass = S3Attachment)
+      attachment_model klass
+      attachment = upload_file :filename => '/files/rails.png'
+      assert_equal attachment.s3_config[:bucket_name], attachment.bucket_name
+    end
+
+    test_against_subclass :test_should_create_correct_bucket_name, S3Attachment
+
+    def test_should_create_default_path_prefix(klass = S3Attachment)
+      attachment_model klass
+      attachment = upload_file :filename => '/files/rails.png'
+      assert_equal File.join(attachment_model.table_name, attachment.attachment_path_id), attachment.base_path
+    end
+
+    test_against_subclass :test_should_create_default_path_prefix, S3Attachment
+
+    def test_should_create_custom_path_prefix(klass = S3WithPathPrefixAttachment)
+      attachment_model klass
+      attachment = upload_file :filename => '/files/rails.png'
+      assert_equal File.join('some/custom/path/prefix', attachment.attachment_path_id), attachment.base_path
+    end
+
+    test_against_subclass :test_should_create_custom_path_prefix, S3WithPathPrefixAttachment
+
+    def test_should_create_valid_url(klass = S3Attachment)
+      attachment_model klass
+      attachment = upload_file :filename => '/files/rails.png'
+      assert_equal "#{s3_protocol}#{s3_hostname}#{s3_port_string}/#{attachment.bucket_name}/#{attachment.full_filename}", attachment.s3_url
+    end
+
+    test_against_subclass :test_should_create_valid_url, S3Attachment
+
+    def test_should_create_authenticated_url(klass = S3Attachment)
+      attachment_model klass
+      attachment = upload_file :filename => '/files/rails.png'
+      assert_match /^http.+AWSAccessKeyId.+Expires.+Signature.+/, attachment.authenticated_s3_url(:use_ssl => true)
+    end
+
+    test_against_subclass :test_should_create_authenticated_url, S3Attachment
+    
+    def test_should_create_authenticated_url_for_thumbnail(klass = S3Attachment)
+      attachment_model klass
+      attachment = upload_file :filename => '/files/rails.png'
+      ['large', :large].each do |thumbnail|
+        assert_match(
+          /^http.+rails_large\.png.+AWSAccessKeyId.+Expires.+Signature/, 
+          attachment.authenticated_s3_url(thumbnail), 
+          "authenticated_s3_url failed with #{thumbnail.class} parameter"
+        )
+      end
+    end
+
+    def test_should_save_attachment(klass = S3Attachment)
+      attachment_model klass
+      assert_created do
+        attachment = upload_file :filename => '/files/rails.png'
+        assert_valid attachment
+        assert attachment.image?
+        assert !attachment.size.zero?
+        assert_kind_of Net::HTTPOK, http_response_for(attachment.s3_url)
+      end
+    end
+
+    test_against_subclass :test_should_save_attachment, S3Attachment
+
+    def test_should_delete_attachment_from_s3_when_attachment_record_destroyed(klass = S3Attachment)
+      attachment_model klass
+      attachment = upload_file :filename => '/files/rails.png'
+
+      urls = [attachment.s3_url] + attachment.thumbnails.collect(&:s3_url)
+
+      urls.each {|url| assert_kind_of Net::HTTPOK, http_response_for(url) }
+      attachment.destroy
+      urls.each do |url|
+        begin
+          http_response_for(url)
+        rescue Net::HTTPForbidden, Net::HTTPNotFound
+          nil
+        end
+      end
+    end
+
+    test_against_subclass :test_should_delete_attachment_from_s3_when_attachment_record_destroyed, S3Attachment
+
+    protected
+      def http_response_for(url)
+        url = URI.parse(url)
+        Net::HTTP.start(url.host, url.port) {|http| http.request_head(url.path) }
+      end
+      
+      def s3_protocol
+        Technoweenie::AttachmentFu::Backends::S3Backend.protocol
+      end
+      
+      def s3_hostname
+        Technoweenie::AttachmentFu::Backends::S3Backend.hostname
+      end
+
+      def s3_port_string
+        Technoweenie::AttachmentFu::Backends::S3Backend.port_string
+      end
+  else
+    def test_flunk_s3
+      puts "s3 config file not loaded, tests not running"
+    end
+  end
+end