Рефакторинг доменной модели (#10)

* Переезд на .net 6

* рефакторинг модели типа токена

* обновление пайплайнов в связи с переездом на новый .NET

* Update Readme.md

* update version

* перенос DoubleValueConverter в тело инструкции, поскольку он используется только там

* Черновик контрактов front-end'а интерпретатора

* каркас сущности для внутренностей парсера

* реорганизация папок

* переименование папок по принципу feature directory

* В рамках проектирования модели создан контекст FrontEnd, где находятся сущности, отвечающие за создание AST, включая само AST

* bugfix

* небольшое форматтирование

* bugfix

* небольшие инфраструктурные изменения: поскольку теперь сущности интерпретатора не конструируются на основе исходного текста, с которым придётся работать, то понятие запроса на создание сущности больше не нужно

* suppressing possible NRE using language feature

* Подстроил инфраструктуру под использование новых доменных контрактов

* доработка контрактов доменной модели

* удалил неиспользуемый класс

* Выпилил всё, что связано с оптимизацией

* Применил паттерн Декоратор для реализация логгируемых сущностей

* переместил логгируемые сущности в инфраструктуру, так как, по сути они не относятся к домену

* маштабная реорганизация файлов - 3 верхнеуровневых контекста:

FrontEnd - лексер, парсер (создание AST)
IR - промежуточное представление (AST, проверка семантики)
BackEnd - виртуальная машина и её инструкции

* solution rename

* Спецификация категории тестов

* Небольшой рефакторинг бэкенда

* removed unused usings

* рефакторинг ошибок семантики

* повысил порог coverage до 80%

* рефакторинг печати в виртуальной машине

* реорганизация папок фичи GetTokens

* реорганизация бэкенда

* рефакторинг модели символов и использованием ковариантных вохвращаемых типов

* lexer tests

* fix tests

* more lexer tests

* StructureTests.cs

* реорганизация папок в тестах

* vm tests

* more vm tests

* vm tests refactoring

* factorial unit test

* Instruction.cs refactoring

* coverage

* values tests

* coverage

* coverage

* coverage

* fix Readme.md

* rename file

* Instructions tests

* test suffix

* coverage

* removed unused

* exception guidelines https://docs.microsoft.com/en-us/dotnet/csharp/fundamentals/exceptions/creating-and-throwing-exceptions#defining-exception-classes

* infrastructure coverage

.github/workflows/develop.yml

@@ -18,7 +18,7 @@ jobs:
       - name: Setup .NET
         uses: actions/setup-dotnet@v2
         with:
-          dotnet-version: 5.0.x
+          dotnet-version: 6.0.x
       - name: Cache NuGet packages
         uses: actions/cache@v3
         with:
@@ -29,14 +29,14 @@ jobs:
       - name: Build
         run: dotnet build --no-restore -c Release -v n
       - name: Test
-        run: dotnet test -c Release --no-build -v n /p:CollectCoverage=true /p:CoverletOutputFormat=cobertura
+        run: dotnet test -c Release --no-build -v n /p:CollectCoverage=true /p:CoverletOutputFormat=cobertura --filter="Category=Unit"
       - name: Code Coverage Summary Report For Merge Request
         if: github.event_name == 'pull_request'
         uses: 5monkeys/cobertura-action@master
         with:
           path: ./Interpreter.Tests/coverage.cobertura.xml
           repo_token: ${{ secrets.GITHUB_TOKEN }}
-          minimum_coverage: 20
+          minimum_coverage: 80
           fail_below_threshold: true
           show_class_names: true
           show_missing: true
@@ -53,5 +53,5 @@ jobs:
           format: markdown
           hide_branch_rate: true
           hide_complexity: true
-          thresholds: '20 30'
+          thresholds: '80 100'
 

.github/workflows/release.yml

@@ -42,7 +42,7 @@ jobs:
       - name: Setup .NET
         uses: actions/setup-dotnet@v2
         with:
-          dotnet-version: 5.0.x
+          dotnet-version: 6.0.x
       - name: Publish
         run: |
           mkdir output

Interpreter.Lib/IR/Instructions/AsString.cs → Interpreter.Lib/BackEnd/Instructions/AsString.cs

@@ -1,10 +1,11 @@
+using System;
 using System.Collections.Generic;
-using Interpreter.Lib.VM;
-using Interpreter.Lib.VM.Values;
+using System.Diagnostics.CodeAnalysis;
+using Interpreter.Lib.BackEnd.Values;
 using Newtonsoft.Json;
 using Newtonsoft.Json.Serialization;
 
-namespace Interpreter.Lib.IR.Instructions
+namespace Interpreter.Lib.BackEnd.Instructions
 {
     public class AsString : Simple
     {
@@ -35,5 +36,22 @@ public override int Execute(VirtualMachine vm)
         }
 
         protected override string ToStringRepresentation() => $"{Left} = {right.right} as string";
+
+        [ExcludeFromCodeCoverage]
+        private class DoubleValueConverter : JsonConverter<double>
+        {
+            public override bool CanRead => false;
+
+            public override void WriteJson(JsonWriter writer, double value, JsonSerializer serializer) =>
+                // ReSharper disable once CompareOfFloatsByEqualityOperator
+                writer.WriteRawValue(value == Math.Truncate(value)
+                    ? JsonConvert.ToString(Convert.ToInt64(value))
+                    : JsonConvert.ToString(value));
+
+            public override double ReadJson(JsonReader reader, Type objectType,
+                double existingValue, bool hasExistingValue,
+                JsonSerializer serializer) =>
+                throw new NotImplementedException("CanRead is false, so reading is unnecessary");
+        }
     }
 }

