CSHARP-2043: used better name for option: was SuppressEnsureIndexes, now AssumeIndexesExist

John Gibbons · John Gibbons · commit fc576557daea · 2017-10-11T14:43:46.000+01:00
diff --git a/src/MongoDB.Driver.GridFS/GridFSBucket.cs b/src/MongoDB.Driver.GridFS/GridFSBucket.cs
@@ -814,7 +814,7 @@ private void EnsureIndexes(IReadWriteBindingHandle binding, CancellationToken ca
             {
                 if (!_ensureIndexesDone)
                 {
-                    if (!_options.SuppressEnsureIndexes)
+                    if (!_options.AssumeIndexesExist)
                     {
                         var isFilesCollectionEmpty = IsFilesCollectionEmpty(binding, cancellationToken);
                         if (isFilesCollectionEmpty)
@@ -846,7 +846,7 @@ private async Task EnsureIndexesAsync(IReadWriteBindingHandle binding, Cancellat
             {
                 if (!_ensureIndexesDone)
                 {
-                    if (!_options.SuppressEnsureIndexes)
+                    if (!_options.AssumeIndexesExist)
                     {
                         var isFilesCollectionEmpty = await IsFilesCollectionEmptyAsync(binding, cancellationToken).ConfigureAwait(false);
                         if (isFilesCollectionEmpty)
diff --git a/src/MongoDB.Driver.GridFS/GridFSBucketOptions.cs b/src/MongoDB.Driver.GridFS/GridFSBucketOptions.cs
@@ -29,7 +29,7 @@ public class GridFSBucketOptions
         private ReadConcern _readConcern;
         private ReadPreference _readPreference;
         private WriteConcern _writeConcern;
-        private bool _suppressEnsureIndexes;
+        private bool _assumeIndexesExist;
 
         // constructors
         /// <summary>
@@ -52,7 +52,7 @@ public GridFSBucketOptions(GridFSBucketOptions other)
             _readConcern = other.ReadConcern;
             _readPreference = other.ReadPreference;
             _writeConcern = other.WriteConcern;
-            _suppressEnsureIndexes = other.SuppressEnsureIndexes;
+            _assumeIndexesExist = other.AssumeIndexesExist;
         }
 
         /// <summary>
@@ -67,7 +67,7 @@ public GridFSBucketOptions(ImmutableGridFSBucketOptions other)
             _readConcern = other.ReadConcern;
             _readPreference = other.ReadPreference;
             _writeConcern = other.WriteConcern;
-            _suppressEnsureIndexes = other.SuppressEnsureIndexes;
+            _assumeIndexesExist = other.AssumeIndexesExist;
         }
 
         // properties
@@ -140,15 +140,15 @@ public WriteConcern WriteConcern
         }
 
         /// <summary>
-        /// Gets or sets the suppress ensure indexes setting
+        /// Gets or sets the assume indexes exist setting
         /// </summary>
         /// <value>
-        /// The suppress ensure indexes setting
+        /// The assume indexes exist setting
         /// </value>
-        public bool SuppressEnsureIndexes
+        public bool AssumeIndexesExist
         {
-            get { return _suppressEnsureIndexes; }
-            set { _suppressEnsureIndexes = value; }
+            get { return _assumeIndexesExist; }
+            set { _assumeIndexesExist = value; }
         }
     }
 
@@ -180,7 +180,7 @@ public static ImmutableGridFSBucketOptions Defaults
         private readonly ReadConcern _readConcern;
         private readonly ReadPreference _readPreference;
         private readonly WriteConcern _writeConcern;
-        private readonly bool _suppressEnsureIndexes;
+        private readonly bool _assumeIndexesExist;
 
         // constructors
         /// <summary>
@@ -190,7 +190,7 @@ public ImmutableGridFSBucketOptions()
         {
             _bucketName = "fs";
             _chunkSizeBytes = 255 * 1024;
-            _suppressEnsureIndexes = false;
+            _assumeIndexesExist = false;
         }
 
         /// <summary>
@@ -205,7 +205,7 @@ public ImmutableGridFSBucketOptions(GridFSBucketOptions other)
             _readConcern = other.ReadConcern;
             _readPreference = other.ReadPreference;
             _writeConcern = other.WriteConcern;
-            _suppressEnsureIndexes = other.SuppressEnsureIndexes;
+            _assumeIndexesExist = other.AssumeIndexesExist;
         }
 
         // properties
@@ -276,14 +276,14 @@ public WriteConcern WriteConcern
         }
 
         /// <summary>
-        /// Gets the suppress ensure indexes setting
+        /// Gets the assume ensure indexes setting
         /// </summary>
         /// <value>
-        /// The suppress ensure indexes setting
+        /// The assume ensure indexes setting
         /// </value>
-        public bool SuppressEnsureIndexes
+        public bool AssumeIndexesExist
         {
-            get { return _suppressEnsureIndexes; }
+            get { return _assumeIndexesExist; }
         }
     }
 }
