├── domain_model.png ├── database_schema.png ├── src ├── Configuration.EntityFramework.snk ├── Configuration.EntityFramework │ ├── Extensions │ │ ├── Microsoft.Extensions.Configuration.IConfigurationSection.cs │ │ ├── System.Reflection.TypeInfo.cs │ │ ├── System.Object.cs │ │ ├── Microsoft.EntityFrameworkCore.ModelBuilder.cs │ │ ├── Newtonsoft.Json.Linq.JContainer.JObject.cs │ │ ├── Microsoft.Extensions.Configuration.IConfigurationBuilder.cs │ │ └── Microsoft.Extensions.Configuration.IConfigurationRoot.cs │ ├── Configuration │ │ ├── EntityMappingConfiguration.cs │ │ ├── SettingConfiguration.cs │ │ └── SectionConfiguration.cs │ ├── Properties │ │ └── AssemblyInfo.cs │ ├── SectionEntity.cs │ ├── Context │ │ └── ConfigurationContext.cs │ ├── Configuration.EntityFramework.csproj │ ├── EFConfigurationSource.cs │ ├── SettingEntity.cs │ └── EFConfigurationProvider.cs ├── Configuration.EntityFramework.Localization │ ├── EFStringLocalizerFactory.cs │ ├── Properties │ │ └── AssemblyInfo.cs │ ├── Configuration.EntityFramework.Localization.csproj │ └── EFStringLocalizer.cs ├── Configuration.EntityFramework.sln └── Configuration.EntityFramework.Localization.sln ├── configuration.entityframework_icon.png ├── test ├── Configuration.EntityFramework.Tests │ ├── appsettings.json │ ├── Properties │ │ └── AssemblyInfo.cs │ ├── App.config │ ├── Configuration.EntityFramework.Tests.csproj │ ├── SectionEntityTests.cs │ ├── SettingEntityTests.cs │ ├── DbContextFixture.cs │ └── EFConfigurationProviderTests.cs └── Configuration.EntityFramework.Tests.sln ├── sample ├── Configuration.EntityFramework.Samples │ ├── appsettings.json │ ├── Settings │ │ ├── Child.cs │ │ ├── SectionWithChildren.cs │ │ └── SectionWithChild.cs │ ├── Properties │ │ └── AssemblyInfo.cs │ ├── Configuration.EntityFramework.Samples.csproj │ ├── Program.cs │ └── Database.cs └── Configuration.EntityFramework.Samples.sln ├── NuGet.config ├── .gitignore ├── README.md └── LICENSE /domain_model.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/thinkabouthub/Configuration.EntityFramework/HEAD/domain_model.png -------------------------------------------------------------------------------- /database_schema.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/thinkabouthub/Configuration.EntityFramework/HEAD/database_schema.png -------------------------------------------------------------------------------- /src/Configuration.EntityFramework.snk: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/thinkabouthub/Configuration.EntityFramework/HEAD/src/Configuration.EntityFramework.snk -------------------------------------------------------------------------------- /configuration.entityframework_icon.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/thinkabouthub/Configuration.EntityFramework/HEAD/configuration.entityframework_icon.png -------------------------------------------------------------------------------- /test/Configuration.EntityFramework.Tests/appsettings.json: -------------------------------------------------------------------------------- 1 | { 2 | "ConnectionStrings": { 3 | "ConfigurationContext": "Data Source=.;Initial Catalog=Configuration.Test;Integrated Security=True" 4 | } 5 | } -------------------------------------------------------------------------------- /sample/Configuration.EntityFramework.Samples/appsettings.json: -------------------------------------------------------------------------------- 1 | { 2 | "ConnectionStrings": { 3 | "ConfigurationContext": "Data Source=.;Initial Catalog=Configuration.Samples;Integrated Security=True" 4 | } 5 | } -------------------------------------------------------------------------------- /sample/Configuration.EntityFramework.Samples/Settings/Child.cs: -------------------------------------------------------------------------------- 1 | using System; 2 | 3 | namespace Configuration.EntityFramework.Samples 4 | { 5 | public class Child 6 | { 7 | public Guid Id { get; set; } 8 | 9 | public string Name { get; set; } 10 | } 11 | } 12 | -------------------------------------------------------------------------------- /NuGet.config: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | -------------------------------------------------------------------------------- /sample/Configuration.EntityFramework.Samples/Settings/SectionWithChildren.cs: -------------------------------------------------------------------------------- 1 | using System; 2 | using System.Collections.ObjectModel; 3 | 4 | namespace Configuration.EntityFramework.Samples 5 | { 6 | public class SectionWithChildren 7 | { 8 | public Guid Id { get; set; } 9 | 10 | public string Name { get; set; } 11 | 12 | public Collection Children { get; set; } 13 | } 14 | } 15 | -------------------------------------------------------------------------------- /sample/Configuration.EntityFramework.Samples/Settings/SectionWithChild.cs: -------------------------------------------------------------------------------- 1 | using System; 2 | using System.ComponentModel; 3 | 4 | namespace Configuration.EntityFramework.Samples 5 | { 6 | public class SectionWithChild 7 | { 8 | public Guid Id { get; set; } 9 | 10 | [DefaultValue("DefaultName")] 11 | public string Name { get; set; } 12 | 13 | public Child Child { get; set; } 14 | } 15 | } 16 | -------------------------------------------------------------------------------- /src/Configuration.EntityFramework/Extensions/Microsoft.Extensions.Configuration.IConfigurationSection.cs: -------------------------------------------------------------------------------- 1 | using System; 2 | using Newtonsoft.Json; 3 | 4 | namespace Microsoft.Extensions.Configuration 5 | { 6 | public static class IConfigurationSectionExtensions 7 | { 8 | public static T As(this IConfigurationSection section) 9 | { 10 | return (T)JsonConvert.DeserializeObject(section.Value, typeof(T)); 11 | } 12 | } 13 | } 14 | -------------------------------------------------------------------------------- /src/Configuration.EntityFramework/Extensions/System.Reflection.TypeInfo.cs: -------------------------------------------------------------------------------- 1 | using System; 2 | using System.Reflection; 3 | 4 | namespace Configuration.EntityFramework 5 | { 6 | public static class TypeInfoExtensions 7 | { 8 | public static bool IsSimple(this TypeInfo type) 9 | { 10 | if (type.IsGenericType && type.GetGenericTypeDefinition() == typeof(Nullable<>)) 11 | { 12 | // nullable type, check if the nested type is simple. 13 | return IsSimple(type.GetGenericArguments()[0].GetTypeInfo()); 14 | } 15 | return type.IsPrimitive 16 | || type.IsEnum 17 | || type.Equals(typeof(string)) 18 | || type.Equals(typeof(decimal)); 19 | } 20 | } 21 | } -------------------------------------------------------------------------------- /src/Configuration.EntityFramework/Configuration/EntityMappingConfiguration.cs: -------------------------------------------------------------------------------- 1 | using Microsoft.EntityFrameworkCore; 2 | using Microsoft.EntityFrameworkCore.Metadata.Builders; 3 | 4 | namespace Configuration.EntityFramework 5 | { 6 | public interface IEntityMappingConfiguration 7 | { 8 | void Map(ModelBuilder b); 9 | } 10 | 11 | public interface IEntityMappingConfiguration : IEntityMappingConfiguration where T : class 12 | { 13 | void Map(EntityTypeBuilder builder); 14 | } 15 | 16 | public abstract class EntityMappingConfiguration : IEntityMappingConfiguration where T : class 17 | { 18 | public abstract void Map(EntityTypeBuilder b); 19 | 20 | public void Map(ModelBuilder b) 21 | { 22 | Map(b.Entity()); 23 | } 24 | } 25 | } -------------------------------------------------------------------------------- /src/Configuration.EntityFramework.Localization/EFStringLocalizerFactory.cs: -------------------------------------------------------------------------------- 1 | using System; 2 | using Microsoft.Extensions.Localization; 3 | 4 | namespace Configuration.EntityFramework.Localization 5 | { 6 | public class EFStringLocalizerFactory : IStringLocalizerFactory 7 | { 8 | private readonly ConfigurationContext Context; 9 | 10 | public EFStringLocalizerFactory(ConfigurationContext context) 11 | { 12 | this.Context = context; 13 | } 14 | 15 | public IStringLocalizer Create(Type resourceSource) 16 | { 17 | return new EFStringLocalizer(this.Context); 18 | } 19 | 20 | public IStringLocalizer Create(string baseName, string location) 21 | { 22 | return new EFStringLocalizer(this.Context); 23 | } 24 | } 25 | } 26 | -------------------------------------------------------------------------------- /src/Configuration.EntityFramework/Extensions/System.Object.cs: -------------------------------------------------------------------------------- 1 | using System; 2 | using System.ComponentModel; 3 | using System.Linq; 4 | using System.Reflection; 5 | 6 | namespace Configuration.EntityFramework 7 | { 8 | public static class ObjectExtensions 9 | { 10 | public static void LoadDefaultValues(this object obj) 11 | { 12 | var properties = obj.GetType().GetTypeInfo().GetProperties().Where(p => p.GetCustomAttributes(typeof(DefaultValueAttribute), true).Any()); 13 | foreach (var property in properties) 14 | { 15 | var attribute = (DefaultValueAttribute)property.GetCustomAttributes(typeof(DefaultValueAttribute), true).First(); 16 | var value = Convert.ChangeType(attribute.Value, property.PropertyType); 17 | property.SetValue(obj, value); 18 | } 19 | } 20 | } 21 | } -------------------------------------------------------------------------------- /src/Configuration.EntityFramework/Properties/AssemblyInfo.cs: -------------------------------------------------------------------------------- 1 | using System.Reflection; 2 | using System.Runtime.InteropServices; 3 | 4 | // General Information about an assembly is controlled through the following 5 | // set of attributes. Change these attribute values to modify the information 6 | // associated with an assembly. 7 | 8 | [assembly: AssemblyConfiguration("")] 9 | [assembly: AssemblyCompany("ThinkAbout")] 10 | [assembly: AssemblyProduct("Configuration.EntityFramework")] 11 | [assembly: AssemblyTrademark("")] 12 | 13 | // Setting ComVisible to false makes the types in this assembly not visible 14 | // to COM components. If you need to access a type in this assembly from 15 | // COM, set the ComVisible attribute to true on that type. 16 | 17 | [assembly: ComVisible(false)] 18 | 19 | // The following GUID is for the ID of the typelib if this project is exposed to COM 20 | 21 | [assembly: Guid("96e2601b-97bf-42ce-b05e-2d59ea13ecf8")] -------------------------------------------------------------------------------- /test/Configuration.EntityFramework.Tests/Properties/AssemblyInfo.cs: -------------------------------------------------------------------------------- 1 | using System.Reflection; 2 | using System.Runtime.CompilerServices; 3 | using System.Runtime.InteropServices; 4 | 5 | // General Information about an assembly is controlled through the following 6 | // set of attributes. Change these attribute values to modify the information 7 | // associated with an assembly. 8 | [assembly: AssemblyConfiguration("")] 9 | [assembly: AssemblyCompany("")] 10 | [assembly: AssemblyProduct("Configuration.EntityFramework.Tests")] 11 | [assembly: AssemblyTrademark("")] 12 | 13 | // Setting ComVisible to false makes the types in this assembly not visible 14 | // to COM components. If you need to access a type in this assembly from 15 | // COM, set the ComVisible attribute to true on that type. 16 | [assembly: ComVisible(false)] 17 | 18 | // The following GUID is for the ID of the typelib if this project is exposed to COM 19 | [assembly: Guid("2522cabd-1ad9-4094-8a0d-5f35de47c865")] 20 | -------------------------------------------------------------------------------- /sample/Configuration.EntityFramework.Samples/Properties/AssemblyInfo.cs: -------------------------------------------------------------------------------- 1 | using System.Reflection; 2 | using System.Runtime.CompilerServices; 3 | using System.Runtime.InteropServices; 4 | 5 | // General Information about an assembly is controlled through the following 6 | // set of attributes. Change these attribute values to modify the information 7 | // associated with an assembly. 8 | [assembly: AssemblyConfiguration("")] 9 | [assembly: AssemblyCompany("")] 10 | [assembly: AssemblyProduct("Configuration.EntityFramework.Samples")] 11 | [assembly: AssemblyTrademark("")] 12 | 13 | // Setting ComVisible to false makes the types in this assembly not visible 14 | // to COM components. If you need to access a type in this assembly from 15 | // COM, set the ComVisible attribute to true on that type. 16 | [assembly: ComVisible(false)] 17 | 18 | // The following GUID is for the ID of the typelib if this project is exposed to COM 19 | [assembly: Guid("938a6075-bc44-4b51-a71a-9fa9b8667f93")] 20 | -------------------------------------------------------------------------------- /src/Configuration.EntityFramework.Localization/Properties/AssemblyInfo.cs: -------------------------------------------------------------------------------- 1 | using System.Reflection; 2 | using System.Runtime.CompilerServices; 3 | using System.Runtime.InteropServices; 4 | 5 | // General Information about an assembly is controlled through the following 6 | // set of attributes. Change these attribute values to modify the information 7 | // associated with an assembly. 8 | [assembly: AssemblyConfiguration("")] 9 | [assembly: AssemblyCompany("")] 10 | [assembly: AssemblyProduct("Configuration.EntityFramework.Localization")] 11 | [assembly: AssemblyTrademark("")] 12 | 13 | // Setting ComVisible to false makes the types in this assembly not visible 14 | // to COM components. If you need to access a type in this assembly from 15 | // COM, set the ComVisible attribute to true on that type. 16 | [assembly: ComVisible(false)] 17 | 18 | // The following GUID is for the ID of the typelib if this project is exposed to COM 19 | [assembly: Guid("2aad8e9e-f9f2-44b6-bf1b-3152119d83de")] 20 | -------------------------------------------------------------------------------- /src/Configuration.EntityFramework/Extensions/Microsoft.EntityFrameworkCore.ModelBuilder.cs: -------------------------------------------------------------------------------- 1 | using System; 2 | using System.Collections.Generic; 3 | using System.Linq; 4 | using System.Reflection; 5 | using Microsoft.EntityFrameworkCore; 6 | 7 | namespace Configuration.EntityFramework 8 | { 9 | public static class ModelBuilderExtensions 10 | { 11 | private static IEnumerable GetMappingTypes(this Assembly assembly, Type mappingInterface) 12 | { 13 | return assembly.GetTypes().Where(x => !x.GetTypeInfo().IsAbstract && x.GetTypeInfo().GetInterfaces().Any(y => y.GetTypeInfo().IsGenericType && (y.GetGenericTypeDefinition() == mappingInterface))); 14 | } 15 | 16 | public static void AddEntityConfigurationsFromAssembly(this ModelBuilder modelBuilder, Assembly assembly) 17 | { 18 | var mappingTypes = assembly.GetMappingTypes(typeof(IEntityMappingConfiguration<>)); 19 | foreach (var config in mappingTypes.Select(Activator.CreateInstance).Cast()) 20 | config.Map(modelBuilder); 21 | } 22 | } 23 | } -------------------------------------------------------------------------------- /src/Configuration.EntityFramework/SectionEntity.cs: -------------------------------------------------------------------------------- 1 | using System; 2 | using System.Collections.ObjectModel; 3 | using System.ComponentModel.DataAnnotations; 4 | 5 | namespace Configuration.EntityFramework 6 | { 7 | public class SectionEntity 8 | { 9 | [Required] 10 | [Key] 11 | public virtual int Id { get; set; } 12 | 13 | [Required] 14 | [MaxLength(50)] 15 | public virtual string ApplicationName { get; set; } 16 | 17 | [Required] 18 | [MaxLength(50)] 19 | public virtual string SectionName { get; set; } 20 | 21 | public virtual string Discriminator { get; set; } 22 | 23 | [MaxLength(50)] 24 | public virtual string Aspect { get; set; } 25 | 26 | public Guid? Tenant { get; set; } 27 | 28 | public virtual DateTime? Modified { get; set; } 29 | 30 | [MaxLength(50)] 31 | public virtual string ModifiedUser { get; set; } 32 | 33 | [Required] 34 | public virtual byte[] Timestamp { get; set; } 35 | 36 | public virtual Collection Settings { get; set; } 37 | } 38 | } -------------------------------------------------------------------------------- /src/Configuration.EntityFramework.sln: -------------------------------------------------------------------------------- 1 | 2 | Microsoft Visual Studio Solution File, Format Version 12.00 3 | # Visual Studio 15 4 | VisualStudioVersion = 15.0.26430.13 5 | MinimumVisualStudioVersion = 10.0.40219.1 6 | Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Configuration.EntityFramework", "Configuration.EntityFramework\Configuration.EntityFramework.csproj", "{72A13EC6-CA1E-453D-9150-F13C20FA75A2}" 7 | EndProject 8 | Global 9 | GlobalSection(SolutionConfigurationPlatforms) = preSolution 10 | Debug|Any CPU = Debug|Any CPU 11 | Release|Any CPU = Release|Any CPU 12 | EndGlobalSection 13 | GlobalSection(ProjectConfigurationPlatforms) = postSolution 14 | {72A13EC6-CA1E-453D-9150-F13C20FA75A2}.Debug|Any CPU.ActiveCfg = Debug|Any CPU 15 | {72A13EC6-CA1E-453D-9150-F13C20FA75A2}.Debug|Any CPU.Build.0 = Debug|Any CPU 16 | {72A13EC6-CA1E-453D-9150-F13C20FA75A2}.Release|Any CPU.ActiveCfg = Release|Any CPU 17 | {72A13EC6-CA1E-453D-9150-F13C20FA75A2}.Release|Any CPU.Build.0 = Release|Any CPU 18 | EndGlobalSection 19 | GlobalSection(SolutionProperties) = preSolution 20 | HideSolutionNode = FALSE 21 | EndGlobalSection 22 | EndGlobal 23 | -------------------------------------------------------------------------------- /sample/Configuration.EntityFramework.Samples/Configuration.EntityFramework.Samples.csproj: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | net462 5 | Configuration.EntityFramework.Samples 6 | Exe 7 | Configuration.EntityFramework.Samples 8 | false 9 | false 10 | false 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | -------------------------------------------------------------------------------- /src/Configuration.EntityFramework.Localization.sln: -------------------------------------------------------------------------------- 1 | 2 | Microsoft Visual Studio Solution File, Format Version 12.00 3 | # Visual Studio 15 4 | VisualStudioVersion = 15.0.26228.9 5 | MinimumVisualStudioVersion = 10.0.40219.1 6 | Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Configuration.EntityFramework.Localization", "Configuration.EntityFramework.Localization\Configuration.EntityFramework.Localization.csproj", "{2AAD8E9E-F9F2-44B6-BF1B-3152119D83DE}" 7 | EndProject 8 | Global 9 | GlobalSection(SolutionConfigurationPlatforms) = preSolution 10 | Debug|Any CPU = Debug|Any CPU 11 | Release|Any CPU = Release|Any CPU 12 | EndGlobalSection 13 | GlobalSection(ProjectConfigurationPlatforms) = postSolution 14 | {2AAD8E9E-F9F2-44B6-BF1B-3152119D83DE}.Debug|Any CPU.ActiveCfg = Debug|Any CPU 15 | {2AAD8E9E-F9F2-44B6-BF1B-3152119D83DE}.Debug|Any CPU.Build.0 = Debug|Any CPU 16 | {2AAD8E9E-F9F2-44B6-BF1B-3152119D83DE}.Release|Any CPU.ActiveCfg = Release|Any CPU 17 | {2AAD8E9E-F9F2-44B6-BF1B-3152119D83DE}.Release|Any CPU.Build.0 = Release|Any CPU 18 | EndGlobalSection 19 | GlobalSection(SolutionProperties) = preSolution 20 | HideSolutionNode = FALSE 21 | EndGlobalSection 22 | EndGlobal 23 | -------------------------------------------------------------------------------- /src/Configuration.EntityFramework/Extensions/Newtonsoft.Json.Linq.JContainer.JObject.cs: -------------------------------------------------------------------------------- 1 | using System; 2 | using System.Collections.Generic; 3 | using System.Linq; 4 | 5 | namespace Newtonsoft.Json.Linq 6 | { 7 | public static class JObjectExtensions 8 | { 9 | public static IDictionary ToDictionary(this JObject @object) 10 | { 11 | var result = @object.ToObject>(); 12 | 13 | var jObjectKeys = (from r in result 14 | let key = r.Key 15 | let value = r.Value 16 | where value.GetType() == typeof(JObject) 17 | select key).ToList(); 18 | 19 | var jArrayKeys = (from r in result 20 | let key = r.Key 21 | let value = r.Value 22 | where value.GetType() == typeof(JArray) 23 | select key).ToList(); 24 | 25 | jArrayKeys.ForEach(key => result[key] = ((JArray)result[key]).Values().Select(x => ((JValue)x).Value).ToArray()); 26 | jObjectKeys.ForEach(key => result[key] = ToDictionary(result[key] as JObject)); 27 | 28 | return result; 29 | } 30 | } 31 | } 32 | -------------------------------------------------------------------------------- /src/Configuration.EntityFramework/Configuration/SettingConfiguration.cs: -------------------------------------------------------------------------------- 1 | using Microsoft.EntityFrameworkCore; 2 | using Microsoft.EntityFrameworkCore.Metadata.Builders; 3 | 4 | namespace Configuration.EntityFramework 5 | { 6 | public class SettingConfiguration : EntityMappingConfiguration 7 | { 8 | public override void Map(EntityTypeBuilder b) 9 | { 10 | b.ToTable("Setting", "Configuration"); 11 | 12 | b.HasIndex(e => e.SectionId) 13 | .HasName("IX_Setting_SectionId"); 14 | 15 | b.HasIndex(e => new { e.SectionId, e.Key }) 16 | .HasName("IX_Setting_SectionId_Key") 17 | .IsUnique(); 18 | 19 | b.Property(e => e.Key) 20 | .IsRequired() 21 | .HasMaxLength(50); 22 | 23 | b.Property(e => e.Modified).HasDefaultValueSql("getdate()"); 24 | 25 | b.Property(e => e.ModifiedUser).HasMaxLength(50); 26 | 27 | b.Property(e => e.Timestamp) 28 | .IsRequired() 29 | .HasColumnType("timestamp") 30 | .ValueGeneratedOnAddOrUpdate(); 31 | 32 | b.HasOne(d => d.Section) 33 | .WithMany(p => p.Settings) 34 | .HasForeignKey(d => d.SectionId); 35 | } 36 | } 37 | } -------------------------------------------------------------------------------- /src/Configuration.EntityFramework/Extensions/Microsoft.Extensions.Configuration.IConfigurationBuilder.cs: -------------------------------------------------------------------------------- 1 | using System; 2 | using Configuration.EntityFramework; 3 | using Microsoft.EntityFrameworkCore; 4 | 5 | namespace Microsoft.Extensions.Configuration 6 | { 7 | public static class IConfigurationBuilderExtensions 8 | { 9 | public static IConfigurationBuilder AddEntityFrameworkConfig(this IConfigurationBuilder builder, string application = null, string discriminator = null, string aspect = "Application", bool ensureCreated = false) 10 | { 11 | return builder.Add(new EFConfigurationSource(application, discriminator, aspect, ensureCreated)); 12 | } 13 | 14 | public static IConfigurationBuilder AddEntityFrameworkConfig(this IConfigurationBuilder builder, Action options, string application = null, string discriminator = null, string aspect = "Application", bool ensureCreated = false) 15 | { 16 | return builder.Add(new EFConfigurationSource(options, application, discriminator, aspect, ensureCreated)); 17 | } 18 | 19 | public static IConfigurationBuilder AddEntityFrameworkConfig(this IConfigurationBuilder builder, ConfigurationContext context, string application = null, string discriminator = null, string aspect = "Application", bool ensureCreated = false) 20 | { 21 | return builder.Add(new EFConfigurationSource(context, application, discriminator, aspect, ensureCreated)); 22 | } 23 | } 24 | } -------------------------------------------------------------------------------- /src/Configuration.EntityFramework/Configuration/SectionConfiguration.cs: -------------------------------------------------------------------------------- 1 | using Microsoft.EntityFrameworkCore; 2 | using Microsoft.EntityFrameworkCore.Metadata.Builders; 3 | 4 | namespace Configuration.EntityFramework 5 | { 6 | public class SectionConfiguration : EntityMappingConfiguration 7 | { 8 | public override void Map(EntityTypeBuilder b) 9 | { 10 | b.ToTable("Section", "Configuration").HasKey(e => e.Id); 11 | 12 | b.HasIndex(e => new {e.ApplicationName, e.Aspect, e.SectionName, e.Discriminator}) 13 | .HasName("IX_Section_ApplicationName_Aspect_SectionName_Discriminator").IsUnique(); 14 | 15 | b.Property(e => e.Discriminator) 16 | .IsRequired(false) 17 | .HasMaxLength(450); 18 | 19 | b.Property(e => e.ApplicationName) 20 | .IsRequired() 21 | .HasMaxLength(50); 22 | 23 | b.Property(e => e.Aspect).HasMaxLength(50); 24 | 25 | b.Property(e => e.Tenant); 26 | 27 | b.Property(e => e.Modified).HasDefaultValueSql("getdate()"); 28 | 29 | b.Property(e => e.ModifiedUser).HasMaxLength(50); 30 | 31 | b.Property(e => e.SectionName) 32 | .IsRequired() 33 | .HasMaxLength(50); 34 | 35 | b.Property(e => e.Timestamp) 36 | .IsRequired() 37 | .HasColumnType("timestamp") 38 | .ValueGeneratedOnAddOrUpdate(); 39 | } 40 | } 41 | } -------------------------------------------------------------------------------- /sample/Configuration.EntityFramework.Samples.sln: -------------------------------------------------------------------------------- 1 | 2 | Microsoft Visual Studio Solution File, Format Version 12.00 3 | # Visual Studio 15 4 | VisualStudioVersion = 15.0.26228.9 5 | MinimumVisualStudioVersion = 10.0.40219.1 6 | Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Configuration.EntityFramework.Samples", "Configuration.EntityFramework.Samples\Configuration.EntityFramework.Samples.csproj", "{938A6075-BC44-4B51-A71A-9FA9B8667F93}" 7 | EndProject 8 | Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Configuration.EntityFramework", "..\src\Configuration.EntityFramework\Configuration.EntityFramework.csproj", "{BFB38E6E-6F3C-4892-90C2-33B22ABED893}" 9 | EndProject 10 | Global 11 | GlobalSection(SolutionConfigurationPlatforms) = preSolution 12 | Debug|Any CPU = Debug|Any CPU 13 | Release|Any CPU = Release|Any CPU 14 | EndGlobalSection 15 | GlobalSection(ProjectConfigurationPlatforms) = postSolution 16 | {938A6075-BC44-4B51-A71A-9FA9B8667F93}.Debug|Any CPU.ActiveCfg = Debug|Any CPU 17 | {938A6075-BC44-4B51-A71A-9FA9B8667F93}.Debug|Any CPU.Build.0 = Debug|Any CPU 18 | {938A6075-BC44-4B51-A71A-9FA9B8667F93}.Release|Any CPU.ActiveCfg = Release|Any CPU 19 | {938A6075-BC44-4B51-A71A-9FA9B8667F93}.Release|Any CPU.Build.0 = Release|Any CPU 20 | {BFB38E6E-6F3C-4892-90C2-33B22ABED893}.Debug|Any CPU.ActiveCfg = Debug|Any CPU 21 | {BFB38E6E-6F3C-4892-90C2-33B22ABED893}.Debug|Any CPU.Build.0 = Debug|Any CPU 22 | {BFB38E6E-6F3C-4892-90C2-33B22ABED893}.Release|Any CPU.ActiveCfg = Release|Any CPU 23 | {BFB38E6E-6F3C-4892-90C2-33B22ABED893}.Release|Any CPU.Build.0 = Release|Any CPU 24 | EndGlobalSection 25 | GlobalSection(SolutionProperties) = preSolution 26 | HideSolutionNode = FALSE 27 | EndGlobalSection 28 | EndGlobal 29 | -------------------------------------------------------------------------------- /src/Configuration.EntityFramework/Context/ConfigurationContext.cs: -------------------------------------------------------------------------------- 1 | using System; 2 | using System.IO; 3 | using System.Reflection; 4 | using Microsoft.EntityFrameworkCore; 5 | using Microsoft.Extensions.Configuration; 6 | using Microsoft.Extensions.Logging; 7 | 8 | namespace Configuration.EntityFramework 9 | { 10 | public class ConfigurationContext : DbContext 11 | { 12 | public ConfigurationContext() 13 | { 14 | } 15 | 16 | public ConfigurationContext(DbContextOptions options) 17 | : base(options) 18 | { 19 | } 20 | 21 | public ConfigurationContext(DbContextOptions options) 22 | : base(options) 23 | { 24 | } 25 | 26 | protected override void OnConfiguring(DbContextOptionsBuilder optionsBuilder) 27 | { 28 | if (!optionsBuilder.IsConfigured) 29 | { 30 | var builder = new ConfigurationBuilder(); 31 | builder.SetBasePath(Directory.GetCurrentDirectory()) 32 | .AddJsonFile("appsettings.json", optional: true, reloadOnChange: true); 33 | var config = builder.Build(); 34 | optionsBuilder.UseSqlServer(config.GetConnectionString("ConfigurationContext")); 35 | } 36 | } 37 | 38 | public DbSet Sections { get; set; } 39 | 40 | public DbSet Settings { get; set; } 41 | 42 | protected override void OnModelCreating(ModelBuilder modelBuilder) 43 | { 44 | modelBuilder.AddEntityConfigurationsFromAssembly(Type.GetType("Configuration.EntityFramework.ConfigurationContext, Configuration.EntityFramework").GetTypeInfo().Assembly); 45 | } 46 | } 47 | } -------------------------------------------------------------------------------- /test/Configuration.EntityFramework.Tests.sln: -------------------------------------------------------------------------------- 1 | 2 | Microsoft Visual Studio Solution File, Format Version 12.00 3 | # Visual Studio 15 4 | VisualStudioVersion = 15.0.26228.9 5 | MinimumVisualStudioVersion = 10.0.40219.1 6 | Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution Items", "{17B9A3C5-D393-4C5A-AD42-2BBAAFC385A6}" 7 | EndProject 8 | Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Configuration.EntityFramework.Tests", "Configuration.EntityFramework.Tests\Configuration.EntityFramework.Tests.csproj", "{2522CABD-1AD9-4094-8A0D-5F35DE47C865}" 9 | EndProject 10 | Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Configuration.EntityFramework", "..\src\Configuration.EntityFramework\Configuration.EntityFramework.csproj", "{933039C4-065E-4588-9EC0-8E8996F62D6F}" 11 | EndProject 12 | Global 13 | GlobalSection(SolutionConfigurationPlatforms) = preSolution 14 | Debug|Any CPU = Debug|Any CPU 15 | Release|Any CPU = Release|Any CPU 16 | EndGlobalSection 17 | GlobalSection(ProjectConfigurationPlatforms) = postSolution 18 | {2522CABD-1AD9-4094-8A0D-5F35DE47C865}.Debug|Any CPU.ActiveCfg = Debug|Any CPU 19 | {2522CABD-1AD9-4094-8A0D-5F35DE47C865}.Debug|Any CPU.Build.0 = Debug|Any CPU 20 | {2522CABD-1AD9-4094-8A0D-5F35DE47C865}.Release|Any CPU.ActiveCfg = Release|Any CPU 21 | {2522CABD-1AD9-4094-8A0D-5F35DE47C865}.Release|Any CPU.Build.0 = Release|Any CPU 22 | {933039C4-065E-4588-9EC0-8E8996F62D6F}.Debug|Any CPU.ActiveCfg = Debug|Any CPU 23 | {933039C4-065E-4588-9EC0-8E8996F62D6F}.Debug|Any CPU.Build.0 = Debug|Any CPU 24 | {933039C4-065E-4588-9EC0-8E8996F62D6F}.Release|Any CPU.ActiveCfg = Release|Any CPU 25 | {933039C4-065E-4588-9EC0-8E8996F62D6F}.Release|Any CPU.Build.0 = Release|Any CPU 26 | EndGlobalSection 27 | GlobalSection(SolutionProperties) = preSolution 28 | HideSolutionNode = FALSE 29 | EndGlobalSection 30 | EndGlobal 31 | -------------------------------------------------------------------------------- /test/Configuration.EntityFramework.Tests/App.config: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | " 9 | 10 | 11 | 12 | 13 | " 14 | 15 | 16 | 17 | 18 | " 19 | 20 | 21 | 22 | 23 | " 24 | 25 | 26 | 27 | 28 | " 29 | 30 | 31 | 32 | 33 | " 34 | 35 | 36 | 40 | 41 | 42 | 43 | -------------------------------------------------------------------------------- /test/Configuration.EntityFramework.Tests/Configuration.EntityFramework.Tests.csproj: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | net461;net462 5 | Configuration.EntityFramework.Tests 6 | Configuration.EntityFramework.Tests 7 | true 8 | false 9 | false 10 | false 11 | true 12 | 13 | 14 | 15 | 16 | PreserveNewest 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 | 30 | 31 | 32 | 33 | 34 | 35 | 36 | 37 | 38 | 39 | 40 | 41 | 42 | 43 | 44 | 45 | 46 | -------------------------------------------------------------------------------- /src/Configuration.EntityFramework/Configuration.EntityFramework.csproj: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | Configuration.EntityFramework is a custom configuration provider for the .NET Core Configuration system. It's built on EntityFrameworkCore allowing configuration settings to be stored in a wide variety of repositories 5 | 1.0.1 6 | netstandard2.0;net461;net462 7 | $(NoWarn);1591 8 | true 9 | Configuration.EntityFramework 10 | ../Configuration.EntityFramework.snk 11 | true 12 | true 13 | Configuration.EntityFramework 14 | Configuration.EntityFramework;Configuration;EntityFramework;c#;dotnetcore 15 | Initial Release 16 | https://raw.githubusercontent.com/thinkabouthub/Configuration.EntityFramework/master/configuration.entityframework_icon.png 17 | https://github.com/thinkabouthub/Configuration.EntityFramework 18 | false 19 | false 20 | false 21 | true 22 | false 23 | true 24 | 25 | 26 | 27 | 28 | 29 | 30 | 31 | 32 | 33 | 34 | 35 | -------------------------------------------------------------------------------- /src/Configuration.EntityFramework/Extensions/Microsoft.Extensions.Configuration.IConfigurationRoot.cs: -------------------------------------------------------------------------------- 1 | using System; 2 | using System.ComponentModel; 3 | using System.Linq; 4 | using System.Reflection; 5 | using Configuration.EntityFramework; 6 | 7 | namespace Microsoft.Extensions.Configuration 8 | { 9 | public static class IConfigurationRootExtensions 10 | { 11 | public static bool SectionExists(this IConfigurationRoot configuration, string section) 12 | { 13 | return configuration.GetChildren().Any(item => item.Key == section); 14 | } 15 | 16 | public static T TryGetSection(this IConfigurationRoot configuration, string section, bool loadDefaultValues = true) where T : class, new() 17 | { 18 | return SectionExists(configuration, section) ? GetSection(configuration, section, loadDefaultValues) : null; 19 | } 20 | 21 | public static T GetSection(this IConfigurationRoot configuration, string section, bool loadDefaultValues = true) where T : class, new() 22 | { 23 | var instance = new T(); 24 | if (loadDefaultValues) configuration.LoadDefaultValues(instance); 25 | configuration.GetSection(section).Bind(instance); 26 | return instance; 27 | } 28 | 29 | public static void LoadDefaultValues(this IConfigurationRoot root, object obj) 30 | { 31 | var properties = obj.GetType().GetTypeInfo().GetProperties().Where(p => p.GetCustomAttributes(typeof(DefaultValueAttribute), true).Any()); 32 | foreach (var property in properties.Where(p => p.PropertyType.GetTypeInfo().IsSimple())) 33 | { 34 | var attribute = (DefaultValueAttribute)property.GetCustomAttributes(typeof(DefaultValueAttribute), true).First(); 35 | var value = Convert.ChangeType(attribute.Value, property.PropertyType); 36 | property.SetValue(obj, value); 37 | } 38 | foreach (var property in properties.Where(p => !p.PropertyType.GetTypeInfo().IsSimple() && !p.PropertyType.IsArray)) 39 | { 40 | var child = Activator.CreateInstance(property.PropertyType); 41 | root.LoadDefaultValues(child); 42 | property.SetValue(obj, child); 43 | } 44 | } 45 | } 46 | } -------------------------------------------------------------------------------- /src/Configuration.EntityFramework/EFConfigurationSource.cs: -------------------------------------------------------------------------------- 1 | using System; 2 | using Microsoft.EntityFrameworkCore; 3 | using Microsoft.Extensions.Configuration; 4 | 5 | namespace Configuration.EntityFramework 6 | { 7 | public class EFConfigurationSource : IConfigurationSource 8 | { 9 | protected virtual Action OptionsAction { get; set; } 10 | 11 | protected virtual ConfigurationContext Context { get; set; } 12 | 13 | protected virtual string Application { get; set; } 14 | 15 | protected virtual string Aspect { get; set; } 16 | 17 | protected virtual string Discriminator { get; set; } 18 | 19 | protected virtual bool EnsureCreated { get; set; } 20 | 21 | public EFConfigurationSource(string application = null, string discriminator = null, string aspect = "Application", bool ensureCreated = false) 22 | { 23 | this.Application = application; 24 | this.Discriminator = discriminator; 25 | this.Aspect = aspect; 26 | this.EnsureCreated = ensureCreated; 27 | } 28 | 29 | public EFConfigurationSource(Action options, string application = null, string discriminator = null, string aspect = "Application", bool ensureCreated = false) 30 | { 31 | this.OptionsAction = options; 32 | this.Application = application; 33 | this.Discriminator = discriminator; 34 | this.Aspect = aspect; 35 | this.EnsureCreated = ensureCreated; 36 | } 37 | 38 | public EFConfigurationSource(ConfigurationContext context, string application = null, string discriminator = null, string aspect = "Application", bool ensureCreated = false) 39 | { 40 | this.Context = context; 41 | this.Application = application; 42 | this.Discriminator = discriminator; 43 | this.Aspect = aspect; 44 | this.EnsureCreated = ensureCreated; 45 | } 46 | 47 | public IConfigurationProvider Build(IConfigurationBuilder builder) 48 | { 49 | return this.Context != null ? new EFConfigurationProvider(this.Context, this.Application, this.Discriminator, this.Aspect, this.EnsureCreated) : new EFConfigurationProvider(this.OptionsAction, this.Application, this.Discriminator, this.Aspect, this.EnsureCreated); 50 | } 51 | } 52 | } -------------------------------------------------------------------------------- /src/Configuration.EntityFramework.Localization/Configuration.EntityFramework.Localization.csproj: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | Configuration.EntityFramework.Localization provides custom localization components. These components leverage Configuration.EntityFramework for persistence 5 | 1.0.1 6 | netstandard2.0;net461;net462 7 | $(NoWarn);1591 8 | true 9 | Configuration.EntityFramework.Localization 10 | ../Configuration.EntityFramework.snk 11 | true 12 | true 13 | Configuration.EntityFramework.Localization 14 | Configuration.EntityFramework.Localization;Localization;EntityFramework;c#;dotnetcore 15 | Initial Release 16 | https://raw.githubusercontent.com/thinkabouthub/Configuration.EntityFramework/master/configuration.entityframework_icon.png 17 | https://github.com/thinkabouthub/Configuration.EntityFramework 18 | false 19 | false 20 | false 21 | true 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 | 30 | 31 | 32 | 33 | 34 | 35 | 36 | -------------------------------------------------------------------------------- /src/Configuration.EntityFramework/SettingEntity.cs: -------------------------------------------------------------------------------- 1 | using System; 2 | using System.ComponentModel.DataAnnotations; 3 | using Newtonsoft.Json; 4 | 5 | namespace Configuration.EntityFramework 6 | { 7 | public class SettingEntity 8 | { 9 | private object _value; 10 | private string _json; 11 | 12 | [Required] 13 | [Key] 14 | public virtual int Id { get; set; } 15 | 16 | [Required] 17 | public virtual int SectionId { get; set; } 18 | 19 | [Required] 20 | [MaxLength(50)] 21 | public virtual string Key { get; set; } 22 | 23 | public virtual SectionEntity Section { get; set; } 24 | 25 | public virtual string ValueType { get; set; } 26 | 27 | public virtual string DefaultValue { get; set; } 28 | 29 | public virtual T GetValue() 30 | { 31 | return (T)Convert.ChangeType(this.GetValue(typeof(T)), typeof(T)); 32 | } 33 | 34 | public virtual object GetValue(Type type) 35 | { 36 | if ((_value == null) && !string.IsNullOrEmpty(this.Json)) 37 | { 38 | _value = JsonConvert.DeserializeObject(this.Json, type); 39 | } 40 | return _value; 41 | } 42 | 43 | public virtual void SetValue(object value) 44 | { 45 | if (_value != value) 46 | { 47 | _value = value; 48 | this.ValueType = null; 49 | this.Json = null; 50 | if (value != null) 51 | { 52 | this.Json = JsonConvert.SerializeObject(value); 53 | if (string.IsNullOrEmpty(this.DefaultValue)) 54 | { 55 | this.DefaultValue = this.Json; 56 | } 57 | var name = value.GetType().AssemblyQualifiedName.Split(Convert.ToChar(",")); 58 | ValueType = $"{name[0].Trim()}, {name[1].Trim()}"; 59 | } 60 | } 61 | } 62 | 63 | public virtual string Json 64 | { 65 | get { return this._json; } 66 | set 67 | { 68 | this._json = value; 69 | this._value = null; 70 | } 71 | } 72 | 73 | public virtual DateTime? Modified { get; set; } 74 | 75 | [MaxLength(50)] 76 | public virtual string ModifiedUser { get; set; } 77 | 78 | [Required] 79 | public virtual byte[] Timestamp { get; set; } 80 | } 81 | } -------------------------------------------------------------------------------- /src/Configuration.EntityFramework.Localization/EFStringLocalizer.cs: -------------------------------------------------------------------------------- 1 | using System; 2 | using System.Collections.Generic; 3 | using System.Collections.ObjectModel; 4 | using System.Globalization; 5 | using System.Linq; 6 | using Microsoft.Extensions.Localization; 7 | 8 | namespace Configuration.EntityFramework.Localization 9 | { 10 | public class EFStringLocalizer : IStringLocalizer 11 | { 12 | private readonly ConfigurationContext Context; 13 | private readonly string CultureName; 14 | private const string AspectName = "Localization"; 15 | 16 | public EFStringLocalizer(ConfigurationContext context) : this(context, CultureInfo.CurrentUICulture) { } 17 | 18 | public EFStringLocalizer(ConfigurationContext context, CultureInfo cultureInfo) 19 | { 20 | this.Context = context; 21 | this.CultureName = cultureInfo.Name; 22 | } 23 | 24 | public virtual LocalizedString this[string name] 25 | { 26 | get 27 | { 28 | var value = this.GetString(name); 29 | return new LocalizedString(name, value ?? name, resourceNotFound: value == null); 30 | } 31 | } 32 | 33 | public virtual LocalizedString this[string name, params object[] arguments] 34 | { 35 | get 36 | { 37 | var format = GetString(name); 38 | var value = string.Format(format ?? name, arguments); 39 | return new LocalizedString(name, value, resourceNotFound: format == null); 40 | } 41 | } 42 | 43 | protected virtual string GetString(string name) 44 | { 45 | var section = this.Context.Sections.FirstOrDefault(s => s.Aspect == AspectName && (string.IsNullOrEmpty(this.CultureName) || s.SectionName == this.CultureName)); 46 | if (section != null) 47 | { 48 | var setting = this.Context.Settings.FirstOrDefault(s => s.SectionId == section.Id && s.Key == name); 49 | return setting?.GetValue(); 50 | } 51 | return name; 52 | } 53 | 54 | public virtual IStringLocalizer WithCulture(CultureInfo culture) 55 | { 56 | return new EFStringLocalizer(this.Context, culture); 57 | } 58 | 59 | public virtual IEnumerable GetAllStrings(bool includeAncestorCultures) 60 | { 61 | var section = this.Context.Sections.FirstOrDefault(s => s.Aspect == AspectName && (string.IsNullOrEmpty(this.CultureName) || s.SectionName == this.CultureName)); 62 | if (section != null) 63 | { 64 | return this.Context.Settings.Select(s => new LocalizedString(s.Key, s.GetValue(), true)); 65 | } 66 | return new Collection(); 67 | } 68 | } 69 | } 70 | -------------------------------------------------------------------------------- /sample/Configuration.EntityFramework.Samples/Program.cs: -------------------------------------------------------------------------------- 1 | using System; 2 | using Microsoft.Extensions.Configuration; 3 | 4 | namespace Configuration.EntityFramework.Samples 5 | { 6 | public class Program 7 | { 8 | public static void Main(string[] args) 9 | { 10 | // Initialise Sample Database and Seed Sample Data 11 | var db = new Database() 12 | .Create() 13 | .Seed(); 14 | 15 | MainSample(); 16 | //SettingsForApplicationSample(); 17 | //SettingsWithDiscriminatorSample(); 18 | } 19 | 20 | /// 21 | /// Common examples. 22 | /// 23 | public static void MainSample() 24 | { 25 | // Initial Configuration System 26 | var config = new ConfigurationBuilder() 27 | .SetBasePath(Environment.CurrentDirectory) 28 | .AddJsonFile("appsettings.json", true, true) 29 | .AddEntityFrameworkConfig().Build(); 30 | 31 | // Check Configuration Section Exists 32 | var exists = config.SectionExists("SectionWithChild"); 33 | 34 | // Get Configuration Section of type SectionWithChild. Return null if section does not exist. 35 | var test1 = config.TryGetSection("SectionWithChild"); 36 | 37 | // Get Configuration Section of type SectionWithChild. Return default value if section does not exist. 38 | var test2 = config.GetSection("SectionWithChild"); 39 | 40 | // Get Configuration Section of type SectionWithChildren. Return default value if section does not exist. 41 | var test3 = config.GetSection("SectionWithChildren"); 42 | 43 | // Get Configuration Value for Key. 44 | var test4 = config.GetValue("TestSetting"); 45 | } 46 | 47 | /// 48 | /// Retrieve settings for application only. 49 | /// 50 | public static void SettingsForApplicationSample() 51 | { 52 | // Initial Configuration System 53 | var config = new ConfigurationBuilder() 54 | .SetBasePath(Environment.CurrentDirectory) 55 | .AddJsonFile("appsettings.json", true, true) 56 | // Only load settings using EntityFramework Configuration Provider for "SampleApplication" application 57 | .AddEntityFrameworkConfig("SampleApplication").Build(); 58 | 59 | var test = config.GetValue("TestSetting"); 60 | } 61 | 62 | /// 63 | /// Retrieve settings filtered by discriminator. 64 | /// 65 | public static void SettingsWithDiscriminatorSample() 66 | { 67 | // Initial Configuration System 68 | var config = new ConfigurationBuilder() 69 | .SetBasePath(Environment.CurrentDirectory) 70 | .AddJsonFile("appsettings.json", true, true) 71 | // Only load settings for user "Patrick" 72 | .AddEntityFrameworkConfig("SampleApplication", @"{""Username"":""Patrick""}").Build(); 73 | 74 | var test = config.GetValue("UserTestSetting"); 75 | } 76 | } 77 | } 78 | -------------------------------------------------------------------------------- /test/Configuration.EntityFramework.Tests/SectionEntityTests.cs: -------------------------------------------------------------------------------- 1 | using System; 2 | using System.Linq; 3 | using Microsoft.EntityFrameworkCore; 4 | using Xunit; 5 | 6 | namespace Configuration.EntityFramework.Tests 7 | { 8 | public class SectionEntityTests : IClassFixture 9 | { 10 | protected virtual DbContextFixture Fixture { get; private set; } 11 | 12 | public SectionEntityTests(DbContextFixture fixture) 13 | { 14 | fixture.InitialiseContext(); 15 | this.Fixture = fixture; 16 | } 17 | 18 | [Fact] 19 | public void Given_AddSection_When_IsValid_Then_SectionPersisted() 20 | { 21 | var context = this.Fixture.GetContext(); 22 | 23 | context.Sections.Add(new SectionEntity() { Tenant = Guid.NewGuid(), ApplicationName = "DbContextSectionTests", SectionName = "appSettings", Aspect = "Application", Discriminator = @"{""Environment"":""Testing"", ""Username"":""Patrick""}", ModifiedUser = "TestUser" }); 24 | context.SaveChanges(); 25 | Assert.NotNull(context.Sections.AsNoTracking().FirstOrDefault(s => s.ApplicationName == "DbContextSectionTests" && s.SectionName == "appSettings" && s.Aspect == "Application")); 26 | } 27 | 28 | [Fact] 29 | public void Given_AddSection_When_ApplicationNameIsNotValid_Then_SectionNotPersisted() 30 | { 31 | var context = this.Fixture.GetContext(); 32 | 33 | var exception = Assert.Throws(() => 34 | { 35 | context.Sections.Add(new SectionEntity() { Tenant = Guid.NewGuid(), ApplicationName = null, SectionName = "appSettings", Aspect = "Application", ModifiedUser = "TestUser" }); 36 | context.SaveChanges(); 37 | }); 38 | Assert.True(exception.InnerException != null && exception.InnerException.Message.StartsWith("Cannot insert the value NULL into column 'ApplicationName'")); 39 | } 40 | 41 | [Fact] 42 | public void Given_AddSection_When_SectionNameIsNotValid_Then_SectionNotPersisted() 43 | { 44 | var context = this.Fixture.GetContext(); 45 | 46 | var exception = Assert.Throws(() => 47 | { 48 | context.Sections.Add(new SectionEntity() { ApplicationName = "DbContextSectionTests", SectionName = null, Aspect = "Application", ModifiedUser = "TestUser" }); 49 | context.SaveChanges(); 50 | }); 51 | Assert.True(exception.InnerException != null && exception.InnerException.Message.StartsWith("Cannot insert the value NULL into column 'SectionName'")); 52 | } 53 | 54 | //[Fact] 55 | //public void Given_AddSection_When_SectionNameIsDuplicate_Then_SectionNotPersisted() 56 | //{ 57 | // var context = this.Fixture.GetContext(); 58 | 59 | // var exception = Assert.Throws(() => 60 | // { 61 | // context.Sections.Add(new SectionEntity() { ApplicationName = "DbContextSectionTests.Duplicate", SectionName = "appSettingsC", Aspect = "Application", ModifiedUser = "TestUser" }); 62 | // context.Sections.Add(new SectionEntity() { ApplicationName = "DbContextSectionTests.Duplicate", SectionName = "appSettingsC", Aspect = "Application", ModifiedUser = "TestUser" }); 63 | // context.SaveChanges(); 64 | // }); 65 | // Assert.True(exception.InnerException != null && exception.InnerException.Message.StartsWith("Cannot insert duplicate key row in object 'Configuration.Section' with unique index 'IX_Section_ApplicationName_Aspect_SectionName_Discriminator'")); 66 | //} 67 | } 68 | } 69 | -------------------------------------------------------------------------------- /sample/Configuration.EntityFramework.Samples/Database.cs: -------------------------------------------------------------------------------- 1 | using System; 2 | using System.Collections.ObjectModel; 3 | 4 | namespace Configuration.EntityFramework.Samples 5 | { 6 | public class Database 7 | { 8 | public Database Create() 9 | { 10 | using (var context = new ConfigurationContext()) 11 | { 12 | context.Database.EnsureDeleted(); 13 | context.Database.EnsureCreated(); 14 | } 15 | return this; 16 | } 17 | 18 | public Database Seed() 19 | { 20 | this.SeedAppSetting(); 21 | this.SeedSectionWithChild(); 22 | this.SeedSectionWithChildren(); 23 | this.SeedAppSettingWithDiscriminator(); 24 | return this; 25 | } 26 | 27 | public Database SeedAppSettingWithDiscriminator() 28 | { 29 | using (var context = new ConfigurationContext()) 30 | { 31 | var section = new SectionEntity() { ApplicationName = "SampleApplication", Aspect = "settings", SectionName = "appSettings", Discriminator = @"{""Environment"":""Testing"", ""Username"":""Patrick""}" }; 32 | context.Sections.Add(section); 33 | context.SaveChanges(); 34 | 35 | var setting = new SettingEntity() { SectionId = section.Id, Key = "UserTestSetting", Json = @"""User Test Value""" }; 36 | context.Settings.Add(setting); 37 | context.SaveChanges(); 38 | } 39 | return this; 40 | } 41 | 42 | public Database SeedAppSetting() 43 | { 44 | using (var context = new ConfigurationContext()) 45 | { 46 | var section = new SectionEntity() { ApplicationName = "SampleApplication", Aspect = "settings", SectionName = "appSettings" }; 47 | context.Sections.Add(section); 48 | context.SaveChanges(); 49 | 50 | var setting = new SettingEntity() { SectionId = section.Id, Key = "TestSetting", Json = @"""Test Value""" }; 51 | context.Settings.Add(setting); 52 | context.SaveChanges(); 53 | } 54 | return this; 55 | } 56 | 57 | public Database SeedSectionWithChild() 58 | { 59 | using (var context = new ConfigurationContext()) 60 | { 61 | var complex = new SectionWithChild() 62 | { 63 | Id = Guid.NewGuid(), 64 | Name = "parent", 65 | Child = new Child() 66 | { 67 | Id = Guid.NewGuid(), 68 | Name = "child" 69 | } 70 | }; 71 | 72 | var section = new SectionEntity() { ApplicationName = "SampleApplication", Aspect = "settings", SectionName = "SectionWithChild" }; 73 | context.Sections.Add(section); 74 | context.SaveChanges(); 75 | 76 | var setting = new SettingEntity() { SectionId = section.Id, Key = "SectionWithChild" }; 77 | setting.SetValue(complex); 78 | 79 | context.Settings.Add(setting); 80 | context.SaveChanges(); 81 | } 82 | return this; 83 | } 84 | 85 | public Database SeedSectionWithChildren() 86 | { 87 | using (var context = new ConfigurationContext()) 88 | { 89 | var complex = new SectionWithChildren() 90 | { 91 | Id = Guid.NewGuid(), 92 | Name = "parent", 93 | }; 94 | complex.Children = new Collection(); 95 | complex.Children.Add 96 | ( 97 | new Child() 98 | { 99 | Id = Guid.NewGuid(), 100 | Name = "child1" 101 | } 102 | ); 103 | complex.Children.Add 104 | ( 105 | new Child() 106 | { 107 | Id = Guid.NewGuid(), 108 | Name = "child2" 109 | } 110 | ); 111 | 112 | var section = new SectionEntity() { ApplicationName = "SampleApplication", Aspect = "settings", SectionName = "SectionWithChildren" }; 113 | context.Sections.Add(section); 114 | context.SaveChanges(); 115 | 116 | var setting = new SettingEntity() { SectionId = section.Id, Key = "SectionWithChildren" }; 117 | setting.SetValue(complex); 118 | 119 | context.Settings.Add(setting); 120 | context.SaveChanges(); 121 | } 122 | return this; 123 | } 124 | } 125 | } 126 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | ## Ignore Visual Studio temporary files, build results, and 2 | ## files generated by popular Visual Studio add-ons. 3 | 4 | # User-specific files 5 | *.suo 6 | *.user 7 | *.userosscache 8 | *.sln.docstates 9 | 10 | # User-specific files (MonoDevelop/Xamarin Studio) 11 | *.userprefs 12 | 13 | # Build results 14 | [Dd]ebug/ 15 | [Dd]ebugPublic/ 16 | [Rr]elease/ 17 | [Rr]eleases/ 18 | x64/ 19 | x86/ 20 | bld/ 21 | [Bb]in/ 22 | [Oo]bj/ 23 | [Ll]og/ 24 | 25 | # Visual Studio 2015 cache/options directory 26 | .vs/ 27 | # Uncomment if you have tasks that create the project's static files in wwwroot 28 | #wwwroot/ 29 | 30 | # MSTest test Results 31 | [Tt]est[Rr]esult*/ 32 | [Bb]uild[Ll]og.* 33 | 34 | # NUNIT 35 | *.VisualState.xml 36 | TestResult.xml 37 | 38 | # Build Results of an ATL Project 39 | [Dd]ebugPS/ 40 | [Rr]eleasePS/ 41 | dlldata.c 42 | 43 | # DNX 44 | project.lock.json 45 | artifacts/ 46 | 47 | *_i.c 48 | *_p.c 49 | *_i.h 50 | *.ilk 51 | *.meta 52 | *.obj 53 | *.pch 54 | *.pdb 55 | *.pgc 56 | *.pgd 57 | *.rsp 58 | *.sbr 59 | *.tlb 60 | *.tli 61 | *.tlh 62 | *.tmp 63 | *.tmp_proj 64 | *.log 65 | *.vspscc 66 | *.vssscc 67 | .builds 68 | *.pidb 69 | *.svclog 70 | *.scc 71 | 72 | # Chutzpah Test files 73 | _Chutzpah* 74 | 75 | # Visual C++ cache files 76 | ipch/ 77 | *.aps 78 | *.ncb 79 | *.opendb 80 | *.opensdf 81 | *.sdf 82 | *.cachefile 83 | *.VC.db 84 | *.VC.VC.opendb 85 | 86 | # Visual Studio profiler 87 | *.psess 88 | *.vsp 89 | *.vspx 90 | *.sap 91 | 92 | # TFS 2012 Local Workspace 93 | $tf/ 94 | 95 | # Guidance Automation Toolkit 96 | *.gpState 97 | 98 | # ReSharper is a .NET coding add-in 99 | _ReSharper*/ 100 | *.[Rr]e[Ss]harper 101 | *.DotSettings.user 102 | 103 | # JustCode is a .NET coding add-in 104 | .JustCode 105 | 106 | # TeamCity is a build add-in 107 | _TeamCity* 108 | 109 | # DotCover is a Code Coverage Tool 110 | *.dotCover 111 | 112 | # NCrunch 113 | _NCrunch_* 114 | .*crunch*.local.xml 115 | nCrunchTemp_* 116 | 117 | # MightyMoose 118 | *.mm.* 119 | AutoTest.Net/ 120 | 121 | # Web workbench (sass) 122 | .sass-cache/ 123 | 124 | # Installshield output folder 125 | [Ee]xpress/ 126 | 127 | # DocProject is a documentation generator add-in 128 | DocProject/buildhelp/ 129 | DocProject/Help/*.HxT 130 | DocProject/Help/*.HxC 131 | DocProject/Help/*.hhc 132 | DocProject/Help/*.hhk 133 | DocProject/Help/*.hhp 134 | DocProject/Help/Html2 135 | DocProject/Help/html 136 | 137 | # Click-Once directory 138 | publish/ 139 | 140 | # Publish Web Output 141 | *.[Pp]ublish.xml 142 | *.azurePubxml 143 | # TODO: Comment the next line if you want to checkin your web deploy settings 144 | # but database connection strings (with potential passwords) will be unencrypted 145 | *.pubxml 146 | *.publishproj 147 | 148 | # Microsoft Azure Web App publish settings. Comment the next line if you want to 149 | # checkin your Azure Web App publish settings, but sensitive information contained 150 | # in these scripts will be unencrypted 151 | PublishScripts/ 152 | 153 | # NuGet Packages 154 | *.nupkg 155 | # The packages folder can be ignored because of Package Restore 156 | **/packages/* 157 | # except build/, which is used as an MSBuild target. 158 | !**/packages/build/ 159 | # Uncomment if necessary however generally it will be regenerated when needed 160 | #!**/packages/repositories.config 161 | # NuGet v3's project.json files produces more ignoreable files 162 | *.nuget.props 163 | *.nuget.targets 164 | 165 | # Microsoft Azure Build Output 166 | csx/ 167 | *.build.csdef 168 | 169 | # Microsoft Azure Emulator 170 | ecf/ 171 | rcf/ 172 | 173 | # Windows Store app package directories and files 174 | AppPackages/ 175 | BundleArtifacts/ 176 | Package.StoreAssociation.xml 177 | _pkginfo.txt 178 | 179 | # Visual Studio cache files 180 | # files ending in .cache can be ignored 181 | *.[Cc]ache 182 | # but keep track of directories ending in .cache 183 | !*.[Cc]ache/ 184 | 185 | # Others 186 | ClientBin/ 187 | ~$* 188 | *~ 189 | *.dbmdl 190 | *.dbproj.schemaview 191 | *.pfx 192 | *.publishsettings 193 | node_modules/ 194 | orleans.codegen.cs 195 | 196 | # Since there are multiple workflows, uncomment next line to ignore bower_components 197 | # (https://github.com/github/gitignore/pull/1529#issuecomment-104372622) 198 | #bower_components/ 199 | 200 | # RIA/Silverlight projects 201 | Generated_Code/ 202 | 203 | # Backup & report files from converting an old project file 204 | # to a newer Visual Studio version. Backup files are not needed, 205 | # because we have git ;-) 206 | _UpgradeReport_Files/ 207 | Backup*/ 208 | UpgradeLog*.XML 209 | UpgradeLog*.htm 210 | 211 | # SQL Server files 212 | *.mdf 213 | *.ldf 214 | 215 | # Business Intelligence projects 216 | *.rdl.data 217 | *.bim.layout 218 | *.bim_*.settings 219 | 220 | # Microsoft Fakes 221 | FakesAssemblies/ 222 | 223 | # GhostDoc plugin setting file 224 | *.GhostDoc.xml 225 | 226 | # Node.js Tools for Visual Studio 227 | .ntvs_analysis.dat 228 | 229 | # Visual Studio 6 build log 230 | *.plg 231 | 232 | # Visual Studio 6 workspace options file 233 | *.opt 234 | 235 | # Visual Studio LightSwitch build output 236 | **/*.HTMLClient/GeneratedArtifacts 237 | **/*.DesktopClient/GeneratedArtifacts 238 | **/*.DesktopClient/ModelManifest.xml 239 | **/*.Server/GeneratedArtifacts 240 | **/*.Server/ModelManifest.xml 241 | _Pvt_Extensions 242 | 243 | # Paket dependency manager 244 | .paket/paket.exe 245 | paket-files/ 246 | 247 | # FAKE - F# Make 248 | .fake/ 249 | 250 | # JetBrains Rider 251 | .idea/ 252 | *.sln.iml 253 | /src/Nugety.Tests.Module 254 | /src/Nugety.Console 255 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # onfiguration.EntityFramework 2 | ## For .NET Framework & .NET Core 3 | 4 | .NET Core supports a variety of different configuration options. Application configuration data can come from files using built-in support for JSON, XML, and INI formats, as well as from environment variables, command line arguments or even an in-memory collection. So why is there no support for EntityFramework? Well now there is! 5 | 6 | Configuration.EntityFramework is a custom configuration provider for the [.NET Core Configuration system](https://docs.asp.net/en/latest/fundamentals/configuration.html). It's built on [EntityFrameworkCore](https://docs.efproject.net/en/latest/) allowing configuration settings to be stored in a wide variety of [repositories](https://docs.efproject.net/en/latest/providers/), including; 7 | 8 | * Microsoft SQL Server, 9 | * SQLite, 10 | * Npgsql (PostgreSQL), 11 | * MySQL (Official), 12 | * Pomelo (MySQL), 13 | * Microsoft SQL Server Compact Edition, 14 | * IBM Data Servers, 15 | * InMemory (for Testing), 16 | * Devart (MySQL, Oracle, PostgreSQL, SQLite, DB2, SQL Server, and more), 17 | * Oracle (Coming Soon). 18 | 19 | ## Build Status 20 | configuration-entityframework MyGet Build Status 21 | 22 | # So why use Configuration.EntityFramework? 23 | Some settings, such as a connection string or those required during the initialisation of an application may be better located in a local file rather than a repository. However, in many cases Configuration.EntityFramework can present some distinct advantages, including; 24 | 25 | 1. Makes use of the .NET Core configuration provider model, 26 | 2. Support for complex types, 27 | 3. Access settings in a strongly typed fashion using the [Options pattern] (https://docs.asp.net/en/latest/fundamentals/configuration.html#options-config-objects), 28 | 4. Enhanced Configuration Management and Change Control. This is particularly relevant to a distributed environment, 29 | 5. Transactional update of settings for whole of environment, 30 | 6. Common settings can be shared among many applications. Support for single point of change, 31 | 7. In a complex system with many related applications or services it's not uncommon to have many configuration files. By persisting settings to a database, the dependency on these configuration files can be reduced, 32 | 8. All settings for a select criteria, such as environment, application or section can be retrieved with a single query, 33 | 9. Allow end users to update settings via the EntityFramework Context. 34 | 35 | # Compatibility 36 | 37 | Configuration.EntityFramework is **compatible** with **netstandard2.0, net461 and net462**. 38 | 39 | # How do I get started? 40 | Our [Sample Project](https://github.com/thinkabouthub/Configuration.EntityFramework/tree/master/sample) demonstrates how to use Configuration.EntityFramework and gives you some starting points for learning more. Additionally, the [Getting Started](https://github.com/thinkabouthub/Configuration.EntityFramework/wiki/getting-started/) tutorial walks you through using Configuration.EntityFramework in a simple ASP.NET Core app. 41 | 42 | ## Get Packages 43 | You can get Configuration.EntityFramework by [grabbing the latest NuGet package](https://www.nuget.org/packages?q=configuration.entityframework). If you're feeling adventurous, [continuous integration builds are on MyGet](https://www.myget.org/feed/configuration-entityframework/package/nuget/Configuration.EntityFramework). 44 | 45 | [Release notes](https://github.com/thinkabouthub/Configuration.EntityFramework/wiki/release-notes) are available on the wiki. 46 | ## Get Help 47 | **Need help with Configuration.EntityFramework?** We're ready to answer your questions on [Stack Overflow](http://stackoverflow.com/questions/tagged/configuration.ef). Alternatively ask a question [here](https://github.com/thinkabouthub/Configuration.EntityFramework/issues). 48 | 49 | ##Super-duper quick start 50 | 51 | Create Configuration.EntityFramework database. 52 | 53 | ```C# 54 | var options = new DbContextOptionsBuilder().UseSqlServer( 55 | @"Data Source=.;Initial Catalog=Configuration;Integrated Security=True").Options; 56 | 57 | using (var context = new ConfigurationContext(options)) 58 | { 59 | context.Database.EnsureCreated(); 60 | } 61 | ``` 62 | 63 | Initialise Configuration.EntityFramework. 64 | ```C# 65 | var config = new ConfigurationBuilder() 66 | .SetBasePath(Environment.CurrentDirectory) 67 | .AddJsonFile("appsettings.json", true, true) 68 | .AddEntityFrameworkConfig(builder => builder.UseSqlServer(@"Data Source=.;Initial Catalog=Configuration;Integrated Security=True")) 69 | .Build(); 70 | ``` 71 | 72 | Check Configuration Section Exists. 73 | ```C# 74 | var exists = config.SectionExists("SampleSection"); 75 | ``` 76 | 77 | Get Configuration Section for complex type. Return null if section does not exist. 78 | ```C# 79 | var section = config.TryGetSection("SampleSection"); 80 | ``` 81 | 82 | Get Configuration Section for complex type. Return default value if section does not exist. 83 | ```C# 84 | var section = config.GetSection("SampleSection"); 85 | ``` 86 | 87 | Get Configuration Value for Key. 88 | ```C# 89 | var setting = config.GetValue("TestSetting"); 90 | ``` 91 | 92 | ## Project 93 | 94 | - [Configuration.EntityFramework](https://www.nuget.org/packages?q=configuration.entityframework) - [this repo](https://github.com/thinkabouthub/Configuration.EntityFramework). 95 | -------------------------------------------------------------------------------- /test/Configuration.EntityFramework.Tests/SettingEntityTests.cs: -------------------------------------------------------------------------------- 1 | using System; 2 | using System.Linq; 3 | using Microsoft.EntityFrameworkCore; 4 | using Newtonsoft.Json.Linq; 5 | using Xunit; 6 | 7 | namespace Configuration.EntityFramework.Tests 8 | { 9 | public class SettingEntityTests : IClassFixture 10 | { 11 | protected virtual DbContextFixture Fixture { get; private set; } 12 | 13 | public SettingEntityTests(DbContextFixture fixture) 14 | { 15 | fixture.InitialiseContext(); 16 | this.Fixture = fixture; 17 | } 18 | 19 | [Fact] 20 | public void Given_AddSection_When_IsValid_Then_SectionPersisted() 21 | { 22 | var context = this.Fixture.GetContext(); 23 | 24 | var section = new SectionEntity() { ApplicationName = "DbContextSettingTests", SectionName = "appSettings", ModifiedUser = "TestUser" }; 25 | context.Sections.Add(section); 26 | context.SaveChanges(); 27 | 28 | context.Settings.Add(new SettingEntity() { SectionId = section.Id, Key = "Setting", Json = "hello world", DefaultValue = "DefaultValue", ModifiedUser = "TestUser" }); 29 | context.SaveChanges(); 30 | 31 | Assert.NotNull(context.Settings.AsNoTracking().FirstOrDefault(s => s.SectionId == section.Id && s.Key == "Setting" && s.Json == "hello world" && s.DefaultValue == "DefaultValue")); 32 | } 33 | 34 | [Fact] 35 | public void Given_AddSection_When_KeyIsNotValid_Then_SectionNotPersisted() 36 | { 37 | var context = this.Fixture.GetContext(); 38 | 39 | var section = new SectionEntity() { ApplicationName = "DbContextSettingTests", SectionName = "appSettingsA", ModifiedUser = "TestUser" }; 40 | context.Sections.Add(section); 41 | context.SaveChanges(); 42 | 43 | var exception = Assert.Throws(() => 44 | { 45 | context.Settings.Add(new SettingEntity() { SectionId = section.Id, Key = null, ModifiedUser = "TestUser" }); 46 | context.SaveChanges(); 47 | }); 48 | Assert.True(exception.InnerException != null && exception.InnerException.Message.StartsWith("Cannot insert the value NULL into column 'Key'")); 49 | } 50 | 51 | [Fact] 52 | public void Given_AddSetting_When_SettingIsDuplicate_Then_SettingNotPersisted() 53 | { 54 | var context = this.Fixture.GetContext(); 55 | 56 | var section = new SectionEntity() { ApplicationName = "DbContextSettingTests", SectionName = "appSettingsB", ModifiedUser = "TestUser" }; 57 | context.Sections.Add(section); 58 | context.SaveChanges(); 59 | 60 | var exception = Assert.Throws(() => 61 | { 62 | context.Settings.Add(new SettingEntity() { SectionId = section.Id, Key = "SettingA", ModifiedUser = "TestUser" }); 63 | context.Settings.Add(new SettingEntity() { SectionId = section.Id, Key = "SettingA", ModifiedUser = "TestUser" }); 64 | context.SaveChanges(); 65 | }); 66 | Assert.True(exception.InnerException != null && exception.InnerException.Message.StartsWith("Cannot insert duplicate key row in object 'Configuration.Setting' with unique index 'IX_Setting_SectionId_Key'")); 67 | } 68 | 69 | [Fact] 70 | public void Given_AddSetting_When_ValueIsComplexType_Then_SettingIsPersisted() 71 | { 72 | var context = this.Fixture.GetContext(); 73 | 74 | var section = new SectionEntity() { ApplicationName = "DbContextSettingTests", SectionName = "TestSection1", ModifiedUser = "TestUser" }; 75 | context.Sections.Add(section); 76 | context.SaveChanges(); 77 | 78 | var setting = new SettingEntity() { SectionId = section.Id, Key = "default", ModifiedUser = "TestUser" }; 79 | setting.SetValue(new TestSection() {Id = Guid.NewGuid(), Name = "Test"}); 80 | context.Settings.Add(setting); 81 | context.SaveChanges(); 82 | 83 | var retrieved = context.Settings.FirstOrDefault(s => s.SectionId == section.Id && s.Key == "default"); 84 | Assert.NotNull(retrieved); 85 | Assert.NotNull(retrieved.GetValue()); 86 | } 87 | 88 | [Fact] 89 | public void Given_AddSetting_When_ValueIsComplexTypeWithNoValueType_Then_SettingIsPersistedAndValueAsJObjectReturned() 90 | { 91 | var context = this.Fixture.GetContext(); 92 | 93 | var section = new SectionEntity() { ApplicationName = "DbContextSettingTests", SectionName = "TestSection2", ModifiedUser = "TestUser" }; 94 | context.Sections.Add(section); 95 | context.SaveChanges(); 96 | 97 | var setting = new SettingEntity() { SectionId = section.Id, Key = "default", ModifiedUser = "TestUser" }; 98 | setting.SetValue(new TestSection() {Id = Guid.NewGuid(), Name = "Test"}); 99 | setting.ValueType = null; 100 | context.Settings.Add(setting); 101 | context.SaveChanges(); 102 | 103 | var retrieved = context.Settings.AsNoTracking().FirstOrDefault(s => s.SectionId == section.Id && s.Key == "default"); 104 | Assert.NotNull(retrieved); 105 | Assert.NotNull(retrieved.GetValue()); 106 | } 107 | 108 | public class TestSection 109 | { 110 | public Guid Id { get; set; } 111 | 112 | public string Name { get; set; } 113 | } 114 | } 115 | } 116 | -------------------------------------------------------------------------------- /test/Configuration.EntityFramework.Tests/DbContextFixture.cs: -------------------------------------------------------------------------------- 1 | using System; 2 | using System.Collections.Generic; 3 | using System.Collections.ObjectModel; 4 | using System.Data.SqlClient; 5 | using System.Diagnostics; 6 | using System.Linq; 7 | using System.Runtime.CompilerServices; 8 | using Microsoft.EntityFrameworkCore; 9 | using Microsoft.Extensions.Configuration; 10 | 11 | namespace Configuration.EntityFramework.Tests 12 | { 13 | public enum DatabaseBuildOption 14 | { 15 | Create, 16 | Migration 17 | } 18 | 19 | public class DbContextFixture : IDisposable 20 | { 21 | public virtual IConfigurationRoot Configuration { get; private set; } 22 | 23 | public virtual Guid Identifier { get; private set; } 24 | 25 | private bool disposed; 26 | 27 | public DbContextFixture() 28 | { 29 | var builder = new ConfigurationBuilder() 30 | .SetBasePath(Environment.CurrentDirectory) 31 | .AddJsonFile("appsettings.json", true, true); 32 | this.Configuration = builder.Build(); 33 | 34 | this.Identifier = Guid.NewGuid(); 35 | this._context = new Collection(); 36 | this.DatabaseBuildOption = DatabaseBuildOption.Create; 37 | } 38 | 39 | private Collection _context; 40 | 41 | public virtual DatabaseBuildOption DatabaseBuildOption { get; set; } 42 | 43 | public virtual IEnumerable Context => this._context; 44 | 45 | [MethodImpl(MethodImplOptions.NoInlining)] 46 | public virtual void InitialiseContext(string identifier = null) where T : DbContext 47 | { 48 | this.InitialiseContextWithName(typeof(T).Name, identifier); 49 | } 50 | 51 | protected virtual Type GetDeclaringType() 52 | { 53 | int index = 1; 54 | var type = new StackFrame(index, true).GetMethod().DeclaringType; 55 | while (type != null && (type.Equals(this.GetType()) || type.Equals(this.GetType().BaseType))) 56 | { 57 | index++; 58 | type = new StackFrame(index, true).GetMethod().DeclaringType; 59 | } 60 | return type; 61 | } 62 | 63 | [MethodImpl(MethodImplOptions.NoInlining)] 64 | public virtual void InitialiseContextWithName(string connectionName, string identifier = null) where T : DbContext 65 | { 66 | var type = this.GetDeclaringType(); 67 | var name = identifier ?? type?.Name; 68 | 69 | var optionsBuilder = new DbContextOptionsBuilder(); 70 | var connection = this.Configuration.GetConnectionString(connectionName); 71 | if (string.IsNullOrEmpty(connection)) connection = this.Configuration.GetConnectionString("DefaultConnection"); 72 | var connectionBuilder = new SqlConnectionStringBuilder(connection); 73 | connectionBuilder.InitialCatalog += string.IsNullOrEmpty(name) ? $"_{this.Identifier}" : $"_{name}"; 74 | optionsBuilder.UseSqlServer(connectionBuilder.ConnectionString); 75 | this.InitialiseContext(optionsBuilder.Options); 76 | } 77 | 78 | public virtual void InitialiseContextWithConnection(string connection) where T : DbContext 79 | { 80 | var optionsBuilder = new DbContextOptionsBuilder(); 81 | optionsBuilder.UseSqlServer(connection); 82 | this.InitialiseContext(optionsBuilder.Options); 83 | } 84 | 85 | public virtual void InitialiseContext(DbContextOptions options) where T : DbContext 86 | { 87 | if (!this.Context.Any(c => c is T)) 88 | { 89 | var context = (T)Activator.CreateInstance(typeof(T), options); 90 | context.Database.EnsureDeleted(); 91 | if (this.DatabaseBuildOption == DatabaseBuildOption.Migration) 92 | { 93 | context.Database.Migrate(); 94 | } 95 | else if (this.DatabaseBuildOption == DatabaseBuildOption.Create) 96 | { 97 | context.Database.EnsureCreated(); 98 | } 99 | context.ChangeTracker.AutoDetectChangesEnabled = false; 100 | this._context.Add(context); 101 | } 102 | } 103 | 104 | public virtual T GetContext(bool clearChangeTracker = true) where T : DbContext 105 | { 106 | var context = this.Context.OfType().FirstOrDefault(); 107 | if (context != null && clearChangeTracker) 108 | { 109 | this.ClearChangeTracker(context); 110 | } 111 | return context; 112 | } 113 | 114 | public virtual void ClearChangeTracker(DbContext context) 115 | { 116 | var entries = context.ChangeTracker.Entries(); 117 | while (entries.Any()) 118 | { 119 | entries.First().State = EntityState.Detached; 120 | } 121 | } 122 | 123 | public virtual void ClearChangeTracker() 124 | { 125 | foreach (var context in this.Context) 126 | { 127 | this.ClearChangeTracker(context); 128 | } 129 | } 130 | 131 | public void Dispose() 132 | { 133 | Dispose(true); 134 | GC.SuppressFinalize(this); 135 | } 136 | 137 | protected virtual void Dispose(bool disposing) 138 | { 139 | if (disposed) return; 140 | 141 | if (disposing) 142 | { 143 | while (this.Context.Any()) 144 | { 145 | var context = this.Context.First(); 146 | //context.Database.EnsureDeleted(); 147 | context.Dispose(); 148 | } 149 | 150 | } 151 | disposed = true; 152 | } 153 | } 154 | 155 | } 156 | -------------------------------------------------------------------------------- /src/Configuration.EntityFramework/EFConfigurationProvider.cs: -------------------------------------------------------------------------------- 1 | using System; 2 | using System.Collections.Generic; 3 | using System.Collections.ObjectModel; 4 | using System.Diagnostics; 5 | using System.Linq; 6 | using Microsoft.EntityFrameworkCore; 7 | using Microsoft.Extensions.Configuration; 8 | using Newtonsoft.Json; 9 | using Newtonsoft.Json.Linq; 10 | 11 | namespace Configuration.EntityFramework 12 | { 13 | public class EFConfigurationProvider : ConfigurationProvider 14 | { 15 | public EFConfigurationProvider(Action optionsAction, string application = null, string discriminator = null, string aspect = "Application", bool ensureCreated = false) 16 | { 17 | this.OptionsAction = optionsAction; 18 | this.Application = application; 19 | this.Discriminator = discriminator; 20 | this.Aspect = aspect; 21 | this.EnsureCreated = ensureCreated; 22 | } 23 | 24 | public EFConfigurationProvider(ConfigurationContext context, string application = null, string discriminator = null, string aspect = "Application", bool ensureCreated = false) 25 | { 26 | this.Context = context; 27 | this.Application = application; 28 | this.Discriminator = discriminator; 29 | this.Aspect = aspect; 30 | this.EnsureCreated = ensureCreated; 31 | } 32 | 33 | protected virtual string Application { get; set; } 34 | 35 | protected virtual string Aspect { get; set; } 36 | 37 | protected virtual string Discriminator { get; set; } 38 | 39 | protected virtual Action OptionsAction { get; set; } 40 | 41 | protected virtual ConfigurationContext Context { get; set; } 42 | 43 | protected virtual bool IsContextOwner { get; set; } 44 | 45 | protected virtual bool EnsureCreated { get; set; } 46 | 47 | public override void Load() 48 | { 49 | this.Data = new Dictionary(); 50 | if (this.Context == null) 51 | { 52 | if (this.OptionsAction != null) 53 | { 54 | var builder = new DbContextOptionsBuilder(); 55 | this.OptionsAction(builder); 56 | this.Context = new ConfigurationContext(builder.Options); 57 | } 58 | else 59 | { 60 | this.Context = new ConfigurationContext(); 61 | } 62 | if (EnsureCreated) this.Context.Database.EnsureCreated(); 63 | this.IsContextOwner = true; 64 | } 65 | try 66 | { 67 | var sections = this.Context.Sections.Where(s => 68 | string.IsNullOrEmpty(this.Application) || (s.ApplicationName == this.Application) 69 | && string.IsNullOrEmpty(this.Aspect) || (s.Aspect == this.Aspect)) 70 | .Include(s => s.Settings); 71 | 72 | var filtered = this.FilterSectionsByDescriminator(sections, this.Discriminator); 73 | 74 | foreach (var section in filtered) 75 | { 76 | Debug.WriteLine($"Adding Section with Id '{section.Id}' and Name '{section.SectionName}' to Configuration Provider"); 77 | 78 | foreach (var setting in section.Settings) 79 | { 80 | Debug.WriteLine($"Adding Setting with Id '{setting.Id}' and Key '{setting.Key}' and Value '{setting.Json}' to Configuration Provider"); 81 | 82 | if (this.IsJsonObjectOrArray(setting.Json)) 83 | { 84 | var data = JsonConvert.DeserializeObject(setting.Json); 85 | var container = (JContainer)data; 86 | this.AddJObjectToData(section.SectionName, container); 87 | } 88 | else 89 | { 90 | this.AddSetting(setting.Key, setting.Json); 91 | } 92 | } 93 | } 94 | } 95 | finally 96 | { 97 | if (this.IsContextOwner && this.Context != null) 98 | { 99 | this.Context.Dispose(); 100 | this.Context = null; 101 | } 102 | } 103 | } 104 | 105 | protected virtual bool IsJsonObjectOrArray(string value) 106 | { 107 | value = value.Trim(); 108 | if ((value.StartsWith("{") && value.EndsWith("}")) || //For object 109 | (value.StartsWith("[") && value.EndsWith("]"))) //For array 110 | { 111 | return true; 112 | } 113 | return false; 114 | } 115 | 116 | protected virtual IEnumerable FilterSectionsByDescriminator(IEnumerable sections, string discriminator) 117 | { 118 | if (string.IsNullOrEmpty(discriminator)) 119 | { 120 | return sections; 121 | } 122 | var filtered = new Collection(); 123 | var kvp = JsonConvert.DeserializeObject>(discriminator); 124 | if (kvp != null && kvp.Any()) 125 | { 126 | foreach (var section in sections) 127 | { 128 | if (this.HasDescriminator(section, kvp)) 129 | { 130 | filtered.Add(section); 131 | } 132 | } 133 | } 134 | else 135 | { 136 | Debug.WriteLine($"Discriminator '{discriminator}' could not deserialize into 'Dictionary'. Check discriminator is valid json formatted string"); 137 | } 138 | return filtered; 139 | } 140 | 141 | protected virtual bool HasDescriminator(SectionEntity section, Dictionary discriminator) 142 | { 143 | if (string.IsNullOrEmpty(section.Discriminator)) 144 | { 145 | return false; 146 | } 147 | var compare = JsonConvert.DeserializeObject>(section.Discriminator); 148 | if (compare != null && compare.Any()) 149 | { 150 | Debug.WriteLine($"Discriminator for section with Id '{section.Id}' and Name '{section.SectionName}' could not deserialize into 'Dictionary'. Check discriminator is valid json formatted string"); 151 | } 152 | foreach (var kvp in discriminator) 153 | { 154 | if (!compare.Any(e => e.Equals(kvp))) return false; 155 | } 156 | return true; 157 | } 158 | 159 | protected virtual void AddJObjectToData(string section, JContainer json) 160 | { 161 | foreach (var kvp in (JObject)json) 162 | { 163 | if (kvp.Value is JObject) 164 | { 165 | this.AddJObjectToData($"{section}:{kvp.Key}", (JObject)kvp.Value); 166 | } 167 | else if (kvp.Value is JArray) 168 | { 169 | var array = (JArray)kvp.Value; 170 | var i = 0; 171 | foreach (var item in array.OfType()) 172 | { 173 | this.AddJObjectToData($"{section}:{kvp.Key}:{i}", item); 174 | i++; 175 | } 176 | } 177 | else 178 | { 179 | var value = kvp.Value.Type != JTokenType.Null ? kvp.Value.ToString() : null; 180 | this.AddSetting($"{section}:{kvp.Key}", value); 181 | } 182 | } 183 | } 184 | 185 | protected virtual void AddSetting(string key, string value) 186 | { 187 | if (!this.Data.ContainsKey(key)) this.Data.Add(key, value); 188 | } 189 | } 190 | } -------------------------------------------------------------------------------- /test/Configuration.EntityFramework.Tests/EFConfigurationProviderTests.cs: -------------------------------------------------------------------------------- 1 | using System; 2 | using System.Collections.ObjectModel; 3 | using System.ComponentModel; 4 | using System.Linq; 5 | using Microsoft.Extensions.Configuration; 6 | using Xunit; 7 | 8 | namespace Configuration.EntityFramework.Tests 9 | { 10 | public class EFConfigurationProviderTests : IClassFixture 11 | { 12 | protected virtual DbContextFixture Fixture { get; private set; } 13 | 14 | public EFConfigurationProviderTests(DbContextFixture fixture) 15 | { 16 | fixture.InitialiseContext(); 17 | this.Fixture = fixture; 18 | } 19 | 20 | [Fact] 21 | public void Given_BasicTypeSetting_When_IsValid_Then_SettingRetrieved() 22 | { 23 | var context = this.Fixture.GetContext(); 24 | 25 | var section = new SectionEntity() { ApplicationName = "EFConfigurationProviderTests", SectionName = "appSettings", Aspect = "Application", ModifiedUser = "TestUser" }; 26 | context.Sections.Add(section); 27 | context.SaveChanges(); 28 | 29 | var setting = new SettingEntity() { SectionId = section.Id, Key = "TestSetting", Json = @"Test Value", ModifiedUser = "TestUser" }; 30 | setting.ValueType = null; 31 | 32 | context.Settings.Add(setting); 33 | context.SaveChanges(); 34 | 35 | this.Fixture.ClearChangeTracker(); 36 | 37 | var builder = new ConfigurationBuilder().AddEntityFrameworkConfig(context, "EFConfigurationProviderTests"); 38 | var configuration = builder.Build(); 39 | 40 | var value = configuration.GetValue("TestSetting"); 41 | Assert.True(value == "Test Value"); 42 | } 43 | 44 | [Fact] 45 | public void Given_BasicTypeSettingWithDescriminator_When_DescriminatorIsValid_Then_SettingRetrieved() 46 | { 47 | var context = this.Fixture.GetContext(); 48 | 49 | var section = new SectionEntity() { ApplicationName = "EFConfigurationProviderTests", SectionName = "appSettings1", Aspect = "Application", Discriminator = @"{""Username"":""Patrick""}", ModifiedUser = "TestUser" }; 50 | context.Sections.Add(section); 51 | context.SaveChanges(); 52 | 53 | var setting = new SettingEntity() { SectionId = section.Id, Key = "TestSetting1", Json = @"Test Value", ModifiedUser = "TestUser" }; 54 | setting.ValueType = null; 55 | 56 | context.Settings.Add(setting); 57 | context.SaveChanges(); 58 | 59 | this.Fixture.ClearChangeTracker(); 60 | 61 | var builder = new ConfigurationBuilder().AddEntityFrameworkConfig(context, "EFConfigurationProviderTests", @"{""Username"":""Patrick""}"); 62 | var configuration = builder.Build(); 63 | 64 | var value = configuration.GetValue("TestSetting1"); 65 | Assert.True(value == "Test Value"); 66 | } 67 | 68 | [Fact] 69 | public void Given_BasicTypeSettingWithDescriminator_When_MultiDescriminatorIsValid_Then_SettingRetrieved() 70 | { 71 | var context = this.Fixture.GetContext(); 72 | 73 | var section = new SectionEntity() { ApplicationName = "EFConfigurationProviderTests", SectionName = "appSettings2", Aspect = "Application", Discriminator = @"{""Environment"":""Testing"", ""Username"":""Patrick""}", ModifiedUser = "TestUser" }; 74 | context.Sections.Add(section); 75 | context.SaveChanges(); 76 | 77 | var setting = new SettingEntity() { SectionId = section.Id, Key = "TestSetting2", Json = @"Test Value", ModifiedUser = "TestUser" }; 78 | setting.ValueType = null; 79 | 80 | context.Settings.Add(setting); 81 | context.SaveChanges(); 82 | 83 | this.Fixture.ClearChangeTracker(); 84 | 85 | var builder = new ConfigurationBuilder().AddEntityFrameworkConfig(context, "EFConfigurationProviderTests", @"{""Environment"":""Testing"", ""Username"":""Patrick""}"); 86 | var configuration = builder.Build(); 87 | 88 | var value = configuration.GetValue("TestSetting2"); 89 | Assert.True(value == "Test Value"); 90 | } 91 | 92 | [Fact] 93 | public void Given_BasicTypeSettingWithDescriminator_When_MultiDescriminatorValueInValid_Then_SettingNotRetrieved() 94 | { 95 | var context = this.Fixture.GetContext(); 96 | 97 | var section = new SectionEntity() { ApplicationName = "EFConfigurationProviderTests", SectionName = "appSettings3", Aspect = "Application", Discriminator = @"{""Environment"":""Testing"", ""Username"":""Patrick""}", ModifiedUser = "TestUser" }; 98 | context.Sections.Add(section); 99 | context.SaveChanges(); 100 | 101 | var setting = new SettingEntity() { SectionId = section.Id, Key = "TestSetting3", Json = @"""Test Value""", ModifiedUser = "TestUser" }; 102 | setting.ValueType = null; 103 | 104 | context.Settings.Add(setting); 105 | context.SaveChanges(); 106 | 107 | this.Fixture.ClearChangeTracker(); 108 | 109 | var builder = new ConfigurationBuilder().AddEntityFrameworkConfig(context, "EFConfigurationProviderTests", @"{""Environment"":""Testing"", ""Username"":""Patrick1""}"); 110 | var configuration = builder.Build(); 111 | 112 | var value = configuration.GetValue("TestSetting3"); 113 | Assert.Null(value); 114 | } 115 | 116 | [Fact] 117 | public void Given_BasicTypeSettingWithDescriminator_When_MultiDescriminatorKeyInValid_Then_SettingNotRetrieved() 118 | { 119 | var context = this.Fixture.GetContext(); 120 | 121 | var section = new SectionEntity() { ApplicationName = "EFConfigurationProviderTests", SectionName = "appSettings4", Aspect = "Application", Discriminator = @"{""Environment"":""Testing""}", ModifiedUser = "TestUser" }; 122 | context.Sections.Add(section); 123 | context.SaveChanges(); 124 | 125 | var setting = new SettingEntity() { SectionId = section.Id, Key = "TestSetting4", Json = @"""Test Value""", ModifiedUser = "TestUser" }; 126 | setting.ValueType = null; 127 | 128 | context.Settings.Add(setting); 129 | context.SaveChanges(); 130 | 131 | this.Fixture.ClearChangeTracker(); 132 | 133 | var builder = new ConfigurationBuilder().AddEntityFrameworkConfig(context, "EFConfigurationProviderTests", @"{""Environment"":""Testing"", ""Username"":""Patrick""}"); 134 | var configuration = builder.Build(); 135 | 136 | var value = configuration.GetValue("TestSetting4"); 137 | Assert.Null(value); 138 | } 139 | 140 | [Fact] 141 | public void Given_BasicTypeSettingWithDefault_When_SettingLoaded_Then_SettingRetrieved() 142 | { 143 | var context = this.Fixture.GetContext(); 144 | 145 | var defaultSection = new SectionEntity() { ApplicationName = "EFConfigurationProviderTests", SectionName = "appSettings5", Aspect = "Application", ModifiedUser = "TestUser" }; 146 | context.Sections.Add(defaultSection); 147 | context.SaveChanges(); 148 | 149 | var setting1 = new SettingEntity() { SectionId = defaultSection.Id, Key = "TestSetting5", Json = @"""Default Test Value""", ModifiedUser = "TestUser" }; 150 | setting1.ValueType = null; 151 | 152 | context.Settings.Add(setting1); 153 | 154 | var section = new SectionEntity() { ApplicationName = "EFConfigurationProviderTests", SectionName = "appSettings6", Aspect = "Application", Discriminator = @"{""Username"":""Patrick""}", ModifiedUser = "TestUser" }; 155 | context.Sections.Add(section); 156 | context.SaveChanges(); 157 | 158 | var setting2 = new SettingEntity() { SectionId = section.Id, Key = "TestSetting6", Json = @"Test Value", ModifiedUser = "TestUser" }; 159 | setting2.ValueType = null; 160 | 161 | context.Settings.Add(setting2); 162 | context.SaveChanges(); 163 | 164 | this.Fixture.ClearChangeTracker(); 165 | 166 | var builder = new ConfigurationBuilder() 167 | .AddEntityFrameworkConfig(context, "EFConfigurationProviderTests") 168 | .AddEntityFrameworkConfig(context, "EFConfigurationProviderTests", @"{""Username"":""Patrick""}"); 169 | var configuration = builder.Build(); 170 | 171 | var value = configuration.GetValue("TestSetting6"); 172 | Assert.True(value == "Test Value"); 173 | } 174 | 175 | [Fact] 176 | public void Given_ComplexTypeSection_When_IsValid_Then_SectionRetrieved() 177 | { 178 | var context = this.Fixture.GetContext(); 179 | 180 | var section = new SectionEntity() { ApplicationName = "EFConfigurationProviderTests", SectionName = "TestSection1", Aspect = "Application", ModifiedUser = "TestUser" }; 181 | context.Sections.Add(section); 182 | context.SaveChanges(); 183 | 184 | var setting = new SettingEntity() { SectionId = section.Id, Key = "default", ModifiedUser = "TestUser" }; 185 | setting.SetValue(new TestSectionWithChild() {Id = Guid.NewGuid(), Name = "Test"}); 186 | var value = setting.GetValue(); 187 | 188 | context.Settings.Add(setting); 189 | context.SaveChanges(); 190 | 191 | this.Fixture.ClearChangeTracker(); 192 | 193 | var builder = new ConfigurationBuilder().AddEntityFrameworkConfig(context); 194 | var configuration = builder.Build(); 195 | 196 | var configSection = configuration.GetSection("TestSection1", false); 197 | Assert.NotNull(configSection); 198 | Assert.Equal(value.Id, configSection.Id); 199 | Assert.Equal(value.Name, configSection.Name); 200 | } 201 | 202 | [Fact] 203 | public void Given_ComplexTypeSectionWithChild_When_IsValid_Then_SectionRetrieved() 204 | { 205 | var context = this.Fixture.GetContext(); 206 | 207 | var section = new SectionEntity() { ApplicationName = "EFConfigurationProviderTests", SectionName = "TestSection2", Aspect = "Application", ModifiedUser = "TestUser" }; 208 | context.Sections.Add(section); 209 | context.SaveChanges(); 210 | 211 | var setting = new SettingEntity() 212 | { 213 | SectionId = section.Id, 214 | Key = "default", 215 | ModifiedUser = "TestUser" 216 | }; 217 | setting.SetValue(new TestSectionWithChild() 218 | { 219 | Id = Guid.NewGuid(), 220 | Name = "Test1", 221 | ChildSection = new TestSectionChild() 222 | { 223 | Id = Guid.NewGuid(), 224 | Name = "Test2" 225 | } 226 | }); 227 | var value = setting.GetValue().ChildSection; 228 | 229 | context.Settings.Add(setting); 230 | context.SaveChanges(); 231 | 232 | this.Fixture.ClearChangeTracker(); 233 | 234 | var builder = new ConfigurationBuilder().AddEntityFrameworkConfig(context); 235 | var configuration = builder.Build(); 236 | 237 | var configSection = configuration.GetSection("TestSection2", false); 238 | Assert.NotNull(configSection); 239 | Assert.NotNull(configSection.ChildSection); 240 | Assert.Equal(value.Id, configSection.ChildSection.Id); 241 | Assert.Equal(value.Name, configSection.ChildSection.Name); 242 | } 243 | 244 | [Fact] 245 | public void Given_ComplexTypeSectionWithChildren_When_IsValid_Then_SectionRetrieved() 246 | { 247 | var context = this.Fixture.GetContext(); 248 | 249 | var section = new SectionEntity() { ApplicationName = "EFConfigurationProviderTests", SectionName = "TestSection3", Aspect = "Application", ModifiedUser = "TestUser" }; 250 | context.Sections.Add(section); 251 | context.SaveChanges(); 252 | 253 | var value = new TestSectionWithChildren() 254 | { 255 | Id = Guid.NewGuid(), 256 | Name = "Test1" 257 | }; 258 | value.Children = new Collection(); 259 | value.Children.Add 260 | ( 261 | new TestSectionChild() 262 | { 263 | Id = Guid.NewGuid(), 264 | Name = "Test1" 265 | } 266 | ); 267 | 268 | var setting = new SettingEntity() 269 | { 270 | SectionId = section.Id, 271 | Key = "default", 272 | ModifiedUser = "TestUser" 273 | }; 274 | setting.SetValue(value); 275 | context.Settings.Add(setting); 276 | context.SaveChanges(); 277 | 278 | this.Fixture.ClearChangeTracker(); 279 | 280 | var builder = new ConfigurationBuilder().AddEntityFrameworkConfig(context); 281 | var configuration = builder.Build(); 282 | 283 | var configSection = configuration.GetSection("TestSection3", false); 284 | Assert.NotNull(configSection); 285 | Assert.NotNull(configSection.Children); 286 | var child = configSection.Children.FirstOrDefault(); 287 | Assert.NotNull(child); 288 | Assert.Equal(value.Children.First().Id, child.Id); 289 | Assert.Equal(value.Children.First().Name, child.Name); 290 | } 291 | 292 | [Fact] 293 | public void Given_ComplexTypeSectionWithDefaultValue_When_IsValid_Then_SectionInitialisedWithDefaultValue() 294 | { 295 | var builder = new ConfigurationBuilder(); 296 | var configuration = builder.Build(); 297 | 298 | var configSection = configuration.GetSection("TestSection4"); 299 | Assert.NotNull(configSection); 300 | Assert.True(!string.IsNullOrEmpty(configSection.TestDefault)); 301 | Assert.Equal("Default Value", configSection.TestDefault); 302 | } 303 | 304 | public class TestSectionWithChild 305 | { 306 | public Guid Id { get; set; } 307 | 308 | public string Name { get; set; } 309 | 310 | [DefaultValue("Default Value")] 311 | public string TestDefault { get; set; } 312 | 313 | public TestSectionChild ChildSection { get; set; } 314 | } 315 | 316 | public class TestSectionWithChildren 317 | { 318 | public Guid Id { get; set; } 319 | 320 | public string Name { get; set; } 321 | 322 | public Collection Children { get; set; } 323 | } 324 | 325 | 326 | public class TestSectionChild 327 | { 328 | public Guid Id { get; set; } 329 | 330 | public string Name { get; set; } 331 | } 332 | } 333 | } 334 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | {one line to give the program's name and a brief idea of what it does.} 635 | Copyright (C) {year} {name of author} 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | {project} Copyright (C) {year} {fullname} 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | --------------------------------------------------------------------------------