refactoring du bouchonnois

REFACTORING DU BUCHONNOIS

The purpose of this kata is to exercise the refactor on an existing code in order to:

• Identify certain smells in our code
• Understand which practice and/or tool can help us to surpass these smells
• Practice in 1 safe environment outside of its production code

The context

Our valiant traffic jams need to be able to manage their hunting games.
They started to develop 1 management system by the Toshiba company but are not satisfied.

The company talks to them about a dette technique that slows them down in the development of new features ...

Hunters are counting on us to improve the situation.

Example mapping

They did some workshops with Toshiba and managed to clarify what is expected of the system.

To do this, they used the Example Mapping format to discover here.

Here is the Example Mapping that served as a alignment to develop this system.

PDF version available here

Facilitation

Prerequisite

The code is available in C# ( .NET 7 ), java (21), kotlin .

Here is the list of bookstores used / recommended:

.NET	Java	Kotlin
xUnit	junit	Kotest
FluentAssertions	assertJ	Native kotest Atertions
Verify.xUnit	approvalTests	approvalTests
FSCheck	vavr-test	kotest-property
TngTech.ArchUnitNET.xUnit	archunit	archunit
LanguageExt.Core	vavr	arrow-kt
FluentAssertions.LanguageExt	assertj-vavr	kotest-extensions-arrow

In order to improve the code, we invite you to follow the steps below:

• 1. get an idea of ​​the base code
• 2. Treat warnings as errors
• 3. Let's Kill Some Mutants
• 4. Improve the readability of tests
• 5. "Approve" Everything
• 6. "Properties" Everywhere
• 7. Architecture tests
• 8. Use boxes
• 9. Tell don ask
• 10. Commands
• 11. More exceptions
• 12. Sourcing event

For each step:

• A proposal for a "step by step" solution is proposed (in C# only)
• There are 1 branch / step

Educational objectives

Through these different stages I tried to introduce the following subjects:

• Example mapping
• Static Code Analysis / Linter
• Treat warnings as errors
• Mutation testing
• Data Builders test
• Approval Testing
• Automated Refactoring
• Property-Based Testing
• Architectural tests
• Test-Driven Development
• Clean Architecture
• Domain Driven Design
• Tell don ask
• Functional Programming
• Primitive avoid
• Avoid exceptions
• Record Decision Architecture
• Sourcing event
• ...

Have a good trip ?