edge badge

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
[R] root
Class Public methods
new(root:)
# File activestorage/lib/active_storage/service/disk_service.rb, line 13
def initialize(root))
  @root = root
end
Instance Public methods
delete(key)
# File activestorage/lib/active_storage/service/disk_service.rb, line 40
def delete(key)
  instrument :delete, key: key do
    begin
      File.delete path_for(key)
    rescue Errno::ENOENT
      # Ignore files already deleted
    end
  end
end
delete_prefixed(prefix)
# File activestorage/lib/active_storage/service/disk_service.rb, line 50
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)
# File activestorage/lib/active_storage/service/disk_service.rb, line 24
def download(key)
  if block_given?
    instrument :streaming_download, key: key do
      File.open(path_for(key), "rb") do |file|
        while data = file.read(64.kilobytes)
          yield data
        end
      end
    end
  else
    instrument :download, key: key do
      File.binread path_for(key)
    end
  end
end
exist?(key)
# File activestorage/lib/active_storage/service/disk_service.rb, line 58
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 112
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 17
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(key, expires_in:, filename:, disposition:, content_type:)
# File activestorage/lib/active_storage/service/disk_service.rb, line 66
def url(key, expires_in,, filename,, disposition,, content_type))
  instrument :url, key: key do |payload|
    verified_key_with_expiration = ActiveStorage.verifier.generate(key, expires_in: expires_in, purpose: :blob_key)

    generated_url =
      if defined?(Rails.application)
        Rails.application.routes.url_helpers.rails_disk_service_path                verified_key_with_expiration,
          filename: filename, disposition: content_disposition_with(type: disposition, filename: filename), content_type: content_type
      else
        "/rails/active_storage/disk/#{verified_key_with_expiration}/#{filename}?content_type=#{content_type}"                "&disposition=#{content_disposition_with(type: disposition, filename: filename)}"
      end

    payload[:url] = generated_url

    generated_url
  end
end
url_for_direct_upload(key, expires_in:, content_type:, content_length:, checksum:)
# File activestorage/lib/active_storage/service/disk_service.rb, line 86
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
      },
      { expires_in: expires_in,
      purpose: :blob_token }
    )

    generated_url =
      if defined?(Rails.application)
        Rails.application.routes.url_helpers.update_rails_disk_service_path verified_token_with_expiration
      else
        "/rails/active_storage/disk/#{verified_token_with_expiration}"
      end

    payload[:url] = generated_url

    generated_url
  end
end