mbailey-paperclip 2.3.2

Sign up to get free protection for your applications and to get access to all the features.
Files changed (56) hide show
  1. data/LICENSE +26 -0
  2. data/README.rdoc +179 -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/attachment.rb +326 -0
  12. data/lib/paperclip/callback_compatability.rb +61 -0
  13. data/lib/paperclip/geometry.rb +115 -0
  14. data/lib/paperclip/interpolations.rb +108 -0
  15. data/lib/paperclip/iostream.rb +59 -0
  16. data/lib/paperclip/matchers/have_attached_file_matcher.rb +57 -0
  17. data/lib/paperclip/matchers/validate_attachment_content_type_matcher.rb +74 -0
  18. data/lib/paperclip/matchers/validate_attachment_presence_matcher.rb +54 -0
  19. data/lib/paperclip/matchers/validate_attachment_size_matcher.rb +95 -0
  20. data/lib/paperclip/matchers.rb +33 -0
  21. data/lib/paperclip/processor.rb +49 -0
  22. data/lib/paperclip/railtie.rb +24 -0
  23. data/lib/paperclip/storage.rb +247 -0
  24. data/lib/paperclip/style.rb +90 -0
  25. data/lib/paperclip/thumbnail.rb +78 -0
  26. data/lib/paperclip/upfile.rb +52 -0
  27. data/lib/paperclip/version.rb +3 -0
  28. data/lib/paperclip.rb +397 -0
  29. data/lib/tasks/paperclip.rake +79 -0
  30. data/rails/init.rb +2 -0
  31. data/shoulda_macros/paperclip.rb +119 -0
  32. data/test/attachment_test.rb +758 -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/s3.yml +8 -0
  39. data/test/fixtures/text.txt +0 -0
  40. data/test/fixtures/twopage.pdf +0 -0
  41. data/test/geometry_test.rb +177 -0
  42. data/test/helper.rb +148 -0
  43. data/test/integration_test.rb +483 -0
  44. data/test/interpolations_test.rb +124 -0
  45. data/test/iostream_test.rb +78 -0
  46. data/test/matchers/have_attached_file_matcher_test.rb +24 -0
  47. data/test/matchers/validate_attachment_content_type_matcher_test.rb +37 -0
  48. data/test/matchers/validate_attachment_presence_matcher_test.rb +26 -0
  49. data/test/matchers/validate_attachment_size_matcher_test.rb +51 -0
  50. data/test/paperclip_test.rb +317 -0
  51. data/test/processor_test.rb +10 -0
  52. data/test/storage_test.rb +343 -0
  53. data/test/style_test.rb +141 -0
  54. data/test/thumbnail_test.rb +227 -0
  55. data/test/upfile_test.rb +36 -0
  56. metadata +205 -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,179 @@
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 ":rails_root/public/system/:attachment/:id/:style/:filename". This
83
+ location was chosen because on standard Capistrano deployments, the
84
+ public/system directory is symlinked to the app's shared directory, meaning it
85
+ will survive between deployments. For example, using that :path, you may have a
86
+ file at
87
+
88
+ /data/myapp/releases/20081229172410/public/system/avatars/13/small/my_pic.png
89
+
90
+ NOTE: This is a change from previous versions of Paperclip, but is overall a
91
+ safer choice for the default file store.
92
+
93
+ You may also choose to store your files using Amazon's S3 service. You can find
94
+ more information about S3 storage at the description for
95
+ Paperclip::Storage::S3.
96
+
97
+ Files on the local filesystem (and in the Rails app's public directory) will be
98
+ available to the internet at large. If you require access control, it's
99
+ possible to place your files in a different location. You will need to change
100
+ both the :path and :url options in order to make sure the files are unavailable
101
+ to the public. Both :path and :url allow the same set of interpolated
102
+ variables.
103
+
104
+ ==Post Processing
105
+
106
+ Paperclip supports an extensible selection of post-processors. When you define
107
+ a set of styles for an attachment, by default it is expected that those
108
+ "styles" are actually "thumbnails". However, you can do much more than just
109
+ thumbnail images. By defining a subclass of Paperclip::Processor, you can
110
+ perform any processing you want on the files that are attached. Any file in
111
+ your Rails app's lib/paperclip_processors directory is automatically loaded by
112
+ paperclip, allowing you to easily define custom processors. You can specify a
113
+ processor with the :processors option to has_attached_file:
114
+
115
+ has_attached_file :scan, :styles => { :text => { :quality => :better } },
116
+ :processors => [:ocr]
117
+
118
+ This would load the hypothetical class Paperclip::Ocr, which would have the
119
+ hash "{ :quality => :better }" passed to it along with the uploaded file. For
120
+ more information about defining processors, see Paperclip::Processor.
121
+
122
+ The default processor is Paperclip::Thumbnail. For backwards compatability
123
+ reasons, you can pass a single geometry string or an array containing a
124
+ geometry and a format, which the file will be converted to, like so:
125
+
126
+ has_attached_file :avatar, :styles => { :thumb => ["32x32#", :png] }
127
+
128
+ This will convert the "thumb" style to a 32x32 square in png format, regardless
129
+ of what was uploaded. If the format is not specified, it is kept the same (i.e.
130
+ jpgs will remain jpgs).
131
+
132
+ Multiple processors can be specified, and they will be invoked in the order
133
+ they are defined in the :processors array. Each successive processor will
134
+ be given the result of the previous processor's execution. All processors will
135
+ receive the same parameters, which are what you define in the :styles hash.
136
+ For example, assuming we had this definition:
137
+
138
+ has_attached_file :scan, :styles => { :text => { :quality => :better } },
139
+ :processors => [:rotator, :ocr]
140
+
141
+ then both the :rotator processor and the :ocr processor would receive the
142
+ options "{ :quality => :better }". This parameter may not mean anything to one
143
+ or more or the processors, and they are expected to ignore it.
144
+
145
+ NOTE: Because processors operate by turning the original attachment into the
146
+ styles, no processors will be run if there are no styles defined.
147
+
148
+ ==Events
149
+
150
+ Before and after the Post Processing step, Paperclip calls back to the model
151
+ with a few callbacks, allowing the model to change or cancel the processing
152
+ step. The callbacks are "before_post_process" and "after_post_process" (which
153
+ are called before and after the processing of each attachment), and the
154
+ attachment-specific "before_<attachment>_post_process" and
155
+ "after_<attachment>_post_process". The callbacks are intended to be as close to
156
+ normal ActiveRecord callbacks as possible, so if you return false (specifically
157
+ - returning nil is not the same) in a before_ filter, the post processing step
158
+ will halt. Returning false in an after_ filter will not halt anything, but you
159
+ can access the model and the attachment if necessary.
160
+
161
+ NOTE: Post processing will not even *start* if the attachment is not valid
162
+ according to the validations. Your callbacks and processors will *only* be
163
+ called with valid attachments.
164
+
165
+ ==Testing
166
+
167
+ Paperclip provides rspec-compatible matchers for testing attachments. See the
168
+ documentation on Paperclip::Shoulda::Matchers for more information.
169
+
170
+ ==Contributing
171
+
172
+ If you'd like to contribute a feature or bugfix: Thanks! To make sure your
173
+ fix/feature has a high chance of being included, please read the following
174
+ guidelines:
175
+
176
+ 1. Ask on the mailing list, or post a new GitHub Issue.
177
+ 2. Make sure there are tests! We will not accept any patch that is not tested.
178
+ It's a rare time when explicit tests aren't needed. If you have questions
179
+ 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