Merge abea769 into c3d4381

wavevision · Oct 30, 2020 · d426033 · d426033
2 parents c3d4381 + abea769
commit d426033
Show file tree

Hide file tree

Showing 8 changed files with 34 additions and 23 deletions.
diff --git a/src/PropsControl/Helpers/ClassName.php b/src/PropsControl/Helpers/ClassName.php
@@ -17,14 +17,16 @@ class ClassName
 
 	public const PROP = 'className';
 
+	private const BLOCK_DELIMITER = '-';
+
 	private const ELEMENT_DELIMITER = '__';
 
 	private const MODIFIER_DELIMITER = '--';
 
-	private const SUB_BLOCK_DELIMITER = '-';
-
 	private string $baseClass;
 
+	private string $blockDelimiter;
+
 	private string $elementDelimiter;
 
 	private string $modifierDelimiter;
@@ -34,15 +36,13 @@ class ClassName
 	 */
 	private $modifiersCallback;
 
-	private string $subBlockDelimiter;
-
 	public function __construct(string $baseClass, ?callable $modifiersCallback = null)
 	{
 		$this->baseClass = $baseClass;
+		$this->blockDelimiter = self::BLOCK_DELIMITER;
 		$this->elementDelimiter = self::ELEMENT_DELIMITER;
 		$this->modifierDelimiter = self::MODIFIER_DELIMITER;
 		$this->modifiersCallback = $modifiersCallback;
-		$this->subBlockDelimiter = self::SUB_BLOCK_DELIMITER;
 	}
 
 	public function block(?string ...$modifiers): string
@@ -53,10 +53,10 @@ public function block(?string ...$modifiers): string
 		return $this->composeClassNames($this->baseClass, $modifiers);
 	}
 
-	public function create(string $baseClass, bool $subBlock = true, bool $excludeModifiers = false): self
+	public function create(string $baseClass, bool $block = true, bool $excludeModifiers = false): self
 	{
-		if ($subBlock) {
-			$baseClass = $this->baseClass . $this->subBlockDelimiter . $baseClass;
+		if ($block) {
+			$baseClass = $this->baseClass . $this->blockDelimiter . $baseClass;
 		}
 		return new self($baseClass, $excludeModifiers ? null : $this->modifiersCallback);
 	}
@@ -69,7 +69,7 @@ public function element(string $className, ?string ...$modifiers): string
 	public function extra(string $className, string $prefix = ''): string
 	{
 		if ($prefix !== '') {
-			return $prefix . $this->subBlockDelimiter . $className;
+			return $prefix . $this->blockDelimiter . $className;
 		}
 		return $className;
 	}
@@ -79,21 +79,21 @@ public function getBaseClass(): string
 		return $this->baseClass;
 	}
 
-	public function setElementDelimiter(string $elementDelimiter): self
+	public function setBlockDelimiter(string $blockDelimiter): self
 	{
-		$this->elementDelimiter = $elementDelimiter;
+		$this->blockDelimiter = $blockDelimiter;
 		return $this;
 	}
 
-	public function setModifierDelimiter(string $modifierDelimiter): self
+	public function setElementDelimiter(string $elementDelimiter): self
 	{
-		$this->modifierDelimiter = $modifierDelimiter;
+		$this->elementDelimiter = $elementDelimiter;
 		return $this;
 	}
 
-	public function setSubBlockDelimiter(string $subBlockDelimiter): self
+	public function setModifierDelimiter(string $modifierDelimiter): self
 	{
-		$this->subBlockDelimiter = $subBlockDelimiter;
+		$this->modifierDelimiter = $modifierDelimiter;
 		return $this;
 	}
 

diff --git a/src/PropsControl/Helpers/PropTypes.php b/src/PropsControl/Helpers/PropTypes.php
@@ -24,9 +24,7 @@ public static function booleans(string ...$props): array
 		/** @var array<string, Schema> $booleans */
 		$booleans = Arrays::mapKeysFromValues(
 			$props,
-			function (string $prop): array {
-				return [$prop, Expect::bool(false)];
-			}
+			fn(string $prop): array => [$prop, Expect::bool(false)]
 		);
 		return $booleans;
 	}

