Skip to content

Commit

Permalink
Initial commit
Browse files Browse the repository at this point in the history
  • Loading branch information
kelunik committed Jul 7, 2017
0 parents commit 3c92079
Show file tree
Hide file tree
Showing 10 changed files with 290 additions and 0 deletions.
8 changes: 8 additions & 0 deletions .editorconfig
@@ -0,0 +1,8 @@
root = true

[*]
end_of_line = lf
insert_final_newline = true
trim_trailing_whitespace = true
indent_style = spaces
charset = utf-8
4 changes: 4 additions & 0 deletions .gitignore
@@ -0,0 +1,4 @@
/.php_cs.cache
/composer.lock
/coverage
/vendor
39 changes: 39 additions & 0 deletions .php_cs.dist
@@ -0,0 +1,39 @@
<?php

return PhpCsFixer\Config::create()
->setRiskyAllowed(true)
->setRules([
"@PSR1" => true,
"@PSR2" => true,
"braces" => [
"allow_single_line_closure" => true,
"position_after_functions_and_oop_constructs" => "same",
],
"array_syntax" => ["syntax" => "short"],
"cast_spaces" => true,
"combine_consecutive_unsets" => true,
"function_to_constant" => true,
"no_multiline_whitespace_before_semicolons" => true,
"no_unused_imports" => true,
"no_useless_else" => true,
"no_useless_return" => true,
"no_whitespace_before_comma_in_array" => true,
"no_whitespace_in_blank_line" => true,
"non_printable_character" => true,
"normalize_index_brace" => true,
"ordered_imports" => true,
"php_unit_construct" => true,
"php_unit_dedicate_assert" => true,
"php_unit_fqcn_annotation" => true,
"phpdoc_summary" => true,
"phpdoc_types" => true,
"psr4" => true,
"return_type_declaration" => ["space_before" => "none"],
"short_scalar_cast" => true,
"single_blank_line_before_namespace" => true,
])
->setFinder(
PhpCsFixer\Finder::create()
->in(__DIR__ . "/src")
->in(__DIR__ . "/test")
);
29 changes: 29 additions & 0 deletions .travis.yml
@@ -0,0 +1,29 @@
sudo: false

language: php

php:
- 7.0
- 7.1
- nightly

matrix:
allow_failures:
- php: nightly
fast_finish: true

before_script:
# --ignore-platform-reqs, because https://github.com/FriendsOfPHP/PHP-CS-Fixer/pull/2722
- composer update -n --prefer-dist --ignore-platform-reqs
- composer require satooshi/php-coveralls dev-master --ignore-platform-reqs

script:
- phpdbg -qrr vendor/bin/phpunit --coverage-text --coverage-clover build/logs/clover.xml
- PHP_CS_FIXER_IGNORE_ENV=1 php vendor/bin/php-cs-fixer --diff --dry-run -v fix

after_script:
- php vendor/bin/coveralls -v

cache:
directories:
- $HOME/.composer/cache/files
22 changes: 22 additions & 0 deletions LICENSE
@@ -0,0 +1,22 @@

The MIT License (MIT)

Copyright (c) 2017 Niklas Keller

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
31 changes: 31 additions & 0 deletions README.md
@@ -0,0 +1,31 @@
# streaming-base64

