Skip to content

Commit c22b2fa

Browse files
AarononthewebAaronontheweb
authored
Merge pull request #209 from akkadotnet/dev
v1.3.3 Release
2 parents fcf6951 + 6597065 commit c22b2fa

File tree

11 files changed

+209
-21
lines changed

11 files changed

+209
-21
lines changed

‎Hocon.sln

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11

22
Microsoft Visual Studio Solution File, Format Version 12.00
3-
# Visual Studio 15
4-
VisualStudioVersion = 15.0.26730.15
3+
# Visual Studio Version 16
4+
VisualStudioVersion = 16.0.29424.173
55
MinimumVisualStudioVersion = 10.0.40219.1
66
Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Hocon", "src\Hocon\Hocon.csproj", "{E945AABA-2779-41E8-9B43-8898FFD64F22}"
77
EndProject
@@ -33,6 +33,8 @@ Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Hocon.Immutable", "src\Hoco
3333
EndProject
3434
Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Hocon.Immutable.Tests", "src\Hocon.Immutable.Tests\Hocon.Immutable.Tests.csproj", "{FEEC6F6B-2511-4BEC-9568-4E6AE6C1D275}"
3535
EndProject
36+
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "SerializationDebug", "src\examples\SerializationDebug\SerializationDebug.csproj", "{6D1D4813-7AB6-4268-A9DF-627A60E08FB1}"
37+
EndProject
3638
Global
3739
GlobalSection(SolutionConfigurationPlatforms) = preSolution
3840
Debug|Any CPU = Debug|Any CPU
@@ -95,6 +97,10 @@ Global
9597
{FEEC6F6B-2511-4BEC-9568-4E6AE6C1D275}.Debug|Any CPU.Build.0 = Debug|Any CPU
9698
{FEEC6F6B-2511-4BEC-9568-4E6AE6C1D275}.Release|Any CPU.ActiveCfg = Release|Any CPU
9799
{FEEC6F6B-2511-4BEC-9568-4E6AE6C1D275}.Release|Any CPU.Build.0 = Release|Any CPU
100+
{6D1D4813-7AB6-4268-A9DF-627A60E08FB1}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
101+
{6D1D4813-7AB6-4268-A9DF-627A60E08FB1}.Debug|Any CPU.Build.0 = Debug|Any CPU
102+
{6D1D4813-7AB6-4268-A9DF-627A60E08FB1}.Release|Any CPU.ActiveCfg = Release|Any CPU
103+
{6D1D4813-7AB6-4268-A9DF-627A60E08FB1}.Release|Any CPU.Build.0 = Release|Any CPU
98104
EndGlobalSection
99105
GlobalSection(SolutionProperties) = preSolution
100106
HideSolutionNode = FALSE

‎RELEASE_NOTES.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,9 @@
1-
#### 1.3.2 January 24 2020 ####
1+
#### 1.3.3 January 27 2020 ####
22
**Bugfix release for HOCON v1.3.0**
33

44
Key changes include:
55

