AddFileToModule

Complexity

Total Complexity

40

Size/Duplication

Total Lines	329
Duplicated Lines	0 %

Importance

Changes	4
Bugs	2	Features	0

23 Methods

Rating	Name	Duplication	Size	Complexity
A	Contributing()	0	3	1
A	replaceWordsInText()	0	11	3
A	Installation()	0	3	1
A	setSourceLocation()	0	3	1
A	Assistance()	0	3	1
A	getReadMeComponent()	0	15	2
A	SuggestedModules()	0	3	1
A	setRootDirForModule()	0	3	1
A	catchFopenWarning()	0	2	1
A	customiseStandardFile()	0	4	1
A	Configuration()	0	3	1
A	Author()	0	3	1
A	replaceWordsInFile()	0	10	3
A	getCustomisationFile()	0	6	1
A	getStandardFile()	0	26	4
A	run()	0	17	5
A	Requirements()	0	3	1
A	getFileLocation()	0	3	1
A	saveFile()	0	32	6
A	Documentation()	0	3	1
A	__construct()	0	6	1
A	compareWithText()	0	5	1
A	setFileLocation()	0	3	1

<?php
/**
 * adds or replaces a file
 * in a git hub module
 * in a module...
 *
 *
 */

abstract class AddFileToModule extends Object
{
    protected $gitReplaceArray = array(
        '+++long-module-name-goes-here+++' => 'LongModuleName',
        '+++medium-module-name-goes-here+++' => 'MediumModuleName',
        '+++short-module-name-goes-here+++' => 'ShortModuleName',
        '+++module-name-goes-here+++' => 'ShortModuleName',
        '+++short-module-name-first-letter-capital+++' => 'ModuleNameFirstLetterCapital'
    );


    protected $replaceArray = array(
        '+++README_DOCUMENTATION+++' => 'Documentation',
        '+++README_SUGGESTED_MODULES+++' => 'SuggestedModules',
        '+++README_REQUIREMENTS+++' => 'Requirements',
        '+++README_INSTALLATION+++' => 'Installation',
        '+++README_AUTHOR+++' => 'Author',
        '+++README_ASSISTANCE+++' => 'Assistance',
        '+++README_CONTRIBUTING+++' => 'Contributing',
        '+++README_CONFIGURATION+++' => 'Configuration'
    );

    /**
     * root dir for module
     * e.g. /var/www/modules/mymodule
     * no final slash
     *
     * @var string
     */
    protected $rootDirForModule = '';


    /**
     * root dir for module
     * e.g.
     *  - README.md
     *  OR
     *  - docs/index.php
     *
     *
     * @var string
     */
    protected $fileLocation = '';

    /**
     * e.g.
     * http://www.mysite.com/myfile.txt
     * myfile.txt
     * where examples.txt will have the base dir + modulechecks director added to it
     * e.g.
     * examples/myfile.txt becomes
     * /var/www/myproject/modulechecks/examples/myfile.txt
     * @var string
     */
    protected $sourceLocation = 'please set in files that extend ';

    protected $useCustomisationFile = false;

    protected $gitObject=null;

    public function __construct($gitObject)
    {
        parent::__construct();
        $this->gitObject = $gitObject;
        $rootDirForModule = $gitObject->Directory();
        $this->rootDirForModule = $rootDirForModule;
    }

    public function setRootDirForModule($rootDirForModule)
    {
        $this->$rootDirForModule = $rootDirForModule;
    }

    public function setSourceLocation($sourceLocation)
    {
        $this->sourceLocation = $sourceLocation;
    }

    public function setFileLocation($relativeDirAndFileName)
    {
        $this->fileLocation = $relativeDirAndFileName;
    }


    public function run()
    {
        if (! $this->rootDirForModule) {
            user_error('no root dir for module has been set');
        }
        if (! $this->fileLocation) {
            user_error('File location not set');
        }
        $fileContent = $this->getStandardFile();

        if ($this->useCustomisationFile) {
            $fileContent = $this->customiseStandardFile($fileContent);
        }

        $this->saveFile($fileContent);
        if ($fileContent) {
            $this->replaceWordsInFile();
        }
    }

