twm_paperclip 2.3.6b
Sign up to get free protection for your applications and to get access to all the features.
- data/LICENSE +26 -0
- data/README.rdoc +182 -0
- data/Rakefile +80 -0
- data/generators/paperclip/USAGE +5 -0
- data/generators/paperclip/paperclip_generator.rb +27 -0
- data/generators/paperclip/templates/paperclip_migration.rb.erb +19 -0
- data/init.rb +1 -0
- data/lib/generators/paperclip/USAGE +8 -0
- data/lib/generators/paperclip/paperclip_generator.rb +31 -0
- data/lib/generators/paperclip/templates/paperclip_migration.rb.erb +19 -0
- data/lib/paperclip/attachment.rb +347 -0
- data/lib/paperclip/callback_compatability.rb +61 -0
- data/lib/paperclip/command_line.rb +80 -0
- data/lib/paperclip/geometry.rb +115 -0
- data/lib/paperclip/interpolations.rb +114 -0
- data/lib/paperclip/iostream.rb +45 -0
- data/lib/paperclip/matchers/have_attached_file_matcher.rb +57 -0
- data/lib/paperclip/matchers/validate_attachment_content_type_matcher.rb +75 -0
- data/lib/paperclip/matchers/validate_attachment_presence_matcher.rb +54 -0
- data/lib/paperclip/matchers/validate_attachment_size_matcher.rb +95 -0
- data/lib/paperclip/matchers.rb +33 -0
- data/lib/paperclip/processor.rb +58 -0
- data/lib/paperclip/railtie.rb +24 -0
- data/lib/paperclip/storage/filesystem.rb +73 -0
- data/lib/paperclip/storage/s3.rb +211 -0
- data/lib/paperclip/storage.rb +2 -0
- data/lib/paperclip/style.rb +90 -0
- data/lib/paperclip/thumbnail.rb +79 -0
- data/lib/paperclip/upfile.rb +55 -0
- data/lib/paperclip/version.rb +3 -0
- data/lib/paperclip.rb +370 -0
- data/lib/tasks/paperclip.rake +79 -0
- data/rails/init.rb +2 -0
- data/shoulda_macros/paperclip.rb +118 -0
- data/test/attachment_test.rb +804 -0
- data/test/command_line_test.rb +133 -0
- data/test/database.yml +4 -0
- data/test/fixtures/12k.png +0 -0
- data/test/fixtures/50x50.png +0 -0
- data/test/fixtures/5k.png +0 -0
- data/test/fixtures/bad.png +1 -0
- data/test/fixtures/s3.yml +8 -0
- data/test/fixtures/text.txt +0 -0
- data/test/fixtures/twopage.pdf +0 -0
- data/test/geometry_test.rb +177 -0
- data/test/helper.rb +146 -0
- data/test/integration_test.rb +482 -0
- data/test/interpolations_test.rb +127 -0
- data/test/iostream_test.rb +71 -0
- data/test/matchers/have_attached_file_matcher_test.rb +24 -0
- data/test/matchers/validate_attachment_content_type_matcher_test.rb +47 -0
- data/test/matchers/validate_attachment_presence_matcher_test.rb +26 -0
- data/test/matchers/validate_attachment_size_matcher_test.rb +51 -0
- data/test/paperclip_test.rb +254 -0
- data/test/processor_test.rb +10 -0
- data/test/storage_test.rb +363 -0
- data/test/style_test.rb +141 -0
- data/test/thumbnail_test.rb +227 -0
- data/test/upfile_test.rb +36 -0
- metadata +225 -0
data/lib/paperclip.rb
ADDED
@@ -0,0 +1,370 @@
|
|
1
|
+
# Paperclip allows file attachments that are stored in the filesystem. All graphical
|
2
|
+
# transformations are done using the Graphics/ImageMagick command line utilities and
|
3
|
+
# are stored in Tempfiles until the record is saved. Paperclip does not require a
|
4
|
+
# separate model for storing the attachment's information, instead adding a few simple
|
5
|
+
# columns to your table.
|
6
|
+
#
|
7
|
+
# Author:: Jon Yurek
|
8
|
+
# Copyright:: Copyright (c) 2008-2009 thoughtbot, inc.
|
9
|
+
# License:: MIT License (http://www.opensource.org/licenses/mit-license.php)
|
10
|
+
#
|
11
|
+
# Paperclip defines an attachment as any file, though it makes special considerations
|
12
|
+
# for image files. You can declare that a model has an attached file with the
|
13
|
+
# +has_attached_file+ method:
|
14
|
+
#
|
15
|
+
# class User < ActiveRecord::Base
|
16
|
+
# has_attached_file :avatar, :styles => { :thumb => "100x100" }
|
17
|
+
# end
|
18
|
+
#
|
19
|
+
# user = User.new
|
20
|
+
# user.avatar = params[:user][:avatar]
|
21
|
+
# user.avatar.url
|
22
|
+
# # => "/users/avatars/4/original_me.jpg"
|
23
|
+
# user.avatar.url(:thumb)
|
24
|
+
# # => "/users/avatars/4/thumb_me.jpg"
|
25
|
+
#
|
26
|
+
# See the +has_attached_file+ documentation for more details.
|
27
|
+
|
28
|
+
require 'erb'
|
29
|
+
require 'digest'
|
30
|
+
require 'tempfile'
|
31
|
+
require 'paperclip/version'
|
32
|
+
require 'paperclip/upfile'
|
33
|
+
require 'paperclip/iostream'
|
34
|
+
require 'paperclip/geometry'
|
35
|
+
require 'paperclip/processor'
|
36
|
+
require 'paperclip/thumbnail'
|
37
|
+
require 'paperclip/interpolations'
|
38
|
+
require 'paperclip/style'
|
39
|
+
require 'paperclip/attachment'
|
40
|
+
require 'paperclip/storage'
|
41
|
+
require 'paperclip/callback_compatability'
|
42
|
+
require 'paperclip/command_line'
|
43
|
+
require 'paperclip/railtie'
|
44
|
+
if defined?(Rails.root) && Rails.root
|
45
|
+
Dir.glob(File.join(File.expand_path(Rails.root), "lib", "paperclip_processors", "*.rb")).each do |processor|
|
46
|
+
require processor
|
47
|
+
end
|
48
|
+
end
|
49
|
+
|
50
|
+
# The base module that gets included in ActiveRecord::Base. See the
|
51
|
+
# documentation for Paperclip::ClassMethods for more useful information.
|
52
|
+
module Paperclip
|
53
|
+
|
54
|
+
class << self
|
55
|
+
# Provides configurability to Paperclip. There are a number of options available, such as:
|
56
|
+
# * whiny: Will raise an error if Paperclip cannot process thumbnails of
|
57
|
+
# an uploaded image. Defaults to true.
|
58
|
+
# * log: Logs progress to the Rails log. Uses ActiveRecord's logger, so honors
|
59
|
+
# log levels, etc. Defaults to true.
|
60
|
+
# * command_path: Defines the path at which to find the command line
|
61
|
+
# programs if they are not visible to Rails the system's search path. Defaults to
|
62
|
+
# nil, which uses the first executable found in the user's search path.
|
63
|
+
# * image_magick_path: Deprecated alias of command_path.
|
64
|
+
def options
|
65
|
+
@options ||= {
|
66
|
+
:whiny => true,
|
67
|
+
:image_magick_path => nil,
|
68
|
+
:command_path => nil,
|
69
|
+
:log => true,
|
70
|
+
:log_command => true,
|
71
|
+
:swallow_stderr => true
|
72
|
+
}
|
73
|
+
end
|
74
|
+
|
75
|
+
def configure
|
76
|
+
yield(self) if block_given?
|
77
|
+
end
|
78
|
+
|
79
|
+
def interpolates key, &block
|
80
|
+
Paperclip::Interpolations[key] = block
|
81
|
+
end
|
82
|
+
|
83
|
+
# The run method takes a command to execute and an array of parameters
|
84
|
+
# that get passed to it. The command is prefixed with the :command_path
|
85
|
+
# option from Paperclip.options. If you have many commands to run and
|
86
|
+
# they are in different paths, the suggested course of action is to
|
87
|
+
# symlink them so they are all in the same directory.
|
88
|
+
#
|
89
|
+
# If the command returns with a result code that is not one of the
|
90
|
+
# expected_outcodes, a PaperclipCommandLineError will be raised. Generally
|
91
|
+
# a code of 0 is expected, but a list of codes may be passed if necessary.
|
92
|
+
# These codes should be passed as a hash as the last argument, like so:
|
93
|
+
#
|
94
|
+
# Paperclip.run("echo", "something", :expected_outcodes => [0,1,2,3])
|
95
|
+
#
|
96
|
+
# This method can log the command being run when
|
97
|
+
# Paperclip.options[:log_command] is set to true (defaults to false). This
|
98
|
+
# will only log if logging in general is set to true as well.
|
99
|
+
def run cmd, *params
|
100
|
+
if options[:image_magick_path]
|
101
|
+
Paperclip.log("[DEPRECATION] :image_magick_path is deprecated and will be removed. Use :command_path instead")
|
102
|
+
end
|
103
|
+
CommandLine.path = options[:command_path] || options[:image_magick_path]
|
104
|
+
CommandLine.new(cmd, *params).run
|
105
|
+
end
|
106
|
+
|
107
|
+
def processor name #:nodoc:
|
108
|
+
name = name.to_s.camelize
|
109
|
+
processor = Paperclip.const_get(name)
|
110
|
+
unless processor.ancestors.include?(Paperclip::Processor)
|
111
|
+
raise PaperclipError.new("Processor #{name} was not found")
|
112
|
+
end
|
113
|
+
processor
|
114
|
+
end
|
115
|
+
|
116
|
+
# Log a paperclip-specific line. Uses ActiveRecord::Base.logger
|
117
|
+
# by default. Set Paperclip.options[:log] to false to turn off.
|
118
|
+
def log message
|
119
|
+
logger.info("[paperclip] #{message}") if logging?
|
120
|
+
end
|
121
|
+
|
122
|
+
def logger #:nodoc:
|
123
|
+
ActiveRecord::Base.logger
|
124
|
+
end
|
125
|
+
|
126
|
+
def logging? #:nodoc:
|
127
|
+
options[:log]
|
128
|
+
end
|
129
|
+
end
|
130
|
+
|
131
|
+
class PaperclipError < StandardError #:nodoc:
|
132
|
+
end
|
133
|
+
|
134
|
+
class PaperclipCommandLineError < PaperclipError #:nodoc:
|
135
|
+
attr_accessor :output
|
136
|
+
def initialize(msg = nil, output = nil)
|
137
|
+
super(msg)
|
138
|
+
@output = output
|
139
|
+
end
|
140
|
+
end
|
141
|
+
|
142
|
+
class StorageMethodNotFound < PaperclipError
|
143
|
+
end
|
144
|
+
|
145
|
+
class CommandNotFoundError < PaperclipError
|
146
|
+
end
|
147
|
+
|
148
|
+
class NotIdentifiedByImageMagickError < PaperclipError #:nodoc:
|
149
|
+
end
|
150
|
+
|
151
|
+
class InfiniteInterpolationError < PaperclipError #:nodoc:
|
152
|
+
end
|
153
|
+
|
154
|
+
module Glue
|
155
|
+
def self.included base #:nodoc:
|
156
|
+
base.extend ClassMethods
|
157
|
+
if base.respond_to?("set_callback")
|
158
|
+
base.send :include, Paperclip::CallbackCompatability::Rails3
|
159
|
+
else
|
160
|
+
base.send :include, Paperclip::CallbackCompatability::Rails21
|
161
|
+
end
|
162
|
+
end
|
163
|
+
end
|
164
|
+
|
165
|
+
module ClassMethods
|
166
|
+
# +has_attached_file+ gives the class it is called on an attribute that maps to a file. This
|
167
|
+
# is typically a file stored somewhere on the filesystem and has been uploaded by a user.
|
168
|
+
# The attribute returns a Paperclip::Attachment object which handles the management of
|
169
|
+
# that file. The intent is to make the attachment as much like a normal attribute. The
|
170
|
+
# thumbnails will be created when the new file is assigned, but they will *not* be saved
|
171
|
+
# until +save+ is called on the record. Likewise, if the attribute is set to +nil+ is
|
172
|
+
# called on it, the attachment will *not* be deleted until +save+ is called. See the
|
173
|
+
# Paperclip::Attachment documentation for more specifics. There are a number of options
|
174
|
+
# you can set to change the behavior of a Paperclip attachment:
|
175
|
+
# * +url+: The full URL of where the attachment is publically accessible. This can just
|
176
|
+
# as easily point to a directory served directly through Apache as it can to an action
|
177
|
+
# that can control permissions. You can specify the full domain and path, but usually
|
178
|
+
# just an absolute path is sufficient. The leading slash *must* be included manually for
|
179
|
+
# absolute paths. The default value is
|
180
|
+
# "/system/:attachment/:id/:style/:filename". See
|
181
|
+
# Paperclip::Attachment#interpolate for more information on variable interpolaton.
|
182
|
+
# :url => "/:class/:attachment/:id/:style_:filename"
|
183
|
+
# :url => "http://some.other.host/stuff/:class/:id_:extension"
|
184
|
+
# * +default_url+: The URL that will be returned if there is no attachment assigned.
|
185
|
+
# This field is interpolated just as the url is. The default value is
|
186
|
+
# "/:attachment/:style/missing.png"
|
187
|
+
# has_attached_file :avatar, :default_url => "/images/default_:style_avatar.png"
|
188
|
+
# User.new.avatar_url(:small) # => "/images/default_small_avatar.png"
|
189
|
+
# * +styles+: A hash of thumbnail styles and their geometries. You can find more about
|
190
|
+
# geometry strings at the ImageMagick website
|
191
|
+
# (http://www.imagemagick.org/script/command-line-options.php#resize). Paperclip
|
192
|
+
# also adds the "#" option (e.g. "50x50#"), which will resize the image to fit maximally
|
193
|
+
# inside the dimensions and then crop the rest off (weighted at the center). The
|
194
|
+
# default value is to generate no thumbnails.
|
195
|
+
# * +default_style+: The thumbnail style that will be used by default URLs.
|
196
|
+
# Defaults to +original+.
|
197
|
+
# has_attached_file :avatar, :styles => { :normal => "100x100#" },
|
198
|
+
# :default_style => :normal
|
199
|
+
# user.avatar.url # => "/avatars/23/normal_me.png"
|
200
|
+
# * +whiny+: Will raise an error if Paperclip cannot post_process an uploaded file due
|
201
|
+
# to a command line error. This will override the global setting for this attachment.
|
202
|
+
# Defaults to true. This option used to be called :whiny_thumbanils, but this is
|
203
|
+
# deprecated.
|
204
|
+
# * +convert_options+: When creating thumbnails, use this free-form options
|
205
|
+
# array to pass in various convert command options. Typical options are "-strip" to
|
206
|
+
# remove all Exif data from the image (save space for thumbnails and avatars) or
|
207
|
+
# "-depth 8" to specify the bit depth of the resulting conversion. See ImageMagick
|
208
|
+
# convert documentation for more options: (http://www.imagemagick.org/script/convert.php)
|
209
|
+
# Note that this option takes a hash of options, each of which correspond to the style
|
210
|
+
# of thumbnail being generated. You can also specify :all as a key, which will apply
|
211
|
+
# to all of the thumbnails being generated. If you specify options for the :original,
|
212
|
+
# it would be best if you did not specify destructive options, as the intent of keeping
|
213
|
+
# the original around is to regenerate all the thumbnails when requirements change.
|
214
|
+
# has_attached_file :avatar, :styles => { :large => "300x300", :negative => "100x100" }
|
215
|
+
# :convert_options => {
|
216
|
+
# :all => "-strip",
|
217
|
+
# :negative => "-negate"
|
218
|
+
# }
|
219
|
+
# NOTE: While not deprecated yet, it is not recommended to specify options this way.
|
220
|
+
# It is recommended that :convert_options option be included in the hash passed to each
|
221
|
+
# :styles for compatability with future versions.
|
222
|
+
# NOTE: Strings supplied to :convert_options are split on space in order to undergo
|
223
|
+
# shell quoting for safety. If your options require a space, please pre-split them
|
224
|
+
# and pass an array to :convert_options instead.
|
225
|
+
# * +storage+: Chooses the storage backend where the files will be stored. The current
|
226
|
+
# choices are :filesystem and :s3. The default is :filesystem. Make sure you read the
|
227
|
+
# documentation for Paperclip::Storage::Filesystem and Paperclip::Storage::S3
|
228
|
+
# for backend-specific options.
|
229
|
+
def has_attached_file name, options = {}
|
230
|
+
include InstanceMethods
|
231
|
+
|
232
|
+
write_inheritable_attribute(:attachment_definitions, {}) if attachment_definitions.nil?
|
233
|
+
attachment_definitions[name] = {:validations => []}.merge(options)
|
234
|
+
|
235
|
+
after_save :save_attached_files
|
236
|
+
before_destroy :destroy_attached_files
|
237
|
+
|
238
|
+
define_paperclip_callbacks :post_process, :"#{name}_post_process"
|
239
|
+
|
240
|
+
define_method name do |*args|
|
241
|
+
a = attachment_for(name)
|
242
|
+
(args.length > 0) ? a.to_s(args.first) : a
|
243
|
+
end
|
244
|
+
|
245
|
+
define_method "#{name}=" do |file|
|
246
|
+
attachment_for(name).assign(file)
|
247
|
+
end
|
248
|
+
|
249
|
+
define_method "#{name}?" do
|
250
|
+
attachment_for(name).file?
|
251
|
+
end
|
252
|
+
|
253
|
+
validates_each(name) do |record, attr, value|
|
254
|
+
attachment = record.attachment_for(name)
|
255
|
+
attachment.send(:flush_errors)
|
256
|
+
end
|
257
|
+
end
|
258
|
+
|
259
|
+
# Places ActiveRecord-style validations on the size of the file assigned. The
|
260
|
+
# possible options are:
|
261
|
+
# * +in+: a Range of bytes (i.e. +1..1.megabyte+),
|
262
|
+
# * +less_than+: equivalent to :in => 0..options[:less_than]
|
263
|
+
# * +greater_than+: equivalent to :in => options[:greater_than]..Infinity
|
264
|
+
# * +message+: error message to display, use :min and :max as replacements
|
265
|
+
# * +if+: A lambda or name of a method on the instance. Validation will only
|
266
|
+
# be run is this lambda or method returns true.
|
267
|
+
# * +unless+: Same as +if+ but validates if lambda or method returns false.
|
268
|
+
def validates_attachment_size name, options = {}
|
269
|
+
min = options[:greater_than] || (options[:in] && options[:in].first) || 0
|
270
|
+
max = options[:less_than] || (options[:in] && options[:in].last) || (1.0/0)
|
271
|
+
range = (min..max)
|
272
|
+
message = options[:message] || "file size must be between :min and :max bytes."
|
273
|
+
message = message.gsub(/:min/, min.to_s).gsub(/:max/, max.to_s)
|
274
|
+
|
275
|
+
validates_inclusion_of :"#{name}_file_size",
|
276
|
+
:in => range,
|
277
|
+
:message => message,
|
278
|
+
:if => options[:if],
|
279
|
+
:unless => options[:unless],
|
280
|
+
:allow_nil => true
|
281
|
+
end
|
282
|
+
|
283
|
+
# Adds errors if thumbnail creation fails. The same as specifying :whiny_thumbnails => true.
|
284
|
+
def validates_attachment_thumbnails name, options = {}
|
285
|
+
warn('[DEPRECATION] validates_attachment_thumbnail is deprecated. ' +
|
286
|
+
'This validation is on by default and will be removed from future versions. ' +
|
287
|
+
'If you wish to turn it off, supply :whiny => false in your definition.')
|
288
|
+
attachment_definitions[name][:whiny_thumbnails] = true
|
289
|
+
end
|
290
|
+
|
291
|
+
# Places ActiveRecord-style validations on the presence of a file.
|
292
|
+
# Options:
|
293
|
+
# * +if+: A lambda or name of a method on the instance. Validation will only
|
294
|
+
# be run is this lambda or method returns true.
|
295
|
+
# * +unless+: Same as +if+ but validates if lambda or method returns false.
|
296
|
+
def validates_attachment_presence name, options = {}
|
297
|
+
message = options[:message] || "must be set."
|
298
|
+
validates_presence_of :"#{name}_file_name",
|
299
|
+
:message => message,
|
300
|
+
:if => options[:if],
|
301
|
+
:unless => options[:unless]
|
302
|
+
end
|
303
|
+
|
304
|
+
# Places ActiveRecord-style validations on the content type of the file
|
305
|
+
# assigned. The possible options are:
|
306
|
+
# * +content_type+: Allowed content types. Can be a single content type
|
307
|
+
# or an array. Each type can be a String or a Regexp. It should be
|
308
|
+
# noted that Internet Explorer upload files with content_types that you
|
309
|
+
# may not expect. For example, JPEG images are given image/pjpeg and
|
310
|
+
# PNGs are image/x-png, so keep that in mind when determining how you
|
311
|
+
# match. Allows all by default.
|
312
|
+
# * +message+: The message to display when the uploaded file has an invalid
|
313
|
+
# content type.
|
314
|
+
# * +if+: A lambda or name of a method on the instance. Validation will only
|
315
|
+
# be run is this lambda or method returns true.
|
316
|
+
# * +unless+: Same as +if+ but validates if lambda or method returns false.
|
317
|
+
# NOTE: If you do not specify an [attachment]_content_type field on your
|
318
|
+
# model, content_type validation will work _ONLY upon assignment_ and
|
319
|
+
# re-validation after the instance has been reloaded will always succeed.
|
320
|
+
def validates_attachment_content_type name, options = {}
|
321
|
+
validation_options = options.dup
|
322
|
+
allowed_types = [validation_options[:content_type]].flatten
|
323
|
+
validates_each(:"#{name}_content_type", validation_options) do |record, attr, value|
|
324
|
+
if !allowed_types.any?{|t| t === value } && !(value.nil? || value.blank?)
|
325
|
+
if record.errors.method(:add).arity == -2
|
326
|
+
message = options[:message] || "is not one of #{allowed_types.join(", ")}"
|
327
|
+
record.errors.add(:"#{name}_content_type", message)
|
328
|
+
else
|
329
|
+
record.errors.add(:"#{name}_content_type", :inclusion, :default => options[:message], :value => value)
|
330
|
+
end
|
331
|
+
end
|
332
|
+
end
|
333
|
+
end
|
334
|
+
|
335
|
+
# Returns the attachment definitions defined by each call to
|
336
|
+
# has_attached_file.
|
337
|
+
def attachment_definitions
|
338
|
+
read_inheritable_attribute(:attachment_definitions)
|
339
|
+
end
|
340
|
+
end
|
341
|
+
|
342
|
+
module InstanceMethods #:nodoc:
|
343
|
+
def attachment_for name
|
344
|
+
@_paperclip_attachments ||= {}
|
345
|
+
@_paperclip_attachments[name] ||= Attachment.new(name, self, self.class.attachment_definitions[name])
|
346
|
+
end
|
347
|
+
|
348
|
+
def each_attachment
|
349
|
+
self.class.attachment_definitions.each do |name, definition|
|
350
|
+
yield(name, attachment_for(name))
|
351
|
+
end
|
352
|
+
end
|
353
|
+
|
354
|
+
def save_attached_files
|
355
|
+
Paperclip.log("Saving attachments.")
|
356
|
+
each_attachment do |name, attachment|
|
357
|
+
attachment.send(:save)
|
358
|
+
end
|
359
|
+
end
|
360
|
+
|
361
|
+
def destroy_attached_files
|
362
|
+
Paperclip.log("Deleting attachments.")
|
363
|
+
each_attachment do |name, attachment|
|
364
|
+
attachment.send(:queue_existing_for_delete)
|
365
|
+
attachment.send(:flush_deletes)
|
366
|
+
end
|
367
|
+
end
|
368
|
+
end
|
369
|
+
|
370
|
+
end
|
@@ -0,0 +1,79 @@
|
|
1
|
+
def obtain_class
|
2
|
+
class_name = ENV['CLASS'] || ENV['class']
|
3
|
+
raise "Must specify CLASS" unless class_name
|
4
|
+
@klass = Object.const_get(class_name)
|
5
|
+
end
|
6
|
+
|
7
|
+
def obtain_attachments
|
8
|
+
name = ENV['ATTACHMENT'] || ENV['attachment']
|
9
|
+
raise "Class #{@klass.name} has no attachments specified" unless @klass.respond_to?(:attachment_definitions)
|
10
|
+
if !name.blank? && @klass.attachment_definitions.keys.include?(name)
|
11
|
+
[ name ]
|
12
|
+
else
|
13
|
+
@klass.attachment_definitions.keys
|
14
|
+
end
|
15
|
+
end
|
16
|
+
|
17
|
+
def for_all_attachments
|
18
|
+
klass = obtain_class
|
19
|
+
names = obtain_attachments
|
20
|
+
ids = klass.connection.select_values(klass.send(:construct_finder_sql, :select => 'id'))
|
21
|
+
|
22
|
+
ids.each do |id|
|
23
|
+
instance = klass.find(id)
|
24
|
+
names.each do |name|
|
25
|
+
result = if instance.send("#{ name }?")
|
26
|
+
yield(instance, name)
|
27
|
+
else
|
28
|
+
true
|
29
|
+
end
|
30
|
+
print result ? "." : "x"; $stdout.flush
|
31
|
+
end
|
32
|
+
end
|
33
|
+
puts " Done."
|
34
|
+
end
|
35
|
+
|
36
|
+
namespace :paperclip do
|
37
|
+
desc "Refreshes both metadata and thumbnails."
|
38
|
+
task :refresh => ["paperclip:refresh:metadata", "paperclip:refresh:thumbnails"]
|
39
|
+
|
40
|
+
namespace :refresh do
|
41
|
+
desc "Regenerates thumbnails for a given CLASS (and optional ATTACHMENT)."
|
42
|
+
task :thumbnails => :environment do
|
43
|
+
errors = []
|
44
|
+
for_all_attachments do |instance, name|
|
45
|
+
result = instance.send(name).reprocess!
|
46
|
+
errors << [instance.id, instance.errors] unless instance.errors.blank?
|
47
|
+
result
|
48
|
+
end
|
49
|
+
errors.each{|e| puts "#{e.first}: #{e.last.full_messages.inspect}" }
|
50
|
+
end
|
51
|
+
|
52
|
+
desc "Regenerates content_type/size metadata for a given CLASS (and optional ATTACHMENT)."
|
53
|
+
task :metadata => :environment do
|
54
|
+
for_all_attachments do |instance, name|
|
55
|
+
if file = instance.send(name).to_file
|
56
|
+
instance.send("#{name}_file_name=", instance.send("#{name}_file_name").strip)
|
57
|
+
instance.send("#{name}_content_type=", file.content_type.strip)
|
58
|
+
instance.send("#{name}_file_size=", file.size) if instance.respond_to?("#{name}_file_size")
|
59
|
+
instance.save(false)
|
60
|
+
else
|
61
|
+
true
|
62
|
+
end
|
63
|
+
end
|
64
|
+
end
|
65
|
+
end
|
66
|
+
|
67
|
+
desc "Cleans out invalid attachments. Useful after you've added new validations."
|
68
|
+
task :clean => :environment do
|
69
|
+
for_all_attachments do |instance, name|
|
70
|
+
instance.send(name).send(:validate)
|
71
|
+
if instance.send(name).valid?
|
72
|
+
true
|
73
|
+
else
|
74
|
+
instance.send("#{name}=", nil)
|
75
|
+
instance.save
|
76
|
+
end
|
77
|
+
end
|
78
|
+
end
|
79
|
+
end
|
data/rails/init.rb
ADDED
@@ -0,0 +1,118 @@
|
|
1
|
+
require 'paperclip/matchers'
|
2
|
+
|
3
|
+
module Paperclip
|
4
|
+
# =Paperclip Shoulda Macros
|
5
|
+
#
|
6
|
+
# These macros are intended for use with shoulda, and will be included into
|
7
|
+
# your tests automatically. All of the macros use the standard shoulda
|
8
|
+
# assumption that the name of the test is based on the name of the model
|
9
|
+
# you're testing (that is, UserTest is the test for the User model), and
|
10
|
+
# will load that class for testing purposes.
|
11
|
+
module Shoulda
|
12
|
+
include Matchers
|
13
|
+
# This will test whether you have defined your attachment correctly by
|
14
|
+
# checking for all the required fields exist after the definition of the
|
15
|
+
# attachment.
|
16
|
+
def should_have_attached_file name
|
17
|
+
klass = self.name.gsub(/Test$/, '').constantize
|
18
|
+
matcher = have_attached_file name
|
19
|
+
should matcher.description do
|
20
|
+
assert_accepts(matcher, klass)
|
21
|
+
end
|
22
|
+
end
|
23
|
+
|
24
|
+
# Tests for validations on the presence of the attachment.
|
25
|
+
def should_validate_attachment_presence name
|
26
|
+
klass = self.name.gsub(/Test$/, '').constantize
|
27
|
+
matcher = validate_attachment_presence name
|
28
|
+
should matcher.description do
|
29
|
+
assert_accepts(matcher, klass)
|
30
|
+
end
|
31
|
+
end
|
32
|
+
|
33
|
+
# Tests that you have content_type validations specified. There are two
|
34
|
+
# options, :valid and :invalid. Both accept an array of strings. The
|
35
|
+
# strings should be a list of content types which will pass and fail
|
36
|
+
# validation, respectively.
|
37
|
+
def should_validate_attachment_content_type name, options = {}
|
38
|
+
klass = self.name.gsub(/Test$/, '').constantize
|
39
|
+
valid = [options[:valid]].flatten
|
40
|
+
invalid = [options[:invalid]].flatten
|
41
|
+
matcher = validate_attachment_content_type(name).allowing(valid).rejecting(invalid)
|
42
|
+
should matcher.description do
|
43
|
+
assert_accepts(matcher, klass)
|
44
|
+
end
|
45
|
+
end
|
46
|
+
|
47
|
+
# Tests to ensure that you have file size validations turned on. You
|
48
|
+
# can pass the same options to this that you can to
|
49
|
+
# validate_attachment_file_size - :less_than, :greater_than, and :in.
|
50
|
+
# :less_than checks that a file is less than a certain size, :greater_than
|
51
|
+
# checks that a file is more than a certain size, and :in takes a Range or
|
52
|
+
# Array which specifies the lower and upper limits of the file size.
|
53
|
+
def should_validate_attachment_size name, options = {}
|
54
|
+
klass = self.name.gsub(/Test$/, '').constantize
|
55
|
+
min = options[:greater_than] || (options[:in] && options[:in].first) || 0
|
56
|
+
max = options[:less_than] || (options[:in] && options[:in].last) || (1.0/0)
|
57
|
+
range = (min..max)
|
58
|
+
matcher = validate_attachment_size(name).in(range)
|
59
|
+
should matcher.description do
|
60
|
+
assert_accepts(matcher, klass)
|
61
|
+
end
|
62
|
+
end
|
63
|
+
|
64
|
+
# Stubs the HTTP PUT for an attachment using S3 storage.
|
65
|
+
#
|
66
|
+
# @example
|
67
|
+
# stub_paperclip_s3('user', 'avatar', 'png')
|
68
|
+
def stub_paperclip_s3(model, attachment, extension)
|
69
|
+
definition = model.gsub(" ", "_").classify.constantize.
|
70
|
+
attachment_definitions[attachment.to_sym]
|
71
|
+
|
72
|
+
path = "http://s3.amazonaws.com/:id/#{definition[:path]}"
|
73
|
+
path.gsub!(/:([^\/\.]+)/) do |match|
|
74
|
+
"([^\/\.]+)"
|
75
|
+
end
|
76
|
+
|
77
|
+
begin
|
78
|
+
FakeWeb.register_uri(:put, Regexp.new(path), :body => "OK")
|
79
|
+
rescue NameError
|
80
|
+
raise NameError, "the stub_paperclip_s3 shoulda macro requires the fakeweb gem."
|
81
|
+
end
|
82
|
+
end
|
83
|
+
|
84
|
+
# Stub S3 and return a file for attachment. Best with Factory Girl.
|
85
|
+
# Uses a strict directory convention:
|
86
|
+
#
|
87
|
+
# features/support/paperclip
|
88
|
+
#
|
89
|
+
# This method is used by the Paperclip-provided Cucumber step:
|
90
|
+
#
|
91
|
+
# When I attach a "demo_tape" "mp3" file to a "band" on S3
|
92
|
+
#
|
93
|
+
# @example
|
94
|
+
# Factory.define :band_with_demo_tape, :parent => :band do |band|
|
95
|
+
# band.demo_tape { band.paperclip_fixture("band", "demo_tape", "png") }
|
96
|
+
# end
|
97
|
+
def paperclip_fixture(model, attachment, extension)
|
98
|
+
stub_paperclip_s3(model, attachment, extension)
|
99
|
+
base_path = File.join(File.dirname(__FILE__), "..", "..",
|
100
|
+
"features", "support", "paperclip")
|
101
|
+
File.new(File.join(base_path, model, "#{attachment}.#{extension}"))
|
102
|
+
end
|
103
|
+
end
|
104
|
+
end
|
105
|
+
|
106
|
+
if defined?(ActionController::Integration::Session)
|
107
|
+
class ActionController::Integration::Session #:nodoc:
|
108
|
+
include Paperclip::Shoulda
|
109
|
+
end
|
110
|
+
end
|
111
|
+
|
112
|
+
class Factory
|
113
|
+
include Paperclip::Shoulda #:nodoc:
|
114
|
+
end
|
115
|
+
|
116
|
+
class Test::Unit::TestCase #:nodoc:
|
117
|
+
extend Paperclip::Shoulda
|
118
|
+
end
|