diff --git a/CSTNet.Tests/BasicTests.cs b/CSTNet.Tests/BasicTests.cs new file mode 100644 index 0000000..5c31184 --- /dev/null +++ b/CSTNet.Tests/BasicTests.cs @@ -0,0 +1,40 @@ +// This project is licensed under the MIT license. +using System; +using System.IO; +using Xunit; + +namespace CSTNet.Tests +{ + public class BasicTests + { + string CSTFile(string cst, string key) + { + var path = Path.Combine(AppContext.BaseDirectory, cst); + var file = File.ReadAllText(path); + + return CaretSeparatedText.Parse(file, key); + } + + [Theory] + [InlineData(1, "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin ac dictum orci, at tincidunt nulla. Donec aliquet, eros non interdum posuere, ipsum sapien molestie nunc, nec facilisis libero ipsum et risus. In sed lorem vel ipsum placerat viverra.")] + [InlineData(4, @"Lorem ipsum dolor sit amet, consectetur adipiscing elit. Fusce justo dui, rhoncus a pulvinar sit amet, fermentum vitae lorem. Maecenas nec nisi sit amet eros rutrum congue. In sagittis suscipit arcu, ac vestibulum nunc feugiat volutpat. + +Vivamus consequat velit dui, sit amet rhoncus dui malesuada a. Maecenas hendrerit commodo mi et scelerisque. Cras pharetra ultrices aliquam. Praesent ac efficitur magna, vitae scelerisque metus.")] + public void V1Test(int key, string expected) + { + var actual = CSTFile("v1.cst", key.ToString()); + Assert.Equal(expected, actual); + } + + [Theory] + [InlineData("Singleline", "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed ultricies nulla eu tortor mattis, dictum posuere lacus ornare. Maecenas a massa in ligula finibus luctus eu vitae nibh. Proin imperdiet dapibus mauris quis placerat.")] + [InlineData("Multiline", @"Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nunc gravida nunc non justo pretium consectetur. Sed tempus libero ac ligula aliquam elementum. Duis vitae interdum leo. Sed semper nulla %1 a lectus dictum dictum. + +Quisque vehicula, nisi ut scelerisque sodales, nisi ipsum sodales ipsum, in rutrum tellus lacus sed nibh. Etiam mauris velit, elementum sed placerat et, elementum et tellus. Duis vitae elit fermentum, viverra lorem in, lobortis elit.")] + public void V2Test(string key, string expected) + { + var actual = CSTFile("v2.cst", key); + Assert.Equal(expected, actual); + } + } +} diff --git a/CSTNet.Tests/CSTNet.Tests.csproj b/CSTNet.Tests/CSTNet.Tests.csproj index 26f8893..b638f32 100644 --- a/CSTNet.Tests/CSTNet.Tests.csproj +++ b/CSTNet.Tests/CSTNet.Tests.csproj @@ -23,4 +23,13 @@ + + + PreserveNewest + + + PreserveNewest + + + diff --git a/CSTNet.Tests/UnitTest1.cs b/CSTNet.Tests/UnitTest1.cs deleted file mode 100644 index 6e87204..0000000 --- a/CSTNet.Tests/UnitTest1.cs +++ /dev/null @@ -1,17 +0,0 @@ -// This project is licensed under the MIT license. -using Xunit; - -namespace CSTNet.Tests -{ - // - public class UnitTest1 - { - [Fact] - public void Test1() - { - /*var file = File.ReadAllText("example.cst"); - var example = CaretSeparatedText.Parse(file, 1); - Console.WriteLine(example);*/ - } - } -} diff --git a/CSTNet.Tests/v1.cst b/CSTNet.Tests/v1.cst new file mode 100644 index 0000000..23de77a --- /dev/null +++ b/CSTNet.Tests/v1.cst @@ -0,0 +1,8 @@ +1 ^Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin ac dictum orci, at tincidunt nulla. Donec aliquet, eros non interdum posuere, ipsum sapien molestie nunc, nec facilisis libero ipsum et risus. In sed lorem vel ipsum placerat viverra.^ +2 ^Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nunc pharetra nunc nec erat finibus efficitur. Duis non ullamcorper purus. Donec sit amet ultricies sapien. Sed lacinia sem eu nunc gravida, vitae tincidunt eros tempus. Quisque nibh est, tempus sit amet purus at, facilisis cursus ante. Nam nisi purus, vehicula sed magna ac, lobortis aliquam urna. Sed condimentum, felis a placerat tincidunt, est augue pulvinar turpis, eu dictum leo diam quis mi. Nulla non efficitur neque, sed efficitur orci. Aliquam quis libero consequat, convallis tortor sit amet, varius orci. + +Orci varius natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Nunc vel dictum eros, vitae mattis risus. Curabitur eget nisi interdum, euismod nisl in, fermentum turpis. Morbi a feugiat lacus. Duis ligula felis, commodo quis sodales ac, congue sit amet tortor. Sed vulputate, velit id interdum convallis, purus nisl interdum lorem, sit amet aliquam lacus sapien ac neque. Proin sit amet ultricies mi.^ +3 ^Lorem ipsum dolor sit amet, consectetur adipiscing elit. Aliquam venenatis ac odio ut pretium. Interdum et malesuada fames ac ante ipsum primis in faucibus. Donec semper turpis tempor, bibendum sapien at, blandit neque. Vivamus hendrerit imperdiet elit, vel sollicitudin nulla luctus vel. Vivamus nisl quam, feugiat a diam aliquam, iaculis vestibulum nunc. Maecenas euismod leo enim, faucibus ultrices ipsum semper eu. Praesent ullamcorper justo at maximus ultricies.^ +4^Lorem ipsum dolor sit amet, consectetur adipiscing elit. Fusce justo dui, rhoncus a pulvinar sit amet, fermentum vitae lorem. Maecenas nec nisi sit amet eros rutrum congue. In sagittis suscipit arcu, ac vestibulum nunc feugiat volutpat. + +Vivamus consequat velit dui, sit amet rhoncus dui malesuada a. Maecenas hendrerit commodo mi et scelerisque. Cras pharetra ultrices aliquam. Praesent ac efficitur magna, vitae scelerisque metus.^ \ No newline at end of file diff --git a/CSTNet.Tests/v2.cst b/CSTNet.Tests/v2.cst new file mode 100644 index 0000000..773bc88 --- /dev/null +++ b/CSTNet.Tests/v2.cst @@ -0,0 +1,4 @@ +Singleline^Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed ultricies nulla eu tortor mattis, dictum posuere lacus ornare. Maecenas a massa in ligula finibus luctus eu vitae nibh. Proin imperdiet dapibus mauris quis placerat.^ +Multiline ^Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nunc gravida nunc non justo pretium consectetur. Sed tempus libero ac ligula aliquam elementum. Duis vitae interdum leo. Sed semper nulla %1 a lectus dictum dictum. + +Quisque vehicula, nisi ut scelerisque sodales, nisi ipsum sodales ipsum, in rutrum tellus lacus sed nibh. Etiam mauris velit, elementum sed placerat et, elementum et tellus. Duis vitae elit fermentum, viverra lorem in, lobortis elit.^ \ No newline at end of file diff --git a/CSTNet/CSTNet.csproj b/CSTNet/CSTNet.csproj index 412a1ba..eba62fb 100644 --- a/CSTNet/CSTNet.csproj +++ b/CSTNet/CSTNet.csproj @@ -3,7 +3,11 @@ netstandard2.0 1.0-rc1 - Caret-Separated Text (or CST) is a key-value pair format represented by numbers or words as keys and the value is the string enclosed between carets (^) that contains the contents. CST.NET is a library for prasing the CST format. + Tony Bark + Caret-Separated Text (or CST) is a key-value pair format represented by numbers or words as keys and the value is the string enclosed between carets (^) that contains the contents. CST.NET is a library for prasing the CST format. + https://github.com/tonytins/cstnet + true + CST.Net diff --git a/README.md b/README.md index 9dfc897..187ed33 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ Caret-Separated Text (or CST) is a key-value pair format represented by numbers or words as keys and the value is the string enclosed between carets (^) that contains the contents. CST.NET is a library for parsing the CST format. -## Example +## Usage ```csharp using System; @@ -17,6 +17,13 @@ var example = CaretSeparatedText.Parse(file, 1); Console.WriteLine(example); ``` +In production, CST files were used in The Sims Online to provide translations. Each translation was split into their respective directories: + +- ``en/hints/toolbar.cst`` +- ``sv/hints/toolbar.cst`` + +As long as the key remained the same, it didn't matter what directory the file was located in. + ## To-do - [ ] Support for arguments (e.g. ``%1``)