Add a renderer spec for escape and undescape double dollar signs ($$name)

Use '_' instead of '.' for numbering cosmo escapes
because it gets syntax highlighted weird because '.' is not valid for like a variable name so the syntax highlighter is splitting the escape phrase at the '.' which means that phrase won't match when unescaped so it fails to get unescaped for example, this would fail: ``` $$ct ```
2025-06-26 13:15:42 -07:00 · 2025-06-25 21:10:30 -07:00 · 2025-06-25 15:49:54 -07:00 · 2025-06-25 15:25:08 -07:00 · 2025-06-25 14:51:12 -07:00 · 2025-06-25 14:51:12 -07:00
7 changed files with 503 additions and 7 deletions
--- a/README.md
+++ b/README.md
@@ -56,9 +56,13 @@

    $ make build

+### build a single file
+
+    $ make build file=index.html
+
 ### start dev server

-    $ make
+    $ make serve

 Visit `localhost:8080` in web browser

--- a/html/.gitignore
+++ b/html/.gitignore
@@ -15,4 +15,5 @@ posts/resize-a-qemu-disk-image.html
 posts/set-up-a-gitweb-server.html
 posts/start-erlangs-dialyzer-with-gui-from-a-docker-container.html
 posts/test-mix-task-file-modify.html
+posts/test-nginx-conf-directives.html
 pygments.css
