path-paperclip 2.3.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (57) hide show
  1. data/LICENSE +26 -0
  2. data/README.rdoc +198 -0
  3. data/Rakefile +76 -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/generators/paperclip/USAGE +8 -0
  9. data/lib/generators/paperclip/paperclip_generator.rb +31 -0
  10. data/lib/generators/paperclip/templates/paperclip_migration.rb.erb +19 -0
  11. data/lib/paperclip.rb +440 -0
  12. data/lib/paperclip/attachment.rb +401 -0
  13. data/lib/paperclip/callback_compatability.rb +61 -0
  14. data/lib/paperclip/geometry.rb +150 -0
  15. data/lib/paperclip/interpolations.rb +113 -0
  16. data/lib/paperclip/iostream.rb +59 -0
  17. data/lib/paperclip/matchers.rb +33 -0
  18. data/lib/paperclip/matchers/have_attached_file_matcher.rb +57 -0
  19. data/lib/paperclip/matchers/validate_attachment_content_type_matcher.rb +75 -0
  20. data/lib/paperclip/matchers/validate_attachment_presence_matcher.rb +54 -0
  21. data/lib/paperclip/matchers/validate_attachment_size_matcher.rb +95 -0
  22. data/lib/paperclip/processor.rb +49 -0
  23. data/lib/paperclip/railtie.rb +20 -0
  24. data/lib/paperclip/storage.rb +258 -0
  25. data/lib/paperclip/style.rb +90 -0
  26. data/lib/paperclip/thumbnail.rb +78 -0
  27. data/lib/paperclip/upfile.rb +52 -0
  28. data/lib/paperclip/version.rb +3 -0
  29. data/lib/tasks/paperclip.rake +95 -0
  30. data/rails/init.rb +2 -0
  31. data/shoulda_macros/paperclip.rb +119 -0
  32. data/test/attachment_test.rb +796 -0
  33. data/test/database.yml +4 -0
  34. data/test/fixtures/12k.png +0 -0
  35. data/test/fixtures/50x50.png +0 -0
  36. data/test/fixtures/5k.png +0 -0
  37. data/test/fixtures/bad.png +1 -0
  38. data/test/fixtures/ceedub.gif +0 -0
  39. data/test/fixtures/s3.yml +8 -0
  40. data/test/fixtures/text.txt +1 -0
  41. data/test/fixtures/twopage.pdf +0 -0
  42. data/test/geometry_test.rb +177 -0
  43. data/test/helper.rb +152 -0
  44. data/test/integration_test.rb +610 -0
  45. data/test/interpolations_test.rb +135 -0
  46. data/test/iostream_test.rb +78 -0
  47. data/test/matchers/have_attached_file_matcher_test.rb +24 -0
  48. data/test/matchers/validate_attachment_content_type_matcher_test.rb +54 -0
  49. data/test/matchers/validate_attachment_presence_matcher_test.rb +26 -0
  50. data/test/matchers/validate_attachment_size_matcher_test.rb +51 -0
  51. data/test/paperclip_test.rb +389 -0
  52. data/test/processor_test.rb +10 -0
  53. data/test/storage_test.rb +407 -0
  54. data/test/style_test.rb +141 -0
  55. data/test/thumbnail_test.rb +227 -0
  56. data/test/upfile_test.rb +36 -0
  57. metadata +221 -0
