Add for_to_data combinators for archetypes

Author: xvw

CHANGES.md

@@ -11,7 +11,10 @@
 - Add `Yocaml.Data.into` and `Yocaml.Data.Validation.from` helpers for easier module use (by [Linda-Njau](https://github.com/Linda-Njau))
 - Add `Yocaml.Metadata.Injectable` and `Yocaml.Metadata.Readable` functors to simplify creation of injectable and readable modules (by [Linda-Njau](https://github.com/Linda-Njau))
 - Add `Yocaml.Data.Validation.String`, a set of validator for `String` (by [Okhuomon Ajayi](https://github.com/six-shot))
-- Adds missing test coverage for `Nel.equal` and `Nel.append` functions (by [Bill Njoroge](https://github.com/Bnjoroge1))
+- Add missing test coverage for `Nel.equal` and `Nel.append` functions (by [Bill Njoroge](https://github.com/Bnjoroge1))
+- Add `to_data` and `from_data` for Archetypes  (by [gr-im](https://github.com/xvw))
+
+
 ### v2.6.0 2025-09-23 Nantes (France)
 
 #### Yocaml

lib/core/archetype.ml

@@ -119,10 +119,12 @@ module Datetime = struct
     | None -> Data.Validation.fail_with ~given:str "Invalid date format"
     | Some (year, month, day) -> make ~year ~month ~day ()
 
-  let validate =
+  let from_data =
     let open Data.Validation in
     string & (validate_from_datetime_str / validate_from_date_str)
 
+  let validate = from_data
+
   let month_to_int = function
     | Jan -> 1
     | Feb -> 2
@@ -235,7 +237,7 @@ module Datetime = struct
     Format.fprintf ppf "%04d-%02d-%02dT%02d:%02d:%02d%s" dt.year mon dt.day
       dt.hour dt.min dt.sec tz
 
-  let normalize ({ year; month; day; hour; min; sec } as dt) =
+  let to_data ({ year; month; day; hour; min; sec } as dt) =
     let has_time = not (Int.equal (compare_time dt dummy) 0) in
     let datetime_repr = Format.asprintf "%a" pp dt in
     let date_repr = Format.asprintf "%a" pp_date dt in
@@ -263,6 +265,8 @@ module Datetime = struct
             ] )
       ]
 
+  let normalize = to_data
+
   module Infix = struct
     let ( = ) = equal
     let ( <> ) x y = not (equal x y)
@@ -325,6 +329,8 @@ module Page = struct
     let open Data.Validation in
     record validate_page
 
+  let from_data = validate
+
   let to_meta name = function
     | None -> []
     | Some x ->
@@ -362,6 +368,7 @@ module Page = struct
 
   let normalize_meta obj = Data.[ ("meta", list @@ meta_list obj) ]
   let normalize obj = normalize_parameters obj @ normalize_meta obj
+  let to_data obj = Data.record (normalize obj)
 end
 
 module Article = struct
@@ -408,6 +415,8 @@ module Article = struct
         and+ date = required fields "date" Datetime.validate in
         new article page ?synopsis ~title ~date ())
 
+  let from_data = validate
+
   let normalize obj =
     Page.normalize obj
     @ Data.
@@ -417,6 +426,8 @@ module Article = struct
         ; ("date", Datetime.normalize obj#date)
         ; ("has_synopsis", bool @@ Option.is_some obj#synopsis)
         ]
+
+  let to_data obj = Data.record (normalize obj)
 end
 
 module Articles = struct
@@ -478,4 +489,6 @@ module Articles = struct
     ("articles", list_of normalize_article obj#articles)
     :: ("has_articles", bool @@ not (is_empty_list obj#articles))
     :: Page.normalize obj
+
+  let to_data obj = Data.record (normalize obj)
 end

lib/core/archetype.mli

@@ -89,11 +89,15 @@ module Datetime : sig
   (** [make ?time ~year ~month ~day ()] Builds a date when all data and
       validates all data.*)
 
-  val validate : Data.t -> t Data.Validation.validated_value
+  include Data.Validation.S with type t := t
+
+  val validate : t Data.validable
   (** [validate data] try to read a date from a generic representation.*)
 
   (** {1 Dealing with date as metadata} *)
 
+  include Data.S with type t := t
+
   val normalize : t -> Data.t
   (** [normalize datetime] render data generically (with additional fields).
       Here is the list of fields:
@@ -227,6 +231,8 @@ module Page : sig
 
       A page can be parsed and injected. *)
 
+  include Data.Validation.S with type t := t
+
   include Required.DATA_READABLE with type t := t
   (** @inline *)
 
@@ -239,6 +245,8 @@ module Page : sig
       description or charset with the parameters [has_page_title],
       [has_page_description], [has_page_charset] and [has_page_tags]. *)
 
+  include Data.S with type t := t
+
   include Required.DATA_INJECTABLE with type t := t
   (** @inline *)
 end
@@ -270,13 +278,17 @@ module Article : sig
       metadata will use the article's [title]. The same applies to [description]
       and [synopsis]. *)
 
+  include Data.Validation.S with type t := t
+
   include Required.DATA_READABLE with type t := t
   (** @inline *)
 
   (** As an article is also a page, article-normalized data includes
       article-normalized data with additional fields. As with optional fields,
       [synopsis] has a [has_synopsis] version. *)
 
+  include Data.S with type t := t
+
   include Required.DATA_INJECTABLE with type t := t
   (** @inline *)
 end
@@ -343,6 +355,8 @@ module Articles : sig
   (** Pipe {!val:fetch} into a computed page. You can refer to the examples to
       see how this is used in a classic pipeline. *)
 
+  include Data.S with type t := t
+
   include Required.DATA_INJECTABLE with type t := t
   (** @inline *)
 end