alg-paperclip 2.3.1.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (50) hide show
  1. data/LICENSE +26 -0
  2. data/README.rdoc +195 -0
  3. data/Rakefile +103 -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 +357 -0
  9. data/lib/paperclip/attachment.rb +345 -0
  10. data/lib/paperclip/callback_compatability.rb +33 -0
  11. data/lib/paperclip/geometry.rb +115 -0
  12. data/lib/paperclip/interpolations.rb +120 -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 +247 -0
  21. data/lib/paperclip/style.rb +90 -0
  22. data/lib/paperclip/thumbnail.rb +75 -0
  23. data/lib/paperclip/upfile.rb +49 -0
  24. data/shoulda_macros/paperclip.rb +117 -0
  25. data/tasks/paperclip_tasks.rake +79 -0
  26. data/test/attachment_test.rb +788 -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 +108 -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 +298 -0
  45. data/test/processor_test.rb +10 -0
  46. data/test/storage_test.rb +330 -0
  47. data/test/style_test.rb +141 -0
  48. data/test/thumbnail_test.rb +227 -0
  49. data/test/upfile_test.rb +28 -0
  50. metadata +164 -0
@@ -0,0 +1,345 @@
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
+ :processors => [:thumbnail],
14
+ :convert_options => {},
15
+ :default_url => "/:attachment/:style/missing.png",
16
+ :default_style => :original,
17
+ :storage => :filesystem,
18
+ :whiny => Paperclip.options[:whiny] || Paperclip.options[:whiny_thumbnails]
19
+ }
20
+ end
21
+
22
+ attr_reader :name, :instance, :default_style, :convert_options, :queued_for_write, :whiny, :options, :tags
23
+
24
+ # Creates an Attachment object. +name+ is the name of the attachment,
25
+ # +instance+ is the ActiveRecord object instance it's attached to, and
26
+ # +options+ is the same as the hash passed to +has_attached_file+.
27
+ def initialize name, instance, options = {}
28
+ @name = name
29
+ @instance = instance
30
+
31
+ options = self.class.default_options.merge(options)
32
+
33
+ @url = options[:url]
34
+ @url = @url.call(self) if @url.is_a?(Proc)
35
+ @path = options[:path]
36
+ @path = @path.call(self) if @path.is_a?(Proc)
37
+ @styles = options[:styles]
38
+ @normalized_styles = nil
39
+ @default_url = options[:default_url]
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]
45
+ @options = options
46
+ @queued_for_delete = []
47
+ @queued_for_write = {}
48
+ @errors = {}
49
+ @dirty = false
50
+ @tags = options[:tags] || {}
51
+
52
+ initialize_storage
53
+ end
54
+
55
+ def styles
56
+ unless @normalized_styles
57
+ @normalized_styles = {}
58
+ (@styles.respond_to?(:call) ? @styles.call(self) : @styles).each do |name, args|
59
+ @normalized_styles[name] = Paperclip::Style.new(name, args, self)
60
+ end
61
+ end
62
+ @normalized_styles
63
+ end
64
+
65
+ def processors
66
+ @processors.respond_to?(:call) ? @processors.call(instance) : @processors
67
+ end
68
+
69
+ # What gets called when you call instance.attachment = File. It clears
70
+ # errors, assigns attributes, and processes the file. It
71
+ # also queues up the previous file for deletion, to be flushed away on
72
+ # #save of its host. In addition to form uploads, you can also assign
73
+ # another Paperclip attachment:
74
+ # new_user.avatar = old_user.avatar
75
+ def assign uploaded_file
76
+ ensure_required_accessors!
77
+
78
+ if uploaded_file.is_a?(Paperclip::Attachment)
79
+ uploaded_file = uploaded_file.to_file(:original)
80
+ close_uploaded_file = uploaded_file.respond_to?(:close)
81
+ end
82
+
83
+ return nil unless valid_assignment?(uploaded_file)
84
+
85
+ uploaded_file.binmode if uploaded_file.respond_to? :binmode
86
+ self.clear
87
+
88
+ return nil if uploaded_file.nil?
89
+
90
+ @queued_for_write[:original] = uploaded_file.to_tempfile
91
+ instance_write(:file_name, uploaded_file.original_filename.strip.gsub(/[^A-Za-z\d\.\-_]+/, '_'))
92
+ instance_write(:content_type, uploaded_file.content_type.to_s.strip)
93
+ instance_write(:file_size, uploaded_file.size.to_i)
94
+ instance_write(:updated_at, Time.now)
95
+
96
+ @dirty = true
97
+
98
+ post_process
99
+
100
+ # Reset the file size if the original file was reprocessed.
101
+ instance_write(:file_size, @queued_for_write[:original].size.to_i)
102
+ ensure
103
+ uploaded_file.close if close_uploaded_file
104
+ end
105
+
106
+ # Returns the public URL of the attachment, with a given style. Note that
107
+ # this does not necessarily need to point to a file that your web server
108
+ # can access and can point to an action in your app, if you need fine
109
+ # grained security. This is not recommended if you don't need the
110
+ # security, however, for performance reasons. set
111
+ # include_updated_timestamp to false if you want to stop the attachment
112
+ # update time appended to the url
113
+ def url style_name = default_style, include_updated_timestamp = true
114
+ url = original_filename.nil? ? interpolate(@default_url, style_name) : interpolate(@url, style_name)
115
+ include_updated_timestamp && updated_at ? [url, updated_at].compact.join(url.include?("?") ? "&" : "?") : url
116
+ end
117
+
118
+ # Returns the path of the attachment as defined by the :path option. If the
119
+ # file is stored in the filesystem the path refers to the path of the file
120
+ # on disk. If the file is stored in S3, the path is the "key" part of the
121
+ # URL, and the :bucket option refers to the S3 bucket.
122
+ def path style_name = default_style
123
+ original_filename.nil? ? nil : interpolate(@path, style_name)
124
+ end
125
+
126
+ # Alias to +url+
127
+ def to_s style_name = nil
128
+ url(style_name)
129
+ end
130
+
131
+ # Returns an array containing the errors on this attachment.
132
+ def errors
133
+ @errors
134
+ end
135
+
136
+ # Returns true if there are changes that need to be saved.
137
+ def dirty?
138
+ @dirty
139
+ end
140
+
141
+ # Saves the file, if there are no errors. If there are, it flushes them to
142
+ # the instance's errors and returns false, cancelling the save.
143
+ def save
144
+ flush_deletes
145
+ flush_writes
146
+ @dirty = false
147
+ true
148
+ end
149
+
150
+ # Clears out the attachment. Has the same effect as previously assigning
151
+ # nil to the attachment. Does NOT save. If you wish to clear AND save,
152
+ # use #destroy.
153
+ def clear
154
+ queue_existing_for_delete
155
+ @errors = {}
156
+ end
157
+
158
+ # Destroys the attachment. Has the same effect as previously assigning
159
+ # nil to the attachment *and saving*. This is permanent. If you wish to
160
+ # wipe out the existing attachment but not save, use #clear.
161
+ def destroy
162
+ clear
163
+ save
164
+ end
165
+
166
+ # Returns the name of the file as originally assigned, and lives in the
167
+ # <attachment>_file_name attribute of the model.
168
+ def original_filename
169
+ instance_read(:file_name)
170
+ end
171
+
172
+ # Returns the size of the file as originally assigned, and lives in the
173
+ # <attachment>_file_size attribute of the model.
174
+ def size
175
+ instance_read(:file_size) || (@queued_for_write[:original] && @queued_for_write[:original].size)
176
+ end
177
+
178
+ # Returns the content_type of the file as originally assigned, and lives
179
+ # in the <attachment>_content_type attribute of the model.
180
+ def content_type
181
+ instance_read(:content_type)
182
+ end
183
+
184
+ # Returns the width of the attachment of a given style.
185
+ def width(style_name)
186
+ Paperclip::Geometry.from_file(path(style_name)).try(:width).to_i
187
+ end
188
+
189
+ # Returns the height of the attachment of a given style.
190
+ def height(style_name)
191
+ Paperclip::Geometry.from_file(path(style_name)).try(:height).to_i
192
+ end
193
+
194
+ # Returns the last modified time of the file as originally assigned, and
195
+ # lives in the <attachment>_updated_at attribute of the model.
196
+ def updated_at
197
+ time = instance_read(:updated_at)
198
+ time && time.to_f.to_i
199
+ end
200
+
201
+ # Paths and URLs can have a number of variables interpolated into them
202
+ # to vary the storage location based on name, id, style, class, etc.
203
+ # This method is a deprecated access into supplying and retrieving these
204
+ # interpolations. Future access should use either Paperclip.interpolates
205
+ # or extend the Paperclip::Interpolations module directly.
206
+ def self.interpolations
207
+ warn('[DEPRECATION] Paperclip::Attachment.interpolations is deprecated ' +
208
+ 'and will be removed from future versions. ' +
209
+ 'Use Paperclip.interpolates instead')
210
+ Paperclip::Interpolations
211
+ end
212
+
213
+ # This method really shouldn't be called that often. It's expected use is
214
+ # in the paperclip:refresh rake task and that's it. It will regenerate all
215
+ # thumbnails forcefully, by reobtaining the original file and going through
216
+ # the post-process again.
217
+ def reprocess!
218
+ new_original = Tempfile.new("paperclip-reprocess")
219
+ new_original.binmode
220
+ if old_original = to_file(:original)
221
+ new_original.write( old_original.read )
222
+ new_original.rewind
223
+
224
+ @queued_for_write = { :original => new_original }
225
+ post_process
226
+
227
+ old_original.close if old_original.respond_to?(:close)
228
+
229
+ save
230
+ else
231
+ true
232
+ end
233
+ end
234
+
235
+ # Returns true if a file has been assigned.
236
+ def file?
237
+ !original_filename.blank?
238
+ end
239
+
240
+ # Writes the attachment-specific attribute on the instance. For example,
241
+ # instance_write(:file_name, "me.jpg") will write "me.jpg" to the instance's
242
+ # "avatar_file_name" field (assuming the attachment is called avatar).
243
+ def instance_write(attr, value)
244
+ setter = :"#{name}_#{attr}="
245
+ responds = instance.respond_to?(setter)
246
+ self.instance_variable_set("@_#{setter.to_s.chop}", value)
247
+ instance.send(setter, value) if responds || attr.to_s == "file_name"
248
+ end
249
+
250
+ # Reads the attachment-specific attribute on the instance. See instance_write
251
+ # for more details.
252
+ def instance_read(attr)
253
+ getter = :"#{name}_#{attr}"
254
+ responds = instance.respond_to?(getter)
255
+ cached = self.instance_variable_get("@_#{getter}")
256
+ return cached if cached
257
+ instance.send(getter) if responds || attr.to_s == "file_name"
258
+ end
259
+
260
+ private
261
+
262
+ def ensure_required_accessors! #:nodoc:
263
+ %w(file_name).each do |field|
264
+ unless @instance.respond_to?("#{name}_#{field}") && @instance.respond_to?("#{name}_#{field}=")
265
+ raise PaperclipError.new("#{@instance.class} model missing required attr_accessor for '#{name}_#{field}'")
266
+ end
267
+ end
268
+ end
269
+
270
+ def log message #:nodoc:
271
+ Paperclip.log(message)
272
+ end
273
+
274
+ def valid_assignment? file #:nodoc:
275
+ file.nil? || (file.respond_to?(:original_filename) && file.respond_to?(:content_type))
276
+ end
277
+
278
+ def initialize_storage #:nodoc:
279
+ @storage_module = Paperclip::Storage.const_get(@storage.to_s.capitalize)
280
+ self.extend(@storage_module)
281
+ end
282
+
283
+ def extra_options_for(style) #:nodoc:
284
+ all_options = convert_options[:all]
285
+ all_options = all_options.call(instance) if all_options.respond_to?(:call)
286
+ style_options = convert_options[style]
287
+ style_options = style_options.call(instance) if style_options.respond_to?(:call)
288
+
289
+ [ style_options, all_options ].compact.join(" ")
290
+ end
291
+
292
+ def post_process #:nodoc:
293
+ return if @queued_for_write[:original].nil?
294
+ return if fire_events(:before)
295
+ post_process_styles
296
+ return if fire_events(:after)
297
+ end
298
+
299
+ def fire_events(which) #:nodoc:
300
+ return true if callback(:"#{which}_post_process") == false
301
+ return true if callback(:"#{which}_#{name}_post_process") == false
302
+ end
303
+
304
+ def callback which #:nodoc:
305
+ instance.run_callbacks(which, @queued_for_write){|result, obj| result == false }
306
+ end
307
+
308
+ def post_process_styles #:nodoc:
309
+ styles.each do |name, style|
310
+ begin
311
+ raise RuntimeError.new("Style #{name} has no processors defined.") if style.processors.blank?
312
+ @queued_for_write[name] = style.processors.inject(@queued_for_write[:original]) do |file, processor|
313
+ Paperclip.processor(processor).make(file, style.processor_options, self)
314
+ end
315
+ rescue PaperclipError => e
316
+ log("An error was received while processing: #{e.inspect}")
317
+ (@errors[:processing] ||= []) << e.message if @whiny
318
+ end
319
+ end
320
+ end
321
+
322
+ def interpolate pattern, style_name = default_style #:nodoc:
323
+ Paperclip::Interpolations.interpolate(pattern, self, style_name)
324
+ end
325
+
326
+ def queue_existing_for_delete #:nodoc:
327
+ return unless file?
328
+ @queued_for_delete += [:original, *styles.keys].uniq.map do |style|
329
+ path(style) if exists?(style)
330
+ end.compact
331
+ instance_write(:file_name, nil)
332
+ instance_write(:content_type, nil)
333
+ instance_write(:file_size, nil)
334
+ instance_write(:updated_at, nil)
335
+ end
336
+
337
+ def flush_errors #:nodoc:
338
+ @errors.each do |error, message|
339
+ [message].flatten.each {|m| instance.errors.add(name, m) }
340
+ end
341
+ end
342
+
343
+ end
344
+ end
345
+
@@ -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