Глейзер Роман #252

RomanGleyzer · 2025-11-03T08:38:40Z

upd:

Предполагаемый алгоритм обработки текста:

Нам пришел на вход текст: "сер_еди_на тест"
После этого pipeline запускает код, в котором текст превратится в результат
BlockSegmenter - первый этап, он разбивает текст по абзацам. В нашем случае только 1 абзац.
Формируется следующая структура:

Blocks [
  Block {
    RawText: "сер_еди_на тест",
    Inlines: (будут заполнены парсером)
  }
]

Далее парсер обрабатывает сформированные блоки и разбивает текст на вершины (INode) Text, Em, Strong:

Blocks [
  Block {
    RawText: "сер_еди_на тест",
    Inlines: [
      Node("сер", Text),
      Node("еди", Em),
      Node("на тест", Text)
    ]
  }
]

После этого html отрендерит сформированные блоки в:

<p>сер<em>еди</em>на тест</p>

masssha1308 · 2025-11-05T20:19:16Z

cs/clean-code.sln

@@ -1,14 +1,16 @@



Лучше не включать в МР, т.к. изменения были сгененрированы IDE автоматически и не имеют прямого отношения к МР

masssha1308 · 2025-11-05T20:36:04Z

cs/Markdown/Pipeline.cs

+
+namespace Markdown;
+
+public class Pipeline(BlockSegmenter blockSegmenter, InlineParser parser, HtmlRenderer htmlRenderer)


На данный момент нет необходимости выносить эту логику в отдельный класс, давай перенесем ее в Md.Render()

masssha1308 · 2025-11-05T21:07:19Z

cs/Markdown/Parsing/InlineParser.cs

+    // Предполагается реализация с разделением кода парсинга на отдельные классы, работающие в следующем порядке:
+    // Класс, посимвольно читающий текст
+    // Класс, преобразующий текст в единицы разметки (текст, бэк слеш, одинарное подчеркивание итд)
+    // Класс, отвечающий за обработку экранирования в тексте после преобразования текста в единицы разметки


Экранирование должно обрабатываться до парсинга тегов

masssha1308 · 2025-11-05T21:26:38Z

cs/Markdown/Parsing/InlineParser.cs

+        throw new NotImplementedException();
+    }
+
+    // Предполагается реализация с разделением кода парсинга на отдельные классы, работающие в следующем порядке:


Разбиение парсера на 5 классов избыточно, каждый из предложенных классов будет содержать 1-2 метода что усложнит архитектуру без реальной поьзы, классы не будут являться самостоятельными сущностями, а будут лишь шагами алгоритма
Отдельные классы стоило бы выделить в случае переиспользования логики или разных "профилей" парсера (например, с конфигурируемыми настройками), в этом кейсе такой необходимости нет

Возможно для упрощения логики парсера стоит вынести отдельный этап предварительной обработки текста которая подготавливает его к основному парсингу, заменяя "мешающие" элементы на временные маркеры

masssha1308 · 2025-11-05T21:48:00Z

cs/Markdown/Blocks/IBlock.cs

+
+public interface IBlock
+{
+    // Далее планируется добавление двух наследников: HeadingBlock и ParagraphBlock


Нет необходимости в наследниках исходя из текущих требований, лучше добавить поле BlockType. Разница HeadingBlock и ParagraphBlock только в рендеринге, хранятся и обрабатываются данные одинаково. Наследники понадобились бы, например, в случае разных структур данных

masssha1308 · 2025-11-05T21:49:22Z

cs/Markdown/Blocks/IBlock.cs

+
+    public IReadOnlyList<INode> Inlines { get; }
+
+    void SetInlines(IReadOnlyList<INode> inlines);


Какие преимущества перед сеттером? Точно ли нужен этот метод?

Какие преимущества перед сеттером? Точно ли нужен этот метод?

Посидел, подумал и не нашел ни одной причины, по которой бы использование SetInlines было бы лучше использования дефолтного сеттера
Мне кажется под заданные требования будет достаточно просто сеттера. В итоговой реализации поправлю этот момент

masssha1308 · 2025-11-05T22:03:44Z

Заметила что для некоторых компонентов выделены отдельные папки, содержащие по одному файлу. Предлагаю убрать, т.к. они избыточны и усложняют навигацию

…нтерфейса INode на класс Node

…ытого __

… парсера

…тесты на проверку парсера

masssha1308 · 2025-11-13T14:37:13Z

cs/Markdown/Md.cs

+
+public class Md
+{
+    public string Render(string text, BlockSegmenter segmenter, InlineParser parser, HtmlRenderer renderer)


Давай передавать зависимости в конструктор, а не в метод. Класс должен скрывать детали реализации. Передавать в метод не стоит, т.к. не получится инжектировать зависимости через di + это нарушает инкасуляцию: любой внешний код вызывающий этот метод будет знать какие зависимости передавать, как их конфигурировать и т.д.

masssha1308 · 2025-11-13T17:16:12Z

cs/Markdown/Inlines/InlineSyntax.cs

+        return position + length < text.Length ? text[position + length] : Space;
+    }
+
+    public static bool IsWordChar(char ch)


Избыточный метод

masssha1308 · 2025-11-13T17:17:06Z

cs/MarkdownTests/MarkdownTests.sln

@@ -0,0 +1,24 @@
+Microsoft Visual Studio Solution File, Format Version 12.00


в МР не нужно включать

не нужно тесты выделять в солюшн, проекта достаточно

в МР не нужно включать

Удалил эти файлы

не нужно тесты выделять в солюшн, проекта достаточно

Отказался от .sln. Сейчас в папке проекта нет такого решения

masssha1308 · 2025-11-13T17:19:40Z

cs/Markdown/Inlines/InlineParser.cs

+            }
+        }
+        return sb.ToString();
+    }


Метод нечитабельный, нужно разбить/сделать компактнее

masssha1308 · 2025-11-13T17:20:08Z

cs/Markdown/Inlines/InlineParser.cs

+        return text?
+            .Replace(PlaceholderUnderscore, Underscore)
+            .Replace(PlaceholderBackslash, Escape)
+            .Replace(PlaceholderHash, '#');


магический символ

masssha1308 · 2025-11-13T17:24:07Z

cs/Markdown/HtmlRenderer.cs

+        return sb.ToString();
+    }
+
+    private static string RenderInlines(IReadOnlyList<Node> inlines, BlockType context)


Вынесем вспомогательные методы для читабельности? Метод получился большой и есть блоки которые напрашиваются в отдельный метод

masssha1308 · 2025-11-13T17:24:29Z

cs/Markdown/HtmlRenderer.cs

+                    break;
+
+                case NodeType.Em:
+                    sb.Append("<em>")


магические строки

masssha1308 · 2025-11-13T17:26:45Z

cs/Markdown/HtmlRenderer.cs

+            switch (node.Type)
+            {
+                case NodeType.Text:
+                    sb.Append(node.Text ?? string.Empty);


В случае пусто строки ничего не добавляет, но вызывает метод. Лучше сделать проверку на пустую строку

masssha1308 · 2025-11-13T18:08:46Z