✨ laravel integration

Author: GautierDele

.github/workflows/packagist-deploy.yml

@@ -0,0 +1,20 @@
+name: Packagist Deploy
+
+on:
+  release:
+    types: [created]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      packages: write
+
+    steps:
+      - uses: actions/checkout@v4
+      - uses: mnavarrocarter/[email protected]
+        with:
+          username: "GautierDele"
+          api_token: ${{ secrets.PACKAGIST_TOKEN }}

.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

.gitignore

@@ -0,0 +1,4 @@
+/vendor
+composer.lock
+.phpunit*
+.idea

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

composer.json

@@ -0,0 +1,51 @@
+{
+  "name": "xefi/faker-php-laravel",
+  "type": "library",
+  "description": "Faker php integration with laravel",
+  "keywords": [
+    "faker",
+    "data",
+    "seeding",
+    "fixtures",
+    "laravel"
+  ],
+  "license": "MIT",
+  "authors": [
+    {
+      "name": "Gautier Deleglise"
+    }
+  ],
+  "require": {
+    "orchestra/testbench": "^9.0",
+    "php": "^8.3",
+    "xefi/faker-php": "^0",
+    "illuminate/support": "^11.0",
+    "psr/container": "^2.0"
+  },
+  "require-dev": {
+    "phpunit/phpunit": "^11"
+  },
+  "autoload": {
+    "files": [
+      "src/helpers.php"
+    ],
+    "psr-4": {
+      "Xefi\\Faker\\Laravel\\": "src/"
+    }
+  },
+  "autoload-dev": {
+    "psr-4": {
+      "Xefi\\Faker\\Laravel\\Tests\\": "tests/"
+    }
+  },
+  "config": {
+    "sort-packages": true
+  },
+  "extra": {
+    "laravel": {
+      "providers": [
+        "Xefi\\Faker\\Laravel\\FakerLaravelServiceProvider"
+      ]
+    }
+  }
+}

docker-compose.yml

@@ -0,0 +1,8 @@
+services:
+  php:
+    build: .
+    image: php:latest
+    volumes:
+      - ./:/var/www/html
+    working_dir: /var/www/html
+    tty: true

phpunit.xml

@@ -0,0 +1,22 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:noNamespaceSchemaLocation="vendor/phpunit/phpunit/phpunit.xsd"
+         bootstrap="vendor/autoload.php"
+         colors="true"
+         displayDetailsOnTestsThatTriggerWarnings="true"
+         displayDetailsOnTestsThatTriggerDeprecations="true"
+         backupStaticProperties="true"
+>
+    <testsuites>
+        <testsuite name="Unit">
+            <directory>tests/Unit</directory>
+        </testsuite>
+    </testsuites>
+    <source>
+        <include>
+            <directory>src</directory>
+        </include>
+    </source>
+    <php>
+    </php>
+</phpunit>

src/FakerLaravelServiceProvider.php

@@ -0,0 +1,31 @@
+<?php
+
+use Illuminate\Contracts\Foundation\Application;
+use Illuminate\Support\Facades\Config;
+
+class FakerLaravelServiceProvider extends \Illuminate\Support\ServiceProvider
+{
+    /**
+     * Register the service provider.
+     *
+     * @return void
+     */
+    public function register(): void
+    {
+        $this->registerServices();
+    }
+
+    /**
+     * Register Rest's services in the container.
+     *
+     * @return void
+     */
+    protected function registerServices(): void
+    {
+        $this->app->singleton(Xefi\Faker\Faker::class, function (Application $app) {
+            return new Xefi\Faker\Faker(
+                Config::get('app.faker_locale')
+            );
+        });
+    }
+}

src/helpers.php

@@ -0,0 +1,19 @@
+<?php
+
+if (! function_exists('faker')) {
+    /**
+     * Get a faker instance.
+     *
+     * @param  string|null  $locale
+     */
+    function faker(string $locale = null) : \Xefi\Faker\Faker
+    {
+        if (app()->bound('config')) {
+            $locale ??= app('config')->get('app.faker_locale');
+        }
+
+        $locale ??= 'en_US';
+
+        return app()->makeWith(\Xefi\Faker\Faker::class, compact('locale'));
+    }
+}

tests/Unit/HelperTest.php

@@ -0,0 +1,14 @@
+<?php
+
+namespace Xefi\Faker\Laravel\Tests\Unit;
+
+use Xefi\Faker\Faker;
+
+class HelperTest extends TestCase
+{
+    public function testFakerHelper() {
+        $faker = faker();
+        
+        $this->assertInstanceOf(Faker::class, $faker);
+    }
+}