Grosse MàJ

This commit is contained in:
olivier
2008-11-25 22:11:16 +01:00
parent 53195fdfcd
commit 3e719157ea
2980 changed files with 343846 additions and 0 deletions

View File

@ -0,0 +1,19 @@
* April 2, 2007 *
* don't copy the #full_filename to the default #temp_paths array if it doesn't exist
* add default ID partitioning for attachments
* add #binmode call to Tempfile (note: ruby should be doing this!) [Eric Beland]
* Check for current type of :thumbnails option.
* allow customization of the S3 configuration file path with the :s3_config_path option.
* Don't try to remove thumbnails if there aren't any. Closes #3 [ben stiglitz]
* BC * (before changelog)
* add default #temp_paths entry [mattly]
* add MiniMagick support to attachment_fu [Isacc]
* update #destroy_file to clear out any empty directories too [carlivar]
* fix references to S3Backend module [Hunter Hillegas]
* make #current_data public with db_file and s3 backends [ebryn]
* oops, actually svn add the files for s3 backend. [Jeffrey Hardy]
* experimental s3 support, egad, no tests.... [Jeffrey Hardy]
* doh, fix a few bad references to ActsAsAttachment [sixty4bit]

View File

@ -0,0 +1,162 @@
attachment-fu
=====================
attachment_fu is a plugin by Rick Olson (aka technoweenie <http://techno-weenie.net>) and is the successor to acts_as_attachment. To get a basic run-through of its capabilities, check out Mike Clark's tutorial <http://clarkware.com/cgi/blosxom/2007/02/24#FileUploadFu>.
attachment_fu functionality
===========================
attachment_fu facilitates file uploads in Ruby on Rails. There are a few storage options for the actual file data, but the plugin always at a minimum stores metadata for each file in the database.
There are three storage options for files uploaded through attachment_fu:
File system
Database file
Amazon S3
Each method of storage many options associated with it that will be covered in the following section. Something to note, however, is that the Amazon S3 storage requires you to modify config/amazon_s3.yml and the Database file storage requires an extra table.
attachment_fu models
====================
For all three of these storage options a table of metadata is required. This table will contain information about the file (hence the 'meta') and its location. This table has no restrictions on naming, unlike the extra table required for database storage, which must have a table name of db_files (and by convention a model of DbFile).
In the model there are two methods made available by this plugins: has_attachment and validates_as_attachment.
has_attachment(options = {})
This method accepts the options in a hash:
:content_type # Allowed content types.
# Allows all by default. Use :image to allow all standard image types.
:min_size # Minimum size allowed.
# 1 byte is the default.
:max_size # Maximum size allowed.
# 1.megabyte is the default.
:size # Range of sizes allowed.
# (1..1.megabyte) is the default. This overrides the :min_size and :max_size options.
:resize_to # Used by RMagick to resize images.
# Pass either an array of width/height, or a geometry string.
:thumbnails # Specifies a set of thumbnails to generate.
# This accepts a hash of filename suffixes and RMagick resizing options.
# This option need only be included if you want thumbnailing.
:thumbnail_class # Set which model class to use for thumbnails.
# This current attachment class is used by default.
:path_prefix # path to store the uploaded files.
# Uses public/#{table_name} by default for the filesystem, and just #{table_name} for the S3 backend.
# Setting this sets the :storage to :file_system.
:storage # Specifies the storage system to use..
# Defaults to :db_file. Options are :file_system, :db_file, and :s3.
:processor # Sets the image processor to use for resizing of the attached image.
# Options include ImageScience, Rmagick, and MiniMagick. Default is whatever is installed.
Examples:
has_attachment :max_size => 1.kilobyte
has_attachment :size => 1.megabyte..2.megabytes
has_attachment :content_type => 'application/pdf'
has_attachment :content_type => ['application/pdf', 'application/msword', 'text/plain']
has_attachment :content_type => :image, :resize_to => [50,50]
has_attachment :content_type => ['application/pdf', :image], :resize_to => 'x50'
has_attachment :thumbnails => { :thumb => [50, 50], :geometry => 'x50' }
has_attachment :storage => :file_system, :path_prefix => 'public/files'
has_attachment :storage => :file_system, :path_prefix => 'public/files',
:content_type => :image, :resize_to => [50,50]
has_attachment :storage => :file_system, :path_prefix => 'public/files',
:thumbnails => { :thumb => [50, 50], :geometry => 'x50' }
has_attachment :storage => :s3
validates_as_attachment
This method prevents files outside of the valid range (:min_size to :max_size, or the :size range) from being saved. It does not however, halt the upload of such files. They will be uploaded into memory regardless of size before validation.
Example:
validates_as_attachment
attachment_fu migrations
========================
Fields for attachment_fu metadata tables...
in general:
size, :integer # file size in bytes
content_type, :string # mime type, ex: application/mp3
filename, :string # sanitized filename
that reference images:
height, :integer # in pixels
width, :integer # in pixels
that reference images that will be thumbnailed:
parent_id, :integer # id of parent image (on the same table, a self-referencing foreign-key).
# Only populated if the current object is a thumbnail.
thumbnail, :string # the 'type' of thumbnail this attachment record describes.
# Only populated if the current object is a thumbnail.
# Usage:
# [ In Model 'Avatar' ]
# has_attachment :content_type => :image,
# :storage => :file_system,
# :max_size => 500.kilobytes,
# :resize_to => '320x200>',
# :thumbnails => { :small => '10x10>',
# :thumb => '100x100>' }
# [ Elsewhere ]
# @user.avatar.thumbnails.first.thumbnail #=> 'small'
that reference files stored in the database (:db_file):
db_file_id, :integer # id of the file in the database (foreign key)
Field for attachment_fu db_files table:
data, :binary # binary file data, for use in database file storage
attachment_fu views
===================
There are two main views tasks that will be directly affected by attachment_fu: upload forms and displaying uploaded images.
There are two parts of the upload form that differ from typical usage.
1. Include ':multipart => true' in the html options of the form_for tag.
Example:
<% form_for(:attachment_metadata, :url => { :action => "create" }, :html => { :multipart => true }) do |form| %>
2. Use the file_field helper with :uploaded_data as the field name.
Example:
<%= form.file_field :uploaded_data %>
Displaying uploaded images is made easy by the public_filename method of the ActiveRecord attachment objects using file system and s3 storage.
public_filename(thumbnail = nil)
Returns the public path to the file. If a thumbnail prefix is specified it will return the public file path to the corresponding thumbnail.
Examples:
attachment_obj.public_filename #=> /attachments/2/file.jpg
attachment_obj.public_filename(:thumb) #=> /attachments/2/file_thumb.jpg
attachment_obj.public_filename(:small) #=> /attachments/2/file_small.jpg
When serving files from database storage, doing more than simply downloading the file is beyond the scope of this document.
attachment_fu controllers
=========================
There are two considerations to take into account when using attachment_fu in controllers.
The first is when the files have no publicly accessible path and need to be downloaded through an action.
Example:
def readme
send_file '/path/to/readme.txt', :type => 'plain/text', :disposition => 'inline'
end
See the possible values for send_file for reference.
The second is when saving the file when submitted from a form.
Example in view:
<%= form.file_field :attachable, :uploaded_data %>
Example in controller:
def create
@attachable_file = AttachmentMetadataModel.new(params[:attachable])
if @attachable_file.save
flash[:notice] = 'Attachment was successfully created.'
redirect_to attachable_url(@attachable_file)
else
render :action => :new
end
end

View File

@ -0,0 +1,22 @@
require 'rake'
require 'rake/testtask'
require 'rake/rdoctask'
desc 'Default: run unit tests.'
task :default => :test
desc 'Test the attachment_fu plugin.'
Rake::TestTask.new(:test) do |t|
t.libs << 'lib'
t.pattern = 'test/**/*_test.rb'
t.verbose = true
end
desc 'Generate documentation for the attachment_fu plugin.'
Rake::RDocTask.new(:rdoc) do |rdoc|
rdoc.rdoc_dir = 'rdoc'
rdoc.title = 'ActsAsAttachment'
rdoc.options << '--line-numbers --inline-source'
rdoc.rdoc_files.include('README')
rdoc.rdoc_files.include('lib/**/*.rb')
end

View File

@ -0,0 +1,14 @@
development:
bucket_name: appname_development
access_key_id:
secret_access_key:
test:
bucket_name: appname_test
access_key_id:
secret_access_key:
production:
bucket_name: appname
access_key_id:
secret_access_key:

View File

@ -0,0 +1,14 @@
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

View File

@ -0,0 +1,5 @@
require 'fileutils'
s3_config = File.dirname(__FILE__) + '/../../../config/amazon_s3.yml'
FileUtils.cp File.dirname(__FILE__) + '/amazon_s3.yml.tpl', s3_config unless File.exist?(s3_config)
puts IO.read(File.join(File.dirname(__FILE__), 'README'))

View File

@ -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

View File

@ -0,0 +1,405 @@
module Technoweenie # :nodoc:
module AttachmentFu # :nodoc:
@@default_processors = %w(ImageScience Rmagick MiniMagick)
@@tempfile_path = File.join(RAILS_ROOT, 'tmp', 'attachment_fu')
@@content_types = ['image/jpeg', 'image/pjpeg', 'image/gif', 'image/png', 'image/x-png', 'image/jpg']
mattr_reader :content_types, :tempfile_path, :default_processors
mattr_writer :tempfile_path
class ThumbnailError < StandardError; end
class AttachmentError < StandardError; end
module ActMethods
# Options:
# * <tt>:content_type</tt> - Allowed content types. Allows all by default. Use :image to allow all standard image types.
# * <tt>:min_size</tt> - Minimum size allowed. 1 byte is the default.
# * <tt>:max_size</tt> - Maximum size allowed. 1.megabyte is the default.
# * <tt>:size</tt> - Range of sizes allowed. (1..1.megabyte) is the default. This overrides the :min_size and :max_size options.
# * <tt>:resize_to</tt> - Used by RMagick to resize images. Pass either an array of width/height, or a geometry string.
# * <tt>:thumbnails</tt> - Specifies a set of thumbnails to generate. This accepts a hash of filename suffixes and RMagick resizing options.
# * <tt>:thumbnail_class</tt> - Set what class to use for thumbnails. This attachment class is used by default.
# * <tt>:path_prefix</tt> - path to store the uploaded files. Uses public/#{table_name} by default for the filesystem, and just #{table_name}
# for the S3 backend. Setting this sets the :storage to :file_system.
# * <tt>:storage</tt> - Use :file_system to specify the attachment data is stored with the file system. Defaults to :db_system.
#
# Examples:
# has_attachment :max_size => 1.kilobyte
# has_attachment :size => 1.megabyte..2.megabytes
# has_attachment :content_type => 'application/pdf'
# has_attachment :content_type => ['application/pdf', 'application/msword', 'text/plain']
# has_attachment :content_type => :image, :resize_to => [50,50]
# has_attachment :content_type => ['application/pdf', :image], :resize_to => 'x50'
# has_attachment :thumbnails => { :thumb => [50, 50], :geometry => 'x50' }
# has_attachment :storage => :file_system, :path_prefix => 'public/files'
# has_attachment :storage => :file_system, :path_prefix => 'public/files',
# :content_type => :image, :resize_to => [50,50]
# has_attachment :storage => :file_system, :path_prefix => 'public/files',
# :thumbnails => { :thumb => [50, 50], :geometry => 'x50' }
# has_attachment :storage => :s3
def has_attachment(options = {})
# this allows you to redefine the acts' options for each subclass, however
options[:min_size] ||= 1
options[:max_size] ||= 1.megabyte
options[:size] ||= (options[:min_size]..options[:max_size])
options[:thumbnails] ||= {}
options[:thumbnail_class] ||= self
options[:s3_access] ||= :public_read
options[:content_type] = [options[:content_type]].flatten.collect! { |t| t == :image ? Technoweenie::AttachmentFu.content_types : t }.flatten unless options[:content_type].nil?
unless options[:thumbnails].is_a?(Hash)
raise ArgumentError, ":thumbnails option should be a hash: e.g. :thumbnails => { :foo => '50x50' }"
end
# doing these shenanigans so that #attachment_options is available to processors and backends
class_inheritable_accessor :attachment_options
self.attachment_options = options
# only need to define these once on a class
unless included_modules.include?(InstanceMethods)
attr_accessor :thumbnail_resize_options
attachment_options[:storage] ||= (attachment_options[:file_system_path] || attachment_options[:path_prefix]) ? :file_system : :db_file
attachment_options[:path_prefix] ||= attachment_options[:file_system_path]
if attachment_options[:path_prefix].nil?
attachment_options[:path_prefix] = attachment_options[:storage] == :s3 ? table_name : File.join("public", table_name)
end
attachment_options[:path_prefix] = attachment_options[:path_prefix][1..-1] if options[:path_prefix].first == '/'
with_options :foreign_key => 'parent_id' do |m|
m.has_many :thumbnails, :class_name => attachment_options[:thumbnail_class].to_s
m.belongs_to :parent, :class_name => base_class.to_s
end
before_destroy :destroy_thumbnails
before_validation :set_size_from_temp_path
after_save :after_process_attachment
after_destroy :destroy_file
extend ClassMethods
include InstanceMethods
include Technoweenie::AttachmentFu::Backends.const_get("#{options[:storage].to_s.classify}Backend")
case attachment_options[:processor]
when :none
when nil
processors = Technoweenie::AttachmentFu.default_processors.dup
begin
include Technoweenie::AttachmentFu::Processors.const_get("#{processors.first}Processor") if processors.any?
rescue LoadError, MissingSourceFile
processors.shift
retry
end
else
begin
include Technoweenie::AttachmentFu::Processors.const_get("#{options[:processor].to_s.classify}Processor")
rescue LoadError, MissingSourceFile
puts "Problems loading #{options[:processor]}Processor: #{$!}"
end
end
after_validation :process_attachment
end
end
end
module ClassMethods
delegate :content_types, :to => Technoweenie::AttachmentFu
# Performs common validations for attachment models.
def validates_as_attachment
validates_presence_of :size, :content_type, :filename
validate :attachment_attributes_valid?
end
# Returns true or false if the given content type is recognized as an image.
def image?(content_type)
content_types.include?(content_type)
end
# Callback after an image has been resized.
#
# class Foo < ActiveRecord::Base
# acts_as_attachment
# after_resize do |record, img|
# record.aspect_ratio = img.columns.to_f / img.rows.to_f
# end
# end
def after_resize(&block)
write_inheritable_array(:after_resize, [block])
end
# Callback after an attachment has been saved either to the file system or the DB.
# Only called if the file has been changed, not necessarily if the record is updated.
#
# class Foo < ActiveRecord::Base
# acts_as_attachment
# after_attachment_saved do |record|
# ...
# end
# end
def after_attachment_saved(&block)
write_inheritable_array(:after_attachment_saved, [block])
end
# Callback before a thumbnail is saved. Use this to pass any necessary extra attributes that may be required.
#
# class Foo < ActiveRecord::Base
# acts_as_attachment
# before_thumbnail_saved do |record, thumbnail|
# ...
# end
# end
def before_thumbnail_saved(&block)
write_inheritable_array(:before_thumbnail_saved, [block])
end
# Get the thumbnail class, which is the current attachment class by default.
# Configure this with the :thumbnail_class option.
def thumbnail_class
attachment_options[:thumbnail_class] = attachment_options[:thumbnail_class].constantize unless attachment_options[:thumbnail_class].is_a?(Class)
attachment_options[:thumbnail_class]
end
# Copies the given file path to a new tempfile, returning the closed tempfile.
def copy_to_temp_file(file, temp_base_name)
returning Tempfile.new(temp_base_name, Technoweenie::AttachmentFu.tempfile_path) do |tmp|
tmp.close
FileUtils.cp file, tmp.path
end
end
# Writes the given data to a new tempfile, returning the closed tempfile.
def write_to_temp_file(data, temp_base_name)
returning Tempfile.new(temp_base_name, Technoweenie::AttachmentFu.tempfile_path) do |tmp|
tmp.binmode
tmp.write data
tmp.close
end
end
end
module InstanceMethods
# Checks whether the attachment's content type is an image content type
def image?
self.class.image?(content_type)
end
# Returns true/false if an attachment is thumbnailable. A thumbnailable attachment has an image content type and the parent_id attribute.
def thumbnailable?
image? && respond_to?(:parent_id) && parent_id.nil?
end
# Returns the class used to create new thumbnails for this attachment.
def thumbnail_class
self.class.thumbnail_class
end
# Gets the thumbnail name for a filename. 'foo.jpg' becomes 'foo_thumbnail.jpg'
def thumbnail_name_for(thumbnail = nil)
return filename if thumbnail.blank?
ext = nil
basename = filename.gsub /\.\w+$/ do |s|
ext = s; ''
end
"#{basename}_#{thumbnail}#{ext}"
end
# Creates or updates the thumbnail for the current attachment.
def create_or_update_thumbnail(temp_file, file_name_suffix, *size)
thumbnailable? || raise(ThumbnailError.new("Can't create a thumbnail if the content type is not an image or there is no parent_id column"))
returning find_or_initialize_thumbnail(file_name_suffix) do |thumb|
thumb.attributes = {
:content_type => content_type,
:filename => thumbnail_name_for(file_name_suffix),
:temp_path => temp_file,
:thumbnail_resize_options => size
}
callback_with_args :before_thumbnail_saved, thumb
thumb.save!
end
end
# Sets the content type.
def content_type=(new_type)
write_attribute :content_type, new_type.to_s.strip
end
# Sanitizes a filename.
def filename=(new_name)
write_attribute :filename, sanitize_filename(new_name)
end
# Returns the width/height in a suitable format for the image_tag helper: (100x100)
def image_size
[width.to_s, height.to_s] * 'x'
end
# Returns true if the attachment data will be written to the storage system on the next save
def save_attachment?
File.file?(temp_path.to_s)
end
# nil placeholder in case this field is used in a form.
def uploaded_data() nil; end
# This method handles the uploaded file object. If you set the field name to uploaded_data, you don't need
# any special code in your controller.
#
# <% form_for :attachment, :html => { :multipart => true } do |f| -%>
# <p><%= f.file_field :uploaded_data %></p>
# <p><%= submit_tag :Save %>
# <% end -%>
#
# @attachment = Attachment.create! params[:attachment]
#
# TODO: Allow it to work with Merb tempfiles too.
def uploaded_data=(file_data)
return nil if file_data.nil? || file_data.size == 0
self.content_type = file_data.content_type
self.filename = file_data.original_filename if respond_to?(:filename)
if file_data.is_a?(StringIO)
file_data.rewind
self.temp_data = file_data.read
else
self.temp_path = file_data.path
end
end
# Gets the latest temp path from the collection of temp paths. While working with an attachment,
# multiple Tempfile objects may be created for various processing purposes (resizing, for example).
# An array of all the tempfile objects is stored so that the Tempfile instance is held on to until
# it's not needed anymore. The collection is cleared after saving the attachment.
def temp_path
p = temp_paths.first
p.respond_to?(:path) ? p.path : p.to_s
end
# Gets an array of the currently used temp paths. Defaults to a copy of #full_filename.
def temp_paths
@temp_paths ||= (new_record? || !File.exist?(full_filename)) ? [] : [copy_to_temp_file(full_filename)]
end
# Adds a new temp_path to the array. This should take a string or a Tempfile. This class makes no
# attempt to remove the files, so Tempfiles should be used. Tempfiles remove themselves when they go out of scope.
# You can also use string paths for temporary files, such as those used for uploaded files in a web server.
def temp_path=(value)
temp_paths.unshift value
temp_path
end
# Gets the data from the latest temp file. This will read the file into memory.
def temp_data
save_attachment? ? File.read(temp_path) : nil
end
# Writes the given data to a Tempfile and adds it to the collection of temp files.
def temp_data=(data)
self.temp_path = write_to_temp_file data unless data.nil?
end
# Copies the given file to a randomly named Tempfile.
def copy_to_temp_file(file)
self.class.copy_to_temp_file file, random_tempfile_filename
end
# Writes the given file to a randomly named Tempfile.
def write_to_temp_file(data)
self.class.write_to_temp_file data, random_tempfile_filename
end
# Stub for creating a temp file from the attachment data. This should be defined in the backend module.
def create_temp_file() end
# Allows you to work with a processed representation (RMagick, ImageScience, etc) of the attachment in a block.
#
# @attachment.with_image do |img|
# self.data = img.thumbnail(100, 100).to_blob
# end
#
def with_image(&block)
self.class.with_image(temp_path, &block)
end
protected
# Generates a unique filename for a Tempfile.
def random_tempfile_filename
"#{rand Time.now.to_i}#{filename || 'attachment'}"
end
def sanitize_filename(filename)
returning filename.strip do |name|
# NOTE: File.basename doesn't work right with Windows paths on Unix
# get only the filename, not the whole path
name.gsub! /^.*(\\|\/)/, ''
# Finally, replace all non alphanumeric, underscore or periods with underscore
name.gsub! /[^\w\.\-]/, '_'
end
end
# before_validation callback.
def set_size_from_temp_path
self.size = File.size(temp_path) if save_attachment?
end
# validates the size and content_type attributes according to the current model's options
def attachment_attributes_valid?
[:size, :content_type].each do |attr_name|
enum = attachment_options[attr_name]
errors.add attr_name, ActiveRecord::Errors.default_error_messages[:inclusion] unless enum.nil? || enum.include?(send(attr_name))
end
end
# Initializes a new thumbnail with the given suffix.
def find_or_initialize_thumbnail(file_name_suffix)
respond_to?(:parent_id) ?
thumbnail_class.find_or_initialize_by_thumbnail_and_parent_id(file_name_suffix.to_s, id) :
thumbnail_class.find_or_initialize_by_thumbnail(file_name_suffix.to_s)
end
# Stub for a #process_attachment method in a processor
def process_attachment
@saved_attachment = save_attachment?
end
# Cleans up after processing. Thumbnails are created, the attachment is stored to the backend, and the temp_paths are cleared.
def after_process_attachment
if @saved_attachment
if respond_to?(:process_attachment_with_processing) && thumbnailable? && !attachment_options[:thumbnails].blank? && parent_id.nil?
temp_file = temp_path || create_temp_file
attachment_options[:thumbnails].each { |suffix, size| create_or_update_thumbnail(temp_file, suffix, *size) }
end
save_to_storage
@temp_paths.clear
@saved_attachment = nil
callback :after_attachment_saved
end
end
# Resizes the given processed img object with either the attachment resize options or the thumbnail resize options.
def resize_image_or_thumbnail!(img)
if (!respond_to?(:parent_id) || parent_id.nil?) && attachment_options[:resize_to] # parent image
resize_image(img, attachment_options[:resize_to])
elsif thumbnail_resize_options # thumbnail
resize_image(img, thumbnail_resize_options)
end
end
# Yanked from ActiveRecord::Callbacks, modified so I can pass args to the callbacks besides self.
# Only accept blocks, however
def callback_with_args(method, arg = self)
notify(method)
result = nil
callbacks_for(method).each do |callback|
result = callback.call(self, arg)
return false if result == false
end
return result
end
# Removes the thumbnails for the attachment, if it has any
def destroy_thumbnails
self.thumbnails.each { |thumbnail| thumbnail.destroy } if thumbnailable?
end
end
end
end

View File

@ -0,0 +1,39 @@
module Technoweenie # :nodoc:
module AttachmentFu # :nodoc:
module Backends
# Methods for DB backed attachments
module DbFileBackend
def self.included(base) #:nodoc:
Object.const_set(:DbFile, Class.new(ActiveRecord::Base)) unless Object.const_defined?(:DbFile)
base.belongs_to :db_file, :class_name => '::DbFile', :foreign_key => 'db_file_id'
end
# Creates a temp file with the current db data.
def create_temp_file
write_to_temp_file current_data
end
# Gets the current data from the database
def current_data
db_file.data
end
protected
# Destroys the file. Called in the after_destroy callback
def destroy_file
db_file.destroy if db_file
end
# Saves the data to the DbFile model
def save_to_storage
if save_attachment?
(db_file || build_db_file).data = temp_data
db_file.save!
self.class.update_all ['db_file_id = ?', self.db_file_id = db_file.id], ['id = ?', id]
end
true
end
end
end
end
end

View File

@ -0,0 +1,97 @@
require 'ftools'
module Technoweenie # :nodoc:
module AttachmentFu # :nodoc:
module Backends
# Methods for file system backed attachments
module FileSystemBackend
def self.included(base) #:nodoc:
base.before_update :rename_file
end
# Gets the full path to the filename in this format:
#
# # This assumes a model name like MyModel
# # public/#{table_name} is the default filesystem path
# RAILS_ROOT/public/my_models/5/blah.jpg
#
# Overwrite this method in your model to customize the filename.
# The optional thumbnail argument will output the thumbnail's filename.
def full_filename(thumbnail = nil)
file_system_path = (thumbnail ? thumbnail_class : self).attachment_options[:path_prefix].to_s
File.join(RAILS_ROOT, file_system_path, *partitioned_path(thumbnail_name_for(thumbnail)))
end
# Used as the base path that #public_filename strips off full_filename to create the public path
def base_path
@base_path ||= File.join(RAILS_ROOT, 'public')
end
# The attachment ID used in the full path of a file
def attachment_path_id
((respond_to?(:parent_id) && parent_id) || id).to_i
end
# overrwrite this to do your own app-specific partitioning.
# you can thank Jamis Buck for this: http://www.37signals.com/svn/archives2/id_partitioning.php
def partitioned_path(*args)
("%08d" % attachment_path_id).scan(/..../) + args
end
# Gets the public path to the file
# The optional thumbnail argument will output the thumbnail's filename.
def public_filename(thumbnail = nil)
full_filename(thumbnail).gsub %r(^#{Regexp.escape(base_path)}), ''
end
def filename=(value)
@old_filename = full_filename unless filename.nil? || @old_filename
write_attribute :filename, sanitize_filename(value)
end
# Creates a temp file from the currently saved file.
def create_temp_file
copy_to_temp_file full_filename
end
protected
# Destroys the file. Called in the after_destroy callback
def destroy_file
FileUtils.rm full_filename
# remove directory also if it is now empty
Dir.rmdir(File.dirname(full_filename)) if (Dir.entries(File.dirname(full_filename))-['.','..']).empty?
rescue
logger.info "Exception destroying #{full_filename.inspect}: [#{$!.class.name}] #{$1.to_s}"
logger.warn $!.backtrace.collect { |b| " > #{b}" }.join("\n")
end
# Renames the given file before saving
def rename_file
return unless @old_filename && @old_filename != full_filename
if save_attachment? && File.exists?(@old_filename)
FileUtils.rm @old_filename
elsif File.exists?(@old_filename)
FileUtils.mv @old_filename, full_filename
end
@old_filename = nil
true
end
# Saves the file to the file system
def save_to_storage
if save_attachment?
# TODO: This overwrites the file if it exists, maybe have an allow_overwrite option?
FileUtils.mkdir_p(File.dirname(full_filename))
File.cp(temp_path, full_filename)
File.chmod(attachment_options[:chmod] || 0644, full_filename)
end
@old_filename = nil
true
end
def current_data
File.file?(full_filename) ? File.read(full_filename) : nil
end
end
end
end
end

View File

@ -0,0 +1,309 @@
module Technoweenie # :nodoc:
module AttachmentFu # :nodoc:
module Backends
# = AWS::S3 Storage Backend
#
# Enables use of {Amazon's Simple Storage Service}[http://aws.amazon.com/s3] as a storage mechanism
#
# == Requirements
#
# Requires the {AWS::S3 Library}[http://amazon.rubyforge.org] for S3 by Marcel Molina Jr. installed either
# as a gem or a as a Rails plugin.
#
# == Configuration
#
# Configuration is done via <tt>RAILS_ROOT/config/amazon_s3.yml</tt> and is loaded according to the <tt>RAILS_ENV</tt>.
# The minimum connection options that you must specify are a bucket name, your access key id and your secret access key.
# If you don't already have your access keys, all you need to sign up for the S3 service is an account at Amazon.
# You can sign up for S3 and get access keys by visiting http://aws.amazon.com/s3.
#
# Example configuration (RAILS_ROOT/config/amazon_s3.yml)
#
# development:
# bucket_name: appname_development
# access_key_id: <your key>
# secret_access_key: <your key>
#
# test:
# bucket_name: appname_test
# access_key_id: <your key>
# secret_access_key: <your key>
#
# production:
# bucket_name: appname
# access_key_id: <your key>
# secret_access_key: <your key>
#
# You can change the location of the config path by passing a full path to the :s3_config_path option.
#
# has_attachment :storage => :s3, :s3_config_path => (RAILS_ROOT + '/config/s3.yml')
#
# === Required configuration parameters
#
# * <tt>:access_key_id</tt> - The access key id for your S3 account. Provided by Amazon.
# * <tt>:secret_access_key</tt> - The secret access key for your S3 account. Provided by Amazon.
# * <tt>:bucket_name</tt> - A unique bucket name (think of the bucket_name as being like a database name).
#
# If any of these required arguments is missing, a MissingAccessKey exception will be raised from AWS::S3.
#
# == About bucket names
#
# Bucket names have to be globaly unique across the S3 system. And you can only have up to 100 of them,
# so it's a good idea to think of a bucket as being like a database, hence the correspondance in this
# implementation to the development, test, and production environments.
#
# The number of objects you can store in a bucket is, for all intents and purposes, unlimited.
#
# === Optional configuration parameters
#
# * <tt>:server</tt> - The server to make requests to. Defaults to <tt>s3.amazonaws.com</tt>.
# * <tt>:port</tt> - The port to the requests should be made on. Defaults to 80 or 443 if <tt>:use_ssl</tt> is set.
# * <tt>:use_ssl</tt> - If set to true, <tt>:port</tt> will be implicitly set to 443, unless specified otherwise. Defaults to false.
#
# == Usage
#
# To specify S3 as the storage mechanism for a model, set the acts_as_attachment <tt>:storage</tt> option to <tt>:s3</tt>.
#
# class Photo < ActiveRecord::Base
# has_attachment :storage => :s3
# end
#
# === Customizing the path
#
# By default, files are prefixed using a pseudo hierarchy in the form of <tt>:table_name/:id</tt>, which results
# in S3 urls that look like: http(s)://:server/:bucket_name/:table_name/:id/:filename with :table_name
# representing the customizable portion of the path. You can customize this prefix using the <tt>:path_prefix</tt>
# option:
#
# class Photo < ActiveRecord::Base
# has_attachment :storage => :s3, :path_prefix => 'my/custom/path'
# end
#
# Which would result in URLs like <tt>http(s)://:server/:bucket_name/my/custom/path/:id/:filename.</tt>
#
# === Permissions
#
# By default, files are stored on S3 with public access permissions. You can customize this using
# the <tt>:s3_access</tt> option to <tt>has_attachment</tt>. Available values are
# <tt>:private</tt>, <tt>:public_read_write</tt>, and <tt>:authenticated_read</tt>.
#
# === Other options
#
# Of course, all the usual configuration options apply, such as content_type and thumbnails:
#
# class Photo < ActiveRecord::Base
# has_attachment :storage => :s3, :content_type => ['application/pdf', :image], :resize_to => 'x50'
# has_attachment :storage => :s3, :thumbnails => { :thumb => [50, 50], :geometry => 'x50' }
# end
#
# === Accessing S3 URLs
#
# You can get an object's URL using the s3_url accessor. For example, assuming that for your postcard app
# you had a bucket name like 'postcard_world_development', and an attachment model called Photo:
#
# @postcard.s3_url # => http(s)://s3.amazonaws.com/postcard_world_development/photos/1/mexico.jpg
#
# The resulting url is in the form: http(s)://:server/:bucket_name/:table_name/:id/:file.
# The optional thumbnail argument will output the thumbnail's filename (if any).
#
# Additionally, you can get an object's base path relative to the bucket root using
# <tt>base_path</tt>:
#
# @photo.file_base_path # => photos/1
#
# And the full path (including the filename) using <tt>full_filename</tt>:
#
# @photo.full_filename # => photos/
#
# Niether <tt>base_path</tt> or <tt>full_filename</tt> include the bucket name as part of the path.
# You can retrieve the bucket name using the <tt>bucket_name</tt> method.
module S3Backend
class RequiredLibraryNotFoundError < StandardError; end
class ConfigFileNotFoundError < StandardError; end
def self.included(base) #:nodoc:
mattr_reader :bucket_name, :s3_config
begin
require 'aws/s3'
include AWS::S3
rescue LoadError
raise RequiredLibraryNotFoundError.new('AWS::S3 could not be loaded')
end
begin
@@s3_config_path = base.attachment_options[:s3_config_path] || (RAILS_ROOT + '/config/amazon_s3.yml')
@@s3_config = YAML.load_file(@@s3_config_path)[ENV['RAILS_ENV']].symbolize_keys
#rescue
# raise ConfigFileNotFoundError.new('File %s not found' % @@s3_config_path)
end
@@bucket_name = s3_config[:bucket_name]
Base.establish_connection!(
:access_key_id => s3_config[:access_key_id],
:secret_access_key => s3_config[:secret_access_key],
:server => s3_config[:server],
:port => s3_config[:port],
:use_ssl => s3_config[:use_ssl]
)
# Bucket.create(@@bucket_name)
base.before_update :rename_file
end
def self.protocol
@protocol ||= s3_config[:use_ssl] ? 'https://' : 'http://'
end
def self.hostname
@hostname ||= s3_config[:server] || AWS::S3::DEFAULT_HOST
end
def self.port_string
@port_string ||= s3_config[:port] == (s3_config[:use_ssl] ? 443 : 80) ? '' : ":#{s3_config[:port]}"
end
module ClassMethods
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
end
# Overwrites the base filename writer in order to store the old filename
def filename=(value)
@old_filename = filename unless filename.nil? || @old_filename
write_attribute :filename, sanitize_filename(value)
end
# The attachment ID used in the full path of a file
def attachment_path_id
((respond_to?(:parent_id) && parent_id) || id).to_s
end
# The pseudo hierarchy containing the file relative to the bucket name
# Example: <tt>:table_name/:id</tt>
def base_path
File.join(attachment_options[:path_prefix], attachment_path_id)
end
# The full path to the file relative to the bucket name
# Example: <tt>:table_name/:id/:filename</tt>
def full_filename(thumbnail = nil)
File.join(base_path, thumbnail_name_for(thumbnail))
end
# All public objects are accessible via a GET request to the S3 servers. You can generate a
# url for an object using the s3_url method.
#
# @photo.s3_url
#
# The resulting url is in the form: <tt>http(s)://:server/:bucket_name/:table_name/:id/:file</tt> where
# the <tt>:server</tt> variable defaults to <tt>AWS::S3 URL::DEFAULT_HOST</tt> (s3.amazonaws.com) and can be
# set using the configuration parameters in <tt>RAILS_ROOT/config/amazon_s3.yml</tt>.
#
# The optional thumbnail argument will output the thumbnail's filename (if any).
def s3_url(thumbnail = nil)
File.join(s3_protocol + s3_hostname + s3_port_string, bucket_name, full_filename(thumbnail))
end
alias :public_filename :s3_url
# All private objects are accessible via an authenticated GET request to the S3 servers. You can generate an
# authenticated url for an object like this:
#
# @photo.authenticated_s3_url
#
# By default authenticated urls expire 5 minutes after they were generated.
#
# Expiration options can be specified either with an absolute time using the <tt>:expires</tt> option,
# or with a number of seconds relative to now with the <tt>:expires_in</tt> option:
#
# # Absolute expiration date (October 13th, 2025)
# @photo.authenticated_s3_url(:expires => Time.mktime(2025,10,13).to_i)
#
# # Expiration in five hours from now
# @photo.authenticated_s3_url(:expires_in => 5.hours)
#
# You can specify whether the url should go over SSL with the <tt>:use_ssl</tt> option.
# By default, the ssl settings for the current connection will be used:
#
# @photo.authenticated_s3_url(:use_ssl => true)
#
# Finally, the optional thumbnail argument will output the thumbnail's filename (if any):
#
# @photo.authenticated_s3_url('thumbnail', :expires_in => 5.hours, :use_ssl => true)
def authenticated_s3_url(*args)
thumbnail = args.first.is_a?(String) ? args.first : nil
options = args.last.is_a?(Hash) ? args.last : {}
S3Object.url_for(full_filename(thumbnail), bucket_name, options)
end
def create_temp_file
write_to_temp_file current_data
end
def current_data
S3Object.value full_filename, bucket_name
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
protected
# Called in the after_destroy callback
def destroy_file
S3Object.delete full_filename, bucket_name
end
def rename_file
return unless @old_filename && @old_filename != filename
old_full_filename = File.join(base_path, @old_filename)
S3Object.rename(
old_full_filename,
full_filename,
bucket_name,
:access => attachment_options[:s3_access]
)
@old_filename = nil
true
end
def save_to_storage
if save_attachment?
S3Object.store(
full_filename,
(temp_path ? File.open(temp_path) : temp_data),
bucket_name,
:content_type => content_type,
:access => attachment_options[:s3_access]
)
end
@old_filename = nil
true
end
end
end
end
end

View File

@ -0,0 +1,55 @@
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 RMagick 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
filename.sub! /gif$/, 'png'
self.temp_path = 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 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

View File

@ -0,0 +1,56 @@
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
if size.is_a?(Fixnum) || (size.is_a?(Array) && size.first.is_a?(Fixnum))
if size.is_a?(Fixnum)
size = [size, size]
img.resize(size.join('x'))
else
img.resize(size.join('x') + '!')
end
else
img.resize(size.to_s)
end
self.temp_path = img
end
end
end
end
end

View File

@ -0,0 +1,53 @@
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, rows) }
end
self.temp_path = write_to_temp_file(img.to_blob)
end
end
end
end
end

