ryansch-paperclip 2.3.10

Sign up to get free protection for your applications and to get access to all the features.
Files changed (63) hide show
  1. data/LICENSE +26 -0
  2. data/README.md +239 -0
  3. data/Rakefile +80 -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 +384 -0
  12. data/lib/paperclip/attachment.rb +378 -0
  13. data/lib/paperclip/callback_compatability.rb +61 -0
  14. data/lib/paperclip/command_line.rb +86 -0
  15. data/lib/paperclip/geometry.rb +115 -0
  16. data/lib/paperclip/interpolations.rb +130 -0
  17. data/lib/paperclip/iostream.rb +45 -0
  18. data/lib/paperclip/matchers.rb +33 -0
  19. data/lib/paperclip/matchers/have_attached_file_matcher.rb +57 -0
  20. data/lib/paperclip/matchers/validate_attachment_content_type_matcher.rb +75 -0
  21. data/lib/paperclip/matchers/validate_attachment_presence_matcher.rb +54 -0
  22. data/lib/paperclip/matchers/validate_attachment_size_matcher.rb +95 -0
  23. data/lib/paperclip/processor.rb +58 -0
  24. data/lib/paperclip/railtie.rb +24 -0
  25. data/lib/paperclip/storage.rb +3 -0
  26. data/lib/paperclip/storage/filesystem.rb +74 -0
  27. data/lib/paperclip/storage/fog.rb +98 -0
  28. data/lib/paperclip/storage/s3.rb +192 -0
  29. data/lib/paperclip/style.rb +91 -0
  30. data/lib/paperclip/thumbnail.rb +79 -0
  31. data/lib/paperclip/upfile.rb +55 -0
  32. data/lib/paperclip/version.rb +3 -0
  33. data/lib/tasks/paperclip.rake +72 -0
  34. data/rails/init.rb +2 -0
  35. data/shoulda_macros/paperclip.rb +118 -0
  36. data/test/attachment_test.rb +939 -0
  37. data/test/command_line_test.rb +138 -0
  38. data/test/database.yml +4 -0
  39. data/test/fixtures/12k.png +0 -0
  40. data/test/fixtures/50x50.png +0 -0
  41. data/test/fixtures/5k.png +0 -0
  42. data/test/fixtures/bad.png +1 -0
  43. data/test/fixtures/s3.yml +8 -0
  44. data/test/fixtures/text.txt +0 -0
  45. data/test/fixtures/twopage.pdf +0 -0
  46. data/test/fixtures/uppercase.PNG +0 -0
  47. data/test/fog_test.rb +107 -0
  48. data/test/geometry_test.rb +177 -0
  49. data/test/helper.rb +146 -0
  50. data/test/integration_test.rb +570 -0
  51. data/test/interpolations_test.rb +143 -0
  52. data/test/iostream_test.rb +71 -0
  53. data/test/matchers/have_attached_file_matcher_test.rb +24 -0
  54. data/test/matchers/validate_attachment_content_type_matcher_test.rb +47 -0
  55. data/test/matchers/validate_attachment_presence_matcher_test.rb +26 -0
  56. data/test/matchers/validate_attachment_size_matcher_test.rb +51 -0
  57. data/test/paperclip_test.rb +306 -0
  58. data/test/processor_test.rb +10 -0
  59. data/test/storage_test.rb +416 -0
  60. data/test/style_test.rb +163 -0
  61. data/test/thumbnail_test.rb +227 -0
  62. data/test/upfile_test.rb +36 -0
  63. metadata +233 -0
