comparing fe1e6e0b8db4f26e1eb6428b02e6c618014cc0cf and main on anil.recoil.org/ocaml-jsonfeed

.gitignore

···

       1
       1
        
       _build

     

       2
       2
        
       blog-feed.json

     

       3
       3
       +
       *.bak*

     

       4
       4
       +
       *.old

     

       5
       5
       +
       .*.swp

.ocamlformat

···

       1
       1
       +
       version=0.27.0

.tangled/workflows/build.yml

···

       26
       26
        
           - bzip2

     

       27
       27
        
           - gcc

     

       28
       28
        
           - ocaml

     

       29
       29
       +
           - pkg-config

     

       29
       30
        
       

     

       30
       31
        
       steps:

     

       31
       32
        
         - name: opam

+11

CHANGES.md

···

       1
       1
       +
       v1.1.0 (2025-11-12)

     

       2
       2
       +
       -------------------

     

       3
       3
       +
       

     

       4
       4
       +
       - Simplify round trip processing of unknown messages using Jsont combinators (@avsm).

     

       5
       5
       +
       - Relax alcotest version constraints (@avsm).

     

       6
       6
       +
       

     

       7
       7
       +
       v1.0.0 (2025-11-12)

     

       8
       8
       +
       -------------------

     

       9
       9
       +
       

     

       10
       10
       +
       - Initial public release (@avsm)

     

       11
       11
       +

+12 -2

README.md

