sayso-paperclip 2.3.10.001

Sign up to get free protection for your applications and to get access to all the features.
Files changed (61) hide show
  1. data/LICENSE +26 -0
  2. data/README.md +250 -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 +376 -0
  12. data/lib/paperclip/attachment.rb +378 -0
  13. data/lib/paperclip/callback_compatability.rb +61 -0
  14. data/lib/paperclip/geometry.rb +117 -0
  15. data/lib/paperclip/interpolations.rb +130 -0
  16. data/lib/paperclip/iostream.rb +45 -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 +58 -0
  23. data/lib/paperclip/railtie.rb +24 -0
  24. data/lib/paperclip/storage.rb +3 -0
  25. data/lib/paperclip/storage/filesystem.rb +73 -0
  26. data/lib/paperclip/storage/fog.rb +98 -0
  27. data/lib/paperclip/storage/s3.rb +192 -0
  28. data/lib/paperclip/style.rb +91 -0
  29. data/lib/paperclip/thumbnail.rb +81 -0
  30. data/lib/paperclip/upfile.rb +55 -0
  31. data/lib/paperclip/version.rb +3 -0
  32. data/lib/tasks/paperclip.rake +72 -0
  33. data/rails/init.rb +2 -0
  34. data/shoulda_macros/paperclip.rb +118 -0
  35. data/test/attachment_test.rb +939 -0
  36. data/test/database.yml +4 -0
  37. data/test/fixtures/12k.png +0 -0
  38. data/test/fixtures/50x50.png +0 -0
  39. data/test/fixtures/5k.png +0 -0
  40. data/test/fixtures/bad.png +1 -0
  41. data/test/fixtures/s3.yml +8 -0
  42. data/test/fixtures/text.txt +0 -0
  43. data/test/fixtures/twopage.pdf +0 -0
  44. data/test/fixtures/uppercase.PNG +0 -0
  45. data/test/fog_test.rb +107 -0
  46. data/test/geometry_test.rb +190 -0
  47. data/test/helper.rb +146 -0
  48. data/test/integration_test.rb +570 -0
  49. data/test/interpolations_test.rb +143 -0
  50. data/test/iostream_test.rb +71 -0
  51. data/test/matchers/have_attached_file_matcher_test.rb +24 -0
  52. data/test/matchers/validate_attachment_content_type_matcher_test.rb +47 -0
  53. data/test/matchers/validate_attachment_presence_matcher_test.rb +26 -0
  54. data/test/matchers/validate_attachment_size_matcher_test.rb +51 -0
  55. data/test/paperclip_test.rb +271 -0
  56. data/test/processor_test.rb +10 -0
  57. data/test/storage_test.rb +416 -0
  58. data/test/style_test.rb +163 -0
  59. data/test/thumbnail_test.rb +257 -0
  60. data/test/upfile_test.rb +36 -0
  61. metadata +203 -0
