anil.recoil.org
OCaml codecs for the Citation File Format (CFF)
import
+17
-1
.gitignore
+17
-1
.gitignore
+53
.tangled/workflows/build.yml
+53
.tangled/workflows/build.yml
···
···
1
+
when:
2
+
- event: ["push", "pull_request"]
3
+
branch: ["main"]
4
+
5
+
engine: nixery
6
+
7
+
dependencies:
8
+
nixpkgs:
9
+
- shell
10
+
- stdenv
11
+
- findutils
12
+
- binutils
13
+
- libunwind
14
+
- ncurses
15
+
- opam
16
+
- git
17
+
- gawk
18
+
- gnupatch
19
+
- gnum4
20
+
- gnumake
21
+
- gnutar
22
+
- gnused
23
+
- gnugrep
24
+
- diffutils
25
+
- gzip
26
+
- bzip2
27
+
- gcc
28
+
- ocaml
29
+
- pkg-config
30
+
31
+
steps:
32
+
- name: opam
33
+
command: |
34
+
opam init --disable-sandboxing -a -y
35
+
- name: repo
36
+
command: |
37
+
opam repo add aoah https://tangled.org/anil.recoil.org/aoah-opam-repo.git
38
+
- name: switch
39
+
command: |
40
+
opam install . --confirm-level=unsafe-yes --deps-only
41
+
- name: build
42
+
command: |
43
+
opam exec -- dune build -p cff
44
+
- name: switch-test
45
+
command: |
46
+
opam install . --confirm-level=unsafe-yes --deps-only --with-test
47
+
- name: test
48
+
command: |
49
+
opam exec -- dune runtest --verbose
50
+
- name: doc
51
+
command: |
52
+
opam install -y odoc
53
+
opam exec -- dune build @doc
+15
LICENSE.md
+15
LICENSE.md
···
···
1
+
ISC License
2
+
3
+
Copyright (c) 2026 Anil Madhavapeddy <anil@recoil.org>
4
+
5
+
Permission to use, copy, modify, and distribute this software for any
6
+
purpose with or without fee is hereby granted, provided that the above
7
+
copyright notice and this permission notice appear in all copies.
8
+
9
+
THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
10
+
WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
11
+
MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
12
+
ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
13
+
WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
14
+
ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
15
+
OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+82
README.md
+82
README.md
···
···
1
+
# ocaml-cff
2
+
3
+
Citation File Format (CFF) codec for OCaml.
4
+
5
+
A library for parsing and generating `CITATION.cff` files following the
6
+
[CFF 1.2.0 specification](https://github.com/citation-file-format/citation-file-format).
7
+
CFF is a human- and machine-readable format for software and dataset citation metadata.
8
+
9
+
## Features
10
+
11
+
- Full CFF 1.2.0 specification support
12
+
- SPDX license expression parsing via `spdx_licenses`
13
+
- Lenient parsing (accepts unknown fields, preserves non-SPDX licenses for round-tripping)
14
+
- Multiple I/O backends:
15
+
- `cff.unix` - Unix file I/O using `In_channel`/`Out_channel`
16
+
- `cff.eio` - Eio-based async I/O
17
+
18
+
## Installation
19
+
20
+
```
21
+
opam install cff
22
+
```
23
+
24
+
## Usage
25
+
26
+
### Reading a CITATION.cff file
27
+
28
+
```ocaml
29
+
(* Using cff.unix *)
30
+
match Cff_unix.of_file "CITATION.cff" with
31
+
| Ok cff ->
32
+
Printf.printf "Title: %s\n" (Cff.title cff);
33
+
Printf.printf "Authors: %d\n" (List.length (Cff.authors cff))
34
+
| Error msg ->
35
+
Printf.eprintf "Error: %s\n" msg
36
+
```
37
+
38
+
### Creating a CFF record programmatically
39
+
40
+
```ocaml
41
+
let author = Cff.Author.person
42
+
~family_names:"Smith"
43
+
~given_names:"Jane"
44
+
~orcid:"https://orcid.org/0000-0001-2345-6789"
45
+
() in
46
+
let cff = Cff.make
47
+
~title:"My Research Software"
48
+
~authors:[author]
49
+
~version:"1.0.0"
50
+
~doi:"10.5281/zenodo.1234567"
51
+
~license:(`Spdx (Spdx_licenses.parse_exn "MIT"))
52
+
()
53
+
```
54
+
55
+
### Writing a CITATION.cff file
56
+
57
+
```ocaml
58
+
match Cff_unix.to_file "CITATION.cff" cff with
59
+
| Ok () -> print_endline "Written successfully"
60
+
| Error msg -> Printf.eprintf "Error: %s\n" msg
61
+
```
62
+
63
+
## API Overview
64
+
65
+
### Core Types
66
+
67
+
- `Cff.t` - A complete CFF document
68
+
- `Cff.Author.t` - Person or entity (polymorphic variant)
69
+
- `Cff.Reference.t` - Bibliographic reference
70
+
- `Cff.License.t` - SPDX expression or custom license with optional URL
71
+
- `Cff.Identifier.t` - DOI, URL, SWH, or custom identifier
72
+
73
+
### Submodules
74
+
75
+
- `Cff.Person` - Individual author with name fields
76
+
- `Cff.Entity` - Organization, team, or conference
77
+
- `Cff.Date` - ISO 8601 date as `(year, month, day)` tuple
78
+
- `Cff.Reference` - Full bibliographic reference with 60+ fields
79
+
80
+
## License
81
+
82
+
ISC License. See [LICENSE.md](LICENSE.md).
+7
-6
cff.opam
+7
-6
cff.opam
···
3
synopsis: "Citation File Format (CFF) codec for OCaml"
4
description:
5
"A library for parsing and generating CITATION.cff files following the CFF 1.2.0 specification. Provides findlib subpackages: cff.unix for Unix file I/O and cff.eio for Eio-based I/O."
6
-
maintainer: ["anil@recoil.org"]
7
-
authors: ["The ocaml-cff programmers"]
8
license: "ISC"
9
-
homepage: "https://github.com/avsm/ocaml-cff"
10
-
bug-reports: "https://github.com/avsm/ocaml-cff/issues"
11
depends: [
12
"dune" {>= "3.20"}
13
-
"ocaml" {>= "4.14.0"}
14
"ptime"
15
"ISO3166"
16
"spdx_licenses"
···
20
"eio"
21
"bytesrw-eio"
22
"odoc" {with-doc}
23
]
24
build: [
25
["dune" "subst"] {dev}
···
35
"@doc" {with-doc}
36
]
37
]
38
-
dev-repo: "git+https://github.com/avsm/ocaml-cff.git"
39
x-maintenance-intent: ["(latest)"]
···
3
synopsis: "Citation File Format (CFF) codec for OCaml"
4
description:
5
"A library for parsing and generating CITATION.cff files following the CFF 1.2.0 specification. Provides findlib subpackages: cff.unix for Unix file I/O and cff.eio for Eio-based I/O."
6
+
maintainer: ["Anil Madhavapeddy <anil@recoil.org>"]
7
+
authors: ["Anil Madhavapeddy"]
8
license: "ISC"
9
+
homepage: "https://tangled.org/@anil.recoil.org/ocaml-cff"
10
+
bug-reports: "https://tangled.org/@anil.recoil.org/ocaml-cff/issues"
11
depends: [
12
"dune" {>= "3.20"}
13
+
"ocaml" {>= "5.1.0"}
14
"ptime"
15
"ISO3166"
16
"spdx_licenses"
···
20
"eio"
21
"bytesrw-eio"
22
"odoc" {with-doc}
23
+
"alcotest" {with-test & >= "1.7.0"}
24
+
"eio_main" {with-test}
25
]
26
build: [
27
["dune" "subst"] {dev}
···
37
"@doc" {with-doc}
38
]
39
]
40
x-maintenance-intent: ["(latest)"]
+16
-6
dune-project
+16
-6
dune-project
···
1
(lang dune 3.20)
2
(name cff)
3
(generate_opam_files true)
4
(license ISC)
5
-
(authors "The ocaml-cff programmers")
6
-
(maintainers "anil@recoil.org")
7
-
(source (github avsm/ocaml-cff))
8
9
(package
10
(name cff)
11
(synopsis "Citation File Format (CFF) codec for OCaml")
12
(description
13
-
"A library for parsing and generating CITATION.cff files following the CFF 1.2.0 specification. Provides findlib subpackages: cff.unix for Unix file I/O and cff.eio for Eio-based I/O.")
14
(depends
15
-
(ocaml (>= 4.14.0))
16
ptime
17
ISO3166
18
spdx_licenses
···
20
yamlt
21
bytesrw
22
eio
23
-
bytesrw-eio))
···
1
(lang dune 3.20)
2
+
3
(name cff)
4
+
5
(generate_opam_files true)
6
+
7
(license ISC)
8
+
(authors "Anil Madhavapeddy")
9
+
(homepage "https://tangled.org/@anil.recoil.org/ocaml-cff")
10
+
(maintainers "Anil Madhavapeddy <anil@recoil.org>")
11
+
(bug_reports "https://tangled.org/@anil.recoil.org/ocaml-cff/issues")
12
+
(maintenance_intent "(latest)")
13
14
(package
15
(name cff)
16
(synopsis "Citation File Format (CFF) codec for OCaml")
17
(description
18
+
"A library for parsing and generating CITATION.cff files following the \
19
+
CFF 1.2.0 specification. Provides findlib subpackages: cff.unix for Unix \
20
+
file I/O and cff.eio for Eio-based I/O.")
21
(depends
22
+
(ocaml (>= 5.1.0))
23
ptime
24
ISO3166
25
spdx_licenses
···
27
yamlt
28
bytesrw
29
eio
30
+
bytesrw-eio
31
+
(odoc :with-doc)
32
+
(alcotest (and :with-test (>= 1.7.0)))
33
+
(eio_main :with-test)))
+153
-91
lib/cff.ml
+153
-91
lib/cff.ml
···
1
(*---------------------------------------------------------------------------
2
-
Copyright (c) 2025 The ocaml-cff programmers. All rights reserved.
3
SPDX-License-Identifier: ISC
4
---------------------------------------------------------------------------*)
5
···
9
module Date = Cff_date
10
module Country = Cff_country
11
module License = Cff_license
12
-
13
module Identifier_type = Cff_enums.Identifier_type
14
module Reference_type = Cff_enums.Reference_type
15
module Status = Cff_enums.Status
16
module Cff_type = Cff_enums.Cff_type
17
-
18
module Address = Cff_address.Address
19
module Contact = Cff_address.Contact
20
-
21
module Author = Cff_author
22
-
module Name = Cff_author.Name
23
module Person = Cff_author.Person
24
module Entity = Cff_author.Entity
25
-
26
module Identifier = Cff_identifier
27
module Reference = Cff_reference
28
29
(* Root CFF type - integrated directly *)
30
31
-
type t = {
32
-
cff_version : string;
33
-
message : string;
34
-
title : string;
35
-
authors : Cff_author.t list;
36
-
abstract : string option;
37
-
commit : string option;
38
-
contact : Cff_author.t list option;
39
-
date_released : Cff_date.t option;
40
-
doi : string option;
41
-
identifiers : Cff_identifier.t list option;
42
-
keywords : string list option;
43
-
license : Cff_license.t option;
44
-
license_url : string option;
45
-
preferred_citation : Cff_reference.t option;
46
-
references : Cff_reference.t list option;
47
-
repository : string option;
48
-
repository_artifact : string option;
49
-
repository_code : string option;
50
-
type_ : Cff_enums.Cff_type.t option;
51
-
url : string option;
52
-
version : string option;
53
-
}
54
55
let default_cff_version = "1.2.0"
56
-
let default_message = "If you use this software, please cite it using the metadata from this file."
57
58
let make
59
-
?(cff_version = default_cff_version)
60
-
?(message = default_message)
61
-
~title
62
-
~authors
63
-
?abstract
64
-
?commit
65
-
?contact
66
-
?date_released
67
-
?doi
68
-
?identifiers
69
-
?keywords
70
-
?license
71
-
?license_url
72
-
?preferred_citation
73
-
?references
74
-
?repository
75
-
?repository_artifact
76
-
?repository_code
77
-
?type_
78
-
?url
79
-
?version
80
-
() =
81
-
{ cff_version; message; title; authors;
82
-
abstract; commit; contact; date_released; doi;
83
-
identifiers; keywords; license; license_url;
84
-
preferred_citation; references; repository;
85
-
repository_artifact; repository_code; type_; url; version }
86
87
(* Required field accessors *)
88
let cff_version t = t.cff_version
···
99
let identifiers t = t.identifiers
100
let keywords t = t.keywords
101
let license t = t.license
102
-
let license_url t = t.license_url
103
let preferred_citation t = t.preferred_citation
104
let references t = t.references
105
let repository t = t.repository
···
118
List.iter (fun a -> Format.fprintf ppf " - %a@," Cff_author.pp a) t.authors;
119
Option.iter (fun v -> Format.fprintf ppf "version: %s@," v) t.version;
120
Option.iter (fun v -> Format.fprintf ppf "doi: %s@," v) t.doi;
121
-
Option.iter (fun v -> Format.fprintf ppf "date-released: %a@," Cff_date.pp v) t.date_released;
122
Option.iter (fun v -> Format.fprintf ppf "license: %a@," Cff_license.pp v) t.license;
123
Option.iter (fun v -> Format.fprintf ppf "url: %s@," v) t.url;
124
Option.iter (fun v -> Format.fprintf ppf "repository: %s@," v) t.repository;
···
126
Option.iter (fun v -> Format.fprintf ppf "abstract: %s@," v) t.abstract;
127
Option.iter (fun v -> Format.fprintf ppf "commit: %s@," v) t.commit;
128
Option.iter (fun v -> Format.fprintf ppf "type: %a@," Cff_enums.Cff_type.pp v) t.type_;
129
-
Option.iter (fun kws ->
130
-
Format.fprintf ppf "keywords:@,";
131
-
List.iter (fun k -> Format.fprintf ppf " - %s@," k) kws
132
-
) t.keywords;
133
-
Option.iter (fun ids ->
134
-
Format.fprintf ppf "identifiers:@,";
135
-
List.iter (fun id -> Format.fprintf ppf " - %a@," Cff_identifier.pp id) ids
136
-
) t.identifiers;
137
-
Option.iter (fun contacts ->
138
-
Format.fprintf ppf "contact:@,";
139
-
List.iter (fun c -> Format.fprintf ppf " - %a@," Cff_author.pp c) contacts
140
-
) t.contact;
141
-
Option.iter (fun refs ->
142
-
Format.fprintf ppf "references:@,";
143
-
List.iter (fun r -> Format.fprintf ppf " - %a@," Cff_reference.pp r) refs
144
-
) t.references;
145
-
Option.iter (fun pc ->
146
-
Format.fprintf ppf "preferred-citation:@, %a@," Cff_reference.pp pc
147
-
) t.preferred_citation;
148
Format.fprintf ppf "@]"
149
150
-
let list_jsont elt = Jsont.(array elt |> map ~dec:Stdlib.Array.to_list ~enc:Stdlib.Array.of_list)
151
152
let jsont =
153
let open Jsont in
···
155
let identifiers_jsont = list_jsont Cff_identifier.jsont in
156
let references_jsont = list_jsont Cff_reference.jsont in
157
let keywords_jsont = list_jsont string in
158
-
Object.map ~kind:"CFF"
159
-
(fun cff_version message title authors abstract commit contact
160
-
date_released doi identifiers keywords license license_url
161
-
preferred_citation references repository repository_artifact
162
-
repository_code type_ url version ->
163
-
{ cff_version; message; title; authors;
164
-
abstract; commit; contact; date_released; doi;
165
-
identifiers; keywords; license; license_url;
166
-
preferred_citation; references; repository;
167
-
repository_artifact; repository_code; type_; url; version })
168
|> Object.mem "cff-version" string ~enc:(fun t -> t.cff_version)
169
|> Object.mem "message" string ~enc:(fun t -> t.message)
170
|> Object.mem "title" string ~enc:(fun t -> t.title)
···
177
|> Object.opt_mem "identifiers" identifiers_jsont ~enc:(fun t -> t.identifiers)
178
|> Object.opt_mem "keywords" keywords_jsont ~enc:(fun t -> t.keywords)
179
|> Object.opt_mem "license" Cff_license.jsont ~enc:(fun t -> t.license)
180
-
|> Object.opt_mem "license-url" string ~enc:(fun t -> t.license_url)
181
-
|> Object.opt_mem "preferred-citation" Cff_reference.jsont ~enc:(fun t -> t.preferred_citation)
182
|> Object.opt_mem "references" references_jsont ~enc:(fun t -> t.references)
183
|> Object.opt_mem "repository" string ~enc:(fun t -> t.repository)
184
|> Object.opt_mem "repository-artifact" string ~enc:(fun t -> t.repository_artifact)
···
187
|> Object.opt_mem "url" string ~enc:(fun t -> t.url)
188
|> Object.opt_mem "version" string ~enc:(fun t -> t.version)
189
|> Object.finish
···
1
(*---------------------------------------------------------------------------
2
+
Copyright (c) 2026 The ocaml-cff programmers. All rights reserved.
3
SPDX-License-Identifier: ISC
4
---------------------------------------------------------------------------*)
5
···
9
module Date = Cff_date
10
module Country = Cff_country
11
module License = Cff_license
12
module Identifier_type = Cff_enums.Identifier_type
13
module Reference_type = Cff_enums.Reference_type
14
module Status = Cff_enums.Status
15
module Cff_type = Cff_enums.Cff_type
16
module Address = Cff_address.Address
17
module Contact = Cff_address.Contact
18
module Author = Cff_author
19
module Person = Cff_author.Person
20
module Entity = Cff_author.Entity
21
module Identifier = Cff_identifier
22
module Reference = Cff_reference
23
24
(* Root CFF type - integrated directly *)
25
26
+
type t =
27
+
{ cff_version : string
28
+
; message : string
29
+
; title : string
30
+
; authors : Cff_author.t list
31
+
; abstract : string option
32
+
; commit : string option
33
+
; contact : Cff_author.t list option
34
+
; date_released : Cff_date.t option
35
+
; doi : string option
36
+
; identifiers : Cff_identifier.t list option
37
+
; keywords : string list option
38
+
; license : Cff_license.t option
39
+
; preferred_citation : Cff_reference.t option
40
+
; references : Cff_reference.t list option
41
+
; repository : string option
42
+
; repository_artifact : string option
43
+
; repository_code : string option
44
+
; type_ : Cff_enums.Cff_type.t option
45
+
; url : string option
46
+
; version : string option
47
+
}
48
49
let default_cff_version = "1.2.0"
50
+
51
+
let default_message =
52
+
"If you use this software, please cite it using the metadata from this file."
53
+
;;
54
55
let make
56
+
?(cff_version = default_cff_version)
57
+
?(message = default_message)
58
+
~title
59
+
~authors
60
+
?abstract
61
+
?commit
62
+
?contact
63
+
?date_released
64
+
?doi
65
+
?identifiers
66
+
?keywords
67
+
?license
68
+
?preferred_citation
69
+
?references
70
+
?repository
71
+
?repository_artifact
72
+
?repository_code
73
+
?type_
74
+
?url
75
+
?version
76
+
()
77
+
=
78
+
{ cff_version
79
+
; message
80
+
; title
81
+
; authors
82
+
; abstract
83
+
; commit
84
+
; contact
85
+
; date_released
86
+
; doi
87
+
; identifiers
88
+
; keywords
89
+
; license
90
+
; preferred_citation
91
+
; references
92
+
; repository
93
+
; repository_artifact
94
+
; repository_code
95
+
; type_
96
+
; url
97
+
; version
98
+
}
99
+
;;
100
101
(* Required field accessors *)
102
let cff_version t = t.cff_version
···
113
let identifiers t = t.identifiers
114
let keywords t = t.keywords
115
let license t = t.license
116
let preferred_citation t = t.preferred_citation
117
let references t = t.references
118
let repository t = t.repository
···
131
List.iter (fun a -> Format.fprintf ppf " - %a@," Cff_author.pp a) t.authors;
132
Option.iter (fun v -> Format.fprintf ppf "version: %s@," v) t.version;
133
Option.iter (fun v -> Format.fprintf ppf "doi: %s@," v) t.doi;
134
+
Option.iter
135
+
(fun v -> Format.fprintf ppf "date-released: %a@," Cff_date.pp v)
136
+
t.date_released;
137
Option.iter (fun v -> Format.fprintf ppf "license: %a@," Cff_license.pp v) t.license;
138
Option.iter (fun v -> Format.fprintf ppf "url: %s@," v) t.url;
139
Option.iter (fun v -> Format.fprintf ppf "repository: %s@," v) t.repository;
···
141
Option.iter (fun v -> Format.fprintf ppf "abstract: %s@," v) t.abstract;
142
Option.iter (fun v -> Format.fprintf ppf "commit: %s@," v) t.commit;
143
Option.iter (fun v -> Format.fprintf ppf "type: %a@," Cff_enums.Cff_type.pp v) t.type_;
144
+
Option.iter
145
+
(fun kws ->
146
+
Format.fprintf ppf "keywords:@,";
147
+
List.iter (fun k -> Format.fprintf ppf " - %s@," k) kws)
148
+
t.keywords;
149
+
Option.iter
150
+
(fun ids ->
151
+
Format.fprintf ppf "identifiers:@,";
152
+
List.iter (fun id -> Format.fprintf ppf " - %a@," Cff_identifier.pp id) ids)
153
+
t.identifiers;
154
+
Option.iter
155
+
(fun contacts ->
156
+
Format.fprintf ppf "contact:@,";
157
+
List.iter (fun c -> Format.fprintf ppf " - %a@," Cff_author.pp c) contacts)
158
+
t.contact;
159
+
Option.iter
160
+
(fun refs ->
161
+
Format.fprintf ppf "references:@,";
162
+
List.iter (fun r -> Format.fprintf ppf " - %a@," Cff_reference.pp r) refs)
163
+
t.references;
164
+
Option.iter
165
+
(fun pc -> Format.fprintf ppf "preferred-citation:@, %a@," Cff_reference.pp pc)
166
+
t.preferred_citation;
167
Format.fprintf ppf "@]"
168
+
;;
169
170
+
let list_jsont elt =
171
+
Jsont.(array elt |> map ~dec:Stdlib.Array.to_list ~enc:Stdlib.Array.of_list)
172
+
;;
173
174
let jsont =
175
let open Jsont in
···
177
let identifiers_jsont = list_jsont Cff_identifier.jsont in
178
let references_jsont = list_jsont Cff_reference.jsont in
179
let keywords_jsont = list_jsont string in
180
+
Object.map
181
+
~kind:"CFF"
182
+
(fun
183
+
cff_version
184
+
message
185
+
title
186
+
authors
187
+
abstract
188
+
commit
189
+
contact
190
+
date_released
191
+
doi
192
+
identifiers
193
+
keywords
194
+
license
195
+
license_url
196
+
preferred_citation
197
+
references
198
+
repository
199
+
repository_artifact
200
+
repository_code
201
+
type_
202
+
url
203
+
version
204
+
->
205
+
let license = Option.map (Cff_license.with_url_opt license_url) license in
206
+
{ cff_version
207
+
; message
208
+
; title
209
+
; authors
210
+
; abstract
211
+
; commit
212
+
; contact
213
+
; date_released
214
+
; doi
215
+
; identifiers
216
+
; keywords
217
+
; license
218
+
; preferred_citation
219
+
; references
220
+
; repository
221
+
; repository_artifact
222
+
; repository_code
223
+
; type_
224
+
; url
225
+
; version
226
+
})
227
|> Object.mem "cff-version" string ~enc:(fun t -> t.cff_version)
228
|> Object.mem "message" string ~enc:(fun t -> t.message)
229
|> Object.mem "title" string ~enc:(fun t -> t.title)
···
236
|> Object.opt_mem "identifiers" identifiers_jsont ~enc:(fun t -> t.identifiers)
237
|> Object.opt_mem "keywords" keywords_jsont ~enc:(fun t -> t.keywords)
238
|> Object.opt_mem "license" Cff_license.jsont ~enc:(fun t -> t.license)
239
+
|> Object.opt_mem "license-url" string ~enc:(fun t ->
240
+
Option.bind t.license Cff_license.url)
241
+
|> Object.opt_mem "preferred-citation" Cff_reference.jsont ~enc:(fun t ->
242
+
t.preferred_citation)
243
|> Object.opt_mem "references" references_jsont ~enc:(fun t -> t.references)
244
|> Object.opt_mem "repository" string ~enc:(fun t -> t.repository)
245
|> Object.opt_mem "repository-artifact" string ~enc:(fun t -> t.repository_artifact)
···
248
|> Object.opt_mem "url" string ~enc:(fun t -> t.url)
249
|> Object.opt_mem "version" string ~enc:(fun t -> t.version)
250
|> Object.finish
251
+
;;
+65
-61
lib/cff.mli
+65
-61
lib/cff.mli
···
1
(*---------------------------------------------------------------------------
2
-
Copyright (c) 2025 The ocaml-cff programmers. All rights reserved.
3
SPDX-License-Identifier: ISC
4
---------------------------------------------------------------------------*)
5
6
(** Citation File Format (CFF) codec for OCaml.
7
8
-
This library provides types and codecs for the
9
{{:https://citation-file-format.github.io/}Citation File Format (CFF)}
10
version 1.2.0, a human- and machine-readable format for software and
11
dataset citation metadata.
···
22
- [title]: The name of the software or dataset
23
- [authors]: A list of persons and/or entities
24
25
-
{1 Quick Start}
26
-
27
{2 Creating a CFF record}
28
29
{[
30
-
let author = Cff.Author.Person
31
-
(Cff.Person.make ~family_names:"Smith" ~given_names:"Jane" ()) in
32
let cff = Cff.make
33
~title:"My Research Software"
34
~authors:[author]
···
37
()
38
]}
39
40
-
{2 File I/O}
41
42
For file operations, use the backend-specific subpackages:
43
- [cff.unix] - Unix file I/O using {!In_channel}/{!Out_channel}
···
54
55
This implementation follows the
56
{{:https://github.com/citation-file-format/citation-file-format}CFF 1.2.0 specification}.
57
-
Key concepts include:
58
59
- {!module:Author}: Can be persons (with family/given names) or entities
60
(organizations, identified by a [name] field)
···
100
Used for author and entity addresses. *)
101
module Country = Cff_country
102
103
(** SPDX license identifiers.
104
105
CFF uses {{:https://spdx.org/licenses/}SPDX license identifiers} for
···
160
161
(** {1 Construction} *)
162
163
-
val default_cff_version : string
164
(** The default CFF version used when not specified: ["1.2.0"]. *)
165
166
-
val default_message : string
167
(** The default citation message:
168
["If you use this software, please cite it using the metadata from this file."] *)
169
170
-
val make :
171
-
?cff_version:string ->
172
-
?message:string ->
173
-
title:string ->
174
-
authors:Author.t list ->
175
-
?abstract:string ->
176
-
?commit:string ->
177
-
?contact:Author.t list ->
178
-
?date_released:Date.t ->
179
-
?doi:string ->
180
-
?identifiers:Identifier.t list ->
181
-
?keywords:string list ->
182
-
?license:License.t ->
183
-
?license_url:string ->
184
-
?preferred_citation:Reference.t ->
185
-
?references:Reference.t list ->
186
-
?repository:string ->
187
-
?repository_artifact:string ->
188
-
?repository_code:string ->
189
-
?type_:Cff_type.t ->
190
-
?url:string ->
191
-
?version:string ->
192
-
unit -> t
193
(** [make ~title ~authors ...] constructs a CFF value.
194
195
@param cff_version The CFF schema version (default: {!default_cff_version})
196
@param message Instructions for users on how to cite (default: {!default_message})
197
@param title The name of the software or dataset
198
@param authors List of persons and/or entities who created the work *)
199
200
(** {2 Required Fields} *)
201
202
-
val cff_version : t -> string
203
(** The CFF schema version that this file adheres to.
204
205
For CFF 1.2.0 files, this should be ["1.2.0"]. The version determines
206
which keys are valid and how they should be interpreted. *)
207
208
-
val message : t -> string
209
(** A message to readers explaining how to cite the work.
210
211
Common examples:
···
213
- ["Please cite this software using the metadata from 'preferred-citation'."]
214
215
The message should guide users toward the preferred citation method. *)
216
217
-
val title : t -> string
218
(** The name of the software or dataset.
219
220
This is the title that should appear in citations. For software, it's
221
typically the project name; for datasets, the dataset title. *)
222
223
-
val authors : t -> Author.t list
224
(** The creators of the software or dataset.
225
226
Authors can be persons (individuals) or entities (organizations).
227
At least one author is required for a valid CFF file. The order
228
typically reflects contribution significance. *)
229
230
(** {2 Optional Fields} *)
231
232
-
val abstract : t -> string option
233
(** A description of the software or dataset.
234
235
Provides context about what the work does, its purpose, and scope. *)
236
237
-
val commit : t -> string option
238
(** The commit hash or revision number of the software version.
239
240
Useful for precise version identification beyond semantic versioning.
241
Example: ["1ff847d81f29c45a3a1a5ce73d38e45c2f319bba"] *)
242
243
-
val contact : t -> Author.t list option
244
(** Contact persons or entities for the software or dataset.
245
246
May differ from authors; useful when the primary contact is a
247
project maintainer rather than the original author. *)
248
249
-
val date_released : t -> Date.t option
250
(** The date when the software or dataset was released.
251
252
Format is [(year, month, day)], corresponding to ISO 8601 [YYYY-MM-DD]. *)
253
254
-
val doi : t -> string option
255
(** The Digital Object Identifier for the software or dataset.
256
257
DOIs provide persistent, citable identifiers. This is a shorthand
258
for a single DOI; use {!identifiers} for multiple DOIs or other
259
identifier types. Example: ["10.5281/zenodo.1234567"] *)
260
261
-
val identifiers : t -> Identifier.t list option
262
(** Additional identifiers beyond the primary DOI.
263
264
Each identifier has a type (DOI, URL, SWH, other), value, and
265
optional description. Useful for versioned DOIs, Software Heritage
266
identifiers, or repository URLs. *)
267
268
-
val keywords : t -> string list option
269
(** Descriptive keywords for the work.
270
271
Help with discoverability and categorization. Example:
272
[["machine learning"; "image processing"; "python"]] *)
273
274
-
val license : t -> License.t option
275
(** The SPDX license identifier(s) for the work.
276
277
Uses {{:https://spdx.org/licenses/}SPDX identifiers}. Multiple
278
licenses imply an OR relationship (user may choose any).
279
Example: ["MIT"], ["Apache-2.0"], or [["GPL-3.0-only"; "MIT"]]. *)
280
-
281
-
val license_url : t -> string option
282
-
(** URL to the license text for non-standard licenses.
283
-
284
-
Only needed for licenses not in the SPDX list. Standard SPDX
285
-
licenses have well-known URLs. *)
286
287
-
val preferred_citation : t -> Reference.t option
288
(** A reference to cite instead of the software itself.
289
290
Used for "credit redirection" when authors prefer citation of
291
a related publication (e.g., a methods paper) over the software.
292
Note: Software citation principles recommend citing software
293
directly; use this field judiciously. *)
294
295
-
val references : t -> Reference.t list option
296
(** Works that this software cites or depends upon.
297
298
Functions like a bibliography, listing dependencies, foundational
299
works, or related publications. Each reference includes full
300
bibliographic metadata. *)
301
302
-
val repository : t -> string option
303
(** URL to the repository where the software is developed.
304
305
Typically a version control system URL. For source code repositories,
306
prefer {!repository_code}. *)
307
308
-
val repository_artifact : t -> string option
309
(** URL to the built/compiled artifact repository.
310
311
For binary distributions, package registries (npm, PyPI, CRAN),
312
or container registries. *)
313
314
-
val repository_code : t -> string option
315
(** URL to the source code repository.
316
317
Typically a GitHub, GitLab, or similar URL where the source
318
code is publicly accessible. *)
319
320
-
val type_ : t -> Cff_type.t option
321
(** The type of work: [`Software] (default) or [`Dataset].
322
323
Most CFF files describe software; use [`Dataset] for data packages. *)
324
325
-
val url : t -> string option
326
(** The URL of the software or dataset homepage.
327
328
A general landing page, documentation site, or project website. *)
329
330
-
val version : t -> string option
331
(** The version string of the software or dataset.
332
333
Can be any version format: semantic versioning (["1.2.3"]),
334
date-based (["2024.01"]), or other schemes. *)
335
336
(** {1 Formatting and Codec} *)
337
338
val pp : Format.formatter -> t -> unit
339
-
(** Pretty-print a CFF value in a human-readable YAML-like format. *)
340
341
-
val jsont : t Jsont.t
342
(** JSON/YAML codec for serialization and deserialization.
343
344
Used internally by the YAML codec functions. *)
···
1
(*---------------------------------------------------------------------------
2
+
Copyright (c) 2026 The ocaml-cff programmers. All rights reserved.
3
SPDX-License-Identifier: ISC
4
---------------------------------------------------------------------------*)
5
6
(** Citation File Format (CFF) codec for OCaml.
7
8
+
This library provides codecs for the
9
{{:https://citation-file-format.github.io/}Citation File Format (CFF)}
10
version 1.2.0, a human- and machine-readable format for software and
11
dataset citation metadata.
···
22
- [title]: The name of the software or dataset
23
- [authors]: A list of persons and/or entities
24
25
{2 Creating a CFF record}
26
27
{[
28
+
let author = Cff.Author.person
29
+
~family_names:"Smith" ~given_names:"Jane" () in
30
let cff = Cff.make
31
~title:"My Research Software"
32
~authors:[author]
···
35
()
36
]}
37
38
+
{2 I/O}
39
40
For file operations, use the backend-specific subpackages:
41
- [cff.unix] - Unix file I/O using {!In_channel}/{!Out_channel}
···
52
53
This implementation follows the
54
{{:https://github.com/citation-file-format/citation-file-format}CFF 1.2.0 specification}.
55
+
Useful modules include:
56
57
- {!module:Author}: Can be persons (with family/given names) or entities
58
(organizations, identified by a [name] field)
···
98
Used for author and entity addresses. *)
99
module Country = Cff_country
100
101
+
(** Physical address information.
102
+
103
+
Address fields used for persons and entities: street address, city,
104
+
region (state/province), postal code, and country code. *)
105
+
module Address = Cff_address.Address
106
+
107
+
(** Contact information.
108
+
109
+
Contact fields used for persons and entities: email, telephone, fax,
110
+
website URL, and ORCID identifier. *)
111
+
module Contact = Cff_address.Contact
112
+
113
(** SPDX license identifiers.
114
115
CFF uses {{:https://spdx.org/licenses/}SPDX license identifiers} for
···
170
171
(** {1 Construction} *)
172
173
(** The default CFF version used when not specified: ["1.2.0"]. *)
174
+
val default_cff_version : string
175
176
(** The default citation message:
177
["If you use this software, please cite it using the metadata from this file."] *)
178
+
val default_message : string
179
180
(** [make ~title ~authors ...] constructs a CFF value.
181
182
@param cff_version The CFF schema version (default: {!default_cff_version})
183
@param message Instructions for users on how to cite (default: {!default_message})
184
@param title The name of the software or dataset
185
@param authors List of persons and/or entities who created the work *)
186
+
val make
187
+
: ?cff_version:string
188
+
-> ?message:string
189
+
-> title:string
190
+
-> authors:Author.t list
191
+
-> ?abstract:string
192
+
-> ?commit:string
193
+
-> ?contact:Author.t list
194
+
-> ?date_released:Date.t
195
+
-> ?doi:string
196
+
-> ?identifiers:Identifier.t list
197
+
-> ?keywords:string list
198
+
-> ?license:License.t
199
+
-> ?preferred_citation:Reference.t
200
+
-> ?references:Reference.t list
201
+
-> ?repository:string
202
+
-> ?repository_artifact:string
203
+
-> ?repository_code:string
204
+
-> ?type_:Cff_type.t
205
+
-> ?url:string
206
+
-> ?version:string
207
+
-> unit
208
+
-> t
209
210
(** {2 Required Fields} *)
211
212
(** The CFF schema version that this file adheres to.
213
214
For CFF 1.2.0 files, this should be ["1.2.0"]. The version determines
215
which keys are valid and how they should be interpreted. *)
216
+
val cff_version : t -> string
217
218
(** A message to readers explaining how to cite the work.
219
220
Common examples:
···
222
- ["Please cite this software using the metadata from 'preferred-citation'."]
223
224
The message should guide users toward the preferred citation method. *)
225
+
val message : t -> string
226
227
(** The name of the software or dataset.
228
229
This is the title that should appear in citations. For software, it's
230
typically the project name; for datasets, the dataset title. *)
231
+
val title : t -> string
232
233
(** The creators of the software or dataset.
234
235
Authors can be persons (individuals) or entities (organizations).
236
At least one author is required for a valid CFF file. The order
237
typically reflects contribution significance. *)
238
+
val authors : t -> Author.t list
239
240
(** {2 Optional Fields} *)
241
242
(** A description of the software or dataset.
243
244
Provides context about what the work does, its purpose, and scope. *)
245
+
val abstract : t -> string option
246
247
(** The commit hash or revision number of the software version.
248
249
Useful for precise version identification beyond semantic versioning.
250
Example: ["1ff847d81f29c45a3a1a5ce73d38e45c2f319bba"] *)
251
+
val commit : t -> string option
252
253
(** Contact persons or entities for the software or dataset.
254
255
May differ from authors; useful when the primary contact is a
256
project maintainer rather than the original author. *)
257
+
val contact : t -> Author.t list option
258
259
(** The date when the software or dataset was released.
260
261
Format is [(year, month, day)], corresponding to ISO 8601 [YYYY-MM-DD]. *)
262
+
val date_released : t -> Date.t option
263
264
(** The Digital Object Identifier for the software or dataset.
265
266
DOIs provide persistent, citable identifiers. This is a shorthand
267
for a single DOI; use {!identifiers} for multiple DOIs or other
268
identifier types. Example: ["10.5281/zenodo.1234567"] *)
269
+
val doi : t -> string option
270
271
(** Additional identifiers beyond the primary DOI.
272
273
Each identifier has a type (DOI, URL, SWH, other), value, and
274
optional description. Useful for versioned DOIs, Software Heritage
275
identifiers, or repository URLs. *)
276
+
val identifiers : t -> Identifier.t list option
277
278
(** Descriptive keywords for the work.
279
280
Help with discoverability and categorization. Example:
281
[["machine learning"; "image processing"; "python"]] *)
282
+
val keywords : t -> string list option
283
284
(** The SPDX license identifier(s) for the work.
285
286
Uses {{:https://spdx.org/licenses/}SPDX identifiers}. Multiple
287
licenses imply an OR relationship (user may choose any).
288
Example: ["MIT"], ["Apache-2.0"], or [["GPL-3.0-only"; "MIT"]]. *)
289
+
val license : t -> License.t option
290
291
(** A reference to cite instead of the software itself.
292
293
Used for "credit redirection" when authors prefer citation of
294
a related publication (e.g., a methods paper) over the software.
295
Note: Software citation principles recommend citing software
296
directly; use this field judiciously. *)
297
+
val preferred_citation : t -> Reference.t option
298
299
(** Works that this software cites or depends upon.
300
301
Functions like a bibliography, listing dependencies, foundational
302
works, or related publications. Each reference includes full
303
bibliographic metadata. *)
304
+
val references : t -> Reference.t list option
305
306
(** URL to the repository where the software is developed.
307
308
Typically a version control system URL. For source code repositories,
309
prefer {!repository_code}. *)
310
+
val repository : t -> string option
311
312
(** URL to the built/compiled artifact repository.
313
314
For binary distributions, package registries (npm, PyPI, CRAN),
315
or container registries. *)
316
+
val repository_artifact : t -> string option
317
318
(** URL to the source code repository.
319
320
Typically a GitHub, GitLab, or similar URL where the source
321
code is publicly accessible. *)
322
+
val repository_code : t -> string option
323
324
(** The type of work: [`Software] (default) or [`Dataset].
325
326
Most CFF files describe software; use [`Dataset] for data packages. *)
327
+
val type_ : t -> Cff_type.t option
328
329
(** The URL of the software or dataset homepage.
330
331
A general landing page, documentation site, or project website. *)
332
+
val url : t -> string option
333
334
(** The version string of the software or dataset.
335
336
Can be any version format: semantic versioning (["1.2.3"]),
337
date-based (["2024.01"]), or other schemes. *)
338
+
val version : t -> string option
339
340
(** {1 Formatting and Codec} *)
341
342
+
(** Pretty-print a CFF value in a human-readable YAML-like format. *)
343
val pp : Format.formatter -> t -> unit
344
345
(** JSON/YAML codec for serialization and deserialization.
346
347
Used internally by the YAML codec functions. *)
348
+
val jsont : t Jsont.t
+43
-55
lib/cff_address.ml
+43
-55
lib/cff_address.ml
···
1
(*---------------------------------------------------------------------------
2
-
Copyright (c) 2025 The ocaml-cff programmers. All rights reserved.
3
SPDX-License-Identifier: ISC
4
---------------------------------------------------------------------------*)
5
···
7
8
(** Physical address information. *)
9
module Address = struct
10
-
type t = {
11
-
address : string option;
12
-
city : string option;
13
-
region : string option;
14
-
post_code : string option;
15
-
country : string option; (* ISO 3166-1 alpha-2 *)
16
-
}
17
18
-
let empty = {
19
-
address = None;
20
-
city = None;
21
-
region = None;
22
-
post_code = None;
23
-
country = None;
24
-
}
25
26
let make ?address ?city ?region ?post_code ?country () =
27
{ address; city; region; post_code; country }
28
29
let of_options ~address ~city ~region ~post_code ~country =
30
{ address; city; region; post_code; country }
31
32
let address t = t.address
33
let city t = t.city
···
36
let country t = t.country
37
38
let is_empty t =
39
-
t.address = None && t.city = None && t.region = None &&
40
-
t.post_code = None && t.country = None
41
42
let pp ppf t =
43
-
let parts = List.filter_map Fun.id [
44
-
t.address;
45
-
t.city;
46
-
t.region;
47
-
t.post_code;
48
-
t.country;
49
-
] in
50
Format.pp_print_string ppf (String.concat ", " parts)
51
52
let jsont_fields ~get obj =
53
obj
···
56
|> Jsont.Object.opt_mem "region" Jsont.string ~enc:(fun x -> (get x).region)
57
|> Jsont.Object.opt_mem "post-code" Jsont.string ~enc:(fun x -> (get x).post_code)
58
|> Jsont.Object.opt_mem "country" Jsont.string ~enc:(fun x -> (get x).country)
59
end
60
61
(** Contact information. *)
62
module Contact = struct
63
-
type t = {
64
-
email : string option;
65
-
tel : string option;
66
-
fax : string option;
67
-
website : string option;
68
-
orcid : string option;
69
-
}
70
71
-
let empty = {
72
-
email = None;
73
-
tel = None;
74
-
fax = None;
75
-
website = None;
76
-
orcid = None;
77
-
}
78
-
79
-
let make ?email ?tel ?fax ?website ?orcid () =
80
-
{ email; tel; fax; website; orcid }
81
-
82
-
let of_options ~email ~tel ~fax ~website ~orcid =
83
-
{ email; tel; fax; website; orcid }
84
-
85
let email t = t.email
86
let tel t = t.tel
87
let fax t = t.fax
···
89
let orcid t = t.orcid
90
91
let is_empty t =
92
-
t.email = None && t.tel = None && t.fax = None &&
93
-
t.website = None && t.orcid = None
94
95
let pp ppf t =
96
-
let parts = List.filter_map (fun (k, v) ->
97
-
Option.map (fun v -> k ^ ": " ^ v) v
98
-
) [
99
-
("email", t.email);
100
-
("tel", t.tel);
101
-
("website", t.website);
102
-
("orcid", t.orcid);
103
-
] in
104
Format.pp_print_string ppf (String.concat ", " parts)
105
106
let jsont_fields ~get obj =
107
obj
···
110
|> Jsont.Object.opt_mem "fax" Jsont.string ~enc:(fun x -> (get x).fax)
111
|> Jsont.Object.opt_mem "website" Jsont.string ~enc:(fun x -> (get x).website)
112
|> Jsont.Object.opt_mem "orcid" Jsont.string ~enc:(fun x -> (get x).orcid)
113
end
···
1
(*---------------------------------------------------------------------------
2
+
Copyright (c) 2026 The ocaml-cff programmers. All rights reserved.
3
SPDX-License-Identifier: ISC
4
---------------------------------------------------------------------------*)
5
···
7
8
(** Physical address information. *)
9
module Address = struct
10
+
type t =
11
+
{ address : string option
12
+
; city : string option
13
+
; region : string option
14
+
; post_code : string option
15
+
; country : string option (* ISO 3166-1 alpha-2 *)
16
+
}
17
18
+
let empty =
19
+
{ address = None; city = None; region = None; post_code = None; country = None }
20
+
;;
21
22
let make ?address ?city ?region ?post_code ?country () =
23
{ address; city; region; post_code; country }
24
+
;;
25
26
let of_options ~address ~city ~region ~post_code ~country =
27
{ address; city; region; post_code; country }
28
+
;;
29
30
let address t = t.address
31
let city t = t.city
···
34
let country t = t.country
35
36
let is_empty t =
37
+
t.address = None
38
+
&& t.city = None
39
+
&& t.region = None
40
+
&& t.post_code = None
41
+
&& t.country = None
42
+
;;
43
44
let pp ppf t =
45
+
let parts =
46
+
List.filter_map Fun.id [ t.address; t.city; t.region; t.post_code; t.country ]
47
+
in
48
Format.pp_print_string ppf (String.concat ", " parts)
49
+
;;
50
51
let jsont_fields ~get obj =
52
obj
···
55
|> Jsont.Object.opt_mem "region" Jsont.string ~enc:(fun x -> (get x).region)
56
|> Jsont.Object.opt_mem "post-code" Jsont.string ~enc:(fun x -> (get x).post_code)
57
|> Jsont.Object.opt_mem "country" Jsont.string ~enc:(fun x -> (get x).country)
58
+
;;
59
end
60
61
(** Contact information. *)
62
module Contact = struct
63
+
type t =
64
+
{ email : string option
65
+
; tel : string option
66
+
; fax : string option
67
+
; website : string option
68
+
; orcid : string option
69
+
}
70
71
+
let empty = { email = None; tel = None; fax = None; website = None; orcid = None }
72
+
let make ?email ?tel ?fax ?website ?orcid () = { email; tel; fax; website; orcid }
73
+
let of_options ~email ~tel ~fax ~website ~orcid = { email; tel; fax; website; orcid }
74
let email t = t.email
75
let tel t = t.tel
76
let fax t = t.fax
···
78
let orcid t = t.orcid
79
80
let is_empty t =
81
+
t.email = None && t.tel = None && t.fax = None && t.website = None && t.orcid = None
82
+
;;
83
84
let pp ppf t =
85
+
let parts =
86
+
List.filter_map
87
+
(fun (k, v) -> Option.map (fun v -> k ^ ": " ^ v) v)
88
+
[ "email", t.email; "tel", t.tel; "website", t.website; "orcid", t.orcid ]
89
+
in
90
Format.pp_print_string ppf (String.concat ", " parts)
91
+
;;
92
93
let jsont_fields ~get obj =
94
obj
···
97
|> Jsont.Object.opt_mem "fax" Jsont.string ~enc:(fun x -> (get x).fax)
98
|> Jsont.Object.opt_mem "website" Jsont.string ~enc:(fun x -> (get x).website)
99
|> Jsont.Object.opt_mem "orcid" Jsont.string ~enc:(fun x -> (get x).orcid)
100
+
;;
101
end
+71
-57
lib/cff_address.mli
+71
-57
lib/cff_address.mli
···
1
(*---------------------------------------------------------------------------
2
-
Copyright (c) 2025 The ocaml-cff programmers. All rights reserved.
3
SPDX-License-Identifier: ISC
4
---------------------------------------------------------------------------*)
5
···
48
49
All fields are optional; an empty address is valid. *)
50
module Address : sig
51
-
type t
52
(** Physical address record. *)
53
54
-
val empty : t
55
(** Empty address with all fields [None]. *)
56
57
-
val make :
58
-
?address:string ->
59
-
?city:string ->
60
-
?region:string ->
61
-
?post_code:string ->
62
-
?country:string ->
63
-
unit -> t
64
(** Create an address with optional fields.
65
66
@param address Street address
···
68
@param region State, province, or administrative region
69
@param post_code Postal code, ZIP code, or postcode
70
@param country ISO 3166-1 alpha-2 country code *)
71
72
-
val of_options :
73
-
address:string option ->
74
-
city:string option ->
75
-
region:string option ->
76
-
post_code:string option ->
77
-
country:string option ->
78
-
t
79
(** Create an address from option values directly.
80
81
Used internally by jsont decoders where fields are decoded as options. *)
82
83
-
val address : t -> string option
84
(** Street address (e.g., ["77 Massachusetts Avenue"]). *)
85
86
-
val city : t -> string option
87
(** City name (e.g., ["Cambridge"], ["London"]). *)
88
89
-
val region : t -> string option
90
(** State, province, or region (e.g., ["Massachusetts"], ["Bavaria"]). *)
91
92
-
val post_code : t -> string option
93
(** Postal or ZIP code (e.g., ["02139"], ["W1A 1AA"]). *)
94
95
-
val country : t -> string option
96
(** ISO 3166-1 alpha-2 country code (e.g., ["US"], ["DE"], ["GB"]). *)
97
98
-
val is_empty : t -> bool
99
(** [true] if all fields are [None]. *)
100
101
-
val pp : Format.formatter -> t -> unit
102
(** Pretty-print the address. *)
103
104
-
val jsont_fields :
105
-
get:('a -> t) ->
106
-
('a, string option -> string option -> string option ->
107
-
string option -> string option -> 'b) Jsont.Object.map ->
108
-
('a, 'b) Jsont.Object.map
109
(** Add address fields to a jsont object builder.
110
111
This adds the five address fields (address, city, region, post-code,
···
113
[string option] arguments in that order.
114
115
@param get Extracts the address from the parent type for encoding *)
116
end
117
118
(** Contact information.
···
120
Electronic contact details for persons and entities. All fields
121
are optional. *)
122
module Contact : sig
123
-
type t
124
(** Contact information record. *)
125
126
-
val empty : t
127
(** Empty contact with all fields [None]. *)
128
129
-
val make :
130
-
?email:string ->
131
-
?tel:string ->
132
-
?fax:string ->
133
-
?website:string ->
134
-
?orcid:string ->
135
-
unit -> t
136
(** Create contact information with optional fields.
137
138
@param email Email address
···
140
@param fax Fax number (any format)
141
@param website Website URL
142
@param orcid ORCID identifier URL *)
143
144
-
val of_options :
145
-
email:string option ->
146
-
tel:string option ->
147
-
fax:string option ->
148
-
website:string option ->
149
-
orcid:string option ->
150
-
t
151
(** Create contact info from option values directly.
152
153
Used internally by jsont decoders where fields are decoded as options. *)
154
155
-
val email : t -> string option
156
(** Email address (e.g., ["jane.smith\@example.org"]). *)
157
158
-
val tel : t -> string option
159
(** Telephone number. No specific format is required. *)
160
161
-
val fax : t -> string option
162
(** Fax number. No specific format is required. *)
163
164
-
val website : t -> string option
165
(** Website URL (e.g., ["https://example.org/~jsmith"]). *)
166
167
-
val orcid : t -> string option
168
(** ORCID identifier as a URL.
169
170
ORCID (Open Researcher and Contributor ID) provides persistent
···
173
Format: ["https://orcid.org/XXXX-XXXX-XXXX-XXXX"]
174
175
Example: ["https://orcid.org/0000-0001-2345-6789"] *)
176
177
-
val is_empty : t -> bool
178
(** [true] if all fields are [None]. *)
179
180
-
val pp : Format.formatter -> t -> unit
181
(** Pretty-print the contact information. *)
182
183
-
val jsont_fields :
184
-
get:('a -> t) ->
185
-
('a, string option -> string option -> string option ->
186
-
string option -> string option -> 'b) Jsont.Object.map ->
187
-
('a, 'b) Jsont.Object.map
188
(** Add contact fields to a jsont object builder.
189
190
This adds the five contact fields (email, tel, fax, website, orcid)
···
192
[string option] arguments in that order.
193
194
@param get Extracts the contact from the parent type for encoding *)
195
end
···
1
(*---------------------------------------------------------------------------
2
+
Copyright (c) 2026 The ocaml-cff programmers. All rights reserved.
3
SPDX-License-Identifier: ISC
4
---------------------------------------------------------------------------*)
5
···
48
49
All fields are optional; an empty address is valid. *)
50
module Address : sig
51
(** Physical address record. *)
52
+
type t
53
54
(** Empty address with all fields [None]. *)
55
+
val empty : t
56
57
(** Create an address with optional fields.
58
59
@param address Street address
···
61
@param region State, province, or administrative region
62
@param post_code Postal code, ZIP code, or postcode
63
@param country ISO 3166-1 alpha-2 country code *)
64
+
val make
65
+
: ?address:string
66
+
-> ?city:string
67
+
-> ?region:string
68
+
-> ?post_code:string
69
+
-> ?country:string
70
+
-> unit
71
+
-> t
72
73
(** Create an address from option values directly.
74
75
Used internally by jsont decoders where fields are decoded as options. *)
76
+
val of_options
77
+
: address:string option
78
+
-> city:string option
79
+
-> region:string option
80
+
-> post_code:string option
81
+
-> country:string option
82
+
-> t
83
84
(** Street address (e.g., ["77 Massachusetts Avenue"]). *)
85
+
val address : t -> string option
86
87
(** City name (e.g., ["Cambridge"], ["London"]). *)
88
+
val city : t -> string option
89
90
(** State, province, or region (e.g., ["Massachusetts"], ["Bavaria"]). *)
91
+
val region : t -> string option
92
93
(** Postal or ZIP code (e.g., ["02139"], ["W1A 1AA"]). *)
94
+
val post_code : t -> string option
95
96
(** ISO 3166-1 alpha-2 country code (e.g., ["US"], ["DE"], ["GB"]). *)
97
+
val country : t -> string option
98
99
(** [true] if all fields are [None]. *)
100
+
val is_empty : t -> bool
101
102
(** Pretty-print the address. *)
103
+
val pp : Format.formatter -> t -> unit
104
105
(** Add address fields to a jsont object builder.
106
107
This adds the five address fields (address, city, region, post-code,
···
109
[string option] arguments in that order.
110
111
@param get Extracts the address from the parent type for encoding *)
112
+
val jsont_fields
113
+
: get:('a -> t)
114
+
-> ( 'a
115
+
, string option
116
+
-> string option
117
+
-> string option
118
+
-> string option
119
+
-> string option
120
+
-> 'b )
121
+
Jsont.Object.map
122
+
-> ('a, 'b) Jsont.Object.map
123
end
124
125
(** Contact information.
···
127
Electronic contact details for persons and entities. All fields
128
are optional. *)
129
module Contact : sig
130
(** Contact information record. *)
131
+
type t
132
133
(** Empty contact with all fields [None]. *)
134
+
val empty : t
135
136
(** Create contact information with optional fields.
137
138
@param email Email address
···
140
@param fax Fax number (any format)
141
@param website Website URL
142
@param orcid ORCID identifier URL *)
143
+
val make
144
+
: ?email:string
145
+
-> ?tel:string
146
+
-> ?fax:string
147
+
-> ?website:string
148
+
-> ?orcid:string
149
+
-> unit
150
+
-> t
151
152
(** Create contact info from option values directly.
153
154
Used internally by jsont decoders where fields are decoded as options. *)
155
+
val of_options
156
+
: email:string option
157
+
-> tel:string option
158
+
-> fax:string option
159
+
-> website:string option
160
+
-> orcid:string option
161
+
-> t
162
163
(** Email address (e.g., ["jane.smith\@example.org"]). *)
164
+
val email : t -> string option
165
166
(** Telephone number. No specific format is required. *)
167
+
val tel : t -> string option
168
169
(** Fax number. No specific format is required. *)
170
+
val fax : t -> string option
171
172
(** Website URL (e.g., ["https://example.org/~jsmith"]). *)
173
+
val website : t -> string option
174
175
(** ORCID identifier as a URL.
176
177
ORCID (Open Researcher and Contributor ID) provides persistent
···
180
Format: ["https://orcid.org/XXXX-XXXX-XXXX-XXXX"]
181
182
Example: ["https://orcid.org/0000-0001-2345-6789"] *)
183
+
val orcid : t -> string option
184
185
(** [true] if all fields are [None]. *)
186
+
val is_empty : t -> bool
187
188
(** Pretty-print the contact information. *)
189
+
val pp : Format.formatter -> t -> unit
190
191
(** Add contact fields to a jsont object builder.
192
193
This adds the five contact fields (email, tel, fax, website, orcid)
···
195
[string option] arguments in that order.
196
197
@param get Extracts the contact from the parent type for encoding *)
198
+
val jsont_fields
199
+
: get:('a -> t)
200
+
-> ( 'a
201
+
, string option
202
+
-> string option
203
+
-> string option
204
+
-> string option
205
+
-> string option
206
+
-> 'b )
207
+
Jsont.Object.map
208
+
-> ('a, 'b) Jsont.Object.map
209
end
+10
-13
lib/cff_country.ml
+10
-13
lib/cff_country.ml
···
1
(*---------------------------------------------------------------------------
2
-
Copyright (c) 2025 The ocaml-cff programmers. All rights reserved.
3
SPDX-License-Identifier: ISC
4
---------------------------------------------------------------------------*)
5
···
13
try
14
let _ = ISO3166.alpha2_of_string s in
15
Ok s
16
-
with Invalid_argument _ ->
17
-
Error (`Invalid_country s)
18
19
let to_string t = t
20
21
let to_iso3166 t =
22
-
try
23
-
Some (ISO3166.alpha2_to_country (ISO3166.alpha2_of_string t))
24
-
with Invalid_argument _ ->
25
-
None
26
27
let name t = Option.map ISO3166.Country.name (to_iso3166 t)
28
-
29
let equal = String.equal
30
let compare = String.compare
31
-
32
-
let pp ppf t =
33
-
Format.pp_print_string ppf t
34
35
(* Jsont codec for country codes *)
36
let jsont =
···
41
Jsont.Error.msgf Jsont.Meta.none "Invalid ISO 3166-1 alpha-2 country code: %s" s
42
in
43
let enc t = to_string t in
44
-
Jsont.string
45
-
|> Jsont.map ~dec ~enc
46
47
(* Lenient codec that accepts any string *)
48
let jsont_lenient = Jsont.string
···
1
(*---------------------------------------------------------------------------
2
+
Copyright (c) 2026 The ocaml-cff programmers. All rights reserved.
3
SPDX-License-Identifier: ISC
4
---------------------------------------------------------------------------*)
5
···
13
try
14
let _ = ISO3166.alpha2_of_string s in
15
Ok s
16
+
with
17
+
| Invalid_argument _ -> Error (`Invalid_country s)
18
+
;;
19
20
let to_string t = t
21
22
let to_iso3166 t =
23
+
try Some (ISO3166.alpha2_to_country (ISO3166.alpha2_of_string t)) with
24
+
| Invalid_argument _ -> None
25
+
;;
26
27
let name t = Option.map ISO3166.Country.name (to_iso3166 t)
28
let equal = String.equal
29
let compare = String.compare
30
+
let pp ppf t = Format.pp_print_string ppf t
31
32
(* Jsont codec for country codes *)
33
let jsont =
···
38
Jsont.Error.msgf Jsont.Meta.none "Invalid ISO 3166-1 alpha-2 country code: %s" s
39
in
40
let enc t = to_string t in
41
+
Jsont.string |> Jsont.map ~dec ~enc
42
+
;;
43
44
(* Lenient codec that accepts any string *)
45
let jsont_lenient = Jsont.string
+11
-11
lib/cff_country.mli
+11
-11
lib/cff_country.mli
···
1
(*---------------------------------------------------------------------------
2
-
Copyright (c) 2025 The ocaml-cff programmers. All rights reserved.
3
SPDX-License-Identifier: ISC
4
---------------------------------------------------------------------------*)
5
···
39
country: DE
40
]} *)
41
42
-
type t = string
43
(** An ISO 3166-1 alpha-2 country code (two uppercase letters). *)
44
45
-
val of_string : string -> (t, [> `Invalid_country of string]) result
46
(** Parse and validate a country code.
47
48
Case-insensitive: ["us"], ["US"], and ["Us"] all produce ["US"].
49
Returns [Error (`Invalid_country s)] for unknown codes. *)
50
51
val to_string : t -> string
52
-
(** Return the uppercase country code. *)
53
54
-
val to_iso3166 : t -> ISO3166.Country.t option
55
(** Look up the full country record from {!ISO3166}.
56
57
Returns [None] if the code is not in the ISO 3166-1 list. *)
58
59
-
val name : t -> string option
60
(** Get the country name if the code is valid.
61
62
Examples:
63
- [name "US" = Some "United States of America"]
64
- [name "GB" = Some "United Kingdom of Great Britain and Northern Ireland"]
65
- [name "XX" = None] *)
66
67
val equal : t -> t -> bool
68
-
(** Country code equality (case-sensitive after normalization). *)
69
70
-
val compare : t -> t -> int
71
(** Alphabetical comparison of country codes. *)
72
73
val pp : Format.formatter -> t -> unit
74
-
(** Pretty-print the country code. *)
75
76
-
val jsont : t Jsont.t
77
(** JSON/YAML codec that validates country codes.
78
79
Returns an error for invalid ISO 3166-1 alpha-2 codes. *)
80
81
-
val jsont_lenient : t Jsont.t
82
(** JSON/YAML codec that accepts any string.
83
84
Use this when parsing CFF files that may contain non-standard
85
country codes. *)
···
1
(*---------------------------------------------------------------------------
2
+
Copyright (c) 2026 The ocaml-cff programmers. All rights reserved.
3
SPDX-License-Identifier: ISC
4
---------------------------------------------------------------------------*)
5
···
39
country: DE
40
]} *)
41
42
(** An ISO 3166-1 alpha-2 country code (two uppercase letters). *)
43
+
type t = string
44
45
(** Parse and validate a country code.
46
47
Case-insensitive: ["us"], ["US"], and ["Us"] all produce ["US"].
48
Returns [Error (`Invalid_country s)] for unknown codes. *)
49
+
val of_string : string -> (t, [> `Invalid_country of string ]) result
50
51
+
(** Return the uppercase country code. *)
52
val to_string : t -> string
53
54
(** Look up the full country record from {!ISO3166}.
55
56
Returns [None] if the code is not in the ISO 3166-1 list. *)
57
+
val to_iso3166 : t -> ISO3166.Country.t option
58
59
(** Get the country name if the code is valid.
60
61
Examples:
62
- [name "US" = Some "United States of America"]
63
- [name "GB" = Some "United Kingdom of Great Britain and Northern Ireland"]
64
- [name "XX" = None] *)
65
+
val name : t -> string option
66
67
+
(** Country code equality (case-sensitive after normalization). *)
68
val equal : t -> t -> bool
69
70
(** Alphabetical comparison of country codes. *)
71
+
val compare : t -> t -> int
72
73
+
(** Pretty-print the country code. *)
74
val pp : Format.formatter -> t -> unit
75
76
(** JSON/YAML codec that validates country codes.
77
78
Returns an error for invalid ISO 3166-1 alpha-2 codes. *)
79
+
val jsont : t Jsont.t
80
81
(** JSON/YAML codec that accepts any string.
82
83
Use this when parsing CFF files that may contain non-standard
84
country codes. *)
85
+
val jsont_lenient : t Jsont.t
+10
-17
lib/cff_date.ml
+10
-17
lib/cff_date.ml
···
1
(*---------------------------------------------------------------------------
2
-
Copyright (c) 2025 The ocaml-cff programmers. All rights reserved.
3
SPDX-License-Identifier: ISC
4
---------------------------------------------------------------------------*)
5
···
10
let of_string s =
11
(* CFF dates are YYYY-MM-DD format *)
12
match String.split_on_char '-' s with
13
-
| [y; m; d] ->
14
(match int_of_string_opt y, int_of_string_opt m, int_of_string_opt d with
15
| Some year, Some month, Some day ->
16
(* Validate the date components *)
17
-
if year >= 0 && year <= 9999 &&
18
-
month >= 1 && month <= 12 &&
19
-
day >= 1 && day <= 31 then
20
-
Ok (year, month, day)
21
-
else
22
-
Error (`Invalid_date s)
23
| _ -> Error (`Invalid_date s))
24
| _ -> Error (`Invalid_date s)
25
26
-
let to_string (year, month, day) =
27
-
Printf.sprintf "%04d-%02d-%02d" year month day
28
-
29
let year (y, _, _) = y
30
let month (_, m, _) = m
31
let day (_, _, d) = d
32
-
33
let equal a b = a = b
34
let compare = Stdlib.compare
35
-
36
-
let pp ppf date =
37
-
Format.pp_print_string ppf (to_string date)
38
39
(* Jsont codec for dates *)
40
let jsont =
···
45
Jsont.Error.msgf Jsont.Meta.none "Invalid date format: %s" s
46
in
47
let enc date = to_string date in
48
-
Jsont.string
49
-
|> Jsont.map ~dec ~enc
···
1
(*---------------------------------------------------------------------------
2
+
Copyright (c) 2026 The ocaml-cff programmers. All rights reserved.
3
SPDX-License-Identifier: ISC
4
---------------------------------------------------------------------------*)
5
···
10
let of_string s =
11
(* CFF dates are YYYY-MM-DD format *)
12
match String.split_on_char '-' s with
13
+
| [ y; m; d ] ->
14
(match int_of_string_opt y, int_of_string_opt m, int_of_string_opt d with
15
| Some year, Some month, Some day ->
16
(* Validate the date components *)
17
+
if year >= 0 && year <= 9999 && month >= 1 && month <= 12 && day >= 1 && day <= 31
18
+
then Ok (year, month, day)
19
+
else Error (`Invalid_date s)
20
| _ -> Error (`Invalid_date s))
21
| _ -> Error (`Invalid_date s)
22
+
;;
23
24
+
let to_string (year, month, day) = Printf.sprintf "%04d-%02d-%02d" year month day
25
let year (y, _, _) = y
26
let month (_, m, _) = m
27
let day (_, _, d) = d
28
let equal a b = a = b
29
let compare = Stdlib.compare
30
+
let pp ppf date = Format.pp_print_string ppf (to_string date)
31
32
(* Jsont codec for dates *)
33
let jsont =
···
38
Jsont.Error.msgf Jsont.Meta.none "Invalid date format: %s" s
39
in
40
let enc date = to_string date in
41
+
Jsont.string |> Jsont.map ~dec ~enc
42
+
;;
+11
-11
lib/cff_date.mli
+11
-11
lib/cff_date.mli
···
1
(*---------------------------------------------------------------------------
2
-
Copyright (c) 2025 The ocaml-cff programmers. All rights reserved.
3
SPDX-License-Identifier: ISC
4
---------------------------------------------------------------------------*)
5
···
45
For historical works or when only the year is known, use the [year]
46
field (an integer) instead of a full date. *)
47
48
-
type t = Ptime.date
49
(** A date as [(year, month, day)] tuple.
50
51
The tuple contains:
52
- [year]: Four-digit year (e.g., [2024])
53
- [month]: Month number (1-12)
54
- [day]: Day of month (1-31) *)
55
56
-
val of_string : string -> (t, [> `Invalid_date of string]) result
57
(** Parse a date from [YYYY-MM-DD] format.
58
59
Returns [Error (`Invalid_date s)] if the string is not a valid date.
60
Validates that the date is a real calendar date (e.g., rejects Feb 30). *)
61
62
-
val to_string : t -> string
63
(** Format a date as [YYYY-MM-DD]. *)
64
65
val year : t -> int
66
-
(** Extract the year component. *)
67
68
-
val month : t -> int
69
(** Extract the month component (1-12). *)
70
71
-
val day : t -> int
72
(** Extract the day component (1-31). *)
73
74
val equal : t -> t -> bool
75
-
(** Date equality. *)
76
77
-
val compare : t -> t -> int
78
(** Date comparison (chronological order). *)
79
80
val pp : Format.formatter -> t -> unit
81
-
(** Pretty-print a date in [YYYY-MM-DD] format. *)
82
83
-
val jsont : t Jsont.t
84
(** JSON/YAML codec for dates.
85
86
Parses strings in [YYYY-MM-DD] format and serializes back to the
87
same format. *)
···
1
(*---------------------------------------------------------------------------
2
+
Copyright (c) 2026 The ocaml-cff programmers. All rights reserved.
3
SPDX-License-Identifier: ISC
4
---------------------------------------------------------------------------*)
5
···
45
For historical works or when only the year is known, use the [year]
46
field (an integer) instead of a full date. *)
47
48
(** A date as [(year, month, day)] tuple.
49
50
The tuple contains:
51
- [year]: Four-digit year (e.g., [2024])
52
- [month]: Month number (1-12)
53
- [day]: Day of month (1-31) *)
54
+
type t = Ptime.date
55
56
(** Parse a date from [YYYY-MM-DD] format.
57
58
Returns [Error (`Invalid_date s)] if the string is not a valid date.
59
Validates that the date is a real calendar date (e.g., rejects Feb 30). *)
60
+
val of_string : string -> (t, [> `Invalid_date of string ]) result
61
62
(** Format a date as [YYYY-MM-DD]. *)
63
+
val to_string : t -> string
64
65
+
(** Extract the year component. *)
66
val year : t -> int
67
68
(** Extract the month component (1-12). *)
69
+
val month : t -> int
70
71
(** Extract the day component (1-31). *)
72
+
val day : t -> int
73
74
+
(** Date equality. *)
75
val equal : t -> t -> bool
76
77
(** Date comparison (chronological order). *)
78
+
val compare : t -> t -> int
79
80
+
(** Pretty-print a date in [YYYY-MM-DD] format. *)
81
val pp : Format.formatter -> t -> unit
82
83
(** JSON/YAML codec for dates.
84
85
Parses strings in [YYYY-MM-DD] format and serializes back to the
86
same format. *)
87
+
val jsont : t Jsont.t
+229
-204
lib/cff_enums.ml
+229
-204
lib/cff_enums.ml
···
1
(*---------------------------------------------------------------------------
2
-
Copyright (c) 2025 The ocaml-cff programmers. All rights reserved.
3
SPDX-License-Identifier: ISC
4
---------------------------------------------------------------------------*)
5
···
8
(** Functor to generate common enum operations. *)
9
module type STRING_ENUM = sig
10
type t
11
val of_string : string -> t option
12
val to_string : t -> string
13
val type_name : string
···
15
16
module Make_enum (E : STRING_ENUM) = struct
17
include E
18
let equal (a : t) (b : t) = a = b
19
let compare = Stdlib.compare
20
let pp ppf t = Format.pp_print_string ppf (to_string t)
21
let jsont =
22
-
Jsont.string |> Jsont.map
23
-
~dec:(fun s ->
24
-
match of_string s with
25
-
| Some t -> t
26
-
| None -> Jsont.Error.msgf Jsont.Meta.none "Invalid %s: %s" type_name s)
27
-
~enc:to_string
28
end
29
30
module Identifier_type = Make_enum (struct
31
-
type t = [ `Doi | `Url | `Swh | `Other ]
32
-
let type_name = "identifier type"
33
34
-
let of_string = function
35
-
| "doi" -> Some `Doi
36
-
| "url" -> Some `Url
37
-
| "swh" -> Some `Swh
38
-
| "other" -> Some `Other
39
-
| _ -> None
40
41
-
let to_string = function
42
-
| `Doi -> "doi"
43
-
| `Url -> "url"
44
-
| `Swh -> "swh"
45
-
| `Other -> "other"
46
-
end)
47
48
module Reference_type = Make_enum (struct
49
-
type t = [
50
-
| `Art
51
-
| `Article
52
-
| `Audiovisual
53
-
| `Bill
54
-
| `Blog
55
-
| `Book
56
-
| `Catalogue
57
-
| `Conference
58
-
| `Conference_paper
59
-
| `Data
60
-
| `Database
61
-
| `Dictionary
62
-
| `Edited_work
63
-
| `Encyclopedia
64
-
| `Film_broadcast
65
-
| `Generic
66
-
| `Government_document
67
-
| `Grant
68
-
| `Hearing
69
-
| `Historical_work
70
-
| `Legal_case
71
-
| `Legal_rule
72
-
| `Magazine_article
73
-
| `Manual
74
-
| `Map
75
-
| `Multimedia
76
-
| `Music
77
-
| `Newspaper_article
78
-
| `Pamphlet
79
-
| `Patent
80
-
| `Personal_communication
81
-
| `Proceedings
82
-
| `Report
83
-
| `Serial
84
-
| `Slides
85
-
| `Software
86
-
| `Software_code
87
-
| `Software_container
88
-
| `Software_executable
89
-
| `Software_virtual_machine
90
-
| `Sound_recording
91
-
| `Standard
92
-
| `Statute
93
-
| `Thesis
94
-
| `Unpublished
95
-
| `Video
96
-
| `Website
97
-
]
98
-
let type_name = "reference type"
99
100
-
let of_string = function
101
-
| "art" -> Some `Art
102
-
| "article" -> Some `Article
103
-
| "audiovisual" -> Some `Audiovisual
104
-
| "bill" -> Some `Bill
105
-
| "blog" -> Some `Blog
106
-
| "book" -> Some `Book
107
-
| "catalogue" -> Some `Catalogue
108
-
| "conference" -> Some `Conference
109
-
| "conference-paper" -> Some `Conference_paper
110
-
| "data" -> Some `Data
111
-
| "database" -> Some `Database
112
-
| "dictionary" -> Some `Dictionary
113
-
| "edited-work" -> Some `Edited_work
114
-
| "encyclopedia" -> Some `Encyclopedia
115
-
| "film-broadcast" -> Some `Film_broadcast
116
-
| "generic" -> Some `Generic
117
-
| "government-document" -> Some `Government_document
118
-
| "grant" -> Some `Grant
119
-
| "hearing" -> Some `Hearing
120
-
| "historical-work" -> Some `Historical_work
121
-
| "legal-case" -> Some `Legal_case
122
-
| "legal-rule" -> Some `Legal_rule
123
-
| "magazine-article" -> Some `Magazine_article
124
-
| "manual" -> Some `Manual
125
-
| "map" -> Some `Map
126
-
| "multimedia" -> Some `Multimedia
127
-
| "music" -> Some `Music
128
-
| "newspaper-article" -> Some `Newspaper_article
129
-
| "pamphlet" -> Some `Pamphlet
130
-
| "patent" -> Some `Patent
131
-
| "personal-communication" -> Some `Personal_communication
132
-
| "proceedings" -> Some `Proceedings
133
-
| "report" -> Some `Report
134
-
| "serial" -> Some `Serial
135
-
| "slides" -> Some `Slides
136
-
| "software" -> Some `Software
137
-
| "software-code" -> Some `Software_code
138
-
| "software-container" -> Some `Software_container
139
-
| "software-executable" -> Some `Software_executable
140
-
| "software-virtual-machine" -> Some `Software_virtual_machine
141
-
| "sound-recording" -> Some `Sound_recording
142
-
| "standard" -> Some `Standard
143
-
| "statute" -> Some `Statute
144
-
| "thesis" -> Some `Thesis
145
-
| "unpublished" -> Some `Unpublished
146
-
| "video" -> Some `Video
147
-
| "website" -> Some `Website
148
-
| _ -> None
149
150
-
let to_string = function
151
-
| `Art -> "art"
152
-
| `Article -> "article"
153
-
| `Audiovisual -> "audiovisual"
154
-
| `Bill -> "bill"
155
-
| `Blog -> "blog"
156
-
| `Book -> "book"
157
-
| `Catalogue -> "catalogue"
158
-
| `Conference -> "conference"
159
-
| `Conference_paper -> "conference-paper"
160
-
| `Data -> "data"
161
-
| `Database -> "database"
162
-
| `Dictionary -> "dictionary"
163
-
| `Edited_work -> "edited-work"
164
-
| `Encyclopedia -> "encyclopedia"
165
-
| `Film_broadcast -> "film-broadcast"
166
-
| `Generic -> "generic"
167
-
| `Government_document -> "government-document"
168
-
| `Grant -> "grant"
169
-
| `Hearing -> "hearing"
170
-
| `Historical_work -> "historical-work"
171
-
| `Legal_case -> "legal-case"
172
-
| `Legal_rule -> "legal-rule"
173
-
| `Magazine_article -> "magazine-article"
174
-
| `Manual -> "manual"
175
-
| `Map -> "map"
176
-
| `Multimedia -> "multimedia"
177
-
| `Music -> "music"
178
-
| `Newspaper_article -> "newspaper-article"
179
-
| `Pamphlet -> "pamphlet"
180
-
| `Patent -> "patent"
181
-
| `Personal_communication -> "personal-communication"
182
-
| `Proceedings -> "proceedings"
183
-
| `Report -> "report"
184
-
| `Serial -> "serial"
185
-
| `Slides -> "slides"
186
-
| `Software -> "software"
187
-
| `Software_code -> "software-code"
188
-
| `Software_container -> "software-container"
189
-
| `Software_executable -> "software-executable"
190
-
| `Software_virtual_machine -> "software-virtual-machine"
191
-
| `Sound_recording -> "sound-recording"
192
-
| `Standard -> "standard"
193
-
| `Statute -> "statute"
194
-
| `Thesis -> "thesis"
195
-
| `Unpublished -> "unpublished"
196
-
| `Video -> "video"
197
-
| `Website -> "website"
198
-
end)
199
200
module Status = Make_enum (struct
201
-
type t = [
202
-
| `Abstract
203
-
| `Advance_online
204
-
| `In_preparation
205
-
| `In_press
206
-
| `Preprint
207
-
| `Submitted
208
-
]
209
-
let type_name = "status"
210
211
-
let of_string = function
212
-
| "abstract" -> Some `Abstract
213
-
| "advance-online" -> Some `Advance_online
214
-
| "in-preparation" -> Some `In_preparation
215
-
| "in-press" -> Some `In_press
216
-
| "preprint" -> Some `Preprint
217
-
| "submitted" -> Some `Submitted
218
-
| _ -> None
219
220
-
let to_string = function
221
-
| `Abstract -> "abstract"
222
-
| `Advance_online -> "advance-online"
223
-
| `In_preparation -> "in-preparation"
224
-
| `In_press -> "in-press"
225
-
| `Preprint -> "preprint"
226
-
| `Submitted -> "submitted"
227
-
end)
228
229
module Cff_type = Make_enum (struct
230
-
type t = [ `Software | `Dataset ]
231
-
let type_name = "CFF type"
232
233
-
let of_string = function
234
-
| "software" -> Some `Software
235
-
| "dataset" -> Some `Dataset
236
-
| _ -> None
237
238
-
let to_string = function
239
-
| `Software -> "software"
240
-
| `Dataset -> "dataset"
241
-
end)
···
1
(*---------------------------------------------------------------------------
2
+
Copyright (c) 2026 The ocaml-cff programmers. All rights reserved.
3
SPDX-License-Identifier: ISC
4
---------------------------------------------------------------------------*)
5
···
8
(** Functor to generate common enum operations. *)
9
module type STRING_ENUM = sig
10
type t
11
+
12
val of_string : string -> t option
13
val to_string : t -> string
14
val type_name : string
···
16
17
module Make_enum (E : STRING_ENUM) = struct
18
include E
19
+
20
let equal (a : t) (b : t) = a = b
21
let compare = Stdlib.compare
22
let pp ppf t = Format.pp_print_string ppf (to_string t)
23
+
24
let jsont =
25
+
Jsont.string
26
+
|> Jsont.map
27
+
~dec:(fun s ->
28
+
match of_string s with
29
+
| Some t -> t
30
+
| None -> Jsont.Error.msgf Jsont.Meta.none "Invalid %s: %s" type_name s)
31
+
~enc:to_string
32
+
;;
33
end
34
35
module Identifier_type = Make_enum (struct
36
+
type t =
37
+
[ `Doi
38
+
| `Url
39
+
| `Swh
40
+
| `Other
41
+
]
42
+
43
+
let type_name = "identifier type"
44
45
+
let of_string = function
46
+
| "doi" -> Some `Doi
47
+
| "url" -> Some `Url
48
+
| "swh" -> Some `Swh
49
+
| "other" -> Some `Other
50
+
| _ -> None
51
+
;;
52
53
+
let to_string = function
54
+
| `Doi -> "doi"
55
+
| `Url -> "url"
56
+
| `Swh -> "swh"
57
+
| `Other -> "other"
58
+
;;
59
+
end)
60
61
module Reference_type = Make_enum (struct
62
+
type t =
63
+
[ `Art
64
+
| `Article
65
+
| `Audiovisual
66
+
| `Bill
67
+
| `Blog
68
+
| `Book
69
+
| `Catalogue
70
+
| `Conference
71
+
| `Conference_paper
72
+
| `Data
73
+
| `Database
74
+
| `Dictionary
75
+
| `Edited_work
76
+
| `Encyclopedia
77
+
| `Film_broadcast
78
+
| `Generic
79
+
| `Government_document
80
+
| `Grant
81
+
| `Hearing
82
+
| `Historical_work
83
+
| `Legal_case
84
+
| `Legal_rule
85
+
| `Magazine_article
86
+
| `Manual
87
+
| `Map
88
+
| `Multimedia
89
+
| `Music
90
+
| `Newspaper_article
91
+
| `Pamphlet
92
+
| `Patent
93
+
| `Personal_communication
94
+
| `Proceedings
95
+
| `Report
96
+
| `Serial
97
+
| `Slides
98
+
| `Software
99
+
| `Software_code
100
+
| `Software_container
101
+
| `Software_executable
102
+
| `Software_virtual_machine
103
+
| `Sound_recording
104
+
| `Standard
105
+
| `Statute
106
+
| `Thesis
107
+
| `Unpublished
108
+
| `Video
109
+
| `Website
110
+
]
111
+
112
+
let type_name = "reference type"
113
114
+
let of_string = function
115
+
| "art" -> Some `Art
116
+
| "article" -> Some `Article
117
+
| "audiovisual" -> Some `Audiovisual
118
+
| "bill" -> Some `Bill
119
+
| "blog" -> Some `Blog
120
+
| "book" -> Some `Book
121
+
| "catalogue" -> Some `Catalogue
122
+
| "conference" -> Some `Conference
123
+
| "conference-paper" -> Some `Conference_paper
124
+
| "data" -> Some `Data
125
+
| "database" -> Some `Database
126
+
| "dictionary" -> Some `Dictionary
127
+
| "edited-work" -> Some `Edited_work
128
+
| "encyclopedia" -> Some `Encyclopedia
129
+
| "film-broadcast" -> Some `Film_broadcast
130
+
| "generic" -> Some `Generic
131
+
| "government-document" -> Some `Government_document
132
+
| "grant" -> Some `Grant
133
+
| "hearing" -> Some `Hearing
134
+
| "historical-work" -> Some `Historical_work
135
+
| "legal-case" -> Some `Legal_case
136
+
| "legal-rule" -> Some `Legal_rule
137
+
| "magazine-article" -> Some `Magazine_article
138
+
| "manual" -> Some `Manual
139
+
| "map" -> Some `Map
140
+
| "multimedia" -> Some `Multimedia
141
+
| "music" -> Some `Music
142
+
| "newspaper-article" -> Some `Newspaper_article
143
+
| "pamphlet" -> Some `Pamphlet
144
+
| "patent" -> Some `Patent
145
+
| "personal-communication" -> Some `Personal_communication
146
+
| "proceedings" -> Some `Proceedings
147
+
| "report" -> Some `Report
148
+
| "serial" -> Some `Serial
149
+
| "slides" -> Some `Slides
150
+
| "software" -> Some `Software
151
+
| "software-code" -> Some `Software_code
152
+
| "software-container" -> Some `Software_container
153
+
| "software-executable" -> Some `Software_executable
154
+
| "software-virtual-machine" -> Some `Software_virtual_machine
155
+
| "sound-recording" -> Some `Sound_recording
156
+
| "standard" -> Some `Standard
157
+
| "statute" -> Some `Statute
158
+
| "thesis" -> Some `Thesis
159
+
| "unpublished" -> Some `Unpublished
160
+
| "video" -> Some `Video
161
+
| "website" -> Some `Website
162
+
| _ -> None
163
+
;;
164
165
+
let to_string = function
166
+
| `Art -> "art"
167
+
| `Article -> "article"
168
+
| `Audiovisual -> "audiovisual"
169
+
| `Bill -> "bill"
170
+
| `Blog -> "blog"
171
+
| `Book -> "book"
172
+
| `Catalogue -> "catalogue"
173
+
| `Conference -> "conference"
174
+
| `Conference_paper -> "conference-paper"
175
+
| `Data -> "data"
176
+
| `Database -> "database"
177
+
| `Dictionary -> "dictionary"
178
+
| `Edited_work -> "edited-work"
179
+
| `Encyclopedia -> "encyclopedia"
180
+
| `Film_broadcast -> "film-broadcast"
181
+
| `Generic -> "generic"
182
+
| `Government_document -> "government-document"
183
+
| `Grant -> "grant"
184
+
| `Hearing -> "hearing"
185
+
| `Historical_work -> "historical-work"
186
+
| `Legal_case -> "legal-case"
187
+
| `Legal_rule -> "legal-rule"
188
+
| `Magazine_article -> "magazine-article"
189
+
| `Manual -> "manual"
190
+
| `Map -> "map"
191
+
| `Multimedia -> "multimedia"
192
+
| `Music -> "music"
193
+
| `Newspaper_article -> "newspaper-article"
194
+
| `Pamphlet -> "pamphlet"
195
+
| `Patent -> "patent"
196
+
| `Personal_communication -> "personal-communication"
197
+
| `Proceedings -> "proceedings"
198
+
| `Report -> "report"
199
+
| `Serial -> "serial"
200
+
| `Slides -> "slides"
201
+
| `Software -> "software"
202
+
| `Software_code -> "software-code"
203
+
| `Software_container -> "software-container"
204
+
| `Software_executable -> "software-executable"
205
+
| `Software_virtual_machine -> "software-virtual-machine"
206
+
| `Sound_recording -> "sound-recording"
207
+
| `Standard -> "standard"
208
+
| `Statute -> "statute"
209
+
| `Thesis -> "thesis"
210
+
| `Unpublished -> "unpublished"
211
+
| `Video -> "video"
212
+
| `Website -> "website"
213
+
;;
214
+
end)
215
216
module Status = Make_enum (struct
217
+
type t =
218
+
[ `Abstract
219
+
| `Advance_online
220
+
| `In_preparation
221
+
| `In_press
222
+
| `Preprint
223
+
| `Submitted
224
+
]
225
226
+
let type_name = "status"
227
228
+
let of_string = function
229
+
| "abstract" -> Some `Abstract
230
+
| "advance-online" -> Some `Advance_online
231
+
| "in-preparation" -> Some `In_preparation
232
+
| "in-press" -> Some `In_press
233
+
| "preprint" -> Some `Preprint
234
+
| "submitted" -> Some `Submitted
235
+
| _ -> None
236
+
;;
237
+
238
+
let to_string = function
239
+
| `Abstract -> "abstract"
240
+
| `Advance_online -> "advance-online"
241
+
| `In_preparation -> "in-preparation"
242
+
| `In_press -> "in-press"
243
+
| `Preprint -> "preprint"
244
+
| `Submitted -> "submitted"
245
+
;;
246
+
end)
247
248
module Cff_type = Make_enum (struct
249
+
type t =
250
+
[ `Software
251
+
| `Dataset
252
+
]
253
254
+
let type_name = "CFF type"
255
+
256
+
let of_string = function
257
+
| "software" -> Some `Software
258
+
| "dataset" -> Some `Dataset
259
+
| _ -> None
260
+
;;
261
262
+
let to_string = function
263
+
| `Software -> "software"
264
+
| `Dataset -> "dataset"
265
+
;;
266
+
end)
+31
-23
lib/cff_enums.mli
+31
-23
lib/cff_enums.mli
···
1
(*---------------------------------------------------------------------------
2
-
Copyright (c) 2025 The ocaml-cff programmers. All rights reserved.
3
SPDX-License-Identifier: ISC
4
---------------------------------------------------------------------------*)
5
···
48
description: Software Heritage archive
49
]} *)
50
module Identifier_type : sig
51
-
type t = [ `Doi | `Url | `Swh | `Other ]
52
(** Identifier types. *)
53
54
val of_string : string -> t option
55
-
(** Parse from YAML string: ["doi"], ["url"], ["swh"], ["other"]. *)
56
57
-
val to_string : t -> string
58
(** Convert to YAML string representation. *)
59
60
val equal : t -> t -> bool
61
val compare : t -> t -> int
62
val pp : Format.formatter -> t -> unit
63
64
val jsont : t Jsont.t
65
-
(** JSON/YAML codec. *)
66
end
67
68
(** Reference type for bibliographic entries.
···
138
- [`Standard] - Technical standard
139
- [`Unpublished] - Unpublished work *)
140
module Reference_type : sig
141
-
type t = [
142
-
| `Art
143
| `Article
144
| `Audiovisual
145
| `Bill
···
186
| `Unpublished
187
| `Video
188
| `Website
189
-
]
190
-
(** All supported reference types. *)
191
192
-
val of_string : string -> t option
193
(** Parse from YAML string. Hyphenated names like ["conference-paper"]
194
map to underscored variants like [`Conference_paper]. *)
195
196
-
val to_string : t -> string
197
(** Convert to YAML string representation.
198
Underscored variants like [`Conference_paper] become ["conference-paper"]. *)
199
200
val equal : t -> t -> bool
201
val compare : t -> t -> int
202
val pp : Format.formatter -> t -> unit
203
204
-
val jsont : t Jsont.t
205
(** JSON/YAML codec. *)
206
end
207
208
(** Publication status for works in progress.
···
230
status: submitted
231
]} *)
232
module Status : sig
233
-
type t = [
234
-
| `Abstract
235
| `Advance_online
236
| `In_preparation
237
| `In_press
238
| `Preprint
239
| `Submitted
240
-
]
241
-
(** Publication status values. *)
242
243
-
val of_string : string -> t option
244
(** Parse from YAML string: ["abstract"], ["advance-online"], etc. *)
245
246
val to_string : t -> string
247
-
(** Convert to YAML string representation. *)
248
249
val equal : t -> t -> bool
250
val compare : t -> t -> int
251
val pp : Format.formatter -> t -> unit
252
253
-
val jsont : t Jsont.t
254
(** JSON/YAML codec. *)
255
end
256
257
(** CFF file type: software or dataset.
···
271
# ...
272
]} *)
273
module Cff_type : sig
274
-
type t = [ `Software | `Dataset ]
275
(** CFF file types. *)
276
277
-
val of_string : string -> t option
278
(** Parse from YAML string: ["software"] or ["dataset"]. *)
279
280
-
val to_string : t -> string
281
(** Convert to YAML string representation. *)
282
283
val equal : t -> t -> bool
284
val compare : t -> t -> int
285
val pp : Format.formatter -> t -> unit
286
287
-
val jsont : t Jsont.t
288
(** JSON/YAML codec. *)
289
end
···
1
(*---------------------------------------------------------------------------
2
+
Copyright (c) 2026 The ocaml-cff programmers. All rights reserved.
3
SPDX-License-Identifier: ISC
4
---------------------------------------------------------------------------*)
5
···
48
description: Software Heritage archive
49
]} *)
50
module Identifier_type : sig
51
(** Identifier types. *)
52
+
type t =
53
+
[ `Doi
54
+
| `Url
55
+
| `Swh
56
+
| `Other
57
+
]
58
59
+
(** Parse from YAML string: ["doi"], ["url"], ["swh"], ["other"]. *)
60
val of_string : string -> t option
61
62
(** Convert to YAML string representation. *)
63
+
val to_string : t -> string
64
65
val equal : t -> t -> bool
66
val compare : t -> t -> int
67
val pp : Format.formatter -> t -> unit
68
69
+
(** JSON/YAML codec. *)
70
val jsont : t Jsont.t
71
end
72
73
(** Reference type for bibliographic entries.
···
143
- [`Standard] - Technical standard
144
- [`Unpublished] - Unpublished work *)
145
module Reference_type : sig
146
+
(** All supported reference types. *)
147
+
type t =
148
+
[ `Art
149
| `Article
150
| `Audiovisual
151
| `Bill
···
192
| `Unpublished
193
| `Video
194
| `Website
195
+
]
196
197
(** Parse from YAML string. Hyphenated names like ["conference-paper"]
198
map to underscored variants like [`Conference_paper]. *)
199
+
val of_string : string -> t option
200
201
(** Convert to YAML string representation.
202
Underscored variants like [`Conference_paper] become ["conference-paper"]. *)
203
+
val to_string : t -> string
204
205
val equal : t -> t -> bool
206
val compare : t -> t -> int
207
val pp : Format.formatter -> t -> unit
208
209
(** JSON/YAML codec. *)
210
+
val jsont : t Jsont.t
211
end
212
213
(** Publication status for works in progress.
···
235
status: submitted
236
]} *)
237
module Status : sig
238
+
(** Publication status values. *)
239
+
type t =
240
+
[ `Abstract
241
| `Advance_online
242
| `In_preparation
243
| `In_press
244
| `Preprint
245
| `Submitted
246
+
]
247
248
(** Parse from YAML string: ["abstract"], ["advance-online"], etc. *)
249
+
val of_string : string -> t option
250
251
+
(** Convert to YAML string representation. *)
252
val to_string : t -> string
253
254
val equal : t -> t -> bool
255
val compare : t -> t -> int
256
val pp : Format.formatter -> t -> unit
257
258
(** JSON/YAML codec. *)
259
+
val jsont : t Jsont.t
260
end
261
262
(** CFF file type: software or dataset.
···
276
# ...
277
]} *)
278
module Cff_type : sig
279
(** CFF file types. *)
280
+
type t =
281
+
[ `Software
282
+
| `Dataset
283
+
]
284
285
(** Parse from YAML string: ["software"] or ["dataset"]. *)
286
+
val of_string : string -> t option
287
288
(** Convert to YAML string representation. *)
289
+
val to_string : t -> string
290
291
val equal : t -> t -> bool
292
val compare : t -> t -> int
293
val pp : Format.formatter -> t -> unit
294
295
(** JSON/YAML codec. *)
296
+
val jsont : t Jsont.t
297
end
+17
-23
lib/cff_identifier.ml
+17
-23
lib/cff_identifier.ml
···
1
(*---------------------------------------------------------------------------
2
-
Copyright (c) 2025 The ocaml-cff programmers. All rights reserved.
3
SPDX-License-Identifier: ISC
4
---------------------------------------------------------------------------*)
5
6
(** Identifier type for CFF. *)
7
8
-
type t = {
9
-
type_ : Cff_enums.Identifier_type.t;
10
-
value : string;
11
-
description : string option;
12
-
}
13
-
14
-
let make ~type_ ~value ?description () =
15
-
{ type_; value; description }
16
17
let type_ t = t.type_
18
let value t = t.value
19
let description t = t.description
20
21
let equal a b =
22
-
Cff_enums.Identifier_type.equal a.type_ b.type_ &&
23
-
String.equal a.value b.value
24
25
let compare a b =
26
match Cff_enums.Identifier_type.compare a.type_ b.type_ with
27
| 0 -> String.compare a.value b.value
28
| n -> n
29
30
-
let pp ppf t =
31
-
Format.fprintf ppf "%a: %s"
32
-
Cff_enums.Identifier_type.pp t.type_
33
-
t.value
34
35
let jsont =
36
-
Jsont.Object.map ~kind:"Identifier"
37
-
(fun type_ value description -> { type_; value; description })
38
-
|> Jsont.Object.mem "type" Cff_enums.Identifier_type.jsont
39
-
~enc:(fun i -> i.type_)
40
-
|> Jsont.Object.mem "value" Jsont.string
41
-
~enc:(fun i -> i.value)
42
-
|> Jsont.Object.opt_mem "description" Jsont.string
43
-
~enc:(fun i -> i.description)
44
|> Jsont.Object.skip_unknown
45
|> Jsont.Object.finish
···
1
(*---------------------------------------------------------------------------
2
+
Copyright (c) 2026 The ocaml-cff programmers. All rights reserved.
3
SPDX-License-Identifier: ISC
4
---------------------------------------------------------------------------*)
5
6
(** Identifier type for CFF. *)
7
8
+
type t =
9
+
{ type_ : Cff_enums.Identifier_type.t
10
+
; value : string
11
+
; description : string option
12
+
}
13
14
+
let make ~type_ ~value ?description () = { type_; value; description }
15
let type_ t = t.type_
16
let value t = t.value
17
let description t = t.description
18
19
let equal a b =
20
+
Cff_enums.Identifier_type.equal a.type_ b.type_ && String.equal a.value b.value
21
+
;;
22
23
let compare a b =
24
match Cff_enums.Identifier_type.compare a.type_ b.type_ with
25
| 0 -> String.compare a.value b.value
26
| n -> n
27
+
;;
28
29
+
let pp ppf t = Format.fprintf ppf "%a: %s" Cff_enums.Identifier_type.pp t.type_ t.value
30
31
let jsont =
32
+
Jsont.Object.map ~kind:"Identifier" (fun type_ value description ->
33
+
{ type_; value; description })
34
+
|> Jsont.Object.mem "type" Cff_enums.Identifier_type.jsont ~enc:(fun i -> i.type_)
35
+
|> Jsont.Object.mem "value" Jsont.string ~enc:(fun i -> i.value)
36
+
|> Jsont.Object.opt_mem "description" Jsont.string ~enc:(fun i -> i.description)
37
|> Jsont.Object.skip_unknown
38
|> Jsont.Object.finish
39
+
;;
+15
-14
lib/cff_identifier.mli
+15
-14
lib/cff_identifier.mli
···
1
(*---------------------------------------------------------------------------
2
-
Copyright (c) 2025 The ocaml-cff programmers. All rights reserved.
3
SPDX-License-Identifier: ISC
4
---------------------------------------------------------------------------*)
5
···
66
- [rel]: Release
67
- [snp]: Snapshot *)
68
69
-
type t
70
(** An identifier with type, value, and optional description. *)
71
72
-
val make :
73
-
type_:Cff_enums.Identifier_type.t ->
74
-
value:string ->
75
-
?description:string ->
76
-
unit -> t
77
(** Create an identifier.
78
79
@param type_ The identifier type ([`Doi], [`Url], [`Swh], or [`Other])
80
@param value The identifier value (DOI, URL, SWH ID, etc.)
81
@param description Optional human-readable description *)
82
83
val type_ : t -> Cff_enums.Identifier_type.t
84
-
(** The identifier type. *)
85
86
-
val value : t -> string
87
(** The identifier value.
88
89
For DOIs, this is just the DOI (e.g., ["10.5281/zenodo.1234567"]),
90
not the full URL. *)
91
92
-
val description : t -> string option
93
(** Optional description explaining what this identifier refers to.
94
95
Examples:
96
- ["The concept DOI for all versions"]
97
- ["Version 1.0.0 archive"]
98
- ["Release on GitHub"] *)
99
100
val equal : t -> t -> bool
101
-
(** Identifier equality (compares all fields). *)
102
103
-
val compare : t -> t -> int
104
(** Identifier comparison. *)
105
106
-
val pp : Format.formatter -> t -> unit
107
(** Pretty-print as "[type]: value (description)". *)
108
109
val jsont : t Jsont.t
110
-
(** JSON/YAML codec for identifiers. *)
···
1
(*---------------------------------------------------------------------------
2
+
Copyright (c) 2026 The ocaml-cff programmers. All rights reserved.
3
SPDX-License-Identifier: ISC
4
---------------------------------------------------------------------------*)
5
···
66
- [rel]: Release
67
- [snp]: Snapshot *)
68
69
(** An identifier with type, value, and optional description. *)
70
+
type t
71
72
(** Create an identifier.
73
74
@param type_ The identifier type ([`Doi], [`Url], [`Swh], or [`Other])
75
@param value The identifier value (DOI, URL, SWH ID, etc.)
76
@param description Optional human-readable description *)
77
+
val make
78
+
: type_:Cff_enums.Identifier_type.t
79
+
-> value:string
80
+
-> ?description:string
81
+
-> unit
82
+
-> t
83
84
+
(** The identifier type. *)
85
val type_ : t -> Cff_enums.Identifier_type.t
86
87
(** The identifier value.
88
89
For DOIs, this is just the DOI (e.g., ["10.5281/zenodo.1234567"]),
90
not the full URL. *)
91
+
val value : t -> string
92
93
(** Optional description explaining what this identifier refers to.
94
95
Examples:
96
- ["The concept DOI for all versions"]
97
- ["Version 1.0.0 archive"]
98
- ["Release on GitHub"] *)
99
+
val description : t -> string option
100
101
+
(** Identifier equality (compares all fields). *)
102
val equal : t -> t -> bool
103
104
(** Identifier comparison. *)
105
+
val compare : t -> t -> int
106
107
(** Pretty-print as "[type]: value (description)". *)
108
+
val pp : Format.formatter -> t -> unit
109
110
+
(** JSON/YAML codec for identifiers. *)
111
val jsont : t Jsont.t
+63
-35
lib/cff_license.ml
+63
-35
lib/cff_license.ml
···
1
(*---------------------------------------------------------------------------
2
-
Copyright (c) 2025 The ocaml-cff programmers. All rights reserved.
3
SPDX-License-Identifier: ISC
4
---------------------------------------------------------------------------*)
5
6
(** SPDX license handling for CFF. *)
7
8
-
type t = [ `Expr of Spdx_licenses.t | `Raw of string list ]
9
10
-
let of_spdx spdx = `Expr spdx
11
12
let of_string s =
13
match Spdx_licenses.parse s with
14
-
| Ok spdx -> `Expr spdx
15
-
| Error _ -> `Raw [s]
16
17
let of_strings ss =
18
-
(* Try to parse as OR combination, fall back to Raw *)
19
let try_parse_all () =
20
let rec build = function
21
| [] -> None
22
-
| [s] ->
23
(match Spdx_licenses.parse s with
24
| Ok spdx -> Some spdx
25
| Error _ -> None)
···
31
build ss
32
in
33
match try_parse_all () with
34
-
| Some spdx -> `Expr spdx
35
-
| None -> `Raw ss
36
37
let to_spdx = function
38
-
| `Expr spdx -> Some spdx
39
-
| `Raw _ -> None
40
41
let to_strings = function
42
-
| `Expr spdx -> [Spdx_licenses.to_string spdx]
43
-
| `Raw ss -> ss
44
45
let pp ppf = function
46
-
| `Expr spdx -> Format.pp_print_string ppf (Spdx_licenses.to_string spdx)
47
-
| `Raw ss ->
48
-
match ss with
49
-
| [s] -> Format.pp_print_string ppf s
50
-
| _ ->
51
-
Format.fprintf ppf "[%a]"
52
-
(Format.pp_print_list ~pp_sep:(fun ppf () -> Format.fprintf ppf ", ")
53
-
Format.pp_print_string) ss
54
55
-
(* Jsont codec - lenient, accepts any string/array *)
56
let jsont =
57
let string_codec =
58
-
Jsont.string |> Jsont.map
59
-
~dec:(fun s -> of_string s)
60
-
~enc:(function
61
-
| `Expr spdx -> Spdx_licenses.to_string spdx
62
-
| `Raw [s] -> s
63
-
| `Raw _ -> assert false)
64
in
65
let array_codec =
66
-
Jsont.(array string) |> Jsont.map
67
-
~dec:(fun ss -> of_strings (Array.to_list ss))
68
-
~enc:(fun t -> Array.of_list (to_strings t))
69
in
70
Jsont.any
71
~dec_string:string_codec
72
~dec_array:array_codec
73
-
~enc:(fun t ->
74
-
match t with
75
-
| `Expr (Spdx_licenses.Simple _) -> string_codec
76
-
| `Raw [_] -> string_codec
77
| _ -> array_codec)
78
()
···
1
(*---------------------------------------------------------------------------
2
+
Copyright (c) 2026 The ocaml-cff programmers. All rights reserved.
3
SPDX-License-Identifier: ISC
4
---------------------------------------------------------------------------*)
5
6
(** SPDX license handling for CFF. *)
7
8
+
type t =
9
+
[ `Spdx of Spdx_licenses.t
10
+
| `Other of string list * string option
11
+
]
12
13
+
let of_spdx spdx = `Spdx spdx
14
15
let of_string s =
16
match Spdx_licenses.parse s with
17
+
| Ok spdx -> `Spdx spdx
18
+
| Error _ -> `Other ([ s ], None)
19
+
;;
20
21
let of_strings ss =
22
+
(* Try to parse as OR combination, fall back to Other *)
23
let try_parse_all () =
24
let rec build = function
25
| [] -> None
26
+
| [ s ] ->
27
(match Spdx_licenses.parse s with
28
| Ok spdx -> Some spdx
29
| Error _ -> None)
···
35
build ss
36
in
37
match try_parse_all () with
38
+
| Some spdx -> `Spdx spdx
39
+
| None -> `Other (ss, None)
40
+
;;
41
+
42
+
let with_url url = function
43
+
| `Spdx _ as t -> t (* SPDX licenses have well-known URLs, ignore provided URL *)
44
+
| `Other (ids, _) -> `Other (ids, Some url)
45
+
;;
46
+
47
+
let with_url_opt url_opt t =
48
+
match url_opt with
49
+
| None -> t
50
+
| Some url -> with_url url t
51
+
;;
52
53
let to_spdx = function
54
+
| `Spdx spdx -> Some spdx
55
+
| `Other _ -> None
56
+
;;
57
58
let to_strings = function
59
+
| `Spdx spdx -> [ Spdx_licenses.to_string spdx ]
60
+
| `Other (ss, _) -> ss
61
+
;;
62
+
63
+
let url = function
64
+
| `Spdx _ -> None
65
+
| `Other (_, url) -> url
66
+
;;
67
68
let pp ppf = function
69
+
| `Spdx spdx -> Format.pp_print_string ppf (Spdx_licenses.to_string spdx)
70
+
| `Other (ss, url_opt) ->
71
+
(match ss with
72
+
| [ s ] -> Format.pp_print_string ppf s
73
+
| _ ->
74
+
Format.fprintf
75
+
ppf
76
+
"[%a]"
77
+
(Format.pp_print_list
78
+
~pp_sep:(fun ppf () -> Format.fprintf ppf ", ")
79
+
Format.pp_print_string)
80
+
ss);
81
+
Option.iter (Format.fprintf ppf " <%s>") url_opt
82
+
;;
83
84
let jsont =
85
let string_codec =
86
+
Jsont.string
87
+
|> Jsont.map ~dec:of_string ~enc:(function
88
+
| `Spdx spdx -> Spdx_licenses.to_string spdx
89
+
| `Other ([ s ], _) -> s
90
+
| `Other _ -> assert false)
91
in
92
let array_codec =
93
+
Jsont.(array string)
94
+
|> Jsont.map
95
+
~dec:(fun ss -> of_strings (Array.to_list ss))
96
+
~enc:(fun t -> Array.of_list (to_strings t))
97
in
98
Jsont.any
99
~dec_string:string_codec
100
~dec_array:array_codec
101
+
~enc:(function
102
+
| `Spdx (Spdx_licenses.Simple _) -> string_codec
103
+
| `Other ([ _ ], _) -> string_codec
104
| _ -> array_codec)
105
()
106
+
;;
+58
-30
lib/cff_license.mli
+58
-30
lib/cff_license.mli
···
1
(*---------------------------------------------------------------------------
2
-
Copyright (c) 2025 The ocaml-cff programmers. All rights reserved.
3
SPDX-License-Identifier: ISC
4
---------------------------------------------------------------------------*)
5
6
(** SPDX license expressions for CFF.
7
8
CFF uses {{:https://spdx.org/licenses/}SPDX license identifiers}
9
-
for the [license] field. This module wraps {!Spdx_licenses.t} with
10
-
support for invalid/unknown licenses to enable round-tripping.
11
12
{1 License Representation}
13
14
Licenses are represented as either:
15
-
- [`Expr spdx] - A valid, parsed SPDX license expression
16
-
- [`Raw strings] - Unparsed strings for invalid/unknown licenses
17
18
The parser is lenient: it tries to parse as SPDX but preserves
19
-
invalid strings for round-tripping.
20
21
{1 Examples}
22
23
-
{2 Single License}
24
{[
25
license: MIT
26
]}
27
28
{2 SPDX Expression}
29
{[
30
-
license: GPL-3.0-or-later WITH Classpath-exception-2.0
31
]}
32
33
-
{2 Multiple Licenses (OR)}
34
{[
35
-
license:
36
-
- Apache-2.0
37
-
- MIT
38
]}
39
-
This is parsed as [Apache-2.0 OR MIT]. *)
40
41
-
type t = [ `Expr of Spdx_licenses.t | `Raw of string list ]
42
-
(** The license type: either a valid SPDX expression or raw strings. *)
43
44
(** {1 Construction} *)
45
46
val of_spdx : Spdx_licenses.t -> t
47
-
(** [of_spdx spdx] wraps a valid SPDX expression. *)
48
49
-
val of_string : string -> t
50
(** [of_string s] parses [s] as an SPDX expression.
51
-
Returns [`Expr] on success, [`Raw [s]] on parse failure. *)
52
53
-
val of_strings : string list -> t
54
(** [of_strings ss] parses a list of license strings.
55
-
If all strings are valid license IDs, returns an [`Expr] with OR combination.
56
-
Otherwise returns [`Raw ss] to preserve the original strings. *)
57
58
(** {1 Access} *)
59
60
val to_spdx : t -> Spdx_licenses.t option
61
-
(** [to_spdx t] returns [Some spdx] if [t] is a valid expression,
62
-
[None] if it contains unparsed raw strings. *)
63
64
val to_strings : t -> string list
65
-
(** [to_strings t] returns the license as a list of strings.
66
-
For [`Expr], returns the normalized SPDX string.
67
-
For [`Raw], returns the original strings. *)
68
69
(** {1 Formatting} *)
70
71
-
val pp : Format.formatter -> t -> unit
72
(** Pretty-print the license. *)
73
74
(** {1 Codec} *)
75
76
-
val jsont : t Jsont.t
77
-
(** JSON/YAML codec for licenses.
78
79
-
Handles both single string and array of strings.
80
Lenient: accepts any string without validation for round-tripping. *)
···
1
(*---------------------------------------------------------------------------
2
+
Copyright (c) 2026 The ocaml-cff programmers. All rights reserved.
3
SPDX-License-Identifier: ISC
4
---------------------------------------------------------------------------*)
5
6
(** SPDX license expressions for CFF.
7
8
CFF uses {{:https://spdx.org/licenses/}SPDX license identifiers}
9
+
for the [license] field. This module combines license identification
10
+
with optional URLs for non-standard licenses.
11
12
{1 License Representation}
13
14
Licenses are represented as either:
15
+
- [`Spdx expr] - A valid SPDX expression (URL is implicit/well-known)
16
+
- [`Other (ids, url_opt)] - Unknown license ID(s) with optional URL
17
18
The parser is lenient: it tries to parse as SPDX but preserves
19
+
invalid/unknown identifiers for round-tripping.
20
+
21
+
{1 Why Combined?}
22
+
23
+
The CFF spec has separate [license] and [license-url] fields, but they
24
+
have a hidden relationship:
25
+
- SPDX licenses have well-known URLs (e.g., MIT → https://spdx.org/licenses/MIT.html)
26
+
- [license-url] is only meaningful for non-SPDX licenses
27
+
28
+
This type makes that relationship explicit: [`Spdx] licenses don't need
29
+
a URL, while [`Other] licenses can optionally include one.
30
31
{1 Examples}
32
33
+
{2 Standard SPDX License}
34
{[
35
license: MIT
36
]}
37
+
Parsed as [`Spdx (Simple (LicenseID "MIT"))].
38
39
{2 SPDX Expression}
40
{[
41
+
license: Apache-2.0 OR MIT
42
]}
43
+
Parsed as [`Spdx (OR ...)].
44
45
+
{2 Custom License with URL}
46
{[
47
+
license: ACME-Proprietary-1.0
48
+
license-url: https://acme.com/license
49
]}
50
+
Parsed as [`Other (["ACME-Proprietary-1.0"], Some "https://acme.com/license")]. *)
51
52
+
(** License type: SPDX expression or unknown ID(s) with optional URL. *)
53
+
type t =
54
+
[ `Spdx of Spdx_licenses.t
55
+
| `Other of string list * string option
56
+
]
57
58
(** {1 Construction} *)
59
60
+
(** [of_spdx expr] wraps a valid SPDX expression. *)
61
val of_spdx : Spdx_licenses.t -> t
62
63
(** [of_string s] parses [s] as an SPDX expression.
64
+
Returns [`Spdx] on success, [`Other ([s], None)] on parse failure. *)
65
+
val of_string : string -> t
66
67
(** [of_strings ss] parses a list of license strings.
68
+
If all are valid SPDX IDs, returns [`Spdx] with OR combination.
69
+
Otherwise returns [`Other (ss, None)]. *)
70
+
val of_strings : string list -> t
71
+
72
+
(** [with_url url t] adds a URL to the license.
73
+
- For [`Spdx], returns unchanged (SPDX URLs are well-known)
74
+
- For [`Other (ids, _)], returns [`Other (ids, Some url)] *)
75
+
val with_url : string -> t -> t
76
+
77
+
(** [with_url_opt url_opt t] optionally adds a URL.
78
+
Convenience for combining during jsont decoding. *)
79
+
val with_url_opt : string option -> t -> t
80
81
(** {1 Access} *)
82
83
+
(** [to_spdx t] returns [Some expr] if valid SPDX, [None] otherwise. *)
84
val to_spdx : t -> Spdx_licenses.t option
85
86
+
(** [to_strings t] returns the license identifier(s) as strings. *)
87
val to_strings : t -> string list
88
+
89
+
(** [url t] returns the license URL.
90
+
- For [`Spdx], always [None] (use SPDX's well-known URLs)
91
+
- For [`Other], returns the URL if provided *)
92
+
val url : t -> string option
93
94
(** {1 Formatting} *)
95
96
(** Pretty-print the license. *)
97
+
val pp : Format.formatter -> t -> unit
98
99
(** {1 Codec} *)
100
101
+
(** JSON/YAML codec for the license field only.
102
+
103
+
This handles just the [license] field. The [license-url] field
104
+
is handled separately by the parent codec which combines them
105
+
using {!with_url}.
106
107
Lenient: accepts any string without validation for round-tripping. *)
108
+
val jsont : t Jsont.t
+665
-385
lib/cff_reference.ml
+665
-385
lib/cff_reference.ml
···
1
(*---------------------------------------------------------------------------
2
-
Copyright (c) 2025 The ocaml-cff programmers. All rights reserved.
3
SPDX-License-Identifier: ISC
4
---------------------------------------------------------------------------*)
5
···
7
8
(** Core identity of a reference. *)
9
module Core = struct
10
-
type t = {
11
-
type_ : Cff_enums.Reference_type.t;
12
-
title : string;
13
-
authors : Cff_author.t list;
14
-
abstract : string option;
15
-
abbreviation : string option;
16
-
}
17
18
let make ~type_ ~title ~authors ?abstract ?abbreviation () =
19
{ type_; title; authors; abstract; abbreviation }
20
21
let type_ t = t.type_
22
let title t = t.title
23
let authors t = t.authors
24
let abstract t = t.abstract
25
let abbreviation t = t.abbreviation
26
-
27
-
let pp ppf t =
28
-
Format.fprintf ppf "%s (%a)"
29
-
t.title Cff_enums.Reference_type.pp t.type_
30
end
31
32
(** Publication information (journal, volume, pages, etc.). *)
33
module Publication = struct
34
-
type t = {
35
-
journal : string option;
36
-
volume : string option;
37
-
issue : string option;
38
-
pages : string option;
39
-
start : string option;
40
-
end_ : string option;
41
-
edition : string option;
42
-
section : string option;
43
-
status : Cff_enums.Status.t option;
44
-
}
45
46
-
let empty = {
47
-
journal = None; volume = None; issue = None; pages = None;
48
-
start = None; end_ = None; edition = None; section = None;
49
-
status = None;
50
-
}
51
52
-
let make ?journal ?volume ?issue ?pages ?start ?end_ ?edition
53
-
?section ?status () =
54
{ journal; volume; issue; pages; start; end_; edition; section; status }
55
56
let journal t = t.journal
57
let volume t = t.volume
···
64
let status t = t.status
65
66
let is_empty t =
67
-
t.journal = None && t.volume = None && t.issue = None &&
68
-
t.pages = None && t.start = None && t.end_ = None &&
69
-
t.edition = None && t.section = None && t.status = None
70
end
71
72
(** Collection information (proceedings, book series, etc.). *)
73
module Collection = struct
74
-
type t = {
75
-
collection_title : string option;
76
-
collection_type : string option;
77
-
collection_doi : string option;
78
-
volume_title : string option;
79
-
number_volumes : string option;
80
-
}
81
82
-
let empty = {
83
-
collection_title = None; collection_type = None;
84
-
collection_doi = None; volume_title = None; number_volumes = None;
85
-
}
86
87
-
let make ?collection_title ?collection_type ?collection_doi
88
-
?volume_title ?number_volumes () =
89
-
{ collection_title; collection_type; collection_doi;
90
-
volume_title; number_volumes }
91
92
let collection_title t = t.collection_title
93
let collection_type t = t.collection_type
···
96
let number_volumes t = t.number_volumes
97
98
let is_empty t =
99
-
t.collection_title = None && t.collection_type = None &&
100
-
t.collection_doi = None && t.volume_title = None &&
101
-
t.number_volumes = None
102
end
103
104
(** Date information. *)
105
module Dates = struct
106
-
type t = {
107
-
date_accessed : Cff_date.t option;
108
-
date_downloaded : Cff_date.t option;
109
-
date_published : Cff_date.t option;
110
-
date_released : Cff_date.t option;
111
-
year : int option;
112
-
year_original : int option;
113
-
month : int option;
114
-
issue_date : string option;
115
-
}
116
117
-
let empty = {
118
-
date_accessed = None; date_downloaded = None;
119
-
date_published = None; date_released = None;
120
-
year = None; year_original = None; month = None; issue_date = None;
121
-
}
122
123
-
let make ?date_accessed ?date_downloaded ?date_published ?date_released
124
-
?year ?year_original ?month ?issue_date () =
125
-
{ date_accessed; date_downloaded; date_published; date_released;
126
-
year; year_original; month; issue_date }
127
128
let date_accessed t = t.date_accessed
129
let date_downloaded t = t.date_downloaded
···
135
let issue_date t = t.issue_date
136
137
let is_empty t =
138
-
t.date_accessed = None && t.date_downloaded = None &&
139
-
t.date_published = None && t.date_released = None &&
140
-
t.year = None && t.year_original = None &&
141
-
t.month = None && t.issue_date = None
142
end
143
144
(** Identifiers and links. *)
145
module Identifiers = struct
146
-
type t = {
147
-
doi : string option;
148
-
url : string option;
149
-
repository : string option;
150
-
repository_code : string option;
151
-
repository_artifact : string option;
152
-
isbn : string option;
153
-
issn : string option;
154
-
pmcid : string option;
155
-
nihmsid : string option;
156
-
identifiers : Cff_identifier.t list option;
157
-
}
158
159
-
let empty = {
160
-
doi = None; url = None; repository = None;
161
-
repository_code = None; repository_artifact = None;
162
-
isbn = None; issn = None; pmcid = None; nihmsid = None;
163
-
identifiers = None;
164
-
}
165
166
-
let make ?doi ?url ?repository ?repository_code ?repository_artifact
167
-
?isbn ?issn ?pmcid ?nihmsid ?identifiers () =
168
-
{ doi; url; repository; repository_code; repository_artifact;
169
-
isbn; issn; pmcid; nihmsid; identifiers }
170
171
let doi t = t.doi
172
let url t = t.url
···
180
let identifiers t = t.identifiers
181
182
let is_empty t =
183
-
t.doi = None && t.url = None && t.repository = None &&
184
-
t.repository_code = None && t.repository_artifact = None &&
185
-
t.isbn = None && t.issn = None && t.pmcid = None &&
186
-
t.nihmsid = None && t.identifiers = None
187
end
188
189
(** Related entities (editors, publisher, etc.). *)
190
module Entities = struct
191
-
type t = {
192
-
editors : Cff_author.t list option;
193
-
editors_series : Cff_author.t list option;
194
-
translators : Cff_author.t list option;
195
-
recipients : Cff_author.t list option;
196
-
senders : Cff_author.t list option;
197
-
contact : Cff_author.t list option;
198
-
publisher : Cff_author.Entity.t option;
199
-
institution : Cff_author.Entity.t option;
200
-
conference : Cff_author.Entity.t option;
201
-
database_provider : Cff_author.Entity.t option;
202
-
location : Cff_author.Entity.t option;
203
-
}
204
205
-
let empty = {
206
-
editors = None; editors_series = None; translators = None;
207
-
recipients = None; senders = None; contact = None;
208
-
publisher = None; institution = None; conference = None;
209
-
database_provider = None; location = None;
210
-
}
211
212
-
let make ?editors ?editors_series ?translators ?recipients ?senders
213
-
?contact ?publisher ?institution ?conference ?database_provider
214
-
?location () =
215
-
{ editors; editors_series; translators; recipients; senders;
216
-
contact; publisher; institution; conference; database_provider;
217
-
location }
218
219
let editors t = t.editors
220
let editors_series t = t.editors_series
···
229
let location t = t.location
230
231
let is_empty t =
232
-
t.editors = None && t.editors_series = None && t.translators = None &&
233
-
t.recipients = None && t.senders = None && t.contact = None &&
234
-
t.publisher = None && t.institution = None && t.conference = None &&
235
-
t.database_provider = None && t.location = None
236
end
237
238
(** Metadata and description. *)
239
module Metadata = struct
240
-
type t = {
241
-
keywords : string list option;
242
-
languages : string list option;
243
-
license : Cff_license.t option;
244
-
license_url : string option;
245
-
copyright : string option;
246
-
scope : string option;
247
-
notes : string option;
248
-
}
249
250
-
let empty = {
251
-
keywords = None; languages = None; license = None;
252
-
license_url = None; copyright = None; scope = None; notes = None;
253
-
}
254
255
-
let make ?keywords ?languages ?license ?license_url ?copyright
256
-
?scope ?notes () =
257
-
{ keywords; languages; license; license_url; copyright; scope; notes }
258
259
let keywords t = t.keywords
260
let languages t = t.languages
261
let license t = t.license
262
-
let license_url t = t.license_url
263
let copyright t = t.copyright
264
let scope t = t.scope
265
let notes t = t.notes
266
267
let is_empty t =
268
-
t.keywords = None && t.languages = None && t.license = None &&
269
-
t.license_url = None && t.copyright = None &&
270
-
t.scope = None && t.notes = None
271
end
272
273
(** Technical and domain-specific fields. *)
274
module Technical = struct
275
-
type t = {
276
-
commit : string option;
277
-
version : string option;
278
-
filename : string option;
279
-
format : string option;
280
-
medium : string option;
281
-
data_type : string option;
282
-
database : string option;
283
-
number : string option;
284
-
patent_states : string list option;
285
-
thesis_type : string option;
286
-
term : string option;
287
-
entry : string option;
288
-
department : string option;
289
-
loc_start : string option;
290
-
loc_end : string option;
291
-
}
292
293
-
let empty = {
294
-
commit = None; version = None; filename = None; format = None;
295
-
medium = None; data_type = None; database = None; number = None;
296
-
patent_states = None; thesis_type = None; term = None; entry = None;
297
-
department = None; loc_start = None; loc_end = None;
298
-
}
299
300
-
let make ?commit ?version ?filename ?format ?medium ?data_type
301
-
?database ?number ?patent_states ?thesis_type ?term ?entry
302
-
?department ?loc_start ?loc_end () =
303
-
{ commit; version; filename; format; medium; data_type; database;
304
-
number; patent_states; thesis_type; term; entry; department;
305
-
loc_start; loc_end }
306
307
let commit t = t.commit
308
let version t = t.version
···
321
let loc_end t = t.loc_end
322
323
let is_empty t =
324
-
t.commit = None && t.version = None && t.filename = None &&
325
-
t.format = None && t.medium = None && t.data_type = None &&
326
-
t.database = None && t.number = None && t.patent_states = None &&
327
-
t.thesis_type = None && t.term = None && t.entry = None &&
328
-
t.department = None && t.loc_start = None && t.loc_end = None
329
end
330
331
(** Complete reference type. *)
332
-
type t = {
333
-
core : Core.t;
334
-
publication : Publication.t;
335
-
collection : Collection.t;
336
-
dates : Dates.t;
337
-
identifiers : Identifiers.t;
338
-
entities : Entities.t;
339
-
metadata : Metadata.t;
340
-
technical : Technical.t;
341
-
}
342
343
-
let make ~core
344
-
?(publication = Publication.empty)
345
-
?(collection = Collection.empty)
346
-
?(dates = Dates.empty)
347
-
?(identifiers = Identifiers.empty)
348
-
?(entities = Entities.empty)
349
-
?(metadata = Metadata.empty)
350
-
?(technical = Technical.empty)
351
-
() =
352
-
{ core; publication; collection; dates; identifiers;
353
-
entities; metadata; technical }
354
355
let make_simple ~type_ ~title ~authors ?doi ?year ?journal () =
356
let core = Core.make ~type_ ~title ~authors () in
···
358
let dates = Dates.make ?year () in
359
let identifiers = Identifiers.make ?doi () in
360
make ~core ~publication ~dates ~identifiers ()
361
362
(* Accessors for sub-records *)
363
let core t = t.core
···
375
let authors t = Core.authors t.core
376
let doi t = Identifiers.doi t.identifiers
377
let year t = Dates.year t.dates
378
-
379
-
let pp ppf t =
380
-
Core.pp ppf t.core
381
382
(* Helper for string that can also be int (for pages, etc.) *)
383
let string_or_int_jsont =
384
Jsont.any
385
-
~dec_number:(Jsont.number |> Jsont.map
386
-
~dec:(fun f -> string_of_int (int_of_float f))
387
-
~enc:float_of_string)
388
~dec_string:Jsont.string
389
~enc:(fun s ->
390
match float_of_string_opt s with
391
-
| Some _ -> Jsont.number |> Jsont.map ~dec:(fun _ -> assert false) ~enc:float_of_string
392
| None -> Jsont.string)
393
()
394
395
(* Helper to convert array jsont to list jsont *)
396
let list_jsont elt =
397
Jsont.(array elt |> map ~dec:Stdlib.Array.to_list ~enc:Stdlib.Array.of_list)
398
399
(* Jsont codec for the full reference type *)
400
let jsont =
···
402
let identifiers_list_jsont = list_jsont Cff_identifier.jsont in
403
let string_list_jsont = list_jsont Jsont.string in
404
(* We need to decode all 60+ fields and then group into sub-records *)
405
-
Jsont.Object.map ~kind:"Reference"
406
-
(fun type_ title authors abstract abbreviation
407
(* Publication *)
408
-
journal volume issue pages start end_ edition section status
409
(* Collection *)
410
-
collection_title collection_type collection_doi volume_title number_volumes
411
(* Dates *)
412
-
date_accessed date_downloaded date_published date_released
413
-
year year_original month issue_date
414
(* Identifiers *)
415
-
doi url repository repository_code repository_artifact
416
-
isbn issn pmcid nihmsid identifiers_list
417
(* Entities *)
418
-
editors editors_series translators recipients senders contact
419
-
publisher institution conference database_provider location_entity
420
(* Metadata *)
421
-
keywords languages license license_url copyright scope notes
422
(* Technical *)
423
-
commit version filename format medium data_type database
424
-
number patent_states thesis_type term entry department
425
-
loc_start loc_end ->
426
-
let core = { Core.type_; title; authors; abstract; abbreviation } in
427
-
let publication = { Publication.journal; volume; issue; pages;
428
-
start; end_; edition; section; status } in
429
-
let collection = { Collection.collection_title; collection_type;
430
-
collection_doi; volume_title; number_volumes } in
431
-
let dates = { Dates.date_accessed; date_downloaded; date_published;
432
-
date_released; year; year_original; month; issue_date } in
433
-
let identifiers = { Identifiers.doi; url; repository; repository_code;
434
-
repository_artifact; isbn; issn; pmcid; nihmsid;
435
-
identifiers = identifiers_list } in
436
-
let entities = { Entities.editors; editors_series; translators;
437
-
recipients; senders; contact; publisher; institution;
438
-
conference; database_provider; location = location_entity } in
439
-
let metadata = { Metadata.keywords; languages; license; license_url;
440
-
copyright; scope; notes } in
441
-
let technical = { Technical.commit; version; filename; format; medium;
442
-
data_type; database; number; patent_states; thesis_type;
443
-
term; entry; department; loc_start; loc_end } in
444
-
{ core; publication; collection; dates; identifiers;
445
-
entities; metadata; technical })
446
(* Core fields *)
447
-
|> Jsont.Object.mem "type" Cff_enums.Reference_type.jsont
448
-
~enc:(fun r -> r.core.type_)
449
-
|> Jsont.Object.mem "title" Jsont.string
450
-
~enc:(fun r -> r.core.title)
451
-
|> Jsont.Object.mem "authors" authors_list_jsont
452
-
~enc:(fun r -> r.core.authors)
453
-
|> Jsont.Object.opt_mem "abstract" Jsont.string
454
-
~enc:(fun r -> r.core.abstract)
455
-
|> Jsont.Object.opt_mem "abbreviation" Jsont.string
456
-
~enc:(fun r -> r.core.abbreviation)
457
(* Publication fields *)
458
-
|> Jsont.Object.opt_mem "journal" Jsont.string
459
-
~enc:(fun r -> r.publication.journal)
460
-
|> Jsont.Object.opt_mem "volume" string_or_int_jsont
461
-
~enc:(fun r -> r.publication.volume)
462
-
|> Jsont.Object.opt_mem "issue" string_or_int_jsont
463
-
~enc:(fun r -> r.publication.issue)
464
-
|> Jsont.Object.opt_mem "pages" string_or_int_jsont
465
-
~enc:(fun r -> r.publication.pages)
466
-
|> Jsont.Object.opt_mem "start" string_or_int_jsont
467
-
~enc:(fun r -> r.publication.start)
468
-
|> Jsont.Object.opt_mem "end" string_or_int_jsont
469
-
~enc:(fun r -> r.publication.end_)
470
-
|> Jsont.Object.opt_mem "edition" Jsont.string
471
-
~enc:(fun r -> r.publication.edition)
472
-
|> Jsont.Object.opt_mem "section" string_or_int_jsont
473
-
~enc:(fun r -> r.publication.section)
474
-
|> Jsont.Object.opt_mem "status" Cff_enums.Status.jsont
475
-
~enc:(fun r -> r.publication.status)
476
(* Collection fields *)
477
-
|> Jsont.Object.opt_mem "collection-title" Jsont.string
478
-
~enc:(fun r -> r.collection.collection_title)
479
-
|> Jsont.Object.opt_mem "collection-type" Jsont.string
480
-
~enc:(fun r -> r.collection.collection_type)
481
-
|> Jsont.Object.opt_mem "collection-doi" Jsont.string
482
-
~enc:(fun r -> r.collection.collection_doi)
483
-
|> Jsont.Object.opt_mem "volume-title" Jsont.string
484
-
~enc:(fun r -> r.collection.volume_title)
485
-
|> Jsont.Object.opt_mem "number-volumes" string_or_int_jsont
486
-
~enc:(fun r -> r.collection.number_volumes)
487
(* Date fields *)
488
-
|> Jsont.Object.opt_mem "date-accessed" Cff_date.jsont
489
-
~enc:(fun r -> r.dates.date_accessed)
490
-
|> Jsont.Object.opt_mem "date-downloaded" Cff_date.jsont
491
-
~enc:(fun r -> r.dates.date_downloaded)
492
-
|> Jsont.Object.opt_mem "date-published" Cff_date.jsont
493
-
~enc:(fun r -> r.dates.date_published)
494
-
|> Jsont.Object.opt_mem "date-released" Cff_date.jsont
495
-
~enc:(fun r -> r.dates.date_released)
496
-
|> Jsont.Object.opt_mem "year" Jsont.int
497
-
~enc:(fun r -> r.dates.year)
498
-
|> Jsont.Object.opt_mem "year-original" Jsont.int
499
-
~enc:(fun r -> r.dates.year_original)
500
-
|> Jsont.Object.opt_mem "month" Jsont.int
501
-
~enc:(fun r -> r.dates.month)
502
-
|> Jsont.Object.opt_mem "issue-date" Jsont.string
503
-
~enc:(fun r -> r.dates.issue_date)
504
(* Identifier fields *)
505
-
|> Jsont.Object.opt_mem "doi" Jsont.string
506
-
~enc:(fun r -> r.identifiers.doi)
507
-
|> Jsont.Object.opt_mem "url" Jsont.string
508
-
~enc:(fun r -> r.identifiers.url)
509
-
|> Jsont.Object.opt_mem "repository" Jsont.string
510
-
~enc:(fun r -> r.identifiers.repository)
511
-
|> Jsont.Object.opt_mem "repository-code" Jsont.string
512
-
~enc:(fun r -> r.identifiers.repository_code)
513
-
|> Jsont.Object.opt_mem "repository-artifact" Jsont.string
514
-
~enc:(fun r -> r.identifiers.repository_artifact)
515
-
|> Jsont.Object.opt_mem "isbn" Jsont.string
516
-
~enc:(fun r -> r.identifiers.isbn)
517
-
|> Jsont.Object.opt_mem "issn" string_or_int_jsont
518
-
~enc:(fun r -> r.identifiers.issn)
519
-
|> Jsont.Object.opt_mem "pmcid" Jsont.string
520
-
~enc:(fun r -> r.identifiers.pmcid)
521
-
|> Jsont.Object.opt_mem "nihmsid" Jsont.string
522
-
~enc:(fun r -> r.identifiers.nihmsid)
523
-
|> Jsont.Object.opt_mem "identifiers" identifiers_list_jsont
524
-
~enc:(fun r -> r.identifiers.identifiers)
525
(* Entity fields *)
526
-
|> Jsont.Object.opt_mem "editors" authors_list_jsont
527
-
~enc:(fun r -> r.entities.editors)
528
-
|> Jsont.Object.opt_mem "editors-series" authors_list_jsont
529
-
~enc:(fun r -> r.entities.editors_series)
530
-
|> Jsont.Object.opt_mem "translators" authors_list_jsont
531
-
~enc:(fun r -> r.entities.translators)
532
-
|> Jsont.Object.opt_mem "recipients" authors_list_jsont
533
-
~enc:(fun r -> r.entities.recipients)
534
-
|> Jsont.Object.opt_mem "senders" authors_list_jsont
535
-
~enc:(fun r -> r.entities.senders)
536
-
|> Jsont.Object.opt_mem "contact" authors_list_jsont
537
-
~enc:(fun r -> r.entities.contact)
538
-
|> Jsont.Object.opt_mem "publisher" Cff_author.Entity.jsont
539
-
~enc:(fun r -> r.entities.publisher)
540
-
|> Jsont.Object.opt_mem "institution" Cff_author.Entity.jsont
541
-
~enc:(fun r -> r.entities.institution)
542
-
|> Jsont.Object.opt_mem "conference" Cff_author.Entity.jsont
543
-
~enc:(fun r -> r.entities.conference)
544
-
|> Jsont.Object.opt_mem "database-provider" Cff_author.Entity.jsont
545
-
~enc:(fun r -> r.entities.database_provider)
546
-
|> Jsont.Object.opt_mem "location" Cff_author.Entity.jsont
547
-
~enc:(fun r -> r.entities.location)
548
(* Metadata fields *)
549
-
|> Jsont.Object.opt_mem "keywords" string_list_jsont
550
-
~enc:(fun r -> r.metadata.keywords)
551
-
|> Jsont.Object.opt_mem "languages" string_list_jsont
552
-
~enc:(fun r -> r.metadata.languages)
553
-
|> Jsont.Object.opt_mem "license" Cff_license.jsont
554
-
~enc:(fun r -> r.metadata.license)
555
-
|> Jsont.Object.opt_mem "license-url" Jsont.string
556
-
~enc:(fun r -> r.metadata.license_url)
557
-
|> Jsont.Object.opt_mem "copyright" Jsont.string
558
-
~enc:(fun r -> r.metadata.copyright)
559
-
|> Jsont.Object.opt_mem "scope" Jsont.string
560
-
~enc:(fun r -> r.metadata.scope)
561
-
|> Jsont.Object.opt_mem "notes" Jsont.string
562
-
~enc:(fun r -> r.metadata.notes)
563
(* Technical fields *)
564
-
|> Jsont.Object.opt_mem "commit" Jsont.string
565
-
~enc:(fun r -> r.technical.commit)
566
-
|> Jsont.Object.opt_mem "version" string_or_int_jsont
567
-
~enc:(fun r -> r.technical.version)
568
-
|> Jsont.Object.opt_mem "filename" Jsont.string
569
-
~enc:(fun r -> r.technical.filename)
570
-
|> Jsont.Object.opt_mem "format" Jsont.string
571
-
~enc:(fun r -> r.technical.format)
572
-
|> Jsont.Object.opt_mem "medium" Jsont.string
573
-
~enc:(fun r -> r.technical.medium)
574
-
|> Jsont.Object.opt_mem "data-type" Jsont.string
575
-
~enc:(fun r -> r.technical.data_type)
576
-
|> Jsont.Object.opt_mem "database" Jsont.string
577
-
~enc:(fun r -> r.technical.database)
578
-
|> Jsont.Object.opt_mem "number" string_or_int_jsont
579
-
~enc:(fun r -> r.technical.number)
580
-
|> Jsont.Object.opt_mem "patent-states" string_list_jsont
581
-
~enc:(fun r -> r.technical.patent_states)
582
-
|> Jsont.Object.opt_mem "thesis-type" Jsont.string
583
-
~enc:(fun r -> r.technical.thesis_type)
584
-
|> Jsont.Object.opt_mem "term" Jsont.string
585
-
~enc:(fun r -> r.technical.term)
586
-
|> Jsont.Object.opt_mem "entry" Jsont.string
587
-
~enc:(fun r -> r.technical.entry)
588
-
|> Jsont.Object.opt_mem "department" Jsont.string
589
-
~enc:(fun r -> r.technical.department)
590
-
|> Jsont.Object.opt_mem "loc-start" string_or_int_jsont
591
-
~enc:(fun r -> r.technical.loc_start)
592
-
|> Jsont.Object.opt_mem "loc-end" string_or_int_jsont
593
-
~enc:(fun r -> r.technical.loc_end)
594
|> Jsont.Object.skip_unknown
595
|> Jsont.Object.finish
···
1
(*---------------------------------------------------------------------------
2
+
Copyright (c) 2026 The ocaml-cff programmers. All rights reserved.
3
SPDX-License-Identifier: ISC
4
---------------------------------------------------------------------------*)
5
···
7
8
(** Core identity of a reference. *)
9
module Core = struct
10
+
type t =
11
+
{ type_ : Cff_enums.Reference_type.t
12
+
; title : string
13
+
; authors : Cff_author.t list
14
+
; abstract : string option
15
+
; abbreviation : string option
16
+
}
17
18
let make ~type_ ~title ~authors ?abstract ?abbreviation () =
19
{ type_; title; authors; abstract; abbreviation }
20
+
;;
21
22
let type_ t = t.type_
23
let title t = t.title
24
let authors t = t.authors
25
let abstract t = t.abstract
26
let abbreviation t = t.abbreviation
27
+
let pp ppf t = Format.fprintf ppf "%s (%a)" t.title Cff_enums.Reference_type.pp t.type_
28
end
29
30
(** Publication information (journal, volume, pages, etc.). *)
31
module Publication = struct
32
+
type t =
33
+
{ journal : string option
34
+
; volume : string option
35
+
; issue : string option
36
+
; pages : string option
37
+
; start : string option
38
+
; end_ : string option
39
+
; edition : string option
40
+
; section : string option
41
+
; status : Cff_enums.Status.t option
42
+
}
43
44
+
let empty =
45
+
{ journal = None
46
+
; volume = None
47
+
; issue = None
48
+
; pages = None
49
+
; start = None
50
+
; end_ = None
51
+
; edition = None
52
+
; section = None
53
+
; status = None
54
+
}
55
+
;;
56
57
+
let make ?journal ?volume ?issue ?pages ?start ?end_ ?edition ?section ?status () =
58
{ journal; volume; issue; pages; start; end_; edition; section; status }
59
+
;;
60
61
let journal t = t.journal
62
let volume t = t.volume
···
69
let status t = t.status
70
71
let is_empty t =
72
+
t.journal = None
73
+
&& t.volume = None
74
+
&& t.issue = None
75
+
&& t.pages = None
76
+
&& t.start = None
77
+
&& t.end_ = None
78
+
&& t.edition = None
79
+
&& t.section = None
80
+
&& t.status = None
81
+
;;
82
end
83
84
(** Collection information (proceedings, book series, etc.). *)
85
module Collection = struct
86
+
type t =
87
+
{ collection_title : string option
88
+
; collection_type : string option
89
+
; collection_doi : string option
90
+
; volume_title : string option
91
+
; number_volumes : string option
92
+
}
93
94
+
let empty =
95
+
{ collection_title = None
96
+
; collection_type = None
97
+
; collection_doi = None
98
+
; volume_title = None
99
+
; number_volumes = None
100
+
}
101
+
;;
102
103
+
let make
104
+
?collection_title
105
+
?collection_type
106
+
?collection_doi
107
+
?volume_title
108
+
?number_volumes
109
+
()
110
+
=
111
+
{ collection_title; collection_type; collection_doi; volume_title; number_volumes }
112
+
;;
113
114
let collection_title t = t.collection_title
115
let collection_type t = t.collection_type
···
118
let number_volumes t = t.number_volumes
119
120
let is_empty t =
121
+
t.collection_title = None
122
+
&& t.collection_type = None
123
+
&& t.collection_doi = None
124
+
&& t.volume_title = None
125
+
&& t.number_volumes = None
126
+
;;
127
end
128
129
(** Date information. *)
130
module Dates = struct
131
+
type t =
132
+
{ date_accessed : Cff_date.t option
133
+
; date_downloaded : Cff_date.t option
134
+
; date_published : Cff_date.t option
135
+
; date_released : Cff_date.t option
136
+
; year : int option
137
+
; year_original : int option
138
+
; month : int option
139
+
; issue_date : string option
140
+
}
141
142
+
let empty =
143
+
{ date_accessed = None
144
+
; date_downloaded = None
145
+
; date_published = None
146
+
; date_released = None
147
+
; year = None
148
+
; year_original = None
149
+
; month = None
150
+
; issue_date = None
151
+
}
152
+
;;
153
154
+
let make
155
+
?date_accessed
156
+
?date_downloaded
157
+
?date_published
158
+
?date_released
159
+
?year
160
+
?year_original
161
+
?month
162
+
?issue_date
163
+
()
164
+
=
165
+
{ date_accessed
166
+
; date_downloaded
167
+
; date_published
168
+
; date_released
169
+
; year
170
+
; year_original
171
+
; month
172
+
; issue_date
173
+
}
174
+
;;
175
176
let date_accessed t = t.date_accessed
177
let date_downloaded t = t.date_downloaded
···
183
let issue_date t = t.issue_date
184
185
let is_empty t =
186
+
t.date_accessed = None
187
+
&& t.date_downloaded = None
188
+
&& t.date_published = None
189
+
&& t.date_released = None
190
+
&& t.year = None
191
+
&& t.year_original = None
192
+
&& t.month = None
193
+
&& t.issue_date = None
194
+
;;
195
end
196
197
(** Identifiers and links. *)
198
module Identifiers = struct
199
+
type t =
200
+
{ doi : string option
201
+
; url : string option
202
+
; repository : string option
203
+
; repository_code : string option
204
+
; repository_artifact : string option
205
+
; isbn : string option
206
+
; issn : string option
207
+
; pmcid : string option
208
+
; nihmsid : string option
209
+
; identifiers : Cff_identifier.t list option
210
+
}
211
212
+
let empty =
213
+
{ doi = None
214
+
; url = None
215
+
; repository = None
216
+
; repository_code = None
217
+
; repository_artifact = None
218
+
; isbn = None
219
+
; issn = None
220
+
; pmcid = None
221
+
; nihmsid = None
222
+
; identifiers = None
223
+
}
224
+
;;
225
226
+
let make
227
+
?doi
228
+
?url
229
+
?repository
230
+
?repository_code
231
+
?repository_artifact
232
+
?isbn
233
+
?issn
234
+
?pmcid
235
+
?nihmsid
236
+
?identifiers
237
+
()
238
+
=
239
+
{ doi
240
+
; url
241
+
; repository
242
+
; repository_code
243
+
; repository_artifact
244
+
; isbn
245
+
; issn
246
+
; pmcid
247
+
; nihmsid
248
+
; identifiers
249
+
}
250
+
;;
251
252
let doi t = t.doi
253
let url t = t.url
···
261
let identifiers t = t.identifiers
262
263
let is_empty t =
264
+
t.doi = None
265
+
&& t.url = None
266
+
&& t.repository = None
267
+
&& t.repository_code = None
268
+
&& t.repository_artifact = None
269
+
&& t.isbn = None
270
+
&& t.issn = None
271
+
&& t.pmcid = None
272
+
&& t.nihmsid = None
273
+
&& t.identifiers = None
274
+
;;
275
end
276
277
(** Related entities (editors, publisher, etc.). *)
278
module Entities = struct
279
+
type t =
280
+
{ editors : Cff_author.t list option
281
+
; editors_series : Cff_author.t list option
282
+
; translators : Cff_author.t list option
283
+
; recipients : Cff_author.t list option
284
+
; senders : Cff_author.t list option
285
+
; contact : Cff_author.t list option
286
+
; publisher : Cff_author.Entity.t option
287
+
; institution : Cff_author.Entity.t option
288
+
; conference : Cff_author.Entity.t option
289
+
; database_provider : Cff_author.Entity.t option
290
+
; location : Cff_author.Entity.t option
291
+
}
292
293
+
let empty =
294
+
{ editors = None
295
+
; editors_series = None
296
+
; translators = None
297
+
; recipients = None
298
+
; senders = None
299
+
; contact = None
300
+
; publisher = None
301
+
; institution = None
302
+
; conference = None
303
+
; database_provider = None
304
+
; location = None
305
+
}
306
+
;;
307
308
+
let make
309
+
?editors
310
+
?editors_series
311
+
?translators
312
+
?recipients
313
+
?senders
314
+
?contact
315
+
?publisher
316
+
?institution
317
+
?conference
318
+
?database_provider
319
+
?location
320
+
()
321
+
=
322
+
{ editors
323
+
; editors_series
324
+
; translators
325
+
; recipients
326
+
; senders
327
+
; contact
328
+
; publisher
329
+
; institution
330
+
; conference
331
+
; database_provider
332
+
; location
333
+
}
334
+
;;
335
336
let editors t = t.editors
337
let editors_series t = t.editors_series
···
346
let location t = t.location
347
348
let is_empty t =
349
+
t.editors = None
350
+
&& t.editors_series = None
351
+
&& t.translators = None
352
+
&& t.recipients = None
353
+
&& t.senders = None
354
+
&& t.contact = None
355
+
&& t.publisher = None
356
+
&& t.institution = None
357
+
&& t.conference = None
358
+
&& t.database_provider = None
359
+
&& t.location = None
360
+
;;
361
end
362
363
(** Metadata and description. *)
364
module Metadata = struct
365
+
type t =
366
+
{ keywords : string list option
367
+
; languages : string list option
368
+
; license : Cff_license.t option
369
+
; copyright : string option
370
+
; scope : string option
371
+
; notes : string option
372
+
}
373
374
+
let empty =
375
+
{ keywords = None
376
+
; languages = None
377
+
; license = None
378
+
; copyright = None
379
+
; scope = None
380
+
; notes = None
381
+
}
382
+
;;
383
384
+
let make ?keywords ?languages ?license ?copyright ?scope ?notes () =
385
+
{ keywords; languages; license; copyright; scope; notes }
386
+
;;
387
388
let keywords t = t.keywords
389
let languages t = t.languages
390
let license t = t.license
391
let copyright t = t.copyright
392
let scope t = t.scope
393
let notes t = t.notes
394
395
let is_empty t =
396
+
t.keywords = None
397
+
&& t.languages = None
398
+
&& t.license = None
399
+
&& t.copyright = None
400
+
&& t.scope = None
401
+
&& t.notes = None
402
+
;;
403
end
404
405
(** Technical and domain-specific fields. *)
406
module Technical = struct
407
+
type t =
408
+
{ commit : string option
409
+
; version : string option
410
+
; filename : string option
411
+
; format : string option
412
+
; medium : string option
413
+
; data_type : string option
414
+
; database : string option
415
+
; number : string option
416
+
; patent_states : string list option
417
+
; thesis_type : string option
418
+
; term : string option
419
+
; entry : string option
420
+
; department : string option
421
+
; loc_start : string option
422
+
; loc_end : string option
423
+
}
424
425
+
let empty =
426
+
{ commit = None
427
+
; version = None
428
+
; filename = None
429
+
; format = None
430
+
; medium = None
431
+
; data_type = None
432
+
; database = None
433
+
; number = None
434
+
; patent_states = None
435
+
; thesis_type = None
436
+
; term = None
437
+
; entry = None
438
+
; department = None
439
+
; loc_start = None
440
+
; loc_end = None
441
+
}
442
+
;;
443
444
+
let make
445
+
?commit
446
+
?version
447
+
?filename
448
+
?format
449
+
?medium
450
+
?data_type
451
+
?database
452
+
?number
453
+
?patent_states
454
+
?thesis_type
455
+
?term
456
+
?entry
457
+
?department
458
+
?loc_start
459
+
?loc_end
460
+
()
461
+
=
462
+
{ commit
463
+
; version
464
+
; filename
465
+
; format
466
+
; medium
467
+
; data_type
468
+
; database
469
+
; number
470
+
; patent_states
471
+
; thesis_type
472
+
; term
473
+
; entry
474
+
; department
475
+
; loc_start
476
+
; loc_end
477
+
}
478
+
;;
479
480
let commit t = t.commit
481
let version t = t.version
···
494
let loc_end t = t.loc_end
495
496
let is_empty t =
497
+
t.commit = None
498
+
&& t.version = None
499
+
&& t.filename = None
500
+
&& t.format = None
501
+
&& t.medium = None
502
+
&& t.data_type = None
503
+
&& t.database = None
504
+
&& t.number = None
505
+
&& t.patent_states = None
506
+
&& t.thesis_type = None
507
+
&& t.term = None
508
+
&& t.entry = None
509
+
&& t.department = None
510
+
&& t.loc_start = None
511
+
&& t.loc_end = None
512
+
;;
513
end
514
515
(** Complete reference type. *)
516
+
type t =
517
+
{ core : Core.t
518
+
; publication : Publication.t
519
+
; collection : Collection.t
520
+
; dates : Dates.t
521
+
; identifiers : Identifiers.t
522
+
; entities : Entities.t
523
+
; metadata : Metadata.t
524
+
; technical : Technical.t
525
+
}
526
527
+
let make
528
+
~core
529
+
?(publication = Publication.empty)
530
+
?(collection = Collection.empty)
531
+
?(dates = Dates.empty)
532
+
?(identifiers = Identifiers.empty)
533
+
?(entities = Entities.empty)
534
+
?(metadata = Metadata.empty)
535
+
?(technical = Technical.empty)
536
+
()
537
+
=
538
+
{ core; publication; collection; dates; identifiers; entities; metadata; technical }
539
+
;;
540
541
let make_simple ~type_ ~title ~authors ?doi ?year ?journal () =
542
let core = Core.make ~type_ ~title ~authors () in
···
544
let dates = Dates.make ?year () in
545
let identifiers = Identifiers.make ?doi () in
546
make ~core ~publication ~dates ~identifiers ()
547
+
;;
548
549
(* Accessors for sub-records *)
550
let core t = t.core
···
562
let authors t = Core.authors t.core
563
let doi t = Identifiers.doi t.identifiers
564
let year t = Dates.year t.dates
565
+
let pp ppf t = Core.pp ppf t.core
566
567
(* Helper for string that can also be int (for pages, etc.) *)
568
let string_or_int_jsont =
569
Jsont.any
570
+
~dec_number:
571
+
(Jsont.number
572
+
|> Jsont.map ~dec:(fun f -> string_of_int (int_of_float f)) ~enc:float_of_string)
573
~dec_string:Jsont.string
574
~enc:(fun s ->
575
match float_of_string_opt s with
576
+
| Some _ ->
577
+
Jsont.number |> Jsont.map ~dec:(fun _ -> assert false) ~enc:float_of_string
578
| None -> Jsont.string)
579
()
580
+
;;
581
582
(* Helper to convert array jsont to list jsont *)
583
let list_jsont elt =
584
Jsont.(array elt |> map ~dec:Stdlib.Array.to_list ~enc:Stdlib.Array.of_list)
585
+
;;
586
587
(* Jsont codec for the full reference type *)
588
let jsont =
···
590
let identifiers_list_jsont = list_jsont Cff_identifier.jsont in
591
let string_list_jsont = list_jsont Jsont.string in
592
(* We need to decode all 60+ fields and then group into sub-records *)
593
+
Jsont.Object.map
594
+
~kind:"Reference"
595
+
(fun
596
+
type_
597
+
title
598
+
authors
599
+
abstract
600
+
abbreviation
601
(* Publication *)
602
+
journal
603
+
volume
604
+
issue
605
+
pages
606
+
start
607
+
end_
608
+
edition
609
+
section
610
+
status
611
(* Collection *)
612
+
collection_title
613
+
collection_type
614
+
collection_doi
615
+
volume_title
616
+
number_volumes
617
(* Dates *)
618
+
date_accessed
619
+
date_downloaded
620
+
date_published
621
+
date_released
622
+
year
623
+
year_original
624
+
month
625
+
issue_date
626
(* Identifiers *)
627
+
doi
628
+
url
629
+
repository
630
+
repository_code
631
+
repository_artifact
632
+
isbn
633
+
issn
634
+
pmcid
635
+
nihmsid
636
+
identifiers_list
637
(* Entities *)
638
+
editors
639
+
editors_series
640
+
translators
641
+
recipients
642
+
senders
643
+
contact
644
+
publisher
645
+
institution
646
+
conference
647
+
database_provider
648
+
location_entity
649
(* Metadata *)
650
+
keywords
651
+
languages
652
+
license
653
+
license_url
654
+
copyright
655
+
scope
656
+
notes
657
(* Technical *)
658
+
commit
659
+
version
660
+
filename
661
+
format
662
+
medium
663
+
data_type
664
+
database
665
+
number
666
+
patent_states
667
+
thesis_type
668
+
term
669
+
entry
670
+
department
671
+
loc_start
672
+
loc_end
673
+
->
674
+
let core = { Core.type_; title; authors; abstract; abbreviation } in
675
+
let publication =
676
+
{ Publication.journal
677
+
; volume
678
+
; issue
679
+
; pages
680
+
; start
681
+
; end_
682
+
; edition
683
+
; section
684
+
; status
685
+
}
686
+
in
687
+
let collection =
688
+
{ Collection.collection_title
689
+
; collection_type
690
+
; collection_doi
691
+
; volume_title
692
+
; number_volumes
693
+
}
694
+
in
695
+
let dates =
696
+
{ Dates.date_accessed
697
+
; date_downloaded
698
+
; date_published
699
+
; date_released
700
+
; year
701
+
; year_original
702
+
; month
703
+
; issue_date
704
+
}
705
+
in
706
+
let identifiers =
707
+
{ Identifiers.doi
708
+
; url
709
+
; repository
710
+
; repository_code
711
+
; repository_artifact
712
+
; isbn
713
+
; issn
714
+
; pmcid
715
+
; nihmsid
716
+
; identifiers = identifiers_list
717
+
}
718
+
in
719
+
let entities =
720
+
{ Entities.editors
721
+
; editors_series
722
+
; translators
723
+
; recipients
724
+
; senders
725
+
; contact
726
+
; publisher
727
+
; institution
728
+
; conference
729
+
; database_provider
730
+
; location = location_entity
731
+
}
732
+
in
733
+
let license = Option.map (Cff_license.with_url_opt license_url) license in
734
+
let metadata =
735
+
{ Metadata.keywords; languages; license; copyright; scope; notes }
736
+
in
737
+
let technical =
738
+
{ Technical.commit
739
+
; version
740
+
; filename
741
+
; format
742
+
; medium
743
+
; data_type
744
+
; database
745
+
; number
746
+
; patent_states
747
+
; thesis_type
748
+
; term
749
+
; entry
750
+
; department
751
+
; loc_start
752
+
; loc_end
753
+
}
754
+
in
755
+
{ core
756
+
; publication
757
+
; collection
758
+
; dates
759
+
; identifiers
760
+
; entities
761
+
; metadata
762
+
; technical
763
+
})
764
(* Core fields *)
765
+
|> Jsont.Object.mem "type" Cff_enums.Reference_type.jsont ~enc:(fun r -> r.core.type_)
766
+
|> Jsont.Object.mem "title" Jsont.string ~enc:(fun r -> r.core.title)
767
+
|> Jsont.Object.mem "authors" authors_list_jsont ~enc:(fun r -> r.core.authors)
768
+
|> Jsont.Object.opt_mem "abstract" Jsont.string ~enc:(fun r -> r.core.abstract)
769
+
|> Jsont.Object.opt_mem "abbreviation" Jsont.string ~enc:(fun r -> r.core.abbreviation)
770
(* Publication fields *)
771
+
|> Jsont.Object.opt_mem "journal" Jsont.string ~enc:(fun r -> r.publication.journal)
772
+
|> Jsont.Object.opt_mem "volume" string_or_int_jsont ~enc:(fun r ->
773
+
r.publication.volume)
774
+
|> Jsont.Object.opt_mem "issue" string_or_int_jsont ~enc:(fun r -> r.publication.issue)
775
+
|> Jsont.Object.opt_mem "pages" string_or_int_jsont ~enc:(fun r -> r.publication.pages)
776
+
|> Jsont.Object.opt_mem "start" string_or_int_jsont ~enc:(fun r -> r.publication.start)
777
+
|> Jsont.Object.opt_mem "end" string_or_int_jsont ~enc:(fun r -> r.publication.end_)
778
+
|> Jsont.Object.opt_mem "edition" Jsont.string ~enc:(fun r -> r.publication.edition)
779
+
|> Jsont.Object.opt_mem "section" string_or_int_jsont ~enc:(fun r ->
780
+
r.publication.section)
781
+
|> Jsont.Object.opt_mem "status" Cff_enums.Status.jsont ~enc:(fun r ->
782
+
r.publication.status)
783
(* Collection fields *)
784
+
|> Jsont.Object.opt_mem "collection-title" Jsont.string ~enc:(fun r ->
785
+
r.collection.collection_title)
786
+
|> Jsont.Object.opt_mem "collection-type" Jsont.string ~enc:(fun r ->
787
+
r.collection.collection_type)
788
+
|> Jsont.Object.opt_mem "collection-doi" Jsont.string ~enc:(fun r ->
789
+
r.collection.collection_doi)
790
+
|> Jsont.Object.opt_mem "volume-title" Jsont.string ~enc:(fun r ->
791
+
r.collection.volume_title)
792
+
|> Jsont.Object.opt_mem "number-volumes" string_or_int_jsont ~enc:(fun r ->
793
+
r.collection.number_volumes)
794
(* Date fields *)
795
+
|> Jsont.Object.opt_mem "date-accessed" Cff_date.jsont ~enc:(fun r ->
796
+
r.dates.date_accessed)
797
+
|> Jsont.Object.opt_mem "date-downloaded" Cff_date.jsont ~enc:(fun r ->
798
+
r.dates.date_downloaded)
799
+
|> Jsont.Object.opt_mem "date-published" Cff_date.jsont ~enc:(fun r ->
800
+
r.dates.date_published)
801
+
|> Jsont.Object.opt_mem "date-released" Cff_date.jsont ~enc:(fun r ->
802
+
r.dates.date_released)
803
+
|> Jsont.Object.opt_mem "year" Jsont.int ~enc:(fun r -> r.dates.year)
804
+
|> Jsont.Object.opt_mem "year-original" Jsont.int ~enc:(fun r -> r.dates.year_original)
805
+
|> Jsont.Object.opt_mem "month" Jsont.int ~enc:(fun r -> r.dates.month)
806
+
|> Jsont.Object.opt_mem "issue-date" Jsont.string ~enc:(fun r -> r.dates.issue_date)
807
(* Identifier fields *)
808
+
|> Jsont.Object.opt_mem "doi" Jsont.string ~enc:(fun r -> r.identifiers.doi)
809
+
|> Jsont.Object.opt_mem "url" Jsont.string ~enc:(fun r -> r.identifiers.url)
810
+
|> Jsont.Object.opt_mem "repository" Jsont.string ~enc:(fun r ->
811
+
r.identifiers.repository)
812
+
|> Jsont.Object.opt_mem "repository-code" Jsont.string ~enc:(fun r ->
813
+
r.identifiers.repository_code)
814
+
|> Jsont.Object.opt_mem "repository-artifact" Jsont.string ~enc:(fun r ->
815
+
r.identifiers.repository_artifact)
816
+
|> Jsont.Object.opt_mem "isbn" Jsont.string ~enc:(fun r -> r.identifiers.isbn)
817
+
|> Jsont.Object.opt_mem "issn" string_or_int_jsont ~enc:(fun r -> r.identifiers.issn)
818
+
|> Jsont.Object.opt_mem "pmcid" Jsont.string ~enc:(fun r -> r.identifiers.pmcid)
819
+
|> Jsont.Object.opt_mem "nihmsid" Jsont.string ~enc:(fun r -> r.identifiers.nihmsid)
820
+
|> Jsont.Object.opt_mem "identifiers" identifiers_list_jsont ~enc:(fun r ->
821
+
r.identifiers.identifiers)
822
(* Entity fields *)
823
+
|> Jsont.Object.opt_mem "editors" authors_list_jsont ~enc:(fun r -> r.entities.editors)
824
+
|> Jsont.Object.opt_mem "editors-series" authors_list_jsont ~enc:(fun r ->
825
+
r.entities.editors_series)
826
+
|> Jsont.Object.opt_mem "translators" authors_list_jsont ~enc:(fun r ->
827
+
r.entities.translators)
828
+
|> Jsont.Object.opt_mem "recipients" authors_list_jsont ~enc:(fun r ->
829
+
r.entities.recipients)
830
+
|> Jsont.Object.opt_mem "senders" authors_list_jsont ~enc:(fun r -> r.entities.senders)
831
+
|> Jsont.Object.opt_mem "contact" authors_list_jsont ~enc:(fun r -> r.entities.contact)
832
+
|> Jsont.Object.opt_mem "publisher" Cff_author.Entity.jsont ~enc:(fun r ->
833
+
r.entities.publisher)
834
+
|> Jsont.Object.opt_mem "institution" Cff_author.Entity.jsont ~enc:(fun r ->
835
+
r.entities.institution)
836
+
|> Jsont.Object.opt_mem "conference" Cff_author.Entity.jsont ~enc:(fun r ->
837
+
r.entities.conference)
838
+
|> Jsont.Object.opt_mem "database-provider" Cff_author.Entity.jsont ~enc:(fun r ->
839
+
r.entities.database_provider)
840
+
|> Jsont.Object.opt_mem "location" Cff_author.Entity.jsont ~enc:(fun r ->
841
+
r.entities.location)
842
(* Metadata fields *)
843
+
|> Jsont.Object.opt_mem "keywords" string_list_jsont ~enc:(fun r -> r.metadata.keywords)
844
+
|> Jsont.Object.opt_mem "languages" string_list_jsont ~enc:(fun r ->
845
+
r.metadata.languages)
846
+
|> Jsont.Object.opt_mem "license" Cff_license.jsont ~enc:(fun r -> r.metadata.license)
847
+
|> Jsont.Object.opt_mem "license-url" Jsont.string ~enc:(fun r ->
848
+
Option.bind r.metadata.license Cff_license.url)
849
+
|> Jsont.Object.opt_mem "copyright" Jsont.string ~enc:(fun r -> r.metadata.copyright)
850
+
|> Jsont.Object.opt_mem "scope" Jsont.string ~enc:(fun r -> r.metadata.scope)
851
+
|> Jsont.Object.opt_mem "notes" Jsont.string ~enc:(fun r -> r.metadata.notes)
852
(* Technical fields *)
853
+
|> Jsont.Object.opt_mem "commit" Jsont.string ~enc:(fun r -> r.technical.commit)
854
+
|> Jsont.Object.opt_mem "version" string_or_int_jsont ~enc:(fun r ->
855
+
r.technical.version)
856
+
|> Jsont.Object.opt_mem "filename" Jsont.string ~enc:(fun r -> r.technical.filename)
857
+
|> Jsont.Object.opt_mem "format" Jsont.string ~enc:(fun r -> r.technical.format)
858
+
|> Jsont.Object.opt_mem "medium" Jsont.string ~enc:(fun r -> r.technical.medium)
859
+
|> Jsont.Object.opt_mem "data-type" Jsont.string ~enc:(fun r -> r.technical.data_type)
860
+
|> Jsont.Object.opt_mem "database" Jsont.string ~enc:(fun r -> r.technical.database)
861
+
|> Jsont.Object.opt_mem "number" string_or_int_jsont ~enc:(fun r -> r.technical.number)
862
+
|> Jsont.Object.opt_mem "patent-states" string_list_jsont ~enc:(fun r ->
863
+
r.technical.patent_states)
864
+
|> Jsont.Object.opt_mem "thesis-type" Jsont.string ~enc:(fun r ->
865
+
r.technical.thesis_type)
866
+
|> Jsont.Object.opt_mem "term" Jsont.string ~enc:(fun r -> r.technical.term)
867
+
|> Jsont.Object.opt_mem "entry" Jsont.string ~enc:(fun r -> r.technical.entry)
868
+
|> Jsont.Object.opt_mem "department" Jsont.string ~enc:(fun r -> r.technical.department)
869
+
|> Jsont.Object.opt_mem "loc-start" string_or_int_jsont ~enc:(fun r ->
870
+
r.technical.loc_start)
871
+
|> Jsont.Object.opt_mem "loc-end" string_or_int_jsont ~enc:(fun r ->
872
+
r.technical.loc_end)
873
|> Jsont.Object.skip_unknown
874
|> Jsont.Object.finish
875
+
;;
+200
-194
lib/cff_reference.mli
+200
-194
lib/cff_reference.mli
···
1
(*---------------------------------------------------------------------------
2
-
Copyright (c) 2025 The ocaml-cff programmers. All rights reserved.
3
SPDX-License-Identifier: ISC
4
---------------------------------------------------------------------------*)
5
···
76
module Core : sig
77
type t
78
79
-
val make :
80
-
type_:Cff_enums.Reference_type.t ->
81
-
title:string ->
82
-
authors:Cff_author.t list ->
83
-
?abstract:string ->
84
-
?abbreviation:string ->
85
-
unit -> t
86
(** Create a core record.
87
88
@param type_ The reference type (article, book, software, etc.)
89
@param title The title of the work
90
@param authors List of persons and/or entities *)
91
92
-
val type_ : t -> Cff_enums.Reference_type.t
93
(** The reference type. Determines which other fields are applicable. *)
94
95
-
val title : t -> string
96
(** The title of the referenced work. *)
97
98
val authors : t -> Cff_author.t list
99
-
(** The authors/creators of the work. *)
100
101
-
val abstract : t -> string option
102
(** A description or abstract of the work. *)
103
104
-
val abbreviation : t -> string option
105
(** Abbreviated form of the title (e.g., for journal names). *)
106
107
val pp : Format.formatter -> t -> unit
108
end
···
115
module Publication : sig
116
type t
117
118
-
val empty : t
119
(** Empty publication record with all fields as [None]. *)
120
121
-
val make :
122
-
?journal:string ->
123
-
?volume:string ->
124
-
?issue:string ->
125
-
?pages:string ->
126
-
?start:string ->
127
-
?end_:string ->
128
-
?edition:string ->
129
-
?section:string ->
130
-
?status:Cff_enums.Status.t ->
131
-
unit -> t
132
133
-
val journal : t -> string option
134
(** The name of the journal or magazine. *)
135
136
-
val volume : t -> string option
137
(** The volume number of the journal. *)
138
139
val issue : t -> string option
140
-
(** The issue number within the volume. *)
141
142
val pages : t -> string option
143
-
(** Page range (e.g., ["123-145"]). Alternative to [start]/[end_]. *)
144
145
-
val start : t -> string option
146
(** Starting page number. *)
147
148
val end_ : t -> string option
149
-
(** Ending page number. *)
150
151
val edition : t -> string option
152
-
(** The edition of the work (e.g., ["2nd edition"]). *)
153
154
-
val section : t -> string option
155
(** The section of a work (e.g., newspaper section). *)
156
157
-
val status : t -> Cff_enums.Status.t option
158
(** Publication status: preprint, in-press, submitted, etc. *)
159
160
val is_empty : t -> bool
161
-
(** [true] if all fields are [None]. *)
162
end
163
164
(** Collection metadata for works in edited volumes.
···
170
171
val empty : t
172
173
-
val make :
174
-
?collection_title:string ->
175
-
?collection_type:string ->
176
-
?collection_doi:string ->
177
-
?volume_title:string ->
178
-
?number_volumes:string ->
179
-
unit -> t
180
181
-
val collection_title : t -> string option
182
(** Title of the collection (proceedings, book series, etc.). *)
183
184
val collection_type : t -> string option
185
-
(** Type of collection (e.g., ["proceedings"], ["book series"]). *)
186
187
-
val collection_doi : t -> string option
188
(** DOI of the collection itself (not the individual work). *)
189
190
val volume_title : t -> string option
191
-
(** Title of the specific volume within a multi-volume collection. *)
192
193
-
val number_volumes : t -> string option
194
(** Total number of volumes in the collection. *)
195
196
val is_empty : t -> bool
197
end
···
211
212
val empty : t
213
214
-
val make :
215
-
?date_accessed:Cff_date.t ->
216
-
?date_downloaded:Cff_date.t ->
217
-
?date_published:Cff_date.t ->
218
-
?date_released:Cff_date.t ->
219
-
?year:int ->
220
-
?year_original:int ->
221
-
?month:int ->
222
-
?issue_date:string ->
223
-
unit -> t
224
225
-
val date_accessed : t -> Cff_date.t option
226
(** Date when an online resource was accessed for citation. *)
227
228
-
val date_downloaded : t -> Cff_date.t option
229
(** Date when a resource was downloaded. *)
230
231
val date_published : t -> Cff_date.t option
232
-
(** Formal publication date. *)
233
234
-
val date_released : t -> Cff_date.t option
235
(** Release date (typically for software). *)
236
237
val year : t -> int option
238
-
(** Publication year when full date is unknown. *)
239
240
-
val year_original : t -> int option
241
(** Year of original publication (for reprints, translations). *)
242
243
val month : t -> int option
244
-
(** Publication month (1-12) when only month/year is known. *)
245
246
-
val issue_date : t -> string option
247
(** Issue date as a string (for periodicals with specific dates). *)
248
249
val is_empty : t -> bool
250
end
···
263
264
val empty : t
265
266
-
val make :
267
-
?doi:string ->
268
-
?url:string ->
269
-
?repository:string ->
270
-
?repository_code:string ->
271
-
?repository_artifact:string ->
272
-
?isbn:string ->
273
-
?issn:string ->
274
-
?pmcid:string ->
275
-
?nihmsid:string ->
276
-
?identifiers:Cff_identifier.t list ->
277
-
unit -> t
278
279
val doi : t -> string option
280
-
(** Digital Object Identifier (e.g., ["10.1234/example"]). *)
281
282
-
val url : t -> string option
283
(** URL where the work can be accessed. *)
284
285
-
val repository : t -> string option
286
(** General repository URL. *)
287
288
val repository_code : t -> string option
289
-
(** Source code repository (GitHub, GitLab, etc.). *)
290
291
-
val repository_artifact : t -> string option
292
(** Built artifact repository (npm, PyPI, Docker Hub, etc.). *)
293
294
-
val isbn : t -> string option
295
(** International Standard Book Number. *)
296
297
val issn : t -> string option
298
-
(** International Standard Serial Number (for journals). *)
299
300
-
val pmcid : t -> string option
301
(** PubMed Central identifier. *)
302
303
-
val nihmsid : t -> string option
304
(** NIH Manuscript Submission System identifier. *)
305
306
val identifiers : t -> Cff_identifier.t list option
307
-
(** Additional typed identifiers (DOI, URL, SWH, other). *)
308
309
val is_empty : t -> bool
310
end
···
321
322
val empty : t
323
324
-
val make :
325
-
?editors:Cff_author.t list ->
326
-
?editors_series:Cff_author.t list ->
327
-
?translators:Cff_author.t list ->
328
-
?recipients:Cff_author.t list ->
329
-
?senders:Cff_author.t list ->
330
-
?contact:Cff_author.t list ->
331
-
?publisher:Cff_author.Entity.t ->
332
-
?institution:Cff_author.Entity.t ->
333
-
?conference:Cff_author.Entity.t ->
334
-
?database_provider:Cff_author.Entity.t ->
335
-
?location:Cff_author.Entity.t ->
336
-
unit -> t
337
338
-
val editors : t -> Cff_author.t list option
339
(** Editors of the work (for edited volumes). *)
340
341
val editors_series : t -> Cff_author.t list option
342
-
(** Series editors (for book series). *)
343
344
-
val translators : t -> Cff_author.t list option
345
(** Translators of the work. *)
346
347
-
val recipients : t -> Cff_author.t list option
348
(** Recipients (for personal communications). *)
349
350
val senders : t -> Cff_author.t list option
351
-
(** Senders (for personal communications). *)
352
353
-
val contact : t -> Cff_author.t list option
354
(** Contact persons for the work. *)
355
356
-
val publisher : t -> Cff_author.Entity.t option
357
(** Publishing organization. *)
358
359
val institution : t -> Cff_author.Entity.t option
360
-
(** Academic/research institution (for theses, reports). *)
361
362
-
val conference : t -> Cff_author.Entity.t option
363
(** Conference where the work was presented. *)
364
365
-
val database_provider : t -> Cff_author.Entity.t option
366
(** Provider of a database (for data references). *)
367
368
val location : t -> Cff_author.Entity.t option
369
-
(** Location entity (city, venue for conferences). *)
370
371
val is_empty : t -> bool
372
end
···
379
380
val empty : t
381
382
-
val make :
383
-
?keywords:string list ->
384
-
?languages:string list ->
385
-
?license:Cff_license.t ->
386
-
?license_url:string ->
387
-
?copyright:string ->
388
-
?scope:string ->
389
-
?notes:string ->
390
-
unit -> t
391
392
val keywords : t -> string list option
393
-
(** Descriptive keywords for the work. *)
394
395
-
val languages : t -> string list option
396
(** Languages the work is available in (ISO 639 codes). *)
397
398
val license : t -> Cff_license.t option
399
-
(** SPDX license identifier(s). *)
400
401
-
val license_url : t -> string option
402
-
(** URL to license text (for non-SPDX licenses). *)
403
-
404
val copyright : t -> string option
405
-
(** Copyright statement. *)
406
407
-
val scope : t -> string option
408
(** Scope of the reference (what aspect it covers). *)
409
410
val notes : t -> string option
411
-
(** Additional notes or comments. *)
412
413
val is_empty : t -> bool
414
end
···
426
427
val empty : t
428
429
-
val make :
430
-
?commit:string ->
431
-
?version:string ->
432
-
?filename:string ->
433
-
?format:string ->
434
-
?medium:string ->
435
-
?data_type:string ->
436
-
?database:string ->
437
-
?number:string ->
438
-
?patent_states:string list ->
439
-
?thesis_type:string ->
440
-
?term:string ->
441
-
?entry:string ->
442
-
?department:string ->
443
-
?loc_start:string ->
444
-
?loc_end:string ->
445
-
unit -> t
446
447
-
val commit : t -> string option
448
(** Git commit hash or VCS revision. *)
449
450
-
val version : t -> string option
451
(** Version string of the software/data. *)
452
453
-
val filename : t -> string option
454
(** Name of the file being referenced. *)
455
456
val format : t -> string option
457
-
(** Format of the work (e.g., ["PDF"], ["HTML"]). *)
458
459
val medium : t -> string option
460
-
(** Physical medium (e.g., ["CD-ROM"], ["print"]). *)
461
462
-
val data_type : t -> string option
463
(** Type of data (for datasets). *)
464
465
val database : t -> string option
466
-
(** Name of the database. *)
467
468
val number : t -> string option
469
-
(** Report/patent/standard number. *)
470
471
-
val patent_states : t -> string list option
472
(** Countries where a patent is held. *)
473
474
-
val thesis_type : t -> string option
475
(** Type of thesis (["PhD"], ["Master's"], etc.). *)
476
477
val term : t -> string option
478
-
(** Dictionary/encyclopedia term being referenced. *)
479
480
-
val entry : t -> string option
481
(** Encyclopedia entry name. *)
482
483
val department : t -> string option
484
-
(** Academic department (for theses). *)
485
486
val loc_start : t -> string option
487
-
(** Starting line/location in source code. *)
488
489
-
val loc_end : t -> string option
490
(** Ending line/location in source code. *)
491
492
val is_empty : t -> bool
493
end
···
497
(** The complete reference type combining all sub-records. *)
498
type t
499
500
-
val make :
501
-
core:Core.t ->
502
-
?publication:Publication.t ->
503
-
?collection:Collection.t ->
504
-
?dates:Dates.t ->
505
-
?identifiers:Identifiers.t ->
506
-
?entities:Entities.t ->
507
-
?metadata:Metadata.t ->
508
-
?technical:Technical.t ->
509
-
unit -> t
510
(** Construct a reference from sub-records.
511
512
Only [core] is required; other sub-records default to empty. *)
513
514
-
val make_simple :
515
-
type_:Cff_enums.Reference_type.t ->
516
-
title:string ->
517
-
authors:Cff_author.t list ->
518
-
?doi:string ->
519
-
?year:int ->
520
-
?journal:string ->
521
-
unit -> t
522
(** Convenience constructor for simple references.
523
524
Creates a reference with just the most common fields. Suitable
525
for quick article or software references. *)
526
527
(** {2 Sub-record Accessors} *)
528
529
-
val core : t -> Core.t
530
(** The core identity fields. *)
531
532
-
val publication : t -> Publication.t
533
(** Publication metadata (journal, volume, pages). *)
534
535
val collection : t -> Collection.t
536
-
(** Collection metadata (proceedings, book series). *)
537
538
-
val dates : t -> Dates.t
539
(** Date-related fields. *)
540
541
-
val identifiers : t -> Identifiers.t
542
(** Identifiers and links. *)
543
544
val entities : t -> Entities.t
545
-
(** Related entities (editors, publisher). *)
546
547
-
val metadata : t -> Metadata.t
548
(** Descriptive metadata (keywords, license). *)
549
550
-
val technical : t -> Technical.t
551
(** Technical fields (commit, version, format). *)
552
553
(** {2 Direct Accessors for Common Fields}
554
555
Convenience accessors that delegate to sub-records. *)
556
557
-
val type_ : t -> Cff_enums.Reference_type.t
558
(** Shortcut for [Core.type_ (core t)]. *)
559
560
-
val title : t -> string
561
(** Shortcut for [Core.title (core t)]. *)
562
563
-
val authors : t -> Cff_author.t list
564
(** Shortcut for [Core.authors (core t)]. *)
565
566
val doi : t -> string option
567
-
(** Shortcut for [Identifiers.doi (identifiers t)]. *)
568
569
-
val year : t -> int option
570
(** Shortcut for [Dates.year (dates t)]. *)
571
572
(** {1 Formatting and Codec} *)
573
574
-
val pp : Format.formatter -> t -> unit
575
(** Pretty-print a reference in a human-readable format. *)
576
577
val jsont : t Jsont.t
578
-
(** JSON/YAML codec for serialization. *)
···
1
(*---------------------------------------------------------------------------
2
+
Copyright (c) 2026 The ocaml-cff programmers. All rights reserved.
3
SPDX-License-Identifier: ISC
4
---------------------------------------------------------------------------*)
5
···
76
module Core : sig
77
type t
78
79
(** Create a core record.
80
81
@param type_ The reference type (article, book, software, etc.)
82
@param title The title of the work
83
@param authors List of persons and/or entities *)
84
+
val make
85
+
: type_:Cff_enums.Reference_type.t
86
+
-> title:string
87
+
-> authors:Cff_author.t list
88
+
-> ?abstract:string
89
+
-> ?abbreviation:string
90
+
-> unit
91
+
-> t
92
93
(** The reference type. Determines which other fields are applicable. *)
94
+
val type_ : t -> Cff_enums.Reference_type.t
95
96
(** The title of the referenced work. *)
97
+
val title : t -> string
98
99
+
(** The authors/creators of the work. *)
100
val authors : t -> Cff_author.t list
101
102
(** A description or abstract of the work. *)
103
+
val abstract : t -> string option
104
105
(** Abbreviated form of the title (e.g., for journal names). *)
106
+
val abbreviation : t -> string option
107
108
val pp : Format.formatter -> t -> unit
109
end
···
116
module Publication : sig
117
type t
118
119
(** Empty publication record with all fields as [None]. *)
120
+
val empty : t
121
122
+
val make
123
+
: ?journal:string
124
+
-> ?volume:string
125
+
-> ?issue:string
126
+
-> ?pages:string
127
+
-> ?start:string
128
+
-> ?end_:string
129
+
-> ?edition:string
130
+
-> ?section:string
131
+
-> ?status:Cff_enums.Status.t
132
+
-> unit
133
+
-> t
134
135
(** The name of the journal or magazine. *)
136
+
val journal : t -> string option
137
138
(** The volume number of the journal. *)
139
+
val volume : t -> string option
140
141
+
(** The issue number within the volume. *)
142
val issue : t -> string option
143
144
+
(** Page range (e.g., ["123-145"]). Alternative to [start]/[end_]. *)
145
val pages : t -> string option
146
147
(** Starting page number. *)
148
+
val start : t -> string option
149
150
+
(** Ending page number. *)
151
val end_ : t -> string option
152
153
+
(** The edition of the work (e.g., ["2nd edition"]). *)
154
val edition : t -> string option
155
156
(** The section of a work (e.g., newspaper section). *)
157
+
val section : t -> string option
158
159
(** Publication status: preprint, in-press, submitted, etc. *)
160
+
val status : t -> Cff_enums.Status.t option
161
162
+
(** [true] if all fields are [None]. *)
163
val is_empty : t -> bool
164
end
165
166
(** Collection metadata for works in edited volumes.
···
172
173
val empty : t
174
175
+
val make
176
+
: ?collection_title:string
177
+
-> ?collection_type:string
178
+
-> ?collection_doi:string
179
+
-> ?volume_title:string
180
+
-> ?number_volumes:string
181
+
-> unit
182
+
-> t
183
184
(** Title of the collection (proceedings, book series, etc.). *)
185
+
val collection_title : t -> string option
186
187
+
(** Type of collection (e.g., ["proceedings"], ["book series"]). *)
188
val collection_type : t -> string option
189
190
(** DOI of the collection itself (not the individual work). *)
191
+
val collection_doi : t -> string option
192
193
+
(** Title of the specific volume within a multi-volume collection. *)
194
val volume_title : t -> string option
195
196
(** Total number of volumes in the collection. *)
197
+
val number_volumes : t -> string option
198
199
val is_empty : t -> bool
200
end
···
214
215
val empty : t
216
217
+
val make
218
+
: ?date_accessed:Cff_date.t
219
+
-> ?date_downloaded:Cff_date.t
220
+
-> ?date_published:Cff_date.t
221
+
-> ?date_released:Cff_date.t
222
+
-> ?year:int
223
+
-> ?year_original:int
224
+
-> ?month:int
225
+
-> ?issue_date:string
226
+
-> unit
227
+
-> t
228
229
(** Date when an online resource was accessed for citation. *)
230
+
val date_accessed : t -> Cff_date.t option
231
232
(** Date when a resource was downloaded. *)
233
+
val date_downloaded : t -> Cff_date.t option
234
235
+
(** Formal publication date. *)
236
val date_published : t -> Cff_date.t option
237
238
(** Release date (typically for software). *)
239
+
val date_released : t -> Cff_date.t option
240
241
+
(** Publication year when full date is unknown. *)
242
val year : t -> int option
243
244
(** Year of original publication (for reprints, translations). *)
245
+
val year_original : t -> int option
246
247
+
(** Publication month (1-12) when only month/year is known. *)
248
val month : t -> int option
249
250
(** Issue date as a string (for periodicals with specific dates). *)
251
+
val issue_date : t -> string option
252
253
val is_empty : t -> bool
254
end
···
267
268
val empty : t
269
270
+
val make
271
+
: ?doi:string
272
+
-> ?url:string
273
+
-> ?repository:string
274
+
-> ?repository_code:string
275
+
-> ?repository_artifact:string
276
+
-> ?isbn:string
277
+
-> ?issn:string
278
+
-> ?pmcid:string
279
+
-> ?nihmsid:string
280
+
-> ?identifiers:Cff_identifier.t list
281
+
-> unit
282
+
-> t
283
284
+
(** Digital Object Identifier (e.g., ["10.1234/example"]). *)
285
val doi : t -> string option
286
287
(** URL where the work can be accessed. *)
288
+
val url : t -> string option
289
290
(** General repository URL. *)
291
+
val repository : t -> string option
292
293
+
(** Source code repository (GitHub, GitLab, etc.). *)
294
val repository_code : t -> string option
295
296
(** Built artifact repository (npm, PyPI, Docker Hub, etc.). *)
297
+
val repository_artifact : t -> string option
298
299
(** International Standard Book Number. *)
300
+
val isbn : t -> string option
301
302
+
(** International Standard Serial Number (for journals). *)
303
val issn : t -> string option
304
305
(** PubMed Central identifier. *)
306
+
val pmcid : t -> string option
307
308
(** NIH Manuscript Submission System identifier. *)
309
+
val nihmsid : t -> string option
310
311
+
(** Additional typed identifiers (DOI, URL, SWH, other). *)
312
val identifiers : t -> Cff_identifier.t list option
313
314
val is_empty : t -> bool
315
end
···
326
327
val empty : t
328
329
+
val make
330
+
: ?editors:Cff_author.t list
331
+
-> ?editors_series:Cff_author.t list
332
+
-> ?translators:Cff_author.t list
333
+
-> ?recipients:Cff_author.t list
334
+
-> ?senders:Cff_author.t list
335
+
-> ?contact:Cff_author.t list
336
+
-> ?publisher:Cff_author.Entity.t
337
+
-> ?institution:Cff_author.Entity.t
338
+
-> ?conference:Cff_author.Entity.t
339
+
-> ?database_provider:Cff_author.Entity.t
340
+
-> ?location:Cff_author.Entity.t
341
+
-> unit
342
+
-> t
343
344
(** Editors of the work (for edited volumes). *)
345
+
val editors : t -> Cff_author.t list option
346
347
+
(** Series editors (for book series). *)
348
val editors_series : t -> Cff_author.t list option
349
350
(** Translators of the work. *)
351
+
val translators : t -> Cff_author.t list option
352
353
(** Recipients (for personal communications). *)
354
+
val recipients : t -> Cff_author.t list option
355
356
+
(** Senders (for personal communications). *)
357
val senders : t -> Cff_author.t list option
358
359
(** Contact persons for the work. *)
360
+
val contact : t -> Cff_author.t list option
361
362
(** Publishing organization. *)
363
+
val publisher : t -> Cff_author.Entity.t option
364
365
+
(** Academic/research institution (for theses, reports). *)
366
val institution : t -> Cff_author.Entity.t option
367
368
(** Conference where the work was presented. *)
369
+
val conference : t -> Cff_author.Entity.t option
370
371
(** Provider of a database (for data references). *)
372
+
val database_provider : t -> Cff_author.Entity.t option
373
374
+
(** Location entity (city, venue for conferences). *)
375
val location : t -> Cff_author.Entity.t option
376
377
val is_empty : t -> bool
378
end
···
385
386
val empty : t
387
388
+
val make
389
+
: ?keywords:string list
390
+
-> ?languages:string list
391
+
-> ?license:Cff_license.t
392
+
-> ?copyright:string
393
+
-> ?scope:string
394
+
-> ?notes:string
395
+
-> unit
396
+
-> t
397
398
+
(** Descriptive keywords for the work. *)
399
val keywords : t -> string list option
400
401
(** Languages the work is available in (ISO 639 codes). *)
402
+
val languages : t -> string list option
403
404
+
(** SPDX license identifier(s), or unknown license with optional URL. *)
405
val license : t -> Cff_license.t option
406
407
+
(** Copyright statement. *)
408
val copyright : t -> string option
409
410
(** Scope of the reference (what aspect it covers). *)
411
+
val scope : t -> string option
412
413
+
(** Additional notes or comments. *)
414
val notes : t -> string option
415
416
val is_empty : t -> bool
417
end
···
429
430
val empty : t
431
432
+
val make
433
+
: ?commit:string
434
+
-> ?version:string
435
+
-> ?filename:string
436
+
-> ?format:string
437
+
-> ?medium:string
438
+
-> ?data_type:string
439
+
-> ?database:string
440
+
-> ?number:string
441
+
-> ?patent_states:string list
442
+
-> ?thesis_type:string
443
+
-> ?term:string
444
+
-> ?entry:string
445
+
-> ?department:string
446
+
-> ?loc_start:string
447
+
-> ?loc_end:string
448
+
-> unit
449
+
-> t
450
451
(** Git commit hash or VCS revision. *)
452
+
val commit : t -> string option
453
454
(** Version string of the software/data. *)
455
+
val version : t -> string option
456
457
(** Name of the file being referenced. *)
458
+
val filename : t -> string option
459
460
+
(** Format of the work (e.g., ["PDF"], ["HTML"]). *)
461
val format : t -> string option
462
463
+
(** Physical medium (e.g., ["CD-ROM"], ["print"]). *)
464
val medium : t -> string option
465
466
(** Type of data (for datasets). *)
467
+
val data_type : t -> string option
468
469
+
(** Name of the database. *)
470
val database : t -> string option
471
472
+
(** Report/patent/standard number. *)
473
val number : t -> string option
474
475
(** Countries where a patent is held. *)
476
+
val patent_states : t -> string list option
477
478
(** Type of thesis (["PhD"], ["Master's"], etc.). *)
479
+
val thesis_type : t -> string option
480
481
+
(** Dictionary/encyclopedia term being referenced. *)
482
val term : t -> string option
483
484
(** Encyclopedia entry name. *)
485
+
val entry : t -> string option
486
487
+
(** Academic department (for theses). *)
488
val department : t -> string option
489
490
+
(** Starting line/location in source code. *)
491
val loc_start : t -> string option
492
493
(** Ending line/location in source code. *)
494
+
val loc_end : t -> string option
495
496
val is_empty : t -> bool
497
end
···
501
(** The complete reference type combining all sub-records. *)
502
type t
503
504
(** Construct a reference from sub-records.
505
506
Only [core] is required; other sub-records default to empty. *)
507
+
val make
508
+
: core:Core.t
509
+
-> ?publication:Publication.t
510
+
-> ?collection:Collection.t
511
+
-> ?dates:Dates.t
512
+
-> ?identifiers:Identifiers.t
513
+
-> ?entities:Entities.t
514
+
-> ?metadata:Metadata.t
515
+
-> ?technical:Technical.t
516
+
-> unit
517
+
-> t
518
519
(** Convenience constructor for simple references.
520
521
Creates a reference with just the most common fields. Suitable
522
for quick article or software references. *)
523
+
val make_simple
524
+
: type_:Cff_enums.Reference_type.t
525
+
-> title:string
526
+
-> authors:Cff_author.t list
527
+
-> ?doi:string
528
+
-> ?year:int
529
+
-> ?journal:string
530
+
-> unit
531
+
-> t
532
533
(** {2 Sub-record Accessors} *)
534
535
(** The core identity fields. *)
536
+
val core : t -> Core.t
537
538
(** Publication metadata (journal, volume, pages). *)
539
+
val publication : t -> Publication.t
540
541
+
(** Collection metadata (proceedings, book series). *)
542
val collection : t -> Collection.t
543
544
(** Date-related fields. *)
545
+
val dates : t -> Dates.t
546
547
(** Identifiers and links. *)
548
+
val identifiers : t -> Identifiers.t
549
550
+
(** Related entities (editors, publisher). *)
551
val entities : t -> Entities.t
552
553
(** Descriptive metadata (keywords, license). *)
554
+
val metadata : t -> Metadata.t
555
556
(** Technical fields (commit, version, format). *)
557
+
val technical : t -> Technical.t
558
559
(** {2 Direct Accessors for Common Fields}
560
561
Convenience accessors that delegate to sub-records. *)
562
563
(** Shortcut for [Core.type_ (core t)]. *)
564
+
val type_ : t -> Cff_enums.Reference_type.t
565
566
(** Shortcut for [Core.title (core t)]. *)
567
+
val title : t -> string
568
569
(** Shortcut for [Core.authors (core t)]. *)
570
+
val authors : t -> Cff_author.t list
571
572
+
(** Shortcut for [Identifiers.doi (identifiers t)]. *)
573
val doi : t -> string option
574
575
(** Shortcut for [Dates.year (dates t)]. *)
576
+
val year : t -> int option
577
578
(** {1 Formatting and Codec} *)
579
580
(** Pretty-print a reference in a human-readable format. *)
581
+
val pp : Format.formatter -> t -> unit
582
583
+
(** JSON/YAML codec for serialization. *)
584
val jsont : t Jsont.t
+15
-5
lib_eio/cff_eio.ml
+15
-5
lib_eio/cff_eio.ml
···
1
(*---------------------------------------------------------------------------
2
-
Copyright (c) 2025 The ocaml-cff programmers. All rights reserved.
3
SPDX-License-Identifier: ISC
4
---------------------------------------------------------------------------*)
5
···
8
(* Custom error type for CFF parsing errors *)
9
type Eio.Exn.err += E of string
10
11
-
let () = Eio.Exn.register_pp (fun f -> function
12
-
| E msg -> Format.fprintf f "Cff %s" msg; true
13
| _ -> false)
14
15
let err msg = Eio.Exn.create (E msg)
16
···
19
match Yamlt.decode ~layout:true Cff.jsont reader with
20
| Ok cff -> cff
21
| Error msg -> raise (err msg)
22
23
let to_yaml_string t =
24
let buf = Buffer.create 1024 in
···
26
match Yamlt.encode ~format:Yamlt.Block Cff.jsont t ~eod:true writer with
27
| Ok () -> Buffer.contents buf
28
| Error msg -> raise (err msg)
29
30
let of_yaml_flow flow =
31
let reader = Bytesrw_eio.bytes_reader_of_flow flow in
32
match Yamlt.decode ~layout:true Cff.jsont reader with
33
| Ok cff -> cff
34
| Error msg -> raise (err msg)
35
36
let to_yaml_flow flow t =
37
let writer = Bytesrw_eio.bytes_writer_of_flow flow in
38
match Yamlt.encode ~format:Yamlt.Block Cff.jsont t ~eod:true writer with
39
| Ok () -> ()
40
| Error msg -> raise (err msg)
41
42
let of_file ~fs path =
43
let data = Eio.Path.load Eio.Path.(fs / path) in
44
-
try of_yaml_string data
45
-
with Eio.Exn.Io _ as ex ->
46
let bt = Printexc.get_raw_backtrace () in
47
Eio.Exn.reraise_with_context ex bt "parsing CFF file %S" path
48
49
let to_file ~fs path t =
50
let data = to_yaml_string t in
51
Eio.Path.save ~create:(`Or_truncate 0o644) Eio.Path.(fs / path) data
···
1
(*---------------------------------------------------------------------------
2
+
Copyright (c) 2026 The ocaml-cff programmers. All rights reserved.
3
SPDX-License-Identifier: ISC
4
---------------------------------------------------------------------------*)
5
···
8
(* Custom error type for CFF parsing errors *)
9
type Eio.Exn.err += E of string
10
11
+
let () =
12
+
Eio.Exn.register_pp (fun f -> function
13
+
| E msg ->
14
+
Format.fprintf f "Cff %s" msg;
15
+
true
16
| _ -> false)
17
+
;;
18
19
let err msg = Eio.Exn.create (E msg)
20
···
23
match Yamlt.decode ~layout:true Cff.jsont reader with
24
| Ok cff -> cff
25
| Error msg -> raise (err msg)
26
+
;;
27
28
let to_yaml_string t =
29
let buf = Buffer.create 1024 in
···
31
match Yamlt.encode ~format:Yamlt.Block Cff.jsont t ~eod:true writer with
32
| Ok () -> Buffer.contents buf
33
| Error msg -> raise (err msg)
34
+
;;
35
36
let of_yaml_flow flow =
37
let reader = Bytesrw_eio.bytes_reader_of_flow flow in
38
match Yamlt.decode ~layout:true Cff.jsont reader with
39
| Ok cff -> cff
40
| Error msg -> raise (err msg)
41
+
;;
42
43
let to_yaml_flow flow t =
44
let writer = Bytesrw_eio.bytes_writer_of_flow flow in
45
match Yamlt.encode ~format:Yamlt.Block Cff.jsont t ~eod:true writer with
46
| Ok () -> ()
47
| Error msg -> raise (err msg)
48
+
;;
49
50
let of_file ~fs path =
51
let data = Eio.Path.load Eio.Path.(fs / path) in
52
+
try of_yaml_string data with
53
+
| Eio.Exn.Io _ as ex ->
54
let bt = Printexc.get_raw_backtrace () in
55
Eio.Exn.reraise_with_context ex bt "parsing CFF file %S" path
56
+
;;
57
58
let to_file ~fs path t =
59
let data = to_yaml_string t in
60
Eio.Path.save ~create:(`Or_truncate 0o644) Eio.Path.(fs / path) data
61
+
;;
+10
-9
lib_eio/cff_eio.mli
+10
-9
lib_eio/cff_eio.mli
···
1
(*---------------------------------------------------------------------------
2
-
Copyright (c) 2025 The ocaml-cff programmers. All rights reserved.
3
SPDX-License-Identifier: ISC
4
---------------------------------------------------------------------------*)
5
···
28
Parsing and encoding errors are raised as {!Eio.Exn.Io} exceptions
29
with the error type {!E}. *)
30
31
-
type Eio.Exn.err += E of string
32
-
(** CFF parsing or encoding error. The string contains the error message. *)
33
34
(** {1 String Functions} *)
35
36
-
val of_yaml_string : string -> Cff.t
37
(** [of_yaml_string s] parses a CFF from YAML string [s].
38
39
@raise Eio.Exn.Io on parse error. *)
40
41
-
val to_yaml_string : Cff.t -> string
42
(** [to_yaml_string cff] serializes [cff] to a YAML string.
43
44
The output uses YAML block style for readability.
45
46
@raise Eio.Exn.Io on encoding error. *)
47
48
(** {1 Flow Functions} *)
49
50
-
val of_yaml_flow : _ Eio.Flow.source -> Cff.t
51
(** [of_yaml_flow flow] parses a CFF from an Eio source flow.
52
53
Reads directly from the flow using bytesrw-eio.
54
55
@raise Eio.Exn.Io on parse error. *)
56
57
-
val to_yaml_flow : _ Eio.Flow.sink -> Cff.t -> unit
58
(** [to_yaml_flow flow cff] serializes [cff] to an Eio sink flow.
59
60
Writes directly to the flow using bytesrw-eio.
61
62
@raise Eio.Exn.Io on encoding error. *)
63
64
(** {1 File Functions} *)
65
66
-
val of_file : fs:_ Eio.Path.t -> string -> Cff.t
67
(** [of_file ~fs path] reads and parses a [CITATION.cff] file.
68
69
@param fs The Eio filesystem (e.g., [Eio.Stdenv.fs env])
70
@param path Path to the CFF file
71
@raise Eio.Exn.Io if the file cannot be read or contains invalid CFF data.
72
The exception context includes the file path. *)
73
74
-
val to_file : fs:_ Eio.Path.t -> string -> Cff.t -> unit
75
(** [to_file ~fs path cff] writes [cff] to a file at [path].
76
77
Creates or overwrites the file.
···
79
@param fs The Eio filesystem (e.g., [Eio.Stdenv.fs env])
80
@param path Path to write the CFF file
81
@raise Eio.Exn.Io on I/O or encoding failure. *)
···
1
(*---------------------------------------------------------------------------
2
+
Copyright (c) 2026 The ocaml-cff programmers. All rights reserved.
3
SPDX-License-Identifier: ISC
4
---------------------------------------------------------------------------*)
5
···
28
Parsing and encoding errors are raised as {!Eio.Exn.Io} exceptions
29
with the error type {!E}. *)
30
31
+
type Eio.Exn.err +=
32
+
| E of string
33
+
(** CFF parsing or encoding error. The string contains the error message. *)
34
35
(** {1 String Functions} *)
36
37
(** [of_yaml_string s] parses a CFF from YAML string [s].
38
39
@raise Eio.Exn.Io on parse error. *)
40
+
val of_yaml_string : string -> Cff.t
41
42
(** [to_yaml_string cff] serializes [cff] to a YAML string.
43
44
The output uses YAML block style for readability.
45
46
@raise Eio.Exn.Io on encoding error. *)
47
+
val to_yaml_string : Cff.t -> string
48
49
(** {1 Flow Functions} *)
50
51
(** [of_yaml_flow flow] parses a CFF from an Eio source flow.
52
53
Reads directly from the flow using bytesrw-eio.
54
55
@raise Eio.Exn.Io on parse error. *)
56
+
val of_yaml_flow : _ Eio.Flow.source -> Cff.t
57
58
(** [to_yaml_flow flow cff] serializes [cff] to an Eio sink flow.
59
60
Writes directly to the flow using bytesrw-eio.
61
62
@raise Eio.Exn.Io on encoding error. *)
63
+
val to_yaml_flow : _ Eio.Flow.sink -> Cff.t -> unit
64
65
(** {1 File Functions} *)
66
67
(** [of_file ~fs path] reads and parses a [CITATION.cff] file.
68
69
@param fs The Eio filesystem (e.g., [Eio.Stdenv.fs env])
70
@param path Path to the CFF file
71
@raise Eio.Exn.Io if the file cannot be read or contains invalid CFF data.
72
The exception context includes the file path. *)
73
+
val of_file : fs:_ Eio.Path.t -> string -> Cff.t
74
75
(** [to_file ~fs path cff] writes [cff] to a file at [path].
76
77
Creates or overwrites the file.
···
79
@param fs The Eio filesystem (e.g., [Eio.Stdenv.fs env])
80
@param path Path to write the CFF file
81
@raise Eio.Exn.Io on I/O or encoding failure. *)
82
+
val to_file : fs:_ Eio.Path.t -> string -> Cff.t -> unit
+8
-4
lib_unix/cff_unix.ml
+8
-4
lib_unix/cff_unix.ml
···
1
(*---------------------------------------------------------------------------
2
-
Copyright (c) 2025 The ocaml-cff programmers. All rights reserved.
3
SPDX-License-Identifier: ISC
4
---------------------------------------------------------------------------*)
5
···
8
let of_yaml_string s =
9
let reader = Bytesrw.Bytes.Reader.of_string s in
10
Yamlt.decode ~layout:true Cff.jsont reader
11
12
let to_yaml_string t =
13
let buf = Buffer.create 1024 in
···
15
match Yamlt.encode ~format:Yamlt.Block Cff.jsont t ~eod:true writer with
16
| Ok () -> Ok (Buffer.contents buf)
17
| Error e -> Error e
18
19
let of_file path =
20
match In_channel.with_open_text path In_channel.input_all with
21
| s -> of_yaml_string s
22
| exception Sys_error e -> Error e
23
24
let to_file path t =
25
match to_yaml_string t with
26
| Error e -> Error e
27
| Ok s ->
28
-
match Out_channel.with_open_text path (fun oc -> Out_channel.output_string oc s) with
29
-
| () -> Ok ()
30
-
| exception Sys_error e -> Error e
···
1
(*---------------------------------------------------------------------------
2
+
Copyright (c) 2026 The ocaml-cff programmers. All rights reserved.
3
SPDX-License-Identifier: ISC
4
---------------------------------------------------------------------------*)
5
···
8
let of_yaml_string s =
9
let reader = Bytesrw.Bytes.Reader.of_string s in
10
Yamlt.decode ~layout:true Cff.jsont reader
11
+
;;
12
13
let to_yaml_string t =
14
let buf = Buffer.create 1024 in
···
16
match Yamlt.encode ~format:Yamlt.Block Cff.jsont t ~eod:true writer with
17
| Ok () -> Ok (Buffer.contents buf)
18
| Error e -> Error e
19
+
;;
20
21
let of_file path =
22
match In_channel.with_open_text path In_channel.input_all with
23
| s -> of_yaml_string s
24
| exception Sys_error e -> Error e
25
+
;;
26
27
let to_file path t =
28
match to_yaml_string t with
29
| Error e -> Error e
30
| Ok s ->
31
+
(match Out_channel.with_open_text path (fun oc -> Out_channel.output_string oc s) with
32
+
| () -> Ok ()
33
+
| exception Sys_error e -> Error e)
34
+
;;
+5
-5
lib_unix/cff_unix.mli
+5
-5
lib_unix/cff_unix.mli
···
1
(*---------------------------------------------------------------------------
2
-
Copyright (c) 2025 The ocaml-cff programmers. All rights reserved.
3
SPDX-License-Identifier: ISC
4
---------------------------------------------------------------------------*)
5
···
22
23
{1 Functions} *)
24
25
-
val of_yaml_string : string -> (Cff.t, string) result
26
(** [of_yaml_string s] parses a CFF from YAML string [s].
27
28
Returns [Ok cff] on success or [Error msg] with a descriptive error
29
message on failure. *)
30
31
-
val to_yaml_string : Cff.t -> (string, string) result
32
(** [to_yaml_string cff] serializes [cff] to a YAML string.
33
34
The output uses YAML block style for readability. *)
35
36
-
val of_file : string -> (Cff.t, string) result
37
(** [of_file path] reads and parses a [CITATION.cff] file.
38
39
Returns [Ok cff] on success or [Error msg] if the file cannot be
40
read or contains invalid CFF data. *)
41
42
-
val to_file : string -> Cff.t -> (unit, string) result
43
(** [to_file path cff] writes [cff] to a file at [path].
44
45
Creates or overwrites the file. Returns [Error msg] on I/O failure. *)
···
1
(*---------------------------------------------------------------------------
2
+
Copyright (c) 2026 The ocaml-cff programmers. All rights reserved.
3
SPDX-License-Identifier: ISC
4
---------------------------------------------------------------------------*)
5
···
22
23
{1 Functions} *)
24
25
(** [of_yaml_string s] parses a CFF from YAML string [s].
26
27
Returns [Ok cff] on success or [Error msg] with a descriptive error
28
message on failure. *)
29
+
val of_yaml_string : string -> (Cff.t, string) result
30
31
(** [to_yaml_string cff] serializes [cff] to a YAML string.
32
33
The output uses YAML block style for readability. *)
34
+
val to_yaml_string : Cff.t -> (string, string) result
35
36
(** [of_file path] reads and parses a [CITATION.cff] file.
37
38
Returns [Ok cff] on success or [Error msg] if the file cannot be
39
read or contains invalid CFF data. *)
40
+
val of_file : string -> (Cff.t, string) result
41
42
(** [to_file path cff] writes [cff] to a file at [path].
43
44
Creates or overwrites the file. Returns [Error msg] on I/O failure. *)
45
+
val to_file : string -> Cff.t -> (unit, string) result
+4
-2
test/dune
+4
-2
test/dune
···
2
(name test_cff)
3
(package cff)
4
(libraries cff cff.unix alcotest)
5
-
(deps (source_tree ../vendor/git/citation-file-format/examples)))
6
7
(test
8
(name test_cff_eio)
9
(package cff)
10
(libraries cff cff.eio alcotest eio_main)
11
-
(deps (source_tree ../vendor/git/citation-file-format/examples)))
···
2
(name test_cff)
3
(package cff)
4
(libraries cff cff.unix alcotest)
5
+
(deps
6
+
(source_tree ../vendor/git/citation-file-format/examples)))
7
8
(test
9
(name test_cff_eio)
10
(package cff)
11
(libraries cff cff.eio alcotest eio_main)
12
+
(deps
13
+
(source_tree ../vendor/git/citation-file-format/examples)))
+184
-153
test/test_cff.ml
+184
-153
test/test_cff.ml
···
1
(*---------------------------------------------------------------------------
2
-
Copyright (c) 2025 The ocaml-cff programmers. All rights reserved.
3
SPDX-License-Identifier: ISC
4
---------------------------------------------------------------------------*)
5
6
(* Test the CFF library by parsing upstream fixtures *)
7
8
-
let minimal_cff = {|
9
cff-version: 1.2.0
10
message: If you use this software in your work, please cite it using the following metadata
11
title: Ruby CFF Library
···
13
- family-names: Haines
14
given-names: Robert
15
|}
16
17
-
let simple_cff = {|
18
cff-version: 1.2.0
19
message: Please cite this software using these metadata.
20
title: My Research Software
···
26
doi: 10.5281/zenodo.1234567
27
date-released: 2021-08-11
28
|}
29
30
let test_parse_minimal () =
31
match Cff_unix.of_yaml_string minimal_cff with
···
33
Alcotest.(check string) "cff-version" "1.2.0" (Cff.cff_version cff);
34
Alcotest.(check string) "title" "Ruby CFF Library" (Cff.title cff);
35
Alcotest.(check int) "authors count" 1 (List.length (Cff.authors cff))
36
-
| Error e ->
37
-
Alcotest.fail (Printf.sprintf "Failed to parse minimal CFF: %s" e)
38
39
let test_parse_simple () =
40
match Cff_unix.of_yaml_string simple_cff with
···
47
| Some (2021, 8, 11) -> ()
48
| Some d -> Alcotest.fail (Printf.sprintf "Wrong date: %s" (Cff.Date.to_string d))
49
| None -> Alcotest.fail "Missing date-released")
50
-
| Error e ->
51
-
Alcotest.fail (Printf.sprintf "Failed to parse simple CFF: %s" e)
52
53
let test_create_programmatic () =
54
-
let author = Cff.Author.Person
55
-
(Cff.Person.make ~family_names:"Smith" ~given_names:"Jane" ()) in
56
-
let cff = Cff.make
57
-
~title:"My Software"
58
-
~authors:[author]
59
-
~version:"1.0.0"
60
-
() in
61
Alcotest.(check string) "cff-version" "1.2.0" (Cff.cff_version cff);
62
Alcotest.(check string) "title" "My Software" (Cff.title cff);
63
Alcotest.(check (option string)) "version" (Some "1.0.0") (Cff.version cff)
64
65
let test_roundtrip () =
66
match Cff_unix.of_yaml_string simple_cff with
67
| Error e -> Alcotest.fail (Printf.sprintf "Failed to parse: %s" e)
68
| Ok cff1 ->
69
-
match Cff_unix.to_yaml_string cff1 with
70
-
| Error e -> Alcotest.fail (Printf.sprintf "Failed to encode: %s" e)
71
-
| Ok yaml ->
72
-
match Cff_unix.of_yaml_string yaml with
73
-
| Error e -> Alcotest.fail (Printf.sprintf "Failed to reparse: %s" e)
74
-
| Ok cff2 ->
75
-
Alcotest.(check string) "title preserved" (Cff.title cff1) (Cff.title cff2);
76
-
Alcotest.(check string) "cff-version preserved" (Cff.cff_version cff1) (Cff.cff_version cff2)
77
78
let test_parse_key_complete () =
79
-
let path = "../vendor/git/citation-file-format/examples/1.2.0/pass/key-complete/CITATION.cff" in
80
match Cff_unix.of_file path with
81
| Ok cff ->
82
(* Check basic fields *)
···
84
Alcotest.(check string) "title" "Citation File Format 1.0.0" (Cff.title cff);
85
Alcotest.(check (option string)) "version" (Some "1.0.0") (Cff.version cff);
86
Alcotest.(check (option string)) "doi" (Some "10.5281/zenodo.1003150") (Cff.doi cff);
87
-
Alcotest.(check (option string)) "abstract"
88
-
(Some "This is an awesome piece of research software!") (Cff.abstract cff);
89
-
Alcotest.(check (option string)) "commit"
90
-
(Some "156a04c74a8a79d40c5d705cddf9d36735feab4d") (Cff.commit cff);
91
-
92
(* Check authors - should have 2 (1 person + 1 entity) *)
93
Alcotest.(check int) "authors count" 2 (List.length (Cff.authors cff));
94
-
95
(* Check first author is a Person *)
96
(match List.hd (Cff.authors cff) with
97
-
| Cff.Author.Person p ->
98
-
Alcotest.(check (option string)) "person family-names"
99
-
(Some "Real Person") (Cff.Person.family_names p);
100
-
Alcotest.(check (option string)) "person given-names"
101
-
(Some "One Truly") (Cff.Person.given_names p)
102
-
| Cff.Author.Entity _ -> Alcotest.fail "Expected Person, got Entity");
103
-
104
(* Check second author is an Entity *)
105
(match List.nth (Cff.authors cff) 1 with
106
-
| Cff.Author.Entity e ->
107
-
Alcotest.(check string) "entity name"
108
-
"Entity Project Team Conference entity" (Cff.Entity.name e)
109
-
| Cff.Author.Person _ -> Alcotest.fail "Expected Entity, got Person");
110
-
111
(* Check identifiers *)
112
(match Cff.identifiers cff with
113
-
| Some ids ->
114
-
Alcotest.(check int) "identifiers count" 4 (List.length ids)
115
| None -> Alcotest.fail "Expected identifiers");
116
-
117
(* Check keywords *)
118
(match Cff.keywords cff with
119
| Some kws ->
120
Alcotest.(check int) "keywords count" 4 (List.length kws);
121
Alcotest.(check string) "first keyword" "One" (List.hd kws)
122
| None -> Alcotest.fail "Expected keywords");
123
-
124
(* Check preferred-citation *)
125
(match Cff.preferred_citation cff with
126
| Some ref ->
127
-
Alcotest.(check string) "preferred-citation title" "Book Title" (Cff.Reference.title ref)
128
| None -> Alcotest.fail "Expected preferred-citation");
129
-
130
(* Check references *)
131
(match Cff.references cff with
132
-
| Some refs ->
133
-
Alcotest.(check int) "references count" 1 (List.length refs)
134
| None -> Alcotest.fail "Expected references")
135
-
| Error e ->
136
-
Alcotest.fail (Printf.sprintf "Failed to parse key-complete CFF: %s" e)
137
138
(* All 1.2.0 pass fixtures *)
139
(* Note: reference-article is skipped due to Yamlt parser limitation with
140
multi-line quoted strings (see issue with indentation in quoted scalars) *)
141
-
let pass_fixtures_1_2_0 = [
142
-
"bjmorgan/bsym";
143
-
"esalmela/haplowinder";
144
-
"key-complete";
145
-
"ls1mardyn/ls1-mardyn";
146
-
"minimal";
147
-
"poc";
148
-
"reference-art";
149
-
(* "reference-article"; -- skipped: Yamlt multi-line quoted string issue *)
150
-
"reference-blog";
151
-
"reference-book";
152
-
"reference-conference-paper";
153
-
"reference-edited-work";
154
-
"reference-report";
155
-
"reference-thesis";
156
-
"short";
157
-
"simple";
158
-
"software-container";
159
-
"software-executable";
160
-
"software-with-a-doi";
161
-
"software-with-a-doi-expanded";
162
-
"software-without-a-doi";
163
-
"software-without-a-doi-closed-source";
164
-
"software-with-reference";
165
-
"tue-excellent-buildings/bso-toolbox";
166
-
"xenon-middleware_xenon-adaptors-cloud";
167
-
]
168
169
let make_fixture_test name =
170
let test_name = String.map (fun c -> if c = '/' then '-' else c) name in
171
let test () =
172
-
let path = Printf.sprintf "../vendor/git/citation-file-format/examples/1.2.0/pass/%s/CITATION.cff" name in
173
match Cff_unix.of_file path with
174
| Ok cff ->
175
(* Basic sanity checks that apply to all valid CFF files *)
176
Alcotest.(check string) "cff-version" "1.2.0" (Cff.cff_version cff);
177
Alcotest.(check bool) "has title" true (String.length (Cff.title cff) > 0);
178
Alcotest.(check bool) "has authors" true (List.length (Cff.authors cff) > 0)
179
-
| Error e ->
180
-
Alcotest.fail (Printf.sprintf "Failed to parse %s: %s" name e)
181
in
182
Alcotest.test_case test_name `Quick test
183
184
(* License parsing tests *)
185
186
-
let cff_with_single_license = {|
187
cff-version: 1.2.0
188
message: Please cite
189
title: Test
···
191
- family-names: Test
192
license: MIT
193
|}
194
195
-
let cff_with_license_expression = {|
196
cff-version: 1.2.0
197
message: Please cite
198
title: Test
···
200
- family-names: Test
201
license: GPL-3.0-or-later WITH Classpath-exception-2.0
202
|}
203
204
-
let cff_with_license_array = {|
205
cff-version: 1.2.0
206
message: Please cite
207
title: Test
···
211
- Apache-2.0
212
- MIT
213
|}
214
215
-
let cff_with_unknown_license = {|
216
cff-version: 1.2.0
217
message: Please cite
218
title: Test
···
220
- family-names: Test
221
license: Some-Unknown-License-v1.0
222
|}
223
224
-
let cff_with_unknown_license_array = {|
225
cff-version: 1.2.0
226
message: Please cite
227
title: Test
···
231
- MIT
232
- Not-A-Real-License
233
|}
234
235
let test_license_single () =
236
match Cff_unix.of_yaml_string cff_with_single_license with
237
| Ok cff ->
238
(match Cff.license cff with
239
-
| Some (`Expr (Spdx_licenses.Simple (Spdx_licenses.LicenseID "MIT"))) -> ()
240
-
| Some (`Expr _) -> Alcotest.fail "Expected simple MIT license"
241
-
| Some (`Raw _) -> Alcotest.fail "License should have parsed as valid SPDX"
242
| None -> Alcotest.fail "Missing license")
243
-
| Error e ->
244
-
Alcotest.fail (Printf.sprintf "Failed to parse: %s" e)
245
246
let test_license_expression () =
247
match Cff_unix.of_yaml_string cff_with_license_expression with
248
| Ok cff ->
249
(match Cff.license cff with
250
-
| Some (`Expr (Spdx_licenses.WITH _)) -> ()
251
-
| Some (`Expr _) -> Alcotest.fail "Expected WITH expression"
252
-
| Some (`Raw _) -> Alcotest.fail "License should have parsed as valid SPDX"
253
| None -> Alcotest.fail "Missing license")
254
-
| Error e ->
255
-
Alcotest.fail (Printf.sprintf "Failed to parse: %s" e)
256
257
let test_license_array () =
258
match Cff_unix.of_yaml_string cff_with_license_array with
259
| Ok cff ->
260
(match Cff.license cff with
261
-
| Some (`Expr (Spdx_licenses.OR _)) -> ()
262
-
| Some (`Expr _) -> Alcotest.fail "Expected OR expression"
263
-
| Some (`Raw _) -> Alcotest.fail "License should have parsed as valid SPDX"
264
| None -> Alcotest.fail "Missing license")
265
-
| Error e ->
266
-
Alcotest.fail (Printf.sprintf "Failed to parse: %s" e)
267
268
let test_license_unknown () =
269
match Cff_unix.of_yaml_string cff_with_unknown_license with
270
| Ok cff ->
271
(match Cff.license cff with
272
-
| Some (`Raw ["Some-Unknown-License-v1.0"]) -> ()
273
-
| Some (`Raw ss) ->
274
-
Alcotest.fail (Printf.sprintf "Wrong raw value: [%s]" (String.concat "; " ss))
275
-
| Some (`Expr _) -> Alcotest.fail "Unknown license should be Raw, not Expr"
276
| None -> Alcotest.fail "Missing license")
277
-
| Error e ->
278
-
Alcotest.fail (Printf.sprintf "Failed to parse: %s" e)
279
280
let test_license_unknown_in_array () =
281
match Cff_unix.of_yaml_string cff_with_unknown_license_array with
282
| Ok cff ->
283
(match Cff.license cff with
284
-
| Some (`Raw ["MIT"; "Not-A-Real-License"]) -> ()
285
-
| Some (`Raw ss) ->
286
-
Alcotest.fail (Printf.sprintf "Wrong raw value: [%s]" (String.concat "; " ss))
287
-
| Some (`Expr _) -> Alcotest.fail "Array with unknown should be Raw"
288
| None -> Alcotest.fail "Missing license")
289
-
| Error e ->
290
-
Alcotest.fail (Printf.sprintf "Failed to parse: %s" e)
291
292
let test_license_unknown_roundtrip () =
293
match Cff_unix.of_yaml_string cff_with_unknown_license with
294
| Error e -> Alcotest.fail (Printf.sprintf "Failed to parse: %s" e)
295
| Ok cff1 ->
296
-
match Cff_unix.to_yaml_string cff1 with
297
-
| Error e -> Alcotest.fail (Printf.sprintf "Failed to encode: %s" e)
298
-
| Ok yaml ->
299
-
match Cff_unix.of_yaml_string yaml with
300
-
| Error e -> Alcotest.fail (Printf.sprintf "Failed to reparse: %s" e)
301
-
| Ok cff2 ->
302
-
(match Cff.license cff2 with
303
-
| Some (`Raw ["Some-Unknown-License-v1.0"]) -> ()
304
-
| Some (`Raw ss) ->
305
-
Alcotest.fail (Printf.sprintf "Roundtrip changed value: [%s]" (String.concat "; " ss))
306
-
| Some (`Expr _) -> Alcotest.fail "Roundtrip changed Raw to Expr"
307
-
| None -> Alcotest.fail "Roundtrip lost license")
308
309
(* Test that we correctly reject or handle known-invalid files *)
310
let test_fail_invalid_date () =
311
-
let path = "../vendor/git/citation-file-format/examples/1.2.0/fail/tue-excellent-buildings/bso-toolbox-invalid-date/CITATION.cff" in
312
match Cff_unix.of_file path with
313
| Ok _ ->
314
(* Our parser might be lenient - that's OK for now *)
···
316
| Error _ ->
317
(* Expected to fail due to invalid date "2020-05-xx" *)
318
()
319
320
(* Test fail fixture with additional key - should parse since we skip unknown *)
321
let test_fail_additional_key () =
322
-
let path = "../vendor/git/citation-file-format/examples/1.2.0/fail/additional-key/CITATION.cff" in
323
match Cff_unix.of_file path with
324
| Ok cff ->
325
(* Our parser is lenient and skips unknown keys *)
326
Alcotest.(check string) "title" "My Research Tool" (Cff.title cff)
327
| Error e ->
328
Alcotest.fail (Printf.sprintf "Should parse with unknown keys skipped: %s" e)
329
330
let () =
331
-
Alcotest.run "CFF" [
332
-
"parsing", [
333
-
Alcotest.test_case "minimal" `Quick test_parse_minimal;
334
-
Alcotest.test_case "simple" `Quick test_parse_simple;
335
-
Alcotest.test_case "key-complete" `Quick test_parse_key_complete;
336
-
];
337
-
"creation", [
338
-
Alcotest.test_case "programmatic" `Quick test_create_programmatic;
339
-
];
340
-
"roundtrip", [
341
-
Alcotest.test_case "simple roundtrip" `Quick test_roundtrip;
342
-
];
343
-
"license", [
344
-
Alcotest.test_case "single license" `Quick test_license_single;
345
-
Alcotest.test_case "license expression" `Quick test_license_expression;
346
-
Alcotest.test_case "license array" `Quick test_license_array;
347
-
Alcotest.test_case "unknown license" `Quick test_license_unknown;
348
-
Alcotest.test_case "unknown in array" `Quick test_license_unknown_in_array;
349
-
Alcotest.test_case "unknown roundtrip" `Quick test_license_unknown_roundtrip;
350
-
];
351
-
"1.2.0 fixtures", List.map make_fixture_test pass_fixtures_1_2_0;
352
-
"fail fixtures", [
353
-
Alcotest.test_case "invalid-date" `Quick test_fail_invalid_date;
354
-
Alcotest.test_case "additional-key" `Quick test_fail_additional_key;
355
-
];
356
-
]
···
1
(*---------------------------------------------------------------------------
2
+
Copyright (c) 2026 The ocaml-cff programmers. All rights reserved.
3
SPDX-License-Identifier: ISC
4
---------------------------------------------------------------------------*)
5
6
(* Test the CFF library by parsing upstream fixtures *)
7
8
+
let minimal_cff =
9
+
{|
10
cff-version: 1.2.0
11
message: If you use this software in your work, please cite it using the following metadata
12
title: Ruby CFF Library
···
14
- family-names: Haines
15
given-names: Robert
16
|}
17
+
;;
18
19
+
let simple_cff =
20
+
{|
21
cff-version: 1.2.0
22
message: Please cite this software using these metadata.
23
title: My Research Software
···
29
doi: 10.5281/zenodo.1234567
30
date-released: 2021-08-11
31
|}
32
+
;;
33
34
let test_parse_minimal () =
35
match Cff_unix.of_yaml_string minimal_cff with
···
37
Alcotest.(check string) "cff-version" "1.2.0" (Cff.cff_version cff);
38
Alcotest.(check string) "title" "Ruby CFF Library" (Cff.title cff);
39
Alcotest.(check int) "authors count" 1 (List.length (Cff.authors cff))
40
+
| Error e -> Alcotest.fail (Printf.sprintf "Failed to parse minimal CFF: %s" e)
41
+
;;
42
43
let test_parse_simple () =
44
match Cff_unix.of_yaml_string simple_cff with
···
51
| Some (2021, 8, 11) -> ()
52
| Some d -> Alcotest.fail (Printf.sprintf "Wrong date: %s" (Cff.Date.to_string d))
53
| None -> Alcotest.fail "Missing date-released")
54
+
| Error e -> Alcotest.fail (Printf.sprintf "Failed to parse simple CFF: %s" e)
55
+
;;
56
57
let test_create_programmatic () =
58
+
let author = Cff.Author.person ~family_names:"Smith" ~given_names:"Jane" () in
59
+
let cff = Cff.make ~title:"My Software" ~authors:[ author ] ~version:"1.0.0" () in
60
Alcotest.(check string) "cff-version" "1.2.0" (Cff.cff_version cff);
61
Alcotest.(check string) "title" "My Software" (Cff.title cff);
62
Alcotest.(check (option string)) "version" (Some "1.0.0") (Cff.version cff)
63
+
;;
64
65
let test_roundtrip () =
66
match Cff_unix.of_yaml_string simple_cff with
67
| Error e -> Alcotest.fail (Printf.sprintf "Failed to parse: %s" e)
68
| Ok cff1 ->
69
+
(match Cff_unix.to_yaml_string cff1 with
70
+
| Error e -> Alcotest.fail (Printf.sprintf "Failed to encode: %s" e)
71
+
| Ok yaml ->
72
+
(match Cff_unix.of_yaml_string yaml with
73
+
| Error e -> Alcotest.fail (Printf.sprintf "Failed to reparse: %s" e)
74
+
| Ok cff2 ->
75
+
Alcotest.(check string) "title preserved" (Cff.title cff1) (Cff.title cff2);
76
+
Alcotest.(check string)
77
+
"cff-version preserved"
78
+
(Cff.cff_version cff1)
79
+
(Cff.cff_version cff2)))
80
+
;;
81
82
let test_parse_key_complete () =
83
+
let path =
84
+
"../vendor/git/citation-file-format/examples/1.2.0/pass/key-complete/CITATION.cff"
85
+
in
86
match Cff_unix.of_file path with
87
| Ok cff ->
88
(* Check basic fields *)
···
90
Alcotest.(check string) "title" "Citation File Format 1.0.0" (Cff.title cff);
91
Alcotest.(check (option string)) "version" (Some "1.0.0") (Cff.version cff);
92
Alcotest.(check (option string)) "doi" (Some "10.5281/zenodo.1003150") (Cff.doi cff);
93
+
Alcotest.(check (option string))
94
+
"abstract"
95
+
(Some "This is an awesome piece of research software!")
96
+
(Cff.abstract cff);
97
+
Alcotest.(check (option string))
98
+
"commit"
99
+
(Some "156a04c74a8a79d40c5d705cddf9d36735feab4d")
100
+
(Cff.commit cff);
101
(* Check authors - should have 2 (1 person + 1 entity) *)
102
Alcotest.(check int) "authors count" 2 (List.length (Cff.authors cff));
103
(* Check first author is a Person *)
104
(match List.hd (Cff.authors cff) with
105
+
| `Person p ->
106
+
Alcotest.(check (option string))
107
+
"person family-names"
108
+
(Some "Real Person")
109
+
(Cff.Person.family_names p);
110
+
Alcotest.(check (option string))
111
+
"person given-names"
112
+
(Some "One Truly")
113
+
(Cff.Person.given_names p)
114
+
| `Entity _ -> Alcotest.fail "Expected Person, got Entity");
115
(* Check second author is an Entity *)
116
(match List.nth (Cff.authors cff) 1 with
117
+
| `Entity e ->
118
+
Alcotest.(check string)
119
+
"entity name"
120
+
"Entity Project Team Conference entity"
121
+
(Cff.Entity.name e)
122
+
| `Person _ -> Alcotest.fail "Expected Entity, got Person");
123
(* Check identifiers *)
124
(match Cff.identifiers cff with
125
+
| Some ids -> Alcotest.(check int) "identifiers count" 4 (List.length ids)
126
| None -> Alcotest.fail "Expected identifiers");
127
(* Check keywords *)
128
(match Cff.keywords cff with
129
| Some kws ->
130
Alcotest.(check int) "keywords count" 4 (List.length kws);
131
Alcotest.(check string) "first keyword" "One" (List.hd kws)
132
| None -> Alcotest.fail "Expected keywords");
133
(* Check preferred-citation *)
134
(match Cff.preferred_citation cff with
135
| Some ref ->
136
+
Alcotest.(check string)
137
+
"preferred-citation title"
138
+
"Book Title"
139
+
(Cff.Reference.title ref)
140
| None -> Alcotest.fail "Expected preferred-citation");
141
(* Check references *)
142
(match Cff.references cff with
143
+
| Some refs -> Alcotest.(check int) "references count" 1 (List.length refs)
144
| None -> Alcotest.fail "Expected references")
145
+
| Error e -> Alcotest.fail (Printf.sprintf "Failed to parse key-complete CFF: %s" e)
146
+
;;
147
148
(* All 1.2.0 pass fixtures *)
149
(* Note: reference-article is skipped due to Yamlt parser limitation with
150
multi-line quoted strings (see issue with indentation in quoted scalars) *)
151
+
let pass_fixtures_1_2_0 =
152
+
[ "bjmorgan/bsym"
153
+
; "esalmela/haplowinder"
154
+
; "key-complete"
155
+
; "ls1mardyn/ls1-mardyn"
156
+
; "minimal"
157
+
; "poc"
158
+
; "reference-art"
159
+
; (* "reference-article"; -- skipped: Yamlt multi-line quoted string issue *)
160
+
"reference-blog"
161
+
; "reference-book"
162
+
; "reference-conference-paper"
163
+
; "reference-edited-work"
164
+
; "reference-report"
165
+
; "reference-thesis"
166
+
; "short"
167
+
; "simple"
168
+
; "software-container"
169
+
; "software-executable"
170
+
; "software-with-a-doi"
171
+
; "software-with-a-doi-expanded"
172
+
; "software-without-a-doi"
173
+
; "software-without-a-doi-closed-source"
174
+
; "software-with-reference"
175
+
; "tue-excellent-buildings/bso-toolbox"
176
+
; "xenon-middleware_xenon-adaptors-cloud"
177
+
]
178
+
;;
179
180
let make_fixture_test name =
181
let test_name = String.map (fun c -> if c = '/' then '-' else c) name in
182
let test () =
183
+
let path =
184
+
Printf.sprintf
185
+
"../vendor/git/citation-file-format/examples/1.2.0/pass/%s/CITATION.cff"
186
+
name
187
+
in
188
match Cff_unix.of_file path with
189
| Ok cff ->
190
(* Basic sanity checks that apply to all valid CFF files *)
191
Alcotest.(check string) "cff-version" "1.2.0" (Cff.cff_version cff);
192
Alcotest.(check bool) "has title" true (String.length (Cff.title cff) > 0);
193
Alcotest.(check bool) "has authors" true (List.length (Cff.authors cff) > 0)
194
+
| Error e -> Alcotest.fail (Printf.sprintf "Failed to parse %s: %s" name e)
195
in
196
Alcotest.test_case test_name `Quick test
197
+
;;
198
199
(* License parsing tests *)
200
201
+
let cff_with_single_license =
202
+
{|
203
cff-version: 1.2.0
204
message: Please cite
205
title: Test
···
207
- family-names: Test
208
license: MIT
209
|}
210
+
;;
211
212
+
let cff_with_license_expression =
213
+
{|
214
cff-version: 1.2.0
215
message: Please cite
216
title: Test
···
218
- family-names: Test
219
license: GPL-3.0-or-later WITH Classpath-exception-2.0
220
|}
221
+
;;
222
223
+
let cff_with_license_array =
224
+
{|
225
cff-version: 1.2.0
226
message: Please cite
227
title: Test
···
231
- Apache-2.0
232
- MIT
233
|}
234
+
;;
235
236
+
let cff_with_unknown_license =
237
+
{|
238
cff-version: 1.2.0
239
message: Please cite
240
title: Test
···
242
- family-names: Test
243
license: Some-Unknown-License-v1.0
244
|}
245
+
;;
246
247
+
let cff_with_unknown_license_array =
248
+
{|
249
cff-version: 1.2.0
250
message: Please cite
251
title: Test
···
255
- MIT
256
- Not-A-Real-License
257
|}
258
+
;;
259
260
let test_license_single () =
261
match Cff_unix.of_yaml_string cff_with_single_license with
262
| Ok cff ->
263
(match Cff.license cff with
264
+
| Some (`Spdx (Spdx_licenses.Simple (Spdx_licenses.LicenseID "MIT"))) -> ()
265
+
| Some (`Spdx _) -> Alcotest.fail "Expected simple MIT license"
266
+
| Some (`Other _) -> Alcotest.fail "License should have parsed as valid SPDX"
267
| None -> Alcotest.fail "Missing license")
268
+
| Error e -> Alcotest.fail (Printf.sprintf "Failed to parse: %s" e)
269
+
;;
270
271
let test_license_expression () =
272
match Cff_unix.of_yaml_string cff_with_license_expression with
273
| Ok cff ->
274
(match Cff.license cff with
275
+
| Some (`Spdx (Spdx_licenses.WITH _)) -> ()
276
+
| Some (`Spdx _) -> Alcotest.fail "Expected WITH expression"
277
+
| Some (`Other _) -> Alcotest.fail "License should have parsed as valid SPDX"
278
| None -> Alcotest.fail "Missing license")
279
+
| Error e -> Alcotest.fail (Printf.sprintf "Failed to parse: %s" e)
280
+
;;
281
282
let test_license_array () =
283
match Cff_unix.of_yaml_string cff_with_license_array with
284
| Ok cff ->
285
(match Cff.license cff with
286
+
| Some (`Spdx (Spdx_licenses.OR _)) -> ()
287
+
| Some (`Spdx _) -> Alcotest.fail "Expected OR expression"
288
+
| Some (`Other _) -> Alcotest.fail "License should have parsed as valid SPDX"
289
| None -> Alcotest.fail "Missing license")
290
+
| Error e -> Alcotest.fail (Printf.sprintf "Failed to parse: %s" e)
291
+
;;
292
293
let test_license_unknown () =
294
match Cff_unix.of_yaml_string cff_with_unknown_license with
295
| Ok cff ->
296
(match Cff.license cff with
297
+
| Some (`Other ([ "Some-Unknown-License-v1.0" ], None)) -> ()
298
+
| Some (`Other (ss, _)) ->
299
+
Alcotest.fail (Printf.sprintf "Wrong value: [%s]" (String.concat "; " ss))
300
+
| Some (`Spdx _) -> Alcotest.fail "Unknown license should be Other, not Spdx"
301
| None -> Alcotest.fail "Missing license")
302
+
| Error e -> Alcotest.fail (Printf.sprintf "Failed to parse: %s" e)
303
+
;;
304
305
let test_license_unknown_in_array () =
306
match Cff_unix.of_yaml_string cff_with_unknown_license_array with
307
| Ok cff ->
308
(match Cff.license cff with
309
+
| Some (`Other ([ "MIT"; "Not-A-Real-License" ], None)) -> ()
310
+
| Some (`Other (ss, _)) ->
311
+
Alcotest.fail (Printf.sprintf "Wrong value: [%s]" (String.concat "; " ss))
312
+
| Some (`Spdx _) -> Alcotest.fail "Array with unknown should be Other"
313
| None -> Alcotest.fail "Missing license")
314
+
| Error e -> Alcotest.fail (Printf.sprintf "Failed to parse: %s" e)
315
+
;;
316
317
let test_license_unknown_roundtrip () =
318
match Cff_unix.of_yaml_string cff_with_unknown_license with
319
| Error e -> Alcotest.fail (Printf.sprintf "Failed to parse: %s" e)
320
| Ok cff1 ->
321
+
(match Cff_unix.to_yaml_string cff1 with
322
+
| Error e -> Alcotest.fail (Printf.sprintf "Failed to encode: %s" e)
323
+
| Ok yaml ->
324
+
(match Cff_unix.of_yaml_string yaml with
325
+
| Error e -> Alcotest.fail (Printf.sprintf "Failed to reparse: %s" e)
326
+
| Ok cff2 ->
327
+
(match Cff.license cff2 with
328
+
| Some (`Other ([ "Some-Unknown-License-v1.0" ], None)) -> ()
329
+
| Some (`Other (ss, _)) ->
330
+
Alcotest.fail
331
+
(Printf.sprintf "Roundtrip changed value: [%s]" (String.concat "; " ss))
332
+
| Some (`Spdx _) -> Alcotest.fail "Roundtrip changed Other to Spdx"
333
+
| None -> Alcotest.fail "Roundtrip lost license")))
334
+
;;
335
336
(* Test that we correctly reject or handle known-invalid files *)
337
let test_fail_invalid_date () =
338
+
let path =
339
+
"../vendor/git/citation-file-format/examples/1.2.0/fail/tue-excellent-buildings/bso-toolbox-invalid-date/CITATION.cff"
340
+
in
341
match Cff_unix.of_file path with
342
| Ok _ ->
343
(* Our parser might be lenient - that's OK for now *)
···
345
| Error _ ->
346
(* Expected to fail due to invalid date "2020-05-xx" *)
347
()
348
+
;;
349
350
(* Test fail fixture with additional key - should parse since we skip unknown *)
351
let test_fail_additional_key () =
352
+
let path =
353
+
"../vendor/git/citation-file-format/examples/1.2.0/fail/additional-key/CITATION.cff"
354
+
in
355
match Cff_unix.of_file path with
356
| Ok cff ->
357
(* Our parser is lenient and skips unknown keys *)
358
Alcotest.(check string) "title" "My Research Tool" (Cff.title cff)
359
| Error e ->
360
Alcotest.fail (Printf.sprintf "Should parse with unknown keys skipped: %s" e)
361
+
;;
362
363
let () =
364
+
Alcotest.run
365
+
"CFF"
366
+
[ ( "parsing"
367
+
, [ Alcotest.test_case "minimal" `Quick test_parse_minimal
368
+
; Alcotest.test_case "simple" `Quick test_parse_simple
369
+
; Alcotest.test_case "key-complete" `Quick test_parse_key_complete
370
+
] )
371
+
; "creation", [ Alcotest.test_case "programmatic" `Quick test_create_programmatic ]
372
+
; "roundtrip", [ Alcotest.test_case "simple roundtrip" `Quick test_roundtrip ]
373
+
; ( "license"
374
+
, [ Alcotest.test_case "single license" `Quick test_license_single
375
+
; Alcotest.test_case "license expression" `Quick test_license_expression
376
+
; Alcotest.test_case "license array" `Quick test_license_array
377
+
; Alcotest.test_case "unknown license" `Quick test_license_unknown
378
+
; Alcotest.test_case "unknown in array" `Quick test_license_unknown_in_array
379
+
; Alcotest.test_case "unknown roundtrip" `Quick test_license_unknown_roundtrip
380
+
] )
381
+
; "1.2.0 fixtures", List.map make_fixture_test pass_fixtures_1_2_0
382
+
; ( "fail fixtures"
383
+
, [ Alcotest.test_case "invalid-date" `Quick test_fail_invalid_date
384
+
; Alcotest.test_case "additional-key" `Quick test_fail_additional_key
385
+
] )
386
+
]
387
+
;;
+55
-24
test/test_cff_eio.ml
+55
-24
test/test_cff_eio.ml
···
1
(*---------------------------------------------------------------------------
2
-
Copyright (c) 2025 The ocaml-cff programmers. All rights reserved.
3
SPDX-License-Identifier: ISC
4
---------------------------------------------------------------------------*)
5
6
(* Test the CFF Eio backend *)
7
8
-
let minimal_cff = {|
9
cff-version: 1.2.0
10
message: If you use this software, please cite it
11
title: Test Software
···
13
- family-names: Smith
14
given-names: Jane
15
|}
16
17
-
let simple_cff = {|
18
cff-version: 1.2.0
19
message: Please cite this software using these metadata.
20
title: My Research Software
···
26
doi: 10.5281/zenodo.1234567
27
date-released: 2021-08-11
28
|}
29
30
let test_parse_string () =
31
let cff = Cff_eio.of_yaml_string minimal_cff in
32
Alcotest.(check string) "cff-version" "1.2.0" (Cff.cff_version cff);
33
Alcotest.(check string) "title" "Test Software" (Cff.title cff);
34
Alcotest.(check int) "authors count" 1 (List.length (Cff.authors cff))
35
36
let test_roundtrip_string () =
37
let cff1 = Cff_eio.of_yaml_string simple_cff in
38
let yaml = Cff_eio.to_yaml_string cff1 in
39
let cff2 = Cff_eio.of_yaml_string yaml in
40
Alcotest.(check string) "title preserved" (Cff.title cff1) (Cff.title cff2);
41
-
Alcotest.(check string) "cff-version preserved" (Cff.cff_version cff1) (Cff.cff_version cff2)
42
43
let test_parse_error () =
44
-
let invalid_yaml = {|
45
cff-version: 1.2.0
46
title: Missing authors field
47
-
|} in
48
match Cff_eio.of_yaml_string invalid_yaml with
49
| _ -> Alcotest.fail "Expected parse error"
50
| exception Eio.Exn.Io (Cff_eio.E _, _) -> ()
51
-
| exception ex -> Alcotest.fail (Printf.sprintf "Wrong exception type: %s" (Printexc.to_string ex))
52
53
let test_file_read env =
54
let fs = Eio.Stdenv.fs env in
55
-
let cff = Cff_eio.of_file ~fs "../vendor/git/citation-file-format/examples/1.2.0/pass/minimal/CITATION.cff" in
56
Alcotest.(check string) "cff-version" "1.2.0" (Cff.cff_version cff);
57
Alcotest.(check bool) "has title" true (String.length (Cff.title cff) > 0);
58
Alcotest.(check bool) "has authors" true (List.length (Cff.authors cff) > 0)
59
60
let test_file_not_found env =
61
let fs = Eio.Stdenv.fs env in
62
match Cff_eio.of_file ~fs "nonexistent_file.cff" with
63
| _ -> Alcotest.fail "Expected file not found error"
64
| exception Eio.Exn.Io _ -> ()
65
-
| exception ex -> Alcotest.fail (Printf.sprintf "Wrong exception type: %s" (Printexc.to_string ex))
66
67
let test_file_roundtrip env =
68
let fs = Eio.Stdenv.fs env in
69
-
let cff1 = Cff_eio.of_file ~fs "../vendor/git/citation-file-format/examples/1.2.0/pass/simple/CITATION.cff" in
70
let tmp_path = "_build/test_roundtrip.cff" in
71
Cff_eio.to_file ~fs tmp_path cff1;
72
let cff2 = Cff_eio.of_file ~fs tmp_path in
73
Alcotest.(check string) "title preserved" (Cff.title cff1) (Cff.title cff2);
74
-
Alcotest.(check string) "cff-version preserved" (Cff.cff_version cff1) (Cff.cff_version cff2)
75
76
let () =
77
-
Eio_main.run @@ fun env ->
78
-
Alcotest.run "CFF Eio" [
79
-
"string parsing", [
80
-
Alcotest.test_case "parse string" `Quick test_parse_string;
81
-
Alcotest.test_case "roundtrip string" `Quick test_roundtrip_string;
82
-
Alcotest.test_case "parse error" `Quick test_parse_error;
83
-
];
84
-
"file operations", [
85
-
Alcotest.test_case "read file" `Quick (fun () -> test_file_read env);
86
-
Alcotest.test_case "file not found" `Quick (fun () -> test_file_not_found env);
87
-
Alcotest.test_case "file roundtrip" `Quick (fun () -> test_file_roundtrip env);
88
-
];
89
-
]
···
1
(*---------------------------------------------------------------------------
2
+
Copyright (c) 2026 The ocaml-cff programmers. All rights reserved.
3
SPDX-License-Identifier: ISC
4
---------------------------------------------------------------------------*)
5
6
(* Test the CFF Eio backend *)
7
8
+
let minimal_cff =
9
+
{|
10
cff-version: 1.2.0
11
message: If you use this software, please cite it
12
title: Test Software
···
14
- family-names: Smith
15
given-names: Jane
16
|}
17
+
;;
18
19
+
let simple_cff =
20
+
{|
21
cff-version: 1.2.0
22
message: Please cite this software using these metadata.
23
title: My Research Software
···
29
doi: 10.5281/zenodo.1234567
30
date-released: 2021-08-11
31
|}
32
+
;;
33
34
let test_parse_string () =
35
let cff = Cff_eio.of_yaml_string minimal_cff in
36
Alcotest.(check string) "cff-version" "1.2.0" (Cff.cff_version cff);
37
Alcotest.(check string) "title" "Test Software" (Cff.title cff);
38
Alcotest.(check int) "authors count" 1 (List.length (Cff.authors cff))
39
+
;;
40
41
let test_roundtrip_string () =
42
let cff1 = Cff_eio.of_yaml_string simple_cff in
43
let yaml = Cff_eio.to_yaml_string cff1 in
44
let cff2 = Cff_eio.of_yaml_string yaml in
45
Alcotest.(check string) "title preserved" (Cff.title cff1) (Cff.title cff2);
46
+
Alcotest.(check string)
47
+
"cff-version preserved"
48
+
(Cff.cff_version cff1)
49
+
(Cff.cff_version cff2)
50
+
;;
51
52
let test_parse_error () =
53
+
let invalid_yaml =
54
+
{|
55
cff-version: 1.2.0
56
title: Missing authors field
57
+
|}
58
+
in
59
match Cff_eio.of_yaml_string invalid_yaml with
60
| _ -> Alcotest.fail "Expected parse error"
61
| exception Eio.Exn.Io (Cff_eio.E _, _) -> ()
62
+
| exception ex ->
63
+
Alcotest.fail (Printf.sprintf "Wrong exception type: %s" (Printexc.to_string ex))
64
+
;;
65
66
let test_file_read env =
67
let fs = Eio.Stdenv.fs env in
68
+
let cff =
69
+
Cff_eio.of_file
70
+
~fs
71
+
"../vendor/git/citation-file-format/examples/1.2.0/pass/minimal/CITATION.cff"
72
+
in
73
Alcotest.(check string) "cff-version" "1.2.0" (Cff.cff_version cff);
74
Alcotest.(check bool) "has title" true (String.length (Cff.title cff) > 0);
75
Alcotest.(check bool) "has authors" true (List.length (Cff.authors cff) > 0)
76
+
;;
77
78
let test_file_not_found env =
79
let fs = Eio.Stdenv.fs env in
80
match Cff_eio.of_file ~fs "nonexistent_file.cff" with
81
| _ -> Alcotest.fail "Expected file not found error"
82
| exception Eio.Exn.Io _ -> ()
83
+
| exception ex ->
84
+
Alcotest.fail (Printf.sprintf "Wrong exception type: %s" (Printexc.to_string ex))
85
+
;;
86
87
let test_file_roundtrip env =
88
let fs = Eio.Stdenv.fs env in
89
+
let cff1 =
90
+
Cff_eio.of_file
91
+
~fs
92
+
"../vendor/git/citation-file-format/examples/1.2.0/pass/simple/CITATION.cff"
93
+
in
94
let tmp_path = "_build/test_roundtrip.cff" in
95
Cff_eio.to_file ~fs tmp_path cff1;
96
let cff2 = Cff_eio.of_file ~fs tmp_path in
97
Alcotest.(check string) "title preserved" (Cff.title cff1) (Cff.title cff2);
98
+
Alcotest.(check string)
99
+
"cff-version preserved"
100
+
(Cff.cff_version cff1)
101
+
(Cff.cff_version cff2)
102
+
;;
103
104
let () =
105
+
Eio_main.run
106
+
@@ fun env ->
107
+
Alcotest.run
108
+
"CFF Eio"
109
+
[ ( "string parsing"
110
+
, [ Alcotest.test_case "parse string" `Quick test_parse_string
111
+
; Alcotest.test_case "roundtrip string" `Quick test_roundtrip_string
112
+
; Alcotest.test_case "parse error" `Quick test_parse_error
113
+
] )
114
+
; ( "file operations"
115
+
, [ Alcotest.test_case "read file" `Quick (fun () -> test_file_read env)
116
+
; Alcotest.test_case "file not found" `Quick (fun () -> test_file_not_found env)
117
+
; Alcotest.test_case "file roundtrip" `Quick (fun () -> test_file_roundtrip env)
118
+
] )
119
+
]
120
+
;;