Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/suddenelfilio/isici
.Net Framework and .Net Core Simple Feature Flags - Successor of Switcheroo
https://github.com/suddenelfilio/isici
dotnet dotnet-core dotnet-framework dotnet-standard feature-flags feature-toggling netcore nuget switcheroo
Last synced: 14 days ago
JSON representation
.Net Framework and .Net Core Simple Feature Flags - Successor of Switcheroo
- Host: GitHub
- URL: https://github.com/suddenelfilio/isici
- Owner: suddenelfilio
- License: other
- Created: 2020-05-18T16:40:37.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2020-05-25T11:02:58.000Z (over 4 years ago)
- Last Synced: 2025-01-19T07:08:43.802Z (18 days ago)
- Topics: dotnet, dotnet-core, dotnet-framework, dotnet-standard, feature-flags, feature-toggling, netcore, nuget, switcheroo
- Language: C#
- Homepage:
- Size: 385 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
Isici - successor of Switcheroo
==========
> Isici is **Feature** in [Zulu](https://translate.google.be/#view=home&op=translate&sl=auto&tl=zu&text=feature)
A lightweight framework for [feature toggling](http://martinfowler.com/bliki/FeatureToggle.html) to enable trunk based development.
Isici aims for simplicity, with a clean syntax and a minimal feature set while not compromising on extensibility and testability.
Isici is the successor of the [Switcheroo](https://github.com/rhanekom/Switcheroo) package developed by Riaan Hanekom. Isici has been split into separate packages for modular development and also now supports .net 4.5.x and up via netstandard 2.0.
Getting Isici
------------------
Isici can be installed via [Nuget](http://nuget.org/packages/Isici.Core).
```powershell
> Install-Package Isici.Core
```
```powershell
> dotnet add package Isici.Core
```
```xml
```
```powershell
> paket add Isici.Core
```
License
--------
Isici is licensed under the [MIT license](http://opensource.org/licenses/MIT).
Quick Start
------------
**Installation**
Nuget packages:
- [Isici.Core](https://www.nuget.org/packages/Isici.Core): core package needed to implement the feature flags 
- [Isici.Core.Abstractions](https://www.nuget.org/packages/Isici.Core.Abstractions): abstractions package with implementation in Isici.Core 
**Add configuration**
Currently there are 2 IconfigurationProviders supported:
- [Isici.Configuration.SystemConfiguration](https://www.nuget.org/packages/Isici.Configuration.SystemConfiguration): uses the System.Configuration.ConfigurationManager to load configuration from *.config files with support for custom sections. This is the original implementtion as was in Switcheroo. 
```xml
```
- [Isici.Configuration.JsonFileConfiguration](https://www.nuget.org/packages/Isici.Configuration.JsonFileConfiguration): uses a json file to load configuration from. This is the original implementation by myself which was a contribution for switcherooo. 
```json
[
{
"name": "testDateRange",
"enabled": true,
"from": "1 November 2012",
"until": "2 November 2012"
}
]
```
**Custom configuration sources**
You can implement your own configuration source by implementing the IConfigurationReader in the Isici.Core.Abstractions package. Feel free to contribute other sources.
Toggle types
--------------
**Boolean (true/false)**
Feature toggles based on a static binary value - either on or off.
```c#
features.Add(new BooleanToggle("Feature1", true));
```
***System.configuration***
```xml
```
***Json file***
```json
[
{
"name": "Feature1",
"enabled": true
}
]
```
**Date Range (true/false, within date range)**
Date Range feature toggles are evaluated on both the binary enabled value and the current date.
```c#
features.Add(new DateRangeToggle("Feature2", true, DateTime.Now.AddDays(5), null));
```
***System.configuration***
```xml
```
***Json file***
```json
[
{
"name": "Feature2",
"enabled": true,
"from": "1 November 2012",
"until": "2 November 2012"
}
]
```
_From_ and _until_ dates can be any valid date format parseable by _DateTime.Parse_.
**Established features**
Marking a feature toggle as established makes the feature toggle throw a _FeatureEstablishedException_ exception to make sure that it is not queried any more.
```c#
features.Add(new EstablishedFeatureToggle("establishedFeature"));
```
***System.configuration***
```xml
```
***Json file***
```json
[
{
"name": "establishedFeature",
"established": true
}
]
```
**Dependencies**
Features can depend on other features. For instance, it is sometimes convenient to have a "main" feature, and then sub-features that depend on it. Dependencies can be specified in configuration as a comma delimited list.
```c#
var mainFeature = new BooleanToggle("mainFeature", true);
var subFeature1 = new BooleanToggle("subFeature1", true);
var subFeature2 = new BooleanToggle("subFeature2", true);
var dependency1 = new DependencyToggle(subFeature1, mainFeature);
var dependency2 = new DependencyToggle(subFeature2, mainFeature);
features.Add(dependency1);
features.Add(dependency2);
```
***System.configuration***
```xml
```
***Json file***
```json
[
{
"name": "mainFeature",
"enabled": true,
"dependencies": [
"subFeature1",
"subFeature2"
]
},
{
"name": "subFeature1",
"enabled": true
},
{
"name": "subFeature2",
"enabled": true
}
]
```
Other features
----------------
**Code-friendly initialization**
```c#
IFeatureConfiguration features = new FeatureConfiguration(new[]
{
new BooleanToggle("Feature1", true),
new DateRangeToggle(
"Feature2",
true,
DateTime.Now.AddDays(-2),
DateTime.Now.AddDays(3))
});
```
**Feature toggle diagnostics : _IFeatureConfiguration.WhatDoIHave_**
```c#
Console.WriteLine(features.WhatDoIHave());
```
```text
Name Feature1
IsEnabled True
Name Feature2
IsEnabled True
From 11/16/2012 3:32:23 PM
Until 11/21/2012 3:32:23 PM
```