@@ -0,0 +1,150 @@
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", "-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
+ # Adapted from attachment_fu.
98
+ # Attempts to get new dimensions for the current geometry string given these old dimensions.
99
+ # This doesn't implement the aspect flag (!) or the area flag (@). PDI
100
+ def new_dimensions_for orig_width, orig_height
101
+ new_width = orig_width
102
+ new_height = orig_height
103
+
104
+ case self.modifier
105
+ when '#'
106
+ new_width = self.width
107
+ new_height = self.height
108
+ when '%'
109
+ scale_x = self.width.zero? ? 100 : self.width
110
+ scale_y = self.height.zero? ? self.width : self.height
111
+ new_width = scale_x.to_f * (orig_width.to_f / 100.0)
112
+ new_height = scale_y.to_f * (orig_height.to_f / 100.0)
113
+ when '<', '>', nil
114
+ scale_factor =
115
+ if new_width.zero? || new_height.zero?
116
+ 1.0
117
+ else
118
+ if self.width.nonzero? && self.height.nonzero?
119
+ [self.width.to_f / new_width.to_f, self.height.to_f / new_height.to_f].min
120
+ else
121
+ self.width.nonzero? ? (self.width.to_f / new_width.to_f) : (self.height.to_f / new_height.to_f)
122
+ end
123
+ end
124
+ new_width = scale_factor * new_width.to_f
125
+ new_height = scale_factor * new_height.to_f
126
+ new_width = orig_width if self.modifier && new_width.send(self.modifier, orig_width)
127
+ new_height = orig_height if self.modifier && new_height.send(self.modifier, orig_height)
128
+ end
129
+ [new_width, new_height].collect! { |v| [v.round, 1].max }
130
+ end
131
+
132
+ private
133
+
134
+ def scaling dst, ratio
135
+ if ratio.horizontal? || ratio.square?
136
+ [ "%dx" % dst.width, ratio.width ]
137
+ else
138
+ [ "x%d" % dst.height, ratio.height ]
139
+ end
140
+ end
141
+
142
+ def cropping dst, ratio, scale
143
+ if ratio.horizontal? || ratio.square?
144
+ "%dx%d+%d+%d" % [ dst.width, dst.height, 0, (self.height * scale - dst.height) / 2 ]
145
+ else
146
+ "%dx%d+%d+%d" % [ dst.width, dst.height, (self.width * scale - dst.width) / 2, 0 ]
147
+ end
148
+ end
149
+ end
150
+ end
@@ -0,0 +1,113 @@
1
+ module Paperclip
2
+ # This module contains all the methods that are available for interpolation
3
+ # in paths and urls. To add your own (or override an existing one), you
4
+ # can either open this module and define it, or call the
5
+ # Paperclip.interpolates method.
6
+ module Interpolations
7
+ extend self
8
+
9
+ # Hash assignment of interpolations. Included only for compatability,
10
+ # and is not intended for normal use.
11
+ def self.[]= name, block
12
+ define_method(name, &block)
13
+ end
14
+
15
+ # Hash access of interpolations. Included only for compatability,
16
+ # and is not intended for normal use.
17
+ def self.[] name
18
+ method(name)
19
+ end
20
+
21
+ # Returns a sorted list of all interpolations.
22
+ def self.all
23
+ self.instance_methods(false).sort
24
+ end
25
+
26
+ # Perform the actual interpolation. Takes the pattern to interpolate
27
+ # and the arguments to pass, which are the attachment and style name.
28
+ def self.interpolate pattern, *args
29
+ all.reverse.inject( pattern.dup ) do |result, tag|
30
+ result.gsub(/:#{tag}/) do |match|
31
+ send( tag, *args )
32
+ end
33
+ end
34
+ end
35
+
36
+ # Returns the filename, the same way as ":basename.:extension" would.
37
+ def filename attachment, style_name
38
+ "#{basename(attachment, style_name)}.#{extension(attachment, style_name)}"
39
+ end
40
+
41
+ # Returns the interpolated URL. Will raise an error if the url itself
42
+ # contains ":url" to prevent infinite recursion. This interpolation
43
+ # is used in the default :path to ease default specifications.
44
+ def url attachment, style_name
45
+ raise InfiniteInterpolationError if attachment.options[:url].include?(":url")
46
+ attachment.url(style_name, false)
47
+ end
48
+
49
+ # Returns the timestamp as defined by the <attachment>_updated_at field
50
+ def timestamp attachment, style_name
51
+ attachment.instance_read(:updated_at).to_s
52
+ end
53
+
54
+ # Returns the Rails.root constant.
55
+ def rails_root attachment, style_name
56
+ Rails.root
57
+ end
58
+
59
+ # Returns the Rails.env constant.
60
+ def rails_env attachment, style_name
61
+ Rails.env
62
+ end
63
+
64
+ # Returns the underscored, pluralized version of the class name.
65
+ # e.g. "users" for the User class.
66
+ # NOTE: The arguments need to be optional, because some tools fetch
67
+ # all class names. Calling #class will return the expected class.
68
+ def class attachment = nil, style_name = nil
69
+ return super() if attachment.nil? && style_name.nil?
70
+ attachment.instance.class.to_s.underscore.pluralize
71
+ end
72
+
73
+ # Returns the basename of the file. e.g. "file" for "file.jpg"
74
+ def basename attachment, style_name
75
+ attachment.original_filename.gsub(/#{File.extname(attachment.original_filename)}$/, "")
76
+ end
77
+
78
+ # Returns the extension of the file. e.g. "jpg" for "file.jpg"
79
+ # If the style has a format defined, it will return the format instead
80
+ # of the actual extension.
81
+ def extension attachment, style_name
82
+ ((style = attachment.styles[style_name]) && style[:format]) ||
83
+ Paperclip.extension_for_content_type(attachment.content_type) ||
84
+ File.extname(attachment.original_filename).gsub(/^\.+/, "")
85
+ end
86
+
87
+ # Returns the id of the instance.
88
+ def id attachment, style_name
89
+ attachment.instance.id
90
+ end
91
+
92
+ def digest attachment, style
93
+ attachment.digest
94
+ end
95
+
96
+ # Returns the id of the instance in a split path form. e.g. returns
97
+ # 000/001/234 for an id of 1234.
98
+ def id_partition attachment, style_name
99
+ ("%09d" % attachment.instance.id).scan(/\d{3}/).join("/")
100
+ end
101
+
102
+ # Returns the pluralized form of the attachment name. e.g.
103
+ # "avatars" for an attachment of :avatar
104
+ def attachment attachment, style_name
105
+ attachment.name.to_s.downcase.pluralize
106
+ end
107
+
108
+ # Returns the style, or the default style if nil is supplied.
109
+ def style attachment, style_name
110
+ style_name || attachment.default_style
111
+ end
112
+ end
113
+ end
@@ -0,0 +1,59 @@
1
+ # Provides method that can be included on File-type objects (IO, StringIO, Tempfile, etc) to allow stream copying
2
+ # and Tempfile conversion.
3
+ module IOStream
4
+
5
+ # Returns a Tempfile containing the contents of the readable object.
6
+ def to_tempfile
7
+ name = respond_to?(:original_filename) ? original_filename : (respond_to?(:path) ? path : "stream")
8
+ tempfile = Paperclip::Tempfile.new("stream" + File.extname(name))
9
+ tempfile.binmode
10
+ self.stream_to(tempfile)
11
+ end
12
+
13
+ # Copies one read-able object from one place to another in blocks, obviating the need to load
14
+ # the whole thing into memory. Defaults to 8k blocks. If this module is included in both
15
+ # StringIO and Tempfile, then either can have its data copied anywhere else without typing
16
+ # worries or memory overhead worries. Returns a File if a String is passed in as the destination
17
+ # and returns the IO or Tempfile as passed in if one is sent as the destination.
18
+ def stream_to path_or_file, in_blocks_of = 8192
19
+ dstio = case path_or_file
20
+ when String then File.new(path_or_file, "wb+")
21
+ when IO then path_or_file
22
+ when Tempfile then path_or_file
23
+ end
24
+ buffer = ""
25
+ self.rewind
26
+ while self.read(in_blocks_of, buffer) do
27
+ dstio.write(buffer)
28
+ end
29
+ dstio.rewind
30
+ dstio
31
+ end
32
+ end
33
+
34
+ class IO #:nodoc:
35
+ include IOStream
36
+ end
37
+
38
+ %w( Tempfile StringIO ).each do |klass|
39
+ if Object.const_defined? klass
40
+ Object.const_get(klass).class_eval do
41
+ include IOStream
42
+ end
43
+ end
44
+ end
45
+
46
+ # Corrects a bug in Windows when asking for Tempfile size.
47
+ if defined? Tempfile
48
+ class Tempfile
49
+ def size
50
+ if @tmpfile
51
+ @tmpfile.fsync
52
+ @tmpfile.flush
53
+ @tmpfile.stat.size
54
+ else
55
+ 0
56
+ end
57
+ end
58
+ end
59
+ end
@@ -0,0 +1,33 @@
1
+ require 'paperclip/matchers/have_attached_file_matcher'
2
+ require 'paperclip/matchers/validate_attachment_presence_matcher'
3
+ require 'paperclip/matchers/validate_attachment_content_type_matcher'
4
+ require 'paperclip/matchers/validate_attachment_size_matcher'
5
+
6
+ module Paperclip
7
+ module Shoulda
8
+ # Provides rspec-compatible matchers for testing Paperclip attachments.
9
+ #
10
+ # In spec_helper.rb, you'll need to require the matchers:
11
+ #
12
+ # require "paperclip/matchers"
13
+ #
14
+ # And include the module:
15
+ #
16
+ # Spec::Runner.configure do |config|
17
+ # config.include Paperclip::Shoulda::Matchers
18
+ # end
19
+ #
20
+ # Example:
21
+ # describe User do
22
+ # it { should have_attached_file(:avatar) }
23
+ # it { should validate_attachment_presence(:avatar) }
24
+ # it { should validate_attachment_content_type(:avatar).
25
+ # allowing('image/png', 'image/gif').
26
+ # rejecting('text/plain', 'text/xml') }
27
+ # it { should validate_attachment_size(:avatar).
28
+ # less_than(2.megabytes) }
29
+ # end
30
+ module Matchers
31
+ end
32
+ end
33
+ end
@@ -0,0 +1,57 @@
1
+ module Paperclip
2
+ module Shoulda
3
+ module Matchers
4
+ # Ensures that the given instance or class has an attachment with the
5
+ # given name.
6
+ #
7
+ # Example:
8
+ # describe User do
9
+ # it { should have_attached_file(:avatar) }
10
+ # end
11
+ def have_attached_file name
12
+ HaveAttachedFileMatcher.new(name)
13
+ end
14
+
15
+ class HaveAttachedFileMatcher
16
+ def initialize attachment_name
17
+ @attachment_name = attachment_name
18
+ end
19
+
20
+ def matches? subject
21
+ @subject = subject
22
+ @subject = @subject.class unless Class === @subject
23
+ responds? && has_column? && included?
24
+ end
25
+
26
+ def failure_message
27
+ "Should have an attachment named #{@attachment_name}"
28
+ end
29
+
30
+ def negative_failure_message
31
+ "Should not have an attachment named #{@attachment_name}"
32
+ end
33
+
34
+ def description
35
+ "have an attachment named #{@attachment_name}"
36
+ end
37
+
38
+ protected
39
+
40
+ def responds?
41
+ methods = @subject.instance_methods.map(&:to_s)
42
+ methods.include?("#{@attachment_name}") &&
43
+ methods.include?("#{@attachment_name}=") &&
44
+ methods.include?("#{@attachment_name}?")
45
+ end
46
+
47
+ def has_column?
48
+ @subject.column_names.include?("#{@attachment_name}_file_name")
49
+ end
50
+
51
+ def included?
52
+ @subject.ancestors.include?(Paperclip::InstanceMethods)
53
+ end
54
+ end
55
+ end
56
+ end
57
+ end
@@ -0,0 +1,75 @@
1
+ module Paperclip
2
+ module Shoulda
3
+ module Matchers
4
+ # Ensures that the given instance or class validates the content type of
5
+ # the given attachment as specified.
6
+ #
7
+ # Example:
8
+ # describe User do
9
+ # it { should validate_attachment_content_type(:icon).
10
+ # allowing('image/png', 'image/gif').
11
+ # rejecting('text/plain', 'text/xml') }
12
+ # end
13
+ def validate_attachment_content_type name
14
+ ValidateAttachmentContentTypeMatcher.new(name)
15
+ end
16
+
17
+ class ValidateAttachmentContentTypeMatcher
18
+ def initialize attachment_name
19
+ @attachment_name = attachment_name
20
+ end
21
+
22
+ def allowing *types
23
+ @allowed_types = types.flatten
24
+ self
25
+ end
26
+
27
+ def rejecting *types
28
+ @rejected_types = types.flatten
29
+ self
30
+ end
31
+
32
+ def matches? subject
33
+ @subject = subject
34
+ @subject = @subject.class unless Class === @subject
35
+ @allowed_types && @rejected_types &&
36
+ allowed_types_allowed? && rejected_types_rejected?
37
+ end
38
+
39
+ def failure_message
40
+ "Content types #{@allowed_types.join(", ")} should be accepted" +
41
+ " and #{@rejected_types.join(", ")} rejected by #{@attachment_name}"
42
+ end
43
+
44
+ def negative_failure_message
45
+ "Content types #{@allowed_types.join(", ")} should be rejected" +
46
+ " and #{@rejected_types.join(", ")} accepted by #{@attachment_name}"
47
+ end
48
+
49
+ def description
50
+ "validate the content types allowed on attachment #{@attachment_name}"
51
+ end
52
+
53
+ protected
54
+
55
+ def allow_types?(types)
56
+ types.all? do |type|
57
+ file = StringIO.new(".")
58
+ file.content_type = type
59
+ (subject = @subject.new).attachment_for(@attachment_name).assign(file)
60
+ subject.valid?
61
+ subject.errors[:"#{@attachment_name}_content_type"].blank?
62
+ end
63
+ end
64
+
65
+ def allowed_types_allowed?
66
+ allow_types?(@allowed_types)
67
+ end
68
+
69
+ def rejected_types_rejected?
70
+ not allow_types?(@rejected_types)
71
+ end
72
+ end
73
+ end
74
+ end
75
+ end