Merge pull request #34 from guiwoda/sluggable-validate-on-build

Validate if slug field exists on build instead of on construction

Author: patrickbrouwers

src/Extensions/Gedmo/Sluggable.php

@@ -2,7 +2,7 @@
 
 namespace LaravelDoctrine\Fluent\Extensions\Gedmo;
 
-use Doctrine\Common\Persistence\Mapping\ClassMetadata;
+use Doctrine\ORM\Mapping\ClassMetadataInfo;
 use Gedmo\Exception\InvalidArgumentException;
 use Gedmo\Sluggable\Mapping\Driver\Fluent as FluentDriver;
 use LaravelDoctrine\Fluent\Buildable;
@@ -95,8 +95,6 @@ class Sluggable implements Buildable, Extension
      */
     public function __construct(ExtensibleClassMetadata $classMetadata, $fieldName, $fields)
     {
-        $this->isValidField($classMetadata, $fieldName);
-
         $this->classMetadata = $classMetadata;
         $this->fieldName     = $fieldName;
         $this->baseOn($fields);
@@ -127,6 +125,8 @@ public static function enable()
      */
     public function build()
     {
+        $this->isValidField($this->classMetadata, $this->fieldName);
+
         $this->classMetadata->appendExtension($this->getExtensionName(), [
             'slugs' => [
                 $this->fieldName => $this->makeConfiguration()
@@ -247,13 +247,13 @@ public function suffix($suffix)
     /**
      * Checks if $field type is valid as Sluggable field
      *
-     * @param ClassMetadata $meta
-     * @param string        $field
+     * @param ClassMetadataInfo $meta
+     * @param string            $field
      *
      * @throws InvalidArgumentException
      * @return bool
      */
-    protected function isValidField(ClassMetadata $meta, $field)
+    protected function isValidField(ClassMetadataInfo $meta, $field)
     {
         $mapping = $meta->getFieldMapping($field);
 

tests/Extensions/Gedmo/SluggableTest.php

@@ -3,16 +3,23 @@
 
 use Doctrine\ORM\Mapping\Builder\ClassMetadataBuilder;
 use Gedmo\Exception\InvalidArgumentException;
+use LaravelDoctrine\Fluent\Builders\Builder;
 use LaravelDoctrine\Fluent\Builders\Field;
 use LaravelDoctrine\Fluent\Extensions\ExtensibleClassMetadata;
 use Gedmo\Sluggable\Mapping\Driver\Fluent as SluggableDriver;
 use LaravelDoctrine\Fluent\Extensions\Gedmo\Sluggable;
+use Tests\Stubs\Entities\StubEntity;
 
 /**
  * @mixin \PHPUnit_Framework_TestCase
  */
 class SluggableTest extends \PHPUnit_Framework_TestCase
 {
+    /**
+     * @var ClassMetadataBuilder
+     */
+    private $classMetadataBuilder;
+
     /**
      * @var string
      */
@@ -30,18 +37,16 @@ class SluggableTest extends \PHPUnit_Framework_TestCase
 
     protected function setUp()
     {
-        $this->fieldName     = 'slug';
-        $this->classMetadata = new ExtensibleClassMetadata('foo');
-        Field::make(new ClassMetadataBuilder($this->classMetadata), 'string', 'slug')->build();
-
-        $this->extension     = new Sluggable($this->classMetadata, $this->fieldName, 'name');
+        $this->fieldName = 'slug';
+        $this->classMetadata = new ExtensibleClassMetadata(StubEntity::class);
+        $this->classMetadataBuilder = new ClassMetadataBuilder($this->classMetadata);
     }
 
     public function test_it_should_add_itself_as_a_field_macro()
     {
         Sluggable::enable();
 
-        $field = Field::make(new ClassMetadataBuilder(new ExtensibleClassMetadata('Foo')), 'string', $this->fieldName)->build();
+        $field = Field::make(new ClassMetadataBuilder($this->classMetadata), 'string', $this->fieldName)->build();
 
         $this->assertInstanceOf(
             Sluggable::class,
@@ -55,13 +60,40 @@ public function test_can_only_make_a_valid_field_sluggable()
 
         Sluggable::enable();
 
-        $field = Field::make(new ClassMetadataBuilder(new ExtensibleClassMetadata('Foo')), 'smallint', $this->fieldName)->build();
+        $field = Field::make($this->classMetadataBuilder, 'bigint', $this->fieldName);
         call_user_func([$field, Sluggable::MACRO_METHOD], 'name');
+        $field->build();
     }
 
+    public function test_it_queues_when_used_as_field_macro_so_that_the_field_gets_built_before_the_extension()
+    {
+    	Sluggable::enable();
+
+        $builder = new Builder($this->classMetadataBuilder);
+
+        $builder->string('title');
+        $builder->string('slug')->sluggable('title');
+
+        $builder->build();
+
+        $this->assertBuildResultIs([
+            'fields'      => ['title'],
+            'handlers'    => [],
+            'slug'        => $this->fieldName,
+            'style'       => 'default',
+            'dateFormat'  => 'Y-m-d-H:i',
+            'updatable'   => true,
+            'unique'      => true,
+            'unique_base' => null,
+            'separator'   => '-',
+            'prefix'      => '',
+            'suffix'      => ''
+        ]);
+    }
 
     public function test_it_should_add_sluggable_to_the_given_field()
     {
+        $this->classMetadataBuilder->addField('slug', 'string');
         $this->getExtension()->build();
 
         $this->assertBuildResultIs([
@@ -81,6 +113,8 @@ public function test_it_should_add_sluggable_to_the_given_field()
 
     public function test_can_set_custom_settingss()
     {
+        $this->classMetadataBuilder->addField('slug', 'string');
+
         $this->getExtension()
              ->baseOn('custom')
              ->handlers('Handler')
@@ -146,7 +180,7 @@ protected function assertBuildResultIs(array $expected)
      */
     protected function getExtension()
     {
-        return $this->extension;
+        return new Sluggable($this->classMetadata, $this->fieldName, 'name');
     }
 
     /**

tests/Stubs/Entities/StubEntity.php

@@ -4,5 +4,5 @@
 
 class StubEntity
 {
-    protected $id, $name, $parent, $children, $one, $many;
+    protected $id, $name, $parent, $children, $one, $many, $slug;
 }