@@ -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
@@ -0,0 +1,54 @@
1
+ module Paperclip
2
+ module Shoulda
3
+ module Matchers
4
+ # Ensures that the given instance or class validates the presence of the
5
+ # given attachment.
6
+ #
7
+ # describe User do
8
+ # it { should validate_attachment_presence(:avatar) }
9
+ # end
10
+ def validate_attachment_presence name
11
+ ValidateAttachmentPresenceMatcher.new(name)
12
+ end
13
+
14
+ class ValidateAttachmentPresenceMatcher
15
+ def initialize attachment_name
16
+ @attachment_name = attachment_name
17
+ end
18
+
19
+ def matches? subject
20
+ @subject = subject
21
+ @subject = @subject.class unless Class === @subject
22
+ error_when_not_valid? && no_error_when_valid?
23
+ end
24
+
25
+ def failure_message
26
+ "Attachment #{@attachment_name} should be required"
27
+ end
28
+
29
+ def negative_failure_message
30
+ "Attachment #{@attachment_name} should not be required"
31
+ end
32
+
33
+ def description
34
+ "require presence of attachment #{@attachment_name}"
35
+ end
36
+
37
+ protected
38
+
39
+ def error_when_not_valid?
40
+ (subject = @subject.new).send(@attachment_name).assign(nil)
41
+ subject.valid?
42
+ not subject.errors[:"#{@attachment_name}_file_name"].blank?
43
+ end
44
+
45
+ def no_error_when_valid?
46
+ @file = StringIO.new(".")
47
+ (subject = @subject.new).send(@attachment_name).assign(@file)
48
+ subject.valid?
49
+ subject.errors[:"#{@attachment_name}_file_name"].blank?
50
+ end
51
+ end
52
+ end
53
+ end
54
+ end
@@ -0,0 +1,95 @@
1
+ module Paperclip
2
+ module Shoulda
3
+ module Matchers
4
+ # Ensures that the given instance or class validates the size of the
5
+ # given attachment as specified.
6
+ #
7
+ # Examples:
8
+ # it { should validate_attachment_size(:avatar).
9
+ # less_than(2.megabytes) }
10
+ # it { should validate_attachment_size(:icon).
11
+ # greater_than(1024) }
12
+ # it { should validate_attachment_size(:icon).
13
+ # in(0..100) }
14
+ def validate_attachment_size name
15
+ ValidateAttachmentSizeMatcher.new(name)
16
+ end
17
+
18
+ class ValidateAttachmentSizeMatcher
19
+ def initialize attachment_name
20
+ @attachment_name = attachment_name
21
+ @low, @high = 0, (1.0/0)
22
+ end
23
+
24
+ def less_than size
25
+ @high = size
26
+ self
27
+ end
28
+
29
+ def greater_than size
30
+ @low = size
31
+ self
32
+ end
33
+
34
+ def in range
35
+ @low, @high = range.first, range.last
36
+ self
37
+ end
38
+
39
+ def matches? subject
40
+ @subject = subject
41
+ @subject = @subject.class unless Class === @subject
42
+ lower_than_low? && higher_than_low? && lower_than_high? && higher_than_high?
43
+ end
44
+
45
+ def failure_message
46
+ "Attachment #{@attachment_name} must be between #{@low} and #{@high} bytes"
47
+ end
48
+
49
+ def negative_failure_message
50
+ "Attachment #{@attachment_name} cannot be between #{@low} and #{@high} bytes"
51
+ end
52
+
53
+ def description
54
+ "validate the size of attachment #{@attachment_name}"
55
+ end
56
+
57
+ protected
58
+
59
+ def override_method object, method, &replacement
60
+ (class << object; self; end).class_eval do
61
+ define_method(method, &replacement)
62
+ end
63
+ end
64
+
65
+ def passes_validation_with_size(new_size)
66
+ file = StringIO.new(".")
67
+ override_method(file, :size){ new_size }
68
+ override_method(file, :to_tempfile){ file }
69
+
70
+ (subject = @subject.new).send(@attachment_name).assign(file)
71
+ subject.valid?
72
+ subject.errors[:"#{@attachment_name}_file_size"].blank?
73
+ end
74
+
75
+ def lower_than_low?
76
+ not passes_validation_with_size(@low - 1)
77
+ end
78
+
79
+ def higher_than_low?
80
+ passes_validation_with_size(@low + 1)
81
+ end
82
+
83
+ def lower_than_high?
84
+ return true if @high == (1.0/0)
85
+ passes_validation_with_size(@high - 1)
86
+ end
87
+
88
+ def higher_than_high?
89
+ return true if @high == (1.0/0)
90
+ not passes_validation_with_size(@high + 1)
91
+ end
92
+ end
93
+ end
94
+ end
95
+ end
@@ -0,0 +1,58 @@
1
+ module Paperclip
2
+ # Paperclip processors allow you to modify attached files when they are
3
+ # attached in any way you are able. Paperclip itself uses command-line
4
+ # programs for its included Thumbnail processor, but custom processors
5
+ # are not required to follow suit.
6
+ #
7
+ # Processors are required to be defined inside the Paperclip module and
8
+ # are also required to be a subclass of Paperclip::Processor. There is
9
+ # only one method you *must* implement to properly be a subclass:
10
+ # #make, but #initialize may also be of use. Both methods accept 3
11
+ # arguments: the file that will be operated on (which is an instance of
12
+ # File), a hash of options that were defined in has_attached_file's
13
+ # style hash, and the Paperclip::Attachment itself.
14
+ #
15
+ # All #make needs to return is an instance of File (Tempfile is
16
+ # acceptable) which contains the results of the processing.
17
+ #
18
+ # See Paperclip.run for more information about using command-line
19
+ # utilities from within Processors.
20
+ class Processor
21
+ attr_accessor :file, :options, :attachment
22
+
23
+ def initialize file, options = {}, attachment = nil
24
+ @file = file
25
+ @options = options
26
+ @attachment = attachment
27
+ end
28
+
29
+ def make
30
+ end
31
+
32
+ def self.make file, options = {}, attachment = nil
33
+ new(file, options, attachment).make
34
+ end
35
+ end
36
+
37
+ # Due to how ImageMagick handles its image format conversion and how Tempfile
38
+ # handles its naming scheme, it is necessary to override how Tempfile makes
39
+ # its names so as to allow for file extensions. Idea taken from the comments
40
+ # on this blog post:
41
+ # http://marsorange.com/archives/of-mogrify-ruby-tempfile-dynamic-class-definitions
42
+ class Tempfile < ::Tempfile
43
+ # This is Ruby 1.8.7's implementation.
44
+ if RUBY_VERSION <= "1.8.6"
45
+ def make_tmpname(basename, n)
46
+ case basename
47
+ when Array
48
+ prefix, suffix = *basename
49
+ else
50
+ prefix, suffix = basename, ''
51
+ end
52
+
53
+ t = Time.now.strftime("%y%m%d")
54
+ path = "#{prefix}#{t}-#{$$}-#{rand(0x100000000).to_s(36)}-#{n}#{suffix}"
55
+ end
56
+ end
57
+ end
58
+ end
@@ -0,0 +1,24 @@
1
+ require 'paperclip'
2
+
3
+ module Paperclip
4
+ if defined? Rails::Railtie
5
+ require 'rails'
6
+ class Railtie < Rails::Railtie
7
+ initializer 'paperclip.insert_into_active_record' do
8
+ ActiveSupport.on_load :active_record do
9
+ Paperclip::Railtie.insert
10
+ end
11
+ end
12
+ rake_tasks do
13
+ load "tasks/paperclip.rake"
14
+ end
15
+ end
16
+ end
17
+
18
+ class Railtie
19
+ def self.insert
20
+ ActiveRecord::Base.send(:include, Paperclip::Glue)
21
+ File.send(:include, Paperclip::Upfile)
22
+ end
23
+ end
24
+ end
@@ -0,0 +1,3 @@
1
+ require "paperclip/storage/filesystem"
2
+ require "paperclip/storage/fog"
3
+ require "paperclip/storage/s3"
@@ -0,0 +1,73 @@
1
+ module Paperclip
2
+ module Storage
3
+ # The default place to store attachments is in the filesystem. Files on the local
4
+ # filesystem can be very easily served by Apache without requiring a hit to your app.
5
+ # They also can be processed more easily after they've been saved, as they're just
6
+ # normal files. There is one Filesystem-specific option for has_attached_file.
7
+ # * +path+: The location of the repository of attachments on disk. This can (and, in
8
+ # almost all cases, should) be coordinated with the value of the +url+ option to
9
+ # allow files to be saved into a place where Apache can serve them without
10
+ # hitting your app. Defaults to
11
+ # ":rails_root/public/:attachment/:id/:style/:basename.:extension"
12
+ # By default this places the files in the app's public directory which can be served
13
+ # directly. If you are using capistrano for deployment, a good idea would be to
14
+ # make a symlink to the capistrano-created system directory from inside your app's
15
+ # public directory.
16
+ # See Paperclip::Attachment#interpolate for more information on variable interpolaton.
17
+ # :path => "/var/app/attachments/:class/:id/:style/:basename.:extension"
18
+ module Filesystem
19
+ def self.extended base
20
+ end
21
+
22
+ def exists?(style_name = default_style)
23
+ if original_filename
24
+ File.exist?(path(style_name))
25
+ else
26
+ false
27
+ end
28
+ end
29
+
30
+ # Returns representation of the data of the file assigned to the given
31
+ # style, in the format most representative of the current storage.
32
+ def to_file style_name = default_style
33
+ @queued_for_write[style_name] || (File.new(path(style_name), 'rb') if exists?(style_name))
34
+ end
35
+
36
+ def flush_writes #:nodoc:
37
+ @queued_for_write.each do |style_name, file|
38
+ file.close
39
+ FileUtils.mkdir_p(File.dirname(path(style_name)))
40
+ log("saving #{path(style_name)}")
41
+ FileUtils.mv(file.path, path(style_name))
42
+ FileUtils.chmod(0644, path(style_name))
43
+ end
44
+ @queued_for_write = {}
45
+ end
46
+
47
+ def flush_deletes #:nodoc:
48
+ @queued_for_delete.each do |path|
49
+ begin
50
+ log("deleting #{path}")
51
+ FileUtils.rm(path) if File.exist?(path)
52
+ rescue Errno::ENOENT => e
53
+ # ignore file-not-found, let everything else pass
54
+ end
55
+ begin
56
+ while(true)
57
+ path = File.dirname(path)
58
+ FileUtils.rmdir(path)
59
+ break if File.exists?(path) # Ruby 1.9.2 does not raise if the removal failed.
60
+ end
61
+ rescue Errno::EEXIST, Errno::ENOTEMPTY, Errno::ENOENT, Errno::EINVAL, Errno::ENOTDIR
62
+ # Stop trying to remove parent directories
63
+ rescue SystemCallError => e
64
+ log("There was an unexpected error while deleting directories: #{e.class}")
65
+ # Ignore it
66
+ end
67
+ end
68
+ @queued_for_delete = []
69
+ end
70
+ end
71
+
72
+ end
73
+ end
@@ -0,0 +1,98 @@
1
+ module Paperclip
2
+ module Storage
3
+
4
+ module Fog
5
+ def self.extended base
6
+ begin
7
+ require 'fog'
8
+ rescue LoadError => e
9
+ e.message << " (You may need to install the fog gem)"
10
+ raise e
11
+ end unless defined?(Fog)
12
+
13
+ base.instance_eval do
14
+ @fog_directory = @options[:fog_directory]
15
+ @fog_credentials = @options[:fog_credentials]
16
+ @fog_host = @options[:fog_host]
17
+ @fog_public = @options[:fog_public]
18
+
19
+ @url = ':fog_public_url'
20
+ Paperclip.interpolates(:fog_public_url) do |attachment, style|
21
+ attachment.public_url(style)
22
+ end unless Paperclip::Interpolations.respond_to? :fog_public_url
23
+ end
24
+ end
25
+
26
+ def exists?(style = default_style)
27
+ if original_filename
28
+ !!directory.files.head(path(style))
29
+ else
30
+ false
31
+ end
32
+ end
33
+
34
+ def flush_writes
35
+ for style, file in @queued_for_write do
36
+ log("saving #{path(style)}")
37
+ directory.files.create(
38
+ :body => file,
39
+ :key => path(style),
40
+ :public => @fog_public
41
+ )
42
+ end
43
+ @queued_for_write = {}
44
+ end
45
+
46
+ def flush_deletes
47
+ for path in @queued_for_delete do
48
+ log("deleting #{path}")
49
+ directory.files.new(:key => path).destroy
50
+ end
51
+ @queued_for_delete = []
52
+ end
53
+
54
+ # Returns representation of the data of the file assigned to the given
55
+ # style, in the format most representative of the current storage.
56
+ def to_file(style = default_style)
57
+ if @queued_for_write[style]
58
+ @queued_for_write[style]
59
+ else
60
+ body = directory.files.get(path(style)).body
61
+ filename = path(style)
62
+ extname = File.extname(filename)
63
+ basename = File.basename(filename, extname)
64
+ file = Tempfile.new([basename, extname])
65
+ file.binmode
66
+ file.write(body)
67
+ file.rewind
68
+ file
69
+ end
70
+ end
71
+
72
+ def public_url(style = default_style)
73
+ if @fog_host
74
+ "#{@fog_host}/#{path(style)}"
75
+ else
76
+ directory.files.new(:key => path(style)).public_url
77
+ end
78
+ end
79
+
80
+ private
81
+
82
+ def connection
83
+ @connection ||= ::Fog::Storage.new(@fog_credentials)
84
+ end
85
+
86
+ def directory
87
+ @directory ||= begin
88
+ connection.directories.get(@fog_directory) || connection.directories.create(
89
+ :key => @fog_directory,
90
+ :public => @fog_public
91
+ )
92
+ end
93
+ end
94
+
95
+ end
96
+
97
+ end
98
+ end