Release 3.0.1 - See CHANGELOG.md for details.

Author: Sam Byass

CHANGELOG.md

@@ -4,6 +4,7 @@
 
 - [Tomlet Changelog](#tomlet-changelog)
   - [Contents](#contents)
+  - [3.0.1](#301)
   - [3.0.0](#300)
   - [2.2.0](#220)
   - [2.1.0](#210)
@@ -24,6 +25,10 @@
   - [1.0.1](#101)
   - [1.0.0](#100)
 
+## 3.0.1
+- Hotfix for an issue where the new, preferred, inline serialization would create invalid TOML documents
+due to not quoting keys.
+
 ## 3.0.0
 - BREAKING CHANGE: Moved TomlPropertyAttribute to the `Tomlet.Attributes` namespace.
 - BREAKING CHANGE: Removed several exceptions that weren't ever actually thrown

README_trimmed_for_nuget.md

@@ -4,24 +4,13 @@
 [![NuGet](https://img.shields.io/nuget/v/Samboy063.Tomlet)](https://www.nuget.org/packages/Samboy063.Tomlet/)
 ![GitHub Workflow Status](https://img.shields.io/github/workflow/status/SamboyCoding/Tomlet/.NET)
 ![Toml Version](https://img.shields.io/badge/TOML%20Version-1.0.0-blue)
+[![Coverage Status](https://coveralls.io/repos/github/SamboyCoding/Tomlet/badge.svg?branch=master)](https://coveralls.io/github/SamboyCoding/Tomlet?branch=master)
 
 ### I have a [discord server](https://discord.gg/CfPSP5GMMv) for support
 
 Tomlet is a zero-dependency library for the [TOML](https://toml.io/) configuration file format. It's targeting [TOML v1.0.0](https://toml.io/en/v1.0.0).
 
-Currently supported features are as follows:
-
-- [x] Primitive key-value pair reading
-- [x] Table Reading
-- [x] Inline Table Reading
-- [x] Array Reading
-- [x] Table-Array Reading
-- [x] Primitive key-value pair writing
-- [x] Table Writing
-- [x] Inline Table Writing
-- [x] Array Writing
-- [x] Table-Array Writing
-- [x] Full Unit Tests for everything supported here.
+The entire 1.0.0 specification as described [here](https://toml.io/en/v1.0.0) is implemented.  
 
 ## A word on dotted keys
 
@@ -67,6 +56,19 @@ class MyClass {
 }
 ```
 
+### Comments
+
+Comments are parsed and stored alongside their corresponding values, where possible. Every instance of `TomlValue`
+has a `Comments` property, which contains both the "inline" and "preceding" comments. Precending comments are
+the comments that appear before the value (and therefore can span multiple lines), and inline comments are
+the comments that appear on the same line as the value (and thus must be a single line).
+
+Any preceding comment which is not associated with a value (i.e. it is placed after the last value) will be
+stored in the `TrailingComment` property of the TOML document itself, and will be re-serialized from there.
+
+If you're using Tomlet's reflective serialization feature (i.e. `TomletMain.____From`), you can use the `TomlInlineComment` and `TomlPrecedingComment`
+attributes on fields or properties to specify the respective comments.
+
 ### Parse a TOML File
 
 `TomlParser.ParseFile` is a utility method to parse an on-disk toml file. This just uses File.ReadAllText, so I/O errors will be thrown up to your calling code.

Tomlet.Tests/DeliberatelyIncorrectTestResources.Designer.cs

@@ -148,4 +148,15 @@ one = 1</value>
         <value>[table
 one = 1</value>
     </data>
+    <data name="InlineTableLockedTestInput" xml:space="preserve">
+        <value>type = { name = "Nail" }
+type.edible = false  # INVALID</value>
+    </data>
+    <data name="TableRedefinitionTestInput" xml:space="preserve">
+        <value>[fruit]
+apple = "red"
+
+[fruit]
+orange = "orange"</value>
+    </data>
 </root>

Tomlet.Tests/DeliberatelyIncorrectTestResources.resx

@@ -172,6 +172,14 @@ public void UnterminatedTableArrayThrows() =>
     [Fact]
     public void UnterminatedTableNameThrows() => 
         AssertThrows<UnterminatedTomlTableNameException>(() => GetDocument(DeliberatelyIncorrectTestResources.TomlUnterminatedTableExample));
+    
+    [Fact]
+    public void AttemptingToModifyInlineTablesThrowsAnException() => 
+        AssertThrows<TomlTableLockedException>(() => GetDocument(DeliberatelyIncorrectTestResources.InlineTableLockedTestInput));
+    
+    [Fact]
+    public void ReDefiningATableThrowsAnException() => 
+        AssertThrows<TomlTableRedefinitionException>(() => GetDocument(DeliberatelyIncorrectTestResources.TableRedefinitionTestInput));
 
     //These are all runtime mistakes on otherwise-valid TOML documents, so they aren't in the DeliberatelyIncorrectTestResources file.
 

Tomlet.Tests/ExceptionTests.cs

@@ -1,5 +1,6 @@
 using Tomlet.Exceptions;
 using Tomlet.Models;
+using Tomlet.Tests.TestModelClasses;
 using Xunit;
 
 namespace Tomlet.Tests
@@ -26,9 +27,18 @@ public void InlineTablesAreSupported()
         }
 
         [Fact]
-        public void AttemptingToModifyInlineTablesThrowsAnException()
+        public void TablesWithKeysContainingWhitespaceDoNotSerializeInline()
         {
-            Assert.Throws<TomlTableLockedException>(() => GetDocument(TestResources.InlineTableLockedTestInput));
+            //Serializing these inline means we have to duplicate all the key quoting shenanigans, it's easier just to not inline them
+            var obj = new KeyWithWhitespaceTestClass() {KeyWithWhitespace = "hello"};
+            var document = TomlDocument.CreateEmpty();
+            document.Put("myTable", obj);
+
+            var tomlString = document.SerializedValue;
+            var doc = GetDocument(tomlString);
+            var newObj = TomletMain.To<KeyWithWhitespaceTestClass>(doc.GetSubTable("myTable"));
+            
+            Assert.Equal(obj.KeyWithWhitespace, newObj.KeyWithWhitespace);
         }
     }
 }

Tomlet.Tests/InlineTableTests.cs

@@ -56,11 +56,5 @@ public void TablesCanHaveQuotedDottedNames()
 
             Assert.Equal("pug", document.GetSubTable("dog").GetSubTable("tater.man").GetSubTable("type").GetString("name"));
         }
-
-        [Fact]
-        public void ReDefiningATableThrowsAnException()
-        {
-            Assert.Throws<TomlTableRedefinitionException>(() => GetDocument(TestResources.TableRedefinitionTestInput));
-        }
     }
 }

Tomlet.Tests/TableTests.cs

@@ -0,0 +1,9 @@
+using Tomlet.Attributes;
+
+namespace Tomlet.Tests.TestModelClasses;
+
+public class KeyWithWhitespaceTestClass
+{
+    [TomlProperty("Key With Whitespace")]
+    public string KeyWithWhitespace { get; set; }
+}

Tomlet.Tests/TestModelClasses/KeyWithWhitespaceTestClass.cs

@@ -204,10 +204,6 @@ fruit . flavor = "banana"   # same as fruit.flavor</value>
 empty = {   }
 point = { x = 1, y = 2 }
 animal = { type.name = "pug" }</value>
-    </data>
-    <data name="InlineTableLockedTestInput" xml:space="preserve">
-        <value>type = { name = "Nail" }
-type.edible = false  # INVALID</value>
     </data>
     <data name="BasicTableTestInput" xml:space="preserve">
         <value>[table-1]
@@ -221,13 +217,6 @@ key2 = 456</value>
     <data name="TableWithQuotedDottedStringTestInput" xml:space="preserve">
         <value>[dog."tater.man"]
 type.name = "pug"</value>
-    </data>
-    <data name="TableRedefinitionTestInput" xml:space="preserve">
-        <value>[fruit]
-apple = "red"
-
-[fruit]
-orange = "orange"</value>
     </data>
     <data name="ComplexTableArrayTestInput" xml:space="preserve">
         <value>[[fruits]]

Tomlet.Tests/TestResources.Designer.cs

@@ -19,7 +19,10 @@ public class TomlTable : TomlValue
 
         public HashSet<string> Keys => new(Entries.Keys);
 
-        public bool ShouldBeSerializedInline => Entries.Count < 4 && Entries.All(e => e.Value.Comments.ThereAreNoComments && (e.Value is TomlArray arr ? arr.IsSimpleArray : e.Value is not TomlTable));
+        public bool ShouldBeSerializedInline => Entries.Count < 4 
+                                                && Entries.All(e => !e.Key.Contains(" ") 
+                                                                    && e.Value.Comments.ThereAreNoComments 
+                                                                    && (e.Value is TomlArray arr ? arr.IsSimpleArray : e.Value is not TomlTable));
 
         public override string SerializedValue
         {

Tomlet.Tests/TestResources.resx

@@ -4,7 +4,7 @@
         <LangVersion>10</LangVersion>
         <Nullable>enable</Nullable>
         <PackageId>Samboy063.Tomlet</PackageId>
-        <Version>3.0.0</Version>
+        <Version>3.0.1</Version>
         <Authors>Sam Byass</Authors>
         <Company>N/A</Company>
         <PackageTags>toml</PackageTags>