paperclip-cloudfiles 2.3.1.1.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (49) hide show
  1. data/LICENSE +26 -0
  2. data/README.rdoc +176 -0
  3. data/Rakefile +105 -0
  4. data/generators/paperclip/USAGE +5 -0
  5. data/generators/paperclip/paperclip_generator.rb +27 -0
  6. data/generators/paperclip/templates/paperclip_migration.rb.erb +19 -0
  7. data/init.rb +1 -0
  8. data/lib/paperclip.rb +356 -0
  9. data/lib/paperclip/attachment.rb +414 -0
  10. data/lib/paperclip/callback_compatability.rb +33 -0
  11. data/lib/paperclip/geometry.rb +115 -0
  12. data/lib/paperclip/interpolations.rb +108 -0
  13. data/lib/paperclip/iostream.rb +59 -0
  14. data/lib/paperclip/matchers.rb +4 -0
  15. data/lib/paperclip/matchers/have_attached_file_matcher.rb +49 -0
  16. data/lib/paperclip/matchers/validate_attachment_content_type_matcher.rb +65 -0
  17. data/lib/paperclip/matchers/validate_attachment_presence_matcher.rb +48 -0
  18. data/lib/paperclip/matchers/validate_attachment_size_matcher.rb +85 -0
  19. data/lib/paperclip/processor.rb +49 -0
  20. data/lib/paperclip/storage.rb +369 -0
  21. data/lib/paperclip/thumbnail.rb +73 -0
  22. data/lib/paperclip/upfile.rb +49 -0
  23. data/shoulda_macros/paperclip.rb +117 -0
  24. data/tasks/paperclip_tasks.rake +79 -0
  25. data/test/attachment_test.rb +780 -0
  26. data/test/cloudfiles.yml +13 -0
  27. data/test/database.yml +4 -0
  28. data/test/fixtures/12k.png +0 -0
  29. data/test/fixtures/50x50.png +0 -0
  30. data/test/fixtures/5k.png +0 -0
  31. data/test/fixtures/bad.png +1 -0
  32. data/test/fixtures/s3.yml +8 -0
  33. data/test/fixtures/text.txt +0 -0
  34. data/test/fixtures/twopage.pdf +0 -0
  35. data/test/geometry_test.rb +177 -0
  36. data/test/helper.rb +111 -0
  37. data/test/integration_test.rb +483 -0
  38. data/test/interpolations_test.rb +124 -0
  39. data/test/iostream_test.rb +78 -0
  40. data/test/matchers/have_attached_file_matcher_test.rb +21 -0
  41. data/test/matchers/validate_attachment_content_type_matcher_test.rb +31 -0
  42. data/test/matchers/validate_attachment_presence_matcher_test.rb +23 -0
  43. data/test/matchers/validate_attachment_size_matcher_test.rb +51 -0
  44. data/test/paperclip_test.rb +319 -0
  45. data/test/processor_test.rb +10 -0
  46. data/test/storage_test.rb +549 -0
  47. data/test/thumbnail_test.rb +227 -0
  48. data/test/upfile_test.rb +28 -0
  49. metadata +175 -0
