* [PATCH] oc-basic.el: Fix wrong type for the editors field when parsing JSON.
@ 2022-12-20 17:03 Hugo Cisneros
2022-12-25 11:40 ` Ihor Radchenko
0 siblings, 1 reply; 4+ messages in thread
From: Hugo Cisneros @ 2022-12-20 17:03 UTC (permalink / raw)
To: emacs-orgmode
[-- Attachment #1: Type: text/plain, Size: 892 bytes --]
I use org-cite with a JSON bibliography and noticed a bug when an entry only has
an "editors" field but no "authors" field. The function
`org-cite-basic—get-author' correctly falls back to using the editors instead of
the authors, but `org-cite-basic--parse-json’ stringifies only the "authors"
field and not the "editors." This creates an error when other functions assume
they got a string from `org-cite-basic—get-author'. The patch fixes the issue by
applying the same transformation to both "authors" and "editors".
As explained in the ChangeLog entry, this points to a more general issue where
`org-cite-basic--get-field' is expected to return nil or a string, but calls
`org-cite-basic--get-entry' that may return an association list. I am not sure
how to fix that since it means converting anything that
`org-cite-basic--get-entry' may return into a string.
[-- Attachment #2: oc-basic.el.patch --]
[-- Type: application/octet-stream, Size: 2762 bytes --]
From 132a63faecdd4b78a3d2aaaa3fd6082b1c4a4fe7 Mon Sep 17 00:00:00 2001
From: hugcis <hmj.cisneros@gmail.com>
Date: Tue, 20 Dec 2022 17:15:20 +0100
Subject: [PATCH] oc-basic.el: Fix wrong type for the editors field when
parsing JSON.
* lisp/oc-basic.el (org-cite-basic--parse-json): Make sure
`org-cite-basic--parse-json' produces a string for the editors field.
The function `org-cite-basic--get-author' expects a string for both the
"authors" field and the "editors" field.
The conversion to string was only done for the "authors" field in
`org-cite-basic--parse-json'. This patch fixes the issue by applying the
transformation to both "authors" and "editors".
This points to a more general issue where `org-cite-basic--get-field' is
expected to return nil or a string, but calls
`org-cite-basic--get-entry' that may return an association list.
TINYCHANGE
---
lisp/oc-basic.el | 18 +++++++++---------
1 file changed, 9 insertions(+), 9 deletions(-)
diff --git a/lisp/oc-basic.el b/lisp/oc-basic.el
index 3ef7a37e3..01e314bfd 100644
--- a/lisp/oc-basic.el
+++ b/lisp/oc-basic.el
@@ -162,17 +162,17 @@ Return a hash table with citation references as keys and fields alist as values.
(puthash (cdr (assq 'id item))
(mapcar (pcase-lambda (`(,field . ,value))
(pcase field
- ('author
- ;; Author is an array of objects, each
- ;; of them designing a person. These
- ;; objects may contain multiple
- ;; properties, but for this basic
- ;; processor, we'll focus on `given' and
- ;; `family'.
+ ((or 'author 'editors)
+ ;; Author and editors are arrays of
+ ;; objects, each of them designing a
+ ;; person. These objects may contain
+ ;; multiple properties, but for this
+ ;; basic processor, we'll focus on
+ ;; `given' and `family'.
;;
;; For compatibility with BibTeX, add
- ;; "and" between authors.
- (cons 'author
+ ;; "and" between authors and editors.
+ (cons field
(mapconcat
(lambda (alist)
(concat (alist-get 'family alist)
--
2.38.1
[-- Attachment #3: Type: text/plain, Size: 15 bytes --]
Hugo Cisneros
^ permalink raw reply related [flat|nested] 4+ messages in thread
* Re: [PATCH] oc-basic.el: Fix wrong type for the editors field when parsing JSON.
2022-12-20 17:03 [PATCH] oc-basic.el: Fix wrong type for the editors field when parsing JSON Hugo Cisneros
@ 2022-12-25 11:40 ` Ihor Radchenko
2022-12-29 14:21 ` [PATCH] Throw an error when bibliography field is not properly parsed (was: [PATCH] oc-basic.el: Fix wrong type for the editors field when parsing JSON.) Ihor Radchenko
0 siblings, 1 reply; 4+ messages in thread
From: Ihor Radchenko @ 2022-12-25 11:40 UTC (permalink / raw)
To: Hugo Cisneros; +Cc: emacs-orgmode
Hugo Cisneros <hmj.cisneros@gmail.com> writes:
> I use org-cite with a JSON bibliography and noticed a bug when an entry only has
> an "editors" field but no "authors" field. The function
> `org-cite-basic—get-author' correctly falls back to using the editors instead of
> the authors, but `org-cite-basic--parse-json’ stringifies only the "authors"
> field and not the "editors." This creates an error when other functions assume
> they got a string from `org-cite-basic—get-author'. The patch fixes the issue by
> applying the same transformation to both "authors" and "editors".
Thanks!
Applied onto bugfix.
https://git.savannah.gnu.org/cgit/emacs/org-mode.git/commit/?id=318807013
Use are now also listed as an Org contributor.
https://git.sr.ht/~bzg/worg/commit/c2bb6a52
> As explained in the ChangeLog entry, this points to a more general issue where
> `org-cite-basic--get-field' is expected to return nil or a string, but calls
> `org-cite-basic--get-entry' that may return an association list. I am not sure
> how to fix that since it means converting anything that
> `org-cite-basic--get-entry' may return into a string.
Non-string can only be for JSON bibliographies for fields that are not
supported. `org-cite-basic--get-field' can probably return nil in such
scenarios.
--
Ihor Radchenko // yantar92,
Org mode contributor,
Learn more about Org mode at <https://orgmode.org/>.
Support Org development at <https://liberapay.com/org-mode>,
or support my work at <https://liberapay.com/yantar92>
^ permalink raw reply [flat|nested] 4+ messages in thread
* [PATCH] Throw an error when bibliography field is not properly parsed (was: [PATCH] oc-basic.el: Fix wrong type for the editors field when parsing JSON.)
2022-12-25 11:40 ` Ihor Radchenko
@ 2022-12-29 14:21 ` Ihor Radchenko
2023-01-17 12:26 ` Ihor Radchenko
0 siblings, 1 reply; 4+ messages in thread
From: Ihor Radchenko @ 2022-12-29 14:21 UTC (permalink / raw)
To: Hugo Cisneros; +Cc: emacs-orgmode
[-- Attachment #1: Type: text/plain, Size: 737 bytes --]
Ihor Radchenko <yantar92@posteo.net> writes:
>> As explained in the ChangeLog entry, this points to a more general issue where
>> `org-cite-basic--get-field' is expected to return nil or a string, but calls
>> `org-cite-basic--get-entry' that may return an association list. I am not sure
>> how to fix that since it means converting anything that
>> `org-cite-basic--get-entry' may return into a string.
>
> Non-string can only be for JSON bibliographies for fields that are not
> supported. `org-cite-basic--get-field' can probably return nil in such
> scenarios.
I am attaching tentative patch that will make
`org-cite-basic--get-field' throw an error when the filed value is not a
string.
I would appreciate testing.
Best,
Ihor
[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: 0001-org-cite-basic-get-field-Throw-an-error-on-non-nil-f.patch --]
[-- Type: text/x-patch, Size: 1584 bytes --]
From 9fe6284fdc7ceeb0e0aa8e5a58b6828ca415b6b2 Mon Sep 17 00:00:00 2001
Message-Id: <9fe6284fdc7ceeb0e0aa8e5a58b6828ca415b6b2.1672323564.git.yantar92@posteo.net>
From: Ihor Radchenko <yantar92@posteo.net>
Date: Thu, 29 Dec 2022 17:18:35 +0300
Subject: [PATCH] org-cite-basic--get-field: Throw an error on non-nil field
values
* lisp/oc-basic.el (org-cite-basic--get-field): Throw an error when
the field value is not a string. Document the new behavior.
Link: https://orgmode.org/list/87edsnsocj.fsf@localhost
---
lisp/oc-basic.el | 6 +++++-
1 file changed, 5 insertions(+), 1 deletion(-)
diff --git a/lisp/oc-basic.el b/lisp/oc-basic.el
index 01e314bfd..8e69db03c 100644
--- a/lisp/oc-basic.el
+++ b/lisp/oc-basic.el
@@ -332,7 +332,9 @@ (defun org-cite-basic--get-field (field entry-or-key &optional info raw)
Return value may be nil or a string. If current export back-end is derived
from `latex', return a raw string instead, unless optional argument RAW is
-non-nil."
+non-nil.
+
+Throw an error if the field value is non-string and non-nil."
(let ((value
(cdr
(assq field
@@ -343,6 +345,8 @@ (defun org-cite-basic--get-field (field entry-or-key &optional info raw)
entry-or-key)
(_
(error "Wrong value for ENTRY-OR-KEY: %S" entry-or-key)))))))
+ (unless (and value (stringp value))
+ (error "Non-string bibliography field value: %S" value))
(if (and value
(not raw)
(org-export-derived-backend-p (plist-get info :back-end) 'latex))
--
2.38.1
[-- Attachment #3: Type: text/plain, Size: 225 bytes --]
--
Ihor Radchenko // yantar92,
Org mode contributor,
Learn more about Org mode at <https://orgmode.org/>.
Support Org development at <https://liberapay.com/org-mode>,
or support my work at <https://liberapay.com/yantar92>
^ permalink raw reply related [flat|nested] 4+ messages in thread
* Re: [PATCH] Throw an error when bibliography field is not properly parsed (was: [PATCH] oc-basic.el: Fix wrong type for the editors field when parsing JSON.)
2022-12-29 14:21 ` [PATCH] Throw an error when bibliography field is not properly parsed (was: [PATCH] oc-basic.el: Fix wrong type for the editors field when parsing JSON.) Ihor Radchenko
@ 2023-01-17 12:26 ` Ihor Radchenko
0 siblings, 0 replies; 4+ messages in thread
From: Ihor Radchenko @ 2023-01-17 12:26 UTC (permalink / raw)
To: Hugo Cisneros; +Cc: emacs-orgmode
Ihor Radchenko <yantar92@posteo.net> writes:
> I am attaching tentative patch that will make
> `org-cite-basic--get-field' throw an error when the filed value is not a
> string.
Applied, onto main; with minor amendments.
I made the new code not throw error on nil return value.
https://git.savannah.gnu.org/cgit/emacs/org-mode.git/commit/?id=104311c7f
--
Ihor Radchenko // yantar92,
Org mode contributor,
Learn more about Org mode at <https://orgmode.org/>.
Support Org development at <https://liberapay.com/org-mode>,
or support my work at <https://liberapay.com/yantar92>
^ permalink raw reply [flat|nested] 4+ messages in thread
end of thread, other threads:[~2023-01-17 12:26 UTC | newest]
Thread overview: 4+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2022-12-20 17:03 [PATCH] oc-basic.el: Fix wrong type for the editors field when parsing JSON Hugo Cisneros
2022-12-25 11:40 ` Ihor Radchenko
2022-12-29 14:21 ` [PATCH] Throw an error when bibliography field is not properly parsed (was: [PATCH] oc-basic.el: Fix wrong type for the editors field when parsing JSON.) Ihor Radchenko
2023-01-17 12:26 ` Ihor Radchenko
Code repositories for project(s) associated with this public inbox
https://git.savannah.gnu.org/cgit/emacs/org-mode.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).