Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Alexander Anronov @raccoon6996 #237

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open

Alexander Anronov @raccoon6996 #237

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
de6c581
Object comparison refactor
batyadmx Nov 28, 2023
42990f0
NumberValidator tests refactor
batyadmx Nov 28, 2023
71fdae7
NumberValidator tests refactor
batyadmx Nov 30, 2023
6fc28bc
NumberValidator great test case merge
batyadmx Nov 30, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
200 changes: 127 additions & 73 deletions cs/HomeExercises/NumberValidatorTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,80 +1,134 @@
using System;
using System.Text.RegularExpressions;
using FluentAssertions;
using NUnit.Framework;

namespace HomeExercises
{
public class NumberValidatorTests
{
[Test]
public void Test()
{
Assert.Throws<ArgumentException>(() => new NumberValidator(-1, 2, true));
Assert.DoesNotThrow(() => new NumberValidator(1, 0, true));
Assert.Throws<ArgumentException>(() => new NumberValidator(-1, 2, false));
Assert.DoesNotThrow(() => new NumberValidator(1, 0, true));

Assert.IsTrue(new NumberValidator(17, 2, true).IsValidNumber("0.0"));
Assert.IsTrue(new NumberValidator(17, 2, true).IsValidNumber("0"));
Assert.IsTrue(new NumberValidator(17, 2, true).IsValidNumber("0.0"));
Assert.IsFalse(new NumberValidator(3, 2, true).IsValidNumber("00.00"));
Assert.IsFalse(new NumberValidator(3, 2, true).IsValidNumber("-0.00"));
Assert.IsTrue(new NumberValidator(17, 2, true).IsValidNumber("0.0"));
Assert.IsFalse(new NumberValidator(3, 2, true).IsValidNumber("+0.00"));
Assert.IsTrue(new NumberValidator(4, 2, true).IsValidNumber("+1.23"));
Assert.IsFalse(new NumberValidator(3, 2, true).IsValidNumber("+1.23"));
Assert.IsFalse(new NumberValidator(17, 2, true).IsValidNumber("0.000"));
Assert.IsFalse(new NumberValidator(3, 2, true).IsValidNumber("-1.23"));
Assert.IsFalse(new NumberValidator(3, 2, true).IsValidNumber("a.sd"));
}
}

public class NumberValidator
{
private readonly Regex numberRegex;
private readonly bool onlyPositive;
private readonly int precision;
private readonly int scale;

public NumberValidator(int precision, int scale = 0, bool onlyPositive = false)
{
this.precision = precision;
this.scale = scale;
this.onlyPositive = onlyPositive;
if (precision <= 0)
throw new ArgumentException("precision must be a positive number");
if (scale < 0 || scale >= precision)
throw new ArgumentException("precision must be a non-negative number less or equal than precision");
numberRegex = new Regex(@"^([+-]?)(\d+)([.,](\d+))?$", RegexOptions.IgnoreCase);
}

public bool IsValidNumber(string value)
{
// Проверяем соответствие входного значения формату N(m,k), в соответствии с правилом,
// описанным в Формате описи документов, направляемых в налоговый орган в электронном виде по телекоммуникационным каналам связи:
// Формат числового значения указывается в виде N(m.к), где m – максимальное количество знаков в числе, включая знак (для отрицательного числа),
// целую и дробную часть числа без разделяющей десятичной точки, k – максимальное число знаков дробной части числа.
// Если число знаков дробной части числа равно 0 (т.е. число целое), то формат числового значения имеет вид N(m).

if (string.IsNullOrEmpty(value))
return false;

var match = numberRegex.Match(value);
if (!match.Success)
return false;

// Знак и целая часть
var intPart = match.Groups[1].Value.Length + match.Groups[2].Value.Length;
// Дробная часть
var fracPart = match.Groups[4].Value.Length;

if (intPart + fracPart > precision || fracPart > scale)
return false;

if (onlyPositive && match.Groups[1].Value == "-")
return false;
return true;
}
}
public class NumberValidatorTests
{
[Test]
public void NumberValidator_WithProperParameters_Success()
{
Assert.DoesNotThrow(() => new NumberValidator(1, 0, true));
}

[Test]
public void NumberValidator_WithNegativePrecision_ThrowsArgumentException()
{
Assert.Throws<ArgumentException>(() => new NumberValidator(-1, 2, true));
}

[Test]
public void NumberValidator_WithNegativeScale_ThrowsArgumentException()
{
Assert.Throws<ArgumentException>(() => new NumberValidator(2, -2, true));
}

[Test]
public void NumberValidator_WithScaleGreaterThanPrecision_ThrowsArgumentException()
{
Assert.Throws<ArgumentException>(() => new NumberValidator(2, 4, true));
}
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Лучше использовать TestCase, кстати, каждому кейсу можно задать свое имя с помощью TestName


[TestCase(17, 2, true, "0.0")]
[TestCase(17, 2, true, "0")]
[TestCase(17, 2, true, "+0.0")]
[TestCase(3, 1, true, "+1.2")]
[TestCase(3, 1, false, "-1.2")]
public void IsValidNumber_WithProperValue_Success
(int precision, int scale, bool positive, string value)
{
var validator = new NumberValidator(precision, scale, positive);

Assert.True(validator.IsValidNumber(value));
}

[TestCase(" ")]
[TestCase("")]
[TestCase(null)]
[TestCase("+-1")]
[TestCase("abc")]
[TestCase("a.bc")]
[TestCase("1.0.1")]
public void IsValidNumber_WithIncorrectValue_ReturnFalse(string value)
{
Assert.False(new NumberValidator(10, 5).IsValidNumber(value));
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Читается тяжело, можно разделить на инициализацию, вызов метода и проверку значения

}


[TestCase("-1.0")]
[TestCase("+1.0")]
[TestCase("10.0")]
[TestCase("1.00")]
public void IsValidNumber_WithValueGreaterThanPrecision_ReturnFalse(string value)
{
var validator = new NumberValidator(2, 1);

Assert.False(validator.IsValidNumber(value));
}

[TestCase(true, "1.00")]
[TestCase(false, "-1.00")]
public void IsValidNumber_WithFracPartGreaterThanScale_ReturnFalse(bool positive, string value)
{
var validator = new NumberValidator(10, 1, positive);

Assert.False(validator.IsValidNumber(value));
}
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Честно говоря тут тоже ничего не мешает переделать все на тест кейсы


Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Потерялся атрибут

public void IsValidNumber_OnlyPositiveWithNegativeValue_ReturnFalse()
{
var validator = new NumberValidator(10, 5, true);

Assert.False(validator.IsValidNumber("-1.0"));
}
}

public class NumberValidator
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

{
private readonly Regex numberRegex;
private readonly bool onlyPositive;
private readonly int precision;
private readonly int scale;

public NumberValidator(int precision, int scale = 0, bool onlyPositive = false)
{
this.precision = precision;
this.scale = scale;
this.onlyPositive = onlyPositive;
if (precision <= 0)
throw new ArgumentException("precision must be a positive number");
if (scale < 0 || scale >= precision)
throw new ArgumentException("precision must be a non-negative number less or equal than precision");
numberRegex = new Regex(@"^([+-]?)(\d+)([.,](\d+))?$", RegexOptions.IgnoreCase);
}

public bool IsValidNumber(string value)
{
// Проверяем соответствие входного значения формату N(m,k), в соответствии с правилом,
// описанным в Формате описи документов, направляемых в налоговый орган в электронном виде по телекоммуникационным каналам связи:
// Формат числового значения указывается в виде N(m.к), где m – максимальное количество знаков в числе, включая знак (для отрицательного числа),
// целую и дробную часть числа без разделяющей десятичной точки, k – максимальное число знаков дробной части числа.
// Если число знаков дробной части числа равно 0 (т.е. число целое), то формат числового значения имеет вид N(m).

if (string.IsNullOrEmpty(value))
return false;

var match = numberRegex.Match(value);
if (!match.Success)
return false;

// Знак и целая часть
var intPart = match.Groups[1].Value.Length + match.Groups[2].Value.Length;
// Дробная часть
var fracPart = match.Groups[4].Value.Length;

if (intPart + fracPart > precision || fracPart > scale)
return false;

if (onlyPositive && match.Groups[1].Value == "-")
return false;
return true;
}
}
}
148 changes: 80 additions & 68 deletions cs/HomeExercises/ObjectComparison.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,81 +3,93 @@

