From 2db23675e220f79737029a221f706649482b94e0 Mon Sep 17 00:00:00 2001 From: Glauber Brennon Date: Mon, 9 Mar 2026 03:32:49 -0300 Subject: [PATCH 1/6] docs(value-objects): add documentation for MedicationFrequency value object --- docs/domain/value_objects/medication_frequency.md | 9 +++++++++ 1 file changed, 9 insertions(+) create mode 100644 docs/domain/value_objects/medication_frequency.md diff --git a/docs/domain/value_objects/medication_frequency.md b/docs/domain/value_objects/medication_frequency.md new file mode 100644 index 0000000..8483d5d --- /dev/null +++ b/docs/domain/value_objects/medication_frequency.md @@ -0,0 +1,9 @@ +# `MediationFrequency` -> `src/domain/value_objects/medication_frequency.rs` + +A value object representing how often a medication should be taken. + +--- + +## Invariants + +- This follow an enum pattern with variants like `OnceDaily`, `TwiceDaily`, `EveryXHours(u8) or Custom(String)`. From de2a7519bdfb0c3278a234bfb2b35838cb0d3ea9 Mon Sep 17 00:00:00 2001 From: Glauber Brennon Date: Mon, 9 Mar 2026 16:49:06 -0300 Subject: [PATCH 2/6] docs(value_objects): update medication frequency documentation --- docs/domain/value_objects/medication_frequency.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/domain/value_objects/medication_frequency.md b/docs/domain/value_objects/medication_frequency.md index 8483d5d..59485cb 100644 --- a/docs/domain/value_objects/medication_frequency.md +++ b/docs/domain/value_objects/medication_frequency.md @@ -7,3 +7,4 @@ A value object representing how often a medication should be taken. ## Invariants - This follow an enum pattern with variants like `OnceDaily`, `TwiceDaily`, `EveryXHours(u8) or Custom(String)`. +- For `EveryXHours`, the number of hours must be between 1 and 24 From 591d400d3ff2bf7c57f522e8b9b1849dcf264911 Mon Sep 17 00:00:00 2001 From: Glauber Brennon Date: Mon, 9 Mar 2026 16:53:03 -0300 Subject: [PATCH 3/6] docs(value_objects): fix typo in `MedicationFrequency` documentation --- docs/domain/value_objects/medication_frequency.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/domain/value_objects/medication_frequency.md b/docs/domain/value_objects/medication_frequency.md index 59485cb..7760996 100644 --- a/docs/domain/value_objects/medication_frequency.md +++ b/docs/domain/value_objects/medication_frequency.md @@ -1,4 +1,4 @@ -# `MediationFrequency` -> `src/domain/value_objects/medication_frequency.rs` +# `MedicationFrequency` -> `src/domain/value_objects/medication_frequency.rs` A value object representing how often a medication should be taken. From 1688310a58f094bd67a8d2d38a8ab18bed6ba5db Mon Sep 17 00:00:00 2001 From: Glauber Brennon Date: Mon, 9 Mar 2026 17:40:27 -0300 Subject: [PATCH 4/6] docs(value_objects): update medication frequency documentation --- .../value_objects/medication_frequency.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/docs/domain/value_objects/medication_frequency.md b/docs/domain/value_objects/medication_frequency.md index 7760996..f56bd6e 100644 --- a/docs/domain/value_objects/medication_frequency.md +++ b/docs/domain/value_objects/medication_frequency.md @@ -8,3 +8,20 @@ A value object representing how often a medication should be taken. - This follow an enum pattern with variants like `OnceDaily`, `TwiceDaily`, `EveryXHours(u8) or Custom(String)`. - For `EveryXHours`, the number of hours must be between 1 and 24 + + +## Usage + +```rust +use bitpill::domain::value_objects::medication_frequency::MedicationFrequency; + +let freq1 = MedicationFrequency::OnceDaily; +let freq2 = MedicationFrequency::EveryXHours(8); +let freq3 = MedicationFrequency::Custom("Every Monday".to_string()); + +assert_eq!(freq1.to_string(), "Once daily"); +assert_eq!(freq2.to_string(), "Every 8 hours"); +assert_eq!(freq3.to_string(), "Every Monday"); +``` + +`MedicationFrequency` is used as a field in the [`Medication`](../entities/medication.md) entity to specify how often the medication should be taken. From 93be12b739a3ebb38297959183c7d8ad53bd4587 Mon Sep 17 00:00:00 2001 From: Glauber Brennon Date: Mon, 9 Mar 2026 17:44:24 -0300 Subject: [PATCH 5/6] docs(medication_frequency): update documentation for MedicationFrequency value object --- docs/domain/value_objects/medication_frequency.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/docs/domain/value_objects/medication_frequency.md b/docs/domain/value_objects/medication_frequency.md index f56bd6e..22e8d2a 100644 --- a/docs/domain/value_objects/medication_frequency.md +++ b/docs/domain/value_objects/medication_frequency.md @@ -25,3 +25,9 @@ assert_eq!(freq3.to_string(), "Every Monday"); ``` `MedicationFrequency` is used as a field in the [`Medication`](../entities/medication.md) entity to specify how often the medication should be taken. + +## Methods + +### `to_string() -> String` + +Formats the frequency as a human-readable string. From a8f9ca531b521fcbf5343f2d5194ce8735f4b29c Mon Sep 17 00:00:00 2001 From: Glauber Brennon Date: Mon, 9 Mar 2026 17:54:34 -0300 Subject: [PATCH 6/6] docs(value_objects): update medication frequency documentation --- docs/domain/value_objects/medication_frequency.md | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/docs/domain/value_objects/medication_frequency.md b/docs/domain/value_objects/medication_frequency.md index 22e8d2a..08fad23 100644 --- a/docs/domain/value_objects/medication_frequency.md +++ b/docs/domain/value_objects/medication_frequency.md @@ -28,6 +28,4 @@ assert_eq!(freq3.to_string(), "Every Monday"); ## Methods -### `to_string() -> String` - -Formats the frequency as a human-readable string. +### `as_str() -> String`