Class: Refile::Backend::FileSystem

Inherits:
Object
  • Object
show all
Extended by:
Refile::BackendMacros
Defined in:
lib/refile/backend/file_system.rb

Overview

A backend which stores uploaded files in the local filesystem

Examples:

backend = Refile::Backend::FileSystem.new("some/path")
file = backend.upload(StringIO.new("hello"))
backend.read(file.id) # => "hello"

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Refile::BackendMacros

decode_id, valid_id?, verify_id, verify_uploadable

Constructor Details

#initialize(directory, max_size: nil, hasher: Refile::RandomHasher.new) ⇒ FileSystem

Creates the given directory if it doesn’t exist.

Parameters:

  • directory (String) —

    The path to a directory where files should be stored

  • max_size (Integer, nil) (defaults to: nil) —

    The maximum size of an uploaded file

  • hasher (#hash) (defaults to: Refile::RandomHasher.new) —

    A hasher which is used to generate ids from files



23
24
25
26
27
28
29
 
# File 'lib/refile/backend/file_system.rb', line 23

def initialize(directory, max_size: nil, hasher: Refile::RandomHasher.new)
  @hasher = hasher
  @directory = directory
  @max_size = max_size

  FileUtils.mkdir_p(@directory)
end

Instance Attribute Details

#directory ⇒ String (readonly)

Returns the directory where files are stored.

Returns:

  • (String) —

    the directory where files are stored



13
14
15
 
# File 'lib/refile/backend/file_system.rb', line 13

def directory
  @directory
end

#max_size ⇒ String (readonly)

Returns the maximum size of files stored in this backend.

Returns:

  • (String) —

    the maximum size of files stored in this backend



16
17
18
 
# File 'lib/refile/backend/file_system.rb', line 16

def max_size
  @max_size
end

Instance Method Details

#clear!(confirm = nil) ⇒ void

This method returns an undefined value.

Remove all files in this backend. You must confirm the deletion by passing the symbol ‘:confirm` as an argument to this method.

Examples:

backend.clear!(:confirm)

Parameters:

  • confirm (:confirm) (defaults to: nil) —

    Pass the symbol ‘:confirm` to confirm deletion.

Raises:



105
106
107
108
109
 
# File 'lib/refile/backend/file_system.rb', line 105

def clear!(confirm = nil)
  raise Refile::Confirm unless confirm == :confirm
  FileUtils.rm_rf(@directory)
  FileUtils.mkdir_p(@directory)
end

#delete ⇒ void

This method returns an undefined value.

Delete a file from this backend

Parameters:

  • id (String) —

    The id of the file



60
61
62
 
# File 'lib/refile/backend/file_system.rb', line 60

verify_id def delete(id)
  FileUtils.rm(path(id)) if exists?(id)
end

#exists? ⇒ Boolean

Return whether the file with the given id exists in this backend.

Parameters:

  • id (String) —

    The id of the file

Returns:

  • (Boolean) 


93
94
95
 
# File 'lib/refile/backend/file_system.rb', line 93

verify_id def exists?(id)
  ::File.exist?(path(id))
end

#get ⇒ Refile::File

Get a file from this backend.

Note that this method will always return a File object, even if a file with the given id does not exist in this backend. Use #exists? to check if the file actually exists.

Parameters:

  • id (String) —

    The id of the file

Returns:



52
53
54
 
# File 'lib/refile/backend/file_system.rb', line 52

verify_id def get(id)
  Refile::File.new(self, id)
end

#open ⇒ IO

Return an IO object for the uploaded file which can be used to read its content.

Parameters:

  • id (String) —

    The id of the file

Returns:

  • (IO) —

    An IO object containing the file contents



69
70
71
 
# File 'lib/refile/backend/file_system.rb', line 69

verify_id def open(id)
  ::File.open(path(id), "rb")
end

#path ⇒ String

Return the full path of the uploaded file with the given id.

Parameters:

  • id (String) —

    The id of the file

Returns:

  • (String) 


115
116
117
 
# File 'lib/refile/backend/file_system.rb', line 115

verify_id def path(id)
  ::File.join(@directory, id)
end

#read ⇒ String

Return the entire contents of the uploaded file as a String.

Parameters:

  • id (String) —

    The id of the file

Returns:

  • (String) —

    The file’s contents



77
78
79
 
# File 'lib/refile/backend/file_system.rb', line 77

verify_id def read(id)
  ::File.read(path(id)) if exists?(id)
end

#size ⇒ Integer

Return the size in bytes of the uploaded file.

Parameters:

  • id (String) —

    The id of the file

Returns:

  • (Integer) —

    The file’s size



85
86
87
 
# File 'lib/refile/backend/file_system.rb', line 85

verify_id def size(id)
  ::File.size(path(id)) if exists?(id)
end

#upload ⇒ Refile::File

Upload a file into this backend

Parameters:

  • uploadable (IO) —

    An uploadable IO-like object.

Returns:



35
36
37
38
39
40
41
42
 
# File 'lib/refile/backend/file_system.rb', line 35

verify_uploadable def upload(uploadable)
  id = @hasher.hash(uploadable)
  IO.copy_stream(uploadable, path(id))

  Refile::File.new(self, id)
ensure
  uploadable.close
end