namespace HomeExercises
{
public class ObjectComparison
{
[Test]
[Description("Проверка текущего царя")]
[Category("ToRefactor")]
public void CheckCurrentTsar()
{
var actualTsar = TsarRegistry.GetCurrentTsar();
public class ObjectComparison
{
[Test]
[Description("Проверка текущего царя")]
[Category("ToRefactor")]
public void CheckCurrentTsar()
{
var actualTsar = TsarRegistry.GetCurrentTsar();

var expectedTsar = new Person("Ivan IV The Terrible", 54, 170, 70,
new Person("Vasili III of Russia", 28, 170, 60, null));
var expectedTsar = new Person("Ivan IV The Terrible", 54, 170, 70,
new Person("Vasili III of Russia", 28, 170, 60, null));

// Перепишите код на использование Fluent Assertions.
Assert.AreEqual(actualTsar.Name, expectedTsar.Name);
Assert.AreEqual(actualTsar.Age, expectedTsar.Age);
Assert.AreEqual(actualTsar.Height, expectedTsar.Height);
Assert.AreEqual(actualTsar.Weight, expectedTsar.Weight);
/*
1. Изменять тест придется, только при изменении или добавлении членов класса, которые нужно исключить
из сравнения.
2. Если забыть добавить новые поля, которые нужно исключить из сравнения, то тест упадет
на эквивалентных экземплярах.
*/

Assert.AreEqual(expectedTsar.Parent!.Name, actualTsar.Parent!.Name);
Assert.AreEqual(expectedTsar.Parent.Age, actualTsar.Parent.Age);
Assert.AreEqual(expectedTsar.Parent.Height, actualTsar.Parent.Height);
Assert.AreEqual(expectedTsar.Parent.Parent, actualTsar.Parent.Parent);
}
actualTsar
.Should()
.BeEquivalentTo(expectedTsar,
option =>
option.Excluding(ctx => ctx.SelectedMemberInfo.Name == nameof(Person.Id) &&
ctx.SelectedMemberInfo.DeclaringType.Name == nameof(Person))
.AllowingInfiniteRecursion());
}

[Test]
[Description("Альтернативное решение. Какие у него недостатки?")]
public void CheckCurrentTsar_WithCustomEquality()
{
var actualTsar = TsarRegistry.GetCurrentTsar();
var expectedTsar = new Person("Ivan IV The Terrible", 54, 170, 70,
new Person("Vasili III of Russia", 28, 170, 60, null));
[Test]
[Description("Альтернативное решение. Какие у него недостатки?")]
public void CheckCurrentTsar_WithCustomEquality()
{
var actualTsar = TsarRegistry.GetCurrentTsar();
var expectedTsar = new Person("Ivan IV The Terrible", 54, 170, 70,
new Person("Vasili III of Russia", 28, 170, 60, null));

// Какие недостатки у такого подхода?
Assert.True(AreEqual(actualTsar, expectedTsar));
}
/*
Какие недостатки у такого подхода?

private bool AreEqual(Person? actual, Person? expected)
{
if (actual == expected) return true;
if (actual == null || expected == null) return false;
return
actual.Name == expected.Name
&& actual.Age == expected.Age
&& actual.Height == expected.Height
&& actual.Weight == expected.Weight
&& AreEqual(actual.Parent, expected.Parent);
}
}
1. Разные классы в объектном графе потребуют создания разных методов для их обхода.
2. Изменение названий учавствующих в сравнении полей и строк потребует изменения тестов.
3. Добавление новых полей и свойств, учавствующих в сравнении также потребует изменения тестов.
4. Если забыть добавить проверку новых полей класса в AreEqual, то тест будет проходить на экземплярах,
которые не равны.
*/
Assert.True(AreEqual(actualTsar, expectedTsar));
}

public class TsarRegistry
{
public static Person GetCurrentTsar()
{
return new Person(
"Ivan IV The Terrible", 54, 170, 70,
new Person("Vasili III of Russia", 28, 170, 60, null));
}
}
private bool AreEqual(Person? actual, Person? expected)
{
if (actual == expected) return true;
if (actual == null || expected == null) return false;
return
actual.Name == expected.Name
&& actual.Age == expected.Age
&& actual.Height == expected.Height
&& actual.Weight == expected.Weight
&& AreEqual(actual.Parent, expected.Parent);
}
}

public class Person
{
public static int IdCounter = 0;
public int Age, Height, Weight;
public string Name;
public Person? Parent;
public int Id;
public class TsarRegistry
{
public static Person GetCurrentTsar()
{
return new Person(
"Ivan IV The Terrible", 54, 170, 70,
new Person("Vasili III of Russia", 28, 170, 60, null));
}
}

public Person(string name, int age, int height, int weight, Person? parent)
{
Id = IdCounter++;
Name = name;
Age = age;
Height = height;
Weight = weight;
Parent = parent;
}
}
public class Person
{
public static int IdCounter = 0;
public int Age, Height, Weight;
public string Name;
public Person? Parent;
public int Id;

public Person(string name, int age, int height, int weight, Person? parent)
{
Id = IdCounter++;
Name = name;
Age = age;
Height = height;
Weight = weight;
Parent = parent;
}
}
}