Merge pull request #18 from 8fold/elemental

Deprecate: setVersion, setEncoding, setStandalone

Author: joshbruce

src/Callables/PropertyArrayToString.php

@@ -17,7 +17,6 @@ public function __invoke(string ...$properties): string
         foreach ($properties as $property) {
             $property = explode(' ', $property, 2);
             $b[] = $property[0] . '="' . $property[1] . '"';
-
         }
 
         return ' ' . implode(' ', $b);

src/Concatenate.php

@@ -4,29 +4,17 @@
 namespace Eightfold\XMLBuilder;
 
 use Eightfold\XMLBuilder\Contracts\Buildable;
+use Eightfold\XMLBuilder\Contracts\ContentWithoutElement;
 
 use Stringable;
 
 use Eightfold\XMLBuilder\Implementations\Buildable as BuildableImp;
+use Eightfold\XMLBuilder\Implementations\ContentWithoutElement as ContentWithoutElementImp;
 
-class Concatenate implements Buildable
+class Concatenate implements Buildable, ContentWithoutElement
 {
     use BuildableImp;
-
-    /**
-     * @var array<string|Stringable>
-     */
-    private array $content = [];
-
-    public static function create(string|Stringable ...$content): self
-    {
-        return new self(...$content);
-    }
-
-    final private function __construct(string|Stringable ...$content)
-    {
-        $this->content = $content;
-    }
+    use ContentWithoutElementImp;
 
     public function __toString(): string
     {

src/Contracts/ContentWithoutElement.php

@@ -0,0 +1,10 @@
+<?php
+
+namespace Eightfold\XMLBuilder\Contracts;
+
+use Stringable;
+
+interface ContentWithoutElement
+{
+    public static function create(string|Stringable ...$content): self;
+}

src/Document.php

@@ -4,12 +4,14 @@
 
 namespace Eightfold\XMLBuilder;
 
+use Eightfold\XMLBuilder\Contracts\Buildable;
+use Eightfold\XMLBuilder\Contracts\Contentable;
+
 use Stringable;
 
-use Eightfold\XMLBuilder\Callables\PropertyArrayToString;
+use Eightfold\XMLBuilder\Concatenate;
 
-use Eightfold\XMLBuilder\Contracts\Buildable;
-use Eightfold\XMLBuilder\Contracts\Contentable;
+use Eightfold\XMLBuilder\Callables\PropertyArrayToString;
 
 use Eightfold\XMLBuilder\Implementations\Properties as PropertiesImp;
 use Eightfold\XMLBuilder\Implementations\Buildable as BuildableImp;
@@ -27,14 +29,7 @@ class Document implements Buildable, Contentable
 
     private string $standalone = 'yes';
 
-    final private function __construct(
-        private string $name,
-        string|Stringable ...$content
-    ) {
-        $this->content  = $content;
-    }
-
-    public function setVersion(string|float|int $version): self
+    public function withVersion(string|float|int $version): self
     {
         if (is_int($version)) {
             $version = strval($version) . '.0';
@@ -43,24 +38,48 @@ public function setVersion(string|float|int $version): self
         return $this;
     }
 
-    public function setEncoding(string $encoding): self
+    /**
+     * @deprecated 1.4 Use `withVersion` instead.
+     */
+    public function setVersion(string|float|int $version): self
+    {
+        return $this->withVersion($version);
+    }
+
+    public function withEncoding(string $encoding): self
     {
         $this->encoding = $encoding;
         return $this;
     }
 
+    /**
+     * @deprecated 1.4 Use `withEncoding` instead.
+     */
+    public function setEncoding(string $encoding): self
+    {
+        return $this->withEncoding($encoding);
+    }
+
     public function removeEncoding(): self
     {
         $this->encoding = '';
         return $this;
     }
 
-    public function setStandalone(bool $standalone = true): self
+    public function withStandalone(bool $standalone): self
     {
         $this->standalone = ($standalone) ? 'yes' : 'no';
         return $this;
     }
 
+    /**
+     * @deprecated 1.4 Use `withStandalone` instead.
+     */
+    public function setStandalone(bool $standalone = true): self
+    {
+        return $this->withStandalone($standalone);
+    }
+
     public function removeStandalone(): self
     {
         $this->standalone = '';
@@ -83,7 +102,9 @@ public function __toString(): string
         $doctype =
             '<?xml' . PropertyArrayToString::convert(...$declarationProps) . ' ?>'
             . "\n";
-        return $doctype . $this->opening() . implode('', $this->content)
+        return $doctype
+            . $this->opening()
+            . Concatenate::create(...$this->content)
             . $this->closing();
     }
 

src/Element.php

@@ -4,11 +4,13 @@
 
 namespace Eightfold\XMLBuilder;
 
-use Stringable;
-
 use Eightfold\XMLBuilder\Contracts\Buildable;
 use Eightfold\XMLBuilder\Contracts\Contentable;
 
+use Stringable;
+
+use Eightfold\XMLBuilder\Concatenate;
+
 use Eightfold\XMLBuilder\Implementations\Properties as PropertiesImp;
 use Eightfold\XMLBuilder\Implementations\Buildable as BuildableImp;
 use Eightfold\XMLBuilder\Implementations\Contentable as ContentableImp;
@@ -21,13 +23,6 @@ class Element implements Buildable, Contentable
 
     private bool $omitEndTag = false;
 
-    final private function __construct(
-        private string $name,
-        string|Stringable ...$content
-    ) {
-        $this->content = $content;
-    }
-
     public function omitEndTag(): static
     {
         $this->omitEndTag = true;
@@ -42,7 +37,9 @@ protected function omitEndTagClosingString(): string
 
     public function __toString(): string
     {
-        return $this->opening() . implode('', $this->content) . $this->closing();
+        return $this->opening()
+            . Concatenate::create(...$this->content)
+            . $this->closing();
     }
 
     private function opening(): string

src/Implementations/ContentWithoutElement.php

@@ -0,0 +1,25 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Eightfold\XMLBuilder\Implementations;
+
+use Stringable;
+
+trait ContentWithoutElement
+{
+    /**
+     * @var array<string|Stringable>
+     */
+    private array $content = [];
+
+    public static function create(string|Stringable ...$content): static
+    {
+        return new static(...$content);
+    }
+
+    final private function __construct(string|Stringable ...$content)
+    {
+        $this->content = $content;
+    }
+}

src/Implementations/Contentable.php

@@ -29,4 +29,11 @@ public static function create(
     ): static {
         return new static($name, ...$content);
     }
+
+    final private function __construct(
+        private string $name,
+        string|Stringable ...$content
+    ) {
+        $this->content = $content;
+    }
 }