aspero 0.3.2

Find, resolve and verify scholarly literature from the command line
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210

//! Building citation claims from arguments, flags and stdin lines.

use aspero_core::{Claim, WorkId};
use serde::Deserialize;
use serde_json::{Value, json};

use super::{Failure, read_stdin};

/// A claim as an agent would write it, one JSON object per stdin line.
/// Unknown keys are rejected so typos aren't silently ignored.
#[derive(Debug, Default, Deserialize)]
#[serde(deny_unknown_fields)]
pub struct ClaimInput {
    pub text: Option<String>,
    pub title: Option<String>,
    #[serde(default)]
    pub authors: Vec<String>,
    pub year: Option<i16>,
    #[serde(alias = "journal")]
    pub container: Option<String>,
    #[serde(default, deserialize_with = "text_or_number")]
    pub volume: Option<String>,
    /// The first page, or a range.
    #[serde(default, alias = "pages", deserialize_with = "text_or_number")]
    pub page: Option<String>,
    /// The caller's own reference for this claim, echoed back untouched;
    /// allowed here, read from the raw line (see [`InputClaim::from_line`]).
    #[serde(rename = "key")]
    pub _key: Option<serde::de::IgnoredAny>,
    pub doi: Option<String>,
    pub arxiv: Option<String>,
    /// Any identifier form `lookup` accepts.
    pub id: Option<String>,
    #[serde(default)]
    pub ids: Vec<String>,
}

/// Volumes and pages are written as numbers or strings ("e1234").
fn text_or_number<'de, D: serde::Deserializer<'de>>(d: D) -> Result<Option<String>, D::Error> {
    Ok(match Option::<serde_json::Value>::deserialize(d)? {
        Some(serde_json::Value::String(s)) => Some(s),
        Some(serde_json::Value::Number(n)) => Some(n.to_string()),
        None | Some(serde_json::Value::Null) => None,
        Some(other) => {
            return Err(serde::de::Error::custom(format!(
                "expected text or a number, got {other}"
            )));
        }
    })
}

impl ClaimInput {
    pub fn into_claim(self) -> Result<Claim, String> {
        let mut claim = match &self.text {
            Some(text) => Claim::from_input(text),
            None => Claim::default(),
        };
        let prefixed = [
            self.doi.map(|d| format!("doi:{d}")),
            self.arxiv.map(|a| format!("arxiv:{a}")),
            self.id,
        ];
        for raw in prefixed.into_iter().flatten().chain(self.ids) {
            let id: WorkId = raw.parse().map_err(|e| format!("{e}"))?;
            if !claim.ids.contains(&id) {
                claim.ids.push(id);
            }
        }
        claim.title = self.title;
        claim.authors = self.authors;
        claim.year = self.year;
        claim.container = self.container;
        claim.volume = self.volume;
        claim.page = self.page;
        if claim.is_empty() {
            return Err("claim has no text, title, authors or identifiers".into());
        }
        Ok(claim)
    }
}

/// A claim with the input it came from and the caller's `key`, or why that
/// input isn't one.
pub struct InputClaim {
    pub input: String,
    pub key: Option<Value>,
    pub claim: Result<Claim, String>,
}

impl InputClaim {
    /// One stdin line: a JSON object or a plain reference. A JSON line's
    /// `key` is kept even when the rest of it is invalid.
    pub fn from_line(line: &str) -> Self {
        let (key, claim) = match line.trim_start().starts_with('{') {
            false => (None, Ok(Claim::from_input(line))),
            true => match serde_json::from_str::<Value>(line) {
                Err(e) => (None, Err(format!("invalid claim JSON: {e}"))),
                Ok(value) => (
                    value.get("key").cloned(),
                    ClaimInput::deserialize(value)
                        .map_err(|e| format!("invalid claim: {e}"))
                        .and_then(ClaimInput::into_claim),
                ),
            },
        };
        InputClaim {
            input: line.to_owned(),
            key,
            claim,
        }
    }

    /// What every result for this claim starts with: the input, the
    /// caller's key, and the claim as understood.
    pub fn echo(&self) -> Value {
        let mut echo = json!({ "input": self.input });
        if let Some(key) = &self.key {
            echo["key"] = key.clone();
        }
        if let Ok(claim) = &self.claim {
            echo["claim"] = json!(claim);
        }
        echo
    }
}

/// The claims to process: `text` plus flags as one claim, or one per stdin
/// line when `text` is `-` (blank lines and `#` comments skipped).
pub fn claims(text: Option<String>, fields: ClaimInput) -> Result<Vec<InputClaim>, Failure> {
    if text.as_deref() == Some("-") {
        let input = read_stdin()?;
        return Ok(input
            .lines()
            .map(str::trim)
            .filter(|l| !l.is_empty() && !l.starts_with('#'))
            .map(InputClaim::from_line)
            .collect());
    }
    let label = text.clone().unwrap_or_else(|| describe_fields(&fields));
    let input = ClaimInput { text, ..fields };
    Ok(vec![InputClaim {
        input: label,
        key: None,
        claim: input.into_claim(),
    }])
}

fn describe_fields(f: &ClaimInput) -> String {
    let parts: Vec<String> = [
        (!f.authors.is_empty()).then(|| f.authors.join(", ")),
        f.title.clone(),
        f.container.clone(),
        f.year.map(|y| y.to_string()),
        f.volume.clone(),
        f.page.clone(),
        f.doi.clone().or(f.arxiv.clone()).or(f.id.clone()),
    ]
    .into_iter()
    .flatten()
    .collect();
    parts.join(". ")
}

#[cfg(test)]
mod tests {
    use super::*;

    fn claim(line: &str) -> Result<Claim, String> {
        InputClaim::from_line(line).claim
    }

    #[test]
    fn json_lines_become_structured_claims() {
        let c = claim(
            r#"{"title": "Attention is all you need", "authors": ["Vaswani, A."], "year": 2017, "arxiv": "1706.03762"}"#,
        )
        .unwrap();
        assert_eq!(c.year, Some(2017));
        assert_eq!(c.ids[0].to_string(), "arxiv:1706.03762");
        assert!(
            claim(r#"{"titel": "typo"}"#)
                .unwrap_err()
                .contains("unknown field")
        );
        assert!(claim(r#"{"doi": "not a doi"}"#).is_err());
    }

    #[test]
    fn journal_volume_and_page_as_text_or_numbers() {
        let c = claim(
            r#"{"title": "X", "journal": "N Engl J Med", "volume": 376, "pages": "2545-55"}"#,
        )
        .unwrap();
        assert_eq!(c.container.as_deref(), Some("N Engl J Med"));
        assert_eq!(c.volume.as_deref(), Some("376"));
        assert_eq!(c.page.as_deref(), Some("2545-55"));
        assert!(claim(r#"{"title": "X", "volume": [1]}"#).is_err());
    }

    #[test]
    fn keys_are_echoed_even_for_invalid_claims() {
        let ok = InputClaim::from_line(r#"{"key": {"note": "pe.md", "line": 7}, "title": "X"}"#);
        assert_eq!(ok.echo()["key"], json!({"note": "pe.md", "line": 7}));
        assert_eq!(ok.echo()["claim"], json!({"title": "X"}));
        let bad = InputClaim::from_line(r#"{"key": "ref-12", "titel": "typo"}"#);
        assert!(bad.claim.is_err());
        assert_eq!(bad.echo()["key"], "ref-12");
        assert!(bad.echo().get("claim").is_none());
    }
}