HtmlCompressor::compress() - Code Metrics - Inspection of "Merge pull request #46 from acs-ferreira/patch-1" - rmrevin/yii2-minify-view - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 8137b1...e31cbc )

by Revin

created 2016-11-04 12:57 UTC

HtmlCompressor::compress() A

↳ Parent: HtmlCompressor

Complexity

Conditions	1
Paths	1

Size

Total Lines	5
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1.125

Importance

Changes

Metric	Value
dl	0
loc	5
ccs	2
cts	4
cp	0.5
rs	9.4285
c	0
b	0
f	0
cc	1
eloc	3
nc	1
nop	2
crap	1.125

<?php
/**
 * HtmlCompressor.php
 * @author Revin Roman
 * @link https://rmrevin.ru
 */

namespace rmrevin\yii\minify;

/**
 * Class HtmlCompressor
 * @package rmrevin\yii\minify
 */
class HtmlCompressor
{

    /**
     * @param string $data is either a handle to an open file, or an HTML string
     * @param null|array $options key => value array of execute options
     * The possible keys are:
     *
     *  - `c` or `no-comments` - removes HTML comments
     *  - `s` or `stats` - output filesize savings calculation
     *  - `x` or `extra` - perform extra (possibly unsafe) compression operations
     *
     * Example: HtmlCompressor::compress($HtmlCode, $options = ['no-comments' => true])
     *
     * @return string
     */
    public static function compress($data, $options = null)
    {
        return (new static)
            ->htmlCompress($data, $options);
    }


    /**
     * HTML Compressor 1.0.1
     * Original Author: Tyler Hall <[email protected]>
     * Edited by: Revin Roman <[email protected]>
     * Latest Source and Bug Tracker: http://github.com/tylerhall/html-compressor
     *
     * Attemps to reduce the filesize of an HTML document by removing unnecessary
     * whitespace at the beginning and end of lines, inside closing tags, and
     * stripping blank lines completely. <pre> tags are respected and their contents
     * are left alone. Warning, nested <pre> tags may exhibit unexpected behaviour.
     *
     * This code is licensed under the MIT Open Source License.
     * Copyright (c) 2010 [email protected]
     * Permission is hereby granted, free of charge, to any person obtaining a copy
     * of this software and associated documentation files (the "Software"), to deal
     * in the Software without restriction, including without limitation the rights
     * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
     * copies of the Software, and to permit persons to whom the Software is
     * furnished to do so, subject to the following conditions:
     *
     * The above copyright notice and this permission notice shall be included in
     * all copies or substantial portions of the Software.
     *
     * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
     * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
     * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
     * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
     * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
     * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
     * THE SOFTWARE.
     *
     * @param $data
     * @param null|array $options
     * @return bool|mixed|string
     */
    private function htmlCompress($data, $options = null)
    {
        if (!isset($options)) {
            $options = [];
        }

        $data .= "\n";
        $out = '';
        $inside_pre = false;
        $inside_textarea = false;
        $bytecount = 0;

        while ($line = $this->getLine($data)) {
            $bytecount += strlen($line);

            if ($inside_pre) {
                list($line, $inside_pre) = $this->checkInsidePre($line);
            } elseif ($inside_textarea) {
                list($line, $inside_textarea) = $this->checkInsideTextarea($line);
            } else {
                if (strpos($line, '<pre') !== false) {
                    // Only trim the beginning since we just entered a <pre> block...
                    $line = ltrim($line);

                    // If the <pre> ends on the same line, don't turn on $inside_pre...
                    list($line, $inside_pre) = $this->checkInsidePre($line);
                } elseif (strpos($line, '<textarea') !== false) {
                    // Only trim the beginning since we just entered a <textarea> block...
                    $line = ltrim($line);

                    // If the <textarea> ends on the same line, don't turn on $inside_textarea...
                    list($line, $inside_textarea) = $this->checkInsideTextarea($line);
                } else {
                    // Since we're not inside a <pre> block, we can trim both ends of the line
                    $line = trim($line);

                    // And condense multiple spaces down to one
                    $line = preg_replace('/\s\s+/', ' ', $line);
                }
            }

            // Filter out any blank lines that aren't inside a <pre> block...
            if ($inside_pre || $inside_textarea) {
                $out .= $line;
            } elseif ($line != '') {
                $out .= $line . "\n";
            }
        }

        // Perform any extra (unsafe) compression techniques...
        if (array_key_exists('x', $options) || array_key_exists('extra', $options)) {
            // Can break layouts that are dependent on whitespace between tags
            $out = str_replace(">\n<", '><', $out);
        }

        // Remove HTML comments...
        if (array_key_exists('c', $options) || array_key_exists('no-comments', $options)) {
            $out = preg_replace('/(<!--.*?-->)/ms', '', $out);
            $out = str_replace('<!>', '', $out);
        }

        // Remove the trailing \n
        $out = trim($out);

        // Output either our stats or the compressed data...
        if (array_key_exists('s', $options) || array_key_exists('stats', $options)) {
            $echo = '';
            $echo .= "Original Size: $bytecount\n";
            $echo .= "Compressed Size: " . strlen($out) . "\n";
            $echo .= "Savings: " . round((1 - strlen($out) / $bytecount) * 100, 2) . "%\n";
            echo $echo;
        } else {
            return $out;
        }

        return false;
    }

