feat!: rename OpenFeature class to API and ns to OpenFeature (#82)

To make it easier to reuse the OpenFeature namespace, we need to ensure
no classes/structs are named OpenFeature.

.github/workflows/release.yml

@@ -34,11 +34,11 @@ jobs:
       - name: Pack
         if: ${{ steps.release.outputs.releases_created }}
         run:  |
-          dotnet pack OpenFeatureSDK.proj --configuration Release --no-build -p:PackageID=OpenFeature
+          dotnet pack OpenFeature.proj --configuration Release --no-build -p:PackageID=OpenFeature
 
       - name: Publish to Nuget
         if: ${{ steps.release.outputs.releases_created }}
         run: |
-          dotnet nuget push src/OpenFeatureSDK/bin/Release/OpenFeature.${{ steps.release.outputs.major }}.${{ steps.release.outputs.minor }}.${{ steps.release.outputs.patch }}.nupkg `
+          dotnet nuget push src/OpenFeature/bin/Release/OpenFeature.${{ steps.release.outputs.major }}.${{ steps.release.outputs.minor }}.${{ steps.release.outputs.patch }}.nupkg `
             --api-key ${{secrets.NUGET_TOKEN}} `
             --source https://api.nuget.org/v3/index.json

OpenFeatureSDK.sln → OpenFeature.sln

@@ -1,6 +1,6 @@
 
 Microsoft Visual Studio Solution File, Format Version 12.00
-Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "OpenFeatureSDK", "src\OpenFeatureSDK\OpenFeatureSDK.csproj", "{07A6E6BD-FB7E-4B3B-9CBE-65AE9D0EB223}"
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "OpenFeature", "src\OpenFeature\OpenFeature.csproj", "{07A6E6BD-FB7E-4B3B-9CBE-65AE9D0EB223}"
 EndProject
 Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "build", "build", "{72005F60-C2E8-40BF-AE95-893635134D7D}"
 	ProjectSection(SolutionItems) = preProject
@@ -29,7 +29,7 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "test", "test", "{65FBA159-2
 		test\Directory.Build.props = test\Directory.Build.props
 	EndProjectSection
 EndProject
-Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "OpenFeatureSDK.Tests", "test\OpenFeatureSDK.Tests\OpenFeatureSDK.Tests.csproj", "{49BB42BA-10A6-4DA3-A7D5-38C968D57837}"
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "OpenFeature.Tests", "test\OpenFeature.Tests\OpenFeature.Tests.csproj", "{49BB42BA-10A6-4DA3-A7D5-38C968D57837}"
 EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution

README.md

@@ -17,10 +17,10 @@ The packages will aim to support all current .NET versions. Refer to the current
 ### Basic Usage
 
 ```csharp
-using OpenFeatureSDK;
+using OpenFeature;
 
 // Sets the provider used by the client
-OpenFeature.Instance.SetProvider(new NoOpProvider());
+Api.Instance.SetProvider(new NoOpProvider());
 // Gets a instance of the feature flag client
 var client = OpenFeature.Instance.GetClient();
 // Evaluation the `my-feature` feature flag
@@ -42,8 +42,8 @@ To develop a provider, you need to create a new project and include the OpenFeat
 Example of implementing a feature flag provider
 
 ```csharp
-using OpenFeatureSDK;
-using OpenFeatureSDK.Model;
+using OpenFeature;
+using OpenFeature.Model;
 
 public class MyFeatureProvider : FeatureProvider
 {
@@ -94,10 +94,10 @@ Example of adding a hook
 
 ```csharp
 // add a hook globally, to run on all evaluations
-openFeature.AddHooks(new ExampleGlobalHook());
+Api.Instance.AddHooks(new ExampleGlobalHook());
 
 // add a hook on this client, to run on all evaluations made by this client
-var client = OpenFeature.Instance.GetClient();
+var client = Api.Instance.GetClient();
 client.AddHooks(new ExampleClientHook());
 
 // add a hook for this evaluation only

build/Common.tests.props

@@ -10,7 +10,7 @@
   </PropertyGroup>
 
   <ItemGroup Condition="$(MSBuildProjectName.EndsWith('.Tests'))">
-    <Content Include="$([MSBuild]::GetDirectoryNameOfFileAbove($(MSBuildProjectDirectory), 'OpenFeatureSDK.sln'))\build\xunit.runner.json">
+    <Content Include="$([MSBuild]::GetDirectoryNameOfFileAbove($(MSBuildProjectDirectory), 'OpenFeature.sln'))\build\xunit.runner.json">
       <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
     </Content>
   </ItemGroup>

src/Directory.Build.props

@@ -1,3 +1,3 @@
 <Project>
-  <Import Project="$([MSBuild]::GetDirectoryNameOfFileAbove($(MSBuildProjectDirectory), 'OpenFeatureSDK.sln'))\build\Common.prod.props" />
+  <Import Project="$([MSBuild]::GetDirectoryNameOfFileAbove($(MSBuildProjectDirectory), 'OpenFeature.sln'))\build\Common.prod.props" />
 </Project>

src/OpenFeatureSDK/OpenFeature.cs → src/OpenFeature/Api.cs

@@ -1,19 +1,18 @@
-using System;
 using System.Collections.Concurrent;
 using System.Collections.Generic;
 using System.Linq;
 using System.Threading;
 using Microsoft.Extensions.Logging;
-using OpenFeatureSDK.Model;
+using OpenFeature.Model;
 
-namespace OpenFeatureSDK
+namespace OpenFeature
 {
     /// <summary>
     /// The evaluation API allows for the evaluation of feature flag values, independent of any flag control plane or vendor.
     /// In the absence of a provider the evaluation API uses the "No-op provider", which simply returns the supplied default flag value.
     /// </summary>
     /// <seealso href="https://github.com/open-feature/spec/blob/main/specification/flag-evaluation.md#flag-evaluation-api"/>
-    public sealed class OpenFeature
+    public sealed class Api
     {
         private EvaluationContext _evaluationContext = EvaluationContext.Empty;
         private FeatureProvider _featureProvider = new NoOpFeatureProvider();
@@ -24,15 +23,15 @@ public sealed class OpenFeature
         private readonly ReaderWriterLockSlim _featureProviderLock = new ReaderWriterLockSlim();
 
         /// <summary>
-        /// Singleton instance of OpenFeature
+        /// Singleton instance of Api
         /// </summary>
-        public static OpenFeature Instance { get; } = new OpenFeature();
+        public static Api Instance { get; } = new Api();
 
         // Explicit static constructor to tell C# compiler
         // not to mark type as beforefieldinit
         // IE Lazy way of ensuring this is thread safe without using locks
-        static OpenFeature() { }
-        private OpenFeature() { }
+        static Api() { }
+        private Api() { }
 
         /// <summary>
         /// Sets the feature provider
@@ -58,7 +57,7 @@ public void SetProvider(FeatureProvider featureProvider)
         /// it should be accessed once for an operation, and then that reference should be used for all dependent
         /// operations. For instance, during an evaluation the flag resolution method, and the provider hooks
         /// should be accessed from the same reference, not two independent calls to
-        /// <see cref="OpenFeature.GetProvider"/>.
+        /// <see cref="GetProvider"/>.
         /// </para>
         /// </summary>
         /// <returns><see cref="FeatureProvider"/></returns>
@@ -80,7 +79,7 @@ public FeatureProvider GetProvider()
         /// <para>
         /// This method is not guaranteed to return the same provider instance that may be used during an evaluation
         /// in the case where the provider may be changed from another thread.
-        /// For multiple dependent provider operations see <see cref="OpenFeature.GetProvider"/>.
+        /// For multiple dependent provider operations see <see cref="GetProvider"/>.
         /// </para>
         /// </summary>
         /// <returns><see cref="ClientMetadata"/></returns>
@@ -111,7 +110,7 @@ public FeatureClient GetClient(string name = null, string version = null, ILogge
         /// Adds a hook to global hooks list
         /// <para>
         /// Hooks which are dependent on each other should be provided in a collection
-        /// using the <see cref="AddHooks(System.Collections.Generic.IEnumerable{OpenFeatureSDK.Hook})"/>.
+        /// using the <see cref="AddHooks(IEnumerable{Hook})"/>.
         /// </para>
         /// </summary>
         /// <param name="hook">Hook that implements the <see cref="Hook"/> interface</param>

src/OpenFeatureSDK/Constant/ErrorType.cs → src/OpenFeature/Constant/ErrorType.cs

@@ -1,6 +1,6 @@
 using System.ComponentModel;
 
-namespace OpenFeatureSDK.Constant
+namespace OpenFeature.Constant
 {
     /// <summary>
     /// These errors are used to indicate abnormal execution when evaluation a flag

src/OpenFeatureSDK/Constant/FlagValueType.cs → src/OpenFeature/Constant/FlagValueType.cs

@@ -1,4 +1,4 @@
-namespace OpenFeatureSDK.Constant
+namespace OpenFeature.Constant
 {
     /// <summary>
     ///  Used to identity what object type of flag being evaluated

src/OpenFeatureSDK/Constant/NoOpProvider.cs → src/OpenFeature/Constant/NoOpProvider.cs

@@ -1,4 +1,4 @@
-namespace OpenFeatureSDK.Constant
+namespace OpenFeature.Constant
 {
     internal static class NoOpProvider
     {

src/OpenFeatureSDK/Constant/Reason.cs → src/OpenFeature/Constant/Reason.cs

@@ -1,4 +1,4 @@
-namespace OpenFeatureSDK.Constant
+namespace OpenFeature.Constant
 {
     /// <summary>
     /// Common reasons used during flag resolution

src/OpenFeatureSDK/Error/FeatureProviderException.cs → src/OpenFeature/Error/FeatureProviderException.cs

@@ -1,7 +1,7 @@
 using System;
-using OpenFeatureSDK.Constant;
+using OpenFeature.Constant;
 
-namespace OpenFeatureSDK.Error
+namespace OpenFeature.Error
 {
     /// <summary>
     /// Used to represent an abnormal error when evaluating a flag. This exception should be thrown

src/OpenFeatureSDK/Extension/EnumExtensions.cs → src/OpenFeature/Extension/EnumExtensions.cs

@@ -2,7 +2,7 @@
 using System.ComponentModel;
 using System.Linq;
 
-namespace OpenFeatureSDK.Extension
+namespace OpenFeature.Extension
 {
     internal static class EnumExtensions
     {

src/OpenFeatureSDK/Extension/ResolutionDetailsExtensions.cs → src/OpenFeature/Extension/ResolutionDetailsExtensions.cs

@@ -1,6 +1,6 @@
-using OpenFeatureSDK.Model;
+using OpenFeature.Model;
 
-namespace OpenFeatureSDK.Extension
+namespace OpenFeature.Extension
 {
     internal static class ResolutionDetailsExtensions
     {

src/OpenFeatureSDK/FeatureProvider.cs → src/OpenFeature/FeatureProvider.cs

@@ -1,8 +1,8 @@
 using System.Collections.Immutable;
 using System.Threading.Tasks;
-using OpenFeatureSDK.Model;
+using OpenFeature.Model;
 
-namespace OpenFeatureSDK
+namespace OpenFeature
 {
     /// <summary>
     /// The provider interface describes the abstraction layer for a feature flag provider.

src/OpenFeatureSDK/Hook.cs → src/OpenFeature/Hook.cs

@@ -1,9 +1,9 @@
 using System;
 using System.Collections.Generic;
 using System.Threading.Tasks;
-using OpenFeatureSDK.Model;
+using OpenFeature.Model;
 
-namespace OpenFeatureSDK
+namespace OpenFeature
 {
     /// <summary>
     /// The Hook abstract class describes the default implementation for a hook.

src/OpenFeatureSDK/IFeatureClient.cs → src/OpenFeature/IFeatureClient.cs

@@ -1,8 +1,8 @@
 using System.Collections.Generic;
 using System.Threading.Tasks;
-using OpenFeatureSDK.Model;
+using OpenFeature.Model;
 
-namespace OpenFeatureSDK
+namespace OpenFeature
 {
     internal interface IFeatureClient
     {

src/OpenFeatureSDK/Model/ClientMetadata.cs → src/OpenFeature/Model/ClientMetadata.cs

@@ -1,4 +1,4 @@
-namespace OpenFeatureSDK.Model
+namespace OpenFeature.Model
 {
     /// <summary>
     /// Represents the client metadata

src/OpenFeatureSDK/Model/EvaluationContext.cs → src/OpenFeature/Model/EvaluationContext.cs

@@ -2,7 +2,7 @@
 using System.Collections.Generic;
 using System.Collections.Immutable;
 
-namespace OpenFeatureSDK.Model
+namespace OpenFeature.Model
 {
     /// <summary>
     /// A KeyValuePair with a string key and object value that is used to apply user defined properties

src/OpenFeatureSDK/Model/EvaluationContextBuilder.cs → src/OpenFeature/Model/EvaluationContextBuilder.cs

@@ -1,6 +1,6 @@
 using System;
 
-namespace OpenFeatureSDK.Model
+namespace OpenFeature.Model
 {
     /// <summary>
     /// A builder which allows the specification of attributes for an <see cref="EvaluationContext"/>.

src/OpenFeatureSDK/Model/FlagEvaluationDetails.cs → src/OpenFeature/Model/FlagEvaluationDetails.cs

@@ -1,6 +1,6 @@
-using OpenFeatureSDK.Constant;
+using OpenFeature.Constant;
 
-namespace OpenFeatureSDK.Model
+namespace OpenFeature.Model
 {
     /// <summary>
     /// The contract returned to the caller that describes the result of the flag evaluation process.

src/OpenFeatureSDK/Model/FlagEvaluationOptions.cs → src/OpenFeature/Model/FlagEvaluationOptions.cs

@@ -1,6 +1,6 @@
 using System.Collections.Immutable;
 
-namespace OpenFeatureSDK.Model
+namespace OpenFeature.Model
 {
     /// <summary>
     /// A structure containing the one or more hooks and hook hints

src/OpenFeatureSDK/Model/HookContext.cs → src/OpenFeature/Model/HookContext.cs

@@ -1,7 +1,7 @@
 using System;
-using OpenFeatureSDK.Constant;
+using OpenFeature.Constant;
 
-namespace OpenFeatureSDK.Model
+namespace OpenFeature.Model
 {
     /// <summary>
     /// Context provided to hook execution

src/OpenFeatureSDK/Model/Metadata.cs → src/OpenFeature/Model/Metadata.cs

@@ -1,19 +1,19 @@
-namespace OpenFeatureSDK.Model
+namespace OpenFeature.Model
 {
     /// <summary>
-    /// <see cref="OpenFeature"/> metadata
+    /// <see cref="Api"/> metadata
     /// </summary>
     public class Metadata
     {
         /// <summary>
-        /// Gets name of <see cref="OpenFeature"/> instance
+        /// Gets name of <see cref="Api"/> instance
         /// </summary>
         public string Name { get; }
 
         /// <summary>
         /// Initializes a new instance of the <see cref="Metadata"/> class.
         /// </summary>
-        /// <param name="name">Name of <see cref="OpenFeature"/> instance</param>
+        /// <param name="name">Name of <see cref="Api"/> instance</param>
         public Metadata(string name)
         {
             this.Name = name;

src/OpenFeatureSDK/Model/ResolutionDetails.cs → src/OpenFeature/Model/ResolutionDetails.cs

@@ -1,6 +1,6 @@
-using OpenFeatureSDK.Constant;
+using OpenFeature.Constant;
 
-namespace OpenFeatureSDK.Model
+namespace OpenFeature.Model
 {
     /// <summary>
     /// Defines the contract that the <see cref="FeatureProvider"/> is required to return

src/OpenFeatureSDK/Model/Structure.cs → src/OpenFeature/Model/Structure.cs

@@ -3,7 +3,7 @@
 using System.Collections.Immutable;
 using System.Diagnostics.CodeAnalysis;
 
-namespace OpenFeatureSDK.Model
+namespace OpenFeature.Model
 {
     /// <summary>
     /// Structure represents a map of Values

src/OpenFeatureSDK/Model/StructureBuilder.cs → src/OpenFeature/Model/StructureBuilder.cs

@@ -2,7 +2,7 @@
 using System.Collections.Generic;
 using System.Collections.Immutable;
 
-namespace OpenFeatureSDK.Model
+namespace OpenFeature.Model
 {
     /// <summary>
     /// A builder which allows the specification of attributes for a <see cref="Structure"/>.

src/OpenFeatureSDK/Model/Value.cs → src/OpenFeature/Model/Value.cs

@@ -2,7 +2,7 @@
 using System.Collections.Generic;
 using System.Collections.Immutable;
 
-namespace OpenFeatureSDK.Model
+namespace OpenFeature.Model
 {
     /// <summary>
     ///  Values serve as a return type for provider objects. Providers may deal in JSON, protobuf, XML or some other data-interchange format.

src/OpenFeatureSDK/NoOpProvider.cs → src/OpenFeature/NoOpProvider.cs

@@ -1,8 +1,8 @@
 using System.Threading.Tasks;
-using OpenFeatureSDK.Constant;
-using OpenFeatureSDK.Model;
+using OpenFeature.Constant;
+using OpenFeature.Model;
 
-namespace OpenFeatureSDK
+namespace OpenFeature
 {
     internal class NoOpFeatureProvider : FeatureProvider
     {

src/OpenFeatureSDK/OpenFeatureSDK.csproj → src/OpenFeature/OpenFeature.csproj

@@ -2,7 +2,7 @@
 
   <PropertyGroup>
     <TargetFrameworks>netstandard2.0;net462</TargetFrameworks>
-    <RootNamespace>OpenFeatureSDK</RootNamespace>
+    <RootNamespace>OpenFeature</RootNamespace>
   </PropertyGroup>
 
   <ItemGroup>
@@ -11,7 +11,7 @@
 
   <ItemGroup>
     <AssemblyAttribute Include="System.Runtime.CompilerServices.InternalsVisibleTo">
-      <_Parameter1>OpenFeatureSDK.Tests</_Parameter1>
+      <_Parameter1>OpenFeature.Tests</_Parameter1>
     </AssemblyAttribute>
   </ItemGroup>