akdasa-studios / shlokas-core Goto Github PK

View Code? Open in Web Editor NEW

2.0 0.0 0.0 495 KB

Core library for Shlokas app

Gherkin 17.34% JavaScript 1.07% TypeScript 81.59%

learn spirituality vedic

shlokas-core's People

Contributors

Stargazers

shlokas-core's Issues

Add `ReviewLog` model

class ReviewLog {
  reviewCardId: CardId
  grade: ReviewGrade
  timestamp: number
}

Add `cardsReviewed` to the `StatisticsService`

interface CardsReviewStatistics {
  [date: string /* 2000-01-01 */] : count: number
}

const cardReviewsCount: CardsReviewStatistics = service.cardsReviewed(
  from: Date,
  to: Date = Today
)

VerseStatus IDs of the same verse and type must match

Update VerseStatus to set inDeck = Review if there is one card in Review deck

If there is at least one card in the Review deck set InDeck property of VerseSatus to Review

"hard" should decrease ease

"Easy" and "Good" are increasing ease. But "Hard" should decrease ease.

Repo social preview

Collections of verses

One verse might belong to several collections.

Example of collections:

10 top popular verses
Essential BG verses
108 most important verses
Bhakti sastri verses
Bhakti vaibhava verses

Recalculate the `progress` field of `VerseStatus` when a `ReviewCard` updates

Calculate the average interval for all cards in a review of a verse. Consider the interval to 0 if a card is not in a review state or not added.

progress = (average interval in days / 90 days) * 100%

Steps

Update UpdateVerseStatus command

Related issues

[blocked by] #52

Card IDs of the same verse and type must match

It helps to avoid collision while syncing.

Move card to ReviewDeck after card memorized

Coverage 100%

coverage 100%
no failing mutational tests
mutational tests threshold → 100%

User removes accidentally added verse from the Inbox deck

Scenario: User removes accidentally added verse from the Inbox deck
  I, as a user, want to remove an accidentally added verse from the Inbox

  Given Empty Inbox deck
  When I add a verse "BG 1.1" to the Inbox deck
  And I revert the last action
  Then Inbox deck contains no cards

Add textAudioUri to Verse model

Synchronisation

Update `ReviewCardReviewed` to create new `ReviewLog`

ReviewCardReviewed should create a new ReviewLog instance:

reviewCardId: reviewCard.id // from constructor
grade: grade // from constructor
timestamp: context.timeMachine.now.getTime()

Add `versesMemorized` to the `StatisticsService`

const versesMemorized: number = service.versesMemorized(
  from: Date,
  to: Date = Today
)

Find the count of from <= VerseStatus.memorizedAt <= to

Prepare commands for new `Processor`

Make some fields public readonly

Add ability to publish / unpublish verses

Verse should have two options:

publish to make it available in the library
unpublish to make it unavailable to users in the library

Users should still be able to find unpublished verses if they set a special flag while searching.

User removes previously added verse from the Inbox deck

Scenario: User removes previously added verse from the Inbox deck
  I, as a user, want to remove an accidentally added verse from the Inbox

  Given Empty Inbox deck
  When I add a verse "BG 1.1" to the Inbox deck
  And I revert the last action
  Then Inbox deck contains no cards

User can add verse to Inbox deck

story: akdasa-studios/shlokas#10

Add AddVerseToInboxDeck command
Add tests

Add a `progress` field to `VerseStatus` model

Add field to VerseStatus model