Auto step counter (#117)

This pull request introduces a new step counter feature to the `ModelDF` class and adds corresponding tests. The main changes include adding a step counter, modifying the `step` method to increment the counter, and adding tests to verify the new functionality.

Enhancements to `ModelDF` class:

* [`mesa_frames/concrete/model.py`](diffhunk://#diff-c5db932a22d9e3b30ff7eead6d38e655cf3be4fee195a6fe18409bbe3c575ddcR88-R101): Introduced a new private attribute `_steps` to keep track of the step count and added a property `steps` to retrieve the current step count. Modified the `step` method to increment the step counter automatically by wrapping the user-defined `step` method. [[1]](diffhunk://#diff-c5db932a22d9e3b30ff7eead6d38e655cf3be4fee195a6fe18409bbe3c575ddcR88-R101) [[2]](diffhunk://#diff-c5db932a22d9e3b30ff7eead6d38e655cf3be4fee195a6fe18409bbe3c575ddcR150-R160)

Testing the new step counter:

* [`tests/test_modeldf.py`](diffhunk://#diff-2be7ad75672aa528662114edd128ae28ae41de2919b9e1740388a914a74122ffR1-R37): Added a new test class `Test_ModelDF` to verify the functionality of the step counter. This includes tests for the default step counter behavior and custom user-defined step behavior.

---------

Co-authored-by: Adam Amer <136176500+adamamer20@users.noreply.github.com>

Author: Ben-geo

mesa_frames/concrete/model.py

@@ -85,6 +85,20 @@ def __init__(self, seed: int | Sequence[int] | None = None) -> None:
         self.current_id = 0
         self._agents = AgentsDF(self)
         self._space = None
+        self._steps = 0
+
+        self._user_step = self.step
+        self.step = self._wrapped_step
+
+    def _wrapped_step(self) -> None:
+        """Automatically increments step counter and calls user-defined step()."""
+        self._steps += 1
+        self._user_step()
+
+    @property
+    def steps(self) -> int:
+        """Get the current step count."""
+        return self._steps
 
     def get_agents_of_type(self, agent_type: type) -> "AgentSetDF":
         """Retrieve the AgentSetDF of a specified type.
@@ -133,6 +147,17 @@ def step(self) -> None:
         """
         self.agents.step()
 
+    @property
+    def steps(self) -> int:
+        """Get the current step count.
+
+        Returns
+        -------
+        int
+            The current step count of the model.
+        """
+        return self._steps
+
     @property
     def agents(self) -> AgentsDF:
         """Get the AgentsDF object containing all agents in the model.

tests/test_modeldf.py

@@ -0,0 +1,37 @@
+from mesa_frames import ModelDF
+
+
+class CustomModel(ModelDF):
+    def __init__(self):
+        super().__init__()
+        self.custom_step_count = 0
+
+    def step(self):
+        self.custom_step_count += 2
+
+
+class Test_ModelDF:
+    def test_steps(self):
+        model = ModelDF()
+
+        assert model.steps == 0
+
+        model.step()
+        assert model.steps == 1
+
+        model.step()
+        assert model.steps == 2
+
+    def test_user_defined_step(self):
+        model = CustomModel()
+
+        assert model.steps == 0
+        assert model.custom_step_count == 0
+
+        model.step()
+        assert model.steps == 1
+        assert model.custom_step_count == 2
+
+        model.step()
+        assert model.steps == 2
+        assert model.custom_step_count == 4