Сибогатов Ринат by sibogatovr · Pull Request #204 · kontur-courses/di

sibogatovr · 2024-01-25T14:34:48Z

Описание проекта:

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

Внесенные изменения:

Добавлена функциональность удаления скучных слов.
Реализовано приведение всех слов к нижнему регистру.
Реализовано изменение цвета ТОП слов
Реализована возможность изменить шрифт, цвет, размер
Добавлен CLI
Реализованы ридеры: *.doc, *.docx, *.txt
Добавлены соответствующие тесты для новой функциональности.
Внесены мелкие улучшения и исправления.

@the-homeless-god

…в, алгоритм покраски слов.

the-homeless-god

Обратить внимание:

Заполнение PR (описание, reviewers, assignes, labels)
Именование веток
Почитать конвенцию коммитов
Написать больше тестов

the-homeless-god · 2024-01-30T10:30:02Z

TagsCloudContainer/Readers/DocReader.cs

+                foreach (Section section in document.Sections)
+                {
+                    foreach (Paragraph paragraph in section.Paragraphs)
+                    {
+                        words.AddRange(paragraph.Text.Split(' ', StringSplitOptions.RemoveEmptyEntries));
+                    }
+                }


Как сократить вложенность?

the-homeless-god · 2024-01-30T10:30:35Z

TagsCloudContainer/TagsCloud/CircularCloudLayouter.cs

+
+        private Size MeasureTextSize(string text, Font font)
+        {
+            using (var temporaryBitmap = new Bitmap(1, 1))


Как поступить с магическими числами? Почему тут 1? Как это понять?

the-homeless-god · 2024-01-30T10:30:58Z

TagsCloudContainer/TagsCloud/TagCloudApp.cs

+            _fontName = fontName;
+        }
+
+        public void Run(CommandLineOptions options)


Слишком много ответственности в функции

Следует разбить над подметоды

the-homeless-god · 2024-01-30T10:31:05Z

TagsCloudContainer/TagsCloud/TagCloudApp.cs

+
+            var tagCloudImage = GenerateTagCloud(processedWords, options.FontName, fontColor, highlightColor, options.PercentageToHighLight);
+
+            tagCloudImage.Save(@"..\..\..\output\tagsCloud.png");


Как с этим быть?

the-homeless-god · 2024-01-30T10:31:14Z

TagsCloudContainer/TagsCloud/TagCloudApp.cs

+
+            switch (fileExtension)
+            {
+                case ".doc":


Что насчёт enum?

the-homeless-god · 2024-01-30T10:31:24Z

TagsCloudContainer/TagsCloud/TagCloudApp.cs

+            }
+        }
+
+        private Bitmap GenerateTagCloud(IEnumerable<string> words, string fontName, Color fontColor, Color highlightColor, double percentageToHighlight)


Функция слишком большая

the-homeless-god · 2024-01-30T10:31:32Z

TagsCloudContainer/TagsCloud/TagCloudApp.cs