6-
* [Critical bugfix: Fallbacks are mutable during traversal](https://github.com/akkadotnet/HOCON/issues/193)
7-
* [Added HOCON Debugger tools](https://github.com/akkadotnet/HOCON/pull/192)
8-
* [Performance: Lookups on configs with fallback are performing merge and allocations each time](https://github.com/akkadotnet/HOCON/issues/195)
6+
* [Make `Config` implement `ISerializable`](https://github.com/akkadotnet/HOCON/pull/207)
7+
* [Implement Akka.NET backwards compatibility fixes](https://github.com/akkadotnet/HOCON/pull/204)
98

10-
You can [see the full set of changes in the HOCON v1.3.2 milestone](https://github.com/akkadotnet/HOCON/milestone/5).
9+
You can [see the full set of changes in the HOCON v1.3.3 milestone](https://github.com/akkadotnet/HOCON/milestone/6).

‎src/Hocon.Configuration.Test/ConfigurationSpec.cs

Lines changed: 32 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@
1111
using System.Reflection;
1212
using FluentAssertions;
1313
using Newtonsoft.Json;
14+
using Newtonsoft.Json.Linq;
1415
using Newtonsoft.Json.Serialization;
1516
using Xunit;
1617

@@ -30,6 +31,19 @@ public class MyObjectConfig
3031
public int[] IntergerArray { get; set; }
3132
}
3233

34+
[Fact]
35+
public void Config_should_be_serializable()
36+
{
37+
var config = ConfigurationFactory.ParseString(@"
38+
foo{
39+
bar.biz = 12
40+
baz = ""quoted""
41+
}");
42+
var serialized = JsonConvert.SerializeObject(config);
43+
var deserialized = JsonConvert.DeserializeObject<Config>(serialized);
44+
config.DumpConfig().Should().Be(deserialized.DumpConfig());
45+
}
46+
3347
[Fact]
3448
public void CanEnumerateQuotedKeys()
3549
{
@@ -434,6 +448,23 @@ public void HoconValue_GetObject_should_use_fallback_values()
434448
rootObject["b"].Raw.Should().Be("3");
435449
}
436450

451+
[Fact]
452+
public void Config_will_not_throw_on_duplicate_fallbacks()
453+
{
454+
var c1 = ConfigurationFactory.ParseString(@"foo.bar = baz");
455+
var c2 = ConfigurationFactory.ParseString(@"bar.biz = fuber");
456+
457+
// normal fallback
458+
var f1 = c1.WithFallback(c2).WithFallback(Config.Empty);
459+
c1.Fallback.Should().BeNull(); // original copy should not have been modified.
460+
461+
// someone adds the same fallback again with realizing it
462+
f1.WithFallback(Config.Empty).GetString("bar.biz").Should().Be("fuber"); // shouldn't throw
463+
464+
var final = f1.WithFallback(c2);
465+
final.GetString("bar.biz").Should().Be("fuber"); // shouldn't throw
466+
}
467+
437468
[Fact]
438469
public void Quoted_key_should_be_parsed()
439470
{
@@ -549,7 +580,7 @@ public void ShouldSerializeFallbackValues()
549580
/// <summary>
550581
/// Source issue: https://github.com/akkadotnet/HOCON/issues/175
551582
/// </summary>
552-
[Fact]
583+
[Fact(Skip = "This is disabled due to temprorary fix for https://github.com/akkadotnet/HOCON/issues/206")]
553584
public void ShouldDeserializeFromJson()
554585
{
555586
var settings = new JsonSerializerSettings

‎src/Hocon.Configuration.Test/DebuggerSpec.cs

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,6 @@
55
// -----------------------------------------------------------------------
66

77
using FluentAssertions;
8-
using Hocon.Debugger;
98
using Xunit;
109

1110
namespace Hocon.Configuration.Tests

‎src/Hocon.Configuration.Test/SerializationSpecs.cs

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
// -----------------------------------------------------------------------
2+
// <copyright file="SerializationSpec.cs" company="Akka.NET Project">
3+
// Copyright (C) 2013 - 2020 .NET Foundation <https://github.com/akkadotnet/hocon>
4+
// </copyright>
5+
// -----------------------------------------------------------------------
6+
7+
using System.Collections.Generic;
8+
using FluentAssertions;
9+
using Newtonsoft.Json;
10+
using Xunit;
11+
12+
namespace Hocon.Configuration.Tests
13+
{
14+
public class SerializationSpecs
15+
{
16+
public static IEnumerable<object[]> HoconGenerator()
17+
{
18+
yield return new object[]
19+
{
20+
@"
21+
foo{
22+
bar.biz = 12
23+
baz = ""quoted""
24+
}
25+
", string.Empty, string.Empty
26+
};
27+
}
28+
29+
[Theory(Skip = "Doesn't work right now")]
30+
[MemberData(nameof(HoconGenerator))]
31+
public void ShouldSerializeHocon(string hocon, string fallback1, string fallback2)
32+
{
33+
var hocon1 = ConfigurationFactory.ParseString(hocon);
34+
var fb1 = string.IsNullOrEmpty(fallback1) ? Config.Empty : ConfigurationFactory.ParseString(fallback1);
35+
var fb2 = string.IsNullOrEmpty(fallback1) ? Config.Empty : ConfigurationFactory.ParseString(fallback2);
36+
37+
var final = hocon1.WithFallback(fb1).WithFallback(fb2);
38+
39+
VerifySerialization(final);
40+
}
41+
42+
private void VerifySerialization(Config config)
43+
{
44+
var serialized = JsonConvert.SerializeObject(config);
45+
var deserialized = (Config)JsonConvert.DeserializeObject(serialized);
46+
config.DumpConfig().Should().Be(deserialized.DumpConfig());
47+
}
48+
}
49+
}

‎src/Hocon.Configuration/Config.cs

Lines changed: 52 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@
77
using System;
88
using System.Collections.Generic;
99
using System.Linq;
10+
using System.Runtime.Serialization;
1011

1112
namespace Hocon
1213
{
@@ -16,8 +17,35 @@ namespace Hocon
1617
/// the internal representation of a HOCON (Human-Optimized Config Object Notation)
1718
/// configuration string.
1819
/// </summary>
19-
public class Config : HoconRoot
20+
[Serializable]
21+
public class Config : HoconRoot, ISerializable
2022
{
23+
/// <summary>
24+
/// INTERNAL API
25+
///
26+
/// Special case for empty configurations. Immutable and can't be added as a fallback.
27+
/// </summary>
28+
internal sealed class EmptyConfig : Config
29+
{
30+
public static EmptyConfig Instance = new EmptyConfig();
31+
32+
private EmptyConfig() : base(new HoconRoot(new HoconEmptyValue(null)))
33+
{
34+
}
35+
36+
protected override Config Copy(Config fallback = null)
37+
{
38+
return Instance;
39+
}
40+
41+
public override Config WithFallback(Config fallback)
42+
{
43+
return fallback;
44+
}
45+
}
46+
47+
public const string SerializedPropertyName = "_dump";
48+
2149
[Obsolete("For json serialization/deserialization only", true)]
2250
private Config()
2351
{
@@ -89,10 +117,10 @@ public string ToString(bool useFallbackValues)
89117
/// Generates a deep clone of the current configuration.
90118
/// </summary>
91119
/// <returns>A deep clone of the current configuration</returns>
92-
protected Config Copy()
120+
protected virtual Config Copy(Config fallback = null)
93121
{
94122
//deep clone
95-
return new Config((HoconValue) Value.Clone(null), Fallback?.Copy());
123+
return new Config((HoconValue) Value.Clone(null), fallback?.Copy() ?? Fallback?.Copy());
96124
}
97125

98126
protected override HoconValue GetNode(HoconPath path, bool throwIfNotFound = false)
@@ -137,10 +165,13 @@ public virtual Config WithFallback(Config fallback)
137165
{
138166
if (fallback == this)
139167
throw new ArgumentException("Config can not have itself as fallback", nameof(fallback));
168+
169+
if (fallback == Config.Empty)
170+
return this; // no-op
140171

141172
// If Fallback is not set - we will set it in new copy
142173
// If Fallback was set - just use it, but with adding new fallback values
143-
return new Config((HoconValue) Value.Clone(null), Fallback?.WithFallback(fallback) ?? fallback);
174+
return Copy(Fallback.SafeWithFallback(fallback));
144175
}
145176

146177
/// <summary>
@@ -206,6 +237,23 @@ private HoconValue GetRootValue()
206237

207238
return aggregated;
208239
}
240+
241+
/// <inheritdoc />
242+
public void GetObjectData(SerializationInfo info, StreamingContext context)
243+
{
244+
info.AddValue(SerializedPropertyName, this.ToString(useFallbackValues: true), typeof(string));
245+
}
246+
247+
[Obsolete("Used for serialization only", true)]
248+
public Config(SerializationInfo info, StreamingContext context)
249+
{
250+
var config = ConfigurationFactory.ParseString(info.GetValue(SerializedPropertyName, typeof(string)) as string);
251+
252+
Value = config.Value;
253+
Fallback = config.Fallback;
254+
255+
Root = GetRootValue();
256+
}
209257
}
210258

211259
/// <summary>

‎src/Hocon.Configuration/ConfigurationFactory.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ public static class ConfigurationFactory
2525
/// <summary>
2626
/// Generates an empty configuration.
2727
/// </summary>
28-
public static Config Empty => new Config(new HoconRoot(new HoconEmptyValue(null)));
28+
public static Config Empty => Config.EmptyConfig.Instance;
2929

3030
/// <summary>
3131
/// Generates a configuration defined in the supplied

‎src/Hocon.Configuration/Debugger/DebuggingExtensions.cs renamed to ‎src/Hocon.Configuration/DebuggingExtensions.cs

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,7 @@
66

77
using System.Text;
88

9-
10-
namespace Hocon.Debugger
9+
namespace Hocon
1110
{
1211
/// <summary>
1312
/// Debugging extensions for <see cref="Config"/> objects.

‎src/common.props

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,12 @@
22
<PropertyGroup>
33
<Copyright>Copyright © 2014-2019 Akka.NET Team</Copyright>
44
<Authors>Akka.NET Team</Authors>
5-
<VersionPrefix>1.3.2</VersionPrefix>
5+
<VersionPrefix>1.3.3</VersionPrefix>
66
<PackageReleaseNotes>Bugfix release for HOCON v1.3.0**
77
Key changes include:
8-
[Critical bugfix: Fallbacks are mutable during traversal](https://github.com/akkadotnet/HOCON/issues/193)
9-
[Added HOCON Debugger tools](https://github.com/akkadotnet/HOCON/pull/192)
10-
[Performance: Lookups on configs with fallback are performing merge and allocations each time](https://github.com/akkadotnet/HOCON/issues/195)
11-
You can [see the full set of changes in the HOCON v1.3.2 milestone](https://github.com/akkadotnet/HOCON/milestone/5).</PackageReleaseNotes>
8+
[Make `Config` implement `ISerializable`](https://github.com/akkadotnet/HOCON/pull/207)
9+
[Implement Akka.NET backwards compatibility fixes](https://github.com/akkadotnet/HOCON/pull/204)
10+
You can [see the full set of changes in the HOCON v1.3.3 milestone](https://github.com/akkadotnet/HOCON/milestone/6).</PackageReleaseNotes>
1211
<PackageIconUrl>http://getakka.net/images/akkalogo.png</PackageIconUrl>
1312
<PackageProjectUrl>https://github.com/akkadotnet/HOCON</PackageProjectUrl>
1413
<PackageLicenseUrl>https://github.com/akkadotnet/HOCON/blob/master/LICENSE</PackageLicenseUrl>
@@ -19,6 +18,7 @@ You can [see the full set of changes in the HOCON v1.3.2 milestone](https://gith
1918
<XunitVersion>2.4.1</XunitVersion>
2019
<XunitCliVersion>2.3.1</XunitCliVersion>
2120
<TestSdkVersion>16.4.0</TestSdkVersion>
21+
<NetCoreVersion>netcoreapp2.1</NetCoreVersion>
2222
</PropertyGroup>
2323
<PropertyGroup Condition=" '$(TargetFramework)' == 'netcoreapp2.1' ">
2424
<DefineConstants>$(DefineConstants);NETCORE</DefineConstants>

‎src/examples/SerializationDebug/Program.cs

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
using System;
2+
using FluentAssertions;
3+
using Hocon;
4+
using Newtonsoft.Json;
5+
6+
namespace SerializationDebug
7+
{
8+
class Program
9+
{
10+
static void Main(string[] args)
11+
{
12+
var hocon1 = @"
13+
foo{
14+
bar.biz = 12
15+
baz = ""quoted""
16+
}";
17+
18+
ShouldSerializeHocon(hocon1, string.Empty, string.Empty);
19+
}
20+
21+
public static void ShouldSerializeHocon(string hocon, string fallback1, string fallback2)
22+
{
23+
var hocon1 = ConfigurationFactory.ParseString(hocon);
24+
var fb1 = string.IsNullOrEmpty(fallback1) ? Config.Empty : ConfigurationFactory.ParseString(fallback1);
25+
var fb2 = string.IsNullOrEmpty(fallback1) ? Config.Empty : ConfigurationFactory.ParseString(fallback2);
26+
27+
var final = hocon1.WithFallback(fb1).WithFallback(fb2);
28+
29+
VerifySerialization(final);
30+
}
31+
32+
public static void VerifySerialization(Config config)
33+
{
34+
var serialized = JsonConvert.SerializeObject(config);
35+
var deserialized = (Config)JsonConvert.DeserializeObject(serialized);
36+
config.DumpConfig().Should().Be(deserialized.DumpConfig());
37+
}
38+
}
39+
}

‎src/examples/SerializationDebug/SerializationDebug.csproj

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
<Project Sdk="Microsoft.NET.Sdk">
2+
<Import Project="..\..\common.props" />
3+
4+
<PropertyGroup>
5+
<OutputType>Exe</OutputType>
6+
<TargetFramework>$(NetCoreVersion)</TargetFramework>
7+
</PropertyGroup>
8+
9+
<ItemGroup>
10+
<PackageReference Include="FluentAssertions" Version="5.10.0" />
11+
<PackageReference Include="Newtonsoft.Json" Version="12.0.3" />
12+
</ItemGroup>
13+
14+
<ItemGroup>
15+
<ProjectReference Include="..\..\Hocon.Configuration\Hocon.Configuration.csproj" />
16+
</ItemGroup>
17+
18+
</Project>

0 commit comments

Comments
 (0)