View File

@ -0,0 +1,6 @@
test:
bucket_name: afu
access_key_id: YOURACCESSKEY
secret_access_key: YOURSECRETACCESSKEY
server: 127.0.0.1
port: 3002

View File

@ -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

View File

@ -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_path = 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

View File

@ -0,0 +1,103 @@
require File.expand_path(File.join(File.dirname(__FILE__), '..', '..', 'test_helper'))
require 'net/http'
class S3Test < Test::Unit::TestCase
if 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_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

View File

@ -0,0 +1,57 @@
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_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.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.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_path = 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
end

View File

@ -0,0 +1,64 @@
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'], ImageAttachment.attachment_options[:content_type]
assert_equal ['pdf', 'image/jpeg', 'image/pjpeg', 'image/gif', 'image/png', 'image/x-png'], 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
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

View File

@ -0,0 +1,18 @@
sqlite:
:adapter: sqlite
:dbfile: attachment_fu_plugin.sqlite.db
sqlite3:
:adapter: sqlite3
:dbfile: attachment_fu_plugin.sqlite3.db
postgresql:
:adapter: postgresql
:username: postgres
:password: postgres
:database: attachment_fu_plugin_test
:min_messages: ERROR
mysql:
:adapter: mysql
:host: localhost
:username: rails
:password:
:database: attachment_fu_plugin_test

