Module: CarrierWave::Uploader::Versions
- Extended by:
- ActiveSupport::Concern
- Includes:
- Callbacks
- Included in:
- Base
- Defined in:
- lib/carrierwave/uploader/versions.rb
Defined Under Namespace
Modules: ClassMethods
Instance Method Summary collapse
-
#cache!(*args) ⇒ Object
Copies the parent's cache_id when caching a version file.
-
#recreate_versions!(*names) ⇒ Object
Recreate versions and reprocess them.
-
#url(*args) ⇒ Object
When given a version name as a parameter, will return the url for that version This also works with nested versions.
-
#version_exists?(name) ⇒ Boolean
Parameters.
-
#version_name ⇒ Object
Returns.
-
#versions ⇒ Object
Returns a hash mapping the name of each version of the uploader to an instance of it.
Methods included from Callbacks
Instance Method Details
#cache!(*args) ⇒ Object
Copies the parent's cache_id when caching a version file. This behavior is not essential but it makes easier to understand that the cached files are generated by the single upload attempt.
199 200 201 202 203 |
# File 'lib/carrierwave/uploader/versions.rb', line 199 def cache!(*args) self.cache_id = parent_version.cache_id if parent_version super end |
#recreate_versions!(*names) ⇒ Object
Recreate versions and reprocess them. This can be used to recreate versions if their parameters somehow have changed.
245 246 247 248 249 250 251 252 253 254 255 256 |
# File 'lib/carrierwave/uploader/versions.rb', line 245 def recreate_versions!(*names) # As well as specified versions, we need to reprocess versions # that are the source of another version. self.cache_id = CarrierWave.generate_cache_id derived_versions.each do |name, v| v.cache!(file) if names.empty? || !(v.descendant_version_names & names).empty? end active_versions.each do |name, v| v.store! if names.empty? || names.include?(name) end end |
#url(*args) ⇒ Object
When given a version name as a parameter, will return the url for that version This also works with nested versions. When given a query hash as a parameter, will return the url with signature that contains query params Query hash only works with AWS (S3 storage).
Example
my_uploader.url # => /path/to/my/uploader.gif
my_uploader.url(:thumb) # => /path/to/my/thumb_uploader.gif
my_uploader.url(:thumb, :small) # => /path/to/my/thumb_small_uploader.gif
my_uploader.url(:query => {"response-content-disposition" => "attachment"})
my_uploader.url(:version, :sub_version, :query => {"response-content-disposition" => "attachment"})
Parameters
- *args (Symbol)
-
any number of versions
OR/AND
- Hash
-
query params
Returns
- String
-
the location where this file is accessible via a url
229 230 231 232 233 234 235 236 237 238 239 |
# File 'lib/carrierwave/uploader/versions.rb', line 229 def url(*args) if (version = args.first) && version.respond_to?(:to_sym) raise ArgumentError, "Version #{version} doesn't exist!" if versions[version.to_sym].nil? # recursively proxy to version versions[version.to_sym].url(*args[1..-1]) elsif args.first super(args.first) else super end end |
#version_exists?(name) ⇒ Boolean
Parameters
- name (#to_sym)
-
name of the version
Returns
- Boolean
-
True when the version exists according to its :if or :unless condition
169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 |
# File 'lib/carrierwave/uploader/versions.rb', line 169 def version_exists?(name) name = name.to_sym return false unless self.class.versions.has_key?(name) if_condition = self.class.versions[name].[:if] unless_condition = self.class.versions[name].[:unless] if if_condition if if_condition.respond_to?(:call) if_condition.call(self, :version => name, :file => file) else send(if_condition, file) end elsif unless_condition if unless_condition.respond_to?(:call) !unless_condition.call(self, :version => name, :file => file) else !send(unless_condition, file) end else true end end |
#version_name ⇒ Object
Returns
- String
-
the name of this version of the uploader
155 156 157 |
# File 'lib/carrierwave/uploader/versions.rb', line 155 def version_name self.class.version_names.join('_').to_sym unless self.class.version_names.blank? end |
#versions ⇒ Object
Returns a hash mapping the name of each version of the uploader to an instance of it
Returns
- Hash=> CarrierWave::Uploader
-
a list of uploader instances
140 141 142 143 144 145 146 147 148 |
# File 'lib/carrierwave/uploader/versions.rb', line 140 def versions return @versions if @versions @versions = {} self.class.versions.each do |name, version| @versions[name] = version.new(model, mounted_as) @versions[name].parent_version = self end @versions end |