Sha256: 858579ebefac14374301a8352d2121d54cef7f7947c33f03e62722b70b638bb7

Contents?: true

Size: 1.9 KB

Versions: 23

Compression:

Stored size: 1.9 KB

Contents

module ActionDispatch
  module Http
    # 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.
    class UploadedFile
      # The basename of the file in the client.
      attr_accessor :original_filename

      # A string with the MIME type of the file.
      attr_accessor :content_type

      # A +Tempfile+ object with the actual uploaded file. Note that some of
      # its interface is available directly.
      attr_accessor :tempfile
      alias :to_io :tempfile

      # A string with the headers of the multipart request.
      attr_accessor :headers

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

        @original_filename = hash[:filename]
        @original_filename &&= @original_filename.encode "UTF-8"
        @content_type      = hash[:type]
        @headers           = hash[:head]
      end

      # Shortcut for +tempfile.read+.
      def read(length=nil, buffer=nil)
        @tempfile.read(length, buffer)
      end

      # Shortcut for +tempfile.open+.
      def open
        @tempfile.open
      end

      # Shortcut for +tempfile.close+.
      def close(unlink_now=false)
        @tempfile.close(unlink_now)
      end

      # Shortcut for +tempfile.path+.
      def path
        @tempfile.path
      end

      # Shortcut for +tempfile.rewind+.
      def rewind
        @tempfile.rewind
      end

      # Shortcut for +tempfile.size+.
      def size
        @tempfile.size
      end

      # Shortcut for +tempfile.eof?+.
      def eof?
        @tempfile.eof?
      end
    end
  end
end

Version data entries

23 entries across 22 versions & 4 rubygems

Version Path
activejob-lock-0.0.2 rails/actionpack/lib/action_dispatch/http/upload.rb
solidus_backend-1.0.0.pre3 vendor/bundle/gems/actionpack-4.2.3/lib/action_dispatch/http/upload.rb
solidus_backend-1.0.0.pre2 vendor/bundle/gems/actionpack-4.2.3/lib/action_dispatch/http/upload.rb
solidus_backend-1.0.0.pre vendor/bundle/gems/actionpack-4.2.1/lib/action_dispatch/http/upload.rb
solidus_backend-1.0.0.pre vendor/bundle/gems/actionpack-4.2.2/lib/action_dispatch/http/upload.rb
actionpack-4.2.3 lib/action_dispatch/http/upload.rb
actionpack-4.2.3.rc1 lib/action_dispatch/http/upload.rb
actionpack-4.2.2 lib/action_dispatch/http/upload.rb
shoppe-paypal-1.1.0 vendor/bundle/ruby/2.1.0/gems/actionpack-4.2.1/lib/action_dispatch/http/upload.rb
actionpack-4.2.1 lib/action_dispatch/http/upload.rb
actionpack-4.2.1.rc4 lib/action_dispatch/http/upload.rb
actionpack-4.2.1.rc3 lib/action_dispatch/http/upload.rb
actionpack-4.2.1.rc2 lib/action_dispatch/http/upload.rb
actionpack-4.2.1.rc1 lib/action_dispatch/http/upload.rb
activejob-lock-0.0.1 rails/actionpack/lib/action_dispatch/http/upload.rb
actionpack-4.2.0 lib/action_dispatch/http/upload.rb
actionpack-4.2.0.rc3 lib/action_dispatch/http/upload.rb
actionpack-4.2.0.rc2 lib/action_dispatch/http/upload.rb
actionpack-4.2.0.rc1 lib/action_dispatch/http/upload.rb
actionpack-4.2.0.beta4 lib/action_dispatch/http/upload.rb