ci: make everything work on CodeSpace

Author: fhuitelec

.devcontainer/devcontainer.json

@@ -30,7 +30,7 @@
             "${workspaceFolder}/src"
           ],
           "python.testing.pytestArgs": [
-            "src"
+            "tests"
           ],
           "python.testing.unittestEnabled": false,
           "python.testing.pytestEnabled": true
@@ -42,7 +42,8 @@
         "ms-python.vscode-pylance",
         "charliermarsh.ruff",
         "ms-python.pylint",
-        "tamasfe.even-better-toml"
+        "tamasfe.even-better-toml",
+        "yzhang.markdown-all-in-one"
       ]
     }
   }

.python-version

@@ -1 +1 @@
-3.12
+3.13

.vscode/testing.code-snippets

@@ -0,0 +1,15 @@
+{
+	"Arrange/Act/Assert test": {
+		"scope": "python",
+		"prefix": "aaa",
+		"body": [
+			"# Arrange",
+			"$1",
+			"# Act",
+			"",
+			"# Assert",
+			""
+		],
+		"description": "Add Arrange/Act/Assert test structure"
+	}
+}

Makefile

@@ -0,0 +1,34 @@
+PYTEST := uv run pytest
+PYLINT := uv run pylint
+PYRIGHT := uv run pyright
+RUFF := uv run ruff
+RADON := uv run radon
+CLI := uv run src/gilded_rose/main.py
+LINT_DIRECTORIES := src/gilded_rose tests
+
+.PHONY: install
+install:
+	$(CLI)
+
+.PHONY: run
+run:
+	$(CLI)
+
+.PHONY: test
+test:
+	$(PYTEST) -v --cov-report term --cov=src/gilded_rose
+
+.PHONY: lint
+lint:
+	$(PYLINT)  $(LINT_DIRECTORIES)
+	$(PYRIGHT) $(LINT_DIRECTORIES)
+	$(RUFF) format       $(LINT_DIRECTORIES)
+	$(RUFF) check  --fix $(LINT_DIRECTORIES)
+
+.PHONY: analyze
+analyze:
+	$(RADON) cc src/
+	@echo
+	@echo "To know more about cyclomatic complexity:"
+	@echo "  - https://radon.readthedocs.io/en/latest/intro.html#cyclomatic-complexity"
+	@echo "  - https://radon.readthedocs.io/en/latest/commandline.html#the-cc-command"

README.md

@@ -1,23 +1,31 @@
 # Gilded Rose starting position in Python
 
+## Credits
+
+This is heavily inspired from [@emilybache](https://github.com/emilybache)'s kata ([code](https://github.com/emilybache/GildedRose-Refactoring-Kata/tree/main/python)) initially created by [Terry Hughes](https://x.com/TerryHughes) in 2011 ([source](https://web.archive.org/web/20240525015111/https://iamnotmyself.com/refactor-this-the-gilded-rose-kata/)).
+
+The essence of the kata is exactly the same but the surroundings have been adapted to have a setup more intuitive with pytest, Dev containers, uv and more.
+
+## Exercice
+
 For exercise instructions, check out the [requirements](./docs/requirements.md).
 
 ## Setup
 
 You need [uv](https://docs.astral.sh/uv/) installed.
 
 ```shell
-uv sync
+make install
 ```
 
 ## Run the example
 
 ```
-uv run gilded_rose/main.py
+make run
 ```
 
 ## Run the unit tests
 
 ```
-uv run pytest
+make test
 ```

docs/requirements.md

@@ -0,0 +1,43 @@
+# Spécification technique de la **Rose dorée**
+
+## Introduction
+
+Bienvenue dans l'équipe de **La rose dorée**. Comme vous le savez, nous sommes une petite auberge idéalement située, tenue par une aubergiste sympathique nommée Allison. Nous achetons et vendons uniquement les meilleurs produits !
+
+Malheureusement, nos articles perdent constamment en **qualité** à mesure qu'ils approchent de leur date limite de vente.
+
+Nous avons un système en place qui met à jour notre inventaire automatiquement. Il a été développé par un certain Leeroy, un type sérieux qui est maintenant parti vers de nouvelles aventures. Votre mission est d’ajouter une nouvelle fonctionnalité à notre système afin que nous puissions commencer à vendre une nouvelle catégorie d’articles.
+
+## Spécifications
+
+### Existant
+
+Voici d'abord une introduction à notre système :
+
+- Tous les `items` ont une valeur `sell_in` qui indique le nombre de jours qu’il nous reste pour les vendre  
+- Tous les `items` ont une valeur de `quality` qui indique à quel point l’article est précieux  
+- À la fin de chaque journée, notre système diminue ces deux valeurs pour chaque item
+
+Assez simple, non ? C’est là que ça devient intéressant :
+
+- Une fois la date limite dépassée, la `quality` diminue deux fois plus vite  
+- La `quality` d’un item n’est jamais négative  
+- `"Aged Brie"` augmente en fait en `quality` avec le temps
+- La `quality` d’un item ne dépasse jamais `50`
+- `"Sulfuras"`, en tant qu’item légendaire, n’a jamais besoin d’être vendu et ne perd jamais en `quality`
+- Les `"Backstage passes"`, comme le `"Aged Brie"`, augmentent en `quality` à mesure que leur `sell_in` approche :
+  - La `quality` augmente de `2` lorsqu’il reste `10` jours ou moins, et de `3` lorsqu’il reste `5` jours ou moins, mais
+  - La `quality` tombe à `0` après le concert
+- un item ne peut jamais voir sa `quality` dépasser `50`, cependant `"Sulfuras"` est un item légendaire et, en tant que tel, sa `quality` est de `80` et elle ne change jamais
+
+### Nouvelle fonctionnalité
+
+Nous avons récemment signé un contrat avec un fournisseur d’items conjurés. Cela nécessite une mise à jour de notre système :
+
+- Les items `"Conjured"` se détériorent en `quality` deux fois plus vite que les items normaux
+
+## Cadre
+
+N’hésitez pas à modifier la méthode `update_quality` et à ajouter du nouveau code tant que tout fonctionne correctement.
+
+Cependant, ne modifiez pas la classe `Item` ni la propriété `Items`, car elles appartiennent au gobelin dans le coin, qui entrerait instantanément en rage et vous tuerait d’un seul coup — il ne croit pas au partage de code (vous pouvez rendre la méthode `UpdateQuality` et la propriété `Items` statiques si vous le souhaitez, nous vous couvrirons).

docs/specifications.md

@@ -3,11 +3,35 @@ name = "gilded-rose-kata"
 version = "0.1.0"
 description = "Gilded rose kata"
 readme = "README.md"
-requires-python = ">=3.12"
-dependencies = []
+requires-python = ">=3.13"
+dependencies = [
+    "radon>=6.0.1",
+]
+
+[build-system]
+build-backend = "hatchling.build"
+requires = [
+    "hatchling",
+]
 
 [tool.uv]
 dev-dependencies = [
+    "pylint>=3.3.7",
+    "pyright>=1.1.403",
     "pytest-cov>=5.0.0",
     "pytest>=8.3.3",
+    "radon>=6.0.1",
+    "ruff>=0.12.7",
+]
+
+[tool.hatch.build.targets.wheel]
+packages = [
+    "src/gilded_rose",
+    "tests",
+]
+
+[tool.coverage.run]
+omit = [
+    "tests/**/*",
+    "src/gilded_rose/main.py"
 ]