Transformable classes can now be bound by an interface instead of manually registering. Fixes dingo#34.

Signed-off-by: Jason Lewis <[email protected]>

Author: jasonlewis

src/Transformer/Factory.php

@@ -44,7 +44,7 @@ public function __construct(Container $container)
 	 * Register a transformer binding resolver for a class.
 	 * 
 	 * @param  string  $class
-	 * @param  string|callable  $resolver
+	 * @param  string|callable|object  $resolver
 	 * @return \Dingo\Api\Transformer\Factory
 	 */
 	public function transform($class, $resolver)
@@ -75,7 +75,7 @@ public function transformResponse($response)
 	 */
 	public function transformableResponse($response)
 	{
-		return $this->transformableType($response) and $this->hasBinding($response);
+		return $this->transformableType($response) and ($this->hasBinding($response) or $this->boundByContract($response));
 	}
 
 	/**
@@ -92,7 +92,7 @@ public function transformableType($value)
 	/**
 	 * Resolve a transfomer binding instance.
 	 * 
-	 * @param  string|callable  $resolver
+	 * @param  string|callable|object  $resolver
 	 * @return mixed
 	 */
 	protected function resolveTransformerBinding($resolver)
@@ -101,15 +101,19 @@ protected function resolveTransformerBinding($resolver)
 		{
 			return $this->container->make($resolver);
 		}
-
-		return call_user_func($resolver, $this->container);
+		elseif (is_callable($resolver))
+		{
+			return call_user_func($resolver, $this->container);
+		}
+		
+		return $resolver;
 	}
 
 	/**
 	 * Get a registered transformer binding.
 	 * 
 	 * @param  string|object  $class
-	 * @return string|callable
+	 * @return string|callable|object
 	 * @throws \RuntimeException
 	 */
 	protected function getBinding($class)
@@ -119,6 +123,11 @@ protected function getBinding($class)
 			return $this->getBindingFromCollection($class);
 		}
 
+		if ($this->boundByContract($class))
+		{
+			return $class->getTransformer();
+		}
+
 		$class = is_object($class) ? get_class($class) : $class;
 
 		if ( ! $this->hasBinding($class))
@@ -158,6 +167,17 @@ protected function hasBinding($class)
 		return isset($this->bindings[$class]);
 	}
 
+	/**
+	 * Determine if the class is bound by the transformable contract.
+	 * 
+	 * @param  string|object  $class
+	 * @return bool
+	 */
+	protected function boundByContract($class)
+	{
+		return is_object($class) and $class instanceof TransformableInterface;
+	}
+
 	/**
 	 * Determine if the instance is a collection.
 	 * 

src/Transformer/TransformableInterface.php

@@ -0,0 +1,12 @@
+<?php namespace Dingo\Api\Transformer;
+
+interface TransformableInterface {
+
+	/**
+	 * Get the transformer instance.
+	 * 
+	 * @return mixed
+	 */
+	public function getTransformer();
+
+}

tests/TransformerFactoryTest.php

@@ -36,8 +36,9 @@ public function testDeterminingIfResponseIsTransformable()
 		$this->assertFalse($this->transformerFactory->transformableResponse(false));
 		$this->assertFalse($this->transformerFactory->transformableResponse(31.1));
 		$this->assertFalse($this->transformerFactory->transformableResponse(new Illuminate\Support\Collection([new Foo, new Foo])));
-		$this->transformerFactory->transform('Foo', 'Bar');
+		$this->transformerFactory->transform('Foo', 'FooTransformerStub');
 		$this->assertTrue($this->transformerFactory->transformableResponse('Foo'));
+		$this->assertTrue($this->transformerFactory->transformableResponse(new Bar));
 		$this->assertTrue($this->transformerFactory->transformableResponse(new Illuminate\Support\Collection([new Foo, new Foo])));
 	}
 

tests/TransformerFractalTransformerTest.php

@@ -63,7 +63,6 @@ public function testTransformingCollectionUsingCallback()
 	public function testTransformingNestedRelationships()
 	{
 		$this->transformerFactory->transform('Bar', 'BarTransformerStub');
-		$this->container->shouldReceive('make')->once()->with('BarTransformerStub')->andReturn(new BarTransformerStub);
 		$this->transformerFactory->setRequest(Illuminate\Http\Request::create('/', 'GET', ['include' => 'foo']));
 		$this->assertEquals(['data' => ['bar' => 'baz', 'foo' => ['data' => ['foo' => 'bar']]], 'embeds' => ['foo']], $this->transformerFactory->transformResponse(new Bar));
 	}

tests/stubs.php

@@ -136,10 +136,12 @@ public function embedFoo(Bar $bar)
 }
 
 class Foo {
-	
-}
-
-class Bar {
 
 }
 
+class Bar implements Dingo\Api\Transformer\TransformableInterface  {
+	public function getTransformer()
+	{
+		return new BarTransformerStub;
+	}
+}