Skip to content

Commit

Permalink
[NEW EXERCISE] State of tic tac toe (#2435)
Browse files Browse the repository at this point in the history
* Adding autogenerated files

* Adding stub

* Adding tests

Amending tests

* Adding proof.ci.js

* Lint & format
  • Loading branch information
Cool-Katt authored May 14, 2024
1 parent 628a743 commit d481a67
Show file tree
Hide file tree
Showing 13 changed files with 564 additions and 0 deletions.
13 changes: 13 additions & 0 deletions config.json
Original file line number Diff line number Diff line change
Expand Up @@ -2608,6 +2608,19 @@
"string-formatting"
],
"difficulty": 5
},
{
"slug": "state-of-tic-tac-toe",
"name": "State of Tic-Tac-Toe",
"uuid": "b381543d-2bcf-4999-9d44-788a2b39c1a0",
"practices": [],
"prerequisites": [
"strings",
"array-loops",
"conditionals",
"errors"
],
"difficulty": 5
}
]
},
Expand Down
101 changes: 101 additions & 0 deletions exercises/practice/state-of-tic-tac-toe/.docs/instructions.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,101 @@
# Instructions

In this exercise, you're going to implement a program that determines the state of a [tic-tac-toe][] game.
(_You may also know the game as "noughts and crosses" or "Xs and Os"._)

The games is played on a 3×3 grid.
Players take turns to place `X`s and `O`s on the grid.
The game ends when one player has won by placing three of marks in a row, column, or along a diagonal of the grid, or when the entire grid is filled up.

In this exercise, we will assume that `X` starts.

It's your job to determine which state a given game is in.

There are 3 potential game states:

- The game is **ongoing**.
- The game ended in a **draw**.
- The game ended in a **win**.

If the given board is invalid, throw an appropriate error.

If a board meets the following conditions, it is invalid:

- The given board cannot be reached when turns are taken in the correct order (remember that `X` starts).
- The game was played after it already ended.

## Examples

### Ongoing game

```text
| |
X | |
___|___|___
| |
| X | O
___|___|___
| |
O | X |
| |
```

### Draw

```text
| |
X | O | X
___|___|___
| |
X | X | O
___|___|___
| |
O | X | O
| |
```

### Win

```text
| |
X | X | X
___|___|___
| |
| O | O
___|___|___
| |
| |
| |
```

### Invalid

#### Wrong turn order

```text
| |
O | O | X
___|___|___
| |
| |
___|___|___
| |
| |
| |
```

#### Continued playing after win

```text
| |
X | X | X
___|___|___
| |
O | O | O
___|___|___
| |
| |
| |
```

