radiant-paperclipped-extension 0.8.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (143) hide show
  1. data/.gitmodules +3 -0
  2. data/HELP_admin.markdown +69 -0
  3. data/LICENSE +21 -0
  4. data/README.md +137 -0
  5. data/Rakefile +110 -0
  6. data/VERSION +1 -0
  7. data/app/controllers/admin/assets_controller.rb +124 -0
  8. data/app/helpers/admin/assets_helper.rb +5 -0
  9. data/app/models/asset.rb +279 -0
  10. data/app/models/asset_page_tags.rb +101 -0
  11. data/app/models/asset_tags.rb +272 -0
  12. data/app/models/old_page_attachment.rb +26 -0
  13. data/app/models/page_attachment.rb +8 -0
  14. data/app/views/admin/assets/_asset.html.haml +19 -0
  15. data/app/views/admin/assets/_asset_table.html.haml +49 -0
  16. data/app/views/admin/assets/_assets_bucket.html.haml +8 -0
  17. data/app/views/admin/assets/_assets_container.html.haml +72 -0
  18. data/app/views/admin/assets/_bucket.html.haml +11 -0
  19. data/app/views/admin/assets/_bucket_asset.html.haml +9 -0
  20. data/app/views/admin/assets/_errors.html.haml +3 -0
  21. data/app/views/admin/assets/_form.html.haml +20 -0
  22. data/app/views/admin/assets/_page_assets.html.haml +12 -0
  23. data/app/views/admin/assets/_search_results.html.haml +17 -0
  24. data/app/views/admin/assets/_show_bucket_link.html.haml +4 -0
  25. data/app/views/admin/assets/_upload_to_page.html.haml +16 -0
  26. data/app/views/admin/assets/edit.html.haml +53 -0
  27. data/app/views/admin/assets/index.html.haml +43 -0
  28. data/app/views/admin/assets/new.html.haml +27 -0
  29. data/app/views/admin/assets/remove.html.haml +21 -0
  30. data/app/views/admin/bucket/_iframe.html.haml +1 -0
  31. data/config/locales/en.yml +60 -0
  32. data/config/locales/nl.yml +60 -0
  33. data/config/locales/pl.yml +60 -0
  34. data/config/routes.rb +20 -0
  35. data/db/migrate/001_create_assets.rb +12 -0
  36. data/db/migrate/002_create_paperclip_attributes.rb +13 -0
  37. data/db/migrate/003_create_user_observer.rb +13 -0
  38. data/db/migrate/004_create_page_attachments.rb +19 -0
  39. data/db/migrate/005_rename_users.rb +13 -0
  40. data/db/migrate/006_add_default_configs.rb +29 -0
  41. data/db/migrate/007_add_default_content_types.rb +29 -0
  42. data/db/migrate/20090316132151_disable_file_types.rb +20 -0
  43. data/lib/assets_admin_ui.rb +38 -0
  44. data/lib/mime_type_ext.rb +7 -0
  45. data/lib/tasks/assets_extension_tasks.rake +123 -0
  46. data/lib/tasks/paperclip_tasks.rake +79 -0
  47. data/lib/url_additions.rb +10 -0
  48. data/paperclipped_extension.rb +56 -0
  49. data/psds/file_type_icons.psd +0 -0
  50. data/psds/file_type_icons_.psd +0 -0
  51. data/public/images/assets/_page_assets.html.haml +26 -0
  52. data/public/images/assets/add-to-bucket.png +0 -0
  53. data/public/images/assets/add.png +0 -0
  54. data/public/images/assets/audio_icon.png +0 -0
  55. data/public/images/assets/audio_thumbnail.png +0 -0
  56. data/public/images/assets/delete.png +0 -0
  57. data/public/images/assets/doc_icon.png +0 -0
  58. data/public/images/assets/doc_thumbnail.png +0 -0
  59. data/public/images/assets/edit.png +0 -0
  60. data/public/images/assets/movie_icon.png +0 -0
  61. data/public/images/assets/movie_thumbnail.png +0 -0
  62. data/public/images/assets/new-asset.png +0 -0
  63. data/public/images/assets/page_edit.png +0 -0
  64. data/public/images/assets/pdf_icon.png +0 -0
  65. data/public/images/assets/pdf_thumbnail.png +0 -0
  66. data/public/images/assets/reorder_assets.png +0 -0
  67. data/public/javascripts/admin/assets.js +173 -0
  68. data/public/stylesheets/admin/assets.css +163 -0
  69. data/spec/controllers/admin/assets_controller_spec.rb +10 -0
  70. data/spec/models/asset_spec.rb +68 -0
  71. data/spec/spec.opts +6 -0
  72. data/spec/spec_helper.rb +27 -0
  73. data/vendor/plugins/acts_as_list/README +23 -0
  74. data/vendor/plugins/acts_as_list/init.rb +3 -0
  75. data/vendor/plugins/acts_as_list/lib/active_record/acts/list.rb +256 -0
  76. data/vendor/plugins/acts_as_list/test/list_test.rb +332 -0
  77. data/vendor/plugins/paperclip/LICENSE +26 -0
  78. data/vendor/plugins/paperclip/README.rdoc +179 -0
  79. data/vendor/plugins/paperclip/Rakefile +76 -0
  80. data/vendor/plugins/paperclip/cucumber/paperclip_steps.rb +6 -0
  81. data/vendor/plugins/paperclip/generators/paperclip/USAGE +5 -0
  82. data/vendor/plugins/paperclip/generators/paperclip/paperclip_generator.rb +27 -0
  83. data/vendor/plugins/paperclip/generators/paperclip/templates/paperclip_migration.rb.erb +19 -0
  84. data/vendor/plugins/paperclip/init.rb +1 -0
  85. data/vendor/plugins/paperclip/lib/generators/paperclip/USAGE +8 -0
  86. data/vendor/plugins/paperclip/lib/generators/paperclip/paperclip_generator.rb +31 -0
  87. data/vendor/plugins/paperclip/lib/generators/paperclip/templates/paperclip_migration.rb.erb +19 -0
  88. data/vendor/plugins/paperclip/lib/paperclip.rb +397 -0
  89. data/vendor/plugins/paperclip/lib/paperclip/attachment.rb +326 -0
  90. data/vendor/plugins/paperclip/lib/paperclip/callback_compatability.rb +61 -0
  91. data/vendor/plugins/paperclip/lib/paperclip/geometry.rb +115 -0
  92. data/vendor/plugins/paperclip/lib/paperclip/interpolations.rb +108 -0
  93. data/vendor/plugins/paperclip/lib/paperclip/iostream.rb +59 -0
  94. data/vendor/plugins/paperclip/lib/paperclip/matchers.rb +33 -0
  95. data/vendor/plugins/paperclip/lib/paperclip/matchers/have_attached_file_matcher.rb +57 -0
  96. data/vendor/plugins/paperclip/lib/paperclip/matchers/validate_attachment_content_type_matcher.rb +74 -0
  97. data/vendor/plugins/paperclip/lib/paperclip/matchers/validate_attachment_presence_matcher.rb +54 -0
  98. data/vendor/plugins/paperclip/lib/paperclip/matchers/validate_attachment_size_matcher.rb +95 -0
  99. data/vendor/plugins/paperclip/lib/paperclip/processor.rb +49 -0
  100. data/vendor/plugins/paperclip/lib/paperclip/railtie.rb +24 -0
  101. data/vendor/plugins/paperclip/lib/paperclip/storage.rb +247 -0
  102. data/vendor/plugins/paperclip/lib/paperclip/style.rb +90 -0
  103. data/vendor/plugins/paperclip/lib/paperclip/thumbnail.rb +78 -0
  104. data/vendor/plugins/paperclip/lib/paperclip/upfile.rb +52 -0
  105. data/vendor/plugins/paperclip/lib/paperclip/version.rb +3 -0
  106. data/vendor/plugins/paperclip/lib/tasks/paperclip.rake +79 -0
  107. data/vendor/plugins/paperclip/paperclip.gemspec +34 -0
  108. data/vendor/plugins/paperclip/rails/init.rb +2 -0
  109. data/vendor/plugins/paperclip/shoulda_macros/paperclip.rb +119 -0
  110. data/vendor/plugins/paperclip/test/.gitignore +1 -0
  111. data/vendor/plugins/paperclip/test/attachment_test.rb +758 -0
  112. data/vendor/plugins/paperclip/test/database.yml +4 -0
  113. data/vendor/plugins/paperclip/test/fixtures/12k.png +0 -0
  114. data/vendor/plugins/paperclip/test/fixtures/50x50.png +0 -0
  115. data/vendor/plugins/paperclip/test/fixtures/5k.png +0 -0
  116. data/vendor/plugins/paperclip/test/fixtures/bad.png +1 -0
  117. data/vendor/plugins/paperclip/test/fixtures/s3.yml +8 -0
  118. data/vendor/plugins/paperclip/test/fixtures/text.txt +0 -0
  119. data/vendor/plugins/paperclip/test/fixtures/twopage.pdf +0 -0
  120. data/vendor/plugins/paperclip/test/geometry_test.rb +177 -0
  121. data/vendor/plugins/paperclip/test/helper.rb +148 -0
  122. data/vendor/plugins/paperclip/test/integration_test.rb +483 -0
  123. data/vendor/plugins/paperclip/test/interpolations_test.rb +124 -0
  124. data/vendor/plugins/paperclip/test/iostream_test.rb +78 -0
  125. data/vendor/plugins/paperclip/test/matchers/have_attached_file_matcher_test.rb +24 -0
  126. data/vendor/plugins/paperclip/test/matchers/validate_attachment_content_type_matcher_test.rb +37 -0
  127. data/vendor/plugins/paperclip/test/matchers/validate_attachment_presence_matcher_test.rb +26 -0
  128. data/vendor/plugins/paperclip/test/matchers/validate_attachment_size_matcher_test.rb +51 -0
  129. data/vendor/plugins/paperclip/test/paperclip_test.rb +317 -0
  130. data/vendor/plugins/paperclip/test/processor_test.rb +10 -0
  131. data/vendor/plugins/paperclip/test/storage_test.rb +343 -0
  132. data/vendor/plugins/paperclip/test/style_test.rb +141 -0
  133. data/vendor/plugins/paperclip/test/thumbnail_test.rb +227 -0
  134. data/vendor/plugins/paperclip/test/upfile_test.rb +36 -0
  135. data/vendor/plugins/responds_to_parent/MIT-LICENSE +20 -0
  136. data/vendor/plugins/responds_to_parent/README +42 -0
  137. data/vendor/plugins/responds_to_parent/Rakefile +22 -0
  138. data/vendor/plugins/responds_to_parent/init.rb +2 -0
  139. data/vendor/plugins/responds_to_parent/lib/parent_selector_assertion.rb +144 -0
  140. data/vendor/plugins/responds_to_parent/lib/responds_to_parent.rb +46 -0
  141. data/vendor/plugins/responds_to_parent/test/assert_select_parent_test.rb +318 -0
  142. data/vendor/plugins/responds_to_parent/test/responds_to_parent_test.rb +115 -0
  143. metadata +226 -0
