feat: Implement dynamic level generation - #70
Merged
Conversation
- Injected `LevelGenerator` into `LevelRepository` to enable dynamic level creation. - Updated `getLevel()` to generate and save a new level if it's not found in the local database. - Added comprehensive logging throughout the `LevelRepository` to trace level generation, loading, and saving processes. - Implemented error handling with logging in `getLevel()` for better debugging.
This commit adds a new data model, `Crossword`, to represent a single word within a crossword puzzle. - **`Crossword` Class:** A new class to hold the word string, its definition, direction (`across` or `down`), and its index (row or column). It includes `fromMap`, `toMap`, `copyWith` methods, and is `Equatable`. - **`CrossWordDirection` Enum:** Defines the possible orientations for a word: `across` and `down`.
- Updated the Dart SDK constraint to `^3.9.0`. - Added `very_good_analysis: ^10.0.0` as a new development dependency. - Replaced the standard `lints/recommended.yaml` with `package:very_good_analysis/analysis_options.yaml` to enforce stricter linting rules.
- Added comprehensive Dartdocs to the `LevelData`, `Reward`, `RewardCoin`, and `Badge` classes to improve clarity and usability. - Introduced `copyWith` methods to `LevelData` for easier immutable updates. - Added `const` constructors to all data models, enabling compile-time constant instantiation and improved performance. - Reordered methods and constructors within the `Reward` hierarchy for better code organization and readability. - Updated the example file to use `const` for model instantiation, reflecting the new changes.
This commit introduces crossword-specific data to the `LevelData` model. - Added a `crosswords` field (`Map<String, Crossword>`) to `LevelData` to store crossword details. - Updated `LevelData.fromMap` and `toMap` to handle serialization and deserialization of the new `crosswords` data. - The `empty` constructor and `copyWith` method have been updated to include the `crosswords` field. - The `Crossword` model is now exported from the main library file. - The example usage has been updated to demonstrate how to include `crosswords` data when creating a `LevelData` instance.
- Introduced `getLevels()` to the `ILevelRepository` interface. This method will allow fetching a list of all `LevelData` objects.
The `ApploaderRepository` is updated to fetch level data dynamically from the injected `ILevelRepository`. This change removes the hardcoded level data, allowing for a more flexible and scalable level loading mechanism.
This commit introduces the `level_generator` package, a comprehensive engine for creating crossword-style game levels. It includes logic for word selection, grid generation, and definition fetching.
- **`LevelGenerator`**: The main orchestrator that combines word selection, grid creation, and definition fetching to produce `LevelData`. It adjusts difficulty based on the level number.
- **`CrosswordGenerator`**: Implements a recursive backtracking algorithm to generate the most compact crossword grid from a given list of words. It supports finding the optimal layout by trying different initial word placements.
- **`WordListService`**: Manages loading words from assets and selecting a suitable, connected set of words for a given level based on length and other constraints. It ensures that the selected words can form a single connected component.
- **`DefinitionFetcher`**: Fetches word definitions using the `free_dictionary_api_v2` package, with an optimized strategy to find the most suitable definition.
- **Models**:
- `CrosswordGrid`: Represents the final 2D grid, including its dimensions and data.
- `WordPlacement`: Stores the position and orientation of a word within the grid.
- `DifficultyConfig`: Defines game difficulty parameters like word length, word count, and grid size.
- **Configuration & CI**:
- Added `pubspec.yaml` with dependencies like `free_dictionary_api_v2`, `http`, and `equatable`.
- Set up a standard CI workflow using GitHub Actions for linting, testing, and spell-checking.
- Included project configuration files (`.gitignore`, `analysis_options.yaml`, issue templates, etc.).
- **Tests**:
- Added unit tests for `CrosswordGenerator` to verify grid generation logic.
- Included basic instantiation tests for `LevelGenerator`.
This commit introduces a new extension method, `toDirection`, on the `String` class. It converts a string to a `CrossWordDirection` enum value, throwing an exception if the string is invalid. This utility simplifies the process of parsing direction data from a string representation.
A new `CrosswordCluesDialog` widget has been added to display all crossword clues for the current level. - The dialog separates clues into "ACROSS" and "DOWN" sections. - Clues are sorted by their direction index. - It displays the clue number, definition, and word length. - Found words are visually distinguished: they are struck-through, dimmed, and marked with a check icon, and the solved word is displayed. - The dialog is responsive to different screen sizes. - It integrates with the `GamePlayBloc` to check the status of each word.
A new button, `CrosswordCluesButton`, has been added to the game UI. This button is conditionally rendered and will only appear if the current level contains crossword puzzles. When pressed, it opens a `CrosswordCluesDialog` which displays the clues for the crosswords in the current level. The dialog gets the necessary level data from the `GamePlayBloc`.
- Added `CrosswordCluesButton` and `CrosswordCluesDialog` to the view's public API by exporting them from `view.dart`.
A new local package, `level_generator`, has been added to the project's dependencies. This also introduces its transitive dependencies, `dartz` and `free_dictionary_api_v2`, into the project.
This commit refactors the letter generation logic within the `GamePlayLetters` component to ensure the correct number of each character is available to form all the words in a level. - Introduced `normaliseLetterList` to calculate the maximum required count for each letter across all words in the current level. For instance, if 'A' appears twice in one word and three times in another, the list will now correctly contain at least three 'A's. - The `initState` method now uses this new logic to populate the `letters` list, replacing the previous implementation that simply used a set of unique characters from the board data. - The generated list of letters is now shuffled to ensure random placement.
- Imported and integrated the new `CrosswordCluesButton` into the `GamePlayHeader`. - The button is now displayed in both the mobile (column) and desktop (row) layouts of the header.
This commit updates `lib/app.dart` to integrate the `level_generator` package. The `LevelRepository` is now instantiated with a `LevelGenerator`, which is configured with a `CrosswordGenerator`, `WordListService` pointing to `assets/words/wordlist.txt`, and a `DefinitionFetcher`. This enables the dynamic generation of game levels.
The mock `Level` objects used in `GamePlayBloc` and `GamePlayBoard` tests were missing the `crosswords` parameter. This commit updates the `Level` instantiations to include an empty `crosswords` map, aligning the test data with the class constructor.
The `withOpacity()` method, which is deprecated, has been replaced with the const `withValues()` method for adjusting color opacity.
The call to `deleteLevels()` has been removed from the `getLevels` method in `LevelRepository`. This prevents the deletion of all levels every time they are fetched, ensuring data persistence.
The `dartz` package dependency has been removed. Additionally, the Dart SDK constraint has been updated from `>=3.8.0 <4.0.0` to `>=3.9.0 <4.0.0`.
In the `game_play_letters_test.dart` file, the `const` keyword has been added to the `LevelData.empty()` constructor call. This improves performance by allowing the compiler to create a compile-time constant.
A check has been added to `GamePlayLetters` to prevent the `letters` list from being cleared when `levelData.words` is empty. This avoids issues in test environments where levels might be initialized without words, ensuring that letter data is preserved.
- Added a mock implementation for the `getLevels` method in the `ApploaderRepository` test. - The test now provides a predefined list of `LevelData` objects when `levelRepo.getLevels()` is called, ensuring the `getLevels` method returns a `LevelList` as expected.
Several files and specific code blocks have been marked to be ignored during code coverage analysis. This helps to focus coverage metrics on testable business logic by excluding boilerplate, framework-specific implementations, and untestable code. - Ignored `user_stats_repository.dart` and `user_progress_data.dart` entirely. - Excluded factory constructors, `decreaseBy` methods, and `props` getters in `booster.dart`. - Marked the `_handleRevealRandomLetter` event handler in `game_play_bloc.dart` to be ignored. - Ignored helper methods and lifecycle overrides (`normaliseLetterList`, `_onInputStart`, `_clearGuess`, etc.) within the `game_play_letters.dart` widget.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Type of Change