--- a/html/images/openresty-splash-page.png
+++ b/html/images/openresty-splash-page.png
--- a/posts/2025-06-22-test-nginx-conf-directives.md
+++ b/posts/2025-06-22-test-nginx-conf-directives.md
@@ -0,0 +1,418 @@
+$index
+
+## Introduction
+
+We'll need nginx and luarocks. Buildpack has luarocks installed.
+
+docker pull openresty/openresty:bookworm-buildpack
+
+$ docker run --rm -it -p 80:80 openresty/openresty:bookworm-buildpack
+
+Visit `localhost` in browser. Should see OpenResty splash page.
+
+![OpenResty default nginx index page](/images/openresty-splash-page.png)
+
+https://openresty.org/en/getting-started.html#prepare-directory-layout
+
+$ mkdir -p logs/ conf/conf.d/ html/
+
+https://github.com/openresty/docker-openresty?tab=readme-ov-file#nginx-config-files
+
+$ docker run --rm -it -w /opt -v $PWD:/opt openresty/openresty:bookworm-buildpack \
+cp /etc/nginx/conf.d/default.conf /opt/conf.d/
+
+edit default.conf
+change `root /usr/local/openresty/nginx/html;` to:
+
+    root /var/www;
+
+`html/index.html`
+
+```html
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="utf-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1" />
+    <title></title>
+  </head>
+  <body>
+    hello world!
+  </body>
+</html>
+```
+
+Start nginx:
+
+```console
+$ docker run --rm -it -p 80:80 \
+-v $PWD/conf/conf.d:/etc/nginx/conf.d -v $PWD/html:/var/www \
+openresty/openresty:bookworm-buildpack
+```
+
+Then, in another console:
+
+```console
+$ curl -v localhost
+*   Trying 127.0.0.1:80...
+* Connected to localhost (127.0.0.1) port 80 (#0)
+> GET / HTTP/1.1
+> Host: localhost
+> User-Agent: curl/7.88.1
+> Accept: */*
+> 
+< HTTP/1.1 200 OK
+< Server: openresty/1.27.1.2
+< ...
+< 
+<!DOCTYPE html>
+<html lang="en">
+  ...
+  <body>
+    hello world!
+  </body>
+</html>
+```
+
+If we wanted to write a test for that, we need some packages from `luarocks`.
+
+`Dockerfile`
+
+```Dockerfile
+FROM openresty/openresty:bookworm-buildpack
+
+WORKDIR /opt/app
+
+# needed for testing
+RUN luarocks install busted
+RUN luarocks install luajit-curl
+RUN luarocks install luasocket # needed for testing nginx reverse proxy
+```
+
+```console
+$ docker build -t test-nginx .
+$ mkdir spec
+```
+
+`spec/nginx_spec.moon`
+
+```moonscript
+http = require "luajit-curl-helper.http"
+
+req = (url) ->
+  request = http.init url
+  st = request\perform!
+  error request\lastError! if not st
+  request
+
+describe "http://localhost", ->
+  it "sends /index.html", ->
+    request = req "http://localhost"
+    assert.same request\statusCode!, 200
+    assert.same request\statusMessage!, "OK"
+    assert.same request\body!\match("<body>%s+(.-)%s+</body>"), "hello world!"
+```
+
+Start the test server:
+
+```console
+$ ct=$(docker run --rm -d \
+-v $PWD/conf/conf.d:/etc/nginx/conf.d \
+-v $PWD/html:/var/www \
+-v $PWD:/opt/app \
+test-nginx)
+```
+
+Run the tests.
+
+```console
+$ docker exec -t $ct busted
+●
+1 success / 0 failures / 0 errors / 0 pending : 0.008246 seconds
+```
+
+Stop the test server.
+
+```console
+$ docker exec -t $ct openresty -s stop
+```
+
+## Edit hosts
+
+Instead of `localhost` we'd like to use an actual domain name. We can do this
+with the `--add-host` option. But before we do that, we want to make sure our
+container does not have access to the internet, otherwise we might
+unintentionally get a response from a domain's server on the internet rather
+than from our test server.
+
+$ docker network create --internal no-internet
+
+Now we can start the test server with our host:
+
+```console
+$ ct=$(docker run --rm -d \
+-v $PWD/conf/conf.d:/etc/nginx/conf.d \
+-v $PWD/html:/var/www \
+-v $PWD:/opt/app \
+--network no-internet \
+--add-host=domain.abc=127.0.0.1 \
+test-nginx)
+```
+
+Update our test
+
+    request = req "http://localhost"
+
+to
+
+    request = req "http://domain.abc"
+
+Run the tests.
+
+```console
+$ docker exec -t $ct busted
+●
+1 success / 0 failures / 0 errors / 0 pending : 0.008246 seconds
+```
+
+Stop the test server.
+
+```console
+$ docker exec -t $ct openresty -s stop
+```
+
+## Add a test to make sure the test server is offline
+
+```moonscript
+describe "test environment", ->
+  it "can't connect to the internet", ->
+    assert.has_error (-> req "http://example.org"),
+      "Couldn't resolve host name"
+```
+
+## Create a Makefile
+
+Let's create a `Makefile` to make running all these commands easier.
+
+`Makefile`
+
+```Makefile
+image = test-nginx
+loopback = 127.0.0.1
+
+image-build:
+	docker build -t $(image) .
+
+image-rm:
+	docker image rm $(image)
+
+test:
+	@ct=$(shell docker run --rm -d \
+	   -v $(PWD)/conf/conf.d:/etc/nginx/conf.d \
+	   -v $(PWD)/html:/var/www \
+	   -v $(PWD):/opt/app \
+	   --network no-internet \
+	   --add-host=domain.abc=$(loopback) \
+	   $(image)); \
+	docker exec -t $$ct busted; \
+	docker exec $$ct openresty -s stop
+```
+
+Now we can run tests by running `make test`.
+
+```console
+$ make test
+●●
+2 successes / 0 failures / 0 errors / 0 pending : 0.008812 seconds
+```
+
+## SSL
+
+We want our server to redirect all `http` requests to `https`.
+
+Our test:
+
+```moonscript
+describe "http://domain.abc", ->
+  it "redirects to https", ->
+    request = req "http://domain.abc"
+    assert.same request\statusCode!, 301
+    assert.same request\statusMessage!, "Moved Permanently"
+    assert.same request\header!.Location, "https://domain.abc/"
+```
+
+```console
+$ make test
+●●◼
+2 successes / 1 failure / 0 errors / 0 pending : 0.010449 seconds
+
+Failure → .../luajit/lib/luarocks/rocks-5.1/busted/2.2.0-1/bin/busted @ 3
+http://domain.abc redirects to https
+spec/nginx_spec.moon:24: Expected objects to be the same.
+Passed in:
+(number) 301
+Expected:
+(number) 200
+```
+
+Make self-signed certs in Dockerfile:
+
+```Dockerfile
+RUN openssl req -x509 -newkey rsa:4096 -nodes \
+      -keyout /etc/ssl/private/domain.abc.pem \
+      -out /etc/ssl/certs/domain.abc.pem \
+      -sha256 -days 365 -subj '/CN=domain.abc' \
+      -addext "subjectAltName=DNS:domain.abc"
+```
+
+Edit `default.conf`:
+
+```
+server {
+    listen 80;
+    return 301 https://$host$request_uri;
+}
+
+server {
+    listen       443 ssl;
+    server_name  domain.abc;
+    ssl_certificate /etc/ssl/certs/domain.abc.pem;
+    ssl_certificate_key /etc/ssl/private/domain.abc.pem;
+```
+
+Rebuild the image:
+
+```console
+$ make image-rm
+$ make image-build
+```
+
+Run tests:
+
+```console
+$ make test
+●◼●
+2 successes / 1 failure / 0 errors / 0 pending : 0.009618 seconds
+
+Failure → .../luajit/lib/luarocks/rocks-5.1/busted/2.2.0-1/bin/busted @ 3
+http://domain.abc sends /index.html
+spec/nginx_spec.moon:17: Expected objects to be the same.
+Passed in:
+(number) 200
+Expected:
+(number) 301
+```
+
+Fix test:
+
+```moonscript
+describe "https://domain.abc", ->
+  it "sends /index.html", ->
+    request = req "https://domain.abc"
+```
+
+Run tests:
+
+```console
+$ make test
+●●●
+3 successes / 0 failures / 0 errors / 0 pending : 0.017065 seconds
+```
+
+## Reverse proxy a subdomain to a Gitea unix socket
+
+Add to `default.conf`:
+
+```
+server {
+    listen 443 ssl;
+    server_name git.domain.abc;
+
+    location / {
+        client_max_body_size 1024M;
+        proxy_pass http://unix:/run/gitea/gitea.socket;
+        proxy_set_header Connection $http_connection;
+        proxy_set_header Upgrade $http_upgrade;
+        proxy_set_header Host $host;
+        proxy_set_header X-Real-IP $remote_addr;
+        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
+        proxy_set_header X-Forwarded-Proto $scheme;
+    }
+}
+```
+
+Add subdomain to certs in Dockerfile:
+
+```
+      -addext "subjectAltName=DNS:domain.abc,DNS:git.domain.abc"
+```
+
+Add a test socket server:
+
+`spec/unixstreamsrvr.moon`
+
+```moonscript
+-- modified from
+-- https://github.com/lunarmodules/luasocket/blob/4844a48fbf76b0400fd7b7e4d15d244484019df1/test/unixstreamsrvr.lua
+socket = require "socket"
+socket.unix = require "socket.unix"
+u = assert socket.unix.stream!
+assert u\bind "/run/gitea/gitea.socket"
+assert u\listen!
+assert u\settimeout 1
+c = assert u\accept!
+
+while true
+  m = assert c\receive!
+  break if m == ""
+  print m
+```
+
+Add a spec:
+
+```moonscript
+describe "https://git.domain.abc", ->
+  it "reverse-proxy's request to a gitea unix socket", ->
+    socket = fname: "unixstreamsrvr.moon", dir: "/run/gitea", owner: "nobody"
+    basepath = debug.getinfo(1).short_src\match"^(.*)/[^/]*$" or "."
+    seconds = 0.1
+
+    os.execute "install -o #{socket.owner} -d #{socket.dir}"
+    cmd = "su -s /bin/bash -c 'moon %s' %s"
+    server = io.popen cmd\format "#{basepath}/#{socket.fname}", socket.owner
+    os.execute "sleep #{seconds}"
+    f = io.popen "find #{socket.dir} -type s -ls", "r"
+    result = with f\read "*a"
+      f\close!
+    assert.truthy result\match "nobody%s+nogroup.+#{socket.dir}/gitea.socket"
+
+    req "https://git.domain.abc"
+
+    reqheader = with server\read "*a"
+      server\close!
+
+    assert.truthy reqheader\match "Host: git.domain.abc"
+```
+
+Edit Makefile:
+
+    --add-host=git.domain.abc=$(loopback) \
+
+Rebuild image:
+
+```console
+$ make image-rm image-build
+```
+
+Run tests:
+
+```console
+$ make test
+●●●●
+4 successes / 0 failures / 0 errors / 0 pending : 0.131619 seconds
+```
+
+
+## Conclusion
+
+
--- a/renderers/markdown.moon
+++ b/renderers/markdown.moon
@@ -1,5 +1,70 @@
 Path = require "sitegen.path"

