Fix tests

Signed-off-by: jparisu <[email protected]>
jparisu · Feb 22, 2025 · 6d49566 · 6d49566
1 parent f7beac8
commit 6d49566
Show file tree

Hide file tree

Showing 22 changed files with 128 additions and 158 deletions.
diff --git a/.github/workflows/install.yml b/.github/workflows/install.yml
@@ -22,13 +22,17 @@ jobs:
       with:
         python-version: '3.x'
 
-    # - name: Install dependencies
-    #   run: |
-    #     python -m pip install --upgrade pip
-    #     pip install -r requirements.txt
+    - name: Extract branch name
+      id: branch
+      run: echo "BRANCH=${GITHUB_HEAD_REF:-${GITHUB_REF#refs/heads/}}" >> $GITHUB_ENV
+
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install -r requirements.txt
 
     - name: Install package from current branch
-      run: pip install --upgrade git+https://github.com/jparisu/sIArena.git@${GITHUB_REF#refs/heads/}
+      run: pip install --upgrade git+https://github.com/jparisu/IArena.git@${BRANCH}
 
     - name: Run tests
       run: pytest
diff --git a/README.md b/README.md
@@ -29,6 +29,7 @@ There are some games implemented under `src/IArena/games`:
 - `FieldWalk`: Similar to `BlindWalk` but with access to the whole map from the beginning.
 - `Coins`: 2 player Roman coins game.
 - `Nim`: 2 player well known Nim game.
+- ...
 
 ### Players
 
@@ -38,6 +39,7 @@ There are some players implemented under `src/IArena/players`:
 - `RandomPlayer`: Play a random movement from the movements possible.
 - `FirstPlayer`: Play the first movement from the movements possible.
 - `LastPlayer`: Play the last movement from the movements possible.
+- ...
 
 ### Arena
 
@@ -46,6 +48,7 @@ Implementations of different ways of playing and measuring scores:
 - `GenericGame`: Decide the rules and the players and create a basic loop game.
 - `BroadcastGame`: Similar to `GenericGame` but print out the player actions.
 - `PlayableGame`: Play a game with all players `PlayablePlayer`.
+- ...
 
 ---
 
@@ -63,3 +66,5 @@ There are some resources under `resources` folder with util information and impl
 ### From source
 
 ```bash
+pip install --upgrade git+https://github.com/jparisu/IArena.git
+```
diff --git a/docs/conf.py b/docs/conf.py
@@ -12,3 +12,10 @@
 
 # The master toctree document.
 master_doc = 'index'
+
+# The spelling list filename.
+spelling_word_list_filename=['spelling/spelling_wordlist.txt']
+
+# Change tab title
+release = '1.0.0'
+html_title = f"{project} {release} Documentation"
diff --git a/docs/index.rst b/docs/index.rst
@@ -6,8 +6,8 @@
    :maxdepth: 2
    :hidden:
 
-   /src/getting_started
-   /src/installation
+   /src/getting_started/getting_started
+   /src/getting_started/installation
 
 
 .. toctree::
@@ -51,4 +51,4 @@
    :maxdepth: 2
    :hidden:
 
-   /rst/appendixes/glossary
+   /src/appendixes/glossary
diff --git a/docs/spelling/spelling_wordlist.txt b/docs/spelling/spelling_wordlist.txt
@@ -1,2 +1,11 @@
 Colab
 IArena
+IGameRules
+IMovement
+IPosition
+IPlayer
+Tic
+Tac
+Toe
+conda
+NQueens
diff --git a/docs/src/appendixes/glossary.rst b/docs/src/appendixes/glossary.rst
@@ -0,0 +1,26 @@
+
+.. _glossary:
+
+########
+Glossary
+########
+
+.. glossary::
+
+    Arena
+        A class that represents the game flow. Uses one GameRule and several players to play a game, returning the final score.
+
+    GameRule
+        A class that defines the rules of a game. It contains methods to help creating the game flow.
+
+    Movement
+        A class that represents a movement in a game. Along with GameRules, generates new Positions given a source one.
+
+    Player
+        A class that represents a player in a game. It contains the method to return a movement given a position.
+
+    Position
+        A class that represents a specific state of a game. Along with the GameRules, it defines the game.
+
+    Score
+        A class that represents the score of a terminated game. Each player has its own score.
diff --git a/docs/src/games/games.rst b/docs/src/games/games.rst
@@ -18,9 +18,9 @@ The *IMovement* represents a movement of the game that goes from one position to
 
 .. _rules:
 
