Add battleship game

[waynehamadi]

Background

Changes

PR Quality Checklist

• I have run the following commands against my code to ensure it passes our linters:

  black . --exclude test.py
  isort .
  mypy .
  autoflake --remove-all-unused-imports --recursive --ignore-init-module-imports --ignore-pass-after-docstring --in-place agbenchmark

[github-actions]

PR Analysis

• 🎯 Main theme: Addition of a new game 'Battleship' to the agbenchmark project.
• 📝 PR summary: This PR introduces a new game, 'Battleship', to the agbenchmark project. The game is implemented in Python and includes tests for both positive and negative scenarios. The PR also includes updates to the project's configuration files.
• 📌 Type of PR: Enhancement
• 🧪 Relevant tests added: Yes
• 🔒 Security concerns: No security concerns found

PR Feedback

• 💡 General suggestions: The PR is well-structured and the code is clean and readable. The tests cover a wide range of scenarios, which is good for ensuring the robustness of the game. However, there are a few areas where the code could be improved, such as error handling and code duplication.

• 🤖 Code feedback:

  • relevant file: agbenchmark/challenges/verticals/code/5_battleship/artifacts_out/battleship.py
    suggestion: Consider refactoring the ship placement validation logic into a separate method to reduce code duplication and improve readability. [medium]
    relevant line: '+ if start_row < 1 or start_row > 10 or start_col < 0 or start_col > 9:'

  • relevant file: agbenchmark/challenges/verticals/code/5_battleship/artifacts_out/battleship.py
    suggestion: Consider adding more specific error messages for different validation failures in ship placement. This would help users understand what went wrong. [medium]
    relevant line: '+ raise ValueError("Invalid ship type {placement.ship_type}")'

  • relevant file: agbenchmark/challenges/verticals/code/5_battleship/artifacts_out/battleship.py
    suggestion: It would be beneficial to add a check to ensure that the game exists before attempting to delete it. This would prevent potential errors. [important]
    relevant line: '+ def delete_game(self, game_id: str) -> None:'

  • relevant file: agbenchmark/challenges/verticals/code/5_battleship/artifacts_out/battleship.py
    suggestion: Consider adding a check to ensure that the game is not already over before creating a new turn. This would prevent unnecessary operations. [medium]
    relevant line: '+ def create_turn(self, game_id: str, turn: Turn) -> TurnResponse:'

How to use

To invoke the PR-Agent, add a comment using one of the following commands:
/review [-i]: Request a review of your Pull Request. For an incremental review, which only considers changes since the last review, include the '-i' option.
/describe: Modify the PR title and description based on the contents of the PR.
/improve [--extended]: Suggest improvements to the code in the PR. Extended mode employs several calls, and provides a more thorough feedback.
/ask <QUESTION>: Pose a question about the PR.
/update_changelog: Update the changelog based on the PR's contents.

To edit any configuration parameter from configuration.toml, add --config_path=new_value
For example: /review --pr_reviewer.extra_instructions="focus on the file: ..."
To list the possible configuration parameters, use the /config command.