+dollar_temp = "z000sitegen_markdown00dollar0000"
+
+-- a constructor for quote delimited strings
+simple_string = (delim) ->
+  import P from require "lpeg"
+
+  inner = P("\\#{delim}") + "\\\\" + (1 - P delim)
+  inner = inner^0
+  P(delim) * inner * P(delim)
+
+lua_string = ->
+  import P, C, Cmt, Cb, Cg from require "lpeg"
+  check_lua_string = (str, pos, right, left) ->
+    #left == #right
+
+  string_open = P"[" * P"="^0 * "["
+  string_close = P"]" * P"="^0 * "]"
+
+  valid_close = Cmt C(string_close) * Cb"string_open", check_lua_string
+
+  Cg(string_open, "string_open") *
+    (1 - valid_close)^0 * string_close
+
+-- returns a pattern that parses a cosmo template. Can be used to have
+-- pre-processors ignore text that would be handled by cosmo
+parse_cosmo = ->
+  import P, R, Cmt, Cs, V from require "lpeg"
+  curly = P {
+    P"{" * (
+      simple_string("'") +
+      simple_string('"') +
+      lua_string! +
+      V(1) +
+      (P(1) - "}")
+    )^0 * P"}"
+  }
+
+  alphanum = R "az", "AZ", "09", "__"
+  P"$" * alphanum^1 * (curly)^-1
+
+escape_cosmo = (str) ->
+  escapes = {}
+  import P, R, Cmt, Cs, V from require "lpeg"
+
+  counter = 0
+
+  cosmo = parse_cosmo! / (tpl) ->
+    counter += 1
+    key = "#{dollar_temp}_#{counter}"
+    escapes[key] = tpl
+    key
+
+  patt = Cs (cosmo + P(1))^0 * P(-1)
+  str = patt\match(str) or str, escapes
+  str, escapes
+
+unescape_cosmo = (str, escapes) ->
+  import P, R, Cmt, Cs from require "lpeg"
+
+  escape_patt = P(dollar_temp) * P("_") * R("09")^1 / (key) ->
+    escapes[key] or error "bad key for unescape_cosmo"
+
+  patt = Cs (escape_patt + P(1))^0 * P(-1)
+  assert patt\match(str)
+
 needs_shell_escape = (str) -> not not str\match "[^%w_-]"
 shell_escape = (str) -> str\gsub "'", "''"