-------
-IRules
-------
+----------
+IGameRules
+----------
 
 Represent the rules of a game implementing the following methods:
 
@@ -236,3 +236,12 @@ This is a list of all the games supported and its characteristics:
      - Random
      - Hidden information
      -
+
+   * - **Connect 4**
+     - ``IArena.games.Connect4``
+     - :ref:`connect4_tutorial`
+     - Connect 4 game.
+     - 2
+     - Deterministic
+     - Perfect information
+     - **0 sum game**
diff --git a/docs/src/games/tutorials/coins.rst b/docs/src/games/tutorials/coins.rst
@@ -73,7 +73,6 @@ A position is represented by an ``int`` describing the size of the remaining sta
 Rules
 =====
 
-This games has every methods of :ref:`IRules <infrastructure_rules>`.
 
 It counts with 2 methods to get the minimum and maximum number of coins that can be taken:
 

diff --git a/docs/src/games/tutorials/fieldwalk.rst b/docs/src/games/tutorials/fieldwalk.rst
@@ -94,7 +94,6 @@ One indicates the x axis, other the y axis and the last one the cost to arrive t
 Rules
 =====
 
-This games has every methods of :ref:`IRules <infrastructure_rules>`.
 
 -----------
 Constructor

diff --git a/docs/src/games/tutorials/hanoi.rst b/docs/src/games/tutorials/hanoi.rst
@@ -83,7 +83,6 @@ The disks go from ``0`` to ``N-1`` in ascending order being ``0`` the highest di
 Rules
 =====
 
-This games has every methods of :ref:`IRules <infrastructure_rules>`.
 
 -----------
 Constructor

diff --git a/docs/src/games/tutorials/highestcard.rst b/docs/src/games/tutorials/highestcard.rst
@@ -9,7 +9,7 @@ Highest Card
 
 This game is a card game with ``N`` players and ``NxM`` cards.
 The objective of the game is to guess the number of rounds that the player will win with its ``M`` cards.
-Each player guesses in secret at the begining knowing only their ``M`` cards, for how many rounds it will win.
+Each player guesses in secret at the beginning knowing only their ``M`` cards, for how many rounds it will win.
 Then, ``M`` rounds are played in which each player plays its highest card.
 The player that gets closer to the real number of rounds that it wins without passing it, wins the game.
 
@@ -84,7 +84,6 @@ Each player can get its cards from the position, and only its cards.
 Rules
 =====
 
-This games has every methods of :ref:`IRules <infrastructure_rules>`.
 
 It counts with 2 method to retrieve the values of the game
 

diff --git a/docs/src/games/tutorials/mastermind.rst b/docs/src/games/tutorials/mastermind.rst
@@ -15,7 +15,7 @@ The goal is to guess the code in the fewest number of turns.
 
 Some changes have been made to the original game:
 
-- There is only a one player game (guesser) while the other player (codemaker) is the game itself.
+- There is only a one player game (guesser) while the other player (password-maker) is the game itself.
 - Instead of colors we use numbers.
 - The clues of each guess is not only the number of appearance and correctness, but are linked with a direct position in the guess.
 - Numbers could be repeated in the secret code.
@@ -105,7 +105,6 @@ or whether it is not present in the secret code (``0``).
 Rules
 =====
 
-This games has every methods of :ref:`IRules <infrastructure_rules>`.
 
 It counts with 2 methods to get the minimum and maximum number of coins that can be taken:
 

diff --git a/docs/src/games/tutorials/nim.rst b/docs/src/games/tutorials/nim.rst
@@ -84,7 +84,6 @@ A position is represented by a ``list`` of ``int`` describing each row:
 Rules
 =====
 
-This games has every methods of :ref:`IRules <infrastructure_rules>`.
 
 
 -----------

diff --git a/docs/src/games/tutorials/nqueens.rst b/docs/src/games/tutorials/nqueens.rst
@@ -47,14 +47,14 @@ Movement
 A movement is represented by a tuple ``new_position`` of 2 ``int``:
 
 - ``new_position``
