https://github.com/troygoode/configreader

Type-safe, convention-over-configuration access to the .Net application configuration, web.config, or other configuration source.
https://github.com/troygoode/configreader

Last synced: about 6 hours ago
JSON representation

Type-safe, convention-over-configuration access to the .Net application configuration, web.config, or other configuration source.

• Host: GitHub
• URL: https://github.com/troygoode/configreader
• Owner: troygoode
• License: apache-2.0
• Created: 2010-05-04T01:49:52.000Z (over 14 years ago)
• Default Branch: master
• Last Pushed: 2011-08-20T02:51:59.000Z (about 13 years ago)
• Last Synced: 2024-10-13T14:42:26.408Z (about 1 month ago)
• Language: C#
• Homepage: https://github.com/TroyGoode/ConfigReader
• Size: 2.62 MB
• Stars: 24
• Watchers: 5
• Forks: 4
• Open Issues: 4
• Metadata Files:
  • Readme: README.markdown
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
# ConfigReader

Type-safe, convention-over-configuration access to the .Net application configuration, web.config, or other configuration source.

# How do I use it?

### Step One: Install the Library

Install ["ConfigReader"](http://nuget.org/List/Packages/ConfigReader) via [NuGet](http://nuget.org) via the GUI or "Install-Package ConfigReader".

### Step Two: Create the Interface & Default-Supplying Class

Create an interface representing your configuration object.

    public interface IMailNotificationSettings{

        Uri SmtpServerAddress { get; }

        string Username { get; }

        string Password { get; }

    }

Create a class that implements the above interface that supplies the defaults for the configuration.

    public class DefaultMailNotificationSettings : IMailNotificationSettings{

        public Uri SmtpServerAddress { get { return new Uri("http://localhost"); } }

        public string Username { get { return string.Empty; } }

        public string Password { get { return string.Empty; } }     

    }

### Step Three: Retrieve Instance of IMailNotificationSettings With Defaults From DefaultMailNotificationSettings

Instantiate an instance of `ConfigReader` and `SetupConfigFor`.

    ConfigurationReader configReader = new ConfigurationReader().SetupConfigOf();

Supply defaults from `DefaultMailNotificationSettings` to ConfigReader.

    IMailNotificationSettings mySettings = configReader.ConfigBrowser.Get(new DefaultMailNotificationSettings());

The `mySettings` now contains an instance implementing `IMailNotificationSettings` with defaults from `DefaultMailNotificationSettings`:

    Assert.Equal("http://localhost", mySettings.SmtpServerAddress);

    Assert.Equal("", mySettings.Username);

    Assert.Equal("", mySettings.Password);

### Step Four (Optional): Override Default Settings via App.config/Web.config

    

    

      

        

        

      

    

Using the above config file, `Username` and `Password` are overriden, but the default value for `SmtpServerAddress` remains:

    Assert.Equal("http://localhost", mySettings.SmtpServerAddress); // default

    Assert.Equal("user123", mySettings.Username); // overridden from config!

    Assert.Equal("passwd123", mySettings.Password); // overridden from config!

# Defaults Via Anonymous Object

    IMailNotificationSettings mySettings = configReader.ConfigBrowser.Get(new {

        SmtpServerAddress = new Uri("http://localhost"),

        Username = String.Empty,

        Password = String.Empty

    });

# No Defaults, Config File Only

The above example works even with creating/using `DefaultMailNotificationSettings`:

    ConfigurationReader configReader = new ConfigurationReader().SetupConfigOf();

    IMailNotificationSettings mySettings = configReader.ConfigBrowser.Get();

Note that doing this requires you to satisfy the `IMailNotificationSettings` with appropriate entries in your configuration file:

    

    

      

        

        

        

      

    

# Custom Type Converters

Let's say you have the following configuration interface:

    public interface ICustomConversionExample

    {

        IPAddress Address { get; }

        string[] AdminUsernames { get; }

    }

And the following configuration file:

    

    

      

        

        

      

    

You can process these by registering your own custom type converters:

    var configReader = new ConfigurationReader()

        .SetupCustomConverter(source => IPAddress.Parse(source))

        .SetupCustomConverter(source => source.Split(';'))

        .SetupConfigOf();

    

    var mySettings = configReader.ConfigBrowser.Get;

    Assert.False(mySettings.Address.IsIPv6LinkLocal);

    Assert.Equal(2, mySettings.AdminUsernames.Count);

    Assert.Equal("Reshef.Mann", mySettings.AdminUsernames[0]);

    Assert.Equal("Troy.Goode", mySettings.AdminUsernames[1]);

# License

Licensed under the [Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0.html).