diff --git a/tests/MongoDB.Driver.GridFS.Tests/GridFSBucketOptionsTests.cs b/tests/MongoDB.Driver.GridFS.Tests/GridFSBucketOptionsTests.cs
@@ -117,7 +117,7 @@ public void constructor_with_immutable_other_should_initialize_instance()
         [Fact]
         public void constructor_with_mutable_other_should_initialize_instance()
         {
-            var other = new GridFSBucketOptions { BucketName = "bucket", ChunkSizeBytes = 123, ReadConcern = ReadConcern.Majority, ReadPreference = ReadPreference.Secondary, WriteConcern = WriteConcern.WMajority, SuppressEnsureIndexes = true };
+            var other = new GridFSBucketOptions { BucketName = "bucket", ChunkSizeBytes = 123, ReadConcern = ReadConcern.Majority, ReadPreference = ReadPreference.Secondary, WriteConcern = WriteConcern.WMajority, AssumeIndexesExist = true };
 
             var result = new GridFSBucketOptions(other);
 
@@ -126,7 +126,7 @@ public void constructor_with_mutable_other_should_initialize_instance()
             result.ReadConcern.Should().Be(other.ReadConcern);
             result.ReadPreference.Should().Be(other.ReadPreference);
             result.WriteConcern.Should().Be(other.WriteConcern);
-            result.SuppressEnsureIndexes.Should().Be(other.SuppressEnsureIndexes);
+            result.AssumeIndexesExist.Should().Be(other.AssumeIndexesExist);
         }
 
         [Fact]
@@ -138,7 +138,7 @@ public void constructor_with_no_arguments_should_initialize_instance_with_defaul
             result.ChunkSizeBytes.Should().Be(255 * 1024);
             result.ReadPreference.Should().BeNull();
             result.WriteConcern.Should().BeNull();
-            result.SuppressEnsureIndexes.Should().BeFalse();
+            result.AssumeIndexesExist.Should().BeFalse();
         }
 
         [Fact]
@@ -202,23 +202,23 @@ public void WriteConcern_set_should_have_expected_result()
         }
 
         [Fact]
-        public void SuppressEnsureIndexes_get_should_return_expected_result()
+        public void AssumeIndexesExist_get_should_return_expected_result()
         {
-            var subject = new GridFSBucketOptions { SuppressEnsureIndexes = true };
+            var subject = new GridFSBucketOptions { AssumeIndexesExist = true };
 
-            var result = subject.SuppressEnsureIndexes;
+            var result = subject.AssumeIndexesExist;
 
             result.Should().BeTrue();
         }
 
         [Fact]
-        public void SuppressEnsureIndexes_set_should_have_expected_result()
+        public void AssumeIndexesExist_set_should_have_expected_result()
         {
             var subject = new GridFSBucketOptions();
 
-            subject.SuppressEnsureIndexes = true;
+            subject.AssumeIndexesExist = true;
 
-            subject.SuppressEnsureIndexes.Should().BeTrue();
+            subject.AssumeIndexesExist.Should().BeTrue();
         }
     }
 
