chore: code review changes

Farfetch · Jun 22, 2024 · 7a09d74 · 7a09d74
1 parent 94662f4
commit 7a09d74
Show file tree

Hide file tree

Showing 8 changed files with 35 additions and 35 deletions.
diff --git a/...s.Framework.Rql/Pipeline/Scan/IScanner.cs → ...mework.Rql/Pipeline/Scan/ITokenScanner.cs b/...s.Framework.Rql/Pipeline/Scan/IScanner.cs → ...mework.Rql/Pipeline/Scan/ITokenScanner.cs
@@ -1,6 +1,6 @@
 namespace Rules.Framework.Rql.Pipeline.Scan
 {
-    internal interface IScanner
+    internal interface ITokenScanner
     {
         ScanResult ScanTokens(string source);
     }

diff --git a/src/Rules.Framework.Rql/Pipeline/Scan/ScanContext.cs b/src/Rules.Framework.Rql/Pipeline/Scan/ScanContext.cs
@@ -86,11 +86,11 @@ private void DiscardTokenCandidate()
             this.TokenCandidate = null;
         }
 
-        private bool Move(int toOffset)
+        private bool Move(int offset)
         {
-            if (toOffset >= 0 && toOffset < this.source.Length)
+            if (offset >= 0 && offset < this.source.Length)
             {
-                var toChar = this.source[toOffset];
+                var toChar = this.source[offset];
                 if (toChar == '\n')
                 {
                     this.NextLine();
@@ -100,7 +100,7 @@ private bool Move(int toOffset)
                     this.NextColumn();
                 }
 
-                this.Offset = toOffset;
+                this.Offset = offset;
                 return true;
             }
 

diff --git a/...es.Framework.Rql/Pipeline/Scan/Scanner.cs → ...amework.Rql/Pipeline/Scan/TokenScanner.cs b/...es.Framework.Rql/Pipeline/Scan/Scanner.cs → ...amework.Rql/Pipeline/Scan/TokenScanner.cs
@@ -7,7 +7,7 @@ namespace Rules.Framework.Rql.Pipeline.Scan
     using Rules.Framework.Rql.Messages;
     using Rules.Framework.Rql.Tokens;
 
-    internal class Scanner : IScanner
+    internal class TokenScanner : ITokenScanner
     {
         private const char DecimalSeparator = '.';
 

diff --git a/src/Rules.Framework.Rql/RqlEngine.cs b/src/Rules.Framework.Rql/RqlEngine.cs
@@ -17,11 +17,11 @@ internal class RqlEngine<TContentType, TConditionType> : IRqlEngine
         private bool disposedValue;
         private IInterpreter interpreter;
         private IParser parser;
-        private IScanner scanner;
+        private ITokenScanner tokenScanner;
 
         public RqlEngine(RqlEngineArgs rqlEngineArgs)
         {
-            this.scanner = rqlEngineArgs.Scanner;
+            this.tokenScanner = rqlEngineArgs.TokenScanner;
             this.parser = rqlEngineArgs.Parser;
             this.interpreter = rqlEngineArgs.Interpreter;
         }
@@ -34,7 +34,7 @@ public void Dispose()
 
         public async Task<IEnumerable<IResult>> ExecuteAsync(string rql)
         {
-            var scanResult = this.scanner.ScanTokens(rql);
+            var scanResult = this.tokenScanner.ScanTokens(rql);
             if (!scanResult.Success)
             {
                 var errors = scanResult.Messages.Where(m => m.Severity == MessageSeverity.Error)
@@ -73,7 +73,7 @@ protected virtual void Dispose(bool disposing)
                 if (disposing)
                 {
                     this.interpreter = null!;
-                    this.scanner = null!;
+                    this.tokenScanner = null!;
                     this.parser = null!;
                 }
 

diff --git a/src/Rules.Framework.Rql/RqlEngineArgs.cs b/src/Rules.Framework.Rql/RqlEngineArgs.cs
@@ -14,6 +14,6 @@ internal class RqlEngineArgs
 
         public IParser Parser { get; set; }
 
-        public IScanner Scanner { get; set; }
+        public ITokenScanner TokenScanner { get; set; }
     }
 }
diff --git a/src/Rules.Framework.Rql/RqlEngineBuilder.cs b/src/Rules.Framework.Rql/RqlEngineBuilder.cs
@@ -30,7 +30,7 @@ public static RqlEngineBuilder<TContentType, TConditionType> CreateRqlEngine(IRu
         public IRqlEngine Build()
         {
             var runtime = RqlRuntime<TContentType, TConditionType>.Create(this.rulesEngine);
-            var scanner = new Scanner();
+            var tokenScanner = new TokenScanner();
             var parseStrategyProvider = new ParseStrategyPool();
             var parser = new Parser(parseStrategyProvider);
             var reverseRqlBuilder = new ReverseRqlBuilder();
@@ -40,7 +40,7 @@ public IRqlEngine Build()
                 Interpreter = interpreter,
                 Options = this.options,
                 Parser = parser,
-                Scanner = scanner,
+                TokenScanner = tokenScanner,
             };
 
             return new RqlEngine<TContentType, TConditionType>(args);

diff --git a/tests/Rules.Framework.Rql.IntegrationTests/GrammarCheck/GrammarCheckTests.cs b/tests/Rules.Framework.Rql.IntegrationTests/GrammarCheck/GrammarCheckTests.cs
@@ -20,12 +20,12 @@ public class GrammarCheckTests
         ];
 
         private readonly IParser parser;
-        private readonly IScanner scanner;
         private readonly ITestOutputHelper testOutputHelper;
+        private readonly ITokenScanner tokenScanner;
 
         public GrammarCheckTests(ITestOutputHelper testOutputHelper)
         {
-            this.scanner = new Scanner();
+            this.tokenScanner = new TokenScanner();
             this.parser = new Parser(new ParseStrategyPool());
             this.testOutputHelper = testOutputHelper;
         }
@@ -111,7 +111,7 @@ public void CheckRqlGrammar(string rqlSource, bool expectsSuccess, IEnumerable<s
 
         private bool TryScanAndParse(string rqlSource, out IEnumerable<string> errorMessages)
         {
-            var scanResult = this.scanner.ScanTokens(rqlSource);
+            var scanResult = this.tokenScanner.ScanTokens(rqlSource);
             if (!scanResult.Success)
             {
                 errorMessages = scanResult.Messages.Select(x => x.Text).ToArray();

diff --git a/tests/Rules.Framework.Rql.Tests/RqlEngineTests.cs b/tests/Rules.Framework.Rql.Tests/RqlEngineTests.cs
@@ -22,18 +22,18 @@ public class RqlEngineTests
         private readonly IInterpreter interpreter;
         private readonly IParser parser;
         private readonly RqlEngine<ContentType, ConditionType> rqlEngine;
-        private readonly IScanner scanner;
+        private readonly ITokenScanner tokenScanner;
 
         public RqlEngineTests()
         {
-            this.scanner = Mock.Of<IScanner>();
+            this.tokenScanner = Mock.Of<ITokenScanner>();
             this.parser = Mock.Of<IParser>();
             this.interpreter = Mock.Of<IInterpreter>();
             var rqlEngineArgs = new RqlEngineArgs
             {
                 Interpreter = interpreter,
                 Parser = parser,
-                Scanner = scanner,
+                TokenScanner = tokenScanner,
             };
 
             this.rqlEngine = new RqlEngine<ContentType, ConditionType>(rqlEngineArgs);
@@ -103,7 +103,7 @@ public async Task ExecuteAsync_GivenRqlSourceCase1_InterpretsAndReturnsResult()
             interpretResult.AddStatementResult(new NothingStatementResult("MATCH ONE RULE FOR \"Test\" ON $2023-01-01Z$;"));
             interpretResult.AddStatementResult(new ExpressionStatementResult("MATCH ONE RULE FOR \"Other\\nTest\" ON $2024-01-01Z$;", rqlArray));
 
-            Mock.Get(this.scanner)
+            Mock.Get(this.tokenScanner)
                 .Setup(x => x.ScanTokens(It.Is(rql, StringComparer.Ordinal)))
                 .Returns(scanResult);
             Mock.Get(this.parser)
@@ -118,7 +118,7 @@ public async Task ExecuteAsync_GivenRqlSourceCase1_InterpretsAndReturnsResult()
 
             // Assert
             Mock.VerifyAll(
-                Mock.Get(this.scanner),
+                Mock.Get(this.tokenScanner),
                 Mock.Get(this.parser),
                 Mock.Get(this.interpreter));
 
@@ -172,7 +172,7 @@ public async Task ExecuteAsync_GivenRqlSourceCase2_InterpretsAndReturnsResult()
             var interpretResult = new InterpretResult();
             interpretResult.AddStatementResult(new ExpressionStatementResult(rql, rqlArray));
 
-            Mock.Get(this.scanner)
+            Mock.Get(this.tokenScanner)
                 .Setup(x => x.ScanTokens(It.Is(rql, StringComparer.Ordinal)))
                 .Returns(scanResult);
             Mock.Get(this.parser)
@@ -187,7 +187,7 @@ public async Task ExecuteAsync_GivenRqlSourceCase2_InterpretsAndReturnsResult()
 
             // Assert
             Mock.VerifyAll(
-                Mock.Get(this.scanner),
+                Mock.Get(this.tokenScanner),
                 Mock.Get(this.parser),
                 Mock.Get(this.interpreter));
 
@@ -237,7 +237,7 @@ public async Task ExecuteAsync_GivenRqlSourceCase3_InterpretsAndReturnsResult()
             var interpretResult = new InterpretResult();
             interpretResult.AddStatementResult(new ExpressionStatementResult(rql, rqlArray));
 
-            Mock.Get(this.scanner)
+            Mock.Get(this.tokenScanner)
                 .Setup(x => x.ScanTokens(It.Is(rql, StringComparer.Ordinal)))
                 .Returns(scanResult);
             Mock.Get(this.parser)
@@ -252,7 +252,7 @@ public async Task ExecuteAsync_GivenRqlSourceCase3_InterpretsAndReturnsResult()
 
             // Assert
             Mock.VerifyAll(
-                Mock.Get(this.scanner),
+                Mock.Get(this.tokenScanner),
                 Mock.Get(this.parser),
                 Mock.Get(this.interpreter));
 
@@ -294,7 +294,7 @@ public async Task ExecuteAsync_GivenRqlSourceCase4_InterpretsAndReturnsResult()
             var interpretResult = new InterpretResult();
             interpretResult.AddStatementResult(new ExpressionStatementResult(rql, rqlString));
 
-            Mock.Get(this.scanner)
+            Mock.Get(this.tokenScanner)
                 .Setup(x => x.ScanTokens(It.Is(rql, StringComparer.Ordinal)))
                 .Returns(scanResult);
             Mock.Get(this.parser)
@@ -309,7 +309,7 @@ public async Task ExecuteAsync_GivenRqlSourceCase4_InterpretsAndReturnsResult()
 
             // Assert
             Mock.VerifyAll(
-                Mock.Get(this.scanner),
+                Mock.Get(this.tokenScanner),
                 Mock.Get(this.parser),
                 Mock.Get(this.interpreter));
 
@@ -340,7 +340,7 @@ public async Task ExecuteAsync_GivenRqlSourceCase5HavingErrorsOnScanner_ThrowsRq
             };
             var scanResult = ScanResult.CreateError(messages);
 
-            Mock.Get(this.scanner)
+            Mock.Get(this.tokenScanner)
                 .Setup(x => x.ScanTokens(It.Is(rql, StringComparer.Ordinal)))
                 .Returns(scanResult);
 
@@ -349,7 +349,7 @@ public async Task ExecuteAsync_GivenRqlSourceCase5HavingErrorsOnScanner_ThrowsRq
 
             // Assert
             Mock.VerifyAll(
-                Mock.Get(this.scanner));
+                Mock.Get(this.tokenScanner));
 
             rqlException.Message.Should().Be("Errors have occurred processing provided RQL source - Sample scan error for source <unavailable> @{1:1}-{1:10}");
             rqlException.Errors.Should().HaveCount(1);
@@ -380,7 +380,7 @@ public async Task ExecuteAsync_GivenRqlSourceCase6HavingErrorsOnParser_ThrowsRql
             };
             var parseResult = ParseResult.CreateError(messages);
 
-            Mock.Get(this.scanner)
+            Mock.Get(this.tokenScanner)
                 .Setup(x => x.ScanTokens(It.Is(rql, StringComparer.Ordinal)))
                 .Returns(scanResult);
             Mock.Get(this.parser)
@@ -392,7 +392,7 @@ public async Task ExecuteAsync_GivenRqlSourceCase6HavingErrorsOnParser_ThrowsRql
 
             // Assert
             Mock.VerifyAll(
-                Mock.Get(this.scanner),
+                Mock.Get(this.tokenScanner),
                 Mock.Get(this.parser));
 
             rqlException.Message.Should().Be("Errors have occurred processing provided RQL source - Sample parse error for source <unavailable> @{1:1}-{1:10}");
@@ -427,7 +427,7 @@ public async Task ExecuteAsync_GivenRqlSourceCase7HavingErrorsOnInterpreter_Thro
             var interpretResult = new InterpretResult();
             interpretResult.AddStatementResult(new ErrorStatementResult("Sample interpret error", rql, RqlSourcePosition.From(1, 1), RqlSourcePosition.From(1, 10)));
 
-            Mock.Get(this.scanner)
+            Mock.Get(this.tokenScanner)
                 .Setup(x => x.ScanTokens(It.Is(rql, StringComparer.Ordinal)))
                 .Returns(scanResult);
             Mock.Get(this.parser)
@@ -442,7 +442,7 @@ public async Task ExecuteAsync_GivenRqlSourceCase7HavingErrorsOnInterpreter_Thro
 
             // Assert
             Mock.VerifyAll(
-                Mock.Get(this.scanner),
+                Mock.Get(this.tokenScanner),
                 Mock.Get(this.parser),
                 Mock.Get(this.interpreter));
 
@@ -478,7 +478,7 @@ public async Task ExecuteAsync_GivenRqlSourceCase8HavingUnknownResultType_Throws
             var interpretResult = new InterpretResult();
             interpretResult.AddStatementResult(new StubResult());
 
-            Mock.Get(this.scanner)
+            Mock.Get(this.tokenScanner)
                 .Setup(x => x.ScanTokens(It.Is(rql, StringComparer.Ordinal)))
                 .Returns(scanResult);
             Mock.Get(this.parser)
@@ -493,7 +493,7 @@ public async Task ExecuteAsync_GivenRqlSourceCase8HavingUnknownResultType_Throws
 
             // Assert
             Mock.VerifyAll(
-                Mock.Get(this.scanner),
+                Mock.Get(this.tokenScanner),
                 Mock.Get(this.parser),
                 Mock.Get(this.interpreter));