ioquatix-attachment_fu 1.0.1

data/lib/geometry.rb

@@ -0,0 +1,93 @@
+# This Geometry class was yanked from RMagick.  However, it lets ImageMagick handle the actual change_geometry.
+# Use #new_dimensions_for to get new dimensons
+# Used so I can use spiffy RMagick geometry strings with ImageScience
+class Geometry
+  # ! and @ are removed until support for them is added
+  FLAGS = ['', '%', '<', '>']#, '!', '@']
+  RFLAGS = { '%' => :percent,
+             '!' => :aspect,
+             '<' => :>,
+             '>' => :<,
+             '@' => :area }
+
+  attr_accessor :width, :height, :x, :y, :flag
+
+  def initialize(width=nil, height=nil, x=nil, y=nil, flag=nil)
+    # Support floating-point width and height arguments so Geometry
+    # objects can be used to specify Image#density= arguments.
+    raise ArgumentError, "width must be >= 0: #{width}"   if width < 0
+    raise ArgumentError, "height must be >= 0: #{height}" if height < 0
+    @width  = width.to_f
+    @height = height.to_f
+    @x      = x.to_i
+    @y      = y.to_i
+    @flag   = flag
+  end
+
+  # Construct an object from a geometry string
+  RE = /\A(\d*)(?:x(\d+)?)?([-+]\d+)?([-+]\d+)?([%!<>@]?)\Z/
+
+  def self.from_s(str)
+    raise(ArgumentError, "no geometry string specified") unless str
+  
+    if m = RE.match(str)
+      new(m[1].to_i, m[2].to_i, m[3].to_i, m[4].to_i, RFLAGS[m[5]])
+    else
+      raise ArgumentError, "invalid geometry format"
+    end
+  end
+
+  # Convert object to a geometry string
+  def to_s
+    str = ''
+    str << "%g" % @width if @width > 0
+    str << 'x' if (@width > 0 || @height > 0)
+    str << "%g" % @height if @height > 0
+    str << "%+d%+d" % [@x, @y] if (@x != 0 || @y != 0)
+    str << FLAGS[@flag.to_i]
+  end
+  
+  # attempts to get new dimensions for the current geometry string given these old dimensions.
+  # This doesn't implement the aspect flag (!) or the area flag (@).  PDI
+  def new_dimensions_for(orig_width, orig_height)
+    new_width  = orig_width
+    new_height = orig_height
+
+    case @flag
+      when :percent
+        scale_x = @width.zero?  ? 100 : @width
+        scale_y = @height.zero? ? @width : @height
+        new_width    = scale_x.to_f * (orig_width.to_f  / 100.0)
+        new_height   = scale_y.to_f * (orig_height.to_f / 100.0)
+      when :<, :>, nil
+        scale_factor =
+          if new_width.zero? || new_height.zero?
+            1.0
+          else
+            if @width.nonzero? && @height.nonzero?
+              [@width.to_f / new_width.to_f, @height.to_f / new_height.to_f].min
+            else
+              @width.nonzero? ? (@width.to_f / new_width.to_f) : (@height.to_f / new_height.to_f)
+            end
+          end
+        new_width  = scale_factor * new_width.to_f
+        new_height = scale_factor * new_height.to_f
+        new_width  = orig_width  if @flag && orig_width.send(@flag,  new_width)
+        new_height = orig_height if @flag && orig_height.send(@flag, new_height)
+    end
+
+    [new_width, new_height].collect! { |v| v.round }
+  end
+end
+
+class Array
+  # allows you to get new dimensions for the current array of dimensions with a given geometry string
+  #
+  #   [50, 64] / '40>' # => [40, 51]
+  def /(geometry)
+    raise ArgumentError, "Only works with a [width, height] pair" if size != 2
+    raise ArgumentError, "Must pass a valid geometry string or object" unless geometry.is_a?(String) || geometry.is_a?(Geometry)
+    geometry = Geometry.from_s(geometry) if geometry.is_a?(String)
+    geometry.new_dimensions_for first, last
+  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

data/test/base_attachment_tests.rb

