Cookbook - corpus draft

[F-Loyer]

After a call with Alvarado Cuihtlauac, I propose an index of the cookbook, the way I think about it. This index identifies some recipes that are already written, and others that I could write. It may be completed (I may lack some imagination)

I propose to review this index. How it would become with a new level of hierarchy ? What aggregation should be done, what decomposition should be done ?

I should add that the decomposition of compression (separing ZIP and Gzip) is motivated by what a reader would be interesting with... usually only Gzip or only ZIP (in a same way merging XML and JSON recipes would not be adequate). On the opposite, my Caqti/ppx_rapper article is large, but a reader would be more likely interested in all the queries. I think this guideline could be used to determine how to split articles.

• Command line

  • Sys (Stdlib)
  • Cmdline

• Compression

  • ZIP Decompression
  • Gzip Decompression
  • ZIP Compression
  • Gzip Compression

• Concurrency

  • Lwt [Perhaps we should add Mutex and something like this... in a new article or in the existing article]
  • Eio [A decomposition should be needed : spawning task, mutex, etc.]
  • Fiber (?)
  • Parmap (?)

• Cryptography

  • X509, Signature/vérif [signing/verifying needs reading a certificate... it is difficult to separate X509 and signature/verification]

• Databases

  • Tasks
    • SQL (recipes applicable to all relational RDBMS)
      • CREATE TABLE
      • INSERT
      • SELECT
    • MySQL (vendor-specific recipes)
      • (TBD)
    • PostgreSQL (vendor-specific recipes)
      • (TBD)
    • NoSQL
      • (TBD)
  • Libraries/Packages
    • Catqi: https://github.com/paurkedal/ocaml-caqti
      • PPX rapper: https://github.com/roddyyaga/ppx_rapper (just a helper)
    • DBM: https://github.com/ocaml/dbm
    • Sequoia: https://github.com/andrenth/sequoia
    • Petrol: https://github.com/Gopiandcode/petrol
    • ORM: https://github.com/mirage/orm
    • Mongo.ml: https://github.com/MassD/mongo
    • OCaml ODBC: https://github.com/Chris00/ocaml-odbc
  • Notes
    • Driver (libraries) vs DBMS (s.a. SQLite, PostgreSQL, MariaDB, MongoDB, etc.)
    • Transaction (added to Caqti... or merged)

• Date & Time

  • Get today's date
  • calendar, ISO8601, odate, ptime (?)

• Debugging

  • minidebug
  • utop (?) [A bit peculiar... no OCaml function, only utop statements]
  • Logs
  • Printers

• Encoding

  • XML function generation with PPX preprocessor
  • XML generation
  • XML parsing
  • JSON function generation with PPX preprocessor
  • Yojson generation
  • Yojson parsing
  • Text encoding/decoding [ Could be put in Text processing...]
  • CSV (generation / parsing)
  • Sexp generation
  • Sexp parsing
  • Base64 [generation / parsing... 1 or 2 articles ?]
  • Hex [generation / parsing... 1 or 2 articles ?]

• File system

  • Stdlib description
  • Traversal

• Garbage collector

  • ???

• Random numbers

  • Generate random number
  • Generate random strings and array

• Hash table et maps

  • Hashtbl (No Stdlib only recipes)
  • Map (No Stdlib only recipes)
  • Sets (No Stdlib only recipes)

• Maths

  • ??? [11 libraries identified in Awesome OCaml. The Owl libray is huge]

• Netwotking

  • TCP server
  • TCP client
  • UDP

• Operating system

  • Fork / Stdlib
  • Fork / Feather

• Sorting

  • sorting list and array [1/ list, 2/ array, 3/ custom compare function]

• Text processing

  • ASCII Text processing (No Stdlib only recipes)
  • UTF-8 Text processing
  • Regular expression
  • Regular expression (ppx_regexp)
  • Menhir / ocamllex [This article is tricky... 3 different file... Menhir, Ocamllex, OCaml]
  • UTF-8 with Uu** packages [1 article per packages?]

• Web programming

  • URI
  • get HTTP file / cohttp
  • Dream + ?? [ dream_eml would require a dune snippet because of a specific preprocessor... dream_html could be preferred]
  • Httpaf (?)
  • Ocurl (?)

• Graphics

• Messaging