paperclip-youtube 2.3.8.1

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