From 83018251247376b0176ac4d989766966d5fdc0b4 Mon Sep 17 00:00:00 2001 From: Vincent Ambo Date: Fri, 15 Oct 2021 13:44:49 +0200 Subject: chore(web/atom-feed): Move feed generator out of //users/tazjin I intend to use this for updates on TVL projects, which will end up on the homepage, which is outside of //users. Change-Id: I03542d1bcef3d9fc4599294655caab5ed22ba5d9 Reviewed-on: https://cl.tvl.fyi/c/depot/+/3728 Tested-by: BuildkiteCI Reviewed-by: sterni --- users/tazjin/atom-feed/default.nix | 145 ------------------------------------- users/tazjin/homepage/feed.nix | 3 +- web/atom-feed/default.nix | 145 +++++++++++++++++++++++++++++++++++++ 3 files changed, 147 insertions(+), 146 deletions(-) delete mode 100644 users/tazjin/atom-feed/default.nix create mode 100644 web/atom-feed/default.nix diff --git a/users/tazjin/atom-feed/default.nix b/users/tazjin/atom-feed/default.nix deleted file mode 100644 index 9ed2c6189237..000000000000 --- a/users/tazjin/atom-feed/default.nix +++ /dev/null @@ -1,145 +0,0 @@ -# This file defines functions for generating an Atom feed. - -{ depot, lib, pkgs, ... }: - -with depot.nix.yants; - -let - inherit (builtins) map readFile replaceStrings; - inherit (lib) concatStrings concatStringsSep removeSuffix; - inherit (pkgs) runCommandNoCC; - - # 'link' describes a related link to a feed, or feed element. - # - # https://validator.w3.org/feed/docs/atom.html#link - link = struct "link" { - rel = string; - href = string; - }; - - # 'entry' describes a feed entry, for example a single post on a - # blog. Some optional fields have been omitted. - # - # https://validator.w3.org/feed/docs/atom.html#requiredEntryElements - entry = struct "entry" { - # Identifies the entry using a universally unique and permanent URI. - id = string; - - # Contains a human readable title for the entry. This value should - # not be blank. - title = string; - - # Content of the entry. - content = option string; - - # Indicates the last time the entry was modified in a significant - # way (in seconds since epoch). - updated = int; - - # Names authors of the entry. Recommended element. - authors = option (list string); - - # Related web pages, such as the web location of a blog post. - links = option (list link); - - # Conveys a short summary, abstract, or excerpt of the entry. - summary = option string; - - # Contains the time of the initial creation or first availability - # of the entry. - published = option int; - - # Conveys information about rights, e.g. copyrights, held in and - # over the entry. - rights = option string; - }; - - # 'feed' describes the metadata of the Atom feed itself. - # - # Some optional fields have been omitted. - # - # https://validator.w3.org/feed/docs/atom.html#requiredFeedElements - feed = struct "feed" { - # Identifies the feed using a universally unique and permanent URI. - id = string; - - # Contains a human readable title for the feed. - title = string; - - # Indicates the last time the feed was modified in a significant - # way (in seconds since epoch). Recommended element. - updated = int; - - # Entries contained within the feed. - entries = list entry; - - # Names authors of the feed. Recommended element. - authors = option (list string); - - # Related web locations. Recommended element. - links = option (list link); - - # Conveys information about rights, e.g. copyrights, held in and - # over the feed. - rights = option string; - - # Contains a human-readable description or subtitle for the feed. - subtitle = option string; - }; - - # Feed generation functions: - - renderEpoch = epoch: removeSuffix "\n" (readFile (runCommandNoCC "date-${toString epoch}" {} '' - date --date='@${toString epoch}' --utc --iso-8601='seconds' > $out - '')); - - escape = replaceStrings [ "<" ">" "&" "'" ] [ "<" ">" "&" "'" ]; - - elem = name: content: ''<${name}>${escape content}''; - - renderLink = defun [ link string ] (l: '' - - ''); - - # Technically the author element can also contain 'uri' and 'email' - # fields, but they are not used for the purpose of this feed and are - # omitted. - renderAuthor = author: ''${escape author}''; - - renderEntry = defun [ entry string ] (e: '' - - ${elem "title" e.title} - ${elem "id" e.id} - ${elem "updated" (renderEpoch e.updated)} - ${if e ? published - then elem "published" (renderEpoch e.published) - else "" - } - ${if e ? content - then ''${escape e.content}'' - else "" - } - ${if e ? summary then elem "summary" e.summary else ""} - ${concatStrings (map renderAuthor (e.authors or []))} - ${if e ? subtitle then elem "subtitle" e.subtitle else ""} - ${if e ? rights then elem "rights" e.rights else ""} - ${concatStrings (map renderLink (e.links or []))} - - ''); - - renderFeed = defun [ feed string ] (f: '' - - - ${elem "id" f.id} - ${elem "title" f.title} - ${elem "updated" (renderEpoch f.updated)} - ${concatStringsSep "\n" (map renderAuthor (f.authors or []))} - ${if f ? subtitle then elem "subtitle" f.subtitle else ""} - ${if f ? rights then elem "rights" f.rights else ""} - ${concatStrings (map renderLink (f.links or []))} - ${concatStrings (map renderEntry f.entries)} - - ''); -in { - inherit entry feed renderFeed renderEpoch; -} diff --git a/users/tazjin/homepage/feed.nix b/users/tazjin/homepage/feed.nix index 40650f678ba1..bd5b3c25f4be 100644 --- a/users/tazjin/homepage/feed.nix +++ b/users/tazjin/homepage/feed.nix @@ -7,7 +7,8 @@ let inherit (builtins) map readFile sort foldl'; inherit (lib) max singleton; inherit (pkgs) writeText; - inherit (depot.users.tazjin) atom-feed blog renderMarkdown; + inherit (depot.web) atom-feed; + inherit (depot.users.tazjin) blog renderMarkdown; postToEntry = defun [ blog.post atom-feed.entry ] (post: rec { id = "https://tazj.in/blog/${post.key}"; diff --git a/web/atom-feed/default.nix b/web/atom-feed/default.nix new file mode 100644 index 000000000000..9ed2c6189237 --- /dev/null +++ b/web/atom-feed/default.nix @@ -0,0 +1,145 @@ +# This file defines functions for generating an Atom feed. + +{ depot, lib, pkgs, ... }: + +with depot.nix.yants; + +let + inherit (builtins) map readFile replaceStrings; + inherit (lib) concatStrings concatStringsSep removeSuffix; + inherit (pkgs) runCommandNoCC; + + # 'link' describes a related link to a feed, or feed element. + # + # https://validator.w3.org/feed/docs/atom.html#link + link = struct "link" { + rel = string; + href = string; + }; + + # 'entry' describes a feed entry, for example a single post on a + # blog. Some optional fields have been omitted. + # + # https://validator.w3.org/feed/docs/atom.html#requiredEntryElements + entry = struct "entry" { + # Identifies the entry using a universally unique and permanent URI. + id = string; + + # Contains a human readable title for the entry. This value should + # not be blank. + title = string; + + # Content of the entry. + content = option string; + + # Indicates the last time the entry was modified in a significant + # way (in seconds since epoch). + updated = int; + + # Names authors of the entry. Recommended element. + authors = option (list string); + + # Related web pages, such as the web location of a blog post. + links = option (list link); + + # Conveys a short summary, abstract, or excerpt of the entry. + summary = option string; + + # Contains the time of the initial creation or first availability + # of the entry. + published = option int; + + # Conveys information about rights, e.g. copyrights, held in and + # over the entry. + rights = option string; + }; + + # 'feed' describes the metadata of the Atom feed itself. + # + # Some optional fields have been omitted. + # + # https://validator.w3.org/feed/docs/atom.html#requiredFeedElements + feed = struct "feed" { + # Identifies the feed using a universally unique and permanent URI. + id = string; + + # Contains a human readable title for the feed. + title = string; + + # Indicates the last time the feed was modified in a significant + # way (in seconds since epoch). Recommended element. + updated = int; + + # Entries contained within the feed. + entries = list entry; + + # Names authors of the feed. Recommended element. + authors = option (list string); + + # Related web locations. Recommended element. + links = option (list link); + + # Conveys information about rights, e.g. copyrights, held in and + # over the feed. + rights = option string; + + # Contains a human-readable description or subtitle for the feed. + subtitle = option string; + }; + + # Feed generation functions: + + renderEpoch = epoch: removeSuffix "\n" (readFile (runCommandNoCC "date-${toString epoch}" {} '' + date --date='@${toString epoch}' --utc --iso-8601='seconds' > $out + '')); + + escape = replaceStrings [ "<" ">" "&" "'" ] [ "<" ">" "&" "'" ]; + + elem = name: content: ''<${name}>${escape content}''; + + renderLink = defun [ link string ] (l: '' + + ''); + + # Technically the author element can also contain 'uri' and 'email' + # fields, but they are not used for the purpose of this feed and are + # omitted. + renderAuthor = author: ''${escape author}''; + + renderEntry = defun [ entry string ] (e: '' + + ${elem "title" e.title} + ${elem "id" e.id} + ${elem "updated" (renderEpoch e.updated)} + ${if e ? published + then elem "published" (renderEpoch e.published) + else "" + } + ${if e ? content + then ''${escape e.content}'' + else "" + } + ${if e ? summary then elem "summary" e.summary else ""} + ${concatStrings (map renderAuthor (e.authors or []))} + ${if e ? subtitle then elem "subtitle" e.subtitle else ""} + ${if e ? rights then elem "rights" e.rights else ""} + ${concatStrings (map renderLink (e.links or []))} + + ''); + + renderFeed = defun [ feed string ] (f: '' + + + ${elem "id" f.id} + ${elem "title" f.title} + ${elem "updated" (renderEpoch f.updated)} + ${concatStringsSep "\n" (map renderAuthor (f.authors or []))} + ${if f ? subtitle then elem "subtitle" f.subtitle else ""} + ${if f ? rights then elem "rights" f.rights else ""} + ${concatStrings (map renderLink (f.links or []))} + ${concatStrings (map renderEntry f.entries)} + + ''); +in { + inherit entry feed renderFeed renderEpoch; +} -- cgit 1.4.1