View File

@ -0,0 +1,57 @@
require File.expand_path(File.join(File.dirname(__FILE__), 'test_helper'))
class OrphanAttachmentTest < Test::Unit::TestCase
include BaseAttachmentTests
attachment_model OrphanAttachment
def test_should_create_image_from_uploaded_file
assert_created do
attachment = upload_file :filename => '/files/rails.png'
assert_valid attachment
assert !attachment.db_file.new_record? if attachment.respond_to?(:db_file)
assert attachment.image?
assert !attachment.size.zero?
end
end
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?
end
end
def test_should_create_image_from_uploaded_file_with_custom_content_type
assert_created do
attachment = upload_file :content_type => 'foo/bar', :filename => '/files/rails.png'
assert_valid attachment
assert !attachment.image?
assert !attachment.db_file.new_record? if attachment.respond_to?(:db_file)
assert !attachment.size.zero?
#assert_equal 1784, attachment.size
end
end
def test_should_create_thumbnail
attachment = upload_file :filename => '/files/rails.png'
assert_raise Technoweenie::AttachmentFu::ThumbnailError do
attachment.create_or_update_thumbnail(attachment.create_temp_file, 'thumb', 50, 50)
end
end
def test_should_create_thumbnail_with_geometry_string
attachment = upload_file :filename => '/files/rails.png'
assert_raise Technoweenie::AttachmentFu::ThumbnailError do
attachment.create_or_update_thumbnail(attachment.create_temp_file, 'thumb', 'x50')
end
end
end
class MinimalAttachmentTest < OrphanAttachmentTest
attachment_model MinimalAttachment
end

