diff --git a/.editorconfig b/.editorconfig new file mode 100644 index 0000000..5919005 --- /dev/null +++ b/.editorconfig @@ -0,0 +1,17 @@ +root = true + +# 对所有文件生效 +[*] +charset = utf-8 +indent_style = space +indent_size = 2 +end_of_line = lf +insert_final_newline = true +trim_trailing_whitespace = true + +# 对后缀名为 md 的文件生效 +[*.md] +trim_trailing_whitespace = false + +[*.php] +indent_size = 4 diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..86318a0 --- /dev/null +++ b/.gitignore @@ -0,0 +1,10 @@ +.idea/ +.phpintel/ +!README.md +!.gitkeep +composer.lock +*.swp +*.log +*.pid +*.patch +.DS_Store diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..261eeb9 --- /dev/null +++ b/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/README.md b/README.md new file mode 100644 index 0000000..6dcd18a --- /dev/null +++ b/README.md @@ -0,0 +1,44 @@ +# data parser + +simple data parser for php + +driver + +- json(by `json_encode`) +- php(by `serialize`) +- swoole(by extension `swoole_serialize`) +- msgpack(by extension `msgpack`) + +## Install + +- composer command + +```bash +composer require swoft/data-parser +``` + +## Usage + +```php +$parser = new SwooleParser(); +// $parser = new JsonParser(); +// $parser = new PhpParser(); +// $parser = new MsgPackParser(); + +// encode +$encoded = $parser->encode($data); + +// decode +$decoded = $parser->encode($encoded); +``` + +## Unit testing + +```bash +phpunit +``` + +## LICENSE + +The Component is open-sourced software licensed under the [Apache license](LICENSE). + diff --git a/composer.json b/composer.json new file mode 100644 index 0000000..88a2035 --- /dev/null +++ b/composer.json @@ -0,0 +1,28 @@ +{ + "name": "swoft/data-parser", + "type": "library", + "description": "simple data parser tool library of the php", + "keywords": ["library","tool","php"], + "homepage": "https://github.com/swoft-cloud/swoft-parser", + "license": "Apache-2.0", + "authors": [ + { + "name": "inhere", + "email": "in.798@qq.com", + "homepage": "http://www.yzone.net/" + } + ], + "require": { + "php": ">7.0.0" + }, + "autoload": { + "psr-4": { + "Swoft\\DataParser\\" : "src/" + } + }, + "autoload-dev": { + "psr-4": { + "SwoftTest\\DataParser\\": "test/" + } + } +} diff --git a/phpunit.xml.dist b/phpunit.xml.dist new file mode 100644 index 0000000..910a2ed --- /dev/null +++ b/phpunit.xml.dist @@ -0,0 +1,24 @@ + + + + + + test/ + + + + + + src + + + diff --git a/src/DataParserAwareTrait.php b/src/DataParserAwareTrait.php new file mode 100644 index 0000000..e753fcc --- /dev/null +++ b/src/DataParserAwareTrait.php @@ -0,0 +1,36 @@ + + */ +trait DataParserAwareTrait +{ + /** + * @var ParserInterface + */ + private $parser; + + /** + * @return ParserInterface + */ + public function getParser(): ParserInterface + { + if (!$this->parser) { + $this->parser = new PhpParser(); + } + + return $this->parser; + } + + /** + * @param ParserInterface $parser + */ + public function setParser(ParserInterface $parser) + { + $this->parser = $parser; + } +} diff --git a/src/JsonParser.php b/src/JsonParser.php new file mode 100644 index 0000000..2d89331 --- /dev/null +++ b/src/JsonParser.php @@ -0,0 +1,67 @@ + + */ +class JsonParser implements ParserInterface +{ + /** + * @var bool + */ + protected $assoc = true; + + /** + * JsonParser constructor. + * @param null $assoc + */ + public function __construct($assoc = null) + { + if ($assoc !== null) { + $this->setAssoc($assoc); + } + } + + /** + * @param string $data + * @return mixed + */ + public function decode(string $data) + { + return \json_decode($data, $this->assoc); + } + + /** + * @param mixed $data + * @return string + */ + public function encode($data): string + { + return \json_encode($data); + } + + /** + * @return bool + */ + public function isAssoc(): bool + { + return $this->assoc; + } + + /** + * @param bool $assoc + */ + public function setAssoc($assoc) + { + $this->assoc = (bool)$assoc; + } +} diff --git a/src/MsgPackParser.php b/src/MsgPackParser.php new file mode 100644 index 0000000..50753e1 --- /dev/null +++ b/src/MsgPackParser.php @@ -0,0 +1,40 @@ + + */ +class MsgPackParser implements ParserInterface +{ + /** + * class constructor. + * @throws \RuntimeException + */ + public function __construct() + { + if (!\function_exists('msgpack_pack')) { + throw new \RuntimeException("The php extension 'msgpack' is required!"); + } + } + + /** + * @param mixed $data + * @return string + */ + public function encode($data): string + { + return \msgpack_pack($data); + } + + /** + * @param string $data + * @return mixed + */ + public function decode(string $data) + { + return \msgpack_unpack($data); + } +} diff --git a/src/ParserInterface.php b/src/ParserInterface.php new file mode 100644 index 0000000..f4ddf43 --- /dev/null +++ b/src/ParserInterface.php @@ -0,0 +1,29 @@ + + */ +interface ParserInterface +{ + /** + * @param mixed $data + * @return string + */ + public function encode($data): string; + + /** + * @param string $data + * @return mixed + */ + public function decode(string $data); +} diff --git a/src/PhpParser.php b/src/PhpParser.php new file mode 100644 index 0000000..ab53934 --- /dev/null +++ b/src/PhpParser.php @@ -0,0 +1,35 @@ + + */ +class PhpParser implements ParserInterface +{ + /** + * @param mixed $data + * @return string + */ + public function encode($data): string + { + return \serialize($data); + } + + /** + * @param string $data + * @return mixed + */ + public function decode(string $data) + { + return \unserialize($data, ['allowed_classes' => false]); + } +} diff --git a/src/SwooleParser.php b/src/SwooleParser.php new file mode 100644 index 0000000..e992976 --- /dev/null +++ b/src/SwooleParser.php @@ -0,0 +1,43 @@ + + * @link https://wiki.swoole.com/wiki/page/p-serialize.html + */ +class SwooleParser implements ParserInterface +{ + /** + * class constructor. + * @throws \RuntimeException + */ + public function __construct() + { + if (!\class_exists(Serialize::class, false)) { + throw new \RuntimeException("The php extension 'swoole_serialize' is required!"); + } + } + + /** + * @param mixed $data + * @return string + */ + public function encode($data): string + { + return (string)Serialize::pack($data); + } + + /** + * @param string $data + * @return mixed + */ + public function decode(string $data) + { + return Serialize::unpack($data); + } +} diff --git a/test/JsonParserTest.php b/test/JsonParserTest.php new file mode 100644 index 0000000..f29a06e --- /dev/null +++ b/test/JsonParserTest.php @@ -0,0 +1,37 @@ +decode($str); + + $this->assertInternalType('array', $ret); + $this->assertArrayHasKey('name', $ret); + } + + public function testEncode() + { + $data = [ + 'name' => 'value', + ]; + + $parser = new JsonParser(); + $ret = $parser->encode($data); + + $this->assertInternalType('string', $ret); + $this->assertJson($ret); + } +} diff --git a/test/PhpParserTest.php b/test/PhpParserTest.php new file mode 100644 index 0000000..aff39e3 --- /dev/null +++ b/test/PhpParserTest.php @@ -0,0 +1,37 @@ +decode($str); + + $this->assertInternalType('array', $ret); + $this->assertArrayHasKey('name', $ret); + } + + public function testEncode() + { + $data = [ + 'name' => 'value', + ]; + + $parser = new PhpParser(); + $ret = $parser->encode($data); + + $this->assertInternalType('string', $ret); + $this->assertStringStartsWith('a:1:{', $ret); + } +} diff --git a/test/boot.php b/test/boot.php new file mode 100644 index 0000000..14bdf76 --- /dev/null +++ b/test/boot.php @@ -0,0 +1,27 @@ +