Skip to content

Commit 7a09d74

Browse files
luispfgarcesluispfgarces
committed
chore: code review changes
1 parent 94662f4 commit 7a09d74

File tree

8 files changed

+35
-35
lines changed

8 files changed

+35
-35
lines changed

src/Rules.Framework.Rql/Pipeline/Scan/IScanner.cs renamed to src/Rules.Framework.Rql/Pipeline/Scan/ITokenScanner.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
namespace Rules.Framework.Rql.Pipeline.Scan
22
{
3-
internal interface IScanner
3+
internal interface ITokenScanner
44
{
55
ScanResult ScanTokens(string source);
66
}

‎src/Rules.Framework.Rql/Pipeline/Scan/ScanContext.cs‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -86,11 +86,11 @@ private void DiscardTokenCandidate()
8686
this.TokenCandidate = null;
8787
}
8888

89-
private bool Move(int toOffset)
89+
private bool Move(int offset)
9090
{
91-
if (toOffset >= 0 && toOffset < this.source.Length)
91+
if (offset >= 0 && offset < this.source.Length)
9292
{
93-
var toChar = this.source[toOffset];
93+
var toChar = this.source[offset];
9494
if (toChar == '\n')
9595
{
9696
this.NextLine();
@@ -100,7 +100,7 @@ private bool Move(int toOffset)
100100
this.NextColumn();
101101
}
102102

103-
this.Offset = toOffset;
103+
this.Offset = offset;
104104
return true;
105105
}
106106

src/Rules.Framework.Rql/Pipeline/Scan/Scanner.cs renamed to src/Rules.Framework.Rql/Pipeline/Scan/TokenScanner.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ namespace Rules.Framework.Rql.Pipeline.Scan
77
using Rules.Framework.Rql.Messages;
88
using Rules.Framework.Rql.Tokens;
99

10-
internal class Scanner : IScanner
10+
internal class TokenScanner : ITokenScanner
1111
{
1212
private const char DecimalSeparator = '.';
1313

‎src/Rules.Framework.Rql/RqlEngine.cs‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -17,11 +17,11 @@ internal class RqlEngine<TContentType, TConditionType> : IRqlEngine
1717
private bool disposedValue;
1818
private IInterpreter interpreter;
1919
private IParser parser;
20-
private IScanner scanner;
20+
private ITokenScanner tokenScanner;
2121

2222
public RqlEngine(RqlEngineArgs rqlEngineArgs)
2323
{
24-
this.scanner = rqlEngineArgs.Scanner;
24+
this.tokenScanner = rqlEngineArgs.TokenScanner;
2525
this.parser = rqlEngineArgs.Parser;
2626
this.interpreter = rqlEngineArgs.Interpreter;
2727
}
@@ -34,7 +34,7 @@ public void Dispose()
3434

3535
public async Task<IEnumerable<IResult>> ExecuteAsync(string rql)
3636
{
37-
var scanResult = this.scanner.ScanTokens(rql);
37+
var scanResult = this.tokenScanner.ScanTokens(rql);
3838
if (!scanResult.Success)
3939
{
4040
var errors = scanResult.Messages.Where(m => m.Severity == MessageSeverity.Error)
@@ -73,7 +73,7 @@ protected virtual void Dispose(bool disposing)
7373
if (disposing)
7474
{
7575
this.interpreter = null!;
76-
this.scanner = null!;
76+
this.tokenScanner = null!;
7777
this.parser = null!;
7878
}
7979

‎src/Rules.Framework.Rql/RqlEngineArgs.cs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,6 @@ internal class RqlEngineArgs
1414

1515
public IParser Parser { get; set; }
1616

17-
public IScanner Scanner { get; set; }
17+
public ITokenScanner TokenScanner { get; set; }
1818
}
1919
}

‎src/Rules.Framework.Rql/RqlEngineBuilder.cs‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ public static RqlEngineBuilder<TContentType, TConditionType> CreateRqlEngine(IRu
3030
public IRqlEngine Build()
3131
{
3232
var runtime = RqlRuntime<TContentType, TConditionType>.Create(this.rulesEngine);
33-
var scanner = new Scanner();
33+
var tokenScanner = new TokenScanner();
3434
var parseStrategyProvider = new ParseStrategyPool();
3535
var parser = new Parser(parseStrategyProvider);
3636
var reverseRqlBuilder = new ReverseRqlBuilder();
@@ -40,7 +40,7 @@ public IRqlEngine Build()
4040
Interpreter = interpreter,
4141
Options = this.options,
4242
Parser = parser,
43-
Scanner = scanner,
43+
TokenScanner = tokenScanner,
4444
};
4545

4646
return new RqlEngine<TContentType, TConditionType>(args);

‎tests/Rules.Framework.Rql.IntegrationTests/GrammarCheck/GrammarCheckTests.cs‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,12 +20,12 @@ public class GrammarCheckTests
2020
];
2121

2222
private readonly IParser parser;
23-
private readonly IScanner scanner;
2423
private readonly ITestOutputHelper testOutputHelper;
24+
private readonly ITokenScanner tokenScanner;
2525

2626
public GrammarCheckTests(ITestOutputHelper testOutputHelper)
2727
{
28-
this.scanner = new Scanner();
28+
this.tokenScanner = new TokenScanner();
2929
this.parser = new Parser(new ParseStrategyPool());
3030
this.testOutputHelper = testOutputHelper;
3131
}
@@ -111,7 +111,7 @@ public void CheckRqlGrammar(string rqlSource, bool expectsSuccess, IEnumerable<s
111111

112112
private bool TryScanAndParse(string rqlSource, out IEnumerable<string> errorMessages)
113113
{
114-
var scanResult = this.scanner.ScanTokens(rqlSource);
114+
var scanResult = this.tokenScanner.ScanTokens(rqlSource);
115115
if (!scanResult.Success)
116116
{
117117
errorMessages = scanResult.Messages.Select(x => x.Text).ToArray();

‎tests/Rules.Framework.Rql.Tests/RqlEngineTests.cs‎

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -22,18 +22,18 @@ public class RqlEngineTests
2222
private readonly IInterpreter interpreter;
2323
private readonly IParser parser;
2424
private readonly RqlEngine<ContentType, ConditionType> rqlEngine;
25-
private readonly IScanner scanner;
25+
private readonly ITokenScanner tokenScanner;
2626

2727
public RqlEngineTests()
2828
{
29-
this.scanner = Mock.Of<IScanner>();
29+
this.tokenScanner = Mock.Of<ITokenScanner>();
3030
this.parser = Mock.Of<IParser>();
3131
this.interpreter = Mock.Of<IInterpreter>();
3232
var rqlEngineArgs = new RqlEngineArgs
3333
{
3434
Interpreter = interpreter,
3535
Parser = parser,
36-
Scanner = scanner,
36+
TokenScanner = tokenScanner,
3737
};
3838

3939
this.rqlEngine = new RqlEngine<ContentType, ConditionType>(rqlEngineArgs);
@@ -103,7 +103,7 @@ public async Task ExecuteAsync_GivenRqlSourceCase1_InterpretsAndReturnsResult()
103103
interpretResult.AddStatementResult(new NothingStatementResult("MATCH ONE RULE FOR \"Test\" ON $2023-01-01Z$;"));
104104
interpretResult.AddStatementResult(new ExpressionStatementResult("MATCH ONE RULE FOR \"Other\\nTest\" ON $2024-01-01Z$;", rqlArray));
105105

106-
Mock.Get(this.scanner)
106+
Mock.Get(this.tokenScanner)
107107
.Setup(x => x.ScanTokens(It.Is(rql, StringComparer.Ordinal)))
108108
.Returns(scanResult);
109109
Mock.Get(this.parser)
@@ -118,7 +118,7 @@ public async Task ExecuteAsync_GivenRqlSourceCase1_InterpretsAndReturnsResult()
118118

119119
// Assert
120120
Mock.VerifyAll(
121-
Mock.Get(this.scanner),
121+
Mock.Get(this.tokenScanner),
122122
Mock.Get(this.parser),
123123
Mock.Get(this.interpreter));
124124

@@ -172,7 +172,7 @@ public async Task ExecuteAsync_GivenRqlSourceCase2_InterpretsAndReturnsResult()
172172
var interpretResult = new InterpretResult();
173173
interpretResult.AddStatementResult(new ExpressionStatementResult(rql, rqlArray));
174174

175-
Mock.Get(this.scanner)
175+
Mock.Get(this.tokenScanner)
176176
.Setup(x => x.ScanTokens(It.Is(rql, StringComparer.Ordinal)))
177177
.Returns(scanResult);
178178
Mock.Get(this.parser)
@@ -187,7 +187,7 @@ public async Task ExecuteAsync_GivenRqlSourceCase2_InterpretsAndReturnsResult()
187187

188188
// Assert
189189
Mock.VerifyAll(
190-
Mock.Get(this.scanner),
190+
Mock.Get(this.tokenScanner),
191191
Mock.Get(this.parser),
192192
Mock.Get(this.interpreter));
193193

@@ -237,7 +237,7 @@ public async Task ExecuteAsync_GivenRqlSourceCase3_InterpretsAndReturnsResult()
237237
var interpretResult = new InterpretResult();
238238
interpretResult.AddStatementResult(new ExpressionStatementResult(rql, rqlArray));
239239

240-
Mock.Get(this.scanner)
240+
Mock.Get(this.tokenScanner)
241241
.Setup(x => x.ScanTokens(It.Is(rql, StringComparer.Ordinal)))
242242
.Returns(scanResult);
243243
Mock.Get(this.parser)
@@ -252,7 +252,7 @@ public async Task ExecuteAsync_GivenRqlSourceCase3_InterpretsAndReturnsResult()
252252

253253
// Assert
254254
Mock.VerifyAll(
255-
Mock.Get(this.scanner),
255+
Mock.Get(this.tokenScanner),
256256
Mock.Get(this.parser),
257257
Mock.Get(this.interpreter));
258258

@@ -294,7 +294,7 @@ public async Task ExecuteAsync_GivenRqlSourceCase4_InterpretsAndReturnsResult()
294294
var interpretResult = new InterpretResult();
295295
interpretResult.AddStatementResult(new ExpressionStatementResult(rql, rqlString));
296296

297-
Mock.Get(this.scanner)
297+
Mock.Get(this.tokenScanner)
298298
.Setup(x => x.ScanTokens(It.Is(rql, StringComparer.Ordinal)))
299299
.Returns(scanResult);
300300
Mock.Get(this.parser)
@@ -309,7 +309,7 @@ public async Task ExecuteAsync_GivenRqlSourceCase4_InterpretsAndReturnsResult()
309309

310310
// Assert
311311
Mock.VerifyAll(
312-
Mock.Get(this.scanner),
312+
Mock.Get(this.tokenScanner),
313313
Mock.Get(this.parser),
314314
Mock.Get(this.interpreter));
315315

@@ -340,7 +340,7 @@ public async Task ExecuteAsync_GivenRqlSourceCase5HavingErrorsOnScanner_ThrowsRq
340340
};
341341
var scanResult = ScanResult.CreateError(messages);
342342

343-
Mock.Get(this.scanner)
343+
Mock.Get(this.tokenScanner)
344344
.Setup(x => x.ScanTokens(It.Is(rql, StringComparer.Ordinal)))
345345
.Returns(scanResult);
346346

@@ -349,7 +349,7 @@ public async Task ExecuteAsync_GivenRqlSourceCase5HavingErrorsOnScanner_ThrowsRq
349349

350350
// Assert
351351
Mock.VerifyAll(
352-
Mock.Get(this.scanner));
352+
Mock.Get(this.tokenScanner));
353353

354354
rqlException.Message.Should().Be("Errors have occurred processing provided RQL source - Sample scan error for source <unavailable> @{1:1}-{1:10}");
355355
rqlException.Errors.Should().HaveCount(1);
@@ -380,7 +380,7 @@ public async Task ExecuteAsync_GivenRqlSourceCase6HavingErrorsOnParser_ThrowsRql
380380
};
381381
var parseResult = ParseResult.CreateError(messages);
382382

383-
Mock.Get(this.scanner)
383+
Mock.Get(this.tokenScanner)
384384
.Setup(x => x.ScanTokens(It.Is(rql, StringComparer.Ordinal)))
385385
.Returns(scanResult);
386386
Mock.Get(this.parser)
@@ -392,7 +392,7 @@ public async Task ExecuteAsync_GivenRqlSourceCase6HavingErrorsOnParser_ThrowsRql
392392

393393
// Assert
394394
Mock.VerifyAll(
395-
Mock.Get(this.scanner),
395+
Mock.Get(this.tokenScanner),
396396
Mock.Get(this.parser));
397397

398398
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
427427
var interpretResult = new InterpretResult();
428428
interpretResult.AddStatementResult(new ErrorStatementResult("Sample interpret error", rql, RqlSourcePosition.From(1, 1), RqlSourcePosition.From(1, 10)));
429429

430-
Mock.Get(this.scanner)
430+
Mock.Get(this.tokenScanner)
431431
.Setup(x => x.ScanTokens(It.Is(rql, StringComparer.Ordinal)))
432432
.Returns(scanResult);
433433
Mock.Get(this.parser)
@@ -442,7 +442,7 @@ public async Task ExecuteAsync_GivenRqlSourceCase7HavingErrorsOnInterpreter_Thro
442442

443443
// Assert
444444
Mock.VerifyAll(
445-
Mock.Get(this.scanner),
445+
Mock.Get(this.tokenScanner),
446446
Mock.Get(this.parser),
447447
Mock.Get(this.interpreter));
448448

@@ -478,7 +478,7 @@ public async Task ExecuteAsync_GivenRqlSourceCase8HavingUnknownResultType_Throws
478478
var interpretResult = new InterpretResult();
479479
interpretResult.AddStatementResult(new StubResult());
480480

481-
Mock.Get(this.scanner)
481+
Mock.Get(this.tokenScanner)
482482
.Setup(x => x.ScanTokens(It.Is(rql, StringComparer.Ordinal)))
483483
.Returns(scanResult);
484484
Mock.Get(this.parser)
@@ -493,7 +493,7 @@ public async Task ExecuteAsync_GivenRqlSourceCase8HavingUnknownResultType_Throws
493493

494494
// Assert
495495
Mock.VerifyAll(
496-
Mock.Get(this.scanner),
496+
Mock.Get(this.tokenScanner),
497497
Mock.Get(this.parser),
498498
Mock.Get(this.interpreter));
499499

0 commit comments

Comments
 (0)