(fix) make roam headline link completion robust (#1473)

Fixes  #1472

.dir-locals.el

@@ -0,0 +1,6 @@
+;;; Directory Local Variables
+;;; For more information see (info "(emacs) Directory Variables")
+
+((emacs-lisp-mode
+  (eval . (require 'org-roam-dev))
+  (eval . (org-roam-dev-mode))))

.github/FUNDING.yml

@@ -0,0 +1,12 @@
+# These are supported funding model platforms
+
+github: [jethrokuan, zaeph]
+patreon: # Replace with a single Patreon username
+open_collective: # Replace with a single Open Collective username
+ko_fi: # Replace with a single Ko-fi username
+tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
+community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
+liberapay: # Replace with a single Liberapay username
+issuehunt: # Replace with a single IssueHunt username
+otechie: # Replace with a single Otechie username
+custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']

.github/ISSUE_TEMPLATE/bug_report.md

@@ -1,14 +1,15 @@
 ---
 name: Bug Report
 about: Something's not working.
-title: ''
-labels: ''
-assignees: 'jethrokuan'
+title: ""
+labels: ""
+assignees: ""
 ---
 
 ### Description
 
 #### Steps to Reproduce
+
 <!--
 Example:
 
@@ -18,13 +19,25 @@ Example:
 ...
 -->
 
+#### Backtrace
+<!--
+   Will help us track and understand issues faster.
+   How to provide a backtrace:
+   1. M-x toggle-debug-on-error
+   2. Trigger error. The debugger buffer should pop up.
+   3. Copy the contents of the debugger buffer and paste here
+-->
 
 #### Expected Results
+
 <!-- Example: File A is there -->
 
 #### Actual Results
+
 <!-- Example: File A is missing -->
 
-### Versions
-- Emacs (`C-h v emacs-version`): vX.X.X
+### Environment
+
+<!-- Please M-x org-roam-diagnostics and paste results here -->
+
 - Org-roam commit: https://github.com/jethrokuan/org-roam/commit/commithashhere

.github/ISSUE_TEMPLATE/feature_request.md

@@ -1,9 +1,9 @@
 ---
 name: Feature Request
 about: Create a feature request to improve Org-roam
-title: ''
-labels: 'enhancement'
-assignees: 'jethrokuan'
+title: ""
+labels: "enhancement"
+assignees: ""
 ---
 
 ### Brief Abstract
@@ -13,4 +13,5 @@ assignees: 'jethrokuan'
 ### Proposed Implementation (if any)
 
 ### Please check the following:
+
 - [ ] No similar feature requests

.github/workflows/docs.yml

@@ -0,0 +1,31 @@
+# * docs.yml --- Build the documentation and publish to Github Pages
+
+name: "Docs"
+on:
+  push:
+    branches:
+      - master
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: true
+    steps:
+    - uses: actions/checkout@v2
+
+    - name: Install deps
+      run: |
+        sudo apt-get install texinfo
+
+    - name: Build docs
+      continue-on-error: false
+      run: make html
+
+    - name: Deploy 🚀
+      uses: JamesIves/github-pages-deploy-action@releases/v3
+      with:
+        ACCESS_TOKEN: ${{ secrets.ACCESS_TOKEN }}
+        BRANCH: gh-pages # The branch the action should deploy to.
+        FOLDER: doc # The folder the action should deploy.
+        CLEAN: true

.github/workflows/test.yml

@@ -29,7 +29,6 @@ on:
   push:
     branches:
       - master
-      - develop
 
 jobs:
   build:
@@ -38,7 +37,6 @@ jobs:
       fail-fast: false
       matrix:
         emacs_version:
-          - 26.3
           - snapshot
     steps:
     - uses: purcell/setup-emacs@master
@@ -47,18 +45,23 @@ jobs:
 
     - uses: actions/checkout@v2
 
-    - name: Initialize sandbox
+    - name: Create Sandbox Directory
       run: |
         SANDBOX_DIR=$(mktemp -d) || exit 1
-        echo ::set-env name=SANDBOX_DIR::$SANDBOX_DIR
+        echo "SANDBOX_DIR=$SANDBOX_DIR" >> $GITHUB_ENV
+
+    - name: Initialize Sandbox
+      run: |
         ./makem.sh -vv --sandbox $SANDBOX_DIR --install-deps --install-linters
 
     # The "all" rule is not used, because it treats compilation warnings
     # as failures, so linting and testing are run as separate steps.
 
+    # org-roam-compat is excluded from linting because it contains
+    # symbols/aliases from other packages
     - name: Lint
-      continue-on-error: true
-      run: ./makem.sh -vv --sandbox $SANDBOX_DIR lint
+      continue-on-error: false
+      run: ./makem.sh -vv --sandbox $SANDBOX_DIR --exclude org-roam-compat.el lint
 
     - name: Test
       if: always()  # Run test even if linting fails.

.gitignore

@@ -1,2 +1,15 @@
 /.sandbox/
 **/*.elc
+/doc/dir
+/doc/*.info
+/doc/*.pdf
+/doc/*.epub
+/doc/META_INF/
+/doc/OEBPS/
+/doc/dir
+/doc/epub.xml
+/doc/org-roam/
+/doc/mimetype
+/doc/stats/
+/config.mk
+/doc/manual.html

.readthedocs.yml

@@ -1,8 +0,0 @@
-version: 2
-mkdocs:
- configuration: mkdocs.yml
-formats: all
-python:
-  version: 3.7
-  install:
-    - requirements: doc/requirements.txt

BACKERS.md

@@ -0,0 +1,8 @@
+# Backers
+
+Many thanks to the following backers, your contributions are greatly appreciated!
+
+- Nathan Tran
+- Burke Libbey
+- forkrul
+- Andreas Stuhlmüller

CHANGELOG.md

@@ -1,93 +1,349 @@
 # Changelog
+## 1.2.4 (TBD)
+
+### Added
+- [#1396](https://github.com/org-roam/org-roam/pull/1396) add option to choose between prepending, appending, and omitting `roam_tags` in file completion
+- [#1270](https://github.com/org-roam/org-roam/pull/1270) capture: create OLP if it does not exist. Removes need for OLP setup in `:head`.
+- [#1353](https://github.com/org-roam/org-roam/pull/1353) support file-level property drawers
+
+### Changed
+- [#1352](https://github.com/org-roam/org-roam/pull/1352) prefer lower-case for roam_tag and roam_alias in interactive commands
+
+### Fixed
+- [#1281](https://github.com/org-roam/org-roam/pull/1281) fixed idle-timer not instantiated on `org-roam-mode`
+- [#1308](https://github.com/org-roam/org-roam/pull/1308) fixed file renames corrupting database
+- [#1325](https://github.com/org-roam/org-roam/pull/1325) make titles and tags extracted unique per note
+- [#1327](https://github.com/org-roam/org-roam/pull/1327) preserve existing link description during automatic replacement
+- [#1346](https://github.com/org-roam/org-roam/pull/1346) prevent malformed path to `org-roam-index-file`
+- [#1347](https://github.com/org-roam/org-roam/pull/1347) allow use of `%a` element in regular Org-roam captures
+- [#1352](https://github.com/org-roam/org-roam/pull/1352) fixed org-roam-{tag/alias}-{add/delete} altering the original case of the Org property
+- [#1374](https://github.com/org-roam/org-roam/pull/1374) fix headline completions erroring out
+- [#1375](https://github.com/org-roam/org-roam/pull/1375) fix org-roam-protocol to use existing ref file 
+- [#1403](https://github.com/org-roam/org-roam/issues/1403) fixed inconsistency between how we write and read props like alias and tags
+- [#1409](https://github.com/org-roam/org-roam/issues/1398) prevent inclusion of non-org-roam files in `org-roam-dailies--list-files`
+
+## 1.2.3 (13-11-2020)
+
+Primarily a stabilization and bug-fix release.
+
+Org-roam-dailies has also been revamped to include new features, see [this video](https://www.youtube.com/watch?v=1q9x2aZCJJ4) for a quick overview.
+
+### Added
+- [#978](https://github.com/org-roam/org-roam/pull/978) Revamp org-roam-dailies
+- [#1183](https://github.com/org-roam/org-roam/pull/1183) Interactive functions for managing aliases and tags in Org-roam file, namely `org-roam-alias-add`, `org-roam-alias-delete`, `org-roam-tag-add`, and `org-roam-tag-delete`.
+- [#1215](https://github.com/org-roam/org-roam/pull/1215) Multiple `ROAM_KEY` keywords can now be specified in one file. This allows bibliographical entries to share the same note file.
+- [#1238](https://github.com/org-roam/org-roam/pull/1238) Add `org-roam-prefer-id-links` variable to select linking method
+- [#1239](https://github.com/org-roam/org-roam/pull/1239) Allow `org-roam-protocol` to capture the webpage's selection, and add a toggle for storing the links to the pages
+- [#1264](https://github.com/org-roam/org-roam/pull/1264) add `org-roam-db-update-method` to control when the cache is rebuilt.
+
+### Changed
+- [#1264](https://github.com/org-roam/org-roam/pull/1264) renamed `org-roam-update-db-idle-seconds` to `org-roam-db-idle-idle-seconds`
+
+### Fixed
+- [#1074](https://github.com/org-roam/org-roam/issues/1074) fix `org-roam--extract-links` to handle content boundaries.
+- [#1193](https://github.com/org-roam/org-roam/issues/1193) fix `org-roam-db-build-cache` by not killing temporary buffer in `org-roam--extract-links`.
+- [#1195](https://github.com/org-roam/org-roam/issues/1195) fix ID face showing as invalid if within Org ID files, but not Org-roam's.
+- [#1199](https://github.com/org-roam/org-roam/issues/1199) make Org-roam link insertions respect `org-roam-link-title-format` everywhere.
+- [#1201](https://github.com/org-roam/org-roam/issues/1201) fix `org-roam-db-build-cache` failing in scenarios involving duplicate IDs and deleted files.
+- [#1226](https://github.com/org-roam/org-roam/issues/1226) only update relative path of file links
+- [#1232](https://github.com/org-roam/org-roam/issues/1232) fix incorrect title extractions from narrowed buffers
+- [#1233](https://github.com/org-roam/org-roam/issues/1233) fixes bug where descriptive file links become plain links during update for relative paths
+- [#1252](https://github.com/org-roam/org-roam/issues/1252) respect original link type during automatic replacement
+
+## 1.2.2 (06-10-2020)
+
+In this release we support fuzzy links of the form `[[roam:Title]]`, `[[roam:*Headline]]` and `[[roam:Title*Headline]]`. Completion for these fuzzy links is supported via `completion-at-point`.
+
+Org-roam now does not resolve symlinks. This significantly speeds up cache builds, but may result in some workflows breaking. In particular, Org-roam now cannot figure out if two distinct file paths in the Org-roam directory are the same file, and both files will be processed as if they were different files. This error seems to be unavoidable now that symlinks are not resolved, but this workflow is rare and should not affect most users.
+
+This change requires you to set `org-roam-directory` to the resolved path of a folder. That is:
+
+```elisp
+(setq org-roam-directory (file-truename "/path/to/directory/"))
+```
+
+### Breaking Changes
+
+- [#1164](https://github.com/org-roam/org-roam/pull/1164) Org-roam now stores the database in the user's Emacs directory by default
+- [#910](https://github.com/org-roam/org-roam/pull/910) Deprecate `company-org-roam`, using `completion-at-point` instead. To use this with company, add the `company-capf` backend instead.
+- [#1109](https://github.com/org-roam/org-roam/pull/1109) Org-roam now does not resolve symlinks.
+
+### Features
+
+- [#1163](https://github.com/org-roam/org-roam/pull/1163) Support file-level IDs introduced in Org 9.4
+- [#1093](https://github.com/org-roam/org-roam/pull/1093) Add `vanilla` org-roam-tag-source to extract buffer Org tags
+- [#1079](https://github.com/org-roam/org-roam/pull/1079) Add `org-roam-tag-face` to customize appearance of tags in interactive commands
+- [#1073](https://github.com/org-roam/org-roam/pull/1073) Rename file on title change, when `org-roam-rename-file-on-title-change` is non-nil.
+- [#1071](https://github.com/org-roam/org-roam/pull/1071) Update link descriptions on title changes, and clean-up rename file advice
+- [#1061](https://github.com/org-roam/org-roam/pull/1061) Speed up the extraction of file properties, headlines, and titles
+- [#1046](https://github.com/org-roam/org-roam/pull/1046) New user option to exclude files from Org-roam
+- [#1032](https://github.com/org-roam/org-roam/pull/1032) File changes are now propagated to the database on idle timer. This prevents large wait times during file saves.
+- [#974](https://github.com/org-roam/org-roam/pull/974) Protect region targeted by `org-roam-insert`
+- [#994](https://github.com/org-roam/org-roam/pull/994) Simplify org-roam-store-link
+- [#1062](https://github.com/org-roam/org-roam/pull/1062) Variable `org-roam-completions-everywhere` allows for completions everywhere from word at point
+- [#910](https://github.com/org-roam/org-roam/pull/910), [#1105](https://github.com/org-roam/org-roam/pull/1105) Support fuzzy links of the form `[[roam:Title]]`, `[[roam:*Headline]]` and `[[roam:Title*Headline]]`
+
+### Bugfixes
+
+- [#1057](https://github.com/org-roam/org-roam/pull/1057) Improve performance of database builds by preventing generation of LaTeX and image previews.
+- [#1103](https://github.com/org-roam/org-roam/pull/1103) Fix long build-times for Windows on files with URL links
+
+## 1.2.1 (27-07-2020)
+
+This release consisted of a big deal of refactoring and bug fixes. Notably, we fixed several catastrophic failures on db builds with bad setups (#854), and modularized tag and title extractions.
+
+We also added some new features that had been a long time coming:
+
+1. We made the backlinks more outline-friendly by also showing the outline hierarchy for a backlink (#863)
+2. We now support nested captures, which is crucial for `org-roam-protocol` (#966)
+
+### Breaking Changes
+
+- [#908](https://github.com/org-roam/org-roam/pull/908) Normalized titles in database. May break external packages that rely on unnormalized titles.
+
+### Features
+
+- [#814](https://github.com/org-roam/org-roam/pull/814) Implement `org-roam-insert-immediate`
+- [#833](https://github.com/org-roam/org-roam/pull/833) Add customization of file titles with `org-roam-title-to-slug-function`.
+- [#839](https://github.com/org-roam/org-roam/pull/839) Return selected file from `org-roam-insert`
+- [#847](https://github.com/org-roam/org-roam/pull/847) Add GC threshold `org-roam-db-gc-threshold` to temporarily change the threshold on expensive operations.
+- [#847](https://github.com/org-roam/org-roam/pull/847) Use sqlite3 transactions instead of storing the values to be inserted.
+- [#851](https://github.com/org-roam/org-roam/pull/851) Add `'first-directory'` option for `org-roam-tag-sources`
+- [#863](https://github.com/org-roam/org-roam/pull/863) Display outline hierarchy in backlinks buffer
+- [#898](https://github.com/org-roam/org-roam/pull/898) Add `org-roam-random-note` to browse a random note.
+- [#900](https://github.com/org-roam/org-roam/pull/900) Support and index all valid org links
+- [#966](https://github.com/org-roam/org-roam/pull/966) Enable nested captures
+
+### Bugfixes
+
+- [#854](https://github.com/org-roam/org-roam/pull/854) Warn instead of fail when duplicate refs and IDs exist.
+- [#857](https://github.com/org-roam/org-roam/pull/857) Fix tag extraction for symlinked directories.
+- [#894](https://github.com/org-roam/org-roam/pull/894) Perform link fixes on all Org-roam files
+- [#952](https://github.com/org-roam/org-roam/pull/952) Cache `${foo}` template variables so they do not need to be re-entered twice
+
+## 1.2.0 (12-06-2020)
+
+In this release, we improved the linking process by achieving feature parity between links to files and links to headlines. Before, we used the `file:foo::*bar` format to link to the headline `bar` in file `foo`, but this was prone to breakage upon renaming the file or modifying the headline. This is not the case anymore. Now, we use `org-id` to create IDs for those headlines, which are then stored in our database to compute the relationships and jump around. Note that this will work even if you’re not using `org-id` in your global configuration for Org-mode.
+
+This is a major step forward. Supporting the in-file structure of Org-mode files means that we can interface with many of its core-features like TODOs, properties, priorities, etc. UX will have to be figured out, but this release ushers in a new age in terms of functionalities.
+
+We also add `org-roam-unlinked-references`, which naively finds text that could be references to the current Org-roam file.
+
+### Breaking Changes
+
+- [#701](https://github.com/org-roam/org-roam/pull/701) Use `emacsql-sqlite3` instead of `emacsql-sqlite` for better Windows compatibility. This requires the presence of the standard `sqlite3` binary on your machine.
+- [#750](https://github.com/org-roam/org-roam/pull/750) Deprecate `org-roam-buffer-no-delete-other-windows` in favour of `org-roam-buffer-window-parameters`.
+
+### Features
+
+- [#787](https://github.com/org-roam/org-roam/pull/787) Add `org-roam-unlinked-references`
+- [#783](https://github.com/org-roam/org-roam/pull/783) Add support for headlines
+- [#757](https://github.com/org-roam/org-roam/pull/757) Roam global properties are now case-insensitive
+- [#680](https://github.com/org-roam/org-roam/pull/680) , [#703](https://github.com/org-roam/org-roam/pull/703), [#708](https://github.com/org-roam/org-roam/pull/708) Add `org-roam-doctor` checkers for `ROAM_*` properties
+- [#664](https://github.com/org-roam/org-roam/pull/664) Add support for shelling out to `rg` and `find` in `org-roam--list-files`
+- [#679](https://github.com/org-roam/org-roam/pull/679), [#683](https://github.com/org-roam/org-roam/pull/683) Building of the graph now happens in a separate process
+
+### Bugfixes
+
+- [#714](https://github.com/org-roam/org-roam/pull/714) No longer print citelinks in backlinks buffer if there is no `ROAM_KEY` property or `org-ref` is not installed
+- [#759](https://github.com/org-roam/org-roam/pull/759), [#760](https://github.com/org-roam/org-roam/pull/760) Tags are only added to the tags table if there are actually tags present
+- [#700](https://github.com/org-roam/org-roam/pull/700), [#733](https://github.com/org-roam/org-roam/pull/733) Allow symlinks within the `org-roam` directory
+
+## 1.1.1 (18-05-2020)
+
+In this release, we added two new features:
+
+1. `org-roam-doctor`: a linting system that helps you discover possible problems with your Org-roam files. This is in the spirit of keeping notes in top quality.
+2. A tagging system: one can now use sub-directories, and the `#+roam_tags` key add additional meta data to notes. For more information, see [here](https://www.orgroam.com/manual/Tags.html#Tags).
+
+As usual, this release comes with a multitude of bug-fixes and refactorings.
+
+### Breaking Changes
+
+- [#523](https://github.com/org-roam/org-roam/pull/523) remove `org-roam-completion-fuzzy-match` in favor of using completion mechanism's configuration options directly
+- [#547](https://github.com/org-roam/org-roam/pull/547) Deprecate `org-roam-db--maybe-update`, in favour of `org-roam-db--update-maybe`
+- [#604](https://github.com/org-roam/org-roam/pull/604) Deprecate `org-roam-title-include-subdirs`, `org-roam-title-subdir-format` `org-roam-title-subdir-separator`, for a more general tagging system built on subdirectories
+
+### Bugfixes
+
+- [#509](https://github.com/org-roam/org-roam/pull/509) fix backup files being tracked in database
+- [#509](https://github.com/org-roam/org-roam/pull/509) fix external org files being tracked in database
+- [#537](https://github.com/org-roam/org-roam/pull/537) quote graphviz node and edge configuration options to allow multi-word configurations
+- [#545](https://github.com/org-roam/org-roam/pull/545) fix `org-roam--extract-links` to ensure that multiple citations (`cite:key1,key2`) are split correctly
+- [#547](https://github.com/org-roam/org-roam/pull/547) Fix unlinked citations
+- [#660](https://github.com/org-roam/org-roam/pull/660) fix rename-file advice not working for renaming to directories
+- [#660](https://github.com/org-roam/org-roam/pull/660) fix links breaking within file on file movement
+
+### Features
+
+- [#538](https://github.com/org-roam/org-roam/pull/538) Optionally use text in first headline as title
+- [#553](https://github.com/org-roam/org-roam/pull/553) Add prefix argument to `org-roam-db-build-cache` for forcing rebuilds
+- [#560](https://github.com/org-roam/org-roam/pull/560) Apply 'error face to distinguish broken links
+- [#570](https://github.com/org-roam/org-roam/pull/570) Add `org-roam-doctor` to diagnose org-roam files
+- [#625](https://github.com/org-roam/org-roam/pull/625) Add `org-roam-title-sources` to control how titles are retrieved within notes
+- [#604](https://github.com/org-roam/org-roam/pull/604) Add a tagging system. `org-roam-tag-sources` controls how tags are retrieved from notes
+
+### Internal Changes
+
+- [#547](https://github.com/org-roam/org-roam/pull/547) Added `type` column to the `refs` table
+- [#606](https://github.com/org-roam/org-roam/pull/606) Added `org-roam-dev.el` for developer coding standards
+- [#622](https://github.com/org-roam/org-roam/pull/622) Online documentation now points to the Org-based documentation
+
+## 1.1.0 (21-04-2020)
+
+To the average user, this release is mainly a bugfix release with additional options to customize. However, the changes made to the source is significant. Most notably, in this release:
+
+1. The codebase has been modularized into separate files, to ease future maintenance and adding of new features (mainly by [@progfolio](https://github.com/progfolio)). Because of these changes, we had to rename many functions and variables: the old names are kept for backwards compatibility, but you are encouraged to use the new function names. You'll receive a warning when you're calling the function with its obsolete name.
+2. [@kljohann](https://github.com/kljohann) did some fantastic work on graph generation: allowing building images for connected components within the graph up to a specified distance
+3. We also started supporting `org-ref` natively: cite links now show up in both the graph and the org-roam buffer.
+
+In the coming months, you can expect work on bigger projects (e.g. revamping the org-roam buffer).
+
+### Breaking Changes
+
+- [#385](https://github.com/org-roam/org-roam/pull/385) Deprecate `org-roam-graph-node-shape` in favour of `org-roam-graph-node-extra-config`.
+- [#473](https://github.com/org-roam/org-roam/pull/473) Deprecate `org-roam-date-filename-format` and `org-roam-date-title-format`, in favour of `org-roam-dailies-capture-templates`.
+
+### New Features
+
+- [#350](https://github.com/org-roam/org-roam/pull/350) Add `org-roam-db-location` to customize location of org-roam database.
+- [#359](https://github.com/org-roam/org-roam/pull/359) Add `org-roam-verbose` to allow or silence printing of information.
+- [#374](https://github.com/org-roam/org-roam/pull/374) Add support for `org-ref` `cite:` links
+- [#380](https://github.com/org-roam/org-roam/pull/380) Allow `org-roam-buffer-position` to also be `top` or `bottom`
+- [#385](https://github.com/org-roam/org-roam/pull/385) Add `org-roam-graph-node-extra-config` to configure Graphviz nodes
+- [#398](https://github.com/org-roam/org-roam/pull/398), [#418](https://github.com/org-roam/org-roam/pull/418) Add graph building for connected components
+- [#435](https://github.com/org-roam/org-roam/pull/435) Add `org-roam-graph-edge-extra-config` to configure Graphviz edges
+- [#439](https://github.com/org-roam/org-roam/pull/439) Add support for `org-ref` citations to display as edges in graph. Add `org-roam-graph-edge-cites-extra-config` to configure these edges
+- [#465](https://github.com/org-roam/org-roam/pull/465) Add `org-roam-file-extensions` to allow detection of org files with different file extensions
+- [#488](https://github.com/org-roam/org-roam/pull/488) Allow a function for `org-roam-graph-viewer`
+- [#491](https://github.com/org-roam/org-roam/pull/491) Use TITLE as description when linking before first heading
+
+### Bugfixes
+
+- [#470](https://github.com/org-roam/org-roam/pull/470) Add workaround for undocumented `file-truename` behaviour in `org-roam--org-roam-file-p`.
+
+### Internal Changes
+
+- [#363](https://github.com/org-roam/org-roam/pull/363), [#473](https://github.com/org-roam/org-roam/pull/473) Modularize org-roam features.
+- [#497](https://github.com/org-roam/org-roam/pull/497) Simplify `org-roam--list-files` implementation
+
+## 1.0.0 (23-03-2020)
+
+Org-roam is now on MELPA! We have squashed most of the bugs, and Org-roam has
+been stable for the most part.
+
+### New Features
+
+- [#269](https://github.com/org-roam/org-roam/pull/269) Add `org-roam-graphviz-extra-options`
+- [#257](https://github.com/org-roam/org-roam/pull/257) Add a company-backend `company-org-roam`
+- [#284](https://github.com/org-roam/org-roam/pull/284), [#289](https://github.com/org-roam/org-roam/pull/289) Configurable `org-roam-completion-system` with options `'default`, `'ido`, `'ivy` and `'helm`
+- [#289](https://github.com/org-roam/org-roam/pull/289) Add customizable `org-roam-fuzzy-match` to allow fuzzy-matching of candidates
+- [#290](https://github.com/org-roam/org-roam/pull/290) Add `org-roam-date-title-format` and `org-roam-date-filename-format` for customizing Org-roam's date files
+- [#296](https://github.com/org-roam/org-roam/pull/296) Allow multiple exclusion matchers in `org-roam-graph-exclude-matcher`
+
+### Bugfixes
+
+- [#293](https://github.com/org-roam/org-roam/pull/293) Fix capture templates not working as expected for `org-roam-find-file`
+- [#275](https://github.com/org-roam/org-roam/pull/275) Fix database rebuild when `org-roam-directory` is set locally
+
+## 1.0.0-rc1 (06-03-2020)
+
+This is a pre-release before the push to MELPA. It contains large
+internal changes, with little user-facing changes. Most notably, the
+backing storage has been changed to a SQLite database, and a
+templating system using `org-capture` is introduced.
+
+### Breaking Changes
+
+- [#200](https://github.com/org-roam/org-roam/pull/200) Move Org-roam cache into a SQLite database.
+- [#203](https://github.com/org-roam/org-roam/pull/203) Roam protocol is deprecated, in favour of extending org-roam-protocol.
+
+### New Features
+
+- [#182](https://github.com/org-roam/org-roam/pull/182) Support file name aliases via `#+ROAM_ALIAS`.
+- [#216](https://github.com/org-roam/org-roam/pull/216) Adds templating functionality by extending org-capture.
+- [#232](https://github.com/org-roam/org-roam/pull/232) Adds a prefix key to `org-roam-show-graph`, to generate graph without opening it.
+- [#233](https://github.com/org-roam/org-roam/pull/233) Adds `org-roam-graph-exclude-matcher`, which allows exclusion of nodes from graph.
+- [#247](https://github.com/org-roam/org-roam/pull/247) Add `org-roam-backlink` face, which allows customizing backlinks appearance
+- [#259](https://github.com/org-roam/org-roam/pull/259) Add optional initial-prompt to `org-roam-find-file`
+
+### Bugfixes
+
+- [#207](https://github.com/org-roam/org-roam/pull/207), [#221](https://github.com/org-roam/org-roam/pull/221) small bugfixes to Org-roam graph generation
+- [#230](https://github.com/org-roam/org-roam/pull/230) remove nonspacing marks from filenames, to prevent cross-platform errors
+
+### New Contributors
+
+- [@acowley][https://github.com/acowley]
+- [@teesloane][https://github.com/teesloane]
 
 ## 0.1.2 (2020-02-21)
 
 ### Breaking Changes
-* [#143][gh-143] `org-roam-mode` is now a global mode. The installation instructions have changed accordingly.
-* [#103][gh-103] Change `org-roam-file-format` to a function: `org-roam-file-name-function` to allow more flexible file name customizaton. Also changes `org-roam-use-timestamp-as-filename` to `org-roam-filename-noconfirm` to better describe what it does.
+
+- [#143](https://github.com/org-roam/org-roam/pull/143) `org-roam-mode` is now a global mode. The installation instructions have changed accordingly.
+- [#103](https://github.com/org-roam/org-roam/pull/103) Change `org-roam-file-format` to a function: `org-roam-file-name-function` to allow more flexible file name customizaton. Also changes `org-roam-use-timestamp-as-filename` to `org-roam-filename-noconfirm` to better describe what it does.
 
 ### New Features
-* [#145][gh-145] `org-roam-show-graph`: Fallback to Emacs SVG viewer
-* [#141][gh-141] add variable `org-roam-new-file-directory` for new Org-roam files
-* [#138][gh-138] add `org-roam-switch-to-buffer`
-* [#124][gh-124], [#141][gh-141] Maintain cache consistency on file rename and delete
-* [#87][gh-87], [#90][gh-90] Support encrypted Org files
-* [#110][gh-110] Add prefix to `org-roam-insert`, for inserting titles down-cased
-* [#99][gh-99] Add keybinding so that `<return>` or `mouse-1` in the backlinks buffer visits the source file of the backlink at point
+
+- [#145](https://github.com/org-roam/org-roam/pull/145) `org-roam-show-graph`: Fallback to Emacs SVG viewer
+- [#141](https://github.com/org-roam/org-roam/pull/141) add variable `org-roam-new-file-directory` for new Org-roam files
+- [#138](https://github.com/org-roam/org-roam/pull/138) add `org-roam-switch-to-buffer`
+- [#124](https://github.com/org-roam/org-roam/pull/124), [#141](https://github.com/org-roam/org-roam/pull/141) Maintain cache consistency on file rename and delete
+- [#87](https://github.com/org-roam/org-roam/pull/87), [#90](https://github.com/org-roam/org-roam/pull/90) Support encrypted Org files
+- [#110](https://github.com/org-roam/org-roam/pull/110) Add prefix to `org-roam-insert`, for inserting titles down-cased
+- [#99](https://github.com/org-roam/org-roam/pull/99) Add keybinding so that `<return>` or `mouse-1` in the backlinks buffer visits the source file of the backlink at point
 
 ### Changes
 
-* [#108][gh-108] Locally overwrite the link following behaviour in the org-roam-buffer to open files in the same window `org-roam` was called from
+- [#108](https://github.com/org-roam/org-roam/pull/108) Locally overwrite the link following behaviour in the org-roam-buffer to open files in the same window `org-roam` was called from
 
 ### Bugfixes
-* [#86][gh-86] Fix `org-roam--parse-content` incorrect `:to` computation for nested files
-* [#98][gh-98] Fix `org-roam--find-file` picking up temporary files
-* [#136][gh-136] Misc bugfixes
+
+- [#86](https://github.com/org-roam/org-roam/pull/86) Fix `org-roam--parse-content` incorrect `:to` computation for nested files
+- [#98](https://github.com/org-roam/org-roam/pull/98) Fix `org-roam--find-file` picking up temporary files
+- [#136](https://github.com/org-roam/org-roam/pull/136) Misc bugfixes
 
 ### Internal
-* [#122][gh-122], [#128][gh-128] Improve performance of post-command-hook
-* [#92][gh-92], [#105][gh-105] Add tests for core functionality
+
+- [#122](https://github.com/org-roam/org-roam/pull/122), [#128](https://github.com/org-roam/org-roam/pull/128) Improve performance of post-command-hook
+- [#92](https://github.com/org-roam/org-roam/pull/92), [#105](https://github.com/org-roam/org-roam/pull/105) Add tests for core functionality
 
 ### New Contributors
-* [@frigge](https://github.com/frigge)
-* [@juergenhoetzel](https://github.com/juergenhoetzel)
-* [@chip2n](https://github.com/chip2n)
-* [@l3kn](https://github.com/l3kn)
-* [@jdormit](https://github.com/jdormit)
-* [@herbertjones](https://github.com/herbertjones)
-* [@CeleritasCelery](https://github.com/CeleritasCelery)
-* [@daniel-koudouna](https://github.com/daniel-koudouna)
+
+- [@frigge](https://github.com/frigge)
+- [@juergenhoetzel](https://github.com/juergenhoetzel)
+- [@chip2n](https://github.com/chip2n)
+- [@l3kn](https://github.com/l3kn)
+- [@jdormit](https://github.com/jdormit)
+- [@herbertjones](https://github.com/herbertjones)
+- [@CeleritasCelery](https://github.com/CeleritasCelery)
+- [@daniel-koudouna](https://github.com/daniel-koudouna)
 
 ## 0.1.1 (2020-02-15)
 
 Mostly a documentation/cleanup release.
 
 ### New Features
-* [#62][gh-62] Add the options `org-roam-use-timestamps-as-filename` and `org-roam-file-format`, more in documentation.
+
+- [#62](https://github.com/org-roam/org-roam/pull/62) Add the options `org-roam-use-timestamps-as-filename` and `org-roam-file-format`, more in documentation.
 
 ### Breaking Changes
-* [#62][gh-62] The ID (file-name) workflow is no longer first-class, but a fallback when titles don't exist.
+
+- [#62](https://github.com/org-roam/org-roam/pull/62) The ID (file-name) workflow is no longer first-class, but a fallback when titles don't exist.
 
 ### Changes
-* [#66][gh-66], [#68][gh-68]: Improved the quality of the package in preparation of submission to MELPA
-* [#73][gh-73]: Added CI to the project via Github Issues (Thanks [@alphapapa](https://github.com/alphapapa/) for scripts and setup)
-* [#69][gh-69], [#72][gh-72], [#75][gh-75]: Major cleanup and de-duplication of code
+
+- [#66](https://github.com/org-roam/org-roam/pull/66), [#68](https://github.com/org-roam/org-roam/pull/68): Improved the quality of the package in preparation of submission to MELPA
+- [#73](https://github.com/org-roam/org-roam/pull/73): Added CI to the project via Github Issues (Thanks [@alphapapa](https://github.com/alphapapa/) for scripts and setup)
+- [#69](https://github.com/org-roam/org-roam/pull/69), [#72](https://github.com/org-roam/org-roam/pull/72), [#75](https://github.com/org-roam/org-roam/pull/75): Major cleanup and de-duplication of code
 
 ### Bugfixes
-* [#67][gh-67]: Fixed `org-roam--make-file` not creating files with extensions
-* [#71][gh-71], [#78][gh-78]: Fixed `org-roam-insert` not inserting correct paths
-* [#82][gh-82]: Fixed nested Org-roam files not being detected as part of Org-roam
 
-[gh-62]: https://github.com/jethrokuan/org-roam/pull/66
-[gh-66]: https://github.com/jethrokuan/org-roam/pull/66
-[gh-67]: https://github.com/jethrokuan/org-roam/pull/67
-[gh-68]: https://github.com/jethrokuan/org-roam/pull/68
-[gh-69]: https://github.com/jethrokuan/org-roam/pull/69
-[gh-71]: https://github.com/jethrokuan/org-roam/pull/71
-[gh-72]: https://github.com/jethrokuan/org-roam/pull/72
-[gh-73]: https://github.com/jethrokuan/org-roam/pull/73
-[gh-75]: https://github.com/jethrokuan/org-roam/pull/75
-[gh-78]: https://github.com/jethrokuan/org-roam/pull/78
-[gh-82]: https://github.com/jethrokuan/org-roam/pull/82
-[gh-86]: https://github.com/jethrokuan/org-roam/pull/86
-[gh-87]: https://github.com/jethrokuan/org-roam/pull/87
-[gh-90]: https://github.com/jethrokuan/org-roam/pull/90
-[gh-92]: https://github.com/jethrokuan/org-roam/pull/92
-[gh-98]: https://github.com/jethrokuan/org-roam/pull/98
-[gh-99]: https://github.com/jethrokuan/org-roam/pull/99
-[gh-103]: https://github.com/jethrokuan/org-roam/pull/103
-[gh-105]: https://github.com/jethrokuan/org-roam/pull/105
-[gh-108]: https://github.com/jethrokuan/org-roam/pull/108
-[gh-110]: https://github.com/jethrokuan/org-roam/pull/110
-[gh-122]: https://github.com/jethrokuan/org-roam/pull/122
-[gh-124]: https://github.com/jethrokuan/org-roam/pull/124
-[gh-128]: https://github.com/jethrokuan/org-roam/pull/128
-[gh-136]: https://github.com/jethrokuan/org-roam/pull/136
-[gh-138]: https://github.com/jethrokuan/org-roam/pull/138
-[gh-141]: https://github.com/jethrokuan/org-roam/pull/141
-[gh-142]: https://github.com/jethrokuan/org-roam/pull/142
-[gh-143]: https://github.com/jethrokuan/org-roam/pull/143
+- [#67](https://github.com/org-roam/org-roam/pull/67): Fixed `org-roam--make-file` not creating files with extensions
+- [#71](https://github.com/org-roam/org-roam/pull/71), [#78](https://github.com/org-roam/org-roam/pull/78): Fixed `org-roam-insert` not inserting correct paths
+- [#82](https://github.com/org-roam/org-roam/pull/82): Fixed nested Org-roam files not being detected as part of Org-roam
 
- # Local Variables:
- # eval: (auto-fill-mode -1)
- # End:
+<!-- Local Variables: -->
+<!-- eval: (auto-fill-mode -1) -->
+<!-- End: -->

Makefile

@@ -54,3 +54,17 @@ endif
 .DEFAULT: init
 init:
 	@./makem.sh $(DEBUG) $(VERBOSE) $(SANDBOX) $(INSTALL_DEPS) $(INSTALL_LINTERS)
+
+docs:
+	@$(MAKE) -C doc all
+
+html:
+	@$(MAKE) -C doc html-dir
+
+install: install-docs
+
+install-docs: docs
+	@$(MAKE) -C doc install-docs
+
+install-info: info
+	@$(MAKE) -C doc install-info

README.md

@@ -1,72 +1,86 @@
-[![License GPL 3][badge-license]](http://www.gnu.org/licenses/gpl-3.0.txt)
-[![Documentation Status](https://readthedocs.org/projects/org-roam/badge/?version=latest)](https://org-roam.readthedocs.io/en/latest/?badge=latest)
-[![GitHub Release](https://img.shields.io/github/v/release/jethrokuan/org-roam)](https://img.shields.io/github/v/release/jethrokuan/org-roam)
+# Org-roam [![GitHub Release][release-badge]][release] [![MELPA][melpa-badge]][melpa] [![License GPL 3][gpl3-badge]][gpl3]
+ 
+<img src="https://www.orgroam.com/img/logo.svg" align="right" alt="Org-roam Logo" width="240">
 
-## Synopsis
-
-Org-roam is a rudimentary [Roam][roamresearch] replica built around
-the all-powerful [Org-mode][org]. 
-
-Like Roam, Org-roam offers a powerful and effortless non-hierarchical
-note-taking approach. With Org-roam, notes flow naturally, making
-note-taking fun and easy. Org-roam *enables* a note-taking workflow that
-is not fluid with vanilla Org-mode (more in [this blog
-post](https://blog.jethro.dev/posts/how_to_take_smart_notes_org/)).
-
-
-The goal of the project is to implement core features of Roam around
-Org-mode, and eventually introduce features enabled by the Emacs
+Org-roam is a plain-text knowledge management system. It brings some of
+[Roam's][roamresearch] more powerful features into the [Org-mode][org]
 ecosystem.
 
-Visit [the documentation
-page](https://org-roam.readthedocs.io/en/latest/) for a tutorial and
-more links.
+Org-roam borrows principles from the Zettelkasten method, providing a solution
+for non-hierarchical note-taking. It should also work as a plug-and-play
+solution for anyone already using Org-mode for their personal wiki.
 
-As of February 2020, it is in a very early stage of development. 
+- **Private and Secure**: Edit your personal wiki completely offline, entirely
+  in your control. Encrypt your notes with GPG. Take lasting notes in
+  plain-text.
+- **Networked Thought**: Connect notes and thoughts together with ease using
+  backlinks. Discover surprising and previously unseen connections in your notes
+  with the built-in graph visualization.
+- **Extensible and Powerful**: Leverage Emacs' fantastic text-editing interface,
+  and the mature Emacs and Org-mode ecosystem of packages.
+- **Free and Open Source**: Org-roam is licensed under the GNU General Public
+  License version 3 or later.
 
-## A Preview
+<p align="center">
+  <img src="https://www.orgroam.com/img/screenshot.png" alt="Org-roam Screenshot" width="738">
+</p>
 
-Here's a screenshot of `org-roam`. The `org-roam` buffer shows
-backlinks for the active org buffer in the left window, as well as the
-surrounding content in the backlink file. The backlink database is
-built asynchronously in the background, and is not noticeable to the
-end user. The graph is generated from the link structure, and can be
-used to navigate to the respective files.
-
-![img](doc/images/org-roam-graph.gif)
+- **[Documentation][docs]**
+- **[Discourse][discourse]**
+- **[Slack][slack]**
+- **[Frequently Asked Questions][faq]**
+- **[Changelog](CHANGELOG.md)**
 
 ## Installation
 
-The recommended method is using use-package and straight, or a similar package manager.
+You can install `org-roam` using `package.el`:
+
+```
+M-x package-install RET org-roam RET
+```
+
+Here's a sample configuration with `use-package`:
 
 ```emacs-lisp
 (use-package org-roam
-      :after org
-      :hook 
+      :ensure t
+      :hook
       (after-init . org-roam-mode)
-      :straight (:host github :repo "jethrokuan/org-roam" :branch "develop")
       :custom
       (org-roam-directory "/path/to/org-files/")
       :bind (:map org-roam-mode-map
               (("C-c n l" . org-roam)
                ("C-c n f" . org-roam-find-file)
-               ("C-c n g" . org-roam-show-graph))
+               ("C-c n g" . org-roam-graph))
               :map org-mode-map
-              (("C-c n i" . org-roam-insert))))
+              (("C-c n i" . org-roam-insert))
+              (("C-c n I" . org-roam-insert-immediate))))
 ```
 
-For more detailed installation instructions (including instructions for
-Spacemacs users), please see [the installation
-documentation](https://org-roam.readthedocs.io/en/develop/installation/).
+Org-roam requires sqlite to function. Org-roam optionally uses Graphviz for
+graph-related functionality. It is recommended to install PCRE-enabled ripgrep
+for better performance and extended functionality.
 
-## Knowledge Bases using Org-Roam
+## Getting Help
+
+Before creating a new topic/issue, please be mindful of our time and ensure that
+it has not already been addressed on [GitHub][issues] or on
+[Discourse][discourse].
+
+- If you are new to Emacs and have problem setting up Org-roam, please ask your
+  question on [Slack, channel #how-do-i][slack].
+- For quick questions, please ask them on [Slack, channel
+  #troubleshooting][slack].
+- If something is not working as it should, or if you would like to suggest a
+  new feature, please [create a new issue][issues].
+- If you have questions about your workflow with the slip-box method, please
+  find a relevant topic on [Discourse][discourse], or create a new one.
+
+## Knowledge Bases using Org-roam
 
 - [Jethro Kuan](https://braindump.jethro.dev/)
   ([Source](https://github.com/jethrokuan/braindump/tree/master/org))
-
-## Changelog
-
-A changelog is being maintained [here](CHANGELOG.md)
+- [Alexey Shmalko](https://braindump.rasen.dev/)
 
 ## Contributing
 
@@ -77,8 +91,18 @@ request. Please also see [CONTRIBUTING.md](.github/CONTRIBUTING.md).
 ## License
 
 Copyright © Jethro Kuan and contributors. Distributed under the GNU
-General Public License, Version 3
+General Public License, Version 3.
 
 [roamresearch]: https://www.roamresearch.com/
 [org]: https://orgmode.org/
-[badge-license]: https://img.shields.io/badge/license-GPL_3-green.svg
+[gpl3-badge]: https://img.shields.io/badge/license-GPL_3-green.svg
+[gpl3]: http://www.gnu.org/licenses/gpl-3.0.txt
+[melpa-badge]: https://melpa.org/packages/org-roam-badge.svg
+[melpa]: https://melpa.org/#/org-roam
+[release-badge]: https://img.shields.io/github/v/release/org-roam/org-roam
+[release]: https://github.com/org-roam/org-roam/releases
+[docs]: https://www.orgroam.com/manual.html
+[discourse]: https://org-roam.discourse.group/
+[slack]: https://join.slack.com/t/orgroam/shared_invite/zt-deoqamys-043YQ~s5Tay3iJ5QRI~Lxg
+[issues]: https://github.com/org-roam/org-roam/issues
+[faq]: https://www.orgroam.com/manual.html#FAQ

default.mk

@@ -0,0 +1,106 @@
+TOP := $(dir $(lastword $(MAKEFILE_LIST)))
+
+## User options ######################################################
+#
+# You can override these settings in "config.mk" or on the command
+# line.
+#
+# You might also want to set LOAD_PATH.  If you do, then it must
+# contain "-L .".
+#
+# If you don't do so, then the default is set in the "Load-Path"
+# section below.  The default assumes that all dependencies are
+# installed either at "../<DEPENDENCY>", or when using package.el
+# at "ELPA_DIR/<DEPENDENCY>-<HIGHEST-VERSION>".
+
+sharedir ?= $(HOME)/.local/share
+lispdir  ?= $(sharedir)/emacs/site-lisp/org-roam
+infodir  ?= $(sharedir)/info
+docdir   ?= $(sharedir)/doc/org-roam
+statsdir ?= $(TOP)/doc/stats
+
+CP       ?= install -p -m 644
+MKDIR    ?= install -p -m 755 -d
+RMDIR    ?= rm -rf
+TAR      ?= tar
+SED      ?= sed
+
+EMACSBIN ?= emacs
+BATCH     = $(EMACSBIN) -Q --batch $(LOAD_PATH)
+
+INSTALL_INFO     ?= $(shell command -v ginstall-info || printf install-info)
+MAKEINFO         ?= makeinfo
+MANUAL_HTML_ARGS ?= --css-ref /assets/page.css
+
+## Files #############################################################
+
+PKG       = org-roam
+PACKAGES  = org-roam
+
+TEXIPAGES = $(addsuffix .texi,$(PACKAGES))
+INFOPAGES = $(addsuffix .info,$(PACKAGES))
+HTMLFILES = $(addsuffix .html,$(PACKAGES))
+HTMLDIRS  = $(PACKAGES)
+PDFFILES  = $(addsuffix .pdf,$(PACKAGES))
+EPUBFILES = $(addsuffix .epub,$(PACKAGES))
+
+ELS = org-roam-buffer.el
+ELS += org-roam-capture.el
+ELS += org-roam-compat.el
+ELS += org-roam-completion.el
+ELS += org-roam-dailies.el
+ELS += org-roam-db.el
+ELS += org-roam.el
+ELS += org-roam-graph.el
+ELS += org-roam-macs.el
+ELS += org-roam-protocol.el
+ELCS = $(ELS:.el=.elc)
+ELMS = org-roam.el $(filter-out $(addsuffix .el,$(PACKAGES)),$(ELS))
+ELGS = org-roam-autoloads.el org-roam-version.el
+
+## Versions ##########################################################
+
+VERSION ?= $(shell test -e $(TOP).git && git describe --tags --abbrev=0 | cut -c2-)
+
+EMACS_VERSION = 26.1
+
+EMACSOLD := $(shell $(BATCH) --eval \
+  "(and (version< emacs-version \"$(EMACS_VERSION)\") (princ \"true\"))")
+ifeq "$(EMACSOLD)" "true"
+  $(error At least version $(EMACS_VERSION) of Emacs is required)
+endif
+
+## Load-Path #########################################################
+
+ifndef LOAD_PATH
+
+ELPA_DIR ?= $(HOME)/.emacs.d/elpa
+
+SYSTYPE := $(shell $(EMACSBIN) -Q --batch --eval "(princ system-type)")
+ifeq ($(SYSTYPE), windows-nt)
+  CYGPATH := $(shell cygpath --version 2>/dev/null)
+endif
+
+LOAD_PATH = -L $(TOP)
+
+# When making changes here, then don't forget to adjust "Makefile",
+# ".travis.yml", ".github/ISSUE_TEMPLATE/bug_report.md",
+# `magit-emacs-Q-command' and the "Installing from the Git Repository"
+# info node accordingly.  Also don't forget to "rgrep \b<pkg>\b".
+
+endif # ifndef LOAD_PATH
+
+ifndef ORG_LOAD_PATH
+ORG_LOAD_PATH  = $(LOAD_PATH)
+ORG_LOAD_PATH += -L $(TOP)../ox-texinfo-plus
+ORG_LOAD_PATH += -L $(TOP)../org-mode/contrib/lisp
+ORG_LOAD_PATH += -L $(TOP)../org-mode/lisp
+endif
+
+## Publish ###########################################################
+
+PUBLISH_TARGETS ?= html html-dir pdf epub
+
+DOCBOOK_XSL ?= /usr/share/xml/docbook/stylesheet/docbook-xsl/epub/docbook.xsl
+
+EPUBTRASH = epub.xml META-INF OEBPS

doc/AUTHORS.md

@@ -0,0 +1,37 @@
+Authors
+=======
+
+The following people have contributed to Org-Roam.
+
+Names below are sorted alphabetically.
+
+Author
+------
+
+- Jethro Kuan <jethrokuan95@gmail.com>
+
+Maintainers
+----------
+
+- Jethro Kuan <jethrokuan95@gmail.com>
+- Leo Vivier <leo.vivier+dev@gmail.com>
+
+Contributors
+------------
+
+- Alexey Shmalko <rasen.dubi@gmail.com>
+- James Ravn <james@r-vn.org>
+- Jethro Kuan <jethrokuan95@gmail.com>
+- Johann Klähn <johann@jklaehn.de>
+- Josh English <josh@joshenglish.com>
+- Jürgen Hötzel <juergen@archlinux.org>
+- Langston Barrett <langston.barrett@gmail.com>
+- Leo Vivier <leo.vivier+dev@gmail.com>
+- Michael Glaesemann <grzm@seespotcode.net>
+- Michael Herold <github@michaeljherold.com>
+- Noboru <noboru.ota@gmail.com>
+- N V <44036031+progfolio@users.noreply.github.com>
+- Rafael Accácio Nogueira <raccacio@poli.ufrj.br>
+- Roland Coeurjoly <rolandcoeurjoly@gmail.com>
+- Sayan <dit7ya@users.noreply.github.com>
+- Tim Quelch <tim@tquelch.com>

doc/Makefile

@@ -0,0 +1,127 @@
+-include ../config.mk
+include ../default.mk
+
+###################################################################
+MANUAL_HTML_ARGS = --css-ref assets/page.css
+
+.PHONY: texi install clean AUTHORS.md stats
+
+all: info
+
+## Build #############################################################
+
+info: $(INFOPAGES) dir
+html: $(HTMLFILES)
+pdf:  $(PDFFILES)
+epub: $(EPUBFILES)
+
+%.info: %.texi
+	@printf "Generating $@\n"
+	@$(MAKEINFO) --no-split $< -o $@
+
+dir: org-roam.info
+	@printf "Generating dir\n"
+	@echo $^ | xargs -n 1 $(INSTALL_INFO) --dir=$@
+
+%.html: %.texi
+	@printf "Generating $@\n"
+	@$(MAKEINFO) --html --no-split $(MANUAL_HTML_ARGS) $<
+
+html-dir:
+	@$(MAKEINFO) --html --no-split $(MANUAL_HTML_ARGS) org-roam.texi
+	mv org-roam.html manual.html
+
+%.pdf: %.texi
+	@printf "Generating $@\n"
+	@texi2pdf --clean $< > /dev/null
+
+%.epub: %.texi
+	@printf "Generating $@\n"
+	@$(MAKEINFO) --docbook $< -o epub.xml
+	@xsltproc $(DOCBOOK_XSL) epub.xml 2> /dev/null
+	@echo "application/epub+zip" > mimetype
+	@zip -X --quiet --recurse-paths -0 $@ mimetype
+	@zip -X --quiet --recurse-paths -9 --no-dir-entries $@ META-INF OEBPS
+	@$(RMDIR) $(EPUBTRASH)
+
+## Install ###########################################################
+
+install: install-info install-docs
+
+install-docs: install-info
+	@$(MKDIR) $(DESTDIR)$(docdir)
+	$(CP) AUTHORS.md $(DESTDIR)$(docdir)
+
+install-info: info
+	@$(MKDIR) $(DESTDIR)$(infodir)
+	$(CP) $(INFOPAGES) $(DESTDIR)$(infodir)
+
+## Clean #############################################################
+
+clean:
+	@printf "Cleaning doc/*...\n"
+	@$(RMDIR) dir $(INFOPAGES) $(HTMLFILES) $(HTMLDIRS) $(PDFFILES)
+	@$(RMDIR) $(EPUBFILES) $(EPUBTRASH)
+
+## Release management ################################################
+
+ORG_ARGS  = --batch -Q $(ORG_LOAD_PATH)
+ORG_ARGS += -l ox-extra -l ox-texinfo+
+ORG_ARGS += --eval "(or (require 'org-man nil t) (require 'ol-man))"
+ORG_EVAL  = --eval "(ox-extras-activate '(ignore-headlines))"
+ORG_EVAL += --eval "(setq indent-tabs-mode nil)"
+ORG_EVAL += --eval "(setq org-src-preserve-indentation nil)"
+ORG_EVAL += --funcall org-texinfo-export-to-texinfo
+
+# This target first bumps version strings in the Org source.  The
+# necessary tools might be missing so other targets do not depend
+# on this target and it has to be run explicitly when appropriate.
+#
+#   AMEND=t make texi    Update manual to be amended to HEAD.
+#   VERSION=N make texi  Update manual for release.
+#
+texi:
+	@$(EMACSBIN) $(ORG_ARGS) $(PKG).org $(ORG_EVAL)
+	@printf "\n" >> $(PKG).texi
+	@rm -f $(PKG).texi~
+
+stats:
+	@printf "Generating statistics\n"
+	@gitstats -c style=/assets/stats.css -c max_authors=999 $(TOP) $(statsdir)
+
+authors: AUTHORS.md
+
+AUTHORS.md:
+	@printf "Generating AUTHORS.md..."
+	@test -e $(TOP).git \
+	&& (printf "$$AUTHORS_HEADER\n" > $@ \
+	&& git log --pretty=format:'- %aN <%aE>' | sort -u >> $@ \
+	&& printf "done\n" ; ) \
+	|| printf "FAILED (non-fatal)\n"
+
+# Templates ##########################################################
+
+define AUTHORS_HEADER
+Authors
+=======
+
+The following people have contributed to Org-Roam.
+
+Names below are sorted alphabetically.
+
+Author
+------
+
+- Jethro Kuan <jethrokuan95@gmail.com>
+
+Maintainers
+----------
+
+- Jethro Kuan <jethrokuan95@gmail.com>
+- Leo Vivier <leo.vivier+dev@gmail.com>
+
+Contributors
+------------
+
+endef
+export AUTHORS_HEADER

doc/assets/page.css

@@ -0,0 +1,68 @@
+:root {
+  --border: #526980;
+  --code: #007;
+}
+
+body {
+    margin: 5ex 10ex;
+    max-width: 80ex;
+    line-height: 1.5;
+    font-family: sans-serif;
+}
+
+h1, h2, h3 {
+    font-weight: normal;
+}
+
+pre, code {
+    font-family: x, monospace;
+}
+
+pre {
+    padding: 1ex;
+    background: #eee;
+    border: solid 1px #ddd;
+    min-width: 0;
+    font-size: 80%;
+    overflow: auto;
+}
+
+code {
+    color: var(--code);
+}
+
+img {
+    max-width: 100%;
+}
+
+table {
+  border-collapse: collapse;
+  width: 100%;
+}
+
+pre.menu-comment {
+  background: none;
+  border: none;
+  font-family: sans-serif;
+  padding: 0;
+  margin: 0;
+  font-size: 100%;
+}
+
+thead {
+  border-bottom: 1px solid var(--border);
+}
+
+tfoot {
+  border-top: 1px solid var(--border);
+}
+
+blockquote {
+  margin-left: 1rem;
+  font-style: italic;
+  font-family: serif;
+  border-left: 3px solid;
+  border-left-color: currentcolor;
+  border-color: var(--text-color);
+  padding-left: 1em;
+}

doc/comparison.md

@@ -1,11 +0,0 @@
----
-title: "Comparing Org-Roam With Other Packages"
-metaTitle: "Comparing Org-Roam With Other Packages"
-metaDescription: "Comparing Org-Roam With Other Packages"
----
-
-# Org-brain
-
-# Zetteldeft
-
-# Org-zettelkasten

doc/configuration.md

@@ -1,121 +0,0 @@
-To ensure that Org-roam remains manageable, the number of
-configuration options is deliberately kept small. However, we have
-attempted to accommodate as many usage styles as possible.
-
-In this section, we'll go over the main customization options
-available to Org-Roam. This section is *crucial*. We need to exploit
-the flexibility of Emacs, and mould our tools exactly to our liking.
-
-All of Org-roam's customization options can be viewed via `M-x
-customize-group org-roam`.
-
-## Setting the Org-roam Directory
-
-Perhaps the single most important variable to set is
-`org-roam-directory`. Set `org-roam-directory` to the folder
-containing all your Org files:
-
-```emacs-lisp
-(setq org-roam-directory "/path/to/org/")
-```
-
-Every Org file, at any level of nesting, within `/path/to/org/` is
-considered part of the Org-roam ecosystem.
-
-## Org-roam Buffer
-
-The Org-roam buffer defaults to popping up from the right. You may
-choose to set it to pop up from the left with `(setq
-org-roam-buffer-position 'left)`.
-
-The Org-roam buffer name can also be renamed: e.g. `(setq
-org-roam-buffer "*my-buffer-name*")`.
-
-The Org-roam buffer width is adjustable via `org-roam-buffer-width`.
-The value of `org-roam-buffer-width` set as a percentage of the total
-frame width. For example:
-
-```emacs-lisp
-(setq org-roam-buffer-width 0.4)
-```
-
-Will result in the Org-roam buffer taking up 40% of the screen width.
-I have found this to be a good number.
-
-## Org-roam Links
-
-By default, links are inserted with the title as the link description.
-This can make them hard to distinguish from external links. If you
-wish, you may choose add special indicators for Org-roam links by
-tweaking `org-roam-link-title-format`, for example:
-
-```emacs-lisp
-(setq org-roam-link-title-format "R:%s")
-```
-
-## Org-roam Files
-
-These customization options revolve around the Org files created and
-managed by Org-roam.
-
-### Automatically Creating Files Using Timestamp
-
-A common hassle is ensuring that files are uniquely named within the
-Org-roam directory. Org-roam's default workflow utilizes the title of
-Org files in all of its main commands (`org-roam-insert`,
-`org-roam-find-file`). Hence, having any unique file name is a decent
-option, and the default workflow uses the timestamp as the filename.
-
-The format of the filename is controlled by the function
-`org-roam-file-name-function`, which defaults to a format like
-`YYYYMMDDHHMMSS_title_here.org`. You may choose to define your own
-function to change this.
-
-If you wish to be prompted to change the file name on creation, set
-`org-roam-filename-noconfirm` to `nil`:
-
-```emacs-lisp
-(setq org-roam-filename-noconfirm nil)
-```
-
-It is then the user's responsibility to ensure that the file names are
-unique.
-
-### Autopopulating Titles
-
-The default workflow uses the title of the Org file in several
-commands. The title is specified via the `#+TITLE:` attribute,
-typically near the top of the file. The option
-`org-roam-autopopulate-title` defaults to `t`. When true, the title
-attribute is automatically inserted into the files created via
-Org-roam commands. Setting it to `nil` will disable this behaviour.
-
-### Encryption
-
-Encryption (via GPG) can be enabled for all new files by setting
-`org-roam-encrypt-files` to `t`. When enabled, new files are created
-with the .org.gpg extension and decryption are handled automatically
-by EasyPG. Note that this causes Emacs to ask for password when the
-cache is built (if you have an encrypted file in `org-roam-directory`)
-as well as each time a new file is created. It might be a good idea to
-cache the password in order to make this more managable.
-
-## Org-roam Graph Viewer
-
-Org-roam generates an SVG image using
-[Graphviz](https://graphviz.org/). To setup graph navigation, see the
-[Graph Setup](graph_setup.md) page.
-
-Org-roam tries its best to locate the Graphviz executable from your
-PATH, but if it fails to do so, you may set it manually:
-
-```
-(setq org-roam-graphviz-executable "/path/to/dot")
-```
-
-Org-roam also attempts to use Firefox (located on PATH) to view the
-SVG, you may choose to set it to any compatible program:
-
-```
-(setq org-roam-graph-viewer "/path/to/image-viewer")
-```

doc/css/styles.css

@@ -0,0 +1,85 @@
+body {
+  margin: 20px;
+  background: #303030;
+  color: #f5f5f5;
+  font-size: 1.6rem;
+  font-weight: 300;
+}
+
+.container {
+  max-width: 800px;
+}
+
+.nav {
+  margin-top: 5rem;
+}
+
+.nav-item a {
+  /* color: #797979; */
+  color: #bebebe;
+  text-decoration: none;
+  font-family: "Consolas", "Monaco", "Menlo", monospace;
+}
+
+.nav-item a:hover {
+  cursor: pointer;
+  /* color: #4d4a4a; */
+  color: #dcdcdc;
+  border: none;
+}
+
+.hero {
+  color: #f5f5f5;
+}
+
+.hero div {
+  margin-bottom: 5rem;
+}
+
+.hero h3 {
+  /* font-family: "Edelsans", sans-serif; */
+  font-size: 5rem;
+  margin-bottom: 0;
+}
+
+.hero h5 {
+  margin-top: 1rem;
+  margin-bottom: 0;
+  /* font-weight: 200; */
+  font-weight: 250;
+}
+
+.grid-demo-col {
+  background: #e4e4e4;
+}
+
+a {
+  color: #cd86ff;
+}
+
+a:hover {
+  color: #dbb9f3;
+}
+
+img {
+  max-width: 100%;
+}
+
+.footer-links {
+  font-size: 1.5rem;
+  color: #f5f5f5;
+  text-decoration: none;
+  font-weight: 250;
+}
+
+.header {
+  font-weight: 200;
+}
+
+#footer {
+  margin-bottom: 3rem;
+}
+
+#footer h5 {
+  margin-bottom: 1.5rem;
+}

