Requirements_Backend_For_Webpack::includeInHTML() - Code Metrics - Inspection of "MINOR: allow exclusions" - sunnysideup/silverstripe-webpack_requirements_backend - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( d208c8...974e64 )

by Nicolaas

created 2017-06-13 07:58 UTC

Requirements_Backend_For_Webpack::includeInHTML() D

↳ Parent: Requirements_Backend_For_Webpack

Complexity

Conditions	35
Paths	201

Size

Total Lines	103
Code Lines	54

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	103
rs	4.0824
c	0
b	0
f	0
cc	35
eloc	54
nc	201
nop	2

How to fix Long Method Complexity

<?php

/**
 *
 *
 *
 */
class Requirements_Backend_For_Webpack extends Requirements_Backend
namespace YourVendor;

class YourClass { }
{


    /**
     * e.g. /mysite/javascript/test.js
     * @ var array
     */
    private static $files_to_ignore = array();

    /**
     * we need this method because Requirements_Backend does not extend Object!
     * @param array $array
     */
    public static function set_files_to_ignore($array)
    {
        self::$files_to_ignore = $array;
    }

    /**
     * @ var string
     */
    private static $copy_css_to_folder = "source/css/requirements";

    /**
     * we need this method because Requirements_Backend does not extend Object!
     * @param string $string
     */
    public static function set_copy_css_to_folder($string)
    {
        self::$copy_css_to_folder = $string;
    }

    /**
     * @ var string
     */
    private static $copy_js_to_folder = "source/js/requirements";

    /**
     * we need this method because Requirements_Backend does not extend Object!
     * @param string $string
     */
    public static function set_copy_js_to_folder($string)
    {
        self::$copy_js_to_folder = $string;
    }

    /**
     * @ var string
     */
    private static $urls_to_exclude = array();

    /**
     * we need this method because Requirements_Backend does not extend Object!
     * @param array $array
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
     */
    public static function set_urls_to_exclude($a)
    {
        self::$urls_to_exclude = $a;
    }
    public static function get_urls_to_exclude()
    {
        return self::$urls_to_exclude;
    }

    /**
     * @ var bool
     */
    private static $force_update = true;
    public static function set_force_update($bool)
    {
        self::$force_update = $bool;
    }
    public static function get_force_update($bool)

    {
        return self::$force_update;
    }

    /**
     * Whether to add caching query params to the requests for file-based requirements.
     * Eg: themes/myTheme/js/main.js?m=123456789. The parameter is a timestamp generated by
     * filemtime. This has the benefit of allowing the browser to cache the URL infinitely,
     * while automatically busting this cache every time the file is changed.
     *
     * @var bool
     */
    protected $suffix_requirements = false;

    /**
     * Whether to combine CSS and JavaScript files
     *
     * @var bool
     */
    protected $combined_files_enabled = false;


    /**
     * Force the JavaScript to the bottom of the page, even if there's a script tag in the body already
     *
     * @var boolean
     */
    protected $force_js_to_bottom = true;