    /**
     * @param $line
     * @return array
     * @codeCoverageIgnore
     */
    private function checkInsidePre($line)

    {
        $inside_pre = true;

        if ((strpos($line, '</pre') !== false) && (strripos($line, '</pre') >= strripos($line, '<pre'))) {
            $line = rtrim($line);
            $inside_pre = false;
        }

        return [$line, $inside_pre];
    }

    /**
     * @param $line
     * @return array
     * @codeCoverageIgnore
     */
    private function checkInsideTextarea($line)

    {
        $inside_textarea = true;

        if ((strpos($line, '</textarea') !== false) && (strripos($line, '</textarea') >= strripos($line, '<textarea'))) {
            $line = rtrim($line);
            $inside_textarea = false;
        }

        return [$line, $inside_textarea];
    }

    /**
     * Returns the next line from an open file handle or a string
     * @param $data
     * @return bool|string
     * @codeCoverageIgnore
     */
    private function getLine(&$data)
    {
        if (is_resource($data)) {
            return fgets($data);
        }

        if (is_string($data)) {
            if (strlen($data) > 0) {
                $pos = strpos($data, "\n");
                $return = substr($data, 0, $pos) . "\n";
                $data = substr($data, $pos + 1);

                return $return;
            } else {
                return false;
            }
        }

        return false;
    }

    /**
     * @param $data
     * @param null|array $options
     * @return bool|mixed|string
     * @deprecated
     * @codeCoverageIgnore
     */
    private function html_compress($data, $options = null)

    {
        \Yii::warning(sprintf('You are using an deprecated method `%s`.', 'html_compress'));

        return $this->htmlCompress($data, $options);
    }

    /**
     * Returns the next line from an open file handle or a string
     * @param $data
     * @return bool|string
     * @deprecated
     * @codeCoverageIgnore
     */
    private function get_line(&$data)

    {
        \Yii::warning(sprintf('You are using an deprecated method `%s`.', 'get_line'));

        return $this->getLine($data);
    }
}

