refactor: add candidates cache

[bdarcus]

Refactor so that bibtex-actions-read pulls candidates from a
cache: bibtex-actions--candidates-cache.

Add:

• bibtex-actions--candidates-cache variable
• bibtex-actions-refresh interactive command, to update cache

Refactor:

• bibtex-actions--get-candidates renamed to bibtex-actions--format-candidates
• bibtex-actions--get-candidates now grabs the candidates from the cache

fixes #69

---

@wenjie2wang - I do think it would also be good to add the hook to bibtex-completion, but you want to give this a try and let me know?

Turns out it was easier than I thought to add this.

But I haven't fully tested it and seen if it has any unintended consequences.

It does cache the candidates, however, so should address #69.

So if you could test it further and let me know, that'd be great.

[wenjie2wang]

Thanks, @bdarcus ! I tried this PR and I found that it worked great. There is no more pause after the first run due to the added candidate cache.

[bdarcus]

Thanks, @bdarcus ! I tried this PR and I found that it worked great. There is no more pause after the first run due to the added candidate cache.

Great!

Can you review the code for the basic logic and confirm that it makes sense to you; that it shouldn't cause any problem when I merge it? It's very simple, but I think should work.

[wenjie2wang]

How will the cache get invalidated? I removed a few BibTeX entries and I still got the cached results.

[bdarcus]

How will the cache get invalidated? I removed a few BibTeX entries and I still got the cached results.

The idea is one would have to run bibtex-actions--reload-candidates-cache (hmm, maybe I should make that a public function and command?), either manually, or via a filenotify process as mentioned here:

https://github.com/bdarcus/bibtex-actions/wiki/Configuration#expand-proactive-loading-of-library-to-pdfs-and-notes

But that would need to include the bib files, since while bibtex-completion already handles this, this PR does not.

I omitted it because I'm thinking it's too complicated (see this recent still open thread), and this approach gives users more flexibility.

WDYT?

Also, maybe you can test the config I list on the wiki for your bib file to confirm it works for you?

[bdarcus]

Updated the wiki section to address here:

https://github.com/bdarcus/bibtex-actions/wiki/Configuration#proactive-reloading-of-library

I will probably add that section to the README before merging.

I wonder if there's a way to do this asychronously, so we never experience a pause when it's reloading?

[bdarcus]

Latest commit:

• changes that reload function to the bibtex-actions-refresh interactive command
• adds section to the README (just need to confirm those file-notify configs are right; may not be for the bib one if there is more than one bib file?)

[wenjie2wang]

Latest commit:

* changes that reload function to the `bibtex-actions-refresh` interactive command

* adds section to the README (just need to confirm those `file-notify` configs are right; may not be for the bib one if there is more than one bib file?)

I followed the README and added file-notify configs. The cache got invalidated correctly.

[bdarcus]

Merged; thanks much!

Let me know of course if you have other ideas, etc.

[bdarcus]

PS - I'm glad I did this. It's nice to have the instant loading!