Merge pull request #1 from petrknap/encoders

Coders with support for base64 and zlib

Author: petrknap

.github/FUNDING.yaml

@@ -0,0 +1 @@
+custom: https://petrknap.github.io/donate.html

.github/workflows/docker.yaml

@@ -0,0 +1,13 @@
+name: composer ci-script
+
+on:
+  pull_request:
+
+jobs:
+  run:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - run: docker build -t $GITHUB_REPOSITORY:$GITHUB_SHA .
+      - name: Run composer ci-script
+        run: docker run $GITHUB_REPOSITORY:$GITHUB_SHA composer ci-script

.github/workflows/linter-docker.yaml

@@ -0,0 +1,17 @@
+name: Docker Linter
+
+on:
+  pull_request:
+    paths:
+      - 'Dockerfile'
+      - '**/Dockerfile'
+      - '**.dockerfile'
+
+jobs:
+  HaskellDockerfileLinter:
+    runs-on: ubuntu-latest
+    container:
+      image: hadolint/hadolint:latest-alpine
+    steps:
+      - uses: actions/checkout@v3
+      - run: find . -name 'Dockerfile' -or -name '*.dockerfile' | xargs -trn 1 hadolint

.github/workflows/linter-php.yaml

@@ -0,0 +1,15 @@
+name: PHP Linter
+
+on:
+  pull_request:
+    paths:
+      - '**.php'
+
+jobs:
+  PHP:
+    runs-on: ubuntu-latest
+    container:
+      image: php:8.1-cli-alpine
+    steps:
+      - uses: actions/checkout@v3
+      - run: find . -name '*.php' | xargs -trn 1 php -l

.gitignore

@@ -0,0 +1,3 @@
+/bin/
+/vendor/
+/composer.lock

.molireali

@@ -0,0 +1,9 @@
+authors
+composer PetrKnap\\Binary
+dockerfile php 8.1-cli
+docker-scripts petrknap/php-binary
+donation
+github-workflow docker "composer ci-script"
+github-workflow linter-docker
+github-workflow linter-php 8.1
+license LGPL-3.0-or-later

AUTHORS

@@ -0,0 +1,3 @@
+# This is the official list of authors for copyright purposes.
+
+Petr Knap <[email protected]>

COPYING

@@ -0,0 +1,165 @@
+                   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

COPYING.LESSER