1			<?php
2			/**
3			* HtmlCompressor.php
4			* @author Revin Roman
5			* @link https://rmrevin.ru
6			*/
7
8			namespace rmrevin\yii\minify;
9
10			/**
11			* Class HtmlCompressor
12			* @package rmrevin\yii\minify
13			*/
14			class HtmlCompressor
15			{
16
17			/**
18			* @param string $data is either a handle to an open file, or an HTML string
19			* @param null\|array $options key => value array of execute options
20			* The possible keys are:
21			*
22			* - `c` or `no-comments` - removes HTML comments
23			* - `s` or `stats` - output filesize savings calculation
24			* - `x` or `extra` - perform extra (possibly unsafe) compression operations
25			*
26			* Example: HtmlCompressor::compress($HtmlCode, $options = ['no-comments' => true])
27			*
28			* @return string
29			*/
30	1		public static function compress($data, $options = null)
31			{
32			return (new static)
33			->htmlCompress($data, $options);
34	1		}
35
36
37			/**
38			* HTML Compressor 1.0.1
39			* Original Author: Tyler Hall <[email protected]>
40			* Edited by: Revin Roman <[email protected]>
41			* Latest Source and Bug Tracker: http://github.com/tylerhall/html-compressor
42			*
43			* Attemps to reduce the filesize of an HTML document by removing unnecessary
44			* whitespace at the beginning and end of lines, inside closing tags, and
45			* stripping blank lines completely. <pre> tags are respected and their contents
46			* are left alone. Warning, nested <pre> tags may exhibit unexpected behaviour.
47			*
48			* This code is licensed under the MIT Open Source License.
49			* Copyright (c) 2010 [email protected]
50			* Permission is hereby granted, free of charge, to any person obtaining a copy
51			* of this software and associated documentation files (the "Software"), to deal
52			* in the Software without restriction, including without limitation the rights
53			* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
54			* copies of the Software, and to permit persons to whom the Software is
55			* furnished to do so, subject to the following conditions:
56			*
57			* The above copyright notice and this permission notice shall be included in
58			* all copies or substantial portions of the Software.
59			*
60			* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
61			* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
62			* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
63			* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
64			* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
65			* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
66			* THE SOFTWARE.
67			*
68			* @param $data
69			* @param null\|array $options
70			* @return bool\|mixed\|string
71			*/
72	1		private function htmlCompress($data, $options = null)
73			{
74			if (!isset($options)) {
75	1		$options = [];
76			}
77
78			$data .= "\n";
79			$out = '';
80			$inside_pre = false;
81			$inside_textarea = false;
82			$bytecount = 0;
83
84			while ($line = $this->getLine($data)) {
85			$bytecount += strlen($line);
86
87			if ($inside_pre) {
88			list($line, $inside_pre) = $this->checkInsidePre($line);
89			} elseif ($inside_textarea) {
90			list($line, $inside_textarea) = $this->checkInsideTextarea($line);
91			} else {
92			if (strpos($line, '<pre') !== false) {
93			// Only trim the beginning since we just entered a <pre> block...
94			$line = ltrim($line);
95
96			// If the <pre> ends on the same line, don't turn on $inside_pre...
97			list($line, $inside_pre) = $this->checkInsidePre($line);
98			} elseif (strpos($line, '<textarea') !== false) {
99			// Only trim the beginning since we just entered a <textarea> block...
100			$line = ltrim($line);
101
102			// If the <textarea> ends on the same line, don't turn on $inside_textarea...
103			list($line, $inside_textarea) = $this->checkInsideTextarea($line);
104			} else {
105			// Since we're not inside a <pre> block, we can trim both ends of the line
106			$line = trim($line);
107
108			// And condense multiple spaces down to one
109			$line = preg_replace('/\s\s+/', ' ', $line);
110			}
111			}
112
113			// Filter out any blank lines that aren't inside a <pre> block...
114			if ($inside_pre \|\| $inside_textarea) {
115			$out .= $line;
116			} elseif ($line != '') {
117			$out .= $line . "\n";
118			}
119			}
120
121			// Perform any extra (unsafe) compression techniques...
122			if (array_key_exists('x', $options) \|\| array_key_exists('extra', $options)) {
123			// Can break layouts that are dependent on whitespace between tags
124			$out = str_replace(">\n<", '><', $out);
125			}
126
127			// Remove HTML comments...
128			if (array_key_exists('c', $options) \|\| array_key_exists('no-comments', $options)) {
129			$out = preg_replace('/(<!--.*?-->)/ms', '', $out);
130			$out = str_replace('<!>', '', $out);
131			}
132
133			// Remove the trailing \n
134			$out = trim($out);
135
136			// Output either our stats or the compressed data...
137			if (array_key_exists('s', $options) \|\| array_key_exists('stats', $options)) {
138	1		$echo = '';
139	1		$echo .= "Original Size: $bytecount\n";
140			$echo .= "Compressed Size: " . strlen($out) . "\n";
141			$echo .= "Savings: " . round((1 - strlen($out) / $bytecount) * 100, 2) . "%\n";
142	1		echo $echo;
143			} else {
144			return $out;
145	1		}
146
147	1		return false;
148			}
149
150			/**
151			* @param $line
152			* @return array
153			* @codeCoverageIgnore
154			*/
155		View Code Duplication	private function checkInsidePre($line)
			0 ignored issues – show Duplication introduced 2016-02-23 19:34 UTC by Report Bug Copy Issue Report This method seems to be duplicated in 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...
156			{
157			$inside_pre = true;
158
159			if ((strpos($line, '</pre') !== false) && (strripos($line, '</pre') >= strripos($line, '<pre'))) {
160			$line = rtrim($line);
161			$inside_pre = false;
162			}
163
164			return [$line, $inside_pre];
165			}
166
167			/**
168			* @param $line
169			* @return array
170			* @codeCoverageIgnore
171			*/
172		View Code Duplication	private function checkInsideTextarea($line)
			0 ignored issues – show Duplication introduced 2016-02-23 19:34 UTC by Report Bug Copy Issue Report This method seems to be duplicated in 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...
173			{
174			$inside_textarea = true;
175
176			if ((strpos($line, '</textarea') !== false) && (strripos($line, '</textarea') >= strripos($line, '<textarea'))) {
177			$line = rtrim($line);
178			$inside_textarea = false;
179			}
180
181			return [$line, $inside_textarea];
182			}
183
184			/**
185			* Returns the next line from an open file handle or a string
186			* @param $data
187			* @return bool\|string
188			* @codeCoverageIgnore
189			*/
190			private function getLine(&$data)
191			{
192			if (is_resource($data)) {
193			return fgets($data);
194			}
195
196			if (is_string($data)) {
197			if (strlen($data) > 0) {
198			$pos = strpos($data, "\n");
199			$return = substr($data, 0, $pos) . "\n";
200			$data = substr($data, $pos + 1);
201
202			return $return;
203			} else {
204			return false;
205			}
206			}
207
208			return false;
209			}
210
211			/**
212			* @param $data
213			* @param null\|array $options
214			* @return bool\|mixed\|string
215			* @deprecated
216			* @codeCoverageIgnore
217			*/
218			private function html_compress($data, $options = null)
			0 ignored issues – show Unused Code introduced 2016-01-19 00:48 UTC by Report Bug Copy Issue Report This method is not used, and could be removed. Loading history...
219			{
220			\Yii::warning(sprintf('You are using an deprecated method `%s`.', 'html_compress'));
221
222			return $this->htmlCompress($data, $options);
223			}
224
225			/**
226			* Returns the next line from an open file handle or a string
227			* @param $data
228			* @return bool\|string
229			* @deprecated
230			* @codeCoverageIgnore
231			*/
232			private function get_line(&$data)
			0 ignored issues – show Unused Code introduced 2016-01-19 00:48 UTC by Report Bug Copy Issue Report This method is not used, and could be removed. Loading history...
233			{
234			\Yii::warning(sprintf('You are using an deprecated method `%s`.', 'get_line'));
235
236			return $this->getLine($data);
237			}
238			}

rmrevin / yii2-minify-view

Push — master ( 8137b1...e31cbc )

HtmlCompressor::compress() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like