Added IBlockDocumentItem and BlockDocumentItemBase for Block documents

Added Properties for ITokenOptions to allow custom name/value pairs to be stored from Tags & Blocks(Opening and Closing) #16 Fixed Fixed Logging formatter NREX
JPVenson · Jan 3, 2021 · c792738 · c792738
1 parent c1f9495
commit c792738
Show file tree

Hide file tree

Showing 63 changed files with 1,230 additions and 605 deletions.
diff --git a/Morestachio.LessCompiler/CompileLessDocumentItem.cs b/Morestachio.LessCompiler/CompileLessDocumentItem.cs
@@ -1,4 +1,5 @@
 using System;
+using System.Collections.Generic;
 using System.Linq;
 using System.Runtime.Serialization;
 using dotless.Core;
@@ -11,6 +12,7 @@
 using Morestachio.Framework;
 using Morestachio.Framework.Context;
 using Morestachio.Framework.IO;
+using Morestachio.Framework.Tokenizing;
 #if ValueTask
 using ItemExecutionPromise = System.Threading.Tasks.ValueTask<System.Collections.Generic.IEnumerable<Morestachio.Document.Contracts.DocumentItemExecution>>;
 using Promise = System.Threading.Tasks.ValueTask;
@@ -25,14 +27,15 @@ namespace Morestachio.LessCompiler
 	///		Wraps the dotless into an Document provider 
 	/// </summary>
 	[Serializable]
-	public class CompileLessDocumentItem : DocumentItemBase, ToParsableStringDocumentVisitor.IStringVisitor
+	public class CompileLessDocumentItem : BlockDocumentItemBase, ToParsableStringDocumentVisitor.IStringVisitor
 	{
-		internal CompileLessDocumentItem() : base(CharacterLocation.Unknown)
+		internal CompileLessDocumentItem() : base(CharacterLocation.Unknown, null)
 		{
 
 		}
 
-		public CompileLessDocumentItem(CharacterLocation location) : base(location)
+		public CompileLessDocumentItem(CharacterLocation location, IEnumerable<ITokenOption> tagTokenOptions) 
+			: base(location, tagTokenOptions)
 		{
 
 		}

diff --git a/Morestachio.LessCompiler/LessCompilerDocumentItemProvider.cs b/Morestachio.LessCompiler/LessCompilerDocumentItemProvider.cs
@@ -1,4 +1,5 @@
-using JetBrains.Annotations;
+using System.Collections.Generic;
+using JetBrains.Annotations;
 using Morestachio.Document.Contracts;
 using Morestachio.Document.Custom;
 using Morestachio.Framework.Tokenizing;
@@ -15,9 +16,9 @@ public LessCompilerDocumentItemProvider() : base("#Less", "/Less")
 		}
 
 		/// <inheritdoc />
-		public override IDocumentItem CreateDocumentItem(string tag, string value, TokenPair token, ParserOptions options)
+		public override IDocumentItem CreateDocumentItem(string tag, string value, TokenPair token, ParserOptions options, IEnumerable<ITokenOption> tagTokenOptions)
 		{
-			return new CompileLessDocumentItem(token.TokenLocation);
+			return new CompileLessDocumentItem(token.TokenLocation, tagTokenOptions);
 		}
 	}
 }
diff --git a/Morestachio.Tests/ParserFixture.cs b/Morestachio.Tests/ParserFixture.cs
@@ -18,6 +18,7 @@
 using Morestachio.Document.Visitor;
 using Morestachio.Formatter.Framework.Attributes;
 using Morestachio.Framework;
+using Morestachio.Framework.Context.Options;
 using Morestachio.Framework.Error;
 using Morestachio.Framework.Expression;
 using Morestachio.Framework.Expression.Framework;
