Support "resources" front-matter (Hugo v0.33+)

https://github.com/kaushalmodi/ox-hugo/issues/115

ox-hugo.el

@@ -604,6 +604,7 @@ newer."
         (?t "To temporary buffer"
             (lambda (a s v _b)
               (org-hugo-export-as-md a s v)))))
+;;;; translate-alist
   :translate-alist '((code . org-hugo-kbd-tags-maybe)
                      (example-block . org-hugo-example-block)
                      (export-block . org-hugo-export-block)
@@ -615,7 +616,7 @@ newer."
                      (paragraph . org-hugo-paragraph)
                      (src-block . org-hugo-src-block))
   :filters-alist '((:filter-body . org-hugo-body-filter))
-
+;;;; options-alist
   ;;                KEY                       KEYWORD                    OPTION  DEFAULT                     BEHAVIOR
   :options-alist '(;; Variables not setting the front-matter directly
                    (:with-toc nil "toc" org-hugo-export-with-toc)
@@ -689,7 +690,8 @@ newer."
                    ;; EXPORT_HUGO_CATEGORIES property can be used to
                    ;; override inherited categories and Org-style
                    ;; categories (Org-style tags with "@" prefix).
-
+                   ;; resources
+                   (:hugo-resources "HUGO_RESOURCES" nil nil)
                    ;; title
                    ;; "title" is parsed from the Org #+TITLE or the subtree heading.
                    ;; type
@@ -938,6 +940,97 @@ If hugo is not found, return nil."
           (setq short-ver (mapconcat #'number-to-string short-ver-list "."))))
       (cons long-ver short-ver))))
 
