Skip to content

Commit e77a5d8

Browse files
committed
IRepository renamed to IConfigurationRepository for clarity
1 parent 249064f commit e77a5d8

22 files changed

Lines changed: 76 additions & 81 deletions

src/ConfigurationRepository.EntityFramework/DbContext/RepositoryDbContext.cs renamed to src/ConfigurationRepository.EntityFramework/DbContext/ConfigurationRepositoryDbContext.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@ namespace ConfigurationRepository.EntityFramework;
55
/// <summary>
66
/// Configuration repository database context.
77
/// </summary>
8-
public class RepositoryDbContext(DbContextOptions<RepositoryDbContext> options)
9-
: DbContext(options), IRepositoryDbContext<ConfigurationEntry>
8+
public class ConfigurationRepositoryDbContext(DbContextOptions<ConfigurationRepositoryDbContext> options)
9+
: DbContext(options), IConfigurationRepositoryDbContext<ConfigurationEntry>
1010
{
1111
private readonly RepositoryDbContextOptions _options = options.FindExtension<RepositoryDbContextOptions>()
1212
?? throw new InvalidOperationException($"{nameof(RepositoryDbContextOptions)} instance not found. Configure options with UseTable() extension method.");

src/ConfigurationRepository.EntityFramework/DbContext/IRepositoryDbContext.cs renamed to src/ConfigurationRepository.EntityFramework/DbContext/IConfigurationRepositoryDbContext.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ namespace ConfigurationRepository.EntityFramework;
66
/// Configuration repository database context abstraction.
77
/// </summary>
88
/// <typeparam name="TEntry"></typeparam>
9-
public interface IRepositoryDbContext<TEntry>
9+
public interface IConfigurationRepositoryDbContext<TEntry>
1010
where TEntry : class, IConfigurationEntry
1111
{
1212
/// <summary>

src/ConfigurationRepository.EntityFramework/DependencyInjection/ConfigurationBuilderExtensions.cs

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ public static IConfigurationBuilder AddEfCoreRepository(
2020
Action<DbContextOptionsBuilder> configureOptions,
2121
Action<ConfigurationRepositorySource>? configureSource = null)
2222
{
23-
var optionsBuilder = new DbContextOptionsBuilder<RepositoryDbContext>();
23+
var optionsBuilder = new DbContextOptionsBuilder<ConfigurationRepositoryDbContext>();
2424

2525
configureOptions.Invoke(optionsBuilder);
2626

@@ -36,14 +36,14 @@ public static IConfigurationBuilder AddEfCoreRepository(
3636
/// <returns>An <see cref="IConfigurationBuilder"/> instance.</returns>
3737
public static IConfigurationBuilder AddEfCoreRepository(
3838
this IConfigurationBuilder builder,
39-
DbContextOptions<RepositoryDbContext> options,
39+
DbContextOptions<ConfigurationRepositoryDbContext> options,
4040
Action<ConfigurationRepositorySource>? configureSource = null)
4141
{
4242
var source = new ConfigurationRepositorySource();
4343

4444
var repository =
45-
new EfDictionaryConfigurationRepository<RepositoryDbContext, ConfigurationEntry>(
46-
new RepositoryDbContext(options));
45+
new EfDictionaryConfigurationRepository<ConfigurationRepositoryDbContext, ConfigurationEntry>(
46+
new ConfigurationRepositoryDbContext(options));
4747

4848
source.Repository = repository;
4949

@@ -66,7 +66,7 @@ public static IConfigurationBuilder AddEfCoreJsonRepository(
6666
Action<DbContextOptionsBuilder> configureOptions,
6767
Action<ConfigurationRepositorySource>? configureSource = null)
6868
{
69-
var optionsBuilder = new DbContextOptionsBuilder<RepositoryDbContext>();
69+
var optionsBuilder = new DbContextOptionsBuilder<ConfigurationRepositoryDbContext>();
7070

7171
configureOptions.Invoke(optionsBuilder);
7272

@@ -84,14 +84,14 @@ public static IConfigurationBuilder AddEfCoreJsonRepository(
8484
public static IConfigurationBuilder AddEfCoreJsonRepository(
8585
this IConfigurationBuilder builder,
8686
string key,
87-
DbContextOptions<RepositoryDbContext> options,
87+
DbContextOptions<ConfigurationRepositoryDbContext> options,
8888
Action<ParsableConfigurationRepositorySource>? configureSource = null)
8989
{
9090
var source = new ParsableConfigurationRepositorySource();
9191

9292
var repository =
93-
new EfParsableConfigurationRepository<RepositoryDbContext, ConfigurationEntry>(
94-
new RepositoryDbContext(options))
93+
new EfParsableConfigurationRepository<ConfigurationRepositoryDbContext, ConfigurationEntry>(
94+
new ConfigurationRepositoryDbContext(options))
9595
{
9696
Key = key
9797
};

src/ConfigurationRepository.EntityFramework/DependencyInjection/RepositoryDbContextOptionsBuilderExtensions.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ public static class RepositoryDbContextOptionsBuilderExtensions
1212
/// <summary>
1313
/// Configures table for <see cref="DbContextOptionsBuilder{TContext}"/>.
1414
/// </summary>
15-
/// <typeparam name="TContext">Type of <see cref="RepositoryDbContext"/> or it`s descendant.</typeparam>
15+
/// <typeparam name="TContext">Type of <see cref="ConfigurationRepositoryDbContext"/> or it`s descendant.</typeparam>
1616
/// <param name="optionsBuilder">Database context options builder.</param>
1717
/// <param name="tableName">Configuration table name in the database.</param>
1818
/// <param name="schemaName">Schema name of the configuration table.</param>
@@ -23,7 +23,7 @@ public static DbContextOptionsBuilder<TContext> UseTable<TContext>(
2323
string tableName,
2424
string? schemaName = null,
2525
Action<RepositoryDbContextOptions>? configurator = null)
26-
where TContext : RepositoryDbContext
26+
where TContext : ConfigurationRepositoryDbContext
2727
{
2828
var extension = (optionsBuilder.Options.FindExtension<RepositoryDbContextOptions>()
2929
?? new RepositoryDbContextOptions());

src/ConfigurationRepository.EntityFramework/DictionaryConfiguration/EfDictionaryConfigurationRepository.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,8 @@ namespace ConfigurationRepository.EntityFramework;
66
/// A dictionary repository that uses Ef Core to fetch data from database.
77
/// Configuration is stored in key-value pairs.
88
/// </summary>
9-
internal sealed class EfDictionaryConfigurationRepository<TDbContext, TEntry>(TDbContext dbContext) : IRepository
10-
where TDbContext : DbContext, IRepositoryDbContext<TEntry>
9+
internal sealed class EfDictionaryConfigurationRepository<TDbContext, TEntry>(TDbContext dbContext) : IConfigurationRepository
10+
where TDbContext : DbContext, IConfigurationRepositoryDbContext<TEntry>
1111
where TEntry : class, IConfigurationEntry
1212
{
1313
public TData GetConfiguration<TData>() => (TData)(IDictionary<string, string?>)GetConfiguration();

src/ConfigurationRepository.EntityFramework/ParsableConfiguration/EfParsableConfigurationRepository.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,8 @@ namespace ConfigurationRepository.EntityFramework;
66
/// <summary>
77
/// A parsable repository that uses Ef Core to fetch data from database.
88
/// </summary>
9-
internal sealed class EfParsableConfigurationRepository<TDbContext, TEntry> : IRepository
10-
where TDbContext : DbContext, IRepositoryDbContext<TEntry>
9+
internal sealed class EfParsableConfigurationRepository<TDbContext, TEntry> : IConfigurationRepository
10+
where TDbContext : DbContext, IConfigurationRepositoryDbContext<TEntry>
1111
where TEntry : class, IConfigurationEntry
1212
{
1313
private TDbContext DbContext { get; }

src/ConfigurationRepository/DependencyInjection/ConfigurationBuilderExtensions.cs

Lines changed: 28 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -8,15 +8,15 @@ namespace ConfigurationRepository;
88
public static class ConfigurationBuilderExtensions
99
{
1010
/// <summary>
11-
/// Adds an <see cref="IRepository"/> object to <paramref name="builder"/>.
11+
/// Adds an <see cref="IConfigurationRepository"/> object to <paramref name="builder"/>.
1212
/// </summary>
13-
/// <param name="builder">A configuration builder instance for adding <see cref="IRepository"/> or it`s descendant.</param>
14-
/// <param name="repository">An <see cref="IRepository"/> object.</param>
13+
/// <param name="builder">A configuration builder instance for adding <see cref="IConfigurationRepository"/> or it`s descendant.</param>
14+
/// <param name="repository">An <see cref="IConfigurationRepository"/> object.</param>
1515
/// <param name="configureSource">If set, configures <see cref="ConfigurationRepositorySource"/>.</param>
1616
/// <returns>An <see cref="IConfigurationBuilder"/>.</returns>
1717
public static IConfigurationBuilder AddRepository<TSource>(
1818
this IConfigurationBuilder builder,
19-
IRepository repository,
19+
IConfigurationRepository repository,
2020
Action<TSource>? configureSource = null)
2121
where TSource : ConfigurationRepositorySource, new()
2222
{
@@ -31,15 +31,15 @@ public static IConfigurationBuilder AddRepository<TSource>(
3131
}
3232

3333
/// <summary>
34-
/// Adds an <see cref="IRepository"/> object to <paramref name="builder"/> with <see cref="DictionaryRetrievalStrategy"/>.
34+
/// Adds an <see cref="IConfigurationRepository"/> object to <paramref name="builder"/> with <see cref="DictionaryRetrievalStrategy"/>.
3535
/// </summary>
36-
/// <param name="builder">A configuration builder instance for adding <see cref="IRepository"/> or it`s descendant.</param>
37-
/// <param name="repository">An <see cref="IRepository"/> object.</param>
36+
/// <param name="builder">A configuration builder instance for adding <see cref="IConfigurationRepository"/> or it`s descendant.</param>
37+
/// <param name="repository">An <see cref="IConfigurationRepository"/> object.</param>
3838
/// <param name="configureSource">If set, configures <see cref="ConfigurationRepositorySource"/>.</param>
3939
/// <returns>An <see cref="IConfigurationBuilder"/>.</returns>
4040
public static IConfigurationBuilder AddDictionaryRepository<TSource>(
4141
this IConfigurationBuilder builder,
42-
IRepository repository,
42+
IConfigurationRepository repository,
4343
Action<TSource>? configureSource = null)
4444
where TSource : ConfigurationRepositorySource, new()
4545
{
@@ -55,18 +55,18 @@ public static IConfigurationBuilder AddDictionaryRepository<TSource>(
5555
}
5656

5757
/// <summary>
58-
/// Adds an <see cref="IRepository"/> object to <paramref name="builder"/> with <see cref="ParsableRetrievalStrategy"/>.
58+
/// Adds an <see cref="IConfigurationRepository"/> object to <paramref name="builder"/> with <see cref="ParsableRetrievalStrategy"/>.
5959
/// </summary>
60-
/// <param name="builder">A configuration builder instance for adding <see cref="IRepository"/> or it`s descendant.</param>
61-
/// <param name="repository">An <see cref="IRepository"/> object.</param>
60+
/// <param name="builder">A configuration builder instance for adding <see cref="IConfigurationRepository"/> or it`s descendant.</param>
61+
/// <param name="repository">An <see cref="IConfigurationRepository"/> object.</param>
6262
/// <param name="parserFactory">A factory method that returns an instance of
6363
/// configuration parser to be used for parsing data being loaded from repository. If not specified then a factory
6464
/// creating instance of <see cref="JsonConfigurationParser"/> is used by default.</param>
6565
/// <param name="configureSource">If set, configures <see cref="ConfigurationRepositorySource"/>.</param>
6666
/// <returns>An <see cref="IConfigurationBuilder"/>.</returns>
6767
public static IConfigurationBuilder AddParsableRepository<TSource>(
6868
this IConfigurationBuilder builder,
69-
IRepository repository,
69+
IConfigurationRepository repository,
7070
Func<IConfigurationParser>? parserFactory = null,
7171
Action<TSource>? configureSource = null)
7272
where TSource : ConfigurationRepositorySource, new()
@@ -85,48 +85,48 @@ public static IConfigurationBuilder AddParsableRepository<TSource>(
8585
}
8686

8787
/// <summary>
88-
/// Adds an <see cref="IRepository"/> object to <paramref name="builder"/>.
88+
/// Adds an <see cref="IConfigurationRepository"/> object to <paramref name="builder"/>.
8989
/// </summary>
90-
/// <param name="builder">A configuration builder instance for adding <see cref="IRepository"/>.</param>
91-
/// <param name="repository">An <see cref="IRepository"/> object.</param>
90+
/// <param name="builder">A configuration builder instance for adding <see cref="IConfigurationRepository"/>.</param>
91+
/// <param name="repository">An <see cref="IConfigurationRepository"/> object.</param>
9292
/// <param name="configureSource">If set, configures <see cref="ConfigurationRepositorySource"/>.</param>
9393
/// <returns>An <see cref="IConfigurationBuilder"/>.</returns>
9494
public static IConfigurationBuilder AddRepository(
9595
this IConfigurationBuilder builder,
96-
IRepository repository,
96+
IConfigurationRepository repository,
9797
Action<ConfigurationRepositorySource>? configureSource = null)
9898
{
9999
return builder.AddRepository<ConfigurationRepositorySource>(repository, configureSource);
100100
}
101101

102102
/// <summary>
103-
/// Adds an <see cref="IRepository"/> object to <paramref name="builder"/> with <see cref="DictionaryRetrievalStrategy"/>.
103+
/// Adds an <see cref="IConfigurationRepository"/> object to <paramref name="builder"/> with <see cref="DictionaryRetrievalStrategy"/>.
104104
/// </summary>
105-
/// <param name="builder">A configuration builder instance for adding <see cref="IRepository"/>.</param>
106-
/// <param name="repository">An <see cref="IRepository"/> object.</param>
105+
/// <param name="builder">A configuration builder instance for adding <see cref="IConfigurationRepository"/>.</param>
106+
/// <param name="repository">An <see cref="IConfigurationRepository"/> object.</param>
107107
/// <param name="configureSource">If set, configures <see cref="ConfigurationRepositorySource"/>.</param>
108108
/// <returns>An <see cref="IConfigurationBuilder"/>.</returns>
109109
public static IConfigurationBuilder AddDictionaryRepository(
110110
this IConfigurationBuilder builder,
111-
IRepository repository,
111+
IConfigurationRepository repository,
112112
Action<ConfigurationRepositorySource>? configureSource = null)
113113
{
114114
return builder.AddDictionaryRepository<ConfigurationRepositorySource>(repository, configureSource);
115115
}
116116

117117
/// <summary>
118-
/// Adds an <see cref="IRepository"/> object to <paramref name="builder"/> with <see cref="DictionaryRetrievalStrategy"/>.
118+
/// Adds an <see cref="IConfigurationRepository"/> object to <paramref name="builder"/> with <see cref="DictionaryRetrievalStrategy"/>.
119119
/// </summary>
120-
/// <param name="builder">A configuration builder instance for adding <see cref="IRepository"/>.</param>
121-
/// <param name="repository">An <see cref="IRepository"/> object.</param>
120+
/// <param name="builder">A configuration builder instance for adding <see cref="IConfigurationRepository"/>.</param>
121+
/// <param name="repository">An <see cref="IConfigurationRepository"/> object.</param>
122122
/// <param name="parserFactory">A factory method that returns an instance of
123123
/// configuration parser to be used for parsing data being loaded from repository. If not specified then a factory
124124
/// creating instance of <see cref="JsonConfigurationParser"/> is used by default.</param>
125125
/// <param name="configureSource">If set, configures <see cref="ConfigurationRepositorySource"/>.</param>
126126
/// <returns>An <see cref="IConfigurationBuilder"/>.</returns>
127127
public static IConfigurationBuilder AddParsableRepository(
128128
this IConfigurationBuilder builder,
129-
IRepository repository,
129+
IConfigurationRepository repository,
130130
Func<IConfigurationParser>? parserFactory = null,
131131
Action<ConfigurationRepositorySource>? configureSource = null)
132132
{
@@ -225,16 +225,16 @@ public static IConfigurationBuilder SetDatabaseConnectionString(this IConfigurat
225225
}
226226

227227
/// <summary>
228-
/// Gets the <see cref="IRepository"/> that will be used to store configurations.
228+
/// Gets the <see cref="IConfigurationRepository"/> that will be used to store configurations.
229229
/// </summary>
230230
/// <param name="builder">An <see cref="IConfigurationBuilder"/>.</param>
231-
/// <returns>An <see cref="IRepository"/>.</returns>
232-
public static IRepository? GetConfigurationRepository(this IConfigurationBuilder builder)
231+
/// <returns>An <see cref="IConfigurationRepository"/>.</returns>
232+
public static IConfigurationRepository? GetConfigurationRepository(this IConfigurationBuilder builder)
233233
{
234234
_ = builder ?? throw new ArgumentNullException(nameof(builder));
235235

236236
return (builder.Properties.TryGetValue(RepositoryKey, out object? repository))
237-
? (IRepository)repository : null;
237+
? (IConfigurationRepository)repository : null;
238238
}
239239

240240
private const string RepositoryKey = "ConfigurationRepository:Key";

src/ConfigurationRepository/Models/ConfigurationEntry.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
namespace ConfigurationRepository;
44

55
/// <summary>
6-
/// A single configuration entry stored in an <see cref="IRepository"/>.
6+
/// A single configuration entry stored in an <see cref="IConfigurationRepository"/>.
77
/// </summary>
88
public class ConfigurationEntry : IConfigurationEntry
99
{

src/ConfigurationRepository/Models/IConfigurationEntry.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
namespace ConfigurationRepository;
55

66
/// <summary>
7-
/// A single configuration entry stored in an <see cref="IRepository"/>.
7+
/// A single configuration entry stored in an <see cref="IConfigurationRepository"/>.
88
/// </summary>
99
public interface IConfigurationEntry
1010
{

src/ConfigurationRepository/Models/IRepository.cs renamed to src/ConfigurationRepository/Models/IConfigurationRepository.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ namespace ConfigurationRepository;
55
/// <summary>
66
/// A storage for <see cref="IConfigurationProvider"/> to access a configuration.
77
/// </summary>
8-
public interface IRepository
8+
public interface IConfigurationRepository
99
{
1010
/// <summary>
1111
/// Gets configuration of type TData.

0 commit comments

Comments
 (0)