    /**
     * Update the given HTML content with the appropriate include tags for the registered
     * requirements. Needs to receive a valid HTML/XHTML template in the $content parameter,
     * including a head and body tag.
     *
     * @param string $templateFile No longer used, only retained for compatibility
     * @param string $content      HTML content that has already been parsed from the $templateFile
     *                             through {@link SSViewer}
     * @return string HTML content augmented with the requirements tags
     */
    public function includeInHTML($templateFile, $content)
    {
        if ($this->themedRequest()) {

            //=====================================================================
            // start copy-ish from parent class

            $hasHead = (strpos($content, '</head>') !== false || strpos($content, '</head ') !== false) ? true : false;
            $hasRequirements = ($this->css || $this->javascript || $this->customCSS || $this->customScript || $this->customHeadTags) ? true: false;

            if ($hasHead && $hasRequirements) {
                $requirements = '';
                $jsRequirements = '';
                $requirementsCSSFiles = array();
                $requirementsJSFiles = array();

                // Combine files - updates $this->javascript and $this->css
                $this->process_combined_files();
                $isDev = Director::isDev();
                foreach (array_diff_key($this->javascript, $this->blocked) as $file => $dummy) {
                    $ignore = in_array($file, self::$files_to_ignore) ? true : false;
                    if($isDev || $ignore) {
                        $path = Convert::raw2xml($this->path_for_file($file));

                        if ($path) {
                            if ($isDev) {
                                $requirementsJSFiles[$path] = $path;
                            }
                            if(in_array($file, self::$files_to_ignore)) {
                                $jsRequirements .= "<script type=\"text/javascript\" src=\"$path\"></script>\n";
                            }
                        }
                    }
                }

                // Add all inline JavaScript *after* including external files they might rely on
                if ($this->customScript) {

                    foreach (array_diff_key($this->customScript, $this->blocked) as $script) {
                        $jsRequirements .= "<script type=\"text/javascript\">\n//<![CDATA[\n";
                        $jsRequirements .= "$script\n";
                        $jsRequirements .= "\n//]]>\n</script>\n";
                    }
                }

                foreach (array_diff_key($this->css, $this->blocked) as $file => $params) {
                    $ignore = in_array($file, self::$files_to_ignore) ? true : false;
                    if($isDev || $ignore) {
                        $path = Convert::raw2xml($this->path_for_file($file));

                        if ($path) {
                            $media = (isset($params['media']) && !empty($params['media'])) ? $params['media'] : "";
                            if ($isDev) {
                                $requirementsCSSFiles[$path."_".$media] = $path;
                            }
                            if($ignore) {
                                if($media !== '') {
                                    $media = " media=\"{$media}\"";
                                }
                                $requirements .= "<link rel=\"stylesheet\" type=\"text/css\"{$media} href=\"$path\" />\n";
                            }
                        }
                    }
                }

                foreach (array_diff_key($this->customCSS, $this->blocked) as $css) {
                    $requirements .= "<style type=\"text/css\">\n$css\n</style>\n";
                }

                foreach (array_diff_key($this->customHeadTags, $this->blocked) as $customHeadTag) {
                    $requirements .= "$customHeadTag\n";
                }

                // Remove all newlines from code to preserve layout
                $jsRequirements = preg_replace('/>\n*/', '>', $jsRequirements);

                // Forcefully put the scripts at the bottom of the body instead of before the first
                // script tag.
                $content = preg_replace("/(<\/body[^>]*>)/i", $jsRequirements . "\\1", $content);

                // Put CSS at the bottom of the head
                $content = preg_replace("/(<\/head>)/i", $requirements . "\\1", $content);

                //end copy-ish from parent class
                //=====================================================================

                //copy files ...
                if ($this->canSaveRequirements()) {

                    //css
                    $cssFolder = '/themes/'.SSViewer::current_theme().'/'.self::$copy_css_to_folder;


                    foreach ($requirementsCSSFiles as $cssFile) {
                        $this->moveFileToRequirementsFolder($cssFile, $cssFolder);
                    }
                    //js
                    $jsFolder = '/themes/'.SSViewer::current_theme().'/'.self::$copy_js_to_folder;

                    foreach ($requirementsJSFiles as $jsFile) {
                        $this->moveFileToRequirementsFolder($jsFile, $jsFolder);
                    }
                }
            }
            return $content;
        } else {
            return parent::includeInHTML($templateFile, $content);
        }
    }

    /**
     * Attach requirements inclusion to X-Include-JS and X-Include-CSS headers on the given
     * HTTP Response
     *
     * @param SS_HTTPResponse $response
     */
    public function include_in_response(SS_HTTPResponse $response)
    {
        if ($this->themedRequest()) {
if (rand(1, 6) > 3) {
//print "Check failed";
} else {
    print "Check succeeded";
}
            //do nothing
        } else {
            return parent::include_in_response($response);
        }
        //$this->process_combined_files();

        //do nothing ...
    }

    /**
     *
     *
     *
     * @return bool

     */
    protected function canSaveRequirements()
    {
        if (Director::isDev()) {
            if ($this->themedRequest()) {
                $socket = @fsockopen('localhost', 3000, $errno, $errstr, 1);
                if ($socket) {
                    return true;
                }
            }
        }
    }