-  - ``tuple(int, int)``
-    - ``int``
-    - ``0 <= tower_source < N``
-    - Number of row to place the next queen.
-  - ``tuple(int, int)``
-    - ``int``
-    - ``0 <= tower_source < N``
-    - Number of column to place the next queen.
+    - ``tuple(int, int)``
+        - ``int``
+        - ``0 <= tower_source < N``
+        - Number of row to place the next queen.
+    - ``tuple(int, int)``
+        - ``int``
+        - ``0 <= tower_source < N``
+        - Number of column to place the next queen.
 
 
 .. code-block:: python
@@ -82,7 +82,6 @@ Each movement represents the position of a queen in the board.
 Rules
 =====
 
-This games has every methods of :ref:`IRules <infrastructure_rules>`.
 
 Remember that using ``score`` method can give the current result of the game:
 

diff --git a/docs/src/games/tutorials/prisoner.rst b/docs/src/games/tutorials/prisoner.rst
@@ -79,7 +79,6 @@ The rules are stored within the rules
 Rules
 =====
 
-This games has every methods of :ref:`IRules <infrastructure_rules>`.
 
 It counts with 1 method to retrieve the score matrix:
 
@@ -90,7 +89,7 @@ It counts with 1 method to retrieve the score matrix:
 Constructor
 -----------
 
-To construct the rules, it can give the score table, or let it be creater randomly:
+To construct the rules, it can give the score table, or let it be created randomly:
 
 #. Using a secret code already defined.
 

diff --git a/docs/src/games/tutorials/slicing.rst b/docs/src/games/tutorials/slicing.rst
@@ -109,7 +109,6 @@ It counts with the following methods:
 Rules
 =====
 
-This games has every methods of :ref:`IRules <infrastructure_rules>`.
 
 
 -----------

diff --git a/docs/src/games/tutorials/tictactoe.rst b/docs/src/games/tutorials/tictactoe.rst
@@ -90,7 +90,6 @@ Each position is represented by an integer, ``0`` for empty, ``1`` for player 1
 Rules
 =====
 
-This games has every methods of :ref:`IRules <infrastructure_rules>`.
 
 
 -----------

diff --git a/docs/src/getting_started.rst → docs/src/getting_started/getting_started.rst b/docs/src/getting_started.rst → docs/src/getting_started/getting_started.rst
@@ -8,8 +8,9 @@ Getting Started
 Project Overview
 ================
 
-In order to know more about the infrastructure and design of this software from a developer point of view,
-check the :ref:`infrastructure` section.
+.. warning::
+
+    Coming soon.
 
 
 ============
@@ -45,10 +46,6 @@ In order to do so follow this instructions with the game desired:
     game = PlayableGame(rules)
     score = game.play()
 
-.. note::
-
-    Always remember that the lowest score is the best one.
-
 
 ==============
 Build a player

diff --git a/docs/src/installation.rst → docs/src/getting_started/installation.rst b/docs/src/installation.rst → docs/src/getting_started/installation.rst
@@ -10,7 +10,7 @@ Installation
 Google Colab
 ============
 
-Using :ref:`Google Colab <https://colab.google>` is the easiest way to get started.
+Using `Google Colab <https://colab.google>` is the easiest way to get started.
 Just add in the first cell of your notebook:
 
 .. code-block:: python
@@ -35,13 +35,22 @@ From a command prompt, you can install it in a conda environment inside Anaconda
 .. code-block:: bash
 
     conda install git
-    pip install --upgrade git+https://github.com/jparisu/[email protected]
+    pip install --upgrade git+https://github.com/jparisu/IArena.git
+
+
+===========================
+Install with pip
+===========================
+
+To install the package with ``pip``, you can use the following command:
+
+.. code-block:: bash
+
+    pip install --upgrade git+https://github.com/jparisu/IArena.git
 
 
 ===========
 Coming soon
 ===========
 
 - Installation from source
-- Installation via ``pip``
-- Installation via ``conda``
diff --git a/docs/src/infraestructure.rst b/docs/src/infraestructure.rst
-Original file line number
+Diff line change
@@ Expand Up @@
     Rules
     =====
-    This games has every methods of :ref:`IRules <infrastructure_rules>`.
     It counts with 2 methods to get the minimum and maximum number of coins that can be taken:
@@ Expand Down @@