path-paperclip 2.3.3

Sign up to get free protection for your applications and to get access to all the features.
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
data/LICENSE ADDED
@@ -0,0 +1,26 @@
1
+
2
+ LICENSE
3
+
4
+ The MIT License
5
+
6
+ Copyright (c) 2008 Jon Yurek and thoughtbot, inc.
7
+
8
+ Permission is hereby granted, free of charge, to any person obtaining a copy
9
+ of this software and associated documentation files (the "Software"), to deal
10
+ in the Software without restriction, including without limitation the rights
11
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
12
+ copies of the Software, and to permit persons to whom the Software is
13
+ furnished to do so, subject to the following conditions:
14
+
15
+ The above copyright notice and this permission notice shall be included in
16
+ all copies or substantial portions of the Software.
17
+
18
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
19
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
20
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
21
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
22
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
23
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
24
+ THE SOFTWARE.
25
+
26
+
data/README.rdoc ADDED
@@ -0,0 +1,198 @@
1
+ =Paperclip
2
+
3
+ Paperclip is intended as an easy file attachment library for ActiveRecord. The
4
+ intent behind it was to keep setup as easy as possible and to treat files as
5
+ much like other attributes as possible. This means they aren't saved to their
6
+ final locations on disk, nor are they deleted if set to nil, until
7
+ ActiveRecord::Base#save is called. It manages validations based on size and
8
+ presence, if required. It can transform its assigned image into thumbnails if
9
+ needed, and the prerequisites are as simple as installing ImageMagick (which,
10
+ for most modern Unix-based systems, is as easy as installing the right
11
+ packages). Attached files are saved to the filesystem and referenced in the
12
+ browser by an easily understandable specification, which has sensible and
13
+ useful defaults.
14
+
15
+ See the documentation for +has_attached_file+ in Paperclip::ClassMethods for
16
+ more detailed options.
17
+
18
+ The complete RDoc[http://rdoc.info/projects/thoughtbot/paperclip] is online.
19
+
20
+ ==Quick Start
21
+
22
+ In your model:
23
+
24
+ class User < ActiveRecord::Base
25
+ has_attached_file :avatar, :styles => { :medium => "300x300>", :thumb => "100x100>" }
26
+ end
27
+
28
+ In your migrations:
29
+
30
+ class AddAvatarColumnsToUser < ActiveRecord::Migration
31
+ def self.up
32
+ add_column :users, :avatar_file_name, :string
33
+ add_column :users, :avatar_content_type, :string
34
+ add_column :users, :avatar_file_size, :integer
35
+ add_column :users, :avatar_updated_at, :datetime
36
+ end
37
+
38
+ def self.down
39
+ remove_column :users, :avatar_file_name
40
+ remove_column :users, :avatar_content_type
41
+ remove_column :users, :avatar_file_size
42
+ remove_column :users, :avatar_updated_at
43
+ end
44
+ end
45
+
46
+ In your edit and new views:
47
+
48
+ <% form_for :user, @user, :url => user_path, :html => { :multipart => true } do |form| %>
49
+ <%= form.file_field :avatar %>
50
+ <% end %>
51
+
52
+ In your controller:
53
+
54
+ def create
55
+ @user = User.create( params[:user] )
56
+ end
57
+
58
+ In your show view:
59
+
60
+ <%= image_tag @user.avatar.url %>
61
+ <%= image_tag @user.avatar.url(:medium) %>
62
+ <%= image_tag @user.avatar.url(:thumb) %>
63
+
64
+ ==Usage
65
+
66
+ The basics of paperclip are quite simple: Declare that your model has an
67
+ attachment with the has_attached_file method, and give it a name. Paperclip
68
+ will wrap up up to four attributes (all prefixed with that attachment's name,
69
+ so you can have multiple attachments per model if you wish) and give the a
70
+ friendly front end. The attributes are <attachment>_file_name,
71
+ <attachment>_file_size, <attachment>_content_type, and <attachment>_updated_at.
72
+ Only <attachment>_file_name is required for paperclip to operate. More
73
+ information about the options to has_attached_file is available in the
74
+ documentation of Paperclip::ClassMethods.
75
+
76
+ Attachments can be validated with Paperclip's validation methods,
77
+ validates_attachment_presence, validates_attachment_content_type, and
78
+ validates_attachment_size.
79
+
80
+ ==Storage
81
+
82
+ The files that are assigned as attachments are, by default, placed in the
83
+ directory specified by the :path option to has_attached_file. By default, this
84
+ location is ":rails_root/public/system/:attachment/:id/:style/:filename". This
85
+ location was chosen because on standard Capistrano deployments, the
86
+ public/system directory is symlinked to the app's shared directory, meaning it
87
+ will survive between deployments. For example, using that :path, you may have a
88
+ file at
89
+
90
+ /data/myapp/releases/20081229172410/public/system/avatars/13/small/my_pic.png
91
+
92
+ NOTE: This is a change from previous versions of Paperclip, but is overall a
93
+ safer choice for the default file store.
94
+
95
+ You may also choose to store your files using Amazon's S3 service. You can find
96
+ more information about S3 storage at the description for
97
+ Paperclip::Storage::S3.
98
+
99
+ Files on the local filesystem (and in the Rails app's public directory) will be
100
+ available to the internet at large. If you require access control, it's
101
+ possible to place your files in a different location. You will need to change
102
+ both the :path and :url options in order to make sure the files are unavailable
103
+ to the public. Both :path and :url allow the same set of interpolated
104
+ variables.
105
+
106
+ ==Post Processing
107
+
108
+ Paperclip supports an extensible selection of post-processors. When you define
109
+ a set of styles for an attachment, by default it is expected that those
110
+ "styles" are actually "thumbnails". However, you can do much more than just
111
+ thumbnail images. By defining a subclass of Paperclip::Processor, you can
112
+ perform any processing you want on the files that are attached. Any file in
113
+ your Rails app's lib/paperclip_processors directory is automatically loaded by
114
+ paperclip, allowing you to easily define custom processors. You can specify a
115
+ processor with the :processors option to has_attached_file:
116
+
117
+ has_attached_file :scan, :styles => { :text => { :quality => :better } },
118
+ :processors => [:ocr]
119
+
120
+ This would load the hypothetical class Paperclip::Ocr, which would have the
121
+ hash "{ :quality => :better }" passed to it along with the uploaded file. For
122
+ more information about defining processors, see Paperclip::Processor.
123
+
124
+ The default processor is Paperclip::Thumbnail. For backwards compatability
125
+ reasons, you can pass a single geometry string or an array containing a
126
+ geometry and a format, which the file will be converted to, like so:
127
+
128
+ has_attached_file :avatar, :styles => { :thumb => ["32x32#", :png] }
129
+
130
+ This will convert the "thumb" style to a 32x32 square in png format, regardless
131
+ of what was uploaded. If the format is not specified, it is kept the same (i.e.
132
+ jpgs will remain jpgs).
133
+
134
+ Multiple processors can be specified, and they will be invoked in the order
135
+ they are defined in the :processors array. Each successive processor will
136
+ be given the result of the previous processor's execution. All processors will
137
+ receive the same parameters, which are what you define in the :styles hash.
138
+ For example, assuming we had this definition:
139
+
140
+ has_attached_file :scan, :styles => { :text => { :quality => :better } },
141
+ :processors => [:rotator, :ocr]
142
+
143
+ then both the :rotator processor and the :ocr processor would receive the
144
+ options "{ :quality => :better }". This parameter may not mean anything to one
145
+ or more or the processors, and they are expected to ignore it.
146
+
147
+ NOTE: Because processors operate by turning the original attachment into the
148
+ styles, no processors will be run if there are no styles defined.
149
+
150
+ ==Events
151
+
152
+ Before and after the Post Processing step, Paperclip calls back to the model
153
+ with a few callbacks, allowing the model to change or cancel the processing
154
+ step. The callbacks are "before_post_process" and "after_post_process" (which
155
+ are called before and after the processing of each attachment), and the
156
+ attachment-specific "before_<attachment>_post_process" and
157
+ "after_<attachment>_post_process". The callbacks are intended to be as close to
158
+ normal ActiveRecord callbacks as possible, so if you return false (specifically
159
+ - returning nil is not the same) in a before_ filter, the post processing step
160
+ will halt. Returning false in an after_ filter will not halt anything, but you
161
+ can access the model and the attachment if necessary.
162
+
163
+ NOTE: Post processing will not even *start* if the attachment is not valid
164
+ according to the validations. Your callbacks and processors will *only* be
165
+ called with valid attachments.
166
+
167
+ ==Testing
168
+
169
+ Paperclip provides rspec-compatible matchers for testing attachments. See the
170
+ documentation on Paperclip::Shoulda::Matchers for more information.
171
+
172
+ ==Image Dimensions
173
+
174
+ If the columns _avatar__width and _avatar__height (replace _avatar_ with your model name) are present in the
175
+ database, they will be filled with the width/height of the image, respectively. You can then query the width/height
176
+ of the image with:
177
+
178
+ @user.avatar.width
179
+ @user.avatar.height
180
+
181
+ or
182
+
183
+ @user.attachment.width(:style)
184
+ @user.attachment.height(:style)
185
+
186
+ If the columns are not present or the attachment is not an image, then these will return nil.
187
+
188
+ ==Contributing
189
+
190
+ If you'd like to contribute a feature or bugfix: Thanks! To make sure your
191
+ fix/feature has a high chance of being included, please read the following
192
+ guidelines:
193
+
194
+ 1. Ask on the mailing list[http://groups.google.com/group/paperclip-plugin], or
195
+ post a new GitHub Issue[http://github.com/thoughtbot/paperclip/issues].
196
+ 2. Make sure there are tests! We will not accept any patch that is not tested.
197
+ It's a rare time when explicit tests aren't needed. If you have questions
198
+ about writing tests for paperclip, please ask the mailing list.
data/Rakefile ADDED
@@ -0,0 +1,76 @@
1
+ require 'rake'
2
+ require 'rake/testtask'
3
+ require 'rake/rdoctask'
4
+
5
+ $LOAD_PATH << File.join(File.dirname(__FILE__), 'lib')
6
+ require 'paperclip'
7
+
8
+ desc 'Default: run unit tests.'
9
+ task :default => [:clean, :test]
10
+
11
+ desc 'Test the paperclip plugin under all supported Rails versions.'
12
+ task :all do |t|
13
+ exec('rake RAILS_VERSION=2.1 && rake RAILS_VERSION=2.3 && rake RAILS_VERSION=3.0')
14
+ end
15
+
16
+ desc 'Test the paperclip plugin.'
17
+ Rake::TestTask.new(:test) do |t|
18
+ t.libs << 'lib' << 'profile'
19
+ t.pattern = 'test/**/*_test.rb'
20
+ t.verbose = true
21
+ end
22
+
23
+ desc 'Start an IRB session with all necessary files required.'
24
+ task :shell do |t|
25
+ chdir File.dirname(__FILE__)
26
+ exec 'irb -I lib/ -I lib/paperclip -r rubygems -r active_record -r tempfile -r init'
27
+ end
28
+
29
+ desc 'Generate documentation for the paperclip plugin.'
30
+ Rake::RDocTask.new(:rdoc) do |rdoc|
31
+ rdoc.rdoc_dir = 'doc'
32
+ rdoc.title = 'Paperclip'
33
+ rdoc.options << '--line-numbers' << '--inline-source'
34
+ rdoc.rdoc_files.include('README*')
35
+ rdoc.rdoc_files.include('lib/**/*.rb')
36
+ end
37
+
38
+ desc 'Update documentation on website'
39
+ task :sync_docs => 'rdoc' do
40
+ `rsync -ave ssh doc/ dev@dev.thoughtbot.com:/home/dev/www/dev.thoughtbot.com/paperclip`
41
+ end
42
+
43
+ desc 'Clean up files.'
44
+ task :clean do |t|
45
+ FileUtils.rm_rf "doc"
46
+ FileUtils.rm_rf "tmp"
47
+ FileUtils.rm_rf "pkg"
48
+ FileUtils.rm_rf "public"
49
+ FileUtils.rm "test/debug.log" rescue nil
50
+ FileUtils.rm "test/paperclip.db" rescue nil
51
+ Dir.glob("paperclip-*.gem").each{|f| FileUtils.rm f }
52
+ end
53
+
54
+ desc 'Build the gemspec.'
55
+ task :gemspec do |t|
56
+ exec 'gem build paperclip.gemspec'
57
+ end
58
+
59
+ desc "Print a list of the files to be put into the gem"
60
+ task :manifest => :clean do
61
+ spec.files.each do |file|
62
+ puts file
63
+ end
64
+ end
65
+
66
+ desc "Generate a gemspec file for GitHub"
67
+ task :gemspec => :clean do
68
+ File.open("#{spec.name}.gemspec", 'w') do |f|
69
+ f.write spec.to_ruby
70
+ end
71
+ end
72
+
73
+ desc "Build the gem into the current directory"
74
+ task :gem => :gemspec do
75
+ `gem build #{spec.name}.gemspec`
76
+ end
@@ -0,0 +1,5 @@
1
+ Usage:
2
+
3
+ script/generate paperclip Class attachment1 (attachment2 ...)
4
+
5
+ This will create a migration that will add the proper columns to your class's table.
@@ -0,0 +1,27 @@
1
+ class PaperclipGenerator < Rails::Generator::NamedBase
2
+ attr_accessor :attachments, :migration_name
3
+
4
+ def initialize(args, options = {})
5
+ super
6
+ @class_name, @attachments = args[0], args[1..-1]
7
+ end
8
+
9
+ def manifest
10
+ file_name = generate_file_name
11
+ @migration_name = file_name.camelize
12
+ record do |m|
13
+ m.migration_template "paperclip_migration.rb.erb",
14
+ File.join('db', 'migrate'),
15
+ :migration_file_name => file_name
16
+ end
17
+ end
18
+
19
+ private
20
+
21
+ def generate_file_name
22
+ names = attachments.map{|a| a.underscore }
23
+ names = names[0..-2] + ["and", names[-1]] if names.length > 1
24
+ "add_attachments_#{names.join("_")}_to_#{@class_name.underscore}"
25
+ end
26
+
27
+ end
@@ -0,0 +1,19 @@
1
+ class <%= migration_name %> < ActiveRecord::Migration
2
+ def self.up
3
+ <% attachments.each do |attachment| -%>
4
+ add_column :<%= class_name.underscore.camelize.tableize %>, :<%= attachment %>_file_name, :string
5
+ add_column :<%= class_name.underscore.camelize.tableize %>, :<%= attachment %>_content_type, :string
6
+ add_column :<%= class_name.underscore.camelize.tableize %>, :<%= attachment %>_file_size, :integer
7
+ add_column :<%= class_name.underscore.camelize.tableize %>, :<%= attachment %>_updated_at, :datetime
8
+ <% end -%>
9
+ end
10
+
11
+ def self.down
12
+ <% attachments.each do |attachment| -%>
13
+ remove_column :<%= class_name.underscore.camelize.tableize %>, :<%= attachment %>_file_name
14
+ remove_column :<%= class_name.underscore.camelize.tableize %>, :<%= attachment %>_content_type
15
+ remove_column :<%= class_name.underscore.camelize.tableize %>, :<%= attachment %>_file_size
16
+ remove_column :<%= class_name.underscore.camelize.tableize %>, :<%= attachment %>_updated_at
17
+ <% end -%>
18
+ end
19
+ end
data/init.rb ADDED
@@ -0,0 +1 @@
1
+ require File.join(File.dirname(__FILE__), "lib", "paperclip")
@@ -0,0 +1,8 @@
1
+ Description:
2
+ Explain the generator
3
+
4
+ Example:
5
+ rails generate paperclip Thing
6
+
7
+ This will create:
8
+ what/will/it/create
@@ -0,0 +1,31 @@
1
+ require 'rails/generators/active_record'
2
+
3
+ class PaperclipGenerator < ActiveRecord::Generators::Base
4
+ desc "Create a migration to add paperclip-specific fields to your model."
5
+
6
+ argument :attachment_names, :required => true, :type => :array, :desc => "The names of the attachment(s) to add.",
7
+ :banner => "attachment_one attachment_two attachment_three ..."
8
+
9
+ def self.source_root
10
+ @source_root ||= File.expand_path('../templates', __FILE__)
11
+ end
12
+
13
+ def generate_migration
14
+ migration_template "paperclip_migration.rb.erb", "db/migrate/#{migration_file_name}"
15
+ end
16
+
17
+ protected
18
+
19
+ def migration_name
20
+ "add_attachment_#{attachment_names.join("_")}_to_#{name.underscore}"
21
+ end
22
+
23
+ def migration_file_name
24
+ "#{migration_name}.rb"
25
+ end
26
+
27
+ def migration_class_name
28
+ migration_name.camelize
29
+ end
30
+
31
+ end
@@ -0,0 +1,19 @@
1
+ class <%= migration_class_name %> < ActiveRecord::Migration
2
+ def self.up
3
+ <% attachment_names.each do |attachment| -%>
4
+ add_column :<%= name.underscore.camelize.tableize %>, :<%= attachment %>_file_name, :string
5
+ add_column :<%= name.underscore.camelize.tableize %>, :<%= attachment %>_content_type, :string
6
+ add_column :<%= name.underscore.camelize.tableize %>, :<%= attachment %>_file_size, :integer
7
+ add_column :<%= name.underscore.camelize.tableize %>, :<%= attachment %>_updated_at, :datetime
8
+ <% end -%>
9
+ end
10
+
11
+ def self.down
12
+ <% attachment_names.each do |attachment| -%>
13
+ remove_column :<%= name.underscore.camelize.tableize %>, :<%= attachment %>_file_name
14
+ remove_column :<%= name.underscore.camelize.tableize %>, :<%= attachment %>_content_type
15
+ remove_column :<%= name.underscore.camelize.tableize %>, :<%= attachment %>_file_size
16
+ remove_column :<%= name.underscore.camelize.tableize %>, :<%= attachment %>_updated_at
17
+ <% end -%>
18
+ end
19
+ end
data/lib/paperclip.rb ADDED
@@ -0,0 +1,440 @@
1
+ # Paperclip allows file attachments that are stored in the filesystem. All graphical
2
+ # transformations are done using the Graphics/ImageMagick command line utilities and
3
+ # are stored in Tempfiles until the record is saved. Paperclip does not require a
4
+ # separate model for storing the attachment's information, instead adding a few simple
5
+ # columns to your table.
6
+ #
7
+ # Author:: Jon Yurek
8
+ # Copyright:: Copyright (c) 2008-2009 thoughtbot, inc.
9
+ # License:: MIT License (http://www.opensource.org/licenses/mit-license.php)
10
+ #
11
+ # Paperclip defines an attachment as any file, though it makes special considerations
12
+ # for image files. You can declare that a model has an attached file with the
13
+ # +has_attached_file+ method:
14
+ #
15
+ # class User < ActiveRecord::Base
16
+ # has_attached_file :avatar, :styles => { :thumb => "100x100" }
17
+ # end
18
+ #
19
+ # user = User.new
20
+ # user.avatar = params[:user][:avatar]
21
+ # user.avatar.url
22
+ # # => "/users/avatars/4/original_me.jpg"
23
+ # user.avatar.url(:thumb)
24
+ # # => "/users/avatars/4/thumb_me.jpg"
25
+ #
26
+ # See the +has_attached_file+ documentation for more details.
27
+
28
+ require 'erb'
29
+ require 'tempfile'
30
+ require 'mime/types'
31
+ require 'paperclip/version'
32
+ require 'paperclip/upfile'
33
+ require 'paperclip/iostream'
34
+ require 'paperclip/geometry'
35
+ require 'paperclip/processor'
36
+ require 'paperclip/thumbnail'
37
+ require 'paperclip/storage'
38
+ require 'paperclip/interpolations'
39
+ require 'paperclip/style'
40
+ require 'paperclip/attachment'
41
+ require 'paperclip/callback_compatability'
42
+ require 'paperclip/railtie'
43
+ if defined?(Rails.root) && Rails.root
44
+ Dir.glob(File.join(File.expand_path(Rails.root), "lib", "paperclip_processors", "*.rb")).each do |processor|
45
+ require processor
46
+ end
47
+ end
48
+
49
+ # Lightly hacking to allow Paperclip to operate without mime-types gem.
50
+ # Also so `rake gems:install` works.
51
+ begin
52
+ require 'mime/types'
53
+ rescue LoadError
54
+ module MIME
55
+ Types = {}
56
+ end
57
+ end
58
+
59
+ # The base module that gets included in ActiveRecord::Base. See the
60
+ # documentation for Paperclip::ClassMethods for more useful information.
61
+ module Paperclip
62
+
63
+ class << self
64
+ # Provides configurability to Paperclip. There are a number of options available, such as:
65
+ # * whiny: Will raise an error if Paperclip cannot process thumbnails of
66
+ # an uploaded image. Defaults to true.
67
+ # * log: Logs progress to the Rails log. Uses ActiveRecord's logger, so honors
68
+ # log levels, etc. Defaults to true.
69
+ # * command_path: Defines the path at which to find the command line
70
+ # programs if they are not visible to Rails the system's search path. Defaults to
71
+ # nil, which uses the first executable found in the user's search path.
72
+ # * image_magick_path: Deprecated alias of command_path.
73
+ def options
74
+ @options ||= {
75
+ :whiny => true,
76
+ :image_magick_path => nil,
77
+ :command_path => nil,
78
+ :log => true,
79
+ :log_command => true,
80
+ :swallow_stderr => true
81
+ }
82
+ end
83
+
84
+ def configure
85
+ yield(self) if block_given?
86
+ end
87
+
88
+ def path_for_command command #:nodoc:
89
+ if options[:image_magick_path]
90
+ warn("[DEPRECATION] :image_magick_path is deprecated and will be removed. Use :command_path instead")
91
+ end
92
+ path = [options[:command_path] || options[:image_magick_path], command].compact
93
+ File.join(*path)
94
+ end
95
+
96
+ def interpolates key, &block
97
+ Paperclip::Interpolations[key] = block
98
+ end
99
+
100
+ # The run method takes a command to execute and an array of parameters
101
+ # that get passed to it. The command is prefixed with the :command_path
102
+ # option from Paperclip.options. If you have many commands to run and
103
+ # they are in different paths, the suggested course of action is to
104
+ # symlink them so they are all in the same directory.
105
+ #
106
+ # If the command returns with a result code that is not one of the
107
+ # expected_outcodes, a PaperclipCommandLineError will be raised. Generally
108
+ # a code of 0 is expected, but a list of codes may be passed if necessary.
109
+ # These codes should be passed as a hash as the last argument, like so:
110
+ #
111
+ # Paperclip.run("echo", "something", :expected_outcodes => [0,1,2,3])
112
+ #
113
+ # This method can log the command being run when
114
+ # Paperclip.options[:log_command] is set to true (defaults to false). This
115
+ # will only log if logging in general is set to true as well.
116
+ def run cmd, *params
117
+ options = params.last.is_a?(Hash) ? params.pop : {}
118
+ expected_outcodes = options[:expected_outcodes] || [0]
119
+ params = quote_command_options(*params).join(" ")
120
+
121
+ command = %Q[#{path_for_command(cmd)} #{params}]
122
+ command = "#{command} 2>#{bit_bucket}" if Paperclip.options[:swallow_stderr]
123
+ Paperclip.log(command) if Paperclip.options[:log_command]
124
+
125
+ begin
126
+ output = `#{command}`
127
+
128
+ if $?
129
+ raise CommandNotFoundError if $?.exitstatus == 127
130
+
131
+ unless expected_outcodes.include?($?.exitstatus)
132
+ raise PaperclipCommandLineError,
133
+ "Error while running #{cmd}. Expected return code to be #{expected_outcodes.join(", ")} but was #{$?.exitstatus}",
134
+ output
135
+ end
136
+ end
137
+ rescue Errno::ENOENT => e
138
+ raise CommandNotFoundError
139
+ end
140
+
141
+ output
142
+ end
143
+
144
+ def quote_command_options(*options)
145
+ options.map do |option|
146
+ option.split("'").map{|m| "'#{m}'" }.join("\\'")
147
+ end
148
+ end
149
+
150
+ SIMPLE_MIME_TYPE = %r{\A([a-zA-Z0-9-]+/[a-zA-Z0-9-]+)}.freeze
151
+
152
+ # The content_type_for_file method determines the MIME type of a file
153
+ # using the `file` command. Returns nil on failure.
154
+ def content_type_for_file file
155
+ file = file.path if file.respond_to? "path"
156
+ return nil if file.nil?
157
+ begin
158
+ output = Paperclip.run("file", '--brief', '--mime', file).strip
159
+ mime_type = output.split(';').first
160
+ match = SIMPLE_MIME_TYPE.match(mime_type)
161
+ content_type = match ? match[0] : nil
162
+ rescue PaperclipCommandLineError
163
+ nil
164
+ end
165
+ end
166
+
167
+ # The extension_for_content_type method determines the best filename extension
168
+ # for a given MIME type. Returns the default first extension for the supplied
169
+ # MIME type. Returns nil on failure.
170
+ def extension_for_content_type content_type
171
+ (t = MIME::Types[content_type]) && (f = t.first) && f.extensions.first
172
+ end
173
+
174
+ def bit_bucket #:nodoc:
175
+ File.exists?("/dev/null") ? "/dev/null" : "NUL"
176
+ end
177
+
178
+ def included base #:nodoc:
179
+ base.extend ClassMethods
180
+ if base.respond_to?("set_callback")
181
+ base.send :include, Paperclip::CallbackCompatability::Rails3
182
+ else
183
+ base.send :include, Paperclip::CallbackCompatability::Rails21
184
+ end
185
+ end
186
+
187
+ def processor name #:nodoc:
188
+ name = name.to_s.camelize
189
+ processor = Paperclip.const_get(name)
190
+ unless processor.ancestors.include?(Paperclip::Processor)
191
+ raise PaperclipError.new("Processor #{name} was not found")
192
+ end
193
+ processor
194
+ end
195
+
196
+ # Log a paperclip-specific line. Uses ActiveRecord::Base.logger
197
+ # by default. Set Paperclip.options[:log] to false to turn off.
198
+ def log message
199
+ logger.info("[paperclip] #{message}") if logging?
200
+ end
201
+
202
+ def logger #:nodoc:
203
+ if defined?(ActiveRecord)
204
+ ActiveRecord::Base.logger
205
+ else
206
+ Rails.logger
207
+ end
208
+ end
209
+
210
+ def logging? #:nodoc:
211
+ options[:log]
212
+ end
213
+ end
214
+
215
+ class PaperclipError < StandardError #:nodoc:
216
+ end
217
+
218
+ class PaperclipCommandLineError < PaperclipError #:nodoc:
219
+ attr_accessor :output
220
+ def initialize(msg = nil, output = nil)
221
+ super(msg)
222
+ @output = output
223
+ end
224
+ end
225
+
226
+ class CommandNotFoundError < PaperclipError
227
+ end
228
+
229
+ class NotIdentifiedByImageMagickError < PaperclipError #:nodoc:
230
+ end
231
+
232
+ class InfiniteInterpolationError < PaperclipError #:nodoc:
233
+ end
234
+
235
+ module ClassMethods
236
+ # +has_attached_file+ gives the class it is called on an attribute that maps to a file. This
237
+ # is typically a file stored somewhere on the filesystem and has been uploaded by a user.
238
+ # The attribute returns a Paperclip::Attachment object which handles the management of
239
+ # that file. The intent is to make the attachment as much like a normal attribute. The
240
+ # thumbnails will be created when the new file is assigned, but they will *not* be saved
241
+ # until +save+ is called on the record. Likewise, if the attribute is set to +nil+ is
242
+ # called on it, the attachment will *not* be deleted until +save+ is called. See the
243
+ # Paperclip::Attachment documentation for more specifics. There are a number of options
244
+ # you can set to change the behavior of a Paperclip attachment:
245
+ # * +url+: The full URL of where the attachment is publically accessible. This can just
246
+ # as easily point to a directory served directly through Apache as it can to an action
247
+ # that can control permissions. You can specify the full domain and path, but usually
248
+ # just an absolute path is sufficient. The leading slash *must* be included manually for
249
+ # absolute paths. The default value is
250
+ # "/system/:attachment/:id/:style/:filename". See
251
+ # Paperclip::Attachment#interpolate for more information on variable interpolaton.
252
+ # :url => "/:class/:attachment/:id/:style_:filename"
253
+ # :url => "http://some.other.host/stuff/:class/:id_:extension"
254
+ # * +default_url+: The URL that will be returned if there is no attachment assigned.
255
+ # This field is interpolated just as the url is. The default value is
256
+ # "/:attachment/:style/missing.png"
257
+ # has_attached_file :avatar, :default_url => "/images/default_:style_avatar.png"
258
+ # User.new.avatar_url(:small) # => "/images/default_small_avatar.png"
259
+ # * +styles+: A hash of thumbnail styles and their geometries. You can find more about
260
+ # geometry strings at the ImageMagick website
261
+ # (http://www.imagemagick.org/script/command-line-options.php#resize). Paperclip
262
+ # also adds the "#" option (e.g. "50x50#"), which will resize the image to fit maximally
263
+ # inside the dimensions and then crop the rest off (weighted at the center). The
264
+ # default value is to generate no thumbnails.
265
+ # * +default_style+: The thumbnail style that will be used by default URLs.
266
+ # Defaults to +original+.
267
+ # has_attached_file :avatar, :styles => { :normal => "100x100#" },
268
+ # :default_style => :normal
269
+ # user.avatar.url # => "/avatars/23/normal_me.png"
270
+ # * +whiny+: Will raise an error if Paperclip cannot post_process an uploaded file due
271
+ # to a command line error. This will override the global setting for this attachment.
272
+ # Defaults to true. This option used to be called :whiny_thumbanils, but this is
273
+ # deprecated.
274
+ # * +convert_options+: When creating thumbnails, use this free-form options
275
+ # array to pass in various convert command options. Typical options are "-strip" to
276
+ # remove all Exif data from the image (save space for thumbnails and avatars) or
277
+ # "-depth 8" to specify the bit depth of the resulting conversion. See ImageMagick
278
+ # convert documentation for more options: (http://www.imagemagick.org/script/convert.php)
279
+ # Note that this option takes a hash of options, each of which correspond to the style
280
+ # of thumbnail being generated. You can also specify :all as a key, which will apply
281
+ # to all of the thumbnails being generated. If you specify options for the :original,
282
+ # it would be best if you did not specify destructive options, as the intent of keeping
283
+ # the original around is to regenerate all the thumbnails when requirements change.
284
+ # has_attached_file :avatar, :styles => { :large => "300x300", :negative => "100x100" }
285
+ # :convert_options => {
286
+ # :all => "-strip",
287
+ # :negative => "-negate"
288
+ # }
289
+ # NOTE: While not deprecated yet, it is not recommended to specify options this way.
290
+ # It is recommended that :convert_options option be included in the hash passed to each
291
+ # :styles for compatability with future versions.
292
+ # NOTE: Strings supplied to :convert_options are split on space in order to undergo
293
+ # shell quoting for safety. If your options require a space, please pre-split them
294
+ # and pass an array to :convert_options instead.
295
+ # * +storage+: Chooses the storage backend where the files will be stored. The current
296
+ # choices are :filesystem and :s3. The default is :filesystem. Make sure you read the
297
+ # documentation for Paperclip::Storage::Filesystem and Paperclip::Storage::S3
298
+ # for backend-specific options.
299
+ def has_attached_file name, options = {}
300
+ include InstanceMethods
301
+
302
+ write_inheritable_attribute(:attachment_definitions, {}) if attachment_definitions.nil?
303
+ attachment_definitions[name] = {:validations => []}.merge(options)
304
+
305
+ after_save :save_attached_files
306
+ before_destroy :destroy_attached_files
307
+
308
+ define_paperclip_callbacks :post_process, :"#{name}_post_process"
309
+
310
+ define_method name do |*args|
311
+ a = attachment_for(name)
312
+ (args.length > 0) ? a.to_s(args.first) : a
313
+ end
314
+
315
+ define_method "#{name}=" do |file|
316
+ attachment_for(name).assign(file)
317
+ end
318
+
319
+ define_method "#{name}?" do
320
+ attachment_for(name).file?
321
+ end
322
+
323
+ validates_each(name) do |record, attr, value|
324
+ attachment = record.attachment_for(name)
325
+ attachment.send(:flush_errors)
326
+ end
327
+ end
328
+
329
+ # Places ActiveRecord-style validations on the size of the file assigned. The
330
+ # possible options are:
331
+ # * +in+: a Range of bytes (i.e. +1..1.megabyte+),
332
+ # * +less_than+: equivalent to :in => 0..options[:less_than]
333
+ # * +greater_than+: equivalent to :in => options[:greater_than]..Infinity
334
+ # * +message+: error message to display, use :min and :max as replacements
335
+ # * +if+: A lambda or name of a method on the instance. Validation will only
336
+ # be run is this lambda or method returns true.
337
+ # * +unless+: Same as +if+ but validates if lambda or method returns false.
338
+ def validates_attachment_size name, options = {}
339
+ min = options[:greater_than] || (options[:in] && options[:in].first) || 0
340
+ max = options[:less_than] || (options[:in] && options[:in].last) || (1.0/0)
341
+ range = (min..max)
342
+ message = options[:message] || "file size must be between :min and :max bytes."
343
+ message = message.gsub(/:min/, min.to_s).gsub(/:max/, max.to_s)
344
+
345
+ validates_inclusion_of :"#{name}_file_size",
346
+ :in => range,
347
+ :message => message,
348
+ :if => options[:if],
349
+ :unless => options[:unless],
350
+ :allow_nil => true
351
+ end
352
+
353
+ # Adds errors if thumbnail creation fails. The same as specifying :whiny_thumbnails => true.
354
+ def validates_attachment_thumbnails name, options = {}
355
+ warn('[DEPRECATION] validates_attachment_thumbnail is deprecated. ' +
356
+ 'This validation is on by default and will be removed from future versions. ' +
357
+ 'If you wish to turn it off, supply :whiny => false in your definition.')
358
+ attachment_definitions[name][:whiny_thumbnails] = true
359
+ end
360
+
361
+ # Places ActiveRecord-style validations on the presence of a file.
362
+ # Options:
363
+ # * +if+: A lambda or name of a method on the instance. Validation will only
364
+ # be run is this lambda or method returns true.
365
+ # * +unless+: Same as +if+ but validates if lambda or method returns false.
366
+ def validates_attachment_presence name, options = {}
367
+ message = options[:message] || "must be set."
368
+ validates_presence_of :"#{name}_file_name",
369
+ :message => message,
370
+ :if => options[:if],
371
+ :unless => options[:unless]
372
+ end
373
+
374
+ # Places ActiveRecord-style validations on the content type of the file
375
+ # assigned. The possible options are:
376
+ # * +content_type+: Allowed content types. Can be a single content type
377
+ # or an array. Each type can be a String or a Regexp. It should be
378
+ # noted that Internet Explorer upload files with content_types that you
379
+ # may not expect. For example, JPEG images are given image/pjpeg and
380
+ # PNGs are image/x-png, so keep that in mind when determining how you
381
+ # match. Allows all by default.
382
+ # * +message+: The message to display when the uploaded file has an invalid
383
+ # content type.
384
+ # * +if+: A lambda or name of a method on the instance. Validation will only
385
+ # be run is this lambda or method returns true.
386
+ # * +unless+: Same as +if+ but validates if lambda or method returns false.
387
+ # NOTE: If you do not specify an [attachment]_content_type field on your
388
+ # model, content_type validation will work _ONLY upon assignment_ and
389
+ # re-validation after the instance has been reloaded will always succeed.
390
+ def validates_attachment_content_type name, options = {}
391
+ validation_options = options.dup
392
+ allowed_types = [validation_options[:content_type]].flatten
393
+ validates_each(:"#{name}_content_type", validation_options) do |record, attr, value|
394
+ if !allowed_types.any?{|t| t === value } && !(value.nil? || value.blank?)
395
+ if record.errors.method(:add).arity == -2
396
+ message = options[:message] || "is not one of #{allowed_types.join(", ")}"
397
+ record.errors.add(:"#{name}_content_type", message)
398
+ else
399
+ record.errors.add(:"#{name}_content_type", :inclusion, :default => options[:message], :value => value)
400
+ end
401
+ end
402
+ end
403
+ end
404
+
405
+ # Returns the attachment definitions defined by each call to
406
+ # has_attached_file.
407
+ def attachment_definitions
408
+ read_inheritable_attribute(:attachment_definitions)
409
+ end
410
+ end
411
+
412
+ module InstanceMethods #:nodoc:
413
+ def attachment_for name
414
+ @_paperclip_attachments ||= {}
415
+ @_paperclip_attachments[name] ||= Attachment.new(name, self, self.class.attachment_definitions[name])
416
+ end
417
+
418
+ def each_attachment
419
+ self.class.attachment_definitions.each do |name, definition|
420
+ yield(name, attachment_for(name))
421
+ end
422
+ end
423
+
424
+ def save_attached_files
425
+ Paperclip.log("Saving attachments.")
426
+ each_attachment do |name, attachment|
427
+ attachment.send(:save)
428
+ end
429
+ end
430
+
431
+ def destroy_attached_files
432
+ Paperclip.log("Deleting attachments.")
433
+ each_attachment do |name, attachment|
434
+ attachment.send(:queue_existing_for_delete)
435
+ attachment.send(:flush_deletes)
436
+ end
437
+ end
438
+ end
439
+
440
+ end