austinheap / php-security-txt

src/Writer.php

Indentation +10 added lines, -10 removed lines

@@ -169,7 +169,7 @@ 
         if (!empty($this->encryption)) {
             if ($this->comments)
                 $this->addSpacer()
-                     ->addComment('Our PGP key');
+                        ->addComment('Our PGP key');
 
             $this->addLine('Encryption: ' . trim($this->encryption));
         }
@@ -177,7 +177,7 @@ 
         if (!empty($this->disclosure)) {
             if ($this->comments)
                 $this->addSpacer()
-                     ->addComment('Our disclosure policy');
+                        ->addComment('Our disclosure policy');
 
             $this->addLine('Disclosure: ' . trim(ucfirst($this->disclosure)));
         }
@@ -185,20 +185,20 @@ 
         if (!empty($this->acknowledgement)) {
             if ($this->comments)
                 $this->addSpacer()
-                     ->addComment('Our public acknowledgement');
+                        ->addComment('Our public acknowledgement');
 
             $this->addLine('Acknowledgement: ' . trim($this->acknowledgement));
         }
 
         if ($this->debug)
             $this->addSpacer()
-                 ->addComment()
-                 ->addComment('Generated by https://github.com/austinheap/laravel-security-txt')
-                 ->addComment('in ' . round((microtime(true) - $time) * 1000, 6) . ' seconds on ' . now() . '.')
-                 ->addComment()
-                 ->addComment('Cache is ' . ($this->cache ? 'enabled with key "' . $this->cacheKey . '"' : 'disabled') . '.')
-                 ->addComment()
-                 ->addSpacer();
+                    ->addComment()
+                    ->addComment('Generated by https://github.com/austinheap/laravel-security-txt')
+                    ->addComment('in ' . round((microtime(true) - $time) * 1000, 6) . ' seconds on ' . now() . '.')
+                    ->addComment()
+                    ->addComment('Cache is ' . ($this->cache ? 'enabled with key "' . $this->cacheKey . '"' : 'disabled') . '.')
+                    ->addComment()
+                    ->addSpacer();
 
         $output = implode(PHP_EOL, $this->lines);
 

Spacing +31 added lines, -31 removed lines

@@ -7,7 +7,7 @@ 
  * @version     v0.3.0
  */
 
-declare(strict_types=1);
+declare(strict_types = 1);
 
 namespace AustinHeap\Security\Txt;
 
@@ -26,84 +26,84 @@ 
      *
      * @var array
      */
-    protected $lines            = [];
+    protected $lines = [];
 
     /**
      * Internal text cache.
      *
      * @var string
      */
-    protected $text             = null;
+    protected $text = null;
 
     /**
      * Enable SecurityTxt.
      *
      * @var bool
      */
-    protected $enabled          = false;
+    protected $enabled = false;
 
     /**
      * Enable debug output.
      *
      * @var bool
      */
-    protected $debug            = false;
+    protected $debug = false;
 
     /**
      * Enable built-in cache.
      *
      * @var bool
      */
-    protected $cache            = false;
+    protected $cache = false;
 
     /**
      * Minutes to cache output.
      *
      * @var int
      */
-    protected $cacheTime        = null;
+    protected $cacheTime = null;
 
     /**
      * Cache key to use.
      *
      * @var string
      */
-    protected $cacheKey         = 'cache:AustinHeap\Security\Txt\SecurityTxt';
+    protected $cacheKey = 'cache:AustinHeap\Security\Txt\SecurityTxt';
 
     /**
      * Enable built-in comments.
      *
      * @var bool
      */
-    protected $comments         = true;
+    protected $comments = true;
 
     /**
      * The security contacts to list.
      *
      * @var array
      */
-    protected $contacts         = [];
+    protected $contacts = [];
 
     /**
      * The PGP key file URL.
      *
      * @var string
      */
-    protected $encryption       = null;
+    protected $encryption = null;
 
     /**
      * The disclosure policy.
      *
      * @var string
      */
-    protected $disclosure       = null;
+    protected $disclosure = null;
 
     /**
      * The acknowledgement URL.
      *
      * @var string
      */
