Requirements_Backend_For_Webpack - Code Metrics - Inspection of "MINOR: creating required file on flush if they don..." - sunnysideup/silverstripe-webpack_requirements_backend - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( bafc4e...3bad92 )

by Nicolaas

created 2017-08-31 05:12 UTC

Requirements_Backend_For_Webpack D

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	468
Duplicated Lines	0 %

Coupling/Cohesion

Components	2
Dependencies	7

Importance

Changes

Metric	Value
wmc	81
lcom	2
cbo	7
dl	0
loc	468
rs	4.8717
c	0
b	0
f	0

22 Methods

Rating	Name	Size	Complexity
A	set_webpack_variables_file_location()	4	1
A	set_files_to_ignore()	4	1
A	get_files_to_ignore()	4	1
A	set_working_theme_folder_extension()	4	1
A	get_working_theme_folder_extension()	4	1
A	set_copy_css_to_folder()	4	1
A	set_copy_js_to_folder()	4	1
A	set_urls_to_exclude()	4	1
A	get_urls_to_exclude()	4	1
A	set_force_update()	4	1
A	get_force_update()	4	1
A	webpack_current_theme_as_set_in_db()	12	3
A	webpack_theme_folder_for_customisation()	4	1
D	includeInHTML()	103	35
A	include_in_response()	10	2
A	canSaveRequirements()	11	4
A	themedRequest()	4	3
D	moveFileToRequirementsFolder()	41	10
A	copyIfYouCan()	10	2
A	addLinesToFile()	11	2
A	makeFolderWritable()	12	4
B	flush()	33	4

How to fix Complexity

<?php

/**
 * Requirements_Backend_For_Webpack::set_files_to_ignore(
 *  'mysite/javascript/myfile.js';
 * );
 *
 *
 */
class Requirements_Backend_For_Webpack extends Requirements_Backend implements flushable
namespace YourVendor;

class YourClass { }
{


    /**
     * @var string
     */
    private static $webpack_variables_file_location = 'themes/webpack-variables.js';

    /**
     * we need this method because Requirements_Backend does not extend Object!
     * @param string
     */
    public static function set_webpack_variables_file_location($str)

    {
        self::$webpack_variables_file_location = $tr;

    }

    /**
     * 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!
     * @var array $array
     */
    public static function set_files_to_ignore($array)
    {
        self::$files_to_ignore = $array;
    }

    /**
     * @return array
     */
    public static function get_files_to_ignore()
    {
        return self::$files_to_ignore = $array;

    }

    /**
     * @var string
     */
    private static $working_theme_folder_extension = "mysite";

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


    /**
     * we need this method because Requirements_Backend does not extend Object!
     * @return string
     */
    public static function get_working_theme_folder_extension()
    {
        return self::$working_theme_folder_extension = $string;

    }

    /**
     * @var string
     */
    private static $copy_css_to_folder = "src/raw_requirements/css";

