whitby3001-paperclip-cloudfiles 2.3.8.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (61) hide show
  1. data/LICENSE +26 -0
  2. data/README.md +225 -0
  3. data/Rakefile +80 -0
  4. data/generators/paperclip/USAGE +5 -0
  5. data/generators/paperclip/paperclip_generator.rb +27 -0
  6. data/generators/paperclip/templates/paperclip_migration.rb.erb +19 -0
  7. data/init.rb +1 -0
  8. data/lib/generators/paperclip/USAGE +8 -0
  9. data/lib/generators/paperclip/paperclip_generator.rb +31 -0
  10. data/lib/generators/paperclip/templates/paperclip_migration.rb.erb +19 -0
  11. data/lib/paperclip.rb +376 -0
  12. data/lib/paperclip/attachment.rb +415 -0
  13. data/lib/paperclip/callback_compatability.rb +61 -0
  14. data/lib/paperclip/command_line.rb +80 -0
  15. data/lib/paperclip/geometry.rb +115 -0
  16. data/lib/paperclip/interpolations.rb +114 -0
  17. data/lib/paperclip/iostream.rb +45 -0
  18. data/lib/paperclip/matchers.rb +33 -0
  19. data/lib/paperclip/matchers/have_attached_file_matcher.rb +57 -0
  20. data/lib/paperclip/matchers/validate_attachment_content_type_matcher.rb +75 -0
  21. data/lib/paperclip/matchers/validate_attachment_presence_matcher.rb +54 -0
  22. data/lib/paperclip/matchers/validate_attachment_size_matcher.rb +95 -0
  23. data/lib/paperclip/processor.rb +58 -0
  24. data/lib/paperclip/railtie.rb +24 -0
  25. data/lib/paperclip/storage.rb +3 -0
  26. data/lib/paperclip/storage/cloud_files.rb +138 -0
  27. data/lib/paperclip/storage/filesystem.rb +73 -0
  28. data/lib/paperclip/storage/s3.rb +192 -0
  29. data/lib/paperclip/style.rb +93 -0
  30. data/lib/paperclip/thumbnail.rb +79 -0
  31. data/lib/paperclip/upfile.rb +55 -0
  32. data/lib/paperclip/version.rb +3 -0
  33. data/lib/tasks/paperclip.rake +72 -0
  34. data/rails/init.rb +2 -0
  35. data/shoulda_macros/paperclip.rb +118 -0
  36. data/test/attachment_test.rb +818 -0
  37. data/test/command_line_test.rb +133 -0
  38. data/test/database.yml +4 -0
  39. data/test/fixtures/12k.png +0 -0
  40. data/test/fixtures/50x50.png +0 -0
  41. data/test/fixtures/5k.png +0 -0
  42. data/test/fixtures/bad.png +1 -0
  43. data/test/fixtures/s3.yml +8 -0
  44. data/test/fixtures/text.txt +0 -0
  45. data/test/fixtures/twopage.pdf +0 -0
  46. data/test/geometry_test.rb +177 -0
  47. data/test/helper.rb +149 -0
  48. data/test/integration_test.rb +498 -0
  49. data/test/interpolations_test.rb +127 -0
  50. data/test/iostream_test.rb +71 -0
  51. data/test/matchers/have_attached_file_matcher_test.rb +24 -0
  52. data/test/matchers/validate_attachment_content_type_matcher_test.rb +47 -0
  53. data/test/matchers/validate_attachment_presence_matcher_test.rb +26 -0
  54. data/test/matchers/validate_attachment_size_matcher_test.rb +51 -0
  55. data/test/paperclip_test.rb +292 -0
  56. data/test/processor_test.rb +10 -0
  57. data/test/storage_test.rb +605 -0
  58. data/test/style_test.rb +141 -0
  59. data/test/thumbnail_test.rb +227 -0
  60. data/test/upfile_test.rb +36 -0
  61. metadata +242 -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.md ADDED
