paperclip-hacked 2.3.1.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 (48) hide show
  1. data/LICENSE +26 -0
  2. data/README.rdoc +179 -0
  3. data/Rakefile +103 -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/paperclip.rb +357 -0
  9. data/lib/paperclip/attachmenta.rb +334 -0
  10. data/lib/paperclip/callback_compatability.rb +33 -0
  11. data/lib/paperclip/geometry.rb +115 -0
  12. data/lib/paperclip/interpolations.rb +108 -0
  13. data/lib/paperclip/iostream.rb +59 -0
  14. data/lib/paperclip/matchers.rb +33 -0
  15. data/lib/paperclip/matchers/have_attached_file_matcher.rb +57 -0
  16. data/lib/paperclip/matchers/validate_attachment_content_type_matcher.rb +75 -0
  17. data/lib/paperclip/matchers/validate_attachment_presence_matcher.rb +55 -0
  18. data/lib/paperclip/matchers/validate_attachment_size_matcher.rb +96 -0
  19. data/lib/paperclip/processor.rb +49 -0
  20. data/lib/paperclip/storage.rb +247 -0
  21. data/lib/paperclip/thumbnail.rb +75 -0
  22. data/lib/paperclip/upfile.rb +50 -0
  23. data/shoulda_macros/paperclip.rb +117 -0
  24. data/tasks/paperclip_tasks.rake +79 -0
  25. data/test/attachment_test.rb +764 -0
  26. data/test/database.yml +4 -0
  27. data/test/fixtures/12k.png +0 -0
  28. data/test/fixtures/50x50.png +0 -0
  29. data/test/fixtures/5k.png +0 -0
  30. data/test/fixtures/bad.png +1 -0
  31. data/test/fixtures/s3.yml +8 -0
  32. data/test/fixtures/text.txt +0 -0
  33. data/test/fixtures/twopage.pdf +0 -0
  34. data/test/geometry_test.rb +177 -0
  35. data/test/helper.rb +128 -0
  36. data/test/integration_test.rb +483 -0
  37. data/test/interpolations_test.rb +124 -0
  38. data/test/iostream_test.rb +78 -0
  39. data/test/matchers/have_attached_file_matcher_test.rb +24 -0
  40. data/test/matchers/validate_attachment_content_type_matcher_test.rb +37 -0
  41. data/test/matchers/validate_attachment_presence_matcher_test.rb +26 -0
  42. data/test/matchers/validate_attachment_size_matcher_test.rb +51 -0
  43. data/test/paperclip_test.rb +298 -0
  44. data/test/processor_test.rb +10 -0
  45. data/test/storage_test.rb +330 -0
  46. data/test/thumbnail_test.rb +227 -0
  47. data/test/upfile_test.rb +36 -0
  48. metadata +185 -0