···

       67
       67
        
             | Some title -> Printf.printf "- %s\n" title

     

       68
       68
        
             | None -> ()

     

       69
       69
        
           ) (Jsonfeed.items feed)

     

       70
       70
       -
       | Error (`Msg err) ->

     

       70
       70
       +
       | Error err ->

     

       71
       71
        
           Printf.eprintf "Parse error: %s\n" err

     

       72
       72
        
       

     

       73
       73
        
       (* Parse from file *)

     
···

       133
       133
        
       - **feed_example.ml** - Creating and serializing feeds (blog and podcast)

     

       134
       134
        
       - **feed_parser.ml** - Parsing and analyzing feeds from files

     

       135
       135
        
       - **feed_validator.ml** - Validating feeds and demonstrating various feed types

     

       136
       136
       +
       - **feed_echo.ml** - Round-trip parsing: reads a feed from stdin and outputs to stdout

     

       136
       137
        
       

     

       137
       138
        
       Run examples:

     

       138
       139
        
       

     

       139
       140
        
       ```bash

     

       140
       140
       -
       opam exec -- dune exec -- ./example/feed_parser.exe

     

       141
       141
       +
       # Create and display sample feeds

     

       141
       142
        
       opam exec -- dune exec -- ./example/feed_example.exe

     

       143
       143
       +
       

     

       144
       144
       +
       # Parse and analyze a feed file

     

       145
       145
       +
       opam exec -- dune exec -- ./example/feed_parser.exe path/to/feed.json

     

       146
       146
       +
       

     

       147
       147
       +
       # Validate feeds

     

       148
       148
       +
       opam exec -- dune exec -- ./example/feed_validator.exe

     

       149
       149
       +
       

     

       150
       150
       +
       # Test round-trip parsing

     

       151
       151
       +
       cat feed.json | opam exec -- dune exec -- ./example/feed_echo.exe

     

       142
       152
        
       ```

     

       143
       153
        
       

     

       144
       154
        
       ## API Documentation

+3 -3

dune-project

···

       21
       21
        
          and serialization using Jsonm and Ptime.")

     

       22
       22
        
        (depends

     

       23
       23
        
         (ocaml (>= 5.2.0))

     

       24
       24
       -
         (jsonm (>= 1.0.0))

     

       24
       24
       +
         (jsont (>= 0.2.0))

     

       25
       25
        
         (ptime (>= 1.2.0))

     

       26
       26
       -
         (fmt (>= 0.11.0))

     

       26
       26
       +
         bytesrw

     

       27
       27
        
         (odoc :with-doc)

     

       28
       28
       -
         (alcotest (and :with-test (>= 1.9.0)))))

     

       28
       28
       +
         (alcotest (and :with-test (>= 1.5.0)))))

example/dune

···

       12
       12
        
        (name feed_validator)

     

       13
       13
        
        (modules feed_validator)

     

       14
       14
        
        (libraries jsonfeed))

     

       15
       15
       +
       

     

       16
       16
       +
       (executable

     

       17
       17
       +
        (name feed_echo)

     

       18
       18
       +
        (modules feed_echo)

     

       19
       19
       +
        (libraries jsonfeed))

+33

example/feed_echo.ml

···

       1
       1
       +
       (** Example: JSON Feed Echo

     

       2
       2
       +
       

     

       3
       3
       +
           Reads a JSON Feed from stdin, parses it, and outputs it to stdout. Useful

     

       4
       4
       +
           for testing round-trip parsing and identifying any changes during

     

       5
       5
       +
           serialization/deserialization.

     

       6
       6
       +
       

     

       7
       7
       +
           Usage: feed_echo < feed.json cat feed.json | feed_echo > output.json diff

     

       8
       8
       +
           <(cat feed.json | feed_echo) feed.json

     

       9
       9
       +
       

     

       10
       10
       +
           Exit codes: 0 - Success 1 - Parsing or encoding failed *)

     

       11
       11
       +
       

     

       12
       12
       +
       let echo_feed () =

     

       13
       13
       +
         (* Create a bytesrw reader from stdin *)

     

       14
       14
       +
         let stdin = Bytesrw.Bytes.Reader.of_in_channel In_channel.stdin in

     

       15
       15
       +
       

     

       16
       16
       +
         (* Parse the JSON feed *)

     

       17
       17
       +
         match Jsonfeed.decode ~locs:true stdin with

     

       18
       18
       +
         | Error err ->

     

       19
       19
       +
             Format.eprintf "Parsing failed:\n  %s\n%!" (Jsont.Error.to_string err);

     

       20
       20
       +
             exit 1

     

       21
       21
       +
         | Ok feed -> (

     

       22
       22
       +
             (* Encode the feed back to stdout *)

     

       23
       23
       +
             match Jsonfeed.to_string ~minify:false feed with

     

       24
       24
       +
             | Error err ->

     

       25
       25
       +
                 Format.eprintf "Encoding failed:\n  %s\n%!"

     

       26
       26
       +
                   (Jsont.Error.to_string err);

     

       27
       27
       +
                 exit 1

     

       28
       28
       +
             | Ok json ->

     

       29
       29
       +
                 print_string json;

     

       30
       30
       +
                 print_newline ();

     

       31
       31
       +
                 exit 0)

     

       32
       32
       +
       

     

       33
       33
       +
       let () = echo_feed ()

+103 -105

example/feed_example.ml

···

       10
       10
        
       

     

       11
       11
        
       (* Helper to write feed to output channel *)

     

       12
       12
        
       let to_file filename feed =

     

       13
       13
       -
         let s = Jsonfeed.to_string feed in

     

       14
       14
       -
         Out_channel.with_open_gen

     

       15
       15
       -
           [Open_wronly; Open_creat; Open_trunc; Open_text]

     

       16
       16
       -
           0o644

     

       17
       17
       -
           filename

     

       18
       18
       -
           (fun oc -> Out_channel.output_string oc s)

     

       13
       13
       +
         match Jsonfeed.to_string feed with

     

       14
       14
       +
         | Ok s ->

     

       15
       15
       +
             Out_channel.with_open_gen

     

       16
       16
       +
               [ Open_wronly; Open_creat; Open_trunc; Open_text ] 0o644 filename

     

       17
       17
       +
               (fun oc -> Out_channel.output_string oc s)

     

       18
       18
       +
         | Error e ->

     

       19
       19
       +
             Printf.eprintf "Error encoding feed: %s\n" (Jsont.Error.to_string e);

     

       20
       20
       +
             exit 1

     

       19
       21
        
       

     

       20
       22
        
       let create_blog_feed () =

     

       21
       23
        
         (* Create some authors *)

     

       22
       22
       -
         let jane = Author.create

     

       23
       23
       -
           ~name:"Jane Doe"

     

       24
       24
       -
           ~url:"https://example.com/authors/jane"

     

       25
       25
       -
           ~avatar:"https://example.com/avatars/jane.png"

     

       26
       26
       -
           () in

     

       24
       24
       +
         let jane =

     

       25
       25
       +
           Author.create ~name:"Jane Doe" ~url:"https://example.com/authors/jane"

     

       26
       26
       +
             ~avatar:"https://example.com/avatars/jane.png" ()

     

       27
       27
       +
         in

     

       27
       28
        
       

     

       28
       28
       -
         let john = Author.create

     

       29
       29
       -
           ~name:"John Smith"

     

       30
       30
       -
           ~url:"https://example.com/authors/john"

     

       31
       31
       -
           () in

     

       29
       29
       +
         let john =

     

       30
       30
       +
           Author.create ~name:"John Smith" ~url:"https://example.com/authors/john" ()

     

       31
       31
       +
         in

     

       32
       32
        
       

     

       33
       33
        
         (* Create items with different content types *)

     

       34
       34
       -
         let item1 = Item.create

     

       35
       35
       -
           ~id:"https://example.com/posts/1"

     

       36
       36
       -
           ~url:"https://example.com/posts/1"

     

       37
       37
       -
           ~title:"Introduction to OCaml"

     

       38
       38
       -
           ~content:(`Both (

     

       39
       39
       -
             "<p>OCaml is a powerful functional programming language.</p>",

     

       40
       40
       -
             "OCaml is a powerful functional programming language."

     

       41
       41
       -
           ))

     

       42
       42
       -
           ~date_published:(Jsonfeed.parse_rfc3339 "2024-11-01T10:00:00Z" |> Option.get)

     

       43
       43
       -
           ~date_modified:(Jsonfeed.parse_rfc3339 "2024-11-01T15:30:00Z" |> Option.get)

     

       44
       44
       -
           ~authors:[jane]

     

       45
       45
       -
           ~tags:["ocaml"; "programming"; "functional"]

     

       46
       46
       -
           ~summary:"A beginner's guide to OCaml programming"

     

       47
       47
       -
           () in

     

       34
       34
       +
         let item1 =

     

       35
       35
       +
           Item.create ~id:"https://example.com/posts/1"

     

       36
       36
       +
             ~url:"https://example.com/posts/1" ~title:"Introduction to OCaml"

     

       37
       37
       +
             ~content:

     

       38
       38
       +
               (`Both

     

       39
       39
       +
                  ( "<p>OCaml is a powerful functional programming language.</p>",

     

       40
       40
       +
                    "OCaml is a powerful functional programming language." ))

     

       41
       41
       +
             ~date_published:

     

       42
       42
       +
               (Jsonfeed.Rfc3339.parse "2024-11-01T10:00:00Z" |> Option.get)

     

       43
       43
       +
             ~date_modified:

     

       44
       44
       +
               (Jsonfeed.Rfc3339.parse "2024-11-01T15:30:00Z" |> Option.get)

     

       45
       45
       +
             ~authors:[ jane ]

     

       46
       46
       +
             ~tags:[ "ocaml"; "programming"; "functional" ]

     

       47
       47
       +
             ~summary:"A beginner's guide to OCaml programming" ()

     

       48
       48
       +
         in

     

       48
       49
        
       

     

       49
       49
       -
         let item2 = Item.create

     

       50
       50
       -
           ~id:"https://example.com/posts/2"

     

       51
       51
       -
           ~url:"https://example.com/posts/2"

     

       52
       52
       -
           ~title:"JSON Feed for Syndication"

     

       53
       53
       -
           ~content:(`Html "<p>JSON Feed is a modern alternative to RSS and Atom.</p>")

     

       54
       54
       -
           ~date_published:(Jsonfeed.parse_rfc3339 "2024-11-02T09:00:00Z" |> Option.get)

     

       55
       55
       -
           ~authors:[jane; john]

     

       56
       56
       -
           ~tags:["json"; "syndication"; "web"]

     

       57
       57
       -
           ~image:"https://example.com/images/jsonfeed.png"

     

       58
       58
       -
           () in

     

       50
       50
       +
         let item2 =

     

       51
       51
       +
           Item.create ~id:"https://example.com/posts/2"

     

       52
       52
       +
             ~url:"https://example.com/posts/2" ~title:"JSON Feed for Syndication"

     

       53
       53
       +
             ~content:

     

       54
       54
       +
               (`Html "<p>JSON Feed is a modern alternative to RSS and Atom.</p>")

     

       55
       55
       +
             ~date_published:

     

       56
       56
       +
               (Jsonfeed.Rfc3339.parse "2024-11-02T09:00:00Z" |> Option.get)

     

       57
       57
       +
             ~authors:[ jane; john ]

     

       58
       58
       +
             ~tags:[ "json"; "syndication"; "web" ]

     

       59
       59
       +
             ~image:"https://example.com/images/jsonfeed.png" ()

     

       60
       60
       +
         in

     

       59
       61
        
       

     

       60
       62
        
         (* Microblog-style item (text only, no title) *)

     

       61
       61
       -
         let item3 = Item.create

     

       62
       62
       -
           ~id:"https://example.com/micro/42"

     

       63
       63
       -
           ~content:(`Text "Just shipped a new feature! 🚀")

     

       64
       64
       -
           ~date_published:(Jsonfeed.parse_rfc3339 "2024-11-03T08:15:00Z" |> Option.get)

     

       65
       65
       -
           ~tags:["microblog"]

     

       66
       66
       -
           () in

     

       63
       63
       +
         let item3 =

     

       64
       64
       +
           Item.create ~id:"https://example.com/micro/42"

     

       65
       65
       +
             ~content:(`Text "Just shipped a new feature! 🚀")

     

       66
       66
       +
             ~date_published:

     

       67
       67
       +
               (Jsonfeed.Rfc3339.parse "2024-11-03T08:15:00Z" |> Option.get)

     

       68
       68
       +
             ~tags:[ "microblog" ] ()

     

       69
       69
       +
         in

     

       67
       70
        
       

     

       68
       71
        
         (* Create the complete feed *)

     

       69
       69
       -
         let feed = Jsonfeed.create

     

       70
       70
       -
           ~title:"Example Blog"

     

       71
       71
       -
           ~home_page_url:"https://example.com"

     

       72
       72
       -
           ~feed_url:"https://example.com/feed.json"

     

       73
       73
       -
           ~description:"A blog about programming, web development, and technology"

     

       74
       74
       -
           ~icon:"https://example.com/icon-512.png"

     

       75
       75
       -
           ~favicon:"https://example.com/favicon-64.png"

     

       76
       76
       -
           ~authors:[jane; john]

     

       77
       77
       -
           ~language:"en-US"

     

       78
       78
       -
           ~items:[item1; item2; item3]

     

       79
       79
       -
           () in

     

       72
       72
       +
         let feed =

     

       73
       73
       +
           Jsonfeed.create ~title:"Example Blog" ~home_page_url:"https://example.com"

     

       74
       74
       +
             ~feed_url:"https://example.com/feed.json"

     

       75
       75
       +
             ~description:"A blog about programming, web development, and technology"

     

       76
       76
       +
             ~icon:"https://example.com/icon-512.png"

     

       77
       77
       +
             ~favicon:"https://example.com/favicon-64.png" ~authors:[ jane; john ]

     

       78
       78
       +
             ~language:"en-US" ~items:[ item1; item2; item3 ] ()

     

       79
       79
       +
         in

     

       80
       80
        
       

     

       81
       81
        
         feed

     

       82
       82
        
       

     

       83
       83
        
       let create_podcast_feed () =

     

       84
       84
        
         (* Create podcast author *)

     

       85
       85
       -
         let host = Author.create

     

       86
       86
       -
           ~name:"Podcast Host"

     

       87
       87
       -
           ~url:"https://podcast.example.com/host"

     

       88
       88
       -
           ~avatar:"https://podcast.example.com/host-avatar.jpg"

     

       89
       89
       -
           () in

     

       85
       85
       +
         let host =

     

       86
       86
       +
           Author.create ~name:"Podcast Host" ~url:"https://podcast.example.com/host"

     

       87
       87
       +
             ~avatar:"https://podcast.example.com/host-avatar.jpg" ()

     

       88
       88
       +
         in

     

       90
       89
        
       

     

       91
       90
        
         (* Create episode with audio attachment *)

     

       92
       92
       -
         let attachment = Attachment.create

     

       93
       93
       -
           ~url:"https://podcast.example.com/episodes/ep1.mp3"

     

       94
       94
       -
           ~mime_type:"audio/mpeg"

     

       95
       95
       -
           ~title:"Episode 1: Introduction"

     

       96
       96
       -
           ~size_in_bytes:15_728_640L

     

       97
       97
       -
           ~duration_in_seconds:1800

     

       98
       98
       -
           () in

     

       91
       91
       +
         let attachment =

     

       92
       92
       +
           Attachment.create ~url:"https://podcast.example.com/episodes/ep1.mp3"

     

       93
       93
       +
             ~mime_type:"audio/mpeg" ~title:"Episode 1: Introduction"

     

       94
       94
       +
             ~size_in_bytes:15_728_640L ~duration_in_seconds:1800 ()

     

       95
       95
       +
         in

     

       99
       96
        
       

     

       100
       100
       -
         let episode = Item.create

     

       101
       101
       -
           ~id:"https://podcast.example.com/episodes/1"

     

       102
       102
       -
           ~url:"https://podcast.example.com/episodes/1"

     

       103
       103
       -
           ~title:"Episode 1: Introduction"

     

       104
       104
       -
           ~content:(`Html "<p>Welcome to our first episode!</p>")

     

       105
       105
       -
           ~date_published:(Jsonfeed.parse_rfc3339 "2024-11-01T12:00:00Z" |> Option.get)

     

       106
       106
       -
           ~attachments:[attachment]

     

       107
       107
       -
           ~authors:[host]

     

       108
       108
       -
           ~image:"https://podcast.example.com/episodes/ep1-cover.jpg"

     

       109
       109
       -
           () in

     

       97
       97
       +
         let episode =

     

       98
       98
       +
           Item.create ~id:"https://podcast.example.com/episodes/1"

     

       99
       99
       +
             ~url:"https://podcast.example.com/episodes/1"

     

       100
       100
       +
             ~title:"Episode 1: Introduction"

     

       101
       101
       +
             ~content:(`Html "<p>Welcome to our first episode!</p>")

     

       102
       102
       +
             ~date_published:

     

       103
       103
       +
               (Jsonfeed.Rfc3339.parse "2024-11-01T12:00:00Z" |> Option.get)

     

       104
       104
       +
             ~attachments:[ attachment ] ~authors:[ host ]

     

       105
       105
       +
             ~image:"https://podcast.example.com/episodes/ep1-cover.jpg" ()

     

       106
       106
       +
         in

     

       110
       107
        
       

     

       111
       108
        
         (* Create podcast feed with hub for real-time updates *)

     

       112
       112
       -
         let hub = Hub.create

     

       113
       113
       -
           ~type_:"WebSub"

     

       114
       114
       -
           ~url:"https://pubsubhubbub.appspot.com/"

     

       115
       115
       -
           () in

     

       109
       109
       +
         let hub =

     

       110
       110
       +
           Hub.create ~type_:"WebSub" ~url:"https://pubsubhubbub.appspot.com/" ()

     

       111
       111
       +
         in

     

       116
       112
        
       

     

       117
       117
       -
         let feed = Jsonfeed.create

     

       118
       118
       -
           ~title:"Example Podcast"

     

       119
       119
       -
           ~home_page_url:"https://podcast.example.com"

     

       120
       120
       -
           ~feed_url:"https://podcast.example.com/feed.json"

     

       121
       121
       -
           ~description:"A podcast about interesting topics"

     

       122
       122
       -
           ~icon:"https://podcast.example.com/icon.png"

     

       123
       123
       -
           ~authors:[host]

     

       124
       124
       -
           ~language:"en-US"

     

       125
       125
       -
           ~hubs:[hub]

     

       126
       126
       -
           ~items:[episode]

     

       127
       127
       -
           () in

     

       113
       113
       +
         let feed =

     

       114
       114
       +
           Jsonfeed.create ~title:"Example Podcast"

     

       115
       115
       +
             ~home_page_url:"https://podcast.example.com"

     

       116
       116
       +
             ~feed_url:"https://podcast.example.com/feed.json"

     

       117
       117
       +
             ~description:"A podcast about interesting topics"

     

       118
       118
       +
             ~icon:"https://podcast.example.com/icon.png" ~authors:[ host ]

     

       119
       119
       +
             ~language:"en-US" ~hubs:[ hub ] ~items:[ episode ] ()

     

       120
       120
       +
         in

     

       128
       121
        
       

     

       129
       122
        
         feed

     

       130
       123
        
       

     
···

       134
       127
        
         Format.printf "Created blog feed: %a\n\n" Jsonfeed.pp blog_feed;

     

       135
       128
        
       

     

       136
       129
        
         (* Serialize to string *)

     

       137
       137
       -
         let json_string = Jsonfeed.to_string blog_feed in

     

       138
       138
       -
         Format.printf "JSON (first 200 chars): %s...\n\n"

     

       139
       139
       -
           (String.sub json_string 0 (min 200 (String.length json_string)));

     

       130
       130
       +
         (match Jsonfeed.to_string blog_feed with

     

       131
       131
       +
         | Ok json_string ->

     

       132
       132
       +
             Format.printf "JSON (first 200 chars): %s...\n\n"

     

       133
       133
       +
               (String.sub json_string 0 (min 200 (String.length json_string)))

     

       134
       134
       +
         | Error e ->

     

       135
       135
       +
             Printf.eprintf "Error serializing to string: %s\n"

     

       136
       136
       +
               (Jsont.Error.to_string e);

     

       137
       137
       +
             exit 1);

     

       140
       138
        
       

     

       141
       139
        
         (* Serialize to file *)

     

       142
       140
        
         to_file "blog-feed.json" blog_feed;

     
···

       148
       146
        
       

     

       149
       147
        
         (* Validate feeds *)

     

       150
       148
        
         (match Jsonfeed.validate blog_feed with

     

       151
       151
       -
          | Ok () -> Format.printf "✓ Blog feed is valid\n"

     

       152
       152
       -
          | Error errors ->

     

       153
       153
       -
              Format.printf "✗ Blog feed validation errors:\n";

     

       154
       154
       -
              List.iter (Format.printf "  - %s\n") errors);

     

       149
       149
       +
         | Ok () -> Format.printf "✓ Blog feed is valid\n"

     

       150
       150
       +
         | Error errors ->

     

       151
       151
       +
             Format.printf "✗ Blog feed validation errors:\n";

     

       152
       152
       +
             List.iter (Format.printf "  - %s\n") errors);

     

       155
       153
        
       

     

       156
       156
       -
         (match Jsonfeed.validate podcast_feed with

     

       157
       157
       -
          | Ok () -> Format.printf "✓ Podcast feed is valid\n"

     

       158
       158
       -
          | Error errors ->

     

       159
       159
       -
              Format.printf "✗ Podcast feed validation errors:\n";

     

       160
       160
       -
              List.iter (Format.printf "  - %s\n") errors)

     

       154
       154
       +
         match Jsonfeed.validate podcast_feed with

     

       155
       155
       +
         | Ok () -> Format.printf "✓ Podcast feed is valid\n"

     

       156
       156
       +
         | Error errors ->

     

       157
       157
       +
             Format.printf "✗ Podcast feed validation errors:\n";

     

       158
       158
       +
             List.iter (Format.printf "  - %s\n") errors

     

       161
       159
        
       

     

       162
       160
        
       let () = main ()

+90 -86

example/feed_parser.ml

···

       19
       19
        
         Format.printf "  Version: %s\n" (Jsonfeed.version feed);

     

       20
       20
        
       

     

       21
       21
        
         (match Jsonfeed.home_page_url feed with

     

       22
       22
       -
          | Some url -> Format.printf "  Home Page: %s\n" url

     

       23
       23
       -
          | None -> ());

     

       22
       22
       +
         | Some url -> Format.printf "  Home Page: %s\n" url

     

       23
       23
       +
         | None -> ());

     

       24
       24
        
       

     

       25
       25
        
         (match Jsonfeed.feed_url feed with

     

       26
       26
       -
          | Some url -> Format.printf "  Feed URL: %s\n" url

     

       27
       27
       -
          | None -> ());

     

       26
       26
       +
         | Some url -> Format.printf "  Feed URL: %s\n" url

     

       27
       27
       +
         | None -> ());

     

       28
       28
        
       

     

       29
       29
        
         (match Jsonfeed.description feed with

     

       30
       30
       -
          | Some desc -> Format.printf "  Description: %s\n" desc

     

       31
       31
       -
          | None -> ());

     

       30
       30
       +
         | Some desc -> Format.printf "  Description: %s\n" desc

     

       31
       31
       +
         | None -> ());

     

       32
       32
        
       

     

       33
       33
        
         (match Jsonfeed.language feed with

     

       34
       34
       -
          | Some lang -> Format.printf "  Language: %s\n" lang

     

       35
       35
       -
          | None -> ());

     

       34
       34
       +
         | Some lang -> Format.printf "  Language: %s\n" lang

     

       35
       35
       +
         | None -> ());

     

       36
       36
        
       

     

       37
       37
        
         (match Jsonfeed.authors feed with

     

       38
       38
       -
          | Some authors ->

     

       39
       39
       -
              Format.printf "  Authors:\n";

     

       40
       40
       -
              List.iter (fun author ->

     

       41
       41
       -
                match Author.name author with

     

       42
       42
       -
                | Some name -> Format.printf "    - %s" name;

     

       43
       43
       -
                    (match Author.url author with

     

       38
       38
       +
         | Some authors ->

     

       39
       39
       +
             Format.printf "  Authors:\n";

     

       40
       40
       +
             List.iter

     

       41
       41
       +
               (fun author ->

     

       42
       42
       +
                 match Author.name author with

     

       43
       43
       +
                 | Some name ->

     

       44
       44
       +
                     Format.printf "    - %s" name;

     

       45
       45
       +
                     (match Author.url author with

     

       44
       46
        
                     | Some url -> Format.printf " (%s)" url

     

       45
       47
        
                     | None -> ());

     

       46
       46
       -
                    Format.printf "\n"

     

       47
       47
       -
                | None -> ()

     

       48
       48
       -
              ) authors

     

       49
       49
       -
          | None -> ());

     

       48
       48
       +
                     Format.printf "\n"

     

       49
       49
       +
                 | None -> ())

     

       50
       50
       +
               authors

     

       51
       51
       +
         | None -> ());

     

       50
       52
        
       

     

       51
       53
        
         Format.printf "  Items: %d\n\n" (List.length (Jsonfeed.items feed))

     

       52
       54
        
       

     
···

       54
       56
        
         Format.printf "Item: %s\n" (Item.id item);

     

       55
       57
        
       

     

       56
       58
        
         (match Item.title item with

     

       57
       57
       -
          | Some title -> Format.printf "  Title: %s\n" title

     

       58
       58
       -
          | None -> Format.printf "  (No title - microblog entry)\n");

     

       59
       59
       +
         | Some title -> Format.printf "  Title: %s\n" title

     

       60
       60
       +
         | None -> Format.printf "  (No title - microblog entry)\n");

     

       59
       61
        
       

     

       60
       62
        
         (match Item.url item with

     

       61
       61
       -
          | Some url -> Format.printf "  URL: %s\n" url

     

       62
       62
       -
          | None -> ());

     

       63
       63
       +
         | Some url -> Format.printf "  URL: %s\n" url

     

       64
       64
       +
         | None -> ());

     

       63
       65
        
       

     

       64
       66
        
         (* Print content info *)

     

       65
       67
        
         (match Item.content item with

     

       66
       66
       -
          | `Html html ->

     

       67
       67
       -
              Format.printf "  Content: HTML only (%d chars)\n"

     

       68
       68
       -
                (String.length html)

     

       69
       69
       -
          | `Text text ->

     

       70
       70
       -
              Format.printf "  Content: Text only (%d chars)\n"

     

       71
       71
       -
                (String.length text)

     

       72
       72
       -
          | `Both (html, text) ->

     

       73
       73
       -
              Format.printf "  Content: Both HTML (%d chars) and Text (%d chars)\n"

     

       74
       74
       -
                (String.length html) (String.length text));

     

       68
       68
       +
         | `Html html ->

     

       69
       69
       +
             Format.printf "  Content: HTML only (%d chars)\n" (String.length html)

     

       70
       70
       +
         | `Text text ->

     

       71
       71
       +
             Format.printf "  Content: Text only (%d chars)\n" (String.length text)

     

       72
       72
       +
         | `Both (html, text) ->

     

       73
       73
       +
             Format.printf "  Content: Both HTML (%d chars) and Text (%d chars)\n"

     

       74
       74
       +
               (String.length html) (String.length text));

     

       75
       75
        
       

     

       76
       76
        
         (* Print dates *)

     

       77
       77
        
         (match Item.date_published item with

     

       78
       78
       -
          | Some date ->

     

       79
       79
       -
              Format.printf "  Published: %s\n"

     

       80
       80
       -
                (Jsonfeed.format_rfc3339 date)

     

       81
       81
       -
          | None -> ());

     

       78
       78
       +
         | Some date ->

     

       79
       79
       +
             Format.printf "  Published: %s\n" (Jsonfeed.Rfc3339.format date)

     

       80
       80
       +
         | None -> ());

     

       82
       81
        
       

     

       83
       82
        
         (match Item.date_modified item with

     

       84
       84
       -
          | Some date ->

     

       85
       85
       -
              Format.printf "  Modified: %s\n"

     

       86
       86
       -
                (Jsonfeed.format_rfc3339 date)

     

       87
       87
       -
          | None -> ());

     

       83
       83
       +
         | Some date -> Format.printf "  Modified: %s\n" (Jsonfeed.Rfc3339.format date)

     

       84
       84
       +
         | None -> ());

     

       88
       85
        
       

     

       89
       86
        
         (* Print tags *)

     

       90
       87
        
         (match Item.tags item with

     

       91
       91
       -
          | Some tags when tags <> [] ->

     

       92
       92
       -
              Format.printf "  Tags: %s\n" (String.concat ", " tags)

     

       93
       93
       -
          | _ -> ());

     

       88
       88
       +
         | Some tags when tags <> [] ->

     

       89
       89
       +
             Format.printf "  Tags: %s\n" (String.concat ", " tags)

     

       90
       90
       +
         | _ -> ());

     

       94
       91
        
       

     

       95
       92
        
         (* Print attachments *)

     

       96
       93
        
         (match Item.attachments item with

     

       97
       97
       -
          | Some attachments when attachments <> [] ->

     

       98
       98
       -
              Format.printf "  Attachments:\n";

     

       99
       99
       -
              List.iter (fun att ->

     

       100
       100
       -
                Format.printf "    - %s (%s)\n"

     

       101
       101
       -
                  (Attachment.url att)

     

       102
       102
       -
                  (Attachment.mime_type att);

     

       103
       103
       -
                (match Attachment.size_in_bytes att with

     

       94
       94
       +
         | Some attachments when attachments <> [] ->

     

       95
       95
       +
             Format.printf "  Attachments:\n";

     

       96
       96
       +
             List.iter

     

       97
       97
       +
               (fun att ->

     

       98
       98
       +
                 Format.printf "    - %s (%s)\n" (Attachment.url att)

     

       99
       99
       +
                   (Attachment.mime_type att);

     

       100
       100
       +
                 (match Attachment.size_in_bytes att with

     

       104
       101
        
                 | Some size ->

     

       105
       102
        
                     let mb = Int64.to_float size /. (1024. *. 1024.) in

     

       106
       103
        
                     Format.printf "      Size: %.2f MB\n" mb

     

       107
       104
        
                 | None -> ());

     

       108
       108
       -
                (match Attachment.duration_in_seconds att with

     

       105
       105
       +
                 match Attachment.duration_in_seconds att with

     

       109
       106
        
                 | Some duration ->

     

       110
       107
        
                     let mins = duration / 60 in

     

       111
       108
        
                     let secs = duration mod 60 in

     

       112
       109
        
                     Format.printf "      Duration: %dm%ds\n" mins secs

     

       113
       110
        
                 | None -> ())

     

       114
       114
       -
              ) attachments

     

       115
       115
       -
          | _ -> ());

     

       111
       111
       +
               attachments

     

       112
       112
       +
         | _ -> ());

     

       116
       113
        
       

     

       117
       114
        
         Format.printf "\n"

     

       118
       115
        
       

     
···

       126
       123
        
         let text_only = ref 0 in

     

       127
       124
        
         let both = ref 0 in

     

       128
       125
        
       

     

       129
       129
       -
         List.iter (fun item ->

     

       130
       130
       -
           match Item.content item with

     

       131
       131
       -
           | `Html _ -> incr html_only

     

       132
       132
       -
           | `Text _ -> incr text_only

     

       133
       133
       -
           | `Both _ -> incr both

     

       134
       134
       -
         ) items;

     

       126
       126
       +
         List.iter

     

       127
       127
       +
           (fun item ->

     

       128
       128
       +
             match Item.content item with

     

       129
       129
       +
             | `Html _ -> incr html_only

     

       130
       130
       +
             | `Text _ -> incr text_only

     

       131
       131
       +
             | `Both _ -> incr both)

     

       132
       132
       +
           items;

     

       135
       133
        
       

     

       136
       134
        
         Format.printf "Content Types:\n";

     

       137
       135
        
         Format.printf "  HTML only: %d\n" !html_only;

     
···

       139
       137
        
         Format.printf "  Both: %d\n\n" !both;

     

       140
       138
        
       

     

       141
       139
        
         (* Find items with attachments *)

     

       142
       142
       -
         let with_attachments = List.filter (fun item ->

     

       143
       143
       -
           match Item.attachments item with

     

       144
       144
       -
           | Some att when att <> [] -> true

     

       145
       145
       -
           | _ -> false

     

       146
       146
       -
         ) items in

     

       140
       140
       +
         let with_attachments =

     

       141
       141
       +
           List.filter

     

       142
       142
       +
             (fun item ->

     

       143
       143
       +
               match Item.attachments item with

     

       144
       144
       +
               | Some att when att <> [] -> true

     

       145
       145
       +
               | _ -> false)

     

       146
       146
       +
             items

     

       147
       147
       +
         in

     

       147
       148
        
       

     

       148
       149
        
         Format.printf "Items with attachments: %d\n\n" (List.length with_attachments);

     

       149
       150
        
       

     

       150
       151
        
         (* Collect all unique tags *)

     

       151
       151
       -
         let all_tags = List.fold_left (fun acc item ->

     

       152
       152
       -
           match Item.tags item with

     

       153
       153
       -
           | Some tags -> acc @ tags

     

       154
       154
       -
           | None -> acc

     

       155
       155
       -
         ) [] items in

     

       152
       152
       +
         let all_tags =

     

       153
       153
       +
           List.fold_left

     

       154
       154
       +
             (fun acc item ->

     

       155
       155
       +
               match Item.tags item with Some tags -> acc @ tags | None -> acc)

     

       156
       156
       +
             [] items

     

       157
       157
       +
         in

     

       156
       158
        
         let unique_tags = List.sort_uniq String.compare all_tags in

     

       157
       159
        
       

     

       158
       158
       -
         if unique_tags <> [] then (

     

       160
       160
       +
         if unique_tags <> [] then

     

       159
       161
        
           Format.printf "All tags used: %s\n\n" (String.concat ", " unique_tags)

     

       160
       160
       -
         )

     

       161
       162
        
       

     

       162
       163
        
       let main () =

     

       163
       164
        
         (* Parse from example_feed.json file *)

     

       164
       165
        
         Format.printf "=== Parsing JSON Feed from example_feed.json ===\n\n";

     

       165
       166
        
       

     

       166
       166
       -
         (try

     

       167
       167
       +
         try

     

       167
       168
        
           match of_file "example/example_feed.json" with

     

       168
       168
       -
           | Ok feed ->

     

       169
       169
       +
           | Ok feed -> (

     

       169
       170
        
               print_feed_info feed;

     

       170
       171
        
       

     

       171
       172
        
               Format.printf "=== Items ===\n\n";

     
···

       175
       176
        
       

     

       176
       177
        
               (* Demonstrate round-trip parsing *)

     

       177
       178
        
               Format.printf "\n=== Round-trip Test ===\n\n";

     

       178
       178
       -
               let json = Jsonfeed.to_string feed in

     

       179
       179
       -
               (match Jsonfeed.of_string json with

     

       180
       180
       -
                | Ok feed2 ->

     

       181
       181
       -
                    if Jsonfeed.equal feed feed2 then

     

       182
       182
       -
                      Format.printf "✓ Round-trip successful: feeds are equal\n"

     

       183
       183
       -
                    else

     

       184
       184
       -
                      Format.printf "✗ Round-trip failed: feeds differ\n"

     

       185
       185
       -
                | Error (`Msg err) ->

     

       186
       186
       -
                    Format.eprintf "✗ Round-trip failed: %s\n" err)

     

       187
       187
       -
           | Error (`Msg err) ->

     

       188
       188
       -
               Format.eprintf "Error parsing feed: %s\n" err

     

       189
       189
       -
         with

     

       190
       190
       -
          | Sys_error msg ->

     

       191
       191
       -
              Format.eprintf "Error reading file: %s\n" msg)

     

       179
       179
       +
               match Jsonfeed.to_string feed with

     

       180
       180
       +
               | Error e ->

     

       181
       181
       +
                   Printf.eprintf "Error serializing feed: %s\n"

     

       182
       182
       +
                     (Jsont.Error.to_string e);

     

       183
       183
       +
                   exit 1

     

       184
       184
       +
               | Ok json -> (

     

       185
       185
       +
                   match Jsonfeed.of_string json with

     

       186
       186
       +
                   | Ok feed2 ->

     

       187
       187
       +
                       if Jsonfeed.equal feed feed2 then

     

       188
       188
       +
                         Format.printf "✓ Round-trip successful: feeds are equal\n"

     

       189
       189
       +
                       else Format.printf "✗ Round-trip failed: feeds differ\n"

     

       190
       190
       +
                   | Error err ->

     

       191
       191
       +
                       Format.eprintf "✗ Round-trip failed: %s\n"

     

       192
       192
       +
                         (Jsont.Error.to_string err)))

     

       193
       193
       +
           | Error err ->

     

       194
       194
       +
               Format.eprintf "Error parsing feed: %s\n" (Jsont.Error.to_string err)

     

       195
       195
       +
         with Sys_error msg -> Format.eprintf "Error reading file: %s\n" msg

     

       192
       196
        
       

     

       193
       197
        
       let () = main ()

+28 -298

example/feed_validator.ml

···

       1
       1
       -
       (** Example: Validating JSON Feeds

     

       2
       2
       -
       

     

       3
       3
       -
           This demonstrates:

     

       4
       4
       -
           - Validating feed structure

     

       5
       5
       -
           - Testing various edge cases

     

       6
       6
       -
           - Handling invalid feeds

     

       7
       7
       -
           - Best practices for feed construction *)

     

       8
       8
       -
       

     

       9
       9
       -
       open Jsonfeed

     

       10
       10
       -
       

     

       11
       11
       -
       let test_valid_minimal_feed () =

     

       12
       12
       -
         Format.printf "=== Test: Minimal Valid Feed ===\n";

     

       13
       13
       -
       

     

       14
       14
       -
         let feed = Jsonfeed.create

     

       15
       15
       -
           ~title:"Minimal Feed"

     

       16
       16
       -
           ~items:[]

     

       17
       17
       -
           () in

     

       18
       18
       -
       

     

       19
       19
       -
         match Jsonfeed.validate feed with

     

       20
       20
       -
         | Ok () -> Format.printf "✓ Minimal feed is valid\n\n"

     

       21
       21
       -
         | Error errors ->

     

       22
       22
       -
             Format.printf "✗ Minimal feed validation failed:\n";

     

       23
       23
       -
             List.iter (Format.printf "  - %s\n") errors;

     

       24
       24
       -
             Format.printf "\n"

     

       25
       25
       -
       

     

       26
       26
       -
       let test_valid_complete_feed () =

     

       27
       27
       -
         Format.printf "=== Test: Complete Valid Feed ===\n";

     

       28
       28
       -
       

     

       29
       29
       -
         let author = Author.create

     

       30
       30
       -
           ~name:"Test Author"

     

       31
       31
       -
           ~url:"https://example.com/author"

     

       32
       32
       -
           ~avatar:"https://example.com/avatar.png"

     

       33
       33
       -
           () in

     

       34
       34
       -
       

     

       35
       35
       -
         let attachment = Attachment.create

     

       36
       36
       -
           ~url:"https://example.com/file.mp3"

     

       37
       37
       -
           ~mime_type:"audio/mpeg"

     

       38
       38
       -
           ~title:"Audio File"

     

       39
       39
       -
           ~size_in_bytes:1024L

     

       40
       40
       -
           ~duration_in_seconds:60

     

       41
       41
       -
           () in

     

       42
       42
       -
       

     

       43
       43
       -
         let item = Item.create

     

       44
       44
       -
           ~id:"https://example.com/items/1"

     

       45
       45
       -
           ~url:"https://example.com/items/1"

     

       46
       46
       -
           ~title:"Test Item"

     

       47
       47
       -
           ~content:(`Both ("<p>HTML content</p>", "Text content"))

     

       48
       48
       -
           ~summary:"A test item"

     

       49
       49
       -
           ~image:"https://example.com/image.jpg"

     

       50
       50
       -
           ~banner_image:"https://example.com/banner.jpg"

     

       51
       51
       -
           ~date_published:(Jsonfeed.parse_rfc3339 "2024-11-01T10:00:00Z" |> Option.get)

     

       52
       52
       -
           ~date_modified:(Jsonfeed.parse_rfc3339 "2024-11-01T15:00:00Z" |> Option.get)

     

       53
       53
       -
           ~authors:[author]

     

       54
       54
       -
           ~tags:["test"; "example"]

     

       55
       55
       -
           ~language:"en"

     

       56
       56
       -
           ~attachments:[attachment]

     

       57
       57
       -
           () in

     

       58
       58
       -
       

     

       59
       59
       -
         let hub = Hub.create

     

       60
       60
       -
           ~type_:"WebSub"

     

       61
       61
       -
           ~url:"https://pubsubhubbub.appspot.com/"

     

       62
       62
       -
           () in

     

       63
       63
       -
       

     

       64
       64
       -
         let feed = Jsonfeed.create

     

       65
       65
       -
           ~title:"Complete Feed"

     

       66
       66
       -
           ~home_page_url:"https://example.com"

     

       67
       67
       -
           ~feed_url:"https://example.com/feed.json"

     

       68
       68
       -
           ~description:"A complete test feed"

     

       69
       69
       -
           ~user_comment:"This is a test feed"

     

       70
       70
       -
           ~icon:"https://example.com/icon.png"

     

       71
       71
       -
           ~favicon:"https://example.com/favicon.ico"

     

       72
       72
       -
           ~authors:[author]

     

       73
       73
       -
           ~language:"en-US"

     

       74
       74
       -
           ~hubs:[hub]

     

       75
       75
       -
           ~items:[item]

     

       76
       76
       -
           () in

     

       77
       77
       -
       

     

       78
       78
       -
         match Jsonfeed.validate feed with

     

       79
       79
       -
         | Ok () -> Format.printf "✓ Complete feed is valid\n\n"

     

       80
       80
       -
         | Error errors ->

     

       81
       81
       -
             Format.printf "✗ Complete feed validation failed:\n";

     

       82
       82
       -
             List.iter (Format.printf "  - %s\n") errors;

     

       83
       83
       -
             Format.printf "\n"

     

       84
       84
       -
       

     

       85
       85
       -
       let test_feed_with_multiple_items () =

     

       86
       86
       -
         Format.printf "=== Test: Feed with Multiple Items ===\n";

     

       87
       87
       -
       

     

       88
       88
       -
         let items = List.init 10 (fun i ->

     

       89
       89
       -
           Item.create

     

       90
       90
       -
             ~id:(Printf.sprintf "https://example.com/items/%d" i)

     

       91
       91
       -
             ~content:(`Text (Printf.sprintf "Item %d content" i))

     

       92
       92
       -
             ~title:(Printf.sprintf "Item %d" i)

     

       93
       93
       -
             ~date_published:(Jsonfeed.parse_rfc3339

     

       94
       94
       -
               (Printf.sprintf "2024-11-%02dT10:00:00Z" (i + 1)) |> Option.get)

     

       95
       95
       -
             ()

     

       96
       96
       -
         ) in

     

       97
       97
       -
       

     

       98
       98
       -
         let feed = Jsonfeed.create

     

       99
       99
       -
           ~title:"Multi-item Feed"

     

       100
       100
       -
           ~items

     

       101
       101
       -
           () in

     

       102
       102
       -
       

     

       103
       103
       -
         match Jsonfeed.validate feed with

     

       104
       104
       -
         | Ok () ->

     

       105
       105
       -
             Format.printf "✓ Feed with %d items is valid\n\n" (List.length items)

     

       106
       106
       -
         | Error errors ->

     

       107
       107
       -
             Format.printf "✗ Multi-item feed validation failed:\n";

     

       108
       108
       -
             List.iter (Format.printf "  - %s\n") errors;

     

       109
       109
       -
             Format.printf "\n"

     

       110
       110
       -
       

     

       111
       111
       -
       let test_podcast_feed () =

     

       112
       112
       -
         Format.printf "=== Test: Podcast Feed ===\n";

     

       113
       113
       -
       

     

       114
       114
       -
         let host = Author.create

     

       115
       115
       -
           ~name:"Podcast Host"

     

       116
       116
       -
           ~url:"https://podcast.example.com/host"

     

       117
       117
       -
           () in

     

       118
       118
       -
       

     

       119
       119
       -
         let episode1 = Attachment.create

     

       120
       120
       -
           ~url:"https://podcast.example.com/ep1.mp3"

     

       121
       121
       -
           ~mime_type:"audio/mpeg"

     

       122
       122
       -
           ~title:"Episode 1"

     

       123
       123
       -
           ~size_in_bytes:20_971_520L  (* 20 MB *)

     

       124
       124
       -
           ~duration_in_seconds:1800    (* 30 minutes *)

     

       125
       125
       -
           () in

     

       126
       126
       -
       

     

       127
       127
       -
         (* Alternate format of the same episode *)

     

       128
       128
       -
         let episode1_aac = Attachment.create

     

       129
       129
       -
           ~url:"https://podcast.example.com/ep1.aac"

     

       130
       130
       -
           ~mime_type:"audio/aac"

     

       131
       131
       -
           ~title:"Episode 1"

     

       132
       132
       -
           ~size_in_bytes:16_777_216L

     

       133
       133
       -
           ~duration_in_seconds:1800

     

       134
       134
       -
           () in

     

       135
       135
       -
       

     

       136
       136
       -
         let item = Item.create

     

       137
       137
       -
           ~id:"https://podcast.example.com/episodes/1"

     

       138
       138
       -
           ~url:"https://podcast.example.com/episodes/1"

     

       139
       139
       -
           ~title:"Episode 1: Introduction"

     

       140
       140
       -
           ~content:(`Html "<p>Welcome to the first episode!</p>")

     

       141
       141
       -
           ~date_published:(Jsonfeed.parse_rfc3339 "2024-11-01T12:00:00Z" |> Option.get)

     

       142
       142
       -
           ~authors:[host]

     

       143
       143
       -
           ~attachments:[episode1; episode1_aac]

     

       144
       144
       -
           ~image:"https://podcast.example.com/ep1-cover.jpg"

     

       145
       145
       -
           () in

     

       146
       146
       -
       

     

       147
       147
       -
         let feed = Jsonfeed.create

     

       148
       148
       -
           ~title:"Example Podcast"

     

       149
       149
       -
           ~home_page_url:"https://podcast.example.com"

     

       150
       150
       -
           ~feed_url:"https://podcast.example.com/feed.json"

     

       151
       151
       -
           ~authors:[host]

     

       152
       152
       -
           ~items:[item]

     

       153
       153
       -
           () in

     

       154
       154
       -
       

     

       155
       155
       -
         match Jsonfeed.validate feed with

     

       156
       156
       -
         | Ok () -> Format.printf "✓ Podcast feed is valid\n\n"

     

       157
       157
       -
         | Error errors ->

     

       158
       158
       -
             Format.printf "✗ Podcast feed validation failed:\n";

     

       159
       159
       -
             List.iter (Format.printf "  - %s\n") errors;

     

       160
       160
       -
             Format.printf "\n"

     

       161
       161
       -
       

     

       162
       162
       -
       let test_microblog_feed () =

     

       163
       163
       -
         Format.printf "=== Test: Microblog Feed (no titles) ===\n";

     

       1
       1
       +
       (** Example: JSON Feed Validator

     

       164
       2
        
       

     

       165
       165
       -
         let author = Author.create

     

       166
       166
       -
           ~name:"Microblogger"

     

       167
       167
       -
           ~url:"https://micro.example.com"

     

       168
       168
       -
           () in

     

       3
       3
       +
           Reads a JSON Feed from stdin and validates it.

     

       169
       4
        
       

     

       170
       170
       -
         let items = [

     

       171
       171
       -
           Item.create

     

       172
       172
       -
             ~id:"https://micro.example.com/1"

     

       173
       173
       -
             ~content:(`Text "Just posted a new photo!")

     

       174
       174
       -
             ~date_published:(Jsonfeed.parse_rfc3339 "2024-11-01T08:00:00Z" |> Option.get)

     

       175
       175
       -
             ();

     

       176
       176
       -
           Item.create

     

       177
       177
       -
             ~id:"https://micro.example.com/2"

     

       178
       178
       -
             ~content:(`Text "Having a great day! ☀️")

     

       179
       179
       -
             ~date_published:(Jsonfeed.parse_rfc3339 "2024-11-01T12:30:00Z" |> Option.get)

     

       180
       180
       -
             ();

     

       181
       181
       -
           Item.create

     

       182
       182
       -
             ~id:"https://micro.example.com/3"

     

       183
       183
       -
             ~content:(`Html "<p>Check out this <a href=\"#\">link</a></p>")

     

       184
       184
       -
             ~date_published:(Jsonfeed.parse_rfc3339 "2024-11-01T16:45:00Z" |> Option.get)

     

       185
       185
       -
             ()

     

       186
       186
       -
         ] in

     

       187
       187
       -
       

     

       188
       188
       -
         let feed = Jsonfeed.create

     

       189
       189
       -
           ~title:"Microblog"

     

       190
       190
       -
           ~home_page_url:"https://micro.example.com"

     

       191
       191
       -
           ~authors:[author]

     

       192
       192
       -
           ~items

     

       193
       193
       -
           () in

     

       194
       194
       -
       

     

       195
       195
       -
         match Jsonfeed.validate feed with

     

       196
       196
       -
         | Ok () ->

     

       197
       197
       -
             Format.printf "✓ Microblog feed with %d items is valid\n\n"

     

       198
       198
       -
               (List.length items)

     

       199
       199
       -
         | Error errors ->

     

       200
       200
       -
             Format.printf "✗ Microblog feed validation failed:\n";

     

       201
       201
       -
             List.iter (Format.printf "  - %s\n") errors;

     

       202
       202
       -
             Format.printf "\n"

     

       203
       203
       -
       

     

       204
       204
       -
       let test_expired_feed () =

     

       205
       205
       -
         Format.printf "=== Test: Expired Feed ===\n";

     

       5
       5
       +
           Usage: feed_validator < feed.json cat feed.json | feed_validator

     

       206
       6
        
       

     

       207
       207
       -
         let feed = Jsonfeed.create

     

       208
       208
       -
           ~title:"Archived Blog"

     

       209
       209
       -
           ~home_page_url:"https://archive.example.com"

     

       210
       210
       -
           ~description:"This blog is no longer updated"

     

       211
       211
       -
           ~expired:true

     

       212
       212
       -
           ~items:[]

     

       213
       213
       -
           () in

     

       7
       7
       +
           Exit codes: 0 - Feed is valid 1 - Feed parsing failed 2 - Feed validation

     

       8
       8
       +
           failed *)

     

       214
       9
        
       

     

       215
       215
       -
         match Jsonfeed.validate feed with

     

       216
       216
       -
         | Ok () -> Format.printf "✓ Expired feed is valid\n\n"

     

       217
       217
       -
         | Error errors ->

     

       218
       218
       -
             Format.printf "✗ Expired feed validation failed:\n";

     

       219
       219
       -
             List.iter (Format.printf "  - %s\n") errors;

     

       220
       220
       -
             Format.printf "\n"

     

       10
       10
       +
       let validate_stdin () =

     

       11
       11
       +
         let stdin = Bytesrw.Bytes.Reader.of_in_channel In_channel.stdin in

     

       12
       12
       +
         match Jsonfeed.decode ~locs:true stdin with

     

       13
       13
       +
         | Error err ->

     

       14
       14
       +
             Format.eprintf "Parsing failed:\n  %s\n%!" (Jsont.Error.to_string err);

     

       15
       15
       +
             exit 1

     

       16
       16
       +
         | Ok feed -> (

     

       17
       17
       +
             match Jsonfeed.validate feed with

     

       18
       18
       +
             | Ok () ->

     

       19
       19
       +
                 Format.printf "Feed is valid\n%!";

     

       20
       20
       +
                 Format.printf "\nFeed details:\n";

     

       21
       21
       +
                 Format.printf "  Title: %s\n" (Jsonfeed.title feed);

     

       22
       22
       +
                 Format.printf "  Version: %s\n" (Jsonfeed.version feed);

     

       23
       23
       +
                 (match Jsonfeed.home_page_url feed with

     

       24
       24
       +
                 | Some url -> Format.printf "  Home page: %s\n" url

     

       25
       25
       +
                 | None -> ());

     

       26
       26
       +
                 Format.printf "  Items: %d\n" (List.length (Jsonfeed.items feed));

     

       27
       27
       +
                 exit 0

     

       28
       28
       +
             | Error errors ->

     

       29
       29
       +
                 Format.eprintf "Validation failed:\n%!";

     

       30
       30
       +
                 List.iter (fun err -> Format.eprintf "  - %s\n%!" err) errors;

     

       31
       31
       +
                 exit 2)

     

       221
       32
        
       

     

       222
       222
       -
       let test_paginated_feed () =

     

       223
       223
       -
         Format.printf "=== Test: Paginated Feed ===\n";

     

       224
       224
       -
       

     

       225
       225
       -
         let items = List.init 25 (fun i ->

     

       226
       226
       -
           Item.create

     

       227
       227
       -
             ~id:(Printf.sprintf "https://example.com/items/%d" i)

     

       228
       228
       -
             ~content:(`Text (Printf.sprintf "Item %d" i))

     

       229
       229
       -
             ()

     

       230
       230
       -
         ) in

     

       231
       231
       -
       

     

       232
       232
       -
         let feed = Jsonfeed.create

     

       233
       233
       -
           ~title:"Large Feed"

     

       234
       234
       -
           ~home_page_url:"https://example.com"

     

       235
       235
       -
           ~feed_url:"https://example.com/feed.json?page=1"

     

       236
       236
       -
           ~next_url:"https://example.com/feed.json?page=2"

     

       237
       237
       -
           ~items

     

       238
       238
       -
           () in

     

       239
       239
       -
       

     

       240
       240
       -
         match Jsonfeed.validate feed with

     

       241
       241
       -
         | Ok () ->

     

       242
       242
       -
             Format.printf "✓ Paginated feed is valid (page 1 with next_url)\n\n"

     

       243
       243
       -
         | Error errors ->

     

       244
       244
       -
             Format.printf "✗ Paginated feed validation failed:\n";

     

       245
       245
       -
             List.iter (Format.printf "  - %s\n") errors;

     

       246
       246
       -
             Format.printf "\n"

     

       247
       247
       -
       

     

       248
       248
       -
       let test_invalid_feed_from_json () =

     

       249
       249
       -
         Format.printf "=== Test: Parsing Invalid JSON ===\n";

     

       250
       250
       -
       

     

       251
       251
       -
         (* Missing required version field *)

     

       252
       252
       -
         let invalid_json1 = {|{

     

       253
       253
       -
           "title": "Test",

     

       254
       254
       -
           "items": []

     

       255
       255
       -
         }|} in

     

       256
       256
       -
       

     

       257
       257
       -
         (match Jsonfeed.of_string invalid_json1 with

     

       258
       258
       -
          | Ok _ -> Format.printf "✗ Should have failed (missing version)\n"

     

       259
       259
       -
          | Error (`Msg err) ->

     

       260
       260
       -
              Format.printf "✓ Correctly rejected invalid feed: %s\n" err);

     

       261
       261
       -
       

     

       262
       262
       -
         (* Missing required title field *)

     

       263
       263
       -
         let invalid_json2 = {|{

     

       264
       264
       -
           "version": "https://jsonfeed.org/version/1.1",

     

       265
       265
       -
           "items": []

     

       266
       266
       -
         }|} in

     

       267
       267
       -
       

     

       268
       268
       -
         (match Jsonfeed.of_string invalid_json2 with

     

       269
       269
       -
          | Ok _ -> Format.printf "✗ Should have failed (missing title)\n"

     

       270
       270
       -
          | Error (`Msg err) ->

     

       271
       271
       -
              Format.printf "✓ Correctly rejected invalid feed: %s\n" err);

     

       272
       272
       -
       

     

       273
       273
       -
         (* Item without id *)

     

       274
       274
       -
         let invalid_json3 = {|{

     

       275
       275
       -
           "version": "https://jsonfeed.org/version/1.1",

     

       276
       276
       -
           "title": "Test",

     

       277
       277
       -
           "items": [{

     

       278
       278
       -
             "content_text": "Hello"

     

       279
       279
       -
           }]

     

       280
       280
       -
         }|} in

     

       281
       281
       -
       

     

       282
       282
       -
         (match Jsonfeed.of_string invalid_json3 with

     

       283
       283
       -
          | Ok _ -> Format.printf "✗ Should have failed (item without id)\n"

     

       284
       284
       -
          | Error (`Msg err) ->

     

       285
       285
       -
              Format.printf "✓ Correctly rejected invalid feed: %s\n" err);

     

       286
       286
       -
       

     

       287
       287
       -
         Format.printf "\n"

     

       288
       288
       -
       

     

       289
       289
       -
       let main () =

     

       290
       290
       -
         Format.printf "\n=== JSON Feed Validation Tests ===\n\n";

     

       291
       291
       -
       

     

       292
       292
       -
         test_valid_minimal_feed ();

     

       293
       293
       -
         test_valid_complete_feed ();

     

       294
       294
       -
         test_feed_with_multiple_items ();

     

       295
       295
       -
         test_podcast_feed ();

     

       296
       296
       -
         test_microblog_feed ();

     

       297
       297
       -
         test_expired_feed ();

     

       298
       298
       -
         test_paginated_feed ();

     

       299
       299
       -
         test_invalid_feed_from_json ();

     

       300
       300
       -
       

     

       301
       301
       -
         Format.printf "=== All Tests Complete ===\n"

     

       302
       302
       -
       

     

       303
       303
       -
       let () = main ()

     

       33
       33
       +
       let () = validate_stdin ()

+4 -3

jsonfeed.opam

···

       11
       11
        
       depends: [

     

       12
       12
        
         "dune" {>= "3.18"}

     

       13
       13
        
         "ocaml" {>= "5.2.0"}

     

       14
       14
       -
         "jsonm" {>= "1.0.0"}

     

       14
       14
       +
         "jsont" {>= "0.2.0"}

     

       15
       15
        
         "ptime" {>= "1.2.0"}

     

       16
       16
       -
         "fmt" {>= "0.11.0"}

     

       16
       16
       +
         "bytesrw"

     

       17
       17
        
         "odoc" {with-doc}

     

       18
       18
       -
         "alcotest" {with-test & >= "1.9.0"}

     

       18
       18
       +
         "alcotest" {with-test & >= "1.5.0"}

     

       19
       19
        
       ]

     

       20
       20
        
       build: [

     

       21
       21
        
         ["dune" "subst"] {dev}

     
···

       32
       32
        
         ]

     

       33
       33
        
       ]

     

       34
       34
        
       x-maintenance-intent: ["(latest)"]

     

       35
       35
       +
       dev-repo: "git+https://tangled.sh/@anil.recoil.org/ocaml-jsonfeed"

jsonfeed.opam.template

···

       1
       1
       +
       dev-repo: "git+https://tangled.sh/@anil.recoil.org/ocaml-jsonfeed"

+47 -19

lib/attachment.ml

···

       1
       1
       -
       (** Attachments for JSON Feed items. *)

     

       1
       1
       +
       (*---------------------------------------------------------------------------

     

       2
       2
       +
          Copyright (c) 2024 Anil Madhavapeddy. All rights reserved.

     

       3
       3
       +
          SPDX-License-Identifier: ISC

     

       4
       4
       +
         ---------------------------------------------------------------------------*)

     

       5
       5
       +
       

     

       6
       6
       +
       module Unknown = struct

     

       7
       7
       +
         type t = Jsont.json

     

       8
       8
       +
       

     

       9
       9
       +
         let empty = Jsont.Object ([], Jsont.Meta.none)

     

       10
       10
       +
         let is_empty = function Jsont.Object ([], _) -> true | _ -> false

     

       11
       11
       +
       end

     

       2
       12
        
       

     

       3
       13
        
       type t = {

     

       4
       14
        
         url : string;

     
···

       6
       16
        
         title : string option;

     

       7
       17
        
         size_in_bytes : int64 option;

     

       8
       18
        
         duration_in_seconds : int option;

     

       19
       19
       +
         unknown : Unknown.t;

     

       9
       20
        
       }

     

       10
       21
        
       

     

       11
       11
       -
       let create ~url ~mime_type ?title ?size_in_bytes ?duration_in_seconds () =

     

       12
       12
       -
         { url; mime_type; title; size_in_bytes; duration_in_seconds }

     

       22
       22
       +
       let create ~url ~mime_type ?title ?size_in_bytes ?duration_in_seconds

     

       23
       23
       +
           ?(unknown = Unknown.empty) () =

     

       24
       24
       +
         { url; mime_type; title; size_in_bytes; duration_in_seconds; unknown }

     

       13
       25
        
       

     

       14
       26
        
       let url t = t.url

     

       15
       27
        
       let mime_type t = t.mime_type

     

       16
       28
        
       let title t = t.title

     

       17
       29
        
       let size_in_bytes t = t.size_in_bytes

     

       18
       30
        
       let duration_in_seconds t = t.duration_in_seconds

     

       31
       31
       +
       let unknown t = t.unknown

     

       19
       32
        
       

     

       20
       33
        
       let equal a b =

     

       21
       21
       -
         a.url = b.url &&

     

       22
       22
       -
         a.mime_type = b.mime_type &&

     

       23
       23
       -
         a.title = b.title &&

     

       24
       24
       -
         a.size_in_bytes = b.size_in_bytes &&

     

       25
       25
       -
         a.duration_in_seconds = b.duration_in_seconds

     

       34
       34
       +
         a.url = b.url && a.mime_type = b.mime_type && a.title = b.title

     

       35
       35
       +
         && a.size_in_bytes = b.size_in_bytes

     

       36
       36
       +
         && a.duration_in_seconds = b.duration_in_seconds

     

       26
       37
        
       

     

       27
       38
        
       let pp ppf t =

     

       28
       39
        
         (* Extract filename from URL *)

     
···

       35
       46
        
       

     

       36
       47
        
         Format.fprintf ppf "%s (%s" filename t.mime_type;

     

       37
       48
        
       

     

       38
       38
       -
         (match t.size_in_bytes with

     

       39
       39
       -
          | Some size ->

     

       40
       40
       -
              let mb = Int64.to_float size /. (1024. *. 1024.) in

     

       41
       41
       -
              Format.fprintf ppf ", %.1f MB" mb

     

       42
       42
       -
          | None -> ());

     

       49
       49
       +
         Option.iter

     

       50
       50
       +
           (fun size ->

     

       51
       51
       +
             let mb = Int64.to_float size /. (1024. *. 1024.) in

     

       52
       52
       +
             Format.fprintf ppf ", %.1f MB" mb)

     

       53
       53
       +
           t.size_in_bytes;

     

       43
       54
        
       

     

       44
       44
       -
         (match t.duration_in_seconds with

     

       45
       45
       -
          | Some duration ->

     

       46
       46
       -
              let mins = duration / 60 in

     

       47
       47
       -
              let secs = duration mod 60 in

     

       48
       48
       -
              Format.fprintf ppf ", %dm%ds" mins secs

     

       49
       49
       -
          | None -> ());

     

       55
       55
       +
         Option.iter

     

       56
       56
       +
           (fun duration ->

     

       57
       57
       +
             let mins = duration / 60 in

     

       58
       58
       +
             let secs = duration mod 60 in

     

       59
       59
       +
             Format.fprintf ppf ", %dm%ds" mins secs)

     

       60
       60
       +
           t.duration_in_seconds;

     

       50
       61
        
       

     

       51
       62
        
         Format.fprintf ppf ")"

     

       63
       63
       +
       

     

       64
       64
       +
       let jsont =

     

       65
       65
       +
         let kind = "Attachment" in

     

       66
       66
       +
         let doc = "An attachment object" in

     

       67
       67
       +
         let create_obj url mime_type title size_in_bytes duration_in_seconds unknown =

     

       68
       68
       +
           create ~url ~mime_type ?title ?size_in_bytes ?duration_in_seconds ~unknown

     

       69
       69
       +
             ()

     

       70
       70
       +
         in

     

       71
       71
       +
         Jsont.Object.map ~kind ~doc create_obj

     

       72
       72
       +
         |> Jsont.Object.mem "url" Jsont.string ~enc:url

     

       73
       73
       +
         |> Jsont.Object.mem "mime_type" Jsont.string ~enc:mime_type

     

       74
       74
       +
         |> Jsont.Object.opt_mem "title" Jsont.string ~enc:title

     

       75
       75
       +
         |> Jsont.Object.opt_mem "size_in_bytes" Jsont.int64 ~enc:size_in_bytes

     

       76
       76
       +
         |> Jsont.Object.opt_mem "duration_in_seconds" Jsont.int

     

       77
       77
       +
              ~enc:duration_in_seconds

     

       78
       78
       +
         |> Jsont.Object.keep_unknown Jsont.json_mems ~enc:unknown

     

       79
       79
       +
         |> Jsont.Object.finish

+64 -43

lib/attachment.mli

···

       1
       1
       +
       (*---------------------------------------------------------------------------

     

       2
       2
       +
          Copyright (c) 2025 Anil Madhavapeddy. All rights reserved.

     

       3
       3
       +
          SPDX-License-Identifier: ISC

     

       4
       4
       +
         ---------------------------------------------------------------------------*)

     

       5
       5
       +
       

     

       1
       6
        
       (** Attachments for JSON Feed items.

     

       2
       7
        
       

     

       3
       3
       -
           An attachment represents an external resource related to a feed item,

     

       4
       4
       -
           such as audio files for podcasts, video files, or other downloadable content.

     

       5
       5
       -
           Attachments with identical titles indicate alternate formats of the same resource.

     

       8
       8
       +
           An attachment represents an external resource related to a feed item, such

     

       9
       9
       +
           as audio files for podcasts, video files, or other downloadable content.

     

       10
       10
       +
           Attachments with identical titles indicate alternate formats of the same

     

       11
       11
       +
           resource.

     

       6
       12
        
       

     

       7
       13
        
           @see <https://www.jsonfeed.org/version/1.1/> JSON Feed Specification *)

     

       8
       14
        
       

     

       9
       9
       -
       

     

       15
       15
       +
       type t

     

       10
       16
        
       (** The type representing an attachment. *)

     

       11
       11
       -
       type t

     

       12
       17
        
       

     

       18
       18
       +
       (** {1 Unknown Fields} *)

     

       13
       19
        
       

     

       14
       14
       -
       (** {1 Construction} *)

     

       20
       20
       +
       module Unknown : sig

     

       21
       21
       +
         type t = Jsont.json

     

       22
       22
       +
         (** Unknown/unrecognized JSON object members as a generic JSON object. Useful

     

       23
       23
       +
             for preserving fields from custom extensions or future spec versions. *)

     

       15
       24
        
       

     

       16
       16
       -
       (** [create ~url ~mime_type ?title ?size_in_bytes ?duration_in_seconds ()]

     

       17
       17
       -
           creates an attachment object.

     

       25
       25
       +
         val empty : t

     

       26
       26
       +
         (** [empty] is the empty list of unknown fields. *)

     

       18
       27
        
       

     

       19
       19
       -
           @param url The location of the attachment (required)

     

       20
       20
       -
           @param mime_type The MIME type of the attachment, e.g. ["audio/mpeg"] (required)

     

       21
       21
       -
           @param title The name of the attachment; identical titles indicate alternate formats

     

       22
       22
       -
                        of the same resource

     

       23
       23
       -
           @param size_in_bytes The size of the attachment file in bytes

     

       24
       24
       -
           @param duration_in_seconds The duration of the attachment in seconds (for audio/video)

     

       28
       28
       +
         val is_empty : t -> bool

     

       29
       29
       +
         (** [is_empty u] returns [true] if there are no unknown fields. *)

     

       30
       30
       +
       end

     

       25
       31
        
       

     

       26
       26
       -
           {b Examples:}

     

       27
       27
       -
           {[

     

       28
       28
       -
             (* Simple attachment *)

     

       29
       29
       -
             let att = Attachment.create

     

       30
       30
       -
               ~url:"https://example.com/episode.mp3"

     

       31
       31
       -
               ~mime_type:"audio/mpeg" ()

     

       32
       32
       +
       (** {1 Jsont Type} *)

     

       33
       33
       +
       

     

       34
       34
       +
       val jsont : t Jsont.t

     

       35
       35
       +
       (** Declarative JSON type for attachments.

     

       36
       36
       +
       

     

       37
       37
       +
           Maps JSON objects with "url" (required), "mime_type" (required), and

     

       38
       38
       +
           optional "title", "size_in_bytes", "duration_in_seconds" fields. *)

     

       32
       39
        
       

     

       33
       33
       -
             (* Podcast episode with metadata *)

     

       34
       34
       -
             let att = Attachment.create

     

       35
       35
       -
               ~url:"https://example.com/episode.mp3"

     

       36
       36
       -
               ~mime_type:"audio/mpeg"

     

       37
       37
       -
               ~title:"Episode 42"

     

       38
       38
       -
               ~size_in_bytes:15_728_640L

     

       39
       39
       -
               ~duration_in_seconds:1800 ()

     

       40
       40
       +
       (** {1 Construction} *)

     

       40
       41
        
       

     

       41
       41
       -
             (* Alternate format (same title indicates same content) *)

     

       42
       42
       -
             let att2 = Attachment.create

     

       43
       43
       -
               ~url:"https://example.com/episode.aac"

     

       44
       44
       -
               ~mime_type:"audio/aac"

     

       45
       45
       -
               ~title:"Episode 42"

     

       46
       46
       -
               ~size_in_bytes:12_582_912L

     

       47
       47
       -
               ~duration_in_seconds:1800 ()

     

       48
       48
       -
           ]} *)

     

       49
       42
        
       val create :

     

       50
       43
        
         url:string ->

     

       51
       44
        
         mime_type:string ->

     

       52
       45
        
         ?title:string ->

     

       53
       46
        
         ?size_in_bytes:int64 ->

     

       54
       47
        
         ?duration_in_seconds:int ->

     

       48
       48
       +
         ?unknown:Unknown.t ->

     

       55
       49
        
         unit ->

     

       56
       50
        
         t

     

       51
       51
       +
       (** [create ~url ~mime_type ?title ?size_in_bytes ?duration_in_seconds ?unknown

     

       52
       52
       +
            ()] creates an attachment object.

     

       57
       53
        
       

     

       54
       54
       +
           @param url The location of the attachment (required)

     

       55
       55
       +
           @param mime_type

     

       56
       56
       +
             The MIME type of the attachment, e.g. ["audio/mpeg"] (required)

     

       57
       57
       +
           @param title

     

       58
       58
       +
             The name of the attachment; identical titles indicate alternate formats of

     

       59
       59
       +
             the same resource

     

       60
       60
       +
           @param size_in_bytes The size of the attachment file in bytes

     

       61
       61
       +
           @param duration_in_seconds

     

       62
       62
       +
             The duration of the attachment in seconds (for audio/video)

     

       63
       63
       +
           @param unknown Unknown/custom fields for extensions (default: empty)

     

       64
       64
       +
       

     

       65
       65
       +
           {b Examples:}

     

       66
       66
       +
           {[

     

       67
       67
       +
             (* Simple attachment *)

     

       68
       68
       +
             let att =

     

       69
       69
       +
               Attachment.create ~url:"https://example.com/episode.mp3"

     

       70
       70
       +
                 ~mime_type:"audio/mpeg" ()

     

       71
       71
       +
       

     

       72
       72
       +
             (* Podcast episode with metadata *)

     

       73
       73
       +
             let att =

     

       74
       74
       +
               Attachment.create ~url:"https://example.com/episode.mp3"

     

       75
       75
       +
                 ~mime_type:"audio/mpeg" ~title:"Episode 42" ~size_in_bytes:15_728_640L

     

       76
       76
       +
                 ~duration_in_seconds:1800 ()

     

       77
       77
       +
           ]} *)

     

       58
       78
        
       

     

       59
       79
        
       (** {1 Accessors} *)

     

       60
       80
        
       

     

       61
       61
       -
       (** [url t] returns the attachment's URL. *)

     

       62
       81
        
       val url : t -> string

     

       82
       82
       +
       (** [url t] returns the attachment's URL. *)

     

       63
       83
        
       

     

       84
       84
       +
       val mime_type : t -> string

     

       64
       85
        
       (** [mime_type t] returns the attachment's MIME type. *)

     

       65
       65
       -
       val mime_type : t -> string

     

       66
       86
        
       

     

       67
       67
       -
       (** [title t] returns the attachment's title, if set. *)

     

       68
       87
        
       val title : t -> string option

     

       88
       88
       +
       (** [title t] returns the attachment's title, if set. *)

     

       69
       89
        
       

     

       70
       70
       -
       (** [size_in_bytes t] returns the attachment's size in bytes, if set. *)

     

       71
       90
        
       val size_in_bytes : t -> int64 option

     

       91
       91
       +
       (** [size_in_bytes t] returns the attachment's size in bytes, if set. *)

     

       72
       92
        
       

     

       73
       73
       -
       (** [duration_in_seconds t] returns the attachment's duration, if set. *)

     

       74
       93
        
       val duration_in_seconds : t -> int option

     

       94
       94
       +
       (** [duration_in_seconds t] returns the attachment's duration, if set. *)

     

       75
       95
        
       

     

       96
       96
       +
       val unknown : t -> Unknown.t

     

       97
       97
       +
       (** [unknown t] returns unrecognized fields from the JSON. *)

     

       76
       98
        
       

     

       77
       99
        
       (** {1 Comparison} *)

     

       78
       100
        
       

     

       79
       79
       -
       (** [equal a b] tests equality between two attachments. *)

     

       80
       101
        
       val equal : t -> t -> bool

     

       81
       81
       -
       

     

       102
       102
       +
       (** [equal a b] tests equality between two attachments. *)

     

       82
       103
        
       

     

       83
       104
        
       (** {1 Pretty Printing} *)

     

       84
       105
        
       

     

       106
       106
       +
       val pp : Format.formatter -> t -> unit

     

       85
       107
        
       (** [pp ppf t] pretty prints an attachment to the formatter.

     

       86
       108
        
       

     

       87
       109
        
           The output is human-readable and suitable for debugging.

     

       88
       110
        
       

     

       89
       111
        
           {b Example output:}

     

       90
       112
        
           {v episode.mp3 (audio/mpeg, 15.0 MB, 30m0s) v} *)

     

       91
       91
       -
       val pp : Format.formatter -> t -> unit

+37 -13

lib/author.ml

···

       1
       1
       -
       (** Author information for JSON Feed items and feeds. *)

     

       1
       1
       +
       (*---------------------------------------------------------------------------

     

       2
       2
       +
          Copyright (c) 2024 Anil Madhavapeddy. All rights reserved.

     

       3
       3
       +
          SPDX-License-Identifier: ISC

     

       4
       4
       +
         ---------------------------------------------------------------------------*)

     

       5
       5
       +
       

     

       6
       6
       +
       module Unknown = struct

     

       7
       7
       +
         type t = Jsont.json

     

       8
       8
       +
       

     

       9
       9
       +
         let empty = Jsont.Object ([], Jsont.Meta.none)

     

       10
       10
       +
         let is_empty = function Jsont.Object ([], _) -> true | _ -> false

     

       11
       11
       +
       end

     

       2
       12
        
       

     

       3
       13
        
       type t = {

     

       4
       14
        
         name : string option;

     

       5
       15
        
         url : string option;

     

       6
       16
        
         avatar : string option;

     

       17
       17
       +
         unknown : Unknown.t;

     

       7
       18
        
       }

     

       8
       19
        
       

     

       9
       9
       -
       let create ?name ?url ?avatar () =

     

       20
       20
       +
       let create ?name ?url ?avatar ?(unknown = Unknown.empty) () =

     

       10
       21
        
         if name = None && url = None && avatar = None then

     

       11
       11
       -
           invalid_arg "Author.create: at least one field (name, url, or avatar) must be provided";

     

       12
       12
       -
         { name; url; avatar }

     

       22
       22
       +
           invalid_arg

     

       23
       23
       +
             "Author.create: at least one field (name, url, or avatar) must be \

     

       24
       24
       +
              provided";

     

       25
       25
       +
         { name; url; avatar; unknown }

     

       13
       26
        
       

     

       14
       27
        
       let name t = t.name

     

       15
       28
        
       let url t = t.url

     

       16
       29
        
       let avatar t = t.avatar

     

       17
       17
       -
       

     

       18
       18
       -
       let is_valid t =

     

       19
       19
       -
         t.name <> None || t.url <> None || t.avatar <> None

     

       20
       20
       -
       

     

       21
       21
       -
       let equal a b =

     

       22
       22
       -
         a.name = b.name && a.url = b.url && a.avatar = b.avatar

     

       30
       30
       +
       let unknown t = t.unknown

     

       31
       31
       +
       let is_valid t = t.name <> None || t.url <> None || t.avatar <> None

     

       32
       32
       +
       let equal a b = a.name = b.name && a.url = b.url && a.avatar = b.avatar

     

       23
       33
        
       

     

       24
       34
        
       let pp ppf t =

     

       25
       25
       -
         match t.name, t.url with

     

       35
       35
       +
         match (t.name, t.url) with

     

       26
       36
        
         | Some name, Some url -> Format.fprintf ppf "%s <%s>" name url

     

       27
       37
        
         | Some name, None -> Format.fprintf ppf "%s" name

     

       28
       38
        
         | None, Some url -> Format.fprintf ppf "<%s>" url

     

       29
       29
       -
         | None, None ->

     

       39
       39
       +
         | None, None -> (

     

       30
       40
        
             match t.avatar with

     

       31
       41
        
             | Some avatar -> Format.fprintf ppf "(avatar: %s)" avatar

     

       32
       32
       -
             | None -> Format.fprintf ppf "(empty author)"

     

       42
       42
       +
             | None -> Format.fprintf ppf "(empty author)")

     

       43
       43
       +
       

     

       44
       44
       +
       let jsont =

     

       45
       45
       +
         let kind = "Author" in

     

       46
       46
       +
         let doc = "An author object with at least one field set" in

     

       47
       47
       +
         (* Constructor that matches the jsont object map pattern *)

     

       48
       48
       +
         let create_obj name url avatar unknown =

     

       49
       49
       +
           create ?name ?url ?avatar ~unknown ()

     

       50
       50
       +
         in

     

       51
       51
       +
         Jsont.Object.map ~kind ~doc create_obj

     

       52
       52
       +
         |> Jsont.Object.opt_mem "name" Jsont.string ~enc:name

     

       53
       53
       +
         |> Jsont.Object.opt_mem "url" Jsont.string ~enc:url

     

       54
       54
       +
         |> Jsont.Object.opt_mem "avatar" Jsont.string ~enc:avatar

     

       55
       55
       +
         |> Jsont.Object.keep_unknown Jsont.json_mems ~enc:unknown

     

       56
       56
       +
         |> Jsont.Object.finish

+54 -22

lib/author.mli

···

       1
       1
       +
       (*---------------------------------------------------------------------------

     

       2
       2
       +
          Copyright (c) 2025 Anil Madhavapeddy. All rights reserved.

     

       3
       3
       +
          SPDX-License-Identifier: ISC

     

       4
       4
       +
         ---------------------------------------------------------------------------*)

     

       5
       5
       +
       

     

       1
       6
        
       (** Author information for JSON Feed items and feeds.

     

       2
       7
        
       

     

       3
       8
        
           An author object provides information about the creator of a feed or item.

     
···

       6
       11
        
       

     

       7
       12
        
           @see <https://www.jsonfeed.org/version/1.1/> JSON Feed Specification *)

     

       8
       13
        
       

     

       14
       14
       +
       type t

     

       15
       15
       +
       (** The type representing an author. *)

     

       9
       16
        
       

     

       10
       10
       -
       (** The type representing an author. *)

     

       11
       11
       -
       type t

     

       17
       17
       +
       (** {1 Unknown Fields} *)

     

       18
       18
       +
       

     

       19
       19
       +
       module Unknown : sig

     

       20
       20
       +
         type t = Jsont.json

     

       21
       21
       +
         (** Unknown/unrecognized JSON object members as a generic JSON object. Useful

     

       22
       22
       +
             for preserving fields from custom extensions or future spec versions. *)

     

       12
       23
        
       

     

       24
       24
       +
         val empty : t

     

       25
       25
       +
         (** [empty] is the empty list of unknown fields. *)

     

       26
       26
       +
       

     

       27
       27
       +
         val is_empty : t -> bool

     

       28
       28
       +
         (** [is_empty u] returns [true] if there are no unknown fields. *)

     

       29
       29
       +
       end

     

       30
       30
       +
       

     

       31
       31
       +
       (** {1 Jsont Type} *)

     

       32
       32
       +
       

     

       33
       33
       +
       val jsont : t Jsont.t

     

       34
       34
       +
       (** Declarative JSON type for authors.

     

       35
       35
       +
       

     

       36
       36
       +
           Maps JSON objects with optional "name", "url", and "avatar" fields. At least

     

       37
       37
       +
           one field must be present during decoding. *)

     

       13
       38
        
       

     

       14
       39
        
       (** {1 Construction} *)

     

       15
       40
        
       

     

       16
       16
       -
       (** [create ?name ?url ?avatar ()] creates an author object.

     

       41
       41
       +
       val create :

     

       42
       42
       +
         ?name:string ->

     

       43
       43
       +
         ?url:string ->

     

       44
       44
       +
         ?avatar:string ->

     

       45
       45
       +
         ?unknown:Unknown.t ->

     

       46
       46
       +
         unit ->

     

       47
       47
       +
         t

     

       48
       48
       +
       (** [create ?name ?url ?avatar ?unknown ()] creates an author.

     

       17
       49
        
       

     

       18
       18
       -
           At least one of the optional parameters must be provided, otherwise

     

       19
       19
       -
           the function will raise [Invalid_argument].

     

       50
       50
       +
           At least one of the optional parameters must be provided, otherwise the

     

       51
       51
       +
           function will raise [Invalid_argument].

     

       20
       52
        
       

     

       21
       53
        
           @param name The author's name

     

       22
       54
        
           @param url URL of the author's website or profile

     

       23
       23
       -
           @param avatar URL of the author's avatar image (should be square, 512x512 or larger)

     

       55
       55
       +
           @param avatar

     

       56
       56
       +
             URL of the author's avatar image (should be square, 512x512 or larger)

     

       57
       57
       +
           @param unknown Unknown/custom fields for extensions (default: empty)

     

       24
       58
        
       

     

       25
       59
        
           {b Examples:}

     

       26
       60
        
           {[

     

       27
       61
        
             let author = Author.create ~name:"Jane Doe" ()

     

       28
       62
        
             let author = Author.create ~name:"Jane Doe" ~url:"https://janedoe.com" ()

     

       29
       29
       -
             let author = Author.create

     

       30
       30
       -
               ~name:"Jane Doe"

     

       31
       31
       -
               ~url:"https://janedoe.com"

     

       32
       32
       -
               ~avatar:"https://janedoe.com/avatar.png" ()

     

       63
       63
       +
       

     

       64
       64
       +
             let author =

     

       65
       65
       +
               Author.create ~name:"Jane Doe" ~url:"https://janedoe.com"

     

       66
       66
       +
                 ~avatar:"https://janedoe.com/avatar.png" ()

     

       33
       67
        
           ]} *)

     

       34
       34
       -
       val create : ?name:string -> ?url:string -> ?avatar:string -> unit -> t

     

       35
       35
       -
       

     

       36
       68
        
       

     

       37
       69
        
       (** {1 Accessors} *)

     

       38
       70
        
       

     

       39
       39
       -
       (** [name t] returns the author's name, if set. *)

     

       40
       71
        
       val name : t -> string option

     

       72
       72
       +
       (** [name t] returns the author's name, if set. *)

     

       41
       73
        
       

     

       74
       74
       +
       val url : t -> string option

     

       42
       75
        
       (** [url t] returns the author's URL, if set. *)

     

       43
       43
       -
       val url : t -> string option

     

       44
       76
        
       

     

       45
       45
       -
       (** [avatar t] returns the author's avatar URL, if set. *)

     

       46
       77
        
       val avatar : t -> string option

     

       78
       78
       +
       (** [avatar t] returns the author's avatar URL, if set. *)

     

       47
       79
        
       

     

       80
       80
       +
       val unknown : t -> Unknown.t

     

       81
       81
       +
       (** [unknown t] returns unrecognized fields from the JSON. *)

     

       48
       82
        
       

     

       49
       83
        
       (** {1 Predicates} *)

     

       50
       84
        
       

     

       85
       85
       +
       val is_valid : t -> bool

     

       51
       86
        
       (** [is_valid t] checks if the author has at least one field set.

     

       52
       87
        
       

     

       53
       53
       -
           This should always return [true] for authors created via {!create},

     

       54
       54
       -
           but may be useful when parsing from external sources. *)

     

       55
       55
       -
       val is_valid : t -> bool

     

       56
       56
       -
       

     

       88
       88
       +
           This should always return [true] for authors created via {!create}, but may

     

       89
       89
       +
           be useful when parsing from external sources. *)

     

       57
       90
        
       

     

       58
       91
        
       (** {1 Comparison} *)

     

       59
       92
        
       

     

       93
       93
       +
       val equal : t -> t -> bool

     

       60
       94
        
       (** [equal a b] tests equality between two authors. *)

     

       61
       61
       -
       val equal : t -> t -> bool

     

       62
       62
       -
       

     

       63
       95
        
       

     

       64
       96
        
       (** {1 Pretty Printing} *)

     

       65
       97
        
       

     

       98
       98
       +
       val pp : Format.formatter -> t -> unit

     

       66
       99
        
       (** [pp ppf t] pretty prints an author to the formatter.

     

       67
       100
        
       

     

       68
       101
        
           The output is human-readable and suitable for debugging.

     

       69
       102
        
       

     

       70
       103
        
           {b Example output:}

     

       71
       104
        
           {v Jane Doe <https://janedoe.com> v} *)

     

       72
       72
       -
       val pp : Format.formatter -> t -> unit

+9 -9

lib/cito.ml

···

       1
       1
       -
       type t = [

     

       2
       2
       -
         | `Cites

     

       1
       1
       +
       type t =

     

       2
       2
       +
         [ `Cites

     

       3
       3
        
         | `CitesAsAuthority

     

       4
       4
        
         | `CitesAsDataSource

     

       5
       5
        
         | `CitesAsEvidence

     
···

       47
       47
        
         | `SharesPublicationVenueWith

     

       48
       48
        
         | `SharesFundingAgencyWith

     

       49
       49
        
         | `SharesAuthorInstitutionWith

     

       50
       50
       -
         | `Other of string

     

       51
       51
       -
       ]

     

       50
       50
       +
         | `Other of string ]

     

       52
       51
        
       

     

       53
       52
        
       let to_string = function

     

       54
       53
        
         | `Cites -> "cites"

     
···

       153
       152
        
         | "sharesauthorinstitutionwith" -> `SharesAuthorInstitutionWith

     

       154
       153
        
         | _ -> `Other s

     

       155
       154
        
       

     

       156
       156
       -
       let equal a b =

     

       157
       157
       -
         match a, b with

     

       158
       158
       -
         | `Other sa, `Other sb -> sa = sb

     

       159
       159
       -
         | _ -> a = b

     

       155
       155
       +
       let equal a b = match (a, b) with `Other sa, `Other sb -> sa = sb | _ -> a = b

     

       156
       156
       +
       let pp ppf t = Format.fprintf ppf "%s" (to_string t)

     

       160
       157
        
       

     

       161
       161
       -
       let pp ppf t = Format.fprintf ppf "%s" (to_string t)

     

       158
       158
       +
       let jsont =

     

       159
       159
       +
         let kind = "CiTO intent" in

     

       160
       160
       +
         let doc = "A Citation Typing Ontology intent annotation" in

     

       161
       161
       +
         Jsont.map ~kind ~doc ~dec:of_string ~enc:to_string Jsont.string

+87 -75

lib/cito.mli

···

       1
       1
       +
       (*---------------------------------------------------------------------------

     

       2
       2
       +
          Copyright (c) 2025 Anil Madhavapeddy. All rights reserved.

     

       3
       3
       +
          SPDX-License-Identifier: ISC

     

       4
       4
       +
         ---------------------------------------------------------------------------*)

     

       5
       5
       +
       

     

       1
       6
        
       (** Citation Typing Ontology (CiTO) intent annotations.

     

       2
       7
        
       

     

       3
       3
       -
           CiTO provides a structured vocabulary for describing the nature of citations.

     

       4
       4
       -
           This module implements support for CiTO annotations as used in the references extension.

     

       8
       8
       +
           CiTO provides a structured vocabulary for describing the nature of

     

       9
       9
       +
           citations. This module implements support for CiTO annotations as used in

     

       10
       10
       +
           the references extension.

     

       5
       11
        
       

     

       6
       12
        
           @see <https://purl.archive.org/spar/cito> Citation Typing Ontology

     

       7
       7
       -
           @see <https://sparontologies.github.io/cito/current/cito.html> CiTO Specification *)

     

       8
       8
       -
       

     

       9
       9
       -
       

     

       10
       10
       -
       (** CiTO citation intent annotation.

     

       13
       13
       +
           @see <https://sparontologies.github.io/cito/current/cito.html>

     

       14
       14
       +
             CiTO Specification *)

     

       11
       15
        
       

     

       12
       12
       -
           Represents the intent or nature of a citation using the Citation Typing Ontology.

     

       13
       13
       -
           Each variant corresponds to a specific CiTO property. The [`Other] variant allows

     

       14
       14
       -
           for custom or future CiTO terms not yet included in this library.

     

       15
       15
       -
       

     

       16
       16
       -
           {b Categories:}

     

       17
       17
       -
           - Factual: Citing for data, methods, evidence, or information

     

       18
       18
       -
           - Critical: Agreement, disagreement, correction, or qualification

     

       19
       19
       -
           - Rhetorical: Style-based citations (parody, ridicule, etc.)

     

       20
       20
       -
           - Relational: Document relationships and compilations

     

       21
       21
       -
           - Support: Providing or obtaining backing and context

     

       22
       22
       -
           - Exploratory: Speculation and recommendations

     

       23
       23
       -
           - Quotation: Direct quotes and excerpts

     

       24
       24
       -
           - Dialogue: Replies and responses

     

       25
       25
       -
           - Sharing: Common attributes between works *)

     

       26
       26
       -
       type t = [

     

       27
       27
       -
         | `Cites  (** The base citation property *)

     

       28
       28
       -
       

     

       29
       29
       -
         (* Factual citation intents *)

     

       30
       30
       -
         | `CitesAsAuthority  (** Cites as authoritative source *)

     

       16
       16
       +
       type t =

     

       17
       17
       +
         [ `Cites  (** The base citation property *)

     

       18
       18
       +
         | (* Factual citation intents *)

     

       19
       19
       +
           `CitesAsAuthority

     

       20
       20
       +
           (** Cites as authoritative source *)

     

       31
       21
        
         | `CitesAsDataSource  (** Cites as origin of data *)

     

       32
       22
        
         | `CitesAsEvidence  (** Cites for factual evidence *)

     

       33
       23
        
         | `CitesForInformation  (** Cites as information source *)

     

       34
       24
        
         | `UsesDataFrom  (** Uses data from cited work *)

     

       35
       25
        
         | `UsesMethodIn  (** Uses methodology from cited work *)

     

       36
       26
        
         | `UsesConclusionsFrom  (** Applies conclusions from cited work *)

     

       37
       37
       -
       

     

       38
       38
       -
         (* Agreement/disagreement *)

     

       39
       39
       -
         | `AgreesWith  (** Concurs with cited statements *)

     

       27
       27
       +
         | (* Agreement/disagreement *)

     

       28
       28
       +
           `AgreesWith

     

       29
       29
       +
           (** Concurs with cited statements *)

     

       40
       30
        
         | `DisagreesWith  (** Rejects cited statements *)

     

       41
       31
        
         | `Confirms  (** Validates facts in cited work *)

     

       42
       32
        
         | `Refutes  (** Disproves cited statements *)

     

       43
       33
        
         | `Disputes  (** Contests without definitive refutation *)

     

       44
       44
       -
       

     

       45
       45
       -
         (* Critical engagement *)

     

       46
       46
       -
         | `Critiques  (** Analyzes and finds fault *)

     

       34
       34
       +
         | (* Critical engagement *)

     

       35
       35
       +
           `Critiques

     

       36
       36
       +
           (** Analyzes and finds fault *)

     

       47
       37
        
         | `Qualifies  (** Places conditions on statements *)

     

       48
       38
        
         | `Corrects  (** Fixes errors in cited work *)

     

       49
       39
        
         | `Updates  (** Advances understanding beyond cited work *)

     

       50
       40
        
         | `Extends  (** Builds upon cited facts *)

     

       51
       51
       -
       

     

       52
       52
       -
         (* Rhetorical/stylistic *)

     

       53
       53
       -
         | `Parodies  (** Imitates for comic effect *)

     

       41
       41
       +
         | (* Rhetorical/stylistic *)

     

       42
       42
       +
           `Parodies

     

       43
       43
       +
           (** Imitates for comic effect *)

     

       54
       44
        
         | `Plagiarizes  (** Uses without acknowledgment *)

     

       55
       45
        
         | `Derides  (** Expresses contempt *)

     

       56
       46
        
         | `Ridicules  (** Mocks cited work *)

     

       57
       57
       -
       

     

       58
       58
       -
         (* Document relationships *)

     

       59
       59
       -
         | `Describes  (** Characterizes cited entity *)

     

       47
       47
       +
         | (* Document relationships *)

     

       48
       48
       +
           `Describes

     

       49
       49
       +
           (** Characterizes cited entity *)

     

       60
       50
        
         | `Documents  (** Records information about source *)

     

       61
       51
        
         | `CitesAsSourceDocument  (** Cites as foundational source *)

     

       62
       52
        
         | `CitesAsMetadataDocument  (** Cites containing metadata *)

     

       63
       53
        
         | `Compiles  (** Uses to create new work *)

     

       64
       54
        
         | `Reviews  (** Examines cited statements *)

     

       65
       55
        
         | `Retracts  (** Formally withdraws *)

     

       66
       66
       -
       

     

       67
       67
       -
         (* Support/context *)

     

       68
       68
       -
         | `Supports  (** Provides intellectual backing *)

     

       56
       56
       +
         | (* Support/context *)

     

       57
       57
       +
           `Supports

     

       58
       58
       +
           (** Provides intellectual backing *)

     

       69
       59
        
         | `GivesSupportTo  (** Provides support to citing entity *)

     

       70
       60
        
         | `ObtainsSupportFrom  (** Obtains backing from cited work *)

     

       71
       61
        
         | `GivesBackgroundTo  (** Provides context *)

     

       72
       62
        
         | `ObtainsBackgroundFrom  (** Obtains context from cited work *)

     

       73
       73
       -
       

     

       74
       74
       -
         (* Exploratory *)

     

       75
       75
       -
         | `SpeculatesOn  (** Theorizes without firm evidence *)

     

       63
       63
       +
         | (* Exploratory *)

     

       64
       64
       +
           `SpeculatesOn

     

       65
       65
       +
           (** Theorizes without firm evidence *)

     

       76
       66
        
         | `CitesAsPotentialSolution  (** Offers possible resolution *)

     

       77
       67
        
         | `CitesAsRecommendedReading  (** Suggests as further reading *)

     

       78
       68
        
         | `CitesAsRelated  (** Identifies as thematically connected *)

     

       79
       79
       -
       

     

       80
       80
       -
         (* Quotation/excerpting *)

     

       81
       81
       -
         | `IncludesQuotationFrom  (** Incorporates direct quotes *)

     

       69
       69
       +
         | (* Quotation/excerpting *)

     

       70
       70
       +
           `IncludesQuotationFrom

     

       71
       71
       +
           (** Incorporates direct quotes *)

     

       82
       72
        
         | `IncludesExcerptFrom  (** Uses non-quoted passages *)

     

       83
       83
       -
       

     

       84
       84
       -
         (* Dialogue *)

     

       85
       85
       -
         | `RepliesTo  (** Responds to cited statements *)

     

       73
       73
       +
         | (* Dialogue *)

     

       74
       74
       +
           `RepliesTo

     

       75
       75
       +
           (** Responds to cited statements *)

     

       86
       76
        
         | `HasReplyFrom  (** Evokes response *)

     

       87
       87
       -
       

     

       88
       88
       -
         (* Linking *)

     

       89
       89
       -
         | `LinksTo  (** Provides URL hyperlink *)

     

       90
       90
       -
       

     

       91
       91
       -
         (* Shared attribution *)

     

       92
       92
       -
         | `SharesAuthorWith  (** Common authorship *)

     

       77
       77
       +
         | (* Linking *)

     

       78
       78
       +
           `LinksTo

     

       79
       79
       +
           (** Provides URL hyperlink *)

     

       80
       80
       +
         | (* Shared attribution *)

     

       81
       81
       +
           `SharesAuthorWith

     

       82
       82
       +
           (** Common authorship *)

     

       93
       83
        
         | `SharesJournalWith  (** Published in same journal *)

     

       94
       84
        
         | `SharesPublicationVenueWith  (** Published in same venue *)

     

       95
       85
        
         | `SharesFundingAgencyWith  (** Funded by same agency *)

     

       96
       86
        
         | `SharesAuthorInstitutionWith  (** Authors share affiliation *)

     

       87
       87
       +
         | (* Extensibility *)

     

       88
       88
       +
           `Other of string

     

       89
       89
       +
           (** Custom or future CiTO term *) ]

     

       90
       90
       +
       (** CiTO citation intent annotation.

     

       97
       91
        
       

     

       98
       98
       -
         (* Extensibility *)

     

       99
       99
       -
         | `Other of string  (** Custom or future CiTO term *)

     

       100
       100
       -
       ]

     

       92
       92
       +
           Represents the intent or nature of a citation using the Citation Typing

     

       93
       93
       +
           Ontology. Each variant corresponds to a specific CiTO property. The [`Other]

     

       94
       94
       +
           variant allows for custom or future CiTO terms not yet included in this

     

       95
       95
       +
           library.

     

       101
       96
        
       

     

       97
       97
       +
           {b Categories:}

     

       98
       98
       +
           - Factual: Citing for data, methods, evidence, or information

     

       99
       99
       +
           - Critical: Agreement, disagreement, correction, or qualification

     

       100
       100
       +
           - Rhetorical: Style-based citations (parody, ridicule, etc.)

     

       101
       101
       +
           - Relational: Document relationships and compilations

     

       102
       102
       +
           - Support: Providing or obtaining backing and context

     

       103
       103
       +
           - Exploratory: Speculation and recommendations

     

       104
       104
       +
           - Quotation: Direct quotes and excerpts

     

       105
       105
       +
           - Dialogue: Replies and responses

     

       106
       106
       +
           - Sharing: Common attributes between works *)

     

       102
       107
        
       

     

       103
       108
        
       (** {1 Conversion} *)

     

       104
       109
        
       

     

       110
       110
       +
       val of_string : string -> t

     

       105
       111
        
       (** [of_string s] converts a CiTO term string to its variant representation.

     

       106
       112
        
       

     

       107
       113
        
           Recognized CiTO terms are converted to their corresponding variants.

     

       108
       114
        
           Unrecognized terms are wrapped in [`Other].

     

       109
       115
        
       

     

       110
       110
       -
           The comparison is case-insensitive for standard CiTO terms but preserves

     

       111
       111
       -
           the original case in [`Other] variants.

     

       116
       116
       +
           The comparison is case-insensitive for standard CiTO terms but preserves the

     

       117
       117
       +
           original case in [`Other] variants.

     

       112
       118
        
       

     

       113
       119
        
           {b Examples:}

     

       114
       120
        
           {[

     

       115
       115
       -
             of_string "cites"  (* returns `Cites *)

     

       116
       116
       -
             of_string "usesMethodIn"  (* returns `UsesMethodIn *)

     

       117
       117
       -
             of_string "citesAsRecommendedReading"  (* returns `CitesAsRecommendedReading *)

     

       118
       118
       -
             of_string "customTerm"  (* returns `Other "customTerm" *)

     

       121
       121
       +
             of_string "cites" (* returns `Cites *) of_string "usesMethodIn"

     

       122
       122
       +
               (* returns `UsesMethodIn *) of_string

     

       123
       123
       +
               "citesAsRecommendedReading" (* returns `CitesAsRecommendedReading *)

     

       124
       124
       +
               of_string "customTerm" (* returns `Other "customTerm" *)

     

       119
       125
        
           ]} *)

     

       120
       120
       -
       val of_string : string -> t

     

       121
       126
        
       

     

       122
       122
       -
       (** [to_string t] converts a CiTO variant to its canonical string representation.

     

       127
       127
       +
       val to_string : t -> string

     

       128
       128
       +
       (** [to_string t] converts a CiTO variant to its canonical string

     

       129
       129
       +
           representation.

     

       123
       130
        
       

     

       124
       131
        
           Standard CiTO terms use their official CiTO local names (camelCase).

     

       125
       132
        
           [`Other] variants return the wrapped string unchanged.

     

       126
       133
        
       

     

       127
       134
        
           {b Examples:}

     

       128
       135
        
           {[

     

       129
       129
       -
             to_string `Cites  (* returns "cites" *)

     

       130
       130
       -
             to_string `UsesMethodIn  (* returns "usesMethodIn" *)

     

       131
       131
       -
             to_string (`Other "customTerm")  (* returns "customTerm" *)

     

       136
       136
       +
             to_string `Cites (* returns "cites" *) to_string `UsesMethodIn

     

       137
       137
       +
               (* returns "usesMethodIn" *) to_string (`Other "customTerm")

     

       138
       138
       +
             (* returns "customTerm" *)

     

       132
       139
        
           ]} *)

     

       133
       133
       -
       val to_string : t -> string

     

       134
       134
       -
       

     

       135
       140
        
       

     

       136
       141
        
       (** {1 Comparison} *)

     

       137
       142
        
       

     

       143
       143
       +
       val equal : t -> t -> bool

     

       138
       144
        
       (** [equal a b] tests equality between two CiTO annotations.

     

       139
       145
        
       

     

       140
       140
       -
           Two annotations are equal if they represent the same CiTO term.

     

       141
       141
       -
           For [`Other] variants, string comparison is case-sensitive. *)

     

       142
       142
       -
       val equal : t -> t -> bool

     

       146
       146
       +
           Two annotations are equal if they represent the same CiTO term. For [`Other]

     

       147
       147
       +
           variants, string comparison is case-sensitive. *)

     

       143
       148
        
       

     

       149
       149
       +
       (** {1 Jsont Type} *)

     

       150
       150
       +
       

     

       151
       151
       +
       val jsont : t Jsont.t

     

       152
       152
       +
       (** Declarative JSON type for CiTO annotations.

     

       153
       153
       +
       

     

       154
       154
       +
           Maps CiTO intent strings to the corresponding variants. Unknown intents are

     

       155
       155
       +
           mapped to [`Other s]. *)

     

       144
       156
        
       

     

       145
       157
        
       (** {1 Pretty Printing} *)

     

       146
       158
        
       

     

       159
       159
       +
       val pp : Format.formatter -> t -> unit

     

       147
       160
        
       (** [pp ppf t] pretty prints a CiTO annotation to the formatter.

     

       148
       161
        
       

     

       149
       162
        
           {b Example output:}

     

       150
       163
        
           {v citesAsRecommendedReading v} *)

     

       151
       151
       -
       val pp : Format.formatter -> t -> unit

+1 -1

lib/dune

···

       1
       1
        
       (library

     

       2
       2
        
        (name jsonfeed)

     

       3
       3
        
        (public_name jsonfeed)

     

       4
       4
       -
        (libraries jsonm ptime fmt))

     

       4
       4
       +
        (libraries jsont jsont.bytesrw bytesrw ptime))

+24 -12

lib/hub.ml

···

       1
       1
       -
       (** Hub endpoints for real-time notifications. *)

     

       1
       1
       +
       (*---------------------------------------------------------------------------

     

       2
       2
       +
          Copyright (c) 2024 Anil Madhavapeddy. All rights reserved.

     

       3
       3
       +
          SPDX-License-Identifier: ISC

     

       4
       4
       +
         ---------------------------------------------------------------------------*)

     

       2
       5
        
       

     

       3
       3
       -
       type t = {

     

       4
       4
       -
         type_ : string;

     

       5
       5
       -
         url : string;

     

       6
       6
       -
       }

     

       6
       6
       +
       module Unknown = struct

     

       7
       7
       +
         type t = Jsont.json

     

       7
       8
        
       

     

       8
       8
       -
       let create ~type_ ~url () =

     

       9
       9
       -
         { type_; url }

     

       9
       9
       +
         let empty = Jsont.Object ([], Jsont.Meta.none)

     

       10
       10
       +
         let is_empty = function Jsont.Object ([], _) -> true | _ -> false

     

       11
       11
       +
       end

     

       12
       12
       +
       

     

       13
       13
       +
       type t = { type_ : string; url : string; unknown : Unknown.t }

     

       10
       14
        
       

     

       15
       15
       +
       let create ~type_ ~url ?(unknown = Unknown.empty) () = { type_; url; unknown }

     

       11
       16
        
       let type_ t = t.type_

     

       12
       17
        
       let url t = t.url

     

       18
       18
       +
       let unknown t = t.unknown

     

       19
       19
       +
       let equal a b = a.type_ = b.type_ && a.url = b.url

     

       20
       20
       +
       let pp ppf t = Format.fprintf ppf "%s: %s" t.type_ t.url

     

       13
       21
        
       

     

       14
       14
       -
       let equal a b =

     

       15
       15
       -
         a.type_ = b.type_ && a.url = b.url

     

       16
       16
       -
       

     

       17
       17
       -
       let pp ppf t =

     

       18
       18
       -
         Format.fprintf ppf "%s: %s" t.type_ t.url

     

       22
       22
       +
       let jsont =

     

       23
       23
       +
         let kind = "Hub" in

     

       24
       24
       +
         let doc = "A hub endpoint" in

     

       25
       25
       +
         let create_obj type_ url unknown = create ~type_ ~url ~unknown () in

     

       26
       26
       +
         Jsont.Object.map ~kind ~doc create_obj

     

       27
       27
       +
         |> Jsont.Object.mem "type" Jsont.string ~enc:type_

     

       28
       28
       +
         |> Jsont.Object.mem "url" Jsont.string ~enc:url

     

       29
       29
       +
         |> Jsont.Object.keep_unknown Jsont.json_mems ~enc:unknown

     

       30
       30
       +
         |> Jsont.Object.finish

+37 -13

lib/hub.mli

···

       1
       1
       +
       (*---------------------------------------------------------------------------

     

       2
       2
       +
          Copyright (c) 2024 Anil Madhavapeddy. All rights reserved.

     

       3
       3
       +
          SPDX-License-Identifier: ISC

     

       4
       4
       +
         ---------------------------------------------------------------------------*)

     

       5
       5
       +
       

     

       1
       6
        
       (** Hub endpoints for real-time notifications.

     

       2
       7
        
       

     

       3
       8
        
           Hubs describe endpoints that can be used to subscribe to real-time

     
···

       6
       11
        
       

     

       7
       12
        
           @see <https://www.jsonfeed.org/version/1.1/> JSON Feed Specification *)

     

       8
       13
        
       

     

       14
       14
       +
       type t

     

       15
       15
       +
       (** The type representing a hub endpoint. *)

     

       9
       16
        
       

     

       10
       10
       -
       (** The type representing a hub endpoint. *)

     

       11
       11
       -
       type t

     

       17
       17
       +
       (** {1 Unknown Fields} *)

     

       18
       18
       +
       

     

       19
       19
       +
       module Unknown : sig

     

       20
       20
       +
         type t = Jsont.json

     

       21
       21
       +
         (** Unknown/unrecognized JSON object members as a generic JSON object. Useful

     

       22
       22
       +
             for preserving fields from custom extensions or future spec versions. *)

     

       12
       23
        
       

     

       24
       24
       +
         val empty : t

     

       25
       25
       +
         (** [empty] is the empty list of unknown fields. *)

     

       26
       26
       +
       

     

       27
       27
       +
         val is_empty : t -> bool

     

       28
       28
       +
         (** [is_empty u] returns [true] if there are no unknown fields. *)

     

       29
       29
       +
       end

     

       30
       30
       +
       

     

       31
       31
       +
       (** {1 Jsont Type} *)

     

       32
       32
       +
       

     

       33
       33
       +
       val jsont : t Jsont.t

     

       34
       34
       +
       (** Declarative JSON type for hubs.

     

       35
       35
       +
       

     

       36
       36
       +
           Maps JSON objects with "type" and "url" fields (both required). *)

     

       13
       37
        
       

     

       14
       38
        
       (** {1 Construction} *)

     

       15
       39
        
       

     

       16
       16
       -
       (** [create ~type_ ~url ()] creates a hub object.

     

       40
       40
       +
       val create : type_:string -> url:string -> ?unknown:Unknown.t -> unit -> t

     

       41
       41
       +
       (** [create ~type_ ~url ?unknown ()] creates a hub object.

     

       17
       42
        
       

     

       18
       43
        
           @param type_ The type of hub protocol (e.g., ["rssCloud"], ["WebSub"])

     

       19
       44
        
           @param url The URL endpoint for the hub

     

       45
       45
       +
           @param unknown Unknown/custom fields for extensions (default: empty)

     

       20
       46
        
       

     

       21
       47
        
           {b Example:}

     

       22
       48
        
           {[

     

       23
       23
       -
             let hub = Hub.create

     

       24
       24
       -
               ~type_:"WebSub"

     

       25
       25
       -
               ~url:"https://pubsubhubbub.appspot.com/" ()

     

       49
       49
       +
             let hub =

     

       50
       50
       +
               Hub.create ~type_:"WebSub" ~url:"https://pubsubhubbub.appspot.com/" ()

     

       26
       51
        
           ]} *)

     

       27
       27
       -
       val create : type_:string -> url:string -> unit -> t

     

       28
       28
       -
       

     

       29
       52
        
       

     

       30
       53
        
       (** {1 Accessors} *)

     

       31
       54
        
       

     

       55
       55
       +
       val type_ : t -> string

     

       32
       56
        
       (** [type_ t] returns the hub's protocol type. *)

     

       33
       33
       -
       val type_ : t -> string

     

       34
       57
        
       

     

       35
       35
       -
       (** [url t] returns the hub's endpoint URL. *)

     

       36
       58
        
       val url : t -> string

     

       59
       59
       +
       (** [url t] returns the hub's endpoint URL. *)

     

       37
       60
        
       

     

       61
       61
       +
       val unknown : t -> Unknown.t

     

       62
       62
       +
       (** [unknown t] returns unrecognized fields from the JSON. *)

     

       38
       63
        
       

     

       39
       64
        
       (** {1 Comparison} *)

     

       40
       65
        
       

     

       41
       41
       -
       (** [equal a b] tests equality between two hubs. *)

     

       42
       66
        
       val equal : t -> t -> bool

     

       43
       43
       -
       

     

       67
       67
       +
       (** [equal a b] tests equality between two hubs. *)

     

       44
       68
        
       

     

       45
       69
        
       (** {1 Pretty Printing} *)

     

       46
       70
        
       

     

       71
       71
       +
       val pp : Format.formatter -> t -> unit

     

       47
       72
        
       (** [pp ppf t] pretty prints a hub to the formatter.

     

       48
       73
        
       

     

       49
       74
        
           The output is human-readable and suitable for debugging.

     

       50
       75
        
       

     

       51
       76
        
           {b Example output:}

     

       52
       77
        
           {v WebSub: https://pubsubhubbub.appspot.com/ v} *)

     

       53
       53
       -
       val pp : Format.formatter -> t -> unit

+90 -33

lib/item.ml

···

       1
       1
       -
       (** Feed items in a JSON Feed. *)

     

       1
       1
       +
       (*---------------------------------------------------------------------------

     

       2
       2
       +
          Copyright (c) 2024 Anil Madhavapeddy. All rights reserved.

     

       3
       3
       +
          SPDX-License-Identifier: ISC

     

       4
       4
       +
         ---------------------------------------------------------------------------*)

     

       2
       5
        
       

     

       3
       3
       -
       type content =

     

       4
       4
       -
         [ `Html of string

     

       5
       5
       -
         | `Text of string

     

       6
       6
       -
         | `Both of string * string

     

       7
       7
       -
         ]

     

       6
       6
       +
       module Unknown = struct

     

       7
       7
       +
         type t = Jsont.json

     

       8
       8
       +
       

     

       9
       9
       +
         let empty = Jsont.Object ([], Jsont.Meta.none)

     

       10
       10
       +
         let is_empty = function Jsont.Object ([], _) -> true | _ -> false

     

       11
       11
       +
       end

     

       12
       12
       +
       

     

       13
       13
       +
       type content = [ `Html of string | `Text of string | `Both of string * string ]

     

       8
       14
        
       

     

       9
       15
        
       type t = {

     

       10
       16
        
         id : string;

     
···

       22
       28
        
         language : string option;

     

       23
       29
        
         attachments : Attachment.t list option;

     

       24
       30
        
         references : Reference.t list option;

     

       31
       31
       +
         unknown : Unknown.t;

     

       25
       32
        
       }

     

       26
       33
        
       

     

       27
       34
        
       let create ~id ~content ?url ?external_url ?title ?summary ?image ?banner_image

     

       28
       28
       -
           ?date_published ?date_modified ?authors ?tags ?language ?attachments ?references () =

     

       35
       35
       +
           ?date_published ?date_modified ?authors ?tags ?language ?attachments

     

       36
       36
       +
           ?references ?(unknown = Unknown.empty) () =

     

       29
       37
        
         {

     

       30
       38
        
           id;

     

       31
       39
        
           content;

     
···

       42
       50
        
           language;

     

       43
       51
        
           attachments;

     

       44
       52
        
           references;

     

       53
       53
       +
           unknown;

     

       45
       54
        
         }

     

       46
       55
        
       

     

       47
       56
        
       let id t = t.id

     
···

       59
       68
        
       let language t = t.language

     

       60
       69
        
       let attachments t = t.attachments

     

       61
       70
        
       let references t = t.references

     

       71
       71
       +
       let unknown t = t.unknown

     

       62
       72
        
       

     

       63
       73
        
       let content_html t =

     

       64
       74
        
         match t.content with

     
···

       72
       82
        
         | `Text text -> Some text

     

       73
       83
        
         | `Both (_, text) -> Some text

     

       74
       84
        
       

     

       75
       75
       -
       let equal a b =

     

       76
       76
       -
         (* Items are equal if they have the same ID *)

     

       77
       77
       -
         a.id = b.id

     

       78
       78
       -
       

     

       79
       79
       -
       let compare a b =

     

       80
       80
       -
         (* Compare by publication date, with items without dates considered older *)

     

       81
       81
       -
         match a.date_published, b.date_published with

     

       82
       82
       -
         | None, None -> 0

     

       83
       83
       -
         | None, Some _ -> -1  (* Items without dates are "older" *)

     

       84
       84
       -
         | Some _, None -> 1

     

       85
       85
       -
         | Some da, Some db -> Ptime.compare da db

     

       86
       86
       -
       

     

       87
       87
       -
       let pp_content ppf = function

     

       88
       88
       -
         | `Html html ->

     

       89
       89
       -
             Format.fprintf ppf "HTML (%d chars)" (String.length html)

     

       90
       90
       -
         | `Text text ->

     

       91
       91
       -
             Format.fprintf ppf "Text (%d chars)" (String.length text)

     

       92
       92
       -
         | `Both (html, text) ->

     

       93
       93
       -
             Format.fprintf ppf "Both (HTML: %d chars, Text: %d chars)"

     

       94
       94
       -
               (String.length html) (String.length text)

     

       85
       85
       +
       let equal a b = a.id = b.id

     

       86
       86
       +
       let compare a b = Option.compare Ptime.compare a.date_published b.date_published

     

       95
       87
        
       

     

       96
       88
        
       let pp ppf t =

     

       97
       97
       -
         match t.date_published, t.title with

     

       89
       89
       +
         match (t.date_published, t.title) with

     

       98
       90
        
         | Some date, Some title ->

     

       99
       99
       -
             (* Use Ptime's date formatting *)

     

       100
       91
        
             let (y, m, d), _ = Ptime.to_date_time date in

     

       101
       92
        
             Format.fprintf ppf "[%04d-%02d-%02d] %s (%s)" y m d title t.id

     

       102
       93
        
         | Some date, None ->

     

       103
       94
        
             let (y, m, d), _ = Ptime.to_date_time date in

     

       104
       95
        
             Format.fprintf ppf "[%04d-%02d-%02d] %s" y m d t.id

     

       105
       105
       -
         | None, Some title ->

     

       106
       106
       -
             Format.fprintf ppf "%s (%s)" title t.id

     

       107
       107
       -
         | None, None ->

     

       108
       108
       -
             Format.fprintf ppf "%s" t.id

     

       96
       96
       +
         | None, Some title -> Format.fprintf ppf "%s (%s)" title t.id

     

       97
       97
       +
         | None, None -> Format.fprintf ppf "%s" t.id

     

       98
       98
       +
       

     

       99
       99
       +
       let pp_summary ppf t =

     

       100
       100
       +
         Format.fprintf ppf "%s" (Option.value ~default:t.id t.title)

     

       101
       101
       +
       

     

       102
       102
       +
       (* Jsont type *)

     

       103
       103
       +
       

     

       104
       104
       +
       let jsont =

     

       105
       105
       +
         let kind = "Item" in

     

       106
       106
       +
         let doc = "A JSON Feed item" in

     

       107
       107
       +
       

     

       108
       108
       +
         (* Helper to construct item from JSON fields *)

     

       109
       109
       +
         let make_from_json id content_html content_text url external_url title summary

     

       110
       110
       +
             image banner_image date_published date_modified authors tags language

     

       111
       111
       +
             attachments references _extensions unknown =

     

       112
       112
       +
           (* Determine content from content_html and content_text *)

     

       113
       113
       +
           let content =

     

       114
       114
       +
             match (content_html, content_text) with

     

       115
       115
       +
             | Some html, Some text -> `Both (html, text)

     

       116
       116
       +
             | Some html, None -> `Html html

     

       117
       117
       +
             | None, Some text -> `Text text

     

       118
       118
       +
             | None, None ->

     

       119
       119
       +
                 Jsont.Error.msg Jsont.Meta.none

     

       120
       120
       +
                   "Item must have at least one of content_html or content_text"

     

       121
       121
       +
           in

     

       122
       122
       +
           {

     

       123
       123
       +
             id;

     

       124
       124
       +
             content;

     

       125
       125
       +
             url;

     

       126
       126
       +
             external_url;

     

       127
       127
       +
             title;

     

       128
       128
       +
             summary;

     

       129
       129
       +
             image;

     

       130
       130
       +
             banner_image;

     

       131
       131
       +
             date_published;

     

       132
       132
       +
             date_modified;

     

       133
       133
       +
             authors;

     

       134
       134
       +
             tags;

     

       135
       135
       +
             language;

     

       136
       136
       +
             attachments;

     

       137
       137
       +
             references;

     

       138
       138
       +
             unknown;

     

       139
       139
       +
           }

     

       140
       140
       +
         in

     

       141
       141
       +
       

     

       142
       142
       +
         Jsont.Object.map ~kind ~doc make_from_json

     

       143
       143
       +
         |> Jsont.Object.mem "id" Jsont.string ~enc:id

     

       144
       144
       +
         |> Jsont.Object.opt_mem "content_html" Jsont.string ~enc:content_html

     

       145
       145
       +
         |> Jsont.Object.opt_mem "content_text" Jsont.string ~enc:content_text

     

       146
       146
       +
         |> Jsont.Object.opt_mem "url" Jsont.string ~enc:url

     

       147
       147
       +
         |> Jsont.Object.opt_mem "external_url" Jsont.string ~enc:external_url

     

       148
       148
       +
         |> Jsont.Object.opt_mem "title" Jsont.string ~enc:title

     

       149
       149
       +
         |> Jsont.Object.opt_mem "summary" Jsont.string ~enc:summary

     

       150
       150
       +
         |> Jsont.Object.opt_mem "image" Jsont.string ~enc:image

     

       151
       151
       +
         |> Jsont.Object.opt_mem "banner_image" Jsont.string ~enc:banner_image

     

       152
       152
       +
         |> Jsont.Object.opt_mem "date_published" Rfc3339.jsont ~enc:date_published

     

       153
       153
       +
         |> Jsont.Object.opt_mem "date_modified" Rfc3339.jsont ~enc:date_modified

     

       154
       154
       +
         |> Jsont.Object.opt_mem "authors" (Jsont.list Author.jsont) ~enc:authors

     

       155
       155
       +
         |> Jsont.Object.opt_mem "tags" (Jsont.list Jsont.string) ~enc:tags

     

       156
       156
       +
         |> Jsont.Object.opt_mem "language" Jsont.string ~enc:language

     

       157
       157
       +
         |> Jsont.Object.opt_mem "attachments"

     

       158
       158
       +
              (Jsont.list Attachment.jsont)

     

       159
       159
       +
              ~enc:attachments

     

       160
       160
       +
         |> Jsont.Object.opt_mem "_references"

     

       161
       161
       +
              (Jsont.list Reference.jsont)

     

       162
       162
       +
              ~enc:references

     

       163
       163
       +
         |> Jsont.Object.opt_mem "_extensions" Jsont.json_object ~enc:(fun _t -> None)

     

       164
       164
       +
         |> Jsont.Object.keep_unknown Jsont.json_mems ~enc:unknown

     

       165
       165
       +
         |> Jsont.Object.finish

+34 -140

lib/item.mli

···

       1
       1
       +
       (*---------------------------------------------------------------------------

     

       2
       2
       +
          Copyright (c) 2025 Anil Madhavapeddy. All rights reserved.

     

       3
       3
       +
          SPDX-License-Identifier: ISC

     

       4
       4
       +
         ---------------------------------------------------------------------------*)

     

       5
       5
       +
       

     

       1
       6
        
       (** Feed items in a JSON Feed.

     

       2
       7
        
       

     

       3
       3
       -
           An item represents a single entry in a feed, such as a blog post, podcast episode,

     

       4
       4
       -
           or microblog entry. Each item must have a unique identifier and content.

     

       8
       8
       +
           An item represents a single entry in a feed, such as a blog post, podcast

     

       9
       9
       +
           episode, or microblog entry. Each item must have a unique identifier and

     

       10
       10
       +
           content.

     

       5
       11
        
       

     

       6
       12
        
           @see <https://www.jsonfeed.org/version/1.1/> JSON Feed Specification *)

     

       7
       13
        
       

     

       8
       8
       -
       

     

       9
       9
       -
       (** The type representing a feed item. *)

     

       10
       14
        
       type t

     

       15
       15
       +
       (** The type representing a feed item. *)

     

       11
       16
        
       

     

       17
       17
       +
       type content = [ `Html of string | `Text of string | `Both of string * string ]

     

       12
       18
        
       (** Content representation for an item.

     

       13
       19
        
       

     

       14
       14
       -
           The JSON Feed specification requires that each item has at least one

     

       15
       15
       -
           form of content. This type enforces that requirement at compile time.

     

       20
       20
       +
           The JSON Feed specification requires that each item has at least one form of

     

       21
       21
       +
           content. This type enforces that requirement at compile time.

     

       16
       22
        
       

     

       17
       23
        
           - [`Html s]: Item has HTML content only

     

       18
       24
        
           - [`Text s]: Item has plain text content only

     

       19
       25
        
           - [`Both (html, text)]: Item has both HTML and plain text versions *)

     

       20
       20
       -
       type content =

     

       21
       21
       -
         [ `Html of string

     

       22
       22
       -
         | `Text of string

     

       23
       23
       -
         | `Both of string * string

     

       24
       24
       -
         ]

     

       25
       26
        
       

     

       27
       27
       +
       (** {1 Unknown Fields} *)

     

       26
       28
        
       

     

       27
       27
       -
       (** {1 Construction} *)

     

       29
       29
       +
       module Unknown : sig

     

       30
       30
       +
         type t = Jsont.json

     

       31
       31
       +
         (** Unknown/unrecognized JSON object members as a generic JSON object. Useful

     

       32
       32
       +
             for preserving fields from custom extensions or future spec versions. *)

     

       28
       33
        
       

     

       29
       29
       -
       (** [create ~id ~content ?url ?external_url ?title ?summary ?image ?banner_image

     

       30
       30
       -
           ?date_published ?date_modified ?authors ?tags ?language ?attachments ()]

     

       31
       31
       -
           creates a feed item.

     

       34
       34
       +
         val empty : t

     

       35
       35
       +
         (** [empty] is the empty list of unknown fields. *)

     

       32
       36
        
       

     

       33
       33
       -
           @param id Unique identifier for the item (required). Should be a full URL if possible.

     

       34
       34
       -
           @param content The item's content in HTML and/or plain text (required)

     

       35
       35
       -
           @param url Permalink to the item

     

       36
       36
       -
           @param external_url URL of an external resource (useful for linkblogs)

     

       37
       37
       -
           @param title Plain text title of the item

     

       38
       38
       -
           @param summary Plain text summary/excerpt of the item

     

       39
       39
       -
           @param image URL of the main featured image for the item

     

       40
       40
       -
           @param banner_image URL of a banner image for the item

     

       41
       41
       -
           @param date_published Publication date/time (RFC 3339 format)

     

       42
       42
       -
           @param date_modified Last modification date/time (RFC 3339 format)

     

       43
       43
       -
           @param authors Item-specific authors (overrides feed-level authors)

     

       44
       44
       -
           @param tags Plain text tags/categories for the item

     

       45
       45
       -
           @param language Primary language of the item (RFC 5646 format, e.g. ["en-US"])

     

       46
       46
       -
           @param attachments Related resources like audio files or downloads

     

       47
       47
       -
           @param references References to cited sources (extension)

     

       37
       37
       +
         val is_empty : t -> bool

     

       38
       38
       +
         (** [is_empty u] returns [true] if there are no unknown fields. *)

     

       39
       39
       +
       end

     

       48
       40
        
       

     

       49
       49
       -
           {b Examples:}

     

       50
       50
       -
           {[

     

       51
       51
       -
             (* Simple blog post *)

     

       52
       52
       -
             let item = Item.create

     

       53
       53
       -
               ~id:"https://example.com/posts/42"

     

       54
       54
       -
               ~content:(`Html "<p>Hello, world!</p>")

     

       55
       55
       -
               ~title:"My First Post"

     

       56
       56
       -
               ~url:"https://example.com/posts/42" ()

     

       41
       41
       +
       (** {1 Jsont Type} *)

     

       57
       42
        
       

     

       58
       58
       -
             (* Microblog entry with plain text *)

     

       59
       59
       -
             let item = Item.create

     

       60
       60
       -
               ~id:"https://example.com/micro/123"

     

       61
       61
       -
               ~content:(`Text "Just posted a new photo!")

     

       62
       62
       -
               ~date_published:(Ptime.of_float_s (Unix.time ()) |> Option.get) ()

     

       43
       43
       +
       val jsont : t Jsont.t

     

       44
       44
       +
       (** Declarative JSON type for feed items.

     

       63
       45
        
       

     

       64
       64
       -
             (* Article with both HTML and plain text *)

     

       65
       65
       -
             let item = Item.create

     

       66
       66
       -
               ~id:"https://example.com/article/99"

     

       67
       67
       -
               ~content:(`Both ("<p>Rich content</p>", "Plain version"))

     

       68
       68
       -
               ~title:"Article Title"

     

       69
       69
       -
               ~tags:["ocaml"; "programming"] ()

     

       46
       46
       +
           Maps JSON objects with "id" (required), content fields, and various optional

     

       47
       47
       +
           metadata. The content must have at least one of "content_html" or

     

       48
       48
       +
           "content_text". *)

     

       70
       49
        
       

     

       71
       71
       -
             (* Podcast episode with attachment *)

     

       72
       72
       -
             let attachment = Attachment.create

     

       73
       73
       -
               ~url:"https://example.com/ep1.mp3"

     

       74
       74
       -
               ~mime_type:"audio/mpeg"

     

       75
       75
       -
               ~duration_in_seconds:1800 () in

     

       76
       76
       -
             let item = Item.create

     

       77
       77
       -
               ~id:"https://example.com/podcast/1"

     

       78
       78
       -
               ~content:(`Html "<p>Episode description</p>")

     

       79
       79
       -
               ~title:"Episode 1"

     

       80
       80
       -
               ~attachments:[attachment] ()

     

       50
       50
       +
       (** {1 Construction} *)

     

       81
       51
        
       

     

       82
       82
       -
             (* Article with references *)

     

       83
       83
       -
             let reference = Reference.create

     

       84
       84
       -
               ~url:"https://doi.org/10.5281/zenodo.16755947"

     

       85
       85
       -
               ~doi:"10.5281/zenodo.16755947"

     

       86
       86
       -
               ~cito:[`CitesAsRecommendedReading; `UsesMethodIn] () in

     

       87
       87
       -
             let item = Item.create

     

       88
       88
       -
               ~id:"https://doi.org/10.59350/krw9n-dv417"

     

       89
       89
       -
               ~content:(`Html "<p>Research article content</p>")

     

       90
       90
       -
               ~title:"One Million IUPAC names #4: a lot is happening"

     

       91
       91
       -
               ~url:"https://chem-bla-ics.linkedchemistry.info/2025/08/09/one-million-iupac-names-4.html"

     

       92
       92
       -
               ~references:[reference] ()

     

       93
       93
       -
           ]} *)

     

       94
       52
        
       val create :

     

       95
       53
        
         id:string ->

     

       96
       54
        
         content:content ->

     
···

       107
       65
        
         ?language:string ->

     

       108
       66
        
         ?attachments:Attachment.t list ->

     

       109
       67
        
         ?references:Reference.t list ->

     

       68
       68
       +
         ?unknown:Unknown.t ->

     

       110
       69
        
         unit ->

     

       111
       70
        
         t

     

       112
       112
       -
       

     

       113
       71
        
       

     

       114
       72
        
       (** {1 Accessors} *)

     

       115
       73
        
       

     

       116
       116
       -
       (** [id t] returns the item's unique identifier. *)

     

       117
       74
        
       val id : t -> string

     

       118
       118
       -
       

     

       119
       119
       -
       (** [content t] returns the item's content. *)

     

       120
       75
        
       val content : t -> content

     

       121
       121
       -
       

     

       122
       122
       -
       (** [url t] returns the item's permalink URL, if set. *)

     

       76
       76
       +
       val content_html : t -> string option

     

       77
       77
       +
       val content_text : t -> string option

     

       123
       78
        
       val url : t -> string option

     

       124
       124
       -
       

     

       125
       125
       -
       (** [external_url t] returns the external resource URL, if set. *)

     

       126
       79
        
       val external_url : t -> string option

     

       127
       127
       -
       

     

       128
       128
       -
       (** [title t] returns the item's title, if set. *)

     

       129
       80
        
       val title : t -> string option

     

       130
       130
       -
       

     

       131
       131
       -
       (** [summary t] returns the item's summary, if set. *)

     

       132
       81
        
       val summary : t -> string option

     

       133
       133
       -
       

     

       134
       134
       -
       (** [image t] returns the item's featured image URL, if set. *)

     

       135
       82
        
       val image : t -> string option

     

       136
       136
       -
       

     

       137
       137
       -
       (** [banner_image t] returns the item's banner image URL, if set. *)

     

       138
       83
        
       val banner_image : t -> string option

     

       139
       139
       -
       

     

       140
       140
       -
       (** [date_published t] returns the item's publication date, if set. *)

     

       141
       84
        
       val date_published : t -> Ptime.t option

     

       142
       142
       -
       

     

       143
       143
       -
       (** [date_modified t] returns the item's last modification date, if set. *)

     

       144
       85
        
       val date_modified : t -> Ptime.t option

     

       145
       145
       -
       

     

       146
       146
       -
       (** [authors t] returns the item's authors, if set. *)

     

       147
       86
        
       val authors : t -> Author.t list option

     

       148
       148
       -
       

     

       149
       149
       -
       (** [tags t] returns the item's tags, if set. *)

     

       150
       87
        
       val tags : t -> string list option

     

       151
       151
       -
       

     

       152
       152
       -
       (** [language t] returns the item's language code, if set. *)

     

       153
       88
        
       val language : t -> string option

     

       154
       154
       -
       

     

       155
       155
       -
       (** [attachments t] returns the item's attachments, if set. *)

     

       156
       89
        
       val attachments : t -> Attachment.t list option

     

       157
       157
       -
       

     

       158
       158
       -
       (** [references t] returns the item's references, if set. *)

     

       159
       90
        
       val references : t -> Reference.t list option

     

       160
       160
       -
       

     

       161
       161
       -
       

     

       162
       162
       -
       (** {1 Content Helpers} *)

     

       163
       163
       -
       

     

       164
       164
       -
       (** [content_html t] extracts HTML content from the item.

     

       165
       165
       -
       

     

       166
       166
       -
           Returns [Some html] if the item has HTML content (either [Html] or [Both]),

     

       167
       167
       -
           [None] otherwise. *)

     

       168
       168
       -
       val content_html : t -> string option

     

       169
       169
       -
       

     

       170
       170
       -
       (** [content_text t] extracts plain text content from the item.

     

       171
       171
       -
       

     

       172
       172
       -
           Returns [Some text] if the item has plain text content (either [Text] or [Both]),

     

       173
       173
       -
           [None] otherwise. *)

     

       174
       174
       -
       val content_text : t -> string option

     

       175
       175
       -
       

     

       91
       91
       +
       val unknown : t -> Unknown.t

     

       176
       92
        
       

     

       177
       93
        
       (** {1 Comparison} *)

     

       178
       94
        
       

     

       179
       179
       -
       (** [equal a b] tests equality between two items.

     

       180
       180
       -
       

     

       181
       181
       -
           Items are considered equal if they have the same ID. *)

     

       182
       95
        
       val equal : t -> t -> bool

     

       183
       183
       -
       

     

       184
       184
       -
       (** [compare a b] compares two items by their publication dates.

     

       185
       185
       -
       

     

       186
       186
       -
           Items without publication dates are considered older than items with dates.

     

       187
       187
       -
           Useful for sorting items chronologically. *)

     

       188
       96
        
       val compare : t -> t -> int

     

       189
       189
       -
       

     

       190
       97
        
       

     

       191
       98
        
       (** {1 Pretty Printing} *)

     

       192
       99
        
       

     

       193
       193
       -
       (** [pp ppf t] pretty prints an item to the formatter.

     

       194
       194
       -
       

     

       195
       195
       -
           The output is human-readable and suitable for debugging.

     

       196
       196
       -
       

     

       197
       197
       -
           {b Example output:}

     

       198
       198
       -
           {v [2024-11-03] My First Post (https://example.com/posts/42) v} *)

     

       199
       100
        
       val pp : Format.formatter -> t -> unit

     

       200
       200
       -
       

     

       201
       201
       -
       (** [pp_content ppf content] pretty prints content to the formatter.

     

       202
       202
       -
       

     

       203
       203
       -
           {b Example output:}

     

       204
       204
       -
           {v HTML (123 chars) v}

     

       205
       205
       -
           {v Text (56 chars) v}

     

       206
       206
       -
           {v Both (HTML: 123 chars, Text: 56 chars) v} *)

     

       207
       207
       -
       val pp_content : Format.formatter -> content -> unit

     

       101
       101
       +
       val pp_summary : Format.formatter -> t -> unit

+99 -515

lib/jsonfeed.ml

···

       1
       1
       -
       (** JSON Feed format parser and serializer. *)

     

       2
       2
       -
       

     

       3
       3
       -
       exception Invalid_feed of string

     

       1
       1
       +
       (*---------------------------------------------------------------------------

     

       2
       2
       +
          Copyright (c) 2024 Anil Madhavapeddy. All rights reserved.

     

       3
       3
       +
          SPDX-License-Identifier: ISC

     

       4
       4
       +
         ---------------------------------------------------------------------------*)

     

       4
       5
        
       

     

       6
       6
       +
       module Rfc3339 = Rfc3339

     

       7
       7
       +
       module Cito = Cito

     

       5
       8
        
       module Author = Author

     

       6
       9
        
       module Attachment = Attachment

     

       7
       10
        
       module Hub = Hub

     

       8
       8
       -
       module Item = Item

     

       9
       11
        
       module Reference = Reference

     

       10
       10
       -
       module Cito = Cito

     

       12
       12
       +
       module Item = Item

     

       13
       13
       +
       

     

       14
       14
       +
       module Unknown = struct

     

       15
       15
       +
         type t = Jsont.json

     

       16
       16
       +
       

     

       17
       17
       +
         let empty = Jsont.Object ([], Jsont.Meta.none)

     

       18
       18
       +
         let is_empty = function Jsont.Object ([], _) -> true | _ -> false

     

       19
       19
       +
       end

     

       11
       20
        
       

     

       12
       21
        
       type t = {

     

       13
       22
        
         version : string;

     
···

       24
       33
        
         expired : bool option;

     

       25
       34
        
         hubs : Hub.t list option;

     

       26
       35
        
         items : Item.t list;

     

       36
       36
       +
         unknown : Unknown.t;

     

       27
       37
        
       }

     

       28
       38
        
       

     

       29
       29
       -
       let create ~title ?home_page_url ?feed_url ?description ?user_comment

     

       30
       30
       -
           ?next_url ?icon ?favicon ?authors ?language ?expired ?hubs ~items () =

     

       39
       39
       +
       let create ~title ?home_page_url ?feed_url ?description ?user_comment ?next_url

     

       40
       40
       +
           ?icon ?favicon ?authors ?language ?expired ?hubs ~items

     

       41
       41
       +
           ?(unknown = Unknown.empty) () =

     

       31
       42
        
         {

     

       32
       43
        
           version = "https://jsonfeed.org/version/1.1";

     

       33
       44
        
           title;

     
···

       43
       54
        
           expired;

     

       44
       55
        
           hubs;

     

       45
       56
        
           items;

     

       57
       57
       +
           unknown;

     

       46
       58
        
         }

     

       47
       59
        
       

     

       48
       60
        
       let version t = t.version

     
···

       59
       71
        
       let expired t = t.expired

     

       60
       72
        
       let hubs t = t.hubs

     

       61
       73
        
       let items t = t.items

     

       62
       62
       -
       

     

       63
       63
       -
       (* RFC3339 date utilities *)

     

       64
       64
       -
       

     

       65
       65
       -
       let parse_rfc3339 s =

     

       66
       66
       -
         match Ptime.of_rfc3339 s with

     

       67
       67
       -
         | Ok (t, _, _) -> Some t

     

       68
       68
       -
         | Error _ -> None

     

       69
       69
       -
       

     

       70
       70
       -
       let format_rfc3339 t =

     

       71
       71
       -
         Ptime.to_rfc3339 t

     

       72
       72
       -
       

     

       73
       73
       -
       (* JSON parsing and serialization *)

     

       74
       74
       -
       

     

       75
       75
       -
       type error = [ `Msg of string ]

     

       76
       76
       -
       

     

       77
       77
       -
       let error_msgf fmt = Format.kasprintf (fun s -> Error (`Msg s)) fmt

     

       78
       78
       -
       

     

       79
       79
       -
       (* JSON parsing helpers *)

     

       80
       80
       -
       

     

       81
       81
       -
       type json_value =

     

       82
       82
       -
         | Null

     

       83
       83
       -
         | Bool of bool

     

       84
       84
       -
         | Float of float

     

       85
       85
       -
         | String of string

     

       86
       86
       -
         | Array of json_value list

     

       87
       87
       -
         | Object of (string * json_value) list

     

       88
       88
       -
       

     

       89
       89
       -
       let rec decode_value dec =

     

       90
       90
       -
         match Jsonm.decode dec with

     

       91
       91
       -
         | `Lexeme `Null -> Null

     

       92
       92
       -
         | `Lexeme (`Bool b) -> Bool b

     

       93
       93
       -
         | `Lexeme (`Float f) -> Float f

     

       94
       94
       -
         | `Lexeme (`String s) -> String s

     

       95
       95
       -
         | `Lexeme `Os -> decode_object dec []

     

       96
       96
       -
         | `Lexeme `As -> decode_array dec []

     

       97
       97
       -
         | `Lexeme _ -> Null

     

       98
       98
       -
         | `Error err -> raise (Invalid_feed (Format.asprintf "%a" Jsonm.pp_error err))

     

       99
       99
       -
         | `End | `Await -> Null

     

       100
       100
       -
       

     

       101
       101
       -
       and decode_object dec acc =

     

       102
       102
       -
         match Jsonm.decode dec with

     

       103
       103
       -
         | `Lexeme `Oe -> Object (List.rev acc)

     

       104
       104
       -
         | `Lexeme (`Name n) ->

     

       105
       105
       -
             let v = decode_value dec in

     

       106
       106
       -
             decode_object dec ((n, v) :: acc)

     

       107
       107
       -
         | `Error err -> raise (Invalid_feed (Format.asprintf "%a" Jsonm.pp_error err))

     

       108
       108
       -
         | _ -> Object (List.rev acc)

     

       109
       109
       -
       

     

       110
       110
       -
       and decode_array dec acc =

     

       111
       111
       -
         match Jsonm.decode dec with

     

       112
       112
       -
         | `Lexeme `Ae -> Array (List.rev acc)

     

       113
       113
       -
         | `Lexeme `Os ->

     

       114
       114
       -
             let v = decode_object dec [] in

     

       115
       115
       -
             decode_array dec (v :: acc)

     

       116
       116
       -
         | `Lexeme `As ->

     

       117
       117
       -
             let v = decode_array dec [] in

     

       118
       118
       -
             decode_array dec (v :: acc)

     

       119
       119
       -
         | `Lexeme `Null -> decode_array dec (Null :: acc)

     

       120
       120
       -
         | `Lexeme (`Bool b) -> decode_array dec (Bool b :: acc)

     

       121
       121
       -
         | `Lexeme (`Float f) -> decode_array dec (Float f :: acc)

     

       122
       122
       -
         | `Lexeme (`String s) -> decode_array dec (String s :: acc)

     

       123
       123
       -
         | `Error err -> raise (Invalid_feed (Format.asprintf "%a" Jsonm.pp_error err))

     

       124
       124
       -
         | _ -> Array (List.rev acc)

     

       125
       125
       -
       

     

       126
       126
       -
       (* Helpers to extract values from JSON *)

     

       127
       127
       -
       

     

       128
       128
       -
       let get_string = function String s -> Some s | _ -> None

     

       129
       129
       -
       let get_bool = function Bool b -> Some b | _ -> None

     

       130
       130
       -
       let _get_float = function Float f -> Some f | _ -> None

     

       131
       131
       -
       let get_int = function Float f -> Some (int_of_float f) | _ -> None

     

       132
       132
       -
       let get_int64 = function Float f -> Some (Int64.of_float f) | _ -> None

     

       133
       133
       -
       let get_array = function Array arr -> Some arr | _ -> None

     

       134
       134
       -
       let _get_object = function Object obj -> Some obj | _ -> None

     

       135
       135
       -
       

     

       136
       136
       -
       let find_field name obj = List.assoc_opt name obj

     

       137
       137
       -
       

     

       138
       138
       -
       let require_field name obj =

     

       139
       139
       -
         match find_field name obj with

     

       140
       140
       -
         | Some v -> v

     

       141
       141
       -
         | None -> raise (Invalid_feed (Printf.sprintf "Missing required field: %s" name))

     

       142
       142
       -
       

     

       143
       143
       -
       let require_string name obj =

     

       144
       144
       -
         match require_field name obj |> get_string with

     

       145
       145
       -
         | Some s -> s

     

       146
       146
       -
         | None -> raise (Invalid_feed (Printf.sprintf "Field %s must be a string" name))

     

       147
       147
       -
       

     

       148
       148
       -
       let optional_string name obj =

     

       149
       149
       -
         match find_field name obj with Some v -> get_string v | None -> None

     

       150
       150
       -
       

     

       151
       151
       -
       let optional_bool name obj =

     

       152
       152
       -
         match find_field name obj with Some v -> get_bool v | None -> None

     

       153
       153
       -
       

     

       154
       154
       -
       let optional_int name obj =

     

       155
       155
       -
         match find_field name obj with Some v -> get_int v | None -> None

     

       156
       156
       -
       

     

       157
       157
       -
       let optional_int64 name obj =

     

       158
       158
       -
         match find_field name obj with Some v -> get_int64 v | None -> None

     

       159
       159
       -
       

     

       160
       160
       -
       let optional_array name obj =

     

       161
       161
       -
         match find_field name obj with Some v -> get_array v | None -> None

     

       162
       162
       -
       

     

       163
       163
       -
       (* Parse Author *)

     

       164
       164
       -
       

     

       165
       165
       -
       let parse_author_obj obj =

     

       166
       166
       -
         let name = optional_string "name" obj in

     

       167
       167
       -
         let url = optional_string "url" obj in

     

       168
       168
       -
         let avatar = optional_string "avatar" obj in

     

       169
       169
       -
         if name = None && url = None && avatar = None then

     

       170
       170
       -
           raise (Invalid_feed "Author must have at least one field");

     

       171
       171
       -
         Author.create ?name ?url ?avatar ()

     

       172
       172
       -
       

     

       173
       173
       -
       let parse_author = function

     

       174
       174
       -
         | Object obj -> parse_author_obj obj

     

       175
       175
       -
         | _ -> raise (Invalid_feed "Author must be an object")

     

       176
       176
       -
       

     

       177
       177
       -
       (* Parse Attachment *)

     

       178
       178
       -
       

     

       179
       179
       -
       let parse_attachment_obj obj =

     

       180
       180
       -
         let url = require_string "url" obj in

     

       181
       181
       -
         let mime_type = require_string "mime_type" obj in

     

       182
       182
       -
         let title = optional_string "title" obj in

     

       183
       183
       -
         let size_in_bytes = optional_int64 "size_in_bytes" obj in

     

       184
       184
       -
         let duration_in_seconds = optional_int "duration_in_seconds" obj in

     

       185
       185
       -
         Attachment.create ~url ~mime_type ?title ?size_in_bytes ?duration_in_seconds ()

     

       186
       186
       -
       

     

       187
       187
       -
       let parse_attachment = function

     

       188
       188
       -
         | Object obj -> parse_attachment_obj obj

     

       189
       189
       -
         | _ -> raise (Invalid_feed "Attachment must be an object")

     

       190
       190
       -
       

     

       191
       191
       -
       (* Parse Hub *)

     

       192
       192
       -
       

     

       193
       193
       -
       let parse_hub_obj obj =

     

       194
       194
       -
         let type_ = require_string "type" obj in

     

       195
       195
       -
         let url = require_string "url" obj in

     

       196
       196
       -
         Hub.create ~type_ ~url ()

     

       197
       197
       -
       

     

       198
       198
       -
       let parse_hub = function

     

       199
       199
       -
         | Object obj -> parse_hub_obj obj

     

       200
       200
       -
         | _ -> raise (Invalid_feed "Hub must be an object")

     

       201
       201
       -
       

     

       202
       202
       -
       (* Parse Item *)

     

       203
       203
       -
       

     

       204
       204
       -
       let parse_item_obj obj =

     

       205
       205
       -
         let id = require_string "id" obj in

     

       206
       206
       -
       

     

       207
       207
       -
         (* Parse content - at least one required *)

     

       208
       208
       -
         let content_html = optional_string "content_html" obj in

     

       209
       209
       -
         let content_text = optional_string "content_text" obj in

     

       210
       210
       -
         let content = match content_html, content_text with

     

       211
       211
       -
           | Some html, Some text -> `Both (html, text)

     

       212
       212
       -
           | Some html, None -> `Html html

     

       213
       213
       -
           | None, Some text -> `Text text

     

       214
       214
       -
           | None, None ->

     

       215
       215
       -
               raise (Invalid_feed "Item must have content_html or content_text")

     

       216
       216
       -
         in

     

       217
       217
       -
       

     

       218
       218
       -
         let url = optional_string "url" obj in

     

       219
       219
       -
         let external_url = optional_string "external_url" obj in

     

       220
       220
       -
         let title = optional_string "title" obj in

     

       221
       221
       -
         let summary = optional_string "summary" obj in

     

       222
       222
       -
         let image = optional_string "image" obj in

     

       223
       223
       -
         let banner_image = optional_string "banner_image" obj in

     

       224
       224
       -
       

     

       225
       225
       -
         let date_published =

     

       226
       226
       -
           match optional_string "date_published" obj with

     

       227
       227
       -
           | Some s -> parse_rfc3339 s

     

       228
       228
       -
           | None -> None

     

       229
       229
       -
         in

     

       230
       230
       -
       

     

       231
       231
       -
         let date_modified =

     

       232
       232
       -
           match optional_string "date_modified" obj with

     

       233
       233
       -
           | Some s -> parse_rfc3339 s

     

       234
       234
       -
           | None -> None

     

       235
       235
       -
         in

     

       236
       236
       -
       

     

       237
       237
       -
         let authors =

     

       238
       238
       -
           match optional_array "authors" obj with

     

       239
       239
       -
           | Some arr ->

     

       240
       240
       -
               let parsed = List.map parse_author arr in

     

       241
       241
       -
               if parsed = [] then None else Some parsed

     

       242
       242
       -
           | None -> None

     

       243
       243
       -
         in

     

       244
       244
       -
       

     

       245
       245
       -
         let tags =

     

       246
       246
       -
           match optional_array "tags" obj with

     

       247
       247
       -
           | Some arr ->

     

       248
       248
       -
               let parsed = List.filter_map get_string arr in

     

       249
       249
       -
               if parsed = [] then None else Some parsed

     

       250
       250
       -
           | None -> None

     

       251
       251
       -
         in

     

       252
       252
       -
       

     

       253
       253
       -
         let language = optional_string "language" obj in

     

       254
       254
       -
       

     

       255
       255
       -
         let attachments =

     

       256
       256
       -
           match optional_array "attachments" obj with

     

       257
       257
       -
           | Some arr ->

     

       258
       258
       -
               let parsed = List.map parse_attachment arr in

     

       259
       259
       -
               if parsed = [] then None else Some parsed

     

       260
       260
       -
           | None -> None

     

       261
       261
       -
         in

     

       262
       262
       -
       

     

       263
       263
       -
         let parse_reference = function

     

       264
       264
       -
           | Object obj ->

     

       265
       265
       -
             let url = require_string "url" obj in

     

       266
       266
       -
             let doi = optional_string "doi" obj in

     

       267
       267
       -
             Reference.create ~url ?doi ()

     

       268
       268
       -
           | _ -> raise (Invalid_feed "Reference must be an object")

     

       269
       269
       -
         in

     

       270
       270
       -
       

     

       271
       271
       -
         let references =

     

       272
       272
       -
           match optional_array "_references" obj with

     

       273
       273
       -
           | Some arr ->

     

       274
       274
       -
               let parsed = List.map parse_reference arr in

     

       275
       275
       -
               if parsed = [] then None else Some parsed

     

       276
       276
       -
           | None -> None

     

       277
       277
       -
         in

     

       278
       278
       -
       

     

       279
       279
       -
         Item.create ~id ~content ?url ?external_url ?title ?summary ?image

     

       280
       280
       -
           ?banner_image ?date_published ?date_modified ?authors ?tags ?language

     

       281
       281
       -
           ?attachments ?references ()

     

       282
       282
       -
       

     

       283
       283
       -
       let parse_item = function

     

       284
       284
       -
         | Object obj -> parse_item_obj obj

     

       285
       285
       -
         | _ -> raise (Invalid_feed "Item must be an object")

     

       286
       286
       -
       

     

       287
       287
       -
       (* Parse Feed *)

     

       288
       288
       -
       

     

       289
       289
       -
       let parse_feed_obj obj =

     

       290
       290
       -
         let version = require_string "version" obj in

     

       291
       291
       -
         let title = require_string "title" obj in

     

       292
       292
       -
         let home_page_url = optional_string "home_page_url" obj in

     

       293
       293
       -
         let feed_url = optional_string "feed_url" obj in

     

       294
       294
       -
         let description = optional_string "description" obj in

     

       295
       295
       -
         let user_comment = optional_string "user_comment" obj in

     

       296
       296
       -
         let next_url = optional_string "next_url" obj in

     

       297
       297
       -
         let icon = optional_string "icon" obj in

     

       298
       298
       -
         let favicon = optional_string "favicon" obj in

     

       299
       299
       -
         let language = optional_string "language" obj in

     

       300
       300
       -
         let expired = optional_bool "expired" obj in

     

       301
       301
       -
       

     

       302
       302
       -
         let authors =

     

       303
       303
       -
           match optional_array "authors" obj with

     

       304
       304
       -
           | Some arr ->

     

       305
       305
       -
               let parsed = List.map parse_author arr in

     

       306
       306
       -
               if parsed = [] then None else Some parsed

     

       307
       307
       -
           | None -> None

     

       308
       308
       -
         in

     

       309
       309
       -
       

     

       310
       310
       -
         let hubs =

     

       311
       311
       -
           match optional_array "hubs" obj with

     

       312
       312
       -
           | Some arr ->

     

       313
       313
       -
               let parsed = List.map parse_hub arr in

     

       314
       314
       -
               if parsed = [] then None else Some parsed

     

       315
       315
       -
           | None -> None

     

       316
       316
       -
         in

     

       317
       317
       -
       

     

       318
       318
       -
         let items =

     

       319
       319
       -
           match optional_array "items" obj with

     

       320
       320
       -
           | Some arr -> List.map parse_item arr

     

       321
       321
       -
           | None -> []

     

       322
       322
       -
         in

     

       323
       323
       -
       

     

       324
       324
       -
         {

     

       325
       325
       -
           version;

     

       326
       326
       -
           title;

     

       327
       327
       -
           home_page_url;

     

       328
       328
       -
           feed_url;

     

       329
       329
       -
           description;

     

       330
       330
       -
           user_comment;

     

       331
       331
       -
           next_url;

     

       332
       332
       -
           icon;

     

       333
       333
       -
           favicon;

     

       334
       334
       -
           authors;

     

       335
       335
       -
           language;

     

       336
       336
       -
           expired;

     

       337
       337
       -
           hubs;

     

       338
       338
       -
           items;

     

       339
       339
       -
         }

     

       340
       340
       -
       

     

       341
       341
       -
       let of_jsonm dec =

     

       342
       342
       -
         try

     

       343
       343
       -
           let json = decode_value dec in

     

       344
       344
       -
           match json with

     

       345
       345
       -
           | Object obj -> Ok (parse_feed_obj obj)

     

       346
       346
       -
           | _ -> error_msgf "Feed must be a JSON object"

     

       347
       347
       -
         with

     

       348
       348
       -
         | Invalid_feed msg -> error_msgf "%s" msg

     

       74
       74
       +
       let unknown t = t.unknown

     

       75
       75
       +
       let equal a b = a.title = b.title && a.items = b.items

     

       349
       76
        
       

     

       350
       350
       -
       (* JSON serialization *)

     

       77
       77
       +
       let pp ppf t =

     

       78
       78
       +
         Format.fprintf ppf "Feed: %s (%d items)" t.title (List.length t.items)

     

       351
       79
        
       

     

       352
       352
       -
       let to_jsonm enc feed =

     

       353
       353
       -
         (* Simplified serialization using Jsonm *)

     

       354
       354
       -
         let enc_field name value_fn =

     

       355
       355
       -
           ignore (Jsonm.encode enc (`Lexeme (`Name name)));

     

       356
       356
       -
           value_fn ()

     

       357
       357
       -
         in

     

       80
       80
       +
       let pp_summary ppf t =

     

       81
       81
       +
         Format.fprintf ppf "%s (%d items)" t.title (List.length t.items)

     

       358
       82
        
       

     

       359
       359
       -
         let enc_string s =

     

       360
       360
       -
           ignore (Jsonm.encode enc (`Lexeme (`String s)))

     

       361
       361
       -
         in

     

       83
       83
       +
       (* Jsont type *)

     

       362
       84
        
       

     

       363
       363
       -
         let enc_bool b =

     

       364
       364
       -
           ignore (Jsonm.encode enc (`Lexeme (`Bool b)))

     

       365
       365
       -
         in

     

       85
       85
       +
       let jsont =

     

       86
       86
       +
         let kind = "JSON Feed" in

     

       87
       87
       +
         let doc = "A JSON Feed document" in

     

       366
       88
        
       

     

       367
       367
       -
         let enc_opt enc_fn = function

     

       368
       368
       -
           | None -> ()

     

       369
       369
       -
           | Some v -> enc_fn v

     

       89
       89
       +
         (* Helper constructor that sets version automatically *)

     

       90
       90
       +
         let make_from_json _version title home_page_url feed_url description

     

       91
       91
       +
             user_comment next_url icon favicon authors language expired hubs items

     

       92
       92
       +
             unknown =

     

       93
       93
       +
           {

     

       94
       94
       +
             version = "https://jsonfeed.org/version/1.1";

     

       95
       95
       +
             title;

     

       96
       96
       +
             home_page_url;

     

       97
       97
       +
             feed_url;

     

       98
       98
       +
             description;

     

       99
       99
       +
             user_comment;

     

       100
       100
       +
             next_url;

     

       101
       101
       +
             icon;

     

       102
       102
       +
             favicon;

     

       103
       103
       +
             authors;

     

       104
       104
       +
             language;

     

       105
       105
       +
             expired;

     

       106
       106
       +
             hubs;

     

       107
       107
       +
             items;

     

       108
       108
       +
             unknown;

     

       109
       109
       +
           }

     

       370
       110
        
         in

     

       371
       111
        
       

     

       372
       372
       -
         let enc_list enc_fn lst =

     

       373
       373
       -
           ignore (Jsonm.encode enc (`Lexeme `As));

     

       374
       374
       -
           List.iter enc_fn lst;

     

       375
       375
       -
           ignore (Jsonm.encode enc (`Lexeme `Ae))

     

       376
       376
       -
         in

     

       112
       112
       +
         Jsont.Object.map ~kind ~doc make_from_json

     

       113
       113
       +
         |> Jsont.Object.mem "version" Jsont.string ~enc:version

     

       114
       114
       +
         |> Jsont.Object.mem "title" Jsont.string ~enc:title

     

       115
       115
       +
         |> Jsont.Object.opt_mem "home_page_url" Jsont.string ~enc:home_page_url

     

       116
       116
       +
         |> Jsont.Object.opt_mem "feed_url" Jsont.string ~enc:feed_url

     

       117
       117
       +
         |> Jsont.Object.opt_mem "description" Jsont.string ~enc:description

     

       118
       118
       +
         |> Jsont.Object.opt_mem "user_comment" Jsont.string ~enc:user_comment

     

       119
       119
       +
         |> Jsont.Object.opt_mem "next_url" Jsont.string ~enc:next_url

     

       120
       120
       +
         |> Jsont.Object.opt_mem "icon" Jsont.string ~enc:icon

     

       121
       121
       +
         |> Jsont.Object.opt_mem "favicon" Jsont.string ~enc:favicon

     

       122
       122
       +
         |> Jsont.Object.opt_mem "authors" (Jsont.list Author.jsont) ~enc:authors

     

       123
       123
       +
         |> Jsont.Object.opt_mem "language" Jsont.string ~enc:language

     

       124
       124
       +
         |> Jsont.Object.opt_mem "expired" Jsont.bool ~enc:expired

     

       125
       125
       +
         |> Jsont.Object.opt_mem "hubs" (Jsont.list Hub.jsont) ~enc:hubs

     

       126
       126
       +
         |> Jsont.Object.mem "items" (Jsont.list Item.jsont) ~enc:items

     

       127
       127
       +
         |> Jsont.Object.keep_unknown Jsont.json_mems ~enc:unknown

     

       128
       128
       +
         |> Jsont.Object.finish

     

       377
       129
        
       

     

       378
       378
       -
         let enc_author author =

     

       379
       379
       -
           ignore (Jsonm.encode enc (`Lexeme `Os));

     

       380
       380
       -
           (match Author.name author with

     

       381
       381
       -
            | Some name -> enc_field "name" (fun () -> enc_string name)

     

       382
       382
       -
            | None -> ());

     

       383
       383
       -
           (match Author.url author with

     

       384
       384
       -
            | Some url -> enc_field "url" (fun () -> enc_string url)

     

       385
       385
       -
            | None -> ());

     

       386
       386
       -
           (match Author.avatar author with

     

       387
       387
       -
            | Some avatar -> enc_field "avatar" (fun () -> enc_string avatar)

     

       388
       388
       -
            | None -> ());

     

       389
       389
       -
           ignore (Jsonm.encode enc (`Lexeme `Oe))

     

       390
       390
       -
         in

     

       130
       130
       +
       (* Encoding and Decoding *)

     

       391
       131
        
       

     

       392
       392
       -
         let enc_attachment att =

     

       393
       393
       -
           ignore (Jsonm.encode enc (`Lexeme `Os));

     

       394
       394
       -
           enc_field "url" (fun () -> enc_string (Attachment.url att));

     

       395
       395
       -
           enc_field "mime_type" (fun () -> enc_string (Attachment.mime_type att));

     

       396
       396
       -
           enc_opt (fun title -> enc_field "title" (fun () -> enc_string title))

     

       397
       397
       -
             (Attachment.title att);

     

       398
       398
       -
           enc_opt (fun size ->

     

       399
       399
       -
             enc_field "size_in_bytes" (fun () ->

     

       400
       400
       -
               ignore (Jsonm.encode enc (`Lexeme (`Float (Int64.to_float size))))))

     

       401
       401
       -
             (Attachment.size_in_bytes att);

     

       402
       402
       -
           enc_opt (fun dur ->

     

       403
       403
       -
             enc_field "duration_in_seconds" (fun () ->

     

       404
       404
       -
               ignore (Jsonm.encode enc (`Lexeme (`Float (float_of_int dur))))))

     

       405
       405
       -
             (Attachment.duration_in_seconds att);

     

       406
       406
       -
           ignore (Jsonm.encode enc (`Lexeme `Oe))

     

       407
       407
       -
         in

     

       132
       132
       +
       let decode ?layout ?locs ?file r =

     

       133
       133
       +
         Jsont_bytesrw.decode' ?layout ?locs ?file jsont r

     

       408
       134
        
       

     

       409
       409
       -
         let enc_reference ref =

     

       410
       410
       -
           ignore (Jsonm.encode enc (`Lexeme `Os));

     

       411
       411
       -
           enc_field "url" (fun () -> enc_string (Reference.url ref));

     

       412
       412
       -
           enc_opt (fun doi -> enc_field "doi" (fun () -> enc_string doi))

     

       413
       413
       -
             (Reference.doi ref);

     

       414
       414
       -
           enc_opt (fun cito_list ->

     

       415
       415
       -
             enc_field "cito" (fun () ->

     

       416
       416
       -
               enc_list (fun cito -> enc_string (Cito.to_string cito)) cito_list))

     

       417
       417
       -
             (Reference.cito ref);

     

       418
       418
       -
           ignore (Jsonm.encode enc (`Lexeme `Oe))

     

       419
       419
       -
         in

     

       135
       135
       +
       let decode_string ?layout ?locs ?file s =

     

       136
       136
       +
         Jsont_bytesrw.decode_string' ?layout ?locs ?file jsont s

     

       420
       137
        
       

     

       421
       421
       -
         let enc_hub hub =

     

       422
       422
       -
           ignore (Jsonm.encode enc (`Lexeme `Os));

     

       423
       423
       -
           enc_field "type" (fun () -> enc_string (Hub.type_ hub));

     

       424
       424
       -
           enc_field "url" (fun () -> enc_string (Hub.url hub));

     

       425
       425
       -
           ignore (Jsonm.encode enc (`Lexeme `Oe))

     

       426
       426
       -
         in

     

       138
       138
       +
       let encode ?format ?number_format feed ~eod w =

     

       139
       139
       +
         Jsont_bytesrw.encode' ?format ?number_format jsont feed ~eod w

     

       427
       140
        
       

     

       428
       428
       -
         let enc_item item =

     

       429
       429
       -
           ignore (Jsonm.encode enc (`Lexeme `Os));

     

       430
       430
       -
           enc_field "id" (fun () -> enc_string (Item.id item));

     

       141
       141
       +
       let encode_string ?format ?number_format feed =

     

       142
       142
       +
         Jsont_bytesrw.encode_string' ?format ?number_format jsont feed

     

       431
       143
        
       

     

       432
       432
       -
           (* Encode content *)

     

       433
       433
       -
           (match Item.content item with

     

       434
       434
       -
            | `Html html ->

     

       435
       435
       -
                enc_field "content_html" (fun () -> enc_string html)

     

       436
       436
       -
            | `Text text ->

     

       437
       437
       -
                enc_field "content_text" (fun () -> enc_string text)

     

       438
       438
       -
            | `Both (html, text) ->

     

       439
       439
       -
                enc_field "content_html" (fun () -> enc_string html);

     

       440
       440
       -
                enc_field "content_text" (fun () -> enc_string text));

     

       144
       144
       +
       let of_string s = decode_string s

     

       441
       145
        
       

     

       442
       442
       -
           enc_opt (fun url -> enc_field "url" (fun () -> enc_string url))

     

       443
       443
       -
             (Item.url item);

     

       444
       444
       -
           enc_opt (fun url -> enc_field "external_url" (fun () -> enc_string url))

     

       445
       445
       -
             (Item.external_url item);

     

       446
       446
       -
           enc_opt (fun title -> enc_field "title" (fun () -> enc_string title))

     

       447
       447
       -
             (Item.title item);

     

       448
       448
       -
           enc_opt (fun summary -> enc_field "summary" (fun () -> enc_string summary))

     

       449
       449
       -
             (Item.summary item);

     

       450
       450
       -
           enc_opt (fun img -> enc_field "image" (fun () -> enc_string img))

     

       451
       451
       -
             (Item.image item);

     

       452
       452
       -
           enc_opt (fun img -> enc_field "banner_image" (fun () -> enc_string img))

     

       453
       453
       -
             (Item.banner_image item);

     

       454
       454
       -
           enc_opt (fun date -> enc_field "date_published" (fun () -> enc_string (format_rfc3339 date)))

     

       455
       455
       -
             (Item.date_published item);

     

       456
       456
       -
           enc_opt (fun date -> enc_field "date_modified" (fun () -> enc_string (format_rfc3339 date)))

     

       457
       457
       -
             (Item.date_modified item);

     

       458
       458
       -
           enc_opt (fun authors ->

     

       459
       459
       -
             enc_field "authors" (fun () -> enc_list enc_author authors))

     

       460
       460
       -
             (Item.authors item);

     

       461
       461
       -
           enc_opt (fun tags ->

     

       462
       462
       -
             enc_field "tags" (fun () -> enc_list enc_string tags))

     

       463
       463
       -
             (Item.tags item);

     

       464
       464
       -
           enc_opt (fun lang -> enc_field "language" (fun () -> enc_string lang))

     

       465
       465
       -
             (Item.language item);

     

       466
       466
       -
           enc_opt (fun atts ->

     

       467
       467
       -
             enc_field "attachments" (fun () -> enc_list enc_attachment atts))

     

       468
       468
       -
             (Item.attachments item);

     

       469
       469
       -
           enc_opt (fun refs ->

     

       470
       470
       -
             enc_field "_references" (fun () -> enc_list enc_reference refs))

     

       471
       471
       -
             (Item.references item);

     

       472
       472
       -
       

     

       473
       473
       -
           ignore (Jsonm.encode enc (`Lexeme `Oe))

     

       474
       474
       -
         in

     

       475
       475
       -
       

     

       476
       476
       -
         (* Encode the feed *)

     

       477
       477
       -
         ignore (Jsonm.encode enc (`Lexeme `Os));

     

       478
       478
       -
         enc_field "version" (fun () -> enc_string feed.version);

     

       479
       479
       -
         enc_field "title" (fun () -> enc_string feed.title);

     

       480
       480
       -
         enc_opt (fun url -> enc_field "home_page_url" (fun () -> enc_string url))

     

       481
       481
       -
           feed.home_page_url;

     

       482
       482
       -
         enc_opt (fun url -> enc_field "feed_url" (fun () -> enc_string url))

     

       483
       483
       -
           feed.feed_url;

     

       484
       484
       -
         enc_opt (fun desc -> enc_field "description" (fun () -> enc_string desc))

     

       485
       485
       -
           feed.description;

     

       486
       486
       -
         enc_opt (fun comment -> enc_field "user_comment" (fun () -> enc_string comment))

     

       487
       487
       -
           feed.user_comment;

     

       488
       488
       -
         enc_opt (fun url -> enc_field "next_url" (fun () -> enc_string url))

     

       489
       489
       -
           feed.next_url;

     

       490
       490
       -
         enc_opt (fun icon -> enc_field "icon" (fun () -> enc_string icon))

     

       491
       491
       -
           feed.icon;

     

       492
       492
       -
         enc_opt (fun favicon -> enc_field "favicon" (fun () -> enc_string favicon))

     

       493
       493
       -
           feed.favicon;

     

       494
       494
       -
         enc_opt (fun authors ->

     

       495
       495
       -
           enc_field "authors" (fun () -> enc_list enc_author authors))

     

       496
       496
       -
           feed.authors;

     

       497
       497
       -
         enc_opt (fun lang -> enc_field "language" (fun () -> enc_string lang))

     

       498
       498
       -
           feed.language;

     

       499
       499
       -
         enc_opt (fun expired -> enc_field "expired" (fun () -> enc_bool expired))

     

       500
       500
       -
           feed.expired;

     

       501
       501
       -
         enc_opt (fun hubs ->

     

       502
       502
       -
           enc_field "hubs" (fun () -> enc_list enc_hub hubs))

     

       503
       503
       -
           feed.hubs;

     

       504
       504
       -
         enc_field "items" (fun () -> enc_list enc_item feed.items);

     

       505
       505
       -
         ignore (Jsonm.encode enc (`Lexeme `Oe));

     

       506
       506
       -
         ignore (Jsonm.encode enc `End)

     

       507
       507
       -
       

     

       508
       508
       -
       let of_string s =

     

       509
       509
       -
         let dec = Jsonm.decoder (`String s) in

     

       510
       510
       -
         of_jsonm dec

     

       511
       511
       -
       

     

       512
       512
       -
       let to_string ?(minify=false) feed =

     

       513
       513
       -
         let buf = Buffer.create 1024 in

     

       514
       514
       -
         let enc = Jsonm.encoder ~minify (`Buffer buf) in

     

       515
       515
       -
         to_jsonm enc feed;

     

       516
       516
       -
         Buffer.contents buf

     

       146
       146
       +
       let to_string ?(minify = false) feed =

     

       147
       147
       +
         let format = if minify then Jsont.Minify else Jsont.Indent in

     

       148
       148
       +
         encode_string ~format feed

     

       517
       149
        
       

     

       518
       150
        
       (* Validation *)

     

       519
       151
        
       

     
···

       522
       154
        
         let add_error msg = errors := msg :: !errors in

     

       523
       155
        
       

     

       524
       156
        
         (* Check required fields *)

     

       525
       525
       -
         if feed.title = "" then

     

       526
       526
       -
           add_error "title is required and cannot be empty";

     

       157
       157
       +
         if feed.title = "" then add_error "title is required and cannot be empty";

     

       527
       158
        
       

     

       528
       159
        
         (* Check items have unique IDs *)

     

       529
       160
        
         let ids = List.map Item.id feed.items in

     
···

       532
       163
        
           add_error "items must have unique IDs";

     

       533
       164
        
       

     

       534
       165
        
         (* Validate authors *)

     

       535
       535
       -
         (match feed.authors with

     

       536
       536
       -
          | Some authors ->

     

       537
       537
       -
              List.iteri (fun i author ->

     

       166
       166
       +
         Option.iter

     

       167
       167
       +
           (List.iteri (fun i author ->

     

       538
       168
        
                if not (Author.is_valid author) then

     

       539
       539
       -
                  add_error (Printf.sprintf "feed author %d is invalid (needs at least one field)" i)

     

       540
       540
       -
              ) authors

     

       541
       541
       -
          | None -> ());

     

       169
       169
       +
                  add_error

     

       170
       170
       +
                    (Printf.sprintf

     

       171
       171
       +
                       "feed author %d is invalid (needs at least one field)" i)))

     

       172
       172
       +
           feed.authors;

     

       542
       173
        
       

     

       543
       174
        
         (* Validate items *)

     

       544
       544
       -
         List.iteri (fun i item ->

     

       545
       545
       -
           if Item.id item = "" then

     

       546
       546
       -
             add_error (Printf.sprintf "item %d has empty ID" i);

     

       547
       547
       -
       

     

       548
       548
       -
           (* Validate item authors *)

     

       549
       549
       -
           (match Item.authors item with

     

       550
       550
       -
            | Some authors ->

     

       551
       551
       -
                List.iteri (fun j author ->

     

       552
       552
       -
                  if not (Author.is_valid author) then

     

       553
       553
       -
                    add_error (Printf.sprintf "item %d author %d is invalid" i j)

     

       554
       554
       -
                ) authors

     

       555
       555
       -
            | None -> ())

     

       556
       556
       -
         ) feed.items;

     

       557
       557
       -
       

     

       558
       558
       -
         if !errors = [] then Ok ()

     

       559
       559
       -
         else Error (List.rev !errors)

     

       560
       560
       -
       

     

       561
       561
       -
       (* Comparison *)

     

       562
       562
       -
       

     

       563
       563
       -
       let equal a b =

     

       564
       564
       -
         a.version = b.version &&

     

       565
       565
       -
         a.title = b.title &&

     

       566
       566
       -
         a.home_page_url = b.home_page_url &&

     

       567
       567
       -
         a.feed_url = b.feed_url &&

     

       568
       568
       -
         a.description = b.description &&

     

       569
       569
       -
         a.user_comment = b.user_comment &&

     

       570
       570
       -
         a.next_url = b.next_url &&

     

       571
       571
       -
         a.icon = b.icon &&

     

       572
       572
       -
         a.favicon = b.favicon &&

     

       573
       573
       -
         a.language = b.language &&

     

       574
       574
       -
         a.expired = b.expired &&

     

       575
       575
       -
         (* Note: We're doing structural equality on items *)

     

       576
       576
       -
         List.length a.items = List.length b.items

     

       577
       577
       -
       

     

       578
       578
       -
       (* Pretty printing *)

     

       579
       579
       -
       

     

       580
       580
       -
       let pp_summary ppf feed =

     

       581
       581
       -
         Format.fprintf ppf "%s (%d items)" feed.title (List.length feed.items)

     

       175
       175
       +
         List.iteri

     

       176
       176
       +
           (fun i item ->

     

       177
       177
       +
             if Item.id item = "" then

     

       178
       178
       +
               add_error (Printf.sprintf "item %d has empty ID" i);

     

       582
       179
        
       

     

       583
       583
       -
       let pp ppf feed =

     

       584
       584
       -
         Format.fprintf ppf "Feed: %s" feed.title;

     

       585
       585
       -
         (match feed.home_page_url with

     

       586
       586
       -
          | Some url -> Format.fprintf ppf " (%s)" url

     

       587
       587
       -
          | None -> ());

     

       588
       588
       -
         Format.fprintf ppf "@\n";

     

       589
       589
       -
       

     

       590
       590
       -
         Format.fprintf ppf "  Items: %d@\n" (List.length feed.items);

     

       591
       591
       -
       

     

       592
       592
       -
         (match feed.authors with

     

       593
       593
       -
          | Some authors when authors <> [] ->

     

       594
       594
       -
              Format.fprintf ppf "  Authors: ";

     

       595
       595
       -
              List.iteri (fun i author ->

     

       596
       596
       -
                if i > 0 then Format.fprintf ppf ", ";

     

       597
       597
       -
                Format.fprintf ppf "%a" Author.pp author

     

       598
       598
       -
              ) authors;

     

       599
       599
       -
              Format.fprintf ppf "@\n"

     

       600
       600
       -
          | _ -> ());

     

       180
       180
       +
             (* Validate item authors *)

     

       181
       181
       +
             Option.iter

     

       182
       182
       +
               (List.iteri (fun j author ->

     

       183
       183
       +
                    if not (Author.is_valid author) then

     

       184
       184
       +
                      add_error (Printf.sprintf "item %d author %d is invalid" i j)))

     

       185
       185
       +
               (Item.authors item))

     

       186
       186
       +
           feed.items;

     

       601
       187
        
       

     

       602
       602
       -
         (match feed.language with

     

       603
       603
       -
          | Some lang -> Format.fprintf ppf "  Language: %s@\n" lang

     

       604
       604
       -
          | None -> ())

     

       188
       188
       +
         match !errors with [] -> Ok () | errs -> Error (List.rev errs)

+175 -294

lib/jsonfeed.mli

···

       1
       1
       -
       (** JSON Feed format parser and serializer.

     

       1
       1
       +
       (*---------------------------------------------------------------------------

     

       2
       2
       +
          Copyright (c) 2025 Anil Madhavapeddy. All rights reserved.

     

       3
       3
       +
          SPDX-License-Identifier: ISC

     

       4
       4
       +
         ---------------------------------------------------------------------------*)

     

       2
       5
        
       

     

       3
       3
       -
           This library implements the JSON Feed specification version 1.1, providing

     

       4
       4
       -
           type-safe parsing and serialization of JSON Feed documents. JSON Feed is a

     

       5
       5
       -
           syndication format similar to RSS and Atom, but using JSON instead of XML.

     

       6
       6
       -
       

     

       7
       7
       -
           {b Key Features:}

     

       8
       8
       -
           - Type-safe construction with compile-time validation

     

       9
       9
       -
           - Support for all JSON Feed 1.1 fields

     

       10
       10
       -
           - RFC 3339 date parsing with Ptime integration

     

       11
       11
       -
           - Streaming parsing and serialization with Jsonm

     

       12
       12
       -
           - Comprehensive documentation and examples

     

       13
       13
       -
       

     

       14
       14
       -
           {b Quick Start:}

     

       15
       15
       -
           {[

     

       16
       16
       -
             (* Create a simple feed *)

     

       17
       17
       -
             let feed = Jsonfeed.create

     

       18
       18
       -
               ~title:"My Blog"

     

       19
       19
       -
               ~home_page_url:"https://example.com"

     

       20
       20
       -
               ~feed_url:"https://example.com/feed.json"

     

       21
       21
       -
               ~items:[

     

       22
       22
       -
                 Item.create

     

       23
       23
       -
                   ~id:"https://example.com/post/1"

     

       24
       24
       -
                   ~content:(Item.Html "<p>Hello, world!</p>")

     

       25
       25
       -
                   ~title:"First Post"

     

       26
       26
       -
                   ()

     

       27
       27
       -
               ]

     

       28
       28
       -
               ()

     

       29
       29
       -
       

     

       30
       30
       -
             (* Serialize to string *)

     

       31
       31
       -
             let json = Jsonfeed.to_string feed

     

       32
       32
       -
       

     

       33
       33
       -
             (* Parse from string *)

     

       34
       34
       -
             match Jsonfeed.of_string json with

     

       35
       35
       -
             | Ok feed -> Printf.printf "Feed: %s\n" (Jsonfeed.title feed)

     

       36
       36
       -
             | Error (`Msg err) -> Printf.eprintf "Error: %s\n" err

     

       37
       37
       -
           ]}

     

       6
       6
       +
       (** JSON Feed format parser and serializer.

     

       38
       7
        
       

     

       39
       8
        
           @see <https://www.jsonfeed.org/version/1.1/> JSON Feed Specification *)

     

       40
       9
        
       

     

       41
       41
       -
       

     

       10
       10
       +
       type t

     

       42
       11
        
       (** The type representing a complete JSON Feed. *)

     

       43
       43
       -
       type t

     

       44
       12
        
       

     

       45
       45
       -
       (** Exception raised when attempting to parse an invalid feed. *)

     

       46
       46
       -
       exception Invalid_feed of string

     

       13
       13
       +
       val jsont : t Jsont.t

     

       14
       14
       +
       (** Declarative type that describes the structure of JSON Feeds.

     

       47
       15
        
       

     

       48
       48
       -
       (** {1 Construction} *)

     

       16
       16
       +
           Maps the complete JSON Feed 1.1 specification including all required and

     

       17
       17
       +
           optional fields. *)

     

       49
       18
        
       

     

       50
       50
       -
       (** [create ~title ?home_page_url ?feed_url ?description ?user_comment ?next_url

     

       51
       51
       -
           ?icon ?favicon ?authors ?language ?expired ?hubs ~items ()]

     

       52
       52
       -
           creates a JSON Feed.

     

       19
       19
       +
       module Unknown : sig

     

       20
       20
       +
         type t = Jsont.json

     

       21
       21
       +
         (** Unknown or unrecognized JSON object members as a generic JSON object.

     

       22
       22
       +
             Useful for preserving fields from custom extensions or future spec

     

       23
       23
       +
             versions. *)

     

       53
       24
        
       

     

       54
       54
       -
           @param title The name of the feed (required)

     

       55
       55
       -
           @param home_page_url The URL of the resource the feed describes

     

       56
       56
       -
           @param feed_url The URL of the feed itself (serves as unique identifier)

     

       57
       57
       -
           @param description Additional information about the feed

     

       58
       58
       -
           @param user_comment A description of the feed's purpose for humans reading the raw JSON

     

       59
       59
       -
           @param next_url URL of the next page of items (for pagination)

     

       60
       60
       -
           @param icon The feed's icon URL (should be square, 512x512 or larger)

     

       61
       61
       -
           @param favicon The feed's favicon URL (should be square, 64x64 or larger)

     

       62
       62
       -
           @param authors The feed's default authors (inherited by items without authors)

     

       63
       63
       -
           @param language The primary language of the feed (RFC 5646 format, e.g. ["en-US"])

     

       64
       64
       -
           @param expired Whether the feed will update again ([true] means no more updates)

     

       65
       65
       -
           @param hubs Endpoints for real-time notifications

     

       66
       66
       -
           @param items The list of feed items (required)

     

       25
       25
       +
         val empty : t

     

       26
       26
       +
         (** [empty] is the empty list of unknown fields. *)

     

       67
       27
        
       

     

       68
       68
       -
           {b Examples:}

     

       69
       69
       -
           {[

     

       70
       70
       -
             (* Minimal feed *)

     

       71
       71
       -
             let feed = Jsonfeed.create

     

       72
       72
       -
               ~title:"My Blog"

     

       73
       73
       -
               ~items:[] ()

     

       28
       28
       +
         val is_empty : t -> bool

     

       29
       29
       +
         (** [is_empty u] returns [true] if there are no unknown fields. *)

     

       30
       30
       +
       end

     

       74
       31
        
       

     

       75
       75
       -
             (* Full-featured blog feed *)

     

       76
       76
       -
             let feed = Jsonfeed.create

     

       77
       77
       -
               ~title:"Example Blog"

     

       78
       78
       -
               ~home_page_url:"https://example.com"

     

       79
       79
       -
               ~feed_url:"https://example.com/feed.json"

     

       80
       80
       -
               ~description:"A blog about OCaml and functional programming"

     

       81
       81
       -
               ~icon:"https://example.com/icon.png"

     

       82
       82
       -
               ~authors:[

     

       83
       83
       -
                 Author.create

     

       84
       84
       -
                   ~name:"Jane Doe"

     

       85
       85
       -
                   ~url:"https://example.com/about"

     

       86
       86
       -
                   ()

     

       87
       87
       -
               ]

     

       88
       88
       -
               ~language:"en-US"

     

       89
       89
       -
               ~items:[

     

       90
       90
       -
                 Item.create

     

       91
       91
       -
                   ~id:"https://example.com/posts/1"

     

       92
       92
       -
                   ~content:(Item.Html "<p>First post</p>")

     

       93
       93
       -
                   ~title:"Hello World"

     

       94
       94
       -
                   ();

     

       95
       95
       -
                 Item.create

     

       96
       96
       -
                   ~id:"https://example.com/posts/2"

     

       97
       97
       -
                   ~content:(Item.Html "<p>Second post</p>")

     

       98
       98
       -
                   ~title:"Another Post"

     

       99
       99
       -
                   ()

     

       100
       100
       -
               ]

     

       101
       101
       -
               ()

     

       32
       32
       +
       (** {1 Construction} *)

     

       102
       33
        
       

     

       103
       103
       -
             (* Podcast feed with hubs *)

     

       104
       104
       -
             let hub = Hub.create

     

       105
       105
       -
               ~type_:"WebSub"

     

       106
       106
       -
               ~url:"https://pubsubhubbub.appspot.com/"

     

       107
       107
       -
               () in

     

       108
       108
       -
             let feed = Jsonfeed.create

     

       109
       109
       -
               ~title:"My Podcast"

     

       110
       110
       -
               ~home_page_url:"https://podcast.example.com"

     

       111
       111
       -
               ~feed_url:"https://podcast.example.com/feed.json"

     

       112
       112
       -
               ~hubs:[hub]

     

       113
       113
       -
               ~items:[

     

       114
       114
       -
                 Item.create

     

       115
       115
       -
                   ~id:"https://podcast.example.com/episodes/1"

     

       116
       116
       -
                   ~content:(Item.Html "<p>Episode description</p>")

     

       117
       117
       -
                   ~title:"Episode 1"

     

       118
       118
       -
                   ~attachments:[

     

       119
       119
       -
                     Attachment.create

     

       120
       120
       -
                       ~url:"https://podcast.example.com/ep1.mp3"

     

       121
       121
       -
                       ~mime_type:"audio/mpeg"

     

       122
       122
       -
                       ~duration_in_seconds:1800

     

       123
       123
       -
                       ()

     

       124
       124
       -
                   ]

     

       125
       125
       -
                   ()

     

       126
       126
       -
               ]

     

       127
       127
       -
               ()

     

       128
       128
       -
           ]} *)

     

       129
       34
        
       val create :

     

       130
       35
        
         title:string ->

     

       131
       36
        
         ?home_page_url:string ->

     
···

       140
       45
        
         ?expired:bool ->

     

       141
       46
        
         ?hubs:Hub.t list ->

     

       142
       47
        
         items:Item.t list ->

     

       48
       48
       +
         ?unknown:Unknown.t ->

     

       143
       49
        
         unit ->

     

       144
       50
        
         t

     

       51
       51
       +
       (** [create ~title ~items ()] creates a new JSON Feed.

     

       145
       52
        
       

     

       53
       53
       +
           @param title

     

       54
       54
       +
             The name of the feed. Required field that should be plain text, not HTML.

     

       55
       55
       +
           @param home_page_url

     

       56
       56
       +
             The URL of the resource that the feed describes. This resource may or may

     

       57
       57
       +
             not actually be a "home" page, but it should be an HTML page. If a feed is

     

       58
       58
       +
             for a podcast, for instance, the home_page_url would be the URL for the

     

       59
       59
       +
             podcast's website.

     

       60
       60
       +
           @param feed_url

     

       61
       61
       +
             The URL of the feed itself. This is the URL that was requested to get this

     

       62
       62
       +
             JSON Feed response. Helps feed readers to determine when they're being

     

       63
       63
       +
             redirected. Strongly recommended for feeds.

     

       64
       64
       +
           @param description

     

       65
       65
       +
             A plain text description of the feed, for human consumption. May contain

     

       66
       66
       +
             some formatting (like newlines).

     

       67
       67
       +
           @param user_comment

     

       68
       68
       +
             A description of the purpose of the feed, for a person looking at the raw

     

       69
       69
       +
             JSON. This is for the publisher's use only, not intended to be displayed

     

       70
       70
       +
             to the user.

     

       71
       71
       +
           @param next_url

     

       72
       72
       +
             The URL of a feed that provides the next n items, where n is determined by

     

       73
       73
       +
             the publisher. Used for pagination. A feed reader may continue to request

     

       74
       74
       +
             the URLs in next_url until it reaches a feed without a next_url.

     

       75
       75
       +
           @param icon

     

       76
       76
       +
             The URL of an image for the feed suitable to be used in a timeline, much

     

       77
       77
       +
             the way an avatar might be used. Should be square and relatively large -

     

       78
       78
       +
             such as 512 x 512 pixels - and may be cropped to a circle or rounded

     

       79
       79
       +
             corners. Should not be transparent.

     

       80
       80
       +
           @param favicon

     

       81
       81
       +
             The URL of an image for the feed suitable to be used in a source list.

     

       82
       82
       +
             Should be square and relatively small - such as 64 x 64 pixels. Should not

     

       83
       83
       +
             be transparent.

     

       84
       84
       +
           @param authors

     

       85
       85
       +
             Specifies one or more feed authors. The author object has several members

     

       86
       86
       +
             (name, url, avatar) which are all optional, but at least one must be

     

       87
       87
       +
             present for the object to be valid.

     

       88
       88
       +
           @param language

     

       89
       89
       +
             The primary language for the feed in RFC 5646 format. The value can be a

     

       90
       90
       +
             language tag such as "en" or "en-US", or a language-region combination.

     

       91
       91
       +
           @param expired

     

       92
       92
       +
             Whether or not the feed is finished - that is, whether or not it will ever

     

       93
       93
       +
             update again. A feed for a temporary event, like an instance of a

     

       94
       94
       +
             conference, may expire. If the value is [true], feed readers may stop

     

       95
       95
       +
             checking for updates.

     

       96
       96
       +
           @param hubs

     

       97
       97
       +
             Endpoints that can be used to subscribe to real-time notifications from

     

       98
       98
       +
             the publisher of this feed. Each hub object has a type (such as "rssCloud"

     

       99
       99
       +
             or "WebSub") and url.

     

       100
       100
       +
           @param items

     

       101
       101
       +
             The items in the feed. Required field, though it may be an empty array.

     

       102
       102
       +
           @param unknown

     

       103
       103
       +
             Unknown JSON object members preserved from parsing. Useful for custom

     

       104
       104
       +
             extensions. *)

     

       146
       105
        
       

     

       147
       106
        
       (** {1 Accessors} *)

     

       148
       107
        
       

     

       149
       149
       -
       (** [version t] returns the JSON Feed version URL.

     

       150
       150
       -
       

     

       151
       151
       -
           This is always ["https://jsonfeed.org/version/1.1"] for feeds created

     

       152
       152
       -
           by this library, but may differ when parsing external feeds. *)

     

       153
       108
        
       val version : t -> string

     

       109
       109
       +
       (** [version feed] returns the URL of the version of the format the feed uses.

     

       110
       110
       +
           This will always be "https://jsonfeed.org/version/1.1" for feeds created

     

       111
       111
       +
           with this library. This is a required field in the JSON Feed spec. *)

     

       154
       112
        
       

     

       155
       155
       -
       (** [title t] returns the feed's title. *)

     

       156
       113
        
       val title : t -> string

     

       114
       114
       +
       (** [title feed] returns the name of the feed. This is plain text and should not

     

       115
       115
       +
           contain HTML. This is a required field. *)

     

       157
       116
        
       

     

       158
       158
       -
       (** [home_page_url t] returns the feed's home page URL, if set. *)

     

       159
       117
        
       val home_page_url : t -> string option

     

       118
       118
       +
       (** [home_page_url feed] returns the URL of the resource that the feed

     

       119
       119
       +
           describes. This resource may or may not actually be a "home" page, but it

     

       120
       120
       +
           should be an HTML page. For instance, if a feed is for a podcast, the

     

       121
       121
       +
           home_page_url would be the URL for the podcast's website. *)

     

       160
       122
        
       

     

       161
       161
       -
       (** [feed_url t] returns the feed's URL, if set. *)

     

       162
       123
        
       val feed_url : t -> string option

     

       124
       124
       +
       (** [feed_url feed] returns the URL of the feed itself. This should be the URL

     

       125
       125
       +
           that was requested to get this JSON Feed response. It helps feed readers

     

       126
       126
       +
           determine when they're being redirected. This is strongly recommended for

     

       127
       127
       +
           feeds. *)

     

       163
       128
        
       

     

       164
       164
       -
       (** [description t] returns the feed's description, if set. *)

     

       165
       129
        
       val description : t -> string option

     

       130
       130
       +
       (** [description feed] returns a plain text description of the feed, for human

     

       131
       131
       +
           consumption. This field may contain some formatting such as newlines. *)

     

       166
       132
        
       

     

       167
       167
       -
       (** [user_comment t] returns the feed's user comment, if set. *)

     

       168
       133
        
       val user_comment : t -> string option

     

       134
       134
       +
       (** [user_comment feed] returns a description of the purpose of the feed, for a

     

       135
       135
       +
           person looking at the raw JSON. This is for the publisher's use only and is

     

       136
       136
       +
           not intended to be displayed to end users. *)

     

       169
       137
        
       

     

       170
       170
       -
       (** [next_url t] returns the URL for the next page of items, if set. *)

     

       171
       138
        
       val next_url : t -> string option

     

       139
       139
       +
       (** [next_url feed] returns the URL of a feed that provides the next n items,

     

       140
       140
       +
           where n is determined by the publisher. This is used for pagination. A feed

     

       141
       141
       +
           reader may continue to request the URLs in next_url until it reaches a feed

     

       142
       142
       +
           without a next_url. *)

     

       172
       143
        
       

     

       173
       173
       -
       (** [icon t] returns the feed's icon URL, if set. *)

     

       174
       144
        
       val icon : t -> string option

     

       145
       145
       +
       (** [icon feed] returns the URL of an image for the feed suitable to be used in

     

       146
       146
       +
           a timeline, much the way an avatar might be used. It should be square and

     

       147
       147
       +
           relatively large (such as 512 x 512 pixels) and may be cropped to a circle

     

       148
       148
       +
           or rounded corners by feed readers. It should not be transparent. *)

     

       175
       149
        
       

     

       176
       176
       -
       (** [favicon t] returns the feed's favicon URL, if set. *)

     

       177
       150
        
       val favicon : t -> string option

     

       151
       151
       +
       (** [favicon feed] returns the URL of an image for the feed suitable to be used

     

       152
       152
       +
           in a source list. It should be square and relatively small (such as 64 x 64

     

       153
       153
       +
           pixels) and should not be transparent. *)

     

       178
       154
        
       

     

       179
       179
       -
       (** [authors t] returns the feed's default authors, if set. *)

     

       180
       155
        
       val authors : t -> Author.t list option

     

       156
       156
       +
       (** [authors feed] returns the feed authors. Each author object has several

     

       157
       157
       +
           members (name, url, avatar) which are all optional, but at least one must be

     

       158
       158
       +
           present for the object to be valid. If a feed has multiple authors, they

     

       159
       159
       +
           should all be listed here. *)

     

       181
       160
        
       

     

       182
       182
       -
       (** [language t] returns the feed's primary language, if set. *)

     

       183
       161
        
       val language : t -> string option

     

       162
       162
       +
       (** [language feed] returns the primary language for the feed in RFC 5646

     

       163
       163
       +
           format. The value can be a language tag such as "en" or "en-US", or a

     

       164
       164
       +
           language-region combination. This field helps feed readers present the feed

     

       165
       165
       +
           in the appropriate language. *)

     

       184
       166
        
       

     

       185
       185
       -
       (** [expired t] returns whether the feed will update again. *)

     

       186
       167
        
       val expired : t -> bool option

     

       168
       168
       +
       (** [expired feed] returns whether the feed is finished - that is, whether it

     

       169
       169
       +
           will ever update again. A feed for a temporary event, like an instance of a

     

       170
       170
       +
           conference, may expire. If the value is [Some true], feed readers may stop

     

       171
       171
       +
           checking for updates. *)

     

       187
       172
        
       

     

       188
       188
       -
       (** [hubs t] returns the feed's hub endpoints, if set. *)

     

       189
       173
        
       val hubs : t -> Hub.t list option

     

       174
       174
       +
       (** [hubs feed] returns endpoints that can be used to subscribe to real-time

     

       175
       175
       +
           notifications from the publisher of this feed. Each hub object has a type

     

       176
       176
       +
           (such as "rssCloud" or "WebSub") and a url. Feed readers can use these to

     

       177
       177
       +
           get immediate updates when new items are published. *)

     

       190
       178
        
       

     

       191
       191
       -
       (** [items t] returns the feed's items. *)

     

       192
       179
        
       val items : t -> Item.t list

     

       180
       180
       +
       (** [items feed] returns the array of items in the feed. This is a required

     

       181
       181
       +
           field, though it may be an empty list. Items represent the individual

     

       182
       182
       +
           entries in the feed - blog posts, podcast episodes, microblog posts, etc. *)

     

       193
       183
        
       

     

       184
       184
       +
       val unknown : t -> Unknown.t

     

       185
       185
       +
       (** [unknown feed] returns any unknown JSON object members that were preserved

     

       186
       186
       +
           during parsing. This is useful for custom extensions or fields from future

     

       187
       187
       +
           versions of the spec. *)

     

       194
       188
        
       

     

       195
       195
       -
       (** {1 Parsing and Serialization} *)

     

       189
       189
       +
       (** {1 Encoding and Decoding} *)

     

       196
       190
        
       

     

       197
       197
       -
       (** Error type for parsing operations. *)

     

       198
       198
       -
       type error = [ `Msg of string ]

     

       199
       199
       -
       

     

       200
       200
       -
       (** [of_jsonm decoder] parses a JSON Feed from a Jsonm decoder.

     

       201
       201
       -
       

     

       202
       202
       -
           This is the lowest-level parsing function, suitable for integration

     

       203
       203
       -
           with streaming JSON processing pipelines.

     

       204
       204
       -
       

     

       205
       205
       -
           @param decoder A Jsonm decoder positioned at the start of a JSON Feed document

     

       206
       206
       -
           @return [Ok feed] on success, [Error (`Msg err)] on parse error

     

       207
       207
       -
       

     

       208
       208
       -
           {b Example:}

     

       209
       209
       -
           {[

     

       210
       210
       -
             let decoder = Jsonm.decoder (`String json_string) in

     

       211
       211
       -
             match Jsonfeed.of_jsonm decoder with

     

       212
       212
       -
             | Ok feed -> (* process feed *)

     

       213
       213
       -
             | Error (`Msg err) -> (* handle error *)

     

       214
       214
       -
           ]} *)

     

       215
       215
       -
       val of_jsonm : Jsonm.decoder -> (t, [> error]) result

     

       216
       216
       -
       

     

       217
       217
       -
       (** [to_jsonm encoder feed] serializes a JSON Feed to a Jsonm encoder.

     

       218
       218
       -
       

     

       219
       219
       -
           This is the lowest-level serialization function, suitable for integration

     

       220
       220
       -
           with streaming JSON generation pipelines.

     

       221
       221
       -
       

     

       222
       222
       -
           @param encoder A Jsonm encoder

     

       223
       223
       -
           @param feed The feed to serialize

     

       224
       224
       -
       

     

       225
       225
       -
           {b Example:}

     

       226
       226
       -
           {[

     

       227
       227
       -
             let buffer = Buffer.create 1024 in

     

       228
       228
       -
             let encoder = Jsonm.encoder (`Buffer buffer) in

     

       229
       229
       -
             Jsonfeed.to_jsonm encoder feed;

     

       230
       230
       -
             let json = Buffer.contents buffer

     

       231
       231
       -
           ]} *)

     

       232
       232
       -
       val to_jsonm : Jsonm.encoder -> t -> unit

     

       233
       233
       -
       

     

       234
       234
       -
       (** [of_string s] parses a JSON Feed from a string.

     

       235
       235
       -
       

     

       236
       236
       -
           @param s A JSON string containing a JSON Feed document

     

       237
       237
       -
           @return [Ok feed] on success, [Error (`Msg err)] on parse error

     

       238
       238
       -
       

     

       239
       239
       -
           {b Example:}

     

       240
       240
       -
           {[

     

       241
       241
       -
             let json = {|{

     

       242
       242
       -
               "version": "https://jsonfeed.org/version/1.1",

     

       243
       243
       -
               "title": "My Feed",

     

       244
       244
       -
               "items": []

     

       245
       245
       -
             }|} in

     

       246
       246
       -
             match Jsonfeed.of_string json with

     

       247
       247
       -
             | Ok feed -> Printf.printf "Parsed: %s\n" (Jsonfeed.title feed)

     

       248
       248
       -
             | Error (`Msg err) -> Printf.eprintf "Error: %s\n" err

     

       249
       249
       -
           ]} *)

     

       250
       250
       -
       val of_string : string -> (t, [> error]) result

     

       251
       251
       -
       

     

       252
       252
       -
       (** [to_string ?minify feed] serializes a JSON Feed to a string.

     

       253
       253
       -
       

     

       254
       254
       -
           @param minify If [true], produces compact JSON without whitespace.

     

       255
       255
       -
                         If [false] (default), produces indented, human-readable JSON.

     

       256
       256
       -
           @param feed The feed to serialize

     

       257
       257
       -
           @return A JSON string

     

       258
       258
       -
       

     

       259
       259
       -
           {b Example:}

     

       260
       260
       -
           {[

     

       261
       261
       -
             let json = Jsonfeed.to_string feed

     

       262
       262
       -
             let compact = Jsonfeed.to_string ~minify:true feed

     

       263
       263
       -
           ]} *)

     

       264
       264
       -
       val to_string : ?minify:bool -> t -> string

     

       265
       265
       -
       

     

       266
       266
       -
       

     

       267
       267
       -
       (** {1 Date Utilities} *)

     

       268
       268
       -
       

     

       269
       269
       -
       (** [parse_rfc3339 s] parses an RFC 3339 date/time string.

     

       270
       270
       -
       

     

       271
       271
       -
           This function parses timestamps in the format required by JSON Feed,

     

       272
       272
       -
           such as ["2024-11-03T10:30:00Z"] or ["2024-11-03T10:30:00-08:00"].

     

       273
       273
       -
       

     

       274
       274
       -
           @param s An RFC 3339 formatted date/time string

     

       275
       275
       -
           @return [Some time] on success, [None] if the string is invalid

     

       276
       276
       -
       

     

       277
       277
       -
           {b Examples:}

     

       278
       278
       -
           {[

     

       279
       279
       -
             parse_rfc3339 "2024-11-03T10:30:00Z"

     

       280
       280
       -
             (* returns Some time *)

     

       191
       191
       +
       val decode :

     

       192
       192
       +
         ?layout:bool ->

     

       193
       193
       +
         ?locs:bool ->

     

       194
       194
       +
         ?file:string ->

     

       195
       195
       +
         Bytesrw.Bytes.Reader.t ->

     

       196
       196
       +
         (t, Jsont.Error.t) result

     

       197
       197
       +
       (** [decode r] decodes a JSON Feed from bytesrw reader [r].

     

       281
       198
        
       

     

       282
       282
       -
             parse_rfc3339 "2024-11-03T10:30:00-08:00"

     

       283
       283
       -
             (* returns Some time *)

     

       199
       199
       +
           @param layout Preserve whitespace for round-tripping (default: false)

     

       200
       200
       +
           @param locs Track locations for better error messages (default: false)

     

       201
       201
       +
           @param file Source file name for error reporting *)

     

       284
       202
        
       

     

       285
       285
       -
             parse_rfc3339 "invalid"

     

       286
       286
       -
             (* returns None *)

     

       287
       287
       -
           ]} *)

     

       288
       288
       -
       val parse_rfc3339 : string -> Ptime.t option

     

       203
       203
       +
       val decode_string :

     

       204
       204
       +
         ?layout:bool ->

     

       205
       205
       +
         ?locs:bool ->

     

       206
       206
       +
         ?file:string ->

     

       207
       207
       +
         string ->

     

       208
       208
       +
         (t, Jsont.Error.t) result

     

       209
       209
       +
       (** [decode_string s] decodes a JSON Feed from string [s]. *)

     

       289
       210
        
       

     

       290
       290
       -
       (** [format_rfc3339 time] formats a timestamp as an RFC 3339 string.

     

       211
       211
       +
       val encode :

     

       212
       212
       +
         ?format:Jsont.format ->

     

       213
       213
       +
         ?number_format:Jsont.number_format ->

     

       214
       214
       +
         t ->

     

       215
       215
       +
         eod:bool ->

     

       216
       216
       +
         Bytesrw.Bytes.Writer.t ->

     

       217
       217
       +
         (unit, Jsont.Error.t) result

     

       218
       218
       +
       (** [encode feed w] encodes [feed] to bytesrw writer [w].

     

       291
       219
        
       

     

       292
       292
       -
           The output uses UTC timezone (Z suffix) and includes fractional seconds

     

       293
       293
       -
           if the timestamp has sub-second precision.

     

       220
       220
       +
           @param format

     

       221
       221
       +
             Output formatting: [Jsont.Minify] or [Jsont.Indent] (default: Minify)

     

       222
       222
       +
           @param number_format Printf format for numbers (default: "%.16g")

     

       223
       223
       +
           @param eod Write end-of-data marker *)

     

       294
       224
        
       

     

       295
       295
       -
           @param time A Ptime timestamp

     

       296
       296
       -
           @return An RFC 3339 formatted string

     

       225
       225
       +
       val encode_string :

     

       226
       226
       +
         ?format:Jsont.format ->

     

       227
       227
       +
         ?number_format:Jsont.number_format ->

     

       228
       228
       +
         t ->

     

       229
       229
       +
         (string, Jsont.Error.t) result

     

       230
       230
       +
       (** [encode_string feed] encodes [feed] to a string. *)

     

       297
       231
        
       

     

       298
       298
       -
           {b Example:}

     

       299
       299
       -
           {[

     

       300
       300
       -
             let now = Ptime_clock.now () in

     

       301
       301
       -
             let s = format_rfc3339 now

     

       302
       302
       -
             (* returns "2024-11-03T10:30:45.123Z" or similar *)

     

       303
       303
       -
           ]} *)

     

       304
       304
       -
       val format_rfc3339 : Ptime.t -> string

     

       232
       232
       +
       val of_string : string -> (t, Jsont.Error.t) result

     

       233
       233
       +
       (** Alias for [decode_string] with default options. *)

     

       305
       234
        
       

     

       235
       235
       +
       val to_string : ?minify:bool -> t -> (string, Jsont.Error.t) result

     

       236
       236
       +
       (** [to_string feed] encodes [feed] to string.

     

       237
       237
       +
           @param minify Use compact format (true) or indented (false, default) *)

     

       306
       238
        
       

     

       307
       239
        
       (** {1 Validation} *)

     

       308
       240
        
       

     

       309
       309
       -
       (** [validate feed] validates a JSON Feed.

     

       310
       310
       -
       

     

       311
       311
       -
           Checks that:

     

       312
       312
       -
           - All required fields are present

     

       313
       313
       -
           - All items have unique IDs

     

       314
       314
       -
           - All items have valid content

     

       315
       315
       -
           - All URLs are well-formed (if possible)

     

       316
       316
       -
           - Authors have at least one field set

     

       317
       317
       -
       

     

       318
       318
       -
           @param feed The feed to validate

     

       319
       319
       -
           @return [Ok ()] if valid, [Error errors] with a list of validation issues

     

       320
       320
       -
       

     

       321
       321
       -
           {b Example:}

     

       322
       322
       -
           {[

     

       323
       323
       -
             match Jsonfeed.validate feed with

     

       324
       324
       -
             | Ok () -> (* feed is valid *)

     

       325
       325
       -
             | Error errors ->

     

       326
       326
       -
                 List.iter (Printf.eprintf "Validation error: %s\n") errors

     

       327
       327
       -
           ]} *)

     

       328
       241
        
       val validate : t -> (unit, string list) result

     

       329
       329
       -
       

     

       242
       242
       +
       (** [validate feed] validates the feed structure. Checks for unique item IDs,

     

       243
       243
       +
           valid content, etc. *)

     

       330
       244
        
       

     

       331
       245
        
       (** {1 Comparison} *)

     

       332
       246
        
       

     

       333
       333
       -
       (** [equal a b] tests equality between two feeds.

     

       334
       334
       -
       

     

       335
       335
       -
           Feeds are compared structurally, including all fields and items. *)

     

       336
       247
        
       val equal : t -> t -> bool

     

       337
       337
       -
       

     

       248
       248
       +
       (** [equal a b] tests equality between two feeds. *)

     

       338
       249
        
       

     

       339
       250
        
       (** {1 Pretty Printing} *)

     

       340
       251
        
       

     

       341
       341
       -
       (** [pp ppf feed] pretty prints a feed to the formatter.

     

       342
       342
       -
       

     

       343
       343
       -
           The output is human-readable and suitable for debugging. It shows

     

       344
       344
       -
           the feed's metadata and a summary of items.

     

       345
       345
       -
       

     

       346
       346
       -
           {b Example output:}

     

       347
       347
       -
           {v

     

       348
       348
       -
           Feed: My Blog (https://example.com)

     

       349
       349
       -
             Items: 2

     

       350
       350
       -
             Authors: Jane Doe

     

       351
       351
       -
             Language: en-US

     

       352
       352
       -
           v} *)

     

       353
       252
        
       val pp : Format.formatter -> t -> unit

     

       354
       354
       -
       

     

       355
       355
       -
       (** [pp_summary ppf feed] prints a brief summary of the feed.

     

       356
       356
       -
       

     

       357
       357
       -
           Shows only the title and item count.

     

       358
       358
       -
       

     

       359
       359
       -
           {b Example output:}

     

       360
       360
       -
           {v My Blog (2 items) v} *)

     

       361
       253
        
       val pp_summary : Format.formatter -> t -> unit

     

       362
       254
        
       

     

       255
       255
       +
       (** {1 Submodules} *)

     

       363
       256
        
       

     

       364
       364
       -
       (** {1 Feed Content} *)

     

       365
       365
       -
       

     

       366
       366
       -
       (** Author information for feeds and items. *)

     

       257
       257
       +
       module Rfc3339 = Rfc3339

     

       258
       258
       +
       module Cito = Cito

     

       367
       259
        
       module Author = Author

     

       368
       368
       -
       

     

       369
       369
       -
       (** Attachments for feed items (audio, video, downloads). *)

     

       370
       260
        
       module Attachment = Attachment

     

       371
       371
       -
       

     

       372
       372
       -
       (** Hub endpoints for real-time notifications. *)

     

       373
       261
        
       module Hub = Hub

     

       374
       374
       -
       

     

       375
       375
       -
       (** Feed items (posts, episodes, entries). *)

     

       376
       376
       -
       module Item = Item

     

       377
       377
       -
       

     

       378
       378
       -
       (** References to cited sources in items (extension). *)

     

       379
       262
        
       module Reference = Reference

     

       380
       380
       -
       

     

       381
       381
       -
       (** Citation Typing Ontology annotations for references (extension). *)

     

       382
       382
       -
       module Cito = Cito

     

       263
       263
       +
       module Item = Item

+28 -5

lib/reference.ml

···

       1
       1
       +
       (*---------------------------------------------------------------------------

     

       2
       2
       +
          Copyright (c) 2024 Anil Madhavapeddy. All rights reserved.

     

       3
       3
       +
          SPDX-License-Identifier: ISC

     

       4
       4
       +
         ---------------------------------------------------------------------------*)

     

       5
       5
       +
       

     

       6
       6
       +
       module Unknown = struct

     

       7
       7
       +
         type t = Jsont.json

     

       8
       8
       +
       

     

       9
       9
       +
         let empty = Jsont.Object ([], Jsont.Meta.none)

     

       10
       10
       +
         let is_empty = function Jsont.Object ([], _) -> true | _ -> false

     

       11
       11
       +
       end

     

       12
       12
       +
       

     

       1
       13
        
       type t = {

     

       2
       14
        
         url : string;

     

       3
       15
        
         doi : string option;

     

       4
       16
        
         cito : Cito.t list option;

     

       17
       17
       +
         unknown : Unknown.t;

     

       5
       18
        
       }

     

       6
       19
        
       

     

       7
       7
       -
       let create ~url ?doi ?cito () = { url; doi; cito }

     

       20
       20
       +
       let create ~url ?doi ?cito ?(unknown = Unknown.empty) () =

     

       21
       21
       +
         { url; doi; cito; unknown }

     

       8
       22
        
       

     

       9
       23
        
       let url t = t.url

     

       10
       24
        
       let doi t = t.doi

     

       11
       25
        
       let cito t = t.cito

     

       12
       12
       -
       

     

       26
       26
       +
       let unknown t = t.unknown

     

       13
       27
        
       let equal a b = String.equal a.url b.url

     

       14
       28
        
       

     

       15
       29
        
       let pp ppf t =

     

       16
       30
        
         let open Format in

     

       17
       31
        
         fprintf ppf "%s" t.url;

     

       18
       18
       -
         match t.doi with

     

       19
       19
       -
         | Some d -> fprintf ppf " [DOI: %s]" d

     

       20
       20
       -
         | None -> ()

     

       32
       32
       +
         Option.iter (fprintf ppf " [DOI: %s]") t.doi

     

       33
       33
       +
       

     

       34
       34
       +
       let jsont =

     

       35
       35
       +
         let kind = "Reference" in

     

       36
       36
       +
         let doc = "A reference to a cited source" in

     

       37
       37
       +
         let create_obj url doi cito unknown = create ~url ?doi ?cito ~unknown () in

     

       38
       38
       +
         Jsont.Object.map ~kind ~doc create_obj

     

       39
       39
       +
         |> Jsont.Object.mem "url" Jsont.string ~enc:url

     

       40
       40
       +
         |> Jsont.Object.opt_mem "doi" Jsont.string ~enc:doi

     

       41
       41
       +
         |> Jsont.Object.opt_mem "cito" (Jsont.list Cito.jsont) ~enc:cito

     

       42
       42
       +
         |> Jsont.Object.keep_unknown Jsont.json_mems ~enc:unknown

     

       43
       43
       +
         |> Jsont.Object.finish

+62 -39

lib/reference.mli

···

       1
       1
       +
       (*---------------------------------------------------------------------------

     

       2
       2
       +
          Copyright (c) 2024 Anil Madhavapeddy. All rights reserved.

     

       3
       3
       +
          SPDX-License-Identifier: ISC

     

       4
       4
       +
         ---------------------------------------------------------------------------*)

     

       5
       5
       +
       

     

       1
       6
        
       (** References extension for JSON Feed items.

     

       2
       7
        
       

     

       3
       8
        
           This implements the references extension that allows items to cite sources.

     

       4
       4
       -
           Each reference represents a cited resource with optional DOI and CiTO annotations.

     

       9
       9
       +
           Each reference represents a cited resource with optional DOI and CiTO

     

       10
       10
       +
           annotations.

     

       5
       11
        
       

     

       6
       6
       -
           @see <https://github.com/egonw/JSONFeed-extensions/blob/main/references.md> References Extension Specification

     

       12
       12
       +
           @see <https://github.com/egonw/JSONFeed-extensions/blob/main/references.md>

     

       13
       13
       +
             References Extension Specification

     

       7
       14
        
           @see <https://purl.archive.org/spar/cito> Citation Typing Ontology *)

     

       8
       15
        
       

     

       16
       16
       +
       type t

     

       17
       17
       +
       (** The type representing a reference to a cited source. *)

     

       9
       18
        
       

     

       10
       10
       -
       (** The type representing a reference to a cited source. *)

     

       11
       11
       -
       type t

     

       19
       19
       +
       (** {1 Unknown Fields} *)

     

       20
       20
       +
       

     

       21
       21
       +
       module Unknown : sig

     

       22
       22
       +
         type t = Jsont.json

     

       23
       23
       +
         (** Unknown/unrecognized JSON object members as a generic JSON object. Useful

     

       24
       24
       +
             for preserving fields from custom extensions or future spec versions. *)

     

       25
       25
       +
       

     

       26
       26
       +
         val empty : t

     

       27
       27
       +
         (** [empty] is the empty list of unknown fields. *)

     

       28
       28
       +
       

     

       29
       29
       +
         val is_empty : t -> bool

     

       30
       30
       +
         (** [is_empty u] returns [true] if there are no unknown fields. *)

     

       31
       31
       +
       end

     

       12
       32
        
       

     

       33
       33
       +
       (** {1 Jsont Type} *)

     

       34
       34
       +
       

     

       35
       35
       +
       val jsont : t Jsont.t

     

       36
       36
       +
       (** Declarative JSON type for references.

     

       37
       37
       +
       

     

       38
       38
       +
           Maps JSON objects with "url" (required) and optional "doi" and "cito"

     

       39
       39
       +
           fields. *)

     

       13
       40
        
       

     

       14
       41
        
       (** {1 Construction} *)

     

       15
       42
        
       

     

       16
       16
       -
       (** [create ~url ?doi ?cito ()] creates a reference.

     

       43
       43
       +
       val create :

     

       44
       44
       +
         url:string ->

     

       45
       45
       +
         ?doi:string ->

     

       46
       46
       +
         ?cito:Cito.t list ->

     

       47
       47
       +
         ?unknown:Unknown.t ->

     

       48
       48
       +
         unit ->

     

       49
       49
       +
         t

     

       50
       50
       +
       (** [create ~url ?doi ?cito ?unknown ()] creates a reference.

     

       17
       51
        
       

     

       18
       18
       -
           @param url Unique URL for the reference (required).

     

       19
       19
       -
                      A URL based on a persistent unique identifier (like DOI) is recommended.

     

       52
       52
       +
           @param url

     

       53
       53
       +
             Unique URL for the reference (required). A URL based on a persistent

     

       54
       54
       +
             unique identifier (like DOI) is recommended.

     

       20
       55
        
           @param doi Digital Object Identifier for the reference

     

       21
       56
        
           @param cito Citation Typing Ontology intent annotations

     

       57
       57
       +
           @param unknown Unknown/custom fields for extensions (default: empty)

     

       22
       58
        
       

     

       23
       59
        
           {b Examples:}

     

       24
       60
        
           {[

     

       25
       61
        
             (* Simple reference with just a URL *)

     

       26
       26
       -
             let ref1 = Reference.create

     

       27
       27
       -
               ~url:"https://doi.org/10.5281/zenodo.16755947"

     

       28
       28
       -
               ()

     

       62
       62
       +
             let ref1 =

     

       63
       63
       +
               Reference.create ~url:"https://doi.org/10.5281/zenodo.16755947" ()

     

       29
       64
        
       

     

       30
       65
        
             (* Reference with DOI *)

     

       31
       31
       -
             let ref2 = Reference.create

     

       32
       32
       -
               ~url:"https://doi.org/10.5281/zenodo.16755947"

     

       33
       33
       -
               ~doi:"10.5281/zenodo.16755947"

     

       34
       34
       -
               ()

     

       66
       66
       +
             let ref2 =

     

       67
       67
       +
               Reference.create ~url:"https://doi.org/10.5281/zenodo.16755947"

     

       68
       68
       +
                 ~doi:"10.5281/zenodo.16755947" ()

     

       35
       69
        
       

     

       36
       70
        
             (* Reference with CiTO annotations *)

     

       37
       37
       -
             let ref3 = Reference.create

     

       38
       38
       -
               ~url:"https://doi.org/10.5281/zenodo.16755947"

     

       39
       39
       -
               ~doi:"10.5281/zenodo.16755947"

     

       40
       40
       -
               ~cito:[`CitesAsRecommendedReading; `UsesMethodIn]

     

       41
       41
       -
               ()

     

       42
       42
       -
       

     

       43
       43
       -
             (* Reference with custom CiTO term *)

     

       44
       44
       -
             let ref4 = Reference.create

     

       45
       45
       -
               ~url:"https://example.com/paper"

     

       46
       46
       -
               ~cito:[`Other "customIntent"]

     

       47
       47
       -
               ()

     

       71
       71
       +
             let ref3 =

     

       72
       72
       +
               Reference.create ~url:"https://doi.org/10.5281/zenodo.16755947"

     

       73
       73
       +
                 ~doi:"10.5281/zenodo.16755947"

     

       74
       74
       +
                 ~cito:[ `CitesAsRecommendedReading; `UsesMethodIn ]

     

       75
       75
       +
                 ()

     

       48
       76
        
           ]} *)

     

       49
       49
       -
       val create :

     

       50
       50
       -
         url:string ->

     

       51
       51
       -
         ?doi:string ->

     

       52
       52
       -
         ?cito:Cito.t list ->

     

       53
       53
       -
         unit ->

     

       54
       54
       -
         t

     

       55
       55
       -
       

     

       56
       77
        
       

     

       57
       78
        
       (** {1 Accessors} *)

     

       58
       79
        
       

     

       59
       59
       -
       (** [url t] returns the reference's URL. *)

     

       60
       80
        
       val url : t -> string

     

       81
       81
       +
       (** [url t] returns the reference's URL. *)

     

       61
       82
        
       

     

       83
       83
       +
       val doi : t -> string option

     

       62
       84
        
       (** [doi t] returns the reference's DOI, if set. *)

     

       63
       63
       -
       val doi : t -> string option

     

       64
       85
        
       

     

       65
       65
       -
       (** [cito t] returns the reference's CiTO annotations, if set. *)

     

       66
       86
        
       val cito : t -> Cito.t list option

     

       87
       87
       +
       (** [cito t] returns the reference's CiTO annotations, if set. *)

     

       67
       88
        
       

     

       89
       89
       +
       val unknown : t -> Unknown.t

     

       90
       90
       +
       (** [unknown t] returns unrecognized fields from the JSON. *)

     

       68
       91
        
       

     

       69
       92
        
       (** {1 Comparison} *)

     

       70
       93
        
       

     

       94
       94
       +
       val equal : t -> t -> bool

     

       71
       95
        
       (** [equal a b] tests equality between two references.

     

       72
       96
        
       

     

       73
       97
        
           References are considered equal if they have the same URL. *)

     

       74
       74
       -
       val equal : t -> t -> bool

     

       75
       75
       -
       

     

       76
       98
        
       

     

       77
       99
        
       (** {1 Pretty Printing} *)

     

       78
       100
        
       

     

       101
       101
       +
       val pp : Format.formatter -> t -> unit

     

       79
       102
        
       (** [pp ppf t] pretty prints a reference to the formatter.

     

       80
       103
        
       

     

       81
       104
        
           {b Example output:}

     

       82
       82
       -
           {v https://doi.org/10.5281/zenodo.16755947 [DOI: 10.5281/zenodo.16755947] v} *)

     

       83
       83
       -
       val pp : Format.formatter -> t -> unit

     

       105
       105
       +
           {v https://doi.org/10.5281/zenodo.16755947 [DOI: 10.5281/zenodo.16755947] v}

     

       106
       106
       +
       *)

+23

lib/rfc3339.ml

···

       1
       1
       +
       (*---------------------------------------------------------------------------

     

       2
       2
       +
          Copyright (c) 2024 Anil Madhavapeddy. All rights reserved.

     

       3
       3
       +
          SPDX-License-Identifier: ISC

     

       4
       4
       +
         ---------------------------------------------------------------------------*)

     

       5
       5
       +
       

     

       6
       6
       +
       let parse s =

     

       7
       7
       +
         Ptime.of_rfc3339 s |> Result.to_option |> Option.map (fun (t, _, _) -> t)

     

       8
       8
       +
       

     

       9
       9
       +
       let format t = Ptime.to_rfc3339 ~frac_s:6 ~tz_offset_s:0 t

     

       10
       10
       +
       let pp ppf t = Format.pp_print_string ppf (format t)

     

       11
       11
       +
       

     

       12
       12
       +
       let jsont =

     

       13
       13
       +
         let kind = "RFC 3339 timestamp" in

     

       14
       14
       +
         let doc = "An RFC 3339 date-time string" in

     

       15
       15
       +
         let dec s =

     

       16
       16
       +
           match parse s with

     

       17
       17
       +
           | Some t -> t

     

       18
       18
       +
           | None ->

     

       19
       19
       +
               Jsont.Error.msgf Jsont.Meta.none "%s: invalid RFC 3339 timestamp: %S"

     

       20
       20
       +
                 kind s

     

       21
       21
       +
         in

     

       22
       22
       +
         let enc = format in

     

       23
       23
       +
         Jsont.map ~kind ~doc ~dec ~enc Jsont.string

+44

lib/rfc3339.mli

···

       1
       1
       +
       (*---------------------------------------------------------------------------

     

       2
       2
       +
          Copyright (c) 2024 Anil Madhavapeddy. All rights reserved.

     

       3
       3
       +
          SPDX-License-Identifier: ISC

     

       4
       4
       +
         ---------------------------------------------------------------------------*)

     

       5
       5
       +
       

     

       6
       6
       +
       (** RFC 3339 date/time handling for JSON Feed.

     

       7
       7
       +
       

     

       8
       8
       +
           Provides parsing, formatting, and jsont combinators for RFC 3339 timestamps

     

       9
       9
       +
           as required by the JSON Feed specification.

     

       10
       10
       +
       

     

       11
       11
       +
           @see <https://www.rfc-editor.org/rfc/rfc3339> RFC 3339 *)

     

       12
       12
       +
       

     

       13
       13
       +
       val jsont : Ptime.t Jsont.t

     

       14
       14
       +
       (** [jsont] is a bidirectional JSON type for RFC 3339 timestamps.

     

       15
       15
       +
       

     

       16
       16
       +
           On decode: accepts JSON strings in RFC 3339 format (e.g.,

     

       17
       17
       +
           "2024-11-03T10:30:00Z") On encode: produces UTC timestamps with 'Z' suffix

     

       18
       18
       +
       

     

       19
       19
       +
           {b Example:}

     

       20
       20
       +
           {[

     

       21
       21
       +
             let time = Ptime.of_float_s (Unix.time ()) |> Option.get in

     

       22
       22
       +
             Jsont_bytesrw.encode_string Rfc3339.jsont time

     

       23
       23
       +
           ]} *)

     

       24
       24
       +
       

     

       25
       25
       +
       val parse : string -> Ptime.t option

     

       26
       26
       +
       (** [parse s] parses an RFC 3339 timestamp string.

     

       27
       27
       +
       

     

       28
       28
       +
           Accepts various formats:

     

       29
       29
       +
           - "2024-11-03T10:30:00Z" (UTC)

     

       30
       30
       +
           - "2024-11-03T10:30:00-08:00" (with timezone offset)

     

       31
       31
       +
           - "2024-11-03T10:30:00.123Z" (with fractional seconds)

     

       32
       32
       +
       

     

       33
       33
       +
           Returns [None] if the string is not valid RFC 3339. *)

     

       34
       34
       +
       

     

       35
       35
       +
       val format : Ptime.t -> string

     

       36
       36
       +
       (** [format t] formats a timestamp as RFC 3339.

     

       37
       37
       +
       

     

       38
       38
       +
           Always uses UTC timezone (Z suffix) and includes fractional seconds if the

     

       39
       39
       +
           timestamp has sub-second precision.

     

       40
       40
       +
       

     

       41
       41
       +
           {b Example output:} ["2024-11-03T10:30:45.123Z"] *)

     

       42
       42
       +
       

     

       43
       43
       +
       val pp : Format.formatter -> Ptime.t -> unit

     

       44
       44
       +
       (** [pp ppf t] pretty prints a timestamp in RFC 3339 format. *)

+30

test/data/complete_valid.json

···

       1
       1
       +
       {

     

       2
       2
       +
         "version": "https://jsonfeed.org/version/1.1",

     

       3
       3
       +
         "title": "Complete Feed",

     

       4
       4
       +
         "home_page_url": "https://example.com",

     

       5
       5
       +
         "feed_url": "https://example.com/feed.json",

     

       6
       6
       +
         "description": "A complete test feed",

     

       7
       7
       +
         "user_comment": "Test comment",

     

       8
       8
       +
         "next_url": "https://example.com/feed2.json",

     

       9
       9
       +
         "icon": "https://example.com/icon.png",

     

       10
       10
       +
         "favicon": "https://example.com/favicon.ico",

     

       11
       11
       +
         "authors": [

     

       12
       12
       +
           {

     

       13
       13
       +
             "name": "Test Author",

     

       14
       14
       +
             "url": "https://example.com/author",

     

       15
       15
       +
             "avatar": "https://example.com/avatar.png"

     

       16
       16
       +
           }

     

       17
       17
       +
         ],

     

       18
       18
       +
         "language": "en-US",

     

       19
       19
       +
         "expired": false,

     

       20
       20
       +
         "items": [

     

       21
       21
       +
           {

     

       22
       22
       +
             "id": "https://example.com/item1",

     

       23
       23
       +
             "content_html": "<p>Test content</p>",

     

       24
       24
       +
             "title": "Test Item",

     

       25
       25
       +
             "url": "https://example.com/item1.html",

     

       26
       26
       +
             "date_published": "2024-01-01T12:00:00Z",

     

       27
       27
       +
             "tags": ["test", "example"]

     

       28
       28
       +
           }

     

       29
       29
       +
         ]

     

       30
       30
       +
       }

test/data/extra_comma.json

···

       1
       1
       +
       {

     

       2
       2
       +
         "version": "https://jsonfeed.org/version/1.1",

     

       3
       3
       +
         "title": "Feed with trailing comma",

     

       4
       4
       +
         "items": [],

     

       5
       5
       +
       }

test/data/invalid_author_type.json

···

       1
       1
       +
       {

     

       2
       2
       +
         "version": "https://jsonfeed.org/version/1.1",

     

       3
       3
       +
         "title": "Feed with invalid author",

     

       4
       4
       +
         "authors": [

     

       5
       5
       +
           "Just a string instead of object"

     

       6
       6
       +
         ],

     

       7
       7
       +
         "items": []

     

       8
       8
       +
       }

+11

test/data/invalid_date_format.json

···

       1
       1
       +
       {

     

       2
       2
       +
         "version": "https://jsonfeed.org/version/1.1",

     

       3
       3
       +
         "title": "Feed with invalid date",

     

       4
       4
       +
         "items": [

     

       5
       5
       +
           {

     

       6
       6
       +
             "id": "https://example.com/item1",

     

       7
       7
       +
             "content_html": "<p>Test</p>",

     

       8
       8
       +
             "date_published": "not-a-valid-date"

     

       9
       9
       +
           }

     

       10
       10
       +
         ]

     

       11
       11
       +
       }

+10

test/data/invalid_hub_type.json

···

       1
       1
       +
       {

     

       2
       2
       +
         "version": "https://jsonfeed.org/version/1.1",

     

       3
       3
       +
         "title": "Feed with invalid hub",

     

       4
       4
       +
         "hubs": [

     

       5
       5
       +
           {

     

       6
       6
       +
             "type": "WebSub"

     

       7
       7
       +
           }

     

       8
       8
       +
         ],

     

       9
       9
       +
         "items": []

     

       10
       10
       +
       }

+16

test/data/invalid_nested_attachment.json

···

       1
       1
       +
       {

     

       2
       2
       +
         "version": "https://jsonfeed.org/version/1.1",

     

       3
       3
       +
         "title": "Feed with invalid attachment",

     

       4
       4
       +
         "items": [

     

       5
       5
       +
           {

     

       6
       6
       +
             "id": "https://example.com/item1",

     

       7
       7
       +
             "content_html": "<p>Test</p>",

     

       8
       8
       +
             "attachments": [

     

       9
       9
       +
               {

     

       10
       10
       +
                 "url": "https://example.com/file.mp3",

     

       11
       11
       +
                 "mime_type": 12345

     

       12
       12
       +
               }

     

       13
       13
       +
             ]

     

       14
       14
       +
           }

     

       15
       15
       +
         ]

     

       16
       16
       +
       }

test/data/malformed_json.json

···

       1
       1
       +
       {

     

       2
       2
       +
         "version": "https://jsonfeed.org/version/1.1"

     

       3
       3
       +
         "title": "Missing comma between fields",

     

       4
       4
       +
         "items": []

     

       5
       5
       +
       }

test/data/minimal_valid.json

···

       1
       1
       +
       {

     

       2
       2
       +
         "version": "https://jsonfeed.org/version/1.1",

     

       3
       3
       +
         "title": "Minimal Feed",

     

       4
       4
       +
         "items": []

     

       5
       5
       +
       }

+10

test/data/missing_item_content.json

···

       1
       1
       +
       {

     

       2
       2
       +
         "version": "https://jsonfeed.org/version/1.1",

     

       3
       3
       +
         "title": "Feed with item missing content",

     

       4
       4
       +
         "items": [

     

       5
       5
       +
           {

     

       6
       6
       +
             "id": "https://example.com/nocontent",

     

       7
       7
       +
             "title": "Item without content"

     

       8
       8
       +
           }

     

       9
       9
       +
         ]

     

       10
       10
       +
       }

test/data/missing_item_id.json

···

       1
       1
       +
       {

     

       2
       2
       +
         "version": "https://jsonfeed.org/version/1.1",

     

       3
       3
       +
         "title": "Feed with item missing ID",

     

       4
       4
       +
         "items": [

     

       5
       5
       +
           {

     

       6
       6
       +
             "content_html": "<p>Item without id</p>"

     

       7
       7
       +
           }

     

       8
       8
       +
         ]

     

       9
       9
       +
       }

test/data/missing_items.json

···

       1
       1
       +
       {

     

       2
       2
       +
         "version": "https://jsonfeed.org/version/1.1",

     

       3
       3
       +
         "title": "Feed without items"

     

       4
       4
       +
       }

test/data/missing_title.json

···

       1
       1
       +
       {

     

       2
       2
       +
         "version": "https://jsonfeed.org/version/1.1",

     

       3
       3
       +
         "items": []

     

       4
       4
       +
       }

test/data/missing_version.json

···

       1
       1
       +
       {

     

       2
       2
       +
         "title": "Feed without version",

     

       3
       3
       +
         "items": []

     

       4
       4
       +
       }

+19

test/data/mixed_content.json

···

       1
       1
       +
       {

     

       2
       2
       +
         "version": "https://jsonfeed.org/version/1.1",

     

       3
       3
       +
         "title": "Mixed Content Feed",

     

       4
       4
       +
         "items": [

     

       5
       5
       +
           {

     

       6
       6
       +
             "id": "https://example.com/html",

     

       7
       7
       +
             "content_html": "<p>HTML only</p>"

     

       8
       8
       +
           },

     

       9
       9
       +
           {

     

       10
       10
       +
             "id": "https://example.com/text",

     

       11
       11
       +
             "content_text": "Text only"

     

       12
       12
       +
           },

     

       13
       13
       +
           {

     

       14
       14
       +
             "id": "https://example.com/both",

     

       15
       15
       +
             "content_html": "<p>HTML version</p>",

     

       16
       16
       +
             "content_text": "Text version"

     

       17
       17
       +
           }

     

       18
       18
       +
         ]

     

       19
       19
       +
       }

test/data/with_extensions.json

···

       1
       1
       +
       {

     

       2
       2
       +
         "version": "https://jsonfeed.org/version/1.1",

     

       3
       3
       +
         "title": "Feed with Extensions",

     

       4
       4
       +
         "items": [],

     

       5
       5
       +
         "_custom_field": "custom value",

     

       6
       6
       +
         "_another_extension": {

     

       7
       7
       +
           "nested": "data"

     

       8
       8
       +
         }

     

       9
       9
       +
       }

test/data/wrong_type_expired.json

···

       1
       1
       +
       {

     

       2
       2
       +
         "version": "https://jsonfeed.org/version/1.1",

     

       3
       3
       +
         "title": "Feed with wrong type for expired",

     

       4
       4
       +
         "expired": "yes",

     

       5
       5
       +
         "items": []

     

       6
       6
       +
       }

test/data/wrong_type_items.json

···

       1
       1
       +
       {

     

       2
       2
       +
         "version": "https://jsonfeed.org/version/1.1",

     

       3
       3
       +
         "title": "Feed with items as object",

     

       4
       4
       +
         "items": {

     

       5
       5
       +
           "item1": {}

     

       6
       6
       +
         }

     

       7
       7
       +
       }

test/data/wrong_type_title.json

···

       1
       1
       +
       {

     

       2
       2
       +
         "version": "https://jsonfeed.org/version/1.1",

     

       3
       3
       +
         "title": true,

     

       4
       4
       +
         "items": []

     

       5
       5
       +
       }

test/data/wrong_type_version.json

···

       1
       1
       +
       {

     

       2
       2
       +
         "version": 1.1,

     

       3
       3
       +
         "title": "Feed with numeric version",

     

       4
       4
       +
         "items": []

     

       5
       5
       +
       }

+10

test/dune

···

       6
       6
        
        (name test_serialization)

     

       7
       7
        
        (modules test_serialization)

     

       8
       8
        
        (libraries jsonfeed))

     

       9
       9
       +
       

     

       10
       10
       +
       (executable

     

       11
       11
       +
        (name test_location_errors)

     

       12
       12
       +
        (modules test_location_errors)

     

       13
       13
       +
        (libraries jsonfeed))

     

       14
       14
       +
       

     

       15
       15
       +
       (cram

     

       16
       16
       +
        (deps

     

       17
       17
       +
         test_location_errors.exe

     

       18
       18
       +
         (glob_files data/*.json)))

+401 -167

test/test_jsonfeed.ml

···

       14
       14
        
       let test_author_create_with_url () =

     

       15
       15
        
         let author = Author.create ~url:"https://example.com" () in

     

       16
       16
        
         Alcotest.(check (option string)) "name" None (Author.name author);

     

       17
       17
       -
         Alcotest.(check (option string)) "url" (Some "https://example.com") (Author.url author);

     

       17
       17
       +
         Alcotest.(check (option string))

     

       18
       18
       +
           "url" (Some "https://example.com") (Author.url author);

     

       18
       19
        
         Alcotest.(check bool) "is_valid" true (Author.is_valid author)

     

       19
       20
        
       

     

       20
       21
        
       let test_author_create_with_all_fields () =

     

       21
       21
       -
         let author = Author.create

     

       22
       22
       -
           ~name:"Jane Doe"

     

       23
       23
       -
           ~url:"https://example.com"

     

       24
       24
       -
           ~avatar:"https://example.com/avatar.png"

     

       25
       25
       -
           () in

     

       22
       22
       +
         let author =

     

       23
       23
       +
           Author.create ~name:"Jane Doe" ~url:"https://example.com"

     

       24
       24
       +
             ~avatar:"https://example.com/avatar.png" ()

     

       25
       25
       +
         in

     

       26
       26
        
         Alcotest.(check (option string)) "name" (Some "Jane Doe") (Author.name author);

     

       27
       27
       -
         Alcotest.(check (option string)) "url" (Some "https://example.com") (Author.url author);

     

       28
       28
       -
         Alcotest.(check (option string)) "avatar" (Some "https://example.com/avatar.png") (Author.avatar author);

     

       27
       27
       +
         Alcotest.(check (option string))

     

       28
       28
       +
           "url" (Some "https://example.com") (Author.url author);

     

       29
       29
       +
         Alcotest.(check (option string))

     

       30
       30
       +
           "avatar" (Some "https://example.com/avatar.png") (Author.avatar author);

     

       29
       31
        
         Alcotest.(check bool) "is_valid" true (Author.is_valid author)

     

       30
       32
        
       

     

       31
       33
        
       let test_author_create_no_fields_fails () =

     

       32
       34
        
         Alcotest.check_raises "no fields"

     

       33
       33
       -
           (Invalid_argument "Author.create: at least one field (name, url, or avatar) must be provided")

     

       34
       34
       -
           (fun () -> ignore (Author.create ()))

     

       35
       35
       +
           (Invalid_argument

     

       36
       36
       +
              "Author.create: at least one field (name, url, or avatar) must be \

     

       37
       37
       +
               provided") (fun () -> ignore (Author.create ()))

     

       35
       38
        
       

     

       36
       39
        
       let test_author_equal () =

     

       37
       40
        
         let a1 = Author.create ~name:"Jane Doe" () in

     
···

       43
       46
        
       let test_author_pp () =

     

       44
       47
        
         let author = Author.create ~name:"Jane Doe" ~url:"https://example.com" () in

     

       45
       48
        
         let s = Format.asprintf "%a" Author.pp author in

     

       46
       46
       -
         Alcotest.(check string) "pp with name and url" "Jane Doe <https://example.com>" s

     

       49
       49
       +
         Alcotest.(check string)

     

       50
       50
       +
           "pp with name and url" "Jane Doe <https://example.com>" s

     

       47
       51
        
       

     

       48
       48
       -
       let author_tests = [

     

       49
       49
       -
         "create with name", `Quick, test_author_create_with_name;

     

       50
       50
       -
         "create with url", `Quick, test_author_create_with_url;

     

       51
       51
       -
         "create with all fields", `Quick, test_author_create_with_all_fields;

     

       52
       52
       -
         "create with no fields fails", `Quick, test_author_create_no_fields_fails;

     

       53
       53
       -
         "equal", `Quick, test_author_equal;

     

       54
       54
       -
         "pp", `Quick, test_author_pp;

     

       55
       55
       -
       ]

     

       52
       52
       +
       let author_tests =

     

       53
       53
       +
         [

     

       54
       54
       +
           ("create with name", `Quick, test_author_create_with_name);

     

       55
       55
       +
           ("create with url", `Quick, test_author_create_with_url);

     

       56
       56
       +
           ("create with all fields", `Quick, test_author_create_with_all_fields);

     

       57
       57
       +
           ("create with no fields fails", `Quick, test_author_create_no_fields_fails);

     

       58
       58
       +
           ("equal", `Quick, test_author_equal);

     

       59
       59
       +
           ("pp", `Quick, test_author_pp);

     

       60
       60
       +
         ]

     

       56
       61
        
       

     

       57
       62
        
       (* Attachment tests *)

     

       58
       63
        
       

     

       59
       64
        
       let test_attachment_create_minimal () =

     

       60
       60
       -
         let att = Attachment.create

     

       61
       61
       -
           ~url:"https://example.com/file.mp3"

     

       62
       62
       -
           ~mime_type:"audio/mpeg"

     

       63
       63
       -
           () in

     

       64
       64
       -
         Alcotest.(check string) "url" "https://example.com/file.mp3" (Attachment.url att);

     

       65
       65
       +
         let att =

     

       66
       66
       +
           Attachment.create ~url:"https://example.com/file.mp3"

     

       67
       67
       +
             ~mime_type:"audio/mpeg" ()

     

       68
       68
       +
         in

     

       69
       69
       +
         Alcotest.(check string)

     

       70
       70
       +
           "url" "https://example.com/file.mp3" (Attachment.url att);

     

       65
       71
        
         Alcotest.(check string) "mime_type" "audio/mpeg" (Attachment.mime_type att);

     

       66
       72
        
         Alcotest.(check (option string)) "title" None (Attachment.title att);

     

       67
       67
       -
         Alcotest.(check (option int64)) "size_in_bytes" None (Attachment.size_in_bytes att);

     

       68
       68
       -
         Alcotest.(check (option int)) "duration_in_seconds" None (Attachment.duration_in_seconds att)

     

       73
       73
       +
         Alcotest.(check (option int64))

     

       74
       74
       +
           "size_in_bytes" None

     

       75
       75
       +
           (Attachment.size_in_bytes att);

     

       76
       76
       +
         Alcotest.(check (option int))

     

       77
       77
       +
           "duration_in_seconds" None

     

       78
       78
       +
           (Attachment.duration_in_seconds att)

     

       69
       79
        
       

     

       70
       80
        
       let test_attachment_create_complete () =

     

       71
       71
       -
         let att = Attachment.create

     

       72
       72
       -
           ~url:"https://example.com/episode.mp3"

     

       73
       73
       -
           ~mime_type:"audio/mpeg"

     

       74
       74
       -
           ~title:"Episode 1"

     

       75
       75
       -
           ~size_in_bytes:15_728_640L

     

       76
       76
       -
           ~duration_in_seconds:1800

     

       77
       77
       -
           () in

     

       78
       78
       -
         Alcotest.(check string) "url" "https://example.com/episode.mp3" (Attachment.url att);

     

       81
       81
       +
         let att =

     

       82
       82
       +
           Attachment.create ~url:"https://example.com/episode.mp3"

     

       83
       83
       +
             ~mime_type:"audio/mpeg" ~title:"Episode 1" ~size_in_bytes:15_728_640L

     

       84
       84
       +
             ~duration_in_seconds:1800 ()

     

       85
       85
       +
         in

     

       86
       86
       +
         Alcotest.(check string)

     

       87
       87
       +
           "url" "https://example.com/episode.mp3" (Attachment.url att);

     

       79
       88
        
         Alcotest.(check string) "mime_type" "audio/mpeg" (Attachment.mime_type att);

     

       80
       80
       -
         Alcotest.(check (option string)) "title" (Some "Episode 1") (Attachment.title att);

     

       81
       81
       -
         Alcotest.(check (option int64)) "size_in_bytes" (Some 15_728_640L) (Attachment.size_in_bytes att);

     

       82
       82
       -
         Alcotest.(check (option int)) "duration_in_seconds" (Some 1800) (Attachment.duration_in_seconds att)

     

       89
       89
       +
         Alcotest.(check (option string))

     

       90
       90
       +
           "title" (Some "Episode 1") (Attachment.title att);

     

       91
       91
       +
         Alcotest.(check (option int64))

     

       92
       92
       +
           "size_in_bytes" (Some 15_728_640L)

     

       93
       93
       +
           (Attachment.size_in_bytes att);

     

       94
       94
       +
         Alcotest.(check (option int))

     

       95
       95
       +
           "duration_in_seconds" (Some 1800)

     

       96
       96
       +
           (Attachment.duration_in_seconds att)

     

       83
       97
        
       

     

       84
       98
        
       let test_attachment_equal () =

     

       85
       85
       -
         let a1 = Attachment.create

     

       86
       86
       -
           ~url:"https://example.com/file.mp3"

     

       87
       87
       -
           ~mime_type:"audio/mpeg"

     

       88
       88
       -
           () in

     

       89
       89
       -
         let a2 = Attachment.create

     

       90
       90
       -
           ~url:"https://example.com/file.mp3"

     

       91
       91
       -
           ~mime_type:"audio/mpeg"

     

       92
       92
       -
           () in

     

       93
       93
       -
         let a3 = Attachment.create

     

       94
       94
       -
           ~url:"https://example.com/other.mp3"

     

       95
       95
       -
           ~mime_type:"audio/mpeg"

     

       96
       96
       -
           () in

     

       99
       99
       +
         let a1 =

     

       100
       100
       +
           Attachment.create ~url:"https://example.com/file.mp3"

     

       101
       101
       +
             ~mime_type:"audio/mpeg" ()

     

       102
       102
       +
         in

     

       103
       103
       +
         let a2 =

     

       104
       104
       +
           Attachment.create ~url:"https://example.com/file.mp3"

     

       105
       105
       +
             ~mime_type:"audio/mpeg" ()

     

       106
       106
       +
         in

     

       107
       107
       +
         let a3 =

     

       108
       108
       +
           Attachment.create ~url:"https://example.com/other.mp3"

     

       109
       109
       +
             ~mime_type:"audio/mpeg" ()

     

       110
       110
       +
         in

     

       97
       111
        
         Alcotest.(check bool) "equal same" true (Attachment.equal a1 a2);

     

       98
       112
        
         Alcotest.(check bool) "equal different" false (Attachment.equal a1 a3)

     

       99
       113
        
       

     

       100
       100
       -
       let attachment_tests = [

     

       101
       101
       -
         "create minimal", `Quick, test_attachment_create_minimal;

     

       102
       102
       -
         "create complete", `Quick, test_attachment_create_complete;

     

       103
       103
       -
         "equal", `Quick, test_attachment_equal;

     

       104
       104
       -
       ]

     

       114
       114
       +
       let attachment_tests =

     

       115
       115
       +
         [

     

       116
       116
       +
           ("create minimal", `Quick, test_attachment_create_minimal);

     

       117
       117
       +
           ("create complete", `Quick, test_attachment_create_complete);

     

       118
       118
       +
           ("equal", `Quick, test_attachment_equal);

     

       119
       119
       +
         ]

     

       105
       120
        
       

     

       106
       121
        
       (* Hub tests *)

     

       107
       122
        
       

     
···

       117
       132
        
         Alcotest.(check bool) "equal same" true (Hub.equal h1 h2);

     

       118
       133
        
         Alcotest.(check bool) "equal different" false (Hub.equal h1 h3)

     

       119
       134
        
       

     

       120
       120
       -
       let hub_tests = [

     

       121
       121
       -
         "create", `Quick, test_hub_create;

     

       122
       122
       -
         "equal", `Quick, test_hub_equal;

     

       123
       123
       -
       ]

     

       135
       135
       +
       let hub_tests =

     

       136
       136
       +
         [ ("create", `Quick, test_hub_create); ("equal", `Quick, test_hub_equal) ]

     

       124
       137
        
       

     

       125
       138
        
       (* Item tests *)

     

       126
       139
        
       

     

       127
       140
        
       let test_item_create_html () =

     

       128
       128
       -
         let item = Item.create

     

       129
       129
       -
           ~id:"https://example.com/1"

     

       130
       130
       -
           ~content:(`Html "<p>Hello</p>")

     

       131
       131
       -
           () in

     

       141
       141
       +
         let item =

     

       142
       142
       +
           Item.create ~id:"https://example.com/1" ~content:(`Html "<p>Hello</p>") ()

     

       143
       143
       +
         in

     

       132
       144
        
         Alcotest.(check string) "id" "https://example.com/1" (Item.id item);

     

       133
       133
       -
         Alcotest.(check (option string)) "content_html" (Some "<p>Hello</p>") (Item.content_html item);

     

       145
       145
       +
         Alcotest.(check (option string))

     

       146
       146
       +
           "content_html" (Some "<p>Hello</p>") (Item.content_html item);

     

       134
       147
        
         Alcotest.(check (option string)) "content_text" None (Item.content_text item)

     

       135
       148
        
       

     

       136
       149
        
       let test_item_create_text () =

     

       137
       137
       -
         let item = Item.create

     

       138
       138
       -
           ~id:"https://example.com/2"

     

       139
       139
       -
           ~content:(`Text "Hello world")

     

       140
       140
       -
           () in

     

       150
       150
       +
         let item =

     

       151
       151
       +
           Item.create ~id:"https://example.com/2" ~content:(`Text "Hello world") ()

     

       152
       152
       +
         in

     

       141
       153
        
         Alcotest.(check string) "id" "https://example.com/2" (Item.id item);

     

       142
       154
        
         Alcotest.(check (option string)) "content_html" None (Item.content_html item);

     

       143
       143
       -
         Alcotest.(check (option string)) "content_text" (Some "Hello world") (Item.content_text item)

     

       155
       155
       +
         Alcotest.(check (option string))

     

       156
       156
       +
           "content_text" (Some "Hello world") (Item.content_text item)

     

       144
       157
        
       

     

       145
       158
        
       let test_item_create_both () =

     

       146
       146
       -
         let item = Item.create

     

       147
       147
       -
           ~id:"https://example.com/3"

     

       148
       148
       -
           ~content:(`Both ("<p>Hello</p>", "Hello"))

     

       149
       149
       -
           () in

     

       159
       159
       +
         let item =

     

       160
       160
       +
           Item.create ~id:"https://example.com/3"

     

       161
       161
       +
             ~content:(`Both ("<p>Hello</p>", "Hello"))

     

       162
       162
       +
             ()

     

       163
       163
       +
         in

     

       150
       164
        
         Alcotest.(check string) "id" "https://example.com/3" (Item.id item);

     

       151
       151
       -
         Alcotest.(check (option string)) "content_html" (Some "<p>Hello</p>") (Item.content_html item);

     

       152
       152
       -
         Alcotest.(check (option string)) "content_text" (Some "Hello") (Item.content_text item)

     

       165
       165
       +
         Alcotest.(check (option string))

     

       166
       166
       +
           "content_html" (Some "<p>Hello</p>") (Item.content_html item);

     

       167
       167
       +
         Alcotest.(check (option string))

     

       168
       168
       +
           "content_text" (Some "Hello") (Item.content_text item)

     

       153
       169
        
       

     

       154
       170
        
       let test_item_with_metadata () =

     

       155
       155
       -
         let item = Item.create

     

       156
       156
       -
           ~id:"https://example.com/4"

     

       157
       157
       -
           ~content:(`Html "<p>Test</p>")

     

       158
       158
       -
           ~title:"Test Post"

     

       159
       159
       -
           ~url:"https://example.com/posts/4"

     

       160
       160
       -
           ~tags:["test"; "example"]

     

       161
       161
       -
           () in

     

       171
       171
       +
         let item =

     

       172
       172
       +
           Item.create ~id:"https://example.com/4" ~content:(`Html "<p>Test</p>")

     

       173
       173
       +
             ~title:"Test Post" ~url:"https://example.com/posts/4"

     

       174
       174
       +
             ~tags:[ "test"; "example" ] ()

     

       175
       175
       +
         in

     

       162
       176
        
         Alcotest.(check (option string)) "title" (Some "Test Post") (Item.title item);

     

       163
       163
       -
         Alcotest.(check (option string)) "url" (Some "https://example.com/posts/4") (Item.url item);

     

       164
       164
       -
         Alcotest.(check (option (list string))) "tags" (Some ["test"; "example"]) (Item.tags item)

     

       177
       177
       +
         Alcotest.(check (option string))

     

       178
       178
       +
           "url" (Some "https://example.com/posts/4") (Item.url item);

     

       179
       179
       +
         Alcotest.(check (option (list string)))

     

       180
       180
       +
           "tags"

     

       181
       181
       +
           (Some [ "test"; "example" ])

     

       182
       182
       +
           (Item.tags item)

     

       165
       183
        
       

     

       166
       184
        
       let test_item_equal () =

     

       167
       185
        
         let i1 = Item.create ~id:"https://example.com/1" ~content:(`Text "test") () in

     

       168
       168
       -
         let i2 = Item.create ~id:"https://example.com/1" ~content:(`Html "<p>test</p>") () in

     

       186
       186
       +
         let i2 =

     

       187
       187
       +
           Item.create ~id:"https://example.com/1" ~content:(`Html "<p>test</p>") ()

     

       188
       188
       +
         in

     

       169
       189
        
         let i3 = Item.create ~id:"https://example.com/2" ~content:(`Text "test") () in

     

       170
       190
        
         Alcotest.(check bool) "equal same id" true (Item.equal i1 i2);

     

       171
       191
        
         Alcotest.(check bool) "equal different id" false (Item.equal i1 i3)

     

       172
       192
        
       

     

       173
       173
       -
       let item_tests = [

     

       174
       174
       -
         "create with HTML content", `Quick, test_item_create_html;

     

       175
       175
       -
         "create with text content", `Quick, test_item_create_text;

     

       176
       176
       -
         "create with both contents", `Quick, test_item_create_both;

     

       177
       177
       -
         "create with metadata", `Quick, test_item_with_metadata;

     

       178
       178
       -
         "equal", `Quick, test_item_equal;

     

       179
       179
       -
       ]

     

       193
       193
       +
       let item_tests =

     

       194
       194
       +
         [

     

       195
       195
       +
           ("create with HTML content", `Quick, test_item_create_html);

     

       196
       196
       +
           ("create with text content", `Quick, test_item_create_text);

     

       197
       197
       +
           ("create with both contents", `Quick, test_item_create_both);

     

       198
       198
       +
           ("create with metadata", `Quick, test_item_with_metadata);

     

       199
       199
       +
           ("equal", `Quick, test_item_equal);

     

       200
       200
       +
         ]

     

       180
       201
        
       

     

       181
       202
        
       (* Jsonfeed tests *)

     

       182
       203
        
       

     

       183
       204
        
       let test_feed_create_minimal () =

     

       184
       205
        
         let feed = Jsonfeed.create ~title:"Test Feed" ~items:[] () in

     

       185
       206
        
         Alcotest.(check string) "title" "Test Feed" (Jsonfeed.title feed);

     

       186
       186
       -
         Alcotest.(check string) "version" "https://jsonfeed.org/version/1.1" (Jsonfeed.version feed);

     

       207
       207
       +
         Alcotest.(check string)

     

       208
       208
       +
           "version" "https://jsonfeed.org/version/1.1" (Jsonfeed.version feed);

     

       187
       209
        
         Alcotest.(check int) "items length" 0 (List.length (Jsonfeed.items feed))

     

       188
       210
        
       

     

       189
       211
        
       let test_feed_create_with_items () =

     

       190
       190
       -
         let item = Item.create

     

       191
       191
       -
           ~id:"https://example.com/1"

     

       192
       192
       -
           ~content:(`Text "Hello")

     

       193
       193
       -
           () in

     

       194
       194
       -
         let feed = Jsonfeed.create

     

       195
       195
       -
           ~title:"Test Feed"

     

       196
       196
       -
           ~items:[item]

     

       197
       197
       -
           () in

     

       212
       212
       +
         let item =

     

       213
       213
       +
           Item.create ~id:"https://example.com/1" ~content:(`Text "Hello") ()

     

       214
       214
       +
         in

     

       215
       215
       +
         let feed = Jsonfeed.create ~title:"Test Feed" ~items:[ item ] () in

     

       198
       216
        
         Alcotest.(check int) "items length" 1 (List.length (Jsonfeed.items feed))

     

       199
       217
        
       

     

       200
       218
        
       let test_feed_validate_valid () =

     
···

       202
       220
        
         match Jsonfeed.validate feed with

     

       203
       221
        
         | Ok () -> ()

     

       204
       222
        
         | Error errors ->

     

       205
       205
       -
             Alcotest.fail (Printf.sprintf "Validation should succeed: %s"

     

       206
       206
       -
               (String.concat "; " errors))

     

       223
       223
       +
             Alcotest.fail

     

       224
       224
       +
               (Printf.sprintf "Validation should succeed: %s"

     

       225
       225
       +
                  (String.concat "; " errors))

     

       207
       226
        
       

     

       208
       227
        
       let test_feed_validate_empty_title () =

     

       209
       228
        
         let feed = Jsonfeed.create ~title:"" ~items:[] () in

     

       210
       229
        
         match Jsonfeed.validate feed with

     

       211
       230
        
         | Ok () -> Alcotest.fail "Should fail validation"

     

       212
       231
        
         | Error errors ->

     

       213
       213
       -
             Alcotest.(check bool) "has error" true

     

       232
       232
       +
             Alcotest.(check bool)

     

       233
       233
       +
               "has error" true

     

       214
       234
        
               (List.exists (fun s -> String.starts_with ~prefix:"title" s) errors)

     

       215
       235
        
       

     

       216
       236
        
       let contains_substring s sub =

     
···

       221
       241
        
       

     

       222
       242
        
       let test_feed_to_string () =

     

       223
       243
        
         let feed = Jsonfeed.create ~title:"Test Feed" ~items:[] () in

     

       224
       224
       -
         let json = Jsonfeed.to_string feed in

     

       225
       225
       -
         Alcotest.(check bool) "contains version" true (contains_substring json "version");

     

       226
       226
       -
         Alcotest.(check bool) "contains title" true (contains_substring json "Test Feed")

     

       244
       244
       +
         match Jsonfeed.to_string feed with

     

       245
       245
       +
         | Ok json ->

     

       246
       246
       +
             Alcotest.(check bool)

     

       247
       247
       +
               "contains version" true

     

       248
       248
       +
               (contains_substring json "version");

     

       249
       249
       +
             Alcotest.(check bool)

     

       250
       250
       +
               "contains title" true

     

       251
       251
       +
               (contains_substring json "Test Feed")

     

       252
       252
       +
         | Error e ->

     

       253
       253
       +
             Alcotest.fail

     

       254
       254
       +
               (Printf.sprintf "Serialization failed: %s" (Jsont.Error.to_string e))

     

       227
       255
        
       

     

       228
       256
        
       let test_feed_parse_minimal () =

     

       229
       229
       -
         let json = {|{

     

       257
       257
       +
         let json =

     

       258
       258
       +
           {|{

     

       230
       259
        
           "version": "https://jsonfeed.org/version/1.1",

     

       231
       260
        
           "title": "Test Feed",

     

       232
       261
        
           "items": []

     

       233
       233
       -
         }|} in

     

       262
       262
       +
         }|}

     

       263
       263
       +
         in

     

       234
       264
        
         match Jsonfeed.of_string json with

     

       235
       265
        
         | Ok feed ->

     

       236
       266
        
             Alcotest.(check string) "title" "Test Feed" (Jsonfeed.title feed);

     

       237
       267
        
             Alcotest.(check int) "items" 0 (List.length (Jsonfeed.items feed))

     

       238
       238
       -
         | Error (`Msg err) ->

     

       239
       239
       -
             Alcotest.fail (Printf.sprintf "Parse failed: %s" err)

     

       268
       268
       +
         | Error err ->

     

       269
       269
       +
             Alcotest.fail

     

       270
       270
       +
               (Printf.sprintf "Parse failed: %s" (Jsont.Error.to_string err))

     

       240
       271
        
       

     

       241
       272
        
       let test_feed_parse_with_item () =

     

       242
       242
       -
         let json = {|{

     

       273
       273
       +
         let json =

     

       274
       274
       +
           {|{

     

       243
       275
        
           "version": "https://jsonfeed.org/version/1.1",

     

       244
       276
        
           "title": "Test Feed",

     

       245
       277
        
           "items": [

     
···

       248
       280
        
               "content_html": "<p>Hello</p>"

     

       249
       281
        
             }

     

       250
       282
        
           ]

     

       251
       251
       -
         }|} in

     

       283
       283
       +
         }|}

     

       284
       284
       +
         in

     

       252
       285
        
         match Jsonfeed.of_string json with

     

       253
       253
       -
         | Ok feed ->

     

       286
       286
       +
         | Ok feed -> (

     

       254
       287
        
             let items = Jsonfeed.items feed in

     

       255
       288
        
             Alcotest.(check int) "items count" 1 (List.length items);

     

       256
       256
       -
             (match items with

     

       257
       257
       -
              | [item] ->

     

       258
       258
       -
                  Alcotest.(check string) "item id" "https://example.com/1" (Item.id item);

     

       259
       259
       -
                  Alcotest.(check (option string)) "content_html" (Some "<p>Hello</p>") (Item.content_html item)

     

       260
       260
       -
              | _ -> Alcotest.fail "Expected 1 item")

     

       261
       261
       -
         | Error (`Msg err) ->

     

       262
       262
       -
             Alcotest.fail (Printf.sprintf "Parse failed: %s" err)

     

       289
       289
       +
             match items with

     

       290
       290
       +
             | [ item ] ->

     

       291
       291
       +
                 Alcotest.(check string)

     

       292
       292
       +
                   "item id" "https://example.com/1" (Item.id item);

     

       293
       293
       +
                 Alcotest.(check (option string))

     

       294
       294
       +
                   "content_html" (Some "<p>Hello</p>") (Item.content_html item)

     

       295
       295
       +
             | _ -> Alcotest.fail "Expected 1 item")

     

       296
       296
       +
         | Error err ->

     

       297
       297
       +
             Alcotest.fail

     

       298
       298
       +
               (Printf.sprintf "Parse failed: %s" (Jsont.Error.to_string err))

     

       263
       299
        
       

     

       264
       300
        
       let test_feed_roundtrip () =

     

       265
       301
        
         let author = Author.create ~name:"Test Author" () in

     

       266
       266
       -
         let item = Item.create

     

       267
       267
       -
           ~id:"https://example.com/1"

     

       268
       268
       -
           ~title:"Test Item"

     

       269
       269
       -
           ~content:(`Html "<p>Hello, world!</p>")

     

       270
       270
       -
           ~date_published:(Jsonfeed.parse_rfc3339 "2024-11-01T10:00:00Z" |> Option.get)

     

       271
       271
       -
           ~tags:["test"; "example"]

     

       272
       272
       -
           () in

     

       302
       302
       +
         let item =

     

       303
       303
       +
           Item.create ~id:"https://example.com/1" ~title:"Test Item"

     

       304
       304
       +
             ~content:(`Html "<p>Hello, world!</p>")

     

       305
       305
       +
             ~date_published:

     

       306
       306
       +
               (Jsonfeed.Rfc3339.parse "2024-11-01T10:00:00Z" |> Option.get)

     

       307
       307
       +
             ~tags:[ "test"; "example" ] ()

     

       308
       308
       +
         in

     

       273
       309
        
       

     

       274
       274
       -
         let feed1 = Jsonfeed.create

     

       275
       275
       -
           ~title:"Test Feed"

     

       276
       276
       -
           ~home_page_url:"https://example.com"

     

       277
       277
       -
           ~authors:[author]

     

       278
       278
       -
           ~items:[item]

     

       279
       279
       -
           () in

     

       310
       310
       +
         let feed1 =

     

       311
       311
       +
           Jsonfeed.create ~title:"Test Feed" ~home_page_url:"https://example.com"

     

       312
       312
       +
             ~authors:[ author ] ~items:[ item ] ()

     

       313
       313
       +
         in

     

       280
       314
        
       

     

       281
       315
        
         (* Serialize and parse *)

     

       282
       282
       -
         let json = Jsonfeed.to_string feed1 in

     

       283
       283
       -
         match Jsonfeed.of_string json with

     

       284
       284
       -
         | Ok feed2 ->

     

       285
       285
       -
             Alcotest.(check string) "title" (Jsonfeed.title feed1) (Jsonfeed.title feed2);

     

       286
       286
       -
             Alcotest.(check (option string)) "home_page_url"

     

       287
       287
       -
               (Jsonfeed.home_page_url feed1) (Jsonfeed.home_page_url feed2);

     

       288
       288
       -
             Alcotest.(check int) "items count"

     

       289
       289
       -
               (List.length (Jsonfeed.items feed1))

     

       290
       290
       -
               (List.length (Jsonfeed.items feed2))

     

       291
       291
       -
         | Error (`Msg err) ->

     

       292
       292
       -
             Alcotest.fail (Printf.sprintf "Round-trip failed: %s" err)

     

       316
       316
       +
         match Jsonfeed.to_string feed1 with

     

       317
       317
       +
         | Error e ->

     

       318
       318
       +
             Alcotest.fail

     

       319
       319
       +
               (Printf.sprintf "Serialization failed: %s" (Jsont.Error.to_string e))

     

       320
       320
       +
         | Ok json -> (

     

       321
       321
       +
             match Jsonfeed.of_string json with

     

       322
       322
       +
             | Ok feed2 ->

     

       323
       323
       +
                 Alcotest.(check string)

     

       324
       324
       +
                   "title" (Jsonfeed.title feed1) (Jsonfeed.title feed2);

     

       325
       325
       +
                 Alcotest.(check (option string))

     

       326
       326
       +
                   "home_page_url"

     

       327
       327
       +
                   (Jsonfeed.home_page_url feed1)

     

       328
       328
       +
                   (Jsonfeed.home_page_url feed2);

     

       329
       329
       +
                 Alcotest.(check int)

     

       330
       330
       +
                   "items count"

     

       331
       331
       +
                   (List.length (Jsonfeed.items feed1))

     

       332
       332
       +
                   (List.length (Jsonfeed.items feed2))

     

       333
       333
       +
             | Error err ->

     

       334
       334
       +
                 Alcotest.fail

     

       335
       335
       +
                   (Printf.sprintf "Round-trip parse failed: %s"

     

       336
       336
       +
                      (Jsont.Error.to_string err)))

     

       293
       337
        
       

     

       294
       338
        
       let test_feed_parse_invalid_missing_content () =

     

       295
       295
       -
         let json = {|{

     

       339
       339
       +
         let json =

     

       340
       340
       +
           {|{

     

       296
       341
        
           "version": "https://jsonfeed.org/version/1.1",

     

       297
       342
        
           "title": "Test",

     

       298
       343
        
           "items": [

     
···

       300
       345
        
               "id": "1"

     

       301
       346
        
             }

     

       302
       347
        
           ]

     

       303
       303
       -
         }|} in

     

       348
       348
       +
         }|}

     

       349
       349
       +
         in

     

       304
       350
        
         match Jsonfeed.of_string json with

     

       305
       351
        
         | Ok _ -> Alcotest.fail "Should reject item without content"

     

       306
       306
       -
         | Error (`Msg err) ->

     

       307
       307
       -
             Alcotest.(check bool) "has error" true

     

       308
       308
       -
               (contains_substring err "content")

     

       352
       352
       +
         | Error err ->

     

       353
       353
       +
             let err_str = Jsont.Error.to_string err in

     

       354
       354
       +
             Alcotest.(check bool)

     

       355
       355
       +
               "has error" true

     

       356
       356
       +
               (contains_substring err_str "content")

     

       309
       357
        
       

     

       310
       310
       -
       let jsonfeed_tests = [

     

       311
       311
       -
         "create minimal feed", `Quick, test_feed_create_minimal;

     

       312
       312
       -
         "create feed with items", `Quick, test_feed_create_with_items;

     

       313
       313
       -
         "validate valid feed", `Quick, test_feed_validate_valid;

     

       314
       314
       -
         "validate empty title", `Quick, test_feed_validate_empty_title;

     

       315
       315
       -
         "to_string", `Quick, test_feed_to_string;

     

       316
       316
       -
         "parse minimal feed", `Quick, test_feed_parse_minimal;

     

       317
       317
       -
         "parse feed with item", `Quick, test_feed_parse_with_item;

     

       318
       318
       -
         "round-trip", `Quick, test_feed_roundtrip;

     

       319
       319
       -
         "parse invalid missing content", `Quick, test_feed_parse_invalid_missing_content;

     

       320
       320
       -
       ]

     

       358
       358
       +
       let jsonfeed_tests =

     

       359
       359
       +
         [

     

       360
       360
       +
           ("create minimal feed", `Quick, test_feed_create_minimal);

     

       361
       361
       +
           ("create feed with items", `Quick, test_feed_create_with_items);

     

       362
       362
       +
           ("validate valid feed", `Quick, test_feed_validate_valid);

     

       363
       363
       +
           ("validate empty title", `Quick, test_feed_validate_empty_title);

     

       364
       364
       +
           ("to_string", `Quick, test_feed_to_string);

     

       365
       365
       +
           ("parse minimal feed", `Quick, test_feed_parse_minimal);

     

       366
       366
       +
           ("parse feed with item", `Quick, test_feed_parse_with_item);

     

       367
       367
       +
           ("round-trip", `Quick, test_feed_roundtrip);

     

       368
       368
       +
           ( "parse invalid missing content",

     

       369
       369
       +
             `Quick,

     

       370
       370
       +
             test_feed_parse_invalid_missing_content );

     

       371
       371
       +
         ]

     

       372
       372
       +
       

     

       373
       373
       +
       (* Unknown fields preservation tests *)

     

       374
       374
       +
       

     

       375
       375
       +
       let test_author_unknown_roundtrip () =

     

       376
       376
       +
         let json =

     

       377
       377
       +
           {|{

     

       378
       378
       +
           "name": "Test Author",

     

       379
       379
       +
           "custom_field": "custom value",

     

       380
       380
       +
           "another_extension": 42

     

       381
       381
       +
         }|}

     

       382
       382
       +
         in

     

       383
       383
       +
         match Jsont_bytesrw.decode_string' Author.jsont json with

     

       384
       384
       +
         | Error e ->

     

       385
       385
       +
             Alcotest.fail

     

       386
       386
       +
               (Printf.sprintf "Parse failed: %s" (Jsont.Error.to_string e))

     

       387
       387
       +
         | Ok author -> (

     

       388
       388
       +
             (* Check that unknown fields are preserved *)

     

       389
       389
       +
             let unknown = Author.unknown author in

     

       390
       390
       +
             Alcotest.(check bool)

     

       391
       391
       +
               "has unknown fields" false

     

       392
       392
       +
               (Jsonfeed.Unknown.is_empty unknown);

     

       393
       393
       +
             (* Encode and decode again *)

     

       394
       394
       +
             match Jsont_bytesrw.encode_string' Author.jsont author with

     

       395
       395
       +
             | Error e ->

     

       396
       396
       +
                 Alcotest.fail

     

       397
       397
       +
                   (Printf.sprintf "Encode failed: %s" (Jsont.Error.to_string e))

     

       398
       398
       +
             | Ok json2 -> (

     

       399
       399
       +
                 match Jsont_bytesrw.decode_string' Author.jsont json2 with

     

       400
       400
       +
                 | Error e ->

     

       401
       401
       +
                     Alcotest.fail

     

       402
       402
       +
                       (Printf.sprintf "Re-parse failed: %s" (Jsont.Error.to_string e))

     

       403
       403
       +
                 | Ok author2 ->

     

       404
       404
       +
                     (* Verify unknown fields survive roundtrip *)

     

       405
       405
       +
                     let unknown2 = Author.unknown author2 in

     

       406
       406
       +
                     Alcotest.(check bool)

     

       407
       407
       +
                       "unknown fields preserved" false

     

       408
       408
       +
                       (Jsonfeed.Unknown.is_empty unknown2)))

     

       409
       409
       +
       

     

       410
       410
       +
       let test_item_unknown_roundtrip () =

     

       411
       411
       +
         let json =

     

       412
       412
       +
           {|{

     

       413
       413
       +
           "id": "https://example.com/1",

     

       414
       414
       +
           "content_html": "<p>Test</p>",

     

       415
       415
       +
           "custom_metadata": "some custom data",

     

       416
       416
       +
           "x_custom_number": 123.45

     

       417
       417
       +
         }|}

     

       418
       418
       +
         in

     

       419
       419
       +
         match Jsont_bytesrw.decode_string' Item.jsont json with

     

       420
       420
       +
         | Error e ->

     

       421
       421
       +
             Alcotest.fail

     

       422
       422
       +
               (Printf.sprintf "Parse failed: %s" (Jsont.Error.to_string e))

     

       423
       423
       +
         | Ok item -> (

     

       424
       424
       +
             (* Check that unknown fields are preserved *)

     

       425
       425
       +
             let unknown = Item.unknown item in

     

       426
       426
       +
             Alcotest.(check bool)

     

       427
       427
       +
               "has unknown fields" false

     

       428
       428
       +
               (Jsonfeed.Unknown.is_empty unknown);

     

       429
       429
       +
             (* Encode and decode again *)

     

       430
       430
       +
             match Jsont_bytesrw.encode_string' Item.jsont item with

     

       431
       431
       +
             | Error e ->

     

       432
       432
       +
                 Alcotest.fail

     

       433
       433
       +
                   (Printf.sprintf "Encode failed: %s" (Jsont.Error.to_string e))

     

       434
       434
       +
             | Ok json2 -> (

     

       435
       435
       +
                 match Jsont_bytesrw.decode_string' Item.jsont json2 with

     

       436
       436
       +
                 | Error e ->

     

       437
       437
       +
                     Alcotest.fail

     

       438
       438
       +
                       (Printf.sprintf "Re-parse failed: %s" (Jsont.Error.to_string e))

     

       439
       439
       +
                 | Ok item2 ->

     

       440
       440
       +
                     let unknown2 = Item.unknown item2 in

     

       441
       441
       +
                     Alcotest.(check bool)

     

       442
       442
       +
                       "unknown fields preserved" false

     

       443
       443
       +
                       (Jsonfeed.Unknown.is_empty unknown2)))

     

       444
       444
       +
       

     

       445
       445
       +
       let test_feed_unknown_roundtrip () =

     

       446
       446
       +
         let json =

     

       447
       447
       +
           {|{

     

       448
       448
       +
           "version": "https://jsonfeed.org/version/1.1",

     

       449
       449
       +
           "title": "Test Feed",

     

       450
       450
       +
           "items": [],

     

       451
       451
       +
           "custom_extension": "custom value",

     

       452
       452
       +
           "x_another_field": {"nested": "data"}

     

       453
       453
       +
         }|}

     

       454
       454
       +
         in

     

       455
       455
       +
         match Jsonfeed.of_string json with

     

       456
       456
       +
         | Error e ->

     

       457
       457
       +
             Alcotest.fail

     

       458
       458
       +
               (Printf.sprintf "Parse failed: %s" (Jsont.Error.to_string e))

     

       459
       459
       +
         | Ok feed -> (

     

       460
       460
       +
             (* Check that unknown fields are preserved *)

     

       461
       461
       +
             let unknown = Jsonfeed.unknown feed in

     

       462
       462
       +
             Alcotest.(check bool)

     

       463
       463
       +
               "has unknown fields" false

     

       464
       464
       +
               (Jsonfeed.Unknown.is_empty unknown);

     

       465
       465
       +
             (* Encode and decode again *)

     

       466
       466
       +
             match Jsonfeed.to_string feed with

     

       467
       467
       +
             | Error e ->

     

       468
       468
       +
                 Alcotest.fail

     

       469
       469
       +
                   (Printf.sprintf "Encode failed: %s" (Jsont.Error.to_string e))

     

       470
       470
       +
             | Ok json2 -> (

     

       471
       471
       +
                 match Jsonfeed.of_string json2 with

     

       472
       472
       +
                 | Error e ->

     

       473
       473
       +
                     Alcotest.fail

     

       474
       474
       +
                       (Printf.sprintf "Re-parse failed: %s" (Jsont.Error.to_string e))

     

       475
       475
       +
                 | Ok feed2 ->

     

       476
       476
       +
                     let unknown2 = Jsonfeed.unknown feed2 in

     

       477
       477
       +
                     Alcotest.(check bool)

     

       478
       478
       +
                       "unknown fields preserved" false

     

       479
       479
       +
                       (Jsonfeed.Unknown.is_empty unknown2)))

     

       480
       480
       +
       

     

       481
       481
       +
       let test_hub_unknown_roundtrip () =

     

       482
       482
       +
         let json =

     

       483
       483
       +
           {|{

     

       484
       484
       +
           "type": "WebSub",

     

       485
       485
       +
           "url": "https://example.com/hub",

     

       486
       486
       +
           "custom_field": "test"

     

       487
       487
       +
         }|}

     

       488
       488
       +
         in

     

       489
       489
       +
         match Jsont_bytesrw.decode_string' Hub.jsont json with

     

       490
       490
       +
         | Error e ->

     

       491
       491
       +
             Alcotest.fail

     

       492
       492
       +
               (Printf.sprintf "Parse failed: %s" (Jsont.Error.to_string e))

     

       493
       493
       +
         | Ok hub -> (

     

       494
       494
       +
             let unknown = Hub.unknown hub in

     

       495
       495
       +
             Alcotest.(check bool)

     

       496
       496
       +
               "has unknown fields" false

     

       497
       497
       +
               (Jsonfeed.Unknown.is_empty unknown);

     

       498
       498
       +
             match Jsont_bytesrw.encode_string' Hub.jsont hub with

     

       499
       499
       +
             | Error e ->

     

       500
       500
       +
                 Alcotest.fail

     

       501
       501
       +
                   (Printf.sprintf "Encode failed: %s" (Jsont.Error.to_string e))

     

       502
       502
       +
             | Ok json2 -> (

     

       503
       503
       +
                 match Jsont_bytesrw.decode_string' Hub.jsont json2 with

     

       504
       504
       +
                 | Error e ->

     

       505
       505
       +
                     Alcotest.fail

     

       506
       506
       +
                       (Printf.sprintf "Re-parse failed: %s" (Jsont.Error.to_string e))

     

       507
       507
       +
                 | Ok hub2 ->

     

       508
       508
       +
                     let unknown2 = Hub.unknown hub2 in

     

       509
       509
       +
                     Alcotest.(check bool)

     

       510
       510
       +
                       "unknown fields preserved" false

     

       511
       511
       +
                       (Jsonfeed.Unknown.is_empty unknown2)))

     

       512
       512
       +
       

     

       513
       513
       +
       let test_attachment_unknown_roundtrip () =

     

       514
       514
       +
         let json =

     

       515
       515
       +
           {|{

     

       516
       516
       +
           "url": "https://example.com/file.mp3",

     

       517
       517
       +
           "mime_type": "audio/mpeg",

     

       518
       518
       +
           "x_custom": "value"

     

       519
       519
       +
         }|}

     

       520
       520
       +
         in

     

       521
       521
       +
         match Jsont_bytesrw.decode_string' Attachment.jsont json with

     

       522
       522
       +
         | Error e ->

     

       523
       523
       +
             Alcotest.fail

     

       524
       524
       +
               (Printf.sprintf "Parse failed: %s" (Jsont.Error.to_string e))

     

       525
       525
       +
         | Ok att -> (

     

       526
       526
       +
             let unknown = Attachment.unknown att in

     

       527
       527
       +
             Alcotest.(check bool)

     

       528
       528
       +
               "has unknown fields" false

     

       529
       529
       +
               (Jsonfeed.Unknown.is_empty unknown);

     

       530
       530
       +
             match Jsont_bytesrw.encode_string' Attachment.jsont att with

     

       531
       531
       +
             | Error e ->

     

       532
       532
       +
                 Alcotest.fail

     

       533
       533
       +
                   (Printf.sprintf "Encode failed: %s" (Jsont.Error.to_string e))

     

       534
       534
       +
             | Ok json2 -> (

     

       535
       535
       +
                 match Jsont_bytesrw.decode_string' Attachment.jsont json2 with

     

       536
       536
       +
                 | Error e ->

     

       537
       537
       +
                     Alcotest.fail

     

       538
       538
       +
                       (Printf.sprintf "Re-parse failed: %s" (Jsont.Error.to_string e))

     

       539
       539
       +
                 | Ok att2 ->

     

       540
       540
       +
                     let unknown2 = Attachment.unknown att2 in

     

       541
       541
       +
                     Alcotest.(check bool)

     

       542
       542
       +
                       "unknown fields preserved" false

     

       543
       543
       +
                       (Jsonfeed.Unknown.is_empty unknown2)))

     

       544
       544
       +
       

     

       545
       545
       +
       let unknown_fields_tests =

     

       546
       546
       +
         [

     

       547
       547
       +
           ("author unknown roundtrip", `Quick, test_author_unknown_roundtrip);

     

       548
       548
       +
           ("item unknown roundtrip", `Quick, test_item_unknown_roundtrip);

     

       549
       549
       +
           ("feed unknown roundtrip", `Quick, test_feed_unknown_roundtrip);

     

       550
       550
       +
           ("hub unknown roundtrip", `Quick, test_hub_unknown_roundtrip);

     

       551
       551
       +
           ("attachment unknown roundtrip", `Quick, test_attachment_unknown_roundtrip);

     

       552
       552
       +
         ]

     

       321
       553
        
       

     

       322
       554
        
       (* Main test suite *)

     

       323
       555
        
       

     

       324
       556
        
       let () =

     

       325
       325
       -
         Alcotest.run "jsonfeed" [

     

       326
       326
       -
           "Author", author_tests;

     

       327
       327
       -
           "Attachment", attachment_tests;

     

       328
       328
       -
           "Hub", hub_tests;

     

       329
       329
       -
           "Item", item_tests;

     

       330
       330
       -
           "Jsonfeed", jsonfeed_tests;

     

       331
       331
       -
         ]

     

       557
       557
       +
         Alcotest.run "jsonfeed"

     

       558
       558
       +
           [

     

       559
       559
       +
             ("Author", author_tests);

     

       560
       560
       +
             ("Attachment", attachment_tests);

     

       561
       561
       +
             ("Hub", hub_tests);

     

       562
       562
       +
             ("Item", item_tests);

     

       563
       563
       +
             ("Jsonfeed", jsonfeed_tests);

     

       564
       564
       +
             ("Unknown Fields", unknown_fields_tests);

     

       565
       565
       +
           ]

+111

test/test_location_errors.ml

···

       1
       1
       +
       (** Test executable for verifying jsont location tracking

     

       2
       2
       +
       

     

       3
       3
       +
           Usage: test_location_errors <file> [field]

     

       4
       4
       +
       

     

       5
       5
       +
           Parses JSON feed files and outputs JSON with either:

     

       6
       6
       +
           - Success: {"status":"ok", "field":"<field>", "value":"<value>"}

     

       7
       7
       +
           - Error: {"status":"error", "message":"...", "location":{...}, "context":"..."}

     

       8
       8
       +
       *)

     

       9
       9
       +
       

     

       10
       10
       +
       open Jsonfeed

     

       11
       11
       +
       

     

       12
       12
       +
       (* Helper to format path context *)

     

       13
       13
       +
       let format_context (ctx : Jsont.Error.Context.t) =

     

       14
       14
       +
         if Jsont.Error.Context.is_empty ctx then "$"

     

       15
       15
       +
         else

     

       16
       16
       +
           let indices = ctx in

     

       17
       17
       +
           let rec format_path acc = function

     

       18
       18
       +
             | [] -> if acc = "" then "$" else "$" ^ acc

     

       19
       19
       +
             | ((_kinded_sort, _meta), idx) :: rest ->

     

       20
       20
       +
                 let segment =

     

       21
       21
       +
                   match idx with

     

       22
       22
       +
                   | Jsont.Path.Mem (name, _meta) -> "." ^ name

     

       23
       23
       +
                   | Jsont.Path.Nth (n, _meta) -> "[" ^ string_of_int n ^ "]"

     

       24
       24
       +
                 in

     

       25
       25
       +
                 format_path (acc ^ segment) rest

     

       26
       26
       +
           in

     

       27
       27
       +
           format_path "" indices

     

       28
       28
       +
       

     

       29
       29
       +
       (* Extract field from successfully parsed feed *)

     

       30
       30
       +
       let extract_field field feed =

     

       31
       31
       +
         match field with

     

       32
       32
       +
         | "title" -> Jsonfeed.title feed

     

       33
       33
       +
         | "version" -> Jsonfeed.version feed

     

       34
       34
       +
         | "item_count" -> string_of_int (List.length (Jsonfeed.items feed))

     

       35
       35
       +
         | "first_item_id" -> (

     

       36
       36
       +
             match Jsonfeed.items feed with

     

       37
       37
       +
             | [] -> "(no items)"

     

       38
       38
       +
             | item :: _ -> Item.id item)

     

       39
       39
       +
         | _ -> "(unknown field)"

     

       40
       40
       +
       

     

       41
       41
       +
       (* Escape JSON strings *)

     

       42
       42
       +
       let escape_json_string s =

     

       43
       43
       +
         let buf = Buffer.create (String.length s) in

     

       44
       44
       +
         String.iter

     

       45
       45
       +
           (function

     

       46
       46
       +
             | '"' -> Buffer.add_string buf "\\\""

     

       47
       47
       +
             | '\\' -> Buffer.add_string buf "\\\\"

     

       48
       48
       +
             | '\n' -> Buffer.add_string buf "\\n"

     

       49
       49
       +
             | '\r' -> Buffer.add_string buf "\\r"

     

       50
       50
       +
             | '\t' -> Buffer.add_string buf "\\t"

     

       51
       51
       +
             | c when c < ' ' -> Printf.bprintf buf "\\u%04x" (Char.code c)

     

       52
       52
       +
             | c -> Buffer.add_char buf c)

     

       53
       53
       +
           s;

     

       54
       54
       +
         Buffer.contents buf

     

       55
       55
       +
       

     

       56
       56
       +
       (* Output success as JSON *)

     

       57
       57
       +
       let output_success field value =

     

       58
       58
       +
         Printf.printf {|{"status":"ok","field":"%s","value":"%s"}|}

     

       59
       59
       +
           (escape_json_string field) (escape_json_string value);

     

       60
       60
       +
         print_newline ()

     

       61
       61
       +
       

     

       62
       62
       +
       (* Output error as JSON *)

     

       63
       63
       +
       let output_error (ctx, meta, kind) =

     

       64
       64
       +
         let message = Jsont.Error.kind_to_string kind in

     

       65
       65
       +
         let textloc = Jsont.Meta.textloc meta in

     

       66
       66
       +
         let file = Jsont.Textloc.file textloc in

     

       67
       67
       +
         let first_byte = Jsont.Textloc.first_byte textloc in

     

       68
       68
       +
         let last_byte = Jsont.Textloc.last_byte textloc in

     

       69
       69
       +
         let line_num, line_start_byte = Jsont.Textloc.first_line textloc in

     

       70
       70
       +
         let column = first_byte - line_start_byte + 1 in

     

       71
       71
       +
         let context = format_context ctx in

     

       72
       72
       +
       

     

       73
       73
       +
         Printf.printf

     

       74
       74
       +
           {|{"status":"error","message":"%s","location":{"file":"%s","line":%d,"column":%d,"byte_start":%d,"byte_end":%d},"context":"%s"}|}

     

       75
       75
       +
           (escape_json_string message)

     

       76
       76
       +
           (escape_json_string file) line_num column first_byte last_byte

     

       77
       77
       +
           (escape_json_string context);

     

       78
       78
       +
         print_newline ()

     

       79
       79
       +
       

     

       80
       80
       +
       let main () =

     

       81
       81
       +
         (* Disable ANSI styling in error messages for consistent output *)

     

       82
       82
       +
         Jsont.Error.disable_ansi_styler ();

     

       83
       83
       +
       

     

       84
       84
       +
         if Array.length Sys.argv < 2 then (

     

       85
       85
       +
           Printf.eprintf "Usage: %s <file> [field]\n" Sys.argv.(0);

     

       86
       86
       +
           Printf.eprintf "Fields: title, version, item_count, first_item_id\n";

     

       87
       87
       +
           exit 1);

     

       88
       88
       +
       

     

       89
       89
       +
         let file = Sys.argv.(1) in

     

       90
       90
       +
         let field = if Array.length Sys.argv > 2 then Sys.argv.(2) else "title" in

     

       91
       91
       +
       

     

       92
       92
       +
         (* Read file *)

     

       93
       93
       +
         let content =

     

       94
       94
       +
           try In_channel.with_open_text file In_channel.input_all

     

       95
       95
       +
           with Sys_error msg ->

     

       96
       96
       +
             Printf.printf {|{"status":"error","message":"File error: %s"}|}

     

       97
       97
       +
               (escape_json_string msg);

     

       98
       98
       +
             print_newline ();

     

       99
       99
       +
             exit 1

     

       100
       100
       +
         in

     

       101
       101
       +
       

     

       102
       102
       +
         (* Parse with location tracking *)

     

       103
       103
       +
         match Jsonfeed.decode_string ~locs:true ~file content with

     

       104
       104
       +
         | Ok feed ->

     

       105
       105
       +
             let value = extract_field field feed in

     

       106
       106
       +
             output_success field value

     

       107
       107
       +
         | Error err ->

     

       108
       108
       +
             output_error err;

     

       109
       109
       +
             exit 1

     

       110
       110
       +
       

     

       111
       111
       +
       let () = main ()

+127

test/test_locations.t

···

       1
       1
       +
       Location tracking tests for JSON Feed parser

     

       2
       2
       +
       ===========================================

     

       3
       3
       +
       

     

       4
       4
       +
       This test suite verifies that jsont combinators correctly track location

     

       5
       5
       +
       information for both valid and invalid JSON feeds.

     

       6
       6
       +
       

     

       7
       7
       +
       Valid Feeds

     

       8
       8
       +
       -----------

     

       9
       9
       +
       

     

       10
       10
       +
       Test minimal valid feed:

     

       11
       11
       +
         $ ./test_location_errors.exe data/minimal_valid.json title

     

       12
       12
       +
         {"status":"ok","field":"title","value":"Minimal Feed"}

     

       13
       13
       +
       

     

       14
       14
       +
         $ ./test_location_errors.exe data/minimal_valid.json version

     

       15
       15
       +
         {"status":"ok","field":"version","value":"https://jsonfeed.org/version/1.1"}

     

       16
       16
       +
       

     

       17
       17
       +
         $ ./test_location_errors.exe data/minimal_valid.json item_count

     

       18
       18
       +
         {"status":"ok","field":"item_count","value":"0"}

     

       19
       19
       +
       

     

       20
       20
       +
       Test complete feed with all fields:

     

       21
       21
       +
         $ ./test_location_errors.exe data/complete_valid.json title

     

       22
       22
       +
         {"status":"ok","field":"title","value":"Complete Feed"}

     

       23
       23
       +
       

     

       24
       24
       +
         $ ./test_location_errors.exe data/complete_valid.json item_count

     

       25
       25
       +
         {"status":"ok","field":"item_count","value":"1"}

     

       26
       26
       +
       

     

       27
       27
       +
         $ ./test_location_errors.exe data/complete_valid.json first_item_id

     

       28
       28
       +
         {"status":"ok","field":"first_item_id","value":"https://example.com/item1"}

     

       29
       29
       +
       

     

       30
       30
       +
       Test mixed content types:

     

       31
       31
       +
         $ ./test_location_errors.exe data/mixed_content.json item_count

     

       32
       32
       +
         {"status":"ok","field":"item_count","value":"3"}

     

       33
       33
       +
       

     

       34
       34
       +
       Test feed with extensions:

     

       35
       35
       +
         $ ./test_location_errors.exe data/with_extensions.json title

     

       36
       36
       +
         {"status":"ok","field":"title","value":"Feed with Extensions"}

     

       37
       37
       +
       

     

       38
       38
       +
       

     

       39
       39
       +
       Missing Required Fields

     

       40
       40
       +
       ------------------------

     

       41
       41
       +
       

     

       42
       42
       +
       Test missing title field:

     

       43
       43
       +
         $ ./test_location_errors.exe data/missing_title.json title

     

       44
       44
       +
         {"status":"error","message":"Missing member title in JSON Feed object","location":{"file":"data/missing_title.json","line":1,"column":1,"byte_start":0,"byte_end":65},"context":"$"}

     

       45
       45
       +
         [1]

     

       46
       46
       +
       

     

       47
       47
       +
       Test missing version field:

     

       48
       48
       +
         $ ./test_location_errors.exe data/missing_version.json title

     

       49
       49
       +
         {"status":"error","message":"Missing member version in JSON Feed object","location":{"file":"data/missing_version.json","line":1,"column":1,"byte_start":0,"byte_end":51},"context":"$"}

     

       50
       50
       +
         [1]

     

       51
       51
       +
       

     

       52
       52
       +
       Test missing items field:

     

       53
       53
       +
         $ ./test_location_errors.exe data/missing_items.json title

     

       54
       54
       +
         {"status":"error","message":"Missing member items in JSON Feed object","location":{"file":"data/missing_items.json","line":1,"column":1,"byte_start":0,"byte_end":83},"context":"$"}

     

       55
       55
       +
         [1]

     

       56
       56
       +
       

     

       57
       57
       +
       Test missing item id:

     

       58
       58
       +
         $ ./test_location_errors.exe data/missing_item_id.json first_item_id

     

       59
       59
       +
         {"status":"error","message":"Missing member id in Item object","location":{"file":"data/missing_item_id.json","line":5,"column":5,"byte_start":108,"byte_end":161},"context":"$.items[0]"}

     

       60
       60
       +
         [1]

     

       61
       61
       +
       

     

       62
       62
       +
       Test missing item content:

     

       63
       63
       +
         $ ./test_location_errors.exe data/missing_item_content.json first_item_id

     

       64
       64
       +
         {"status":"error","message":"Item must have at least one of content_html or content_text","location":{"file":"-","line":-1,"column":1,"byte_start":-1,"byte_end":-1},"context":"$.items[0]"}

     

       65
       65
       +
         [1]

     

       66
       66
       +
       

     

       67
       67
       +
       

     

       68
       68
       +
       Type Errors

     

       69
       69
       +
       -----------

     

       70
       70
       +
       

     

       71
       71
       +
       Test wrong type for version (number instead of string):

     

       72
       72
       +
         $ ./test_location_errors.exe data/wrong_type_version.json title

     

       73
       73
       +
         {"status":"error","message":"Expected string but found number","location":{"file":"data/wrong_type_version.json","line":2,"column":14,"byte_start":15,"byte_end":15},"context":"$.version"}

     

       74
       74
       +
         [1]

     

       75
       75
       +
       

     

       76
       76
       +
       Test wrong type for items (object instead of array):

     

       77
       77
       +
         $ ./test_location_errors.exe data/wrong_type_items.json item_count

     

       78
       78
       +
         {"status":"error","message":"Expected array<Item object> but found object","location":{"file":"data/wrong_type_items.json","line":4,"column":12,"byte_start":102,"byte_end":102},"context":"$.items"}

     

       79
       79
       +
         [1]

     

       80
       80
       +
       

     

       81
       81
       +
       Test wrong type for title (boolean instead of string):

     

       82
       82
       +
         $ ./test_location_errors.exe data/wrong_type_title.json title

     

       83
       83
       +
         {"status":"error","message":"Expected string but found bool","location":{"file":"data/wrong_type_title.json","line":3,"column":12,"byte_start":62,"byte_end":62},"context":"$.title"}

     

       84
       84
       +
         [1]

     

       85
       85
       +
       

     

       86
       86
       +
       Test wrong type for expired (string instead of boolean):

     

       87
       87
       +
         $ ./test_location_errors.exe data/wrong_type_expired.json title

     

       88
       88
       +
         {"status":"error","message":"Expected bool but found string","location":{"file":"data/wrong_type_expired.json","line":4,"column":14,"byte_start":111,"byte_end":111},"context":"$.expired"}

     

       89
       89
       +
         [1]

     

       90
       90
       +
       

     

       91
       91
       +
       

     

       92
       92
       +
       Nested Errors

     

       93
       93
       +
       -------------

     

       94
       94
       +
       

     

       95
       95
       +
       Test invalid date format in item:

     

       96
       96
       +
         $ ./test_location_errors.exe data/invalid_date_format.json first_item_id

     

       97
       97
       +
         {"status":"error","message":"RFC 3339 timestamp: invalid RFC 3339 timestamp: \"not-a-valid-date\"","location":{"file":"-","line":-1,"column":1,"byte_start":-1,"byte_end":-1},"context":"$.items[0].date_published"}

     

       98
       98
       +
         [1]

     

       99
       99
       +
       

     

       100
       100
       +
       Test invalid author type (string instead of object):

     

       101
       101
       +
         $ ./test_location_errors.exe data/invalid_author_type.json title

     

       102
       102
       +
         {"status":"error","message":"Expected Author object but found string","location":{"file":"data/invalid_author_type.json","line":5,"column":5,"byte_start":109,"byte_end":109},"context":"$.authors[0]"}

     

       103
       103
       +
         [1]

     

       104
       104
       +
       

     

       105
       105
       +
       Test invalid attachment field type (deeply nested):

     

       106
       106
       +
         $ ./test_location_errors.exe data/invalid_nested_attachment.json first_item_id

     

       107
       107
       +
         {"status":"error","message":"Expected string but found number","location":{"file":"data/invalid_nested_attachment.json","line":11,"column":24,"byte_start":296,"byte_end":296},"context":"$.items[0].attachments[0].mime_type"}

     

       108
       108
       +
         [1]

     

       109
       109
       +
       

     

       110
       110
       +
       Test missing required field in hub:

     

       111
       111
       +
         $ ./test_location_errors.exe data/invalid_hub_type.json title

     

       112
       112
       +
         {"status":"error","message":"Missing member url in Hub object","location":{"file":"data/invalid_hub_type.json","line":5,"column":5,"byte_start":103,"byte_end":132},"context":"$.hubs[0]"}

     

       113
       113
       +
         [1]

     

       114
       114
       +
       

     

       115
       115
       +
       

     

       116
       116
       +
       JSON Syntax Errors

     

       117
       117
       +
       ------------------

     

       118
       118
       +
       

     

       119
       119
       +
       Test trailing comma:

     

       120
       120
       +
         $ ./test_location_errors.exe data/extra_comma.json title

     

       121
       121
       +
         {"status":"error","message":"Expected object member but found }","location":{"file":"data/extra_comma.json","line":5,"column":1,"byte_start":105,"byte_end":105},"context":"$"}

     

       122
       122
       +
         [1]

     

       123
       123
       +
       

     

       124
       124
       +
       Test malformed JSON (missing comma):

     

       125
       125
       +
         $ ./test_location_errors.exe data/malformed_json.json title

     

       126
       126
       +
         {"status":"error","message":"Expected , or } after object member but found: \"","location":{"file":"data/malformed_json.json","line":3,"column":3,"byte_start":52,"byte_end":52},"context":"$"}

     

       127
       127
       +
         [1]

+13 -12

test/test_serialization.ml

···

       5
       5
        
       let () =

     

       6
       6
        
         (* Create a simple feed *)

     

       7
       7
        
         let author = Author.create ~name:"Test Author" () in

     

       8
       8
       -
         let item = Item.create

     

       9
       9
       -
           ~id:"https://example.com/1"

     

       10
       10
       -
           ~title:"Test Item"

     

       11
       11
       -
           ~content:(`Html "<p>Hello, world!</p>")

     

       12
       12
       -
           () in

     

       8
       8
       +
         let item =

     

       9
       9
       +
           Item.create ~id:"https://example.com/1" ~title:"Test Item"

     

       10
       10
       +
             ~content:(`Html "<p>Hello, world!</p>") ()

     

       11
       11
       +
         in

     

       13
       12
        
       

     

       14
       14
       -
         let feed = Jsonfeed.create

     

       15
       15
       -
           ~title:"Test Feed"

     

       16
       16
       -
           ~home_page_url:"https://example.com"

     

       17
       17
       -
           ~authors:[author]

     

       18
       18
       -
           ~items:[item]

     

       19
       19
       -
           () in

     

       13
       13
       +
         let feed =

     

       14
       14
       +
           Jsonfeed.create ~title:"Test Feed" ~home_page_url:"https://example.com"

     

       15
       15
       +
             ~authors:[ author ] ~items:[ item ] ()

     

       16
       16
       +
         in

     

       20
       17
        
       

     

       21
       18
        
         (* Serialize to JSON *)

     

       22
       22
       -
         let json = Jsonfeed.to_string feed in

     

       19
       19
       +
         let json =

     

       20
       20
       +
           match Jsonfeed.to_string feed with

     

       21
       21
       +
           | Ok s -> s

     

       22
       22
       +
           | Error e -> failwith (Jsont.Error.to_string e)

     

       23
       23
       +
         in

     

       23
       24
        
       

     

       24
       25
        
         (* Print it *)

     

       25
       26
        
         Printf.printf "Generated JSON Feed:\n%s\n\n" json;

Compare changes