CSL

.github/workflows/ci.yml

@@ -7,5 +7,9 @@ jobs:
     steps:
       - uses: actions/checkout@v3
       - uses: dtolnay/rust-toolchain@stable
+      - name: Check out CSL styles
+        run: |
+          cd ..
+          git clone --depth 1 https://github.com/citation-style-language/styles
       - run: cargo build
-      - run: cargo test
+      - run: cargo test --features csl-json

CHANGELOG.md

@@ -0,0 +1,102 @@
+# 0.4.0
+
+## Breaking changes:
+
+Hayagriva now uses the [Citation Style Language](https://citationstyles.org) to
+encode formatting styles. This means that Hayagriva's own formatting styles have
+been deprecated.
+
+### For users:
+- The YAML input format has changed.
+    - Titles and formattable strings have been merged into one type. All
+      formattable strings can have a shorthand now.
+    - Formattable Strings do not have `title-case` and `sentence-case` keys
+      anymore. `shorthand` has been renamed to `short`. To prevent changes of
+      the text case of formattable strings, you can use braces. Enclose a part
+      of a formattable string (or `short`) in `{braces}` to print it as-is.
+    - The fields `doi`, `isbn`, and `issn` have been moved to `serial-number`
+      which can now be a dictionary containing these and arbitrary other serial
+      numbers like a `pmid` (PubMed ID) and `arxiv` (ArXiv Identifier).
+    - The `tweet` entry type has been renamed to `post`.
+    - All numeric variables can now also contains strings. Numbers can have
+      string affixes.
+
+Refer to the updated
+[file format](https://github.com/typst/hayagriva/blob/main/docs/file-format.md)
+docs for examples.
+
+### For developers:
+- To use a CSL style, you can either supply a CSL file or use an archive of
+  provided styles with the `archive` feature.
+- The `from_yaml_str` function will now return the new `Library` struct, with the
+  entries within.
+- The `Database` struct has been replaced by the easier to handle
+  `BibliographyDriver`.
+- We switched from `yaml_rust` to `serde_yaml`. The `Entry` now implement's
+  `serde`'s `Serialize` and `Deserialize` traits. Hence, the `from_yaml` and
+  `to_yaml` functions have been deleted.
+- Brackets are no longer individually overridable. Instead, use the new
+  `CitePurpose`.
+- `Entry::kind` has been renamed to `Entry::entry_type`.
+    - The citation styles `AuthorTitle` and `Keys` have been removed but can be
+      realized with CSL.
+
+This release fixes many bugs and makes Hayagriva a serious contender for
+reference management.
+
+## Other changes
+
+- We added the entry types `Performance` and `Original`.
+- We added the field `call-number`.
+
+
+# 0.3.2
+
+Fixes a title case formatting bug introduced in the previous release.
+
+# 0.3.1
+
+_Bug Fixes:_
+- Added an option to turn off abbreviation of journals (thanks to @CMDJojo)
+- Fixed bugs with title case formatting (thanks to @jmskov)
+- Fixed off-by-one error with dates in APA style (thanks to @bluebear94)
+- Fixed supplements in the Alphanumeric and AuthorTitle styles (thanks to @lynn)
+- Fixed bugs with sentence case formatting
+- Fixed `verbatim` option
+- Fixed terminal formatting
+- Fixed some typos (thanks to @kianmeng and @bluebear94)
+
+# 0.3.0
+
+*Breaking:*
+- Updated to `biblatex` 0.8.0
+
+*Bug Fixes:*
+- Fixed string indexing for titles, removed panic
+- More permissive BibLaTeX parsing
+
+# 0.2.1
+
+*Bug Fixes:*
+- Fixed APA bibliography ordering
+
+# 0.2.0
+
+*Breaking:*
+- Replaced `NoHyphenation` formatting with `Link` formatting
+- Switched to newest BibLaTeX (which is part of the public API)
+
+*Bug Fixes:*
+- Fixed IEEE bibliography ordering
+- Fixed A, B, C, ... suffixes for Author Date citations
+- Removed `println` calls
+
+# 0.1.1
+
+🐞 This release fixes the documentation of the CLI in the `README.md` file.
+✨ There are new options for bracketed citations in the CLI.
+✅ No breaking changes.
+
+# 0.1.0
+
+🎉 This is the initial release!

Cargo.toml

@@ -1,8 +1,8 @@
 [package]
 name = "hayagriva"
-version = "0.3.2"
+version = "0.4.0"
 authors = ["Martin Haug <mhaug@live.de>"]
-edition = "2018"
+edition = "2021"
 license = "MIT OR Apache-2.0"
 description = "Work with references: Literature database management, storage, and citation formatting"
 repository = "https://github.com/typst/hayagriva"
@@ -11,25 +11,37 @@ categories = ["template-engine", "value-formatting", "command-line-utilities"]
 keywords = ["bibliography", "citation", "reference", "bibtex", "literature"]
 
 [features]
-default = ["biblatex"]
-cli = ["clap"]
+default = ["biblatex", "archive"]
+cli = ["clap", "strum"]
+archive = ["rkyv", "ciborium"]
+csl-json = ["citationberg/json"]
 
 [dependencies]
-biblatex = { version = "0.8", optional = true }
-clap = { version = "3.1", optional = true, features = ["cargo"] }
-chrono = { version = "0.4", default-features = false }
-isolang = "2.1"
-lazy_static = "1.4.0"
-linked-hash-map = "0.5.3"
-paste = "1.0.0"
-regex = { version = "1.4", default-features = false, features = ["std", "unicode-perl"] }
-strum = { version = "0.24", features = ["derive"] }
-thiserror = "1.0.20"
-unic-langid = "0.9.0"
+citationberg = { version = "0.1" }
+indexmap = { version = "2.0.2", features = ["serde"] }
+numerals = "0.1.4"
+paste = "1.0.14"
+serde = { version = "1", features = ["derive"] }
+serde_yaml = "0.9.25"
+thiserror = "1.0.48"
+unic-langid = { version = "0.9.0", features = ["serde"] }
 unicode-segmentation = "1.6.0"
-url = "2.1.1"
-yaml-rust = "0.4.4"
+unscanny = "0.1.0"
+url = { version =  "2.4", features = ["serde"] }
+biblatex = { version = "0.8.1", optional = true }
+ciborium = { version = "0.2.1", optional = true }
+clap = { version = "3.1", optional = true, features = ["cargo"] }
+rkyv = { version = "0.7.42", optional = true }
+strum = { version = "0.24", features = ["derive"], optional = true }
+
+[dev-dependencies]
+serde_json = "1"
 
 [[bin]]
 name = "hayagriva"
 required-features = ["cli"]
+
+[[test]]
+name = "citeproc"
+path = "tests/citeproc.rs"
+required-features = ["csl-json"]

NOTICE

@@ -0,0 +1,8 @@
+Licenses for third party components used by this project can be found below.
+
+================================================================================
+The Creative Commons BY-SA 3.0 DEED License applies to:
+* The CSL styles found in `tests/data/*`
+* The CSL styles and locales found in `styles.cbor.rkyv`
+
+https://creativecommons.org/licenses/by-sa/3.0/

README.md

@@ -24,34 +24,14 @@ to install and use Hayagriva on your terminal.
 
 ## Supported styles
 
-- Institute of Electrical and Electronics Engineers (IEEE)
-    - References
-    - Numerical citations
-- Modern Language Association (MLA), 8th edition of the MLA Handbook
-    - "Works Cited" references
-- Chicago Manual of Style (CMoS), 17th edition
-    - Notes and Bibliography
-    - Author-Date references and citations
-- American Psychological Association (APA), 7th edition of the APA Publication Manual
-    - References
-- Other in-text citation styles
-    - Alphanumerical (e. g. "Rass97")
-    - Author Title
-
-## Usage
-
-Add this to your `Cargo.toml`:
-```toml
-[dependencies]
-hayagriva = "0.3"
-```
+Hayagriva supports all styles provided in the
+[official Citation Style Language repository](https://github.com/citation-style-language/styles),
+currently over 2,600.
 
-Below, there is an example of how to parse a YAML database and get a Modern
-Language Association-style citation.
+# Usage
 
 ```rust
 use hayagriva::io::from_yaml_str;
-use hayagriva::style::{Database, Mla};
 
 let yaml = r#"
 crazy-rich:
@@ -65,20 +45,46 @@ crazy-rich:
 
 // Parse a bibliography
 let bib = from_yaml_str(yaml).unwrap();
-assert_eq!(bib[0].date().unwrap().year, 2014);
+assert_eq!(bib.get("crazy-rich").unwrap().date().unwrap().year, 2014);
 
 // Format the reference
-let db = Database::from_entries(bib.iter());
-let mut mla = Mla::new();
-let reference = db.bibliography(&mut mla, None);
-assert_eq!(reference[0].display.value, "Kwan, Kevin. Crazy Rich Asians. Anchor Books, 2014.");
+use std::fs;
+use hayagriva::{
+    BibliographyDriver, BibliographyRequest, BufWriteFormat,
+    CitationItem, CitationRequest,
+};
+use hayagriva::citationberg::{LocaleFile, IndependentStyle};
+
+let en_locale = fs::read_to_string("tests/data/locales-en-US.xml").unwrap();
+let locales = [LocaleFile::from_xml(&en_locale).unwrap().into()];
+
+let style = fs::read_to_string("tests/data/art-history.csl").unwrap();
+let style = IndependentStyle::from_xml(&style).unwrap();
+
+let mut driver = BibliographyDriver::new();
+
+for entry in bib.iter() {
+    let items = vec![CitationItem::with_entry(entry)];
+    driver.citation(CitationRequest::from_items(items, &style, &locales));
+}
+
+let result = driver.finish(BibliographyRequest {
+    style: &style,
+    locale: None,
+    locale_files: &locales,
+});
+
+for cite in result.citations {
+    println!("{}", cite.citation.to_string())
+}
 ```
 
-Formatting for in-text citations is available through implementors of the
-`hayagriva::style::CitationStyle` trait whereas bibliographies can be created by
-`hayagriva::style::BibliographyStyle`. Both traits are used through
-`style::Database` which provides methods to format its records as bibliographies
-and citations.
+To format entries, you need to wrap them in a `CitationRequest`. Each of these
+can reference multiple entries in their respective `CitationItem`s.
+Use these with a `BibliographyDriver` to obtain formatted citations and bibliographies.
+
+You can either supply your own CSL files or choose from about 100 bundled
+citation styles using the `archive` feature.
 
 If the default features are enabled, Hayagriva supports BibTeX and BibLaTeX
 bibliographies. You can use `io::from_biblatex_str` to parse such
@@ -133,7 +139,7 @@ quantized-vortex:
 
 let entries = from_yaml_str(yaml).unwrap();
 let journal = select!((Article["date"]) > ("journal":Periodical));
-assert!(journal.matches(&entries[0]));
+assert!(journal.matches(entries.nth(0).unwrap()));
 ```
 
 There are two ways to check if a selector matches an entry.
@@ -164,7 +170,8 @@ dependence:
     title: The program dependence graph and its use in optimization
     author: ["Ferrante, Jeanne", "Ottenstein, Karl J.", "Warren, Joe D."]
     date: 1987-07
-    doi: "10.1145/24039.24041"
+    serial-number:
+        doi: "10.1145/24039.24041"
     parent:
         type: Periodical
         title: ACM Transactions on Programming Languages and Systems
@@ -254,12 +261,10 @@ tab. We would also be very happy to accept PRs for bug fixes, minor
 refactorings, features that were requested in the issues and greenlit by us, as
 well as the planned features listed below:
 
-- More citation and reference styles (especially styles used in the 'hard'
-  sciences would be incredibly appreciated)
 - Implementing the YAML-to-BibLaTeX conversion
-- Improvements to the sentence and title formatter
-- Work for non-English bibliographies
 - Documentation improvements
+- CSL bugfixes
+- CSL-M Support
 
 We wish to thank each and every prospective contributor for the effort you (plan
 to) invest in this project and for adopting it!
@@ -271,3 +276,9 @@ Hayagriva is licensed under a MIT / Apache 2.0 dual license.
 Users and consumers of the library may choose which of those licenses they want
 to apply whereas contributors have to accept that their code is in compliance
 and distributed under the terms of both of these licenses.
+
+Hayagriva includes CSL styles that are licensed as CC-BY-SA 3.0 Deed if the
+`archive` feature is enabled. The file `styles.cbor.rkyv` is a collection of
+these works and falls under this license. Retrieve attribution information by
+deserializing it using the `styles` function and reading the `StyleInfo`
+structs.