Provide a Faker Enum Provider Bridge #30

xavier-rdo · 2017-06-21T14:18:34Z

Fixes #29

Method enum(EnumAlias::VALUE) using pipes for flagged enums, e.g: enum(Permissions::WRITE|READ)
Method randomEnum(EnumAlias)
Unit tests for EnumProvider
Integration tests (loading Alice fixtures)
Update README, Integrations part

ogizanagi

Thanks for taking care of this 😃

ogizanagi · 2017-06-21T14:26:22Z

src/Bridge/Faker/Provider/EnumProvider.php

+
+        $reflectionEnum = new ReflectionClass($enumClass);
+
+        if (!$reflectionEnum->implementsInterface(EnumInterface::class)) {


Rather than using reflection, you can use is_a with third argument set to true.

Thanx for the tip !!!

ogizanagi · 2017-06-21T14:27:25Z

src/Bridge/Faker/Provider/EnumProvider.php

+     *
+     * ```
+     * [
+     *   'civility' => Civility::class,


I'd use capitalized aliases: Civility

ogizanagi · 2017-06-21T15:31:15Z

src/Bridge/Faker/Provider/EnumProvider.php

+    }
+
+    /**
+     * @param string $enumValueShortcut As <ENUM_CLASS_ALIAS::ENUM_VALUE_CONSTANT>


< and > is specific to Alice. it should not appear here.

Eh eh, < and > is just a convention for generic template masks but as a matter of fact, it can be ambiguous in an Alice/Fixture context.

ogizanagi · 2017-06-21T15:31:47Z

src/Bridge/Faker/Provider/EnumProvider.php

+        /** @var EnumInterface $class */
+        $class = $this->enumMapping[$classAlias];
+
+        $constants = explode('|', $constants);


Perhaps we should check if the enum class is an instance of FlaggedEnum to throw a nice exception otherwise

ogizanagi · 2017-06-21T15:33:21Z

src/Bridge/Faker/Provider/EnumProvider.php

+    private function ensureEnumClass(string $enumClass)
+    {
+        if (!class_exists($enumClass)) {
+            throw new \InvalidArgumentException("$enumClass class does not exist");


I think you can remove this check as is_a below will already trigger autoload.

ogizanagi · 2017-06-21T15:34:37Z

src/Bridge/Faker/Provider/EnumProvider.php

+        }
+
+        if (!is_a($enumClass, EnumInterface::class, true)) {
+            throw new \InvalidArgumentException("$enumClass is not a proper enum class");


You should use the one in the package (Elao\Enum\Exception\InvalidArgumentException)

xavier-rdo · 2017-06-22T07:34:47Z

tests/Unit/Bridge/Faker/Provider/EnumProviderTest.php

+<?php
+
+/*
+ * This file is part of the Jarvis - Elao website.


Jarvis ;( >> I will update my IDE config for this project

vendor/bin/php-cs-fixer fix

ogizanagi · 2017-06-22T09:48:14Z

src/Bridge/Faker/Provider/EnumProvider.php

+        $class = $this->enumMapping[$enumClassAlias];
+
+        $instances = $class::instances();
+        $randomRank = rand(0, count($instances) - 1);


Could you rather use mt_rand ?

ogizanagi · 2017-06-22T10:46:21Z

tests/Unit/Bridge/Faker/Provider/EnumProviderTest.php

+        $enumProvider = new EnumProvider($mapping);
+    }
+
+    public function provideErroneousEnumMapping(): array


diff --git a/tests/Unit/Bridge/Faker/Provider/EnumProviderTest.php b/tests/Unit/Bridge/Faker/Provider/EnumProviderTest.php index f0640fc..dcfa153 100644 --- a/tests/Unit/Bridge/Faker/Provider/EnumProviderTest.php +++ b/tests/Unit/Bridge/Faker/Provider/EnumProviderTest.php @@ -50,25 +50,22 @@ class EnumProviderTest extends \PHPUnit_Framework_TestCase */ public function testConstructorShouldFailWhenEnumClassIsIncorrect(array $mapping) { - $enumProvider = new EnumProvider($mapping); + new EnumProvider($mapping); } - public function provideErroneousEnumMapping(): array + public function provideErroneousEnumMapping() { - return [ + yield 'EnumProvider constructor with a class that does not exist' => [ [ - // Pass to EnumProvider constructor a class that does not exist - [ - 'Simple' => SimpleEnum::class, - 'Not-a-class' => '\UnexistingClass', - ], + 'Simple' => SimpleEnum::class, + 'Not-a-class' => '\UnexistingClass', ], + ]; + + yield 'EnumProvider constructor with a class that is not an Enum' => [ [ - // Pass to EnumProvider constructor a class that is not an Enum - [ - 'Simple' => SimpleEnum::class, - 'Not-an-enum' => \DateTime::class, - ], + 'Simple' => SimpleEnum::class, + 'Not-an-enum' => \DateTime::class, ], ]; }

ogizanagi

Just a minor diff to apply, and I think we're good to go. Thank you :)

chalasr

👍 Nice

xavier-rdo added Enhancement WIP labels Jun 21, 2017

xavier-rdo self-assigned this Jun 21, 2017

ogizanagi reviewed Jun 21, 2017

View reviewed changes

xavier-rdo force-pushed the feature/bridge-faker-provider branch 3 times, most recently from c5d4bb9 to c220f08 Compare June 21, 2017 15:20

ogizanagi reviewed Jun 21, 2017

View reviewed changes

xavier-rdo force-pushed the feature/bridge-faker-provider branch 6 times, most recently from d29c349 to d037be3 Compare June 22, 2017 07:33

xavier-rdo commented Jun 22, 2017

View reviewed changes

xavier-rdo force-pushed the feature/bridge-faker-provider branch from d037be3 to 5105219 Compare June 22, 2017 07:45

xavier-rdo added 2 commits June 22, 2017 09:46

Provide a Faker Enum Provider Bridge

5105219

[Composer] Add Nelmio/Alice lib to dev dependencies

dfd7eb9

xavier-rdo force-pushed the feature/bridge-faker-provider branch from 86a627b to bc2542a Compare June 22, 2017 08:54

Integration test for Bridge/Faker/EnumProvider

bc2542a

xavier-rdo force-pushed the feature/bridge-faker-provider branch 2 times, most recently from 7713f4f to ebf6a64 Compare June 22, 2017 09:31

README.md updated to mention the Faker Enum Provider bridge

ebf6a64

xavier-rdo added Ready To Review and removed WIP labels Jun 22, 2017

ogizanagi reviewed Jun 22, 2017

View reviewed changes

ogizanagi approved these changes Jun 22, 2017

View reviewed changes

xavier-rdo force-pushed the feature/bridge-faker-provider branch from 1bc8b63 to 4e96d48 Compare June 22, 2017 10:59

Faker enum provider bridge: some fixes after code review

4e96d48

chalasr approved these changes Jun 22, 2017

View reviewed changes

chalasr merged commit 92bb0e6 into master Jun 22, 2017

chalasr deleted the feature/bridge-faker-provider branch June 22, 2017 14:25

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Provide a Faker Enum Provider Bridge #30

Provide a Faker Enum Provider Bridge #30

xavier-rdo commented Jun 21, 2017 •

edited

ogizanagi left a comment

ogizanagi Jun 21, 2017

xavier-rdo Jun 21, 2017

ogizanagi Jun 21, 2017

ogizanagi Jun 21, 2017

xavier-rdo Jun 21, 2017 •

edited

ogizanagi Jun 21, 2017

ogizanagi Jun 21, 2017

ogizanagi Jun 21, 2017

xavier-rdo Jun 22, 2017 •

edited

ogizanagi Jun 22, 2017

ogizanagi Jun 22, 2017

ogizanagi Jun 22, 2017

ogizanagi left a comment

chalasr left a comment


		$reflectionEnum = new ReflectionClass($enumClass);

		if (!$reflectionEnum->implementsInterface(EnumInterface::class)) {

Provide a Faker Enum Provider Bridge #30

Provide a Faker Enum Provider Bridge #30

Conversation

xavier-rdo commented Jun 21, 2017 • edited

ogizanagi left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

xavier-rdo Jun 21, 2017 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

xavier-rdo Jun 22, 2017 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ogizanagi left a comment

Choose a reason for hiding this comment

chalasr left a comment

Choose a reason for hiding this comment

xavier-rdo commented Jun 21, 2017 •

edited

xavier-rdo Jun 21, 2017 •

edited

xavier-rdo Jun 22, 2017 •

edited