    /**
     * we need this method because Requirements_Backend does not extend Object!
     * @var 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 = "src/raw_requirements/js";

    /**
     * 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 array
     */
    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;
    }

    /**
     *
     * @return array
     */
    public static function get_urls_to_exclude()
    {
        return self::$urls_to_exclude;
    }

    /**
     * @var bool
     */
    private static $force_update = true;

    /**
     *
     * @param bool
     */
    public static function set_force_update($bool)
    {
        self::$force_update = $bool;
    }


    /**
     *
     * @return 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;


    /**
     * @return string
     */
    protected static function webpack_current_theme_as_set_in_db()
    {
        $v = null;
        if(Security::database_is_ready()) {
            $v = SiteConfig::current_site_config()->Theme;
        }
        if(! $v) {
            $v = Config::inst()->get('SSViewer', 'current_theme');
        }

        return $v;
    }


    /**
     * @return string
     */
    protected static function webpack_theme_folder_for_customisation()
    {
        return '/themes/'.self::webpack_current_theme_as_set_in_db().'_'.self::$working_theme_folder_extension.'/';
    }


    /**
     * 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()) {
                    $themeFolderForSavingFiles = self::webpack_theme_folder_for_customisation();
                    //css
                    $cssFolder = $themeFolderForSavingFiles.self::$copy_css_to_folder;

                    foreach ($requirementsCSSFiles as $cssFile) {
                        $this->moveFileToRequirementsFolder($cssFile, $cssFolder);
                    }
                    //js
                    $jsFolder = $themeFolderForSavingFiles.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($line, $lines)) {
                $this->addLinesToFile($logFile, $fileLocation);
            }
        } 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)) {
                $this->addLinesToFile($logFile, $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);
                }
            }
        }
    }

    protected $addLinesToFileCount = 0;

    protected function copyIfYouCan($from, $to)
    {
        try {
            copy($from, $to);
        }
        catch(Exception $e) {
            $this->makeFolderWritable();

            $this->copyIfYouCan($from, $to);
        }
    }

    protected function addLinesToFile($fileLocation, $line)
    {
        try {
            $handle = fopen($fileLocation, 'a');
            fwrite($handle, $line);
        }
        catch(Exception $e) {
            $this->makeFolderWritable();

            $this->addLinesToFile($fileLocation, $lines);

        }
    }

    protected function makeFolderWritable($fileLocation)
    {
        if(file_exists($fileLocation)) {
            $iterator = new RecursiveIteratorIterator(new RecursiveDirectoryIterator(dirname($fileLocation)));
            foreach($iterator as $item) {
                chmod($item, '0664');
            }
            if($this->addLinesToFileCount < 3) {
                $this->addLinesToFileCount++;
            }
        }
    }


    public static function flush()
// 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);
    }
}
    {
        //make raw requirements writeable
        $base = Director::baseFolder();
        $themeFolderForCustomisation = self::webpack_theme_folder_for_customisation();
        $rawFolders = [
            $base.'/'.$themeFolderForCustomisation.'/src/sass',
            $base.'/'.$themeFolderForCustomisation.'/'.self::$copy_css_to_folder,
            $base.'/'.$themeFolderForCustomisation.'/'.self::$copy_js_to_folder
        ];
        foreach($rawFolders as $folder) {
            Filesystem::makeFolder($folder);
        }
        $files = [
            $base.'/'.$themeFolderForCustomisation.'/src/main.js',
            $base.$themeFolderForCustomisation.'/src/sass/styles.sass'
        ];
        foreach($files as $file) {
            if(!file_exists($file)){
                file_put_contents($file, '//add your customisations in this file');
            }
        }

        $varArray = [
            'themeName' => self::webpack_current_theme_as_set_in_db(),
            'devWebAddress' => $_SERVER['HTTP_HOST'],
            'distributionFolder' => self::webpack_current_theme_as_set_in_db().'_'.Config::inst()->get('WebpackPageControllerExtension', 'webpack_distribution_folder_extension')
        ];
        $str = 'module.exports = '.json_encode($varArray).'';
        file_put_contents($base.'/'.self::$webpack_variables_file_location, $str);


    }


}


1			<?php
2
3			/**
4			* Requirements_Backend_For_Webpack::set_files_to_ignore(
5			* 'mysite/javascript/myfile.js';
6			* );
7			*
8			*
9			*/
10			class Requirements_Backend_For_Webpack extends Requirements_Backend implements flushable
			0 ignored issues – show Coding Style Compatibility introduced 2017-08-30 04:58 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...
11			{
12
13
14			/**
15			* @var string
16			*/
17			private static $webpack_variables_file_location = 'themes/webpack-variables.js';
18
19			/**
20			* we need this method because Requirements_Backend does not extend Object!
21			* @param string
22			*/
23			public static function set_webpack_variables_file_location($str)
			0 ignored issues – show Unused Code introduced 2017-08-30 04:58 UTC by Report Bug Copy Issue Report The parameter `$str` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
24			{
25			self::$webpack_variables_file_location = $tr;
			0 ignored issues – show Bug introduced 2017-08-30 04:58 UTC by Report Bug Copy Issue Report The variable `$tr` does not exist. Did you forget to declare it? This check marks access to variables or properties that have not been declared yet. While PHP has no explicit notion of declaring a variable, accessing it before a value is assigned to it is most likely a bug. Loading history...
26			}
27
28			/**
29			* e.g. /mysite/javascript/test.js
30			* @var array
31			*/
32			private static $files_to_ignore = array();
33
34			/**
35			* we need this method because Requirements_Backend does not extend Object!
36			* @var array $array
37			*/

sunnysideup / silverstripe-webpack_requirements_backend

Push — master ( bafc4e...3bad92 )

Requirements_Backend_For_Webpack D

Complexity

Size/Duplication

Coupling/Cohesion

Importance

22 Methods

How to fix Complexity

Complex Class

Duplication Side-by-Side

Filter issues like