@@ -19,12 +84,13 @@ write_exec = (cmd, content) ->

  fname

-- config command like this in site.moon:
-- require("renderers.markdown").cmd = "pandoc --mathjax >"
-class PandocRenderer extends require "sitegen.renderers.markdown"
-  unescape_cosmo = @unescape_cosmo
-  escape_cosmo = @escape_cosmo
+class PandocRenderer extends require "sitegen.renderers.html"
+  @escape_cosmo: escape_cosmo
+  @unescape_cosmo: unescape_cosmo
+  @parse_cosmo: parse_cosmo

+  source_ext: "md"
+  ext: "html"
  cmd: "pandoc --mathjax --lua-filter pygments.lua >"
  pandoc: (content) => Path.read_file write_exec @@cmd, content

--- a/site.moon
+++ b/site.moon
@@ -29,7 +29,6 @@ get_files = (path, prefix=path) ->
    files = for file in *files
      file\gsub "^#{escape_patt prefix}/?", ""

-  table.sort files
  files

 -- strip file extension from filename
--- a/spec/renderers_spec.moon
+++ b/spec/renderers_spec.moon
@@ -86,3 +86,11 @@ this code block has no label

      assert.same [[<div class="sourceCode" id="cb1"><pre
 class="sourceCode heex"><code class="sourceCode elixir"><span id="cb1-1"><a href="#cb1-1" aria-hidden="true" tabindex="-1"></a><span class="op">&lt;.</span>greet name<span class="op">=</span><span class="st">&quot;Jane&quot;</span><span class="op">/&gt;</span></span></code></pre></div>]], out
+
+    it "escapes and unescapes double dollar signs", ->
+      out = flatten_html render [[
+```Makefile
+  $$name
+```]]
+
+      assert.same [[<div class="highlight"><pre><span></span><code><span class="py-w"></span><span class="py-nv">$$name</span></code></pre></div>]], out
Author	SHA1	Message	Date
Catalin Constantin Mititiuc	eb896676cc	Add a renderer spec for escape and undescape double dollar signs (`$$name`)	2025-06-26 13:15:42 -07:00
Catalin Constantin Mititiuc	766c9bad62	Use '_' instead of '.' for numbering cosmo escapes because it gets syntax highlighted weird because '.' is not valid for like a variable name so the syntax highlighter is splitting the escape phrase at the '.' which means that phrase won't match when unescaped so it fails to get unescaped for example, this would fail: ``` $$ct ```	2025-06-25 21:10:30 -07:00
Catalin Constantin Mititiuc	c26453415d	Clean up last spec	2025-06-25 15:49:54 -07:00
Catalin Constantin Mititiuc	dce537b50c	Delete duplicate post	2025-06-25 15:25:08 -07:00
Catalin Constantin Mititiuc	b7e6a93bf9	Add post draft	2025-06-25 14:51:12 -07:00
Catalin Constantin Mititiuc	95b3589d22	Add markdown file	2025-06-25 14:51:12 -07:00
Catalin Constantin Mititiuc	4ad479f8f9	Update commands in README.md	2025-06-25 14:47:23 -07:00
Catalin Constantin Mititiuc	0e848c5e7b	Change cosmo '$' escape string in markdown renderer so that we can put 2 selectors next to each other and still be able to tell where one ends and the other one begins	2025-06-25 14:44:32 -07:00