    /**
     *
     *
     * @return bool
     */
    protected function themedRequest()
    {
        return Config::inst()->get('SSViewer', 'theme') && Config::inst()->get('SSViewer', 'theme_enabled') ? true : false;
    }

    protected function moveFileToRequirementsFolder($fileLocation, $folderLocation)
// Bad
class Router
{
    public function generate($path)
    {
        return $_SERVER['HOST'].$path;
    }
}

// Better
class Router
{
    private $host;

    public function __construct($host)
    {
        $this->host = $host;
    }

    public function generate($path)
    {
        return $this->host.$path;
    }
}

class Controller
{
    public function myAction(Request $request)
    {
        // Instead of
        $page = isset($_GET['page']) ? intval($_GET['page']) : 1;

        // Better (assuming you use the Symfony2 request)
        $page = $request->query->get('page', 1);
    }
}
    {
        $base = Director::baseFolder();
        $folderLocationWithBase = $base . $folderLocation;
        Filesystem::makeFolder($folderLocationWithBase);
        if (!file_exists($folderLocationWithBase)) {
            user_error('Please update Requirements_Backend_For_Webpack for the right folder or create '.$folderLocationWithBase);
        }
        if (strpos($fileLocation, "//") !== false) {
            $logFile = $folderLocationWithBase."/EXTERNALS.log";
            $lines = array();
            $line = $_SERVER['REQUEST_URI']." | ".$fileLocation."\n";
            if (file_exists($logFile)) {
                $lines = file($logFile);
            }
            if (! in_array($fileLocation, $lines)) {

                $handle = fopen($logFile, 'a');
                fwrite($handle, $line);
            }
        } else {
            $from = $fileLocation;
            $to = basename($fileLocation);
            $line = '"cp .'.$from.' .'.$folderLocation.$to.'",'."\n";
            $from = $base.$from;
            $to = $folderLocationWithBase . '/' . $to;
            $logFile = $folderLocationWithBase."/TO.INCLUDE.IN.COMPOSER.log";
            $lines = array();
            if (file_exists($logFile)) {
                $lines = file($logFile);
            }
            if (! in_array($line, $lines)) {

                $handle = fopen($logFile, 'a');
                fwrite($handle, $line);
            }
            if (in_array($fileLocation, self::$files_to_ignore)) {
if (rand(1, 6) > 3) {
//print "Check failed";
} else {
    print "Check succeeded";
}
                //to be completed ...
            } else {
                if (! file_exists($to) || self::$force_update) {
                    copy($from, $to);
                }
            }
        }
    }
}


1			<?php
2
3			/**
4			*
5			*
6			*
7			*/
8			class Requirements_Backend_For_Webpack extends Requirements_Backend
			0 ignored issues – show Coding Style Compatibility introduced 2017-01-10 01:03 UTC by Report Bug Copy Issue Report PSR1 recommends that each class must be in a namespace of at least one level to avoid collisions. You can fix this by adding a namespace to your class: namespace YourVendor; class YourClass { } When choosing a vendor namespace, try to pick something that is not too generic to avoid conflicts with other libraries. Loading history...
9			{
10
11
12			/**
13			* e.g. /mysite/javascript/test.js
14			* @ var array
15			*/
16			private static $files_to_ignore = array();
17
18			/**
19			* we need this method because Requirements_Backend does not extend Object!
20			* @param array $array
21			*/
22			public static function set_files_to_ignore($array)
23			{
24			self::$files_to_ignore = $array;
25			}
26
27			/**
28			* @ var string
29			*/
30			private static $copy_css_to_folder = "source/css/requirements";
31
32			/**
33			* we need this method because Requirements_Backend does not extend Object!
34			* @param string $string
35			*/
36			public static function set_copy_css_to_folder($string)
37			{
38			self::$copy_css_to_folder = $string;
39			}

sunnysideup / silverstripe-webpack_requirements_backend

Push — master ( d208c8...974e64 )

Requirements_Backend_For_Webpack::includeInHTML() D

Complexity

Size

Duplication

Importance

How to fix Long Method Complexity

Long Method

Duplication Side-by-Side

Filter issues like