View File

@ -0,0 +1,127 @@
class Attachment < ActiveRecord::Base
@@saves = 0
cattr_accessor :saves
has_attachment :processor => :rmagick
validates_as_attachment
after_attachment_saved do |record|
self.saves += 1
end
end
class SmallAttachment < Attachment
has_attachment :max_size => 1.kilobyte
end
class BigAttachment < Attachment
has_attachment :size => 1.megabyte..2.megabytes
end
class PdfAttachment < Attachment
has_attachment :content_type => 'pdf'
end
class DocAttachment < Attachment
has_attachment :content_type => %w(pdf doc txt)
end
class ImageAttachment < Attachment
has_attachment :content_type => :image, :resize_to => [50,50]
end
class ImageOrPdfAttachment < Attachment
has_attachment :content_type => ['pdf', :image], :resize_to => 'x50'
end
class ImageWithThumbsAttachment < Attachment
has_attachment :thumbnails => { :thumb => [50, 50], :geometry => 'x50' }, :resize_to => [55,55]
after_resize do |record, img|
record.aspect_ratio = img.columns.to_f / img.rows.to_f
end
end
class FileAttachment < ActiveRecord::Base
has_attachment :path_prefix => 'vendor/plugins/attachment_fu/test/files', :processor => :rmagick
validates_as_attachment
end
class ImageFileAttachment < FileAttachment
has_attachment :path_prefix => 'vendor/plugins/attachment_fu/test/files',
:content_type => :image, :resize_to => [50,50]
end
class ImageWithThumbsFileAttachment < FileAttachment
has_attachment :path_prefix => 'vendor/plugins/attachment_fu/test/files',
:thumbnails => { :thumb => [50, 50], :geometry => 'x50' }, :resize_to => [55,55]
after_resize do |record, img|
record.aspect_ratio = img.columns.to_f / img.rows.to_f
end
end
class ImageWithThumbsClassFileAttachment < FileAttachment
# use file_system_path to test backwards compatibility
has_attachment :file_system_path => 'vendor/plugins/attachment_fu/test/files',
:thumbnails => { :thumb => [50, 50] }, :resize_to => [55,55],
:thumbnail_class => 'ImageThumbnail'
end
class ImageThumbnail < FileAttachment
has_attachment :path_prefix => 'vendor/plugins/attachment_fu/test/files/thumbnails'
end
# no parent
class OrphanAttachment < ActiveRecord::Base
has_attachment :processor => :rmagick
validates_as_attachment
end
# no filename, no size, no content_type
class MinimalAttachment < ActiveRecord::Base
has_attachment :path_prefix => 'vendor/plugins/attachment_fu/test/files', :processor => :rmagick
validates_as_attachment
def filename
"#{id}.file"
end
end
begin
class ImageScienceAttachment < ActiveRecord::Base
has_attachment :path_prefix => 'vendor/plugins/attachment_fu/test/files',
:processor => :image_science, :thumbnails => { :thumb => [50, 51], :geometry => '31>' }, :resize_to => 55
end
rescue MissingSourceFile
puts $!.message
puts "no ImageScience"
end
begin
class MiniMagickAttachment < ActiveRecord::Base
has_attachment :path_prefix => 'vendor/plugins/attachment_fu/test/files',
:processor => :mini_magick, :thumbnails => { :thumb => [50, 51], :geometry => '31>' }, :resize_to => 55
end
rescue MissingSourceFile
puts $!.message
puts "no Mini Magick"
end
begin
class MiniMagickAttachment < ActiveRecord::Base
has_attachment :path_prefix => 'vendor/plugins/attachment_fu/test/files',
:processor => :mini_magick, :thumbnails => { :thumb => [50, 51], :geometry => '31>' }, :resize_to => 55
end
rescue MissingSourceFile
end
begin
class S3Attachment < ActiveRecord::Base
has_attachment :storage => :s3, :processor => :rmagick, :s3_config_path => File.join(File.dirname(__FILE__), '../amazon_s3.yml')
validates_as_attachment
end
class S3WithPathPrefixAttachment < S3Attachment
has_attachment :storage => :s3, :path_prefix => 'some/custom/path/prefix', :processor => :rmagick
validates_as_attachment
end
rescue Technoweenie::AttachmentFu::Backends::S3Backend::ConfigFileNotFoundError
puts "S3 error: #{$!}"
end

