Брозовский Максим #234

BMV989 · 2024-11-24T16:37:53Z

No description provided.

HELLoWorlD01100 · 2024-11-24T17:38:56Z

cs/Markdown/IConverter.cs

+
+namespace Markdown;
+
+public interface IConverter


Конвертер чего?

HELLoWorlD01100 · 2024-11-24T17:49:19Z

cs/Markdown/Tags/ITag.cs

+    bool IsOpenedCorrectly((char left, char right) contextChars);
+    bool IsClosedCorrectly((char left, char right) contextChars);


Выдели мб отдельную модельку под это? Таплы передавать публично плохая практика. У тебя уже два места, где одна и та же модель используется. При изменении одно из этих мест надо отдельно помнить и о другом

HELLoWorlD01100 · 2024-11-24T17:51:02Z

cs/Markdown/Tags/PairTag.cs

@@ -0,0 +1,12 @@
+namespace Markdown.Tags;
+
+public abstract class PairTag : ITag 


Чет не отразил чем отличается от одинарного

И как определяем закрываюищий тег?

для MdTag добавил, а HtmlTag там симметричный, т.е. <HtmlTag></HtmlTag>

Чет не отразил чем отличается от одинарного

Главное отличие в том, что у одинарного не будет закрвающего MdTag и он действует на всю строчку, а для HtmlTag мы делаем как в коментарии выше - симметрично

Но там тоже могут быть особые случаи типа <img> тега....

но мне кажется это уже отвественность IMdConverter, как он будет эти токены укладывать в строку

HELLoWorlD01100 · 2024-11-24T17:55:29Z

cs/Markdown/Tokens/TagToken.cs

+
+namespace Markdown.Tokens;
+
+public class TagToken(ITag tag, char left, char right) : IToken


А почему char? Например, __ - это два подчеркивания.

HELLoWorlD01100 · 2024-11-24T17:58:28Z

cs/Markdown/Tags/ItalicTag.cs

@@ -0,0 +1,9 @@
+namespace Markdown.Tags;
+
+public class ItalicTag : PairTag, ITag


А зачем интерфейс еще раз указывать?

HELLoWorlD01100

Папку Tags можно тоже спокойно переносить в папку Models

HELLoWorlD01100 · 2024-12-15T20:02:26Z

cs/Markdown/Tags/SingleMdTagKind.cs

+
+namespace Markdown.Tags;
+
+public class SingleMdTagKind(string mdTagKind, string htmlOpenTag, string htmlCloseTag) : IMdTagKind


Чет не вижу прикола использовать такой конструктор конкретно тут:
Приходится отдельно поля в свойства прописывать, значения в двух местах "хранятся по итогу". В поле и в свойстве.

HELLoWorlD01100 · 2024-12-15T20:05:05Z

cs/Markdown/Token.cs

+    public IMdTagKind Tag => mdTagKind;
+    public int Position { get; private set; } = position;
+
+    public Token(string value) : this(value, value.Length, new SingleMdTagKind())


Логика работы(что мы изначально берем весь текст как токен) протекает в абстракцию

HELLoWorlD01100 · 2024-12-15T20:19:04Z

cs/MarkdownTests/MdTests.cs

+    [TestCase(100, 10)]
+    [TestCase(100, 100)]
+    [TestCase(100, 1000)]
+    public void Render_ShouldWorkLinearly(int times, int inputScale)


Правила, что реальное время несоотносится со сложностью,- нету. Более того, у тебя в зависимости от железа это время будет отличаться. А тогда мы приходим к тому, что у тебя тесты начинают плавающе работать. У меня они пойдут, у другого человека нет, в CI/CD в зависимости от тачки будут работать или не работать.

Получим хаос :)

HELLoWorlD01100 · 2024-12-15T20:20:42Z

cs/MarkdownTests/MdTests.cs

+    public static IEnumerable<TestCaseData> ConvertTagsTests
+    {
+        get
+        {
+            yield return new TestCaseData(
+                    $"# Заголовок{Environment.NewLine}#Заголовок", $"<h1> Заголовок</h1>{Environment.NewLine}<h1>Заголовок</h1>")
+                .SetName("Render_ShouldConvertHeaderTag")
+                .SetCategory(nameof(ConvertTagsTests));
+            yield return new TestCaseData(
+                    $"_курсивный текст_{Environment.NewLine}_курсивный текст_",
+                    $"<em>курсивный текст</em>{Environment.NewLine}<em>курсивный текст</em>")
+                .SetName("Render_ShouldConvertItalicTag")
+                .SetCategory(nameof(ConvertTagsTests));
+            yield return new TestCaseData(
+                    $"__полужирный текст__{Environment.NewLine}__полужирный текст__",
+                    $"<strong>полужирный текст</strong>{Environment.NewLine}<strong>полужирный текст</strong>")
+                .SetName("Render_ShouldConvertBoldTag")
+                .SetCategory(nameof(ConvertTagsTests));
+            yield return new TestCaseData(
+                    "_чем\\_ 100_ __раз_ услышать.__",
+                    "_чем_ 100_ __раз_ услышать.__")
+                .SetName("Render_ShouldConvertEscapeTag")
+                .SetCategory(nameof(ConvertTagsTests));
+            yield return new TestCaseData(
+                    "# Заголовок c _курсивным текстом_ и __полужирным текстом__",
+                    "<h1> Заголовок c <em>курсивным текстом</em> и <strong>полужирным текстом</strong></h1>")
+                .SetName("Render_ShouldConvertAllTagsInHeader")
+                .SetCategory(nameof(ConvertTagsTests)); 
+        }
+    }


Получается слишком громоздко и нечитаемо.
Хотя нас интересуют по существу только Входное значение, Чего ожидаем, Название теста.
Это можно и в TestCase засунуть

