Bump citationberg to fix page in number (#289)

PgBiel · web-flow · commit d2556502b894 · 2025-04-01T00:11:49.000-03:00
diff --git a/Cargo.toml b/Cargo.toml
@@ -17,7 +17,7 @@ archive = ["ciborium"]
 csl-json = ["citationberg/json"]
 
 [dependencies]
-citationberg = "0.5.0"
+citationberg = { git = "https://github.com/typst/citationberg.git", rev = "67db988c7155f17b2e0aff9aabcd9a00745e4c04" }
 indexmap = { version = "2.0.2", features = ["serde"] }
 numerals = "0.1.4"
 paste = "1.0.14"
diff --git a/src/csl/mod.rs b/src/csl/mod.rs
@@ -8,8 +8,8 @@ use std::num::{NonZeroI16, NonZeroUsize};
 use std::{mem, vec};
 
 use citationberg::taxonomy::{
-    DateVariable, Locator, NameVariable, NumberVariable, OtherTerm, PageVariable,
-    StandardVariable, Term, Variable,
+    DateVariable, Locator, NameVariable, NumberOrPageVariable, NumberVariable, OtherTerm,
+    PageVariable, StandardVariable, Term, Variable,
 };
 use citationberg::{
     taxonomy as csl_taxonomy, Affixes, BaseLanguage, Citation, CitationFormat, Collapse,
@@ -23,6 +23,7 @@ use indexmap::IndexSet;
 use crate::csl::elem::{simplify_children, NonEmptyStack};
 use crate::csl::rendering::names::NameDisambiguationProperties;
 use crate::csl::rendering::RenderCsl;
+use crate::csl::taxonomy::NumberOrPageVariableResult;
 use crate::lang::CaseFolder;
 use crate::types::{ChunkKind, ChunkedString, Date, MaybeTyped, Person};
 
@@ -2641,6 +2642,20 @@ impl<'a, T: EntryLike> Context<'a, T> {
         self.instance.resolve_page_variable(variable)
     }
 
+    fn resolve_number_or_page_variable(
+        &self,
+        variable: NumberOrPageVariable,
+    ) -> Option<NumberOrPageVariableResult<'a>> {
+        match variable {
+            NumberOrPageVariable::Page(p) => {
+                self.resolve_page_variable(p).map(NumberOrPageVariableResult::Page)
+            }
+            NumberOrPageVariable::Number(n) => self
+                .resolve_number_variable(n)
+                .map(NumberOrPageVariableResult::Number),
+        }
+    }
+
     /// Resolve a name variable.
     ///
     /// Honors suppressions.
diff --git a/src/csl/rendering/mod.rs b/src/csl/rendering/mod.rs
@@ -19,7 +19,7 @@ use crate::lang::{Case, SentenceCase, TitleCase};
 use crate::types::{ChunkedString, Date, MaybeTyped, Numeric};
 use crate::PageRanges;
 
-use super::taxonomy::EntryLike;
+use super::taxonomy::{EntryLike, NumberOrPageVariableResult};
 use super::{write_year, Context, ElemMeta, IbidState, SpecialForm, UsageInfo};
 
 pub mod names;
@@ -278,11 +278,20 @@ impl RenderCsl for citationberg::Number {
             return;
         }
 
-        let value = ctx.resolve_number_variable(self.variable);
+        let value = ctx.resolve_number_or_page_variable(self.variable);
         if ctx.instance.sorting {
-            if let Some(NumberVariableResult::Regular(MaybeTyped::Typed(n))) = value {
-                n.fmt_value(ctx, true).unwrap();
-                return;
+            match value {
+                Some(NumberOrPageVariableResult::Number(
+                    NumberVariableResult::Regular(MaybeTyped::Typed(n)),
+                )) => {
+                    n.fmt_value(ctx, true).unwrap();
+                    return;
+                }
+                Some(NumberOrPageVariableResult::Page(MaybeTyped::Typed(p))) => {
+                    write!(ctx, "{p}").unwrap();
+                    return;
+                }
+                _ => {}
             }
         }
 
@@ -292,18 +301,32 @@ impl RenderCsl for citationberg::Number {
         let gender = ctx.gender(self.variable.into());
 
         match value {
-            Some(NumberVariableResult::Regular(MaybeTyped::Typed(num)))
-                if num.will_transform() =>
-            {
+            Some(NumberOrPageVariableResult::Number(NumberVariableResult::Regular(
+                MaybeTyped::Typed(num),
+            ))) if num.will_transform() => {
                 render_typed_num(num.as_ref(), self.form, gender, ctx);
             }
-            Some(NumberVariableResult::Regular(MaybeTyped::Typed(num))) => {
-                write!(ctx, "{}", num).unwrap()
+
+            Some(NumberOrPageVariableResult::Number(NumberVariableResult::Regular(
+                MaybeTyped::Typed(num),
+            ))) => write!(ctx, "{}", num).unwrap(),
+
+            Some(NumberOrPageVariableResult::Number(NumberVariableResult::Regular(
+                MaybeTyped::String(s),
+            ))) => ctx.push_str(&s),
+
+            Some(NumberOrPageVariableResult::Number(
+                NumberVariableResult::Transparent(n),
+            )) => ctx.push_transparent(n),
+
+            Some(NumberOrPageVariableResult::Page(MaybeTyped::Typed(p))) => {
+                render_page_range(&p, ctx)
             }
-            Some(NumberVariableResult::Regular(MaybeTyped::String(s))) => {
+
+            Some(NumberOrPageVariableResult::Page(MaybeTyped::String(s))) => {
                 ctx.push_str(&s)
             }
-            Some(NumberVariableResult::Transparent(n)) => ctx.push_transparent(n),
+
             None => {}
         }
 
@@ -312,25 +335,36 @@ impl RenderCsl for citationberg::Number {
         ctx.commit_elem(
             depth,
             self.display,
-            (self.variable == NumberVariable::CitationNumber)
-                .then_some(ElemMeta::CitationNumber)
-                .or(Some(ElemMeta::Number)),
+            Some(
+                if self.variable
+                    == NumberOrPageVariable::Number(NumberVariable::CitationNumber)
+                {
+                    ElemMeta::CitationNumber
+                } else {
+                    ElemMeta::Number
+                },
+            ),
         );
     }
 
     fn will_render<T: EntryLike>(&self, ctx: &mut Context<T>, var: Variable) -> bool {
         match ctx.instance.kind {
-            Some(SpecialForm::VarOnly(Variable::Number(n))) if self.variable != n => {
+            Some(SpecialForm::VarOnly(Variable::Number(n)))
+                if self.variable != NumberOrPageVariable::Number(n) =>
+            {
                 return false
             }
             Some(SpecialForm::OnlyFirstDate | SpecialForm::OnlyYearSuffix) => {
-                return self.variable == NumberVariable::Locator
+                return matches!(
+                    self.variable,
+                    NumberOrPageVariable::Number(NumberVariable::Locator)
+                )
             }
             Some(SpecialForm::VarOnly(_)) => return false,
             _ => {}
         }
 
-        var == Variable::Number(self.variable)
+        var == Variable::from(self.variable)
     }
 
     fn will_have_info<T: EntryLike>(&self, ctx: &mut Context<T>) -> (bool, UsageInfo) {
@@ -339,7 +373,7 @@ impl RenderCsl for citationberg::Number {
             // silent lookup, otherwise we need to perform a regular lookup.
             let suppressing = ctx.writing.suppress_queried_variables;
             ctx.writing.stop_suppressing_queried_variables();
-            let lookup_result = ctx.resolve_number_variable(self.variable);
+            let lookup_result = ctx.resolve_number_or_page_variable(self.variable);
 
             if suppressing {
                 ctx.writing.start_suppressing_queried_variables();
diff --git a/src/csl/taxonomy.rs b/src/csl/taxonomy.rs
@@ -111,6 +111,11 @@ pub(super) enum NumberVariableResult<'a> {
 
 pub(super) type PageVariableResult = MaybeTyped<PageRanges>;
 
+pub(super) enum NumberOrPageVariableResult<'a> {
+    Number(NumberVariableResult<'a>),
+    Page(PageVariableResult),
+}
+
 impl<'a> NumberVariableResult<'a> {
     pub(super) fn from_regular(regular: MaybeTyped<Cow<'a, Numeric>>) -> Self {
         Self::Regular(regular)
diff --git a/tests/local/page_NumberPage.txt b/tests/local/page_NumberPage.txt
@@ -0,0 +1,45 @@
+>>===== MODE =====>>
+citation
+<<===== MODE =====<<
+
+
+
+>>===== RESULT =====>>
+22–45
+<<===== RESULT =====<<
+
+
+>>===== CSL =====>>
+<style
+      xmlns="http://purl.org/net/xbiblio/csl"
+      class="note"
+      version="1.0">
+  <info>
+    <id />
+    <title />
+    <updated>2009-08-10T04:49:00+09:00</updated>
+  </info>
+  <citation>
+    <layout>
+      <number variable="page"/>
+    </layout>
+  </citation>
+</style>
+<<===== CSL =====<<
+
+
+>>===== INPUT =====>>
+[
+    {
+        "id": "ITEM-1",
+        "page": "22-45",
+        "title": "His Anonymous Life",
+        "type": "book"
+    }
+]
+<<===== INPUT =====<<
+
+
+>>===== VERSION =====>>
+1.0
+<<===== VERSION =====<<
diff --git a/tests/local/page_NumberPageMacroSort.txt b/tests/local/page_NumberPageMacroSort.txt
@@ -0,0 +1,81 @@
+>>===== MODE =====>>
+citation
+<<===== MODE =====<<
+
+
+
+>>===== RESULT =====>>
+22–45; 3; 33; 450, 60–30 & 8; 46; 5
+<<===== RESULT =====<<
+
+
+>>===== CSL =====>>
+<style
+      xmlns="http://purl.org/net/xbiblio/csl"
+      class="note"
+      version="1.0">
+  <info>
+    <id />
+    <title />
+    <updated>2009-08-10T04:49:00+09:00</updated>
+  </info>
+  <macro name="page-num">
+    <number variable="page"/>
+  </macro>
+  <citation>
+    <sort>
+      <key macro="page-num" />
+    </sort>
+    <layout delimiter="; ">
+      <number variable="page"/>
+    </layout>
+  </citation>
+</style>
+<<===== CSL =====<<
+
+
+>>===== INPUT =====>>
+[
+    {
+        "id": "ITEM-1",
+        "page": "3",
+        "title": "A",
+        "type": "book"
+    },
+    {
+        "id": "ITEM-2",
+        "page": "5",
+        "title": "B",
+        "type": "book"
+    },
+    {
+        "id": "ITEM-3",
+        "page": "22-45",
+        "title": "C",
+        "type": "book"
+    },
+    {
+        "id": "ITEM-4",
+        "page": "33",
+        "title": "D",
+        "type": "book"
+    },
+    {
+        "id": "ITEM-5",
+        "page": "46",
+        "title": "E",
+        "type": "book"
+    },
+    {
+        "id": "ITEM-6",
+        "page": "450, 60-30 & 8",
+        "title": "F",
+        "type": "book"
+    }
+]
+<<===== INPUT =====<<
+
+
+>>===== VERSION =====>>
+1.0
+<<===== VERSION =====<<
diff --git a/tests/local/page_NumberPageSort.txt b/tests/local/page_NumberPageSort.txt
@@ -0,0 +1,78 @@
+>>===== MODE =====>>
+citation
+<<===== MODE =====<<
+
+
+
+>>===== RESULT =====>>
+3; 5; 33; 46; 450, 60–30 & 8; 22–45
+<<===== RESULT =====<<
+
+
+>>===== CSL =====>>
+<style
+      xmlns="http://purl.org/net/xbiblio/csl"
+      class="note"
+      version="1.0">
+  <info>
+    <id />
+    <title />
+    <updated>2009-08-10T04:49:00+09:00</updated>
+  </info>
+  <citation>
+    <sort>
+      <key variable="page" />
+    </sort>
+    <layout delimiter="; ">
+      <number variable="page"/>
+    </layout>
+  </citation>
+</style>
+<<===== CSL =====<<
+
+
+>>===== INPUT =====>>
+[
+    {
+        "id": "ITEM-1",
+        "page": "3",
+        "title": "A",
+        "type": "book"
+    },
+    {
+        "id": "ITEM-2",
+        "page": "5",
+        "title": "B",
+        "type": "book"
+    },
+    {
+        "id": "ITEM-3",
+        "page": "22-45",
+        "title": "C",
+        "type": "book"
+    },
+    {
+        "id": "ITEM-4",
+        "page": "33",
+        "title": "D",
+        "type": "book"
+    },
+    {
+        "id": "ITEM-5",
+        "page": "46",
+        "title": "E",
+        "type": "book"
+    },
+    {
+        "id": "ITEM-6",
+        "page": "450, 60-30 & 8",
+        "title": "F",
+        "type": "book"
+    }
+]
+<<===== INPUT =====<<
+
+
+>>===== VERSION =====>>
+1.0
+<<===== VERSION =====<<
