lostboy-paperclip 2.2.6.1
Sign up to get free protection for your applications and to get access to all the features.
- data/LICENSE +26 -0
- data/README.rdoc +172 -0
- data/Rakefile +77 -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/paperclip/attachment.rb +398 -0
- data/lib/paperclip/callback_compatability.rb +33 -0
- data/lib/paperclip/geometry.rb +115 -0
- data/lib/paperclip/iostream.rb +58 -0
- data/lib/paperclip/matchers/have_attached_file_matcher.rb +49 -0
- data/lib/paperclip/matchers/validate_attachment_content_type_matcher.rb +66 -0
- data/lib/paperclip/matchers/validate_attachment_presence_matcher.rb +48 -0
- data/lib/paperclip/matchers/validate_attachment_size_matcher.rb +83 -0
- data/lib/paperclip/matchers.rb +4 -0
- data/lib/paperclip/processor.rb +48 -0
- data/lib/paperclip/storage.rb +241 -0
- data/lib/paperclip/thumbnail.rb +70 -0
- data/lib/paperclip/upfile.rb +48 -0
- data/lib/paperclip.rb +318 -0
- data/shoulda_macros/paperclip.rb +68 -0
- data/tasks/paperclip_tasks.rake +79 -0
- data/test/attachment_test.rb +723 -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/text.txt +0 -0
- data/test/fixtures/twopage.pdf +0 -0
- data/test/geometry_test.rb +168 -0
- data/test/helper.rb +82 -0
- data/test/integration_test.rb +495 -0
- data/test/iostream_test.rb +71 -0
- data/test/matchers/have_attached_file_matcher_test.rb +21 -0
- data/test/matchers/validate_attachment_content_type_matcher_test.rb +30 -0
- data/test/matchers/validate_attachment_presence_matcher_test.rb +21 -0
- data/test/matchers/validate_attachment_size_matcher_test.rb +50 -0
- data/test/paperclip_test.rb +237 -0
- data/test/processor_test.rb +10 -0
- data/test/storage_test.rb +277 -0
- data/test/thumbnail_test.rb +177 -0
- metadata +133 -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,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.
|
data/Rakefile
ADDED
@@ -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,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")
|