[tic-tac-toe]: https://en.wikipedia.org/wiki/Tic-tac-toe
14 changes: 14 additions & 0 deletions exercises/practice/state-of-tic-tac-toe/.eslintrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
{
"root": true,
"extends": "@exercism/eslint-config-javascript",
"env": {
"jest": true
},
"overrides": [
{
"files": [".meta/proof.ci.js", ".meta/exemplar.js", "*.spec.js"],
"excludedFiles": ["custom.spec.js"],
"extends": "@exercism/eslint-config-javascript/maintainers"
}
]
}
5 changes: 5 additions & 0 deletions exercises/practice/state-of-tic-tac-toe/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
/node_modules
/bin/configlet
/bin/configlet.exe
/pnpm-lock.yaml
/yarn.lock
19 changes: 19 additions & 0 deletions exercises/practice/state-of-tic-tac-toe/.meta/config.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
{
"authors": [
"Cool-Katt"
],
"files": {
"solution": [
"state-of-tic-tac-toe.js"
],
"test": [
"state-of-tic-tac-toe.spec.js"
],
"example": [
".meta/proof.ci.js"
]
},
"blurb": "Determine the game state of a match of Tic-Tac-Toe.",
"source": "Created by Sascha Mann for the Julia track of the Exercism Research Experiment.",
"source_url": "https://github.com/exercism/research_experiment_1/tree/julia-dev/exercises/julia-1-a"
}
41 changes: 41 additions & 0 deletions exercises/practice/state-of-tic-tac-toe/.meta/proof.ci.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
export const gamestate = (board) => {
let gridSize = board.length;
let numberOfX = board.join('').match(/X/g)?.length ?? 0;
let numberOfO = board.join('').match(/O/g)?.length ?? 0;
let scorringArray = Array(gridSize * 2 + 2).fill(null);
let boardAsNumbers = board
.map((row) =>
row
.split('')
.map((element) =>
element.replaceAll('X', 1).replaceAll('O', -1).replaceAll(/\s/g, 0),
),
)
.flat();

boardAsNumbers.forEach((element, index) => {
let [row, col] = [Math.floor(index / gridSize), index % gridSize];
scorringArray[row] += Number(element);
scorringArray[gridSize + col] += Number(element);
row === col && (scorringArray[2 * gridSize] += Number(element));
gridSize - 1 - col === row &&
(scorringArray[2 * gridSize + 1] += Number(element));
});

switch (true) {
case numberOfX - numberOfO > 1:
throw new Error('Wrong turn order: X went twice');
case numberOfX - numberOfO < 0:
throw new Error('Wrong turn order: O started');
case scorringArray.includes(gridSize) && scorringArray.includes(-gridSize):
throw new Error(
'Impossible board: game should have ended after the game was won',
);
case scorringArray.includes(gridSize) || scorringArray.includes(-gridSize):
return 'win';
case boardAsNumbers.includes('0'):
return 'ongoing';
default:
return 'draw';
}
};
101 changes: 101 additions & 0 deletions exercises/practice/state-of-tic-tac-toe/.meta/tests.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,101 @@
# This is an auto-generated file.
#
# Regenerating this file via `configlet sync` will:
# - Recreate every `description` key/value pair
# - Recreate every `reimplements` key/value pair, where they exist in problem-specifications
# - Remove any `include = true` key/value pair (an omitted `include` key implies inclusion)
# - Preserve any other key/value pair
#
# As user-added comments (using the # character) will be removed when this file
# is regenerated, comments can be added via a `comment` key.

[fe8e9fa9-37af-4d7e-aa24-2f4b8517161a]
description = "Won games -> Finished game where X won via left column victory"

[96c30df5-ae23-4cf6-bf09-5ef056dddea1]
description = "Won games -> Finished game where X won via middle column victory"

[0d7a4b0a-2afd-4a75-8389-5fb88ab05eda]
description = "Won games -> Finished game where X won via right column victory"

[bd1007c0-ec5d-4c60-bb9f-1a4f22177d51]
description = "Won games -> Finished game where O won via left column victory"

[c032f800-5735-4354-b1b9-46f14d4ee955]
description = "Won games -> Finished game where O won via middle column victory"

[662c8902-c94a-4c4c-9d9c-e8ca513db2b4]
description = "Won games -> Finished game where O won via right column victory"

[2d62121f-7e3a-44a0-9032-0d73e3494941]
description = "Won games -> Finished game where X won via top row victory"

[108a5e82-cc61-409f-aece-d7a18c1beceb]
description = "Won games -> Finished game where X won via middle row victory"
include = false

[346527db-4db9-4a96-b262-d7023dc022b0]
description = "Won games -> Finished game where X won via middle row victory"
reimplements = "108a5e82-cc61-409f-aece-d7a18c1beceb"

[a013c583-75f8-4ab2-8d68-57688ff04574]
description = "Won games -> Finished game where X won via bottom row victory"

[2c08e7d7-7d00-487f-9442-e7398c8f1727]
description = "Won games -> Finished game where O won via top row victory"

[bb1d6c62-3e3f-4d1a-9766-f8803c8ed70f]
description = "Won games -> Finished game where O won via middle row victory"

[6ef641e9-12ec-44f5-a21c-660ea93907af]
description = "Won games -> Finished game where O won via bottom row victory"

[ab145b7b-26a7-426c-ab71-bf418cd07f81]
description = "Won games -> Finished game where X won via falling diagonal victory"