@@ -0,0 +1,414 @@
1
+ # encoding: utf-8
2
+ module Paperclip
3
+ # The Attachment class manages the files for a given attachment. It saves
4
+ # when the model saves, deletes when the model is destroyed, and processes
5
+ # the file upon assignment.
6
+ class Attachment
7
+
8
+ def self.default_options
9
+ @default_options ||= {
10
+ :url => "/system/:attachment/:id/:style/:filename",
11
+ :path => ":rails_root/public:url",
12
+ :styles => {},
13
+ :default_url => "/:attachment/:style/missing.png",
14
+ :default_style => :original,
15
+ :validations => [],
16
+ :storage => :filesystem,
17
+ :whiny => Paperclip.options[:whiny] || Paperclip.options[:whiny_thumbnails]
18
+ }
19
+ end
20
+
21
+ attr_reader :name, :instance, :styles, :default_style, :convert_options, :queued_for_write, :options
22
+
23
+ # Creates an Attachment object. +name+ is the name of the attachment,
24
+ # +instance+ is the ActiveRecord object instance it's attached to, and
25
+ # +options+ is the same as the hash passed to +has_attached_file+.
26
+ def initialize name, instance, options = {}
27
+ @name = name
28
+ @instance = instance
29
+
30
+ options = self.class.default_options.merge(options)
31
+
32
+ @url = options[:url]
33
+ @url = @url.call(self) if @url.is_a?(Proc)
34
+ @path = options[:path]
35
+ @path = @path.call(self) if @path.is_a?(Proc)
36
+ @styles = options[:styles]
37
+ @styles = @styles.call(self) if @styles.is_a?(Proc)
38
+ @default_url = options[:default_url]
39
+ @validations = options[:validations]
40
+ @default_style = options[:default_style]
41
+ @storage = options[:storage]
42
+ @whiny = options[:whiny_thumbnails] || options[:whiny]
43
+ @convert_options = options[:convert_options] || {}
44
+ @processors = options[:processors] || [:thumbnail]
45
+ @options = options
46
+ @queued_for_delete = []
47
+ @queued_for_write = {}
48
+ @errors = {}
49
+ @validation_errors = nil
50
+ @dirty = false
51
+
52
+ normalize_style_definition
53
+ initialize_storage
54
+ end
55
+
56
+ # What gets called when you call instance.attachment = File. It clears
57
+ # errors, assigns attributes, processes the file, and runs validations. It
58
+ # also queues up the previous file for deletion, to be flushed away on
59
+ # #save of its host. In addition to form uploads, you can also assign
60
+ # another Paperclip attachment:
61
+ # new_user.avatar = old_user.avatar
62
+ # If the file that is assigned is not valid, the processing (i.e.
63
+ # thumbnailing, etc) will NOT be run.
64
+ def assign uploaded_file
65
+ ensure_required_accessors!
66
+
67
+ if uploaded_file.is_a?(Paperclip::Attachment)
68
+ uploaded_file = uploaded_file.to_file(:original)
69
+ close_uploaded_file = uploaded_file.respond_to?(:close)
70
+ end
71
+
72
+ return nil unless valid_assignment?(uploaded_file)
73
+
74
+ uploaded_file.binmode if uploaded_file.respond_to? :binmode
75
+ self.clear
76
+
77
+ return nil if uploaded_file.nil?
78
+
79
+ @queued_for_write[:original] = uploaded_file.to_tempfile
80
+ instance_write(:file_name, uploaded_file.original_filename.strip.gsub(/[^A-Za-z\d\.\-_]+/, '_'))
81
+ instance_write(:content_type, uploaded_file.content_type.to_s.strip)
82
+ instance_write(:file_size, uploaded_file.size.to_i)
83
+ instance_write(:updated_at, Time.now)
84
+
85
+ @dirty = true
86
+
87
+ post_process if valid?
88
+
89
+ # Reset the file size if the original file was reprocessed.
90
+ instance_write(:file_size, @queued_for_write[:original].size.to_i)
91
+ ensure
92
+ uploaded_file.close if close_uploaded_file
93
+ validate
94
+ end
95
+
96
+ # Returns the public URL of the attachment, with a given style. Note that
97
+ # this does not necessarily need to point to a file that your web server
98
+ # can access and can point to an action in your app, if you need fine
99
+ # grained security. This is not recommended if you don't need the
100
+ # security, however, for performance reasons. set
101
+ # include_updated_timestamp to false if you want to stop the attachment
102
+ # update time appended to the url
103
+ def url style = default_style, include_updated_timestamp = true
104
+ url = original_filename.nil? ? interpolate(@default_url, style) : interpolate(@url, style)
105
+ include_updated_timestamp && updated_at ? [url, updated_at].compact.join(url.include?("?") ? "&" : "?") : url
106
+ end
107
+
108
+ # Returns the path of the attachment as defined by the :path option. If the
109
+ # file is stored in the filesystem the path refers to the path of the file
110
+ # on disk. If the file is stored in S3, the path is the "key" part of the
111
+ # URL, and the :bucket option refers to the S3 bucket.
112
+ def path style = default_style
113
+ original_filename.nil? ? nil : interpolate(@path, style)
114
+ end
115
+
116
+ # Alias to +url+
117
+ def to_s style = nil
118
+ url(style)
119
+ end
120
+
121
+ # Returns true if there are no errors on this attachment.
122
+ def valid?
123
+ validate
124
+ errors.empty?
125
+ end
126
+
127
+ # Returns an array containing the errors on this attachment.
128
+ def errors
129
+ @errors
130
+ end
131
+
132
+ # Returns true if there are changes that need to be saved.
133
+ def dirty?
134
+ @dirty
135
+ end
136
+
137
+ # Saves the file, if there are no errors. If there are, it flushes them to
138
+ # the instance's errors and returns false, cancelling the save.
139
+ def save
140
+ if valid?
141
+ flush_deletes
142
+ flush_writes
143
+ @dirty = false
144
+ true
145
+ else
146
+ flush_errors
147
+ false
148
+ end
149
+ end
150
+
151
+ # Clears out the attachment. Has the same effect as previously assigning
152
+ # nil to the attachment. Does NOT save. If you wish to clear AND save,
153
+ # use #destroy.
154
+ def clear
155
+ queue_existing_for_delete
156
+ @errors = {}
157
+ @validation_errors = nil
158
+ end
159
+
160
+ # Destroys the attachment. Has the same effect as previously assigning
161
+ # nil to the attachment *and saving*. This is permanent. If you wish to
162
+ # wipe out the existing attachment but not save, use #clear.
163
+ def destroy
164
+ clear
165
+ save
166
+ end
167
+
168
+ # Returns the name of the file as originally assigned, and lives in the
169
+ # <attachment>_file_name attribute of the model.
170
+ def original_filename
171
+ instance_read(:file_name)
172
+ end
173
+
174
+ # Returns the size of the file as originally assigned, and lives in the
175
+ # <attachment>_file_size attribute of the model.
176
+ def size
177
+ instance_read(:file_size) || (@queued_for_write[:original] && @queued_for_write[:original].size)
178
+ end
179
+
180
+ # Returns the content_type of the file as originally assigned, and lives
181
+ # in the <attachment>_content_type attribute of the model.
182
+ def content_type
183
+ instance_read(:content_type)
184
+ end
185
+
186
+ # Returns the last modified time of the file as originally assigned, and
187
+ # lives in the <attachment>_updated_at attribute of the model.
188
+ def updated_at
189
+ time = instance_read(:updated_at)
190
+ time && time.to_f.to_i
191
+ end
192
+
193
+ # Paths and URLs can have a number of variables interpolated into them
194
+ # to vary the storage location based on name, id, style, class, etc.
195
+ # This method is a deprecated access into supplying and retrieving these
196
+ # interpolations. Future access should use either Paperclip.interpolates
197
+ # or extend the Paperclip::Interpolations module directly.
198
+ def self.interpolations
199
+ warn('[DEPRECATION] Paperclip::Attachment.interpolations is deprecated ' +
200
+ 'and will be removed from future versions. ' +
201
+ 'Use Paperclip.interpolates instead')
202
+ Paperclip::Interpolations
203
+ end
204
+
205
+ # This method really shouldn't be called that often. It's expected use is
206
+ # in the paperclip:refresh rake task and that's it. It will regenerate all
207
+ # thumbnails forcefully, by reobtaining the original file and going through
208
+ # the post-process again.
209
+ def reprocess!
210
+ new_original = Tempfile.new("paperclip-reprocess")
211
+ new_original.binmode
212
+ if old_original = to_file(:original)
213
+ new_original.write( old_original.read )
214
+ new_original.rewind
215
+
216
+ @queued_for_write = { :original => new_original }
217
+ post_process
218
+
219
+ old_original.close if old_original.respond_to?(:close)
220
+
221
+ save
222
+ else
223
+ true
224
+ end
225
+ end
226
+
227
+ # Returns true if a file has been assigned.
228
+ def file?
229
+ !original_filename.blank?
230
+ end
231
+
232
+ # Writes the attachment-specific attribute on the instance. For example,
233
+ # instance_write(:file_name, "me.jpg") will write "me.jpg" to the instance's
234
+ # "avatar_file_name" field (assuming the attachment is called avatar).
235
+ def instance_write(attr, value)
236
+ setter = :"#{name}_#{attr}="
237
+ responds = instance.respond_to?(setter)
238
+ self.instance_variable_set("@_#{setter.to_s.chop}", value)
239
+ instance.send(setter, value) if responds || attr.to_s == "file_name"
240
+ end
241
+
242
+ # Reads the attachment-specific attribute on the instance. See instance_write
243
+ # for more details.
244
+ def instance_read(attr)
245
+ getter = :"#{name}_#{attr}"
246
+ responds = instance.respond_to?(getter)
247
+ cached = self.instance_variable_get("@_#{getter}")
248
+ return cached if cached
249
+ instance.send(getter) if responds || attr.to_s == "file_name"
250
+ end
251
+
252
+ private
253
+
254
+ def ensure_required_accessors! #:nodoc:
255
+ %w(file_name).each do |field|
256
+ unless @instance.respond_to?("#{name}_#{field}") && @instance.respond_to?("#{name}_#{field}=")
257
+ raise PaperclipError.new("#{@instance.class} model missing required attr_accessor for '#{name}_#{field}'")
258
+ end
259
+ end
260
+ end
261
+
262
+ def log message #:nodoc:
263
+ Paperclip.log(message)
264
+ end
265
+
266
+ def valid_assignment? file #:nodoc:
267
+ file.nil? || (file.respond_to?(:original_filename) && file.respond_to?(:content_type))
268
+ end
269
+
270
+ def validate #:nodoc:
271
+ unless @validation_errors
272
+ @validation_errors = @validations.inject({}) do |errors, validation|
273
+ name, options = validation
274
+ errors[name] = send(:"validate_#{name}", options) if allow_validation?(options)
275
+ errors
276
+ end
277
+ @validation_errors.reject!{|k,v| v == nil }
278
+ @errors.merge!(@validation_errors)
279
+ end
280
+ @validation_errors
281
+ end
282
+
283
+ def allow_validation? options #:nodoc:
284
+ (options[:if].nil? || check_guard(options[:if])) && (options[:unless].nil? || !check_guard(options[:unless]))
285
+ end
286
+
287
+ def check_guard guard #:nodoc:
288
+ if guard.respond_to? :call
289
+ guard.call(instance)
290
+ elsif ! guard.blank?
291
+ instance.send(guard.to_s)
292
+ end
293
+ end
294
+
295
+ def validate_size options #:nodoc:
296
+ if file? && !options[:range].include?(size.to_i)
297
+ options[:message].gsub(/:min/, options[:min].to_s).gsub(/:max/, options[:max].to_s)
298
+ end
299
+ end
300
+
301
+ def validate_presence options #:nodoc:
302
+ options[:message] unless file?
303
+ end
304
+
305
+ def validate_content_type options #:nodoc:
306
+ valid_types = [options[:content_type]].flatten
307
+ unless original_filename.blank?
308
+ unless valid_types.blank?
309
+ content_type = instance_read(:content_type)
310
+ unless valid_types.any?{|t| content_type.nil? || t === content_type }
311
+ options[:message] || "is not one of the allowed file types."
312
+ end
313
+ end
314
+ end
315
+ end
316
+
317
+ def normalize_style_definition #:nodoc:
318
+ @styles.each do |name, args|
319
+ unless args.is_a? Hash
320
+ dimensions, format = [args, nil].flatten[0..1]
321
+ format = nil if format.blank?
322
+ @styles[name] = {
323
+ :processors => @processors,
324
+ :geometry => dimensions,
325
+ :format => format,
326
+ :whiny => @whiny,
327
+ :convert_options => extra_options_for(name)
328
+ }
329
+ else
330
+ @styles[name] = {
331
+ :processors => @processors,
332
+ :whiny => @whiny,
333
+ :convert_options => extra_options_for(name)
334
+ }.merge(@styles[name])
335
+ end
336
+ end
337
+ end
338
+
339
+ def solidify_style_definitions #:nodoc:
340
+ @styles.each do |name, args|
341
+ @styles[name][:geometry] = @styles[name][:geometry].call(instance) if @styles[name][:geometry].respond_to?(:call)
342
+ @styles[name][:processors] = @styles[name][:processors].call(instance) if @styles[name][:processors].respond_to?(:call)
343
+ end
344
+ end
345
+
346
+ def initialize_storage #:nodoc:
347
+ @storage_module = Paperclip::Storage.const_get(@storage.to_s.classify)
348
+ self.extend(@storage_module)
349
+ end
350
+
351
+ def extra_options_for(style) #:nodoc:
352
+ all_options = convert_options[:all]
353
+ all_options = all_options.call(instance) if all_options.respond_to?(:call)
354
+ style_options = convert_options[style]
355
+ style_options = style_options.call(instance) if style_options.respond_to?(:call)
356
+
357
+ [ style_options, all_options ].compact.join(" ")
358
+ end
359
+
360
+ def post_process #:nodoc:
361
+ return if @queued_for_write[:original].nil?
362
+ solidify_style_definitions
363
+ return if fire_events(:before)
364
+ post_process_styles
365
+ return if fire_events(:after)
366
+ end
367
+
368
+ def fire_events(which) #:nodoc:
369
+ return true if callback(:"#{which}_post_process") == false
370
+ return true if callback(:"#{which}_#{name}_post_process") == false
371
+ end
372
+
373
+ def callback which #:nodoc:
374
+ instance.run_callbacks(which, @queued_for_write){|result, obj| result == false }
375
+ end
376
+
377
+ def post_process_styles #:nodoc:
378
+ @styles.each do |name, args|
379
+ begin
380
+ raise RuntimeError.new("Style #{name} has no processors defined.") if args[:processors].blank?
381
+ @queued_for_write[name] = args[:processors].inject(@queued_for_write[:original]) do |file, processor|
382
+ Paperclip.processor(processor).make(file, args, self)
383
+ end
384
+ rescue PaperclipError => e
385
+ log("An error was received while processing: #{e.inspect}")
386
+ (@errors[:processing] ||= []) << e.message if @whiny
387
+ end
388
+ end
389
+ end
390
+
391
+ def interpolate pattern, style = default_style #:nodoc:
392
+ Paperclip::Interpolations.interpolate(pattern, self, style)
393
+ end
394
+
395
+ def queue_existing_for_delete #:nodoc:
396
+ return unless file?
397
+ @queued_for_delete += [:original, *@styles.keys].uniq.map do |style|
398
+ path(style) if exists?(style)
399
+ end.compact
400
+ instance_write(:file_name, nil)
401
+ instance_write(:content_type, nil)
402
+ instance_write(:file_size, nil)
403
+ instance_write(:updated_at, nil)
404
+ end
405
+
406
+ def flush_errors #:nodoc:
407
+ @errors.each do |error, message|
408
+ [message].flatten.each {|m| instance.errors.add(name, m) }
409
+ end
410
+ end
411
+
412
+ end
413
+ end
414
+
@@ -0,0 +1,33 @@
1
+ module Paperclip
2
+ # This module is intended as a compatability shim for the differences in
3
+ # callbacks between Rails 2.0 and Rails 2.1.
4
+ module CallbackCompatability
5
+ def self.included(base)
6
+ base.extend(ClassMethods)
7
+ base.send(:include, InstanceMethods)
8
+ end
9
+
10
+ module ClassMethods
11
+ # The implementation of this method is taken from the Rails 1.2.6 source,
12
+ # from rails/activerecord/lib/active_record/callbacks.rb, line 192.
13
+ def define_callbacks(*args)
14
+ args.each do |method|
15
+ self.class_eval <<-"end_eval"
16
+ def self.#{method}(*callbacks, &block)
17
+ callbacks << block if block_given?
18
+ write_inheritable_array(#{method.to_sym.inspect}, callbacks)
19
+ end
20
+ end_eval
21
+ end
22
+ end
23
+ end
24
+
25
+ module InstanceMethods
26
+ # The callbacks in < 2.1 don't worry about the extra options or the
27
+ # block, so just run what we have available.
28
+ def run_callbacks(meth, opts = nil, &blk)
29
+ callback(meth)
30
+ end
31
+ end
32
+ end
33
+ end
@@ -0,0 +1,115 @@
1
+ module Paperclip
2
+
3
+ # Defines the geometry of an image.
4
+ class Geometry
5
+ attr_accessor :height, :width, :modifier
6
+
7
+ # Gives a Geometry representing the given height and width
8
+ def initialize width = nil, height = nil, modifier = nil
9
+ @height = height.to_f
10
+ @width = width.to_f
11
+ @modifier = modifier
12
+ end
13
+
14
+ # Uses ImageMagick to determing the dimensions of a file, passed in as either a
15
+ # File or path.
16
+ def self.from_file file
17
+ file = file.path if file.respond_to? "path"
18
+ geometry = begin
19
+ Paperclip.run("identify", %Q[-format "%wx%h" "#{file}"[0]])
20
+ rescue PaperclipCommandLineError
21
+ ""
22
+ end
23
+ parse(geometry) ||
24
+ raise(NotIdentifiedByImageMagickError.new("#{file} is not recognized by the 'identify' command."))
25
+ end
26
+
27
+ # Parses a "WxH" formatted string, where W is the width and H is the height.
28
+ def self.parse string
29
+ if match = (string && string.match(/\b(\d*)x?(\d*)\b([\>\<\#\@\%^!])?/i))
30
+ Geometry.new(*match[1,3])
31
+ end
32
+ end
33
+
34
+ # True if the dimensions represent a square
35
+ def square?
36
+ height == width
37
+ end
38
+
39
+ # True if the dimensions represent a horizontal rectangle
40
+ def horizontal?
41
+ height < width
42
+ end
43
+
44
+ # True if the dimensions represent a vertical rectangle
45
+ def vertical?
46
+ height > width
47
+ end
48
+
49
+ # The aspect ratio of the dimensions.
50
+ def aspect
51
+ width / height
52
+ end
53
+
54
+ # Returns the larger of the two dimensions
55
+ def larger
56
+ [height, width].max
57
+ end
58
+
59
+ # Returns the smaller of the two dimensions
60
+ def smaller
61
+ [height, width].min
62
+ end
63
+
64
+ # Returns the width and height in a format suitable to be passed to Geometry.parse
65
+ def to_s
66
+ s = ""
67
+ s << width.to_i.to_s if width > 0
68
+ s << "x#{height.to_i}" if height > 0
69
+ s << modifier.to_s
70
+ s
71
+ end
72
+
73
+ # Same as to_s
74
+ def inspect
75
+ to_s
76
+ end
77
+
78
+ # Returns the scaling and cropping geometries (in string-based ImageMagick format)
79
+ # neccessary to transform this Geometry into the Geometry given. If crop is true,
80
+ # then it is assumed the destination Geometry will be the exact final resolution.
81
+ # In this case, the source Geometry is scaled so that an image containing the
82
+ # destination Geometry would be completely filled by the source image, and any
83
+ # overhanging image would be cropped. Useful for square thumbnail images. The cropping
84
+ # is weighted at the center of the Geometry.
85
+ def transformation_to dst, crop = false
86
+ if crop
87
+ ratio = Geometry.new( dst.width / self.width, dst.height / self.height )
88
+ scale_geometry, scale = scaling(dst, ratio)
89
+ crop_geometry = cropping(dst, ratio, scale)
90
+ else
91
+ scale_geometry = dst.to_s
92
+ end
93
+
94
+ [ scale_geometry, crop_geometry ]
95
+ end
96
+
97
+ private
98
+
99
+ def scaling dst, ratio
100
+ if ratio.horizontal? || ratio.square?
101
+ [ "%dx" % dst.width, ratio.width ]
102
+ else
103
+ [ "x%d" % dst.height, ratio.height ]
104
+ end
105
+ end
106
+
107
+ def cropping dst, ratio, scale
108
+ if ratio.horizontal? || ratio.square?
109
+ "%dx%d+%d+%d" % [ dst.width, dst.height, 0, (self.height * scale - dst.height) / 2 ]
110
+ else
111
+ "%dx%d+%d+%d" % [ dst.width, dst.height, (self.width * scale - dst.width) / 2, 0 ]
112
+ end
113
+ end
114
+ end
115
+ end