Skip to content

Commit 3af6f9b

Browse files
committed
style: TEntity --> TResource
1 parent f2e411c commit 3af6f9b

19 files changed

+144
-144
lines changed

src/JsonApiDotNetCore/Data/DbContextResolver.cs

+1-1
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ public DbContextResolver(TContext context)
1414

1515
public DbContext GetContext() => _context;
1616

17-
public DbSet<TEntity> GetDbSet<TEntity>() where TEntity : class => null;
17+
public DbSet<TResource> GetDbSet<TResource>() where TResource : class => null;
1818

1919
}
2020
}

src/JsonApiDotNetCore/Data/DefaultResourceRepository.cs

+26-26
Original file line numberDiff line numberDiff line change
@@ -18,12 +18,12 @@ namespace JsonApiDotNetCore.Data
1818
/// Provides a default repository implementation and is responsible for
1919
/// abstracting any EF Core APIs away from the service layer.
2020
/// </summary>
21-
public class DefaultResourceRepository<TEntity, TId> : IResourceRepository<TEntity, TId>
22-
where TEntity : class, IIdentifiable<TId>
21+
public class DefaultResourceRepository<TResource, TId> : IResourceRepository<TResource, TId>
22+
where TResource : class, IIdentifiable<TId>
2323
{
2424
private readonly ITargetedFields _targetedFields;
2525
private readonly DbContext _context;
26-
private readonly DbSet<TEntity> _dbSet;
26+
private readonly DbSet<TResource> _dbSet;
2727
private readonly IResourceGraph _resourceGraph;
2828
private readonly IGenericProcessorFactory _genericProcessorFactory;
2929

@@ -46,16 +46,16 @@ public DefaultResourceRepository(
4646
_resourceGraph = resourceGraph;
4747
_genericProcessorFactory = genericProcessorFactory;
4848
_context = contextResolver.GetContext();
49-
_dbSet = _context.Set<TEntity>();
49+
_dbSet = _context.Set<TResource>();
5050
}
5151

5252
/// <inheritdoc />
53-
public virtual IQueryable<TEntity> Get() => _dbSet;
53+
public virtual IQueryable<TResource> Get() => _dbSet;
5454
/// <inheritdoc />
55-
public virtual IQueryable<TEntity> Get(TId id) => _dbSet.Where(e => e.Id.Equals(id));
55+
public virtual IQueryable<TResource> Get(TId id) => _dbSet.Where(e => e.Id.Equals(id));
5656

5757
/// <inheritdoc />
58-
public virtual IQueryable<TEntity> Select(IQueryable<TEntity> entities, List<AttrAttribute> fields)
58+
public virtual IQueryable<TResource> Select(IQueryable<TResource> entities, List<AttrAttribute> fields)
5959
{
6060
if (fields?.Count > 0)
6161
return entities.Select(fields);
@@ -64,24 +64,24 @@ public virtual IQueryable<TEntity> Select(IQueryable<TEntity> entities, List<Att
6464
}
6565

6666
/// <inheritdoc />
67-
public virtual IQueryable<TEntity> Filter(IQueryable<TEntity> entities, FilterQueryContext filterQueryContext)
67+
public virtual IQueryable<TResource> Filter(IQueryable<TResource> entities, FilterQueryContext filterQueryContext)
6868
{
6969
if (filterQueryContext.IsCustom)
7070
{
71-
var query = (Func<IQueryable<TEntity>, FilterQuery, IQueryable<TEntity>>)filterQueryContext.CustomQuery;
71+
var query = (Func<IQueryable<TResource>, FilterQuery, IQueryable<TResource>>)filterQueryContext.CustomQuery;
7272
return query(entities, filterQueryContext.Query);
7373
}
7474
return entities.Filter(filterQueryContext);
7575
}
7676

7777
/// <inheritdoc />
78-
public virtual IQueryable<TEntity> Sort(IQueryable<TEntity> entities, SortQueryContext sortQueryContext)
78+
public virtual IQueryable<TResource> Sort(IQueryable<TResource> entities, SortQueryContext sortQueryContext)
7979
{
8080
return entities.Sort(sortQueryContext);
8181
}
8282

8383
/// <inheritdoc />
84-
public virtual async Task<TEntity> CreateAsync(TEntity entity)
84+
public virtual async Task<TResource> CreateAsync(TResource entity)
8585
{
8686
foreach (var relationshipAttr in _targetedFields.Relationships)
8787
{
@@ -150,7 +150,7 @@ private bool IsHasOneRelationship(string internalRelationshipName, Type type)
150150
return !type.GetProperty(internalRelationshipName).PropertyType.Inherits(typeof(IEnumerable));
151151
}
152152

153-
private void DetachRelationships(TEntity entity)
153+
private void DetachRelationships(TResource entity)
154154
{
155155
foreach (var relationshipAttr in _targetedFields.Relationships)
156156
{
@@ -176,7 +176,7 @@ private void DetachRelationships(TEntity entity)
176176
}
177177

178178
/// <inheritdoc />
179-
public virtual async Task<TEntity> UpdateAsync(TEntity updatedEntity)
179+
public virtual async Task<TResource> UpdateAsync(TResource updatedEntity)
180180
{
181181
var databaseEntity = await Get(updatedEntity.Id).FirstOrDefaultAsync();
182182
if (databaseEntity == null)
@@ -212,7 +212,7 @@ public virtual async Task<TEntity> UpdateAsync(TEntity updatedEntity)
212212
/// to the change tracker. It does so by checking if there already are
213213
/// instances of the to-be-attached entities in the change tracker.
214214
/// </summary>
215-
private object GetTrackedRelationshipValue(RelationshipAttribute relationshipAttr, TEntity entity, out bool wasAlreadyAttached)
215+
private object GetTrackedRelationshipValue(RelationshipAttribute relationshipAttr, TResource entity, out bool wasAlreadyAttached)
216216
{
217217
wasAlreadyAttached = false;
218218
if (relationshipAttr is HasOneAttribute hasOneAttr)
@@ -278,7 +278,7 @@ public virtual async Task<bool> DeleteAsync(TId id)
278278
return true;
279279
}
280280

281-
public virtual IQueryable<TEntity> Include(IQueryable<TEntity> entities, params RelationshipAttribute[] inclusionChain)
281+
public virtual IQueryable<TResource> Include(IQueryable<TResource> entities, params RelationshipAttribute[] inclusionChain)
282282
{
283283
if (!inclusionChain.Any())
284284
return entities;
@@ -293,7 +293,7 @@ public virtual IQueryable<TEntity> Include(IQueryable<TEntity> entities, params
293293
}
294294

295295
/// <inheritdoc />
296-
public virtual async Task<IEnumerable<TEntity>> PageAsync(IQueryable<TEntity> entities, int pageSize, int pageNumber)
296+
public virtual async Task<IEnumerable<TResource>> PageAsync(IQueryable<TResource> entities, int pageSize, int pageNumber)
297297
{
298298
if (pageNumber >= 0)
299299
{
@@ -315,25 +315,25 @@ public virtual async Task<IEnumerable<TEntity>> PageAsync(IQueryable<TEntity> en
315315
}
316316

317317
/// <inheritdoc />
318-
public async Task<int> CountAsync(IQueryable<TEntity> entities)
318+
public async Task<int> CountAsync(IQueryable<TResource> entities)
319319
{
320-
return (entities is IAsyncEnumerable<TEntity>)
320+
return (entities is IAsyncEnumerable<TResource>)
321321
? await entities.CountAsync()
322322
: entities.Count();
323323
}
324324

325325
/// <inheritdoc />
326-
public async Task<TEntity> FirstOrDefaultAsync(IQueryable<TEntity> entities)
326+
public async Task<TResource> FirstOrDefaultAsync(IQueryable<TResource> entities)
327327
{
328-
return (entities is IAsyncEnumerable<TEntity>)
328+
return (entities is IAsyncEnumerable<TResource>)
329329
? await entities.FirstOrDefaultAsync()
330330
: entities.FirstOrDefault();
331331
}
332332

333333
/// <inheritdoc />
334-
public async Task<IReadOnlyList<TEntity>> ToListAsync(IQueryable<TEntity> entities)
334+
public async Task<IReadOnlyList<TResource>> ToListAsync(IQueryable<TResource> entities)
335335
{
336-
return (entities is IAsyncEnumerable<TEntity>)
336+
return (entities is IAsyncEnumerable<TResource>)
337337
? await entities.ToListAsync()
338338
: entities.ToList();
339339
}
@@ -351,7 +351,7 @@ public async Task<IReadOnlyList<TEntity>> ToListAsync(IQueryable<TEntity> entiti
351351
/// after which the reassignment `p1.todoItems = [t3, t4]` will actually
352352
/// make EF Core perform a complete replace. This method does the loading of `[t1, t2]`.
353353
/// </summary>
354-
protected void LoadCurrentRelationships(TEntity oldEntity, RelationshipAttribute relationshipAttribute)
354+
protected void LoadCurrentRelationships(TResource oldEntity, RelationshipAttribute relationshipAttribute)
355355
{
356356
if (relationshipAttribute is HasManyThroughAttribute throughAttribute)
357357
{
@@ -369,7 +369,7 @@ protected void LoadCurrentRelationships(TEntity oldEntity, RelationshipAttribute
369369
/// use the join table (ArticleTags). This methods assigns the relationship value to entity
370370
/// by taking care of that
371371
/// </summary>
372-
private void AssignHasManyThrough(TEntity entity, HasManyThroughAttribute hasManyThrough, IList relationshipValue)
372+
private void AssignHasManyThrough(TResource entity, HasManyThroughAttribute hasManyThrough, IList relationshipValue)
373373
{
374374
var pointers = relationshipValue.Cast<IIdentifiable>();
375375
var throughRelationshipCollection = Activator.CreateInstance(hasManyThrough.ThroughProperty.PropertyType) as IList;
@@ -414,8 +414,8 @@ private IIdentifiable AttachOrGetTracked(IIdentifiable relationshipValue)
414414
}
415415

416416
/// <inheritdoc />
417-
public class DefaultResourceRepository<TEntity> : DefaultResourceRepository<TEntity, int>, IResourceRepository<TEntity>
418-
where TEntity : class, IIdentifiable<int>
417+
public class DefaultResourceRepository<TResource> : DefaultResourceRepository<TResource, int>, IResourceRepository<TResource>
418+
where TResource : class, IIdentifiable<int>
419419
{
420420
public DefaultResourceRepository(ITargetedFields targetedFields,
421421
IDbContextResolver contextResolver,

src/JsonApiDotNetCore/Data/IDbContextResolver.cs

+3-3
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,8 @@ public interface IDbContextResolver
77
{
88
DbContext GetContext();
99

10-
[Obsolete("Use DbContext.Set<TEntity>() instead", error: true)]
11-
DbSet<TEntity> GetDbSet<TEntity>()
12-
where TEntity : class;
10+
[Obsolete("Use DbContext.Set<TResource>() instead", error: true)]
11+
DbSet<TResource> GetDbSet<TResource>()
12+
where TResource : class;
1313
}
1414
}

src/JsonApiDotNetCore/Data/IResourceReadRepository.cs

+15-15
Original file line numberDiff line numberDiff line change
@@ -6,27 +6,27 @@
66

77
namespace JsonApiDotNetCore.Data
88
{
9-
public interface IResourceReadRepository<TEntity>
10-
: IResourceReadRepository<TEntity, int>
11-
where TEntity : class, IIdentifiable<int>
9+
public interface IResourceReadRepository<TResource>
10+
: IResourceReadRepository<TResource, int>
11+
where TResource : class, IIdentifiable<int>
1212
{ }
1313

14-
public interface IResourceReadRepository<TEntity, in TId>
15-
where TEntity : class, IIdentifiable<TId>
14+
public interface IResourceReadRepository<TResource, in TId>
15+
where TResource : class, IIdentifiable<TId>
1616
{
1717
/// <summary>
1818
/// The base GET query. This is a good place to apply rules that should affect all reads,
1919
/// such as authorization of resources.
2020
/// </summary>
21-
IQueryable<TEntity> Get();
21+
IQueryable<TResource> Get();
2222
/// <summary>
2323
/// Get the entity by id
2424
/// </summary>
25-
IQueryable<TEntity> Get(TId id);
25+
IQueryable<TResource> Get(TId id);
2626
/// <summary>
2727
/// Apply fields to the provided queryable
2828
/// </summary>
29-
IQueryable<TEntity> Select(IQueryable<TEntity> entities, List<AttrAttribute> fields);
29+
IQueryable<TResource> Select(IQueryable<TResource> entities, List<AttrAttribute> fields);
3030
/// <summary>
3131
/// Include a relationship in the query
3232
/// </summary>
@@ -35,30 +35,30 @@ public interface IResourceReadRepository<TEntity, in TId>
3535
/// _todoItemsRepository.GetAndIncludeAsync(1, "achieved-date");
3636
/// </code>
3737
/// </example>
38-
IQueryable<TEntity> Include(IQueryable<TEntity> entities, params RelationshipAttribute[] inclusionChain);
38+
IQueryable<TResource> Include(IQueryable<TResource> entities, params RelationshipAttribute[] inclusionChain);
3939
/// <summary>
4040
/// Apply a filter to the provided queryable
4141
/// </summary>
42-
IQueryable<TEntity> Filter(IQueryable<TEntity> entities, FilterQueryContext filterQuery);
42+
IQueryable<TResource> Filter(IQueryable<TResource> entities, FilterQueryContext filterQuery);
4343
/// <summary>
4444
/// Apply a sort to the provided queryable
4545
/// </summary>
46-
IQueryable<TEntity> Sort(IQueryable<TEntity> entities, SortQueryContext sortQueries);
46+
IQueryable<TResource> Sort(IQueryable<TResource> entities, SortQueryContext sortQueries);
4747
/// <summary>
4848
/// Paginate the provided queryable
4949
/// </summary>
50-
Task<IEnumerable<TEntity>> PageAsync(IQueryable<TEntity> entities, int pageSize, int pageNumber);
50+
Task<IEnumerable<TResource>> PageAsync(IQueryable<TResource> entities, int pageSize, int pageNumber);
5151
/// <summary>
5252
/// Count the total number of records
5353
/// </summary>
54-
Task<int> CountAsync(IQueryable<TEntity> entities);
54+
Task<int> CountAsync(IQueryable<TResource> entities);
5555
/// <summary>
5656
/// Get the first element in the collection, return the default value if collection is empty
5757
/// </summary>
58-
Task<TEntity> FirstOrDefaultAsync(IQueryable<TEntity> entities);
58+
Task<TResource> FirstOrDefaultAsync(IQueryable<TResource> entities);
5959
/// <summary>
6060
/// Convert the collection to a materialized list
6161
/// </summary>
62-
Task<IReadOnlyList<TEntity>> ToListAsync(IQueryable<TEntity> entities);
62+
Task<IReadOnlyList<TResource>> ToListAsync(IQueryable<TResource> entities);
6363
}
6464
}

src/JsonApiDotNetCore/Data/IResourceRepository.cs

+7-7
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,14 @@
22

33
namespace JsonApiDotNetCore.Data
44
{
5-
public interface IResourceRepository<TEntity>
6-
: IResourceRepository<TEntity, int>
7-
where TEntity : class, IIdentifiable<int>
5+
public interface IResourceRepository<TResource>
6+
: IResourceRepository<TResource, int>
7+
where TResource : class, IIdentifiable<int>
88
{ }
99

10-
public interface IResourceRepository<TEntity, in TId>
11-
: IResourceReadRepository<TEntity, TId>,
12-
IResourceWriteRepository<TEntity, TId>
13-
where TEntity : class, IIdentifiable<TId>
10+
public interface IResourceRepository<TResource, in TId>
11+
: IResourceReadRepository<TResource, TId>,
12+
IResourceWriteRepository<TResource, TId>
13+
where TResource : class, IIdentifiable<TId>
1414
{ }
1515
}

src/JsonApiDotNetCore/Data/IResourceWriteRepository.cs

+7-7
Original file line numberDiff line numberDiff line change
@@ -5,17 +5,17 @@
55

66
namespace JsonApiDotNetCore.Data
77
{
8-
public interface IResourceWriteRepository<TEntity>
9-
: IResourceWriteRepository<TEntity, int>
10-
where TEntity : class, IIdentifiable<int>
8+
public interface IResourceWriteRepository<TResource>
9+
: IResourceWriteRepository<TResource, int>
10+
where TResource : class, IIdentifiable<int>
1111
{ }
1212

13-
public interface IResourceWriteRepository<TEntity, in TId>
14-
where TEntity : class, IIdentifiable<TId>
13+
public interface IResourceWriteRepository<TResource, in TId>
14+
where TResource : class, IIdentifiable<TId>
1515
{
16-
Task<TEntity> CreateAsync(TEntity entity);
16+
Task<TResource> CreateAsync(TResource entity);
1717

18-
Task<TEntity> UpdateAsync(TEntity entity);
18+
Task<TResource> UpdateAsync(TResource entity);
1919

2020
Task UpdateRelationshipsAsync(object parent, RelationshipAttribute relationship, IEnumerable<string> relationshipIds);
2121

src/JsonApiDotNetCore/Extensions/TypeExtensions.cs

+1-1
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ public static void AddRange<T>(this IList list, IEnumerable<T> items)
3333
/// <summary>
3434
/// Extension to use the LINQ cast method in a non-generic way:
3535
/// <code>
36-
/// Type targetType = typeof(TEntity)
36+
/// Type targetType = typeof(TResource)
3737
/// ((IList)myList).Cast(targetType).
3838
/// </code>
3939
/// </summary>

src/JsonApiDotNetCore/Hooks/Discovery/HooksDiscovery.cs

+3-3
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ namespace JsonApiDotNetCore.Hooks
1010
/// <summary>
1111
/// The default implementation for IHooksDiscovery
1212
/// </summary>
13-
public class HooksDiscovery<TEntity> : IHooksDiscovery<TEntity> where TEntity : class, IIdentifiable
13+
public class HooksDiscovery<TResource> : IHooksDiscovery<TResource> where TResource : class, IIdentifiable
1414
{
1515
private readonly ResourceHook[] _allHooks;
1616
private readonly ResourceHook[] _databaseValuesAttributeAllowed =
@@ -40,8 +40,8 @@ public HooksDiscovery()
4040
/// <returns>The implemented hooks for model.</returns>
4141
void DiscoverImplementedHooksForModel()
4242
{
43-
Type parameterizedResourceDefinition = typeof(ResourceDefinition<TEntity>);
44-
var derivedTypes = TypeLocator.GetDerivedTypes(typeof(TEntity).Assembly, parameterizedResourceDefinition).ToList();
43+
Type parameterizedResourceDefinition = typeof(ResourceDefinition<TResource>);
44+
var derivedTypes = TypeLocator.GetDerivedTypes(typeof(TResource).Assembly, parameterizedResourceDefinition).ToList();
4545

4646

4747
var implementedHooks = new List<ResourceHook>();

src/JsonApiDotNetCore/Hooks/Discovery/IHooksDiscovery.cs

+3-3
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,11 @@ namespace JsonApiDotNetCore.Hooks
44
{
55

66
/// <summary>
7-
/// A singleton service for a particular TEntity that stores a field of
7+
/// A singleton service for a particular TResource that stores a field of
88
/// enums that represents which resource hooks have been implemented for that
99
/// particular entity.
1010
/// </summary>
11-
public interface IHooksDiscovery<TEntity> : IHooksDiscovery where TEntity : class, IIdentifiable
11+
public interface IHooksDiscovery<TResource> : IHooksDiscovery where TResource : class, IIdentifiable
1212
{
1313

1414
}
@@ -17,7 +17,7 @@ public interface IHooksDiscovery<TEntity> : IHooksDiscovery where TEntity : clas
1717
public interface IHooksDiscovery
1818
{
1919
/// <summary>
20-
/// A list of the implemented hooks for resource TEntity
20+
/// A list of the implemented hooks for resource TResource
2121
/// </summary>
2222
/// <value>The implemented hooks.</value>
2323
ResourceHook[] ImplementedHooks { get; }

src/JsonApiDotNetCore/Hooks/Execution/IHookExecutorHelper.cs

+1-1
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ internal interface IHookExecutorHelper
3131
/// Also caches the retrieves containers so we don't need to reflectively
3232
/// instantiate them multiple times.
3333
/// </summary>
34-
IResourceHookContainer<TEntity> GetResourceHookContainer<TEntity>(ResourceHook hook = ResourceHook.None) where TEntity : class, IIdentifiable;
34+
IResourceHookContainer<TResource> GetResourceHookContainer<TResource>(ResourceHook hook = ResourceHook.None) where TResource : class, IIdentifiable;
3535

3636
/// <summary>
3737
/// Load the implicitly affected entities from the database for a given set of target target entities and involved relationships

0 commit comments

Comments
 (0)