Skip to content

Commit afa516e

Browse files
azjezzazjezz
committed
Initial commit
0 parents  commit afa516e

20 files changed

+528
-0
lines changed

‎.gitattributes

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
*.hack linguist-language=Hack
2+
3+
/tests export-ignore
4+
/docs export-ignore
5+
.travis.sh export-ignore
6+
.travis.yml export-ignore

‎.gitignore

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
composer.lock
2+
vendor/
3+
*.hhast.parser-cache

‎.hhconfig

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
assume_php=false
2+
safe_array = true
3+
safe_vector_array = true
4+
unsafe_rx = false
5+
ignored_paths = [ "vendor/.+/tests/.+", "vendor/.+/bin/.+" ]

‎.travis.sh

+30
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
#!/bin/sh
2+
set -ex
3+
apt update -y
4+
DEBIAN_FRONTEND=noninteractive apt install -y php-cli zip unzip
5+
hhvm --version
6+
php --version
7+
if [ ! -e .git/refs/heads/master ]; then
8+
# - Travis clones with `--branch`, then moves to a detached HEAD state
9+
# - if we're on a detached HEAD, Composer uses master to resolve branch
10+
# aliases.
11+
# So, create the master branch :p
12+
git branch master HEAD
13+
fi
14+
15+
(
16+
cd $(mktemp -d)
17+
curl https://getcomposer.org/installer | php -- --install-dir=/usr/local/bin --filename=composer
18+
)
19+
20+
if (hhvm --version | grep -q -- -dev); then
21+
# Doesn't exist in master, but keep it here so that we can test release
22+
# branches on nightlies too
23+
rm -f composer.lock
24+
fi
25+
26+
composer --version
27+
28+
composer install
29+
30+
composer check

‎.travis.yml

+18
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
sudo: false
2+
dist: trusty
3+
language: generic
4+
services: docker
5+
env:
6+
- HHVM_VERSION=4.25-latest
7+
- HHVM_VERSION=latest
8+
- HHVM_VERSION=nightly
9+
matrix:
10+
allow_failures:
11+
- env: HHVM_VERSION=nightly
12+
install:
13+
- docker pull hhvm/hhvm:$HHVM_VERSION
14+
script:
15+
- docker run --rm -w /var/source -v $(pwd):/var/source hhvm/hhvm:$HHVM_VERSION ./.travis.sh
16+
notifications:
17+
slack:
18+
secure: fZ74Yt9xxelrIZiWBe74X6zCNV+RCbI2aD0EjB8P6d3ovIdyHc+JOe/AFDwUwU8tuKBYt1DpiMnw/rFQQwu2Y6CQnAjgGtG+ScCCVhy5OJvHqFTmMt/XMs9Hrgdylak3IofaI6D/4Du+E9ZMXHgXGVgjQQr0SNMsj1s70sSd97oiW4t4Kn5hxlAbZK7EWCs2BWwyTtVJD96UOEJrBK59lD0wQvfv0wSV948Wwnms70cPgO26Fa+pdBGsv4Ho475Dzu/y4JuO/kqMMzodZtMSm7FNDrppwqgX3qYkfGBI/foQ5IpBn5gGcG5w3RhZLXsNhLDrULcEHtF1Ptfo5PQGUArN8KPRf91Mju2CGICg3wy6GMEm+iXHdPWzUkCaQPhw4ty6ix+fm2ELatXW4BGGXANJzL6UNUGuQPh4Z2oVeX8zEFpUAA+PJRzd6FPYdQDdI3Xj8P445x/KQ+Mg4f2wCR/YKTkjWbkYKzqvjvssgrDGkbQfhXWAOr5/NgKj0/vRovT66Tra14UncjZdM6yHUOqeMq5KfDboEBXoj7+jZG1cQmtSErUoFF2CUyI/Jqva7symsJbjOYSVTKv6BAgoL+CncdLcTPGFLzavLiavkqp4Gd3ErWoeOWqFY0ZYByY4cLcnwLtL0TrY6Y9fdzFeJLmN6xhxTteuw3Ils66K/fw=

‎LICENSE

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2018-2019 Saif Eddin Gmati
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

‎README.md

