Changed interface implementation from IDisposable to IAsyncDisposable

Morten Turn Pedersen · Morten Turn Pedersen · commit 6c45091fa6dd · 2021-01-12T12:23:37.000+01:00
diff --git a/NetCoreEntityFramework.Tests/EntityRepositoryTests.cs b/NetCoreEntityFramework.Tests/EntityRepositoryTests.cs
@@ -70,7 +70,7 @@ public async Task AddAddsEntityAndSetsAttributes()
             int expectedSize = startSize + 1;
             var entity = new TestEntity();
 
-            using(_repository)
+            await using(_repository)
             {
                 await _repository.Add(entity);
             }
@@ -91,7 +91,7 @@ public async Task AddEntityWithIdKeepsId()
                 Id = id
             };
 
-            using (_repository)
+            await using (_repository)
             {
                 await _repository.Add(entity);
             }
@@ -264,7 +264,7 @@ public async Task UpdateUpdatesUpdated(string propertyValue)
             DateTime oldCreated = _entity.Created;
             _entity.Property = propertyValue;
 
-            using(_repository)
+            await using(_repository)
             {
                 await _repository.Update(_entity);
             }
@@ -288,7 +288,7 @@ public void UpdateThrowsExceptionIfNull()
         public async Task DeleteSoftDeletesAndSetsDeletedAt()
         {
             bool success;
-            using(_repository)
+            await using(_repository)
             {
                 success = await _repository.Delete(_entity);
             }
@@ -310,7 +310,7 @@ public async Task DeleteWithValidIdDeletesAndSetsDeletedAt()
         {
             bool success;
             Guid id = (Guid)_entity.Id;
-            using (_repository)
+            await using (_repository)
             {
                 success = await _repository.Delete(id);
             }
@@ -327,7 +327,7 @@ public async Task DeleteWithInvalidIdReturnsFalse(Guid randomId)
         {
             bool success;
 
-            using(_repository)
+            await using(_repository)
             {
                 success = await _repository.Delete(randomId);
             }
@@ -348,7 +348,7 @@ public async Task RestoreSetsDeletedFalse()
         {
             bool success;
 
-            using(_repository)
+            await using(_repository)
             {
                 success = await _repository.Restore(_deletedEntity);
             }
@@ -371,7 +371,7 @@ public async Task RestoreOnIdSetsDeletedFalse()
             bool success;
             Guid id = (Guid)_deletedEntity.Id;
 
-            using (_repository)
+            await using (_repository)
             {
                 success = await _repository.Restore(id);
             }
@@ -388,7 +388,7 @@ public async Task RestoreOnInvalidIdReturnsFalse(Guid randomId)
         {
             bool success;
 
-            using(_repository)
+            await using(_repository)
             {
                 success = await _repository.Restore(randomId);
             }
diff --git a/NetCoreEntityFramework.Tests/Mocks/TestEntityRepository.cs b/NetCoreEntityFramework.Tests/Mocks/TestEntityRepository.cs
@@ -2,7 +2,7 @@
 
 namespace Nodes.NetCore.EntityFramework.Tests.Mocks
 {
-    public class TestEntityRepository : EntityRepository<TestEntity, TestContext>
+    public class TestEntityRepository : EntityRepository<TestEntity>
     {
         public TestEntityRepository(TestContext context) : base(context, context.Table)
         {
diff --git a/NetCoreEntityFramework/Repositories/EntityRepository.cs b/NetCoreEntityFramework/Repositories/EntityRepository.cs
@@ -10,12 +10,12 @@
 
 namespace Nodes.NetCore.EntityFramework.Repositories
 {
-    public abstract class EntityRepository<TEntity, TContext> : IEntityRepository<TEntity, TContext> where TEntity : EntityBase where TContext : DbContext
+    public abstract class EntityRepository<TEntity> : IEntityRepository<TEntity> where TEntity : EntityBase
     {
         protected DbSet<TEntity> Table { get; private set; }
-        private TContext Context { get; set; }
+        private DbContext Context { get; set; }
 
-        protected EntityRepository(TContext context, DbSet<TEntity> table)
+        protected EntityRepository(DbContext context, DbSet<TEntity> table)
         {
             Context = context;
             Table = table;
@@ -143,33 +143,19 @@ public virtual Task<bool> Restore(TEntity entity)
             return Task.FromResult(true);
         }
 
-        public void Dispose()
-        {
-            Context.SaveChanges();
-        }
-
         private IQueryable<TEntity> GetQueryable(
             Expression<Func<TEntity, bool>> where = null,
             Expression<Func<TEntity, object>> orderByExpression = null,
             OrderBy orderBy = OrderBy.Ascending,
             GetListMode mode = GetListMode.ExcludeDeleted)
         {
-            IQueryable<TEntity> query;
-
-            switch (mode)
+            IQueryable<TEntity> query = mode switch
             {
-                case GetListMode.ExcludeDeleted:
-                    query = Table.Where(e => !e.Deleted);
-                    break;
-                case GetListMode.IncludeDeleted:
-                    query = Table;
-                    break;
-                case GetListMode.OnlyDeleted:
-                    query = Table.Where(e => e.Deleted);
-                    break;
-                default:
-                    throw new ArgumentException("Unknown setting", nameof(mode));
-            }
+                GetListMode.ExcludeDeleted => Table.Where(e => !e.Deleted),
+                GetListMode.IncludeDeleted => Table,
+                GetListMode.OnlyDeleted => Table.Where(e => e.Deleted),
+                _ => throw new ArgumentException("Unknown setting", nameof(mode)),
+            };
 
             if (where != null)
                 query = query.Where(where);
@@ -183,5 +169,10 @@ private IQueryable<TEntity> GetQueryable(
 
             return query;
         }
+
+        public async ValueTask DisposeAsync()
+        {
+            await Context.SaveChangesAsync();
+        }
     }
 }
diff --git a/NetCoreEntityFramework/Repositories/IEntityRepository.cs b/NetCoreEntityFramework/Repositories/IEntityRepository.cs
@@ -9,7 +9,7 @@
 
 namespace Nodes.NetCore.EntityFramework.Repositories
 {
-    public interface IEntityRepository<TEntity, TContext> : IDisposable where TEntity : EntityBase where TContext : DbContext
+    public interface IEntityRepository<TEntity> : IAsyncDisposable where TEntity : EntityBase
     {
         /// <summary>
         /// Get the entity with the given <paramref name="id"/>.

Original file line number	Diff line number	Diff line change
`@@ -70,7 +70,7 @@ public async Task AddAddsEntityAndSetsAttributes()`
`70`	`70`	`int expectedSize = startSize + 1;`
`71`	`71`	`var entity = new TestEntity();`
`72`	`72`
`73`		`- using(_repository)`
	`73`	`+ await using(_repository)`
`74`	`74`	`{`
`75`	`75`	`await _repository.Add(entity);`
`76`	`76`	`}`
`@@ -91,7 +91,7 @@ public async Task AddEntityWithIdKeepsId()`
`91`	`91`	`Id = id`
`92`	`92`	`};`
`93`	`93`
`94`		`- using (_repository)`
	`94`	`+ await using (_repository)`
`95`	`95`	`{`
`96`	`96`	`await _repository.Add(entity);`
`97`	`97`	`}`
`@@ -264,7 +264,7 @@ public async Task UpdateUpdatesUpdated(string propertyValue)`
`264`	`264`	`DateTime oldCreated = _entity.Created;`
`265`	`265`	`_entity.Property = propertyValue;`
`266`	`266`
`267`		`- using(_repository)`
	`267`	`+ await using(_repository)`
`268`	`268`	`{`
`269`	`269`	`await _repository.Update(_entity);`
`270`	`270`	`}`
`@@ -288,7 +288,7 @@ public void UpdateThrowsExceptionIfNull()`
`288`	`288`	`public async Task DeleteSoftDeletesAndSetsDeletedAt()`
`289`	`289`	`{`
`290`	`290`	`bool success;`
`291`		`- using(_repository)`
	`291`	`+ await using(_repository)`
`292`	`292`	`{`
`293`	`293`	`success = await _repository.Delete(_entity);`
`294`	`294`	`}`
`@@ -310,7 +310,7 @@ public async Task DeleteWithValidIdDeletesAndSetsDeletedAt()`
`310`	`310`	`{`
`311`	`311`	`bool success;`
`312`	`312`	`Guid id = (Guid)_entity.Id;`
`313`		`- using (_repository)`
	`313`	`+ await using (_repository)`
`314`	`314`	`{`
`315`	`315`	`success = await _repository.Delete(id);`
`316`	`316`	`}`
`@@ -327,7 +327,7 @@ public async Task DeleteWithInvalidIdReturnsFalse(Guid randomId)`
`327`	`327`	`{`
`328`	`328`	`bool success;`
`329`	`329`
`330`		`- using(_repository)`
	`330`	`+ await using(_repository)`
`331`	`331`	`{`
`332`	`332`	`success = await _repository.Delete(randomId);`
`333`	`333`	`}`
`@@ -348,7 +348,7 @@ public async Task RestoreSetsDeletedFalse()`
`348`	`348`	`{`
`349`	`349`	`bool success;`
`350`	`350`
`351`		`- using(_repository)`
	`351`	`+ await using(_repository)`
`352`	`352`	`{`
`353`	`353`	`success = await _repository.Restore(_deletedEntity);`
`354`	`354`	`}`
`@@ -371,7 +371,7 @@ public async Task RestoreOnIdSetsDeletedFalse()`
`371`	`371`	`bool success;`
`372`	`372`	`Guid id = (Guid)_deletedEntity.Id;`
`373`	`373`
`374`		`- using (_repository)`
	`374`	`+ await using (_repository)`
`375`	`375`	`{`
`376`	`376`	`success = await _repository.Restore(id);`
`377`	`377`	`}`
`@@ -388,7 +388,7 @@ public async Task RestoreOnInvalidIdReturnsFalse(Guid randomId)`
`388`	`388`	`{`
`389`	`389`	`bool success;`
`390`	`390`
`391`		`- using(_repository)`
	`391`	`+ await using(_repository)`
`392`	`392`	`{`
`393`	`393`	`success = await _repository.Restore(randomId);`
`394`	`394`	`}`
Original file line number	Diff line number	Diff line change
`@@ -2,7 +2,7 @@`
`2`	`2`
`3`	`3`	`namespace Nodes.NetCore.EntityFramework.Tests.Mocks`
`4`	`4`	`{`
`5`		`- public class TestEntityRepository : EntityRepository<TestEntity, TestContext>`
	`5`	`+ public class TestEntityRepository : EntityRepository<TestEntity>`
`6`	`6`	`{`
`7`	`7`	`public TestEntityRepository(TestContext context) : base(context, context.Table)`
`8`	`8`	`{`
Original file line number	Diff line number	Diff line change
`@@ -9,7 +9,7 @@`
`9`	`9`
`10`	`10`	`namespace Nodes.NetCore.EntityFramework.Repositories`
`11`	`11`	`{`
`12`		`- public interface IEntityRepository<TEntity, TContext> : IDisposable where TEntity : EntityBase where TContext : DbContext`
	`12`	`+ public interface IEntityRepository<TEntity> : IAsyncDisposable where TEntity : EntityBase`
`13`	`13`	`{`
`14`	`14`	`/// <summary>`
`15`	`15`	`/// Get the entity with the given <paramref name="id"/>.`