@@ -247,7 +247,7 @@ public void ChunkSizeBytes_get_should_return_expected_result()
         [Fact]
         public void constructor_with_arguments_should_initialize_instance()
         {
-            var mutable = new GridFSBucketOptions { BucketName = "bucket", ChunkSizeBytes = 123, ReadConcern = ReadConcern.Majority, ReadPreference = ReadPreference.Secondary, WriteConcern = WriteConcern.WMajority, SuppressEnsureIndexes = true };
+            var mutable = new GridFSBucketOptions { BucketName = "bucket", ChunkSizeBytes = 123, ReadConcern = ReadConcern.Majority, ReadPreference = ReadPreference.Secondary, WriteConcern = WriteConcern.WMajority, AssumeIndexesExist = true };
 
             var result = new ImmutableGridFSBucketOptions(mutable);
 
@@ -256,7 +256,7 @@ public void constructor_with_arguments_should_initialize_instance()
             result.ReadConcern.Should().Be(ReadConcern.Majority);
             result.ReadPreference.Should().Be(ReadPreference.Secondary);
             result.WriteConcern.Should().Be(WriteConcern.WMajority);
-            result.SuppressEnsureIndexes.Should().BeTrue();
+            result.AssumeIndexesExist.Should().BeTrue();
         }
 
         [Fact]
@@ -269,7 +269,7 @@ public void constructor_with_no_arguments_should_initialize_instance_with_defaul
             result.ReadConcern.Should().BeNull();
             result.ReadPreference.Should().BeNull();
             result.WriteConcern.Should().BeNull();
-            result.SuppressEnsureIndexes.Should().BeFalse();
+            result.AssumeIndexesExist.Should().BeFalse();
         }
 
         [Fact]
@@ -291,7 +291,7 @@ public void Defaults_get_should_return_expected_result()
             result.ReadConcern.Should().BeNull();
             result.ReadPreference.Should().BeNull();
             result.WriteConcern.Should().BeNull();
-            result.SuppressEnsureIndexes.Should().BeFalse();
+            result.AssumeIndexesExist.Should().BeFalse();
         }
 
         [Fact]
@@ -325,11 +325,11 @@ public void WriteConcern_get_should_return_expected_result()
         }
 
         [Fact]
-        public void SuppressEnsureIndexes_get_should_return_expected_result()
+        public void AssumeIndexesExist_get_should_return_expected_result()
         {
-            var subject = new ImmutableGridFSBucketOptions(new GridFSBucketOptions { SuppressEnsureIndexes = true });
+            var subject = new ImmutableGridFSBucketOptions(new GridFSBucketOptions { AssumeIndexesExist = true });
 
-            var result = subject.SuppressEnsureIndexes;
+            var result = subject.AssumeIndexesExist;
 
             result.Should().BeTrue();
         }

Original file line number	Diff line number	Diff line change
`@@ -814,7 +814,7 @@ private void EnsureIndexes(IReadWriteBindingHandle binding, CancellationToken ca`
`814`	`814`	`{`
`815`	`815`	`if (!_ensureIndexesDone)`
`816`	`816`	`{`
`817`		`- if (!_options.SuppressEnsureIndexes)`
	`817`	`+ if (!_options.AssumeIndexesExist)`
`818`	`818`	`{`
`819`	`819`	`var isFilesCollectionEmpty = IsFilesCollectionEmpty(binding, cancellationToken);`
`820`	`820`	`if (isFilesCollectionEmpty)`
`@@ -846,7 +846,7 @@ private async Task EnsureIndexesAsync(IReadWriteBindingHandle binding, Cancellat`
`846`	`846`	`{`
`847`	`847`	`if (!_ensureIndexesDone)`
`848`	`848`	`{`
`849`		`- if (!_options.SuppressEnsureIndexes)`
	`849`	`+ if (!_options.AssumeIndexesExist)`
