Merge pull request #13 from keanedp/update_dependencies_and_migrate_jodconverter

Update dependencies and resolve JODConverter breaking changes

Author: matthewdowney

README.md

@@ -23,6 +23,10 @@ Lein:
     - [Grids](#grids)
     - [Templates](#templates)
 - [Roadmap](#roadmap)
+- [Development](#development)
+    - [Unit Tests](#unit-tests)
+    - [Office Integration Tests](#office-integration-tests)
+    - [All Tests](#all-tests)
 
 ## Getting Started
 
@@ -113,7 +117,7 @@ contains final result of those calculations.
 
 ### PDF Generation
 
-If you're on a system that uses an OpenOffice implementation of Excel, PDF 
+If you're on a system that uses a LibreOffice or Apache OpenOffice implementation of Excel, PDF 
 generation works the same was as creating a spreadsheet:
 
 ```clojure
@@ -251,3 +255,25 @@ For example, you can try:
   not sure what the best way to extract style data is, since there are so many
   possible values.
 
+## Development
+
+### Unit Tests
+
+Standard unit tests can be run with the following command:
+
+`$ lein test`
+
+### Office Integration Tests
+
+This test selector is designed to run tests that are dependent on the presence of LibreOffice or OpenOffice. 
+
+These tests can be run with:
+
+`$ lein test :office-integrations`
+
+### All Tests
+
+Run all tests with the following command:
+
+`$ lein test :all`
+ 

project.clj

@@ -3,8 +3,12 @@
   :url "https://github.com/matthewdowney/excel-clj"
   :license {:name "Eclipse Public License"
             :url "http://www.eclipse.org/legal/epl-v10.html"}
-  :dependencies [[org.clojure/clojure "1.10.1"]
-                 [com.taoensso/encore "3.12.1"]
+  :dependencies [[org.clojure/clojure "1.10.3"]
+                 [com.taoensso/encore "3.21.0"]
                  [com.taoensso/tufte "2.2.0"]
-                 [org.apache.poi/poi-ooxml "4.1.2"]
-                 [org.jodconverter/jodconverter-core "4.0.0-RELEASE"]])
+                 [org.apache.poi/poi-ooxml "5.2.0"]
+                 [org.jodconverter/jodconverter-local "4.4.2"]]
+  :profiles {:test {:dependencies [[org.apache.logging.log4j/log4j-core "2.17.1"]
+                                   [org.slf4j/slf4j-nop "1.7.36"]]}}
+  :test-selectors {:default             (complement :office-integrations)
+                   :office-integrations :office-integrations})

src/excel_clj/file.clj

@@ -15,8 +15,8 @@
   (:import (org.apache.poi.xssf.streaming SXSSFSheet)
            (org.apache.poi.ss.usermodel Sheet)
            (java.io File)
-           (org.jodconverter.office DefaultOfficeManagerBuilder)
-           (org.jodconverter OfficeDocumentConverter)
+           (org.jodconverter.local.office LocalOfficeManager)
+           (org.jodconverter.local LocalConverter)
            (java.awt Desktop HeadlessException)))
 
 
@@ -140,16 +140,20 @@
   "Convert the `from-document`, either a File or a path to any office document,
   to pdf format and write the pdf to the given pdf-path.
 
-  Requires OpenOffice. See https://github.com/sbraconnier/jodconverter.
+  Requires LibreOffice or Apache OpenOffice https://github.com/sbraconnier/jodconverter
 
   Returns a File pointing at the PDF."
   [from-document pdf-path]
   (let [path (force-extension pdf-path "pdf")
-        office-manager (.build (DefaultOfficeManagerBuilder.))]
+        office-manager (-> (LocalOfficeManager/builder)
+                           (.build))]
     (.start office-manager)
     (try
-      (let [document-converter (OfficeDocumentConverter. office-manager)]
-        (.convert document-converter (io/file from-document) (io/file path)))
+      (let [document-converter (LocalConverter/make office-manager)]
+        (-> document-converter
+            (.convert (io/file from-document))
+            (.to (io/file path))
+            (.execute)))
       (finally
         (.stop office-manager)))
     (io/file path)))
@@ -181,37 +185,38 @@
   (open (write-pdf! workbook (temp ".pdf"))))
 
 
-(defn example
-  "Write & open a sheet composed of a simple grid."
-  []
-  (let [grid [["A" "B" "C"]
-              [1 2 3]]]
-    (quick-open! {"Sheet 1" grid})))
-
-
-(defn example-plus
-  "Write & open a sheet composed of a more involved grid."
-  []
-  (let [t (java.util.Calendar/getInstance)
-        grid [["String" "Abc"]
-              ["Numbers" 100M 1.234 1234 12345N]
-              ["Date (not styled, styled)" t (style t {:data-format :ymd})]]
-
-        header-style {:border-bottom :thin :font {:bold true}}
-        header-rows [[(-> "Type"
-                          (style header-style)
-                          (dims {:height 2})
-                          (style {:vertical-alignment :center}))
-                      (-> "Examples"
-                          (style header-style)
-                          (dims {:width 4})
-                          (style {:alignment :center :border-bottom :none}))]
-                     (mapv #(style % {:font {:italic true}
-                                      :alignment :center
-                                      :border-bottom :thin})
-                           [nil 1 2 3 4])]
-        excel-file (quick-open! {"Sheet 1" (concat header-rows grid)})]
-    (try
-      (open (convert-pdf! excel-file (temp ".pdf")))
-      (catch Exception e
-        (println "(Couldn't open a PDF on this platform.)")))))
+(comment
+  (defn example
+    "Write & open a sheet composed of a simple grid."
+    []
+    (let [grid [["A" "B" "C"]
+                [1 2 3]]]
+      (quick-open! {"Sheet 1" grid})))
+
+
+  (defn example-plus
+    "Write & open a sheet composed of a more involved grid."
+    []
+    (let [t (java.util.Calendar/getInstance)
+          grid [["String" "Abc"]
+                ["Numbers" 100M 1.234 1234 12345N]
+                ["Date (not styled, styled)" t (style t {:data-format :ymd})]]
+
+          header-style {:border-bottom :thin :font {:bold true}}
+          header-rows [[(-> "Type"
+                            (style header-style)
+                            (dims {:height 2})
+                            (style {:vertical-alignment :center}))
+                        (-> "Examples"
+                            (style header-style)
+                            (dims {:width 4})
+                            (style {:alignment :center :border-bottom :none}))]
+                       (mapv #(style % {:font          {:italic true}
+                                        :alignment     :center
+                                        :border-bottom :thin})
+                             [nil 1 2 3 4])]
+          excel-file (quick-open! {"Sheet 1" (concat header-rows grid)})]
+      (try
+        (open (convert-pdf! excel-file (temp ".pdf")))
+        (catch Exception e
+          (println "(Couldn't open a PDF on this platform.)"))))))

test/excel_clj/core_test.clj

@@ -54,6 +54,6 @@
         (println "Writing example template...")
         (let [template (clojure.java.io/resource "uptime-template.xlsx")
               new-data {"raw" (table-grid example-template-data)}]
-          (append! new-data template "filled-in-template.xlsx")))
+          (append! new-data template temp-file)))
       (finally
         (io/delete-file temp-file)))))

test/excel_clj/file_test.clj

@@ -0,0 +1,14 @@
+(ns excel-clj.file-test
+  (:require [clojure.test :refer :all]
+            [excel-clj.file :as file]
+            [clojure.java.io :as io]))
+
+(deftest ^:office-integrations convert-to-pdf-test
+  (let [input-file (clojure.java.io/resource "uptime-template.xlsx")
+        temp-pdf-file (io/file (file/temp ".pdf"))]
+    (try
+      (testing "Convert XLSX file to PDF"
+        (println "Writing example PDF...")
+        (file/convert-pdf! input-file temp-pdf-file))
+      (finally
+        (io/delete-file temp-pdf-file)))))

test/excel_clj/poi_test.clj

@@ -11,7 +11,6 @@
          :success)
       "Example function writes successfully."))
 
-
 (deftest performance-test
   (testing "Performance is reasonable"
     (println "Starting performance test -- writing to a temp file...")