refactor: Separate business logic from user interface code

[ronzulu]

Based on https://github.com/st3v3nmw/obsidian-spaced-repetition/releases/tag/1.10.1

• Separated out "business logic" from the user interface code for flashcards, as well as other refactoring.
• The intention has been to keep existing functionality without change, but structure the code to support future contributions.
• As part of the restructure, many unit test cases were added - now around 170 (up from 20)

Bug Fixes

To simplify the process of reviewing for the project owner, apart from keeping functionality the same, no bugs have been fixed. However, during the restructure and testing, it was noticed that the following was fixed:

• [Fixed] Revisons cannot be saved properly #745
• [Fixed] Decrease in Card Count after Pressing 'Reset' #704

Details

• Development: Thoughts about implementation redesign? #736

Commit Comments

Much work went into this restructure. Until the home stretch, the commit comments weren't used (just "something")
There wouldn't be much to gain by examining any of the interim commits.

[ronzulu]

Hi Stephen

I just noticed that the restructure has also fixed:

• [BUG] Decrease in Card Count after Pressing 'Reset' #704

Cheers
Ronny

[st3v3nmw]

Hi @ronzulu, I think this is good to go in. Please fix the linting issues.
Again, thanks for the awesome work! 🚀

[ronzulu]

Hi Stephen, I've fixed all issues reported by pnpm lint. Cheers.

[ronzulu]

Oops, forgot to mention that https://github.com/ronzulu/obsidian-spaced-repetition also now includes fixes for:

#706
#709

Cheers
Ronny

[st3v3nmw]

Hi @ronzulu, please reduce the coverage thresholds for now so that this can go in

[ronzulu]

Hi @st3v3nmw, just doing this now :-)

[st3v3nmw]

🚀

[st3v3nmw]

Hi @ronzulu, I'll do a release over the weekend

[ronzulu]

Hi @st3v3nmw great 👍

I've been looking at https://github.com/st3v3nmw/obsidian-spaced-repetition/issues?q=is%3Aissue+is%3Aopen, and there are many open!

Let me know if there are any specific bugs/features I can help with! I'm currently working on #754.

Also, I think there are a fair few issues that are open that could be closed. If you like, I could mark any that I come across for your attention.

Cheers
Ronny

[st3v3nmw]

Hi @ronzulu,

I did the release a few hours ago.

Yeah, there are a lot of open issues (life & work got in the way 🥲) but I'm hoping to start closing them slowly. I think your refactor will help speedup the process.

I'll create a new GitHub board to start tracking the bugs/features that are currently being worked on but I currently don't have any in mind.

Yes, please let me know if you find any open issues that could be closed.

Thank you!

[AB1908]

Jesus Christ, how long did it take to pull this off? You're a much braver person than I. I actually ended up rewriting most of the plugin and deprecating a bunch of features because I don't have the skills to do something like this. Given that you're familiar with the domain and the underlying logic, I would love to get some thoughts on my fork of this plugin.

[ronzulu]

Hi @AB1908 I didn't record the time spent, but definitely a lot of time! I'm guessing at least the equivalent of 6 full-time weeks spread over maybe 12. The main issue was that I only used a portion of the plug-in functionality myself, and so there were a fair few bugs that I introduced, which usually weren't difficult to fix. But I always added unit test cases, so hopefully long-term the product quality is higher.

I'm now working on Refactor code to support diff methods of storing the scheduling info, and diff SR algorithms #878, This has also required significant work, hopefully at the tail end now.