Merge pull request #9 from python-discord/release/0.2.0

Prepare the release of version 0.2.0 of Async RedisCache

Author: SebastiaanZ

.github/workflows/lint_test.yaml

@@ -43,7 +43,7 @@ jobs:
             ${{ hashFiles('Pipfile') }}"
 
       - name: Prepend PATH
-        run: echo '::add-path::${{ env.PYTHONUSERBASE }}/bin'
+        run: echo '${{ env.PYTHONUSERBASE }}/bin' >> $GITHUB_PATH
 
       - name: Install pipenv
         run: pip install pipenv
@@ -57,4 +57,13 @@ jobs:
         run: python -m flake8
 
       - name: Run unittest
-        run: python -m unittest
+        run: |
+          python -m coverage run -m unittest
+          python -m coverage report -m
+
+      # This step will publish the coverage reports coveralls.io and
+      # print a "job" link in the output of the GitHub Action
+      - name: Publish coverage report to coveralls.io
+        env:
+            GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: python -m coveralls

.gitignore

@@ -3,3 +3,4 @@
 build/
 dist/
 *.egg-info
+.coverage

MANIFEST.in

@@ -1 +1,2 @@
 recursive-exclude tests *
+recursive-include async_rediscache/redis_scripts *.lua

Pipfile

@@ -13,10 +13,13 @@ flake8-string-format = "~=0.3.0"
 flake8-tidy-imports = "~=4.1.0"
 flake8-todo = "~=0.7"
 pep8-naming = "~=0.11.0"
+"coverage[toml]" = "~=5.3"
+coveralls = "~=2.2.0"
+time-machine = "~=1.3.0"
 
 [packages]
 aioredis = "~=1.3.1"
-fakeredis = "~=1.4.3"
+"fakeredis[lua]" = "~=1.4.4"
 
 [requires]
 python_version = "3.8"

Pipfile.lock

@@ -1,3 +1,7 @@
+[![Coverage Status](https://coveralls.io/repos/github/python-discord/async-rediscache/badge.svg?branch=master)](https://coveralls.io/github/python-discord/async-rediscache?branch=master)
+![Lint & Test](https://github.com/python-discord/async-rediscache/workflows/Lint%20&%20Test/badge.svg)
+![Release to PyPI](https://github.com/python-discord/async-rediscache/workflows/Release%20to%20PyPI/badge.svg)
+
 # Asynchronous Redis Cache
 This package offers several data types to ease working with a Redis cache in an asynchronous workflow. The package is currently in development and it's not recommended to start using it in production at this point.
 

README.md

@@ -0,0 +1,35 @@
+local value = redis.call('HGET', KEYS[1], KEYS[2]);
+if not value then value = "i|0" end
+
+local get_prefix = function (redis_value)
+    local prefix_end = redis_value:find("|")
+    return prefix_end, redis_value:sub(1, prefix_end-1)
+end
+
+local value_prefix_end, value_prefix = get_prefix(value)
+if not value_prefix_end then
+    return string.format("ValueError|received malformed value from keys %s %s: `%s`", KEYS[1], KEYS[1], value)
+end
+
+local increment = ARGV[1]
+local incr_prefix_end, incr_prefix = get_prefix(increment)
+if not incr_prefix_end then
+    return string.format("ValueError|received malformed increment value: `%s`", increment)
+end
+
+local valid_prefixes = "if"
+local valid_values = valid_prefixes:match(value_prefix) and valid_prefixes:match(incr_prefix)
+if not valid_values then
+    return string.format("TypeError|cannot increment value `%s` with `%s`.", value, ARGV[1])
+end
+
+local new_value = value:sub(value_prefix_end+1) + increment:sub(incr_prefix_end+1)
+local result
+if incr_prefix..value_prefix == "ii" then
+    result = string.format("i|%d", new_value)
+else
+    result = string.format("f|%s", tostring(new_value))
+end
+
+redis.call("HSET", KEYS[1], KEYS[2], result)
+return result

async_rediscache/redis_scripts/__init__.py

@@ -0,0 +1,3 @@
+local popped_value = redis.call('HGET', KEYS[1], KEYS[2])
+redis.call('HDEL', KEYS[1], KEYS[2])
+return popped_value

async_rediscache/redis_scripts/rediscache_increment.lua

@@ -0,0 +1,17 @@
+local queue_size = redis.call("LLEN", KEYS[2])
+local client_tasks = redis.call("LRANGE", KEYS[2], 0, queue_size)
+
+-- For Lua version compatibility, try picking the right version of unpack
+local unpack_function
+if unpack == nil then
+  unpack_function = table.unpack
+else
+  unpack_function = unpack
+end
+
+if queue_size > 0 then
+  redis.call("RPUSH", KEYS[1], unpack_function(client_tasks))
+end
+
+redis.call("DEL", KEYS[2])
+return queue_size

async_rediscache/redis_scripts/rediscache_pop.lua

@@ -0,0 +1,6 @@
+local number_rescheduled = redis.call("LREM", KEYS[2], 1, ARGV[1])
+if number_rescheduled == 0 then
+    return redis.error_reply("Task not found in pending tasks queue.")
+end
+
+redis.call("LPUSH", KEYS[1], ARGV[1])