-    protected $acknowledgement  = null;
+    protected $acknowledgement = null;
 
     /**
      * Create a new SecurityTxt instance.
@@ -113,16 +113,16 @@ 
     public function __construct()
     {
         $keys = [
-            'security-txt.enabled'          => ['validator' => 'is_bool',       'setter' => 'setEnabled'],
-            'security-txt.debug'            => ['validator' => 'is_bool',       'setter' => 'setDebug'],
-            'security-txt.cache'            => ['validator' => 'is_bool',       'setter' => 'setCache'],
-            'security-txt.cache-time'       => ['validator' => 'is_numeric',    'setter' => 'setCacheTime'],
-            'security-txt.cache-key'        => ['validator' => 'is_string',     'setter' => 'setCacheKey'],
-            'security-txt.comments'         => ['validator' => 'is_bool',       'setter' => 'setComments'],
-            'security-txt.contacts'         => ['validator' => 'is_array',      'setter' => 'setContacts'],
-            'security-txt.encryption'       => ['validator' => 'is_string',     'setter' => 'setEncryption'],
-            'security-txt.disclosure'       => ['validator' => 'is_string',     'setter' => 'setDisclosure'],
-            'security-txt.acknowledgement'  => ['validator' => 'is_string',     'setter' => 'setAcknowledgement'],
+            'security-txt.enabled'          => ['validator' => 'is_bool', 'setter' => 'setEnabled'],
+            'security-txt.debug'            => ['validator' => 'is_bool', 'setter' => 'setDebug'],
+            'security-txt.cache'            => ['validator' => 'is_bool', 'setter' => 'setCache'],
+            'security-txt.cache-time'       => ['validator' => 'is_numeric', 'setter' => 'setCacheTime'],
+            'security-txt.cache-key'        => ['validator' => 'is_string', 'setter' => 'setCacheKey'],
+            'security-txt.comments'         => ['validator' => 'is_bool', 'setter' => 'setComments'],
+            'security-txt.contacts'         => ['validator' => 'is_array', 'setter' => 'setContacts'],
+            'security-txt.encryption'       => ['validator' => 'is_string', 'setter' => 'setEncryption'],
+            'security-txt.disclosure'       => ['validator' => 'is_string', 'setter' => 'setDisclosure'],
+            'security-txt.acknowledgement'  => ['validator' => 'is_string', 'setter' => 'setAcknowledgement'],
         ];
 
         foreach ($keys as $key => $mapping)
@@ -164,14 +164,14 @@ 
             throw new \Exception('One (or more) contacts must be defined.');
 
         foreach ($this->contacts as $contact)
-            $this->addLine('Contact: ' . trim($contact));
+            $this->addLine('Contact: '.trim($contact));
 
         if (!empty($this->encryption)) {
             if ($this->comments)
                 $this->addSpacer()
                      ->addComment('Our PGP key');
 
-            $this->addLine('Encryption: ' . trim($this->encryption));
+            $this->addLine('Encryption: '.trim($this->encryption));
         }
 
         if (!empty($this->disclosure)) {
@@ -179,7 +179,7 @@ 
                 $this->addSpacer()
                      ->addComment('Our disclosure policy');
 
-            $this->addLine('Disclosure: ' . trim(ucfirst($this->disclosure)));
+            $this->addLine('Disclosure: '.trim(ucfirst($this->disclosure)));
         }
 
         if (!empty($this->acknowledgement)) {
@@ -187,16 +187,16 @@ 
                 $this->addSpacer()
                      ->addComment('Our public acknowledgement');
 
-            $this->addLine('Acknowledgement: ' . trim($this->acknowledgement));
+            $this->addLine('Acknowledgement: '.trim($this->acknowledgement));
         }
 
         if ($this->debug)
             $this->addSpacer()
                  ->addComment()
                  ->addComment('Generated by https://github.com/austinheap/laravel-security-txt')
-                 ->addComment('in ' . round((microtime(true) - $time) * 1000, 6) . ' seconds on ' . now() . '.')
+                 ->addComment('in '.round((microtime(true) - $time) * 1000, 6).' seconds on '.now().'.')
                  ->addComment()
-                 ->addComment('Cache is ' . ($this->cache ? 'enabled with key "' . $this->cacheKey . '"' : 'disabled') . '.')
+                 ->addComment('Cache is '.($this->cache ? 'enabled with key "'.$this->cacheKey.'"' : 'disabled').'.')
                  ->addComment()
                  ->addSpacer();
 
@@ -619,9 +619,9 @@ 
         $comment = trim($comment);
 
         if (!empty($comment))
-            $comment = ' ' . $comment;
+            $comment = ' '.$comment;
 
-        return $this->addLine('#' . $comment);
+        return $this->addLine('#'.$comment);
     }
 
     /**

Braces +57 added lines, -38 removed lines

@@ -125,10 +125,11 @@ 
             'security-txt.acknowledgement'  => ['validator' => 'is_string',     'setter' => 'setAcknowledgement'],
         ];
 
-        foreach ($keys as $key => $mapping)
-            if (config($key, null) !== null &&
+        foreach ($keys as $key => $mapping) {
+                    if (config($key, null) !== null &&
                 $mapping['validator'](config($key)))
                 $this->{$mapping['setter']}(config($key));
+        }
 
         return $this;
     }
@@ -145,53 +146,62 @@ 
             $output = cache($this->cacheKey, null);
 
             if (!is_null($output) &&
-                is_string($output))
-                return $this->setText($output);
+                is_string($output)) {
+                            return $this->setText($output);
+            }
 
             unset($output);
         }
 
-        if ($this->debug)
-            $time = microtime(true);
+        if ($this->debug) {
+                    $time = microtime(true);
+        }
 
-        if ($reset)
-            $this->resetLines();
+        if ($reset) {
+                    $this->resetLines();
+        }
 
-        if ($this->comments)
-            $this->addComment('Our security address');
+        if ($this->comments) {
+                    $this->addComment('Our security address');
+        }
 
-        if (empty($this->contacts))
-            throw new \Exception('One (or more) contacts must be defined.');
+        if (empty($this->contacts)) {
+                    throw new \Exception('One (or more) contacts must be defined.');
+        }
 
-        foreach ($this->contacts as $contact)
-            $this->addLine('Contact: ' . trim($contact));
+        foreach ($this->contacts as $contact) {
+                    $this->addLine('Contact: ' . trim($contact));
+        }
 
         if (!empty($this->encryption)) {
-            if ($this->comments)
-                $this->addSpacer()
+            if ($this->comments) {
+                            $this->addSpacer()
                      ->addComment('Our PGP key');
+            }
 
             $this->addLine('Encryption: ' . trim($this->encryption));
         }
 
         if (!empty($this->disclosure)) {
-            if ($this->comments)
-                $this->addSpacer()
+            if ($this->comments) {
+                            $this->addSpacer()
                      ->addComment('Our disclosure policy');
+            }
 
             $this->addLine('Disclosure: ' . trim(ucfirst($this->disclosure)));
         }
 
         if (!empty($this->acknowledgement)) {
-            if ($this->comments)
-                $this->addSpacer()
+            if ($this->comments) {
+                            $this->addSpacer()
                      ->addComment('Our public acknowledgement');
+            }
 
             $this->addLine('Acknowledgement: ' . trim($this->acknowledgement));
         }
 
-        if ($this->debug)
-            $this->addSpacer()
+        if ($this->debug) {
+                    $this->addSpacer()
                  ->addComment()
                  ->addComment('Generated by https://github.com/austinheap/laravel-security-txt')
                  ->addComment('in ' . round((microtime(true) - $time) * 1000, 6) . ' seconds on ' . now() . '.')
@@ -199,11 +209,13 @@ 
                  ->addComment('Cache is ' . ($this->cache ? 'enabled with key "' . $this->cacheKey . '"' : 'disabled') . '.')
                  ->addComment()
                  ->addSpacer();
+        }
 
         $output = implode(PHP_EOL, $this->lines);
 
-        if ($this->cache)
-            cache([$this->cacheKey => $output], now()->addMinutes($this->cacheTime));
+        if ($this->cache) {
+                    cache([$this->cacheKey => $output], now()->addMinutes($this->cacheTime));
+        }
 
         return $this->setText($output);
     }
@@ -448,8 +460,9 @@ 
      */
     public function getText(bool $generate = false, bool $reset = false): string
     {
-        if ($generate)
-            $this->generate($reset);
+        if ($generate) {
+                    $this->generate($reset);
+        }
 
         return $this->text === null ? '' : $this->text;
     }