@@ -0,0 +1,77 @@
+module BaseAttachmentTests
+  def test_should_create_file_from_uploaded_file
+    assert_created do
+      attachment = upload_file :filename => '/files/foo.txt'
+      assert_valid attachment
+      assert !attachment.db_file.new_record? if attachment.respond_to?(:db_file)
+      assert  attachment.image?
+      assert !attachment.size.zero?
+      #assert_equal 3, attachment.size
+      assert_nil      attachment.width
+      assert_nil      attachment.height
+    end
+  end
+  
+  def test_should_create_file_from_merb_temp_file
+    assert_created do
+      attachment = upload_merb_file :filename => '/files/foo.txt'
+      assert_valid attachment
+      assert !attachment.db_file.new_record? if attachment.respond_to?(:db_file)
+      assert  attachment.image?
+      assert !attachment.size.zero?
+      #assert_equal 3, attachment.size
+      assert_nil      attachment.width
+      assert_nil      attachment.height
+    end
+  end
+  
+  def test_reassign_attribute_data
+    assert_created 1 do
+      attachment = upload_file :filename => '/files/rails.png'
+      assert_valid attachment
+      assert attachment.size > 0, "no data was set"
+      
+      attachment.set_temp_data 'wtf'
+      assert attachment.save_attachment?
+      attachment.save!
+      
+      assert_equal 'wtf', attachment_model.find(attachment.id).send(:current_data)
+    end
+  end
+  
+  def test_no_reassign_attribute_data_on_nil
+    assert_created 1 do
+      attachment = upload_file :filename => '/files/rails.png'
+      assert_valid attachment
+      assert attachment.size > 0, "no data was set"
+      
+      attachment.set_temp_data nil
+      assert !attachment.save_attachment?
+    end
+  end
+  
+  def test_should_overwrite_old_contents_when_updating
+    attachment   = upload_file :filename => '/files/rails.png'
+    assert_not_created do # no new db_file records
+      use_temp_file 'files/rails.png' do |file|
+        attachment.filename = 'rails2.png'
+        attachment.temp_paths.unshift File.join(fixture_path, file)
+        attachment.save!
+      end
+    end
+  end
+  
+  def test_should_save_without_updating_file
+    attachment = upload_file :filename => '/files/foo.txt'
+    assert_valid attachment
+    assert !attachment.save_attachment?
+    assert_nothing_raised { attachment.save! }
+  end
+  
+  def test_should_handle_nil_file_upload
+    attachment = attachment_model.create :uploaded_data => ''
+    assert_raise ActiveRecord::RecordInvalid do
+      attachment.save!
+    end
+  end
+end

data/test/basic_test.rb

@@ -0,0 +1,70 @@
+require File.expand_path(File.join(File.dirname(__FILE__), 'test_helper'))
+
+class BasicTest < Test::Unit::TestCase
+  def test_should_set_default_min_size
+    assert_equal 1, Attachment.attachment_options[:min_size]
+  end
+  
+  def test_should_set_default_max_size
+    assert_equal 1.megabyte, Attachment.attachment_options[:max_size]
+  end
+  
+  def test_should_set_default_size
+    assert_equal (1..1.megabyte), Attachment.attachment_options[:size]
+  end
+  
+  def test_should_set_default_thumbnails_option
+    assert_equal Hash.new, Attachment.attachment_options[:thumbnails]
+  end
+
+  def test_should_set_default_thumbnail_class
+    assert_equal Attachment, Attachment.attachment_options[:thumbnail_class]
+  end
+  
+  def test_should_normalize_content_types_to_array
+    assert_equal %w(pdf), PdfAttachment.attachment_options[:content_type]
+    assert_equal %w(pdf doc txt), DocAttachment.attachment_options[:content_type]
+    assert_equal ['image/jpeg', 'image/pjpeg', 'image/gif', 'image/png', 'image/x-png', 'image/jpg'], ImageAttachment.attachment_options[:content_type]
+    assert_equal ['pdf', 'image/jpeg', 'image/pjpeg', 'image/gif', 'image/png', 'image/x-png', 'image/jpg'], ImageOrPdfAttachment.attachment_options[:content_type]
+  end
+  
+  def test_should_sanitize_content_type
+    @attachment = Attachment.new :content_type => ' foo '
+    assert_equal 'foo', @attachment.content_type
+  end
+  
+  def test_should_sanitize_filenames
+    @attachment = Attachment.new :filename => 'blah/foo.bar'
+    assert_equal 'foo.bar',    @attachment.filename
+
+    @attachment.filename = 'blah\\foo.bar'
+    assert_equal 'foo.bar',    @attachment.filename
+
+    @attachment.filename = 'f o!O-.bar'
+    assert_equal 'f_o_O-.bar', @attachment.filename
+    
+    @attachment.filename = 'sheeps_says_bææ'
+    assert_equal 'sheeps_says_b__', @attachment.filename
+
+    @attachment.filename = nil
+    assert_nil @attachment.filename
+  end
+  
+  def test_should_convert_thumbnail_name
+    @attachment = FileAttachment.new :filename => 'foo.bar'
+    assert_equal 'foo.bar',           @attachment.thumbnail_name_for(nil)
+    assert_equal 'foo.bar',           @attachment.thumbnail_name_for('')
+    assert_equal 'foo_blah.bar',      @attachment.thumbnail_name_for(:blah)
+    assert_equal 'foo_blah.blah.bar', @attachment.thumbnail_name_for('blah.blah')
+    
+    @attachment.filename = 'foo.bar.baz'
+    assert_equal 'foo.bar_blah.baz', @attachment.thumbnail_name_for(:blah)
+  end
+  
+  def test_should_require_valid_thumbnails_option
+    klass = Class.new(ActiveRecord::Base)
+    assert_raise ArgumentError do
+      klass.has_attachment :thumbnails => []
+    end
+  end
+end