Module: Paperclip
- Defined in:
- lib/paperclip.rb,
lib/paperclip/style.rb,
lib/paperclip/schema.rb,
lib/paperclip/upfile.rb,
lib/paperclip/railtie.rb,
lib/paperclip/version.rb,
lib/paperclip/geometry.rb,
lib/paperclip/matchers.rb,
lib/paperclip/processor.rb,
lib/paperclip/thumbnail.rb,
lib/paperclip/attachment.rb,
lib/paperclip/storage/s3.rb,
lib/paperclip/storage/fog.rb,
lib/paperclip/url_generator.rb,
lib/paperclip/interpolations.rb,
lib/paperclip/storage/filesystem.rb,
lib/paperclip/callback_compatibility.rb,
lib/paperclip/missing_attachment_styles.rb,
lib/paperclip/matchers/have_attached_file_matcher.rb,
lib/paperclip/matchers/validate_attachment_size_matcher.rb,
lib/paperclip/matchers/validate_attachment_presence_matcher.rb,
lib/paperclip/matchers/validate_attachment_content_type_matcher.rb
Overview
The base module that gets included in ActiveRecord::Base. See the documentation for Paperclip::ClassMethods for more useful information.
Defined Under Namespace
Modules: CallbackCompatability, ClassMethods, Glue, InstanceMethods, Interpolations, Schema, Shoulda, Storage, Upfile Classes: Attachment, CommandNotFoundError, Geometry, InfiniteInterpolationError, NotIdentifiedByImageMagickError, PaperclipError, Processor, Railtie, StorageMethodNotFound, Style, Tempfile, Thumbnail, UrlGenerator
Constant Summary collapse
- VERSION =
"2.5.0"
Class Attribute Summary collapse
-
.classes_with_attachments ⇒ Object
Returns the value of attribute classes_with_attachments.
- .registered_attachments_styles_path ⇒ Object
Class Method Summary collapse
- .check_for_url_clash(name, url, klass) ⇒ Object
- .class_for(class_name) ⇒ Object
- .clear_processors! ⇒ Object
- .configure {|_self| ... } ⇒ Object
-
.each_instance_with_attachment(klass, name) ⇒ Object
Find all instances of the given Active Record model
klass
with attachmentname
. - .interpolates(key, &block) ⇒ Object
- .load_processor(name) ⇒ Object
-
.log(message) ⇒ Object
Log a paperclip-specific line.
-
.logger ⇒ Object
:nodoc:.
- .logger=(logger) ⇒ Object
-
.logging? ⇒ Boolean
:nodoc:.
-
.missing_attachments_styles ⇒ Object
Returns hash with styles missing from recent run of rake paperclip:refresh:missing_styles { :User => => [:big], :Book => { :cover => [:croppable]}, } }.
-
.options ⇒ Object
Provides configurability to Paperclip.
-
.processor(name) ⇒ Object
:nodoc:.
-
.register_processor(name, processor) ⇒ Object
You can add your own processor via the Paperclip configuration.
- .reset_duplicate_clash_check! ⇒ Object
-
.run(cmd, arguments = "", local_options = {}) ⇒ Object
The run method takes the name of a binary to run, the arguments to that binary and some options:.
- .save_current_attachments_styles! ⇒ Object
Class Attribute Details
.classes_with_attachments ⇒ Object
Returns the value of attribute classes_with_attachments.
6 7 8 |
# File 'lib/paperclip/missing_attachment_styles.rb', line 6 def @classes_with_attachments end |
.registered_attachments_styles_path ⇒ Object
8 9 10 |
# File 'lib/paperclip/missing_attachment_styles.rb', line 8 def @registered_attachments_styles_path ||= Rails.root.join('public/system/paperclip_attachments.yml').to_s end |
Class Method Details
.check_for_url_clash(name, url, klass) ⇒ Object
193 194 195 196 197 198 199 200 |
# File 'lib/paperclip.rb', line 193 def check_for_url_clash(name,url,klass) @names_url ||= {} default_url = url || Attachment.[:url] if @names_url[name] && @names_url[name][:url] == default_url && @names_url[name][:class] != klass && @names_url[name][:url] !~ /:class/ log("Duplicate URL for #{name} with #{default_url}. This will clash with attachment defined in #{@names_url[name][:class]} class") end @names_url[name] = {:url => default_url, :class => klass} end |
.class_for(class_name) ⇒ Object
168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 |
# File 'lib/paperclip.rb', line 168 def class_for(class_name) # Ruby 1.9 introduces an inherit argument for Module#const_get and # #const_defined? and changes their default behavior. # https://github.com/rails/rails/blob/v3.0.9/activesupport/lib/active_support/inflector/methods.rb#L89 if Module.method(:const_get).arity == 1 class_name.split('::').inject(Object) do |klass, partial_class_name| klass.const_defined?(partial_class_name) ? klass.const_get(partial_class_name) : klass.const_missing(partial_class_name) end else class_name.split('::').inject(Object) do |klass, partial_class_name| klass.const_defined?(partial_class_name) ? klass.const_get(partial_class_name, false) : klass.const_missing(partial_class_name) end end rescue ArgumentError => e # Sadly, we need to capture ArgumentError here because Rails 2.3.x # ActiveSupport dependency management will try to the constant inherited # from Object, and fail miserably with "Object is not missing constant X" error # https://github.com/rails/rails/blob/v2.3.12/activesupport/lib/active_support/dependencies.rb#L124 if e. =~ /is not missing constant/ raise NameError, "uninitialized constant #{class_name}" else raise e end end |
.clear_processors! ⇒ Object
122 123 124 |
# File 'lib/paperclip.rb', line 122 def clear_processors! @known_processors.try(:clear) end |
.configure {|_self| ... } ⇒ Object
72 73 74 |
# File 'lib/paperclip.rb', line 72 def configure yield(self) if block_given? end |
.each_instance_with_attachment(klass, name) ⇒ Object
Find all instances of the given Active Record model klass
with attachment name
. This method is used by the refresh rake tasks.
141 142 143 144 145 146 147 148 |
# File 'lib/paperclip.rb', line 141 def (klass, name) unscope_method = class_for(klass).respond_to?(:unscoped) ? :unscoped : :with_exclusive_scope class_for(klass).send(unscope_method) do class_for(klass).find(:all, :order => 'id').each do |instance| yield(instance) if instance.send(:"#{name}?") end end end |
.interpolates(key, &block) ⇒ Object
76 77 78 |
# File 'lib/paperclip.rb', line 76 def interpolates key, &block Paperclip::Interpolations[key] = block end |
.load_processor(name) ⇒ Object
116 117 118 119 120 |
# File 'lib/paperclip.rb', line 116 def load_processor(name) if defined?(Rails.root) && Rails.root require File.(Rails.root.join("lib", "paperclip_processors", "#{name.underscore}.rb")) end end |
.log(message) ⇒ Object
Log a paperclip-specific line. This will logs to STDOUT by default. Set Paperclip.options to false to turn off.
152 153 154 |
# File 'lib/paperclip.rb', line 152 def log logger.info("[paperclip] #{}") if logging? end |
.logger ⇒ Object
:nodoc:
156 157 158 |
# File 'lib/paperclip.rb', line 156 def logger #:nodoc: @logger ||= [:logger] || Logger.new(STDOUT) end |
.logger=(logger) ⇒ Object
160 161 162 |
# File 'lib/paperclip.rb', line 160 def logger=(logger) @logger = logger end |
.logging? ⇒ Boolean
:nodoc:
164 165 166 |
# File 'lib/paperclip.rb', line 164 def logging? #:nodoc: [:log] end |
.missing_attachments_styles ⇒ Object
Returns hash with styles missing from recent run of rake paperclip:refresh:missing_styles
{
:User => {:avatar => [:big]},
:Book => {
:cover => [:croppable]},
}
}
66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 |
# File 'lib/paperclip/missing_attachment_styles.rb', line 66 def self. current_styles = registered_styles = Hash.new.tap do |missing_styles| current_styles.each do |klass, | .each do |, styles| registered = registered_styles[klass][] || [] rescue [] missed = styles - registered if missed.present? klass_sym = klass.to_s.to_sym missing_styles[klass_sym] ||= Hash.new missing_styles[klass_sym][.to_sym] ||= Array.new missing_styles[klass_sym][.to_sym].concat(missed.to_a) missing_styles[klass_sym][.to_sym].map!(&:to_s).sort!.map!(&:to_sym).uniq! end end end end end |
.options ⇒ Object
Provides configurability to Paperclip. The options available are:
-
whiny: Will raise an error if Paperclip cannot process thumbnails of an uploaded image. Defaults to true.
-
log: Logs progress to the Rails log. Uses ActiveRecord’s logger, so honors log levels, etc. Defaults to true.
-
command_path: Defines the path at which to find the command line programs if they are not visible to Rails the system’s search path. Defaults to nil, which uses the first executable found in the user’s search path.
-
image_magick_path: Deprecated alias of command_path.
61 62 63 64 65 66 67 68 69 70 |
# File 'lib/paperclip.rb', line 61 def @options ||= { :whiny => true, :image_magick_path => nil, :command_path => nil, :log => true, :log_command => true, :swallow_stderr => true } end |
.processor(name) ⇒ Object
:nodoc:
104 105 106 107 108 109 110 111 112 113 114 |
# File 'lib/paperclip.rb', line 104 def processor(name) #:nodoc: @known_processors ||= {} if @known_processors[name.to_s] @known_processors[name.to_s] else name = name.to_s.camelize load_processor(name) unless Paperclip.const_defined?(name) processor = Paperclip.const_get(name) @known_processors[name.to_s] = processor end end |
.register_processor(name, processor) ⇒ Object
You can add your own processor via the Paperclip configuration. Normally Paperclip will load all processors from the Rails.root/lib/paperclip_processors directory, but here you can add any existing class using this mechanism.
Paperclip.configure do |c|
c.register_processor :watermarker, WatermarkingProcessor.new
end
134 135 136 137 |
# File 'lib/paperclip.rb', line 134 def register_processor(name, processor) @known_processors ||= {} @known_processors[name.to_s] = processor end |
.reset_duplicate_clash_check! ⇒ Object
202 203 204 |
# File 'lib/paperclip.rb', line 202 def reset_duplicate_clash_check! @names_url = nil end |
.run(cmd, arguments = "", local_options = {}) ⇒ Object
The run method takes the name of a binary to run, the arguments to that binary and some options:
:command_path -> A $PATH-like variable that defines where to look for the binary
on the filesystem. Colon-separated, just like $PATH.
:expected_outcodes -> An array of integers that defines the expected exit codes
of the binary. Defaults to [0].
:log_command -> Log the command being run when set to true (defaults to false).
This will only log if logging in general is set to true as well.
:swallow_stderr -> Set to true if you don't care what happens on STDERR.
94 95 96 97 98 99 100 101 102 |
# File 'lib/paperclip.rb', line 94 def run(cmd, arguments = "", = {}) if [:image_magick_path] Paperclip.log("[DEPRECATION] :image_magick_path is deprecated and will be removed. Use :command_path instead") end command_path = [:command_path] || [:image_magick_path] Cocaine::CommandLine.path = ( Cocaine::CommandLine.path ? [Cocaine::CommandLine.path, command_path ].flatten : command_path ) = .merge(:logger => logger) if logging? && ([:log_command] || [:log_command]) Cocaine::CommandLine.new(cmd, arguments, ).run end |