Binary file not shown.

After

Width:  |  Height:  |  Size: 4.1 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.7 KiB

View File

@ -0,0 +1,101 @@
require 'test/unit'
require File.expand_path(File.join(File.dirname(__FILE__), '../lib/geometry')) unless Object.const_defined?(:Geometry)
class GeometryTest < Test::Unit::TestCase
def test_should_resize
assert_geometry 50, 64,
"50x50" => [39, 50],
"60x60" => [47, 60],
"100x100" => [78, 100]
end
def test_should_resize_no_width
assert_geometry 50, 64,
"x50" => [39, 50],
"x60" => [47, 60],
"x100" => [78, 100]
end
def test_should_resize_no_height
assert_geometry 50, 64,
"50" => [50, 64],
"60" => [60, 77],
"100" => [100, 128]
end
def test_should_resize_with_percent
assert_geometry 50, 64,
"50x50%" => [25, 32],
"60x60%" => [30, 38],
"120x112%" => [60, 72]
end
def test_should_resize_with_percent_and_no_width
assert_geometry 50, 64,
"x50%" => [50, 32],
"x60%" => [50, 38],
"x112%" => [50, 72]
end
def test_should_resize_with_percent_and_no_height
assert_geometry 50, 64,
"50%" => [25, 32],
"60%" => [30, 38],
"120%" => [60, 77]
end
def test_should_resize_with_less
assert_geometry 50, 64,
"50x50<" => [50, 64],
"60x60<" => [50, 64],
"100x100<" => [78, 100],
"100x112<" => [88, 112],
"40x70<" => [50, 64]
end
def test_should_resize_with_less_and_no_width
assert_geometry 50, 64,
"x50<" => [50, 64],
"x60<" => [50, 64],
"x100<" => [78, 100]
end
def test_should_resize_with_less_and_no_height
assert_geometry 50, 64,
"50<" => [50, 64],
"60<" => [60, 77],
"100<" => [100, 128]
end
def test_should_resize_with_greater
assert_geometry 50, 64,
"50x50>" => [39, 50],
"60x60>" => [47, 60],
"100x100>" => [50, 64],
"100x112>" => [50, 64],
"40x70>" => [40, 51]
end
def test_should_resize_with_greater_and_no_width
assert_geometry 50, 64,
"x40>" => [31, 40],
"x60>" => [47, 60],
"x100>" => [50, 64]
end
def test_should_resize_with_greater_and_no_height
assert_geometry 50, 64,
"40>" => [40, 51],
"60>" => [50, 64],
"100>" => [50, 64]
end
protected
def assert_geometry(width, height, values)
values.each do |geo, result|
# run twice to verify the Geometry string isn't modified after a run
geo = Geometry.from_s(geo)
2.times { assert_equal result, [width, height] / geo }
end
end
end

