arielvalentin-paperclip 2.3.6
Sign up to get free protection for your applications and to get access to all the features.
- data/LICENSE +26 -0
- data/README.rdoc +182 -0
- data/Rakefile +80 -0
- data/generators/paperclip/USAGE +5 -0
- data/generators/paperclip/paperclip_generator.rb +27 -0
- data/generators/paperclip/templates/paperclip_migration.rb.erb +19 -0
- data/init.rb +1 -0
- data/lib/generators/paperclip/USAGE +8 -0
- data/lib/generators/paperclip/paperclip_generator.rb +31 -0
- data/lib/generators/paperclip/templates/paperclip_migration.rb.erb +19 -0
- data/lib/paperclip.rb +370 -0
- data/lib/paperclip/attachment.rb +347 -0
- data/lib/paperclip/callback_compatability.rb +61 -0
- data/lib/paperclip/command_line.rb +80 -0
- data/lib/paperclip/geometry.rb +115 -0
- data/lib/paperclip/interpolations.rb +114 -0
- data/lib/paperclip/iostream.rb +45 -0
- data/lib/paperclip/matchers.rb +33 -0
- data/lib/paperclip/matchers/have_attached_file_matcher.rb +57 -0
- data/lib/paperclip/matchers/validate_attachment_content_type_matcher.rb +75 -0
- data/lib/paperclip/matchers/validate_attachment_presence_matcher.rb +54 -0
- data/lib/paperclip/matchers/validate_attachment_size_matcher.rb +95 -0
- data/lib/paperclip/processor.rb +58 -0
- data/lib/paperclip/railtie.rb +24 -0
- data/lib/paperclip/storage.rb +2 -0
- data/lib/paperclip/storage/filesystem.rb +73 -0
- data/lib/paperclip/storage/s3.rb +192 -0
- data/lib/paperclip/style.rb +90 -0
- data/lib/paperclip/thumbnail.rb +79 -0
- data/lib/paperclip/upfile.rb +55 -0
- data/lib/paperclip/version.rb +3 -0
- data/lib/tasks/paperclip.rake +79 -0
- data/rails/init.rb +2 -0
- data/shoulda_macros/paperclip.rb +118 -0
- data/test/attachment_test.rb +804 -0
- data/test/command_line_test.rb +133 -0
- data/test/database.yml +4 -0
- data/test/fixtures/12k.png +0 -0
- data/test/fixtures/50x50.png +0 -0
- data/test/fixtures/5k.png +0 -0
- data/test/fixtures/bad.png +1 -0
- data/test/fixtures/s3.yml +8 -0
- data/test/fixtures/text.txt +0 -0
- data/test/fixtures/twopage.pdf +0 -0
- data/test/geometry_test.rb +177 -0
- data/test/helper.rb +146 -0
- data/test/integration_test.rb +482 -0
- data/test/interpolations_test.rb +127 -0
- data/test/iostream_test.rb +71 -0
- data/test/matchers/have_attached_file_matcher_test.rb +24 -0
- data/test/matchers/validate_attachment_content_type_matcher_test.rb +47 -0
- data/test/matchers/validate_attachment_presence_matcher_test.rb +26 -0
- data/test/matchers/validate_attachment_size_matcher_test.rb +51 -0
- data/test/paperclip_test.rb +254 -0
- data/test/processor_test.rb +10 -0
- data/test/storage_test.rb +363 -0
- data/test/style_test.rb +141 -0
- data/test/thumbnail_test.rb +227 -0
- data/test/upfile_test.rb +36 -0
- metadata +227 -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,182 @@
|
|
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
|
+
==Contributing
|
173
|
+
|
174
|
+
If you'd like to contribute a feature or bugfix: Thanks! To make sure your
|
175
|
+
fix/feature has a high chance of being included, please read the following
|
176
|
+
guidelines:
|
177
|
+
|
178
|
+
1. Ask on the mailing list[http://groups.google.com/group/paperclip-plugin], or
|
179
|
+
post a new GitHub Issue[http://github.com/thoughtbot/paperclip/issues].
|
180
|
+
2. Make sure there are tests! We will not accept any patch that is not tested.
|
181
|
+
It's a rare time when explicit tests aren't needed. If you have questions
|
182
|
+
about writing tests for paperclip, please ask the mailing list.
|
data/Rakefile
ADDED
@@ -0,0 +1,80 @@
|
|
1
|
+
require 'rubygems'
|
2
|
+
require 'appraisal'
|
3
|
+
require 'bundler/setup'
|
4
|
+
|
5
|
+
require 'rake'
|
6
|
+
require 'rake/testtask'
|
7
|
+
require 'rake/rdoctask'
|
8
|
+
|
9
|
+
$LOAD_PATH << File.join(File.dirname(__FILE__), 'lib')
|
10
|
+
require 'paperclip'
|
11
|
+
|
12
|
+
desc 'Default: run unit tests.'
|
13
|
+
task :default => [:clean, :all]
|
14
|
+
|
15
|
+
desc 'Test the paperclip plugin under all supported Rails versions.'
|
16
|
+
task :all do |t|
|
17
|
+
exec('rake appraisal test')
|
18
|
+
end
|
19
|
+
|
20
|
+
desc 'Test the paperclip plugin.'
|
21
|
+
Rake::TestTask.new(:test) do |t|
|
22
|
+
t.libs << 'lib' << 'profile'
|
23
|
+
t.pattern = 'test/**/*_test.rb'
|
24
|
+
t.verbose = true
|
25
|
+
end
|
26
|
+
|
27
|
+
desc 'Start an IRB session with all necessary files required.'
|
28
|
+
task :shell do |t|
|
29
|
+
chdir File.dirname(__FILE__)
|
30
|
+
exec 'irb -I lib/ -I lib/paperclip -r rubygems -r active_record -r tempfile -r init'
|
31
|
+
end
|
32
|
+
|
33
|
+
desc 'Generate documentation for the paperclip plugin.'
|
34
|
+
Rake::RDocTask.new(:rdoc) do |rdoc|
|
35
|
+
rdoc.rdoc_dir = 'doc'
|
36
|
+
rdoc.title = 'Paperclip'
|
37
|
+
rdoc.options << '--line-numbers' << '--inline-source'
|
38
|
+
rdoc.rdoc_files.include('README*')
|
39
|
+
rdoc.rdoc_files.include('lib/**/*.rb')
|
40
|
+
end
|
41
|
+
|
42
|
+
desc 'Update documentation on website'
|
43
|
+
task :sync_docs => 'rdoc' do
|
44
|
+
`rsync -ave ssh doc/ dev@dev.thoughtbot.com:/home/dev/www/dev.thoughtbot.com/paperclip`
|
45
|
+
end
|
46
|
+
|
47
|
+
desc 'Clean up files.'
|
48
|
+
task :clean do |t|
|
49
|
+
FileUtils.rm_rf "doc"
|
50
|
+
FileUtils.rm_rf "tmp"
|
51
|
+
FileUtils.rm_rf "pkg"
|
52
|
+
FileUtils.rm_rf "public"
|
53
|
+
FileUtils.rm "test/debug.log" rescue nil
|
54
|
+
FileUtils.rm "test/paperclip.db" rescue nil
|
55
|
+
Dir.glob("paperclip-*.gem").each{|f| FileUtils.rm f }
|
56
|
+
end
|
57
|
+
|
58
|
+
desc 'Build the gemspec.'
|
59
|
+
task :gemspec do |t|
|
60
|
+
exec 'gem build paperclip.gemspec'
|
61
|
+
end
|
62
|
+
|
63
|
+
desc "Print a list of the files to be put into the gem"
|
64
|
+
task :manifest => :clean do
|
65
|
+
spec.files.each do |file|
|
66
|
+
puts file
|
67
|
+
end
|
68
|
+
end
|
69
|
+
|
70
|
+
desc "Generate a gemspec file for GitHub"
|
71
|
+
task :gemspec => :clean do
|
72
|
+
File.open("#{spec.name}.gemspec", 'w') do |f|
|
73
|
+
f.write spec.to_ruby
|
74
|
+
end
|
75
|
+
end
|
76
|
+
|
77
|
+
desc "Build the gem into the current directory"
|
78
|
+
task :gem => :gemspec do
|
79
|
+
`gem build #{spec.name}.gemspec`
|
80
|
+
end
|
@@ -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,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,370 @@
|
|
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 'digest'
|
30
|
+
require 'tempfile'
|
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/interpolations'
|
38
|
+
require 'paperclip/style'
|
39
|
+
require 'paperclip/attachment'
|
40
|
+
require 'paperclip/storage'
|
41
|
+
require 'paperclip/callback_compatability'
|
42
|
+
require 'paperclip/command_line'
|
43
|
+
require 'paperclip/railtie'
|
44
|
+
if defined?(Rails.root) && Rails.root
|
45
|
+
Dir.glob(File.join(File.expand_path(Rails.root), "lib", "paperclip_processors", "*.rb")).each do |processor|
|
46
|
+
require processor
|
47
|
+
end
|
48
|
+
end
|
49
|
+
|
50
|
+
# The base module that gets included in ActiveRecord::Base. See the
|
51
|
+
# documentation for Paperclip::ClassMethods for more useful information.
|
52
|
+
module Paperclip
|
53
|
+
|
54
|
+
class << self
|
55
|
+
# Provides configurability to Paperclip. There are a number of options available, such as:
|
56
|
+
# * whiny: Will raise an error if Paperclip cannot process thumbnails of
|
57
|
+
# an uploaded image. Defaults to true.
|
58
|
+
# * log: Logs progress to the Rails log. Uses ActiveRecord's logger, so honors
|
59
|
+
# log levels, etc. Defaults to true.
|
60
|
+
# * command_path: Defines the path at which to find the command line
|
61
|
+
# programs if they are not visible to Rails the system's search path. Defaults to
|
62
|
+
# nil, which uses the first executable found in the user's search path.
|
63
|
+
# * image_magick_path: Deprecated alias of command_path.
|
64
|
+
def options
|
65
|
+
@options ||= {
|
66
|
+
:whiny => true,
|
67
|
+
:image_magick_path => nil,
|
68
|
+
:command_path => nil,
|
69
|
+
:log => true,
|
70
|
+
:log_command => true,
|
71
|
+
:swallow_stderr => true
|
72
|
+
}
|
73
|
+
end
|
74
|
+
|
75
|
+
def configure
|
76
|
+
yield(self) if block_given?
|
77
|
+
end
|
78
|
+
|
79
|
+
def interpolates key, &block
|
80
|
+
Paperclip::Interpolations[key] = block
|
81
|
+
end
|
82
|
+
|
83
|
+
# The run method takes a command to execute and an array of parameters
|
84
|
+
# that get passed to it. The command is prefixed with the :command_path
|
85
|
+
# option from Paperclip.options. If you have many commands to run and
|
86
|
+
# they are in different paths, the suggested course of action is to
|
87
|
+
# symlink them so they are all in the same directory.
|
88
|
+
#
|
89
|
+
# If the command returns with a result code that is not one of the
|
90
|
+
# expected_outcodes, a PaperclipCommandLineError will be raised. Generally
|
91
|
+
# a code of 0 is expected, but a list of codes may be passed if necessary.
|
92
|
+
# These codes should be passed as a hash as the last argument, like so:
|
93
|
+
#
|
94
|
+
# Paperclip.run("echo", "something", :expected_outcodes => [0,1,2,3])
|
95
|
+
#
|
96
|
+
# This method can log the command being run when
|
97
|
+
# Paperclip.options[:log_command] is set to true (defaults to false). This
|
98
|
+
# will only log if logging in general is set to true as well.
|
99
|
+
def run cmd, *params
|
100
|
+
if options[:image_magick_path]
|
101
|
+
Paperclip.log("[DEPRECATION] :image_magick_path is deprecated and will be removed. Use :command_path instead")
|
102
|
+
end
|
103
|
+
CommandLine.path = options[:command_path] || options[:image_magick_path]
|
104
|
+
CommandLine.new(cmd, *params).run
|
105
|
+
end
|
106
|
+
|
107
|
+
def processor name #:nodoc:
|
108
|
+
name = name.to_s.camelize
|
109
|
+
processor = Paperclip.const_get(name)
|
110
|
+
unless processor.ancestors.include?(Paperclip::Processor)
|
111
|
+
raise PaperclipError.new("Processor #{name} was not found")
|
112
|
+
end
|
113
|
+
processor
|
114
|
+
end
|
115
|
+
|
116
|
+
# Log a paperclip-specific line. Uses ActiveRecord::Base.logger
|
117
|
+
# by default. Set Paperclip.options[:log] to false to turn off.
|
118
|
+
def log message
|
119
|
+
logger.info("[paperclip] #{message}") if logging?
|
120
|
+
end
|
121
|
+
|
122
|
+
def logger #:nodoc:
|
123
|
+
ActiveRecord::Base.logger
|
124
|
+
end
|
125
|
+
|
126
|
+
def logging? #:nodoc:
|
127
|
+
options[:log]
|
128
|
+
end
|
129
|
+
end
|
130
|
+
|
131
|
+
class PaperclipError < StandardError #:nodoc:
|
132
|
+
end
|
133
|
+
|
134
|
+
class PaperclipCommandLineError < PaperclipError #:nodoc:
|
135
|
+
attr_accessor :output
|
136
|
+
def initialize(msg = nil, output = nil)
|
137
|
+
super(msg)
|
138
|
+
@output = output
|
139
|
+
end
|
140
|
+
end
|
141
|
+
|
142
|
+
class StorageMethodNotFound < PaperclipError
|
143
|
+
end
|
144
|
+
|
145
|
+
class CommandNotFoundError < PaperclipError
|
146
|
+
end
|
147
|
+
|
148
|
+
class NotIdentifiedByImageMagickError < PaperclipError #:nodoc:
|
149
|
+
end
|
150
|
+
|
151
|
+
class InfiniteInterpolationError < PaperclipError #:nodoc:
|
152
|
+
end
|
153
|
+
|
154
|
+
module Glue
|
155
|
+
def self.included base #:nodoc:
|
156
|
+
base.extend ClassMethods
|
157
|
+
if base.respond_to?("set_callback")
|
158
|
+
base.send :include, Paperclip::CallbackCompatability::Rails3
|
159
|
+
else
|
160
|
+
base.send :include, Paperclip::CallbackCompatability::Rails21
|
161
|
+
end
|
162
|
+
end
|
163
|
+
end
|
164
|
+
|
165
|
+
module ClassMethods
|
166
|
+
# +has_attached_file+ gives the class it is called on an attribute that maps to a file. This
|
167
|
+
# is typically a file stored somewhere on the filesystem and has been uploaded by a user.
|
168
|
+
# The attribute returns a Paperclip::Attachment object which handles the management of
|
169
|
+
# that file. The intent is to make the attachment as much like a normal attribute. The
|
170
|
+
# thumbnails will be created when the new file is assigned, but they will *not* be saved
|
171
|
+
# until +save+ is called on the record. Likewise, if the attribute is set to +nil+ is
|
172
|
+
# called on it, the attachment will *not* be deleted until +save+ is called. See the
|
173
|
+
# Paperclip::Attachment documentation for more specifics. There are a number of options
|
174
|
+
# you can set to change the behavior of a Paperclip attachment:
|
175
|
+
# * +url+: The full URL of where the attachment is publically accessible. This can just
|
176
|
+
# as easily point to a directory served directly through Apache as it can to an action
|
177
|
+
# that can control permissions. You can specify the full domain and path, but usually
|
178
|
+
# just an absolute path is sufficient. The leading slash *must* be included manually for
|
179
|
+
# absolute paths. The default value is
|
180
|
+
# "/system/:attachment/:id/:style/:filename". See
|
181
|
+
# Paperclip::Attachment#interpolate for more information on variable interpolaton.
|
182
|
+
# :url => "/:class/:attachment/:id/:style_:filename"
|
183
|
+
# :url => "http://some.other.host/stuff/:class/:id_:extension"
|
184
|
+
# * +default_url+: The URL that will be returned if there is no attachment assigned.
|
185
|
+
# This field is interpolated just as the url is. The default value is
|
186
|
+
# "/:attachment/:style/missing.png"
|
187
|
+
# has_attached_file :avatar, :default_url => "/images/default_:style_avatar.png"
|
188
|
+
# User.new.avatar_url(:small) # => "/images/default_small_avatar.png"
|
189
|
+
# * +styles+: A hash of thumbnail styles and their geometries. You can find more about
|
190
|
+
# geometry strings at the ImageMagick website
|
191
|
+
# (http://www.imagemagick.org/script/command-line-options.php#resize). Paperclip
|
192
|
+
# also adds the "#" option (e.g. "50x50#"), which will resize the image to fit maximally
|
193
|
+
# inside the dimensions and then crop the rest off (weighted at the center). The
|
194
|
+
# default value is to generate no thumbnails.
|
195
|
+
# * +default_style+: The thumbnail style that will be used by default URLs.
|
196
|
+
# Defaults to +original+.
|
197
|
+
# has_attached_file :avatar, :styles => { :normal => "100x100#" },
|
198
|
+
# :default_style => :normal
|
199
|
+
# user.avatar.url # => "/avatars/23/normal_me.png"
|
200
|
+
# * +whiny+: Will raise an error if Paperclip cannot post_process an uploaded file due
|
201
|
+
# to a command line error. This will override the global setting for this attachment.
|
202
|
+
# Defaults to true. This option used to be called :whiny_thumbanils, but this is
|
203
|
+
# deprecated.
|
204
|
+
# * +convert_options+: When creating thumbnails, use this free-form options
|
205
|
+
# array to pass in various convert command options. Typical options are "-strip" to
|
206
|
+
# remove all Exif data from the image (save space for thumbnails and avatars) or
|
207
|
+
# "-depth 8" to specify the bit depth of the resulting conversion. See ImageMagick
|
208
|
+
# convert documentation for more options: (http://www.imagemagick.org/script/convert.php)
|
209
|
+
# Note that this option takes a hash of options, each of which correspond to the style
|
210
|
+
# of thumbnail being generated. You can also specify :all as a key, which will apply
|
211
|
+
# to all of the thumbnails being generated. If you specify options for the :original,
|
212
|
+
# it would be best if you did not specify destructive options, as the intent of keeping
|
213
|
+
# the original around is to regenerate all the thumbnails when requirements change.
|
214
|
+
# has_attached_file :avatar, :styles => { :large => "300x300", :negative => "100x100" }
|
215
|
+
# :convert_options => {
|
216
|
+
# :all => "-strip",
|
217
|
+
# :negative => "-negate"
|
218
|
+
# }
|
219
|
+
# NOTE: While not deprecated yet, it is not recommended to specify options this way.
|
220
|
+
# It is recommended that :convert_options option be included in the hash passed to each
|
221
|
+
# :styles for compatability with future versions.
|
222
|
+
# NOTE: Strings supplied to :convert_options are split on space in order to undergo
|
223
|
+
# shell quoting for safety. If your options require a space, please pre-split them
|
224
|
+
# and pass an array to :convert_options instead.
|
225
|
+
# * +storage+: Chooses the storage backend where the files will be stored. The current
|
226
|
+
# choices are :filesystem and :s3. The default is :filesystem. Make sure you read the
|
227
|
+
# documentation for Paperclip::Storage::Filesystem and Paperclip::Storage::S3
|
228
|
+
# for backend-specific options.
|
229
|
+
def has_attached_file name, options = {}
|
230
|
+
include InstanceMethods
|
231
|
+
|
232
|
+
write_inheritable_attribute(:attachment_definitions, {}) if attachment_definitions.nil?
|
233
|
+
attachment_definitions[name] = {:validations => []}.merge(options)
|
234
|
+
|
235
|
+
after_save :save_attached_files
|
236
|
+
before_destroy :destroy_attached_files
|
237
|
+
|
238
|
+
define_paperclip_callbacks :post_process, :"#{name}_post_process"
|
239
|
+
|
240
|
+
define_method name do |*args|
|
241
|
+
a = attachment_for(name)
|
242
|
+
(args.length > 0) ? a.to_s(args.first) : a
|
243
|
+
end
|
244
|
+
|
245
|
+
define_method "#{name}=" do |file|
|
246
|
+
attachment_for(name).assign(file)
|
247
|
+
end
|
248
|
+
|
249
|
+
define_method "#{name}?" do
|
250
|
+
attachment_for(name).file?
|
251
|
+
end
|
252
|
+
|
253
|
+
validates_each(name) do |record, attr, value|
|
254
|
+
attachment = record.attachment_for(name)
|
255
|
+
attachment.send(:flush_errors)
|
256
|
+
end
|
257
|
+
end
|
258
|
+
|
259
|
+
# Places ActiveRecord-style validations on the size of the file assigned. The
|
260
|
+
# possible options are:
|
261
|
+
# * +in+: a Range of bytes (i.e. +1..1.megabyte+),
|
262
|
+
# * +less_than+: equivalent to :in => 0..options[:less_than]
|
263
|
+
# * +greater_than+: equivalent to :in => options[:greater_than]..Infinity
|
264
|
+
# * +message+: error message to display, use :min and :max as replacements
|
265
|
+
# * +if+: A lambda or name of a method on the instance. Validation will only
|
266
|
+
# be run is this lambda or method returns true.
|
267
|
+
# * +unless+: Same as +if+ but validates if lambda or method returns false.
|
268
|
+
def validates_attachment_size name, options = {}
|
269
|
+
min = options[:greater_than] || (options[:in] && options[:in].first) || 0
|
270
|
+
max = options[:less_than] || (options[:in] && options[:in].last) || (1.0/0)
|
271
|
+
range = (min..max)
|
272
|
+
message = options[:message] || "file size must be between :min and :max bytes."
|
273
|
+
message = message.gsub(/:min/, min.to_s).gsub(/:max/, max.to_s)
|
274
|
+
|
275
|
+
validates_inclusion_of :"#{name}_file_size",
|
276
|
+
:in => range,
|
277
|
+
:message => message,
|
278
|
+
:if => options[:if],
|
279
|
+
:unless => options[:unless],
|
280
|
+
:allow_nil => true
|
281
|
+
end
|
282
|
+
|
283
|
+
# Adds errors if thumbnail creation fails. The same as specifying :whiny_thumbnails => true.
|
284
|
+
def validates_attachment_thumbnails name, options = {}
|
285
|
+
warn('[DEPRECATION] validates_attachment_thumbnail is deprecated. ' +
|
286
|
+
'This validation is on by default and will be removed from future versions. ' +
|
287
|
+
'If you wish to turn it off, supply :whiny => false in your definition.')
|
288
|
+
attachment_definitions[name][:whiny_thumbnails] = true
|
289
|
+
end
|
290
|
+
|
291
|
+
# Places ActiveRecord-style validations on the presence of a file.
|
292
|
+
# Options:
|
293
|
+
# * +if+: A lambda or name of a method on the instance. Validation will only
|
294
|
+
# be run is this lambda or method returns true.
|
295
|
+
# * +unless+: Same as +if+ but validates if lambda or method returns false.
|
296
|
+
def validates_attachment_presence name, options = {}
|
297
|
+
message = options[:message] || "must be set."
|
298
|
+
validates_presence_of :"#{name}_file_name",
|
299
|
+
:message => message,
|
300
|
+
:if => options[:if],
|
301
|
+
:unless => options[:unless]
|
302
|
+
end
|
303
|
+
|
304
|
+
# Places ActiveRecord-style validations on the content type of the file
|
305
|
+
# assigned. The possible options are:
|
306
|
+
# * +content_type+: Allowed content types. Can be a single content type
|
307
|
+
# or an array. Each type can be a String or a Regexp. It should be
|
308
|
+
# noted that Internet Explorer upload files with content_types that you
|
309
|
+
# may not expect. For example, JPEG images are given image/pjpeg and
|
310
|
+
# PNGs are image/x-png, so keep that in mind when determining how you
|
311
|
+
# match. Allows all by default.
|
312
|
+
# * +message+: The message to display when the uploaded file has an invalid
|
313
|
+
# content type.
|
314
|
+
# * +if+: A lambda or name of a method on the instance. Validation will only
|
315
|
+
# be run is this lambda or method returns true.
|
316
|
+
# * +unless+: Same as +if+ but validates if lambda or method returns false.
|
317
|
+
# NOTE: If you do not specify an [attachment]_content_type field on your
|
318
|
+
# model, content_type validation will work _ONLY upon assignment_ and
|
319
|
+
# re-validation after the instance has been reloaded will always succeed.
|
320
|
+
def validates_attachment_content_type name, options = {}
|
321
|
+
validation_options = options.dup
|
322
|
+
allowed_types = [validation_options[:content_type]].flatten
|
323
|
+
validates_each(:"#{name}_content_type", validation_options) do |record, attr, value|
|
324
|
+
if !allowed_types.any?{|t| t === value } && !(value.nil? || value.blank?)
|
325
|
+
if record.errors.method(:add).arity == -2
|
326
|
+
message = options[:message] || "is not one of #{allowed_types.join(", ")}"
|
327
|
+
record.errors.add(:"#{name}_content_type", message)
|
328
|
+
else
|
329
|
+
record.errors.add(:"#{name}_content_type", :inclusion, :default => options[:message], :value => value)
|
330
|
+
end
|
331
|
+
end
|
332
|
+
end
|
333
|
+
end
|
334
|
+
|
335
|
+
# Returns the attachment definitions defined by each call to
|
336
|
+
# has_attached_file.
|
337
|
+
def attachment_definitions
|
338
|
+
read_inheritable_attribute(:attachment_definitions)
|
339
|
+
end
|
340
|
+
end
|
341
|
+
|
342
|
+
module InstanceMethods #:nodoc:
|
343
|
+
def attachment_for name
|
344
|
+
@_paperclip_attachments ||= {}
|
345
|
+
@_paperclip_attachments[name] ||= Attachment.new(name, self, self.class.attachment_definitions[name])
|
346
|
+
end
|
347
|
+
|
348
|
+
def each_attachment
|
349
|
+
self.class.attachment_definitions.each do |name, definition|
|
350
|
+
yield(name, attachment_for(name))
|
351
|
+
end
|
352
|
+
end
|
353
|
+
|
354
|
+
def save_attached_files
|
355
|
+
Paperclip.log("Saving attachments.")
|
356
|
+
each_attachment do |name, attachment|
|
357
|
+
attachment.send(:save)
|
358
|
+
end
|
359
|
+
end
|
360
|
+
|
361
|
+
def destroy_attached_files
|
362
|
+
Paperclip.log("Deleting attachments.")
|
363
|
+
each_attachment do |name, attachment|
|
364
|
+
attachment.send(:queue_existing_for_delete)
|
365
|
+
attachment.send(:flush_deletes)
|
366
|
+
end
|
367
|
+
end
|
368
|
+
end
|
369
|
+
|
370
|
+
end
|