Initial import

Author: clue

.gitignore

@@ -0,0 +1,2 @@
+/vendor
+/composer.lock

.travis.yml

@@ -0,0 +1,9 @@
+language: php
+php:
+  - 5.3
+  - 5.6
+  - hhvm
+install:
+  - composer install --prefer-source --no-interaction
+script:
+  - phpunit --coverage-text

LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Christian Lück
+
+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.

README.md

@@ -0,0 +1,52 @@
+# clue/tar-react [![Build Status](https://travis-ci.org/clue/php-tar-react.svg?branch=master)](https://travis-ci.org/clue/php-tar-react)
+
+Async, streaming parser for the [TAR file format](https://en.wikipedia.org/wiki/Tar_%28computing%29) (Tape ARchive),
+built on top of [React PHP](http://reactphp.org/).
+
+Implements UStar (Uniform Standard Tape ARchive) format, introduced by the POSIX IEEE P1003.1
+
+> Note: This project is in early alpha stage! Feel free to report any issues you encounter.
+
+## Quickstart example
+
+Once [installed](#install), you can use the following code to pipe a readable
+tar stream into the `Decoder` which emits "entry" events for each individual file:
+
+```php
+$loop = React\EventLoop\Factory::create();
+$stream = new Stream(fopen('archive.tar', 'r'), $loop);
+
+$decoder = new Decoder();
+
+$decoder->on('entry', function ($header, ReadableStreamInterface $file) {
+    echo 'File ' . $header['filename'] . ' 
+    echo $header['size'] . ' bytes:' . PHP_EOL;
+    
+    $file->on('data', function ($chunk) {
+        echo $chunk;
+    });
+});
+
+$stream->pipe($decoder);
+
+$loop->run();
+```
+
+See also the [examples](examples).
+
+## Install
+
+The recommended way to install this library is [through composer](https://getcomposer.org).
+[New to composer?](https://getcomposer.org/doc/00-intro.md)
+
+```JSON
+{
+    "require": {
+        "clue/tar-react": "dev-master"
+    }
+}
+```
+
+## License
+
+MIT

composer.json

@@ -0,0 +1,25 @@
+{
+    "name": "clue/tar-react",
+    "description": "Async, streaming parser for the TAR file format (Tape ARchive), built on top of React PHP",
+    "keywords": ["tar", "archive", "parser", "decoder", "extractor", "unpacker", "ReactPHP", "async"],
+    "homepage": "https://github.com/clue/php-tar-react",
+    "license": "MIT",
+    "authors": [
+        {
+            "name": "Christian Lück",
+            "email": "christian@lueck.tv"
+        }
+    ],
+    "require": {
+        "php": ">=5.3",
+        "react/stream": "~0.4.0|~0.3.0"
+    },
+    "require-dev": {
+        "react/event-loop": "~0.4.0|~0.3.0",
+        "react/promise": "~2.0|~1.0",
+        "clue/hexdump": "~0.2.0"
+    },
+    "autoload": {
+        "psr-4": { "Clue\\React\\Tar\\": "src/" }
+    }
+}

examples/dump.php

@@ -0,0 +1,46 @@
+<?php
+
+use React\Stream\Stream;
+use React\EventLoop\Factory;
+use Clue\React\Tar\Decoder;
+use React\Stream\BufferedSink;
+use Clue\Hexdump\Hexdump;
+use React\EventLoop\StreamSelectLoop;
+
+require __DIR__ . '/../vendor/autoload.php';
+
+$in = isset($argv[1]) ? $argv[1] : (__DIR__ . '/../tests/fixtures/alice-bob.tar');
+echo 'Reading file "' . $in . '" (pass as argument to example)' . PHP_EOL;
+
+// using the default loop does *not* work for file I/O
+//$loop = Factory::create();
+$loop = new StreamSelectLoop();
+
+$stream = new Stream(fopen($in, 'r'), $loop);
+
+$decoder = new Decoder();
+$decoder->on('entry', function ($header, $file) {
+    static $i = 0;
+    echo 'FILE #' . ++$i . PHP_EOL;
+
+
+    echo 'Received entry headers:' . PHP_EOL;
+    var_dump($header);
+
+    BufferedSink::createPromise($file)->then(function ($contents) {
+        echo 'Received entry contents (' . strlen($contents) . ' bytes)' . PHP_EOL;
+
+        $d = new Hexdump();
+        echo $d->dump($contents) . PHP_EOL . PHP_EOL;
+    });
+});
+$decoder->on('error', function ($error) {
+    echo 'ERROR: ' . $error . PHP_EOL;
+});
+$decoder->on('close', function() {
+    echo 'CLOSED' . PHP_EOL;
+});
+
+$stream->pipe($decoder);
+
+$loop->run();

phpunit.xml.dist

@@ -0,0 +1,19 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<phpunit bootstrap="tests/bootstrap.php"
+         colors="true"
+         convertErrorsToExceptions="true"
+         convertNoticesToExceptions="true"
+         convertWarningsToExceptions="true"
+>
+    <testsuites>
+        <testsuite name="Tar React Test Suite">
+            <directory>./tests/</directory>
+        </testsuite>
+    </testsuites>
+    <filter>
+        <whitelist>
+            <directory>./src/</directory>
+        </whitelist>
+    </filter>
+</phpunit>