Active Storage Disk Service

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

Methods

Attributes

[RW] root

Class Public methods

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

📝 Source code
# File activestorage/lib/active_storage/service/disk_service.rb, line 16
    def initialize(root:, public: false, **options)
      @root = root
      @public = public
    end
🔎 See on GitHub

Instance Public methods

compose(source_keys, destination_key, **)

📝 Source code
# File activestorage/lib/active_storage/service/disk_service.rb, line 105
    def compose(source_keys, destination_key, **)
      File.open(make_path_for(destination_key), "w") do |destination_file|
        source_keys.each do |source_key|
          File.open(path_for(source_key), "rb") do |source_file|
            IO.copy_stream(source_file, destination_file)
          end
        end
      end
    end
🔎 See on GitHub

delete(key)

📝 Source code
# File activestorage/lib/active_storage/service/disk_service.rb, line 53
    def delete(key)
      instrument :delete, key: key do
        File.delete path_for(key)
      rescue Errno::ENOENT
        # Ignore files already deleted
      end
    end
🔎 See on GitHub

delete_prefixed(prefix)

📝 Source code
# File activestorage/lib/active_storage/service/disk_service.rb, line 61
    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
🔎 See on GitHub

download(key, &block)

📝 Source code
# File activestorage/lib/active_storage/service/disk_service.rb, line 28
    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
🔎 See on GitHub

download_chunk(key, range)

📝 Source code
# File activestorage/lib/active_storage/service/disk_service.rb, line 42
    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
🔎 See on GitHub

exist?(key)

📝 Source code
# File activestorage/lib/active_storage/service/disk_service.rb, line 69
    def exist?(key)
      instrument :exist, key: key do |payload|
        answer = File.exist? path_for(key)
        payload[:exist] = answer
        answer
      end
    end
🔎 See on GitHub

headers_for_direct_upload(key, content_type:, **)

📝 Source code
# File activestorage/lib/active_storage/service/disk_service.rb, line 97
    def headers_for_direct_upload(key, content_type:, **)
      { "Content-Type" => content_type }
    end
🔎 See on GitHub

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

📝 Source code
# File activestorage/lib/active_storage/service/disk_service.rb, line 21
    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
🔎 See on GitHub

url_for_direct_upload(key, expires_in:, content_type:, content_length:, checksum:, custom_metadata: {})

📝 Source code
# File activestorage/lib/active_storage/service/disk_service.rb, line 77
    def url_for_direct_upload(key, expires_in:, content_type:, content_length:, checksum:, custom_metadata: {})
      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
🔎 See on GitHub