refactor: board generator (#586)

* refactor: move models to folder

* refactor: rename package to board generator

* refactor: rename scripts folder to tool

* docs: update readme

* chore: update gitignore

* Update packages/board_generator/README.md

Co-authored-by: Alejandro Santiago <dev@alestiago.com>

* refactor: move tool outside of lib

---------

Co-authored-by: Alejandro Santiago <dev@alestiago.com>

.github/workflows/board_generator.yaml

@@ -1,4 +1,4 @@
-name: board_uploader
+name: board_generator
 
 concurrency:
   group: ${{ github.workflow }}-${{ github.ref }}
@@ -7,8 +7,8 @@ concurrency:
 on:
   pull_request:
     paths:
-      - "packages/board_uploader/**"
-      - ".github/workflows/board_uploader.yaml"
+      - "packages/board_generator/**"
+      - ".github/workflows/board_generator.yaml"
     branches:
       - main
 
@@ -17,6 +17,7 @@ jobs:
     uses: VeryGoodOpenSource/very_good_workflows/.github/workflows/dart_package.yml@v1
     with:
       dart_sdk: stable
-      working_directory: packages/board_uploader
+      working_directory: packages/board_generator
       coverage_excludes: "**/*.g.dart"
-      min_coverage: 20
+      min_coverage: 100
+      check_ignore: true

.github/workflows/board_generator_playground.yaml → .github/workflows/board_uploader.yaml

@@ -1,4 +1,4 @@
-name: board_generator_playground
+name: board_uploader
 
 concurrency:
   group: ${{ github.workflow }}-${{ github.ref }}
@@ -7,8 +7,8 @@ concurrency:
 on:
   pull_request:
     paths:
-      - "packages/board_generator_playground/**"
-      - ".github/workflows/board_generator_playground.yaml"
+      - "packages/board_uploader/**"
+      - ".github/workflows/board_uploader.yaml"
     branches:
       - main
 
@@ -17,7 +17,6 @@ jobs:
     uses: VeryGoodOpenSource/very_good_workflows/.github/workflows/dart_package.yml@v1
     with:
       dart_sdk: stable
-      working_directory: packages/board_generator_playground
+      working_directory: packages/board_uploader
       coverage_excludes: "**/*.g.dart"
-      min_coverage: 100
-      check_ignore: true
+      min_coverage: 20

packages/board_generator_playground/.gitignore → packages/board_generator/.gitignore

@@ -7,5 +7,5 @@ build/
 pubspec.lock
 
 **/**.csv
-/**_crossword.txt
-/board.txt
+**/**_crossword.txt
+**/board_**.txt

packages/board_generator/README.md

@@ -0,0 +1,27 @@
+# Board Generator
+
+Package used to experiment with the board generation process.
+
+## 📝 Getting a list of words
+
+To generate a board, you need a set of words and clues that will be used as an input. Create a `words.csv` file inside the `tool` directory with the following format:
+
+```none
+word,"clue"
+flutter,"Open source framework to build multi-platform applications"
+firebase,"Mobile and web app development platform by Google"
+```
+
+If you need some inspiration, you can always [ask gemini](https://g.co/gemini/share/488086554d89) for help.
+
+## 🧩 Generating a board
+
+You can either generate a symmetrical crossword or an asymmetrical one by running its corresponding script from the `tool` directory.
+
+```bash
+dart asymmetrical_generation.dart
+```
+
+You can customize the size of the generated board by updating the `bounds` parameter in the `Crossword`.
+
+The script will generate two outputs, a visual representation of the crossword in `asymmetrical_crossword.txt` and a csv file (`board_asymmetrical.txt`) with the position, direction, words and clues for the generated board. The csv is ready to be used by the `board_uploader` package to store the new board in firestore.

packages/board_generator_playground/lib/board_generator_playground.dart → packages/board_generator/lib/board_generator.dart

@@ -3,7 +3,5 @@ library;
 
 export 'src/crossword.dart';
 export 'src/generators/generators.dart';
-export 'src/horizontal_line_of_symmetry.dart';
 export 'src/models/models.dart';
 export 'src/sort_words.dart';
-export 'src/word_pool.dart';

packages/board_generator_playground/lib/src/crossword.dart → packages/board_generator/lib/src/crossword.dart

@@ -1,4 +1,4 @@
-import 'package:board_generator_playground/board_generator_playground.dart';
+import 'package:board_generator/board_generator.dart';
 
 /// {@template character_map}
 /// Maps a [Location] to a [CharacterData].

packages/board_generator_playground/lib/src/generators/asymmetrical_crossword_generator.dart → packages/board_generator/lib/src/generators/asymmetrical_crossword_generator.dart

@@ -1,6 +1,6 @@
 // coverage:ignore-file
 
-import 'package:board_generator_playground/board_generator_playground.dart';
+import 'package:board_generator/board_generator.dart';
 
 /// {@template asymmetrical_crossword_generator}
 /// A simple crossword generator that populates a crossword without

packages/board_generator_playground/lib/src/generators/crossword_generator.dart → packages/board_generator/lib/src/generators/crossword_generator.dart

@@ -1,6 +1,6 @@
 // coverage:ignore-file
 
-import 'package:board_generator_playground/board_generator_playground.dart';
+import 'package:board_generator/board_generator.dart';
 
 /// {@template crossword_generator}
 /// A generator that populates a [Crossword] with words from a [WordPool].

packages/board_generator_playground/lib/src/generators/symmetrical_crossword_generator.dart → packages/board_generator/lib/src/generators/symmetrical_crossword_generator.dart

@@ -1,6 +1,6 @@
 // coverage:ignore-file
 
-import 'package:board_generator_playground/board_generator_playground.dart';
+import 'package:board_generator/board_generator.dart';
 
 /// {@template symmetrical_crossword_generator}
 /// A simple crossword generator that populates a crossword with an

packages/board_generator_playground/lib/src/models/bounds.dart → packages/board_generator/lib/src/models/bounds.dart

@@ -1,4 +1,4 @@
-import 'package:board_generator_playground/board_generator_playground.dart';
+import 'package:board_generator/board_generator.dart';
 import 'package:equatable/equatable.dart';
 
 /// A set of bounds that define a rectangular region in the crossword puzzle.

packages/board_generator_playground/lib/src/models/character_data.dart → packages/board_generator/lib/src/models/character_data.dart

@@ -1,4 +1,4 @@
-import 'package:board_generator_playground/board_generator_playground.dart';
+import 'package:board_generator/board_generator.dart';
 import 'package:equatable/equatable.dart';
 
 /// {@template character_data}

packages/board_generator_playground/lib/src/horizontal_line_of_symmetry.dart → packages/board_generator/lib/src/models/horizontal_line_of_symmetry.dart

@@ -1,4 +1,4 @@
-import 'package:board_generator_playground/board_generator_playground.dart';
+import 'package:board_generator/board_generator.dart';
 
 /// {@template horizontal_line_of_symmetry}
 /// An horizontal line of symmetry.

packages/board_generator_playground/lib/src/models/models.dart → packages/board_generator/lib/src/models/models.dart

@@ -1,5 +1,7 @@
 export 'bounds.dart';
 export 'character_data.dart';
 export 'direction.dart';
+export 'horizontal_line_of_symmetry.dart';
 export 'location.dart';
 export 'word_candidate.dart';
+export 'word_pool.dart';

packages/board_generator_playground/lib/src/models/word_candidate.dart → packages/board_generator/lib/src/models/word_candidate.dart

@@ -1,5 +1,5 @@
-import 'package:board_generator_playground/board_generator_playground.dart';
-import 'package:board_generator_playground/src/models/models.dart';
+import 'package:board_generator/board_generator.dart';
+import 'package:board_generator/src/models/models.dart';
 import 'package:equatable/equatable.dart';
 
 /// {@template word_candidate}

packages/board_generator_playground/lib/src/word_pool.dart → packages/board_generator/lib/src/models/word_pool.dart

@@ -1,4 +1,4 @@
-import 'package:board_generator_playground/board_generator_playground.dart';
+import 'package:board_generator/board_generator.dart';
 import 'package:meta/meta.dart';
 
 /// {@template word_pool}

packages/board_generator_playground/pubspec.yaml → packages/board_generator/pubspec.yaml

@@ -1,5 +1,5 @@
-name: board_generator_playground
-description: Ephemeral package used to experiment with the board generation process.
+name: board_generator
+description: Package used to experiment with the board generation process.
 version: 0.1.0+1
 publish_to: none
 

packages/board_generator_playground/test/src/crossword_test.dart → packages/board_generator/test/src/crossword_test.dart

@@ -1,8 +1,8 @@
 // ignore_for_file: prefer_const_constructors
 // ignore_for_file: prefer_const_literals_to_create_immutables
 
-import 'package:board_generator_playground/src/crossword.dart';
-import 'package:board_generator_playground/src/models/models.dart';
+import 'package:board_generator/src/crossword.dart';
+import 'package:board_generator/src/models/models.dart';
 import 'package:test/test.dart';
 
 import 'fixtures/crosswords.dart';

packages/board_generator_playground/test/src/fixtures/crosswords.dart → packages/board_generator/test/src/fixtures/crosswords.dart

@@ -1,5 +1,5 @@
-import 'package:board_generator_playground/src/crossword.dart';
-import 'package:board_generator_playground/src/models/models.dart';
+import 'package:board_generator/src/crossword.dart';
+import 'package:board_generator/src/models/models.dart';
 
 /// {@template crossword1}
 /// A pre-defined crossword for testing.

packages/board_generator_playground/test/src/line_of_symmetry_test.dart → packages/board_generator/test/src/line_of_symmetry_test.dart

@@ -1,6 +1,6 @@
 // ignore_for_file: prefer_const_constructors
 
-import 'package:board_generator_playground/board_generator_playground.dart';
+import 'package:board_generator/board_generator.dart';
 import 'package:test/test.dart';
 
 void main() {

packages/board_generator_playground/test/src/models/bounds_test.dart → packages/board_generator/test/src/models/bounds_test.dart

@@ -1,6 +1,6 @@
 // ignore_for_file: prefer_const_constructors
 
-import 'package:board_generator_playground/src/models/models.dart';
+import 'package:board_generator/src/models/models.dart';
 import 'package:test/test.dart';
 
 void main() {

packages/board_generator_playground/test/src/models/location_test.dart → packages/board_generator/test/src/models/location_test.dart

@@ -1,6 +1,6 @@
 // ignore_for_file: prefer_const_constructors
 
-import 'package:board_generator_playground/src/models/location.dart';
+import 'package:board_generator/src/models/location.dart';
 import 'package:test/test.dart';
 
 void main() {

packages/board_generator_playground/test/src/models/word_candidate_test.dart → packages/board_generator/test/src/models/word_candidate_test.dart

@@ -1,4 +1,4 @@
-import 'package:board_generator_playground/src/models/models.dart';
+import 'package:board_generator/src/models/models.dart';
 import 'package:test/test.dart';
 
 void main() {

packages/board_generator_playground/test/src/models/word_entry_test.dart → packages/board_generator/test/src/models/word_entry_test.dart

@@ -1,6 +1,6 @@
 // ignore_for_file: prefer_const_constructors
 
-import 'package:board_generator_playground/src/models/models.dart';
+import 'package:board_generator/src/models/models.dart';
 import 'package:test/test.dart';
 
 void main() {

packages/board_generator_playground/test/src/sort_words_test.dart → packages/board_generator/test/src/sort_words_test.dart

@@ -1,4 +1,4 @@
-import 'package:board_generator_playground/src/sort_words.dart';
+import 'package:board_generator/src/sort_words.dart';
 import 'package:test/test.dart';
 
 void main() {

packages/board_generator_playground/test/src/word_pool_test.dart → packages/board_generator/test/src/word_pool_test.dart

@@ -1,8 +1,7 @@
 // ignore_for_file: prefer_const_constructors
 // ignore_for_file: prefer_const_literals_to_create_immutables
 
-import 'package:board_generator_playground/src/models/models.dart';
-import 'package:board_generator_playground/src/word_pool.dart';
+import 'package:board_generator/src/models/models.dart';
 import 'package:test/test.dart';
 
 void main() {

packages/board_generator_playground/lib/scripts/asymmetrical_generation.dart → packages/board_generator/tool/asymmetrical_generation.dart

@@ -1,9 +1,10 @@
 import 'dart:io';
 
-import 'package:board_generator_playground/board_generator_playground.dart';
-import 'package:board_generator_playground/scripts/model/model.dart';
+import 'package:board_generator/board_generator.dart';
 import 'package:csv/csv.dart';
 
+import 'model/model.dart';
+
 void main({void Function(String) log = print}) {
   final fileString = File('words.csv').readAsStringSync();
   final rows = const CsvToListConverter().convert(fileString);

packages/board_generator_playground/lib/scripts/symmetrical_generation.dart → packages/board_generator/tool/symmetrical_generation.dart

@@ -1,9 +1,10 @@
 import 'dart:io';
 
-import 'package:board_generator_playground/board_generator_playground.dart';
-import 'package:board_generator_playground/scripts/model/model.dart';
+import 'package:board_generator/board_generator.dart';
 import 'package:csv/csv.dart';
 
+import 'model/model.dart';
+
 void main({
   void Function(String) log = print,
 }) {

packages/board_uploader/README.md

@@ -12,7 +12,7 @@ This package is responsible for dividing the board into sections and uploading i
 
 ### Dividing the board in sections
 
-Add a `board.txt` file inside the `assets` folder with the board generated by the `board_generator_playground` package.
+Add a `board.txt` file inside the `assets` folder with the board generated by the `board_generator` package.
 Once the board is generated, create the sections and upload them to Firestore by running:
 
 ```sh