[![Build Status](https://img.shields.io/travis/kelunik/streaming-base64/master.svg?style=flat-square)](https://travis-ci.org/kelunik/streaming-base64)
[![CoverageStatus](https://img.shields.io/coveralls/kelunik/streaming-base64/master.svg?style=flat-square)](https://coveralls.io/github/kelunik/streaming-base64?branch=master)
![License](https://img.shields.io/badge/license-MIT-blue.svg?style=flat-square)

`kelunik/streaming-base64` is a streaming Base64 encoder / decoder for Amp's streams.

## Installation

This package can be installed as a [Composer](https://getcomposer.org/) dependency.

```bash
composer require kelunik/streaming-base64
```

## Requirements

- PHP 7.0+

## Versioning

`kelunik/streaming-base64` follows the [semver](http://semver.org/) semantic versioning specification.

## Security

If you discover any security related issues, please email [`me@kelunik.com`](mailto:me@kelunik.com) instead of using the issue tracker.

## License

The MIT License (MIT). Please see [`LICENSE`](./LICENSE) for more information.
25 changes: 25 additions & 0 deletions composer.json
@@ -0,0 +1,25 @@
{
"name": "kelunik/streaming-base64",
"description": "On the fly Base64 encoding for Amp's streams.",
"type": "library",
"license": "MIT",
"authors": [
{
"name": "Niklas Keller",
"email": "me@kelunik.com"
}
],
"autoload": {
"psr-4": {
"Kelunik\\StreamingBase64\\": "src"
}
},
"require": {
"amphp/byte-stream": "^1.1",
"amphp/phpunit-util": "^1.0"
},
"require-dev": {
"phpunit/phpunit": "^6",
"friendsofphp/php-cs-fixer": "^2.3"
}
}
31 changes: 31 additions & 0 deletions phpunit.xml.dist
@@ -0,0 +1,31 @@
<?xml version="1.0" encoding="UTF-8"?>
<phpunit
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="http://schema.phpunit.de/6.0/phpunit.xsd"
backupGlobals="false"
backupStaticAttributes="false"
bootstrap="vendor/autoload.php"
colors="true"
convertErrorsToExceptions="true"
convertNoticesToExceptions="true"
convertWarningsToExceptions="true"
processIsolation="false"
stopOnFailure="false"
>
<testsuites>
<testsuite name="Main">
<directory>test</directory>
</testsuite>
<testsuite name="PHPT tests">
<directory suffix=".phpt">test</directory>
</testsuite>
</testsuites>
<filter>
<whitelist>
<directory suffix=".php">src</directory>
</whitelist>
</filter>
<listeners>
<listener class="Amp\PHPUnit\LoopReset"/>
</listeners>
</phpunit>
65 changes: 65 additions & 0 deletions src/EncodingInputStream.php
@@ -0,0 +1,65 @@
<?php

namespace Kelunik\StreamingBase64;

use Amp\ByteStream\InputStream;
use Amp\Promise;
use function Amp\call;

class EncodingInputStream implements InputStream {
const TYPE_BASE64 = 0;
const TYPE_BASE64URL = 1;

private $source;
private $type;
private $buffer;

public function __construct(InputStream $source, int $type = self::TYPE_BASE64) {
$this->source = $source;
$this->type = $type;
$this->buffer = "";
}

/** @inheritdoc */
public function read(): Promise {
return call(function () {
if ($this->buffer === null) {
return null;
}

$data = yield $this->source->read();

if ($data === null) {
$buffer = $this->buffer;

$this->buffer = null;
$this->source = null;

if ($buffer !== "") {
if ($this->type === self::TYPE_BASE64) {
return \base64_encode($buffer);
} else {
return \rtrim(\strtr(\base64_encode($buffer), "+/", "-_"), "=");
}
}

return null;
}

$this->buffer .= $data;
$length = \strlen($this->buffer);
$buffer = \substr($this->buffer, 0, $length - $length % 3);
$this->buffer = \substr($this->buffer, $length - $length % 3);

if ($buffer !== "") {
if ($this->type === self::TYPE_BASE64) {
return \base64_encode($buffer);
} else {
return \strtr(\base64_encode($buffer), "+/", "-_");
}
}

return "";
});
}
}
36 changes: 36 additions & 0 deletions test/EncodingInputStreamTest.php
@@ -0,0 +1,36 @@
<?php

namespace Kelunik\StreamingBase64\Test;

use Amp\ByteStream\IteratorStream;
use Amp\ByteStream\Message;
use Amp\Loop;
use Amp\PHPUnit\TestCase;
use Kelunik\StreamingBase64\EncodingInputStream;
use function Amp\Iterator\fromIterable;

class EncodingInputStreamTest extends TestCase {
public function testBase64() {
Loop::run(function () {
$array = [\random_bytes(16), \random_bytes(1), \random_bytes(23)];
$stream = new IteratorStream(fromIterable($array, 10));

$encodingStream = new EncodingInputStream($stream, EncodingInputStream::TYPE_BASE64);
$result = yield new Message($encodingStream);

$this->assertSame(\base64_encode(\implode("", $array)), $result);
});
}

public function testBase64Url() {
Loop::run(function () {
$array = [\random_bytes(16), \random_bytes(1), \random_bytes(23)];
$stream = new IteratorStream(fromIterable($array, 10));

$encodingStream = new EncodingInputStream($stream, EncodingInputStream::TYPE_BASE64URL);
$result = yield new Message($encodingStream);

$this->assertSame(\rtrim(\strtr(\base64_encode(\implode("", $array)), "+/", "-_"), "="), $result);
});
}
}

0 comments on commit 3c92079

Please sign in to comment.