diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml new file mode 100644 index 0000000..f7a5a0b --- /dev/null +++ b/.github/workflows/tests.yml @@ -0,0 +1,48 @@ +name: tests + +on: + push: + branches: [ main ] + pull_request: + branches: [ main ] + +jobs: + build: + + runs-on: ubuntu-latest + + strategy: + fail-fast: false + matrix: + php-version: [ '8.3', '8.4' ] + + name: Tests on PHP ${{ matrix.php-version }} + + steps: + - name: Checkout + uses: actions/checkout@v4 + + - name: Setup PHP + uses: shivammathur/setup-php@v2 + with: + php-version: ${{ matrix.php-version }} + coverage: none + + - name: Validate composer.json and composer.lock + run: composer validate + + - name: Cache Composer packages + id: composer-cache + uses: actions/cache@v4 + with: + path: vendor + key: ${{ runner.os }}-php-${{ matrix.php-version }}-${{ hashFiles('**/composer.lock') }} + restore-keys: | + ${{ runner.os }}-php-${{ matrix.php-version }}- + + - name: Install dependencies + if: steps.composer-cache.outputs.cache-hit != 'true' + run: composer i --prefer-dist --no-progress + + - name: Run test suite + run: vendor/bin/phpunit \ No newline at end of file diff --git a/Dockerfile b/Dockerfile new file mode 100644 index 0000000..4e19af6 --- /dev/null +++ b/Dockerfile @@ -0,0 +1,10 @@ +FROM php:latest + +RUN apt update +RUN apt install unzip curl -y + +RUN curl -sS https://getcomposer.org/installer -o /usr/local/composer-setup.php + +RUN php /usr/local/composer-setup.php --install-dir=/usr/local/bin --filename=composer + +RUN rm /usr/local/composer-setup.php diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..f49a4e1 --- /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. \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..62aae64 --- /dev/null +++ b/README.md @@ -0,0 +1,18 @@ +# Faker PHP - Symfony bundle + +This repository is a Symfony bundle that ensure compatibility and dependency injection for the [Faker package](https://github.com/xefi/faker-php). +Please refer to the [main package](https://github.com/xefi/faker-php) or the [documentation](https://faker-php.xefi.com/) to understand it well. + +# Configuration + +Once the package is required, you can configure the locale to use. +For this, simply create a `config/packages/xefi_faker.yaml` file, and fill it like this : +``` +xefi_faker_symfony: + locale: fr_FR +``` + +# Requirements + +PHP 8.3+ +Symfony 6.4+ \ No newline at end of file diff --git a/composer.json b/composer.json new file mode 100644 index 0000000..34ccd6d --- /dev/null +++ b/composer.json @@ -0,0 +1,46 @@ +{ + "name": "xefi/faker-php-symfony", + "version": "1.0.0", + "type": "symfony-bundle", + "description": "Faker PHP integration with Symfony", + "keywords": [ + "faker", + "data", + "seeding", + "fixtures", + "symfony" + ], + "license": "MIT", + "authors": [ + { + "name": "Martin Soenen" + } + ], + "require": { + "php": "^8.3", + "symfony/framework-bundle": "^6.4 || ^7.0 || ^7.1", + "symfony/yaml": "^6.4 || ^7.0 || ^7.1", + "xefi/faker-php": "^1" + }, + "require-dev": { + "phpunit/phpunit": "^11" + }, + "autoload": { + "psr-4": { + "Xefi\\Faker\\SymfonyBundle\\": "src/" + } + }, + "autoload-dev": { + "psr-4": { + "Xefi\\Faker\\SymfonyBundle\\Tests\\": "tests/" + } + }, + "config": { + "sort-packages": true + }, + "extra": { + "branch-alias": { + "dev-main": "1.x-dev" + } + } +} diff --git a/config/services.yaml b/config/services.yaml new file mode 100644 index 0000000..d21fb74 --- /dev/null +++ b/config/services.yaml @@ -0,0 +1,3 @@ +services: + Xefi\Faker\Faker: + alias: xefi.faker \ No newline at end of file diff --git a/docker-compose.yml b/docker-compose.yml new file mode 100644 index 0000000..bee3307 --- /dev/null +++ b/docker-compose.yml @@ -0,0 +1,8 @@ +services: + php: + build: . + image: php:latest + volumes: + - ./:/var/www/html + working_dir: /var/www/html + tty: true \ No newline at end of file diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 0000000..3ff776b --- /dev/null +++ b/docs/index.md @@ -0,0 +1 @@ +The documentation is available in [https://faker-php.xefi.com](https://faker-php.xefi.com). \ No newline at end of file diff --git a/phpunit.xml b/phpunit.xml new file mode 100644 index 0000000..a354244 --- /dev/null +++ b/phpunit.xml @@ -0,0 +1,22 @@ + + + + + tests/Unit + + + + + src + + + + + \ No newline at end of file diff --git a/src/DependencyInjection/XefiFakerSymfonyExtension.php b/src/DependencyInjection/XefiFakerSymfonyExtension.php new file mode 100644 index 0000000..26ffbb4 --- /dev/null +++ b/src/DependencyInjection/XefiFakerSymfonyExtension.php @@ -0,0 +1,25 @@ +register('xefi.faker', Faker::class); + $faker->setPublic(true); + if (isset($configs[0]['locale'])) { + $faker->setArgument('$locale', $configs[0]['locale']); + } + + // services.yaml + $loader = new YamlFileLoader($container, new FileLocator(__DIR__.'/../../config')); + $loader->load('services.yaml'); + } +} \ No newline at end of file diff --git a/src/XefiFakerSymfonyBundle.php b/src/XefiFakerSymfonyBundle.php new file mode 100644 index 0000000..27efcb5 --- /dev/null +++ b/src/XefiFakerSymfonyBundle.php @@ -0,0 +1,40 @@ +container->getParameter('kernel.project_dir'); + $cacheDir = $this->container->getParameter('kernel.cache_dir'); + + Container::basePath(sprintf('%s/', $projectDir)); + Container::packageManifestPath(sprintf('%s/faker-packages.php', $cacheDir)); + Container::containerMixinManifestPath(sprintf('%s/vendor/xefi/faker-php/src/Container/ContainerMixin.php', $projectDir)); + } + + public function build(ContainerBuilder $container): void + { + $container->registerExtension(new XefiFakerSymfonyExtension()); + } + + public function configure(DefinitionConfigurator $definition): void + { + $definition->rootNode() + ->children() + ->arrayNode('xefi_faker') + ->children() + ->integerNode('locale')->defaultNull()->end() + ->end() + ->end() + ->end() + ; + } +} \ No newline at end of file diff --git a/tests/Unit/TestCase.php b/tests/Unit/TestCase.php new file mode 100644 index 0000000..447a100 --- /dev/null +++ b/tests/Unit/TestCase.php @@ -0,0 +1,7 @@ +load($configs, $container); + + $this->assertTrue($container->has('xefi.faker')); + + $definition = $container->getDefinition('xefi.faker'); + $this->assertSame(Faker::class, $definition->getClass()); + + $arguments = $definition->getArguments(); + $this->assertArrayNotHasKey('$locale', $arguments); + } + + public function testServiceIsLoadedWithLocaleConfiguration(): void + { + $container = new ContainerBuilder(); + $extension = new XefiFakerSymfonyExtension(); + + $configs = [['locale' => 'fr_FR']]; + + $extension->load($configs, $container); + + $this->assertTrue($container->has('xefi.faker')); + + $definition = $container->getDefinition('xefi.faker'); + $this->assertSame(Faker::class, $definition->getClass()); + + $arguments = $definition->getArguments(); + $this->assertArrayHasKey('$locale', $arguments); + $this->assertEquals('fr_FR', $arguments['$locale']); + } +}