`850`	`850`	`{`
`851`	`851`	`var isFilesCollectionEmpty = await IsFilesCollectionEmptyAsync(binding, cancellationToken).ConfigureAwait(false);`
`852`	`852`	`if (isFilesCollectionEmpty)`
Original file line number	Diff line number	Diff line change
`@@ -117,7 +117,7 @@ public void constructor_with_immutable_other_should_initialize_instance()`
`117`	`117`	`[Fact]`
`118`	`118`	`public void constructor_with_mutable_other_should_initialize_instance()`
`119`	`119`	`{`
`120`		`- var other = new GridFSBucketOptions { BucketName = "bucket", ChunkSizeBytes = 123, ReadConcern = ReadConcern.Majority, ReadPreference = ReadPreference.Secondary, WriteConcern = WriteConcern.WMajority, SuppressEnsureIndexes = true };`
	`120`	`+ var other = new GridFSBucketOptions { BucketName = "bucket", ChunkSizeBytes = 123, ReadConcern = ReadConcern.Majority, ReadPreference = ReadPreference.Secondary, WriteConcern = WriteConcern.WMajority, AssumeIndexesExist = true };`
`121`	`121`
`122`	`122`	`var result = new GridFSBucketOptions(other);`
`123`	`123`
`@@ -126,7 +126,7 @@ public void constructor_with_mutable_other_should_initialize_instance()`
`126`	`126`	`result.ReadConcern.Should().Be(other.ReadConcern);`
`127`	`127`	`result.ReadPreference.Should().Be(other.ReadPreference);`
`128`	`128`	`result.WriteConcern.Should().Be(other.WriteConcern);`
`129`		`- result.SuppressEnsureIndexes.Should().Be(other.SuppressEnsureIndexes);`
	`129`	`+ result.AssumeIndexesExist.Should().Be(other.AssumeIndexesExist);`
`130`	`130`	`}`
`131`	`131`
`132`	`132`	`[Fact]`
`@@ -138,7 +138,7 @@ public void constructor_with_no_arguments_should_initialize_instance_with_defaul`
`138`	`138`	`result.ChunkSizeBytes.Should().Be(255 * 1024);`
`139`	`139`	`result.ReadPreference.Should().BeNull();`
`140`	`140`	`result.WriteConcern.Should().BeNull();`
`141`		`- result.SuppressEnsureIndexes.Should().BeFalse();`
	`141`	`+ result.AssumeIndexesExist.Should().BeFalse();`
`142`	`142`	`}`
`143`	`143`
`144`	`144`	`[Fact]`
`@@ -202,23 +202,23 @@ public void WriteConcern_set_should_have_expected_result()`
`202`	`202`	`}`
`203`	`203`
`204`	`204`	`[Fact]`
`205`		`- public void SuppressEnsureIndexes_get_should_return_expected_result()`
	`205`	`+ public void AssumeIndexesExist_get_should_return_expected_result()`
`206`	`206`	`{`
`207`		`- var subject = new GridFSBucketOptions { SuppressEnsureIndexes = true };`
	`207`	`+ var subject = new GridFSBucketOptions { AssumeIndexesExist = true };`
`208`	`208`
`209`		`- var result = subject.SuppressEnsureIndexes;`
	`209`	`+ var result = subject.AssumeIndexesExist;`
`210`	`210`
`211`	`211`	`result.Should().BeTrue();`
`212`	`212`	`}`
`213`	`213`
`214`	`214`	`[Fact]`
`215`		`- public void SuppressEnsureIndexes_set_should_have_expected_result()`
	`215`	`+ public void AssumeIndexesExist_set_should_have_expected_result()`
`216`	`216`	`{`
`217`	`217`	`var subject = new GridFSBucketOptions();`
`218`	`218`
`219`		`- subject.SuppressEnsureIndexes = true;`
	`219`	`+ subject.AssumeIndexesExist = true;`