+        private CircularCloudLayouter CreateLayouter()
+        {
+            var center = new Point(_imageSettings.ImageWidth / 2, _imageSettings.ImageHeight / 2);
+            var spiral = new Spiral(center, 0.02, 0.04);


Магические числа

the-homeless-god · 2024-01-30T10:31:37Z

TagsCloudContainer/TagsCloud/TagCloudApp.cs

+        {
+            if (wordFrequencies.TryGetValue(word, out var frequency))
+            {
+                return Math.Max(30, 30 + frequency * 2);


Магические числа

the-homeless-god · 2024-01-30T10:31:56Z

TagsCloudContainer/Utility/Visualizer.cs

+        //private static void DrawRectangles(IEnumerable<Rectangle> rectangles, Graphics graphics)
+        //{
+        //    var pen = new Pen(Color.Green);
+        //    foreach (var rect in rectangles)
+        //    {
+        //        graphics.DrawRectangle(pen, rect);
+        //    }
+        //}


Для чего хранить закомментированный код?

the-homeless-god · 2024-01-30T18:31:30Z

TagsCloudContainer/Interfaces/ICircularCloudLayouter.cs

+        public Point CloudCenter { get; }
+        public IList<Rectangle> Rectangles { get; }


Почему решил сделать неполные свойства?

the-homeless-god · 2024-01-30T18:31:45Z

TagsCloudContainer/Interfaces/IImageSettings.cs

+        Color BackgroundColor { get; }
+        Color FontColor { get; }


Почему решил сделать неполные свойства?

the-homeless-god · 2024-01-30T18:32:22Z

TagsCloudContainer/Interfaces/IImageSettings.cs

+        int ImageWidth { get; set; }
+        int ImageHeight { get; set; }


Так как это уже элементы интерфейса Image, то можно опустить слова Image

То есть:

Width
Height

the-homeless-god · 2024-01-30T18:32:53Z

TagsCloudContainer/Interfaces/IImageSettings.cs

+        int ImageWidth { get; set; }
+        int ImageHeight { get; set; }
+
+        void UpdateImageSettings(int width, int height);


Также и здесь

UpdateSize или SetSize

Не вижу изменений

the-homeless-god · 2024-01-30T18:41:28Z

TagsCloudContainer/Program.cs

+                        using (var serviceProvider = Startup.ConfigureServices())
+                        {
+                            var tagCloudApp = serviceProvider.GetRequiredService<TagCloudApp>();
+                            tagCloudApp.Run(o);


давай поменяем o на что-то длинное и понятное)

the-homeless-god · 2024-01-30T18:43:45Z

TagsCloudContainer/TagsCloud/CircularCloudLayouter.cs

+
+        private void ValidateRectangleSize(Size rectangleSize)
+        {
+            if (rectangleSize.Width <= 0 || rectangleSize.Height <= 0)


для 0 нужно завести константы

the-homeless-god · 2024-01-30T18:43:53Z

TagsCloudContainer/TagsCloud/CircularCloudLayouter.cs

+
+        private Point GetUpperLeftCorner(Point rectangleCenter, Size rectangleSize)
+        {
+            return new Point(rectangleCenter.X - rectangleSize.Width / 2, rectangleCenter.Y - rectangleSize.Height / 2);


для 2 надо константы

TagsCloudContainer/TagsCloud/ColorHelper.cs

the-homeless-god · 2024-01-30T18:45:01Z

TagsCloudContainer/TagsCloud/TagCloudApp.cs

+        /// Расчитывает размер шрифта для заданного слова на основе его частоты встречаемости.
+        /// </summary>
+        /// <param name="word">Строка, представляющая слово, для которого необходимо определить размер шрифта.</param>
+        /// <param name="wordFrequencies">Словарь, содержащий частоту встречаемости каждого слова в тексте.</param>
+        /// <returns>Размер шрифта для заданного слова.</returns>      
+
+        private const int BaseFontSize = 30;
+        private const int FontSizeMultiplier = 2;
+        private const int DefaultFontSize = 10;
+        private int CalculateWordFontSize(string word, Dictionary<string, int> wordFrequencies)
+        {
+            if (wordFrequencies.TryGetValue(word, out var frequency))
+            {
+                return Math.Max(BaseFontSize, BaseFontSize + frequency * FontSizeMultiplier);
+            }
+            return DefaultFontSize;
+        }
+
+
+        private Dictionary<string, int> CalculateWordFrequencies(IEnumerable<string> words)
+        {
+            var wordFrequencies = new Dictionary<string, int>();
+
+            foreach (var word in words)
+            {
+                wordFrequencies.TryGetValue(word, out var frequency);
+                wordFrequencies[word] = frequency + 1;
+            }
+
+            return wordFrequencies;


Тянет на отдельный класс, почитай про S в SOLID

the-homeless-god · 2024-01-30T18:45:22Z

TagsCloudContainer/TagsCloud/TagCloudApp.cs

+
+        private CircularCloudLayouter CreateLayouter(double angleStep = DefaultAngleStep, double radiusStep = DefaultRadiusStep)
+        {
+            var center = new Point(_imageSettings.ImageWidth / 2, _imageSettings.ImageHeight / 2);


Дублирование кода, уже где-то выше видел использование деления на 2

the-homeless-god · 2024-02-05T10:49:08Z

TagsCloudContainer/Interfaces/IImageSettings.cs

+        int ImageWidth { get; set; }
+        int ImageHeight { get; set; }
+
+        void UpdateImageSettings(int width, int height);


Не вижу изменений

the-homeless-god · 2024-02-05T10:49:30Z

TagsCloudContainer/Readers/FileReader.cs

+
+            switch (fileExtension)
+            {
+                case ".doc":


Не вижу изменений

the-homeless-god · 2024-02-05T10:50:39Z

TagsCloudContainer/TagsCloud/TagCloudApp.cs

+            _fontName = fontName;
+        }
+
+        public void Run(CommandLineOptions options)


Следует разбить над подметоды

the-homeless-god · 2024-02-05T10:51:37Z

TagsCloudContainer/src/boring_words.txt

Я бы в README добавил описание зачем они нужны

the-homeless-god · 2024-02-06T13:28:35Z

TagsCloudContainer/Readme.md

+# TagsCloudContainer
+
+������ ������������ ����� ��������� ��� ��������� ������ ����� �� ����� � ������� ����. ��������� ������������ �������� ������� ����, �������� ������� ������ � ��������� �����, � ����� ���������� ���� ���� � ������� �������� ��� ����������.
+
+## ��������� ���������:
+
+- ��������� ���������������� �������� ������� ����.
+- ����������� ���������� ���� ���� � ������� ��������.
+- ����������� ��������� ����� ��� ����.
+- ����������� ����������� �������� �����, ����, ������.
+- �������� CLI.
+- ����������� ������: \*.doc, \*.docx, \*.txt.
+- ��������� ��������������� ����� ��� ����� ����������������.
+- ������� ������ ��������� � �����������.
+
+## ���������� ���� �� ������
+
+- ������ ���� ������� ���� ���������, ��������� � ����� 'boring_words.txt'


Слетела кодировка

the-homeless-god

LGTM 🚀

sibogatovr added 5 commits January 22, 2024 00:05

init, hardcode, v1

d0feb67

Добавлены настройки Шрифта, Скучных слов, Цвета, Цвета популярных сло…

5cffcd9

…в, алгоритм покраски слов.

Добавлен commandLineParser

0ce51a9

fix

4072767

fix tests

ac8b8ae

the-homeless-god suggested changes Jan 30, 2024

View reviewed changes

sibogatovr added 2 commits January 30, 2024 21:03

refactor: Разделение ответственности в классе DocReader, TagCloudApp

d7d53fd

feat: Добавлены тесты

4148cb1

the-homeless-god suggested changes Jan 30, 2024

View reviewed changes

sibogatovr added 3 commits January 31, 2024 23:44

feat: add FontSizeCalculator

5e0054f

refactor: improve property names and perform minor code cleanup

3f50bf8

refactor: Improve variable names, code readability

2320a14

the-homeless-god suggested changes Feb 5, 2024

View reviewed changes

sibogatovr added 2 commits February 6, 2024 03:32

feat: Add Readme.md file

21aa80d

refactor: decomposition Run method, update the FileReader

553a053

the-homeless-god suggested changes Feb 6, 2024

View reviewed changes

fix: encoding issue in Readme.md

ed0c9b1

the-homeless-god approved these changes Feb 7, 2024

View reviewed changes


		var tagCloudImage = GenerateTagCloud(processedWords, options.FontName, fontColor, highlightColor, options.PercentageToHighLight);

		tagCloudImage.Save(@"..\..\..\output\tagsCloud.png");

		public Point CloudCenter { get; }
		public IList<Rectangle> Rectangles { get; }

Conversation

sibogatovr commented Jan 25, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Описание проекта:

Внесенные изменения:

Uh oh!

the-homeless-god left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

the-homeless-god left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

sibogatovr commented Jan 25, 2024 •

edited

Loading