Merge pull request #93 from peter-gribanov/writer_state

Optimize check state in Writers
gpslab · Jul 7, 2020 · 83604f7 · 83604f7
2 parents e5d1c2d + f002503
commit 83604f7
Show file tree

Hide file tree

Showing 33 changed files with 284 additions and 269 deletions.
diff --git a/src/Limiter.php b/src/Limiter.php
@@ -46,6 +46,9 @@ final class Limiter
      */
     private $used_bytes = 0;
 
+    /**
+     * @throws LinksOverflowException
+     */
     public function tryAddUrl(): void
     {
         if ($this->added_urls + 1 > self::LINKS_LIMIT) {
@@ -63,6 +66,9 @@ public function howManyUrlsAvailableToAdd(): int
         return self::LINKS_LIMIT - $this->added_urls;
     }
 
+    /**
+     * @throws SitemapsOverflowException
+     */
     public function tryAddSitemap(): void
     {
         if ($this->added_sitemaps + 1 > self::SITEMAPS_LIMIT) {
@@ -82,6 +88,8 @@ public function howManySitemapsAvailableToAdd(): int
 
     /**
      * @param int $used_bytes
+     *
+     * @throws SizeOverflowException
      */
     public function tryUseBytes(int $used_bytes): void
     {

diff --git a/src/Location.php b/src/Location.php
@@ -26,9 +26,9 @@ final class Location
     private $location;
 
     /**
-     * @throws InvalidLocationException
-     *
      * @param string $location
+     *
+     * @throws InvalidLocationException
      */
     public function __construct(string $location)
     {

diff --git a/src/Sitemap/Sitemap.php b/src/Sitemap/Sitemap.php
@@ -31,6 +31,8 @@ class Sitemap
     /**
      * @param Location|string         $location
      * @param \DateTimeInterface|null $last_modify
+     *
+     * @throws InvalidLastModifyException
      */
     public function __construct($location, ?\DateTimeInterface $last_modify = null)
     {

diff --git a/src/Stream/IndexStream.php b/src/Stream/IndexStream.php
@@ -11,15 +11,24 @@
 namespace GpsLab\Component\Sitemap\Stream;
 
 use GpsLab\Component\Sitemap\Sitemap\Sitemap;
+use GpsLab\Component\Sitemap\Stream\Exception\StreamStateException;
 
 interface IndexStream
 {
+    /**
+     * @throws StreamStateException
+     */
     public function open(): void;
 
+    /**
+     * @throws StreamStateException
+     */
     public function close(): void;
 
     /**
      * @param Sitemap $sitemap
+     *
+     * @throws StreamStateException
      */
     public function pushSitemap(Sitemap $sitemap): void;
 }
diff --git a/src/Stream/LoggerStream.php b/src/Stream/LoggerStream.php
@@ -10,6 +10,7 @@
 
 namespace GpsLab\Component\Sitemap\Stream;
 
+use GpsLab\Component\Sitemap\Stream\Exception\StreamStateException;
 use GpsLab\Component\Sitemap\Url\Url;
 use Psr\Log\LoggerInterface;
 
@@ -40,6 +41,8 @@ public function close(): void
 
     /**
      * @param Url $url
+     *
+     * @throws StreamStateException
      */
     public function push(Url $url): void
     {

diff --git a/src/Stream/MultiStream.php b/src/Stream/MultiStream.php
@@ -10,6 +10,7 @@
 
 namespace GpsLab\Component\Sitemap\Stream;
 
+use GpsLab\Component\Sitemap\Stream\Exception\StreamStateException;
 use GpsLab\Component\Sitemap\Url\Url;
 
 final class MultiStream implements Stream
@@ -27,13 +28,19 @@ public function __construct(Stream ...$streams)
         $this->streams = $streams;
     }
 
+    /**
+     * @throws StreamStateException
+     */
     public function open(): void
     {
         foreach ($this->streams as $stream) {
             $stream->open();
         }
     }
 
+    /**
+     * @throws StreamStateException
+     */
     public function close(): void
     {
         foreach ($this->streams as $stream) {
@@ -43,6 +50,8 @@ public function close(): void
 
     /**
      * @param Url $url
+     *
+     * @throws StreamStateException
      */
     public function push(Url $url): void
     {

diff --git a/src/Stream/OutputStream.php b/src/Stream/OutputStream.php
@@ -48,6 +48,9 @@ public function __construct(SitemapRender $render)
         $this->limiter = new Limiter();
     }
 
+    /**
+     * @throws StreamStateException
+     */
     public function open(): void
     {
         $this->state->open();
@@ -58,6 +61,9 @@ public function open(): void
         $this->limiter->tryUseBytes(mb_strlen($this->end_string, '8bit'));
     }
 
+    /**
+     * @throws StreamStateException
+     */
     public function close(): void
     {
         $this->state->close();
@@ -67,6 +73,8 @@ public function close(): void
 
     /**
      * @param Url $url
+     *
+     * @throws StreamStateException
      */
     public function push(Url $url): void
     {

diff --git a/src/Stream/State/StreamState.php b/src/Stream/State/StreamState.php
@@ -28,6 +28,9 @@ final class StreamState
      */
     private $state = self::STATE_CREATED;
 
+    /**
+     * @throws StreamStateException
+     */
     public function open(): void
     {
         if ($this->state === self::STATE_READY) {
@@ -37,6 +40,9 @@ public function open(): void
         $this->state = self::STATE_READY;
     }
 
+    /**
+     * @throws StreamStateException
+     */
     public function close(): void
     {
         if ($this->state === self::STATE_CLOSED) {

diff --git a/src/Stream/Stream.php b/src/Stream/Stream.php
@@ -10,16 +10,25 @@
 
 namespace GpsLab\Component\Sitemap\Stream;
 
+use GpsLab\Component\Sitemap\Stream\Exception\StreamStateException;
 use GpsLab\Component\Sitemap\Url\Url;
 
 interface Stream
 {
+    /**
+     * @throws StreamStateException
+     */
     public function open(): void;
 
+    /**
+     * @throws StreamStateException
+     */
     public function close(): void;
 
     /**
      * @param Url $url
+     *
+     * @throws StreamStateException
      */
     public function push(Url $url): void;
 }
diff --git a/src/Stream/WritingIndexStream.php b/src/Stream/WritingIndexStream.php
@@ -58,13 +58,19 @@ public function __construct(SitemapIndexRender $render, Writer $writer, string $
         $this->limiter = new Limiter();
     }
 
+    /**
+     * @throws StreamStateException
+     */
     public function open(): void
     {
         $this->state->open();
         $this->writer->start($this->filename);
         $this->writer->append($this->render->start());
     }
 
+    /**
+     * @throws StreamStateException
+     */
     public function close(): void
     {
         $this->state->close();
@@ -75,6 +81,8 @@ public function close(): void
 
     /**
      * @param Sitemap $sitemap
+     *
+     * @throws StreamStateException
      */
     public function pushSitemap(Sitemap $sitemap): void
     {

diff --git a/src/Stream/WritingSplitIndexStream.php b/src/Stream/WritingSplitIndexStream.php
@@ -101,6 +101,8 @@ final class WritingSplitIndexStream implements Stream, IndexStream
      * @param string             $index_filename
      * @param string             $part_filename_pattern
      * @param string             $part_web_path_pattern
+     *
+     * @throws SplitIndexException
      */
     public function __construct(
         SitemapIndexRender $index_render,
@@ -151,6 +153,9 @@ public function __construct(
         $this->part_limiter = new Limiter();
     }
 
+    /**
+     * @throws StreamStateException
+     */
     public function open(): void
     {
         $this->state->open();
@@ -159,6 +164,9 @@ public function open(): void
         $this->index_writer->append($this->index_render->start());
     }
 
+    /**
+     * @throws StreamStateException
+     */
     public function close(): void
     {
         $this->state->close();
@@ -182,6 +190,8 @@ public function close(): void
 
     /**
      * @param Url $url
+     *
+     * @throws StreamStateException
      */
     public function push(Url $url): void
     {
@@ -204,6 +214,8 @@ public function push(Url $url): void
 
     /**
      * @param Sitemap $sitemap
+     *
+     * @throws StreamStateException
      */
     public function pushSitemap(Sitemap $sitemap): void
     {

diff --git a/src/Stream/WritingSplitStream.php b/src/Stream/WritingSplitStream.php
@@ -77,6 +77,8 @@ final class WritingSplitStream implements SplitStream
      * @param Writer        $writer
      * @param string        $filename_pattern
      * @param string        $web_path_pattern
+     *
+     * @throws SplitIndexException
      */
     public function __construct(
         SitemapRender $render,
@@ -109,12 +111,18 @@ public function __construct(
         $this->limiter = new Limiter();
     }
 
+    /**
+     * @throws StreamStateException
+     */
     public function open(): void
     {
         $this->state->open();
         $this->openPart();
     }
 
+    /**
+     * @throws StreamStateException
+     */
     public function close(): void
     {
         $this->state->close();
@@ -130,6 +138,8 @@ public function close(): void
 
     /**
      * @param Url $url
+     *
+     * @throws StreamStateException
      */
     public function push(Url $url): void
     {

diff --git a/src/Stream/WritingStream.php b/src/Stream/WritingStream.php
@@ -63,6 +63,9 @@ public function __construct(SitemapRender $render, Writer $writer, string $filen
         $this->limiter = new Limiter();
     }
 
+    /**
+     * @throws StreamStateException
+     */
     public function open(): void
     {
         $this->state->open();
@@ -74,6 +77,9 @@ public function open(): void
         $this->limiter->tryUseBytes(mb_strlen($this->end_string, '8bit'));
     }
 
+    /**
+     * @throws StreamStateException
+     */
     public function close(): void
     {
         $this->state->close();
@@ -84,6 +90,8 @@ public function close(): void
 
     /**
      * @param Url $url
+     *
+     * @throws StreamStateException
      */
     public function push(Url $url): void
     {

diff --git a/src/Url/Language.php b/src/Url/Language.php
@@ -43,6 +43,8 @@ final class Language
     /**
      * @param string $language
      * @param string $location
+     *
+     * @throws InvalidLanguageException
      */
     public function __construct(string $language, string $location)
     {

diff --git a/src/Url/Priority.php b/src/Url/Priority.php
@@ -69,6 +69,8 @@ private static function safeCreate(string $priority): self
     /**
      * @param string|float|int $priority
      *
+     * @throws InvalidPriorityException
+     *
      * @return self
      */
     public static function create($priority): self

diff --git a/src/Url/Url.php b/src/Url/Url.php
@@ -46,6 +46,8 @@ class Url
      * @param ChangeFrequency|string|null    $change_frequency
      * @param Priority|string|float|int|null $priority
      * @param array<string, string>          $languages
+     *
+     * @throws InvalidLastModifyException
      */
     public function __construct(
         $location,