+(defun org-hugo--get-resources-alist (resources)
+  "Generate a merged RESOURCES alist.
+
+All parameters for the same \"src\" are merged together in the
+same lisp form.  Parameters that are none of \"src\", \"title\"
+or \"name\" are packed into an alist with `car' as \"params\"."
+  ;; (message "[resources IN DBG]: %S" resources)
+  (when resources
+    (let (src1 all-src src-cons src-already-exists)
+      (dolist (res resources)
+        ;; (message "res: %S" res)
+        (let ((key (car res)))
+          (cond
+           ((equal key 'src)
+            (unless (null src1)
+              (setq src1 (nreverse src1))
+              (if src-already-exists
+                  (setcdr src-already-exists (cdr src1))
+                (push src1 all-src)))
+            (setq src-cons res)
+            (setq src-already-exists (assoc src-cons all-src))
+            ;; (message "%S exists? %S" (cdr src-cons) src-already-exists)
+            (setq src1 (or (nreverse src-already-exists) (list res)))
+            ;; (message "src1 temp: %S" src1)
+            )
+           ((member key '(title name))
+            (push res src1))
+           (t                             ;Resource Params
+            (let* ((params-cons (assoc 'params src1))
+                   (params (cdr params-cons)))
+              (if params
+                  (progn
+                    ;; (message "params 1: %S" params)
+                    (push res params)
+                    (setq params (nreverse params))
+                    ;; (message "params 2: %S" params)
+                    (setcdr params-cons params))
+                (setq params (list res))
+                (push `(params . ,params) src1))
+              ;; (message "src1 temp 2: %S" src1)
+              (setcdr (assoc 'params src1) params))))))
+      (setq src1 (nreverse src1))
+      ;; (message "src1: %S" src1)
+      (if src-already-exists
+          (setcdr src-already-exists (cdr src1))
+        (push src1 all-src))
+      ;; Retain the order of src
+      (setq all-src (nreverse all-src))
+      ;; (message "all-src: %S" all-src)
+      all-src)))
+
+(defun org-hugo--get-yaml-toml-list-string (value)
+  "Return VALUE as a YAML/TOML list represented as a string.
+
+If VALUE is a string, each `org-hugo--internal-list-separator'
+separated string component will be interpreted as a string
+element.
+
+If VALUE is a list, it is first converted to a
+`org-hugo--internal-list-separator' separated string.
+
+Return a string representing a YAML/TOML list.
+
+Examples:
+
+  \"abc\ndef\"              -> \"[\\\"abc\\\", \\\"def\\\"]\"
+
+  \(\"abc\" \"def\")   -> \"[\\\"abc\\\", \\\"def\\\"]\"
+"
+  (when (listp value)
+    ;; Convert value to a string
+    (setq value (mapconcat
+                 (lambda (v)
+                   (cond
+                    ((symbolp v)
+                     (symbol-name v))
+                    ((numberp v)
+                     (number-to-string v))
+                    (t
+                     v)))
+                 value
+                 org-hugo--internal-list-separator)))
+  (concat "["
+          (mapconcat #'identity
+                     (mapcar #'org-hugo--quote-string
+                             (split-string
+                              value
+                              org-hugo--internal-list-separator))
+                     ", ")
+          "]"))
+
 
 
 ;;; Transcode Functions
@@ -2106,6 +2199,8 @@ INFO is a plist used as a communication channel."
                              (push override-prop updated-menu-alist))))
                        updated-menu-alist))
          (custom-fm-data (org-hugo--parse-property-arguments (plist-get info :hugo-custom-front-matter)))
+         (resources (org-hugo--get-resources-alist
+                     (org-hugo--parse-property-arguments (plist-get info :hugo-resources))))
          (blackfriday (org-hugo--parse-blackfriday-prop-to-alist (plist-get info :hugo-blackfriday)))
          (data `(;; The order of the elements below will be the order in which the front matter
                  ;; variables will be ordered.
@@ -2132,7 +2227,8 @@ INFO is a plist used as a communication channel."
                  (draft . ,draft)
                  (creator . ,creator)
                  (blackfriday . ,blackfriday)
-                 (menu . ,menu-alist)))
+                 (menu . ,menu-alist)
+                 (resources . ,resources)))
          (data `,(append data custom-fm-data)))
     ;; (message "[get fm DBG] tags: %s" tags)
     ;; (message "dbg: todo-state: keyword=%S draft=%S" todo-keyword draft)
@@ -2142,6 +2238,7 @@ INFO is a plist used as a communication channel."
     ;; (message "[get fm menu DBG] %S" menu-alist)
     ;; (message "[get fm menu override DBG] %S" menu-alist-override)
     ;; (message "[custom fm data DBG] %S" custom-fm-data)
+    ;; (message "[fm resources OUT DBG] %S" resources)
     ;; (message "[fm data DBG] %S" data)
     (org-hugo--gen-front-matter data fm-format)))
 
@@ -2170,9 +2267,10 @@ are \"toml\" and \"yaml\"."
                     ((string= format "yaml") ":")
                     (t "")))
         (front-matter "")
-        (indent "  ")
+        (indent (make-string 2 ? ))
         (bf-string "")
-        (menu-string ""))
+        (menu-string "")
+        (res-string ""))
     ;; (message "hugo fm format: %s" format)
     (dolist (pair data)
       (let ((key (symbol-name (car pair)))
@@ -2274,6 +2372,67 @@ are \"toml\" and \"yaml\"."
                           (concat bf-value-str
                                   (format "%s%s %s %s\n" indent bf-key sign bf-value)))))
                 (setq bf-string (concat bf-entry-str bf-value-str)))))
+           ((string= key "resources")
+            (when value
+              (dolist (res-alist value)
+                (let ((res-entry-str "")
+                      (res-value-str "")
+                      res-src-present
+                      res-param-str)
+                  (setq res-entry-str (cond ((string= format "toml")
+                                             "[[resources]]\n")
+                                            ((string= format "yaml")
+                                             ;; For YAML, this string
+                                             ;; needs to be inserted
+                                             ;; only once.
+                                             (if (org-string-nw-p res-string)
+                                                 ""
+                                               (format "resources %s\n" sign)))
+                                            (t
+                                             "")))
+                  (dolist (res-pair res-alist)
+                    ;; (message "[resources DBG] res-pair: %S" res-pair)
+                    (let* ((res-key (symbol-name (car res-pair)))
+                           (res-value (cdr res-pair)))
+                      ;; (message "[resources DBG]: %S %S" res-key res-value)
+                      (cond ((string= res-key "params")
+                             (setq indent (make-string 4 ? ))
+                             (setq res-param-str (cond ((string= format "toml")
+                                                        (format "  [resources.%s]\n" res-key))
+                                                       ((string= format "yaml")
+                                                        (format "  %s %s\n" res-key sign))
+                                                       (t
+                                                        "")))
+                             (dolist (param-pair res-value) ;res-value would be an alist of params
+                               (let ((param-key (symbol-name (car param-pair)))
+                                     (param-value (cdr param-pair))
+                                     param-value-str)
+                                 ;; (message "[resources DBG] param-key: %S" param-key)
+                                 ;; (message "[resources DBG] param-value: %S" param-value)
+                                 (setq param-value-str (if (listp param-value)
+                                                           (org-hugo--get-yaml-toml-list-string param-value)
+                                                         (org-hugo--quote-string param-value)))
+                                 (setq res-param-str
+                                       (concat res-param-str
+                                               (format "%s%s %s %s\n"
+                                                       indent param-key sign param-value-str)))))
+                             ;; (message "[resources params DBG] %s" res-param-str)
+                             )
+                            (t
+                             (when (string= res-key "src")
+                               (setq res-src-present t))
+                             (if (and (string= res-key "src")
+                                      (string= format "yaml"))
+                                 (setq indent "- ")
+                               (setq indent "  "))
+                             (setq res-value (org-hugo--quote-string res-value))
+                             (setq res-value-str
+                                   (concat res-value-str
+                                           (format "%s%s %s %s\n"
+                                                   indent res-key sign res-value)))))))
+                  (unless res-src-present
+                    (user-error "`src' must be set for the `resources'"))
+                  (setq res-string (concat res-string res-entry-str res-value-str res-param-str))))))
            (t
             (setq front-matter
                   (concat front-matter
@@ -2282,31 +2441,10 @@ are \"toml\" and \"yaml\"."
                                   sign
                                   (cond ((or (member key '("aliases" "tags" "categories" "keywords"))
                                              (listp value)) ;Custom front matter which are lists
-                                         (when (listp value)
-                                           ;; Convert value to a string
-                                           (setq value (mapconcat
-                                                        (lambda (v)
-                                                          (cond
-                                                           ((symbolp v)
-                                                            (symbol-name v))
-                                                           ((numberp v)
-                                                            (number-to-string v))
-                                                           (t
-                                                            v)))
-                                                        value
-                                                        org-hugo--internal-list-separator)))
-                                         ;; "abc def" -> "[\"abc\", \"def\"]"
-                                         (concat "["
-                                                 (mapconcat #'identity
-                                                            (mapcar #'org-hugo--quote-string
-                                                                    (split-string
-                                                                     value
-                                                                     org-hugo--internal-list-separator))
-                                                            ", ")
-                                                 "]"))
+                                         (org-hugo--get-yaml-toml-list-string value))
                                         (t
                                          (org-hugo--quote-string value)))))))))))
-    (concat sep front-matter bf-string menu-string sep)))
+    (concat sep front-matter bf-string menu-string res-string sep)))
 
 (defun org-hugo--selective-property-inheritance ()
   "Return a list of properties that should be inherited."

test/site/content-org/all-posts.org

@@ -1624,6 +1624,61 @@ The following results in the 'genres' property having the value
 :EXPORT_HUGO_CUSTOM_FRONT_MATTER+: :booleans '(true false)
 :END:
 [[https://github.com/kaushalmodi/ox-hugo/issues/99][Issue # 99]]
+* Resources                                                       :resources:
+** TOML                                                                :toml:
+*** Post with resources in front-matter
+:PROPERTIES:
+:EXPORT_FILE_NAME: resources-in-front-matter-toml
+:EXPORT_HUGO_RESOURCES: :src "image-4.png" :title "TOML: The Fourth Image"
+:EXPORT_HUGO_RESOURCES+: :src "*.png" :name "my-cool-image-:counter" :title "TOML: The Image #:counter"
+:EXPORT_HUGO_RESOURCES+: :src "*.png" :byline "bep"
+:EXPORT_HUGO_RESOURCES+: :src "*.jpg" :title "JPEG Image #:counter"
+:END:
+*** Only custom resource params
+:PROPERTIES:
+:EXPORT_FILE_NAME: resources-only-custom-params
+:EXPORT_HUGO_RESOURCES: :src "*.png" :foo "bar"
+:END:
+*** Custom resource params with list values
+:PROPERTIES:
+:EXPORT_FILE_NAME: resources-custom-params-list-values-toml
+:EXPORT_HUGO_RESOURCES: :src "*.png" :animals '(dog cat "penguin" "mountain gorilla")
+:EXPORT_HUGO_RESOURCES+: :strings-symbols '("abc" def "two words")
+:EXPORT_HUGO_RESOURCES+: :integers '(123 -5 17 1_234)
+:EXPORT_HUGO_RESOURCES+: :floats '(12.3 -5.0 -17E-6)
+:EXPORT_HUGO_RESOURCES+: :booleans '(true false)
+:EXPORT_HUGO_RESOURCES+: :foo bar
+:END:
+*** No "src" in resources front-matter         :dont_export_during_make_test:
+:PROPERTIES:
+:EXPORT_FILE_NAME: resources-no-src
+:EXPORT_HUGO_RESOURCES: :foo "bar"
+:END:
+This is illegal --- You'll get a user-error.
+
+The =src= field *must* be specified for the =resources= front-matter.
+** YAML                                                                :yaml:
+:PROPERTIES:
+:EXPORT_HUGO_FRONT_MATTER_FORMAT: yaml
+:END:
+*** Post with resources in front-matter
+:PROPERTIES:
+:EXPORT_FILE_NAME: resources-in-front-matter-yaml
+:EXPORT_HUGO_RESOURCES: :src "image-4.png" :title "The Fourth Image"
+:EXPORT_HUGO_RESOURCES+: :src "*.png" :name "my-cool-image-:counter" :title "The Image #:counter"
+:EXPORT_HUGO_RESOURCES+: :src "*.png" :byline "bep"
+:EXPORT_HUGO_RESOURCES+: :src "*.jpg" :title "JPEG Image #:counter"
+:END:
+*** Custom resource params with list values
+:PROPERTIES:
+:EXPORT_FILE_NAME: resources-custom-params-list-values-yaml
+:EXPORT_HUGO_RESOURCES: :src "*.png" :animals '(dog cat "penguin" "mountain gorilla")
+:EXPORT_HUGO_RESOURCES+: :strings-symbols '("abc" def "two words")
+:EXPORT_HUGO_RESOURCES+: :integers '(123 -5 17 1_234)
+:EXPORT_HUGO_RESOURCES+: :floats '(12.3 -5.0 -17E-6)
+:EXPORT_HUGO_RESOURCES+: :booleans '(true false)
+:EXPORT_HUGO_RESOURCES+: :foo bar
+:END:
 * Outputs                                                           :outputs:
 ** Output HTML and JSON                                                :json:
 :PROPERTIES:

test/site/content/posts/resources-custom-params-list-values-toml.md

@@ -0,0 +1,14 @@
++++
+title = "Custom resource params with list values"
+tags = ["resources", "toml"]
+draft = false
+[[resources]]
+  src = "*.png"
+  [resources.params]
+    booleans = [true, false]
+    integers = [123, -5, 17, 1_234]
+    animals = ["dog", "cat", "penguin", "mountain gorilla"]
+    strings-symbols = ["abc", "def", "two words"]
+    floats = [12.3, -5.0, -1.7e-05]
+    foo = "bar"
++++

test/site/content/posts/resources-custom-params-list-values-yaml.md

@@ -0,0 +1,14 @@
+---
+title : "Custom resource params with list values"
+tags : ["resources", "yaml"]
+draft : false
+resources :
+- src : "*.png"
+  params :
+    booleans : [true, false]
+    integers : [123, -5, 17, 1_234]
+    animals : ["dog", "cat", "penguin", "mountain gorilla"]
+    strings-symbols : ["abc", "def", "two words"]
+    floats : [12.3, -5.0, -1.7e-05]
+    foo : "bar"
+---

test/site/content/posts/resources-in-front-matter-toml.md

@@ -0,0 +1,17 @@
++++
+title = "Post with resources in front-matter"
+tags = ["resources", "toml"]
+draft = false
+[[resources]]
+  src = "image-4.png"
+  title = "TOML: The Fourth Image"
+[[resources]]
+  src = "*.png"
+  name = "my-cool-image-:counter"
+  title = "TOML: The Image #:counter"
+  [resources.params]
+    byline = "bep"
+[[resources]]
+  src = "*.jpg"
+  title = "JPEG Image #:counter"
++++

test/site/content/posts/resources-in-front-matter-yaml.md

@@ -0,0 +1,15 @@
+---
+title : "Post with resources in front-matter"
+tags : ["resources", "yaml"]
+draft : false
+resources :
+- src : "image-4.png"
+  title : "The Fourth Image"
+- src : "*.png"
+  name : "my-cool-image-:counter"
+  title : "The Image #:counter"
+  params :
+    byline : "bep"
+- src : "*.jpg"
+  title : "JPEG Image #:counter"
+---

test/site/content/posts/resources-only-custom-params.md

@@ -0,0 +1,9 @@
++++
+title = "Only custom resource params"
+tags = ["resources", "toml"]
+draft = false
+[[resources]]
+  src = "*.png"
+  [resources.params]
+    foo = "bar"
++++