`220`	`220`
`221`		`- subject.SuppressEnsureIndexes.Should().BeTrue();`
	`221`	`+ subject.AssumeIndexesExist.Should().BeTrue();`
`222`	`222`	`}`
`223`	`223`	`}`
`224`	`224`
`@@ -247,7 +247,7 @@ public void ChunkSizeBytes_get_should_return_expected_result()`
`247`	`247`	`[Fact]`
`248`	`248`	`public void constructor_with_arguments_should_initialize_instance()`
`249`	`249`	`{`
`250`		`- var mutable = new GridFSBucketOptions { BucketName = "bucket", ChunkSizeBytes = 123, ReadConcern = ReadConcern.Majority, ReadPreference = ReadPreference.Secondary, WriteConcern = WriteConcern.WMajority, SuppressEnsureIndexes = true };`
	`250`	`+ var mutable = new GridFSBucketOptions { BucketName = "bucket", ChunkSizeBytes = 123, ReadConcern = ReadConcern.Majority, ReadPreference = ReadPreference.Secondary, WriteConcern = WriteConcern.WMajority, AssumeIndexesExist = true };`
`251`	`251`
`252`	`252`	`var result = new ImmutableGridFSBucketOptions(mutable);`
`253`	`253`
`@@ -256,7 +256,7 @@ public void constructor_with_arguments_should_initialize_instance()`
`256`	`256`	`result.ReadConcern.Should().Be(ReadConcern.Majority);`
`257`	`257`	`result.ReadPreference.Should().Be(ReadPreference.Secondary);`
`258`	`258`	`result.WriteConcern.Should().Be(WriteConcern.WMajority);`
`259`		`- result.SuppressEnsureIndexes.Should().BeTrue();`
	`259`	`+ result.AssumeIndexesExist.Should().BeTrue();`
`260`	`260`	`}`
`261`	`261`
`262`	`262`	`[Fact]`
`@@ -269,7 +269,7 @@ public void constructor_with_no_arguments_should_initialize_instance_with_defaul`
`269`	`269`	`result.ReadConcern.Should().BeNull();`
`270`	`270`	`result.ReadPreference.Should().BeNull();`
`271`	`271`	`result.WriteConcern.Should().BeNull();`
`272`		`- result.SuppressEnsureIndexes.Should().BeFalse();`
	`272`	`+ result.AssumeIndexesExist.Should().BeFalse();`
`273`	`273`	`}`
`274`	`274`
`275`	`275`	`[Fact]`
`@@ -291,7 +291,7 @@ public void Defaults_get_should_return_expected_result()`
`291`	`291`	`result.ReadConcern.Should().BeNull();`
`292`	`292`	`result.ReadPreference.Should().BeNull();`
`293`	`293`	`result.WriteConcern.Should().BeNull();`
`294`		`- result.SuppressEnsureIndexes.Should().BeFalse();`
	`294`	`+ result.AssumeIndexesExist.Should().BeFalse();`
`295`	`295`	`}`
`296`	`296`
`297`	`297`	`[Fact]`
`@@ -325,11 +325,11 @@ public void WriteConcern_get_should_return_expected_result()`
`325`	`325`	`}`
`326`	`326`
`327`	`327`	`[Fact]`
`328`		`- public void SuppressEnsureIndexes_get_should_return_expected_result()`
	`328`	`+ public void AssumeIndexesExist_get_should_return_expected_result()`
`329`	`329`	`{`
`330`		`- var subject = new ImmutableGridFSBucketOptions(new GridFSBucketOptions { SuppressEnsureIndexes = true });`
	`330`	`+ var subject = new ImmutableGridFSBucketOptions(new GridFSBucketOptions { AssumeIndexesExist = true });`
`331`	`331`
`332`		`- var result = subject.SuppressEnsureIndexes;`
	`332`	`+ var result = subject.AssumeIndexesExist;`
`333`	`333`
`334`	`334`	`result.Should().BeTrue();`
`335`	`335`	`}`