doc/ecosystem.md

@@ -1,126 +0,0 @@
-A number of packages work well combined with Org-Roam:
-
-## Deft
-
-[Deft][deft] provides a nice interface for browsing and filtering
-org-roam notes.
-
-```emacs-lisp
-(use-package deft
-  :after org
-  :bind
-  ("C-c n d" . deft)
-  :custom
-  (deft-recursive t)
-  (deft-use-filter-string-for-filename t)
-  (deft-default-extension "org")
-  (deft-directory "/path/to/org-roam-files/"))
-```
-
-If the title of the Org file is not the first line, you might not get
-nice titles. You may choose to patch this to use `org-roam`'s
-functionality. Here I'm using [el-patch](https://github.com/raxod502/el-patch):
-
-```emacs-lisp
-(use-package el-patch
-  :straight (:host github
-                   :repo "raxod502/el-patch"
-                   :branch "develop"))
-
-(eval-when-compile
-  (require 'el-patch))
-
-(use-package deft
-  ;; same as above...
-  :config/el-patch
-  (defun deft-parse-title (file contents)
-    "Parse the given FILE and CONTENTS and determine the title.
-If `deft-use-filename-as-title' is nil, the title is taken to
-be the first non-empty line of the FILE.  Else the base name of the FILE is
-used as title."
-    (el-patch-swap (if deft-use-filename-as-title
-                       (deft-base-filename file)
-                     (let ((begin (string-match "^.+$" contents)))
-                       (if begin
-                           (funcall deft-parse-title-function
-                                    (substring contents begin (match-end 0))))))
-                   (org-roam--get-title-or-slug file))))
-```
-
-The Deft interface can slow down quickly when the number of files get
-huge. [Notdeft][notdeft] is a fork of Deft that uses an external
-search engine and indexer.
-
-## Org-journal
-
-[Org-journal](https://github.com/bastibe/org-journal) is a more
-powerful alternative to the simple function `org-roam-today`. It
-provides better journaling capabilities, and a nice calendar interface
-to see all dated entries.
-
-```emacs-lisp
-(use-package org-journal
-  :bind
-  ("C-c n j" . org-journal-new-entry)
-  :custom
-  (org-journal-date-prefix "#+TITLE: ")
-  (org-journal-file-format "%Y-%m-%d.org")
-  (org-journal-dir "/path/to/org-roam-files/")
-  (org-journal-date-format "%A, %d %B %Y"))
-```
-
-## Note-taking Add-ons
-
-These are some plugins that make note-taking in Org-mode more
-enjoyable.
-
-### Org-download
-
-[Org-download][org-download] lets you screenshot and yank images from
-the web into your notes:
-
-![org-download](images/org-download.gif)
-
-```emacs-lisp
-(use-package org-download
-  :after org
-  :bind
-  (:map org-mode-map
-        (("s-Y" . org-download-screenshot)
-         ("s-y" . org-download-yank))))
-```
-
-### mathpix.el
-
-[mathpix.el][mathpix-el] uses [Mathpix's](https://mathpix.com/) API to convert clips into
-latex equations:
-
-![mathpix](images/mathpix.gif)
-
-```emacs-lisp
-(use-package mathpix.el
-  :straight (:host github :repo "jethrokuan/mathpix.el")
-  :custom ((mathpix-app-id "app-id")
-           (mathpix-app-key "app-key"))
-  :bind
-  ("C-x m" . mathpix-screenshot))
-```
-
-### Org-noter / Interleave
-
-[Org-noter][org-noter] and [Interleave][interleave] are both projects
-that allow synchronised annotation of documents (PDF, EPUB etc.)
-within Org-mode.
-
-### Org-ref
-
-[Org-ref][org-ref] does citation and bibliography management in
-Org-mode, and a great tool for scientific notes.
-
-[deft]: https://jblevins.org/projects/deft/
-[notdeft]: https://github.com/hasu/notdeft
-[org-download]: https://github.com/abo-abo/org-download
-[mathpix-el]: https://github.com/jethrokuan/mathpix.el
-[org-noter]: https://github.com/weirdNox/org-noter
-[interleave]: https://github.com/rudolfochrist/interleave
-[org-ref]: https://github.com/jkitchin/org-ref

doc/graph_setup.md

@@ -1,78 +0,0 @@
-The setup is similar to that of org-protocol. Here `roam://` links are
-defined, and need to be associated with an application. 
-
-The gist of the setup is setting up a Bash script to trim off the
-`roam://` prefix from the link, causing the desktop application to
-call `emacsclient path/to/org-roam-file.org`.
-
-## Linux
-
-Create a desktop application. I place mine in
-`~/.local/share/applications/roam.desktop`:
-
-```
-[Desktop Entry]
-Name=Org-Roam Client
-Exec=/home/jethro/.local/bin/launch_emacs %u
-Icon=emacs-icon
-Type=Application
-Terminal=false
-MimeType=x-scheme-handler/roam
-```
-
-Note the `Exec` key is set to a bash script poorly named
-`launch_emacs`. You can set it to whatever you want.
-
-Create the corresponding bash script, and make it executable. Here's
-how it looks like:
-
-```bash
-#!/usr/bin/env bash
-emacsclient "${1#*:}"
-```
-
-Finally, associate `roam://` links with the desktop application by
-running in your shell:
-
-```bash
-xdg-mime default roam.desktop x-scheme-handler/roam
-```
-
-## Mac OS
-
-One solution to this, recommended in [Issue
-#115](https://github.com/jethrokuan/org-roam/issues/115), is to use
-[Platypus](https://github.com/sveinbjornt/Platypus). Here are the
-instructions for setting up with Platypus and Chrome:
-
-1. Create an executable `launch-emacs.sh` script:
-
-```sh
-#!/usr/bin/env bash
-/usr/local/bin/emacsclient --no-wait "${1#*:}"
-```
-
-2. Install and launch Platypus (with [Homebrew](https://brew.sh/)):
-
-```sh
-brew cask install playtpus
-```
-
-3. Playtpus settings:
-
-- App Name: `OrgRoam`
-- Script Type: `env` and `/usr/bin/env`
-- Script Path: `/path/to/your/launch-emacs.sh`
-- Tick Accept dropped items and click Settings
-- Tick Accept dropped files
-- Tick Register as URI scheme handler
-- Add `roam` as a protocol
-- Create the app
-
-To disable the "confirm" prompt in Chrome, you can also make Chrome
-show a checkbox to tick, so that the `OrgRoam` app will be used
-without confirmation. To do this, run in a shell:
-
-```sh
-defaults write com.google.Chrome ExternalProtocolDialogShowAlwaysOpenCheckbox -bool true
-```

doc/htmlxref.cnf

@@ -0,0 +1,15 @@
+# https://www.gnu.org/software/texinfo/manual/texinfo/html_node/HTML-Xref-Configuration.html
+
+EMACS = https://www.gnu.org/software/emacs/manual
+
+auth		mono	${EMACS}/html_mono/auth.html
+auth		node	${EMACS}/html_node/auth/
+
+ediff		mono	${EMACS}/html_mono/ediff.html
+ediff		node	${EMACS}/html_node/ediff/
+
+elisp		mono	${EMACS}/html_mono/elisp.html
+elisp		node	${EMACS}/html_node/elisp/
+
+emacs		mono	${EMACS}/html_mono/emacs.html
+emacs		node	${EMACS}/html_node/emacs/

doc/index.html

@@ -0,0 +1,168 @@
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="utf-8" />
+    <meta http-equiv="X-UA-Compatible" content="IE=edge" />
+    <meta name="viewport" content="width=device-width, initial-scale=1" />
+    <meta name="description" content="An Effortless PKM System." />
+    <meta name="author" content="Org-roam Contributors" />
+
+    <title>Org-roam</title>
+
+    <link rel="stylesheet" href="https://unpkg.com/wingcss" />
+    <link rel="stylesheet" type="text/css" href="./css/styles.css" />
+
+    <script src="https://code.iconify.design/1/1.0.6/iconify.min.js"></script>
+  </head>
+
+  <body>
+    <section class="hero container center text-center">
+      <div>
+        <img src="./img/logo.png" alt="Org-roam Logo" height="200" />
+        <h3>Org-roam</h3>
+        <h5>A plain-text personal knowledge management system.</h5>
+      </div>
+    </section>
+
+    <section class="container center">
+      <div>
+        <img src="./img/screenshot.png" alt="screenshot" />
+      </div>
+    </section>
+
+    <section id="features" class="container center">
+      <div>
+        <h3 class="header">FEATURES</h3>
+        <div class="row">
+          <div class="col">
+            <h5 class="left">
+              <iconify-icon data-icon="fxemoji:lock"></iconify-icon> &nbsp;
+              Private and Secure
+            </h5>
+            <p class="content">
+              Edit your personal wiki completely offline, entirely in your
+              control. Encrypt your notes with GPG. Take lasting notes in
+              plain-text.
+            </p>
+          </div>
+          <div class="col">
+            <h5 class="left">
+              <iconify-icon data-icon="flat-color-icons:link"></iconify-icon>
+              &nbsp; Make Connections
+            </h5>
+            <p class="content">
+              Connect notes and thoughts together with ease using backlinks.
+              Discover surprising and previously unseen connections in your
+              notes with the built-in graph visualization.
+            </p>
+          </div>
+        </div>
+
+        <div class="row">
+          <div class="col">
+            <h5 class="left">
+              <iconify-icon data-icon="twemoji:puzzle-piece"></iconify-icon>
+              &nbsp; Extensible and Powerful
+            </h5>
+            <p class="content">
+              Leverage Emacs' fantastic text-editing interface, and the mature
+              Emacs and Org-mode ecosystem of packages.
+            </p>
+          </div>
+          <div class="col">
+            <h5 class="left">
+              <iconify-icon data-icon="logos:git-icon"></iconify-icon> &nbsp;
+              Free and Open Source
+            </h5>
+            <p class="content">
+              Org-roam is licensed under the GNU General Public License version
+              3 or later. You are free to extend its functionality and
+              contribute back. Find
+              us <a href="https://github.com/org-roam/org-roam">here</a>.
+            </p>
+          </div>
+        </div>
+      </div>
+    </section>
+    
+    <section id="links" class="container">
+      <div>
+        <h3 class="header">LINKS</h3> New to Emacs and Org-mode, and trying to
+        find your way around? Org-roam has an inclusive community of users
+        passionate about Personal Knowledge Management -- we're happy to help!
+        You can find us on Discourse and Slack.
+        
+        <ul>
+            <li>Read our documentation within Emacs, or on the <a href="https://www.orgroam.com/manual.html">Online Manual</a></li>
+            <li>Participate in our forum discussions on <a href="https://org-roam.discourse.group">Discourse</a></li>
+            <li>Chat with us on <a href="https://join.slack.com/t/orgroam/shared_invite/zt-deoqamys-043YQ~s5Tay3iJ5QRI~Lxg">Slack</a></li>
+          </ul>
+      </div>
+    </section>
+
+    <section id="footer" class="row container">
+      <div class="col">
+        <div class="row">
+          <h5 class="header">Ecosystem</h5>
+        </div>
+
+        <div class="row">
+          <a
+            class="content footer-links"
+            href="https://github.com/org-roam/org-roam-bibtex"
+            >org-roam-bibtex</a
+          >
+        </div>
+        <div class="row">
+          <a
+            class="content footer-links"
+            href="https://github.com/org-roam/org-roam-server"
+            >org-roam-server</a
+          >
+        </div>
+      </div>
+
+      <div class="col">
+        <div class="row">
+          <h5 class="header">Resources</h5>
+        </div>
+
+        <div class="row">
+          <a
+            class="content footer-links"
+            href="https://github.com/org-roam/org-roam/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc"
+            >Open Issues</a
+          >
+        </div>
+        <div class="row">
+          <a
+            class="content footer-links"
+            href="https://github.com/org-roam/org-roam/releases"
+            >Releases</a
+          >
+        </div>
+      </div>
+
+      <div class="col">
+        <div class="row">
+          <h5 class="header">Connect</h5>
+        </div>
+
+        <div class="row">
+          <a
+            class="content footer-links"
+            href="https://join.slack.com/t/orgroam/shared_invite/zt-deoqamys-043YQ~s5Tay3iJ5QRI~Lxg"
+            >Slack</a
+          >
+        </div>
+        <div class="row">
+          <a
+            class="content footer-links"
+            href="https://org-roam.discourse.group/"
+            >Discourse</a
+          >
+        </div>
+      </div>
+    </section>
+  </body>
+</html>

doc/index.md

@@ -1,41 +0,0 @@
-![org-roam][org-roam-intro-image]
-
-## What is Org-Roam?
-
-Org-roam is a rudimentary [Roam][roamresearch] replica built around
-the all-powerful [Org-mode][org]. 
-
-Like Roam, Org-roam offers a powerful and effortless non-hierarchical
-note-taking approach. With Org-roam, notes flow naturally, making
-note-taking fun and easy. To understand more about Roam, I recommend
-the following links:
-
--   [Building a second brain in
-    Roam](https://reddit.com/r/RoamResearch/comments/eho7de/building_a_second_brain_in_roamand_why_you_might)
--   [Roam: Why I Love It and How I Use
-    It](https://www.nateliason.com/blog/roam)
-
-The goal of the project is to implement core features of Roam around
-Org-mode, and eventually introduce features enabled by the Emacs
-ecosystem. 
-
-## Why build Org-Roam?
-
-With Org-roam, you:
-
-1. Never have to leave Emacs.
-2. Can leverage all the powerful features of Org-mode: LaTeX, tables,
-   and the whole to-do ecosystem (org-agenda etc.)
-3. Be in full control your second brain, and access it offline. Never
-   share your data with anyone
-
-There are several packages that are similar to Org-roam, see the
-[Comparison](comparison.md) page for a detailed comparison.
-
-## Project Status
-
-As of February 2020, it is in a very early stage of development. 
-
-[org-roam-intro-image]: images/org-roam-intro.png
-[roamresearch]: https://www.roamresearch.com/
-[org]: https://orgmode.org/

doc/installation.md

@@ -1,93 +0,0 @@
-## Installation
-
-The recommended method is using [use-package][use-package] and
-[straight][straight], or a similar package manager.
-
-```
-(use-package org-roam
-      :after org
-      :hook 
-      (after-init . org-roam-mode)
-      :straight (:host github :repo "jethrokuan/org-roam" :branch "develop")
-      :custom
-      (org-roam-directory "/path/to/org-files/")
-      :bind (:map org-roam-mode-map
-              (("C-c n l" . org-roam)
-               ("C-c n f" . org-roam-find-file)
-               ("C-c n g" . org-roam-show-graph))
-              :map org-mode-map
-              (("C-c n i" . org-roam-insert))))
-```
-
-If not using package.el, you can also clone it into your Emacs
-directory and add it to your load path:
-
-```
-git clone https://github.com/jethrokuan/org-roam/ ~/.emacs.d/elisp/org-roam
-```
-
-```
-(use-package org-roam
-      :after org
-      :load-path "elisp/"
-      :hook 
-      (after-init . org-roam-mode)
-      :straight (:host github :repo "jethrokuan/org-roam" :branch "develop")
-      :custom
-      (org-roam-directory "/path/to/org-files/")
-      :bind (:map org-roam-mode-map
-              (("C-c n l" . org-roam)
-               ("C-c n f" . org-roam-find-file)
-               ("C-c n g" . org-roam-show-graph))
-              :map org-mode-map
-              (("C-c n i" . org-roam-insert))))
-```
-
-Or without use-package:
-
-```
-(add-to-list 'load-path "./elisp")
-(require 'org-roam)
-```
-
-There are a number of important configuration options, that greatly
-affect the Roam workflow. Do look through them at the
-[Configuration](configuration.md) page.
-
-[use-package]: https://github.com/jwiegley/use-package
-[straight]: https://github.com/raxod502/straight.el
-
-## Spacemacs
-If you are using Spacemacs, you can easily install org-roam by creating a simple layer that wraps org-roam. Paste the following into a new file `/.emacs.d/private/org-roam/packages.el`.
-```
-(defconst org-roam-packages
-  '((org-roam :location
-        (recipe :fetcher github :repo "jethrokuan/org-roam" :branch "develop"))))
-
-(defun org-roam/init-org-roam ()
-    (use-package org-roam
-        :after org
-        :hook
-        (after-init . org-roam-mode)
-        :custom
-        (org-roam-directory "/path/to/org-files/")
-        :init
-        (progn
-          (spacemacs/declare-prefix "ar" "org-roam")
-          (spacemacs/set-leader-keys
-            "arl" 'org-roam
-            "art" 'org-roam-today
-            "arf" 'org-roam-find-file
-            "arg" 'org-roam-show-graph)
-
-          (spacemacs/declare-prefix-for-mode 'org-mode "mr" "org-roam")
-          (spacemacs/set-leader-keys-for-major-mode 'org-mode
-            "rl" 'org-roam
-            "rt" 'org-roam-today
-            "rb" 'org-roam-switch-to-buffer
-            "rf" 'org-roam-find-file
-            "ri" 'org-roam-insert
-            "rg" 'org-roam-show-graph))))
-```
-
-Next, append `org-roam` to the `dotspacemacs-configuration-layers` list in your `.spacemacs` configuration file. Reload (`SPC f e R`) or restart Emacs to load `org-roam`. It's functions are available under the prefix `SPC a r` and `, r` when visiting an org-mode buffer. 

doc/notetaking_workflow.md

@@ -1,20 +0,0 @@
-## Recommended Books
-- [How to Take Smart Notes][1]
-
-## Articles
-- [How to Take Smart Notes in Org-mode - Jethro Kuan][7]
-- [The Zettelkasten Method - LessWrong 2.0][3]
-- [Building a second brain in Roam][4]
-- [Roam: Why I Love It and How I Use It][5]
-- [Adam Keesling's Twitter Thread][6]
-
-## What to Do With Your Notes
-- [How to Use Roam to Outline a New Article in Under 20 Minutes][2]
-
-[1]: https://www.goodreads.com/book/show/34507927-how-to-take-smart-notes?ac=1&from_search=true&qid=6L8iEE1FIA&rank=1
-[2]: https://www.youtube.com/watch?v=RvWic15iXjk
-[3]: https://www.lesswrong.com/posts/NfdHG6oHBJ8Qxc26s/the-zettelkasten-method-1
-[4]: https://reddit.com/r/RoamResearch/comments/eho7de/building_a_second_brain_in_roamand_why_you_might
-[5]: https://www.nateliason.com/blog/roam
-[6]: https://twitter.com/adam_keesling/status/1196864424725774336?s=20
-[7]: https://blog.jethro.dev/posts/how_to_take_smart_notes_org/

doc/requirements.txt

@@ -1,2 +0,0 @@
-mkdocs-material==4.6.2
-pymdown-extensions==6.3

doc/tour.md

@@ -1,69 +0,0 @@
-Org-roam was built to support a workflow that was not possible with
-vanilla Org-mode. This flow is modelled after the [Zettelkasten
-method][zettelkasten], and many of [Roam Research][roam]'s workflows.
-Understanding this flow is crucial! Org-roam doesn't auto-magically
-make your note-taking better -- it's changing the note-taking workflow
-that does.
-
-To understand more the methods and madness, the [Note-Taking
-Workflow][appendix:ntw] page contains a page of useful references.
-I've also written [a post][jethro-blog-post] about how I use Org-roam.
-
-Without further ado, let's begin!
-
-## Building the Cache
-
-Assuming you've set `org-roam-directory` appropriately, running `M-x
-org-roam--build-cache-async` should build up the caches that will
-allow you to begin using Org-roam. I do this on startup:
-
-```emacs-lisp
-(add-hook 'after-init-hook 'org-roam--build-cache-async)
-```
-
-## Finding a Note
-
-`org-roam-find-file` shows you the list of notes you currently have in
-Org-roam. Selecting the title will bring you to the corresponding
-note. Entering a title of a note that does not yet exist will create a
-new note with that title.
-
-![org-roam-find-file](images/org-roam-find-file.gif)
-
-## Inserting Links
-
-Within your Org-roam notes, you are encouraged to liberally insert
-links to existing (or new) Org-roam notes with `org-roam-insert`.
-Entering a non-existent title will also create a new note with that
-title.
-
-![org-roam-insert](images/org-roam-insert-filetag.gif)
-
-It is crucial for good usage of Org-roam to insert links liberally,
-where you want them the notes to resurface!
-
-## The Org-roam Buffer
-
-All of Org-roam's operations are designed such that the built cache is
-a consistent view of the inter-connectivity between your notes. The
-Org-roam buffer shows backlinks: i.e. the files that link to the
-currently viewed file, along with some surrounding context. The
-Org-roam buffer will always show the backlinks for the current
-Org-roam file in view.
-
-![org-roam-buffer](images/org-roam-buffer.gif)
-
-## Exporting the Graph
-
-It's also possible to export the links as a graph, using graphviz. The
-generated graph is navigable in Emacs, but requires some additional
-setup, which I describe in the [Graph Appendix][appendix:graph-setup]
-page.
-
-![org-roam-graph](images/org-roam-graph.gif)
-
-[zettelkasten]: https://zettelkasten.de/
-[appendix:ntw]: notetaking_workflow.md
-[appendix:graph-setup]: graph_setup.md
-[roam]: https://www.roamresearch.com/
-[jethro-blog-post]: https://blog.jethro.dev/posts/how_to_take_smart_notes_org/

makem.sh

@@ -155,7 +155,8 @@ function elisp-checkdoc-file {
     (when makem-checkdoc-errors-p
       (kill-emacs 1))))
 
-(setq checkdoc-spellcheck-documentation-flag t)
+(setq sentence-end-double-space nil)
+(setq checkdoc-spellcheck-documentation-flag nil)
 (makem-checkdoc-files-and-exit)
 EOF
     echo $file
@@ -325,7 +326,7 @@ function dirnames {
 
 function filter-files-exclude-default {
     # Filter out paths (STDIN) which should be excluded by default.
-    egrep -v "(/\.cask/|-autoloads.el|.dir-locals)"
+    egrep -v "(/\.cask/|-autoloads.el|-macs.el|.dir-locals)"
 }
 
 function filter-files-exclude-args {
@@ -590,6 +591,12 @@ function debug {
         }
     fi
 }
+
+function error_nonblocking {
+    echo_color red "ERROR ($(ts)): $@" >&2
+    ((errors_nonblocking++))
+}
+
 function error {
     echo_color red "ERROR ($(ts)): $@" >&2
     ((errors++))
@@ -694,7 +701,7 @@ function lint {
     lint-checkdoc
     lint-compile
     lint-declare
-    lint-indent
+    # lint-indent
     lint-package
     lint-regexps
 }
@@ -762,7 +769,7 @@ function lint-package {
         --funcall package-lint-batch-and-exit \
         "${files_project_feature[@]}" \
         && success "Linting package finished without errors." \
-            || error "Linting package failed."
+            || error_nonblocking "Linting package failed."
 }
 
 function lint-regexps {
@@ -831,6 +838,7 @@ test_files_regexp='^((tests?|t)/)|-test.el$|^test-'
 
 emacs_command=("emacs")
 errors=0
+errors_nonblocking=0
 verbose=0
 compile=true
 arg_batch="--batch"
@@ -1071,9 +1079,9 @@ done
 
 if [[ $errors -gt 0 ]]
 then
-    log_color red "Finished with $errors errors."
+    log_color red "Finished with $errors errors and $errors_nonblocking non-blocking errors."
 else
-    success "Finished without errors."
+    success "Finished with $errors errors and $errors_nonblocking non-blocking errors."
 fi
 
 exit $errors

mkdocs.yml

@@ -1,33 +0,0 @@
-site_name: "Org-Roam: Roam + Org-Mode = ♥"
-repo_url: https://github.com/jethrokuan/org-roam/
-edit_uri: edit/master/doc/
-copyright: "Copyright (C) 2020 Jethro Kuan and contributors"
-docs_dir: doc
-nav:
-- Home: index.md
-- A Tour of Org-Roam: tour.md
-- Installation: installation.md
-- Configuration: configuration.md
-- Ecosystem: ecosystem.md
-- Similar Packages: comparison.md
-- "Appendix: Note-taking Workflow": notetaking_workflow.md
-- "Appendix: Graph Setup": graph_setup.md
-markdown_extensions:
-  - admonition
-  - pymdownx.betterem:
-      smart_enable: all
-  - pymdownx.caret
-  - pymdownx.critic
-  - pymdownx.details
-  - pymdownx.mark
-  - pymdownx.smartsymbols
-  - pymdownx.superfences
-  - pymdownx.tasklist:
-      custom_checkbox: true
-  - pymdownx.tilde
-
-theme:
-  name: 'material'
-  palette:
-    primary: 'deep purple'
-    accent: 'deep purple'

org-roam-buffer.el

@@ -0,0 +1,357 @@
+;;; org-roam-buffer.el --- Metadata buffer -*- coding: utf-8; lexical-binding: t; -*-
+
+;; Copyright © 2020 Jethro Kuan <jethrokuan95@gmail.com>
+
+;; Author: Jethro Kuan <jethrokuan95@gmail.com>
+;; URL: https://github.com/org-roam/org-roam
+;; Keywords: org-mode, roam, convenience
+;; Version: 1.2.3
+;; Package-Requires: ((emacs "26.1") (dash "2.13") (f "0.17.2") (s "1.12.0") (org "9.3") (emacsql "3.0.0") (emacsql-sqlite3 "1.0.2"))
+
+;; This file is NOT part of GNU Emacs.
+
+;; This program is free software; you can redistribute it and/or modify
+;; it under the terms of the GNU General Public License as published by
+;; the Free Software Foundation; either version 3, or (at your option)
+;; any later version.
+;;
+;; This program is distributed in the hope that it will be useful,
+;; but WITHOUT ANY WARRANTY; without even the implied warranty of
+;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+;; GNU General Public License for more details.
+;;
+;; You should have received a copy of the GNU General Public License
+;; along with GNU Emacs; see the file COPYING.  If not, write to the
+;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
+;; Boston, MA 02110-1301, USA.
+
+;;; Commentary:
+;;
+;; This library provides the org-roam-buffer functionality for org-roam
+;;; Code:
+;;;; Library Requires
+(eval-when-compile (require 'subr-x))
+(require 'cl-lib)
+(require 'dash)
+(require 's)
+(require 'f)
+(require 'ol)
+(require 'org-element)
+(require 'org-roam-macs)
+
+(defvar org-roam-directory)
+(defvar org-link-frame-setup)
+(defvar org-return-follows-link)
+(defvar org-roam-backlinks-mode)
+(defvar org-roam-last-window)
+(defvar org-ref-cite-types) ;; in org-ref-core.el
+(defvar org-roam-mode)
+(defvar org-roam--org-link-bracket-typed-re)
+
+(declare-function org-roam-db--ensure-built   "org-roam-db")
+(declare-function org-roam-db--get-title      "org-roam-db")
+(declare-function org-roam-db-has-file-p      "org-roam-db")
+(declare-function org-roam--extract-refs      "org-roam")
+(declare-function org-roam--extract-titles    "org-roam")
+(declare-function org-roam--get-backlinks     "org-roam")
+(declare-function org-roam-backlinks-mode     "org-roam")
+(declare-function org-roam-mode               "org-roam")
+(declare-function org-roam--find-file         "org-roam")
+(declare-function org-roam-format-link        "org-roam")
+(declare-function org-roam-link-get-path      "org-roam-link")
+
+(defcustom org-roam-buffer-position 'right
+  "Position of `org-roam' buffer.
+Valid values are
+ * left,
+ * right,
+ * top,
+ * bottom,
+ * a function returning one of the above."
+  :type '(choice (const left)
+                 (const right)
+                 (const top)
+                 (const bottom)
+                 function)
+  :group 'org-roam)
+
+(defcustom org-roam-buffer-width 0.33
+  "Width of `org-roam' buffer.
+Has an effect if and only if `org-roam-buffer-position' is `left' or `right'."
+  :type 'number
+  :group 'org-roam)
+
+(defcustom org-roam-buffer-height 0.27
+  "Height of `org-roam' buffer.
+Has an effect if and only if `org-roam-buffer-position' is `top' or `bottom'."
+  :type 'number
+  :group 'org-roam)
+
+
+(defcustom org-roam-buffer "*org-roam*"
+  "Org-roam buffer name."
+  :type 'string
+  :group 'org-roam)
+
+(defcustom org-roam-buffer-prepare-hook '(org-roam-buffer--insert-title
+                                          org-roam-buffer--insert-backlinks
+                                          org-roam-buffer--insert-ref-links)
+  "Hook run in the `org-roam-buffer' before it is displayed."
+  :type 'hook
+  :group 'org-roam)
+
+(defcustom org-roam-buffer-preview-function #'org-roam-buffer--preview
+  "Function to obtain preview contents for a given link.
+The function takes in two arguments, the FILE containing the
+link, and the POINT of the link."
+  :type 'function
+  :group 'org-roam)
+
+(defcustom org-roam-buffer-window-parameters nil
+  "Additional window parameters for the `org-roam-buffer' side window.
+For example: (setq org-roam-buffer-window-parameters '((no-other-window . t)))"
+  :type '(alist)
+  :group 'org-roam)
+
+(defvar org-roam-buffer--current nil
+  "Currently displayed file in `org-roam' buffer.")
+
+(defun org-roam-buffer--find-file (file)
+  "Open FILE in the window `org-roam' was called from."
+  (setq file (expand-file-name file))
+  (let ((last-window org-roam-last-window))
+    (if (window-valid-p last-window)
+        (progn (with-selected-window last-window
+                 (org-roam--find-file file))
+               (select-window last-window))
+      (org-roam--find-file file))))
+
+(defun org-roam-buffer--insert-title ()
+  "Insert the org-roam-buffer title."
+  (insert (propertize (org-roam-db--get-title
+                       (buffer-file-name org-roam-buffer--current))
+                      'font-lock-face
+                      'org-document-title)))
+
+(defun org-roam-buffer--preview (file point)
+  "Get preview content for FILE at POINT."
+  (save-excursion
+    (org-roam--with-temp-buffer file
+      (goto-char point)
+      (let ((elem (org-element-at-point)))
+        (or (org-element-property :raw-value elem)
+            (when-let ((begin (org-element-property :begin elem))
+                       (end (org-element-property :end elem)))
+              (string-trim (buffer-substring-no-properties begin end))))))))
+
+(defun org-roam-buffer--pluralize (string number)
+  "Conditionally pluralize STRING if NUMBER is above 1."
+  (let ((l (pcase number
+             ((pred (listp)) (length number))
+             ((pred (integerp)) number)
+             (wrong-type (signal 'wrong-type-argument
+                                 `((listp integerp)
+                                   ,wrong-type))))))
+    (concat string (when (> l 1) "s"))))
+
+(defun org-roam-buffer-expand-links (content orig-path)
+  "Crawl CONTENT for relative links and corrects them to be correctly displayed.
+ORIG-PATH is the path where the CONTENT originated."
+  (with-temp-buffer
+    (insert content)
+    (goto-char (point-min))
+    (let (link link-type)
+      (while (re-search-forward org-roam--org-link-bracket-typed-re (point-max) t)
+        (setq link-type (match-string 1)
+              link (match-string 2))
+        (when (and (string-equal link-type "file")
+                   (f-relative-p link))
+          (replace-match (org-roam-link-get-path (expand-file-name link (file-name-directory orig-path)))
+                         nil t nil 2))))
+    (buffer-string)))
+
+(defun org-roam-buffer--insert-ref-links ()
+  "Insert ref backlinks for the current buffer."
+  (when-let* ((refs (with-temp-buffer
+                      (insert-buffer-substring org-roam-buffer--current)
+                      (org-roam--extract-refs)))
+              (paths (mapcar #'cdr refs)))
+    (if-let* ((key-backlinks (mapcan #'org-roam--get-backlinks paths))
+              (grouped-backlinks (--group-by (nth 0 it) key-backlinks)))
+        (progn
+          (insert (let ((l (length key-backlinks)))
+                    (format "\n\n* %d %s\n"
+                            l (org-roam-buffer--pluralize "Ref Backlink" l))))
+          (dolist (group grouped-backlinks)
+            (let ((file-from (car group))
+                  (bls (cdr group)))
+              (insert (format "** %s\n"
+                              (org-roam-format-link file-from
+                                                    (org-roam-db--get-title file-from)
+                                                    "file")))
+              (dolist (backlink bls)
+                (pcase-let ((`(,file-from _ ,props) backlink))
+                  (insert (if-let ((content (funcall org-roam-buffer-preview-function file-from (plist-get props :point))))
+                              (propertize (org-roam-buffer-expand-links content file-from)
+                                          'help-echo "mouse-1: visit backlinked note"
+                                          'file-from file-from
+                                          'file-from-point (plist-get props :point))
+                            "")
+                          "\n\n"))))))
+      (insert "\n\n* No ref backlinks!"))))
+
+(defun org-roam-buffer--insert-backlinks ()
+  "Insert the org-roam-buffer backlinks string for the current buffer."
+  (let (props file-from)
+    (if-let* ((file-path (buffer-file-name org-roam-buffer--current))
+              (titles (with-current-buffer org-roam-buffer--current
+                        (org-roam--extract-titles)))
+              (backlinks (org-roam--get-backlinks (push file-path titles)))
+              (grouped-backlinks (--group-by (nth 0 it) backlinks)))
+        (progn
+          (insert (let ((l (length backlinks)))
+                    (format "\n\n* %d %s\n"
+                            l (org-roam-buffer--pluralize "Backlink" l))))
+          (dolist (group grouped-backlinks)
+            (setq file-from (car group))
+            (setq props (mapcar (lambda (row) (nth 2 row)) (cdr group)))
+            (setq props (seq-sort-by (lambda (p) (plist-get p :point)) #'< props))
+            (insert (format "** %s\n"
+                            (org-roam-format-link file-from
+                                                  (org-roam-db--get-title file-from)
+                                                  "file")))
+            (dolist (prop props)
+              (insert "*** "
+                      (if-let ((outline (plist-get prop :outline)))
+                          (-> outline
+                              (string-join " > ")
+                              (org-roam-buffer-expand-links file-from))
+                        "Top")
+                      "\n"
+                      (if-let ((content (funcall org-roam-buffer-preview-function file-from (plist-get prop :point))))
+                          (propertize
+                           (s-trim (s-replace "\n" " " (org-roam-buffer-expand-links content file-from)))
+                           'help-echo "mouse-1: visit backlinked note"
+                           'file-from file-from
+                           'file-from-point (plist-get prop :point))
+                        "")
+                      "\n\n"))))
+      (insert "\n\n* No backlinks!"))))
+
+(defun org-roam-buffer-update ()
+  "Update the `org-roam-buffer'."
+  (interactive)
+  (org-roam-db--ensure-built)
+  (let* ((source-org-roam-directory org-roam-directory))
+    (with-current-buffer org-roam-buffer
+      ;; When dir-locals.el is used to override org-roam-directory,
+      ;; org-roam-buffer should have a different local org-roam-directory and
+      ;; default-directory, as relative links are relative from the overridden
+      ;; org-roam-directory.
+      (setq-local org-roam-directory source-org-roam-directory)
+      (setq-local default-directory source-org-roam-directory)
+      ;; Locally overwrite the file opening function to re-use the
+      ;; last window org-roam was called from
+      (setq-local org-link-frame-setup
+                  (cons '(file . org-roam--find-file) org-link-frame-setup))
+      (let ((inhibit-read-only t))
+        (erase-buffer)
+        (unless (eq major-mode 'org-mode)
+          (org-mode))
+        (unless org-roam-backlinks-mode
+          (org-roam-backlinks-mode))
+        (make-local-variable 'org-return-follows-link)
+        (setq org-return-follows-link t)
+        (run-hooks 'org-roam-buffer-prepare-hook)
+        (read-only-mode 1)))))
+
+
+(cl-defun org-roam-buffer--update-maybe (&key redisplay)
+  "Reconstructs `org-roam-buffer'.
+This needs to be quick or infrequent, because this is run at
+`post-command-hook'.  If REDISPLAY, force an update of
+`org-roam-buffer'."
+  (let ((buffer (window-buffer)))
+    (when (and (or redisplay
+                   (not (eq org-roam-buffer--current buffer)))
+               (eq 'visible (org-roam-buffer--visibility))
+               (buffer-file-name buffer)
+               (org-roam-db-has-file-p (buffer-file-name buffer)))
+      (setq org-roam-buffer--current buffer)
+      (org-roam-buffer-update))))
+
+;;;; Toggling the org-roam buffer
+(define-inline org-roam-buffer--visibility ()
+  "Return whether the current visibility state of the org-roam buffer.
+Valid states are 'visible, 'exists and 'none."
+  (declare (side-effect-free t))
+  (inline-quote
+   (cond
+    ((get-buffer-window org-roam-buffer) 'visible)
+    ((get-buffer org-roam-buffer) 'exists)
+    (t 'none))))
+
+(defun org-roam-buffer--set-width (width)
+  "Set the width of `org-roam-buffer' to `WIDTH'."
+  (unless (one-window-p)
+    (let ((window-size-fixed)
+          (w (max width window-min-width)))
+      (cond
+       ((> (window-width) w)
+        (shrink-window-horizontally  (- (window-width) w)))
+       ((< (window-width) w)
+        (enlarge-window-horizontally (- w (window-width))))))))
+
+(defun org-roam-buffer--set-height (height)
+  "Set the height of `org-roam-buffer' to `HEIGHT'."
+  (unless (one-window-p)
+    (let ((window-size-fixed)
+          (h (max height window-min-height)))
+      (cond
+       ((> (window-height) h)
+        (shrink-window  (- (window-height) h)))
+       ((< (window-height) h)
+        (enlarge-window (- h (window-height))))))))
+
+(defun org-roam-buffer--get-create ()
+  "Set up the `org-roam' buffer at `org-roam-buffer-position'."
+  (let ((position (if (functionp org-roam-buffer-position)
+                      (funcall org-roam-buffer-position)
+                    org-roam-buffer-position)))
+    (save-selected-window
+      (-> (get-buffer-create org-roam-buffer)
+          (display-buffer-in-side-window
+           `((side . ,position)
+             (window-parameters . ,org-roam-buffer-window-parameters)))
+          (select-window))
+      (pcase position
+        ((or 'right 'left)
+         (org-roam-buffer--set-width
+          (round (* (frame-width)  org-roam-buffer-width))))
+        ((or 'top  'bottom)
+         (org-roam-buffer--set-height
+          (round (* (frame-height) org-roam-buffer-height))))))))
+
+(defun org-roam-buffer-activate ()
+  "Activate display of the `org-roam-buffer'."
+  (interactive)
+  (unless org-roam-mode (org-roam-mode))
+  (setq org-roam-last-window (get-buffer-window))
+  (org-roam-buffer--get-create))
+
+(defun org-roam-buffer-deactivate ()
+  "Deactivate display of the `org-roam-buffer'."
+  (interactive)
+  (setq org-roam-last-window (get-buffer-window))
+  (delete-window (get-buffer-window org-roam-buffer)))
+
+(defun org-roam-buffer-toggle-display ()
+  "Toggle display of the `org-roam-buffer'."
+  (interactive)
+  (pcase (org-roam-buffer--visibility)
+    ('visible (org-roam-buffer-deactivate))
+    ((or 'exists 'none) (org-roam-buffer-activate))))
+
+(provide 'org-roam-buffer)
+
+;;; org-roam-buffer.el ends here

org-roam-capture.el

@@ -0,0 +1,640 @@
+;;; org-roam-capture.el --- Capture functionality -*- coding: utf-8; lexical-binding: t; -*-
+
+;; Copyright © 2020 Jethro Kuan <jethrokuan95@gmail.com>
+
+;; Author: Jethro Kuan <jethrokuan95@gmail.com>
+;; URL: https://github.com/org-roam/org-roam
+;; Keywords: org-mode, roam, convenience
+;; Version: 1.2.3
+;; Package-Requires: ((emacs "26.1") (dash "2.13") (f "0.17.2") (s "1.12.0") (org "9.3") (emacsql "3.0.0") (emacsql-sqlite3 "1.0.2"))
+
+;; This file is NOT part of GNU Emacs.
+
+;; This program is free software; you can redistribute it and/or modify
+;; it under the terms of the GNU General Public License as published by
+;; the Free Software Foundation; either version 3, or (at your option)
+;; any later version.
+;;
+;; This program is distributed in the hope that it will be useful,
+;; but WITHOUT ANY WARRANTY; without even the implied warranty of
+;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+;; GNU General Public License for more details.
+;;
+;; You should have received a copy of the GNU General Public License
+;; along with GNU Emacs; see the file COPYING.  If not, write to the
+;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
+;; Boston, MA 02110-1301, USA.
+
+;;; Commentary:
+;;
+;; This library provides capture functionality for org-roam
+;;; Code:
+;;;; Library Requires
+(require 'org-capture)
+(require 'org-roam-macs)
+(require 'org-roam-db)
+(require 'dash)
+(require 's)
+(require 'cl-lib)
+
+;; Declarations
+(defvar org-roam-encrypt-files)
+(defvar org-roam-directory)
+(defvar org-roam-mode)
+(defvar org-roam-title-to-slug-function)
+(defvar org-roam-file-extensions)
+
+(declare-function  org-roam--get-title-path-completions "org-roam")
+(declare-function  org-roam--get-ref-path-completions   "org-roam")
+(declare-function  org-roam--find-file                  "org-roam")
+(declare-function  org-roam-format-link                "org-roam")
+(declare-function  org-roam--split-ref                 "org-roam")
+(declare-function  org-roam-mode                        "org-roam")
+(declare-function  org-roam-completion--completing-read "org-roam-completion")
+
+(defvar org-roam-capture--file-path nil
+  "The file path for the Org-roam capture.
+This variable is set during the Org-roam capture process.")
+
+(defvar org-roam-capture--info nil
+  "An alist of additional information passed to the Org-roam template.
+This variable is populated dynamically, and is only non-nil
+during the Org-roam capture process.")
+
+(defvar org-roam-capture--context nil
+  "A symbol, that reflects the context for obtaining the exact point in a file.
+This variable is populated dynamically, and is only active during
+an Org-roam capture process.
+
+The `title' context is used in `org-roam-insert' and
+`org-roam-find-file', where the capture process is triggered upon
+trying to create a new file without that `title'.
+
+The `ref' context is used by `org-roam-protocol', where the
+capture process is triggered upon trying to find or create a new
+note with the given `ref'.")
+
+(defvar org-roam-capture-additional-template-props nil
+  "Additional props to be added to the Org-roam template.")
+
+(defconst org-roam-capture--template-keywords '(:file-name :head :olp)
+  "Keywords used in `org-roam-capture-templates' specific to Org-roam.")
+
+(defcustom org-roam-capture-templates
+  `(("d" "default" plain (function org-roam-capture--get-point)
+     "%?"
+     :file-name "%<%Y%m%d%H%M%S>-${slug}"
+     :head "#+title: ${title}\n"
+     :unnarrowed t))
+  "Capture templates for Org-roam.
+The Org-roam capture-templates  builds on the default behaviours of
+`org-capture-templates' by expanding them in 3 areas:
+
+1. Template-expansion capabilities are extended with additional
+   custom syntax. See `org-roam-capture--fill-template' for more
+   details.
+
+2. The `:file-name' key is added, which defines the naming format
+   to use when creating new notes. This file-name is relative to
+   `org-roam-directory', and is without the file-extension.
+
+3. The `:head' key is added, which contains the template that is
+   inserted upon the creation of a new file. This is where you
+   your note metadata should go.
+
+Each template should have the following structure:
+
+\(KEY DESCRIPTION `plain' `(function org-roam-capture--get-point)'
+  TEMPLATE
+  `:file-name' FILENAME-FORMAT
+  `:head' HEADER-FORMAT
+  `:unnarrowed t'
+  OPTIONS-PLIST)
+
+The elements of a template-entry and their placement are the same
+as in `org-capture-templates', except that the entry type must
+always be the symbol `plain', and that the target must always be
+the list `(function org-roam-capture--get-point)'.
+
+Org-roam requires the plist elements `:file-name' and `:head' to
+be present, and it’s recommended that `:unnarrowed' be set to t."
+  :group 'org-roam
+  ;; Adapted from `org-capture-templates'
+  :type
+  '(repeat
+    (choice :value ("d" "default" plain (function org-roam-capture--get-point)
+                    "%?"
+                    :file-name "%<%Y%m%d%H%M%S>-${slug}"
+                    :head "#+title: ${title}\n"
+                    :unnarrowed t)
+            (list :tag "Multikey description"
+                  (string :tag "Keys       ")
+                  (string :tag "Description"))
+            (list :tag "Template entry"
+                  (string :tag "Keys              ")
+                  (string :tag "Description       ")
+                  (const :format "" plain)
+                  (const :format "" (function org-roam-capture--get-point))
+                  (choice :tag "Template          "
+                          (string :tag "String"
+                                  :format "String:\n            \
+Template string   :\n%v")
+                          (list :tag "File"
+                                (const :format "" file)
+                                (file :tag "Template file     "))
+                          (list :tag "Function"
+                                (const :format "" function)
+                                (function :tag "Template function ")))
+                  (const :format "File name format  :" :file-name)
+                  (string :format " %v" :value "#+title: ${title}\n")
+                  (const :format "Header format     :" :head)
+                  (string :format "\n%v" :value "%<%Y%m%d%H%M%S>-${slug}")
+                  (const :format "" :unnarrowed) (const :format "" t)
+                  (plist :inline t
+                         :tag "Options"
+                         ;; Give the most common options as checkboxes
+                         :options
+                         (((const :format "%v " :prepend) (const t))
+                          ((const :format "%v " :immediate-finish) (const t))
+                          ((const :format "%v " :jump-to-captured) (const t))
+                          ((const :format "%v " :empty-lines) (const 1))
+                          ((const :format "%v " :empty-lines-before) (const 1))
+                          ((const :format "%v " :empty-lines-after) (const 1))
+                          ((const :format "%v " :clock-in) (const t))
+                          ((const :format "%v " :clock-keep) (const t))
+                          ((const :format "%v " :clock-resume) (const t))
+                          ((const :format "%v " :time-prompt) (const t))
+                          ((const :format "%v " :tree-type) (const week))
+                          ((const :format "%v " :table-line-pos) (string))
+                          ((const :format "%v " :kill-buffer) (const t))))))))
+
+(defcustom org-roam-capture-immediate-template
+  (append (car org-roam-capture-templates) '(:immediate-finish t))
+  "Capture template to use for immediate captures in Org-roam.
+This is a single template, so do not enclose it into a list.
+See `org-roam-capture-templates' for details on templates."
+  :group 'org-roam
+  ;; Adapted from `org-capture-templates'
+  :type
+  '(list :tag "Template entry"
+         :value ("d" "default" plain (function org-roam-capture--get-point)
+                 "%?"
+                 :file-name "%<%Y%m%d%H%M%S>-${slug}"
+                 :head "#+title: ${title}\n"
+                 :unnarrowed t
+                 :immediate-finish t)
+         (string :tag "Keys              ")
+         (string :tag "Description       ")
+         (const :format "" plain)
+         (const :format "" (function org-roam-capture--get-point))
+         (choice :tag "Template          "
+                 (string :tag "String"
+                         :format "String:\n            \
+Template string   :\n%v")
+                 (list :tag "File"
+                       (const :format "" file)
+                       (file :tag "Template file     "))
+                 (list :tag "Function"
+                       (const :format "" function)
+                       (function :tag "Template function ")))
+         (const :format "File name format  :" :file-name)
+         (string :format " %v" :value "#+title: ${title}\n")
+         (const :format "Header format     :" :head)
+         (string :format "\n%v" :value "%<%Y%m%d%H%M%S>-${slug}")
+         (const :format "" :unnarrowed) (const :format "" t)
+         (const :format "" :immediate-finish) (const :format "" t)
+         (plist :inline t
+                :tag "Options"
+                ;; Give the most common options as checkboxes
+                :options
+                (((const :format "%v " :prepend) (const t))
+                 ((const :format "%v " :jump-to-captured) (const t))
+                 ((const :format "%v " :empty-lines) (const 1))
+                 ((const :format "%v " :empty-lines-before) (const 1))
+                 ((const :format "%v " :empty-lines-after) (const 1))
+                 ((const :format "%v " :clock-in) (const t))
+                 ((const :format "%v " :clock-keep) (const t))
+                 ((const :format "%v " :clock-resume) (const t))
+                 ((const :format "%v " :time-prompt) (const t))
+                 ((const :format "%v " :tree-type) (const week))
+                 ((const :format "%v " :table-line-pos) (string))
+                 ((const :format "%v " :kill-buffer) (const t))))))
+
+(defcustom org-roam-capture-ref-templates
+  '(("r" "ref" plain #'org-roam-capture--get-point
+     "%?"
+     :file-name "${slug}"
+     :head "#+title: ${title}\n#+roam_key: ${ref}"
+     :unnarrowed t))
+  "The Org-roam templates used during a capture from the roam-ref protocol.
+Details on how to specify for the template is given in `org-roam-capture-templates'."
+  :group 'org-roam
+  ;; Adapted from `org-capture-templates'
+  :type
+  '(repeat
+    (choice :value ("d" "default" plain (function org-roam-capture--get-point)
+                    "%?"
+                    :file-name "${slug}"
+                    :head "#+title: ${title}\n#+roam_key: ${ref}\n"
+                    :unnarrowed t)
+            (list :tag "Multikey description"
+                  (string :tag "Keys       ")
+                  (string :tag "Description"))
+            (list :tag "Template entry"
+                  (string :tag "Keys              ")
+                  (string :tag "Description       ")
+                  (const :format "" plain)
+                  (const :format "" (function org-roam-capture--get-point))
+                  (choice :tag "Template          "
+                          (string :tag "String"
+                                  :format "String:\n            \
+Template string   :\n%v")
+                          (list :tag "File"
+                                (const :format "" file)
+                                (file :tag "Template file     "))
+                          (list :tag "Function"
+                                (const :format "" function)
+                                (function :tag "Template function ")))
+                  (const :format "File name format  :" :file-name)
+                  (string :format " %v" :value "#+title: ${title}\n")
+                  (const :format "Header format     :" :head)
+                  (string :format "\n%v" :value "%<%Y%m%d%H%M%S>-${slug}")
+                  (const :format "" :unnarrowed) (const :format "" t)
+                  (plist :inline t
+                         :tag "Options"
+                         ;; Give the most common options as checkboxes
+                         :options
+                         (((const :format "%v " :prepend) (const t))
+                          ((const :format "%v " :immediate-finish) (const t))
+                          ((const :format "%v " :jump-to-captured) (const t))
+                          ((const :format "%v " :empty-lines) (const 1))
+                          ((const :format "%v " :empty-lines-before) (const 1))
+                          ((const :format "%v " :empty-lines-after) (const 1))
+                          ((const :format "%v " :clock-in) (const t))
+                          ((const :format "%v " :clock-keep) (const t))
+                          ((const :format "%v " :clock-resume) (const t))
+                          ((const :format "%v " :time-prompt) (const t))
+                          ((const :format "%v " :tree-type) (const week))
+                          ((const :format "%v " :table-line-pos) (string))
+                          ((const :format "%v " :kill-buffer) (const t))))))))
+
+(defun org-roam-capture-p ()
+  "Return t if the current capture process is an Org-roam capture.
+This function is to only be called when org-capture-plist is
+valid for the capture (i.e. initialization, and finalization of
+the capture)."
+  (plist-get org-capture-plist :org-roam))
+
+(defun org-roam-capture--get (keyword)
+  "Get the value for KEYWORD from the `org-roam-capture-template'."
+  (plist-get (plist-get org-capture-plist :org-roam) keyword))
+
+(defun org-roam-capture--put (&rest stuff)
+  "Put properties from STUFF into the `org-roam-capture-template'."
+  (let ((p (plist-get org-capture-plist :org-roam)))
+    (while stuff
+      (setq p (plist-put p (pop stuff) (pop stuff))))
+    (setq org-capture-plist
+          (plist-put org-capture-plist :org-roam p))))
+
+;; FIXME: Pending upstream patch
+;; https://orgmode.org/list/87h7tv9pkm.fsf@hidden/T/#u
+;;
+;; Org-capture's behaviour right now is that `org-capture-plist' is valid only
+;; during the initialization of the Org-capture buffer. The value of
+;; `org-capture-plist' is saved into buffer-local `org-capture-current-plist'.
+;; However, the value for that particular capture is no longer accessible for
+;; hooks in `org-capture-after-finalize-hook', since the capture buffer has been
+;; cleaned up.
+;;
+;; This advice restores the global `org-capture-plist' during finalization, so
+;; the plist is valid during both initialization and finalization of the
+;; capture.
+(defun org-roam-capture--update-plist (&optional _)
+  "Update global plist from local var."
+  (setq org-capture-plist org-capture-current-plist))
+
+(advice-add 'org-capture-finalize :before #'org-roam-capture--update-plist)
+
+(defun org-roam-capture--finalize ()
+  "Finalize the `org-roam-capture' process."
+  (let* ((finalize (org-roam-capture--get :finalize))
+         ;; In case any regions were shielded before, unshield them
+         (region (when-let ((region (org-roam-capture--get :region)))
+                   (org-roam-unshield-region (car region) (cdr region))))
+         (beg (car region))
+         (end (cdr region)))
+    (unless org-note-abort
+      (pcase finalize
+        ('find-file
+         (when-let ((file-path (org-roam-capture--get :file-path)))
+           (org-roam--find-file file-path)
+           (run-hooks 'org-roam-capture-after-find-file-hook)))
+        ('insert-link
+         (when-let* ((mkr (org-roam-capture--get :insert-at))
+                     (buf (marker-buffer mkr)))
+           (with-current-buffer buf
+             (when region
+               (delete-region (car region) (cdr region)))
+             (let ((path (org-roam-capture--get :file-path))
+                   (type (org-roam-capture--get :link-type))
+                   (desc (org-roam-capture--get :link-description)))
+               (if (eq (point) (marker-position mkr))
+                   (insert (org-roam-format-link path desc type))
+                 (org-with-point-at mkr
+                   (insert (org-roam-format-link path desc type))))))))))
+    (when region
+      (set-marker beg nil)
+      (set-marker end nil))
+    (org-roam-capture--save-file-maybe)
+    (remove-hook 'org-capture-after-finalize-hook #'org-roam-capture--finalize)))
+
+(defun org-roam-capture--install-finalize ()
+  "Install `org-roam-capture--finalize' if the capture is an Org-roam capture."
+  (when (org-roam-capture-p)
+    (add-hook 'org-capture-after-finalize-hook #'org-roam-capture--finalize)))
+
+(add-hook 'org-capture-prepare-finalize-hook #'org-roam-capture--install-finalize)
+
+(defun org-roam-capture--fill-template (str)
+  "Expand the template STR, returning the string.
+This is an extension of org-capture's template expansion.
+
+First, it expands ${var} occurrences in STR, using `org-roam-capture--info'.
+If there is a ${var} with no matching var in the alist, the value
+of var is prompted for via `completing-read'.
+
+Next, it expands the remaining template string using
+`org-capture-fill-template'."
+  (-> str
+      (s-format (lambda (key)
+                  (or (s--aget org-roam-capture--info key)
+                      (when-let ((val (completing-read (format "%s: " key) nil)))
+                        (push (cons key val) org-roam-capture--info)
+                        val))) nil)
+      (org-capture-fill-template)))
+
+(defun org-roam-capture--save-file-maybe ()
+  "Save the file conditionally.
+The file is saved if the original value of :no-save is not t and
+`org-note-abort' is not t. It is added to
+`org-capture-after-finalize-hook'."
+  (cond
+   ((and (org-roam-capture--get :new-file)
+         org-note-abort)
+    (with-current-buffer (org-capture-get :buffer)
+      (set-buffer-modified-p nil)
+      (kill-buffer)))
+   ((and (not (org-roam-capture--get :orig-no-save))
+         (not org-note-abort))
+    (with-current-buffer (org-capture-get :buffer)
+      (save-buffer)))))
+
+(defun org-roam-capture--get-file-path (basename)
+  "Return path for Org-roam file with BASENAME."
+  (let* ((ext (or (car org-roam-file-extensions)
+                  "org"))
+         (file (concat basename "." ext)))
+    (expand-file-name
+     (if org-roam-encrypt-files
+         (concat file ".gpg")
+       file)
+     org-roam-directory)))
+
+(defun org-roam-capture--new-file (&optional allow-existing-file-p)
+  "Return the path to file during an Org-roam capture.
+
+This function reads the file-name attribute of the currently
+active Org-roam template.
+
+If the file path already exists, and not ALLOW-EXISTING-FILE-P,
+raise a warning.
+
+Else, to insert the header content in the file, `org-capture'
+prepends the `:head' property of the Org-roam capture template.
+
+To prevent the creation of a new file if the capture process is
+aborted, we do the following:
+
+1. Save the original value of the capture template's :no-save.
+2. Set the capture template's :no-save to t.
+3. Add a function on `org-capture-before-finalize-hook' that saves
+the file if the original value of :no-save is not t and
+`org-note-abort' is not t."
+  (let* ((name-templ (or (org-roam-capture--get :file-name)
+                         (user-error "Template needs to specify `:file-name'")))
+         (new-id (s-trim (org-roam-capture--fill-template
+                          name-templ)))
+         (file-path (org-roam-capture--get-file-path new-id))
+         (roam-head (or (org-roam-capture--get :head)
+                        ""))
+         (org-template (org-capture-get :template))
+         (roam-template (concat roam-head org-template)))
+    (if (or (file-exists-p file-path)
+            (find-buffer-visiting file-path))
+        (unless allow-existing-file-p
+          (lwarn '(org-roam) :warning
+                 "Attempted to recreate existing file: %s.
+This can happen when your org-roam db is not in sync with your notes.
+Using existing file..." file-path))
+      (make-directory (file-name-directory file-path) t)
+      (org-roam-capture--put :orig-no-save (org-capture-get :no-save)
+                             :new-file t)
+      (pcase org-roam-capture--context
+        ('dailies
+         ;; Populate the header of the daily file before capture to prevent it
+         ;; from appearing in the buffer-restriction
+         (save-window-excursion
+           (find-file file-path)
+           (insert (substring (org-capture-fill-template (concat roam-head "*"))
+                              0 -2))
+           (set-buffer-modified-p nil))
+         (org-capture-put :template org-template))
+        (_
+         (org-capture-put :template roam-template
+                          :type 'plain)))
+      (org-capture-put :no-save t))
+    file-path))
+
+(defun org-roam-capture-find-or-create-olp (olp)
+  "Return a marker pointing to the entry at OLP in the current buffer.
+If OLP does not exist, create it. If anything goes wrong, throw
+an error, and if you need to do something based on this error,
+you can catch it with `condition-case'."
+  (let* ((level 1)
+         (lmin 1)
+         (lmax 1)
+         (start (point-min))
+         (end (point-max))
+         found flevel)
+    (unless (derived-mode-p 'org-mode)
+      (error "Buffer %s needs to be in Org mode" (current-buffer)))
+    (org-with-wide-buffer
+     (goto-char start)
+     (dolist (heading olp)
+       (let ((re (format org-complex-heading-regexp-format
+                         (regexp-quote heading)))
+             (cnt 0))
+         (while (re-search-forward re end t)
+           (setq level (- (match-end 1) (match-beginning 1)))
+           (when (and (>= level lmin) (<= level lmax))
+             (setq found (match-beginning 0) flevel level cnt (1+ cnt))))
+         (when (> cnt 1)
+           (error "Heading not unique on level %d: %s" lmax heading))
+         (when (= cnt 0)
+           ;; Create heading if it doesn't exist
+           (goto-char end)
+           (unless (bolp) (newline))
+           (org-insert-heading nil nil t)
+           (unless (= lmax 1) (org-do-demote))
+           (insert heading)
+           (setq end (point))
+           (goto-char start)
+           (while (re-search-forward re end t)
+             (setq level (- (match-end 1) (match-beginning 1)))
+             (when (and (>= level lmin) (<= level lmax))
+               (setq found (match-beginning 0) flevel level cnt (1+ cnt))))))
+       (goto-char found)
+       (setq lmin (1+ flevel) lmax (+ lmin (if org-odd-levels-only 1 0)))
+       (setq start found
+             end (save-excursion (org-end-of-subtree t t))))
+     (point-marker))))
+
+(defun org-roam-capture--get-ref-path (type path)
+  "Get the file path to the ref with TYPE and PATH."
+  (caar (org-roam-db-query
+         [:select [file]
+          :from refs
+          :where (= type $s1)
+          :and (= ref $s2)
+          :limit 1]
+         type path)))
+
+(defun org-roam-capture--get-point ()
+  "Return exact point to file for org-capture-template.
+The file to use is dependent on the context:
+
+If the search is via title, it is assumed that the file does not
+yet exist, and Org-roam will attempt to create new file.
+
+If the search is via daily notes, 'time will be passed via
+`org-roam-capture--info'. This is used to alter the default time
+in `org-capture-templates'.
+
+If the search is via ref, it is matched against the Org-roam database.
+If there is no file with that ref, a file with that ref is created.
+
+This function is used solely in Org-roam's capture templates: see
+`org-roam-capture-templates'."
+  (let* ((file-path (pcase org-roam-capture--context
+                      ('capture
+                       (or (cdr (assoc 'file org-roam-capture--info))
+                           (org-roam-capture--new-file)))
+                      ('title
+                       (org-roam-capture--new-file))
+                      ('dailies
+                       (org-capture-put :default-time (cdr (assoc 'time org-roam-capture--info)))
+                       (org-roam-capture--new-file 'allow-existing))
+                      ('ref
+                       (if-let ((ref (cdr (assoc 'ref org-roam-capture--info))))
+                           (pcase (org-roam--split-ref ref)
+                             (`(,type . ,path)
+                              (or (org-roam-capture--get-ref-path type path)
+                                  (org-roam-capture--new-file)))
+                             (_ (user-error "%s is not a valid ref" ref)))
+                         (error "Ref not found in `org-roam-capture--info'")))
+                      (_ (error "Invalid org-roam-capture-context")))))
+    (org-capture-put :template
+                     (org-roam-capture--fill-template (org-capture-get :template)))
+    (org-roam-capture--put :file-path file-path
+                           :finalize (or (org-capture-get :finalize)
+                                         (org-roam-capture--get :finalize)))
+    (while org-roam-capture-additional-template-props
+      (let ((prop (pop org-roam-capture-additional-template-props))
+            (val (pop org-roam-capture-additional-template-props)))
+        (org-roam-capture--put prop val)))
+    (set-buffer (org-capture-target-buffer file-path))
+    (widen)
+    (if-let* ((olp (org-roam-capture--get :olp)))
+        (condition-case err
+            (when-let ((marker (org-roam-capture-find-or-create-olp olp)))
+              (goto-char marker)
+              (set-marker marker nil))
+          (error
+           (when (org-roam-capture--get :new-file)
+             (kill-buffer))
+           (signal (car err) (cdr err))))
+      (goto-char (point-max)))))
+
+(defun org-roam-capture--convert-template (template)
+  "Convert TEMPLATE from Org-roam syntax to `org-capture-templates' syntax."
+  (pcase template
+    (`(,_key ,_description) template)
+    (`(,key ,description ,type ,target . ,rest)
+     (let ((converted `(,key ,description ,type ,target
+                             ,(unless (keywordp (car rest)) (pop rest))))
+           org-roam-plist
+           options)
+       (while rest
+         (let* ((key (pop rest))
+                (val (pop rest))
+                (custom (member key org-roam-capture--template-keywords)))
+           (when (and custom
+                      (not val))
+             (user-error "Invalid capture template format: %s\nkey %s cannot be nil" template key))
+           (push val (if custom org-roam-plist options))
+           (push key (if custom org-roam-plist options))))
+       (append converted options `(:org-roam ,org-roam-plist))))
+    (_ (user-error "Invalid capture template format: %s" template))))
+
+(defcustom org-roam-capture-after-find-file-hook nil
+  "Hook that is run right after an Org-roam capture process is finalized.
+Suitable for moving point."
+  :group 'org-roam
+  :type 'hook)
+
+(defcustom org-roam-capture-function #'org-capture
+  "Function that is invoked to start the `org-capture' process."
+  :group 'org-roam
+  :type 'function)
+
+(defun org-roam-capture--capture (&optional goto keys)
+  "Create a new file, and return the path to the edited file.
+The templates are defined at `org-roam-capture-templates'.  The
+GOTO and KEYS argument have the same functionality as
+`org-capture'."
+  (let* ((org-capture-templates (mapcar #'org-roam-capture--convert-template org-roam-capture-templates))
+         (one-template-p (= (length org-capture-templates) 1))
+         org-capture-templates-contexts)
+    (when one-template-p
+      (setq keys (caar org-capture-templates)))
+    (if (or one-template-p
+            (eq org-roam-capture-function 'org-capture))
+        (org-capture goto keys)
+      (funcall-interactively org-roam-capture-function))))
+
+;;;###autoload
+(defun org-roam-capture (&optional goto keys)
+  "Launches an `org-capture' process for a new or existing note.
+This uses the templates defined at `org-roam-capture-templates'.
+Arguments GOTO and KEYS see `org-capture'."
+  (interactive "P")
+  (unless org-roam-mode (org-roam-mode))
+  (let* ((completions (org-roam--get-title-path-completions))
+         (title-with-keys (org-roam-completion--completing-read "File: "
+                                                                completions))
+         (res (cdr (assoc title-with-keys completions)))
+         (title (or (plist-get res :title) title-with-keys))
+         (file-path (plist-get res :path)))
+    (let ((org-roam-capture--info (list (cons 'title title)
+                                        (cons 'slug (funcall org-roam-title-to-slug-function title))
+                                        (cons 'file file-path)))
+          (org-roam-capture--context 'capture))
+      (condition-case err
+          (org-roam-capture--capture goto keys)
+        (error (user-error "%s.  Please adjust `org-roam-capture-templates'"
+                           (error-message-string err)))))))
+
+(provide 'org-roam-capture)
+
+;;; org-roam-capture.el ends here

org-roam-compat.el

@@ -0,0 +1,112 @@
+;;; org-roam-compat.el --- Compatibility Code -*- coding: utf-8; lexical-binding: t; -*-
+
+;; Copyright © 2020 Jethro Kuan <jethrokuan95@gmail.com>
+
+;; Author: Jethro Kuan <jethrokuan95@gmail.com>
+;; URL: https://github.com/org-roam/org-roam
+;; Keywords: org-mode, roam, convenience
+;; Version: 1.2.3
+;; Package-Requires: ((emacs "26.1") (dash "2.13") (f "0.17.2") (s "1.12.0") (org "9.3") (emacsql "3.0.0") (emacsql-sqlite3 "1.0.2"))
+
+;; This file is NOT part of GNU Emacs.
+
+;; This program is free software; you can redistribute it and/or modify
+;; it under the terms of the GNU General Public License as published by
+;; the Free Software Foundation; either version 3, or (at your option)
+;; any later version.
+;;
+;; This program is distributed in the hope that it will be useful,
+;; but WITHOUT ANY WARRANTY; without even the implied warranty of
+;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+;; GNU General Public License for more details.
+;;
+;; You should have received a copy of the GNU General Public License
+;; along with GNU Emacs; see the file COPYING.  If not, write to the
+;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
+;; Boston, MA 02110-1301, USA.
+
+;;; Commentary:
+;;
+;; This file contains code needed for backward compatibility with older Emacsen
+;; and previous versions of org-roam.
+;;
+;;; Code:
+;;;; Library Requires
+
+;;; Obsolete aliases (remove after next major release)
+;;;; Functions
+(define-obsolete-function-alias 'org-roam--capture-get-point 'org-roam-capture--get-point
+  "org-roam 1.0.0")
+(define-obsolete-function-alias 'org-roam-build-cache 'org-roam-db-build-cache
+  "org-roam 1.0.0")
+(define-obsolete-function-alias 'org-roam-sql         'org-roam-db-query
+  "org-roam 1.0.0")
+(define-obsolete-function-alias 'org-roam--db-clear   'org-roam-db--clear
+  "org-roam 1.0.0")
+(define-obsolete-function-alias 'org-roam-show-graph  'org-roam-graph-show
+  "org-roam 1.0.0")
+(define-obsolete-function-alias 'org-roam--maybe-update-buffer
+  'org-roam-buffer--update-maybe "org-roam 1.0.0")
+(define-obsolete-function-alias 'org-roam--current-visibility
+  'org-roam-buffer--visibility "org-roam 1.0.0")
+(define-obsolete-function-alias 'org-roam-update         'org-roam-buffer-update
+  "org-roam 1.0.0")
+(define-obsolete-function-alias 'org-roam--set-width     'org-roam-buffer--set-width
+  "org-roam 1.0.0")
+(define-obsolete-function-alias 'org-roam--set-height    'org-roam-buffer--set-height
+  "org-roam 1.0.0")
+(define-obsolete-function-alias 'org-roam--set-up-buffer 'org-roam-buffer--get-create
+  "org-roam 1.0.0")
+(define-obsolete-function-alias 'org-roam-today 'org-roam-dailies-today
+  "org-roam 1.0.0")
+(define-obsolete-function-alias 'org-roam-tomorrow 'org-roam-dailies-tomorrow
+  "org-roam 1.0.0")
+(define-obsolete-function-alias 'org-roam-yesterday 'org-roam-dailies-yesterday
+  "org-roam 1.0.0")
+(define-obsolete-function-alias 'org-roam-date 'org-roam-dailies-date
+  "org-roam 1.0.0")
+(define-obsolete-function-alias 'org-roam-graph-show  'org-roam-graph
+  "org-roam 1.0.0")
+(define-obsolete-function-alias 'org-roam-graph-build 'org-roam-graph
+  "org-roam 1.0.0")
+(define-obsolete-function-alias 'org-roam-find-index 'org-roam-jump-to-index
+  "org-roam 1.1.0")
+(define-obsolete-function-alias 'org-roam--pluralize 'org-roam-buffer--pluralize
+  "org-roam 1.1.0")
+(define-obsolete-function-alias 'org-roam--capture 'org-roam-capture--capture
+  "org-roam 1.1.0")
+(define-obsolete-function-alias 'org-roam-db--clear 'org-roam-db-clear
+  "org-roam 1.2.0")
+(define-obsolete-function-alias 'org-roam-dailies-today 'org-roam-dailies-find-today
+  "org-roam 1.2.2")
+(define-obsolete-function-alias 'org-roam-dailies-yesterday 'org-roam-dailies-find-yesterday
+  "org-roam 1.2.2")
+(define-obsolete-function-alias 'org-roam-dailies-tomorrow 'org-roam-dailies-find-tomorrow
+  "org-roam 1.2.2")
+(define-obsolete-function-alias 'org-roam-dailies-date 'org-roam-dailies-find-date
+  "org-roam 1.2.2")
+
+;;;; Variables
+(define-obsolete-variable-alias 'org-roam-graphviz-extra-options
+  'org-roam-graph-extra-config "org-roam 1.0.0")
+(define-obsolete-variable-alias 'org-roam-grapher-extra-options
+  'org-roam-graph-extra-config "org-roam 1.0.0")
+(define-obsolete-variable-alias 'org-roam-graph-node-shape
+  'org-roam-graph-node-extra-config "org-roam 1.0.0")
+(define-obsolete-variable-alias 'org-roam--db-connection
+  'org-roam-db--connection "org-roam 1.0.0")
+(define-obsolete-variable-alias 'org-roam--current-buffer
+  'org-roam-buffer--current "org-roam 1.0.0")
+(define-obsolete-variable-alias 'org-roam-date-title-format
+  'org-roam-dailies-capture-templates "org-roam 1.0.0")
+(define-obsolete-variable-alias 'org-roam-date-filename-format
+  'org-roam-dailies-capture-templates "org-roam 1.0.0")
+(define-obsolete-variable-alias 'org-roam-update-db-idle-seconds
+  'org-roam-db-update-idle-seconds "org-roam 1.2.2")
+
+(make-obsolete-variable 'org-roam-buffer-no-delete-other-windows
+  'org-roam-buffer-window-parameters "org-roam 1.1.1")
+
+(provide 'org-roam-compat)
+
+;;; org-roam-compat.el ends here

org-roam-completion.el

@@ -0,0 +1,117 @@
+;;; org-roam-completion.el --- Completion features -*- coding: utf-8; lexical-binding: t; -*-
+
+;; Copyright © 2020 Jethro Kuan <jethrokuan95@gmail.com>
+
+;; Author: Jethro Kuan <jethrokuan95@gmail.com>
+;; URL: https://github.com/org-roam/org-roam
+;; Keywords: org-mode, roam, convenience
+;; Version: 1.2.3
+;; Package-Requires: ((emacs "26.1") (dash "2.13") (f "0.17.2") (s "1.12.0") (org "9.3") (emacsql "3.0.0") (emacsql-sqlite3 "1.0.2"))
+
+;; This file is NOT part of GNU Emacs.
+
+;; This program is free software; you can redistribute it and/or modify
+;; it under the terms of the GNU General Public License as published by
+;; the Free Software Foundation; either version 3, or (at your option)
+;; any later version.
+;;
+;; This program is distributed in the hope that it will be useful,
+;; but WITHOUT ANY WARRANTY; without even the implied warranty of
+;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+;; GNU General Public License for more details.
+;;
+;; You should have received a copy of the GNU General Public License
+;; along with GNU Emacs; see the file COPYING.  If not, write to the
+;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
+;; Boston, MA 02110-1301, USA.
+
+;;; Commentary:
+;;
+;; This library provides completion for org-roam.
+;;; Code:
+;;;; Library Requires
+(require 'cl-lib)
+(require 's)
+
+(defvar helm-pattern)
+(declare-function helm "ext:helm")
+(declare-function helm-make-source "ext:helm-source" (name class &rest args) t)
+
+(defcustom org-roam-completion-system 'default
+  "The completion system to be used by `org-roam'."
+  :type '(radio
+          (const :tag "Default" default)
+          (const :tag "Ido" ido)
+          (const :tag "Ivy" ivy)
+          (const :tag "Helm" helm)
+          (function :tag "Custom function"))
+  :group 'org-roam)
+
+(defcustom org-roam-completion-ignore-case t
+  "Whether to ignore case in Org-roam `completion-at-point' completions."
+  :group 'org-roam
+  :type 'boolean)
+
+(defun org-roam-completion--helm-candidate-transformer (candidates _source)
+  "Transforms CANDIDATES for Helm-based completing read.
+SOURCE is not used."
+  (let ((prefix (propertize "[?] "
+                            'face 'helm-ff-prefix)))
+    (cons (propertize helm-pattern
+                      'display (concat prefix helm-pattern))
+          candidates)))
+
+(cl-defun org-roam-completion--completing-read (prompt choices &key
+                                                       require-match initial-input
+                                                       action)
+  "Present a PROMPT with CHOICES and optional INITIAL-INPUT.
+If REQUIRE-MATCH is t, the user must select one of the CHOICES.
+Return user choice."
+  (let (res)
+    (setq res
+          (cond
+           ((eq org-roam-completion-system 'ido)
+            (let ((candidates (mapcar #'car choices)))
+              (ido-completing-read prompt candidates nil require-match initial-input)))
+           ((eq org-roam-completion-system 'default)
+            (completing-read prompt choices nil require-match initial-input))
+           ((eq org-roam-completion-system 'ivy)
+            (if (fboundp 'ivy-read)
+                (ivy-read prompt choices
+                          :initial-input initial-input
+                          :preselect initial-input
+                          :require-match require-match
+                          :action (prog1 action
+                                    (setq action nil))
+                          :caller 'org-roam--completing-read)
+              (user-error "Please install ivy from \
+https://github.com/abo-abo/swiper")))
+           ((eq org-roam-completion-system 'helm)
+            (unless (and (fboundp 'helm)
+                         (fboundp 'helm-make-source))
+              (user-error "Please install helm from \
+https://github.com/emacs-helm/helm"))
+            (let ((source (helm-make-source prompt 'helm-source-sync
+                            :candidates (mapcar #'car choices)
+                            :filtered-candidate-transformer
+                            (and (not require-match)
+                                 #'org-roam-completion--helm-candidate-transformer)))
+                  (buf (concat "*org-roam "
+                               (s-downcase (s-chop-suffix ":" (s-trim prompt)))
+                               "*")))
+              (or (helm :sources source
+                        :action (if action
+                                    (prog1 action
+                                      (setq action nil))
+                                  #'identity)
+                        :prompt prompt
+                        :input initial-input
+                        :buffer buf)
+                  (keyboard-quit))))))
+    (if action
+        (funcall action res)
+      res)))
+
+(provide 'org-roam-completion)
+
+;;; org-roam-completion.el ends here

org-roam-dailies.el

@@ -0,0 +1,348 @@
+;;; org-roam-dailies.el --- Daily-notes for Org-roam -*- coding: utf-8; lexical-binding: t; -*-
+;;;
+;; Copyright © 2020 Jethro Kuan <jethrokuan95@gmail.com>
+;; Copyright © 2020 Leo Vivier <leo.vivier+dev@gmail.com>
+
+;; Author: Jethro Kuan <jethrokuan95@gmail.com>
+;; 	Leo Vivier <leo.vivier+dev@gmail.com>
+;; URL: https://github.com/org-roam/org-roam
+;; Keywords: org-mode, roam, convenience
+;; Version: 1.2.3
+;; Package-Requires: ((emacs "26.1") (dash "2.13") (f "0.17.2") (s "1.12.0") (org "9.3") (emacsql "3.0.0") (emacsql-sqlite3 "1.0.2"))
+
+;; This file is NOT part of GNU Emacs.
+
+;; This program is free software; you can redistribute it and/or modify
+;; it under the terms of the GNU General Public License as published by
+;; the Free Software Foundation; either version 3, or (at your option)
+;; any later version.
+;;
+;; This program is distributed in the hope that it will be useful,
+;; but WITHOUT ANY WARRANTY; without even the implied warranty of
+;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+;; GNU General Public License for more details.
+;;
+;; You should have received a copy of the GNU General Public License
+;; along with GNU Emacs; see the file COPYING.  If not, write to the
+;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
+;; Boston, MA 02110-1301, USA.
+
+;;; Commentary:
+;;
+;; This library provides functionality for creating daily-notes. This is a
+;; concept borrowed from Roam Research.
+;;
+;;; Code:
+;;; Library Requires
+(require 'org-capture)
+(require 'org-roam-capture)
+(require 'org-roam-macs)
+(require 'f)
+
+;;;; Declarations
+(defvar org-roam-mode)
+(defvar org-roam-directory)
+(defvar org-roam-file-extensions)
+(declare-function org-roam--org-file-p        "org-roam")
+(declare-function org-roam--find-file         "org-roam")
+(declare-function org-roam-mode               "org-roam")
+
+;;;; Customizable variables
+(defcustom org-roam-dailies-directory "daily/"
+  "Path to daily-notes."
+  :group 'org-roam
+  :type 'string)
+
+(defcustom org-roam-dailies-find-file-hook nil
+  "Hook that is run right after navigating to a daily-note."
+  :group 'org-roam
+  :type 'hook)
+
+(defcustom org-roam-dailies-capture-templates
+  `(("d" "default" entry (function org-roam-capture--get-point)
+     "* %?"
+     :file-name ,(concat org-roam-dailies-directory "%<%Y-%m-%d>")
+     :head "#+title: %<%Y-%m-%d>\n"))
+  "Capture templates for daily-notes in Org-roam."
+  :group 'org-roam
+  ;; Adapted from `org-capture-templates'
+  :type
+  `(repeat
+    (choice :value ("d" "default" plain (function org-roam-capture--get-point)
+                    "%?"
+                    :file-name ,(concat org-roam-dailies-directory
+					"%<%Y-%m-%d>")
+                    :head "#+title: %<%Y-%m-%d>\n"
+                    :unnarrowed t)
+      (list :tag "Multikey description"
+        (string :tag "Keys       ")
+        (string :tag "Description"))
+      (list :tag "Template entry"
+        (string :tag "Keys              ")
+        (string :tag "Description       ")
+        (choice :tag "Type              "
+         (const :tag "Plain" plain)
+         (const :tag "Entry (for creating headlines)" entry))
+        (const :format "" #'org-roam-capture--get-point)
+        (choice :tag "Template          "
+          (string :tag "String"
+                  :format "String:\n            \
+Template string   :\n%v")
+          (list :tag "File"
+            (const :format "" file)
+            (file :tag "Template file     "))
+          (list :tag "Function"
+            (const :format "" function)
+            (function :tag "Template function ")))
+        (const :format "File name format  :" :file-name)
+        (string :format " %v" :value ,(concat org-roam-dailies-directory
+					      "%<%Y-%m-%d>"))
+        (const :format "Header format     :" :head)
+        (string :format " %v" :value "#+title: ${title}\n")
+        (plist :inline t
+               :tag "Options"
+          ;; Give the most common options as checkboxes
+               :options
+               (((const :tag "Outline path" :olp)
+                 (repeat :tag "Headings"
+                   (string :tag "Heading")))
+                ((const :format "%v " :unnarrowed) (const t))
+                ((const :format "%v " :prepend) (const t))
+                ((const :format "%v " :immediate-finish) (const t))
+                ((const :format "%v " :jump-to-captured) (const t))
+                ((const :format "%v " :empty-lines) (const 1))
+                ((const :format "%v " :empty-lines-before) (const 1))
+                ((const :format "%v " :empty-lines-after) (const 1))
+                ((const :format "%v " :clock-in) (const t))
+                ((const :format "%v " :clock-keep) (const t))
+                ((const :format "%v " :clock-resume) (const t))
+                ((const :format "%v " :time-prompt) (const t))
+                ((const :format "%v " :tree-type) (const week))
+                ((const :format "%v " :table-line-pos) (string))
+                ((const :format "%v " :kill-buffer) (const t))))))))
+
+;;;; Utilities
+(defun org-roam-dailies-directory--get-absolute-path ()
+  "Get absolute path to `org-roam-dailies-directory'."
+  (expand-file-name org-roam-dailies-directory org-roam-directory))
+
+(defun org-roam-dailies-find-directory ()
+  "Find and open `org-roam-dailies-directory'."
+  (interactive)
+  (org-roam--find-file (org-roam-dailies-directory--get-absolute-path)))
+
+(defun org-roam-dailies--daily-note-p (&optional file)
+  "Return t if FILE is an Org-roam daily-note, nil otherwise.
+
+If FILE is not specified, use the current buffer's file-path."
+  (when-let ((path (or file
+                       (-> (buffer-base-buffer)
+                           (buffer-file-name))))
+             (directory (org-roam-dailies-directory--get-absolute-path)))
+    (setq path (expand-file-name path))
+    (save-match-data
+      (and
+       (org-roam--org-file-p path)
+       (f-descendant-of-p path directory)))))
+
+(defun org-roam-dailies--capture (time &optional goto)
+  "Capture an entry in a daily-note for TIME, creating it if necessary.
+
+When GOTO is non-nil, go the note without creating an entry."
+  (unless org-roam-mode (org-roam-mode))
+  (let ((org-roam-capture-templates (--> org-roam-dailies-capture-templates
+                                         (if goto (list (car it)) it)))
+        (org-roam-capture--info (list (cons 'time time)))
+        (org-roam-capture--context 'dailies))
+    (org-roam-capture--capture (when goto '(4)))))
+
+;;;; Commands
+;;; Today
+(defun org-roam-dailies-capture-today (&optional goto)
+  "Create an entry in the daily-note for today.
+
+When GOTO is non-nil, go the note without creating an entry."
+  (interactive "P")
+  (org-roam-dailies--capture (current-time) goto)
+  (when goto
+    (run-hooks 'org-roam-dailies-find-file-hook)))
+
+(defun org-roam-dailies-find-today ()
+  "Find the daily-note for today, creating it if necessary."
+  (interactive)
+  (org-roam-dailies-capture-today t))
+
+;;; Tomorrow
+(defun org-roam-dailies-capture-tomorrow (n &optional goto)
+  "Create an entry in the daily-note for tomorrow.
+
+With numeric argument N, use the daily-note N days in the future.
+
+With a `C-u' prefix or when GOTO is non-nil, go the note without
+creating an entry."
+  (interactive "p")
+  (org-roam-dailies--capture (time-add (* n 86400) (current-time)) goto))
+
+(defun org-roam-dailies-find-tomorrow (n)
+  "Find the daily-note for tomorrow, creating it if necessary.
+
+With numeric argument N, use the daily-note N days in the
+future."
+  (interactive "p")
+  (org-roam-dailies-capture-tomorrow n t))
+
+;;; Yesterday
+(defun org-roam-dailies-capture-yesterday (n &optional goto)
+  "Create an entry in the daily-note for yesteday.
+
+With numeric argument N, use the daily-note N days in the past.
+
+When GOTO is non-nil, go the note without creating an entry."
+  (interactive "p")
+  (org-roam-dailies-capture-tomorrow (- n) goto))
+
+(defun org-roam-dailies-find-yesterday (n)
+  "Find the daily-note for yesterday, creating it if necessary.
+
+With numeric argument N, use the daily-note N days in the
+future."
+  (interactive "p")
+  (org-roam-dailies-capture-tomorrow (- n) t))
+
+;;; Calendar
+(defvar org-roam-dailies-calendar-hook (list 'org-roam-dailies-calendar-mark-entries)
+  "Hooks to run when showing the `org-roam-dailies-calendar'.")
+
+(defun org-roam-dailies-calendar--install-hook ()
+  "Install Org-roam-dailies hooks to calendar."
+  (add-hook 'calendar-today-visible-hook #'org-roam-dailies-calendar--run-hook)
+  (add-hook 'calendar-today-invisible-hook #'org-roam-dailies-calendar--run-hook))
+
+(defun org-roam-dailies-calendar--run-hook ()
+  "Run Org-roam-dailies hooks to calendar."
+  (run-hooks 'org-roam-dailies-calendar-hook)
+  (remove-hook 'calendar-today-visible-hook #'org-roam-dailies-calendar--run-hook)
+  (remove-hook 'calendar-today-invisible-hook #'org-roam-dailies-calendar--run-hook))
+
+(defun org-roam-dailies-calendar--file-to-date (&optional file)
+  "Convert FILE to date.
+
+Return (MONTH DAY YEAR)."
+  (let ((file (or file
+                  (-> (buffer-base-buffer)
+                      (buffer-file-name)))))
+    (cl-destructuring-bind (_ _ _ d m y _ _ _)
+        (-> file
+            (file-name-nondirectory)
+            (file-name-sans-extension)
+            (org-parse-time-string))
+      (list m d y))))
+
+(defun org-roam-dailies-calendar--date-to-time (date)
+  "Convert DATE as returned from the calendar (MONTH DAY YEAR) to a time."
+  (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date)))
+
+(defun org-roam-dailies-calendar-mark-entries ()
+  "Mark days in the calendar for which a daily-note is present."
+  (when (file-exists-p (org-roam-dailies-directory--get-absolute-path))
+    (dolist (date (mapcar #'org-roam-dailies-calendar--file-to-date
+                          (org-roam-dailies--list-files)))
+      (when (calendar-date-is-visible-p date)
+        (calendar-mark-visible-date date 'org-roam-dailies-calendar-note)))))
+
+;;; Date
+(defun org-roam-dailies-capture-date (&optional goto prefer-future)
+  "Create an entry in the daily-note for a date using the calendar.
+
+Prefer past dates, unless PREFER-FUTURE is non-nil.
+
+With a `C-u' prefix or when GOTO is non-nil, go the note without
+creating an entry."
+  (interactive "P")
+  (org-roam-dailies-calendar--install-hook)
+  (let* ((time-str (let ((org-read-date-prefer-future prefer-future))
+                     (org-read-date nil nil nil (if goto
+                                                    "Find daily-note: "
+                                                  "Capture to daily-note: "))))
+         (time (org-read-date nil t time-str)))
+    (org-roam-dailies--capture time goto)
+    (when goto
+      (run-hooks 'org-roam-dailies-find-file-hook))))
+
+(defun org-roam-dailies-find-date (&optional prefer-future)
+  "Find the daily-note for a date using the calendar, creating it if necessary.
+
+Prefer past dates, unless PREFER-FUTURE is non-nil."
+  (interactive)
+  (org-roam-dailies-capture-date t prefer-future))
+
+;;; Navigation
+(defun org-roam-dailies--list-files (&rest extra-files)
+  "List all files in `org-roam-dailies-directory'.
+EXTRA-FILES can be used to append extra files to the list."
+  (let ((dir (org-roam-dailies-directory--get-absolute-path))
+	(regexp (rx-to-string `(and "." (or ,@org-roam-file-extensions)))))
+    (append (--remove (let ((file (file-name-nondirectory it)))
+                        (when (or (auto-save-file-name-p file)
+                                  (backup-file-name-p file)
+                                  (string-match "^\\." file))
+                          it))
+                      (directory-files-recursively dir regexp))
+            extra-files)))
+
+(defun org-roam-dailies-find-next-note (&optional n)
+  "Find next daily-note.
+
+With numeric argument N, find note N days in the future. If N is
+negative, find note N days in the past."
+  (interactive "p")
+  (unless (org-roam-dailies--daily-note-p)
+    (user-error "Not in a daily-note"))
+  (setq n (or n 1))
+  (let* ((dailies (org-roam-dailies--list-files))
+         (position
+          (cl-position-if (lambda (candidate)
+                            (string= (buffer-file-name (buffer-base-buffer)) candidate))
+                          dailies))
+         note)
+      (unless position
+        (user-error "Can't find current note file - have you saved it yet?"))
+      (pcase n
+        ((pred (natnump))
+         (when (eq position (- (length dailies) 1))
+           (user-error "Already at newest note")))
+        ((pred (integerp))
+         (when (eq position 0)
+             (user-error "Already at oldest note"))))
+      (setq note (nth (+ position n) dailies))
+      (find-file note)
+      (run-hooks 'org-roam-dailies-find-file-hook)))
+
+(defun org-roam-dailies-find-previous-note (&optional n)
+  "Find previous daily-note.
+
+With numeric argument N, find note N days in the past. If N is
+negative, find note N days in the future."
+  (interactive "p")
+  (let ((n (if n (- n) -1)))
+    (org-roam-dailies-find-next-note n)))
+
+;;;; Bindings
+(defvar org-roam-dailies-map (make-sparse-keymap)
+  "Keymap for `org-roam-dailies'.")
+
+(define-prefix-command 'org-roam-dailies-map)
+
+(define-key org-roam-dailies-map (kbd "d") #'org-roam-dailies-find-today)
+(define-key org-roam-dailies-map (kbd "y") #'org-roam-dailies-find-yesterday)
+(define-key org-roam-dailies-map (kbd "t") #'org-roam-dailies-find-tomorrow)
+(define-key org-roam-dailies-map (kbd "n") #'org-roam-dailies-capture-today)
+(define-key org-roam-dailies-map (kbd "f") #'org-roam-dailies-find-next-note)
+(define-key org-roam-dailies-map (kbd "b") #'org-roam-dailies-find-previous-note)
+(define-key org-roam-dailies-map (kbd "c") #'org-roam-dailies-find-date)
+(define-key org-roam-dailies-map (kbd "v") #'org-roam-dailies-capture-date)
+(define-key org-roam-dailies-map (kbd ".") #'org-roam-dailies-find-directory)
+
+(provide 'org-roam-dailies)
+
+;;; org-roam-dailies.el ends here

org-roam-db.el

@@ -0,0 +1,633 @@
+;;; org-roam-db.el --- Org-roam database API -*- coding: utf-8; lexical-binding: t; -*-
+
+;; Copyright © 2020 Jethro Kuan <jethrokuan95@gmail.com>
+
+;; Author: Jethro Kuan <jethrokuan95@gmail.com>
+;; URL: https://github.com/org-roam/org-roam
+;; Keywords: org-mode, roam, convenience
+;; Version: 1.2.3
+;; Package-Requires: ((emacs "26.1") (dash "2.13") (f "0.17.2") (s "1.12.0") (org "9.3") (emacsql "3.0.0") (emacsql-sqlite3 "1.0.2"))
+
+;; This file is NOT part of GNU Emacs.
+
+;; This program is free software; you can redistribute it and/or modify
+;; it under the terms of the GNU General Public License as published by
+;; the Free Software Foundation; either version 3, or (at your option)
+;; any later version.
+;;
+;; This program is distributed in the hope that it will be useful,
+;; but WITHOUT ANY WARRANTY; without even the implied warranty of
+;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+;; GNU General Public License for more details.
+;;
+;; You should have received a copy of the GNU General Public License
+;; along with GNU Emacs; see the file COPYING.  If not, write to the
+;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
+;; Boston, MA 02110-1301, USA.
+
+;;; Commentary:
+;;
+;; This library is provides the underlying database api to org-roam
+;;
+;;; Code:
+;;;; Library Requires
+(eval-when-compile (require 'subr-x))
+(require 'emacsql)
+(require 'emacsql-sqlite3)
+(require 'seq)
+
+(eval-and-compile
+  (require 'org-roam-macs)
+  ;; For `org-with-wide-buffer'
+  (require 'org-macs))
+
+(defvar org-roam-directory)
+(defvar org-roam-enable-headline-linking)
+(defvar org-roam-verbose)
+(defvar org-roam-file-name)
+
+(defvar org-agenda-files)
+
+(declare-function org-roam--org-roam-file-p                "org-roam")
+(declare-function org-roam--extract-titles                 "org-roam")
+(declare-function org-roam--extract-refs                   "org-roam")
+(declare-function org-roam--extract-tags                   "org-roam")
+(declare-function org-roam--extract-ids                    "org-roam")
+(declare-function org-roam--extract-links                  "org-roam")
+(declare-function org-roam--list-all-files                 "org-roam")
+(declare-function org-roam--path-to-slug                   "org-roam")
+(declare-function org-roam--file-name-extension            "org-roam")
+(declare-function org-roam-buffer--update-maybe            "org-roam-buffer")
+
+;;;; Options
+(defcustom org-roam-db-location (expand-file-name "org-roam.db" user-emacs-directory)
+  "The full path to file where the Org-roam database is stored.
+If this is non-nil, the Org-roam sqlite database is saved here.
+
+It is the user's responsibility to set this correctly, especially
+when used with multiple Org-roam instances."
+  :type 'string
+  :group 'org-roam)
+
+(defcustom org-roam-db-gc-threshold gc-cons-threshold
+  "The value to temporarily set the `gc-cons-threshold' threshold to.
+During large, heavy operations like `org-roam-db-build-cache',
+many GC operations happen because of the large number of
+temporary structures generated (e.g. parsed ASTs). Temporarily
+increasing `gc-cons-threshold' will help reduce the number of GC
+operations, at the cost of temporary memory usage.
+
+This defaults to the original value of `gc-cons-threshold', but
+tweaking this number may lead to better overall performance. For
+example, to reduce the number of GCs, one may set it to a large
+value like `most-positive-fixnum'."
+  :type 'int
+  :group 'org-roam)
+
+(defconst org-roam-db--version 10)
+
+(defvar org-roam-db--connection (make-hash-table :test #'equal)
+  "Database connection to Org-roam database.")
+
+(defvar org-roam-db-dirty nil
+  "Whether the org-roam database is dirty and requires an update.
+Contains pairs of `org-roam-directory' and `org-roam-db-location'
+so that multi-directories are updated.")
+
+(defcustom org-roam-db-update-method 'idle-timer
+  "Method to update the Org-roam database.
+
+`immediate'
+  Update the database immediately upon file changes.
+
+`idle-timer'
+  Updates the database if dirty, if Emacs idles for `org-roam-db-update-idle-seconds'."
+  :type '(choice (const :tag "idle-timer" idle-timer)
+		 (const :tag "immediate" immediate))
+  :group 'org-roam)
+
+(defcustom org-roam-db-update-idle-seconds 2
+  "Number of idle seconds before triggering an Org-roam database update."
+  :type 'integer
+  :group 'org-roam)
+
+;;;; Core Functions
+
+(defun org-roam-db--get-connection ()
+  "Return the database connection, if any."
+  (gethash (expand-file-name org-roam-directory)
+           org-roam-db--connection))
+
+(defun org-roam-db ()
+  "Entrypoint to the Org-roam sqlite database.
+Initializes and stores the database, and the database connection.
+Performs a database upgrade when required."
+  (unless (and (org-roam-db--get-connection)
+               (emacsql-live-p (org-roam-db--get-connection)))
+    (let ((init-db (not (file-exists-p org-roam-db-location))))
+      (make-directory (file-name-directory org-roam-db-location) t)
+      (let ((conn (emacsql-sqlite3 org-roam-db-location)))
+        (set-process-query-on-exit-flag (emacsql-process conn) nil)
+        (puthash (expand-file-name org-roam-directory)
+                 conn
+                 org-roam-db--connection)
+        (when init-db
+          (org-roam-db--init conn))
+        (let* ((version (caar (emacsql conn "PRAGMA user_version")))
+               (version (org-roam-db--upgrade-maybe conn version)))
+          (cond
+           ((> version org-roam-db--version)
+            (emacsql-close conn)
+            (user-error
+             "The Org-roam database was created with a newer Org-roam version.  "
+             "You need to update the Org-roam package"))
+           ((< version org-roam-db--version)
+            (emacsql-close conn)
+            (error "BUG: The Org-roam database scheme changed %s"
+                   "and there is no upgrade path")))))))
+  (org-roam-db--get-connection))
+
+;;;; Entrypoint: (org-roam-db-query)
+(defun org-roam-db-query (sql &rest args)
+  "Run SQL query on Org-roam database with ARGS.
+SQL can be either the emacsql vector representation, or a string."
+  (if  (stringp sql)
+      (emacsql (org-roam-db) (apply #'format sql args))
+    (apply #'emacsql (org-roam-db) sql args)))
+
+;;;; Schemata
+(defconst org-roam-db--table-schemata
+  '((files
+     [(file :unique :primary-key)
+      (hash :not-null)
+      (meta :not-null)])
+
+    (ids
+     [(id :unique :primary-key)
+      (file :not-null)
+      (level :not-null)])
+
+    (links
+     [(source :not-null)
+      (dest :not-null)
+      (type :not-null)
+      (properties :not-null)])
+
+    (tags
+     [(file :unique :primary-key)
+      (tags)])
+
+    (titles
+     [(file :not-null)
+      title])
+
+    (refs
+     [(ref :unique :not-null)
+      (file :not-null)
+      (type :not-null)])))
+
+(defun org-roam-db--init (db)
+  "Initialize database DB with the correct schema and user version."
+  (emacsql-with-transaction db
+    (pcase-dolist (`(,table . ,schema) org-roam-db--table-schemata)
+      (emacsql db [:create-table $i1 $S2] table schema))
+    (emacsql db (format "PRAGMA user_version = %s" org-roam-db--version))))
+
+(defun org-roam-db--upgrade-maybe (db version)
+  "Upgrades the database schema for DB, if VERSION is old."
+  (emacsql-with-transaction db
+    'ignore
+    (if (< version org-roam-db--version)
+        (progn
+          (org-roam-message (format "Upgrading the Org-roam database from version %d to version %d"
+                                    version org-roam-db--version))
+          (org-roam-db-build-cache t))))
+  version)
+
+(defun org-roam-db--close (&optional db)
+  "Closes the database connection for database DB.
+If DB is nil, closes the database connection for the database in
+the current `org-roam-directory'."
+  (unless db
+    (setq db (org-roam-db--get-connection)))
+  (when (and db (emacsql-live-p db))
+    (emacsql-close db)))
+
+(defun org-roam-db--close-all ()
+  "Closes all database connections made by Org-roam."
+  (dolist (conn (hash-table-values org-roam-db--connection))
+    (org-roam-db--close conn)))
+
+;;;; Timer-based updating
+(defvar org-roam-db-file-update-timer nil
+  "Timer for updating the database when dirty.")
+
+(defun org-roam-db-mark-dirty ()
+  "Mark the Org-roam database as dirty."
+  (add-to-list 'org-roam-db-dirty (list org-roam-directory org-roam-db-location)
+               nil #'equal))
+
+(defun org-roam-db-update-cache-on-timer ()
+  "Update the cache if the database is dirty.
+This function is called on `org-roam-db-file-update-timer'."
+  (pcase-dolist (`(,org-roam-directory ,org-roam-db-location) org-roam-db-dirty)
+    (org-roam-db-build-cache))
+  (setq org-roam-db-dirty nil))
+
+;;;; Database API
+;;;;; Initialization
+(defun org-roam-db--initialized-p ()
+  "Whether the Org-roam cache has been initialized."
+  (and (file-exists-p org-roam-db-location)
+       (> (caar (org-roam-db-query [:select (funcall count) :from titles]))
+          0)))
+
+(defun org-roam-db--ensure-built ()
+  "Ensures that Org-roam cache is built."
+  (unless (org-roam-db--initialized-p)
+    (error "[Org-roam] your cache isn't built yet! Please run org-roam-db-build-cache")))
+
+;;;;; Clearing
+(defun org-roam-db-clear ()
+  "Clears all entries in the Org-roam cache."
+  (interactive)
+  (when (file-exists-p org-roam-db-location)
+    (dolist (table (mapcar #'car org-roam-db--table-schemata))
+      (org-roam-db-query `[:delete :from ,table]))))
+
+(defun org-roam-db--clear-file (&optional file)
+  "Remove any related links to the FILE.
+This is equivalent to removing the node from the graph."
+  (setq file (or file (buffer-file-name (buffer-base-buffer))))
+  (dolist (table (mapcar #'car org-roam-db--table-schemata))
+    (org-roam-db-query `[:delete :from ,table
+                         :where (= ,(if (eq table 'links) 'source 'file) $s1)]
+                       file)))
+
+;;;;; Inserting
+(defun org-roam-db--insert-meta (&optional update-p)
+  "Update the metadata of the current buffer into the cache.
+If UPDATE-P is non-nil, first remove the meta for the file in the database."
+  (let* ((file (or org-roam-file-name (buffer-file-name)))
+         (attr (file-attributes file))
+         (atime (file-attribute-access-time attr))
+         (mtime (file-attribute-modification-time attr))
+         (hash (org-roam-db--file-hash)))
+    (when update-p
+      (org-roam-db-query [:delete :from files
+                          :where (= file $s1)]
+                         file))
+    (org-roam-db-query
+     [:insert :into files
+      :values $v1]
+     (list (vector file hash (list :atime atime :mtime mtime))))))
+
+(defun org-roam-db--insert-titles (&optional update-p)
+  "Update the titles of the current buffer into the cache.
+If UPDATE-P is non-nil, first remove titles for the file in the database.
+Returns the number of rows inserted."
+  (let* ((file (or org-roam-file-name (buffer-file-name)))
+         (titles (or (org-roam--extract-titles)
+                     (list (org-roam--path-to-slug file))))
+         (rows (mapcar (lambda (title)
+                         (vector file title)) titles)))
+    (when update-p
+      (org-roam-db-query [:delete :from titles
+                          :where (= file $s1)]
+                         file))
+    (org-roam-db-query
+        [:insert :into titles
+         :values $v1]
+        rows)
+    (length rows)))
+
+(defun org-roam-db--insert-refs (&optional update-p)
+  "Update the refs of the current buffer into the cache.
+If UPDATE-P is non-nil, first remove the ref for the file in the database."
+  (let ((file (or org-roam-file-name (buffer-file-name)))
+        (count 0))
+    (when update-p
+      (org-roam-db-query [:delete :from refs
+                          :where (= file $s1)]
+                         file))
+    (when-let ((refs (org-roam--extract-refs)))
+      (dolist (ref refs)
+        (let ((key (cdr ref))
+              (type (car ref)))
+          (condition-case nil
+              (progn
+                (org-roam-db-query
+                 [:insert :into refs :values $v1]
+                 (list (vector key file type)))
+                (cl-incf count))
+            (error
+             (lwarn '(org-roam) :error
+                    (format "Duplicate ref %s in:\n\nA: %s\nB: %s\n\nskipping..."
+                            key
+                            file
+                            (caar (org-roam-db-query
+                                   [:select file :from refs
+                                    :where (= ref $v1)]
+                                   (vector key))))))))))
+    count))
+
+(defun org-roam-db--insert-links (&optional update-p)
+  "Update the file links of the current buffer in the cache.
+If UPDATE-P is non-nil, first remove the links for the file in the database.
+Return the number of rows inserted."
+  (let ((file (or org-roam-file-name (buffer-file-name))))
+    (when update-p
+      (org-roam-db-query [:delete :from links
+                          :where (= source $s1)]
+                         file))
+    (if-let ((links (org-roam--extract-links)))
+        (progn
+          (org-roam-db-query
+           [:insert :into links
+            :values $v1]
+           links)
+          (length links))
+      0)))
+
+(defun org-roam-db--insert-ids (&optional update-p)
+  "Update the ids of the current buffer into the cache.
+If UPDATE-P is non-nil, first remove ids for the file in the database.
+Returns the number of rows inserted."
+  (let ((file (or org-roam-file-name (buffer-file-name))))
+    (when update-p
+      (org-roam-db-query [:delete :from ids
+                          :where (= file $s1)]
+                         file))
+    (if-let ((ids (org-roam--extract-ids file)))
+      (condition-case nil
+          (progn
+            (org-roam-db-query
+             [:insert :into ids
+              :values $v1]
+             ids)
+            (length ids))
+        (error
+         (lwarn '(org-roam) :error
+                (format "Duplicate IDs in %s, one of:\n\n%s\n\nskipping..."
+                        (aref (car ids) 1)
+                        (string-join (mapcar (lambda (hl)
+                                               (aref hl 0)) ids) "\n")))
+         0))
+      0)))
+
+(defun org-roam-db--insert-tags (&optional update-p)
+  "Insert tags for the current buffer into the Org-roam cache.
+If UPDATE-P is non-nil, first remove tags for the file in the database.
+Return the number of rows inserted."
+  (let* ((file (or org-roam-file-name (buffer-file-name)))
+         (tags (org-roam--extract-tags file)))
+    (when update-p
+      (org-roam-db-query [:delete :from tags
+                          :where (= file $s1)]
+                         file))
+    (if tags
+        (progn (org-roam-db-query
+                [:insert :into tags
+                 :values $v1]
+                (list (vector file tags)))
+               1)
+      0)))
+
+;;;;; Fetching
+(defun org-roam-db-has-file-p (file)
+  "Return t if FILE is in the database, nil otherwise."
+  (> (caar (org-roam-db-query [:select (funcall count) :from files
+                              :where (= file $s1)]
+                              file))
+     0))
+
+(defun org-roam-db--get-current-files ()
+  "Return a hash-table of file to the hash of its file contents."
+  (let* ((current-files (org-roam-db-query [:select * :from files]))
+         (ht (make-hash-table :test #'equal)))
+    (dolist (row current-files)
+      (puthash (car row) (cadr row) ht))
+    ht))
+
+(defun org-roam-db--get-title (file)
+  "Return the main title of FILE from the cache."
+  (caar (org-roam-db-query [:select [title] :from titles
+                            :where (= file $s1)
+                            :limit 1]
+                           file)))
+
+(defun org-roam-db--get-tags ()
+  "Return all distinct tags from the cache."
+  (let ((rows (org-roam-db-query [:select :distinct [tags] :from tags]))
+        acc)
+    (dolist (row rows)
+      (dolist (tag (car row))
+        (unless (member tag acc)
+          (push tag acc))))
+    acc))
+
+(defun org-roam-db--connected-component (file)
+  "Return all files reachable from/connected to FILE, including the file itself.
+If the file does not have any connections, nil is returned."
+  (let* ((query "WITH RECURSIVE
+                   links_of(file, link) AS
+                     (WITH filelinks AS (SELECT * FROM links WHERE NOT \"type\" = '\"cite\"'),
+                           citelinks AS (SELECT * FROM links
+                                                  JOIN refs ON links.\"dest\" = refs.\"ref\"
+                                                            AND links.\"type\" = '\"cite\"')
+                      SELECT \"source\", \"dest\" FROM filelinks UNION
+                      SELECT \"dest\", \"source\" FROM filelinks UNION
+                      SELECT \"file\", \"source\" FROM citelinks UNION
+                      SELECT \"dest\", \"file\" FROM citelinks),
+                   connected_component(file) AS
+                     (SELECT link FROM links_of WHERE file = $s1
+                      UNION
+                      SELECT link FROM links_of JOIN connected_component USING(file))
+                   SELECT * FROM connected_component;")
+         (files (mapcar 'car-safe (emacsql (org-roam-db) query file))))
+    files))
+
+(defun org-roam-db--links-with-max-distance (file max-distance)
+  "Return all files connected to FILE in at most MAX-DISTANCE steps.
+This includes the file itself. If the file does not have any
+connections, nil is returned."
+  (let* ((query "WITH RECURSIVE
+                   links_of(file, link) AS
+                     (WITH filelinks AS (SELECT * FROM links WHERE NOT \"type\" = '\"cite\"'),
+                           citelinks AS (SELECT * FROM links
+                                                  JOIN refs ON links.\"dest\" = refs.\"ref\"
+                                                            AND links.\"type\" = '\"cite\"')
+                      SELECT \"source\", \"dest\" FROM filelinks UNION
+                      SELECT \"dest\", \"source\" FROM filelinks UNION
+                      SELECT \"file\", \"source\" FROM citelinks UNION
+                      SELECT \"source\", \"file\" FROM citelinks),
+                   -- Links are traversed in a breadth-first search.  In order to calculate the
+                   -- distance of nodes and to avoid following cyclic links, the visited nodes
+                   -- are tracked in 'trace'.
+                   connected_component(file, trace) AS
+                     (VALUES($s1, json_array($s1))
+                      UNION
+                      SELECT lo.link, json_insert(cc.trace, '$[' || json_array_length(cc.trace) || ']', lo.link) FROM
+                      connected_component AS cc JOIN links_of AS lo USING(file)
+                      WHERE (
+                        -- Avoid cycles by only visiting each file once.
+                        (SELECT count(*) FROM json_each(cc.trace) WHERE json_each.value == lo.link) == 0
+                        -- Note: BFS is cut off early here.
+                        AND json_array_length(cc.trace) < ($s2 + 1)))
+                   SELECT DISTINCT file, min(json_array_length(trace)) AS distance
+                   FROM connected_component GROUP BY file ORDER BY distance;")
+         ;; In principle the distance would be available in the second column.
+         (files (mapcar 'car-safe (emacsql (org-roam-db) query file max-distance))))
+    files))
+
+(defun org-roam-db--file-hash (&optional file-path)
+  "Compute the hash of FILE-PATH, a file or current buffer."
+  (if file-path
+      (with-temp-buffer
+        (set-buffer-multibyte nil)
+        (insert-file-contents-literally file-path)
+        (secure-hash 'sha1 (current-buffer)))
+    (org-with-wide-buffer
+     (secure-hash 'sha1 (current-buffer)))))
+
+;;;;; Updating
+(defun org-roam-db--update-file (&optional file-path)
+  "Update Org-roam cache for FILE-PATH.
+If the file does not exist anymore, remove it from the cache.
+If the file exists, update the cache with information."
+  (setq file-path (or file-path
+                      (buffer-file-name (buffer-base-buffer))))
+  (if (not (file-exists-p file-path))
+      (org-roam-db--clear-file file-path)
+    ;; save the file before performing a database update
+    (when-let ((buf (find-buffer-visiting file-path)))
+      (with-current-buffer buf
+        (save-buffer)))
+    (org-roam--with-temp-buffer file-path
+      (emacsql-with-transaction (org-roam-db)
+        (org-roam-db--insert-meta 'update)
+        (org-roam-db--insert-tags 'update)
+        (org-roam-db--insert-titles 'update)
+        (org-roam-db--insert-refs 'update)
+        (when org-roam-enable-headline-linking
+          (org-roam-db--insert-ids 'update))
+        (org-roam-db--insert-links 'update)))))
+
+(defun org-roam-db-build-cache (&optional force)
+  "Build the cache for `org-roam-directory'.
+If FORCE, force a rebuild of the cache from scratch."
+  (interactive "P")
+  (when force (delete-file org-roam-db-location))
+  (org-roam-db--close) ;; Force a reconnect
+  (org-roam-db) ;; To initialize the database, no-op if already initialized
+  (let* ((gc-cons-threshold org-roam-db-gc-threshold)
+         (org-agenda-files nil)
+         (org-roam-files (org-roam--list-all-files))
+         (current-files (org-roam-db--get-current-files))
+         (count-plist nil)
+         (deleted-count 0)
+         (modified-files nil))
+    (dolist (file org-roam-files)
+      (let ((contents-hash (org-roam-db--file-hash file)))
+        (unless (string= (gethash file current-files)
+                       contents-hash)
+          (push (cons file contents-hash) modified-files)))
+      (remhash file current-files))
+    (dolist (file (hash-table-keys current-files))
+        ;; These files are no longer around, remove from cache...
+        (org-roam-db--clear-file file)
+        (setq deleted-count (1+ deleted-count)))
+    (setq count-plist (org-roam-db--update-files modified-files))
+    (org-roam-message "total: Δ%s, files-modified: Δ%s, ids: Δ%s, links: Δ%s, tags: Δ%s, titles: Δ%s, refs: Δ%s, deleted: Δ%s"
+                      (- (length org-roam-files) (plist-get count-plist :error-count))
+                      (plist-get count-plist :modified-count)
+                      (plist-get count-plist :id-count)
+                      (plist-get count-plist :link-count)
+                      (plist-get count-plist :tag-count)
+                      (plist-get count-plist :title-count)
+                      (plist-get count-plist :ref-count)
+                      deleted-count)))
+
+(defun org-roam-db--get-file-hash-from-db (&optional file-path)
+  "Get hash from Org-roam database for FILE-PATH."
+  (setq file-path (or file-path
+                      (buffer-file-name (buffer-base-buffer))))
+  (caar (org-roam-db-query [:select hash :from files
+                              :where (= file $s1)] file-path)))
+
+(defun org-roam-db-update-file (file-path)
+  "Update Org-roam cache for FILE-PATH.
+If the file does not exist anymore, remove it from the cache.
+If the file exists, update the cache with information."
+  (let ((content-hash (org-roam-db--file-hash file-path))
+        (db-hash  (org-roam-db--get-file-hash-from-db file-path)))
+    (unless (string= content-hash db-hash)
+      (org-roam-db--update-files (list (cons file-path content-hash)))
+      (org-roam-message "Updated: %s" file-path))))
+
+(defun org-roam-db--update-files (modified-files)
+  "Update Org-roam cache for a list of MODIFIED-FILES.
+FILES is a list of (file . hash) pairs."
+  (let* ((gc-cons-threshold org-roam-db-gc-threshold)
+         (org-agenda-files nil)
+         (error-count 0)
+         (id-count 0)
+         (link-count 0)
+         (tag-count 0)
+         (title-count 0)
+         (ref-count 0)
+         (modified-count 0))
+    (pcase-dolist (`(,file . _) modified-files)
+      (org-roam-db--clear-file file))
+    ;; Process all the files for IDs first
+    ;;
+    ;; We do this so that link extraction is cheaper: this eliminates the need
+    ;; to read the file to check if the ID really exists
+    (pcase-dolist (`(,file . ,contents-hash) modified-files)
+      (let* ((attr (file-attributes file))
+             (atime (file-attribute-access-time attr))
+             (mtime (file-attribute-modification-time attr)))
+        (condition-case nil
+            (org-roam--with-temp-buffer file
+              (org-roam-db-query
+               [:insert :into files
+                :values $v1]
+               (vector file contents-hash (list :atime atime :mtime mtime)))
+              (when org-roam-enable-headline-linking
+                (setq id-count (+ id-count (org-roam-db--insert-ids)))))
+          (file-error
+           (setq error-count (1+ error-count))
+           (org-roam-db--clear-file file)
+           (lwarn '(org-roam) :warning
+                  "Skipping unreadable file while building cache: %s" file)))))
+
+    ;; Process titles, tags, links and ref links of file
+    (pcase-dolist (`(,file . _) modified-files)
+      (org-roam-message "Processed %s/%s modified files..." modified-count (length modified-files))
+      (condition-case nil
+          (org-roam--with-temp-buffer file
+            (setq modified-count (1+ modified-count))
+            (setq link-count (+ link-count (org-roam-db--insert-links)))
+            (setq tag-count (+ tag-count (org-roam-db--insert-tags)))
+            (setq title-count (+ title-count (org-roam-db--insert-titles)))
+            (setq ref-count (+ ref-count (org-roam-db--insert-refs))))
+        (file-error
+         (setq error-count (1+ error-count))
+         (org-roam-db--clear-file file)
+         (lwarn '(org-roam) :warning
+                "Skipping unreadable file while building cache: %s" file))))
+    (list :error-count error-count :modified-count modified-count :id-count id-count :title-count title-count :tag-count tag-count :link-count link-count :ref-count ref-count)))
+
+(defun org-roam-db-update ()
+  "Update the database."
+  (pcase org-roam-db-update-method
+    ('immediate
+     (org-roam-db-update-file (buffer-file-name (buffer-base-buffer))))
+    ('idle-timer
+     (org-roam-db-mark-dirty))
+    (_
+     (user-error "Invalid `org-roam-db-update-method'"))))
+
+(provide 'org-roam-db)
+
+;;; org-roam-db.el ends here

org-roam-dev.el

@@ -0,0 +1,46 @@
+;;; org-roam-dev.el --- Org-roam development code -mode -*- coding: utf-8; lexical-binding: t; -*-
+
+;; Copyright © 2020 Jethro Kuan <jethrokuan95@gmail.com>
+
+;; Author: Jethro Kuan <jethrokuan95@gmail.com>
+;; URL: https://github.com/org-roam/org-roam
+;; Keywords: org-mode, roam, convenience
+;; Version: 1.2.3
+;; Package-Requires: ((emacs "26.1") (dash "2.13") (f "0.17.2") (s "1.12.0") (org "9.3") (emacsql "3.0.0") (emacsql-sqlite3 "1.0.2"))
+
+;; This file is NOT part of GNU Emacs.
+
+;; This program is free software; you can redistribute it and/or modify
+;; it under the terms of the GNU General Public License as published by
+;; the Free Software Foundation; either version 3, or (at your option)
+;; any later version.
+;;
+;; This program is distributed in the hope that it will be useful,
+;; but WITHOUT ANY WARRANTY; without even the implied warranty of
+;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+;; GNU General Public License for more details.
+;;
+;; You should have received a copy of the GNU General Public License
+;; along with GNU Emacs; see the file COPYING.  If not, write to the
+;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
+;; Boston, MA 02110-1301, USA.
+
+;;; Commentary:
+;;
+;; This library provides code for org-roam developers.
+;; It is intended to be loaded before editing org-roam source files.
+;; It ensures consistent application of various developer settings.
+;;
+;;; Code:
+(require 'emacsql)
+
+;;;###autoload
+(define-minor-mode org-roam-dev-mode
+  "Minor mode for setting the dev environment of Org-roam."
+  :lighter " ORD"
+  (when org-roam-dev-mode
+    (emacsql-fix-vector-indentation)
+    (setq-local sentence-end-double-space nil)))
+
+(provide 'org-roam-dev)
+;;; org-roam-dev.el ends here

org-roam-doctor.el

@@ -0,0 +1,317 @@
+;;; org-roam-doctor.el --- Linter for Org-roam files -*- coding: utf-8; lexical-binding: t; -*-
+;;
+;; Copyright © 2020 Jethro Kuan <jethrokuan95@gmail.com>
+
+;; Author: Jethro Kuan <jethrokuan95@gmail.com>
+;; URL: https://github.com/jethrokuan/org-roam
+;; Keywords: org-mode, roam, convenience
+;; Version: 1.2.3
+;; Package-Requires: ((emacs "26.1") (dash "2.13") (f "0.17.2") (s "1.12.0") (org "9.3") (emacsql "3.0.0") (emacsql-sqlite3 "1.0.2"))
+
+;; This file is NOT part of GNU Emacs.
+
+;; This program is free software; you can redistribute it and/or modify
+;; it under the terms of the GNU General Public License as published by
+;; the Free Software Foundation; either version 3, or (at your option)
+;; any later version.
+;;
+;; This program is distributed in the hope that it will be useful,
+;; but WITHOUT ANY WARRANTY; without even the implied warranty of
+;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+;; GNU General Public License for more details.
+;;
+;; You should have received a copy of the GNU General Public License
+;; along with GNU Emacs; see the file COPYING.  If not, write to the
+;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
+;; Boston, MA 02110-1301, USA.
+
+
+;;; Commentary:
+;;
+;; This library provides `org-roam-doctor', a utility for diagnosing and fixing
+;; Org-roam files. Running `org-roam-doctor' launches a list of checks defined
+;; by `org-roam-doctor--checkers'. Every checker is an instance of
+;; `org-roam-doctor-checker'.
+;;
+;; Each checker is given the Org parse tree (AST), and is expected to return a
+;; list of errors. The checker can also provide "actions" for auto-fixing errors
+;; (see `org-roam-doctor--remove-link' for an example).
+;;
+;; The UX experience is inspired by both org-lint and checkdoc, and their code
+;; is heavily referenced.
+;;
+;;; Code:
+;; Library Requires
+(require 'cl-lib)
+(require 'org)
+(require 'org-element)
+(require 's)
+(require 'dash)
+(require 'org-roam-macs)
+
+(declare-function org-roam-insert "org-roam")
+(declare-function org-roam--get-roam-buffers "org-roam")
+(declare-function org-roam--list-all-files "org-roam")
+(declare-function org-roam--org-roam-file-p "org-roam")
+(declare-function org-roam-mode "org-roam")
+
+(defvar org-roam-verbose)
+(defvar org-roam-mode)
+
+(defcustom org-roam-doctor-inhibit-startup t
+  "Inhibit `org-mode' startup when processing files with `org-doctor'.
+When non-nil, images and LaTeX preview will not be generated,
+tables will not be aligned, and headlines will not respect
+startup visability. This significantly improves performance when
+processing multiple files"
+  :type 'boolean
+  :group 'org-roam)
+
+(cl-defstruct (org-roam-doctor-checker (:copier nil))
+  (name 'missing-checker-name)
+  (description "")
+  (actions nil))
+
+(defconst org-roam-doctor--checkers
+  (list
+   (make-org-roam-doctor-checker
+    :name 'org-roam-doctor-broken-links
+    :description "Fix broken links."
+    :actions '(("d" . ("Unlink" . org-roam-doctor--remove-link))
+               ("r" . ("Replace link" . org-roam-doctor--replace-link))
+               ("R" . ("Replace link (keep label)" . org-roam-doctor--replace-link-keep-label))))
+   (make-org-roam-doctor-checker
+    :name 'org-roam-doctor-check-roam-props
+    :description "Check #+roam_* properties.")
+   (make-org-roam-doctor-checker
+    :name 'org-roam-doctor-check-tags
+    :description "Check #+roam_tags.")
+   (make-org-roam-doctor-checker
+    :name 'org-roam-doctor-check-alias
+    :description "Check #+roam_alias.")))
+
+(defconst org-roam-doctor--supported-roam-properties
+  '("roam_tags" "roam_alias" "roam_key")
+  "List of supported Org-roam properties.")
+
+(defun org-roam-doctor-check-roam-props (ast)
+  "Checker for detecting invalid #+roam_* properties.
+AST is the org-element parse tree."
+  (let (reports)
+    (org-element-map ast 'keyword
+      (lambda (kw)
+        (let ((key (org-element-property :key kw)))
+          (when (and (string-prefix-p "ROAM_" key t)
+                     (not (member (downcase key) org-roam-doctor--supported-roam-properties)))
+            (push
+             `(,(org-element-property :begin kw)
+               ,(concat "Possible mispelled key: "
+                        (prin1-to-string key)
+                        "\nOrg-roam supports the following keys: "
+                        (s-join ", " org-roam-doctor--supported-roam-properties)))
+             reports)))))
+    reports))
+
+(defun org-roam-doctor-check-tags (ast)
+  "Checker for detecting invalid #+roam_tags.
+AST is the org-element parse tree."
+  (let (reports)
+    (org-element-map ast 'keyword
+      (lambda (kw)
+        (when (string-collate-equalp (org-element-property :key kw) "roam_tags" nil t)
+          (let ((tags (org-element-property :value kw)))
+            (condition-case nil
+                (split-string-and-unquote tags)
+              (error
+               (push
+                `(,(org-element-property :begin kw)
+                  ,(concat "Unable to parse tags: "
+                           tags
+                           (when (s-contains? "," tags)
+                             "\nCheck that your tags are not comma-separated.")))
+                reports)))))))
+    reports))
+
+(defun org-roam-doctor-check-alias (ast)
+  "Checker for detecting invalid #+roam_alias.
+AST is the org-element parse tree."
+  (let (reports)
+    (org-element-map ast 'keyword
+      (lambda (kw)
+        (when (string-collate-equalp (org-element-property :key kw) "roam_alias" nil t)
+          (let ((aliases (org-element-property :value kw)))
+            (condition-case nil
+              (split-string-and-unquote aliases)
+              (error
+               (push
+                `(,(org-element-property :begin kw)
+                  ,(concat "Unable to parse aliases: "
+                           aliases
+                           (when (s-contains? "," aliases)
+                             "\nCheck that your aliases are not comma-separated.")))
+                reports)))))))
+    reports))
+
+(defun org-roam-doctor-broken-links (ast)
+  "Checker for detecting broken links.
+AST is the org-element parse tree."
+  (let (reports)
+    (org-element-map ast 'link
+      (lambda (l)
+        (when (equal "file" (org-element-property :type l))
+          (let ((file (org-element-property :path l)))
+            (or (file-exists-p file)
+                (file-remote-p file)
+                (push
+                 `(,(org-element-property :begin l)
+                   ,(format (if (org-element-lineage l '(link))
+                                "Link to non-existent image file \"%s\"\
+ in link description"
+                              "Link to non-existent local file \"%s\"")
+                            file))
+                 reports))))))
+    reports))
+
+(defun org-roam-doctor--check (buffer checkers)
+  "Check BUFFER for errors.
+CHECKERS is the list of checkers used."
+  (with-current-buffer buffer
+    (save-excursion
+      (goto-char (point-min))
+      (let* ((ast (org-element-parse-buffer))
+             (errors (sort (cl-mapcan
+                            (lambda (c)
+                              (mapcar
+                               (lambda (report)
+                                 (list (set-marker (make-marker) (car report))
+                                       (nth 1 report) c))
+                               (save-excursion
+                                 (funcall
+                                  (org-roam-doctor-checker-name c)
+                                  ast))))
+                            checkers)
+                           #'car-less-than-car)))
+        (dolist (e errors)
+          (pcase-let ((`(,m ,msg ,checker) e))
+            (switch-to-buffer buffer)
+            (goto-char m)
+            (org-reveal)
+            (undo-boundary)
+            (org-roam-doctor--resolve msg checker)
+            (set-marker m nil)))
+        errors))))
+
+;;; Actions
+(defun org-roam-doctor--recursive-edit ()
+  "Launch into a recursive edit."
+  (message "When you're done editing press C-M-c to continue.")
+  (recursive-edit))
+
+(defun org-roam-doctor--skip ()
+  "Skip the current error."
+  (org-roam-message "Skipping..."))
+
+(defun org-roam-doctor--replace-link ()
+  "Replace the current link with a new link."
+  (save-match-data
+    (unless (org-in-regexp org-link-bracket-re 1)
+      (user-error "No link at point"))
+    (let ((orig (buffer-string))
+          (p (point)))
+      (condition-case nil
+          (save-excursion
+            (replace-match "")
+            (org-roam-insert))
+        (quit (progn
+                (replace-buffer-contents orig)
+                (goto-char p)))))))
+
+(defun org-roam-doctor--replace-link-keep-label ()
+  "Replace the current link with a new link, keeping the current link's label."
+  (save-match-data
+    (unless (org-in-regexp org-link-bracket-re 1)
+      (user-error "No link at point"))
+    (let ((orig (buffer-string))
+          (p (point)))
+      (condition-case nil
+          (save-excursion
+            (let ((label (if (match-end 2)
+                             (match-string-no-properties 2)
+                           (org-link-unescape (match-string-no-properties 1)))))
+              (replace-match "")
+              (org-roam-insert nil nil label)))
+        (quit (progn
+                (replace-buffer-contents orig)
+                (goto-char p)))))))
+
+(defun org-roam-doctor--remove-link ()
+  "Unlink the text at point."
+  (unless (org-in-regexp org-link-bracket-re 1)
+    (user-error "No link at point"))
+  (save-excursion
+    (let ((label (if (match-end 2)
+                     (match-string-no-properties 2)
+                   (org-link-unescape (match-string-no-properties 1)))))
+      (delete-region (match-beginning 0) (match-end 0))
+      (insert label))))
+
+(defun org-roam-doctor--resolve (msg checker)
+  "Resolve an error.
+MSG is the error that was found, which is displayed in a help buffer.
+CHECKER is a org-roam-doctor checker instance."
+  (let ((actions (org-roam-doctor-checker-actions checker))
+        c)
+    (push '("e" . ("Edit" . org-roam-doctor--recursive-edit)) actions)
+    (push '("s" . ("Skip" . org-roam-doctor--skip)) actions)
+    (with-output-to-temp-buffer "*Org-roam-doctor Help*"
+      (mapc #'princ
+            (list "Error message:\n   " msg "\n\n"))
+      (dolist (action actions)
+        (princ (format "[%s]: %s\n"
+                       (car action)
+                       (cadr action))))
+      (princ "\n\n"))
+    (shrink-window-if-larger-than-buffer
+     (get-buffer-window "*Org-roam-doctor Help*"))
+    (message "Press key for command:")
+    (unwind-protect
+        (progn
+          (cl-loop
+           do (setq c (char-to-string (read-char-exclusive)))
+           until (assoc c actions)
+           do (message "Please enter a valid key for command:"))
+          (funcall (cddr (assoc c actions)))
+          (redisplay))
+      (when (get-buffer-window "*Org-roam-doctor Help*")
+        (delete-window (get-buffer-window "*Org-roam-doctor Help*"))
+        (kill-buffer "*Org-roam-doctor Help*")))))
+
+;;;###autoload
+(defun org-roam-doctor (&optional checkall)
+  "Perform a check on the current buffer to ensure cleanliness.
+If CHECKALL, run the check for all Org-roam files."
+  (interactive "P")
+  (unless org-roam-mode (org-roam-mode))
+  (let ((files (if checkall
+                  (org-roam--list-all-files)
+                (unless (org-roam--org-roam-file-p)
+                  (user-error "Not in an org-roam file"))
+                `(,(buffer-file-name)))))
+    (org-roam-doctor-start files org-roam-doctor--checkers)))
+
+(defun org-roam-doctor-start (files checkers)
+  "Lint FILES using CHECKERS."
+  (save-window-excursion
+    (let ((existing-buffers (org-roam--get-roam-buffers))
+          (org-inhibit-startup org-roam-doctor-inhibit-startup))
+      (dolist (f files)
+        (let ((buf (find-file-noselect f)))
+          (org-roam-doctor--check buf checkers)
+          (unless (memq buf existing-buffers)
+            (save-buffer buf)
+            (kill-buffer buf))))))
+  (org-roam-message "Linting completed."))
+
+(provide 'org-roam-doctor)
+
+;;; org-roam-doctor.el ends here

org-roam-faces.el

@@ -0,0 +1,77 @@
+;;; org-roam-faces.el --- Face definitions -*- coding: utf-8; lexical-binding: t; -*-
+
+;; Copyright © 2020 Jethro Kuan <jethrokuan95@gmail.com>
+
+;; Author: Jethro Kuan <jethrokuan95@gmail.com>
+;; URL: https://github.com/org-roam/org-roam
+;; Keywords: org-mode, roam, convenience
+;; Version: 1.2.3
+;; Package-Requires: ((emacs "26.1"))
+
+;; This file is NOT part of GNU Emacs.
+
+;; This program is free software; you can redistribute it and/or modify
+;; it under the terms of the GNU General Public License as published by
+;; the Free Software Foundation; either version 3, or (at your option)
+;; any later version.
+;;
+;; This program is distributed in the hope that it will be useful,
+;; but WITHOUT ANY WARRANTY; without even the implied warranty of
+;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+;; GNU General Public License for more details.
+;;
+;; You should have received a copy of the GNU General Public License
+;; along with GNU Emacs; see the file COPYING.  If not, write to the
+;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
+;; Boston, MA 02110-1301, USA.
+
+;;; Commentary:
+
+;; This file contains the face definitions for Org-roam.
+
+;;; Code:
+
+(defgroup org-roam-faces nil
+  "Faces used by Org-roam."
+  :group 'org-roam
+  :group 'faces)
+
+;;; Definitions
+(defface org-roam-link
+  '((t :inherit org-link))
+  "Face for Org-roam links."
+  :group 'org-roam-faces)
+
+(defface org-roam-tag
+  '((t :weight bold))
+  "Face for Org-roam tags in minibuffer commands."
+  :group 'org-roam-faces)
+
+(defface org-roam-link-current
+  '((t :inherit org-link))
+  "Face for Org-roam links pointing to the current buffer."
+  :group 'org-roam-faces)
+
+(defface org-roam-link-invalid
+  '((t :inherit (error org-link)))
+  "Face for Org-roam links that are not valid.
+This face is used for links without a destination."
+  :group 'org-roam-faces)
+
+(defface org-roam-link-shielded
+  '((t :inherit (warning org-link)))
+  "Face for Org-roam links that are shielded.
+This face is used on the region target by `org-roam-insertion'
+during an `org-roam-capture'."
+  :group 'org-roam-faces)
+
+(defface org-roam-dailies-calendar-note
+  '((t :inherit (org-roam-link) :underline nil))
+  "Face for dates with a daily-note in the calendar"
+  :group 'org-roam-faces)
+
+;;; _
+
+(provide 'org-roam-faces)
+
+;;; org-roam-faces.el ends here

org-roam-graph.el

@@ -0,0 +1,309 @@
+;;; org-roam-graph.el --- Graphing API -*- coding: utf-8; lexical-binding: t; -*-
+
+;; Copyright © 2020 Jethro Kuan <jethrokuan95@gmail.com>
+
+;; Author: Jethro Kuan <jethrokuan95@gmail.com>
+;; URL: https://github.com/org-roam/org-roam
+;; Keywords: org-mode, roam, convenience
+;; Version: 1.2.3
+;; Package-Requires: ((emacs "26.1") (dash "2.13") (f "0.17.2") (s "1.12.0") (org "9.3") (emacsql "3.0.0") (emacsql-sqlite3 "1.0.2"))
+
+;; This file is NOT part of GNU Emacs.
+
+;; This program is free software; you can redistribute it and/or modify
+;; it under the terms of the GNU General Public License as published by
+;; the Free Software Foundation; either version 3, or (at your option)
+;; any later version.
+;;
+;; This program is distributed in the hope that it will be useful,
+;; but WITHOUT ANY WARRANTY; without even the implied warranty of
+;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+;; GNU General Public License for more details.
+;;
+;; You should have received a copy of the GNU General Public License
+;; along with GNU Emacs; see the file COPYING.  If not, write to the
+;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
+;; Boston, MA 02110-1301, USA.
+
+;;; Commentary:
+;;
+;; This library provides graphing functionality for org-roam.
+;;
+;;; Code:
+(require 'xml) ;xml-escape-string
+(require 's)   ;s-truncate, s-replace
+(eval-and-compile
+  (require 'org-roam-macs))
+(require 'org-roam-db)
+
+;;;; Declarations
+(defvar org-roam-directory)
+(defvar org-roam-mode)
+(declare-function org-roam--org-roam-file-p  "org-roam")
+(declare-function org-roam--path-to-slug     "org-roam")
+(declare-function org-roam-mode              "org-roam")
+
+;;;; Options
+(defcustom org-roam-graph-viewer (executable-find "firefox")
+  "Method to view the org-roam graph.
+It may be one of the following:
+  - a string representing the path to the executable for viewing the graph.
+  - a function accepting a single argument: the graph file path.
+  - nil uses `view-file' to view the graph."
+  :type '(choice
+          (string   :tag "Path to executable")
+          (function :tag "Function to display graph" eww-open-file)
+          (const    :tag "view-file"))
+  :group 'org-roam)
+
+(defcustom org-roam-graph-executable "dot"
+  "Path to graphing executable, or its name."
+  :type 'string
+  :group 'org-roam)
+
+(defcustom org-roam-graph-extra-config nil
+  "Extra options passed to graphviz.
+Example:
+ '((\"rankdir\" . \"LR\"))"
+  :type '(alist)
+  :group 'org-roam)
+
+(defcustom org-roam-graph-node-extra-config
+  '(("shape"      . "underline")
+    ("style"      . "rounded,filled")
+    ("fillcolor"  . "#EEEEEE")
+    ("color"      . "#C9C9C9")
+    ("fontcolor"  . "#111111"))
+  "Extra options for graphviz nodes.
+Example:
+ '((\"color\" . \"skyblue\"))"
+  :type '(alist)
+  :group 'org-roam)
+
+(defcustom org-roam-graph-edge-extra-config
+  '(("color" . "#333333"))
+  "Extra options for graphviz edges.
+Example:
+ '((\"dir\" . \"back\"))"
+  :type '(alist)
+  :group 'org-roam)
+
+(defcustom org-roam-graph-edge-cites-extra-config '(("color" . "red"))
+  "Extra options for graphviz edges for citation links.
+Example:
+ '((\"dir\" . \"back\"))"
+  :type '(alist)
+  :group 'org-roam)
+
+(defcustom org-roam-graph-max-title-length 100
+  "Maximum length of titles in graph nodes."
+  :type 'number
+  :group 'org-roam)
+
+(defcustom org-roam-graph-shorten-titles 'truncate
+  "Determines how long titles appear in graph nodes.
+Recognized values are the symbols `truncate' and `wrap', in which
+cases the title will be truncated or wrapped, respectively, if it
+is longer than `org-roam-graph-max-title-length'.
+
+All other values including nil will have no effect."
+  :type '(choice
+          (const :tag "truncate" truncate)
+          (const :tag "wrap" wrap)
+          (const :tag "no" nil))
+  :group 'org-roam)
+
+(defcustom org-roam-graph-exclude-matcher nil
+  "Matcher for excluding nodes from the generated graph.
+Any nodes and links for file paths matching this string is
+excluded from the graph.
+
+If value is a string, the string is the only matcher.
+
+If value is a list, all file paths matching any of the strings
+are excluded."
+  :type '(choice
+          (string :tag "Matcher")
+          (list :tag "Matchers"))
+  :group 'org-roam)
+
+;;;; Functions
+(defun org-roam-graph--expand-matcher (col &optional negate where)
+  "Return the exclusion regexp from `org-roam-graph-exclude-matcher'.
+COL is the symbol to be matched against.  if NEGATE, add :not to sql query.
+set WHERE to true if WHERE query already exists."
+  (let ((matchers (pcase org-roam-graph-exclude-matcher
+                    ('nil nil)
+                    ((pred stringp) `(,(concat "%" org-roam-graph-exclude-matcher "%")))
+                    ((pred listp) (mapcar (lambda (m)
+                                            (concat "%" m "%"))
+                                          org-roam-graph-exclude-matcher))
+                    (_ (error "Invalid org-roam-graph-exclude-matcher"))))
+        res)
+    (dolist (match matchers)
+      (if where
+          (push :and res)
+        (push :where res)
+        (setq where t))
+      (push col res)
+      (when negate
+        (push :not res))
+      (push :like res)
+      (push match res))
+    (nreverse res)))
+
+(defun org-roam-graph--dot-option (option &optional wrap-key wrap-val)
+  "Return dot string of form KEY=VAL for OPTION cons.
+If WRAP-KEY is non-nil it wraps the KEY.
+If WRAP-VAL is non-nil it wraps the VAL."
+  (concat wrap-key (car option) wrap-key
+          "="
+          wrap-val (cdr option) wrap-val))
+
+(defun org-roam-graph--dot (node-query)
+  "Build the graphviz dot string for NODE-QUERY.
+The Org-roam database titles table is read, to obtain the list of titles.
+The links table is then read to obtain all directed links, and formatted
+into a digraph."
+  (org-roam-db--ensure-built)
+  (org-roam--with-temp-buffer nil
+    (let* ((nodes (org-roam-db-query node-query))
+           (edges-query
+            `[:with selected :as [:select [file] :from ,node-query]
+              :select :distinct [dest source] :from links
+              :where (and (in dest selected) (in source selected))])
+           (edges-cites-query
+            `[:with selected :as [:select [file] :from ,node-query]
+              :select :distinct [file source]
+              :from links :inner :join refs :on (and (= links:dest refs:ref)
+                                                     (= links:type "cite")
+                                                     (= refs:type "cite"))
+              :where (and (in file selected) (in source selected))])
+           (edges       (org-roam-db-query edges-query))
+           (edges-cites (org-roam-db-query edges-cites-query)))
+      (insert "digraph \"org-roam\" {\n")
+      (dolist (option org-roam-graph-extra-config)
+        (insert (org-roam-graph--dot-option option) ";\n"))
+      (dolist (attribute '("node" "edge"))
+        (insert (format " %s [%s];\n" attribute
+                        (mapconcat (lambda (var)
+                                     (org-roam-graph--dot-option var nil "\""))
+                                   (symbol-value
+                                    (intern (concat "org-roam-graph-" attribute "-extra-config")))
+                                   ","))))
+      (dolist (node nodes)
+        (let* ((file (xml-escape-string (car node)))
+               (title (or (cadr node)
+                          (org-roam--path-to-slug file)))
+               (shortened-title (pcase org-roam-graph-shorten-titles
+                                  (`truncate (s-truncate org-roam-graph-max-title-length title))
+                                  (`wrap (s-word-wrap org-roam-graph-max-title-length title))
+                                  (_ title)))
+               (shortened-title (org-roam-string-quote shortened-title))
+               (title (org-roam-string-quote title))
+               (node-properties
+                `(("label"   . ,shortened-title)
+                  ("URL"     . ,(concat "org-protocol://roam-file?file=" (url-hexify-string file)))
+                  ("tooltip" . ,(xml-escape-string title)))))
+          (insert
+           (format "  \"%s\" [%s];\n" file
+                   (mapconcat (lambda (n)
+                                (org-roam-graph--dot-option n nil "\""))
+                              node-properties ",")))))
+      (dolist (edge edges)
+        (insert (apply #'format `("  \"%s\" -> \"%s\";\n"
+                                  ,@(mapcar #'xml-escape-string edge)))))
+      (insert (format "  edge [%s];\n"
+                      (mapconcat #'org-roam-graph--dot-option
+                                 org-roam-graph-edge-cites-extra-config ",")))
+      (dolist (edge edges-cites)
+        (insert (apply #'format `("  \"%s\" -> \"%s\";\n"
+                                  ,@(mapcar #'xml-escape-string edge)))))
+      (insert "}")
+      (buffer-string))))
+
+(defun org-roam-graph--build (&optional node-query callback)
+  "Generate a graph showing the relations between nodes in NODE-QUERY.
+Execute CALLBACK when process exits successfully.
+CALLBACK is passed the graph file as its sole argument."
+  (unless (stringp org-roam-graph-executable)
+    (user-error "`org-roam-graph-executable' is not a string"))
+  (unless (executable-find org-roam-graph-executable)
+    (user-error (concat "Cannot find executable \"%s\" to generate the graph.  "
+                        "Please adjust `org-roam-graph-executable'")
+                org-roam-graph-executable))
+  (let* ((node-query (or node-query
+                         `[:select [file title] :from titles
+                           ,@(org-roam-graph--expand-matcher 'file t)
+                           :group :by file]))
+         (graph      (org-roam-graph--dot node-query))
+         (temp-dot   (make-temp-file "graph." nil ".dot" graph))
+         (temp-graph (make-temp-file "graph." nil ".svg")))
+    (org-roam-message "building graph")
+    (make-process
+     :name "*org-roam-graph--build-process*"
+     :buffer "*org-roam-graph--build-process*"
+     :command `(,org-roam-graph-executable ,temp-dot "-Tsvg" "-o" ,temp-graph)
+     :sentinel (when callback
+                 (lambda (process _event)
+                   (when (= 0 (process-exit-status process))
+                     (funcall callback temp-graph)))))))
+
+(defun org-roam-graph--open (file)
+  "Open FILE using `org-roam-graph-viewer' with `view-file' as a fallback."
+  (pcase org-roam-graph-viewer
+    ((pred stringp)
+     (if (executable-find org-roam-graph-viewer)
+         (condition-case err
+             (call-process org-roam-graph-viewer nil 0 nil file)
+           (error (user-error "Failed to open org-roam graph: %s" err)))
+       (user-error "Executable not found: \"%s\"" org-roam-graph-viewer)))
+    ((pred functionp) (funcall org-roam-graph-viewer file))
+    ('nil (view-file file))
+    (_ (signal 'wrong-type-argument `((functionp stringp null) ,org-roam-graph-viewer)))))
+
+(defun org-roam-graph--build-connected-component (file &optional max-distance callback)
+  "Build a graph of nodes connected to FILE.
+If MAX-DISTANCE is non-nil, limit nodes to MAX-DISTANCE steps.
+CALLBACK is passed to `org-roam-graph--build'."
+  (let* ((file (expand-file-name file))
+         (files (or (if (and max-distance (>= max-distance 0))
+                        (org-roam-db--links-with-max-distance file max-distance)
+                      (org-roam-db--connected-component file))
+                    (list file)))
+         (query `[:select [file title]
+                  :from titles
+                  :where (in file [,@files])]))
+    (org-roam-graph--build query callback)))
+
+;;;; Commands
+;;;###autoload
+(defun org-roam-graph (&optional arg file node-query)
+  "Build and possibly display a graph for FILE from NODE-QUERY.
+If FILE is nil, default to current buffer's file name.
+ARG may be any of the following values:
+  - nil       show the graph.
+  - `\\[universal-argument]'     show the graph for FILE.
+  - `\\[universal-argument]' N   show the graph for FILE limiting nodes to N steps.
+  - `\\[universal-argument] \\[universal-argument]' build the graph.
+  - `\\[universal-argument]' -   build the graph for FILE.
+  - `\\[universal-argument]' -N  build the graph for FILE limiting nodes to N steps."
+  (interactive "P")
+  (unless org-roam-mode (org-roam-mode))
+  (let ((file (or file (buffer-file-name (buffer-base-buffer)))))
+    (unless (or (not arg) (equal arg '(16)))
+      (unless file
+        (user-error "Cannot build graph for nil file. Is current buffer visiting a file?"))
+      (unless (org-roam--org-roam-file-p file)
+        (user-error "\"%s\" is not an org-roam file" file)))
+    (pcase arg
+      ('nil            (org-roam-graph--build node-query #'org-roam-graph--open))
+      ('(4)            (org-roam-graph--build-connected-component file nil #'org-roam-graph--open))
+      ((pred integerp) (org-roam-graph--build-connected-component file (abs arg) (when (>= arg 0) #'org-roam-graph--open)))
+      ('(16)           (org-roam-graph--build node-query))
+      ('-              (org-roam-graph--build-connected-component file))
+      (_ (user-error "Unrecognized ARG: %s" arg)))))
+
+(provide 'org-roam-graph)
+
+;;; org-roam-graph.el ends here

org-roam-link.el

@@ -0,0 +1,324 @@
+;;; org-roam-link.el --- Custom links for Org-roam -*- coding: utf-8; lexical-binding: t; -*-
+
+;; Copyright © 2020 Jethro Kuan <jethrokuan95@gmail.com>
+;;                  Alan Carroll
+
+;; Author: Jethro Kuan <jethrokuan95@gmail.com>
+;; URL: https://github.com/org-roam/org-roam
+;; Keywords: org-mode, roam, convenience
+;; Version: 1.2.3
+;; Package-Requires: ((emacs "26.1") (dash "2.13") (f "0.17.2") (s "1.12.0") (org "9.3") (emacsql "3.0.0") (emacsql-sqlite3 "1.0.2"))
+
+;; This file is NOT part of GNU Emacs.
+
+;; This program is free software; you can redistribute it and/or modify
+;; it under the terms of the GNU General Public License as published by
+;; the Free Software Foundation; either version 3, or (at your option)
+;; any later version.
+;;
+;; This program is distributed in the hope that it will be useful,
+;; but WITHOUT ANY WARRANTY; without even the implied warranty of
+;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+;; GNU General Public License for more details.
+;;
+;; You should have received a copy of the GNU General Public License
+;; along with GNU Emacs; see the file COPYING.  If not, write to the
+;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
+;; Boston, MA 02110-1301, USA.
+
+;;; Commentary:
+;;
+;; This adds the custom `roam:' link to Org-roam. `roam:' links allow linking to
+;; Org-roam files via their titles and headlines.
+;;
+;;; Code:
+;;;; Dependencies
+
+(require 'ol)
+(require 'org-roam-compat)
+(require 'org-roam-macs)
+(require 'org-roam-db)
+
+(require 'org-element)
+
+(defvar org-roam-completion-ignore-case)
+(defvar org-roam-directory)
+(declare-function  org-roam--find-file                  "org-roam")
+(declare-function  org-roam-find-file                   "org-roam")
+(declare-function org-roam-format-link                  "org-roam")
+
+(defcustom org-roam-link-auto-replace t
+  "When non-nil, replace Org-roam's roam links with file or id links whenever possible."
+  :group 'org-roam
+  :type 'boolean)
+
+(defcustom org-roam-link-file-path-type 'relative
+  "How the path name in file links should be stored.
+Valid values are:
+
+relative  Relative to the current directory, i.e. the directory of the file
+          into which the link is being inserted.
+absolute  Absolute path, if possible with ~ for home directory.
+noabbrev  Absolute path, no abbreviation of home directory."
+  :group 'org-roam
+  :type '(choice
+          (const relative)
+          (const absolute)
+          (const noabbrev))
+  :safe #'symbolp)
+
+;;; the roam: link
+(org-link-set-parameters "roam"
+                         :follow #'org-roam-link-follow-link)
+
+(defun org-roam-link-follow-link (_path)
+  "Navigates to location in Org-roam link.
+This function is called by Org when following links of the type
+`roam'. While the path is passed, assume that the cursor is on
+the link."
+  (pcase-let ((`(,link-type ,loc ,desc ,mkr) (org-roam-link--get-location)))
+    (when (and org-roam-link-auto-replace loc desc)
+      (org-roam-link--replace-link link-type loc desc))
+    (pcase link-type
+      ("file"
+       (if loc
+           (org-roam--find-file loc)
+         (org-roam-find-file desc nil nil t)))
+      ("id"
+       (org-goto-marker-or-bmk mkr)))))
+
+;;; Retrieval Functions
+(defun org-roam-link--get-titles ()
+  "Return all titles within Org-roam."
+  (mapcar #'car (org-roam-db-query [:select [titles:title] :from titles])))
+
+(defun org-roam-link--get-headlines (&optional file with-marker use-stack)
+  "Return all outline headings for the current buffer.
+If FILE, return outline headings for passed FILE instead.
+If WITH-MARKER, return a cons cell of (headline . marker).
+If USE-STACK, include the parent paths as well."
+  (org-roam-with-file file (when with-marker 'keep)
+    (let* ((outline-level-fn outline-level)
+           (path-separator "/")
+           (stack-level 0)
+           stack cands name level marker)
+      (save-excursion
+        (goto-char (point-min))
+        (while (re-search-forward org-complex-heading-regexp nil t)
+          (save-excursion
+            (setq name (substring-no-properties (or (match-string 4) "")))
+            (setq marker (point-marker))
+            (when use-stack
+              (goto-char (match-beginning 0))
+              (setq level (funcall outline-level-fn))
+              ;; Update stack.  The empty entry guards against incorrect
+              ;; headline hierarchies, e.g. a level 3 headline
+              ;; immediately following a level 1 entry.
+              (while (<= level stack-level)
+                (pop stack)
+                (cl-decf stack-level))
+              (while (> level stack-level)
+                (push name stack)
+                (cl-incf stack-level))
+              (setq name (mapconcat #'identity
+                                    (reverse stack)
+                                    path-separator)))
+            (push (if with-marker
+                      (cons name marker)
+                    name) cands))))
+      (nreverse cands))))
+
+
+(defun org-roam-link--get-file-from-title (title &optional no-interactive)
+  "Return the file path corresponding to TITLE.
+When NO-INTERACTIVE, return nil if there are multiple options."
+  (let ((files (mapcar #'car (org-roam-db-query [:select [titles:file] :from titles
+                                                 :where (= titles:title $v1)]
+                                                (vector title)))))
+    (pcase files
+      ('nil nil)
+      (`(,file) file)
+      (_
+       (unless no-interactive
+         (completing-read "Select file: " files))))))
+
+(defun org-roam-link--get-id-from-headline (headline &optional file)
+  "Return (marker . id) correspondng to HEADLINE in FILE.
+If FILE is nil, get ID from current buffer.
+If there is no corresponding headline, return nil."
+  (save-excursion
+    (org-roam-with-file file 'keep
+      (let ((headlines (org-roam-link--get-headlines file 'with-markers)))
+        (when-let ((marker (cdr (assoc-string headline headlines))))
+          (goto-char marker)
+          (cons marker
+                (when org-roam-link-auto-replace
+                  (org-id-get-create))))))))
+
+;;; Path-related functions
+(defun org-roam-link-get-path (path &optional type)
+  "Return the PATH of the link to use.
+If TYPE is non-nil, create a link of TYPE. Otherwise, respect
+`org-link-file-path-type'."
+  (pcase (or type org-roam-link-file-path-type)
+      ('absolute
+       (abbreviate-file-name (expand-file-name path)))
+      ('noabbrev
+       (expand-file-name path))
+      ('relative
+       (file-relative-name path))))
+
+(defun org-roam-link--split-path (path)
+  "Splits PATH into title and headline.
+Return a list of the form (type title has-headline-p headline star-idx).
+type is one of `title', `headline', `title+headline'.
+title is the title component of the path.
+headline is the headline component of the path.
+star-idx is the index of the asterisk, if any."
+  (save-match-data
+    (let* ((star-index (string-match-p "\\*" path))
+           (title (substring-no-properties path 0 star-index))
+           (headline (if star-index
+                         (substring-no-properties path (+ 1 star-index))
+                       ""))
+           (type (cond ((not star-index)
+                        'title)
+                       ((= 0 star-index)
+                        'headline)
+                       (t 'title+headline))))
+      (list type title headline star-index))))
+
+(defun org-roam-link--get-location ()
+  "Return the location of the Org-roam fuzzy link at point.
+The location is returned as a list containing (link-type loc desc marker).
+nil is returned if there is no matching location.
+
+link-type is either \"file\" or \"id\".
+loc is the target location: e.g. a file path, or an id.
+marker is a marker to the headline, if applicable.
+
+desc is either the the description of the link under point, or
+the target of LINK (title or heading content)."
+  (let ((context (org-element-context))
+        mkr link-type desc loc)
+    (pcase (org-element-lineage context '(link) t)
+      (`nil (error "Not at an Org link"))
+      (link
+       (if (not (string-equal "roam" (org-element-property :type link)))
+           (error "Not at Org-roam link")
+         (setq desc (and (org-element-property :contents-begin link)
+                         (org-element-property :contents-end link)
+                         (buffer-substring-no-properties
+                          (org-element-property :contents-begin link)
+                          (org-element-property :contents-end link))))
+         (pcase-let ((`(,type ,title ,headline _) (org-roam-link--split-path
+                                                   (org-element-property :path link))))
+           (pcase type
+             ('title+headline
+              (let ((file (org-roam-link--get-file-from-title title)))
+                (if (not file)
+                    (org-roam-message "Cannot find matching file")
+                  (setq mkr (org-roam-link--get-id-from-headline headline file))
+                  (pcase mkr
+                    (`(,marker . ,target-id)
+                     (progn
+                       (setq mkr marker
+                             loc target-id
+                             desc (or desc headline)
+                             link-type "id")))
+                    (_ (org-roam-message "Cannot find matching id"))))))
+             ('title
+              (setq loc (org-roam-link--get-file-from-title title)
+                    link-type "file"
+                    desc (or desc title)))
+             ('headline
+              (setq mkr (org-roam-link--get-id-from-headline headline))
+              (pcase mkr
+                (`(,marker . ,target-id)
+                 (setq mkr marker
+                       loc target-id
+                       link-type "id"
+                       desc (or desc headline)))
+                (_ (org-roam-message "Cannot find matching headline")))))))))
+    (list link-type loc desc mkr)))
+
+;;; Conversion Functions
+(defun org-roam-link--replace-link (link-type loc &optional desc)
+  "Replace link at point with a vanilla Org link.
+LINK-TYPE is the Org link type, typically \"file\" or \"id\".
+LOC is path for the Org link.
+DESC is the link description."
+  (save-excursion
+    (save-match-data
+      (unless (org-in-regexp org-link-bracket-re 1)
+        (user-error "No link at point"))
+      (replace-match "")
+      (insert (org-roam-format-link loc desc link-type)))))
+
+(defun org-roam-link-replace-all ()
+  "Replace all roam links in the current buffer."
+  (interactive)
+  (save-excursion
+    (goto-char (point-min))
+    (while (re-search-forward org-link-bracket-re nil t)
+      (condition-case nil
+          (pcase-let ((`(,link-type ,loc ,desc _) (org-roam-link--get-location)))
+            (when (and link-type loc)
+              (org-roam-link--replace-link link-type loc desc)))
+        (error nil)))))
+
+(defun org-roam-link--replace-link-on-save ()
+  "Hook to replace all roam links on save."
+  (when org-roam-link-auto-replace
+    (org-roam-link-replace-all)))
+
+;;; Completion
+(defun org-roam-link-complete-at-point ()
+  "Do appropriate completion for the link at point."
+  (let ((end (point))
+        (start (point))
+        collection link-type headline-only-p)
+    (when (org-in-regexp org-link-bracket-re 1)
+      (setq start (match-beginning 1)
+            end (match-end 1))
+      (let ((context (org-element-context)))
+        (pcase (org-element-lineage context '(link) t)
+          (`nil nil)
+          (link
+           (setq link-type (org-element-property :type link))
+           (when (member link-type '("roam" "fuzzy"))
+             (when (string= link-type "roam") (setq start (+ start (length "roam:"))))
+             (pcase-let ((`(,type ,title _ ,star-idx)
+                          (org-roam-link--split-path (org-element-property :path link))))
+               (pcase type
+                 ('title+headline
+                  (when-let ((file (org-roam-link--get-file-from-title title t)))
+                    (setq collection (apply-partially #'org-roam-link--get-headlines file))
+                    (setq start (+ start star-idx 1))))
+                 ('title
+                  (setq collection #'org-roam-link--get-titles))
+                 ('headline
+                  (setq collection #'org-roam-link--get-headlines)
+                  (setq start (+ start star-idx 1))
+                  (setq headline-only-p t)))))))))
+    (when collection
+      (let ((prefix (buffer-substring-no-properties start end)))
+        (list start end
+              (if (functionp collection)
+                  (completion-table-case-fold
+                   (completion-table-dynamic
+                    (lambda (_)
+                      (cl-remove-if (apply-partially #'string= prefix)
+                                    (funcall collection))))
+                   (not org-roam-completion-ignore-case))
+                collection)
+              :exit-function
+              (lambda (str &rest _)
+                (delete-char (- 0 (length str)
+                                (if headline-only-p 1 0)))
+                (insert (concat (unless (string= link-type "roam") "roam:")
+                                (when headline-only-p "*")
+                                (org-link-escape str)))))))))
+
+(provide 'org-roam-link)
+;;; org-roam-link.el ends here

org-roam-macs.el

@@ -0,0 +1,130 @@
+;;; org-roam-macs.el --- Macros/utility functions -*- coding: utf-8; lexical-binding: t; -*-
+
+;; Copyright © 2020 Jethro Kuan <jethrokuan95@gmail.com>
+
+;; Author: Jethro Kuan <jethrokuan95@gmail.com>
+;; URL: https://github.com/org-roam/org-roam
+;; Keywords: org-mode, roam, convenience
+;; Version: 1.2.3
+;; Package-Requires: ((emacs "26.1") (dash "2.13") (f "0.17.2") (s "1.12.0") (org "9.3") (emacsql "3.0.0") (emacsql-sqlite3 "1.0.2"))
+
+;; This file is NOT part of GNU Emacs.
+
+;; This program is free software; you can redistribute it and/or modify
+;; it under the terms of the GNU General Public License as published by
+;; the Free Software Foundation; either version 3, or (at your option)
+;; any later version.
+;;
+;; This program is distributed in the hope that it will be useful,
+;; but WITHOUT ANY WARRANTY; without even the implied warranty of
+;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+;; GNU General Public License for more details.
+;;
+;; You should have received a copy of the GNU General Public License
+;; along with GNU Emacs; see the file COPYING.  If not, write to the
+;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
+;; Boston, MA 02110-1301, USA.
+
+;;; Commentary:
+;;
+;; This library implements macros and utility functions used throughout
+;; org-roam.
+;;
+;;
+;;; Code:
+;;;; Library Requires
+(require 'dash)
+(require 's)
+
+(defvar org-roam-verbose)
+
+;; This is necessary to ensure all dependents on this module see
+;; `org-mode-hook' and `org-inhibit-startup' as dynamic variables,
+;; regardless of whether Org is loaded before their compilation.
+(require 'org)
+
+;;;; Utility Functions
+(defun org-roam--list-interleave (lst separator)
+  "Interleaves elements in LST with SEPARATOR."
+  (when lst
+    (let ((new-lst (list (pop lst))))
+      (dolist (it lst)
+        (nconc new-lst (list separator it)))
+      new-lst)))
+
+(defmacro org-roam-with-file (file keep-buf-p &rest body)
+  "Execute BODY within FILE.
+If FILE is nil, execute BODY in the current buffer.
+Kills the buffer if KEEP-BUF-P is nil, and FILE is not yet visited."
+  (declare (indent 2) (debug t))
+  `(let* (new-buf
+          (buf (or (and (not ,file)
+                        (current-buffer)) ;If FILE is nil, use current buffer
+                   (find-buffer-visiting ,file) ; If FILE is already visited, find buffer
+                   (progn
+                     (setq new-buf t)
+                     (find-file-noselect ,file)))) ; Else, visit FILE and return buffer
+          res)
+     (with-current-buffer buf
+       (setq res (progn ,@body))
+       (unless (and new-buf (not ,keep-buf-p))
+         (save-buffer)))
+     (if (and new-buf (not ,keep-buf-p))
+       (when (find-buffer-visiting ,file)
+         (kill-buffer (find-buffer-visiting ,file))))
+     res))
+
+(defmacro org-roam--with-temp-buffer (file &rest body)
+  "Execute BODY within a temp buffer.
+Like `with-temp-buffer', but propagates `org-roam-directory'.
+If FILE, set `org-roam-temp-file-name' to file and insert its contents."
+  (declare (indent 1) (debug t))
+  (let ((current-org-roam-directory (make-symbol "current-org-roam-directory")))
+    `(let ((,current-org-roam-directory org-roam-directory))
+       (with-temp-buffer
+         (let ((org-roam-directory ,current-org-roam-directory)
+               (org-mode-hook nil)
+               (org-inhibit-startup t))
+           (org-mode)
+           (when ,file
+             (insert-file-contents ,file)
+             (setq-local org-roam-file-name ,file)
+             (setq-local default-directory (file-name-directory ,file)))
+           ,@body)))))
+
+(defun org-roam-message (format-string &rest args)
+  "Pass FORMAT-STRING and ARGS to `message' when `org-roam-verbose' is t."
+  (when org-roam-verbose
+    (apply #'message `(,(concat "(org-roam) " format-string) ,@args))))
+
+(defun org-roam-string-quote (str)
+  "Quote STR."
+  (->> str
+       (s-replace "\\" "\\\\")
+       (s-replace "\"" "\\\"")))
+
+;;; Shielding regions
+(defun org-roam-shield-region (beg end)
+  "Shield REGION against modifications.
+REGION must be a cons-cell containing the marker to the region
+beginning and maximum values."
+  (when (and beg end)
+    (add-text-properties beg end
+                           '(font-lock-face org-roam-link-shielded
+                                            read-only t)
+                           (marker-buffer beg))
+    (cons beg end)))
+
+(defun org-roam-unshield-region (beg end)
+  "Unshield the shielded REGION."
+  (when (and beg end)
+    (let ((inhibit-read-only t))
+      (remove-text-properties beg end
+                              '(font-lock-face org-roam-link-shielded
+                                               read-only t)
+                              (marker-buffer beg)))
+    (cons beg end)))
+
+(provide 'org-roam-macs)
+
+;;; org-roam-macs.el ends here

org-roam-protocol.el

@@ -0,0 +1,111 @@
+;;; org-roam-protocol.el --- Protocol handler for roam:// links  -*- coding: utf-8; lexical-binding: t; -*-
+
+;; Copyright © 2020 Jethro Kuan <jethrokuan95@gmail.com>
+;; Author: Jethro Kuan <jethrokuan95@gmail.com>
+;; URL: https://github.com/org-roam/org-roam
+;; Keywords: org-mode, roam, convenience
+;; Version: 1.2.3
+;; Package-Requires: ((emacs "26.1") (org "9.3"))
+
+;; This file is NOT part of GNU Emacs.
+
+;; This program is free software; you can redistribute it and/or modify
+;; it under the terms of the GNU General Public License as published by
+;; the Free Software Foundation; either version 3, or (at your option)
+;; any later version.
+;;
+;; This program is distributed in the hope that it will be useful,
+;; but WITHOUT ANY WARRANTY; without even the implied warranty of
+;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+;; GNU General Public License for more details.
+;;
+;; You should have received a copy of the GNU General Public License
+;; along with GNU Emacs; see the file COPYING.  If not, write to the
+;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
+;; Boston, MA 02110-1301, USA.
+
+;;; Commentary:
+;;
+;; We extend org-protocol, adding custom Org-roam handlers. The setup
+;; instructions for `org-protocol' can be found in org-protocol.el.
+;;
+;; We define 2 protocols:
+;;
+;; 1. "roam-file": This protocol simply opens the file given by the FILE key
+;; 2. "roam-ref": This protocol creates or opens a note with the given REF
+;;
+;;; Code:
+(require 'org-protocol)
+(require 'org-roam)
+(require 'ol) ;; for org-link-decode
+
+(defcustom org-roam-protocol-store-links nil
+  "Whether to store links when capturing websites with `org-roam-protocol'."
+  :type 'boolean
+  :group 'org-roam)
+
+;;;; Functions
+(defun org-roam-protocol-open-ref (info)
+  "Process an org-protocol://roam-ref?ref= style url with INFO.
+
+It opens or creates a note with the given ref.
+
+  javascript:location.href = \\='org-protocol://roam-ref?template=r&ref=\\='+ \\
+        encodeURIComponent(location.href) + \\='&title=\\=' + \\
+        encodeURIComponent(document.title) + \\='&body=\\=' + \\
+        encodeURIComponent(window.getSelection())"
+  (when-let* ((alist (org-roam--plist-to-alist info))
+              (decoded-alist (mapcar (lambda (k.v)
+                                       (let ((key (car k.v))
+                                             (val (cdr k.v)))
+                                         (cons key (org-link-decode val)))) alist)))
+    (unless (assoc 'ref decoded-alist)
+      (error "No ref key provided"))
+    (when-let ((title (cdr (assoc 'title decoded-alist))))
+      (push (cons 'slug (funcall org-roam-title-to-slug-function title)) decoded-alist))
+    (let-alist decoded-alist
+      (let* ((ref (org-protocol-sanitize-uri .ref))
+             (type (and (string-match org-link-plain-re ref)
+                        (match-string 1 ref)))
+             (title (or .title ""))
+             (body (or .body ""))
+             (orglink
+              (org-link-make-string ref (or (org-string-nw-p title) ref))))
+        (when org-roam-protocol-store-links
+          (push (list ref title) org-stored-links))
+        (org-link-store-props :type type
+                              :link ref
+                              :annotation orglink
+                              :initial body)))
+    (let* ((org-roam-capture-templates org-roam-capture-ref-templates)
+           (org-roam-capture--context 'ref)
+           (org-roam-capture--info decoded-alist)
+           (org-capture-link-is-already-stored t)
+           (template (cdr (assoc 'template decoded-alist))))
+      (raise-frame)
+      (org-roam-capture--capture nil template)
+      (org-roam-message "Item captured.")))
+  nil)
+
+(defun org-roam-protocol-open-file (info)
+  "This handler simply opens the file with emacsclient.
+
+INFO is an alist containing additional information passed by the protocol URL.
+It should contain the FILE key, pointing to the path of the file to open.
+
+  Example protocol string:
+
+org-protocol://roam-file?file=/path/to/file.org"
+  (when-let ((file (plist-get info :file)))
+    (raise-frame)
+    (org-roam--find-file file))
+  nil)
+
+(push '("org-roam-ref"  :protocol "roam-ref"   :function org-roam-protocol-open-ref)
+      org-protocol-protocol-alist)
+(push '("org-roam-file"  :protocol "roam-file"   :function org-roam-protocol-open-file)
+      org-protocol-protocol-alist)
+
+(provide 'org-roam-protocol)
+
+;;; org-roam-protocol.el ends here

org-roam-utils.el

@@ -1,169 +0,0 @@
-;;; org-roam-utils.el --- Roam Research replica with Org-mode -*- coding: utf-8; lexical-binding: t -*-
-
-;; Copyright © 2020 Jethro Kuan <jethrokuan95@gmail.com>
-
-;; Author: Jethro Kuan <jethrokuan95@gmail.com>
-;; URL: https://github.com/jethrokuan/org-roam
-;; Keywords: org-mode, roam, convenience
-;; Version: 0.1.2
-;; Package-Requires: ((emacs "26.1"))
-
-;; This file is NOT part of GNU Emacs.
-
-;; This program is free software; you can redistribute it and/or modify
-;; it under the terms of the GNU General Public License as published by
-;; the Free Software Foundation; either version 3, or (at your option)
-;; any later version.
-;;
-;; This program is distributed in the hope that it will be useful,
-;; but WITHOUT ANY WARRANTY; without even the implied warranty of
-;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-;; GNU General Public License for more details.
-;;
-;; You should have received a copy of the GNU General Public License
-;; along with GNU Emacs; see the file COPYING.  If not, write to the
-;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
-;; Boston, MA 02110-1301, USA.
-
-;;; Commentary:
-;;
-;; This library is an attempt at injecting Roam functionality into Org-mode.
-;; This is achieved primarily through building caches for forward links,
-;; backward links, and file titles.
-;;
-;;; Code:
-
-(require 'org)
-(require 'org-element)
-(require 'subr-x)
-(require 'cl-lib)
-
-(defun org-roam--file-name-extension (filename)
-  "Return file name extension for FILENAME.
-
-Like file-name-extension, but does not strip version number."
-  (save-match-data
-    (let ((file (file-name-nondirectory filename)))
-      (if (and (string-match "\\.[^.]*\\'" file)
-                     (not (eq 0 (match-beginning 0))))
-          (substring file (+ (match-beginning 0) 1))))))
-
-(defun org-roam--org-file-p (path)
-  "Check if PATH is pointing to an org file."
-  (let ((ext (org-roam--file-name-extension path)))
-    (or (string= ext "org")
-        (and
-         (string= ext "gpg")
-         (string= (org-roam--file-name-extension (file-name-sans-extension path)) "org")))))
-
-(defun org-roam--find-files (dir)
-  "Return all `org-roam' files in `DIR'."
-  (if (file-exists-p dir)
-      (let ((files (directory-files dir t "." t))
-            (dir-ignore-regexp (concat "\\(?:"
-                                       "\\."
-                                       "\\|\\.\\."
-                                       "\\)$"))
-            result)
-        (dolist (file files)
-          (cond
-           ((file-directory-p file)
-            (when (not (string-match dir-ignore-regexp file))
-              (setq result (append (org-roam--find-files file) result))))
-           ((and (file-readable-p file)
-                 (org-roam--org-file-p file))
-            (setq result (cons (file-truename file) result)))))
-        result)))
-
-(defun org-roam--parse-content (&optional file-path)
-  "Parse the current buffer, and return a list of items for processing."
-  (org-element-map (org-element-parse-buffer) 'link
-    (lambda (link)
-      (let ((type (org-element-property :type link))
-            (path (org-element-property :path link))
-            (start (org-element-property :begin link)))
-        (when (and (string= type "file")
-                   (org-roam--org-file-p path))
-          (goto-char start)
-          (let* ((element (org-element-at-point))
-                 (begin (or (org-element-property :content-begin element)
-                            (org-element-property :begin element)))
-                 (content (or (org-element-property :raw-value element)
-                              (buffer-substring
-                               begin
-                               (or (org-element-property :content-end element)
-                                   (org-element-property :end element)))))
-                 (content (string-trim content))
-                 (file-path (or file-path
-                                (file-truename (buffer-file-name (current-buffer))))))
-            (list :from file-path
-                  :to (file-truename (expand-file-name path (file-name-directory file-path)))
-                  :properties (list :content content :point begin))))))))
-
-(cl-defun org-roam--insert-item (item &key forward backward)
-  "Insert ITEM into FORWARD and BACKWARD cache.
-
-ITEM is of the form: (:from from-path :to to-path :properties (:content preview-content :point point))."
-  (pcase-let ((`(:from ,p-from :to ,p-to :properties ,props) item))
-    ;; Build forward-links
-    (let ((links (gethash p-from forward)))
-      (if links
-          (puthash p-from
-                   (if (member p-to links)
-                       links
-                     (cons p-to links)) forward)
-        (puthash p-from (list p-to) forward)))
-    ;; Build backward-links
-    (let ((contents-hash (gethash p-to backward)))
-      (if contents-hash
-          (if-let ((contents-list (gethash p-from contents-hash)))
-              (let ((updated (cons props contents-list)))
-                (puthash p-from updated contents-hash)
-                (puthash p-to contents-hash backward))
-            (progn
-              (puthash p-from (list props) contents-hash)
-              (puthash p-to contents-hash backward)))
-        (let ((contents-hash (make-hash-table :test #'equal)))
-          (puthash p-from (list props) contents-hash)
-          (puthash p-to contents-hash backward))))))
-
-(defun org-roam--extract-title ()
-  "Extract the title from `BUFFER'."
-  (org-element-map
-      (org-element-parse-buffer)
-      'keyword
-    (lambda (kw)
-      (when (string= (org-element-property :key kw) "TITLE")
-        (org-element-property :value kw)))
-    :first-match t))
-
-(defun org-roam--build-cache (dir)
-  "Build the org-roam caches in DIR."
-  (let ((backward-links (make-hash-table :test #'equal))
-        (forward-links (make-hash-table :test #'equal))
-        (file-titles (make-hash-table :test #'equal)))
-    (let* ((org-roam-files (org-roam--find-files dir))
-           (file-items (mapcar (lambda (file)
-                                 (with-temp-buffer
-                                   (insert-file-contents file)
-                                   (org-roam--parse-content file))) org-roam-files)))
-      (dolist (items file-items)
-        (dolist (item items)
-          (org-roam--insert-item
-           item
-           :forward forward-links
-           :backward backward-links)))
-      (dolist (file org-roam-files)
-        (with-temp-buffer
-          (insert-file-contents file)
-          (when-let ((title (org-roam--extract-title)))
-            (puthash file title file-titles)))
-        org-roam-files))
-    (list
-     :forward forward-links
-     :backward backward-links
-     :titles file-titles)))
-
-(provide 'org-roam-utils)
-
-;;; org-roam-utils.el ends here

tests/roam-files/alias.org

@@ -0,0 +1,2 @@
+#+roam_alias: "a1" "a 2"
+#+title: t1

tests/roam-files/bar.org

@@ -0,0 +1,3 @@
+#+title: Bar
+
+This is file bar. Bar links to [[file:nested/bar.org][Nested Bar]].

tests/roam-files/base.org

@@ -0,0 +1 @@
+#+title: Base

tests/roam-files/cite_ref.org

@@ -0,0 +1 @@
+#+roam_key: cite:mitsuha2007

tests/roam-files/f1.org

@@ -1,7 +0,0 @@
-#+TITLE: File 1
-
-link to [[file:nested/f1.org][Nested File 1]] 
-link to [[file:f2.org][File 2]]
-
-Arbitrary [[https://google.com][HTML]] link
-Arbitrary text

tests/roam-files/f3.org

@@ -1,5 +0,0 @@
-#+TITLE: File 3
-
-This file has a link to an file with no title.
-
-[[file:no-title.org][no-title]]

tests/roam-files/foo.org

@@ -0,0 +1,8 @@
+#+title: Foo
+
+This is the foo file. It contains a link to [[file:bar.org][Bar]].
+
+To make the tests more robust, here are some arbitrary links:
+
+- [[https:google.com][Google]]
+- [[mailto:foo@john.com][mail to foo]]

tests/roam-files/headlines/headline.org

@@ -0,0 +1,14 @@
+#+TITLE: Headline
+
+* Headline 1
+:PROPERTIES:
+:ID:       e84d0630-efad-4017-9059-5ef917908823
+:END:
+
+* No headline here
+Oops.
+
+* Headline 2
+:PROPERTIES:
+:ID:       801b58eb-97e2-435f-a33e-ff59a2f0c213
+:END:

tests/roam-files/multiple-refs.org

@@ -0,0 +1,2 @@
+#+roam_key: https://www.orgroam.com/
+#+roam_key: cite:orgroam2020

tests/roam-files/nested/bar.org

@@ -0,0 +1,3 @@
+#+title: Nested Bar
+
+This file is nested, 1 level deeper. It links to both [[file:../foo.org][Foo]] and [[file:foo.org][Nested Foo]].

tests/roam-files/nested/deeply/deeply_nested_file.org

@@ -0,0 +1 @@
+#+title: Deeply Nested File

tests/roam-files/nested/f1.org

@@ -1,4 +0,0 @@
-#+TITLE: Nested File 1
-
-Link to [[file:f2.org][Nested File 2]]
-Link to [[file:../f1.org][File 1]]

tests/roam-files/nested/f2.org

@@ -1,3 +0,0 @@
-#+TITLE: Nested File 2
-
-Link to [[file:f1.org][Nested File 1]]

tests/roam-files/nested/foo.org

@@ -1,3 +1,3 @@
-#+TITLE: File 2
+#+title: Nested Foo
 
 This file has no links.

tests/roam-files/no-title.org

@@ -1 +1,5 @@
 no title in this file :O
+
+links to itself, with no title: [[file:no-title.org][no-title]]
+
+* Headline title

tests/roam-files/tags/no_tag.org

@@ -0,0 +1,3 @@
+#+title: Tagless File
+
+This file has no tags, and should not yield any tags on extracting via ~#+roam_tags~.

tests/roam-files/tags/tag.org

@@ -0,0 +1,4 @@
+#+roam_tags: "t1" "t2 with space" t3
+#+title: Tags
+
+This file is used to test functionality for =(org-roam--extract-tags)=

tests/roam-files/titles/aliases.org

@@ -0,0 +1 @@
+#+roam_alias: "roam" "alias"

tests/roam-files/titles/combination.org

@@ -0,0 +1,4 @@
+#+title: TITLE PROP
+#+roam_alias: "roam" "alias"
+
+* Headline

tests/roam-files/titles/headline.org

@@ -0,0 +1 @@
+* Headline

tests/roam-files/titles/title.org

@@ -0,0 +1 @@
+#+title: Title

tests/roam-files/unlinked.org

@@ -0,0 +1,3 @@
+#+title: Unlinked
+
+Nothing links here :(

tests/roam-files/web_ref.org

@@ -0,0 +1 @@
+#+roam_key: https://google.com/

tests/test-org-roam-perf.el

@@ -0,0 +1,53 @@
+;;; test-org-roam-perf.el --- Performance Tests for Org-roam -*- lexical-binding: t; -*-
+
+;; Copyright (C) 2020 Jethro Kuan
+
+;; Author: Jethro Kuan <jethrokuan95@gmail.com>
+;; Package-Requires: ((buttercup))
+
+;; This program is free software; you can redistribute it and/or modify
+;; it under the terms of the GNU General Public License as published by
+;; the Free Software Foundation, either version 3 of the License, or
+;; (at your option) any later version.
+
+;; This program is distributed in the hope that it will be useful,
+;; but WITHOUT ANY WARRANTY; without even the implied warranty of
+;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+;; GNU General Public License for more details.
+
+;; You should have received a copy of the GNU General Public License
+;; along with this program.  If not, see <https://www.gnu.org/licenses/>.
+
+;;; Commentary:
+;;; Code:
+
+(require 'buttercup)
+(require 'org-roam)
+
+(defconst test-org-roam-perf-zip-url "https://github.com/org-roam/test-org-files/archive/master.zip"
+  "Path to zip for test org-roam files.")
+
+(defun test-org-roam-perf--abs-path (file-path)
+  "Get absolute FILE-PATH from `org-roam-directory'."
+  (expand-file-name file-path org-roam-directory))
+
+(defun test-org-roam-perf--init ()
+  "."
+  (let* ((temp-loc (expand-file-name (make-temp-name "test-org-files-") temporary-file-directory))
+         (zip-file-loc (concat temp-loc ".zip"))
+         (_ (url-copy-file test-org-roam-perf-zip-url zip-file-loc))
+         (_ (shell-command (format "mkdir -p %s && unzip -j -qq %s -d %s" temp-loc zip-file-loc temp-loc))))
+    (setq org-roam-directory temp-loc)))
+
+(describe "Cache Build"
+  (it "cache build from scratch time to be acceptable"
+    (test-org-roam-perf--init)
+    (pcase (benchmark-run 1 (org-roam-db-build-cache t))
+      (`(,time ,gcs ,time-in-gc)
+       (message "Elapsed time: %fs (%fs in %d GCs)" time time-in-gc gcs)
+       (expect time :to-be-less-than 110))))
+  (it "builds quickly without change"
+    (pcase (benchmark-run 1 (org-roam-db-build-cache))
+      (`(,time ,gcs ,time-in-gc)
+       (message "Elapsed time: %fs (%fs in %d GCs)" time time-in-gc gcs)
+       (expect time :to-be-less-than 5)))))

tests/test-org-roam.el

@@ -1,9 +1,9 @@
-;;; test-org-roam.el --- Tests for org-roam -*- lexical-binding: t; -*-
+;;; test-org-roam.el --- Tests for Org-roam -*- lexical-binding: t; -*-
 
 ;; Copyright (C) 2020 Jethro Kuan
 
 ;; Author: Jethro Kuan <jethrokuan95@gmail.com>
-;; Package-Requires: ((buttercup) (with-simulated-input))
+;; Package-Requires: ((buttercup))
 
 ;; This program is free software; you can redistribute it and/or modify
 ;; it under the terms of the GNU General Public License as published by
@@ -19,212 +19,346 @@
 ;; along with this program.  If not, see <https://www.gnu.org/licenses/>.
 
 ;;; Commentary:
-
-;;
-
 ;;; Code:
 
-;;;; Requirements
-
 (require 'buttercup)
-(require 'with-simulated-input)
 (require 'org-roam)
 (require 'dash)
 
-(defun abs-path (file-path)
-  (file-truename (expand-file-name file-path org-roam-directory)))
+(defun test-org-roam--abs-path (file-path)
+  "Get absolute FILE-PATH from `org-roam-directory'."
+  (expand-file-name file-path org-roam-directory))
 
-(defun org-roam--test-find-new-file (path)
-  (let ((path (abs-path path)))
+(defun test-org-roam--find-file (path)
+  "PATH."
+  (let ((path (test-org-roam--abs-path path)))
     (make-directory (file-name-directory path) t)
     (find-file path)))
 
-(defvar org-roam--tests-directory (file-truename (concat default-directory "tests/roam-files"))
+(defvar test-org-roam-directory (expand-file-name "tests/roam-files")
   "Directory containing org-roam test org files.")
 
-(defun org-roam--test-init ()
-  (let ((original-dir org-roam--tests-directory)
+(defun test-org-roam--init ()
+  "."
+  (let ((original-dir test-org-roam-directory)
         (new-dir (expand-file-name (make-temp-name "org-roam") temporary-file-directory)))
     (copy-directory original-dir new-dir)
-    (setq org-roam-directory new-dir))
-  (org-roam-mode +1))
+    (setq org-roam-directory new-dir)
+    (org-roam-mode +1)
+    (sleep-for 2)))
 
-(defun org-roam--test-build-cache ()
-  "Builds the caches synchronously."
-  (let ((cache (org-roam--build-cache org-roam-directory)))
-    (setq org-roam-forward-links-cache (plist-get cache :forward))
-    (setq org-roam-backward-links-cache (plist-get cache :backward))
-    (setq org-roam-titles-cache (plist-get cache :titles))
-    (setq org-roam-cache-initialized t)))
+(defun test-org-roam--teardown ()
+  (org-roam-mode -1)
+  (delete-file org-roam-db-location)
+  (org-roam-db--close))
+
+(describe "Ref extraction"
+  (before-all
+    (test-org-roam--init))
+
+  (after-all
+    (test-org-roam--teardown))
+
+  (cl-flet
+      ((test (fn file)
+             (let* ((fname (test-org-roam--abs-path file))
+                    (buf (find-file-noselect fname)))
+               (with-current-buffer buf
+                 ;; Unlike tag extraction, it doesn't make sense to
+                 ;; pass a filename.
+                 (funcall fn)))))
+    ;; Enable "cite:" link parsing
+    (org-link-set-parameters "cite")
+    (it "extracts web keys"
+      (expect (test #'org-roam--extract-ref
+                    "web_ref.org")
+              :to-equal
+              '("website" . "//google.com/")))
+    (it "extracts cite keys"
+      (expect (test #'org-roam--extract-ref
+                    "cite_ref.org")
+              :to-equal
+              '("cite" . "mitsuha2007")))
+    (it "extracts all keys"
+      (expect (test #'org-roam--extract-refs
+                    "multiple-refs.org")
+              :to-have-same-items-as
+              '(("cite" . "orgroam2020")
+                ("website" . "//www.orgroam.com/"))))))
+
+(describe "Title extraction"
+  :var (org-roam-title-sources)
+  (before-all
+    (test-org-roam--init))
+
+  (after-all
+    (test-org-roam--teardown))
+
+  (cl-flet
+      ((test (fn file)
+             (let ((buf (find-file-noselect
+                         (test-org-roam--abs-path file))))
+               (with-current-buffer buf
+                 (funcall fn)))))
+    (it "extracts title from title property"
+      (expect (test #'org-roam--extract-titles-title
+                    "titles/title.org")
+              :to-equal
+              '("Title"))
+      (expect (test #'org-roam--extract-titles-title
+                    "titles/aliases.org")
+              :to-equal
+              nil)
+      (expect (test #'org-roam--extract-titles-title
+                    "titles/headline.org")
+              :to-equal
+              nil)
+      (expect (test #'org-roam--extract-titles-title
+                    "titles/combination.org")
+              :to-equal
+              '("TITLE PROP")))
+
+    (it "extracts alias"
+      (expect (test #'org-roam--extract-titles-alias
+                    "titles/title.org")
+              :to-equal
+              nil)
+      (expect (test #'org-roam--extract-titles-alias
+                    "titles/aliases.org")
+              :to-equal
+              '("roam" "alias"))
+      (expect (test #'org-roam--extract-titles-alias
+                    "titles/headline.org")
+              :to-equal
+              nil)
+      (expect (test #'org-roam--extract-titles-alias
+                    "titles/combination.org")
+              :to-equal
+              '("roam" "alias")))
+
+    (it "extracts headlines"
+      (expect (test #'org-roam--extract-titles-alias
+                    "titles/title.org")
+              :to-equal
+              nil)
+      (expect (test #'org-roam--extract-titles-headline
+                    "titles/aliases.org")
+              :to-equal
+              nil)
+      (expect (test #'org-roam--extract-titles-headline
+                    "titles/headline.org")
+              :to-equal
+              '("Headline"))
+      (expect (test #'org-roam--extract-titles-headline
+                    "titles/combination.org")
+              :to-equal
+              '("Headline")))
+
+    (describe "uses org-roam-title-sources correctly"
+      (it "'((title headline) alias)"
+        (expect (let ((org-roam-title-sources '((title headline) alias)))
+                  (test #'org-roam--extract-titles
+                        "titles/combination.org"))
+                :to-equal
+                '("TITLE PROP" "roam" "alias")))
+      (it "'((headline title) alias)"
+        (expect (let ((org-roam-title-sources '((headline title) alias)))
+                  (test #'org-roam--extract-titles
+                        "titles/combination.org"))
+                :to-equal
+                '("Headline" "roam" "alias")))
+      (it "'(headline alias title)"
+        (expect (let ((org-roam-title-sources '(headline alias title)))
+                  (test #'org-roam--extract-titles
+                        "titles/combination.org"))
+                :to-equal
+                '("Headline" "roam" "alias" "TITLE PROP"))))))
+
+(describe "Tag extraction"
+  :var (org-roam-tag-sources)
+  (before-all
+    (test-org-roam--init))
+
+  (after-all
+    (test-org-roam--teardown))
+
+  (cl-flet
+      ((test (fn file)
+             (let* ((fname (test-org-roam--abs-path file))
+                    (buf (find-file-noselect fname)))
+               (with-current-buffer buf
+                 (funcall fn fname)))))
+    (it "extracts from prop"
+      (expect (test #'org-roam--extract-tags-prop
+                    "tags/tag.org")
+              :to-equal
+              '("t1" "t2 with space" "t3"))
+      (expect (test #'org-roam--extract-tags-prop
+                    "tags/no_tag.org")
+              :to-equal
+              nil))
+
+    (it "extracts from all directories"
+      (expect (test #'org-roam--extract-tags-all-directories
+                    "base.org")
+              :to-equal
+              nil)
+      (expect (test #'org-roam--extract-tags-all-directories
+                    "tags/tag.org")
+              :to-equal
+              '("tags"))
+      (expect (test #'org-roam--extract-tags-all-directories
+                    "nested/deeply/deeply_nested_file.org")
+              :to-equal
+              '("nested" "deeply")))
+
+    (it "extracts from last directory"
+      (expect (test #'org-roam--extract-tags-last-directory
+                    "base.org")
+              :to-equal
+              nil)
+      (expect (test #'org-roam--extract-tags-last-directory
+                    "tags/tag.org")
+              :to-equal
+              '("tags"))
+      (expect (test #'org-roam--extract-tags-last-directory
+                    "nested/deeply/deeply_nested_file.org")
+              :to-equal
+              '("deeply")))
+
+    (it "extracts from first directory"
+      (expect (test #'org-roam--extract-tags-first-directory
+                    "base.org")
+              :to-equal
+              nil)
+      (expect (test #'org-roam--extract-tags-first-directory
+                    "tags/tag.org")
+              :to-equal
+              '("tags"))
+      (expect (test #'org-roam--extract-tags-first-directory
+                    "nested/deeply/deeply_nested_file.org")
+              :to-equal
+              '("nested")))
+
+    (describe "uses org-roam-tag-sources correctly"
+      (it "'(prop)"
+        (expect (let ((org-roam-tag-sources '(prop)))
+                  (test #'org-roam--extract-tags
+                        "tags/tag.org"))
+                :to-equal
+                '("t1" "t2 with space" "t3")))
+      (it "'(prop all-directories)"
+        (expect (let ((org-roam-tag-sources '(prop all-directories)))
+                  (test #'org-roam--extract-tags
+                        "tags/tag.org"))
+                :to-equal
+                '("t1" "t2 with space" "t3" "tags"))))))
+
+(describe "ID extraction"
+  (before-all
+    (test-org-roam--init))
+
+  (after-all
+    (test-org-roam--teardown))
+
+  (cl-flet
+      ((test (fn file)
+             (let* ((fname (test-org-roam--abs-path file))
+                    (buf (find-file-noselect fname)))
+               (with-current-buffer buf
+                 (funcall fn fname)))))
+    (it "extracts ids"
+      (expect (test #'org-roam--extract-ids
+                    "headlines/headline.org")
+              :to-have-same-items-as
+              `(["e84d0630-efad-4017-9059-5ef917908823" ,(test-org-roam--abs-path "headlines/headline.org") 1]
+                ["801b58eb-97e2-435f-a33e-ff59a2f0c213" ,(test-org-roam--abs-path "headlines/headline.org") 1])))))
+
+(describe "Test roam links"
+  (it ""
+    (expect (org-roam-link--split-path "")
+            :to-equal
+            '(title "" "" nil)))
+  (it "title"
+    (expect (org-roam-link--split-path "title")
+            :to-equal
+            '(title "title" "" nil)))
+  (it "title*"
+    (expect (org-roam-link--split-path "title*")
+            :to-equal
+            '(title+headline "title" "" 5)))
+  (it "title*headline"
+    (expect (org-roam-link--split-path "title*headline")
+            :to-equal
+            '(title+headline "title" "headline" 5)))
+  (it "*headline"
+    (expect (org-roam-link--split-path "*headline")
+            :to-equal
+            '(headline "" "headline" 0))))
 
 ;;; Tests
-(describe "org-roam--build-cache-async"
-          (it "initializes correctly"
-              (org-roam--test-init)
-              (expect org-roam-cache-initialized :to-be nil)
-              (expect (hash-table-count org-roam-forward-links-cache) :to-be 0)
-              (expect (hash-table-count org-roam-backward-links-cache) :to-be 0)
-              (expect (hash-table-count org-roam-titles-cache) :to-be 0)
+(xdescribe "org-roam-db-build-cache"
+  (before-each
+    (test-org-roam--init))
 
-              (org-roam--build-cache-async)
-              (sleep-for 3) ;; Because it's async
+  (after-each
+    (test-org-roam--teardown))
 
-              ;; Caches should be populated
-              (expect org-roam-cache-initialized :to-be t)
-              (expect (hash-table-count org-roam-forward-links-cache) :to-be 4)
-              (expect (hash-table-count org-roam-backward-links-cache) :to-be 5)
-              (expect (hash-table-count org-roam-titles-cache) :to-be 5)
+  (it "initializes correctly"
+    ;; Cache
+    (expect (caar (org-roam-db-query [:select (funcall count) :from files])) :to-be 8)
+    (expect (caar (org-roam-db-query [:select (funcall count) :from links])) :to-be 5)
+    (expect (caar (org-roam-db-query [:select (funcall count) :from titles])) :to-be 8)
+    (expect (caar (org-roam-db-query [:select (funcall count) :from titles
+                                      :where titles :is-null])) :to-be 1)
+    (expect (caar (org-roam-db-query [:select (funcall count) :from refs])) :to-be 1)
 
-              ;; Forward cache
-              (let ((f1 (gethash (abs-path "f1.org") org-roam-forward-links-cache))
-                    (f2 (gethash (abs-path "f2.org") org-roam-forward-links-cache))
-                    (nested-f1 (gethash (abs-path "nested/f1.org") org-roam-forward-links-cache))
-                    (nested-f2 (gethash (abs-path "nested/f2.org") org-roam-forward-links-cache))
-                    (expected-f1 (list (abs-path "nested/f1.org")
-                                       (abs-path "f2.org")))
-                    (expected-nested-f1 (list (abs-path "nested/f2.org")
-                                              (abs-path "f1.org")))
-                    (expected-nested-f2 (list (abs-path "nested/f1.org"))))
+    ;; Links
+    (expect (caar (org-roam-db-query [:select (funcall count) :from links
+                                      :where (= source $s1)]
+                                     (test-org-roam--abs-path "foo.org"))) :to-be 1)
+    (expect (caar (org-roam-db-query [:select (funcall count) :from links
+                                      :where (= source $s1)]
+                                     (test-org-roam--abs-path "nested/bar.org"))) :to-be 2)
 
-                (expect f1 :to-have-same-items-as expected-f1)
-                (expect f2 :to-be nil)
-                (expect nested-f1 :to-have-same-items-as expected-nested-f1)
-                (expect nested-f2 :to-have-same-items-as expected-nested-f2))
+    ;; Links -- File-to
+    (expect (caar (org-roam-db-query [:select (funcall count) :from links
+                                      :where (= dest $s1)]
+                                     (test-org-roam--abs-path "nested/foo.org"))) :to-be 1)
+    (expect (caar (org-roam-db-query [:select (funcall count) :from links
+                                      :where (= dest $s1)]
+                                     (test-org-roam--abs-path "nested/bar.org"))) :to-be 1)
+    (expect (caar (org-roam-db-query [:select (funcall count) :from links
+                                      :where (= dest $s1)]
+                                     (test-org-roam--abs-path "unlinked.org"))) :to-be 0)
+    ;; TODO Test titles
+    (expect (org-roam-db-query [:select * :from titles])
+            :to-have-same-items-as
+            (list (list (test-org-roam--abs-path "alias.org")
+                        (list "t1" "a1" "a 2"))
+                  (list (test-org-roam--abs-path "bar.org")
+                        (list "Bar"))
+                  (list (test-org-roam--abs-path "foo.org")
+                        (list "Foo"))
+                  (list (test-org-roam--abs-path "nested/bar.org")
+                        (list "Nested Bar"))
+                  (list (test-org-roam--abs-path "nested/foo.org")
+                        (list "Nested Foo"))
+                  (list (test-org-roam--abs-path "no-title.org")
+                        (list "Headline title"))
+                  (list (test-org-roam--abs-path "web_ref.org") nil)
+                  (list (test-org-roam--abs-path "unlinked.org")
+                        (list "Unlinked"))))
 
-              ;; Backward cache
-              (let ((f1 (hash-table-keys (gethash (abs-path "f1.org") org-roam-backward-links-cache)))
-                    (f2 (hash-table-keys (gethash (abs-path "f2.org") org-roam-backward-links-cache)))
-                    (nested-f1 (hash-table-keys(gethash (abs-path "nested/f1.org") org-roam-backward-links-cache)))
-                    (nested-f2 (hash-table-keys (gethash (abs-path "nested/f2.org") org-roam-backward-links-cache)))
-                    (expected-f1 (list (abs-path "nested/f1.org")))
-                    (expected-f2 (list (abs-path "f1.org")))
-                    (expected-nested-f1 (list (abs-path "nested/f2.org")
-                                              (abs-path "f1.org")))
-                    (expected-nested-f2 (list (abs-path "nested/f1.org"))))
-                (expect f1 :to-have-same-items-as expected-f1)
-                (expect f2 :to-have-same-items-as expected-f2)
-                (expect nested-f1 :to-have-same-items-as expected-nested-f1)
-                (expect nested-f2 :to-have-same-items-as expected-nested-f2))
+    (expect (org-roam-db-query [:select * :from refs])
+            :to-have-same-items-as
+            (list (list "https://google.com/" (test-org-roam--abs-path "web_ref.org") "website")))
 
-              ;; Titles Cache
-              (expect (gethash (abs-path "f1.org") org-roam-titles-cache) :to-equal "File 1")
-              (expect (gethash (abs-path "f2.org") org-roam-titles-cache) :to-equal "File 2")
-              (expect (gethash (abs-path "nested/f1.org") org-roam-titles-cache) :to-equal "Nested File 1")
-              (expect (gethash (abs-path "nested/f2.org") org-roam-titles-cache) :to-equal "Nested File 2")
-              (expect (gethash (abs-path "no-title.org") org-roam-titles-cache) :to-be nil)))
+    ;; Expect rebuilds to be really quick (nothing changed)
+    (expect (org-roam-db-build-cache)
+            :to-equal
+            (list :files 0 :links 0 :tags 0 :titles 0 :refs 0 :deleted 0))))
 
-(describe "org-roam-insert"
-          (before-each
-           (org-roam--test-init)
-           (org-roam--clear-cache)
-           (org-roam--test-build-cache))
+(provide 'test-org-roam)
 
-          (it "temp1 -> f1"
-              (let ((buf (org-roam--test-find-new-file "temp1.org")))
-                (with-current-buffer buf
-                  (with-simulated-input
-                   "File SPC 1 RET"
-                   (org-roam-insert nil))))
-              (expect (buffer-string) :to-match (regexp-quote "file:f1.org")))
-
-          (it "temp2 -> nested/f1"
-              (let ((buf (org-roam--test-find-new-file "temp2.org")))
-                (with-current-buffer buf
-                  (with-simulated-input
-                   "Nested SPC File SPC 1 RET"
-                   (org-roam-insert nil))))
-              (expect (buffer-string) :to-match (regexp-quote "file:nested/f1.org")))
-
-          (it "nested/temp3 -> f1"
-              (let ((buf (org-roam--test-find-new-file "nested/temp3.org")))
-                (with-current-buffer buf
-                  (with-simulated-input
-                   "File SPC 1 RET"
-                   (org-roam-insert nil))))
-              (expect (buffer-string) :to-match (regexp-quote "file:../f1.org")))
-
-          (it "a/b/temp4 -> nested/f1"
-              (let ((buf (org-roam--test-find-new-file "a/b/temp4.org")))
-                (with-current-buffer buf
-                  (with-simulated-input
-                   "Nested SPC File SPC 1 RET"
-                   (org-roam-insert nil))))
-              (expect (buffer-string) :to-match (regexp-quote "file:../../nested/f1.org"))))
-
-(describe "rename file updates cache"
-          (before-each
-           (org-roam--test-init)
-           (org-roam--clear-cache)
-           (org-roam--test-build-cache))
-
-          (it "f1 -> new_f1"
-              (rename-file (abs-path "f1.org")
-                           (abs-path "new_f1.org"))
-              ;; Cache should be cleared of old file
-              (expect (gethash (abs-path "f1.org")  org-roam-forward-links-cache) :to-be nil)
-              (expect (->> org-roam-backward-links-cache
-                           (gethash (abs-path "nested/f1.org"))
-                           (hash-table-keys)
-                           (member (abs-path "f1.org"))) :to-be nil)
-
-              (expect (->> org-roam-forward-links-cache
-                           (gethash (abs-path "new_f1.org"))) :not :to-be nil)
-
-              (expect (->> org-roam-forward-links-cache
-                           (gethash (abs-path "new_f1.org"))
-                           (member (abs-path "nested/f1.org"))) :not :to-be nil)
-              ;; Links are updated
-              (expect (with-temp-buffer
-                        (insert-file-contents (abs-path "nested/f1.org"))
-                        (buffer-string)) :to-match (regexp-quote "[[file:../new_f1.org][File 1]]")))
-
-
-          (it "f1 -> f1 with spaces"
-              (rename-file (abs-path "f1.org")
-                           (abs-path "f1 with spaces.org"))
-              ;; Cache should be cleared of old file
-              (expect (gethash (abs-path "f1.org")  org-roam-forward-links-cache) :to-be nil)
-              (expect (->> org-roam-backward-links-cache
-                           (gethash (abs-path "nested/f1.org"))
-                           (hash-table-keys)
-                           (member (abs-path "f1.org"))) :to-be nil)
-              ;; Links are updated
-              (expect (with-temp-buffer
-                        (insert-file-contents (abs-path "nested/f1.org"))
-                        (buffer-string)) :to-match (regexp-quote "[[file:../f1 with spaces.org][File 1]]")))
-
-          (it "no-title -> meaningful-title"
-              (rename-file (abs-path "no-title.org")
-                           (abs-path "meaningful-title.org"))
-              ;; File has no forward links
-              (expect (gethash (abs-path "no-title.org")  org-roam-forward-links-cache) :to-be nil)
-              (expect (gethash (abs-path "meaningful-title.org")  org-roam-forward-links-cache) :to-be nil)
-
-              (expect (->> org-roam-forward-links-cache
-                           (gethash (abs-path "f3.org"))
-                           (member (abs-path "no-title.org"))) :to-be nil)
-
-              (expect (->> org-roam-forward-links-cache
-                           (gethash (abs-path "f3.org"))
-                           (member (abs-path "meaningful-title.org"))) :not :to-be nil)
-
-              ;; Links are updated with the appropriate name
-              (expect (with-temp-buffer
-                        (insert-file-contents (abs-path "f3.org"))
-                        (buffer-string)) :to-match (regexp-quote "[[file:meaningful-title.org][meaningful-title]]"))))
-
-(describe "delete file updates cache"
-          (before-each
-           (org-roam--test-init)
-           (org-roam--clear-cache)
-           (org-roam--test-build-cache))
-          (it "delete f1"
-              (delete-file (abs-path "f1.org"))
-              (expect (->> org-roam-forward-links-cache
-                           (gethash (abs-path "f1.org"))) :to-be nil)
-              (expect (->> org-roam-backward-links-cache
-                           (gethash (abs-path "nested/f1.org"))
-                           (gethash (abs-path "f1.org"))) :to-be nil)
-              (expect (->> org-roam-backward-links-cache
-                           (gethash (abs-path "nested/f1.org"))
-                           (gethash (abs-path "nested/f2.org"))) :not :to-be nil)))
+;;; test-org-roam.el ends here