Merge pull request #19 from ARCANEDEV/update-1

Update the package

.scrutinizer.yml

@@ -21,7 +21,7 @@ checks:
 tools:
     external_code_coverage:
         timeout: 600
-        runs: 3
+        runs: 4
     php_code_sniffer:
         enabled: true
         config:

.travis.yml

@@ -6,6 +6,7 @@ php:
   - 7.1.3
   - 7.1
   - 7.2
+  - 7.3
   - nightly
 
 matrix:

LICENSE.md

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2015-2018 | ARCANEDEV <[email protected]> - LaravelSitemap
+Copyright (c) 2015-2019 | ARCANEDEV <[email protected]> - LaravelSitemap
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -19,7 +19,7 @@ This package allows you to manage and generate a sitemap without you having to a
   * Easy setup & configuration.
   * Well documented & IDE Friendly.
   * Well tested with maximum code quality.
-  * Laravel `5.4 | 5.5 | 5.6` are supported.
+  * Laravel `5.4` to `5.6` are supported.
   * Made with :heart: & :coffee:.
 
 ## Table of contents

composer.json

@@ -14,7 +14,9 @@
     "type":    "library",
     "license": "MIT",
     "require": {
-        "php":               ">=7.0",
+        "php":               ">=7.1.3",
+        "ext-dom":           "*",
+        "ext-json":          "*",
         "arcanedev/support": "~4.3.0"
     },
     "require-dev": {

phpunit.xml.dist

@@ -7,8 +7,7 @@
          convertNoticesToExceptions="true"
          convertWarningsToExceptions="true"
          processIsolation="false"
-         stopOnFailure="false"
-         syntaxCheck="false">
+         stopOnFailure="false">
     <testsuites>
         <testsuite name="Package Test Suite">
             <directory suffix=".php">./tests/</directory>
@@ -22,6 +21,6 @@
     <logging>
         <log type="coverage-clover" target="build/logs/clover.xml"/>
         <log type="coverage-text" target="build/logs/coverage.txt"/>
-        <log type="coverage-html" target="build/logs/coverage" charset="UTF-8" yui="true" highlight="true"/>
+        <log type="coverage-html" target="build/logs/coverage"/>
     </logging>
 </phpunit>

src/Exceptions/SitemapException.php

@@ -1,9 +1,11 @@
 <?php namespace Arcanedev\LaravelSitemap\Exceptions;
 
+use Exception;
+
 /**
  * Class     SitemapException
  *
  * @package  Arcanedev\LaravelSitemap\Exceptions
  * @author   ARCANEDEV <[email protected]>
  */
-class SitemapException extends \Exception {}
+class SitemapException extends Exception {}

src/SitemapBuilder.php

@@ -1,12 +1,14 @@
 <?php namespace Arcanedev\LaravelSitemap;
 
+use Arcanedev\LaravelSitemap\Contracts\Entities\Sitemap;
 use DOMDocument;
+use Illuminate\Support\Collection;
 use Illuminate\Support\Str;
 
 /**
  * Class     SitemapBuilder
  *
- * @package  Arcanedev\LaravelSitemap\Tests
+ * @package  Arcanedev\LaravelSitemap
  * @author   ARCANEDEV <[email protected]>
  */
 class SitemapBuilder
@@ -19,7 +21,7 @@ class SitemapBuilder
     /**
      * Create the builder instance.
      *
-     * @return self
+     * @return \Arcanedev\LaravelSitemap\SitemapBuilder
      */
     public static function make()
     {
@@ -33,9 +35,11 @@ public static function make()
      * @param  \Illuminate\Support\Collection  $sitemaps
      * @param  string                          $format
      *
+     * @throws \Throwable
+     *
      * @return string|null
      */
-    public function build($name, $sitemaps, $format)
+    public function build($name, Collection $sitemaps, $format)
     {
         if ($sitemaps->isEmpty())
             return null;
@@ -46,7 +50,9 @@ public function build($name, $sitemaps, $format)
                 : static::renderSitemap($format, $sitemaps->first());
         }
 
-        list($name, $key) = Str::contains($name, '.') ? explode('.', $name, 2) : [$name, null];
+        list($name, $key) = Str::contains($name, '.')
+            ? explode('.', $name, 2)
+            : [$name, null];
 
         if ($sitemaps->has($name))
             return static::renderSitemap($format, $sitemaps->get($name), $key);
@@ -66,9 +72,11 @@ public function build($name, $sitemaps, $format)
      * @param  \Arcanedev\LaravelSitemap\Contracts\Entities\Sitemap|null  $sitemap
      * @param  string|null                                                $key
      *
+     * @throws \Throwable
+     *
      * @return string|null
      */
-    protected function renderSitemap($format, $sitemap, $key = null)
+    protected function renderSitemap($format, Sitemap $sitemap = null, $key = null)
     {
         if (is_null($sitemap))
             return null;
@@ -89,7 +97,9 @@ protected function renderSitemap($format, $sitemap, $key = null)
      * @param  string                          $format
      * @param  \Illuminate\Support\Collection  $sitemaps
      *
-     * @return null|string
+     * @throws \Throwable
+     *
+     * @return string|null
      */
     protected function renderSitemapIndex($format, $sitemaps)
     {
@@ -103,7 +113,9 @@ protected function renderSitemapIndex($format, $sitemaps)
      * @param  string  $type
      * @param  array   $data
      *
-     * @return null|string
+     * @throws \Throwable
+     *
+     * @return string|null
      */
     protected function render($format, $type, array $data)
     {
@@ -147,6 +159,8 @@ protected function renderXml($format, $type, array $data)
      * @param  string  $format
      * @param  array   $data
      *
+     * @throws \Throwable
+     *
      * @return string
      */
     protected function renderView($type, $format, array $data)

src/SitemapManager.php

@@ -127,11 +127,13 @@ public function has($name)
 
         list($name, $key) = explode('.', $name, 2);
 
-        $map = $this->sitemaps->filter(function (SitemapContract $map) use ($name) {
+        $map = $this->sitemaps->filter(function (SitemapContract $map) {
             return $map->isExceeded();
         })->get($name);
 
-        return is_null($map) ? false : $map->chunk()->has(intval($key));
+        return is_null($map)
+            ? false
+            : $map->chunk()->has(intval($key));
     }
 
     /**
@@ -163,6 +165,8 @@ public function count()
      *
      * @param  string  $name
      *
+     * @throws \Throwable
+     *
      * @return string|null
      */
     public function render($name = null)
@@ -176,6 +180,8 @@ public function render($name = null)
      * @param  string       $path
      * @param  string|null  $name
      *
+     * @throws \Throwable
+     *
      * @return self
      */
     public function save($path, $name = null)
@@ -201,6 +207,8 @@ public function save($path, $name = null)
      * @param  int     $status
      * @param  array   $headers
      *
+     * @throws \Throwable
+     *
      * @return \Illuminate\Contracts\Routing\ResponseFactory|\Symfony\Component\HttpFoundation\Response
      */
     public function respond($name = null, $status = 200, array $headers = [])
@@ -245,6 +253,8 @@ public function jsonSerialize()
      *
      * @param  string                                                $path
      * @param  \Arcanedev\LaravelSitemap\Contracts\Entities\Sitemap  $sitemap
+     *
+     * @throws \Throwable
      */
     private function saveMultiple($path, $sitemap)
     {