[7450caab-08f5-4f03-a74b-99b98c4b7a4b]
description = "Won games -> Finished game where X won via rising diagonal victory"

[c2a652ee-2f93-48aa-a710-a70cd2edce61]
description = "Won games -> Finished game where O won via falling diagonal victory"

[5b20ceea-494d-4f0c-a986-b99efc163bcf]
description = "Won games -> Finished game where O won via rising diagonal victory"

[035a49b9-dc35-47d3-9d7c-de197161b9d4]
description = "Won games -> Finished game where X won via a row and a column victory"

[e5dfdeb0-d2bf-4b5a-b307-e673f69d4a53]
description = "Won games -> Finished game where X won via two diagonal victories"

[b42ed767-194c-4364-b36e-efbfb3de8788]
description = "Drawn games -> Draw"

[227a76b2-0fef-4e16-a4bd-8f9d7e4c3b13]
description = "Drawn games -> Another draw"

[4d93f15c-0c40-43d6-b966-418b040012a9]
description = "Ongoing games -> Ongoing game: one move in"

[c407ae32-4c44-4989-b124-2890cf531f19]
description = "Ongoing games -> Ongoing game: two moves in"

[199b7a8d-e2b6-4526-a85e-78b416e7a8a9]
description = "Ongoing games -> Ongoing game: five moves in"

[1670145b-1e3d-4269-a7eb-53cd327b302e]
description = "Invalid boards -> Invalid board: X went twice"

[47c048e8-b404-4bcf-9e51-8acbb3253f3b]
description = "Invalid boards -> Invalid board: O started"

[b1dc8b13-46c4-47db-a96d-aa90eedc4e8d]
description = "Invalid boards -> Invalid board"
include = false

[6c1920f2-ab5c-4648-a0c9-997414dda5eb]
description = "Invalid boards -> Invalid board: X won and O kept playing"
reimplements = "b1dc8b13-46c4-47db-a96d-aa90eedc4e8d"

[4801cda2-f5b7-4c36-8317-3cdd167ac22c]
description = "Invalid boards -> Invalid board: players kept playing after a win"
1 change: 1 addition & 0 deletions exercises/practice/state-of-tic-tac-toe/.npmrc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
audit=false
21 changes: 21 additions & 0 deletions exercises/practice/state-of-tic-tac-toe/LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2021 Exercism

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
4 changes: 4 additions & 0 deletions exercises/practice/state-of-tic-tac-toe/babel.config.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
module.exports = {
presets: ['@exercism/babel-preset-javascript'],
plugins: [],
};
34 changes: 34 additions & 0 deletions exercises/practice/state-of-tic-tac-toe/package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
{
"name": "@exercism/javascript-state-of-tic-tac-toe",
"description": "Exercism practice exercise on state-of-tic-tac-toe",
"author": "Katrina Owen",
"contributors": [
"Derk-Jan Karrenbeld <[email protected]> (https://derk-jan.com)",
"Tejas Bubane (https://tejasbubane.github.io/)",
"Cool-Katt (https://github.com/Cool-Katt)"
],
"private": true,
"license": "MIT",
"repository": {
"type": "git",
"url": "https://github.com/exercism/javascript",
"directory": "exercises/practice/state-of-tic-tac-toe"
},
"devDependencies": {
"@babel/core": "^7.23.0",
"@exercism/babel-preset-javascript": "^0.2.1",
"@exercism/eslint-config-javascript": "^0.6.0",
"@types/jest": "^29.5.4",
"@types/node": "^20.5.6",
"babel-jest": "^29.6.4",
"core-js": "~3.32.2",
"eslint": "^8.49.0",
"jest": "^29.7.0"
},
"dependencies": {},
"scripts": {
"test": "jest ./*",
"watch": "jest --watch ./*",
"lint": "eslint ."
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
//
// This is only a SKELETON file for the 'State of Tic Tac Toe' exercise. It's been provided as a
// convenience to get you started writing code faster.
//

export const gamestate = (board) => {
throw new Error('Remove this statement and implement this function');
};
Loading

0 comments on commit d481a67

Please sign in to comment.