austinheap / laravel-security-txt

src/SecurityTxtController.php

Spacing +1 added lines, -1 removed lines

@@ -28,7 +28,7 @@
      */
     public function show()
     {
-        if (! config('security-txt.enabled', false))
+        if (!config('security-txt.enabled', false))
             abort(404);
 
         return \Response::make(

Braces +3 added lines, -2 removed lines

@@ -28,8 +28,9 @@
      */
     public function show()
     {
-        if (! config('security-txt.enabled', false))
-            abort(404);
+        if (! config('security-txt.enabled', false)) {
+                    abort(404);
+        }
 
         return \Response::make(
                     (new SecurityTxt)->getText(true, true),

src/SecurityTxtServiceProvider.php

Spacing +3 added lines, -3 removed lines

@@ -26,7 +26,7 @@ 
      *
      * @var bool
      */
-    protected $defer = false;
+    protected $defer=false;
 
     /**
      * Perform post-registration booting of services.
@@ -39,7 +39,7 @@ 
             __DIR__ . '/config/security-txt.php' => config_path('security-txt.php'),
         ]);
 
-        if (! $this->app->routesAreCached())
+        if (!$this->app->routesAreCached())
             require __DIR__ . '/routes/security-txt.php';
     }
 
@@ -54,7 +54,7 @@ 
             __DIR__ . '/config/security-txt.php', 'security-txt'
         );
 
-        $this->app->singleton('securitytxt', function () {
+        $this->app->singleton('securitytxt', function() {
             return new SecurityTxt;
         });
     }

Braces +3 added lines, -2 removed lines

@@ -39,8 +39,9 @@
             __DIR__ . '/config/security-txt.php' => config_path('security-txt.php'),
         ]);
 
-        if (! $this->app->routesAreCached())
-            require __DIR__ . '/routes/security-txt.php';
+        if (! $this->app->routesAreCached()) {
+                    require __DIR__ . '/routes/security-txt.php';
+        }
     }
 
     /**

src/SecurityTxt.php

Indentation +10 added lines, -10 removed lines

@@ -166,7 +166,7 @@ 
         if (!empty($this->encryption)) {
             if ($this->comments)
                 $this->addSpacer()
-                     ->addComment('Our PGP key');
+                        ->addComment('Our PGP key');
 
             $this->addLine('Encryption: ' . trim($this->encryption));
         }
@@ -174,7 +174,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)));
         }
@@ -182,20 +182,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 +53 added lines, -53 removed lines

@@ -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.
@@ -112,23 +112,23 @@ 
      */
     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'],
+        $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' ],
         ];
 
         foreach ($keys as $key => $mapping)
             if (config($key, null) !== null &&
-                $mapping['validator'](config($key)))
-                $this->{$mapping['setter']}(config($key));
+                $mapping[ 'validator' ](config($key)))
+                $this->{$mapping[ 'setter' ]}(config($key));
 
         return $this;
     }
@@ -139,17 +139,17 @@ 
      * @param  bool         $reset
      * @return SecurityTxt
      */
-    public function generate(bool $reset = false): SecurityTxt
+    public function generate(bool $reset=false): SecurityTxt
     {
         if ($this->cache) {
-            $output = cache($this->cacheKey, null);
+            $output=cache($this->cacheKey, null);
 
             if (!is_null($output))
                 return $this->setText($output);
         }
 
         if ($this->debug)
-            $time = microtime(true);
+            $time=microtime(true);
 
         if ($reset)
             $this->resetLines();
@@ -197,10 +197,10 @@ 
                  ->addComment()
                  ->addSpacer();
 
-        $output = implode(PHP_EOL, $this->lines);
+        $output=implode(PHP_EOL, $this->lines);
 
         if ($this->cache)
-            cache([$this->cacheKey => $output], now()->addMinutes($this->cacheTime));
+            cache([ $this->cacheKey => $output ], now()->addMinutes($this->cacheTime));
 
         return $this->setText($output);
     }
@@ -233,7 +233,7 @@ 
      */
     public function setEnabled(bool $enabled): SecurityTxt
     {
-        $this->enabled = $enabled;
+        $this->enabled=$enabled;
 
         return $this;
     }
@@ -276,7 +276,7 @@ 
      */
     public function setComments(bool $comments): SecurityTxt
     {
-        $this->comments = $comments;
+        $this->comments=$comments;
 
         return $this;
     }
@@ -319,7 +319,7 @@ 
      */
     public function setDebug(bool $debug): SecurityTxt
     {
-        $this->debug = $debug;
+        $this->debug=$debug;
 
         return $this;
     }
@@ -362,7 +362,7 @@ 
      */
     public function setCache(bool $cache): SecurityTxt
     {
-        $this->cache = $cache;
+        $this->cache=$cache;
 
         return $this;
     }
@@ -385,7 +385,7 @@ 
      */
     public function setCacheKey(string $cacheKey): SecurityTxt
     {
-        $this->cacheKey = $cacheKey;
+        $this->cacheKey=$cacheKey;
 
         return $this;
     }
@@ -408,7 +408,7 @@ 
      */
     public function setCacheTime(int $cacheTime): SecurityTxt
     {
-        $this->cacheTime = $cacheTime;
+        $this->cacheTime=$cacheTime;
 
         return $this;
     }
@@ -431,7 +431,7 @@ 
      */
     public function setText(string $text): SecurityTxt
     {
-        $this->text = $text;
+        $this->text=$text;
 
         return $this;
     }
@@ -443,7 +443,7 @@ 
      * @param  bool   $reset
      * @return string
      */
-    public function getText(bool $generate = false, bool $reset = false): string
+    public function getText(bool $generate=false, bool $reset=false): string
     {
         if ($generate)
             $this->generate($reset);
@@ -459,7 +459,7 @@ 
      */
     public function setContacts(array $contacts): SecurityTxt
     {
-        $this->contacts = $contacts;
+        $this->contacts=$contacts;
 
         return $this;
     }
@@ -471,7 +471,7 @@ 
      */
     public function getContacts(): array
     {
-        return is_null($this->contacts) ? [] : $this->contacts;
+        return is_null($this->contacts) ? [ ] : $this->contacts;
     }
 
     /**
@@ -482,7 +482,7 @@ 
      */
     public function addContact(string $contact): SecurityTxt
     {
-        return $this->addContacts([$contact]);
+        return $this->addContacts([ $contact ]);
     }
 
     /**
@@ -494,7 +494,7 @@ 
     public function addContacts(array $contacts): SecurityTxt
     {
         foreach ($contacts as $contact)
-            $this->contact[$contact] = true;
+            $this->contact[ $contact ]=true;
 
         return $this;
     }
@@ -507,7 +507,7 @@ 
      */
     public function removeContact(string $contact): SecurityTxt
     {
-        $this->removeContacts([$contact]);
+        $this->removeContacts([ $contact ]);
 
         return $this;
     }
@@ -522,7 +522,7 @@ 
     {
         foreach ($contacts as $contact)
             if (array_key_exists($contact, $this->contacts))
-                unset($this->contacts[$contact]);
+                unset($this->contacts[ $contact ]);
 
         return $this;
     }
@@ -538,7 +538,7 @@ 
         if (filter_var($encryption, FILTER_VALIDATE_URL) === false)
             throw new \Exception('Encryption must be a well-formed URL.');
 
-        $this->encryption = $encryption;
+        $this->encryption=$encryption;
 
         return $this;
     }
@@ -561,10 +561,10 @@ 
      */
     public function setDisclosure(string $disclosure): SecurityTxt
     {
-        if (!in_array(trim(strtolower($disclosure)), ['full', 'partial', '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;
+        $this->disclosure=$disclosure;
 
         return $this;
     }
@@ -590,7 +590,7 @@ 
         if (filter_var($acknowledgement, FILTER_VALIDATE_URL) === false)
             throw new \Exception('Acknowledgement must be a well-formed URL.');
 
-        $this->acknowledgement = $acknowledgement;
+        $this->acknowledgement=$acknowledgement;
 
         return $this;
     }
@@ -611,12 +611,12 @@ 
      * @param  string $comment
      * @return SecurityTxt
      */
-    private function addComment(string $comment = ''): SecurityTxt
+    private function addComment(string $comment=''): SecurityTxt
     {
-        $comment = trim($comment);
+        $comment=trim($comment);
 
         if (!empty($comment))
-            $comment = ' ' . $comment;
+            $comment=' ' . $comment;
 
         return $this->addLine('#' . $comment);
     }
@@ -639,7 +639,7 @@ 
      */
     private function addLine(string $line): SecurityTxt
     {
-        $this->lines[] = $line;
+        $this->lines[ ]=$line;
 
         return $this;
     }
@@ -651,7 +651,7 @@ 
      */
     private function resetLines(): SecurityTxt
     {
-        $this->lines = [];
+        $this->lines=[ ];
 
         return $this;
     }

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;
     }
@@ -144,51 +145,60 @@ 
         if ($this->cache) {
             $output = cache($this->cacheKey, null);
 
-            if (!is_null($output))
-                return $this->setText($output);
+            if (!is_null($output)) {
+                            return $this->setText($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() . '.')
@@ -196,11 +206,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);
     }
@@ -445,8 +457,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;
     }
@@ -493,8 +506,9 @@ 
      */
     public function addContacts(array $contacts): SecurityTxt
     {
-        foreach ($contacts as $contact)
-            $this->contact[$contact] = true;
+        foreach ($contacts as $contact) {
+                    $this->contact[$contact] = true;
+        }
 
         return $this;
     }
@@ -520,9 +534,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;
     }
@@ -535,8 +550,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;
 
@@ -561,8 +577,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;
 
@@ -587,8 +604,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;
 
@@ -615,8 +633,9 @@ 
     {
         $comment = trim($comment);
 
-        if (!empty($comment))
-            $comment = ' ' . $comment;
+        if (!empty($comment)) {
+                    $comment = ' ' . $comment;
+        }
 
         return $this->addLine('#' . $comment);
     }

src/config/security-txt.php

Spacing +1 added lines, -1 removed lines

@@ -22,7 +22,7 @@
     'comments'          => env('SECURITY_TXT_COMMENTS', true),
 
     'contacts'          => env('SECURITY_TXT_CONTACT', false) !== false ?
-                           [env('SECURITY_TXT_CONTACT')] : null,
+                           [ env('SECURITY_TXT_CONTACT') ] : null,
 
     'encryption'        => env('SECURITY_TXT_ENCRYPTION', null),