Interpreter.Lib/IR/Instructions/BeginFunction.cs → Interpreter.Lib/BackEnd/Instructions/BeginFunction.cs

@@ -1,6 +1,4 @@
-using Interpreter.Lib.VM;
-
-namespace Interpreter.Lib.IR.Instructions
+namespace Interpreter.Lib.BackEnd.Instructions
 {
     public class BeginFunction : Instruction
     {

Interpreter.Lib/IR/Instructions/CallFunction.cs → Interpreter.Lib/BackEnd/Instructions/CallFunction.cs

@@ -1,8 +1,7 @@
 using System;
 using System.Collections.Generic;
-using Interpreter.Lib.VM;
 
-namespace Interpreter.Lib.IR.Instructions
+namespace Interpreter.Lib.BackEnd.Instructions
 {
     public class CallFunction : Simple
     {

Interpreter.Lib/IR/Instructions/CreateArray.cs → Interpreter.Lib/BackEnd/Instructions/CreateArray.cs

@@ -1,7 +1,6 @@
 using System.Linq;
-using Interpreter.Lib.VM;
 
-namespace Interpreter.Lib.IR.Instructions
+namespace Interpreter.Lib.BackEnd.Instructions
 {
     public class CreateArray : Instruction
     {

Interpreter.Lib/IR/Instructions/CreateObject.cs → Interpreter.Lib/BackEnd/Instructions/CreateObject.cs

@@ -1,7 +1,6 @@
 using System.Collections.Generic;
-using Interpreter.Lib.VM;
 
-namespace Interpreter.Lib.IR.Instructions
+namespace Interpreter.Lib.BackEnd.Instructions
 {
     public class CreateObject : Instruction
     {

Interpreter.Lib/IR/Instructions/DotAssignment.cs → Interpreter.Lib/BackEnd/Instructions/DotAssignment.cs

@@ -1,8 +1,7 @@
 using System.Collections.Generic;
-using Interpreter.Lib.VM;
-using Interpreter.Lib.VM.Values;
+using Interpreter.Lib.BackEnd.Values;
 
-namespace Interpreter.Lib.IR.Instructions
+namespace Interpreter.Lib.BackEnd.Instructions
 {
     public class DotAssignment : Simple
     {

Interpreter.Lib/IR/Instructions/Goto.cs → Interpreter.Lib/BackEnd/Instructions/Goto.cs

@@ -1,6 +1,4 @@
-using Interpreter.Lib.VM;
-
-namespace Interpreter.Lib.IR.Instructions
+namespace Interpreter.Lib.BackEnd.Instructions
 {
     public class Goto : Instruction
     {

Interpreter.Lib/IR/Instructions/Halt.cs → Interpreter.Lib/BackEnd/Instructions/Halt.cs

@@ -1,6 +1,4 @@
-using Interpreter.Lib.VM;
-
-namespace Interpreter.Lib.IR.Instructions
+namespace Interpreter.Lib.BackEnd.Instructions
 {
     public class Halt : Instruction
     {

Interpreter.Lib/IR/Instructions/IfNotGoto.cs → Interpreter.Lib/BackEnd/Instructions/IfNotGoto.cs

@@ -1,8 +1,7 @@
 using System;
-using Interpreter.Lib.VM;
-using Interpreter.Lib.VM.Values;
+using Interpreter.Lib.BackEnd.Values;
 
-namespace Interpreter.Lib.IR.Instructions
+namespace Interpreter.Lib.BackEnd.Instructions
 {
     public class IfNotGoto : Goto
     {

Interpreter.Lib/IR/Instructions/IndexAssignment.cs → Interpreter.Lib/BackEnd/Instructions/IndexAssignment.cs

@@ -1,9 +1,8 @@
 using System;
 using System.Collections.Generic;
-using Interpreter.Lib.VM;
-using Interpreter.Lib.VM.Values;
+using Interpreter.Lib.BackEnd.Values;
 
-namespace Interpreter.Lib.IR.Instructions
+namespace Interpreter.Lib.BackEnd.Instructions
 {
     public class IndexAssignment : Simple
     {

Interpreter.Lib/IR/Instructions/Instruction.cs → Interpreter.Lib/BackEnd/Instructions/Instruction.cs

@@ -1,35 +1,22 @@
 using System;
-using Interpreter.Lib.VM;
 
-namespace Interpreter.Lib.IR.Instructions
+namespace Interpreter.Lib.BackEnd.Instructions
 {
-    public abstract class Instruction : IComparable<Instruction>, IEquatable<Instruction>
+    public abstract class Instruction : IComparable<Instruction>
     {
         public int Number { get; }
 
-        public bool Leader { get; set; }
-
-        protected Instruction(int number)
-        {
+        protected Instruction(int number) => 
             Number = number;
-        }
 
         public virtual int Jump() => Number + 1;
 
-        public bool Branch() => Jump() != Number + 1;
-
         public virtual bool End() => false;
 
         public abstract int Execute(VirtualMachine vm);
 
         public int CompareTo(Instruction other) => Number.CompareTo(other.Number);
 
-        public bool Equals(Instruction other) => other != null && Number.Equals(other.Number);
-
-        public override bool Equals(object obj) => Equals(obj as Instruction);
-
-        public override int GetHashCode() => Number;
-
         protected abstract string ToStringRepresentation();
 
         public override string ToString() => $"{Number}: {ToStringRepresentation()}";

Interpreter.Lib/IR/Instructions/Print.cs → Interpreter.Lib/BackEnd/Instructions/Print.cs

@@ -1,8 +1,6 @@
-using System;
-using Interpreter.Lib.VM;
-using Interpreter.Lib.VM.Values;
+using Interpreter.Lib.BackEnd.Values;
 
-namespace Interpreter.Lib.IR.Instructions
+namespace Interpreter.Lib.BackEnd.Instructions
 {
     public class Print : Instruction
     {
@@ -15,7 +13,7 @@ public Print(int number, IValue value) : base(number)
 
         public override int Execute(VirtualMachine vm)
         {
-            Console.WriteLine(_value.Get(vm.Frames.Peek()));
+            vm.Writer.WriteLine(_value.Get(vm.Frames.Peek()));
             return Number + 1;
         }
 

Interpreter.Lib/IR/Instructions/PushParameter.cs → Interpreter.Lib/BackEnd/Instructions/PushParameter.cs

@@ -1,7 +1,6 @@
-using Interpreter.Lib.VM;
-using Interpreter.Lib.VM.Values;
+using Interpreter.Lib.BackEnd.Values;
 
-namespace Interpreter.Lib.IR.Instructions
+namespace Interpreter.Lib.BackEnd.Instructions
 {
     public class PushParameter : Instruction
     {

Interpreter.Lib/IR/Instructions/RemoveFromArray.cs → Interpreter.Lib/BackEnd/Instructions/RemoveFromArray.cs

@@ -1,9 +1,8 @@
 using System;
 using System.Collections.Generic;
-using Interpreter.Lib.VM;
-using Interpreter.Lib.VM.Values;
+using Interpreter.Lib.BackEnd.Values;
 
-namespace Interpreter.Lib.IR.Instructions
+namespace Interpreter.Lib.BackEnd.Instructions
 {
     public class RemoveFromArray : Instruction
     {

Interpreter.Lib/IR/Instructions/Return.cs → Interpreter.Lib/BackEnd/Instructions/Return.cs

@@ -1,9 +1,8 @@
 using System.Collections;
 using System.Collections.Generic;
-using Interpreter.Lib.VM;
-using Interpreter.Lib.VM.Values;
+using Interpreter.Lib.BackEnd.Values;
 
-namespace Interpreter.Lib.IR.Instructions
+namespace Interpreter.Lib.BackEnd.Instructions
 {
     public class Return : Instruction, IEnumerable<int>
     {

Interpreter.Lib/IR/Instructions/Simple.cs → Interpreter.Lib/BackEnd/Instructions/Simple.cs

@@ -1,17 +1,16 @@
 using System;
 using System.Collections.Generic;
 using System.Linq;
-using Interpreter.Lib.VM;
-using Interpreter.Lib.VM.Values;
+using Interpreter.Lib.BackEnd.Values;
 
-namespace Interpreter.Lib.IR.Instructions
+namespace Interpreter.Lib.BackEnd.Instructions
 {
     public class Simple : Instruction
     {
         public string Left { get; set; }
 
         protected (IValue left, IValue right) right;
-        protected string @operator;
+        protected readonly string @operator;
 
         public Simple(
             string left,
@@ -87,32 +86,6 @@ public override int Execute(VirtualMachine vm)
             return Jump();
         }
 
-        public void ReduceToAssignment()
-        {
-            right = ToStringRepresentation().Split('=')[1].Trim() switch
-            {
-                var s
-                    when s.EndsWith("+ 0") || s.EndsWith("- 0") ||
-                         s.EndsWith("* 1") || s.EndsWith("/ 1") => (null, right.left),
-                var s
-                    when s.StartsWith("0 +") || s.StartsWith("1 *") => (null, right.right),
-                _ => throw new NotImplementedException()
-            };
-            @operator = "";
-        }
-
-        public void ReduceToZero()
-        {
-            right = ToStringRepresentation().Split('=')[1].Trim() switch
-            {
-                "-0" => (null, new Constant(0, "0")),
-                var s
-                    when s.EndsWith("* 0") || s.StartsWith("0 *") => (null, new Constant(0, "0")),
-                _ => throw new NotImplementedException()
-            };
-            @operator = "";
-        }
-
         protected override string ToStringRepresentation() =>
             right.left == null
                 ? $"{Left} = {@operator}{right.right}"

Interpreter.Lib/VM/Values/Constant.cs → Interpreter.Lib/BackEnd/Values/Constant.cs

@@ -1,4 +1,4 @@
-namespace Interpreter.Lib.VM.Values
+namespace Interpreter.Lib.BackEnd.Values
 {
     public class Constant : IValue
     {

Interpreter.Lib/VM/Values/IValue.cs → Interpreter.Lib/BackEnd/Values/IValue.cs

@@ -1,6 +1,6 @@
 using System;
 
-namespace Interpreter.Lib.VM.Values
+namespace Interpreter.Lib.BackEnd.Values
 {
     public interface IValue : IEquatable<IValue>
     {

Interpreter.Lib/VM/Values/Name.cs → Interpreter.Lib/BackEnd/Values/Name.cs

@@ -1,4 +1,4 @@
-namespace Interpreter.Lib.VM.Values
+namespace Interpreter.Lib.BackEnd.Values
 {
     public class Name : IValue
     {