View File

@ -0,0 +1,31 @@
require File.expand_path(File.join(File.dirname(__FILE__), '..', 'test_helper'))
class ImageScienceTest < Test::Unit::TestCase
attachment_model ImageScienceAttachment
if Object.const_defined?(:ImageScience)
def test_should_resize_image
attachment = upload_file :filename => '/files/rails.png'
assert_valid attachment
assert attachment.image?
# test image science thumbnail
assert_equal 42, attachment.width
assert_equal 55, attachment.height
thumb = attachment.thumbnails.detect { |t| t.filename =~ /_thumb/ }
geo = attachment.thumbnails.detect { |t| t.filename =~ /_geometry/ }
# test exact resize dimensions
assert_equal 50, thumb.width
assert_equal 51, thumb.height
# test geometry string
assert_equal 31, geo.width
assert_equal 41, geo.height
end
else
def test_flunk
puts "ImageScience not loaded, tests not running"
end
end
end

View File

@ -0,0 +1,31 @@
require File.expand_path(File.join(File.dirname(__FILE__), '..', 'test_helper'))
class MiniMagickTest < Test::Unit::TestCase
attachment_model MiniMagickAttachment
if Object.const_defined?(:MiniMagick)
def test_should_resize_image
attachment = upload_file :filename => '/files/rails.png'
assert_valid attachment
assert attachment.image?
# test MiniMagick thumbnail
assert_equal 43, attachment.width
assert_equal 55, attachment.height
thumb = attachment.thumbnails.detect { |t| t.filename =~ /_thumb/ }
geo = attachment.thumbnails.detect { |t| t.filename =~ /_geometry/ }
# test exact resize dimensions
assert_equal 50, thumb.width
assert_equal 51, thumb.height
# test geometry string
assert_equal 31, geo.width
assert_equal 40, geo.height
end
else
def test_flunk
puts "MiniMagick not loaded, tests not running"
end
end
end

View File

