summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorIan Martins <ianxm@jhu.edu>2020-11-15 19:08:17 -0500
committerIan Martins <ianxm@jhu.edu>2020-11-17 06:38:56 -0500
commit93087e0b3add4935fc6478903a6caff65e067ad9 (patch)
tree8e7177d5649decb49ae987829df3d71ce5fcd8cc
parentc0588fc42d9993d49503819ce1c0c9ab08fbc326 (diff)
downloadorg-mode-93087e0b3add4935fc6478903a6caff65e067ad9.tar.gz
lisp/ob-java.el: Make the default to write to the current directory
* lisp/ob-java.el(org-babel-default-header-args:java): Add :dir default. (org-babel-execute:java): Check for existence of :dir in params using alist-get instead of assq because we want a nil cdr to be false. * testing/lisp/test-ob-java.el (ob-java/simple, ob-java/simple-with-bracket) (ob-java/simple-with-quote, ob-java/simple-return-int) (ob-java/simple-return-float, ob-java/simple-return-string) (ob-java/simple-with-main, ob-java/simple-with-two-methods) (ob-java/simple-with-no-main, ob-java/simple-with-main-args-array) (ob-java/simple-with-main-whitespace, ob-java/simple-with-class) (ob-java/simple-with-non-public-class) (ob-java/simple-with-class-and-package) (ob-java/simple-with-class-attr) (ob-java/simple-with-class-attr-with-package, ob-java/one-arg) (ob-java/args-quoted-string, ob-java/integer-var) (ob-java/var-with-main, ob-java/var-with-class) (ob-java/var-with-class-and-package) (ob-java/var-with-class-and-hanging-curlies, ob-java/two-vars) (ob-java/string-var, ob-java/multiline-string-var) (ob-java/return-vector-using-list, ob-java/return-vector-using-array) (ob-java/read-return-list, ob-java/read-list-return-array) (ob-java/read-return-list-with-package) (ob-java/output-list-with-spaces, ob-java/list-var, ob-java/vector-var) (ob-java/matrix-var, ob-java/matrix-var-with-header) (ob-java/output-table-with-header, ob-java/inhomogeneous_table) (ob-java/import_library, ob-java/import_library_inline) (ob-java/tangle): Set :dir to nil to prevent tests from writing files outside of temporary directory. (ob-java/tangle-with-package, ob-java/simple-dir): (ob-java/simple-dir-with-package): Move :dir param to be consistent with other tests. Most languages write tempfiles to babel's temporary directory, but ob-java originally had to write them to the current directory instead. I suspect this is because java puts the source file in package directories, and babel doesn't expect subdirectories in the babel temporary directory. This change brings back the original behavior. Reported-by: Jarmo Hurri <jarmo.hurri@iki.fi> Ref: https://orgmode.org/list/87mtzk9n30.fsf@iki.fi
-rw-r--r--lisp/ob-java.el13
-rw-r--r--testing/lisp/test-ob-java.el88
2 files changed, 53 insertions, 48 deletions
diff --git a/lisp/ob-java.el b/lisp/ob-java.el
index 4cf8043..1417097 100644
--- a/lisp/ob-java.el
+++ b/lisp/ob-java.el
@@ -35,13 +35,18 @@
(defvar org-babel-temporary-directory) ; from ob-core
-(defvar org-babel-default-header-args:java '((:results . "output"))
+(defvar org-babel-default-header-args:java '((:results . "output")
+ (:dir . "."))
"Default header args for java source blocks.
The docs say functional mode should be the default [1], but
-ob-java didn't support functional mode until recently, so we keep
-scripting mode as the default for now to maintain existing
+ob-java didn't originally support functional mode, so we keep
+scripting mode as the default for now to maintain previous
behavior.
+Most languages write tempfiles to babel's temporary directory,
+but ob-java originally had to write them to the current
+directory, so we keep that as the default behavior.
+
[1] https://orgmode.org/manual/Results-of-Evaluation.html")
(defconst org-babel-header-args:java '((imports . :any))
@@ -159,7 +164,7 @@ replaced in this string.")
(defun org-babel-execute:java (body params)
"Execute a java source block with BODY code and PARAMS params."
(let* (;; if true, run from babel temp directory
- (run-from-temp (not (assq :dir params)))
+ (run-from-temp (not (alist-get :dir params)))
;; class and package
(fullclassname (or (cdr (assq :classname params))
(org-babel-java-find-classname body)))
diff --git a/testing/lisp/test-ob-java.el b/testing/lisp/test-ob-java.el
index 50d3ef5..2bac188 100644
--- a/testing/lisp/test-ob-java.el
+++ b/testing/lisp/test-ob-java.el
@@ -40,7 +40,7 @@
"Hello world program that writes output. Also tests that
ob-java defaults to scripting mode."
(org-test-with-temp-text
- "#+begin_src java :results silent
+ "#+begin_src java :dir 'nil :results silent
System.out.print(42);
#+end_src"
(should (string= "42" (org-babel-execute-src-block)))))
@@ -48,7 +48,7 @@ System.out.print(42);
(ert-deftest ob-java/simple-with-bracket ()
"Hello world program that outputs an open square bracket."
(org-test-with-temp-text
- "#+begin_src java :results output silent
+ "#+begin_src java :dir 'nil :results output silent
System.out.print(\"[42\");
#+end_src"
(should (string= "[42" (org-babel-execute-src-block)))))
@@ -56,7 +56,7 @@ System.out.print(\"[42\");
(ert-deftest ob-java/simple-with-quote ()
"Hello world program that writes quotes."
(org-test-with-temp-text
- "#+begin_src java :results output silent
+ "#+begin_src java :dir 'nil :results output silent
System.out.print(\"\\\"42\\\"\");
#+end_src"
(should (string= "\"42\"" (org-babel-execute-src-block)))))
@@ -64,7 +64,7 @@ System.out.print(\"\\\"42\\\"\");
(ert-deftest ob-java/simple-return-int ()
"Hello world program that returns an int value."
(org-test-with-temp-text
- "#+begin_src java :results value silent
+ "#+begin_src java :dir 'nil :results value silent
return 42;
#+end_src"
(should (eq 42 (org-babel-execute-src-block)))))
@@ -72,7 +72,7 @@ return 42;
(ert-deftest ob-java/simple-return-float ()
"Hello world program that returns a float value."
(org-test-with-temp-text
- "#+begin_src java :results value silent
+ "#+begin_src java :dir 'nil :results value silent
return 42.0;
#+end_src"
(should (equal 42.0 (org-babel-execute-src-block)))))
@@ -80,7 +80,7 @@ return 42.0;
(ert-deftest ob-java/simple-return-string ()
"Hello world program that returns a string value."
(org-test-with-temp-text
- "#+begin_src java :results value silent
+ "#+begin_src java :dir 'nil :results value silent
return \"forty two\";
#+end_src"
(should (string= "forty two" (org-babel-execute-src-block)))))
@@ -88,7 +88,7 @@ return \"forty two\";
(ert-deftest ob-java/simple-with-main ()
"Hello world program that defines a main function."
(org-test-with-temp-text
- "#+begin_src java :results output silent
+ "#+begin_src java :dir 'nil :results output silent
public static void main(String[] args) {
System.out.print(42);
}
@@ -98,7 +98,7 @@ public static void main(String[] args) {
(ert-deftest ob-java/simple-with-two-methods ()
"Hello world program with two methods and no class."
(org-test-with-temp-text
- "#+begin_src java :results output silent
+ "#+begin_src java :dir 'nil :results output silent
public static void main(String[] args) {
System.out.print(foo());
}
@@ -111,7 +111,7 @@ public static int foo() {
(ert-deftest ob-java/simple-with-no-main ()
"Hello world program with no main method. Babel adds a dummy one so it can run without error."
(org-test-with-temp-text
- "#+begin_src java :results output silent
+ "#+begin_src java :dir 'nil :results output silent
public static int foo() {
return 42;
}
@@ -121,7 +121,7 @@ public static int foo() {
(ert-deftest ob-java/simple-with-main-args-array ()
"Hello world program that defines a main function with the square brackets after `args'."
(org-test-with-temp-text
- "#+begin_src java :results output silent
+ "#+begin_src java :dir 'nil :results output silent
public static void main(String args[]) {
System.out.print(42);
}
@@ -131,7 +131,7 @@ public static void main(String args[]) {
(ert-deftest ob-java/simple-with-main-whitespace ()
"Hello world program that defines a main function with the square brackets after `args'."
(org-test-with-temp-text
- "#+begin_src java :results output silent
+ "#+begin_src java :dir 'nil :results output silent
public
static
void
@@ -149,7 +149,7 @@ main
(ert-deftest ob-java/simple-with-class ()
"Hello world program that defines a class."
(org-test-with-temp-text
- "#+begin_src java :results output silent
+ "#+begin_src java :dir 'nil :results output silent
public class Simple {
public static void main(String[] args) {
System.out.print(42);
@@ -161,7 +161,7 @@ public class Simple {
(ert-deftest ob-java/simple-with-non-public-class ()
"Hello world program that defines a non-public class."
(org-test-with-temp-text
- "#+begin_src java :results output silent
+ "#+begin_src java :dir 'nil :results output silent
class Simple {
public static void main(String[] args) {
System.out.print(42);
@@ -173,7 +173,7 @@ class Simple {
(ert-deftest ob-java/simple-with-class-and-package ()
"Hello world program that defines a class and package."
(org-test-with-temp-text
- "#+begin_src java :results output silent
+ "#+begin_src java :dir 'nil :results output silent
package pkg;
public class Simple {
public static void main(String[] args) {
@@ -186,7 +186,7 @@ public class Simple {
(ert-deftest ob-java/simple-with-class-attr ()
"Hello world program with class header attribute."
(org-test-with-temp-text
- "#+begin_src java :results output silent :classname Simple
+ "#+begin_src java :dir 'nil :results output silent :classname Simple
public static void main(String[] args) {
System.out.print(42);
}
@@ -196,7 +196,7 @@ public static void main(String[] args) {
(ert-deftest ob-java/simple-with-class-attr-with-package ()
"Hello world program with class attr with package."
(org-test-with-temp-text
- "#+begin_src java :results output silent :classname pkg.Simple
+ "#+begin_src java :dir 'nil :results output silent :classname pkg.Simple
public static void main(String[] args) {
System.out.print(42);
}
@@ -207,7 +207,7 @@ public static void main(String[] args) {
(ert-deftest ob-java/one-arg ()
"Command line arg."
(org-test-with-temp-text
- "#+begin_src java :results output silent :cmdargs \"fortytwo\"
+ "#+begin_src java :dir 'nil :results output silent :cmdargs \"fortytwo\"
System.out.print(args[0]);
#+end_src"
(should (string= "fortytwo" (org-babel-execute-src-block)))))
@@ -215,7 +215,7 @@ System.out.print(args[0]);
(ert-deftest ob-java/args-quoted-string ()
"Two command line args, first contains a space."
(org-test-with-temp-text
- "#+begin_src java :results output silent :cmdargs \"\\\"forty two\\\" 42\"
+ "#+begin_src java :dir 'nil :results output silent :cmdargs \"\\\"forty two\\\" 42\"
System.out.println(args[0]);
System.out.println(args[1]);
#+end_src"
@@ -226,7 +226,7 @@ System.out.println(args[1]);
(ert-deftest ob-java/integer-var ()
"Read and write an integer variable."
(org-test-with-temp-text
- "#+begin_src java :var a=42 :results output silent
+ "#+begin_src java :dir 'nil :var a=42 :results output silent
System.out.print(a);
#+end_src"
(should (string= "42" (org-babel-execute-src-block)))))
@@ -234,7 +234,7 @@ System.out.print(a);
(ert-deftest ob-java/var-with-main ()
"Read and write an integer variable, with main function provided."
(org-test-with-temp-text
- "#+begin_src java :var a=42 :results output silent
+ "#+begin_src java :dir 'nil :var a=42 :results output silent
public static void main(String[] args) {
System.out.print(a);
}
@@ -244,7 +244,7 @@ public static void main(String[] args) {
(ert-deftest ob-java/var-with-class ()
"Read and write an integer variable, with class provided."
(org-test-with-temp-text
- "#+begin_src java :var a=42 :results output silent
+ "#+begin_src java :dir 'nil :var a=42 :results output silent
public class Main {
public static void main(String[] args) {
System.out.print(a);
@@ -256,7 +256,7 @@ public class Main {
(ert-deftest ob-java/var-with-class-and-package ()
"Read and write an integer variable, with class and package provided."
(org-test-with-temp-text
- "#+begin_src java :var a=42 :results output silent
+ "#+begin_src java :dir 'nil :var a=42 :results output silent
package pkg;
public class Main {
public static void main(String[] args) {
@@ -269,7 +269,7 @@ public class Main {
(ert-deftest ob-java/var-with-class-and-hanging-curlies ()
"Read and write an integer variable, with class with hanging curlies."
(org-test-with-temp-text
- "#+begin_src java :var a=42 :results output silent
+ "#+begin_src java :dir 'nil :var a=42 :results output silent
public class Main
{
public static void main(String[] args)
@@ -283,7 +283,7 @@ public class Main
(ert-deftest ob-java/two-vars ()
"Read two integer variables, combine and write them."
(org-test-with-temp-text
- "#+begin_src java :var a=21 b=2 :results output silent
+ "#+begin_src java :dir 'nil :var a=21 b=2 :results output silent
System.out.print(a*b);
#+end_src"
(should (string= "42" (org-babel-execute-src-block)))))
@@ -291,7 +291,7 @@ System.out.print(a*b);
(ert-deftest ob-java/string-var ()
"Read and write a string variable."
(org-test-with-temp-text
- "#+begin_src java :var a=\"forty two\" :results output silent
+ "#+begin_src java :dir 'nil :var a=\"forty two\" :results output silent
System.out.print(String.format(\"%s, len=%d\", a, a.length()));
#+end_src"
(should (string= "forty two, len=9" (org-babel-execute-src-block)))))
@@ -299,7 +299,7 @@ System.out.print(String.format(\"%s, len=%d\", a, a.length()));
(ert-deftest ob-java/multiline-string-var ()
"Java doesn't support multiline string literals, so this errors."
(org-test-with-temp-text
- "#+begin_src java :var a=\"forty\ntwo\" :results output silent
+ "#+begin_src java :dir 'nil :var a=\"forty\ntwo\" :results output silent
System.out.print(String.format(\"%s, len=%d\", a, a.length()));
#+end_src"
(should-error (org-babel-execute-src-block)))
@@ -310,7 +310,7 @@ System.out.print(String.format(\"%s, len=%d\", a, a.length()));
(ert-deftest ob-java/return-vector-using-list ()
"Return a vector using a list."
(org-test-with-temp-text
- "#+begin_src java :results value vector silent
+ "#+begin_src java :dir 'nil :results value vector silent
import java.util.List;
import java.util.Arrays;
List<List<Integer>> a = Arrays.asList(Arrays.asList(4),
@@ -323,7 +323,7 @@ return a;
(ert-deftest ob-java/return-vector-using-array ()
"Return a vector using an array."
(org-test-with-temp-text
- "#+begin_src java :results value vector silent
+ "#+begin_src java :dir 'nil :results value vector silent
Integer[][] a = {{4}, {2}};
return a;
#+end_src"
@@ -333,7 +333,7 @@ return a;
(ert-deftest ob-java/read-return-list ()
"Read and return a list."
(org-test-with-temp-text
- "#+begin_src java :var a=java_list :results value silent
+ "#+begin_src java :dir 'nil :var a=java_list :results value silent
import java.util.List;
import java.util.Arrays;
List<String> b = Arrays.asList(a.get(0).get(0),
@@ -350,7 +350,7 @@ return b;
(ert-deftest ob-java/read-list-return-array ()
"Read a list and return an array."
(org-test-with-temp-text
- "#+begin_src java :var a=java_list :results value silent
+ "#+begin_src java :dir 'nil :var a=java_list :results value silent
String[] b = {a.get(0).get(0), a.get(1).get(0)};
return b;
#+end_src
@@ -364,7 +364,7 @@ return b;
(ert-deftest ob-java/read-return-list-with-package ()
"Return a vector."
(org-test-with-temp-text
- "#+begin_src java :var a=java_list :results value silent
+ "#+begin_src java :dir 'nil :var a=java_list :results value silent
package pkg;
import java.util.List;
import java.util.Arrays;
@@ -382,7 +382,7 @@ return b;
(ert-deftest ob-java/output-list-with-spaces ()
"Return a vector."
(org-test-with-temp-text
- "#+begin_src java :results output list raw silent
+ "#+begin_src java :dir 'nil :results output list raw silent
System.out.println(\"forty two\");
System.out.println(\"forty two\");
#+end_src"
@@ -394,7 +394,7 @@ System.out.println(\"forty two\");
(ert-deftest ob-java/list-var ()
"Read and write a list variable."
(org-test-with-temp-text
- "#+begin_src java :var a='(\"forty\" \"two\") :results value silent
+ "#+begin_src java :dir 'nil :var a='(\"forty\" \"two\") :results value silent
import java.util.List;
List<String> b = a;
return b;
@@ -405,7 +405,7 @@ return b;
(ert-deftest ob-java/vector-var ()
"Read and write a vector variable."
(org-test-with-temp-text
- "#+begin_src java :var a='[\"forty\" \"two\"] :results value silent
+ "#+begin_src java :dir 'nil :var a='[\"forty\" \"two\"] :results value silent
import java.util.List;
List<String> b = a;
return b;
@@ -416,7 +416,7 @@ return b;
(ert-deftest ob-java/matrix-var ()
"Read and write matrix variable."
(org-test-with-temp-text
- "#+begin_src java :var a=java_matrix :results value silent
+ "#+begin_src java :dir 'nil :var a=java_matrix :results value silent
import java.util.List;
import java.util.Arrays;
List<List<Integer>> b = Arrays.asList(Arrays.asList(a.get(0).get(0), a.get(1).get(0)),
@@ -433,7 +433,7 @@ return b; // transpose
(ert-deftest ob-java/matrix-var-with-header ()
"Read matrix variable and write it with header."
(org-test-with-temp-text
- "#+begin_src java :var a=java_matrix :results value table silent
+ "#+begin_src java :dir 'nil :var a=java_matrix :results value table silent
import java.util.List;
import java.util.Arrays;
List<List> b = Arrays.asList(Arrays.asList(\"col1\", \"col2\"),
@@ -454,7 +454,7 @@ return b; // transpose
(ert-deftest ob-java/output-table-with-header ()
"Write a table that includes a header."
(org-test-with-temp-text
- "#+begin_src java :var a=java_matrix :results output raw table silent
+ "#+begin_src java :dir 'nil :var a=java_matrix :results output raw table silent
System.out.println(\"|col1|col2|\");
System.out.println(\"|-\");
for (int ii=0; ii<a.size(); ii++) {
@@ -474,7 +474,7 @@ for (int ii=0; ii<a.size(); ii++) {
(ert-deftest ob-java/inhomogeneous_table ()
"Read and write an inhomogeneous table."
(org-test-with-temp-text
- "#+begin_src java :var a=java_table :results value silent
+ "#+begin_src java :dir 'nil :var a=java_table :results value silent
import java.util.List;
import java.util.Arrays;
List<List> b = Arrays.asList(Arrays.asList(a.get(0).get(0),
@@ -498,7 +498,7 @@ return b;
(ert-deftest ob-java/import_library ()
"Import a standard java library."
(org-test-with-temp-text
- "#+begin_src java :results output silent :imports java.util.Base64
+ "#+begin_src java :dir 'nil :results output silent :imports java.util.Base64
byte[] encoded = Base64.getEncoder().encode(\"42\".getBytes());
String decoded = new String(Base64.getDecoder().decode(encoded));
System.out.print(String.format(\"encoded=%s, decoded=%s\", new String(encoded), decoded));
@@ -510,7 +510,7 @@ System.out.print(String.format(\"encoded=%s, decoded=%s\", new String(encoded),
(ert-deftest ob-java/import_library_inline ()
"Import a standard java library."
(org-test-with-temp-text
- "#+begin_src java :results output silent
+ "#+begin_src java :dir 'nil :results output silent
import java.util.Base64;
byte[] encoded = Base64.getEncoder().encode(\"42\".getBytes());
String decoded = new String(Base64.getDecoder().decode(encoded));
@@ -525,7 +525,7 @@ System.out.print(String.format(\"encoded=%s, decoded=%s\", new String(encoded),
(ert-deftest ob-java/tangle ()
"Tangle a source block."
(org-test-with-temp-text-in-file
- "#+begin_src java :tangle \"Tangle.java\" :results value :classname Tangle
+ "#+begin_src java :dir 'nil :tangle \"Tangle.java\" :results value :classname Tangle
return \"tangled\";
#+end_src"
(should
@@ -547,7 +547,7 @@ return \"tangled\";
(ert-deftest ob-java/tangle-with-package ()
"Tangle a source block."
(org-test-with-temp-text-in-file
- "#+begin_src java :tangle \"tangle/Tangle.java\" :results value :classname tangle.Tangle
+ "#+begin_src java :dir 'nil :tangle \"tangle/Tangle.java\" :results value :classname tangle.Tangle
return \"tangled\";
#+end_src"
(should
@@ -577,7 +577,7 @@ public class Tangle {
(ert-deftest ob-java/simple-dir ()
"Hello world program that writes output."
(org-test-with-temp-text
- (format "#+begin_src java :results output silent :dir %s
+ (format "#+begin_src java :dir %s :results output silent
System.out.print(42);
#+end_src" org-babel-temporary-directory)
(should (string=
@@ -592,7 +592,7 @@ System.out.print(42);
(ert-deftest ob-java/simple-dir-with-package ()
"Hello world program that writes output."
(org-test-with-temp-text
- (format "#+begin_src java :results output silent :dir %s
+ (format "#+begin_src java :dir %s :results output silent
package pkg;
public class Main {