@@ -496,8 +509,9 @@ 
      */
     public function addContacts(array $contacts): SecurityTxt
     {
-        foreach ($contacts as $contact)
-            $this->contacts[$contact] = true;
+        foreach ($contacts as $contact) {
+                    $this->contacts[$contact] = true;
+        }
 
         return $this;
     }
@@ -523,9 +537,10 @@ 
      */
     public function removeContacts(array $contacts): SecurityTxt
     {
-        foreach ($contacts as $contact)
-            if (array_key_exists($contact, $this->contacts))
+        foreach ($contacts as $contact) {
+                    if (array_key_exists($contact, $this->contacts))
                 unset($this->contacts[$contact]);
+        }
 
         return $this;
     }
@@ -538,8 +553,9 @@ 
      */
     public function setEncryption(string $encryption): SecurityTxt
     {
-        if (filter_var($encryption, FILTER_VALIDATE_URL) === false)
-            throw new \Exception('Encryption must be a well-formed URL.');
+        if (filter_var($encryption, FILTER_VALIDATE_URL) === false) {
+                    throw new \Exception('Encryption must be a well-formed URL.');
+        }
 
         $this->encryption = $encryption;
 
@@ -564,8 +580,9 @@ 
      */
     public function setDisclosure(string $disclosure): SecurityTxt
     {
-        if (!in_array(trim(strtolower($disclosure)), ['full', 'partial', 'none']))
-            throw new \Exception('Disclosure policy must be either "full", "partial", or "none".');
+        if (!in_array(trim(strtolower($disclosure)), ['full', 'partial', 'none'])) {
+                    throw new \Exception('Disclosure policy must be either "full", "partial", or "none".');
+        }
 
         $this->disclosure = $disclosure;
 
@@ -590,8 +607,9 @@ 
      */
     public function setAcknowledgement(string $acknowledgement): SecurityTxt
     {
-        if (filter_var($acknowledgement, FILTER_VALIDATE_URL) === false)
-            throw new \Exception('Acknowledgement must be a well-formed URL.');
+        if (filter_var($acknowledgement, FILTER_VALIDATE_URL) === false) {
+                    throw new \Exception('Acknowledgement must be a well-formed URL.');
+        }
 
         $this->acknowledgement = $acknowledgement;
 
@@ -618,8 +636,9 @@ 
     {
         $comment = trim($comment);
 
-        if (!empty($comment))
-            $comment = ' ' . $comment;
+        if (!empty($comment)) {
+                    $comment = ' ' . $comment;
+        }
 
         return $this->addLine('#' . $comment);
     }

src/SecurityTxt.php

Indentation +10 added lines, -10 removed lines

@@ -169,7 +169,7 @@ 
         if (!empty($this->encryption)) {
             if ($this->comments)
                 $this->addSpacer()
-                     ->addComment('Our PGP key');
+                        ->addComment('Our PGP key');
 
             $this->addLine('Encryption: ' . trim($this->encryption));
         }
@@ -177,7 +177,7 @@ 
         if (!empty($this->disclosure)) {
             if ($this->comments)
                 $this->addSpacer()
-                     ->addComment('Our disclosure policy');
+                        ->addComment('Our disclosure policy');
 
             $this->addLine('Disclosure: ' . trim(ucfirst($this->disclosure)));
         }
@@ -185,20 +185,20 @@ 
         if (!empty($this->acknowledgement)) {
             if ($this->comments)
                 $this->addSpacer()
-                     ->addComment('Our public acknowledgement');
+                        ->addComment('Our public acknowledgement');
 
             $this->addLine('Acknowledgement: ' . trim($this->acknowledgement));
         }
 
         if ($this->debug)
             $this->addSpacer()
-                 ->addComment()
-                 ->addComment('Generated by https://github.com/austinheap/laravel-security-txt')
-                 ->addComment('in ' . round((microtime(true) - $time) * 1000, 6) . ' seconds on ' . now() . '.')
-                 ->addComment()
-                 ->addComment('Cache is ' . ($this->cache ? 'enabled with key "' . $this->cacheKey . '"' : 'disabled') . '.')
-                 ->addComment()
-                 ->addSpacer();
+                    ->addComment()
+                    ->addComment('Generated by https://github.com/austinheap/laravel-security-txt')
+                    ->addComment('in ' . round((microtime(true) - $time) * 1000, 6) . ' seconds on ' . now() . '.')
+                    ->addComment()
+                    ->addComment('Cache is ' . ($this->cache ? 'enabled with key "' . $this->cacheKey . '"' : 'disabled') . '.')
+                    ->addComment()
+                    ->addSpacer();
 
         $output = implode(PHP_EOL, $this->lines);
 

Spacing +31 added lines, -31 removed lines

@@ -7,7 +7,7 @@ 
  * @version     v0.3.0
  */
 
-declare(strict_types=1);
+declare(strict_types = 1);
 
 namespace AustinHeap\Security\Txt;
 
@@ -26,84 +26,84 @@ 
      *
      * @var array
      */
-    protected $lines            = [];
+    protected $lines = [];
 
     /**
      * Internal text cache.
      *
      * @var string
      */
-    protected $text             = null;
+    protected $text = null;
 
     /**
      * Enable SecurityTxt.
      *
      * @var bool
      */
-    protected $enabled          = false;
+    protected $enabled = false;
 
     /**
      * Enable debug output.
      *
      * @var bool
      */
-    protected $debug            = false;
+    protected $debug = false;
 
     /**
      * Enable built-in cache.
      *
      * @var bool
      */
-    protected $cache            = false;
+    protected $cache = false;
 
     /**
      * Minutes to cache output.
      *
      * @var int
      */
-    protected $cacheTime        = null;
+    protected $cacheTime = null;
 
     /**
      * Cache key to use.
      *
      * @var string
      */
-    protected $cacheKey         = 'cache:AustinHeap\Security\Txt\SecurityTxt';
+    protected $cacheKey = 'cache:AustinHeap\Security\Txt\SecurityTxt';
 
     /**
      * Enable built-in comments.
      *
      * @var bool
      */
-    protected $comments         = true;
+    protected $comments = true;
 
     /**
      * The security contacts to list.
      *
      * @var array
      */
-    protected $contacts         = [];
+    protected $contacts = [];
 
     /**
      * The PGP key file URL.
      *
      * @var string
      */
-    protected $encryption       = null;
+    protected $encryption = null;
 
     /**
      * The disclosure policy.
      *
      * @var string
      */
-    protected $disclosure       = null;
+    protected $disclosure = null;
 
     /**
      * The acknowledgement URL.
      *
      * @var string
      */
-    protected $acknowledgement  = null;
+    protected $acknowledgement = null;
 
     /**
      * Create a new SecurityTxt instance.
@@ -113,16 +113,16 @@ 
     public function __construct()
     {
         $keys = [
-            'security-txt.enabled'          => ['validator' => 'is_bool',       'setter' => 'setEnabled'],
-            'security-txt.debug'            => ['validator' => 'is_bool',       'setter' => 'setDebug'],
-            'security-txt.cache'            => ['validator' => 'is_bool',       'setter' => 'setCache'],
-            'security-txt.cache-time'       => ['validator' => 'is_numeric',    'setter' => 'setCacheTime'],
-            'security-txt.cache-key'        => ['validator' => 'is_string',     'setter' => 'setCacheKey'],
-            'security-txt.comments'         => ['validator' => 'is_bool',       'setter' => 'setComments'],
-            'security-txt.contacts'         => ['validator' => 'is_array',      'setter' => 'setContacts'],
-            'security-txt.encryption'       => ['validator' => 'is_string',     'setter' => 'setEncryption'],
-            'security-txt.disclosure'       => ['validator' => 'is_string',     'setter' => 'setDisclosure'],
-            'security-txt.acknowledgement'  => ['validator' => 'is_string',     'setter' => 'setAcknowledgement'],
+            'security-txt.enabled'          => ['validator' => 'is_bool', 'setter' => 'setEnabled'],
+            'security-txt.debug'            => ['validator' => 'is_bool', 'setter' => 'setDebug'],
+            'security-txt.cache'            => ['validator' => 'is_bool', 'setter' => 'setCache'],
+            'security-txt.cache-time'       => ['validator' => 'is_numeric', 'setter' => 'setCacheTime'],
+            'security-txt.cache-key'        => ['validator' => 'is_string', 'setter' => 'setCacheKey'],
+            'security-txt.comments'         => ['validator' => 'is_bool', 'setter' => 'setComments'],
+            'security-txt.contacts'         => ['validator' => 'is_array', 'setter' => 'setContacts'],
+            'security-txt.encryption'       => ['validator' => 'is_string', 'setter' => 'setEncryption'],
+            'security-txt.disclosure'       => ['validator' => 'is_string', 'setter' => 'setDisclosure'],
+            'security-txt.acknowledgement'  => ['validator' => 'is_string', 'setter' => 'setAcknowledgement'],
         ];
 
         foreach ($keys as $key => $mapping)
@@ -164,14 +164,14 @@ 
             throw new \Exception('One (or more) contacts must be defined.');
 
         foreach ($this->contacts as $contact)
-            $this->addLine('Contact: ' . trim($contact));
+            $this->addLine('Contact: '.trim($contact));
 
         if (!empty($this->encryption)) {
             if ($this->comments)
                 $this->addSpacer()
                      ->addComment('Our PGP key');
 
-            $this->addLine('Encryption: ' . trim($this->encryption));
+            $this->addLine('Encryption: '.trim($this->encryption));
         }
 
         if (!empty($this->disclosure)) {
@@ -179,7 +179,7 @@ 
                 $this->addSpacer()
                      ->addComment('Our disclosure policy');
 
-            $this->addLine('Disclosure: ' . trim(ucfirst($this->disclosure)));
+            $this->addLine('Disclosure: '.trim(ucfirst($this->disclosure)));
         }
 
         if (!empty($this->acknowledgement)) {
@@ -187,16 +187,16 @@ 
                 $this->addSpacer()
                      ->addComment('Our public acknowledgement');
 
-            $this->addLine('Acknowledgement: ' . trim($this->acknowledgement));
+            $this->addLine('Acknowledgement: '.trim($this->acknowledgement));
         }
 
         if ($this->debug)
             $this->addSpacer()
                  ->addComment()
                  ->addComment('Generated by https://github.com/austinheap/laravel-security-txt')
-                 ->addComment('in ' . round((microtime(true) - $time) * 1000, 6) . ' seconds on ' . now() . '.')
+                 ->addComment('in '.round((microtime(true) - $time) * 1000, 6).' seconds on '.now().'.')
                  ->addComment()
-                 ->addComment('Cache is ' . ($this->cache ? 'enabled with key "' . $this->cacheKey . '"' : 'disabled') . '.')
+                 ->addComment('Cache is '.($this->cache ? 'enabled with key "'.$this->cacheKey.'"' : 'disabled').'.')
                  ->addComment()
                  ->addSpacer();
 
@@ -619,9 +619,9 @@ 
         $comment = trim($comment);
 
         if (!empty($comment))
-            $comment = ' ' . $comment;
+            $comment = ' '.$comment;
 
-        return $this->addLine('#' . $comment);
+        return $this->addLine('#'.$comment);
     }
 
     /**

Braces +57 added lines, -38 removed lines

@@ -125,10 +125,11 @@ 
             'security-txt.acknowledgement'  => ['validator' => 'is_string',     'setter' => 'setAcknowledgement'],
         ];
 
-        foreach ($keys as $key => $mapping)
-            if (config($key, null) !== null &&
+        foreach ($keys as $key => $mapping) {
+                    if (config($key, null) !== null &&
                 $mapping['validator'](config($key)))
                 $this->{$mapping['setter']}(config($key));
+        }
 
         return $this;
     }
@@ -145,53 +146,62 @@ 
             $output = cache($this->cacheKey, null);
 
             if (!is_null($output) &&
-                is_string($output))
-                return $this->setText($output);
+                is_string($output)) {
+                            return $this->setText($output);
+            }
 
             unset($output);
         }
 
-        if ($this->debug)
-            $time = microtime(true);
+        if ($this->debug) {
+                    $time = microtime(true);
+        }
 
-        if ($reset)
-            $this->resetLines();
+        if ($reset) {
+                    $this->resetLines();
+        }
 
-        if ($this->comments)
-            $this->addComment('Our security address');
+        if ($this->comments) {
+                    $this->addComment('Our security address');
+        }
 
-        if (empty($this->contacts))
-            throw new \Exception('One (or more) contacts must be defined.');
+        if (empty($this->contacts)) {
+                    throw new \Exception('One (or more) contacts must be defined.');
+        }
 
-        foreach ($this->contacts as $contact)
-            $this->addLine('Contact: ' . trim($contact));
+        foreach ($this->contacts as $contact) {
+                    $this->addLine('Contact: ' . trim($contact));
+        }
 
         if (!empty($this->encryption)) {
-            if ($this->comments)
-                $this->addSpacer()
+            if ($this->comments) {
+                            $this->addSpacer()
                      ->addComment('Our PGP key');
+            }
 
             $this->addLine('Encryption: ' . trim($this->encryption));
         }
 
         if (!empty($this->disclosure)) {
-            if ($this->comments)
-                $this->addSpacer()
+            if ($this->comments) {
+                            $this->addSpacer()
                      ->addComment('Our disclosure policy');
+            }
 
             $this->addLine('Disclosure: ' . trim(ucfirst($this->disclosure)));
         }
 
         if (!empty($this->acknowledgement)) {
-            if ($this->comments)
-                $this->addSpacer()
+            if ($this->comments) {
+                            $this->addSpacer()
                      ->addComment('Our public acknowledgement');
+            }
 
             $this->addLine('Acknowledgement: ' . trim($this->acknowledgement));
         }
 
-        if ($this->debug)
-            $this->addSpacer()
+        if ($this->debug) {
+                    $this->addSpacer()
                  ->addComment()
                  ->addComment('Generated by https://github.com/austinheap/laravel-security-txt')
                  ->addComment('in ' . round((microtime(true) - $time) * 1000, 6) . ' seconds on ' . now() . '.')
@@ -199,11 +209,13 @@ 
                  ->addComment('Cache is ' . ($this->cache ? 'enabled with key "' . $this->cacheKey . '"' : 'disabled') . '.')
                  ->addComment()
                  ->addSpacer();
+        }
 
         $output = implode(PHP_EOL, $this->lines);
 
-        if ($this->cache)
-            cache([$this->cacheKey => $output], now()->addMinutes($this->cacheTime));
+        if ($this->cache) {
+                    cache([$this->cacheKey => $output], now()->addMinutes($this->cacheTime));
+        }
 
         return $this->setText($output);
     }
@@ -448,8 +460,9 @@ 
      */
     public function getText(bool $generate = false, bool $reset = false): string
     {
-        if ($generate)
-            $this->generate($reset);
+        if ($generate) {
+                    $this->generate($reset);
+        }
 
         return $this->text === null ? '' : $this->text;
     }
@@ -496,8 +509,9 @@ 
      */
     public function addContacts(array $contacts): SecurityTxt
     {
-        foreach ($contacts as $contact)
-            $this->contacts[$contact] = true;
+        foreach ($contacts as $contact) {
+                    $this->contacts[$contact] = true;
+        }
 
         return $this;
     }
@@ -523,9 +537,10 @@ 
      */
     public function removeContacts(array $contacts): SecurityTxt
     {
-        foreach ($contacts as $contact)
-            if (array_key_exists($contact, $this->contacts))
+        foreach ($contacts as $contact) {
+                    if (array_key_exists($contact, $this->contacts))
                 unset($this->contacts[$contact]);
+        }
 
         return $this;
     }
@@ -538,8 +553,9 @@ 
      */
     public function setEncryption(string $encryption): SecurityTxt
     {
-        if (filter_var($encryption, FILTER_VALIDATE_URL) === false)
-            throw new \Exception('Encryption must be a well-formed URL.');
+        if (filter_var($encryption, FILTER_VALIDATE_URL) === false) {
+                    throw new \Exception('Encryption must be a well-formed URL.');
+        }
 
         $this->encryption = $encryption;
 
@@ -564,8 +580,9 @@ 
      */
     public function setDisclosure(string $disclosure): SecurityTxt
     {
-        if (!in_array(trim(strtolower($disclosure)), ['full', 'partial', 'none']))
-            throw new \Exception('Disclosure policy must be either "full", "partial", or "none".');
+        if (!in_array(trim(strtolower($disclosure)), ['full', 'partial', 'none'])) {
+                    throw new \Exception('Disclosure policy must be either "full", "partial", or "none".');
+        }
 
         $this->disclosure = $disclosure;
 
@@ -590,8 +607,9 @@ 
      */
     public function setAcknowledgement(string $acknowledgement): SecurityTxt
     {
-        if (filter_var($acknowledgement, FILTER_VALIDATE_URL) === false)
-            throw new \Exception('Acknowledgement must be a well-formed URL.');
+        if (filter_var($acknowledgement, FILTER_VALIDATE_URL) === false) {
+                    throw new \Exception('Acknowledgement must be a well-formed URL.');
+        }
 
         $this->acknowledgement = $acknowledgement;
 
@@ -618,8 +636,9 @@ 
     {
         $comment = trim($comment);
 
-        if (!empty($comment))
-            $comment = ' ' . $comment;
+        if (!empty($comment)) {
+                    $comment = ' ' . $comment;
+        }
 
         return $this->addLine('#' . $comment);
     }

src/Reader.php

Indentation +10 added lines, -10 removed lines

@@ -169,7 +169,7 @@ 
         if (!empty($this->encryption)) {
             if ($this->comments)
                 $this->addSpacer()
-                     ->addComment('Our PGP key');
+                        ->addComment('Our PGP key');
 
             $this->addLine('Encryption: ' . trim($this->encryption));
         }
@@ -177,7 +177,7 @@ 
         if (!empty($this->disclosure)) {
             if ($this->comments)
                 $this->addSpacer()
-                     ->addComment('Our disclosure policy');
+                        ->addComment('Our disclosure policy');
 
             $this->addLine('Disclosure: ' . trim(ucfirst($this->disclosure)));
         }
@@ -185,20 +185,20 @@ 
         if (!empty($this->acknowledgement)) {
             if ($this->comments)
                 $this->addSpacer()
-                     ->addComment('Our public acknowledgement');
+                        ->addComment('Our public acknowledgement');
 
             $this->addLine('Acknowledgement: ' . trim($this->acknowledgement));
         }
 
         if ($this->debug)
             $this->addSpacer()
-                 ->addComment()
-                 ->addComment('Generated by https://github.com/austinheap/laravel-security-txt')
-                 ->addComment('in ' . round((microtime(true) - $time) * 1000, 6) . ' seconds on ' . now() . '.')
-                 ->addComment()
-                 ->addComment('Cache is ' . ($this->cache ? 'enabled with key "' . $this->cacheKey . '"' : 'disabled') . '.')
-                 ->addComment()
-                 ->addSpacer();
+                    ->addComment()
+                    ->addComment('Generated by https://github.com/austinheap/laravel-security-txt')
+                    ->addComment('in ' . round((microtime(true) - $time) * 1000, 6) . ' seconds on ' . now() . '.')
+                    ->addComment()
+                    ->addComment('Cache is ' . ($this->cache ? 'enabled with key "' . $this->cacheKey . '"' : 'disabled') . '.')
+                    ->addComment()
+                    ->addSpacer();
 
         $output = implode(PHP_EOL, $this->lines);
 

Spacing +31 added lines, -31 removed lines

@@ -7,7 +7,7 @@ 
  * @version     v0.3.0
  */
 
-declare(strict_types=1);
+declare(strict_types = 1);
 
 namespace AustinHeap\Security\Txt;
 
@@ -26,84 +26,84 @@ 
      *
      * @var array
      */
-    protected $lines            = [];
+    protected $lines = [];
 
     /**
      * Internal text cache.
      *
      * @var string
      */
-    protected $text             = null;
+    protected $text = null;
 
     /**
      * Enable SecurityTxt.
      *
      * @var bool
      */
-    protected $enabled          = false;
+    protected $enabled = false;
 
     /**
      * Enable debug output.
      *
      * @var bool
      */
-    protected $debug            = false;
+    protected $debug = false;
 
     /**
      * Enable built-in cache.
      *
      * @var bool
      */
-    protected $cache            = false;
+    protected $cache = false;
 
     /**
      * Minutes to cache output.
      *
      * @var int
      */
-    protected $cacheTime        = null;
+    protected $cacheTime = null;
 
     /**
      * Cache key to use.
      *
      * @var string
      */
-    protected $cacheKey         = 'cache:AustinHeap\Security\Txt\SecurityTxt';
+    protected $cacheKey = 'cache:AustinHeap\Security\Txt\SecurityTxt';
 
     /**
      * Enable built-in comments.
      *
      * @var bool
      */
-    protected $comments         = true;
+    protected $comments = true;
 
     /**
      * The security contacts to list.
      *
      * @var array
      */
-    protected $contacts         = [];
+    protected $contacts = [];
 
     /**
      * The PGP key file URL.
      *
      * @var string
      */
-    protected $encryption       = null;
+    protected $encryption = null;
 
     /**
      * The disclosure policy.
      *
      * @var string
      */
-    protected $disclosure       = null;
+    protected $disclosure = null;
 
     /**
      * The acknowledgement URL.
      *
      * @var string
      */
-    protected $acknowledgement  = null;
+    protected $acknowledgement = null;
 
     /**
      * Create a new SecurityTxt instance.
@@ -113,16 +113,16 @@ 
     public function __construct()
     {
         $keys = [
-            'security-txt.enabled'          => ['validator' => 'is_bool',       'setter' => 'setEnabled'],
-            'security-txt.debug'            => ['validator' => 'is_bool',       'setter' => 'setDebug'],
-            'security-txt.cache'            => ['validator' => 'is_bool',       'setter' => 'setCache'],
-            'security-txt.cache-time'       => ['validator' => 'is_numeric',    'setter' => 'setCacheTime'],
-            'security-txt.cache-key'        => ['validator' => 'is_string',     'setter' => 'setCacheKey'],
-            'security-txt.comments'         => ['validator' => 'is_bool',       'setter' => 'setComments'],
-            'security-txt.contacts'         => ['validator' => 'is_array',      'setter' => 'setContacts'],
-            'security-txt.encryption'       => ['validator' => 'is_string',     'setter' => 'setEncryption'],
-            'security-txt.disclosure'       => ['validator' => 'is_string',     'setter' => 'setDisclosure'],
-            'security-txt.acknowledgement'  => ['validator' => 'is_string',     'setter' => 'setAcknowledgement'],
+            'security-txt.enabled'          => ['validator' => 'is_bool', 'setter' => 'setEnabled'],
+            'security-txt.debug'            => ['validator' => 'is_bool', 'setter' => 'setDebug'],
+            'security-txt.cache'            => ['validator' => 'is_bool', 'setter' => 'setCache'],
+            'security-txt.cache-time'       => ['validator' => 'is_numeric', 'setter' => 'setCacheTime'],
+            'security-txt.cache-key'        => ['validator' => 'is_string', 'setter' => 'setCacheKey'],
+            'security-txt.comments'         => ['validator' => 'is_bool', 'setter' => 'setComments'],
+            'security-txt.contacts'         => ['validator' => 'is_array', 'setter' => 'setContacts'],
+            'security-txt.encryption'       => ['validator' => 'is_string', 'setter' => 'setEncryption'],
+            'security-txt.disclosure'       => ['validator' => 'is_string', 'setter' => 'setDisclosure'],
+            'security-txt.acknowledgement'  => ['validator' => 'is_string', 'setter' => 'setAcknowledgement'],
         ];
 
         foreach ($keys as $key => $mapping)
@@ -164,14 +164,14 @@ 
             throw new \Exception('One (or more) contacts must be defined.');
 
         foreach ($this->contacts as $contact)
-            $this->addLine('Contact: ' . trim($contact));
+            $this->addLine('Contact: '.trim($contact));
 
         if (!empty($this->encryption)) {
             if ($this->comments)
                 $this->addSpacer()
                      ->addComment('Our PGP key');
 
-            $this->addLine('Encryption: ' . trim($this->encryption));
+            $this->addLine('Encryption: '.trim($this->encryption));
         }
 
         if (!empty($this->disclosure)) {
@@ -179,7 +179,7 @@ 
                 $this->addSpacer()
                      ->addComment('Our disclosure policy');
 
-            $this->addLine('Disclosure: ' . trim(ucfirst($this->disclosure)));
+            $this->addLine('Disclosure: '.trim(ucfirst($this->disclosure)));
         }
 
         if (!empty($this->acknowledgement)) {
@@ -187,16 +187,16 @@ 
                 $this->addSpacer()
                      ->addComment('Our public acknowledgement');
 
-            $this->addLine('Acknowledgement: ' . trim($this->acknowledgement));
+            $this->addLine('Acknowledgement: '.trim($this->acknowledgement));
         }
 
         if ($this->debug)
             $this->addSpacer()
                  ->addComment()
                  ->addComment('Generated by https://github.com/austinheap/laravel-security-txt')
-                 ->addComment('in ' . round((microtime(true) - $time) * 1000, 6) . ' seconds on ' . now() . '.')
+                 ->addComment('in '.round((microtime(true) - $time) * 1000, 6).' seconds on '.now().'.')
                  ->addComment()
-                 ->addComment('Cache is ' . ($this->cache ? 'enabled with key "' . $this->cacheKey . '"' : 'disabled') . '.')
+                 ->addComment('Cache is '.($this->cache ? 'enabled with key "'.$this->cacheKey.'"' : 'disabled').'.')
                  ->addComment()
                  ->addSpacer();
 
@@ -619,9 +619,9 @@ 
         $comment = trim($comment);
 
         if (!empty($comment))
-            $comment = ' ' . $comment;
+            $comment = ' '.$comment;
 
-        return $this->addLine('#' . $comment);
+        return $this->addLine('#'.$comment);
     }
 
     /**

Braces +57 added lines, -38 removed lines

@@ -125,10 +125,11 @@ 
             'security-txt.acknowledgement'  => ['validator' => 'is_string',     'setter' => 'setAcknowledgement'],
         ];
 
-        foreach ($keys as $key => $mapping)
-            if (config($key, null) !== null &&
+        foreach ($keys as $key => $mapping) {
+                    if (config($key, null) !== null &&
                 $mapping['validator'](config($key)))
                 $this->{$mapping['setter']}(config($key));
+        }
 
         return $this;
     }
@@ -145,53 +146,62 @@ 
             $output = cache($this->cacheKey, null);
 
             if (!is_null($output) &&
-                is_string($output))
-                return $this->setText($output);
+                is_string($output)) {
+                            return $this->setText($output);
+            }
 
             unset($output);
         }
 
-        if ($this->debug)
-            $time = microtime(true);
+        if ($this->debug) {
+                    $time = microtime(true);
+        }
 
-        if ($reset)
-            $this->resetLines();
+        if ($reset) {
+                    $this->resetLines();
+        }
 
-        if ($this->comments)
-            $this->addComment('Our security address');
+        if ($this->comments) {
+                    $this->addComment('Our security address');
+        }
 
-        if (empty($this->contacts))
-            throw new \Exception('One (or more) contacts must be defined.');
+        if (empty($this->contacts)) {
+                    throw new \Exception('One (or more) contacts must be defined.');
+        }
 
-        foreach ($this->contacts as $contact)
-            $this->addLine('Contact: ' . trim($contact));
+        foreach ($this->contacts as $contact) {
+                    $this->addLine('Contact: ' . trim($contact));
+        }
 
         if (!empty($this->encryption)) {
-            if ($this->comments)
-                $this->addSpacer()
+            if ($this->comments) {
+                            $this->addSpacer()
                      ->addComment('Our PGP key');
+            }
 
             $this->addLine('Encryption: ' . trim($this->encryption));
         }
 
         if (!empty($this->disclosure)) {
-            if ($this->comments)
-                $this->addSpacer()
+            if ($this->comments) {
+                            $this->addSpacer()
                      ->addComment('Our disclosure policy');
+            }
 
             $this->addLine('Disclosure: ' . trim(ucfirst($this->disclosure)));
         }
 
         if (!empty($this->acknowledgement)) {
-            if ($this->comments)
-                $this->addSpacer()
+            if ($this->comments) {
+                            $this->addSpacer()
                      ->addComment('Our public acknowledgement');
+            }
 
             $this->addLine('Acknowledgement: ' . trim($this->acknowledgement));
         }
 
-        if ($this->debug)
-            $this->addSpacer()
+        if ($this->debug) {
+                    $this->addSpacer()
                  ->addComment()
                  ->addComment('Generated by https://github.com/austinheap/laravel-security-txt')
                  ->addComment('in ' . round((microtime(true) - $time) * 1000, 6) . ' seconds on ' . now() . '.')
@@ -199,11 +209,13 @@ 
                  ->addComment('Cache is ' . ($this->cache ? 'enabled with key "' . $this->cacheKey . '"' : 'disabled') . '.')
                  ->addComment()
                  ->addSpacer();
+        }
 
         $output = implode(PHP_EOL, $this->lines);
 
-        if ($this->cache)
-            cache([$this->cacheKey => $output], now()->addMinutes($this->cacheTime));
+        if ($this->cache) {
+                    cache([$this->cacheKey => $output], now()->addMinutes($this->cacheTime));
+        }
 
         return $this->setText($output);
     }
@@ -448,8 +460,9 @@ 
      */
     public function getText(bool $generate = false, bool $reset = false): string
     {
-        if ($generate)
-            $this->generate($reset);
+        if ($generate) {
+                    $this->generate($reset);
+        }
 
         return $this->text === null ? '' : $this->text;
     }
@@ -496,8 +509,9 @@ 
      */
     public function addContacts(array $contacts): SecurityTxt
     {
-        foreach ($contacts as $contact)
-            $this->contacts[$contact] = true;
+        foreach ($contacts as $contact) {
+                    $this->contacts[$contact] = true;
+        }
 
         return $this;
     }
@@ -523,9 +537,10 @@ 
      */
     public function removeContacts(array $contacts): SecurityTxt
     {
-        foreach ($contacts as $contact)
-            if (array_key_exists($contact, $this->contacts))
+        foreach ($contacts as $contact) {
+                    if (array_key_exists($contact, $this->contacts))
                 unset($this->contacts[$contact]);
+        }
 
         return $this;
     }
@@ -538,8 +553,9 @@ 
      */
     public function setEncryption(string $encryption): SecurityTxt
     {
-        if (filter_var($encryption, FILTER_VALIDATE_URL) === false)
-            throw new \Exception('Encryption must be a well-formed URL.');
+        if (filter_var($encryption, FILTER_VALIDATE_URL) === false) {
+                    throw new \Exception('Encryption must be a well-formed URL.');
+        }
 
         $this->encryption = $encryption;
 
@@ -564,8 +580,9 @@ 
      */
     public function setDisclosure(string $disclosure): SecurityTxt
     {
-        if (!in_array(trim(strtolower($disclosure)), ['full', 'partial', 'none']))
-            throw new \Exception('Disclosure policy must be either "full", "partial", or "none".');
+        if (!in_array(trim(strtolower($disclosure)), ['full', 'partial', 'none'])) {
+                    throw new \Exception('Disclosure policy must be either "full", "partial", or "none".');
+        }
 
         $this->disclosure = $disclosure;
 
@@ -590,8 +607,9 @@ 
      */
     public function setAcknowledgement(string $acknowledgement): SecurityTxt
     {
-        if (filter_var($acknowledgement, FILTER_VALIDATE_URL) === false)
-            throw new \Exception('Acknowledgement must be a well-formed URL.');
+        if (filter_var($acknowledgement, FILTER_VALIDATE_URL) === false) {
+                    throw new \Exception('Acknowledgement must be a well-formed URL.');
+        }
 
         $this->acknowledgement = $acknowledgement;
 
@@ -618,8 +636,9 @@ 
     {
         $comment = trim($comment);
 
-        if (!empty($comment))
-            $comment = ' ' . $comment;
+        if (!empty($comment)) {
+                    $comment = ' ' . $comment;
+        }
 
         return $this->addLine('#' . $comment);
     }