@@ -0,0 +1,24 @@
+FROM php:8.1-cli
+
+# region included composer
+# hadolint ignore=DL3008
+RUN apt-get update \
+ && apt-get install -y --no-install-recommends \
+      git \
+      unzip \
+ && php -r "copy('https://getcomposer.org/installer', 'composer-setup.php');" \
+ && php -r "copy('https://composer.github.io/installer.sig', 'composer-setup.php.sig');" \
+ && php -r "if (trim(hash_file('SHA384', 'composer-setup.php')) === trim(file_get_contents('composer-setup.php.sig'))) { echo 'Installer verified' . PHP_EOL; exit(0); } else { echo 'Installer corrupt' . PHP_EOL; unlink('composer-setup.php'); unlink('composer-setup.php.sig'); exit(-1); }" \
+ && php composer-setup.php \
+ && php -r "unlink('composer-setup.php'); unlink('composer-setup.php.sig');" \
+ && mv composer.phar /usr/local/bin/composer \
+ && apt-get clean \
+ && rm -rf /var/lib/apt/lists/* \
+;
+# endregion
+
+# region included composer-library
+WORKDIR /app
+COPY . .
+RUN composer update --prefer-lowest
+# endregion

Dockerfile

@@ -1 +1,20 @@
-# php-binary
+# Library for work with binaries
+
+Library for basic work with binary data in PHP.
+See the sample below for more information, or check out [`CoderInterface`](./src/CoderInterface.php).
+
+```php
+use PetrKnap\Binary\Binary;
+
+$data = base64_decode('hmlpFnFwbchsoQARSibVpfbWVfuwAHLbGxjFl9eC8fiGaWkWcXBtyGyhABFKJtWl9tZV+7AActsbGMWX14Lx+A==');
+$encoded = Binary::encode($data)->zlib()->base64(urlSafe: true)->getData();
+$decoded = Binary::decode($encoded)->base64()->zlib()->getData();
+
+printf('Data was coded into `%s` %s.', $encoded, $decoded === $data ? 'successfully' : 'unsuccessfully');
+```
+
+---
+
+Run `composer require petrknap/binary` to install it.
+You can [support this project via donation](https://petrknap.github.io/donate.html).
+The project is licensed under [the terms of the `LGPL-3.0-or-later`](./COPYING.LESSER).

README.md

@@ -0,0 +1,64 @@
+{
+  "WARNING": "This file is updated automatically. All keys will be overwritten, except of 'conflict', 'keywords', 'require', 'require-dev', 'scripts' and 'suggest'.",
+  "autoload": {
+    "psr-4": {
+      "PetrKnap\\Binary\\": "src"
+    }
+  },
+  "autoload-dev": {
+    "psr-4": {
+      "PetrKnap\\Binary\\": "tests"
+    }
+  },
+  "config": {
+    "allow-plugins": false,
+    "sort-packages": true
+  },
+  "description": "Library for work with binaries",
+  "funding": [
+    {
+      "type": "other",
+      "url": "https://petrknap.github.io/donate.html"
+    }
+  ],
+  "homepage": "https://github.com/petrknap/php-binary",
+  "keywords": [
+    "binary",
+    "helper",
+    "base64",
+    "encoder",
+    "decoder",
+    "zlib",
+    "compression",
+    "decompression"
+  ],
+  "license": "LGPL-3.0-or-later",
+  "name": "petrknap/binary",
+  "require": {
+    "php": ">=8.1"
+  },
+  "require-dev": {
+    "ext-zlib": "*",
+    "nunomaduro/phpinsights": "^2.11",
+    "petrknap/shorts": "^1.3",
+    "phpstan/phpstan": "^1.10",
+    "phpunit/phpunit": "^10.5",
+    "squizlabs/php_codesniffer": "^3.7"
+  },
+  "scripts": {
+    "test": "phpunit --colors=always --testdox tests",
+    "validate": [
+      "phpcs --colors --standard=PSR12 --exclude=PSR12.Files.OpenTag,PSR12.Files.FileHeader,Generic.Files.LineLength src tests",
+      "phpstan analyse --level max src",
+      "phpstan analyse --level 5 tests",
+      "phpinsights analyse src --ansi --no-interaction"
+    ],
+    "ci-script": [
+      "@validate",
+      "@test"
+    ]
+  },
+  "suggest": {
+    "ext-zlib": "Required to compress data"
+  }
+}

composer.json

@@ -0,0 +1,18 @@
+<?php
+
+declare(strict_types=1);
+
+namespace PetrKnap\Binary;
+
+final class Binary
+{
+    public static function encode(string $data): Encoder
+    {
+        return new Encoder($data);
+    }
+
+    public static function decode(string $data): Decoder
+    {
+        return new Decoder($data);
+    }
+}

src/Binary.php

@@ -0,0 +1,33 @@
+<?php
+
+declare(strict_types=1);
+
+namespace PetrKnap\Binary;
+
+/**
+ * @phpstan-consistent-constructor override {@see self::create()} if not
+ *
+ * @implements CoderInterface<Exception\CouldNotCodeData>
+ */
+abstract class Coder implements CoderInterface
+{
+    protected const BASE64_URL_SAFE_MAP = [
+        ['+', '/', '='],
+        ['-', '_', ''],
+    ];
+
+    public function __construct(
+        protected readonly string $data,
+    ) {
+    }
+
+    public function getData(): string
+    {
+        return $this->data;
+    }
+
+    protected static function create(self $coder, string $data): static
+    {
+        return new static($data);
+    }
+}