(chore): cleanup and re-order code (#213)

org-roam-db.el

@@ -1,146 +0,0 @@
-;;; org-roam-db.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>
-
-;; 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 code is heavily referenced from https://github.com/magit/forge.
-;;
-;;; Code:
-
-(require 'emacsql)
-(require 'emacsql-sqlite)
-
-;;; Options
-
-(defcustom org-roam-directory (expand-file-name "~/org-roam/")
-  "Default path to Org-roam files.
-
-All Org files, at any level of nesting, is considered part of the Org-roam."
-  :type 'directory
-  :group 'org-roam)
-
-(defconst org-roam-db-filename "org-roam.db"
-  "Name of the Org-roam database file.")
-
-(defconst org-roam--db-version 1)
-(defconst org-roam--sqlite-available-p
-  (with-demoted-errors "Org-roam initialization: %S"
-    (emacsql-sqlite-ensure-binary)
-    t))
-
-(defvar org-roam--db-connection (make-hash-table :test #'equal)
-  "Database connection to Org-roam database.")
-
-;;; Core
-
-(defun org-roam--get-db ()
-  "Return the sqlite db file."
-  (interactive "P")
-  (expand-file-name org-roam-db-filename org-roam-directory))
-
-(defun org-roam--get-db-connection ()
-  "Return the database connection, if any."
-  (gethash (file-truename org-roam-directory)
-           org-roam--db-connection))
-
-(defun org-roam-db ()
-  (unless (and (org-roam--get-db-connection)
-               (emacsql-live-p (org-roam--get-db-connection)))
-    (let* ((db-file (org-roam--get-db))
-           (init-db (not (file-exists-p db-file))))
-      (make-directory (file-name-directory db-file) t)
-      (let ((conn (emacsql-sqlite db-file)))
-        (puthash (file-truename 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-maybe-update 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. %s"
-             "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--get-db-connection))
-
-;;; Api
-
-(defun org-roam-sql (sql &rest args)
-  (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)
-      (last-modified :not-null)
-      ])
-
-    (file-links
-     [(file-from :not-null)
-      (file-to :not-null)
-      (properties :not-null)])
-
-    (titles
-     [
-      (file :not-null)
-      titles])
-
-    (refs
-     [(ref :unique :not-null)
-      (file :not-null)])))
-
-(defun org-roam--db-init (db)
-  (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-maybe-update (db version)
-  (emacsql-with-transaction db
-    'ignore
-    ;; Do nothing now
-    version))
-
-(defun org-roam--db-close (&optional db)
-  (unless db
-    (setq db (org-roam--get-db-connection)))
-  (when (and db (emacsql-live-p db))
-    (emacsql-close db)))
-
-(defun org-roam--db-close-all ()
-  (dolist (conn (hash-table-values org-roam--db-connection))
-    (org-roam--db-close conn)))
-
-(provide 'org-roam-db)
-
-;;; org-roam-db.el ends here

org-roam-protocol.el

@@ -28,7 +28,9 @@
 ;;; Code:
 
 (require 'org-protocol)
-(require 'org-roam-utils)
+(require 'org-roam)
+
+(declare-function org-roam-find-ref "org-roam" (&optional info))
 
 (defun org-roam-protocol-open-ref (info)
   "Process an org-protocol://roam-ref?ref= style url with INFO.

org-roam-utils.el

@@ -1,98 +0,0 @@
-;;; org-roam-utils.el --- Org-roam utility functions  -*- coding: utf-8; lexical-binding: t -*-
-
-;; Copyright © 2020 Jethro Kuan <jethrokuan95@gmail.com>
-;; Author: Jethro Kuan <jethrokuan95@gmail.com>
-
-;; 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:
-;;
-;; Provides several utility functions used throughout Org-roam.
-;;
-;;; Code:
-
-(require 'f)
-(require 'ob-core)  ;for org-babel-parse-header-arguments
-
-(defun org-roam--plist-to-alist (plist)
-  "Return an alist of the property-value pairs in PLIST."
-  (let (res)
-    (while plist
-      (let ((prop (intern (substring (symbol-name (pop plist)) 1 nil)))
-            (val (pop plist)))
-        (push (cons prop val) res)))
-    res))
-
-(defun org-roam--touch-file (path)
-  "Touches an empty file at PATH."
-  (make-directory (file-name-directory path) t)
-  (f-touch path))
-
-(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--org-roam-file-p (&optional file)
-  "Return t if FILE is part of org-roam system, return nil otherwise.
-If FILE is not specified, use the current-buffer file path."
-  (let ((path (or file
-                  (buffer-file-name (current-buffer)))))
-    (and path
-         (org-roam--org-file-p path)
-         (f-descendant-of-p (file-truename path)
-                            (file-truename org-roam-directory)))))
-
-(defun org-roam--aliases-str-to-list (str)
-  "Function to transform string STR into list of alias titles.
-
-This snippet is obtained from ox-hugo:
-https://github.com/kaushalmodi/ox-hugo/blob/a80b250987bc770600c424a10b3bca6ff7282e3c/ox-hugo.el#L3131"
-  (when (stringp str)
-    (let* ((str (org-trim str))
-           (str-list (split-string str "\n"))
-           ret)
-      (dolist (str-elem str-list)
-        (let* ((format-str ":dummy '(%s)") ;The :dummy key is discarded in the `lst' var below.
-               (alist (org-babel-parse-header-arguments (format format-str str-elem)))
-               (lst (cdr (car alist)))
-               (str-list2 (mapcar (lambda (elem)
-                                    (cond
-                                     ((symbolp elem)
-                                      (symbol-name elem))
-                                     (t
-                                      elem)))
-                                  lst)))
-          (setq ret (append ret str-list2))))
-      ret)))
-
-;;; -
-(provide 'org-roam-utils)
-;;; org-roam-utils.el ends here

tests/test-org-roam.el

@@ -29,8 +29,6 @@
 (require 'buttercup)
 (require 'with-simulated-input)
 (require 'org-roam)
-(require 'org-roam-db)
-(require 'org-roam-utils)
 (require 'dash)
 
 (defun abs-path (file-path)