+52
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
<p align="center"><img src="https://avatars3.githubusercontent.com/u/45311177?s=200&v=4"></p>
2+
3+
<p align="center">
4+
<a href="https://travis-ci.org/nuxed/json"><img src="https://travis-ci.org/nuxed/json.svg" alt="Build Status"></a>
5+
<a href="https://packagist.org/packages/nuxed/json"><img src="https://poser.pugx.org/nuxed/json/d/total.svg" alt="Total Downloads"></a>
6+
<a href="https://packagist.org/packages/nuxed/json"><img src="https://poser.pugx.org/nuxed/json/v/stable.svg" alt="Latest Stable Version"></a>
7+
<a href="https://packagist.org/packages/nuxed/json"><img src="https://poser.pugx.org/nuxed/json/license.svg" alt="License"></a>
8+
</p>
9+
10+
# Nuxed Json
11+
12+
Nuxed Json provides functions that help you encode, and decode json structures safely.
13+
14+
### Installation
15+
16+
This package can be installed with [Composer](https://getcomposer.org).
17+
18+
```console
19+
$ composer require nuxed/json
20+
```
21+
22+
### Example
23+
24+
```hack
25+
use namespace Nuxed\Json;
26+
use namespace Facebook\TypeSpec;
27+
28+
<<__EntryPoint>>
29+
async function main(): void {
30+
$data = Json\encode(dict[
31+
'foo' => 5,
32+
'bar' => 6
33+
]);
34+
35+
// $decoded is dict<string, int>
36+
$decoded = Json\spec($data, TypeSpec\dict(
37+
TypeSpec\string(), TypeSpec\int();
38+
));
39+
}
40+
```
41+
42+
---
43+
44+
### Security
45+
46+
For information on reporting security vulnerabilities in Nuxed Json, see [SECURITY.md](SECURITY.md).
47+
48+
---
49+
50+
### License
51+
52+
The Nuxed Json library is open-sourced software licensed under the MIT-licensed.

‎SECURITY.md

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# Security
2+
3+
If you discover a security vulnerability within Nuxed Json, please send an e-mail to Saif Eddin Gmati via [email protected].
4+
5+
Please withhold public disclosure until after we have addressed the vulnerability.
6+
7+
There are no hard and fast rules to determine if a bug is worth reporting as a security issue.

‎composer.json

+45
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
{
2+
"name": "nuxed/json",
3+
"type": "library",
4+
"description": "Nuxed Json - Encode, and Decode Json Safely",
5+
"license": "MIT",
6+
"keywords": [
7+
"nuxed",
8+
"hhvm",
9+
"hack",
10+
"json",
11+
"type-assert",
12+
"type-spec",
13+
"type-safety",
14+
"encoding"
15+
],
16+
"authors": [
17+
{
18+
"name": "azjezz",
19+
"email": "[email protected]"
20+
},
21+
{
22+
"name": "Nuxed Community",
23+
"homepage": "https://github.com/nuxed/json/graphs/contributors"
24+
}
25+
],
26+
"require": {
27+
"hhvm": "^4.25",
28+
"hhvm/type-assert": "^3.6"
29+
},
30+
"require-dev": {
31+
"facebook/fbexpect": "^2.7",
32+
"hhvm/hacktest": "^1.6",
33+
"hhvm/hhast": "^4.25"
34+
},
35+
"scripts": {
36+
"check": [
37+
"@type-check",
38+
"@lint",
39+
"@test"
40+
],
41+
"lint": "hhast-lint -v src/",
42+
"test": "hacktest tests/",
43+
"type-check": "hh_client src/"
44+
}
45+
}

‎hh_autoload.json

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
{
2+
"roots": [
3+
"src/"
4+
],
5+
"devRoots": [
6+
"tests/"
7+
],
8+
"devFailureHandler": "Facebook\\AutoloadMap\\HHClientFallbackHandler"
9+
}

‎hhast-lint.json

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
{
2+
"roots": [ "src/" ],
3+
"builtinLinters": "all",
4+
"disableAllAutoFixes": false,
5+
"disabledLinters": [
6+
"Facebook\\HHAST\\Linters\\AsyncFunctionAndMethodLinter"
7+
],
8+
"overrides": []
9+
}

‎src/Nuxed/Json/Errors.hack

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
namespace Nuxed\Json;
2+
3+
const dict<int, string> Errors = dict[
4+
\JSON_ERROR_NONE => 'No error',
5+
\JSON_ERROR_DEPTH => 'Maximum stack depth exceeded',
6+
\JSON_ERROR_STATE_MISMATCH => 'State mismatch (invalid or malformed JSON)',
7+
\JSON_ERROR_CTRL_CHAR =>
8+
'Control character error, possibly incorrectly encoded',
9+
\JSON_ERROR_SYNTAX => 'Syntax error',
10+
\JSON_ERROR_UTF8 =>
11+
'Malformed UTF-8 characters, possibly incorrectly encoded',
12+
\JSON_ERROR_INF_OR_NAN => 'Inf and NaN cannot be JSON encoded',
13+
\JSON_ERROR_UNSUPPORTED_TYPE =>
14+
'A value of a type that cannot be encoded was given',
15+
];

‎src/Nuxed/Json/Exception/IException.hack

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
namespace Nuxed\Json\Exception;
2+
3+
<<__Sealed(JsonDecodeException::class, JsonEncodeException::class)>>
4+
interface IException {
5+
require extends \Exception;
6+
}

‎src/Nuxed/Json/Exception/JsonDecodeException.hack

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
namespace Nuxed\Json\Exception;
2+
3+
final class JsonDecodeException
4+
extends \InvalidArgumentException
5+
implements IException {
6+
}

‎src/Nuxed/Json/Exception/JsonEncodeException.hack

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
namespace Nuxed\Json\Exception;
2+
3+
final class JsonEncodeException
4+
extends \InvalidArgumentException
5+
implements IException {
6+
}

‎src/Nuxed/Json/decode.hack

+30
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
namespace Nuxed\Json;
2+
3+
/**
4+
* Decode a json encoded string into a dynamic variable.
5+
*/
6+
function decode(string $json, bool $assoc = true): dynamic {
7+
try {
8+
$value = \json_decode(
9+
$json,
10+
$assoc,
11+
512,
12+
\JSON_BIGINT_AS_STRING | \JSON_FB_HACK_ARRAYS,
13+
);
14+
} catch (\Throwable $e) {
15+
// assoc = true & invalid property name results in `\Error`
16+
// we catch `\Throwable` to be safe, in case hhvm decided to change the error
17+
// to an exception in the future.
18+
throw new Exception\JsonDecodeException(
19+
$e->getMessage(),
20+
(int)$e->getCode(),
21+
);
22+
}
23+
24+
$error = \json_last_error();
25+
if (\JSON_ERROR_NONE !== $error) {
26+
throw new Exception\JsonDecodeException(Errors[$error], $error);
27+
}
28+
29+
return $value;
30+
}

‎src/Nuxed/Json/encode.hack

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
namespace Nuxed\Json;
2+
3+
/**
4+
* Decode a json encoded string into a dynamic variable.
5+
*/
6+
function encode(mixed $value, bool $pretty = false, int $flags = 0): string {
7+
$flags |= \JSON_UNESCAPED_UNICODE |
8+
\JSON_UNESCAPED_SLASHES |
9+
\JSON_PRESERVE_ZERO_FRACTION;
10+
if ($pretty) {
11+
$flags |= \JSON_PRETTY_PRINT;
12+
}
13+
14+
$json = \json_encode($value, $flags);
15+
$error = \json_last_error();
16+
if (\JSON_ERROR_NONE !== $error) {
17+
throw new Exception\JsonEncodeException(Errors[$error], $error);
18+
}
19+
20+
return $json;
21+
}

‎src/Nuxed/Json/spec.hack

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
namespace Nuxed\Json;
2+
3+
use namespace Facebook\{TypeAssert, TypeSpec};
4+
5+
/**
6+
* Decoded a json encoded string, and assert, or coerce the type to the provided type spec.
7+
*/
8+
function spec<T>(string $json, TypeSpec\TypeSpec<T> $spec): T {
9+
$value = decode($json);
10+
try {
11+
return $spec->assertType($value);
12+
} catch (TypeAssert\IncorrectTypeException $e) {
13+
return $spec->coerceType($value);
14+
} catch (TypeAssert\TypeCoercionException $e) {
15+
throw new Exception\JsonDecodeException(
16+
$e->getMessage(),
17+
$e->getCode(),
18+
$e,
19+
);
20+
}
21+
}

‎src/Nuxed/Json/structure.hack

+18
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
namespace Nuxed\Json;
2+
3+
use namespace Facebook\TypeAssert;
4+
5+
/**
6+
* Decode a json encoded string and match the provided type structure.
7+
*/
8+
function structure<T>(string $json, TypeStructure<T> $structure): T {
9+
try {
10+
return TypeAssert\matches_type_structure($structure, decode($json));
11+
} catch (TypeAssert\IncorrectTypeException $e) {
12+
throw new Exception\JsonDecodeException(
13+
$e->getMessage(),
14+
$e->getCode(),
15+
$e,
16+
);
17+
}
18+
}

0 commit comments

Comments
 (0)