@@ -0,0 +1,26 @@
1
+
2
+ LICENSE
3
+
4
+ The MIT License
5
+
6
+ Copyright (c) 2008 Jon Yurek and thoughtbot, inc.
7
+
8
+ Permission is hereby granted, free of charge, to any person obtaining a copy
9
+ of this software and associated documentation files (the "Software"), to deal
10
+ in the Software without restriction, including without limitation the rights
11
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
12
+ copies of the Software, and to permit persons to whom the Software is
13
+ furnished to do so, subject to the following conditions:
14
+
15
+ The above copyright notice and this permission notice shall be included in
16
+ all copies or substantial portions of the Software.
17
+
18
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
19
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
20
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
21
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
22
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
23
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
24
+ THE SOFTWARE.
25
+
26
+
@@ -0,0 +1,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.
@@ -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,6 @@
1
+ When /^I attach an? "([^\"]*)" "([^\"]*)" file to an? "([^\"]*)" on S3$/ do |attachment, extension, model|
2
+ stub_paperclip_s3(model, attachment, extension)
3
+ attach_file attachment,
4
+ "features/support/paperclip/#{model.gsub(" ", "_").underscore}/#{attachment}.#{extension}"
5
+ end
6
+
@@ -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
@@ -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
@@ -0,0 +1,397 @@
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 'tempfile'
30
+ require 'paperclip/version'
31
+ require 'paperclip/upfile'
32
+ require 'paperclip/iostream'
33
+ require 'paperclip/geometry'
34
+ require 'paperclip/processor'
35
+ require 'paperclip/thumbnail'
36
+ require 'paperclip/storage'
37
+ require 'paperclip/interpolations'
38
+ require 'paperclip/style'
39
+ require 'paperclip/attachment'
40
+ require 'paperclip/callback_compatability'
41
+ require 'paperclip/railtie'
42
+ if defined?(Rails.root) && Rails.root
43
+ Dir.glob(File.join(File.expand_path(Rails.root), "lib", "paperclip_processors", "*.rb")).each do |processor|
44
+ require processor
45
+ end
46
+ end
47
+
48
+ # The base module that gets included in ActiveRecord::Base. See the
49
+ # documentation for Paperclip::ClassMethods for more useful information.
50
+ module Paperclip
51
+
52
+ class << self
53
+ # Provides configurability to Paperclip. There are a number of options available, such as:
54
+ # * whiny: Will raise an error if Paperclip cannot process thumbnails of
55
+ # an uploaded image. Defaults to true.
56
+ # * log: Logs progress to the Rails log. Uses ActiveRecord's logger, so honors
57
+ # log levels, etc. Defaults to true.
58
+ # * command_path: Defines the path at which to find the command line
59
+ # programs if they are not visible to Rails the system's search path. Defaults to
60
+ # nil, which uses the first executable found in the user's search path.
61
+ # * image_magick_path: Deprecated alias of command_path.
62
+ def options
63
+ @options ||= {
64
+ :whiny => true,
65
+ :image_magick_path => nil,
66
+ :command_path => nil,
67
+ :log => true,
68
+ :log_command => true,
69
+ :swallow_stderr => true
70
+ }
71
+ end
72
+
73
+ def configure
74
+ yield(self) if block_given?
75
+ end
76
+
77
+ def path_for_command command #:nodoc:
78
+ if options[:image_magick_path]
79
+ warn("[DEPRECATION] :image_magick_path is deprecated and will be removed. Use :command_path instead")
80
+ end
81
+ path = [options[:command_path] || options[:image_magick_path], command].compact
82
+ File.join(*path)
83
+ end
84
+
85
+ def interpolates key, &block
86
+ Paperclip::Interpolations[key] = block
87
+ end
88
+
89
+ # The run method takes a command to execute and an array of parameters
90
+ # that get passed to it. The command is prefixed with the :command_path
91
+ # option from Paperclip.options. If you have many commands to run and
92
+ # they are in different paths, the suggested course of action is to
93
+ # symlink them so they are all in the same directory.
94
+ #
95
+ # If the command returns with a result code that is not one of the
96
+ # expected_outcodes, a PaperclipCommandLineError will be raised. Generally
97
+ # a code of 0 is expected, but a list of codes may be passed if necessary.
98
+ # These codes should be passed as a hash as the last argument, like so:
99
+ #
100
+ # Paperclip.run("echo", "something", :expected_outcodes => [0,1,2,3])
101
+ #
102
+ # This method can log the command being run when
103
+ # Paperclip.options[:log_command] is set to true (defaults to false). This
104
+ # will only log if logging in general is set to true as well.
105
+ def run cmd, *params
106
+ options = params.last.is_a?(Hash) ? params.pop : {}
107
+ expected_outcodes = options[:expected_outcodes] || [0]
108
+ params = quote_command_options(*params).join(" ")
109
+
110
+ command = %Q[#{path_for_command(cmd)} #{params}]
111
+ command = "#{command} 2>#{bit_bucket}" if Paperclip.options[:swallow_stderr]
112
+ Paperclip.log(command) if Paperclip.options[:log_command]
113
+
114
+ begin
115
+ output = `#{command}`
116
+
117
+ raise CommandNotFoundError if $?.exitstatus == 127
118
+
119
+ unless expected_outcodes.include?($?.exitstatus)
120
+ raise PaperclipCommandLineError,
121
+ "Error while running #{cmd}. Expected return code to be #{expected_outcodes.join(", ")} but was #{$?.exitstatus}",
122
+ output
123
+ end
124
+ rescue Errno::ENOENT => e
125
+ raise CommandNotFoundError
126
+ end
127
+
128
+ output
129
+ end
130
+
131
+ def quote_command_options(*options)
132
+ options.map do |option|
133
+ option.split("'").map{|m| "'#{m}'" }.join("\\'")
134
+ end
135
+ end
136
+
137
+ def bit_bucket #:nodoc:
138
+ File.exists?("/dev/null") ? "/dev/null" : "NUL"
139
+ end
140
+
141
+ def included base #:nodoc:
142
+ base.extend ClassMethods
143
+ if base.respond_to?("set_callback")
144
+ base.send :include, Paperclip::CallbackCompatability::Rails3
145
+ else
146
+ base.send :include, Paperclip::CallbackCompatability::Rails21
147
+ end
148
+ end
149
+
150
+ def processor name #:nodoc:
151
+ name = name.to_s.camelize
152
+ processor = Paperclip.const_get(name)
153
+ unless processor.ancestors.include?(Paperclip::Processor)
154
+ raise PaperclipError.new("Processor #{name} was not found")
155
+ end
156
+ processor
157
+ end
158
+
159
+ # Log a paperclip-specific line. Uses ActiveRecord::Base.logger
160
+ # by default. Set Paperclip.options[:log] to false to turn off.
161
+ def log message
162
+ logger.info("[paperclip] #{message}") if logging?
163
+ end
164
+
165
+ def logger #:nodoc:
166
+ ActiveRecord::Base.logger
167
+ end
168
+
169
+ def logging? #:nodoc:
170
+ options[:log]
171
+ end
172
+ end
173
+
174
+ class PaperclipError < StandardError #:nodoc:
175
+ end
176
+
177
+ class PaperclipCommandLineError < PaperclipError #:nodoc:
178
+ attr_accessor :output
179
+ def initialize(msg = nil, output = nil)
180
+ super(msg)
181
+ @output = output
182
+ end
183
+ end
184
+
185
+ class CommandNotFoundError < PaperclipError
186
+ end
187
+
188
+ class NotIdentifiedByImageMagickError < PaperclipError #:nodoc:
189
+ end
190
+
191
+ class InfiniteInterpolationError < PaperclipError #:nodoc:
192
+ end
193
+
194
+ module ClassMethods
195
+ # +has_attached_file+ gives the class it is called on an attribute that maps to a file. This
196
+ # is typically a file stored somewhere on the filesystem and has been uploaded by a user.
197
+ # The attribute returns a Paperclip::Attachment object which handles the management of
198
+ # that file. The intent is to make the attachment as much like a normal attribute. The
199
+ # thumbnails will be created when the new file is assigned, but they will *not* be saved
200
+ # until +save+ is called on the record. Likewise, if the attribute is set to +nil+ is
201
+ # called on it, the attachment will *not* be deleted until +save+ is called. See the
202
+ # Paperclip::Attachment documentation for more specifics. There are a number of options
203
+ # you can set to change the behavior of a Paperclip attachment:
204
+ # * +url+: The full URL of where the attachment is publically accessible. This can just
205
+ # as easily point to a directory served directly through Apache as it can to an action
206
+ # that can control permissions. You can specify the full domain and path, but usually
207
+ # just an absolute path is sufficient. The leading slash *must* be included manually for
208
+ # absolute paths. The default value is
209
+ # "/system/:attachment/:id/:style/:filename". See
210
+ # Paperclip::Attachment#interpolate for more information on variable interpolaton.
211
+ # :url => "/:class/:attachment/:id/:style_:filename"
212
+ # :url => "http://some.other.host/stuff/:class/:id_:extension"
213
+ # * +default_url+: The URL that will be returned if there is no attachment assigned.
214
+ # This field is interpolated just as the url is. The default value is
215
+ # "/:attachment/:style/missing.png"
216
+ # has_attached_file :avatar, :default_url => "/images/default_:style_avatar.png"
217
+ # User.new.avatar_url(:small) # => "/images/default_small_avatar.png"
218
+ # * +styles+: A hash of thumbnail styles and their geometries. You can find more about
219
+ # geometry strings at the ImageMagick website
220
+ # (http://www.imagemagick.org/script/command-line-options.php#resize). Paperclip
221
+ # also adds the "#" option (e.g. "50x50#"), which will resize the image to fit maximally
222
+ # inside the dimensions and then crop the rest off (weighted at the center). The
223
+ # default value is to generate no thumbnails.
224
+ # * +default_style+: The thumbnail style that will be used by default URLs.
225
+ # Defaults to +original+.
226
+ # has_attached_file :avatar, :styles => { :normal => "100x100#" },
227
+ # :default_style => :normal
228
+ # user.avatar.url # => "/avatars/23/normal_me.png"
229
+ # * +whiny+: Will raise an error if Paperclip cannot post_process an uploaded file due
230
+ # to a command line error. This will override the global setting for this attachment.
231
+ # Defaults to true. This option used to be called :whiny_thumbanils, but this is
232
+ # deprecated.
233
+ # * +convert_options+: When creating thumbnails, use this free-form options
234
+ # array to pass in various convert command options. Typical options are "-strip" to
235
+ # remove all Exif data from the image (save space for thumbnails and avatars) or
236
+ # "-depth 8" to specify the bit depth of the resulting conversion. See ImageMagick
237
+ # convert documentation for more options: (http://www.imagemagick.org/script/convert.php)
238
+ # Note that this option takes a hash of options, each of which correspond to the style
239
+ # of thumbnail being generated. You can also specify :all as a key, which will apply
240
+ # to all of the thumbnails being generated. If you specify options for the :original,
241
+ # it would be best if you did not specify destructive options, as the intent of keeping
242
+ # the original around is to regenerate all the thumbnails when requirements change.
243
+ # has_attached_file :avatar, :styles => { :large => "300x300", :negative => "100x100" }
244
+ # :convert_options => {
245
+ # :all => "-strip",
246
+ # :negative => "-negate"
247
+ # }
248
+ # NOTE: While not deprecated yet, it is not recommended to specify options this way.
249
+ # It is recommended that :convert_options option be included in the hash passed to each
250
+ # :styles for compatability with future versions.
251
+ # NOTE: Strings supplied to :convert_options are split on space in order to undergo
252
+ # shell quoting for safety. If your options require a space, please pre-split them
253
+ # and pass an array to :convert_options instead.
254
+ # * +storage+: Chooses the storage backend where the files will be stored. The current
255
+ # choices are :filesystem and :s3. The default is :filesystem. Make sure you read the
256
+ # documentation for Paperclip::Storage::Filesystem and Paperclip::Storage::S3
257
+ # for backend-specific options.
258
+ def has_attached_file name, options = {}
259
+ include InstanceMethods
260
+
261
+ write_inheritable_attribute(:attachment_definitions, {}) if attachment_definitions.nil?
262
+ attachment_definitions[name] = {:validations => []}.merge(options)
263
+
264
+ after_save :save_attached_files
265
+ before_destroy :destroy_attached_files
266
+
267
+ define_paperclip_callbacks :post_process, :"#{name}_post_process"
268
+
269
+ define_method name do |*args|
270
+ a = attachment_for(name)
271
+ (args.length > 0) ? a.to_s(args.first) : a
272
+ end
273
+
274
+ define_method "#{name}=" do |file|
275
+ attachment_for(name).assign(file)
276
+ end
277
+
278
+ define_method "#{name}?" do
279
+ attachment_for(name).file?
280
+ end
281
+
282
+ validates_each(name) do |record, attr, value|
283
+ attachment = record.attachment_for(name)
284
+ attachment.send(:flush_errors)
285
+ end
286
+ end
287
+
288
+ # Places ActiveRecord-style validations on the size of the file assigned. The
289
+ # possible options are:
290
+ # * +in+: a Range of bytes (i.e. +1..1.megabyte+),
291
+ # * +less_than+: equivalent to :in => 0..options[:less_than]
292
+ # * +greater_than+: equivalent to :in => options[:greater_than]..Infinity
293
+ # * +message+: error message to display, use :min and :max as replacements
294
+ # * +if+: A lambda or name of a method on the instance. Validation will only
295
+ # be run is this lambda or method returns true.
296
+ # * +unless+: Same as +if+ but validates if lambda or method returns false.
297
+ def validates_attachment_size name, options = {}
298
+ min = options[:greater_than] || (options[:in] && options[:in].first) || 0
299
+ max = options[:less_than] || (options[:in] && options[:in].last) || (1.0/0)
300
+ range = (min..max)
301
+ message = options[:message] || "file size must be between :min and :max bytes."
302
+ message = message.gsub(/:min/, min.to_s).gsub(/:max/, max.to_s)
303
+
304
+ validates_inclusion_of :"#{name}_file_size",
305
+ :in => range,
306
+ :message => message,
307
+ :if => options[:if],
308
+ :unless => options[:unless]
309
+ end
310
+
311
+ # Adds errors if thumbnail creation fails. The same as specifying :whiny_thumbnails => true.
312
+ def validates_attachment_thumbnails name, options = {}
313
+ warn('[DEPRECATION] validates_attachment_thumbnail is deprecated. ' +
314
+ 'This validation is on by default and will be removed from future versions. ' +
315
+ 'If you wish to turn it off, supply :whiny => false in your definition.')
316
+ attachment_definitions[name][:whiny_thumbnails] = true
317
+ end
318
+
319
+ # Places ActiveRecord-style validations on the presence of a file.
320
+ # Options:
321
+ # * +if+: A lambda or name of a method on the instance. Validation will only
322
+ # be run is this lambda or method returns true.
323
+ # * +unless+: Same as +if+ but validates if lambda or method returns false.
324
+ def validates_attachment_presence name, options = {}
325
+ message = options[:message] || "must be set."
326
+ validates_presence_of :"#{name}_file_name",
327
+ :message => message,
328
+ :if => options[:if],
329
+ :unless => options[:unless]
330
+ end
331
+
332
+ # Places ActiveRecord-style validations on the content type of the file
333
+ # assigned. The possible options are:
334
+ # * +content_type+: Allowed content types. Can be a single content type
335
+ # or an array. Each type can be a String or a Regexp. It should be
336
+ # noted that Internet Explorer upload files with content_types that you
337
+ # may not expect. For example, JPEG images are given image/pjpeg and
338
+ # PNGs are image/x-png, so keep that in mind when determining how you
339
+ # match. Allows all by default.
340
+ # * +message+: The message to display when the uploaded file has an invalid
341
+ # content type.
342
+ # * +if+: A lambda or name of a method on the instance. Validation will only
343
+ # be run is this lambda or method returns true.
344
+ # * +unless+: Same as +if+ but validates if lambda or method returns false.
345
+ # NOTE: If you do not specify an [attachment]_content_type field on your
346
+ # model, content_type validation will work _ONLY upon assignment_ and
347
+ # re-validation after the instance has been reloaded will always succeed.
348
+ def validates_attachment_content_type name, options = {}
349
+ types = [options.delete(:content_type)].flatten
350
+ validates_each(:"#{name}_content_type", options) do |record, attr, value|
351
+ unless types.any?{|t| t === value }
352
+ if record.errors.method(:add).arity == -2
353
+ message = options[:message] || "is not one of #{types.join(", ")}"
354
+ record.errors.add(:"#{name}_content_type", message)
355
+ else
356
+ record.errors.add(:"#{name}_content_type", :inclusion, :default => options[:message], :value => value)
357
+ end
358
+ end
359
+ end
360
+ end
361
+
362
+ # Returns the attachment definitions defined by each call to
363
+ # has_attached_file.
364
+ def attachment_definitions
365
+ read_inheritable_attribute(:attachment_definitions)
366
+ end
367
+ end
368
+
369
+ module InstanceMethods #:nodoc:
370
+ def attachment_for name
371
+ @_paperclip_attachments ||= {}
372
+ @_paperclip_attachments[name] ||= Attachment.new(name, self, self.class.attachment_definitions[name])
373
+ end
374
+
375
+ def each_attachment
376
+ self.class.attachment_definitions.each do |name, definition|
377
+ yield(name, attachment_for(name))
378
+ end
379
+ end
380
+
381
+ def save_attached_files
382
+ Paperclip.log("Saving attachments.")
383
+ each_attachment do |name, attachment|
384
+ attachment.send(:save)
385
+ end
386
+ end
387
+
388
+ def destroy_attached_files
389
+ Paperclip.log("Deleting attachments.")
390
+ each_attachment do |name, attachment|
391
+ attachment.send(:queue_existing_for_delete)
392
+ attachment.send(:flush_deletes)
393
+ end
394
+ end
395
+ end
396
+
397
+ end