Merge pull request #51 from ARCANEDEV/update-package

Updating the package
ARCANEDEV · Oct 3, 2019 · 3f1ee79 · 3f1ee79
2 parents d6264bd + 4dac4c3
commit 3f1ee79
Show file tree

Hide file tree

Showing 22 changed files with 223 additions and 328 deletions.
diff --git a/.travis.yml b/.travis.yml
@@ -1,7 +1,5 @@
 language: php
 
-sudo: false
-
 php:
   - 7.2
   - 7.3

diff --git a/README.md b/README.md
@@ -25,7 +25,7 @@ Feel free to check out the [releases](https://github.com/ARCANEDEV/SEO-Helper/re
   * Easy setup &amp; configuration.
   * Well documented &amp; IDE Friendly.
   * Well tested with maximum code quality.
-  * Laravel `5.0` to `6.0` are supported.
+  * Laravel `5.x | 6.x` are supported.
   * Made with :heart: &amp; :coffee:.
 
 ## Table of contents

diff --git a/_docs/0-Home.md b/_docs/0-Home.md
@@ -11,7 +11,7 @@ SEO Helper is a package that provides tools and helpers for SEO (Search Engine O
   * Easy setup &amp; configuration.
   * Well documented &amp; IDE Friendly.
   * Well tested with maximum code quality.
-  * Laravel `5.0` to `6.0` are supported.
+  * Laravel `5.x | 6.x` are supported.
   * Made with :heart: &amp; :coffee:.
 
 ## Table of contents

diff --git a/_docs/1-Installation-and-Setup.md b/_docs/1-Installation-and-Setup.md
@@ -19,7 +19,7 @@
 | ![SEO-Helper v1.5.x][seo_helper_1_5_x] | ![Laravel v5.6][laravel_5_6]                                                           |
 | ![SEO-Helper v1.6.x][seo_helper_1_6_x] | ![Laravel v5.7][laravel_5_7]                                                           |
 | ![SEO-Helper v1.7.x][seo_helper_1_7_x] | ![Laravel v5.8][laravel_5_8]                                                           |
-| ![SEO-Helper v2.0.x][seo_helper_2_0_x] | ![Laravel v6.0][laravel_6_0]                                                           |
+| ![SEO-Helper v2.x][seo_helper_2_x]     | ![Laravel v6.x][laravel_6_x]                                                           |
 
 [laravel_5_0]:  https://img.shields.io/badge/v5.0-supported-brightgreen.svg?style=flat-square "Laravel v5.0"
 [laravel_5_1]:  https://img.shields.io/badge/v5.1-supported-brightgreen.svg?style=flat-square "Laravel v5.1"
@@ -30,16 +30,16 @@
 [laravel_5_6]:  https://img.shields.io/badge/v5.6-supported-brightgreen.svg?style=flat-square "Laravel v5.6"
 [laravel_5_7]:  https://img.shields.io/badge/v5.7-supported-brightgreen.svg?style=flat-square "Laravel v5.7"
 [laravel_5_8]:  https://img.shields.io/badge/v5.8-supported-brightgreen.svg?style=flat-square "Laravel v5.8"
-[laravel_6_0]:  https://img.shields.io/badge/v6.0-supported-brightgreen.svg?style=flat-square "Laravel v6.0"
-
-[seo_helper_1_1_x]: https://img.shields.io/badge/version-1.1.*-blue.svg?style=flat-square "SEO-Helper v1.1.*"
-[seo_helper_1_2_x]: https://img.shields.io/badge/version-1.2.*-blue.svg?style=flat-square "SEO-Helper v1.2.*"
-[seo_helper_1_3_x]: https://img.shields.io/badge/version-1.3.*-blue.svg?style=flat-square "SEO-Helper v1.3.*"
-[seo_helper_1_4_x]: https://img.shields.io/badge/version-1.4.*-blue.svg?style=flat-square "SEO-Helper v1.4.*"
-[seo_helper_1_5_x]: https://img.shields.io/badge/version-1.5.*-blue.svg?style=flat-square "SEO-Helper v1.5.*"
-[seo_helper_1_6_x]: https://img.shields.io/badge/version-1.6.*-blue.svg?style=flat-square "SEO-Helper v1.6.*"
-[seo_helper_1_7_x]: https://img.shields.io/badge/version-1.7.*-blue.svg?style=flat-square "SEO-Helper v1.7.*"
-[seo_helper_2_0_x]: https://img.shields.io/badge/version-2.0.*-blue.svg?style=flat-square "SEO-Helper v2.0.*"
+[laravel_6_x]:  https://img.shields.io/badge/v6.x-supported-brightgreen.svg?style=flat-square "Laravel v6.x"
+
+[seo_helper_1_1_x]: https://img.shields.io/badge/version-1.1.x-blue.svg?style=flat-square "SEO-Helper v1.1.x"
+[seo_helper_1_2_x]: https://img.shields.io/badge/version-1.2.x-blue.svg?style=flat-square "SEO-Helper v1.2.x"
+[seo_helper_1_3_x]: https://img.shields.io/badge/version-1.3.x-blue.svg?style=flat-square "SEO-Helper v1.3.x"
+[seo_helper_1_4_x]: https://img.shields.io/badge/version-1.4.x-blue.svg?style=flat-square "SEO-Helper v1.4.x"
+[seo_helper_1_5_x]: https://img.shields.io/badge/version-1.5.x-blue.svg?style=flat-square "SEO-Helper v1.5.x"
+[seo_helper_1_6_x]: https://img.shields.io/badge/version-1.6.x-blue.svg?style=flat-square "SEO-Helper v1.6.x"
+[seo_helper_1_7_x]: https://img.shields.io/badge/version-1.7.x-blue.svg?style=flat-square "SEO-Helper v1.7.x"
+[seo_helper_2_x]:   https://img.shields.io/badge/version-2.x-blue.svg?style=flat-square "SEO-Helper v2.x"
 
 ## Composer
 

diff --git a/_docs/2-Configuration.md b/_docs/2-Configuration.md
@@ -8,4 +8,116 @@
   4. [API](4-API.md)
   5. [Extras](5-Extras.md)
 
-> Coming Soon ...
+
+```php
+<?php
+
+return [
+
+    /* -----------------------------------------------------------------
+     |  Title
+     | -----------------------------------------------------------------
+     */
+
+    'title' => [
+        'default'   => 'Default Title',
+        'site-name' => config('app.name', 'My Application'),
+        'separator' => '-',
+        'first'     => true,
+        'max'       => 55,
+    ],
+
+    /* -----------------------------------------------------------------
+     |  Description
+     | -----------------------------------------------------------------
+     */
+
+    'description' => [
+        'default'   => 'Default description',
+        'max'       => 155,
+    ],
+
+    /* -----------------------------------------------------------------
+     |  Keywords
+     | -----------------------------------------------------------------
+     */
+
+    'keywords'  => [
+        'default'   => [
+            //
+        ],
+    ],
+
+    /* -----------------------------------------------------------------
+     |  Miscellaneous
+     | -----------------------------------------------------------------
+     */
+
+    'misc'      => [
+        'canonical' => true,
+        'robots'    => config('app.env') !== 'production', // Tell robots not to index the content if it's not on production
+        'default'   => [
+            'viewport'  => 'width=device-width, initial-scale=1', // Responsive design thing
+            'author'    => '', // https://plus.google.com/[YOUR PERSONAL G+ PROFILE HERE]
+            'publisher' => '', // https://plus.google.com/[YOUR PERSONAL G+ PROFILE HERE]
+        ],
+    ],
+
+    /* -----------------------------------------------------------------
+     |  Webmaster Tools
+     | -----------------------------------------------------------------
+     */
+
+    'webmasters' => [
+        'google'    => '',
+        'bing'      => '',
+        'alexa'     => '',
+        'pinterest' => '',
+        'yandex'    => '',
+    ],
+
+    /* -----------------------------------------------------------------
+     |  Open Graph
+     | -----------------------------------------------------------------
+     */
+
+    'open-graph' => [
+        'enabled'     => true,
+        'prefix'      => 'og:',
+        'type'        => 'website',
+        'title'       => 'Default Open Graph title',
+        'description' => 'Default Open Graph description',
+        'site-name'   => '',
+        'properties'  => [
+            //
+        ],
+    ],
+
+    /* -----------------------------------------------------------------
+     |  Twitter
+     | -----------------------------------------------------------------
+     |  Supported card types : 'app', 'gallery', 'photo', 'player', 'product', 'summary', 'summary_large_image'.
+     */
+
+    'twitter' => [
+        'enabled' => true,
+        'prefix'  => 'twitter:',
+        'card'    => 'summary',
+        'site'    => 'Username',
+        'title'   => 'Default Twitter Card title',
+        'metas'   => [
+            //
+        ],
+    ],
+
+    /* -----------------------------------------------------------------
+     |  Analytics
+     | -----------------------------------------------------------------
+     */
+
+    'analytics' => [
+        'google' => '', // UA-XXXXXXXX-X
+    ],
+
+];
+```
diff --git a/composer.json b/composer.json
@@ -18,14 +18,14 @@
     "license": "MIT",
     "require": {
         "php":                ">=7.2.0",
-        "arcanedev/php-html": "~3.0",
-        "arcanedev/support":  "~5.0.0"
+        "arcanedev/php-html": "^3.0",
+        "arcanedev/support":  "^5.0"
     },
     "require-dev": {
         "ext-dom":             "*",
-        "orchestra/testbench": "~4.0.0",
-        "phpunit/phpcov":      "~6.0",
-        "phpunit/phpunit":     "~8.0"
+        "orchestra/testbench": "^4.0",
+        "phpunit/phpcov":      "^6.0",
+        "phpunit/phpunit":     "^8.0"
     },
     "autoload": {
         "psr-4": {

diff --git a/helpers.php b/helpers.php
@@ -8,7 +8,8 @@
      *
      * @return \Arcanedev\SeoHelper\Contracts\SeoHelper
      */
-    function seo_helper() {
+    function seo_helper(): SeoHelper
+    {
         return app(SeoHelper::class);
     }
 }
diff --git a/src/Entities/Description.php b/src/Entities/Description.php
@@ -31,7 +31,7 @@ class Description implements DescriptionContract
      *
      * @var string
      */
-    protected $name    = 'description';
+    protected $name = 'description';
 
     /**
      * The meta content.
@@ -45,7 +45,7 @@ class Description implements DescriptionContract
      *
      * @var int
      */
-    protected $max     = 155;
+    protected $max = 155;
 
     /* -----------------------------------------------------------------
      |  Constructor
@@ -182,7 +182,7 @@ public function __toString()
      *
      * @return bool
      */
-    private function hasContent()
+    private function hasContent(): bool
     {
         return ! empty($this->get());
     }
@@ -194,7 +194,7 @@ private function hasContent()
      *
      * @throws \Arcanedev\SeoHelper\Exceptions\InvalidArgumentException
      */
-    private function checkMax($max)
+    private function checkMax($max): void
     {
         if ( ! is_int($max)) {
             throw new InvalidArgumentException(

diff --git a/src/Entities/Keywords.php b/src/Entities/Keywords.php
@@ -183,7 +183,7 @@ public function __toString()
      *
      * @return bool
      */
-    private function hasContent()
+    private function hasContent(): bool
     {
         return ! empty($this->getContent());
     }
@@ -200,7 +200,7 @@ private function hasContent()
      *
      * @return string
      */
-    private function clean($value)
+    private function clean(string $value): string
     {
         return trim(strip_tags($value));
     }

diff --git a/src/Entities/MiscTags.php b/src/Entities/MiscTags.php
@@ -207,7 +207,7 @@ public function __toString()
      *
      * @return bool
      */
-    private function hasUrl()
+    private function hasUrl(): bool
     {
         return ! empty($this->getUrl());
     }
@@ -217,7 +217,7 @@ private function hasUrl()
      *
      * @return bool
      */
-    private function isCanonicalEnabled()
+    private function isCanonicalEnabled(): bool
     {
         return (bool) $this->getConfig('canonical', false);
     }
@@ -227,7 +227,7 @@ private function isCanonicalEnabled()
      *
      * @return bool
      */
-    private function isRobotsEnabled()
+    private function isRobotsEnabled(): bool
     {
         return (bool) $this->getConfig('robots', false);
     }
@@ -242,7 +242,7 @@ private function isRobotsEnabled()
      *
      * @return \Arcanedev\SeoHelper\Entities\MiscTags
      */
-    private function addRobotsMeta()
+    private function addRobotsMeta(): self
     {
         if ($this->isRobotsEnabled())
             $this->add('robots', 'noindex, nofollow');
@@ -255,7 +255,7 @@ private function addRobotsMeta()
      *
      * @return \Arcanedev\SeoHelper\Entities\MiscTags
      */
-    private function addCanonical()
+    private function addCanonical(): self
     {
         if ($this->isCanonicalEnabled() && $this->hasUrl())
             $this->add('canonical', $this->currentUrl);

diff --git a/src/Entities/Title.php b/src/Entities/Title.php
@@ -353,7 +353,7 @@ public function __toString()
      *
      * @return bool
      */
-    private function hasSiteName()
+    private function hasSiteName(): bool
     {
         return ! empty($this->getSiteName()) && $this->siteNameVisibility;
     }
@@ -365,7 +365,7 @@ private function hasSiteName()
      *
      * @throws \Arcanedev\SeoHelper\Exceptions\InvalidArgumentException
      */
-    private function checkTitle(&$title)
+    private function checkTitle(&$title): void
     {
         if ( ! is_string($title)) {
             $type = gettype($title);
@@ -387,7 +387,7 @@ private function checkTitle(&$title)
      *
      * @throws \Arcanedev\SeoHelper\Exceptions\InvalidArgumentException
      */
-    private function checkMax($max)
+    private function checkMax($max): void
     {
         if ( ! is_int($max)) {
             throw new InvalidArgumentException('The title maximum length must be integer.');
@@ -410,7 +410,7 @@ private function checkMax($max)
      *
      * @return string
      */
-    private function renderTitleFirst($separator)
+    private function renderTitleFirst(string $separator): string
     {
         $output   = [];
         $output[] = $this->getTitleOnly();
@@ -430,7 +430,7 @@ private function renderTitleFirst($separator)
      *
      * @return string
      */
-    private function renderTitleLast($separator)
+    private function renderTitleLast(string $separator): string
     {
         $output = [];
 
@@ -451,7 +451,7 @@ private function renderTitleLast($separator)
      *
      * @return string
      */
-    private function prepareTitleOutput($output)
+    private function prepareTitleOutput(string $output): string
     {
         return htmlspecialchars(
             Str::limit(strip_tags($output), $this->getMax()), ENT_QUOTES, 'UTF-8', false

diff --git a/src/Entities/Twitter/Card.php b/src/Entities/Twitter/Card.php
@@ -289,7 +289,7 @@ public function __toString()
      *
      * @throws \Arcanedev\SeoHelper\Exceptions\InvalidTwitterCardException
      */
-    private function checkType(&$type)
+    private function checkType(&$type): void
     {
         if ( ! is_string($type)) {
             throw new InvalidTwitterCardException(
@@ -309,7 +309,7 @@ private function checkType(&$type)
      *
      * @param  string  $site
      */
-    private function checkSite(&$site)
+    private function checkSite(string &$site): void
     {
         $site = $this->prepareUsername($site);
     }
@@ -326,7 +326,7 @@ private function checkSite(&$site)
      *
      * @return string
      */
-    private function prepareUsername($username)
+    private function prepareUsername(string $username): string
     {
         return Str::startsWith($username, '@')
             ? $username :