@ -0,0 +1,241 @@
require File.expand_path(File.join(File.dirname(__FILE__), '..', 'test_helper'))
class RmagickTest < Test::Unit::TestCase
attachment_model Attachment
if Object.const_defined?(:Magick)
def test_should_create_image_from_uploaded_file
assert_created do
attachment = upload_file :filename => '/files/rails.png'
assert_valid attachment
assert !attachment.db_file.new_record? if attachment.respond_to?(:db_file)
assert attachment.image?
assert !attachment.size.zero?
#assert_equal 1784, attachment.size
assert_equal 50, attachment.width
assert_equal 64, attachment.height
assert_equal '50x64', attachment.image_size
end
end
def test_should_create_image_from_uploaded_file_with_custom_content_type
assert_created do
attachment = upload_file :content_type => 'foo/bar', :filename => '/files/rails.png'
assert_valid attachment
assert !attachment.image?
assert !attachment.db_file.new_record? if attachment.respond_to?(:db_file)
assert !attachment.size.zero?
#assert_equal 1784, attachment.size
assert_nil attachment.width
assert_nil attachment.height
assert_equal [], attachment.thumbnails
end
end
def test_should_create_thumbnail
attachment = upload_file :filename => '/files/rails.png'
assert_created do
basename, ext = attachment.filename.split '.'
thumbnail = attachment.create_or_update_thumbnail(attachment.create_temp_file, 'thumb', 50, 50)
assert_valid thumbnail
assert !thumbnail.size.zero?
#assert_in_delta 4673, thumbnail.size, 2
assert_equal 50, thumbnail.width
assert_equal 50, thumbnail.height
assert_equal [thumbnail.id], attachment.thumbnails.collect(&:id)
assert_equal attachment.id, thumbnail.parent_id if thumbnail.respond_to?(:parent_id)
assert_equal "#{basename}_thumb.#{ext}", thumbnail.filename
end
end
def test_should_create_thumbnail_with_geometry_string
attachment = upload_file :filename => '/files/rails.png'
assert_created do
basename, ext = attachment.filename.split '.'
thumbnail = attachment.create_or_update_thumbnail(attachment.create_temp_file, 'thumb', 'x50')
assert_valid thumbnail
assert !thumbnail.size.zero?
#assert_equal 3915, thumbnail.size
assert_equal 39, thumbnail.width
assert_equal 50, thumbnail.height
assert_equal [thumbnail], attachment.thumbnails
assert_equal attachment.id, thumbnail.parent_id if thumbnail.respond_to?(:parent_id)
assert_equal "#{basename}_thumb.#{ext}", thumbnail.filename
end
end
def test_should_resize_image(klass = ImageAttachment)
attachment_model klass
assert_equal [50, 50], attachment_model.attachment_options[:resize_to]
attachment = upload_file :filename => '/files/rails.png'
assert_valid attachment
assert !attachment.db_file.new_record? if attachment.respond_to?(:db_file)
assert attachment.image?
assert !attachment.size.zero?
#assert_in_delta 4673, attachment.size, 2
assert_equal 50, attachment.width
assert_equal 50, attachment.height
end
test_against_subclass :test_should_resize_image, ImageAttachment
def test_should_resize_image_with_geometry(klass = ImageOrPdfAttachment)
attachment_model klass
assert_equal 'x50', attachment_model.attachment_options[:resize_to]
attachment = upload_file :filename => '/files/rails.png'
assert_valid attachment
assert !attachment.db_file.new_record? if attachment.respond_to?(:db_file)
assert attachment.image?
assert !attachment.size.zero?
#assert_equal 3915, attachment.size
assert_equal 39, attachment.width
assert_equal 50, attachment.height
end
test_against_subclass :test_should_resize_image_with_geometry, ImageOrPdfAttachment
def test_should_give_correct_thumbnail_filenames(klass = ImageWithThumbsFileAttachment)
attachment_model klass
assert_created 3 do
attachment = upload_file :filename => '/files/rails.png'
thumb = attachment.thumbnails.detect { |t| t.filename =~ /_thumb/ }
geo = attachment.thumbnails.detect { |t| t.filename =~ /_geometry/ }
[attachment, thumb, geo].each { |record| assert_valid record }
assert_match /rails\.png$/, attachment.full_filename
assert_match /rails_geometry\.png$/, attachment.full_filename(:geometry)
assert_match /rails_thumb\.png$/, attachment.full_filename(:thumb)
end
end
test_against_subclass :test_should_give_correct_thumbnail_filenames, ImageWithThumbsFileAttachment
def test_should_automatically_create_thumbnails(klass = ImageWithThumbsAttachment)
attachment_model klass
assert_created 3 do
attachment = upload_file :filename => '/files/rails.png'
assert_valid attachment
assert !attachment.size.zero?
#assert_equal 1784, attachment.size
assert_equal 55, attachment.width
assert_equal 55, attachment.height
assert_equal 2, attachment.thumbnails.length
assert_equal 1.0, attachment.aspect_ratio
thumb = attachment.thumbnails.detect { |t| t.filename =~ /_thumb/ }
assert !thumb.new_record?, thumb.errors.full_messages.join("\n")
assert !thumb.size.zero?
#assert_in_delta 4673, thumb.size, 2
assert_equal 50, thumb.width
assert_equal 50, thumb.height
assert_equal 1.0, thumb.aspect_ratio
geo = attachment.thumbnails.detect { |t| t.filename =~ /_geometry/ }
assert !geo.new_record?, geo.errors.full_messages.join("\n")
assert !geo.size.zero?
#assert_equal 3915, geo.size
assert_equal 50, geo.width
assert_equal 50, geo.height
assert_equal 1.0, geo.aspect_ratio
end
end
test_against_subclass :test_should_automatically_create_thumbnails, ImageWithThumbsAttachment
# same as above method, but test it on a file model
test_against_class :test_should_automatically_create_thumbnails, ImageWithThumbsFileAttachment
test_against_subclass :test_should_automatically_create_thumbnails_on_class, ImageWithThumbsFileAttachment
def test_should_use_thumbnail_subclass(klass = ImageWithThumbsClassFileAttachment)
attachment_model klass
attachment = nil
assert_difference ImageThumbnail, :count do
attachment = upload_file :filename => '/files/rails.png'
assert_valid attachment
end
assert_kind_of ImageThumbnail, attachment.thumbnails.first
assert_equal attachment.id, attachment.thumbnails.first.parent.id
assert_kind_of FileAttachment, attachment.thumbnails.first.parent
assert_equal 'rails_thumb.png', attachment.thumbnails.first.filename
assert_equal attachment.thumbnails.first.full_filename, attachment.full_filename(attachment.thumbnails.first.thumbnail),
"#full_filename does not use thumbnail class' path."
assert_equal attachment.destroy attachment
end
test_against_subclass :test_should_use_thumbnail_subclass, ImageWithThumbsClassFileAttachment
def test_should_remove_old_thumbnail_files_when_updating(klass = ImageWithThumbsFileAttachment)
attachment_model klass
attachment = nil
assert_created 3 do
attachment = upload_file :filename => '/files/rails.png'
end
old_filenames = [attachment.full_filename] + attachment.thumbnails.collect(&:full_filename)
assert_not_created do
use_temp_file "files/rails.png" do |file|
attachment.filename = 'rails2.png'
attachment.temp_path = File.join(fixture_path, file)
attachment.save
new_filenames = [attachment.reload.full_filename] + attachment.thumbnails.collect { |t| t.reload.full_filename }
new_filenames.each { |f| assert File.exists?(f), "#{f} does not exist" }
old_filenames.each { |f| assert !File.exists?(f), "#{f} still exists" }
end
end
end
test_against_subclass :test_should_remove_old_thumbnail_files_when_updating, ImageWithThumbsFileAttachment
def test_should_delete_file_when_in_file_system_when_attachment_record_destroyed(klass = ImageWithThumbsFileAttachment)
attachment_model klass
attachment = upload_file :filename => '/files/rails.png'
filenames = [attachment.full_filename] + attachment.thumbnails.collect(&:full_filename)
filenames.each { |f| assert File.exists?(f), "#{f} never existed to delete on destroy" }
attachment.destroy
filenames.each { |f| assert !File.exists?(f), "#{f} still exists" }
end
test_against_subclass :test_should_delete_file_when_in_file_system_when_attachment_record_destroyed, ImageWithThumbsFileAttachment
def test_should_overwrite_old_thumbnail_records_when_updating(klass = ImageWithThumbsAttachment)
attachment_model klass
attachment = nil
assert_created 3 do
attachment = upload_file :filename => '/files/rails.png'
end
assert_not_created do # no new db_file records
use_temp_file "files/rails.png" do |file|
attachment.filename = 'rails2.png'
attachment.temp_path = File.join(fixture_path, file)
attachment.save!
end
end
end
test_against_subclass :test_should_overwrite_old_thumbnail_records_when_updating, ImageWithThumbsAttachment
def test_should_overwrite_old_thumbnail_records_when_renaming(klass = ImageWithThumbsAttachment)
attachment_model klass
attachment = nil
assert_created 3 do
attachment = upload_file :class => klass, :filename => '/files/rails.png'
end
assert_not_created do # no new db_file records
attachment.filename = 'rails2.png'
attachment.save
assert !attachment.reload.size.zero?
assert_equal 'rails2.png', attachment.filename
end
end
test_against_subclass :test_should_overwrite_old_thumbnail_records_when_renaming, ImageWithThumbsAttachment
else
def test_flunk
puts "RMagick not installed, no tests running"
end
end
end

