Writer::spacer() - Code Metrics - Inspection of "beta support for wordpress" - austinheap/php-security-txt - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( fa5ea6...438f4a )

by Austin

created 2017-11-20 20:54 UTC

Writer::spacer() A

↳ Parent: Writer

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
eloc	1
nc	1
nop	0
dl	0
loc	3
rs	10
c	0
b	0
f	0

<?php
/**
 * src/Writer.php
 *
 * @package     php-security-txt
 * @author      Austin Heap <[email protected]>
 * @version     v0.3.1
 */

declare(strict_types = 1);

namespace AustinHeap\Security\Txt;

use Exception;

/**
 * Writer
 *
 * @link        https://github.com/austinheap/php-security-txt
 * @link        https://packagist.org/packages/austinheap/php-security-txt
 * @link        https://austinheap.github.io/php-security-txt/classes/AustinHeap.Security.Txt.Writer.html
 */
class Writer extends SecurityTxt
{

    /**
     * Internal lines cache.
     *
     * @var array
     */
    private $lines = [];

    /**
     * Create a new Writer instance.
     *
     * @return \AustinHeap\Security\Txt\Writer
     */
    public function __construct()
    {
        return parent::__construct($this);
    }

    /**
     * Add a comment to the output buffer.
     *
     * @param  string $comment
     *
     * @return \AustinHeap\Security\Txt\Writer
     */
    public function comment(string $comment = ''): Writer
    {
        $comment = trim($comment);

        if (!empty($comment)) {
            $comment = ' ' . $comment;
        }

        return $this->line(trim('#' . $comment));
    }

    /**
     * Add a spacer to the output buffer.
     *
     * @return \AustinHeap\Security\Txt\Writer
     */
    public function spacer(): Writer
    {
        return $this->line('');
    }

    /**
     * Add multiple spacers to the output buffer.
     *
     * @return \AustinHeap\Security\Txt\Writer
     */
    public function spacers($count = 1): Writer
    {
        for ($x = 0; $x < $count; $x++) {
            $this->spacer();
        }

        return $this;
    }

    /**
     * Add a line.
     *
     * @param  string $line
     *
     * @return \AustinHeap\Security\Txt\Writer
     */
    public function line(string $line): Writer
    {
        $this->lines[] = $line;

        return $this;
    }

    /**
     * Add multiple lines.
     *
     * @param  array $lines
     *
     * @return \AustinHeap\Security\Txt\Writer
     */
    public function lines(array $lines): Writer
    {
        foreach ($lines as $line) {
            $this->line($line);
        }

        return $this;
    }

    /**
     * Reset the output buffer.
     *
     * @return \AustinHeap\Security\Txt\Writer
     */
    public function reset(): Writer
    {
        $this->lines = [];

        return $this;
    }

    /**
     * Generate the data.
     *
     * @return \AustinHeap\Security\Txt\Writer
     * @throws Exception
     */
    public function generate(): Writer
    {
        if ($this->debug) {
            $time = microtime(true);
        }

        if ($this->comments) {
            $this->comment('Our security address');
        }

        if (empty($this->contacts)) {
            throw new Exception('One (or more) contacts must be defined.');
        }

        foreach (array_keys($this->contacts) as $contact) {
            $this->line('Contact: ' . trim($contact));
        }

        if (!empty($this->encryption)) {

            if ($this->comments) {
                $this->spacer()
                     ->comment('Our PGP key');
            }

            $this->line('Encryption: ' . trim($this->encryption));
        }

        if (!empty($this->disclosure)) {
            if ($this->comments) {
                $this->spacer()
                     ->comment('Our disclosure policy');
            }

            $this->line('Disclosure: ' . trim(ucfirst($this->disclosure)));
        }

        if (!empty($this->acknowledgement)) {

            if ($this->comments) {
                $this->spacer()
                     ->comment('Our public acknowledgement');
            }

            $this->line('Acknowledgement: ' . trim($this->acknowledgement));
        }

        if ($this->debug && isset($time)) {
            $this->spacer()
                 ->comment()
                 ->comment(
                     'Generated by "' . (defined('LARAVEL_SECURITY_TXT_VERSION') ? 'laravel' : (defined('WORDPRESS_SECURITY_TXT_VERSION') ? 'wordpress' : 'php')) . '-security-txt"' .
                     (defined('LARAVEL_SECURITY_TXT_VERSION') ? ' v' . LARAVEL_SECURITY_TXT_VERSION : (defined('WORDPRESS_SECURITY_TXT_VERSION') ? ' v' . WORDPRESS_SECURITY_TXT_VERSION : (defined('PHP_SECURITY_TXT_VERSION') ? ' v' . PHP_SECURITY_TXT_VERSION : ''))) .

                     ' (https://github.com/austinheap/' . (defined('LARAVEL_SECURITY_TXT_VERSION') ? 'laravel' : (defined('WORDPRESS_SECURITY_TXT_VERSION') ? 'wordpress' : 'php')) . '-security-txt' . (defined('LARAVEL_SECURITY_TXT_VERSION') ? '/releases/tag/v' . LARAVEL_SECURITY_TXT_VERSION : (defined('WORDPRESS_SECURITY_TXT_VERSION') ? '/releases/tag/v' . WORDPRESS_SECURITY_TXT_VERSION : (defined('PHP_SECURITY_TXT_VERSION') ? '/releases/tag/v' . PHP_SECURITY_TXT_VERSION : ''))) . ')');
            if (defined('LARAVEL_SECURITY_TXT_VERSION') || defined('WORDPRESS_SECURITY_TXT_VERSION')) {
                $this->comment(
                    'using "php-security-txt"' . (defined('PHP_SECURITY_TXT_VERSION') ? ' v' . PHP_SECURITY_TXT_VERSION : '') .
                    ' (https://github.com/austinheap/php-security-txt' . (defined('PHP_SECURITY_TXT_VERSION') ? '/releases/tag/v' . PHP_SECURITY_TXT_VERSION : '') . ')');
            }
            $this->comment('in ' . round((microtime(true) - $time) * 1000, 6) . ' seconds on ' . date('c') . '.')
                 ->comment()
                 ->spacer();
        }

        $output = implode(PHP_EOL, $this->lines);

        return $this->setText($output);
    }
}