diff --git a/src/PropsControl/PropsControl.php b/src/PropsControl/PropsControl.php
@@ -28,6 +28,8 @@ abstract class PropsControl extends BaseControl
 
 	private const CLASS_NAME = ClassName::PROP;
 
+	private const DEFINITION = 'definition';
+
 	private const MODIFIERS = 'modifiers';
 
 	private const PROPS = 'props';
@@ -50,6 +52,7 @@ public function __construct()
 			function (Template $template): void {
 				$template->setParameters(
 					[
+						self::DEFINITION => $this->getProps(),
 						self::CLASS_NAME => $this->createClassName(),
 						self::STYLE => new Style(),
 					]
@@ -135,6 +138,9 @@ final public function getProps(): Props
 		return $this->createProps($props ? (array)$props : []);
 	}
 
+	/**
+	 * @return class-string<Props>
+	 */
 	abstract protected function getPropsClass(): string;
 
 	protected function beforeMapPropsToTemplate(ValidProps $props): void

diff --git a/src/PropsControl/PropsControlTemplate.php b/src/PropsControl/PropsControlTemplate.php
@@ -11,6 +11,8 @@ class PropsControlTemplate extends Template
 
 	public ClassName $className;
 
+	public Props $definition;
+
 	/**
 	 * @var string[]
 	 */

diff --git a/tests/PropsControlTests/Components/InvalidComponent.php b/tests/PropsControlTests/Components/InvalidComponent.php
@@ -9,7 +9,7 @@ class InvalidComponent extends PropsControl
 
 	protected function getPropsClass(): string
 	{
-		return '';
+		return ''; // @phpstan-ignore-line
 	}
 
 }
diff --git a/tests/PropsControlTests/Components/TestComponent/TestComponent.php b/tests/PropsControlTests/Components/TestComponent/TestComponent.php
@@ -65,6 +65,9 @@ protected function beforeRender(ValidProps $props): void
 		// do stuff before component is rendered
 	}
 
+	/**
+	 * @return class-string<TestComponentProps>
+	 */
 	protected function getPropsClass(): string
 	{
 		return TestComponentProps::class;

diff --git a/tests/PropsControlTests/Components/TestComponent/templates/default.latte b/tests/PropsControlTests/Components/TestComponent/templates/default.latte
@@ -1,9 +1,11 @@
+{templateType Wavevision\PropsControl\PropsControlTemplate}
+{varType Wavevision\PropsControlTests\Components\TestComponent\TestComponentProps $definition}
 <div n:class="$className->block()" n:attr="style => $style">
 	<div n:class="$className->element(first-child)">
-		{$props->string}
+		{$props->get($definition::STRING)}
 	</div>
-	<div n:class="$className->element(collection)" n:inner-foreach="$props->collection as $item">
-		<p>{$item->one} / {$item->two}</p>
+	<div n:class="$className->element(collection)" n:inner-foreach="$props->get($definition::COLLECTION) as $item">
+		<p>{$item->{$definition::TYPE_ONE}} / {$item->{$definition::TYPE_TWO}}</p>
 	</div>
 	{var $partClassName = $className->create(part)}
 	<div n:class="$partClassName->block()" n:inner-foreach="[1,2,3,4,5] as $part">

diff --git a/tests/PropsControlTests/Helpers/ClassNameTest.php b/tests/PropsControlTests/Helpers/ClassNameTest.php
@@ -30,7 +30,7 @@ public function testCreate(): void
 		$this->assertInstanceOf(ClassName::class, $sub2);
 		$this->assertInstanceOf(ClassName::class, $sub1->setElementDelimiter(''));
 		$this->assertInstanceOf(ClassName::class, $sub1->setModifierDelimiter(''));
-		$this->assertInstanceOf(ClassName::class, $sub1->setSubBlockDelimiter(''));
+		$this->assertInstanceOf(ClassName::class, $sub1->setBlockDelimiter(''));
 	}
 
 	public function testElement(): void