@@ -0,0 +1,225 @@
1
+ Paperclip
2
+ =========
3
+
4
+ Paperclip is intended as an easy file attachment library for ActiveRecord. The
5
+ intent behind it was to keep setup as easy as possible and to treat files as
6
+ much like other attributes as possible. This means they aren't saved to their
7
+ final locations on disk, nor are they deleted if set to nil, until
8
+ ActiveRecord::Base#save is called. It manages validations based on size and
9
+ presence, if required. It can transform its assigned image into thumbnails if
10
+ needed, and the prerequisites are as simple as installing ImageMagick (which,
11
+ for most modern Unix-based systems, is as easy as installing the right
12
+ packages). Attached files are saved to the filesystem and referenced in the
13
+ browser by an easily understandable specification, which has sensible and
14
+ useful defaults.
15
+
16
+ See the documentation for `has_attached_file` in Paperclip::ClassMethods for
17
+ more detailed options.
18
+
19
+ This fork has support for Rackspace Cloud Files. It requires the "cloudfiles"
20
+ gem, >= 1.4.9, from Gemcutter.org. The Thoughtbot guys have indicated that they
21
+ don't want to pull any code into the official Paperclip mainline that they don't
22
+ personally use on projects, so until they discover the joy of Cloud Files, this
23
+ fork is available as the {paperclip-cloudfiles gem}[http://gemcutter.org/gems/paperclip-cloudfiles]
24
+ on Gemcutter's gem server.
25
+
26
+ The complete [RDoc](http://rdoc.info/github/minter/paperclip) is online.
27
+
28
+ Installation
29
+ ------------
30
+
31
+ Include the gem in your Gemfile:
32
+
33
+ gem "paperclip-cloudfiles", "~> 2.3"
34
+
35
+ In your environment.rb:
36
+
37
+ config.gem "paperclip-cloudfiles", :lib => 'paperclip'
38
+
39
+ This is because the gem name and the library name don't match.
40
+
41
+ Quick Start
42
+ -----------
43
+
44
+ In your model:
45
+
46
+ class User < ActiveRecord::Base
47
+ has_attached_file :avatar, :styles => { :medium => "300x300>", :thumb => "100x100>" }
48
+ end
49
+
50
+ In your migrations:
51
+
52
+ class AddAvatarColumnsToUser < ActiveRecord::Migration
53
+ def self.up
54
+ add_column :users, :avatar_file_name, :string
55
+ add_column :users, :avatar_content_type, :string
56
+ add_column :users, :avatar_file_size, :integer
57
+ add_column :users, :avatar_updated_at, :datetime
58
+ end
59
+
60
+ def self.down
61
+ remove_column :users, :avatar_file_name
62
+ remove_column :users, :avatar_content_type
63
+ remove_column :users, :avatar_file_size
64
+ remove_column :users, :avatar_updated_at
65
+ end
66
+ end
67
+
68
+ In your edit and new views:
69
+
70
+ <% form_for :user, @user, :url => user_path, :html => { :multipart => true } do |form| %>
71
+ <%= form.file_field :avatar %>
72
+ <% end %>
73
+
74
+ In your controller:
75
+
76
+ def create
77
+ @user = User.create( params[:user] )
78
+ end
79
+
80
+ In your show view:
81
+
82
+ <%= image_tag @user.avatar.url %>
83
+ <%= image_tag @user.avatar.url(:medium) %>
84
+ <%= image_tag @user.avatar.url(:thumb) %>
85
+
86
+ Usage
87
+ -----
88
+
89
+ The basics of paperclip are quite simple: Declare that your model has an
90
+ attachment with the has_attached_file method, and give it a name. Paperclip
91
+ will wrap up up to four attributes (all prefixed with that attachment's name,
92
+ so you can have multiple attachments per model if you wish) and give the a
93
+ friendly front end. The attributes are `<attachment>_file_name`,
94
+ `<attachment>_file_size`, `<attachment>_content_type`, and `<attachment>_updated_at`.
95
+ Only `<attachment>_file_name` is required for paperclip to operate. More
96
+ information about the options to has_attached_file is available in the
97
+ documentation of Paperclip::ClassMethods.
98
+
99
+ Attachments can be validated with Paperclip's validation methods,
100
+ validates_attachment_presence, validates_attachment_content_type, and
101
+ validates_attachment_size.
102
+
103
+ Storage
104
+ -------
105
+
106
+ The files that are assigned as attachments are, by default, placed in the
107
+ directory specified by the :path option to has_attached_file. By default, this
108
+ location is ":rails_root/public/system/:attachment/:id/:style/:filename". This
109
+ location was chosen because on standard Capistrano deployments, the
110
+ public/system directory is symlinked to the app's shared directory, meaning it
111
+ will survive between deployments. For example, using that :path, you may have a
112
+ file at
113
+
114
+ /data/myapp/releases/20081229172410/public/system/avatars/13/small/my_pic.png
115
+
116
+ _NOTE: This is a change from previous versions of Paperclip, but is overall a
117
+ safer choice for the default file store._
118
+
119
+ You may also choose to store your files using Amazon's S3 service or Rackspace's Cloud Files service. You can find
120
+ more information about S3 storage at the description for Paperclip::Storage::S3. and more information about Cloud Files storage at the description for Paperclip::Storage::CloudFile
121
+
122
+ Files on the local filesystem (and in the Rails app's public directory) will be
123
+ available to the internet at large. If you require access control, it's
124
+ possible to place your files in a different location. You will need to change
125
+ both the :path and :url options in order to make sure the files are unavailable
126
+ to the public. Both :path and :url allow the same set of interpolated
127
+ variables.
128
+
129
+ Post Processing
130
+ ---------------
131
+
132
+ Paperclip supports an extensible selection of post-processors. When you define
133
+ a set of styles for an attachment, by default it is expected that those
134
+ "styles" are actually "thumbnails". However, you can do much more than just
135
+ thumbnail images. By defining a subclass of Paperclip::Processor, you can
136
+ perform any processing you want on the files that are attached. Any file in
137
+ your Rails app's lib/paperclip_processors directory is automatically loaded by
138
+ paperclip, allowing you to easily define custom processors. You can specify a
139
+ processor with the :processors option to has_attached_file:
140
+
141
+ has_attached_file :scan, :styles => { :text => { :quality => :better } },
142
+ :processors => [:ocr]
143
+
144
+ This would load the hypothetical class Paperclip::Ocr, which would have the
145
+ hash "{ :quality => :better }" passed to it along with the uploaded file. For
146
+ more information about defining processors, see Paperclip::Processor.
147
+
148
+ The default processor is Paperclip::Thumbnail. For backwards compatability
149
+ reasons, you can pass a single geometry string or an array containing a
150
+ geometry and a format, which the file will be converted to, like so:
151
+
152
+ has_attached_file :avatar, :styles => { :thumb => ["32x32#", :png] }
153
+
154
+ This will convert the "thumb" style to a 32x32 square in png format, regardless
155
+ of what was uploaded. If the format is not specified, it is kept the same (i.e.
156
+ jpgs will remain jpgs).
157
+
158
+ Multiple processors can be specified, and they will be invoked in the order
159
+ they are defined in the :processors array. Each successive processor will
160
+ be given the result of the previous processor's execution. All processors will
161
+ receive the same parameters, which are what you define in the :styles hash.
162
+ For example, assuming we had this definition:
163
+
164
+ has_attached_file :scan, :styles => { :text => { :quality => :better } },
165
+ :processors => [:rotator, :ocr]
166
+
167
+ then both the :rotator processor and the :ocr processor would receive the
168
+ options "{ :quality => :better }". This parameter may not mean anything to one
169
+ or more or the processors, and they are expected to ignore it.
170
+
171
+ _NOTE: Because processors operate by turning the original attachment into the
172
+ styles, no processors will be run if there are no styles defined._
173
+
174
+ Events
175
+ ------
176
+
177
+ Before and after the Post Processing step, Paperclip calls back to the model
178
+ with a few callbacks, allowing the model to change or cancel the processing
179
+ step. The callbacks are `before_post_process` and `after_post_process` (which
180
+ are called before and after the processing of each attachment), and the
181
+ attachment-specific `before_<attachment>_post_process` and
182
+ `after_<attachment>_post_process`. The callbacks are intended to be as close to
183
+ normal ActiveRecord callbacks as possible, so if you return false (specifically
184
+ - returning nil is not the same) in a before_ filter, the post processing step
185
+ will halt. Returning false in an after_ filter will not halt anything, but you
186
+ can access the model and the attachment if necessary.
187
+
188
+ _NOTE: Post processing will not even *start* if the attachment is not valid
189
+ according to the validations. Your callbacks and processors will *only* be
190
+ called with valid attachments._
191
+
192
+ Testing
193
+ -------
194
+
195
+ Paperclip provides rspec-compatible matchers for testing attachments. See the
196
+ documentation on Paperclip::Shoulda::Matchers for more information.
197
+
198
+ Contributing
199
+ ------------
200
+
201
+ If you'd like to contribute a feature or bugfix: Thanks! To make sure your
202
+ fix/feature has a high chance of being included, please read the following
203
+ guidelines:
204
+
205
+ 1. Ask on the mailing list[http://groups.google.com/group/paperclip-plugin], or
206
+ post a new GitHub Issue[http://github.com/thoughtbot/paperclip/issues].
207
+ 2. Make sure there are tests! We will not accept any patch that is not tested.
208
+ It's a rare time when explicit tests aren't needed. If you have questions
209
+ about writing tests for paperclip, please ask the mailing list.
210
+
211
+ Credits
212
+ -------
213
+
214
+ ![thoughtbot](http://thoughtbot.com/images/tm/logo.png)
215
+
216
+ Paperclip is maintained and funded by [thoughtbot, inc](http://thoughtbot.com/community)
217
+
218
+ Thank you to all [the contributors](https://github.com/thoughtbot/paperclip/contributors)!
219
+
220
+ The names and logos for thoughtbot are trademarks of thoughtbot, inc.
221
+
222
+ License
223
+ -------
224
+
225
+ Paperclip is Copyright © 2008-2011 thoughtbot. It is free software, and may be redistributed under the terms specified in the MIT-LICENSE file.
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-cloudfiles.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,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