data/LICENSE ADDED
@@ -0,0 +1,26 @@
1
+
2
+ LICENSE
3
+
4
+ The MIT License
5
+
6
+ Copyright (c) 2008 Jon Yurek and thoughtbot, inc.
7
+
8
+ Permission is hereby granted, free of charge, to any person obtaining a copy
9
+ of this software and associated documentation files (the "Software"), to deal
10
+ in the Software without restriction, including without limitation the rights
11
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
12
+ copies of the Software, and to permit persons to whom the Software is
13
+ furnished to do so, subject to the following conditions:
14
+
15
+ The above copyright notice and this permission notice shall be included in
16
+ all copies or substantial portions of the Software.
17
+
18
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
19
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
20
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
21
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
22
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
23
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
24
+ THE SOFTWARE.
25
+
26
+
data/README.rdoc ADDED
@@ -0,0 +1,179 @@
1
+ =Paperclip
2
+
3
+ Paperclip is intended as an easy file attachment library for ActiveRecord. The
4
+ intent behind it was to keep setup as easy as possible and to treat files as
5
+ much like other attributes as possible. This means they aren't saved to their
6
+ final locations on disk, nor are they deleted if set to nil, until
7
+ ActiveRecord::Base#save is called. It manages validations based on size and
8
+ presence, if required. It can transform its assigned image into thumbnails if
9
+ needed, and the prerequisites are as simple as installing ImageMagick (which,
10
+ for most modern Unix-based systems, is as easy as installing the right
11
+ packages). Attached files are saved to the filesystem and referenced in the
12
+ browser by an easily understandable specification, which has sensible and
13
+ useful defaults.
14
+
15
+ See the documentation for +has_attached_file+ in Paperclip::ClassMethods for
16
+ more detailed options.
17
+
18
+ ==Quick Start
19
+
20
+ In your model:
21
+
22
+ class User < ActiveRecord::Base
23
+ has_attached_file :avatar, :styles => { :medium => "300x300>", :thumb => "100x100>" }
24
+ end
25
+
26
+ In your migrations:
27
+
28
+ class AddAvatarColumnsToUser < ActiveRecord::Migration
29
+ def self.up
30
+ add_column :users, :avatar_file_name, :string
31
+ add_column :users, :avatar_content_type, :string
32
+ add_column :users, :avatar_file_size, :integer
33
+ add_column :users, :avatar_updated_at, :datetime
34
+ end
35
+
36
+ def self.down
37
+ remove_column :users, :avatar_file_name
38
+ remove_column :users, :avatar_content_type
39
+ remove_column :users, :avatar_file_size
40
+ remove_column :users, :avatar_updated_at
41
+ end
42
+ end
43
+
44
+ In your edit and new views:
45
+
46
+ <% form_for :user, @user, :url => user_path, :html => { :multipart => true } do |form| %>
47
+ <%= form.file_field :avatar %>
48
+ <% end %>
49
+
50
+ In your controller:
51
+
52
+ def create
53
+ @user = User.create( params[:user] )
54
+ end
55
+
56
+ In your show view:
57
+
58
+ <%= image_tag @user.avatar.url %>
59
+ <%= image_tag @user.avatar.url(:medium) %>
60
+ <%= image_tag @user.avatar.url(:thumb) %>
61
+
62
+ ==Usage
63
+
64
+ The basics of paperclip are quite simple: Declare that your model has an
65
+ attachment with the has_attached_file method, and give it a name. Paperclip
66
+ will wrap up up to four attributes (all prefixed with that attachment's name,
67
+ so you can have multiple attachments per model if you wish) and give the a
68
+ friendly front end. The attributes are <attachment>_file_name,
69
+ <attachment>_file_size, <attachment>_content_type, and <attachment>_updated_at.
70
+ Only <attachment>_file_name is required for paperclip to operate. More
71
+ information about the options to has_attached_file is available in the
72
+ documentation of Paperclip::ClassMethods.
73
+
74
+ Attachmentas can be validated with Paperclip's validation methods,
75
+ validates_attachment_presence, validates_attachment_content_type, and
76
+ validates_attachment_size.
77
+
78
+ ==Storage
79
+
80
+ The files that are assigned as attachments are, by default, placed in the
81
+ directory specified by the :path option to has_attached_file. By default, this
82
+ location is ":rails_root/public/system/:attachment/:id/:style/:filename". This
83
+ location was chosen because on standard Capistrano deployments, the
84
+ public/system directory is symlinked to the app's shared directory, meaning it
85
+ will survive between deployments. For example, using that :path, you may have a
86
+ file at
87
+
88
+ /data/myapp/releases/20081229172410/public/system/avatars/13/small/my_pic.png
89
+
90
+ NOTE: This is a change from previous versions of Paperclip, but is overall a
91
+ safer choice for the default file store.
92
+
93
+ You may also choose to store your files using Amazon's S3 service. You can find
94
+ more information about S3 storage at the description for
95
+ Paperclip::Storage::S3.
96
+
97
+ Files on the local filesystem (and in the Rails app's public directory) will be
98
+ available to the internet at large. If you require access control, it's
99
+ possible to place your files in a different location. You will need to change
100
+ both the :path and :url options in order to make sure the files are unavailable
101
+ to the public. Both :path and :url allow the same set of interpolated
102
+ variables.
103
+
104
+ ==Post Processing
105
+
106
+ Paperclip supports an extensible selection of post-processors. When you define
107
+ a set of styles for an attachment, by default it is expected that those
108
+ "styles" are actually "thumbnails". However, you can do much more than just
109
+ thumbnail images. By defining a subclass of Paperclip::Processor, you can
110
+ perform any processing you want on the files that are attached. Any file in
111
+ your Rails app's lib/paperclip_processors directory is automatically loaded by
112
+ paperclip, allowing you to easily define custom processors. You can specify a
113
+ processor with the :processors option to has_attached_file:
114
+
115
+ has_attached_file :scan, :styles => { :text => { :quality => :better } },
116
+ :processors => [:ocr]
117
+
118
+ This would load the hypothetical class Paperclip::Ocr, which would have the
119
+ hash "{ :quality => :better }" passed to it along with the uploaded file. For
120
+ more information about defining processors, see Paperclip::Processor.
121
+
122
+ The default processor is Paperclip::Thumbnail. For backwards compatability
123
+ reasons, you can pass a single geometry string or an array containing a
124
+ geometry and a format, which the file will be converted to, like so:
125
+
126
+ has_attached_file :avatar, :styles => { :thumb => ["32x32#", :png] }
127
+
128
+ This will convert the "thumb" style to a 32x32 square in png format, regardless
129
+ of what was uploaded. If the format is not specified, it is kept the same (i.e.
130
+ jpgs will remain jpgs).
131
+
132
+ Multiple processors can be specified, and they will be invoked in the order
133
+ they are defined in the :processors array. Each successive processor will
134
+ be given the result of the previous processor's execution. All processors will
135
+ receive the same parameters, which are what you define in the :styles hash.
136
+ For example, assuming we had this definition:
137
+
138
+ has_attached_file :scan, :styles => { :text => { :quality => :better } },
139
+ :processors => [:rotator, :ocr]
140
+
141
+ then both the :rotator processor and the :ocr processor would receive the
142
+ options "{ :quality => :better }". This parameter may not mean anything to one
143
+ or more or the processors, and they are expected to ignore it.
144
+
145
+ NOTE: Because processors operate by turning the original attachment into the
146
+ styles, no processors will be run if there are no styles defined.
147
+
148
+ ==Events
149
+
150
+ Before and after the Post Processing step, Paperclip calls back to the model
151
+ with a few callbacks, allowing the model to change or cancel the processing
152
+ step. The callbacks are "before_post_process" and "after_post_process" (which
153
+ are called before and after the processing of each attachment), and the
154
+ attachment-specific "before_<attachment>_post_process" and
155
+ "after_<attachment>_post_process". The callbacks are intended to be as close to
156
+ normal ActiveRecord callbacks as possible, so if you return false (specifically
157
+ - returning nil is not the same) in a before_ filter, the post processing step
158
+ will halt. Returning false in an after_ filter will not halt anything, but you
159
+ can access the model and the attachment if necessary.
160
+
161
+ NOTE: Post processing will not even *start* if the attachment is not valid
162
+ according to the validations. Your callbacks and processors will *only* be
163
+ called with valid attachments.
164
+
165
+ ==Testing
166
+
167
+ Paperclip provides rspec-compatible matchers for testing attachments. See the
168
+ documentation on Paperclip::Shoulda::Matchers for more information.
169
+
170
+ ==Contributing
171
+
172
+ If you'd like to contribute a feature or bugfix: Thanks! To make sure your
173
+ fix/feature has a high chance of being included, please read the following
174
+ guidelines:
175
+
176
+ 1. Ask on the mailing list, or post a new GitHub Issue.
177
+ 2. Make sure there are tests! We will not accept any patch that is not tested.
178
+ It's a rare time when explicit tests aren't needed. If you have questions
179
+ about writing tests for paperclip, please ask the mailing list.
data/Rakefile ADDED
@@ -0,0 +1,103 @@
1
+ require 'rake'
2
+ require 'rake/testtask'
3
+ require 'rake/rdoctask'
4
+
5
+ $LOAD_PATH << File.join(File.dirname(__FILE__), 'lib')
6
+ require 'paperclip'
7
+
8
+ desc 'Default: run unit tests.'
9
+ task :default => [:clean, :test]
10
+
11
+ desc 'Test the paperclip plugin.'
12
+ Rake::TestTask.new(:test) do |t|
13
+ t.libs << 'lib' << 'profile'
14
+ t.pattern = 'test/**/*_test.rb'
15
+ t.verbose = true
16
+ end
17
+
18
+ desc 'Start an IRB session with all necessary files required.'
19
+ task :shell do |t|
20
+ chdir File.dirname(__FILE__)
21
+ exec 'irb -I lib/ -I lib/paperclip -r rubygems -r active_record -r tempfile -r init'
22
+ end
23
+
24
+ desc 'Generate documentation for the paperclip plugin.'
25
+ Rake::RDocTask.new(:rdoc) do |rdoc|
26
+ rdoc.rdoc_dir = 'doc'
27
+ rdoc.title = 'Paperclip'
28
+ rdoc.options << '--line-numbers' << '--inline-source'
29
+ rdoc.rdoc_files.include('README*')
30
+ rdoc.rdoc_files.include('lib/**/*.rb')
31
+ end
32
+
33
+ desc 'Update documentation on website'
34
+ task :sync_docs => 'rdoc' do
35
+ `rsync -ave ssh doc/ dev@dev.thoughtbot.com:/home/dev/www/dev.thoughtbot.com/paperclip`
36
+ end
37
+
38
+ desc 'Clean up files.'
39
+ task :clean do |t|
40
+ FileUtils.rm_rf "doc"
41
+ FileUtils.rm_rf "tmp"
42
+ FileUtils.rm_rf "pkg"
43
+ FileUtils.rm "test/debug.log" rescue nil
44
+ FileUtils.rm "test/paperclip.db" rescue nil
45
+ Dir.glob("paperclip-*.gem").each{|f| FileUtils.rm f }
46
+ end
47
+
48
+ include_file_globs = ["README*",
49
+ "LICENSE",
50
+ "Rakefile",
51
+ "init.rb",
52
+ "{generators,lib,tasks,test,shoulda_macros}/**/*"]
53
+ exclude_file_globs = ["test/s3.yml",
54
+ "test/debug.log",
55
+ "test/paperclip.db",
56
+ "test/doc",
57
+ "test/doc/*",
58
+ "test/pkg",
59
+ "test/pkg/*",
60
+ "test/tmp",
61
+ "test/tmp/*"]
62
+ spec = Gem::Specification.new do |s|
63
+ s.name = "paperclip"
64
+ s.version = Paperclip::VERSION
65
+ s.author = "Jon Yurek"
66
+ s.email = "jyurek@thoughtbot.com"
67
+ s.homepage = "http://www.thoughtbot.com/projects/paperclip"
68
+ s.platform = Gem::Platform::RUBY
69
+ s.summary = "File attachments as attributes for ActiveRecord"
70
+ s.files = FileList[include_file_globs].to_a - FileList[exclude_file_globs].to_a
71
+ s.require_path = "lib"
72
+ s.test_files = FileList["test/**/test_*.rb"].to_a
73
+ s.rubyforge_project = "paperclip"
74
+ s.has_rdoc = true
75
+ s.extra_rdoc_files = FileList["README*"].to_a
76
+ s.rdoc_options << '--line-numbers' << '--inline-source'
77
+ s.requirements << "ImageMagick"
78
+ s.add_development_dependency 'shoulda'
79
+ s.add_development_dependency 'jferris-mocha', '>= 0.9.5.0.1241126838'
80
+ s.add_development_dependency 'aws-s3'
81
+ s.add_development_dependency 'sqlite3-ruby'
82
+ s.add_development_dependency 'activerecord'
83
+ s.add_development_dependency 'activesupport'
84
+ end
85
+
86
+ desc "Print a list of the files to be put into the gem"
87
+ task :manifest => :clean do
88
+ spec.files.each do |file|
89
+ puts file
90
+ end
91
+ end
92
+
93
+ desc "Generate a gemspec file for GitHub"
94
+ task :gemspec => :clean do
95
+ File.open("#{spec.name}.gemspec", 'w') do |f|
96
+ f.write spec.to_ruby
97
+ end
98
+ end
99
+
100
+ desc "Build the gem into the current directory"
101
+ task :gem => :gemspec do
102
+ `gem build #{spec.name}.gemspec`
103
+ 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")
data/lib/paperclip.rb ADDED
@@ -0,0 +1,357 @@
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/upfile'
31
+ require 'paperclip/iostream'
32
+ require 'paperclip/geometry'
33
+ require 'paperclip/processor'
34
+ require 'paperclip/thumbnail'
35
+ require 'paperclip/storage'
36
+ require 'paperclip/interpolations'
37
+ require 'paperclip/style'
38
+ require 'paperclip/attachmenta'
39
+ if defined? RAILS_ROOT
40
+ Dir.glob(File.join(File.expand_path(RAILS_ROOT), "lib", "paperclip_processors", "*.rb")).each do |processor|
41
+ require processor
42
+ end
43
+ end
44
+
45
+ # The base module that gets included in ActiveRecord::Base. See the
46
+ # documentation for Paperclip::ClassMethods for more useful information.
47
+ module Paperclip
48
+
49
+ VERSION = "2.3.1.1"
50
+
51
+ class << self
52
+ # Provides configurability to Paperclip. There are a number of options available, such as:
53
+ # * whiny: Will raise an error if Paperclip cannot process thumbnails of
54
+ # an uploaded image. Defaults to true.
55
+ # * log: Logs progress to the Rails log. Uses ActiveRecord's logger, so honors
56
+ # log levels, etc. Defaults to true.
57
+ # * command_path: Defines the path at which to find the command line
58
+ # programs if they are not visible to Rails the system's search path. Defaults to
59
+ # nil, which uses the first executable found in the user's search path.
60
+ # * image_magick_path: Deprecated alias of command_path.
61
+ def options
62
+ @options ||= {
63
+ :whiny => true,
64
+ :image_magick_path => nil,
65
+ :command_path => nil,
66
+ :log => true,
67
+ :log_command => false,
68
+ :swallow_stderr => true
69
+ }
70
+ end
71
+
72
+ def path_for_command command #:nodoc:
73
+ if options[:image_magick_path]
74
+ warn("[DEPRECATION] :image_magick_path is deprecated and will be removed. Use :command_path instead")
75
+ end
76
+ path = [options[:command_path] || options[:image_magick_path], command].compact
77
+ File.join(*path)
78
+ end
79
+
80
+ def interpolates key, &block
81
+ Paperclip::Interpolations[key] = block
82
+ end
83
+
84
+ # The run method takes a command to execute and a string of parameters
85
+ # that get passed to it. The command is prefixed with the :command_path
86
+ # option from Paperclip.options. If you have many commands to run and
87
+ # they are in different paths, the suggested course of action is to
88
+ # symlink them so they are all in the same directory.
89
+ #
90
+ # If the command returns with a result code that is not one of the
91
+ # expected_outcodes, a PaperclipCommandLineError will be raised. Generally
92
+ # a code of 0 is expected, but a list of codes may be passed if necessary.
93
+ #
94
+ # This method can log the command being run when
95
+ # Paperclip.options[:log_command] is set to true (defaults to false). This
96
+ # will only log if logging in general is set to true as well.
97
+ def run cmd, params = "", expected_outcodes = 0
98
+ command = %Q[#{path_for_command(cmd)} #{params}].gsub(/\s+/, " ")
99
+ command = "#{command} 2>#{bit_bucket}" if Paperclip.options[:swallow_stderr]
100
+ Paperclip.log(command) if Paperclip.options[:log_command]
101
+ output = `#{command}`
102
+ unless [expected_outcodes].flatten.include?($?.exitstatus)
103
+ raise PaperclipCommandLineError, "Error while running #{cmd}"
104
+ end
105
+ output
106
+ end
107
+
108
+ def bit_bucket #:nodoc:
109
+ File.exists?("/dev/null") ? "/dev/null" : "NUL"
110
+ end
111
+
112
+ def included base #:nodoc:
113
+ base.extend ClassMethods
114
+ unless base.respond_to?(:define_callbacks)
115
+ base.send(:include, Paperclip::CallbackCompatability)
116
+ end
117
+ end
118
+
119
+ def processor name #:nodoc:
120
+ name = name.to_s.camelize
121
+ processor = Paperclip.const_get(name)
122
+ unless processor.ancestors.include?(Paperclip::Processor)
123
+ raise PaperclipError.new("Processor #{name} was not found")
124
+ end
125
+ processor
126
+ end
127
+
128
+ # Log a paperclip-specific line. Uses ActiveRecord::Base.logger
129
+ # by default. Set Paperclip.options[:log] to false to turn off.
130
+ def log message
131
+ logger.info("[paperclip] #{message}") if logging?
132
+ end
133
+
134
+ def logger #:nodoc:
135
+ ActiveRecord::Base.logger
136
+ end
137
+
138
+ def logging? #:nodoc:
139
+ options[:log]
140
+ end
141
+ end
142
+
143
+ class PaperclipError < StandardError #:nodoc:
144
+ end
145
+
146
+ class PaperclipCommandLineError < StandardError #:nodoc:
147
+ end
148
+
149
+ class NotIdentifiedByImageMagickError < PaperclipError #:nodoc:
150
+ end
151
+
152
+ class InfiniteInterpolationError < PaperclipError #:nodoc:
153
+ end
154
+
155
+ module ClassMethods
156
+ # +has_attached_file+ gives the class it is called on an attribute that maps to a file. This
157
+ # is typically a file stored somewhere on the filesystem and has been uploaded by a user.
158
+ # The attribute returns a Paperclip::Attachmenta object which handles the management of
159
+ # that file. The intent is to make the attachment as much like a normal attribute. The
160
+ # thumbnails will be created when the new file is assigned, but they will *not* be saved
161
+ # until +save+ is called on the record. Likewise, if the attribute is set to +nil+ is
162
+ # called on it, the attachment will *not* be deleted until +save+ is called. See the
163
+ # Paperclip::Attachmenta documentation for more specifics. There are a number of options
164
+ # you can set to change the behavior of a Paperclip attachment:
165
+ # * +url+: The full URL of where the attachment is publically accessible. This can just
166
+ # as easily point to a directory served directly through Apache as it can to an action
167
+ # that can control permissions. You can specify the full domain and path, but usually
168
+ # just an absolute path is sufficient. The leading slash *must* be included manually for
169
+ # absolute paths. The default value is
170
+ # "/system/:attachment/:id/:style/:filename". See
171
+ # Paperclip::Attachmenta#interpolate for more information on variable interpolaton.
172
+ # :url => "/:class/:attachment/:id/:style_:filename"
173
+ # :url => "http://some.other.host/stuff/:class/:id_:extension"
174
+ # * +default_url+: The URL that will be returned if there is no attachment assigned.
175
+ # This field is interpolated just as the url is. The default value is
176
+ # "/:attachment/:style/missing.png"
177
+ # has_attached_file :avatar, :default_url => "/images/default_:style_avatar.png"
178
+ # User.new.avatar_url(:small) # => "/images/default_small_avatar.png"
179
+ # * +styles+: A hash of thumbnail styles and their geometries. You can find more about
180
+ # geometry strings at the ImageMagick website
181
+ # (http://www.imagemagick.org/script/command-line-options.php#resize). Paperclip
182
+ # also adds the "#" option (e.g. "50x50#"), which will resize the image to fit maximally
183
+ # inside the dimensions and then crop the rest off (weighted at the center). The
184
+ # default value is to generate no thumbnails.
185
+ # * +default_style+: The thumbnail style that will be used by default URLs.
186
+ # Defaults to +original+.
187
+ # has_attached_file :avatar, :styles => { :normal => "100x100#" },
188
+ # :default_style => :normal
189
+ # user.avatar.url # => "/avatars/23/normal_me.png"
190
+ # * +whiny+: Will raise an error if Paperclip cannot post_process an uploaded file due
191
+ # to a command line error. This will override the global setting for this attachment.
192
+ # Defaults to true. This option used to be called :whiny_thumbanils, but this is
193
+ # deprecated.
194
+ # * +convert_options+: When creating thumbnails, use this free-form options
195
+ # field to pass in various convert command options. Typical options are "-strip" to
196
+ # remove all Exif data from the image (save space for thumbnails and avatars) or
197
+ # "-depth 8" to specify the bit depth of the resulting conversion. See ImageMagick
198
+ # convert documentation for more options: (http://www.imagemagick.org/script/convert.php)
199
+ # Note that this option takes a hash of options, each of which correspond to the style
200
+ # of thumbnail being generated. You can also specify :all as a key, which will apply
201
+ # to all of the thumbnails being generated. If you specify options for the :original,
202
+ # it would be best if you did not specify destructive options, as the intent of keeping
203
+ # the original around is to regenerate all the thumbnails when requirements change.
204
+ # has_attached_file :avatar, :styles => { :large => "300x300", :negative => "100x100" }
205
+ # :convert_options => {
206
+ # :all => "-strip",
207
+ # :negative => "-negate"
208
+ # }
209
+ # NOTE: While not deprecated yet, it is not recommended to specify options this way.
210
+ # It is recommended that :convert_options option be included in the hash passed to each
211
+ # :styles for compatability with future versions.
212
+ # * +storage+: Chooses the storage backend where the files will be stored. The current
213
+ # choices are :filesystem and :s3. The default is :filesystem. Make sure you read the
214
+ # documentation for Paperclip::Storage::Filesystem and Paperclip::Storage::S3
215
+ # for backend-specific options.
216
+ def has_attached_file name, options = {}
217
+ include InstanceMethods
218
+
219
+ write_inheritable_attribute(:attachment_definitions, {}) if attachment_definitions.nil?
220
+ attachment_definitions[name] = {:validations => []}.merge(options)
221
+
222
+ after_save :save_attached_files
223
+ before_destroy :destroy_attached_files
224
+
225
+ define_callbacks :before_post_process, :after_post_process
226
+ define_callbacks :"before_#{name}_post_process", :"after_#{name}_post_process"
227
+
228
+ define_method name do |*args|
229
+ a = attachment_for(name)
230
+ (args.length > 0) ? a.to_s(args.first) : a
231
+ end
232
+
233
+ define_method "#{name}=" do |file|
234
+ attachment_for(name).assign(file)
235
+ end
236
+
237
+ define_method "#{name}?" do
238
+ attachment_for(name).file?
239
+ end
240
+
241
+ validates_each(name) do |record, attr, value|
242
+ attachment = record.attachment_for(name)
243
+ attachment.send(:flush_errors)
244
+ end
245
+ end
246
+
247
+ # Places ActiveRecord-style validations on the size of the file assigned. The
248
+ # possible options are:
249
+ # * +in+: a Range of bytes (i.e. +1..1.megabyte+),
250
+ # * +less_than+: equivalent to :in => 0..options[:less_than]
251
+ # * +greater_than+: equivalent to :in => options[:greater_than]..Infinity
252
+ # * +message+: error message to display, use :min and :max as replacements
253
+ # * +if+: A lambda or name of a method on the instance. Validation will only
254
+ # be run is this lambda or method returns true.
255
+ # * +unless+: Same as +if+ but validates if lambda or method returns false.
256
+ def validates_attachment_size name, options = {}
257
+ min = options[:greater_than] || (options[:in] && options[:in].first) || 0
258
+ max = options[:less_than] || (options[:in] && options[:in].last) || (1.0/0)
259
+ range = (min..max)
260
+ message = options[:message] || "file size must be between :min and :max bytes."
261
+ message = message.gsub(/:min/, min.to_s).gsub(/:max/, max.to_s)
262
+
263
+ validates_inclusion_of :"#{name}_file_size",
264
+ :in => range,
265
+ :message => message,
266
+ :if => options[:if],
267
+ :unless => options[:unless]
268
+ end
269
+
270
+ # Adds errors if thumbnail creation fails. The same as specifying :whiny_thumbnails => true.
271
+ def validates_attachment_thumbnails name, options = {}
272
+ warn('[DEPRECATION] validates_attachment_thumbnail is deprecated. ' +
273
+ 'This validation is on by default and will be removed from future versions. ' +
274
+ 'If you wish to turn it off, supply :whiny => false in your definition.')
275
+ attachment_definitions[name][:whiny_thumbnails] = true
276
+ end
277
+
278
+ # Places ActiveRecord-style validations on the presence of a file.
279
+ # Options:
280
+ # * +if+: A lambda or name of a method on the instance. Validation will only
281
+ # be run is this lambda or method returns true.
282
+ # * +unless+: Same as +if+ but validates if lambda or method returns false.
283
+ def validates_attachment_presence name, options = {}
284
+ message = options[:message] || "must be set."
285
+ validates_presence_of :"#{name}_file_name",
286
+ :message => message,
287
+ :if => options[:if],
288
+ :unless => options[:unless]
289
+ end
290
+
291
+ # Places ActiveRecord-style validations on the content type of the file
292
+ # assigned. The possible options are:
293
+ # * +content_type+: Allowed content types. Can be a single content type
294
+ # or an array. Each type can be a String or a Regexp. It should be
295
+ # noted that Internet Explorer upload files with content_types that you
296
+ # may not expect. For example, JPEG images are given image/pjpeg and
297
+ # PNGs are image/x-png, so keep that in mind when determining how you
298
+ # match. Allows all by default.
299
+ # * +message+: The message to display when the uploaded file has an invalid
300
+ # content type.
301
+ # * +if+: A lambda or name of a method on the instance. Validation will only
302
+ # be run is this lambda or method returns true.
303
+ # * +unless+: Same as +if+ but validates if lambda or method returns false.
304
+ # NOTE: If you do not specify an [attachment]_content_type field on your
305
+ # model, content_type validation will work _ONLY upon assignment_ and
306
+ # re-validation after the instance has been reloaded will always succeed.
307
+ def validates_attachment_content_type name, options = {}
308
+ types = [options.delete(:content_type)].flatten
309
+ validates_each(:"#{name}_content_type", options) do |record, attr, value|
310
+ unless types.any?{|t| t === value }
311
+ record.errors.add(:"#{name}_content_type", :inclusion, :default => options[:message], :value => value)
312
+ end
313
+ end
314
+ end
315
+
316
+ # Returns the attachment definitions defined by each call to
317
+ # has_attached_file.
318
+ def attachment_definitions
319
+ read_inheritable_attribute(:attachment_definitions)
320
+ end
321
+ end
322
+
323
+ module InstanceMethods #:nodoc:
324
+ def attachment_for name
325
+ @_paperclip_attachments ||= {}
326
+ @_paperclip_attachments[name] ||= Attachmenta.new(name, self, self.class.attachment_definitions[name])
327
+ end
328
+
329
+ def each_attachment
330
+ self.class.attachment_definitions.each do |name, definition|
331
+ yield(name, attachment_for(name))
332
+ end
333
+ end
334
+
335
+ def save_attached_files
336
+ logger.info("[paperclip] Saving attachments.")
337
+ each_attachment do |name, attachment|
338
+ attachment.send(:save)
339
+ end
340
+ end
341
+
342
+ def destroy_attached_files
343
+ logger.info("[paperclip] Deleting attachments.")
344
+ each_attachment do |name, attachment|
345
+ attachment.send(:queue_existing_for_delete)
346
+ attachment.send(:flush_deletes)
347
+ end
348
+ end
349
+ end
350
+
351
+ end
352
+
353
+ # Set it all up.
354
+ if Object.const_defined?("ActiveRecord")
355
+ ActiveRecord::Base.send(:include, Paperclip)
356
+ File.send(:include, Paperclip::Upfile)
357
+ end