linted

Author: fabiocicerchia

.github/linters/.ecrc

@@ -1,5 +1,6 @@
 {
   "Exclude": [
+    "docs/lua-nginx-module/DIRECTIVES.md",
     "docs/lua-nginx-module/known-issues.md",
     "docs/lua-nginx-module/nginx-api-for-lua.md"
   ]

README.md

@@ -61,7 +61,7 @@ Lua is a lightweight, high-level, multi-paradigm programming language designed p
 
 | | nginx-lua | OpenResty |
 |--|--|--|
-| nginx latest version | `1.21.0` | `1.19.x` (last tested: `1.19.9`)<sup>*</sup> |
+| nginx latest version | `1.21.0` | `1.19.x` (last tested: `1.19.9`)¹ |
 | Alpine supported | ✅ | ✅ |
 | Amazon supported | ✅ | ✅ |
 | CentOS supported | ❌ | ✅ |
@@ -70,7 +70,7 @@ Lua is a lightweight, high-level, multi-paradigm programming language designed p
 | Ubuntu supported | ✅ | ✅ |
 | Windows supported | ❌ | ✅ |
 
-<sup>*</sup> Note: Between OpenResty compatibility for `1.17.4` (28 Sep 2019) and `1.19.3` (3 Nov 2020) have passed ~10 months, and nginx 1.19.3 has been released on 29 Sep 2020.
+¹ Note: Between OpenResty compatibility for `1.17.4` (28 Sep 2019) and `1.19.3` (3 Nov 2020) have passed ~10 months, and nginx 1.19.3 has been released on 29 Sep 2020.
 
 ## Features
 
@@ -642,7 +642,6 @@ As for any pre-built image usage, it is the image user's responsibility to ensur
 - [Lua License](https://www.lua.org/license.html)
 - [OpenResty License](https://github.com/openresty/openresty#copyright--license)
 
-
 [![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Ffabiocicerchia%2Fnginx-lua.svg?type=large)](https://app.fossa.com/projects/git%2Bgithub.com%2Ffabiocicerchia%2Fnginx-lua?ref=badge_large)
 
 ### `fabiocicerchia/nginx-lua`

bin/generate-supported-versions.sh

@@ -28,7 +28,7 @@ fetch_latest() {
 set -eux
 
 DISTRO=nginx
-VER_NGINX=$(wget -q https://registry.hub.docker.com/v1/repositories/$DISTRO/tags -O - | sed -e 's/[][]//g' -e 's/"//g' -e 's/ //g' | tr '}' '\n'  | cut -d: -f3 | grep -E "[0-9]+\.[0-9]+\.[0-9]+" | grep -E -v "alpine|perl" | sort -Vr | head -n 1)
+VER_NGINX=$(wget -q https://registry.hub.docker.com/v1/repositories/$DISTRO/tags -O - | sed -e 's/[][]//g' -e 's/"//g' -e 's/ //g' | tr '}' '\n' | cut -d: -f3 | grep -E "[0-9]+\.[0-9]+\.[0-9]+" | grep -E -v "alpine|perl" | sort -Vr | head -n 1)
 NGINX=()
 for VER in $VER_NGINX; do
     NGINX+=("$VER")

bin/update-readme.sh

@@ -2,5 +2,5 @@
 
 head -n "$(grep -n START_SUPPORTED_TAGS README.md | cut -d: -f1)" README.md >README.md.tmp
 ./bin/readme-tags.sh >>README.md.tmp
-tail -n "$(($(wc -l <README.md) - $(grep -n END_SUPPORTED_TAGS README.md | cut -d: -f1)+1))" README.md >>README.md.tmp
+tail -n "$(($(wc -l <README.md) - $(grep -n END_SUPPORTED_TAGS README.md | cut -d: -f1) + 1))" README.md >>README.md.tmp
 mv README.md.tmp README.md

docs/examples/docker-compose.md

@@ -4,10 +4,10 @@
 web:
   image: fabiocicerchia/ginx-lua
   volumes:
-   - ./templates:/etc/nginx/templates
+    - ./templates:/etc/nginx/templates
   ports:
-   - "8080:80"
+    - "8080:80"
   environment:
-   - NGINX_HOST=foobar.com
-   - NGINX_PORT=80
+    - NGINX_HOST=foobar.com
+    - NGINX_PORT=80
 ```

docs/examples/lua-nginx-module.md

@@ -91,26 +91,49 @@ server {
     }
 
     location / {
-       client_max_body_size 100k;
-       client_body_buffer_size 100k;
-
-       access_by_lua_block {
-           -- check the client IP address is in our black list
-           if ngx.var.remote_addr == "132.5.72.3" then
-               ngx.exit(ngx.HTTP_FORBIDDEN)
-           end
-
-           -- check if the URI contains bad words
-           if ngx.var.uri and
-                  string.match(ngx.var.request_body, "evil")
-           then
-               return ngx.redirect("/terms_of_use.html")
-           end
-
-           -- tests passed
-       }
-
-       # proxy_pass/fastcgi_pass/etc settings
+        client_max_body_size 100k;
+        client_body_buffer_size 100k;
+
+        access_by_lua_block {
+            -- check the client IP address is in our black list
+            if ngx.var.remote_addr == "132.5.72.3" then
+                ngx.exit(ngx.HTTP_FORBIDDEN)
+            end
+
+            -- body may get buffered in a temp file:
+            local file = ngx.req.get_body_file()
+            if file then
+                ngx.say("body is in file ", file)
+            else
+                ngx.say("no body found")
+            end
+        }
+    }
+
+    # transparent non-blocking I/O in Lua via subrequests
+    # (well, a better way is to use cosockets)
+    location = /lua {
+        # MIME type determined by default_type:
+        default_type 'text/plain';
+
+        content_by_lua_block {
+            local res = ngx.location.capture("/some_other_location")
+            if res then
+                ngx.say("status: ", res.status)
+                ngx.say("body:")
+                ngx.print(res.body)
+            end
+        }
+    }
+
+    location = /foo {
+        rewrite_by_lua_block {
+            res = ngx.location.capture("/memc",
+                { args = { cmd = "incr", key = ngx.var.uri } }
+            )
+        }
+
+        # proxy_pass/fastcgi_pass/etc settings
     }
 }
 ```