From b65cd8c828ce150cedcb34c2bf87bb61636702ed Mon Sep 17 00:00:00 2001 From: Raymond Huang Date: Thu, 9 Mar 2017 00:03:28 -0800 Subject: Add ability to name src blocks and auto-collapse code blocks. --- ox-jira.el | 33 +++++++++++++++++++++++++++------ test/ox-jira-test.el | 38 ++++++++++++++++++++++++++++++++------ 2 files changed, 59 insertions(+), 12 deletions(-) diff --git a/ox-jira.el b/ox-jira.el index ff95e9e..a59a192 100644 --- a/ox-jira.el +++ b/ox-jira.el @@ -40,6 +40,23 @@ (require 'ox) (require 'ox-publish) + +;;; User Configurable Options +(defgroup org-export-jira nil + "Options specific to JIRA export back-end." + :tag "Org Export JIRA" + :group 'org-export + :version "24.4" + :package-version '(ox-jira . "0.1")) + +(defcustom org-jira-src-collapse-threshold 30 + "Minimum number of lines in a src block to set collapse=true in JIRA/Confluence {code} block." + :group 'org-export-jira + :type '(integer)) + + + +;;; Defining Backend (org-export-define-backend 'jira '((babel-call . (lambda (&rest args) (ox-jira--not-implemented 'babel-call))) (body . (lambda (&rest args) (ox-jira--not-implemented 'body))) @@ -96,6 +113,8 @@ (verbatim . ox-jira-verbatim) (verse-block . (lambda (&rest args) (ox-jira--not-implemented 'verse-block)))) :filters-alist '((:filter-parse-tree . ox-jira-fix-multi-paragraph-items)) + :options-alist + '((:src-collapse-threshold nil nil org-jira-src-collapse-threshold)) :menu-entry '(?j "Export to JIRA" ((?j "As JIRA buffer" ox-jira-export-as-jira)))) @@ -386,13 +405,15 @@ the plist used as a communication channel." CONTENTS holds the contents of the src-block. INFO is a plist holding contextual information." (when (org-string-nw-p (org-element-property :value src-block)) - (let* ((lang (org-element-property :language src-block)) - (lang (if (member lang '("actionscript" "html" "java" "javascript" "sql" "xhtml" "xml")) lang)) - (code (org-export-format-code-default src-block info))) + (let* ((title (or (org-element-property :name src-block) "")) + (lang (org-element-property :language src-block)) + (lang (if (member lang '("actionscript" "html" "java" "javascript" "sql" "xhtml" "xml")) lang "none")) + (code (org-export-format-code-default src-block info)) + (collapse (if (< (plist-get info :src-collapse-threshold) + (org-count-lines code)) + "true" "false"))) (concat - (if lang - (format "{code:%s}" lang) - "{code}") + (format "{code:title=%s|language=%s|collapse=%s}" title lang collapse) code "{code}")))) diff --git a/test/ox-jira-test.el b/test/ox-jira-test.el index a302678..9b47cef 100644 --- a/test/ox-jira-test.el +++ b/test/ox-jira-test.el @@ -26,7 +26,7 @@ (require 'ox-jira) (defun to-jira (string) - (org-export-string-as string 'jira)) + (org-export-string-as string 'jira nil '(:src-collapse-threshold 3))) ;; This is my first foray into testing in Emacs. Please be kind. @@ -197,9 +197,9 @@ fo 3. fum"))) (should (equal "# fi -#* {code:sql}SELECT 1; +#* {code:title=|language=sql|collapse=false}SELECT 1; {code} -{code:sql}SELECT 2; +{code:title=|language=sql|collapse=false}SELECT 2; {code} #* fofo # fa @@ -225,7 +225,7 @@ fo " (to-jira "fi fo [fa] fum")))) (ert-deftest ox-jira-test/src-blocks () - (should (equal "{code}echo hello + (should (equal "{code:title=|language=none|collapse=false}echo hello # echo world {code} " (to-jira "#+begin_src sh @@ -233,7 +233,7 @@ fo # echo world #+end_src "))) - (should (equal "{code:sql}BEGIN; + (should (equal "{code:title=|language=sql|collapse=false}BEGIN; SELECT NOW(); END; {code} @@ -242,7 +242,33 @@ END; SELECT NOW(); END; #+end_src -")))) +"))) + (should (equal "{code:title=Hello|language=sql|collapse=false}BEGIN; +SELECT NOW(); +END; +{code} +" (to-jira "#+NAME: Hello + #+begin_src sql + BEGIN; + SELECT NOW(); + END; + #+end_src +"))) + + (should (equal "{code:title=Hello|language=sql|collapse=true}BEGIN; +SELECT NOW(); +SELECT NOW(); +END; +{code} +" (to-jira "#+NAME: Hello + #+begin_src sql + BEGIN; + SELECT NOW(); + SELECT NOW(); + END; + #+end_src +"))) + ) ;; The Holy Grail. Do me proud, Org mode! ;; -- cgit v1.2.3 From 7f6e6a87b542eedfe270a196a76ebaed55634e45 Mon Sep 17 00:00:00 2001 From: Raymond Huang Date: Mon, 20 Mar 2017 20:02:55 -0700 Subject: Use caption instead of name --- ox-jira.el | 2 +- test/ox-jira-test.el | 6 +++--- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/ox-jira.el b/ox-jira.el index a59a192..f163cf9 100644 --- a/ox-jira.el +++ b/ox-jira.el @@ -405,7 +405,7 @@ the plist used as a communication channel." CONTENTS holds the contents of the src-block. INFO is a plist holding contextual information." (when (org-string-nw-p (org-element-property :value src-block)) - (let* ((title (or (org-element-property :name src-block) "")) + (let* ((title (apply #'concat (org-export-get-caption src-block))) (lang (org-element-property :language src-block)) (lang (if (member lang '("actionscript" "html" "java" "javascript" "sql" "xhtml" "xml")) lang "none")) (code (org-export-format-code-default src-block info)) diff --git a/test/ox-jira-test.el b/test/ox-jira-test.el index 9b47cef..90716d5 100644 --- a/test/ox-jira-test.el +++ b/test/ox-jira-test.el @@ -247,7 +247,7 @@ END; SELECT NOW(); END; {code} -" (to-jira "#+NAME: Hello +" (to-jira "#+CAPTION: Hello #+begin_src sql BEGIN; SELECT NOW(); @@ -255,12 +255,12 @@ END; #+end_src "))) - (should (equal "{code:title=Hello|language=sql|collapse=true}BEGIN; + (should (equal "{code:title=Hello World|language=sql|collapse=true}BEGIN; SELECT NOW(); SELECT NOW(); END; {code} -" (to-jira "#+NAME: Hello +" (to-jira "#+CAPTION: Hello World #+begin_src sql BEGIN; SELECT NOW(); -- cgit v1.2.3 From 85ef8dce3f3bab1d3cf9b8818a7569992dc87808 Mon Sep 17 00:00:00 2001 From: Raymond Huang Date: Sat, 25 Mar 2017 18:02:01 -0700 Subject: PR feedback for var naming --- ox-jira.el | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/ox-jira.el b/ox-jira.el index f163cf9..e623cee 100644 --- a/ox-jira.el +++ b/ox-jira.el @@ -42,16 +42,16 @@ ;;; User Configurable Options -(defgroup org-export-jira nil +(defgroup ox-jira-export nil "Options specific to JIRA export back-end." :tag "Org Export JIRA" :group 'org-export :version "24.4" :package-version '(ox-jira . "0.1")) -(defcustom org-jira-src-collapse-threshold 30 +(defcustom ox-jira-src-collapse-threshold 30 "Minimum number of lines in a src block to set collapse=true in JIRA/Confluence {code} block." - :group 'org-export-jira + :group 'ox-export-jira :type '(integer)) @@ -114,7 +114,7 @@ (verse-block . (lambda (&rest args) (ox-jira--not-implemented 'verse-block)))) :filters-alist '((:filter-parse-tree . ox-jira-fix-multi-paragraph-items)) :options-alist - '((:src-collapse-threshold nil nil org-jira-src-collapse-threshold)) + '((:src-collapse-threshold nil nil ox-jira-src-collapse-threshold)) :menu-entry '(?j "Export to JIRA" ((?j "As JIRA buffer" ox-jira-export-as-jira)))) -- cgit v1.2.3