    /**
     * you can either return the string from the
     * `$sourceLocation` or you can just have a string here
     * that returns the data directly....
     *
     * @param string $fileContent
     *
     * @return bool - true on success, false on failure
     */
    protected function getStandardFile()
    {
        $isURL = (strpos($this->sourceLocation, '//') !== false);

        if ($isURL) {
            $fullFileName = $this->sourceLocation;
        } else {
            $fullFileName = Director::baseFolder().'/'.$this->sourceLocation;
        }

        print("<li>$fullFileName</li>");

        $file = fopen($fullFileName, "r");
        if ($file) {

$file is of type false|resource, thus it always evaluated to false.

            $fileSize = filesize($fullFileName);

            if ($fileSize > 0) {
                $fileContents = fread($file, filesize($fullFileName));
            } else {
                $fileContents = "";
            }
            fclose($file);

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

    /**
     * takes the standard file and adds any
     * customisations to it from the module
     *
     * @return bool - true on success, false on failure
     */
    protected function customiseStandardFile($fileContent)
    {
        $obj = $this->getCustomisationFile();
        $fileContent = $obj->customiseFile($this->fileLocation, $fileContent);

The assignment to $fileContent is dead and can be removed.

    }

    /**
     * writes the file
     *
     * @param string $fileContent
     *
     * @return bool - true on success, false on failure
     */
    protected function saveFile($fileContent)
    {
        GeneralMethods::output_to_screen("<li> Adding " . $this->fileLocation . " to module  </li>");

        /*
         * If fileLocation  contains folder, name then need to check
         * if folder exists
         */
        if (strpos($this->fileLocation, '/')!==false) {
            $folderPath = substr($this->fileLocation, 0, strrpos($this->fileLocation, '/'));

            //print_r ($this->rootDirForModule.'/'.$folderPath);

            if (!file_exists($this->rootDirForModule.'/'.$folderPath)) {
                $folder = Filesystem::makeFolder($this->rootDirForModule.'/'.$folderPath);

The assignment to $folder is dead and can be removed.

Are you sure the assignment to $folder is correct as Filesystem::makeFolder($this->rootDirForModule . '/' . $folderPath) targeting Filesystem::makeFolder() seems to always return null.

            }
        }

        if (isset($folderPath)  && !file_exists($this->rootDirForModule.'/'.$folderPath)) {
            user_error('could not find or create directory ' . $this->rootDirForModule.'/'.$folderPath);
        }

        $fileName = $this->rootDirForModule.'/'.$this->fileLocation;
        $this->fileLocation;

        $file = fopen($fileName, "w");

        if ($file) {

$file is of type false|resource, thus it always evaluated to false.

            $result = fwrite($file, $fileContent);

The assignment to $result is dead and can be removed.

            $a = file_exists($fileName);

The assignment to $a is dead and can be removed.

        } else {
            return false;
        }
    }
    /**
     *
     *
     * @return ModuleConfig (instance of ModuleConfigInterface)
     */
    protected function getCustomisationFile()
    {
        require_once(
            $this->rootDirForModule . '/ssmoduleconfigs/ModuleConfig.php'
        );
        return Injector::inst()->get('ModuleConfig');
    }


    protected function getReadMeComponent($componentName)
    {
        $temp_dir = GitHubModule::Config()->get('absolute_temp_folder');
        $moduleName = $this->gitObject->ModuleName;

        $fileName = $temp_dir . '/' . $moduleName . '/docs/en/' . strtoupper($componentName) . '.md';

        set_error_handler(array($this, 'catchFopenWarning'), E_WARNING);
        $file = fopen($fileName, 'r');
        restore_error_handler();

        if ($file) {

$file is of type false|resource, thus it always evaluated to false.

            $content = fread($file, filesize($filename));

The variable $filename does not exist. Did you maybe mean $fileName?

The assignment to $content is dead and can be removed.

        } else {
            $content = "";
        }
    }

    /*
     *
     * */
    private function catchFopenWarning($errno, $errstr)
    {
        //
    }


    protected function Configuration()
    {
        return $this->getReadMeComponent('configuration');

Are you sure the usage of $this->getReadMeComponent('configuration') targeting AddFileToModule::getReadMeComponent() seems to always return null.

    }

    protected function Contributing()
    {
        return $this->getReadMeComponent('contributing');

Are you sure the usage of $this->getReadMeComponent('contributing') targeting AddFileToModule::getReadMeComponent() seems to always return null.

    }

    protected function Documentation()
    {
        return $this->getReadMeComponent('documentation');

Are you sure the usage of $this->getReadMeComponent('documentation') targeting AddFileToModule::getReadMeComponent() seems to always return null.

    }

    protected function Requirements()
    {
        return $this->getReadMeComponent('requirements');

Are you sure the usage of $this->getReadMeComponent('requirements') targeting AddFileToModule::getReadMeComponent() seems to always return null.

    }

    protected function Installation()
    {
        return $this->getReadMeComponent('installation');

Are you sure the usage of $this->getReadMeComponent('installation') targeting AddFileToModule::getReadMeComponent() seems to always return null.

    }

    protected function Author()
    {
        return $this->getReadMeComponent('author');

Are you sure the usage of $this->getReadMeComponent('author') targeting AddFileToModule::getReadMeComponent() seems to always return null.

    }

    protected function Assistance()
    {
        return $this->getReadMeComponent('assistance');

Are you sure the usage of $this->getReadMeComponent('assistance') targeting AddFileToModule::getReadMeComponent() seems to always return null.

    }

    protected function SuggestedModules()
    {
        return $this->getReadMeComponent('suggestedmodules');

Are you sure the usage of $this->getReadMeComponent('suggestedmodules') targeting AddFileToModule::getReadMeComponent() seems to always return null.

    }




    /**
     * @param string $file
     * @param GitHubModule $gitObject
     *
     * @return string
     */
    public function replaceWordsInFile()
    {
        foreach ($this->gitReplaceArray as $searchTerm => $replaceMethod) {
            $fileName = $this->rootDirForModule.'/'.$this->fileLocation;
            GeneralMethods::replaceInFile($fileName, $searchTerm, $this->gitObject->$replaceMethod());
        }

        foreach ($this->replaceArray as $searchTerm => $replaceMethod) {
            $fileName = $this->rootDirForModule.'/'.$this->fileLocation;
            GeneralMethods::replaceInFile($fileName, $searchTerm, $this->$replaceMethod());
        }
    }

    /**
     *
     * @return string
     */
    public function getFileLocation()
    {
        return $this->fileLocation;
    }

    /**
     * @param string $text
     * @return string
     */
    public function replaceWordsInText($text)
    {
        $originalText = $text;

The assignment to $originalText is dead and can be removed.

        foreach ($this->gitReplaceArray as $searchTerm => $replaceMethod) {
            $text = str_replace($searchTerm, $this->gitObject->$replaceMethod(), $text);
        }

        foreach ($this->replaceArray as $searchTerm => $replaceMethod) {
            $text = str_replace($searchTerm, $this->$replaceMethod(), $text);
        }
        return $text;
    }

    public function compareWithText($compareText)
    {
        $fileText = $this->getStandardFile();
        $text = $this->replaceWordsInText($fileText);

$fileText of type false is incompatible with the type string expected by parameter $text of AddFileToModule::replaceWordsInText().

        return (trim($text) == trim($compareText));
    }
}