1		<?php
2		/**
3		* src/Writer.php
4		*
5		* @package php-security-txt
6		* @author Austin Heap <[email protected]>
7		* @version v0.3.1
8		*/
9
10		declare(strict_types = 1);
11
12		namespace AustinHeap\Security\Txt;
13
14		use Exception;
15
16		/**
17		* Writer
18		*
19		* @link https://github.com/austinheap/php-security-txt
20		* @link https://packagist.org/packages/austinheap/php-security-txt
21		* @link https://austinheap.github.io/php-security-txt/classes/AustinHeap.Security.Txt.Writer.html
22		*/
23		class Writer extends SecurityTxt
24		{
25
26		/**
27		* Internal lines cache.
28		*
29		* @var array
30		*/
31		private $lines = [];
32
33		/**
34		* Create a new Writer instance.
35		*
36		* @return \AustinHeap\Security\Txt\Writer
37		*/
38		public function __construct()
39		{
40		return parent::__construct($this);
41		}
42
43		/**
44		* Add a comment to the output buffer.
45		*
46		* @param string $comment
47		*
48		* @return \AustinHeap\Security\Txt\Writer
49		*/
50		public function comment(string $comment = ''): Writer
51		{
52		$comment = trim($comment);
53
54		if (!empty($comment)) {
55		$comment = ' ' . $comment;
56		}
57
58		return $this->line(trim('#' . $comment));
59		}
60
61		/**
62		* Add a spacer to the output buffer.
63		*
64		* @return \AustinHeap\Security\Txt\Writer
65		*/
66		public function spacer(): Writer
67		{
68		return $this->line('');
69		}
70
71		/**
72		* Add multiple spacers to the output buffer.
73		*
74		* @return \AustinHeap\Security\Txt\Writer
75		*/
76		public function spacers($count = 1): Writer
77		{
78		for ($x = 0; $x < $count; $x++) {
79		$this->spacer();
80		}
81
82		return $this;
83		}
84
85		/**
86		* Add a line.
87		*
88		* @param string $line
89		*
90		* @return \AustinHeap\Security\Txt\Writer
91		*/
92		public function line(string $line): Writer
93		{
94		$this->lines[] = $line;
95
96		return $this;
97		}
98
99		/**
100		* Add multiple lines.
101		*
102		* @param array $lines
103		*
104		* @return \AustinHeap\Security\Txt\Writer
105		*/
106		public function lines(array $lines): Writer
107		{
108		foreach ($lines as $line) {
109		$this->line($line);
110		}
111
112		return $this;
113		}
114
115		/**
116		* Reset the output buffer.
117		*
118		* @return \AustinHeap\Security\Txt\Writer
119		*/
120		public function reset(): Writer
121		{
122		$this->lines = [];
123
124		return $this;
125		}
126
127		/**
128		* Generate the data.
129		*
130		* @return \AustinHeap\Security\Txt\Writer
131		* @throws Exception
132		*/
133		public function generate(): Writer
134		{
135		if ($this->debug) {
136		$time = microtime(true);
137		}
138
139		if ($this->comments) {
140		$this->comment('Our security address');
141		}
142
143		if (empty($this->contacts)) {
144		throw new Exception('One (or more) contacts must be defined.');
145		}
146
147		foreach (array_keys($this->contacts) as $contact) {
148		$this->line('Contact: ' . trim($contact));
149		}
150
151	View Code Duplication	if (!empty($this->encryption)) {
		0 ignored issues – show Duplication introduced 2017-11-19 07:59 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
152		if ($this->comments) {
153		$this->spacer()
154		->comment('Our PGP key');
155		}
156
157		$this->line('Encryption: ' . trim($this->encryption));
158		}
159
160		if (!empty($this->disclosure)) {
161		if ($this->comments) {
162		$this->spacer()
163		->comment('Our disclosure policy');
164		}
165
166		$this->line('Disclosure: ' . trim(ucfirst($this->disclosure)));
167		}
168
169	View Code Duplication	if (!empty($this->acknowledgement)) {
		0 ignored issues – show Duplication introduced 2017-11-19 07:59 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
170		if ($this->comments) {
171		$this->spacer()
172		->comment('Our public acknowledgement');
173		}
174
175		$this->line('Acknowledgement: ' . trim($this->acknowledgement));
176		}
177
178		if ($this->debug && isset($time)) {
179		$this->spacer()
180		->comment()
181		->comment(
182		'Generated by "' . (defined('LARAVEL_SECURITY_TXT_VERSION') ? 'laravel' : (defined('WORDPRESS_SECURITY_TXT_VERSION') ? 'wordpress' : 'php')) . '-security-txt"' .
183		(defined('LARAVEL_SECURITY_TXT_VERSION') ? ' v' . LARAVEL_SECURITY_TXT_VERSION : (defined('WORDPRESS_SECURITY_TXT_VERSION') ? ' v' . WORDPRESS_SECURITY_TXT_VERSION : (defined('PHP_SECURITY_TXT_VERSION') ? ' v' . PHP_SECURITY_TXT_VERSION : ''))) .
		0 ignored issues – show Bug introduced 2017-11-20 20:56 UTC by Report Bug Copy Issue Report The constant `AustinHeap\Security\Txt\...SS_SECURITY_TXT_VERSION` was not found. Maybe you did not declare it correctly or list all dependencies? Loading history... Bug introduced 2017-11-20 20:56 UTC by Report Bug Copy Issue Report The constant `AustinHeap\Security\Txt\...EL_SECURITY_TXT_VERSION` was not found. Maybe you did not declare it correctly or list all dependencies? Loading history...
184		' (https://github.com/austinheap/' . (defined('LARAVEL_SECURITY_TXT_VERSION') ? 'laravel' : (defined('WORDPRESS_SECURITY_TXT_VERSION') ? 'wordpress' : 'php')) . '-security-txt' . (defined('LARAVEL_SECURITY_TXT_VERSION') ? '/releases/tag/v' . LARAVEL_SECURITY_TXT_VERSION : (defined('WORDPRESS_SECURITY_TXT_VERSION') ? '/releases/tag/v' . WORDPRESS_SECURITY_TXT_VERSION : (defined('PHP_SECURITY_TXT_VERSION') ? '/releases/tag/v' . PHP_SECURITY_TXT_VERSION : ''))) . ')');
185		if (defined('LARAVEL_SECURITY_TXT_VERSION') \|\| defined('WORDPRESS_SECURITY_TXT_VERSION')) {
186		$this->comment(
187		'using "php-security-txt"' . (defined('PHP_SECURITY_TXT_VERSION') ? ' v' . PHP_SECURITY_TXT_VERSION : '') .
188		' (https://github.com/austinheap/php-security-txt' . (defined('PHP_SECURITY_TXT_VERSION') ? '/releases/tag/v' . PHP_SECURITY_TXT_VERSION : '') . ')');
189		}
190		$this->comment('in ' . round((microtime(true) - $time) * 1000, 6) . ' seconds on ' . date('c') . '.')
191		->comment()
192		->spacer();
193		}
194
195		$output = implode(PHP_EOL, $this->lines);
196
197		return $this->setText($output);
198		}
199		}
200

austinheap / php-security-txt

Push — master ( fa5ea6...438f4a )

Writer::spacer() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like