paperclip-cloudfiles 2.3.1.1.0

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