Added codec: klopf

dhondta · dhondta · commit 3142e3f3a8eb · 2021-09-25T10:51:16.000+02:00
diff --git a/README.md b/README.md
@@ -182,6 +182,7 @@ o
 `gzip` | text <-> Gzip-compressed text | standard Gzip compression/decompression
 `html` | text <-> HTML entities | implements entities according to [this reference](https://dev.w3.org/html5/html-author/charref)
 `ipsum` | text <-> latin words | aka lorem ipsum
+`klopf` | text <-> klopf encoded text | Polybius square with trivial alphabetical distribution
 `leetspeak` | text <-> leetspeak encoded text | based on minimalistic elite speaking rules
 `letter-indices` | text <-> text with letter indices | encodes consonants and/or vowels with their corresponding indices
 `manchester` | text <-> manchester encoded text | XORes each bit of the input with `01`
diff --git a/codext/stegano/__init__.py b/codext/stegano/__init__.py
@@ -1,4 +1,5 @@
 # -*- coding: UTF-8 -*-
+from .klopf import *
 from .resistor import *
 from .sms import *
 from .whitespace import *
diff --git a/codext/stegano/klopf.py b/codext/stegano/klopf.py
@@ -0,0 +1,24 @@
+# -*- coding: UTF-8 -*-
+"""Klopf Codec - Polybius-based content encoding.
+
+This codec:
+- en/decodes strings from str to str
+- en/decodes strings from bytes to bytes
+- decodes file content to str (read)
+- encodes file content from str to bytes (write)
+"""
+from ..__common__ import *
+
+
+__examples__ = {
+    'enc(klopf|klopfcode)': {'this is a test': "44324234 4234 11 44513444"},
+}
+
+
+ENCMAP = {"ABCDEFGHIKLMNOPQRSTUVWXYZ"[y*5+x]: "".join([str(x+1), str(y+1)]) for x in range(5) for y in range(5)}
+ENCMAP['J'] = "43"
+ENCMAP[' '] = " "
+
+
+add_map("klopf", ENCMAP, ignore_case="both", pattern=r"^(?:klopf(?:code)?)$", printables_rate=1.)
+
diff --git a/docs/enc/stegano.md b/docs/enc/stegano.md
@@ -2,6 +2,23 @@
 
 -----
 
+### Klopf Code
+
+This is a Polybius code with the trivial alphabetical distribution ("A" -> (1,1), "B" -> (2,1), ...). This can be tested [here](https://gc.de/gc/klopfcode/).
+
+**Codec** | **Conversions** | **Aliases** | **Comment**
+:---: | :---: | --- | ---
+`klopf` | text <-> klopf encoded text | `klopfcode` | 
+
+```python
+>>> codext.encode("this is a test", "klopf")
+'44324234 4234 11 44513444'
+>>> codext.decode("44324234 4234 11 44513444", "klopf")
+'THIS IS A TEST'
+```
+
+-----
+
 ### Resistor Color Codes
 
 This uses the [electronic color code](https://en.wikipedia.org/wiki/Electronic_color_code#Resistor_color-coding) to encode digits, displaying colors in the terminal with ANSI color codes.

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,5 @@`
`1`	`1`	`# -- coding: UTF-8 --`
	`2`	`+from .klopf import *`
`2`	`3`	`from .resistor import *`
`3`	`4`	`from .sms import *`
`4`	`5`	`from .whitespace import *`