@@ -113,9 +114,18 @@ public static void TestLocationsInOrder(MorestachioDocumentInfo documentInfo)
 
 			while (api.Context.OperationStatus)
 			{
-				if (api.Context.CurrentNode.Item is TextEditDocumentItem || api.Context.CurrentNode.Item is RemoveAliasDocumentItem)
+				if (api.Context.CurrentNode.Item is TextEditDocumentItem txtEdit)
 				{
-					Assert.That(api.Context.CurrentNode.Item.ExpressionStart, Is.GreaterThan(lastLocation).Or.EqualTo(lastLocation));
+					if (txtEdit.EmbeddedInstructionOrigin != EmbeddedInstructionOrigin.Self)
+					{
+						api.SearchForward(f => true, false);
+						continue;
+					}
+				}
+
+				if (api.Context.CurrentNode.Item is RemoveAliasDocumentItem)
+				{
+					Assert.That(api.Context.CurrentNode.Item.ExpressionStart, Is.GreaterThan(lastLocation), () => "");
 				}
 				else
 				{
@@ -461,22 +471,22 @@ public async Task ParserCanVariableSetToOtherVariable()
 		public async Task ParserCanVariableScope()
 		{
 			var template =
-				@"{{#VAR global = data |-}}
-{{#data |-}}
-		{{global |-}}
-		{{#LET global = 'Burns ' |-}}
-		{{global |-}}
-		{{#LET global = 'Likes ' |-}}
-		{{global |-}}
-		{{#LET local = 'Likes ' |-}}
-		{{#VAR global = 'Miss ' |-}}
-{{/data |-}}
-{{local |-}}
-{{global |-}}
-{{#VAR global = 'Money ' |-}}
-{{global |-}}
-{{#LET global = 'Alot' |-}}
-{{global |-}}";
+				@"{{#VAR global = data |--}}
+{{#data |--}}
+		{{global |--}}
+		{{#LET global = 'Burns ' |--}}
+		{{global |--}}
+		{{#LET global = 'Likes ' |--}}
+		{{global |--}}
+		{{#LET local = 'Likes ' |--}}
+		{{#VAR global = 'Miss ' |--}}
+{{/data |--}}
+{{local |--}}
+{{global |--}}
+{{#VAR global = 'Money ' |--}}
+{{global |--}}
+{{#LET global = 'Alot' |--}}
+{{global |--}}";
 			var data = new Dictionary<string, object>
 			{
 				{ "data", "Mr " },
@@ -1745,8 +1755,8 @@ public async Task TestRepeatLoopContext()
 		[Test]
 		public async Task TestWhileLoopContext()
 		{
-			var template = @"{{#WHILE $index.SmallerAs(5) |-}}
-						   {{$index}},
+			var template = @"{{#WHILE $index.SmallerAs(5)}}
+						   {{-| $index}},
 						   {{-| /WHILE}}";
 			var data = new Dictionary<string, object> { };
 
@@ -1793,10 +1803,10 @@ public async Task TestCanRemoveLineBreaks()
 		[Test]
 		public async Task TestCanRemoveLineBreaksWithinKeyword()
 		{
-			var template = @"{{data |-}}
+			var template = @"{{data |--}}
 Static
 
-{{-| data}}";
+{{--| data}}";
 			var data = new
 			{
 				data = "World"
@@ -1815,7 +1825,6 @@ public async Task TestCanRemoveLineBreaksWithOption()
 			var template = @"{{#SET OPTION TrimTailing = true}}{{#SET OPTION TrimLeading = true}}
 {{data}}
 Static
-
 {{data}}";
 			var data = new
 			{

diff --git a/Morestachio.Tests/SerilalizerTests/SerializerTest.cs b/Morestachio.Tests/SerilalizerTests/SerializerTest.cs
@@ -3,6 +3,7 @@
 using Morestachio.Document.Items;
 using Morestachio.Document.Visitor;
 using Morestachio.Framework;
+using Morestachio.Framework.Tokenizing;
 using Morestachio.Helper.Localization;
 using Morestachio.TemplateContainers;
 using Morestachio.Tests.SerilalizerTests.Strategies;
@@ -264,7 +265,7 @@ public void TestLocIsSerializable()
 		[Test]
 		public void Alias()
 		{
-			var alias = new AliasDocumentItem(CharacterLocation.Unknown, "Alias", 101);
+			var alias = new AliasDocumentItem(CharacterLocation.Unknown, "Alias", 101, null);
 			SerilalizeAndDeserialize(alias);
 		}
 	}

diff --git a/Morestachio/Document/Contracts/IBlockDocumentItem.cs b/Morestachio/Document/Contracts/IBlockDocumentItem.cs
@@ -0,0 +1,26 @@
+using System.Collections.Generic;
+using Morestachio.Framework.Tokenizing;
+
+namespace Morestachio.Document.Contracts
+{
+	/// <summary>
+	///		Defines a part that can store itself and children
+	/// </summary>
+	public interface IBlockDocumentItem : IDocumentItem
+	{
+		/// <summary>
+		///		The list of Children that are children of this Document item
+		/// </summary>
+		IList<IDocumentItem> Children { get; }
+
+		/// <summary>
+		///		The token options set on a closing tag of an block
+		/// </summary>
+		IEnumerable<ITokenOption> BlockClosingOptions { get; set; }
+
+		/// <summary>
+		///		Adds the specified childs.
+		/// </summary>
+		void Add(params IDocumentItem[] documentChildren);
+	}
+}
diff --git a/Morestachio/Document/Contracts/IDocumentItem.cs b/Morestachio/Document/Contracts/IDocumentItem.cs
@@ -4,6 +4,7 @@
 using Morestachio.Framework;
 using Morestachio.Framework.Context;
 using Morestachio.Framework.IO;
+using Morestachio.Framework.Tokenizing;
 #if ValueTask
 using ItemExecutionPromise = System.Threading.Tasks.ValueTask<System.Collections.Generic.IEnumerable<Morestachio.Document.Contracts.DocumentItemExecution>>;
 using Promise = System.Threading.Tasks.ValueTask;
@@ -30,16 +31,10 @@ public interface IDocumentItem
 		ItemExecutionPromise Render(IByteCounterStream outputStream, ContextObject context,
 			ScopeData scopeData);
 
-
 		/// <summary>
-		///		The list of Children that are children of this Document item
+		///		Contains the list of TokenOptions used to construct this DocumentItem.
 		/// </summary>
-		IList<IDocumentItem> Children { get; }
-
-		/// <summary>
-		///		Adds the specified childs.
-		/// </summary>
-		void Add(params IDocumentItem[] documentChildren);
+		IEnumerable<ITokenOption> TagCreationOptions { get; }
 
 		/// <summary>
 		///		If this is a Natural Document item this defines the Position within the Template where the DocumentItem is parsed from

diff --git a/Morestachio/Document/Custom/BlockDocumentItemProvider.cs b/Morestachio/Document/Custom/BlockDocumentItemProvider.cs
@@ -1,4 +1,5 @@
-using Morestachio.Document.Contracts;
+using System.Collections.Generic;
+using Morestachio.Document.Contracts;
 using Morestachio.Document.Items.Base;
 using Morestachio.Document.Visitor;
 using Morestachio.Framework;
@@ -43,15 +44,16 @@ public class BlockDocumentItem : ValueDocumentItemBase
 			/// <summary>
 			/// 
 			/// </summary>
-			public BlockDocumentItem() : base(CharacterLocation.Unknown, null)
+			public BlockDocumentItem()
 			{
 
 			}
 
 			/// <inheritdoc />
 			public BlockDocumentItem(CharacterLocation location, 
 				BlockDocumentProviderFunction action, 
-				string value) : base(location, value)
+				string value,
+				IEnumerable<ITokenOption> tagCreationOptions) : base(location, value, tagCreationOptions)
 			{
 				_action = action;
 			}
@@ -71,9 +73,10 @@ public override void Accept(IDocumentItemVisitor visitor)
 		}
 
 		/// <inheritdoc />
-		public override IDocumentItem CreateDocumentItem(string tag, string value, TokenPair token, ParserOptions options)
+		public override IDocumentItem CreateDocumentItem(string tag, string value, TokenPair token,
+			ParserOptions options, IEnumerable<ITokenOption> tagCreationOptions)
 		{
-			return new BlockDocumentItem(token.TokenLocation, _action, value);
+			return new BlockDocumentItem(token.TokenLocation, _action, value, tagCreationOptions);
 		}
 	}
 }
diff --git a/Morestachio/Document/Custom/BlockDocumentItemProviderBase.cs b/Morestachio/Document/Custom/BlockDocumentItemProviderBase.cs
@@ -36,7 +36,8 @@ protected BlockDocumentItemProviderBase(string tagOpen, string tagClose)
 		/// <summary>
 		///		Will be called to produce an Document item that must be executed
 		/// </summary>
-		public abstract IDocumentItem CreateDocumentItem(string tag, string value, TokenPair token, ParserOptions options);
+		public abstract IDocumentItem CreateDocumentItem(string tag, string value, TokenPair token,
+			ParserOptions options, IEnumerable<ITokenOption> tagCreationOptions);
 
 		/// <inheritdoc />
 		public override IEnumerable<TokenPair> Tokenize(TokenInfo token, ParserOptions options)
@@ -53,20 +54,20 @@ public override IEnumerable<TokenPair> Tokenize(TokenInfo token, ParserOptions o
 		}
 
 		/// <inheritdoc />
-		public override bool ShouldParse(TokenPair token, ParserOptions options)
+		public override bool ShouldParse(TokenPair token, ParserOptions options, IEnumerable<ITokenOption> tagCreationOptions)
 		{
 			return token.Type.Equals(TagOpen.Trim()) || token.Type.Equals(TagClose);
 		}
 
 		/// <inheritdoc />
 		public override IDocumentItem Parse(TokenPair token, ParserOptions options, Stack<DocumentScope> buildStack,
-			Func<int> getScope)
+			Func<int> getScope, IEnumerable<ITokenOption> tagCreationOptions)
 		{
 			if (Equals(token.Type, TagOpen.Trim()))
 			{
 				var tagDocumentItem = CreateDocumentItem(TagOpen, 
 					token.Value?.Remove(0, TagOpen.Length).Trim(),
-					token, options);
+					token, options, tagCreationOptions);
 				buildStack.Push(new DocumentScope(tagDocumentItem, getScope));
 				return tagDocumentItem;
 			}

diff --git a/Morestachio/Document/Custom/CustomDocumentItemProvider.cs b/Morestachio/Document/Custom/CustomDocumentItemProvider.cs
@@ -31,13 +31,13 @@ protected CustomDocumentItemProvider()
 		/// </summary>
 		public class TokenInfo
 		{
-
 			internal TokenInfo(string token,
 				TokenzierContext context,
-				Stack<Tokenizer.ScopeStackItem> scopeStack)
+				Stack<Tokenizer.ScopeStackItem> scopeStack, IList<ITokenOption> tokenOptions)
 			{
 				TokenizerContext = context;
 				ScopeStack = scopeStack;
+				TokenOptions = tokenOptions;
 				Token = token;
 				Errors = new List<IMorestachioError>();
 			}
@@ -52,6 +52,11 @@ internal TokenInfo(string token,
 			/// </summary>
 			public Stack<Tokenizer.ScopeStackItem> ScopeStack { get; }
 
+			/// <summary>
+			///		Contains the list of Options that are determend outside of the processing of this token
+			/// </summary>
+			public IList<ITokenOption> TokenOptions { get; }
+
 			/// <summary>
 			///		The obtained Token. This is the Full text token
 			/// </summary>
@@ -78,13 +83,14 @@ internal TokenInfo(string token,
 		/// <returns></returns>
 		public abstract IEnumerable<TokenPair> Tokenize(TokenInfo token, ParserOptions options);
 
-		/// <summary>
-		///		Should return True if the Token is produced by this provider and should be parsed with this provider
-		/// </summary>
-		/// <param name="token"></param>
-		/// <param name="options"></param>
-		/// <returns></returns>
-		public abstract bool ShouldParse(TokenPair token, ParserOptions options);
+		///  <summary>
+		/// 		Should return True if the Token is produced by this provider and should be parsed with this provider
+		///  </summary>
+		///  <param name="token"></param>
+		///  <param name="options"></param>
+		///  <param name="tokenOptions"></param>
+		///  <returns></returns>
+		public abstract bool ShouldParse(TokenPair token, ParserOptions options, IEnumerable<ITokenOption> tokenOptions);
 
 		///  <summary>
 		/// 		Should return an document item that will be invoked when parsing the Template
@@ -93,8 +99,9 @@ internal TokenInfo(string token,
 		///  <param name="options"></param>
 		///  <param name="buildStack"></param>
 		///  <param name="getScope"></param>
+		///  <param name="tokenOptions"></param>
 		///  <returns></returns>
 		public abstract IDocumentItem Parse(TokenPair token, ParserOptions options, Stack<DocumentScope> buildStack,
-			Func<int> getScope);
+			Func<int> getScope, IEnumerable<ITokenOption> tokenOptions);
 	}
 }
diff --git a/Morestachio/Document/Custom/TagDocumentItemProvider.cs b/Morestachio/Document/Custom/TagDocumentItemProvider.cs
@@ -1,4 +1,5 @@
 using System;
+using System.Collections.Generic;
 using Morestachio.Document.Contracts;
 using Morestachio.Document.Items.Base;
 using Morestachio.Document.Visitor;
@@ -40,15 +41,16 @@ public class TagDocumentItem : ValueDocumentItemBase
 			private readonly TagDocumentProviderFunction _action;
 
 			/// <inheritdoc />
-			public TagDocumentItem() : base(CharacterLocation.Unknown, null)
+			public TagDocumentItem()
 			{
 
 			}
 
 			/// <inheritdoc />
 			public TagDocumentItem(CharacterLocation location,
 				TagDocumentProviderFunction action, 
-				string value) : base(location, value)
+				string value,
+				IEnumerable<ITokenOption> tagCreationOptions) : base(location, value, tagCreationOptions)
 			{
 				_action = action;
 			}
@@ -68,9 +70,10 @@ public override void Accept(IDocumentItemVisitor visitor)
 		}
 
 		/// <inheritdoc />
-		public override IDocumentItem CreateDocumentItem(string tag, string value, TokenPair token, ParserOptions options)
+		public override IDocumentItem CreateDocumentItem(string tag, string value, TokenPair token,
+			ParserOptions options, IEnumerable<ITokenOption> tagCreationOptions)
 		{
-			return new TagDocumentItem(token.TokenLocation, _action, value);
+			return new TagDocumentItem(token.TokenLocation, _action, value, tagCreationOptions);
 		}
 	}
 }