Skip to content

Commit edbab3c

Browse files
committed
CSHARP-1191: Rename GridFSFilesCollectionDocument to GridFSFileInfo.
1 parent b5c346e commit edbab3c

12 files changed

+96
-94
lines changed

src/MongoDB.Driver.GridFS.Tests/GridFSFilesCollectionDocumentTests.cs renamed to src/MongoDB.Driver.GridFS.Tests/GridFSFileInfoTests.cs

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@
2727
namespace MongoDB.Driver.GridFS.Tests
2828
{
2929
[TestFixture]
30-
public class GridFSFilesCollectionDocumentTests
30+
public class GridFSFileInfoTests
3131
{
3232
[Test]
3333
public void Aliases_get_should_return_the_expected_result()
@@ -97,7 +97,7 @@ public void constructor_should_initialize_instance()
9797
var metadata = new BsonDocument();
9898
var uploadDateTime = DateTime.UtcNow;
9999

100-
var result = new GridFSFilesCollectionDocument(
100+
var result = new GridFSFileInfo(
101101
aliases,
102102
chunkSizeBytes,
103103
contentType,
@@ -378,7 +378,7 @@ private BsonDocument CreateFilesCollectionDocument()
378378
};
379379
}
380380

381-
private GridFSFilesCollectionDocument CreateSubject(
381+
private GridFSFileInfo CreateSubject(
382382
IEnumerable<string> aliases = null,
383383
int? chunkSizeBytes = null,
384384
string contentType = null,
@@ -390,7 +390,7 @@ private GridFSFilesCollectionDocument CreateSubject(
390390
BsonDocument metadata = null,
391391
DateTime? uploadDateTime = null)
392392
{
393-
return new GridFSFilesCollectionDocument(
393+
return new GridFSFileInfo(
394394
aliases,
395395
chunkSizeBytes ?? 255 * 1024,
396396
contentType,
@@ -403,9 +403,9 @@ private GridFSFilesCollectionDocument CreateSubject(
403403
uploadDateTime ?? DateTime.UtcNow);
404404
}
405405

406-
private GridFSFilesCollectionDocument DeserializeFilesCollectionDocument(BsonDocument document)
406+
private GridFSFileInfo DeserializeFilesCollectionDocument(BsonDocument document)
407407
{
408-
return BsonSerializer.Deserialize<GridFSFilesCollectionDocument>(document);
408+
return BsonSerializer.Deserialize<GridFSFileInfo>(document);
409409
}
410410
}
411411
}

src/MongoDB.Driver.GridFS.Tests/GridFSFindOptionsTests.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -189,7 +189,7 @@ public void Skip_set_should_throw_when_value_is_invalid()
189189
[Test]
190190
public void Sort_get_should_return_expected_result()
191191
{
192-
var sort = Builders<GridFSFilesCollectionDocument>.Sort.Ascending(x => x.Length);
192+
var sort = Builders<GridFSFileInfo>.Sort.Ascending(x => x.Length);
193193
var subject = new GridFSFindOptions { Sort = sort };
194194

195195
var result = subject.Sort;
@@ -201,7 +201,7 @@ public void Sort_get_should_return_expected_result()
201201
public void Sort_set_should_have_expected_result()
202202
{
203203
var subject = new GridFSFindOptions();
204-
var sort = Builders<GridFSFilesCollectionDocument>.Sort.Ascending(x => x.Length);
204+
var sort = Builders<GridFSFileInfo>.Sort.Ascending(x => x.Length);
205205

206206
subject.Sort = sort;
207207

src/MongoDB.Driver.GridFS.Tests/MongoDB.Driver.GridFS.Tests.csproj

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@
6262
<Compile Include="GridFSDownloadOptionsTests.cs" />
6363
<Compile Include="GridFSExceptionTests.cs" />
6464
<Compile Include="GridFSFileNotFoundExceptionTests.cs" />
65-
<Compile Include="GridFSFilesCollectionDocumentTests.cs" />
65+
<Compile Include="GridFSFileInfoTests.cs" />
6666
<Compile Include="GridFSFindOptionsTests.cs" />
6767
<Compile Include="GridFSMD5ExceptionTests.cs" />
6868
<Compile Include="GridFSUploadOptionsTests.cs" />

src/MongoDB.Driver.GridFS/GridFSBucket.cs

Lines changed: 44 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -113,8 +113,8 @@ public ImmutableGridFSBucketOptions Options
113113

114114
using (var binding = await GetSingleServerReadBindingAsync(cancellationToken).ConfigureAwait(false))
115115
{
116-
var filesCollectionDocument = await GetFilesCollectionDocumentByNameAsync(binding, filename, options.Revision, cancellationToken).ConfigureAwait(false);
117-
return await DownloadAsBytesHelperAsync(binding, filesCollectionDocument, options, cancellationToken).ConfigureAwait(false);
116+
var fileInfo = await GetFileInfoByNameAsync(binding, filename, options.Revision, cancellationToken).ConfigureAwait(false);
117+
return await DownloadAsBytesHelperAsync(binding, fileInfo, options, cancellationToken).ConfigureAwait(false);
118118
}
119119
}
120120

@@ -150,27 +150,27 @@ public ImmutableGridFSBucketOptions Options
150150

151151
using (var binding = await GetSingleServerReadBindingAsync(cancellationToken).ConfigureAwait(false))
152152
{
153-
var filesCollectionDocument = await GetFilesCollectionDocumentByNameAsync(binding, filename, options.Revision, cancellationToken).ConfigureAwait(false);
154-
await DownloadToStreamHelperAsync(binding, filesCollectionDocument, destination, options, cancellationToken).ConfigureAwait(false);
153+
var fileInfo = await GetFileInfoByNameAsync(binding, filename, options.Revision, cancellationToken).ConfigureAwait(false);
154+
await DownloadToStreamHelperAsync(binding, fileInfo, destination, options, cancellationToken).ConfigureAwait(false);
155155
}
156156
}
157157

158158
/// <inheritdoc />
159-
public async Task<IAsyncCursor<GridFSFilesCollectionDocument>> FindAsync(FilterDefinition<GridFSFilesCollectionDocument> filter, GridFSFindOptions options = null, CancellationToken cancellationToken = default(CancellationToken))
159+
public async Task<IAsyncCursor<GridFSFileInfo>> FindAsync(FilterDefinition<GridFSFileInfo> filter, GridFSFindOptions options = null, CancellationToken cancellationToken = default(CancellationToken))
160160
{
161161
Ensure.IsNotNull(filter, nameof(filter));
162162
options = options ?? new GridFSFindOptions();
163163

164164
var filesCollectionNamespace = GetFilesCollectionNamespace();
165165
var serializerRegistry = _database.Settings.SerializerRegistry;
166-
var filesCollectionDocumentSerializer = serializerRegistry.GetSerializer<GridFSFilesCollectionDocument>();
166+
var fileInfoSerializer = serializerRegistry.GetSerializer<GridFSFileInfo>();
167167
var messageEncoderSettings = GetMessageEncoderSettings();
168-
var renderedFilter = filter.Render(filesCollectionDocumentSerializer, serializerRegistry);
169-
var renderedSort = options.Sort == null ? null : options.Sort.Render(filesCollectionDocumentSerializer, serializerRegistry);
168+
var renderedFilter = filter.Render(fileInfoSerializer, serializerRegistry);
169+
var renderedSort = options.Sort == null ? null : options.Sort.Render(fileInfoSerializer, serializerRegistry);
170170

171-
var operation = new FindOperation<GridFSFilesCollectionDocument>(
171+
var operation = new FindOperation<GridFSFileInfo>(
172172
filesCollectionNamespace,
173-
filesCollectionDocumentSerializer,
173+
fileInfoSerializer,
174174
messageEncoderSettings)
175175
{
176176
BatchSize = options.BatchSize,
@@ -216,8 +216,8 @@ public ImmutableGridFSBucketOptions Options
216216

217217
using (var binding = await GetSingleServerReadBindingAsync(cancellationToken).ConfigureAwait(false))
218218
{
219-
var filesCollectionDocument = await GetFilesCollectionDocumentByNameAsync(binding, filename, options.Revision, cancellationToken).ConfigureAwait(false);
220-
return CreateDownloadStream(binding.Fork(), filesCollectionDocument, options);
219+
var fileInfo = await GetFileInfoByNameAsync(binding, filename, options.Revision, cancellationToken).ConfigureAwait(false);
220+
return CreateDownloadStream(binding.Fork(), fileInfo, options);
221221
}
222222
}
223223

@@ -345,7 +345,7 @@ private async Task CreateChunksCollectionIndexesAsync(IReadWriteBindingHandle bi
345345
await operation.ExecuteAsync(binding, cancellationToken).ConfigureAwait(false);
346346
}
347347

348-
private GridFSDownloadStream CreateDownloadStream(IReadBindingHandle binding, GridFSFilesCollectionDocument filesCollectionDocument, GridFSDownloadOptions options = null, CancellationToken cancellationToken = default(CancellationToken))
348+
private GridFSDownloadStream CreateDownloadStream(IReadBindingHandle binding, GridFSFileInfo fileInfo, GridFSDownloadOptions options = null, CancellationToken cancellationToken = default(CancellationToken))
349349
{
350350
var checkMD5 = options.CheckMD5 ?? false;
351351
var seekable = options.Seekable ?? false;
@@ -356,11 +356,11 @@ private async Task CreateChunksCollectionIndexesAsync(IReadWriteBindingHandle bi
356356

357357
if (seekable)
358358
{
359-
return new GridFSSeekableDownloadStream(this, binding, filesCollectionDocument);
359+
return new GridFSSeekableDownloadStream(this, binding, fileInfo);
360360
}
361361
else
362362
{
363-
return new GridFSForwardOnlyDownloadStream(this, binding, filesCollectionDocument, checkMD5);
363+
return new GridFSForwardOnlyDownloadStream(this, binding, fileInfo, checkMD5);
364364
}
365365
}
366366

@@ -406,33 +406,33 @@ private async Task CreateFilesCollectionIndexesAsync(IReadWriteBindingHandle bin
406406
{
407407
using (var binding = await GetSingleServerReadBindingAsync(cancellationToken).ConfigureAwait(false))
408408
{
409-
var filesCollectionDocument = await GetFilesCollectionDocumentAsync(binding, id, cancellationToken).ConfigureAwait(false);
410-
return await DownloadAsBytesHelperAsync(binding, filesCollectionDocument, options, cancellationToken).ConfigureAwait(false);
409+
var fileInfo = await GetFileInfoAsync(binding, id, cancellationToken).ConfigureAwait(false);
410+
return await DownloadAsBytesHelperAsync(binding, fileInfo, options, cancellationToken).ConfigureAwait(false);
411411
}
412412
}
413413

414-
private async Task<byte[]> DownloadAsBytesHelperAsync(IReadBindingHandle binding, GridFSFilesCollectionDocument filesCollectionDocument, GridFSDownloadOptions options, CancellationToken cancellationToken = default(CancellationToken))
414+
private async Task<byte[]> DownloadAsBytesHelperAsync(IReadBindingHandle binding, GridFSFileInfo fileInfo, GridFSDownloadOptions options, CancellationToken cancellationToken = default(CancellationToken))
415415
{
416-
if (filesCollectionDocument.Length > int.MaxValue)
416+
if (fileInfo.Length > int.MaxValue)
417417
{
418418
throw new NotSupportedException("GridFS stored file is too large to be returned as a byte array.");
419419
}
420420

421-
using (var destination = new MemoryStream((int)filesCollectionDocument.Length))
421+
using (var destination = new MemoryStream((int)fileInfo.Length))
422422
{
423-
await DownloadToStreamHelperAsync(binding, filesCollectionDocument, destination, options, cancellationToken).ConfigureAwait(false);
423+
await DownloadToStreamHelperAsync(binding, fileInfo, destination, options, cancellationToken).ConfigureAwait(false);
424424
return destination.GetBuffer();
425425
}
426426
}
427427

428-
private async Task DownloadToStreamHelperAsync(IReadBindingHandle binding, GridFSFilesCollectionDocument filesCollectionDocument, Stream destination, GridFSDownloadOptions options = null, CancellationToken cancellationToken = default(CancellationToken))
428+
private async Task DownloadToStreamHelperAsync(IReadBindingHandle binding, GridFSFileInfo fileInfo, Stream destination, GridFSDownloadOptions options = null, CancellationToken cancellationToken = default(CancellationToken))
429429
{
430430
var checkMD5 = options.CheckMD5 ?? false;
431431

432-
using (var source = new GridFSForwardOnlyDownloadStream(this, binding.Fork(), filesCollectionDocument, checkMD5))
432+
using (var source = new GridFSForwardOnlyDownloadStream(this, binding.Fork(), fileInfo, checkMD5))
433433
{
434434
var count = source.Length;
435-
var buffer = new byte[filesCollectionDocument.ChunkSizeBytes];
435+
var buffer = new byte[fileInfo.ChunkSizeBytes];
436436

437437
while (count > 0)
438438
{
@@ -450,8 +450,8 @@ private async Task CreateFilesCollectionIndexesAsync(IReadWriteBindingHandle bin
450450
{
451451
using (var binding = await GetSingleServerReadBindingAsync(cancellationToken).ConfigureAwait(false))
452452
{
453-
var filesCollectionDocument = await GetFilesCollectionDocumentAsync(binding, id, cancellationToken).ConfigureAwait(false);
454-
await DownloadToStreamHelperAsync(binding, filesCollectionDocument, destination, options, cancellationToken).ConfigureAwait(false);
453+
var fileInfo = await GetFileInfoAsync(binding, id, cancellationToken).ConfigureAwait(false);
454+
await DownloadToStreamHelperAsync(binding, fileInfo, destination, options, cancellationToken).ConfigureAwait(false);
455455
}
456456
}
457457

@@ -476,17 +476,17 @@ internal CollectionNamespace GetChunksCollectionNamespace()
476476
return new CollectionNamespace(_database.DatabaseNamespace, _options.BucketName + ".chunks");
477477
}
478478

479-
private async Task<GridFSFilesCollectionDocument> GetFilesCollectionDocumentAsync(IReadBindingHandle binding, BsonValue id, CancellationToken cancellationToken)
479+
private async Task<GridFSFileInfo> GetFileInfoAsync(IReadBindingHandle binding, BsonValue id, CancellationToken cancellationToken)
480480
{
481481
var filesCollectionNamespace = GetFilesCollectionNamespace();
482482
var serializerRegistry = _database.Settings.SerializerRegistry;
483-
var filesCollectionDocumentSerializer = serializerRegistry.GetSerializer<GridFSFilesCollectionDocument>();
483+
var fileInfoSerializer = serializerRegistry.GetSerializer<GridFSFileInfo>();
484484
var messageEncoderSettings = GetMessageEncoderSettings();
485485
var filter = new BsonDocument("_id", id);
486486

487-
var operation = new FindOperation<GridFSFilesCollectionDocument>(
487+
var operation = new FindOperation<GridFSFileInfo>(
488488
filesCollectionNamespace,
489-
filesCollectionDocumentSerializer,
489+
fileInfoSerializer,
490490
messageEncoderSettings)
491491
{
492492
Filter = filter,
@@ -495,30 +495,30 @@ private async Task<GridFSFilesCollectionDocument> GetFilesCollectionDocumentAsyn
495495

496496
using (var cursor = await operation.ExecuteAsync(binding, cancellationToken).ConfigureAwait(false))
497497
{
498-
var filesCollectionDocuments = await cursor.ToListAsync(cancellationToken).ConfigureAwait(false);
499-
var filesCollectionDocument = filesCollectionDocuments.FirstOrDefault();
500-
if (filesCollectionDocument == null)
498+
var fileInfoList = await cursor.ToListAsync(cancellationToken).ConfigureAwait(false);
499+
var fileInfo = fileInfoList.FirstOrDefault();
500+
if (fileInfo == null)
501501
{
502502
throw new GridFSFileNotFoundException(id);
503503
}
504-
return filesCollectionDocument;
504+
return fileInfo;
505505
}
506506
}
507507

508-
private async Task<GridFSFilesCollectionDocument> GetFilesCollectionDocumentByNameAsync(IReadBindingHandle binding, string filename, int revision, CancellationToken cancellationToken)
508+
private async Task<GridFSFileInfo> GetFileInfoByNameAsync(IReadBindingHandle binding, string filename, int revision, CancellationToken cancellationToken)
509509
{
510510
var collectionNamespace = GetFilesCollectionNamespace();
511511
var serializerRegistry = _database.Settings.SerializerRegistry;
512-
var filesCollectionDocumentSerializer = serializerRegistry.GetSerializer<GridFSFilesCollectionDocument>();
512+
var fileInfoSerializer = serializerRegistry.GetSerializer<GridFSFileInfo>();
513513
var messageEncoderSettings = GetMessageEncoderSettings();
514514
var filter = new BsonDocument("filename", filename);
515515
var skip = revision >= 0 ? revision : -revision - 1;
516516
var limit = 1;
517517
var sort = new BsonDocument("uploadDate", revision >= 0 ? 1 : -1);
518518

519-
var operation = new FindOperation<GridFSFilesCollectionDocument>(
519+
var operation = new FindOperation<GridFSFileInfo>(
520520
collectionNamespace,
521-
filesCollectionDocumentSerializer,
521+
fileInfoSerializer,
522522
messageEncoderSettings)
523523
{
524524
Filter = filter,
@@ -529,13 +529,13 @@ private async Task<GridFSFilesCollectionDocument> GetFilesCollectionDocumentByNa
529529

530530
using (var cursor = await operation.ExecuteAsync(binding, cancellationToken).ConfigureAwait(false))
531531
{
532-
var filesCollectionDocuments = await cursor.ToListAsync(cancellationToken).ConfigureAwait(false);
533-
var filesCollectionDocument = filesCollectionDocuments.FirstOrDefault();
534-
if (filesCollectionDocument == null)
532+
var fileInfoList = await cursor.ToListAsync(cancellationToken).ConfigureAwait(false);
533+
var fileInfo = fileInfoList.FirstOrDefault();
534+
if (fileInfo == null)
535535
{
536536
throw new GridFSFileNotFoundException(filename, revision);
537537
}
538-
return filesCollectionDocument;
538+
return fileInfo;
539539
}
540540
}
541541

@@ -602,8 +602,8 @@ private async Task<bool> IsFilesCollectionEmptyAsync(IReadWriteBindingHandle bin
602602

603603
using (var binding = await GetSingleServerReadBindingAsync(cancellationToken).ConfigureAwait(false))
604604
{
605-
var filesCollectionDocument = await GetFilesCollectionDocumentAsync(binding, id, cancellationToken).ConfigureAwait(false);
606-
return CreateDownloadStream(binding.Fork(), filesCollectionDocument, options, cancellationToken);
605+
var fileInfo = await GetFileInfoAsync(binding, id, cancellationToken).ConfigureAwait(false);
606+
return CreateDownloadStream(binding.Fork(), fileInfo, options, cancellationToken);
607607
}
608608
}
609609

src/MongoDB.Driver.GridFS/GridFSDownloadStream.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ public abstract class GridFSDownloadStream : Stream
3131
/// <value>
3232
/// The files collection document.
3333
/// </value>
34-
public abstract GridFSFilesCollectionDocument FilesCollectionDocument { get; }
34+
public abstract GridFSFileInfo FileInfo { get; }
3535

3636
// public methods
3737
/// <summary>

src/MongoDB.Driver.GridFS/GridFSDownloadStreamBase.cs

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -28,17 +28,17 @@ internal abstract class GridFSDownloadStreamBase : GridFSDownloadStream
2828
private readonly GridFSBucket _bucket;
2929
private bool _closed;
3030
private bool _disposed;
31-
private readonly GridFSFilesCollectionDocument _filesCollectionDocument;
31+
private readonly GridFSFileInfo _fileInfo;
3232

3333
// constructors
3434
protected GridFSDownloadStreamBase(
3535
GridFSBucket bucket,
3636
IReadBinding binding,
37-
GridFSFilesCollectionDocument filesCollectionDocument)
37+
GridFSFileInfo fileInfo)
3838
{
3939
_bucket = bucket;
4040
_binding = binding;
41-
_filesCollectionDocument = filesCollectionDocument;
41+
_fileInfo = fileInfo;
4242
}
4343

4444
// public properties
@@ -52,14 +52,14 @@ public override bool CanWrite
5252
get { return false; }
5353
}
5454

55-
public override GridFSFilesCollectionDocument FilesCollectionDocument
55+
public override GridFSFileInfo FileInfo
5656
{
57-
get { return _filesCollectionDocument; }
57+
get { return _fileInfo; }
5858
}
5959

6060
public override long Length
6161
{
62-
get { return _filesCollectionDocument.Length; }
62+
get { return _fileInfo.Length; }
6363
}
6464

6565
// protected properties

0 commit comments

Comments
 (0)