HELLoWorlD01100 · 2024-12-15T20:22:36Z

cs/MarkdownTests/MdTests.cs

+                    $"__Непарные _символы в рамках{Environment.NewLine}одного_ абзаца не считаются__ выделением")
+                .SetName("Render_ShouldIgnorePairTags_WhenPlacedInMultiLine")
+                .SetCategory("MdSpec");
+            yield return new TestCaseData(


\n и другие спец. символы не работают в соответствии с этим правилом

HELLoWorlD01100 · 2024-12-15T20:28:04Z

cs/Markdown/StringExtension.cs

+    public static Token CreateToken(this string text, int startIndex, int stopIndex, IMdTagKind tag)
+    {
+        var value = text.Substring(startIndex, stopIndex - startIndex);
+        return new Token(value, startIndex, tag);
+    }


Такое лучше вынести статикой в класс Token или в его конструктор.
У Тебя string - базовый тип. Любой, кто подключит твою библиотеку, бонусом получит мусорный(для него) метод CreateToken.

Либо же его делать internal, но тогда у нас логика по тому как из текста создать токен выносится во вне класса.

HELLoWorlD01100 · 2024-12-15T20:34:19Z

cs/Markdown/StringExtension.cs

+        return new Token(value, startIndex, tag);
+    }
+
+    public static int GetEndOfLinePosition(this string text, int startIndex = 0)


У строк нет "позиций". Только индексы

HELLoWorlD01100 · 2024-12-15T20:34:41Z

cs/Markdown/StringExtension.cs

+        return newLinePosition != -1 ? newLinePosition + Environment.NewLine.Length : text.Length;
+    }
+
+    public static Token CreateEscapeToken(this string text, Tag escapeTag)


Точно так же, как и с обычным Token'ом

HELLoWorlD01100 · 2024-12-15T20:40:05Z

cs/Markdown/MdTokenizer.cs

+    private readonly List<int> mdLenOfTagSignatures = tags
+            .Select(tag => tag.MdTag.Length)
+            .Distinct()
+            .OrderDescending()
+            .ToList();
+


Какое-то неявное соответствие тега и его длины получается

HELLoWorlD01100 · 2024-12-15T20:42:32Z

cs/Markdown/Tags/IMdTagKind.cs

+    public string RemoveMdTags(string text);
+    public string InsertHtmlTags(string text);


Как будто это должна быть атомарная операция, но по архитектуре вижу, что просто поменять не получится

BMV989 added 3 commits November 21, 2024 01:33

Project setup

882da40

Initial architecture

f5c3f1d

Added test project for Markdown

18b7b96

HELLoWorlD01100 reviewed Nov 24, 2024

View reviewed changes

BMV989 added 4 commits November 24, 2024 23:18

remove unnecessary interface references

898ec46

refactor Converter to MdConverter

a05ef8a

now we distinguish PairTag and SingleTag

23b8f6a

Rename of Tokenizer to MdTokenizer

e91b0e2

BMV989 requested a review from HELLoWorlD01100 November 25, 2024 14:14

BMV989 added 6 commits December 1, 2024 16:11

new architecture 2.0

89b922f

Added base implementation of Md Render with basic Tests

711d9f0

Added test for Linear time complexity of Md Render

0bb79b7

small fixes in one of the Md tests

e764bda

small refactor in MdTokenizer

f9c3b56

Added some more tests for MdTests

4b9415b

HELLoWorlD01100 reviewed Dec 15, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Брозовский Максим #234

Брозовский Максим #234

BMV989 commented Nov 24, 2024

HELLoWorlD01100 Nov 24, 2024

HELLoWorlD01100 Nov 24, 2024

HELLoWorlD01100 Nov 24, 2024

HELLoWorlD01100 Nov 24, 2024

BMV989 Nov 25, 2024 •

edited

Loading

BMV989 Nov 25, 2024 •

edited

Loading

BMV989 Nov 25, 2024

BMV989 Nov 25, 2024

HELLoWorlD01100 Nov 24, 2024

HELLoWorlD01100 Nov 24, 2024

HELLoWorlD01100 left a comment

HELLoWorlD01100 Dec 15, 2024

HELLoWorlD01100 Dec 15, 2024

HELLoWorlD01100 Dec 15, 2024

HELLoWorlD01100 Dec 15, 2024

HELLoWorlD01100 Dec 15, 2024

HELLoWorlD01100 Dec 15, 2024

HELLoWorlD01100 Dec 15, 2024

HELLoWorlD01100 Dec 15, 2024

HELLoWorlD01100 Dec 15, 2024

HELLoWorlD01100 Dec 15, 2024

		bool IsOpenedCorrectly((char left, char right) contextChars);
		bool IsClosedCorrectly((char left, char right) contextChars);

		@@ -0,0 +1,12 @@
		namespace Markdown.Tags;

		public abstract class PairTag : ITag


		namespace Markdown.Tokens;

		public class TagToken(ITag tag, char left, char right) : IToken

		@@ -0,0 +1,9 @@
		namespace Markdown.Tags;

		public class ItalicTag : PairTag, ITag


		namespace Markdown.Tags;

		public class SingleMdTagKind(string mdTagKind, string htmlOpenTag, string htmlCloseTag) : IMdTagKind

		public string RemoveMdTags(string text);
		public string InsertHtmlTags(string text);

Брозовский Максим #234

Are you sure you want to change the base?

Брозовский Максим #234

Conversation

BMV989 commented Nov 24, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

BMV989 Nov 25, 2024 • edited Loading

Choose a reason for hiding this comment

BMV989 Nov 25, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

HELLoWorlD01100 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

BMV989 Nov 25, 2024 •

edited

Loading

BMV989 Nov 25, 2024 •

edited

Loading