betelgeuse-paperclip 2.2.8.1

Sign up to get free protection for your applications and to get access to all the features.
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
+
@@ -0,0 +1,172 @@
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
+ ==Quick Start
19
+
20
+ In your model:
21
+
22
+ class User < ActiveRecord::Base
23
+ has_attached_file :avatar, :styles => { :medium => "300x300>", :thumb => "100x100>" }
24
+ end
25
+
26
+ In your migrations:
27
+
28
+ class AddAvatarColumnsToUser < ActiveRecord::Migration
29
+ def self.up
30
+ add_column :users, :avatar_file_name, :string
31
+ add_column :users, :avatar_content_type, :string
32
+ add_column :users, :avatar_file_size, :integer
33
+ add_column :users, :avatar_updated_at, :datetime
34
+ end
35
+
36
+ def self.down
37
+ remove_column :users, :avatar_file_name
38
+ remove_column :users, :avatar_content_type
39
+ remove_column :users, :avatar_file_size
40
+ remove_column :users, :avatar_updated_at
41
+ end
42
+ end
43
+
44
+ In your edit and new views:
45
+
46
+ <% form_for :user, @user, :url => user_path, :html => { :multipart => true } do |form| %>
47
+ <%= form.file_field :avatar %>
48
+ <% end %>
49
+
50
+ In your controller:
51
+
52
+ def create
53
+ @user = User.create( params[:user] )
54
+ end
55
+
56
+ In your show view:
57
+
58
+ <%= image_tag @user.avatar.url %>
59
+ <%= image_tag @user.avatar.url(:medium) %>
60
+ <%= image_tag @user.avatar.url(:thumb) %>
61
+
62
+ ==Usage
63
+
64
+ The basics of paperclip are quite simple: Declare that your model has an
65
+ attachment with the has_attached_file method, and give it a name. Paperclip
66
+ will wrap up up to four attributes (all prefixed with that attachment's name,
67
+ so you can have multiple attachments per model if you wish) and give the a
68
+ friendly front end. The attributes are <attachment>_file_name,
69
+ <attachment>_file_size, <attachment>_content_type, and <attachment>_updated_at.
70
+ Only <attachment>_file_name is required for paperclip to operate. More
71
+ information about the options to has_attached_file is available in the
72
+ documentation of Paperclip::ClassMethods.
73
+
74
+ Attachments can be validated with Paperclip's validation methods,
75
+ validates_attachment_presence, validates_attachment_content_type, and
76
+ validates_attachment_size.
77
+
78
+ ==Storage
79
+
80
+ The files that are assigned as attachments are, by default, placed in the
81
+ directory specified by the :path option to has_attached_file. By default, this
82
+ location is
83
+ ":rails_root/public/system/:attachment/:id/:style/:basename.:extension". This
84
+ location was chosen because on standard Capistrano deployments, the
85
+ public/system directory is symlinked to the app's shared directory, meaning it
86
+ will survive between deployments. For example, using that :path, you may have a
87
+ file at
88
+
89
+ /data/myapp/releases/20081229172410/public/system/avatars/13/small/my_pic.png
90
+
91
+ NOTE: This is a change from previous versions of Paperclip, but is overall a
92
+ safer choice for the defaul file store.
93
+
94
+ You may also choose to store your files using Amazon's S3 service. You can find
95
+ more information about S3 storage at the description for
96
+ Paperclip::Storage::S3.
97
+
98
+ Files on the local filesystem (and in the Rails app's public directory) will be
99
+ available to the internet at large. If you require access control, it's
100
+ possible to place your files in a different location. You will need to change
101
+ both the :path and :url options in order to make sure the files are unavailable
102
+ to the public. Both :path and :url allow the same set of interpolated
103
+ variables.
104
+
105
+ ==Post Processing
106
+
107
+ Paperclip supports an extendible selection of post-processors. When you define
108
+ a set of styles for an attachment, by default it is expected that those
109
+ "styles" are actually "thumbnails". However, you can do more than just
110
+ thumbnail images. By defining a subclass of Paperclip::Processor, you can
111
+ perform any processing you want on the files that are attached. Any file in
112
+ your Rails app's lib/paperclip_processors directory is automatically loaded by
113
+ paperclip, allowing you to easily define custom processors. You can specify a
114
+ processor with the :processors option to has_attached_file:
115
+
116
+ has_attached_file :scan, :styles => { :text => { :quality => :better } },
117
+ :processors => [:ocr]
118
+
119
+ This would load the hypothetical class Paperclip::Ocr, which would have the
120
+ hash "{ :quality => :better }" passed to it along with the uploaded file. For
121
+ more information about defining processors, see Paperclip::Processor.
122
+
123
+ The default processor is Paperclip::Thumbnail. For backwards compatability
124
+ reasons, you can pass a single geometry string or an array containing a
125
+ geometry and a format, which the file will be converted to, like so:
126
+
127
+ has_attached_file :avatar, :styles => { :thumb => ["32x32#", :png] }
128
+
129
+ This will convert the "thumb" style to a 32x32 square in png format, regardless
130
+ of what was uploaded. If the format is not specified, it is kept the same (i.e.
131
+ jpgs will remain jpgs).
132
+
133
+ Multiple processors can be specified, and they will be invoked in the order
134
+ they are defined in the :processors array. Each successive processor will
135
+ be given the result of the previous processor's execution. All processors will
136
+ receive the same parameters, which are what you define in the :styles hash.
137
+ For example, assuming we had this definition:
138
+
139
+ has_attached_file :scan, :styles => { :text => { :quality => :better } },
140
+ :processors => [:rotator, :ocr]
141
+
142
+ then both the :rotator processor and the :ocr processor would receive the
143
+ options "{ :quality => :better }". This parameter may not mean anything to one
144
+ or more or the processors, and they are free to ignore it.
145
+
146
+ ==Events
147
+
148
+ Before and after the Post Processing step, Paperclip calls back to the model
149
+ with a few callbacks, allowing the model to change or cancel the processing
150
+ step. The callbacks are "before_post_process" and "after_post_process" (which
151
+ are called before and after the processing of each attachment), and the
152
+ attachment-specific "before_<attachment>_post_process" and
153
+ "after_<attachment>_post_process". The callbacks are intended to be as close to
154
+ normal ActiveRecord callbacks as possible, so if you return false (specifically
155
+ - returning nil is not the same) in a before_ filter, the post processing step
156
+ will halt. Returning false in an after_ filter will not halt anything, but you
157
+ can access the model and the attachment if necessary.
158
+
159
+ NOTE: Post processing will not even *start* if the attachment is not valid
160
+ according to the validations. Your callbacks (and processors) will only be
161
+ called with valid attachments.
162
+
163
+ ==Contributing
164
+
165
+ If you'd like to contribute a feature or bugfix: Thanks! To make sure your
166
+ fix/feature has a high chance of being included, please read the following
167
+ guidelines:
168
+
169
+ 1. Ask on the mailing list, or post a ticket in Lighthouse.
170
+ 2. Make sure there are tests! We will not accept any patch that is not tested.
171
+ It's a rare time when explicit tests aren't needed. If you have questions
172
+ about writing tests for paperclip, please ask the mailing list.
@@ -0,0 +1,77 @@
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.'
12
+ Rake::TestTask.new(:test) do |t|
13
+ t.libs << 'lib' << 'profile'
14
+ t.pattern = 'test/**/*_test.rb'
15
+ t.verbose = true
16
+ end
17
+
18
+ desc 'Start an IRB session with all necessary files required.'
19
+ task :shell do |t|
20
+ chdir File.dirname(__FILE__)
21
+ exec 'irb -I lib/ -I lib/paperclip -r rubygems -r active_record -r tempfile -r init'
22
+ end
23
+
24
+ desc 'Generate documentation for the paperclip plugin.'
25
+ Rake::RDocTask.new(:rdoc) do |rdoc|
26
+ rdoc.rdoc_dir = 'doc'
27
+ rdoc.title = 'Paperclip'
28
+ rdoc.options << '--line-numbers' << '--inline-source'
29
+ rdoc.rdoc_files.include('README*')
30
+ rdoc.rdoc_files.include('lib/**/*.rb')
31
+ end
32
+
33
+ desc 'Update documentation on website'
34
+ task :sync_docs => 'rdoc' do
35
+ `rsync -ave ssh doc/ dev@dev.thoughtbot.com:/home/dev/www/dev.thoughtbot.com/paperclip`
36
+ end
37
+
38
+ desc 'Clean up files.'
39
+ task :clean do |t|
40
+ FileUtils.rm_rf "doc"
41
+ FileUtils.rm_rf "tmp"
42
+ FileUtils.rm_rf "pkg"
43
+ FileUtils.rm "test/debug.log" rescue nil
44
+ FileUtils.rm "test/paperclip.db" rescue nil
45
+ end
46
+
47
+ spec = Gem::Specification.new do |s|
48
+ s.name = "paperclip"
49
+ s.version = Paperclip::VERSION
50
+ s.author = "Jon Yurek"
51
+ s.email = "jyurek@thoughtbot.com"
52
+ s.homepage = "http://www.thoughtbot.com/projects/paperclip"
53
+ s.platform = Gem::Platform::RUBY
54
+ s.summary = "File attachments as attributes for ActiveRecord"
55
+ s.files = FileList["README*",
56
+ "LICENSE",
57
+ "Rakefile",
58
+ "init.rb",
59
+ "{generators,lib,tasks,test,shoulda_macros}/**/*"].to_a
60
+ s.require_path = "lib"
61
+ s.test_files = FileList["test/**/test_*.rb"].to_a
62
+ s.rubyforge_project = "paperclip"
63
+ s.has_rdoc = true
64
+ s.extra_rdoc_files = FileList["README*"].to_a
65
+ s.rdoc_options << '--line-numbers' << '--inline-source'
66
+ s.requirements << "ImageMagick"
67
+ s.add_runtime_dependency 'right_aws'
68
+ s.add_development_dependency 'thoughtbot-shoulda'
69
+ s.add_development_dependency 'mocha'
70
+ end
71
+
72
+ desc "Generate a gemspec file for GitHub"
73
+ task :gemspec do
74
+ File.open("#{spec.name}.gemspec", 'w') do |f|
75
+ f.write spec.to_ruby
76
+ end
77
+ 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,351 @@
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 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 'tempfile'
29
+ require 'paperclip/upfile'
30
+ require 'paperclip/iostream'
31
+ require 'paperclip/geometry'
32
+ require 'paperclip/processor'
33
+ require 'paperclip/thumbnail'
34
+ require 'paperclip/storage'
35
+ require 'paperclip/attachment'
36
+ if defined? RAILS_ROOT
37
+ Dir.glob(File.join(File.expand_path(RAILS_ROOT), "lib", "paperclip_processors", "*.rb")).each do |processor|
38
+ require processor
39
+ end
40
+ end
41
+
42
+ # The base module that gets included in ActiveRecord::Base. See the
43
+ # documentation for Paperclip::ClassMethods for more useful information.
44
+ module Paperclip
45
+
46
+ VERSION = "2.2.8"
47
+
48
+ class << self
49
+ # Provides configurability to Paperclip. There are a number of options available, such as:
50
+ # * whiny_thumbnails: Will raise an error if Paperclip cannot process thumbnails of
51
+ # an uploaded image. Defaults to true.
52
+ # * log: Logs progress to the Rails log. Uses ActiveRecord's logger, so honors
53
+ # log levels, etc. Defaults to true.
54
+ # * command_path: Defines the path at which to find the command line
55
+ # programs if they are not visible to Rails the system's search path. Defaults to
56
+ # nil, which uses the first executable found in the user's search path.
57
+ # * image_magick_path: Deprecated alias of command_path.
58
+ def options
59
+ @options ||= {
60
+ :whiny_thumbnails => true,
61
+ :image_magick_path => nil,
62
+ :command_path => nil,
63
+ :log => true,
64
+ :swallow_stderr => true
65
+ }
66
+ end
67
+
68
+ def path_for_command command #:nodoc:
69
+ if options[:image_magick_path]
70
+ warn("[DEPRECATION] :image_magick_path is deprecated and will be removed. Use :command_path instead")
71
+ end
72
+ path = [options[:command_path] || options[:image_magick_path], command].compact
73
+ File.join(*path)
74
+ end
75
+
76
+ def interpolates key, &block
77
+ Paperclip::Attachment.interpolations[key] = block
78
+ end
79
+
80
+ # The run method takes a command to execute and a string of parameters
81
+ # that get passed to it. The command is prefixed with the :command_path
82
+ # option from Paperclip.options. If you have many commands to run and
83
+ # they are in different paths, the suggested course of action is to
84
+ # symlink them so they are all in the same directory.
85
+ #
86
+ # If the command returns with a result code that is not one of the
87
+ # expected_outcodes, a PaperclipCommandLineError will be raised. Generally
88
+ # a code of 0 is expected, but a list of codes may be passed if necessary.
89
+ def run cmd, params = "", expected_outcodes = 0
90
+ command = %Q<#{%Q[#{path_for_command(cmd)} #{params}].gsub(/\s+/, " ")}>
91
+ command = "#{command} 2>#{bit_bucket}" if Paperclip.options[:swallow_stderr]
92
+ output = `#{command}`
93
+ unless [expected_outcodes].flatten.include?($?.exitstatus)
94
+ raise PaperclipCommandLineError, "Error while running #{cmd}"
95
+ end
96
+ output
97
+ end
98
+
99
+ def bit_bucket #:nodoc:
100
+ File.exists?("/dev/null") ? "/dev/null" : "NUL"
101
+ end
102
+
103
+ def included base #:nodoc:
104
+ base.extend ClassMethods
105
+ unless base.respond_to?(:define_callbacks)
106
+ base.send(:include, Paperclip::CallbackCompatability)
107
+ end
108
+ end
109
+
110
+ def processor name #:nodoc:
111
+ name = name.to_s.camelize
112
+ processor = Paperclip.const_get(name)
113
+ unless processor.ancestors.include?(Paperclip::Processor)
114
+ raise PaperclipError.new("Processor #{name} was not found")
115
+ end
116
+ processor
117
+ end
118
+ end
119
+
120
+ class PaperclipError < StandardError #:nodoc:
121
+ end
122
+
123
+ class PaperclipCommandLineError < StandardError #:nodoc:
124
+ end
125
+
126
+ class NotIdentifiedByImageMagickError < PaperclipError #:nodoc:
127
+ end
128
+
129
+ module ClassMethods
130
+ # +has_attached_file+ gives the class it is called on an attribute that maps to a file. This
131
+ # is typically a file stored somewhere on the filesystem and has been uploaded by a user.
132
+ # The attribute returns a Paperclip::Attachment object which handles the management of
133
+ # that file. The intent is to make the attachment as much like a normal attribute. The
134
+ # thumbnails will be created when the new file is assigned, but they will *not* be saved
135
+ # until +save+ is called on the record. Likewise, if the attribute is set to +nil+ is
136
+ # called on it, the attachment will *not* be deleted until +save+ is called. See the
137
+ # Paperclip::Attachment documentation for more specifics. There are a number of options
138
+ # you can set to change the behavior of a Paperclip attachment:
139
+ # * +url+: The full URL of where the attachment is publically accessible. This can just
140
+ # as easily point to a directory served directly through Apache as it can to an action
141
+ # that can control permissions. You can specify the full domain and path, but usually
142
+ # just an absolute path is sufficient. The leading slash *must* be included manually for
143
+ # absolute paths. The default value is
144
+ # "/system/:attachment/:id/:style/:basename.:extension". See
145
+ # Paperclip::Attachment#interpolate for more information on variable interpolaton.
146
+ # :url => "/:class/:attachment/:id/:style_:basename.:extension"
147
+ # :url => "http://some.other.host/stuff/:class/:id_:extension"
148
+ # * +default_url+: The URL that will be returned if there is no attachment assigned.
149
+ # This field is interpolated just as the url is. The default value is
150
+ # "/:attachment/:style/missing.png"
151
+ # has_attached_file :avatar, :default_url => "/images/default_:style_avatar.png"
152
+ # User.new.avatar_url(:small) # => "/images/default_small_avatar.png"
153
+ # * +styles+: A hash of thumbnail styles and their geometries. You can find more about
154
+ # geometry strings at the ImageMagick website
155
+ # (http://www.imagemagick.org/script/command-line-options.php#resize). Paperclip
156
+ # also adds the "#" option (e.g. "50x50#"), which will resize the image to fit maximally
157
+ # inside the dimensions and then crop the rest off (weighted at the center). The
158
+ # default value is to generate no thumbnails.
159
+ # * +default_style+: The thumbnail style that will be used by default URLs.
160
+ # Defaults to +original+.
161
+ # has_attached_file :avatar, :styles => { :normal => "100x100#" },
162
+ # :default_style => :normal
163
+ # user.avatar.url # => "/avatars/23/normal_me.png"
164
+ # * +whiny_thumbnails+: Will raise an error if Paperclip cannot post_process an uploaded file due
165
+ # to a command line error. This will override the global setting for this attachment.
166
+ # Defaults to true.
167
+ # * +convert_options+: When creating thumbnails, use this free-form options
168
+ # field to pass in various convert command options. Typical options are "-strip" to
169
+ # remove all Exif data from the image (save space for thumbnails and avatars) or
170
+ # "-depth 8" to specify the bit depth of the resulting conversion. See ImageMagick
171
+ # convert documentation for more options: (http://www.imagemagick.org/script/convert.php)
172
+ # Note that this option takes a hash of options, each of which correspond to the style
173
+ # of thumbnail being generated. You can also specify :all as a key, which will apply
174
+ # to all of the thumbnails being generated. If you specify options for the :original,
175
+ # it would be best if you did not specify destructive options, as the intent of keeping
176
+ # the original around is to regenerate all the thumbnails when requirements change.
177
+ # has_attached_file :avatar, :styles => { :large => "300x300", :negative => "100x100" }
178
+ # :convert_options => {
179
+ # :all => "-strip",
180
+ # :negative => "-negate"
181
+ # }
182
+ # * +storage+: Chooses the storage backend where the files will be stored. The current
183
+ # choices are :filesystem and :s3. The default is :filesystem. Make sure you read the
184
+ # documentation for Paperclip::Storage::Filesystem and Paperclip::Storage::S3
185
+ # for backend-specific options.
186
+ def has_attached_file name, options = {}
187
+ include InstanceMethods
188
+
189
+ write_inheritable_attribute(:attachment_definitions, {}) if attachment_definitions.nil?
190
+ attachment_definitions[name] = {:validations => {}}.merge(options)
191
+
192
+ after_save :save_attached_files
193
+ before_destroy :destroy_attached_files
194
+
195
+ define_callbacks :before_post_process, :after_post_process
196
+ define_callbacks :"before_#{name}_post_process", :"after_#{name}_post_process"
197
+
198
+ define_method name do |*args|
199
+ a = attachment_for(name)
200
+ (args.length > 0) ? a.to_s(args.first) : a
201
+ end
202
+
203
+ define_method "#{name}=" do |file|
204
+ attachment_for(name).assign(file)
205
+ end
206
+
207
+ define_method "#{name}?" do
208
+ attachment_for(name).file?
209
+ end
210
+
211
+ validates_each(name) do |record, attr, value|
212
+ attachment = record.attachment_for(name)
213
+ attachment.send(:flush_errors) unless attachment.valid?
214
+ end
215
+
216
+ setup_file_columns(name) if options[:storage] == :database
217
+ end
218
+
219
+ # Places ActiveRecord-style validations on the size of the file assigned. The
220
+ # possible options are:
221
+ # * +in+: a Range of bytes (i.e. +1..1.megabyte+),
222
+ # * +less_than+: equivalent to :in => 0..options[:less_than]
223
+ # * +greater_than+: equivalent to :in => options[:greater_than]..Infinity
224
+ # * +message+: error message to display, use :min and :max as replacements
225
+ def validates_attachment_size name, options = {}
226
+ min = options[:greater_than] || (options[:in] && options[:in].first) || 0
227
+ max = options[:less_than] || (options[:in] && options[:in].last) || (1.0/0)
228
+ range = (min..max)
229
+ message = options[:message] || "file size must be between :min and :max bytes."
230
+
231
+ attachment_definitions[name][:validations][:size] = lambda do |attachment, instance|
232
+ if attachment.file? && !range.include?(attachment.size.to_i)
233
+ message.gsub(/:min/, min.to_s).gsub(/:max/, max.to_s)
234
+ end
235
+ end
236
+ end
237
+
238
+ # Adds errors if thumbnail creation fails. The same as specifying :whiny_thumbnails => true.
239
+ def validates_attachment_thumbnails name, options = {}
240
+ attachment_definitions[name][:whiny_thumbnails] = true
241
+ end
242
+
243
+ # Places ActiveRecord-style validations on the presence of a file.
244
+ def validates_attachment_presence name, options = {}
245
+ message = options[:message] || "must be set."
246
+ attachment_definitions[name][:validations][:presence] = lambda do |attachment, instance|
247
+ message unless attachment.file?
248
+ end
249
+ end
250
+
251
+ # Places ActiveRecord-style validations on the content type of the file
252
+ # assigned. The possible options are:
253
+ # * +content_type+: Allowed content types. Can be a single content type
254
+ # or an array. Each type can be a String or a Regexp. It should be
255
+ # noted that Internet Explorer upload files with content_types that you
256
+ # may not expect. For example, JPEG images are given image/pjpeg and
257
+ # PNGs are image/x-png, so keep that in mind when determining how you
258
+ # match. Allows all by default.
259
+ # * +message+: The message to display when the uploaded file has an invalid
260
+ # content type.
261
+ # NOTE: If you do not specify an [attachment]_content_type field on your
262
+ # model, content_type validation will work _ONLY upon assignment_ and
263
+ # re-validation after the instance has been reloaded will always succeed.
264
+ def validates_attachment_content_type name, options = {}
265
+ attachment_definitions[name][:validations][:content_type] = lambda do |attachment, instance|
266
+ valid_types = [options[:content_type]].flatten
267
+
268
+ unless attachment.original_filename.blank?
269
+ unless valid_types.blank?
270
+ content_type = attachment.instance_read(:content_type)
271
+ unless valid_types.any?{|t| content_type.nil? || t === content_type }
272
+ options[:message] || "is not one of the allowed file types."
273
+ end
274
+ end
275
+ end
276
+ end
277
+ end
278
+
279
+ # Returns the attachment definitions defined by each call to
280
+ # has_attached_file.
281
+ def attachment_definitions
282
+ read_inheritable_attribute(:attachment_definitions)
283
+ end
284
+
285
+ # Setup and validate file column names for database storage
286
+ def setup_file_columns name
287
+ (attachment_definitions[name][:file_columns] = file_columns(name)).each do | style, column |
288
+ raise PaperclipError.new("#{name} is not an allowed column name; please choose another column name.") if column == name.to_s
289
+ raise PaperclipError.new("#{self} model does not have required column '#{column}'") unless column_names.include? column
290
+ end
291
+ end
292
+
293
+ # Retrieve file column names from options, or use default (name_file or name_style_file)
294
+ def file_columns name
295
+ original_style_column = attachment_definitions[name][:column]
296
+ original_style_column ||= "#{name}_file"
297
+
298
+ styles = attachment_definitions[name][:styles]
299
+ styles ||= {}
300
+ styles.inject({ :original => original_style_column }) do |cols, (style_key, style_value)|
301
+ cols[style_key] = style_value[:column] unless style_value[:column].nil?
302
+ cols[style_key] ||= "#{name}_#{style_key}_file"
303
+ cols
304
+ end
305
+ end
306
+
307
+ # ActiveRecord scope that can be used to avoid loading blob columns
308
+ def select_without_file_columns_for name
309
+ unless attachment_definitions[name][:storage] == :database
310
+ raise PaperclipError.new("select_without_file_columns_for is only defined when :storage => :database is specified")
311
+ end
312
+ { :select => column_names.reject { |n| attachment_definitions[name][:file_columns].has_value?(n) }.join(',') }
313
+ end
314
+ end
315
+
316
+ module InstanceMethods #:nodoc:
317
+ def attachment_for name
318
+ @_paperclip_attachments ||= {}
319
+ @_paperclip_attachments[name] ||= Attachment.new(name, self, self.class.attachment_definitions[name])
320
+ end
321
+
322
+ def each_attachment
323
+ self.class.attachment_definitions.each do |name, definition|
324
+ yield(name, attachment_for(name))
325
+ end
326
+ end
327
+
328
+ def save_attached_files
329
+ logger.info("[paperclip] Saving attachments.")
330
+ each_attachment do |name, attachment|
331
+ attachment.send(:save)
332
+ end
333
+ end
334
+
335
+ def destroy_attached_files
336
+ logger.info("[paperclip] Deleting attachments.")
337
+ each_attachment do |name, attachment|
338
+ attachment.send(:queue_existing_for_delete)
339
+ attachment.send(:flush_deletes)
340
+ end
341
+ end
342
+ end
343
+
344
+ end
345
+
346
+ # Set it all up.
347
+ if Object.const_defined?("ActiveRecord")
348
+ ActiveRecord::Base.send(:include, Paperclip)
349
+ File.send(:include, Paperclip::Upfile)
350
+ ActionController::Base.send(:include, Paperclip::Storage::Database::ControllerClassMethods)
351
+ end