Optional subsections (#32)

* feat: optional subsections

* revert to simple case

* chore: remove unnecessary change

* chore: removed WIP

* chore: remove WIP

---------

Co-authored-by: queil <[email protected]>

Author: queil

.vscode/launch.json

@@ -0,0 +1,24 @@
+{
+    // Use IntelliSense to learn about possible attributes.
+    // Hover to view descriptions of existing attributes.
+    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "name": ".NET Core Launch (console)",
+            "type": "coreclr",
+            "request": "launch",
+            "preLaunchTask": "build",
+            "program": "dotnet",
+            "args": [
+                "test"
+            ],
+            "cwd": "${workspaceFolder}/tests/FsConfig.Tests",
+            "stopAtEntry": false,
+            "console": "internalConsole",
+            "env": {
+                "VSTEST_HOST_DEBUG": "1"
+            }
+        }
+    ]
+}

.vscode/settings.json

@@ -1,5 +1,4 @@
 {
-    "FSharp.fsacRuntime":"netcore",
     "FSharp.enableAnalyzers": true,
     "FSharp.analyzersPath": [
         "./packages/analyzers"

.vscode/tasks.json

@@ -0,0 +1,17 @@
+{
+    "version": "2.0.0",
+    "tasks": [
+        {
+            "type": "msbuild",
+            "problemMatcher": [
+                "$msCompile"
+            ],
+            "group": {
+                "kind": "build",
+                "isDefault": true
+            },
+            "label": "build",
+            "detail": "Build the FsConfig.Tests.fsproj project using dotnet build"
+        }
+    ]
+}

src/FsConfig/Config.fs

@@ -185,43 +185,6 @@ module internal Core =
             )
         | _ -> None
 
-    let parseFSharpOption<'T> name value (fsharpOption: IShapeFSharpOption) =
-        let wrap (p: ConfigParseResult<'a>) = unbox<ConfigParseResult<'T>> p
-
-        fsharpOption.Element.Accept
-            { new ITypeVisitor<ConfigParseResult<'T>> with
-                member __.Visit<'t>() =
-                    match value with
-                    | None ->
-                        let result: ConfigParseResult<'t option> = None |> Ok
-                        wrap result
-                    | Some v ->
-                        match getTryParseFunc<'t> fsharpOption.Element with
-                        | Some tryParseFunc ->
-                            match shapeof<'t> with
-                            | Shape.String ->
-                                if String.IsNullOrWhiteSpace v then
-                                    let result: ConfigParseResult<'t option> = None |> Ok
-                                    wrap result
-                                else
-                                    tryParseWith name v tryParseFunc
-                                    |> Result.bind (
-                                        Some
-                                        >> Ok
-                                        >> wrap
-                                    )
-                            | _ ->
-                                tryParseWith name v tryParseFunc
-                                |> Result.bind (
-                                    Some
-                                    >> Ok
-                                    >> wrap
-                                )
-                        | None ->
-                            notSupported name
-                            |> Error
-            }
-
     let parseListReducer name tryParseFunc acc element =
         acc
         |> Result.bind (fun xs ->
@@ -285,7 +248,8 @@ module internal Core =
         match targetTypeShape with
         | Shape.FSharpRecord (:? ShapeFSharpRecord<'T> as shape) ->
             parseFSharpRecord configReader fieldNameCanonicalizer (Prefix args.Name) shape
-        | Shape.FSharpOption fsharpOption -> parseFSharpOption<'T> args.Name value fsharpOption
+        | Shape.FSharpOption fsharpOption ->
+            parseFSharpOption configReader fieldNameCanonicalizer args fsharpOption
         | Shape.FSharpList fsharpList ->
             parseFSharpList<'T> args.Name value fsharpList args.ListSplitChar
         | _ ->
@@ -364,6 +328,35 @@ module internal Core =
             (Ok [])
         |> Result.map (List.fold (fun acc f -> f acc) record)
 
+    and parseFSharpOption
+        (configReader: IConfigReader)
+        (fieldNameCanonicalizer: FieldNameCanonicalizer)
+        args
+        (fsharpOption: IShapeFSharpOption)
+        =
+        let wrap (p: ConfigParseResult<'a>) = unbox<ConfigParseResult<'T>> p
+
+        fsharpOption.Element.Accept
+            { new ITypeVisitor<ConfigParseResult<'T>> with
+                member __.Visit<'t>() =
+
+                    match parseInternal<'t> configReader fieldNameCanonicalizer args with
+                    | Ok (value) ->
+                        match box value with
+                        | :? string as s when String.IsNullOrWhiteSpace s ->
+                            let result: ConfigParseResult<'t option> = None |> Ok
+                            wrap result
+                        | _ ->
+                            Some(value)
+                            |> Ok
+                            |> wrap
+                    | Error (BadValue v) -> Error(BadValue v)
+                    | Error (NotFound _) ->
+                        let result: ConfigParseResult<'t option> = None |> Ok
+                        wrap result
+                    | Error (NotSupported x) -> Error(NotSupported x)
+            }
+
 [<AutoOpen>]
 module Config =
     open Core

tests/FsConfig.Tests/AppConfig.fs

@@ -67,6 +67,18 @@ module ``App Config tests`` =
 
             test <@ appConfig.Get<Config>() = expected @>
 
+        [<Test>]
+        member __.``getOptionalRecord should succeed``() =
+            let expected =
+                {
+                    optionalSubsectionNone = None
+                    optionalSubsectionSome = Some({ apiKey = "abc-def"; value = 1 })
+
+                }
+
+                |> Ok
+
+            test <@ appConfig.Get<ConfigWithOptionalSubsection>() = expected @>
 
         [<Test>]
         member __.``get list of DU with custom name``() =

tests/FsConfig.Tests/AssemblyInfo.fs

@@ -92,3 +92,10 @@ module Common =
     type ConfigWithUri = { Uri: Uri }
 
     type ConfigWithInvalidUri = { InvalidUri: Uri }
+
+    type ConfigWithOptionalSubsection = {
+        optionalSubsectionNone: Subsection option
+        optionalSubsectionSome: Subsection option
+    }
+
+    and Subsection = { apiKey: string; value: int }

tests/FsConfig.Tests/Common.fs

@@ -18,4 +18,4 @@
     <ProjectReference Include="..\..\src\FsConfig\FsConfig.fsproj" />
   </ItemGroup>
   <Import Project="..\..\.paket\Paket.Restore.targets" />
-</Project>
+</Project>

tests/FsConfig.Tests/FsConfig.Tests.fsproj

@@ -1,13 +1,18 @@
 {
-  "processId" : "123",
-  "processName" : "FsConfig",
-  "magicNumber" : 42,
-  "aws" : {
-    "accessKeyId" : "Id-123",
-    "defaultRegion" : "us-east-1",
-    "secretAccessKey" : "secret123"
-  },
-  "colors" : "Red,Green",
-  "uri": "https://example.com",
-  "invalidUri": "invalid"
+    "processId": "123",
+    "processName": "FsConfig",
+    "magicNumber": 42,
+    "aws": {
+        "accessKeyId": "Id-123",
+        "defaultRegion": "us-east-1",
+        "secretAccessKey": "secret123"
+    },
+    "colors": "Red,Green",
+    "uri": "https://example.com",
+    "invalidUri": "invalid",
+    "optionalSubsectionNone": {},
+    "optionalSubsectionSome": {
+        "apiKey": "abc-def",
+        "value": 1
+    }
 }