Class: ActionDispatch::Http::UploadedFile

Inherits:
Object
  • Object
show all
Defined in:
actionpack/lib/action_dispatch/http/upload.rb

Overview

Models uploaded files.

The actual file is accessible via the tempfile accessor, though some of its interface is available directly for convenience.

Uploaded files are temporary files whose lifespan is one request. When the object is finalized Ruby unlinks the file, so there is no need to clean them with a separate maintenance task.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(hash) ⇒ UploadedFile

:nodoc:

Raises:

  • (ArgumentError)

26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
# File 'actionpack/lib/action_dispatch/http/upload.rb', line 26

def initialize(hash) # :nodoc:
  @tempfile          = hash[:tempfile]
  raise(ArgumentError, ':tempfile is required') unless @tempfile

  @original_filename = hash[:filename]
  if @original_filename
    begin
      @original_filename.encode!(Encoding::UTF_8)
    rescue EncodingError
      @original_filename.force_encoding(Encoding::UTF_8)
    end
  end
  @content_type      = hash[:type]
  @headers           = hash[:head]
end

Instance Attribute Details

#content_typeObject

A string with the MIME type of the file.


16
17
18
# File 'actionpack/lib/action_dispatch/http/upload.rb', line 16

def content_type
  @content_type
end

#headersObject

A string with the headers of the multipart request.


24
25
26
# File 'actionpack/lib/action_dispatch/http/upload.rb', line 24

def headers
  @headers
end

#original_filenameObject

The basename of the file in the client.


13
14
15
# File 'actionpack/lib/action_dispatch/http/upload.rb', line 13

def original_filename
  @original_filename
end

#tempfileObject Also known as: to_io

A Tempfile object with the actual uploaded file. Note that some of its interface is available directly.


20
21
22
# File 'actionpack/lib/action_dispatch/http/upload.rb', line 20

def tempfile
  @tempfile
end

Instance Method Details

#close(unlink_now = false) ⇒ Object

Shortcut for tempfile.close.


53
54
55
# File 'actionpack/lib/action_dispatch/http/upload.rb', line 53

def close(unlink_now=false)
  @tempfile.close(unlink_now)
end

#eof?Boolean

Shortcut for tempfile.eof?.

Returns:

  • (Boolean)

73
74
75
# File 'actionpack/lib/action_dispatch/http/upload.rb', line 73

def eof?
  @tempfile.eof?
end

#openObject

Shortcut for tempfile.open.


48
49
50
# File 'actionpack/lib/action_dispatch/http/upload.rb', line 48

def open
  @tempfile.open
end

#pathObject

Shortcut for tempfile.path.


58
59
60
# File 'actionpack/lib/action_dispatch/http/upload.rb', line 58

def path
  @tempfile.path
end

#read(length = nil, buffer = nil) ⇒ Object

Shortcut for tempfile.read.


43
44
45
# File 'actionpack/lib/action_dispatch/http/upload.rb', line 43

def read(length=nil, buffer=nil)
  @tempfile.read(length, buffer)
end

#rewindObject

Shortcut for tempfile.rewind.


63
64
65
# File 'actionpack/lib/action_dispatch/http/upload.rb', line 63

def rewind
  @tempfile.rewind
end

#sizeObject

Shortcut for tempfile.size.


68
69
70
# File 'actionpack/lib/action_dispatch/http/upload.rb', line 68

def size
  @tempfile.size
end