edge badge
Skip to Content Skip to Search

Wraps a local disk path as an Active Storage service. See ActiveStorage::Service for the generic API documentation that applies to all services.

Methods
D
E
H
N
U

Attributes

[RW] root

Class Public methods

new(root:, public: false, **options)

# File activestorage/lib/active_storage/service/disk_service.rb, line 14
def initialize(root:, public: false, **options)
  @root = root
  @public = public
end

Instance Public methods

delete(key)

# File activestorage/lib/active_storage/service/disk_service.rb, line 51
def delete(key)
  instrument :delete, key: key do
    File.delete path_for(key)
  rescue Errno::ENOENT
    # Ignore files already deleted
  end
end

delete_prefixed(prefix)

# File activestorage/lib/active_storage/service/disk_service.rb, line 59
def delete_prefixed(prefix)
  instrument :delete_prefixed, prefix: prefix do
    Dir.glob(path_for("#{prefix}*")).each do |path|
      FileUtils.rm_rf(path)
    end
  end
end

download(key, &block)

# File activestorage/lib/active_storage/service/disk_service.rb, line 26
def download(key, &block)
  if block_given?
    instrument :streaming_download, key: key do
      stream key, &block
    end
  else
    instrument :download, key: key do
      File.binread path_for(key)
    rescue Errno::ENOENT
      raise ActiveStorage::FileNotFoundError
    end
  end
end

download_chunk(key, range)

# File activestorage/lib/active_storage/service/disk_service.rb, line 40
def download_chunk(key, range)
  instrument :download_chunk, key: key, range: range do
    File.open(path_for(key), "rb") do |file|
      file.seek range.begin
      file.read range.size
    end
  rescue Errno::ENOENT
    raise ActiveStorage::FileNotFoundError
  end
end

exist?(key)

# File activestorage/lib/active_storage/service/disk_service.rb, line 67
def exist?(key)
  instrument :exist, key: key do |payload|
    answer = File.exist? path_for(key)
    payload[:exist] = answer
    answer
  end
end

headers_for_direct_upload(key, content_type:, **)

# File activestorage/lib/active_storage/service/disk_service.rb, line 95
def headers_for_direct_upload(key, content_type:, **)
  { "Content-Type" => content_type }
end

upload(key, io, checksum: nil, **)

# File activestorage/lib/active_storage/service/disk_service.rb, line 19
def upload(key, io, checksum: nil, **)
  instrument :upload, key: key, checksum: checksum do
    IO.copy_stream(io, make_path_for(key))
    ensure_integrity_of(key, checksum) if checksum
  end
end

url_for_direct_upload(key, expires_in:, content_type:, content_length:, checksum:)

# File activestorage/lib/active_storage/service/disk_service.rb, line 75
def url_for_direct_upload(key, expires_in:, content_type:, content_length:, checksum:)
  instrument :url, key: key do |payload|
    verified_token_with_expiration = ActiveStorage.verifier.generate(
      {
        key: key,
        content_type: content_type,
        content_length: content_length,
        checksum: checksum,
        service_name: name
      },
      expires_in: expires_in,
      purpose: :blob_token
    )

    url_helpers.update_rails_disk_service_url(verified_token_with_expiration, url_options).tap do |generated_url|
      payload[:url] = generated_url
    end
  end
end