@@ -0,0 +1,61 @@
1
+ module Paperclip
2
+ module CallbackCompatability
3
+ module Rails21
4
+ def self.included(base)
5
+ base.extend(Defining)
6
+ base.send(:include, Running)
7
+ end
8
+
9
+ module Defining
10
+ def define_paperclip_callbacks(*args)
11
+ args.each do |callback|
12
+ define_callbacks("before_#{callback}")
13
+ define_callbacks("after_#{callback}")
14
+ end
15
+ end
16
+ end
17
+
18
+ module Running
19
+ def run_paperclip_callbacks(callback, opts = nil, &blk)
20
+ # The overall structure of this isn't ideal since after callbacks run even if
21
+ # befores return false. But this is how rails 3's callbacks work, unfortunately.
22
+ if run_callbacks(:"before_#{callback}"){ |result, object| result == false } != false
23
+ blk.call
24
+ end
25
+ run_callbacks(:"after_#{callback}"){ |result, object| result == false }
26
+ end
27
+ end
28
+ end
29
+
30
+ module Rails3
31
+ def self.included(base)
32
+ base.extend(Defining)
33
+ base.send(:include, Running)
34
+ end
35
+
36
+ module Defining
37
+ def define_paperclip_callbacks(*callbacks)
38
+ define_callbacks *[callbacks, {:terminator => "result == false"}].flatten
39
+ callbacks.each do |callback|
40
+ eval <<-end_callbacks
41
+ def before_#{callback}(*args, &blk)
42
+ set_callback(:#{callback}, :before, *args, &blk)
43
+ end
44
+ def after_#{callback}(*args, &blk)
45
+ set_callback(:#{callback}, :after, *args, &blk)
46
+ end
47
+ end_callbacks
48
+ end
49
+ end
50
+ end
51
+
52
+ module Running
53
+ def run_paperclip_callbacks(callback, opts = nil, &block)
54
+ run_callbacks(callback, opts, &block)
55
+ end
56
+ end
57
+
58
+ end
59
+
60
+ end
61
+ end
@@ -0,0 +1,86 @@
1
+ module Paperclip
2
+ class CommandLine
3
+ class << self
4
+ attr_accessor :path
5
+ end
6
+
7
+ def initialize(binary, params = "", options = {})
8
+ @binary = binary.dup
9
+ @params = params.dup
10
+ @options = options.dup
11
+ @swallow_stderr = @options.has_key?(:swallow_stderr) ? @options.delete(:swallow_stderr) : Paperclip.options[:swallow_stderr]
12
+ @expected_outcodes = @options.delete(:expected_outcodes)
13
+ @expected_outcodes ||= [0]
14
+ end
15
+
16
+ def command
17
+ cmd = []
18
+ cmd << full_path(@binary)
19
+ cmd << interpolate(@params, @options)
20
+ cmd << bit_bucket if @swallow_stderr
21
+ cmd.join(" ")
22
+ end
23
+
24
+ def run
25
+ Paperclip.log(command)
26
+ begin
27
+ output = self.class.send(:'`', command)
28
+ rescue Errno::ENOENT
29
+ raise Paperclip::CommandNotFoundError
30
+ end
31
+ if $?.exitstatus == 127
32
+ raise Paperclip::CommandNotFoundError
33
+ end
34
+ unless @expected_outcodes.include?($?.exitstatus)
35
+ raise Paperclip::PaperclipCommandLineError, "Command '#{command}' returned #{$?.exitstatus}. Expected #{@expected_outcodes.join(", ")}"
36
+ end
37
+ output
38
+ end
39
+
40
+ private
41
+
42
+ def full_path(binary)
43
+ [self.class.path, binary].compact.join("/")
44
+ end
45
+
46
+ def interpolate(pattern, vars)
47
+ # interpolates :variables and :{variables}
48
+ pattern.gsub(%r#:(?:\w+|\{\w+\})#) do |match|
49
+ key = match[1..-1]
50
+ key = key[1..-2] if key[0,1] == '{'
51
+ if invalid_variables.include?(key)
52
+ raise PaperclipCommandLineError,
53
+ "Interpolation of #{key} isn't allowed."
54
+ end
55
+ interpolation(vars, key) || match
56
+ end
57
+ end
58
+
59
+ def invalid_variables
60
+ %w(expected_outcodes swallow_stderr)
61
+ end
62
+
63
+ def interpolation(vars, key)
64
+ if vars.key?(key.to_sym)
65
+ shell_quote(vars[key.to_sym])
66
+ end
67
+ end
68
+
69
+ def shell_quote(string)
70
+ return "" if string.nil? or string.blank?
71
+ if self.class.unix?
72
+ string.split("'").map{|m| "'#{m}'" }.join("\\'")
73
+ else
74
+ %{"#{string}"}
75
+ end
76
+ end
77
+
78
+ def bit_bucket
79
+ self.class.unix? ? "2>/dev/null" : "2>NUL"
80
+ end
81
+
82
+ def self.unix?
83
+ File.exist?("/dev/null")
84
+ end
85
+ end
86
+ 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", "-format %wx%h :file", :file => "#{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
@@ -0,0 +1,130 @@
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
+ RIGHT_HERE = "#{__FILE__.gsub(%r{^\./}, "")}:#{__LINE__ + 3}"
45
+ def url attachment, style_name
46
+ raise InfiniteInterpolationError if caller.any?{|b| b.index(RIGHT_HERE) }
47
+ attachment.url(style_name, false)
48
+ end
49
+
50
+ # Returns the timestamp as defined by the <attachment>_updated_at field
51
+ # in the server default time zone unless :use_global_time_zone is set
52
+ # to false. Note that a Rails.config.time_zone change will still
53
+ # invalidate any path or URL that uses :timestamp. For a
54
+ # time_zone-agnostic timestamp, use #updated_at.
55
+ def timestamp attachment, style_name
56
+ attachment.instance_read(:updated_at).in_time_zone(attachment.time_zone).to_s
57
+ end
58
+
59
+ # Returns an integer timestamp that is time zone-neutral, so that paths
60
+ # remain valid even if a server's time zone changes.
61
+ def updated_at attachment, style_name
62
+ attachment.updated_at
63
+ end
64
+
65
+ # Returns the Rails.root constant.
66
+ def rails_root attachment, style_name
67
+ Rails.root
68
+ end
69
+
70
+ # Returns the Rails.env constant.
71
+ def rails_env attachment, style_name
72
+ Rails.env
73
+ end
74
+
75
+ # Returns the underscored, pluralized version of the class name.
76
+ # e.g. "users" for the User class.
77
+ # NOTE: The arguments need to be optional, because some tools fetch
78
+ # all class names. Calling #class will return the expected class.
79
+ def class attachment = nil, style_name = nil
80
+ return super() if attachment.nil? && style_name.nil?
81
+ attachment.instance.class.to_s.underscore.pluralize
82
+ end
83
+
84
+ # Returns the basename of the file. e.g. "file" for "file.jpg"
85
+ def basename attachment, style_name
86
+ attachment.original_filename.gsub(/#{File.extname(attachment.original_filename)}$/, "")
87
+ end
88
+
89
+ # Returns the extension of the file. e.g. "jpg" for "file.jpg"
90
+ # If the style has a format defined, it will return the format instead
91
+ # of the actual extension.
92
+ def extension attachment, style_name
93
+ ((style = attachment.styles[style_name]) && style[:format]) ||
94
+ File.extname(attachment.original_filename).gsub(/^\.+/, "")
95
+ end
96
+
97
+ # Returns the id of the instance.
98
+ def id attachment, style_name
99
+ attachment.instance.id
100
+ end
101
+
102
+ # Returns the fingerprint of the instance.
103
+ def fingerprint attachment, style_name
104
+ attachment.fingerprint
105
+ end
106
+
107
+ # Returns a the attachment hash. See Paperclip::Attachment#hash for
108
+ # more details.
109
+ def hash attachment, style_name
110
+ attachment.hash(style_name)
111
+ end
112
+
113
+ # Returns the id of the instance in a split path form. e.g. returns
114
+ # 000/001/234 for an id of 1234.
115
+ def id_partition attachment, style_name
116
+ ("%09d" % attachment.instance.id).scan(/\d{3}/).join("/")
117
+ end
118
+
119
+ # Returns the pluralized form of the attachment name. e.g.
120
+ # "avatars" for an attachment of :avatar
121
+ def attachment attachment, style_name
122
+ attachment.name.to_s.downcase.pluralize
123
+ end
124
+
125
+ # Returns the style, or the default style if nil is supplied.
126
+ def style attachment, style_name
127
+ style_name || attachment.default_style
128
+ end
129
+ end
130
+ end
@@ -0,0 +1,45 @@
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
+ # Returns a Tempfile containing the contents of the readable object.
5
+ def to_tempfile(object)
6
+ return object.to_tempfile if object.respond_to?(:to_tempfile)
7
+ name = object.respond_to?(:original_filename) ? object.original_filename : (object.respond_to?(:path) ? object.path : "stream")
8
+ tempfile = Paperclip::Tempfile.new(["stream", File.extname(name)])
9
+ tempfile.binmode
10
+ stream_to(object, 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. Returns a File if a String is passed
15
+ # in as the destination and returns the IO or Tempfile as passed in if one is sent as the destination.
16
+ def stream_to object, path_or_file, in_blocks_of = 8192
17
+ dstio = case path_or_file
18
+ when String then File.new(path_or_file, "wb+")
19
+ when IO then path_or_file
20
+ when Tempfile then path_or_file
21
+ end
22
+ buffer = ""
23
+ object.rewind
24
+ while object.read(in_blocks_of, buffer) do
25
+ dstio.write(buffer)
26
+ end
27
+ dstio.rewind
28
+ dstio
29
+ end
30
+ end
31
+
32
+ # Corrects a bug in Windows when asking for Tempfile size.
33
+ if defined? Tempfile
34
+ class Tempfile
35
+ def size
36
+ if @tmpfile
37
+ @tmpfile.fsync
38
+ @tmpfile.flush
39
+ @tmpfile.stat.size
40
+ else
41
+ 0
42
+ end
43
+ end
44
+ end
45
+ 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