View File

@ -0,0 +1,86 @@
ActiveRecord::Schema.define(:version => 0) do
create_table :attachments, :force => true do |t|
t.column :db_file_id, :integer
t.column :parent_id, :integer
t.column :thumbnail, :string
t.column :filename, :string, :limit => 255
t.column :content_type, :string, :limit => 255
t.column :size, :integer
t.column :width, :integer
t.column :height, :integer
t.column :aspect_ratio, :float
end
create_table :file_attachments, :force => true do |t|
t.column :parent_id, :integer
t.column :thumbnail, :string
t.column :filename, :string, :limit => 255
t.column :content_type, :string, :limit => 255
t.column :size, :integer
t.column :width, :integer
t.column :height, :integer
t.column :type, :string
t.column :aspect_ratio, :float
end
create_table :image_science_attachments, :force => true do |t|
t.column :parent_id, :integer
t.column :thumbnail, :string
t.column :filename, :string, :limit => 255
t.column :content_type, :string, :limit => 255
t.column :size, :integer
t.column :width, :integer
t.column :height, :integer
t.column :type, :string
end
create_table :mini_magick_attachments, :force => true do |t|
t.column :parent_id, :integer
t.column :thumbnail, :string
t.column :filename, :string, :limit => 255
t.column :content_type, :string, :limit => 255
t.column :size, :integer
t.column :width, :integer
t.column :height, :integer
t.column :type, :string
end
create_table :mini_magick_attachments, :force => true do |t|
t.column :parent_id, :integer
t.column :thumbnail, :string
t.column :filename, :string, :limit => 255
t.column :content_type, :string, :limit => 255
t.column :size, :integer
t.column :width, :integer
t.column :height, :integer
t.column :type, :string
end
create_table :orphan_attachments, :force => true do |t|
t.column :db_file_id, :integer
t.column :filename, :string, :limit => 255
t.column :content_type, :string, :limit => 255
t.column :size, :integer
end
create_table :minimal_attachments, :force => true do |t|
t.column :size, :integer
t.column :content_type, :string, :limit => 255
end
create_table :db_files, :force => true do |t|
t.column :data, :binary
end
create_table :s3_attachments, :force => true do |t|
t.column :parent_id, :integer
t.column :thumbnail, :string
t.column :filename, :string, :limit => 255
t.column :content_type, :string, :limit => 255
t.column :size, :integer
t.column :width, :integer
t.column :height, :integer
t.column :type, :string
t.column :aspect_ratio, :float
end
end

View File

@ -0,0 +1,142 @@
$:.unshift(File.dirname(__FILE__) + '/../lib')
ENV['RAILS_ENV'] = 'test'
require 'test/unit'
require File.expand_path(File.join(File.dirname(__FILE__), '../../../../config/environment.rb'))
require 'breakpoint'
require 'active_record/fixtures'
require 'action_controller/test_process'
config = YAML::load(IO.read(File.dirname(__FILE__) + '/database.yml'))
ActiveRecord::Base.logger = Logger.new(File.dirname(__FILE__) + "/debug.log")
db_adapter = ENV['DB']
# no db passed, try one of these fine config-free DBs before bombing.
db_adapter ||=
begin
require 'rubygems'
require 'sqlite'
'sqlite'
rescue MissingSourceFile
begin
require 'sqlite3'
'sqlite3'
rescue MissingSourceFile
end
end
if db_adapter.nil?
raise "No DB Adapter selected. Pass the DB= option to pick one, or install Sqlite or Sqlite3."
end
ActiveRecord::Base.establish_connection(config[db_adapter])
load(File.dirname(__FILE__) + "/schema.rb")
Test::Unit::TestCase.fixture_path = File.dirname(__FILE__) + "/fixtures"
$LOAD_PATH.unshift(Test::Unit::TestCase.fixture_path)
class Test::Unit::TestCase #:nodoc:
include ActionController::TestProcess
def create_fixtures(*table_names)
if block_given?
Fixtures.create_fixtures(Test::Unit::TestCase.fixture_path, table_names) { yield }
else
Fixtures.create_fixtures(Test::Unit::TestCase.fixture_path, table_names)
end
end
def setup
Attachment.saves = 0
DbFile.transaction { [Attachment, FileAttachment, OrphanAttachment, MinimalAttachment, DbFile].each { |klass| klass.delete_all } }
attachment_model self.class.attachment_model
end
def teardown
FileUtils.rm_rf File.join(File.dirname(__FILE__), 'files')
end
self.use_transactional_fixtures = true
self.use_instantiated_fixtures = false
def self.attachment_model(klass = nil)
@attachment_model = klass if klass
@attachment_model
end
def self.test_against_class(test_method, klass, subclass = false)
define_method("#{test_method}_on_#{:sub if subclass}class") do
klass = Class.new(klass) if subclass
attachment_model klass
send test_method, klass
end
end
def self.test_against_subclass(test_method, klass)
test_against_class test_method, klass, true
end
protected
def upload_file(options = {})
use_temp_file options[:filename] do |file|
att = attachment_model.create :uploaded_data => fixture_file_upload(file, options[:content_type] || 'image/png')
att.reload unless att.new_record?
return att
end
end
def use_temp_file(fixture_filename)
temp_path = File.join('/tmp', File.basename(fixture_filename))
FileUtils.mkdir_p File.join(fixture_path, 'tmp')
FileUtils.cp File.join(fixture_path, fixture_filename), File.join(fixture_path, temp_path)
yield temp_path
ensure
FileUtils.rm_rf File.join(fixture_path, 'tmp')
end
def assert_created(num = 1)
assert_difference attachment_model.base_class, :count, num do
if attachment_model.included_modules.include? DbFile
assert_difference DbFile, :count, num do
yield
end
else
yield
end
end
end
def assert_not_created
assert_created(0) { yield }
end
def should_reject_by_size_with(klass)
attachment_model klass
assert_not_created do
attachment = upload_file :filename => '/files/rails.png'
assert attachment.new_record?
assert attachment.errors.on(:size)
assert_nil attachment.db_file if attachment.respond_to?(:db_file)
end
end
def assert_difference(object, method = nil, difference = 1)
initial_value = object.send(method)
yield
assert_equal initial_value + difference, object.send(method)
end
def assert_no_difference(object, method, &block)
assert_difference object, method, 0, &block
end
def attachment_model(klass = nil)
@attachment_model = klass if klass
@attachment_model
end
end
require File.join(File.dirname(__FILE__), 'fixtures/attachment')
require File.join(File.dirname(__FILE__), 'base_attachment_tests')

View File

@ -0,0 +1,55 @@
require File.expand_path(File.join(File.dirname(__FILE__), 'test_helper'))
class ValidationTest < Test::Unit::TestCase
def test_should_invalidate_big_files
@attachment = SmallAttachment.new
assert !@attachment.valid?
assert @attachment.errors.on(:size)
@attachment.size = 2000
assert !@attachment.valid?
assert @attachment.errors.on(:size), @attachment.errors.full_messages.to_sentence
@attachment.size = 1000
assert !@attachment.valid?
assert_nil @attachment.errors.on(:size)
end
def test_should_invalidate_small_files
@attachment = BigAttachment.new
assert !@attachment.valid?
assert @attachment.errors.on(:size)
@attachment.size = 2000
assert !@attachment.valid?
assert @attachment.errors.on(:size), @attachment.errors.full_messages.to_sentence
@attachment.size = 1.megabyte
assert !@attachment.valid?
assert_nil @attachment.errors.on(:size)
end
def test_should_validate_content_type
@attachment = PdfAttachment.new
assert !@attachment.valid?
assert @attachment.errors.on(:content_type)
@attachment.content_type = 'foo'
assert !@attachment.valid?
assert @attachment.errors.on(:content_type)
@attachment.content_type = 'pdf'
assert !@attachment.valid?
assert_nil @attachment.errors.on(:content_type)
end
def test_should_require_filename
@attachment = Attachment.new
assert !@attachment.valid?
assert @attachment.errors.on(:filename)
@attachment.filename = 'foo'
assert !@attachment.valid?
assert_nil @attachment.errors.on(:filename)
end
end