Module: CarrierWave::Uploader::Cache

Defined in:
lib/carrierwave/uploader/cache.rb

Defined Under Namespace

Modules: ClassMethods

Instance Method Summary collapse

Instance Method Details

#cache!(new_file) ⇒ Object

Caches the given file. Calls process! to trigger any process callbacks.

Parameters

new_file (File, IOString, Tempfile)

any kind of file object

Raises

CarrierWave::FormNotMultipart

if the assigned parameter is a string

Raises:



87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
 
# File 'lib/carrierwave/uploader/cache.rb', line 87

def cache!(new_file)
  new_file = CarrierWave::SanitizedFile.new(new_file)
  raise CarrierWave::FormNotMultipart if new_file.is_path?

  unless new_file.empty?
    with_callbacks(:cache, new_file) do
      self.cache_id = CarrierWave.generate_cache_id unless cache_id

      @filename = new_file.filename
      self.original_filename = new_file.filename

      @file = new_file.copy_to(cache_path, permissions)
    end
  end
end

#cache_name ⇒ Object

Returns a String which uniquely identifies the currently cached file for later retrieval

Returns

String

a cache name, in the format YYYYMMDD-HHMM-PID-RND/filename.txt



72
73
74
 
# File 'lib/carrierwave/uploader/cache.rb', line 72

def cache_name
  File.join(cache_id, full_original_filename) if cache_id and original_filename
end

#cached? ⇒ Boolean

Returns true if the uploader has been cached

Returns

Bool

whether the current file is cached

Returns:

  • (Boolean) 


61
62
63
 
# File 'lib/carrierwave/uploader/cache.rb', line 61

def cached?
  @cache_id
end

#retrieve_from_cache!(cache_name) ⇒ Object

Retrieves the file with the given cache_name from the cache.

Parameters

cache_name (String)

uniquely identifies a cache file

Raises

CarrierWave::InvalidParameter

if the cache_name is incorrectly formatted.



114
115
116
117
118
119
120
 
# File 'lib/carrierwave/uploader/cache.rb', line 114

def retrieve_from_cache!(cache_name)
  with_callbacks(:retrieve_from_cache, cache_name) do
    self.cache_id, self.original_filename = cache_name.to_s.split('/', 2)
    @filename = original_filename
    @file = CarrierWave::SanitizedFile.new(cache_path)
  end
end