JuliaMathias / moolah / c13d32534f1db70650f0ac45853196b84b962376

4%

push

github

Create core investments resource with history and operations (#67)

* Add guideline for referencing GitHub issues

Adds a new guideline to the project documentation specifying that when a task references a GitHub issue, the issue text should be fetched using `gh issue view <number>` and copied into a `private_docs/issues/issue-<number>-*.md` file. This helps maintain clarity and organization in issue tracking.

* Add `credo` to precommit hooks

Updates the `precommit` hooks in the `mix.exs` file to include `credo --strict`. This change ensures that code quality checks are enforced before commits, promoting better coding standards and reducing potential issues in the codebase.

* Add guideline to run `mix format` after file changes

Updates the project guidelines to include a requirement for developers to always run `mix format` after creating or editing a file. This change aims to ensure consistent code formatting across the project.

* Update project guidelines for function documentation

Adds requirements for new functions to include `@spec` and public functions to have `@doc`. Enhances module documentation by specifying that it must be detailed and include examples when appropriate. Mandates that migrations include a `@moduledoc` explaining the reasons for changes. Encourages the use of explanatory comments for private functions and inline comments for complex logic in tests.

* Create `CreateInvestmentHistory` module for managing investment history snapshots

Adds functionality to create and update investment history snapshots when investments are created or modified. The `change/3` function handles the logic for determining the mode of operation (create or update) and invokes the appropriate private functions. The `create_history_on_create/1` function builds history entries based on the purchase date and current value, while `create_history_on_update/2` appends a new snapshot if the `current_value` changes. The `insert_history_entries/2` function... (continued)

70 of 70 new or added lines in 6 files covered. (100.0%)

350 of 10867 relevant lines covered (3.22%)

0.61 hits per line