src/derails/action_dispatch/http/upload.rb
# frozen_string_literal: true

# :markup: markdown

module ActionDispatch
  module Http
    # # Action Dispatch HTTP UploadedFile
    #
    # 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

      # 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

        @content_type = hash[:type]

        if hash[:filename]
          @original_filename = hash[:filename].dup

          begin
            @original_filename.encode!(Encoding::UTF_8)
          rescue EncodingError
            @original_filename.force_encoding(Encoding::UTF_8)
          end
        else
          @original_filename = nil
        end

        if hash[:head]
          @headers = hash[:head].dup

          begin
            @headers.encode!(Encoding::UTF_8)
          rescue EncodingError
            @headers.force_encoding(Encoding::UTF_8)
          end
        else
          @headers = nil
        end
      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.to_path`.
      def to_path
        @tempfile.to_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

      def to_io
        @tempfile.to_io
      end
    end
  end
end
