New release

Makefile

@@ -1,14 +1,15 @@
 #
 # Programs used in the make goals
 #
-export CASK ?= cask
+export CASK  ?= cask
 export EMACS ?= emacs
 
 #
 # General configuration
 #
-export CASK_DIR ?= `${CASK} package-directory`
-export BATCH     = --batch -q -l .emacs/init.el
+export CASK_DIR            ?= `${CASK} package-directory`
+export BATCH                = --batch -q -l .emacs/init.el
+export COVERALLS_REPO_TOKEN = 61YFD7RG1RRJTs0kEuj1aZX7VBgUPiMNO
 
 all: version test
 

README.md

@@ -35,6 +35,7 @@ You can also download the latest version of PlantUML straight into `plantuml-jar
 - Syntax highlight
 - Autocompletion
 - Preview of buffer or region
+- [EXPERIMENTAL] Use either local JAR or remote server for preview
 
 # Enable the major mode
 
@@ -88,6 +89,27 @@ Then you can edit a `plantuml` code block with `plantuml-mode` by hitting `C-'`
 
 When in the `plantuml-mode` buffer you can then hit again `C-'` to return to the original `org-mode` document.
 
+# Execution modes
+
+**EXPERIMENTAL**
+
+As of `v1.3.0` support is added for switching execution mode. The following two modes are available:
+
+- `jar` (default) to run PlantUML as a local JAR file. This is the traditional system used by `plantuml-mode`
+- `server` (experimental) to let an instance of [`plantuml-server`](https://github.com/plantuml/plantuml-server) render the preview
+
+You can customize `plantuml-default-exec-mode` or run `plantuml-set-exec-mode` from a `plantuml-mode` buffer to switch modes.
+
+## Configure server rendering
+
+When selecting `server` execution modes, you can customize the following variable to set the server to use for rendering:
+
+```
+plantuml-server-url
+```
+
+It defaults to `"https://www.plantuml.com/plantuml"`.
+
 # Migration from `puml-mode`
 
 If you were previously using `puml-mode`, you should change any reference to a `puml-..` variable or function to its `plantuml-..` counterpart. Most notably, `puml-plantuml-jar-path` is now just `plantuml-jar-path`.

test/plantuml-config-test.el

@@ -0,0 +1,32 @@
+;;; plantuml-config-test.el --- tests for plantuml-mode configuration knobs  -*- lexical-binding: t; -*-
+
+;; Author: Carlo Sciolla
+;; Maintainer: Carlo Sciolla
+;; URL: https://github.com/skuro/plantuml-mode
+
+;;; Commentary:
+
+;; Test user-accessible configuration knobs
+
+;;; Code:
+
+(require 'plantuml-mode)
+
+(ert-deftest plantuml-config-test/set-exec-mode-happy-path ()
+  "Test switching execution modes"
+  (let ((orig-mode plantuml-exec-mode))
+    ;; happy flows:
+    (plantuml-set-exec-mode "server")
+    (should (equal 'server plantuml-exec-mode))
+    (plantuml-set-exec-mode "jar")
+    (should (equal 'jar plantuml-exec-mode))
+
+    (setq plantuml-exec-mode orig-mode)))
+
+(ert-deftest plantuml-config-test/set-exec-mode-wrong-mode ()
+  "Test setting the exec mode with the wrong text"
+  (should-error (plantuml-set-exec-mode "turing-machine")))
+
+(provide 'plantuml-mode-config-test)
+
+;;; plantuml-config-test.el ends here

test/plantuml-mode-custom-jar-location-test.el

@@ -13,11 +13,11 @@
   (should (equal `("-Djava.awt.headless=true" "-jar"
                    ,(expand-file-name "~/.plantuml/plantuml.jar")
                    "-charset" "UTF-8")
-                 (plantuml-render-command)))
+                 (plantuml-jar-render-command)))
 
   (setq-local plantuml-jar-path "/path/with spaces/plantuml.jar")
   (should (equal `("-Djava.awt.headless=true" "-jar" "/path/with spaces/plantuml.jar" "-charset" "UTF-8")
-                 (plantuml-render-command))))
+                 (plantuml-jar-render-command))))
 
 (provide 'plantuml-mode-custom-jar-location-test)
 

test/plantuml-preview-test.el

@@ -8,16 +8,19 @@
 
 ;;; Code:
 
-(defun assert-preview (puml output &optional format)
+(defun assert-preview (puml output &optional format mode)
   (if format
-    (setq plantuml-output-type format)
-    (setq plantuml-output-type "utxt"))
+      (setq plantuml-output-type format)
+    (setq plantuml-output-type "txt"))
+  (if mode
+      (setq plantuml-exec-mode mode)
+    (setq plantuml-exec-mode 'jar))
   (plantuml-preview-string 42 (read-test-file puml))
   (sleep-for 3)
   (should (equal (format-preview-output (replace-regexp-in-string " " "~" (read-test-file output)))
                  (format-preview-output (replace-regexp-in-string " " "~" (read-preview-buffer))))))
 
-(ert-deftest preview-utxt-test ()
+(ert-deftest preview-txt-test ()
   (setq-local plantuml-jar-path plantuml-test-jar-path)
   (assert-preview "a-b.puml" "a-b.txt"))
 

test/test-helper.el

@@ -53,15 +53,15 @@ Finally, the indented text in the buffer will be compared with AFTER."
   (with-temp-buffer
     ;; fix the JAR location prior to mode initialization
     ;; for some reason, plantuml-mode disregards the setq-local
-    (setq-local plantuml-jar-path plantuml-test-jar-path)
-    (plantuml-init-once)
+    (setq plantuml-jar-path plantuml-test-jar-path)
+    (plantuml-init-once 'jar)
 
     (insert before)
     (goto-char (point-min))
     (plantuml-mode)
     ;; use 2 spaces instead of one tab for indentation
-    (setq-local indent-tabs-mode nil)
-    (setq-local tab-width 2)
+    (setq indent-tabs-mode nil)
+    (setq tab-width 2)
 
     (indent-region (point-min) (point-max))
     (should (equal (buffer-string) after))))