Fix empty locator (resolve #70)

CHANGELOG.md

@@ -10,6 +10,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Add support for multiple bibliographies (`refsection` environment).
 - Add global `ref-section` option.
 
+### Fixed
+
+- Fix an error of empty locator in citation (([#70](https://github.com/zepinglee/citeproc-lua/discussions/70)))
+
 ## [0.5.1] - 2024-07-10
 
 ### Fixed

citeproc/citeproc-element.lua

@@ -384,10 +384,20 @@ function Element:apply_strip_periods(str)
 end
 
 
+---@param number string Non-empty string
+---@param variable string
+---@param form string
+---@param context Context
+---@return string
 function Element:format_number(number, variable, form, context)
   number = util.strip(number)
   if variable == "locator" then
-    variable = context:get_variable("label")
+    local locator_variable = context:get_variable("label")
+    if not locator_variable or type(locator_variable) ~= "string" then
+      util.error("Invalid locator label")
+      locator_variable = "page"
+    end
+    variable = locator_variable
   end
   form = form or "numeric"
   local number_part_list = self:split_number_parts_lpeg(number, context)
@@ -431,9 +441,11 @@ function Element:format_number(number, variable, form, context)
   return res
 end
 
----comment
----@param number any
----@param context any
+---@alias NumberToken {type: string, value: string, delimiter_type: string}
+
+---@param number string
+---@param context Context
+---@return NumberToken[]
 function Element:parse_number_tokens(number, context)
   local and_text = "and"
   local and_symbol = "&"
@@ -465,10 +477,15 @@ function Element:parse_number_tokens(number, context)
       value = token,
     }
   end
-  local grammer = l.Ct(token_patt * (delimiter * token_patt)^0)
+  local grammer = l.Ct((token_patt * (delimiter * token_patt)^0)^-1)
   local tokens = grammer:match(number)
   -- util.debug(tokens)
 
+  if not tokens then
+    return {}
+  end
+  ---@cast tokens NumberToken[]
+
   for i, token in ipairs(tokens) do
     if token.type == "string" then
       token.value = string.gsub(token.value, "\\%-", "-")

citeproc/citeproc-node-choose.lua

@@ -283,6 +283,10 @@ function If:evaluate_condition(condition, state, context)
     return self:is_uncertain_date(value)
 
   elseif condition.condition == "locator" then
+    local locator = context:get_variable("locator")
+    if not locator or locator == "" then
+      return false
+    end
     local locator_label = context:get_variable("label")
     if locator_label == "sub verbo" then
       locator_label = "sub-verbo"

citeproc/citeproc-node-number.lua

@@ -59,8 +59,9 @@ function Number:build_ir(engine, state, context)
   local number
   if not state.suppressed[self.variable] then
     number = context:get_variable(self.variable, self.form)
+    ---@cast number string | number?
   end
-  if not number then
+  if not number or number == "" then
     local ir = Rendered:new({}, self)
     ir.group_var = GroupVar.Missing
     return ir

citeproc/citeproc-node-text.lua

@@ -86,6 +86,7 @@ function Text:build_ir(engine, state, context)
   if self.variable then
     ir = self:build_variable_ir(engine, state, context)
   elseif self.macro then
+    -- util.debug(self.macro)
     ir = self:build_macro_ir(engine, state, context)
   elseif self.term then
     ir = self:build_term_ir(engine, state, context)
@@ -108,9 +109,10 @@ function Text:build_variable_ir(engine, state, context)
 
   if not state.suppressed[variable] then
     text = context:get_variable(variable, self.form)
+    ---@case text string | number?
   end
 
-  if not text then
+  if not text or text == "" then
     local ir = Rendered:new({}, self)
     ir.group_var = GroupVar.Missing
     return ir

latex/citation-style-language-cite.sty

@@ -246,10 +246,17 @@
 
 \cs_new:Npn \__csl_set_locator:nn #1#2
   {
-    \prop_put:Nnn \l__csl_cite_item_prop { label } {#1}
-    \prop_put:Nnn \l__csl_cite_item_prop { locator } {#2}
+    \tl_if_empty:nTF {#2}
+      { \msg_warning:nnn { citation-style-language } { empty-locator } {#1} }
+      {
+        \prop_put:Nnn \l__csl_cite_item_prop { label } {#1}
+        \prop_put:Nnn \l__csl_cite_item_prop { locator } {#2}
+      }
   }
 
+\msg_new:nnn { citation-style-language } { empty-locator }
+  { Empty~ `#1'~ locator. }
+
 \keys_define:nn { csl / cite-item }
   {
     prefix          .prop_put:N = \l__csl_cite_item_prop,

tests/fixtures/local/locator_EmptyLocator.txt

@@ -0,0 +1,86 @@
+>>===== MODE =====>>
+citation
+<<===== MODE =====<<
+
+
+
+>>===== DESCRIPTION =====>>
+<https://github.com/zepinglee/citeproc-lua/discussions/70>
+<<===== DESCRIPTION =====<<
+
+
+
+>>===== RESULT =====>>
+(Doe, condition false: Title Page)
+<<===== RESULT =====<<
+
+
+>>==== CITATION-ITEMS ====>>
+[
+    [
+        {
+            "id": "ITEM-1",
+            "label": "page",
+            "locator": ""
+        }
+    ]
+]
+<<==== CITATION-ITEMS ====<<
+
+
+>>===== CSL =====>>
+<?xml version="1.0" encoding="utf-8"?>
+<style xmlns="http://purl.org/net/xbiblio/csl" class="in-text" version="1.0">
+  <info>
+    <id />
+    <title />
+    <updated>2024-07-28T11:35:35+08:00</updated>
+  </info>
+  <citation>
+    <layout prefix="(" suffix=")" delimiter="; ">
+      <group delimiter=", ">
+        <names variable="author">
+          <name form="short" and="symbol" delimiter=", " initialize-with=". "/>
+        </names>
+        <group delimiter=" ">
+          <choose>
+            <if locator="page paragraph" match="any">
+              <text value="condition true:"/>
+              <text variable="title"/>
+              <label variable="locator" form="short"/>
+            </if>
+            <else>
+              <text value="condition false:"/>
+              <text variable="title"/>
+              <label variable="locator" text-case="capitalize-first"/>
+            </else>
+          </choose>
+          <text variable="locator"/>
+        </group>
+      </group>
+    </layout>
+  </citation>
+</style>
+<<===== CSL =====<<
+
+
+>>===== INPUT =====>>
+[
+    {
+        "id": "ITEM-1",
+        "type": "book",
+        "author": [
+            {
+                "family": "Doe",
+                "given": "John"
+            }
+        ],
+        "title": "Title"
+    }
+]
+<<===== INPUT =====<<
+
+
+>>===== VERSION =====>>
+1.0
+<<===== VERSION =====<<

tests/latex/luatex-1/issue-70.lvt

@@ -0,0 +1,20 @@
+% <https://github.com/zepinglee/citeproc-lua/discussions/70>
+
+\input{regression-test}
+\documentclass{article}
+\input{csl-test}
+
+\usepackage[style=chicago-fullnote-bibliography]{citation-style-language}
+\cslsetup{regression-test = true}
+\addbibresource{test.json}
+
+
+\begin{document}
+\START
+
+\TEST{Citation with empty locator}{
+  \cite[page = ]{ITEM-1}
+}
+
+\OMIT
+\end{document}

tests/latex/luatex-1/issue-70.tlg

@@ -0,0 +1,21 @@
+This is a generated file for the l3build validation system.
+Don't change this file in any respect.
+============================================================
+TEST 1: Citation with empty locator
+============================================================
+Package citation-style-language Warning: Empty `page' locator.
+> \l__csl_citation_info_tl=citationID={ITEM-1@1},citationItems={{id={ITEM-1}}},properties={noteIndex={1}}.
+<recently read> }
+l. ...}
+> \l__csl_citation_tl=Bruce D’Arcus, \textit {Boundaries of Dissent: Protest and State Power in the Media Age} (Routledge, 2005)..
+<recently read> }
+l. ...}
+LaTeX Font Info:    External font `cmex10' loaded for size
+(Font)              <7> on input line ....
+LaTeX Font Info:    External font `cmex10' loaded for size
+(Font)              <5> on input line ....
+LaTeX Font Info:    External font `cmex10' loaded for size
+(Font)              <8> on input line ....
+LaTeX Font Info:    External font `cmex10' loaded for size
+(Font)              <6> on input line ....
+============================================================

tests/latex/luatex-2/issue-70.lvt

@@ -0,0 +1,20 @@
+% <https://github.com/zepinglee/citeproc-lua/discussions/70>
+
+\input{regression-test}
+\documentclass{article}
+\input{csl-test}
+
+\usepackage[style=chicago-fullnote-bibliography]{citation-style-language}
+\cslsetup{regression-test = true}
+\addbibresource{test.json}
+
+
+\begin{document}
+\START
+
+\TEST{Citation with empty locator}{
+  \cite[page = ]{ITEM-1}
+}
+
+\OMIT
+\end{document}

tests/latex/luatex-2/issue-70.tlg

@@ -0,0 +1,21 @@
+This is a generated file for the l3build validation system.
+Don't change this file in any respect.
+============================================================
+TEST 1: Citation with empty locator
+============================================================
+Package citation-style-language Warning: Empty `page' locator.
+> \l__csl_citation_info_tl=citationID={ITEM-1@1},citationItems={{id={ITEM-1}}},properties={noteIndex={1}}.
+<recently read> }
+l. ...}
+> \l__csl_citation_tl=Bruce D’Arcus, \textit {Boundaries of Dissent: Protest and State Power in the Media Age} (Routledge, 2005)..
+<recently read> }
+l. ...}
+LaTeX Font Info:    External font `cmex10' loaded for size
+(Font)              <7> on input line ....
+LaTeX Font Info:    External font `cmex10' loaded for size
+(Font)              <5> on input line ....
+LaTeX Font Info:    External font `cmex10' loaded for size
+(Font)              <8> on input line ....
+LaTeX Font Info:    External font `cmex10' loaded for size
+(Font)              <6> on input line ....
+============================================================

tests/latex/pdftex-1/issue-70.lvt

@@ -0,0 +1,20 @@
+% <https://github.com/zepinglee/citeproc-lua/discussions/70>
+
+\input{regression-test}
+\documentclass{article}
+\input{csl-test}
+
+\usepackage[style=chicago-fullnote-bibliography]{citation-style-language}
+\cslsetup{regression-test = true}
+\addbibresource{test.json}
+
+
+\begin{document}
+\START
+
+\TEST{Citation with empty locator}{
+  \cite[page = ]{ITEM-1}
+}
+
+\OMIT
+\end{document}

tests/latex/pdftex-1/issue-70.tlg

@@ -0,0 +1,22 @@
+This is a generated file for the l3build validation system.
+Don't change this file in any respect.
+============================================================
+TEST 1: Citation with empty locator
+============================================================
+Package citation-style-language Warning: Empty `page' locator.
+> \l__csl_citation_info_tl=citationID={ITEM-1@1},citationItems={{id={ITEM-1}}},properties={noteIndex={1}}.
+<recently read> }
+l. ...}
+LaTeX Warning: Citation `ITEM-1' on page 1 undefined on input line ....
+> \l__csl_citation_tl=[\textbf {ITEM-1}].
+<recently read> }
+l. ...}
+LaTeX Font Info:    External font `cmex10' loaded for size
+(Font)              <7> on input line ....
+LaTeX Font Info:    External font `cmex10' loaded for size
+(Font)              <5> on input line ....
+LaTeX Font Info:    External font `cmex10' loaded for size
+(Font)              <8> on input line ....
+LaTeX Font Info:    External font `cmex10' loaded for size
+(Font)              <6> on input line ....
+============================================================

tests/latex/pdftex-2/issue-70.lvt

@@ -0,0 +1,20 @@
+% <https://github.com/zepinglee/citeproc-lua/discussions/70>
+
+\input{regression-test}
+\documentclass{article}
+\input{csl-test}
+
+\usepackage[style=chicago-fullnote-bibliography]{citation-style-language}
+\cslsetup{regression-test = true}
+\addbibresource{test.json}
+
+
+\begin{document}
+\START
+
+\TEST{Citation with empty locator}{
+  \cite[page = ]{ITEM-1}
+}
+
+\OMIT
+\end{document}

tests/latex/pdftex-2/issue-70.tlg

@@ -0,0 +1,21 @@
+This is a generated file for the l3build validation system.
+Don't change this file in any respect.
+============================================================
+TEST 1: Citation with empty locator
+============================================================
+Package citation-style-language Warning: Empty `page' locator.
+> \l__csl_citation_info_tl=citationID={ITEM-1@1},citationItems={{id={ITEM-1}}},properties={noteIndex={1}}.
+<recently read> }
+l. ...}
+> \l__csl_citation_tl=Bruce D’Arcus, \textit {Boundaries of Dissent: Protest and State Power in the Media Age} (Routledge, 2005)..
+<recently read> }
+l. ...}
+LaTeX Font Info:    External font `cmex10' loaded for size
+(Font)              <7> on input line ....
+LaTeX Font Info:    External font `cmex10' loaded for size
+(Font)              <5> on input line ....
+LaTeX Font Info:    External font `cmex10' loaded for size
+(Font)              <8> on input line ....
+LaTeX Font Info:    External font `cmex10' loaded for size
+(Font)              <6> on input line ....
+============================================================