Class: Mongo::Grid::File::Info

Inherits:
Object
  • Object
show all
Defined in:
lib/mongo/grid/file/info.rb

Overview

Encapsulates behaviour around GridFS files collection file document.

Since:

  • 2.0.0

Constant Summary collapse

COLLECTION =

Name of the files collection.

Since:

  • 2.0.0

'files'.freeze
MAPPINGS =

Mappings of user supplied fields to db specification.

Since:

  • 2.0.0

{
  :chunk_size => :chunkSize,
  :content_type => :contentType,
  :filename => :filename,
  :_id => :_id,
  :md5 => :md5,
  :length => :length,
  :metadata => :metadata,
  :upload_date => :uploadDate,
  :aliases => :aliases
}.freeze
DEFAULT_CONTENT_TYPE =

Default content type for stored files.

Since:

  • 2.0.0

'binary/octet-stream'.freeze

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(document) ⇒ Info

Create the new file information document.

Examples:

Create the new file information document.

Info.new(:filename => 'test.txt')

Parameters:

  • document (BSON::Document) —

    The document to create from.

Since:

  • 2.0.0



133
134
135
136
 
# File 'lib/mongo/grid/file/info.rb', line 133

def initialize(document)
  @document = default_document.merge(Options::Mapper.transform(document, MAPPINGS))
  @client_md5 = Digest::MD5.new
end

Instance Attribute Details

#document ⇒ BSON::Document (readonly)

Returns document The files collection document.

Returns:

  • (BSON::Document) —

    document The files collection document.

Since:

  • 2.0.0



50
51
52
 
# File 'lib/mongo/grid/file/info.rb', line 50

def document
  @document
end

Instance Method Details

#==(other) ⇒ true, false

Is this file information document equal to another?

Examples:

Check file information document equality.

file_info == other

Parameters:

  • other (Object) —

    The object to check against.

Returns:

  • (true, false) —

    If the objects are equal.

Since:

  • 2.0.0



62
63
64
65
 
# File 'lib/mongo/grid/file/info.rb', line 62

def ==(other)
  return false unless other.is_a?(Info)
  document == other.document
end

#bson_type ⇒ Integer

Get the BSON type for a files information document.

Examples:

Get the BSON type.

file_info.bson_type

Returns:

  • (Integer) —

    The BSON type.

Since:

  • 2.0.0



75
76
77
 
# File 'lib/mongo/grid/file/info.rb', line 75

def bson_type
  BSON::Hash::BSON_TYPE
end

#chunk_size ⇒ Integer

Get the file chunk size.

Examples:

Get the chunk size.

file_info.chunk_size

Returns:

  • (Integer) —

    The chunksize in bytes.

Since:

  • 2.0.0



87
88
89
 
# File 'lib/mongo/grid/file/info.rb', line 87

def chunk_size
  document[:chunkSize]
end

#content_type ⇒ String

Get the file information content type.

Examples:

Get the content type.

file_info.content_type

Returns:

  • (String) —

    The content type.

Since:

  • 2.0.0



99
100
101
 
# File 'lib/mongo/grid/file/info.rb', line 99

def content_type
  document[:contentType]
end

#filename ⇒ String

Get the filename from the file information.

Examples:

Get the filename.

file_info.filename

Returns:

  • (String) —

    The filename.

Since:

  • 2.0.0



109
110
111
 
# File 'lib/mongo/grid/file/info.rb', line 109

def filename
  document[:filename]
end

#id ⇒ BSON::ObjectId

Get the file id from the file information.

Examples:

Get the file id.

file_info.id

Returns:

  • (BSON::ObjectId) —

    The file id.

Since:

  • 2.0.0



121
122
123
 
# File 'lib/mongo/grid/file/info.rb', line 121

def id
  document[:_id]
end

#inspect ⇒ String

Get a readable inspection for the object.

Examples:

Inspect the file information.

file_info.inspect

Returns:

  • (String) —

    The nice inspection.

Since:

  • 2.0.0



146
147
148
149
 
# File 'lib/mongo/grid/file/info.rb', line 146

def inspect
  "#<Mongo::Grid::File::Info:0x#{object_id} chunk_size=#{chunk_size} " +
    "filename=#{filename} content_type=#{content_type} id=#{id} md5=#{md5}>"
end

#length ⇒ Integer Also known as: size

Get the length of the document in bytes.

Examples:

Get the file length from the file information document.

file_info.length

Returns:

  • (Integer) —

    The file length.

Since:

  • 2.0.0



159
160
161
 
# File 'lib/mongo/grid/file/info.rb', line 159

def length
  document[:length]
end

#md5 ⇒ String

Get the md5 hash.

Examples:

Get the md5 hash.

file_info.md5

Returns:

  • (String) —

    The md5 hash as a string.

Since:

  • 2.0.0



184
185
186
 
# File 'lib/mongo/grid/file/info.rb', line 184

def md5
  document[:md5] || @client_md5
end

#metadata ⇒ String

Get the additional metadata from the file information document.

Examples:

Get additional metadata.

file_info.metadata

Returns:

  • (String) —

    The additional metadata from file information document.

Since:

  • 2.0.0



172
173
174
 
# File 'lib/mongo/grid/file/info.rb', line 172

def metadata
  document[:metadata]
end

#to_bson(encoded = ''.force_encoding(BSON::BINARY)) ⇒ String

Note:

If no md5 exists in the file information document (it was loaded from the server and is not a new file) then we digest the md5 and set it.

Convert the file information document to BSON for storage.

Examples:

Convert the file information document to BSON.

file_info.to_bson

Parameters:

  • encoded (String) (defaults to: ''.force_encoding(BSON::BINARY)) —

    The encoded data to append to.

Returns:

  • (String) —

    The raw BSON data.

Since:

  • 2.0.0



201
202
203
204
 
# File 'lib/mongo/grid/file/info.rb', line 201

def to_bson(encoded = ''.force_encoding(BSON::BINARY))
  document[:md5] ||= @client_md5.hexdigest
  document.to_bson(encoded)
end

#upload_date ⇒ Time

Get the upload date.

Examples:

Get the upload date.

file_info.upload_date

Returns:

  • (Time) —

    The upload date.

Since:

  • 2.0.0



214
215
216
 
# File 'lib/mongo/grid/file/info.rb', line 214

def upload_date
  document[:uploadDate]
end