Заколюкин Степан #230

StepanZakolukin · 2024-11-24T14:19:00Z

Inree · 2024-11-24T15:27:30Z

cs/Markdown/StringExtension.cs

+internal static class StringExtension
+{
+    public static string PerformTextFormatting(
+        this string text, Func<string, int, PortionText> getNextFragmentToFormat,


Делать экстеншны от базовых типов нужно только если очень хочется
Почему: если напишешь var a = "text". и попросишь IDE предложить варианты после точки, то она предложит тебе кучу самописных методов, бесполезных тебе в контексте. Конкретно этот метод предложится в методе Main, в котором он скорее всего не нужен

Исключения: штуки, которые могут пригодиться во всём проекте. Например, для стринга ты написал метод, который какой-то магией делит текст на массив предложений. Если пишешь парсер текстов, то этот метод будет использоваться часто, и его можно обернуть в экстеншн

Можно просто класс сделать internal, и тогда страдать будут только разработчики конкретного пакета, но я бы вообще убрал метод в реализацию Md, тк кроме того класса этот метод не нужен

cs/Markdown/Md.cs

Inree · 2024-11-24T16:10:32Z

cs/Markdown/PortionText.cs

@@ -0,0 +1,18 @@
+namespace Markdown;
+
+internal class PortionText


А здесь если хотелось назвать "Порцаия текста", то правильнее будет "TextPortion"

Inree · 2024-12-01T12:55:54Z

cs/Markdown/TagReplacementSpecification.cs

+        InputOpeningTag = inputOpeningTag ?? throw new ArgumentNullException(nameof(inputOpeningTag));
+        InputClosingTag = inputClosingTag ?? inputOpeningTag;
+        OutputOpeningTag = outputOpeningTag ?? throw new ArgumentNullException(nameof(outputOpeningTag));
+        OutputClosingTag = outputClosingTag ?? outputOpeningTag[0] + "/" + outputOpeningTag.Substring(1);


Автоматизация это круто, но эта строчка будет смущать потенциального юзера, который захочет использовать твой конвертер для конвертации в язык без слэшей в закрывающих тегах

И кста стоит понатыкать вопросов у нулабельных типов

Inree · 2024-12-01T12:56:46Z

cs/Markdown/TagReplacementSpecification.cs

+        OutputClosingTag = outputClosingTag ?? outputOpeningTag[0] + "/" + outputOpeningTag.Substring(1);
+
+        if (invalidSubstringsInMarkup.Any(substring => substring.Length > inputOpeningTag.Length + 2))
+            throw new ArgumentException("Запрещенные подстроки не могут быть длиннее inputOpeningTag.Length + 2");


Вот это условие вообще непонятно

Inree · 2024-12-01T13:09:00Z

cs/Markdown/Md.cs

+        result.Add(new SingleReplacementTagSpecification([],
+            "# ", "<h1>"));
+
+        return result;


Идея выделить правила обработки в отдельный объект тоже неплохая, я бы даже выделил этот метод в отдельный класс типа MdToHtmlSpecificationBuilder и вызывал его отсюда

По хорошему видится такая структура: есть ISpecificationProvider с методом GetMarkupSpecification, который возвращает массив спецификаций, его реализует MdToHtmlSpecificationBuilder с кодом из этого метода, а Md имеет в конструкторе Md(ISpecificationProvider specificationProvider) { /* тут задать приватное ридонли поле*/}, а метод GetMarkupSpecification вызывается внутри Render, и так ты сможешь в любой момент всунуть ему другую спецификацию

Inree · 2024-12-01T13:11:01Z

cs/Markdown/Md.cs

+        var markupSpecification = GetMarkupSpecification().ToArray();
+
+        return RemoveEscapingOfControlSubstrings(PerformTextFormatting(markdown,
+            FindAllSubstringsForFormatting(markdown, markupSpecification)), markupSpecification);


Тут бы навыделять переменных:

var markupSpecification = GetMarkupSpecification().ToArray(); var fragments = FindAllSubstringsForFormatting(markdown, markupSpecification); var renderedString = PerformTextFormatting(markdown, fragments); return RemoveEscapingOfControlSubstrings(renderedString, markupSpecification);

Так легче читается

Inree · 2024-12-01T13:12:54Z

cs/Markdown/SingleReplacementTagSpecification.cs

+{
+    public SingleReplacementTagSpecification(IEnumerable<string> invalidSubstringsInMarkup,
+        string inputOpeningTag, string outputOpeningTag)
+        : base(invalidSubstringsInMarkup, inputOpeningTag, outputOpeningTag, "\n\r")


Докопаюсь до \n\r: это для винды такой перенос. Для линуха: \n. В шарпе есть Evironment.NewLine, который в зависимости от системы разный

Inree · 2024-12-01T13:24:22Z

cs/Markdown/TagReplacementOptions.cs

+    public readonly string OldTag;
+    public readonly string NewTag;
+    public readonly int StartIndex;


В шарпе вообще не принято писать public readonly:

либо private type fieldName для изменяемых полей в реализации, что встречается редко

либо private readonly type fieldName для неизменяемых полей (чаще всего зависимостей, например, ISpecificationProvider, описанный выше)

либо public type PropertyName { get; } для данных, которые нужны снаружи, с добавлением set; если надо уметь изменять данные извне или private set; если извне изменять нельзя, а изнутри надо

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

А вот класс Md совершает работу, и там будет не круто видеть публичные поля или свойства, тк его дело - сделать работу и попасть под каток сборщика мусора. А IScpecificationProvider призван помогать выполнять работу, поэтому он называется зависимостью Md и чаще всего помечается как private readonly

Inree · 2024-12-01T13:28:56Z

cs/Markdown/TagReplacementSpecification.cs

+    public readonly string OutputOpeningTag;
+    public readonly string OutputClosingTag;


Вот эти поля можно объединить в объект Tag:

public record Tag(string Opening, string Closing);

а тут будет:

public Tag InputTag { get; } public Tag OutputTag { get; }

Inree · 2024-12-01T13:46:38Z

cs/Markdown/Md.cs

+        foreach (var tagSpecific in markupSpecification)
+        {
+            foreach (var fragment in FindAllFragmentsHighlightedByTag(tagSpecific, text))
+                yield return fragment;
+        }


Так мы ж всё равно для каждого нового тега дополнительный раз гоняем по тексту. Тогда алгоритм работает за O(textLength * tagsCount), то есть каждый новый тег будет чуть замедлять работу.

Я думал цикл поиска будет выглядеть так:

циклом гонимся по тексту

Нашли что какие-то теги из списка подходят к символу по индексу. Если только один, то норм, если больше , то берём тот, что длинее (то есть из одинарного и двойного прочерка берётся двойной)

Если в этот момент был открыт контекст другого тега (например, жирный тег найден в рамках заголовка), то смотрим, не соответствует ли он invalidSubstrings этого контекста. Соответствует - пропускаем

Если был открыт контекст этого же тега (то есть найден закрывающий, а ранее был найден открывающий), пишем, что всё норм, найден открывающий тут, закрывающий тут, а контекст отпускаем

Открываем этот контекст, чтобы на будущих итерациях закрыть

Добежали до конца текста - смотрим, какой контекст остался открыт (не нашлось закрытия), дописываем их в конец, чтобы вёрстка не поплыла

Тогда тебе не понадобится (вроде бы 🌚) самописное дерево, а понадобится встроенный в систему Stack, в который ты будешь писать активные на конкретную итерацию контексты и смотреть по ним invalidSubstring

И ещё не стоит забывать про обработку пересечений тегов типа #text _text \n text_ text text", в котором на какой-то итерации найдётся, что закрывается контекст, внутри которого ещё контекст. Тогда по идее надо просто дропать незакрытый контекст, потому что кто-то накосячил в тексте, не наша проблема. В примере первый курсив просто не будет считаться

Тогда ты за один прогон найдёшь все теги

Если в этот момент был открыт контекст другого тега (например, жирный тег найден в рамках заголовка), то смотрим, не соответствует ли он invalidSubstrings этого контекста. Соответствует - пропускаем

Есть ощущение, что упадет на вот таком случае: "__пересечения _двойных__ и одинарных_ подчерков"

В спецификации к заданию сказано:

В случае пересечения двойных и одинарных подчерков ни один из них не считается выделением.

A здесь выделение должно сработать по твоему алгоритму

Inree · 2024-12-01T14:03:14Z

cs/Markdown/TagReplacementSpecification.cs

+    private bool CheckForbiddenPrefixes(string substring, IEnumerable<string> forbiddenPrefixes)
+    {
+        if (forbiddenPrefixes.Any(substring.EndsWith))
+            return false;
+        return substring[1] != '\\' || substring.StartsWith(@"\\");
+    }


Возвращаясь к делению объектов на хранилки и работников, хранилка может иметь какую-то простую логику, но если операция сложнее простейшей арифметики или навешивания единичных методов, то лучше такое либо выносить в вызывающий код, либо в TagreplacementSpecificationExtensions

StepanZakolukin added 3 commits November 24, 2024 15:27

Написал тесты на решение

d996f7b

Добавил класс фрагмента текста

d12bd7e

Выполнил декомпозицию решения

b90ae8e

Inree reviewed Nov 24, 2024

View reviewed changes

StepanZakolukin added 5 commits November 25, 2024 17:26

Изменил декомпозицию решения

c6ce4db

Написал решение проходящее большую часть тестов

9fecab8

Исправил ошибку в тесте форматирования заголовков

fb761e9

Упростил код

534eaeb

Внес поправки в алгоритм и отрефакторил код

25d5bc2

Inree reviewed Dec 1, 2024

View reviewed changes

StepanZakolukin added 9 commits December 2, 2024 12:22

Отрефакторил код

7a6b124

Добавил интерфейс и классы тегов

5ad8df2

Закончил проектирование решения и дописал кдасс md

6faef2b

Написал решение для курсива и жирного шрифта

b0b5ba7

Допсал базовую часть решения

7ab097b

Добавил поддержку маркерованных списков

99ee583

Добавил тест на производительность, большой тест

c281960

Отрефакторил класс с тегом курсивного шрифта

a599c77

Завершил рефакторинг

3ca3881

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Заколюкин Степан #230

Заколюкин Степан #230

StepanZakolukin commented Nov 24, 2024

Inree Nov 24, 2024

Inree Nov 24, 2024

Inree Dec 1, 2024

Inree Dec 1, 2024

Inree Dec 1, 2024

Inree Dec 1, 2024

Inree Dec 1, 2024

Inree Dec 1, 2024

Inree Dec 1, 2024

Inree Dec 1, 2024

Inree Dec 1, 2024 •

edited

Loading

Inree Dec 1, 2024

StepanZakolukin Dec 2, 2024 •

edited

Loading

StepanZakolukin Dec 2, 2024 •

edited

Loading

Inree Dec 1, 2024

		@@ -0,0 +1,18 @@
		namespace Markdown;

		internal class PortionText

		public readonly string OutputOpeningTag;
		public readonly string OutputClosingTag;

Заколюкин Степан #230

Are you sure you want to change the base?

Заколюкин Степан #230

Conversation

StepanZakolukin 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

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

Inree Dec 1, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

StepanZakolukin Dec 2, 2024 • edited Loading

Choose a reason for hiding this comment

StepanZakolukin Dec 2, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Inree Dec 1, 2024 •

edited

Loading

StepanZakolukin Dec 2, 2024 •

edited

Loading

StepanZakolukin Dec 2, 2024 •

edited

Loading