ModuleChecks

Complexity

Total Complexity

13

Size/Duplication

Total Lines	116
Duplicated Lines	0 %

Importance

Changes	3
Bugs	2	Features	0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	existsOnAddOns()	0	3	1
B	run()	0	37	7
A	hasReadMeFile()	0	3	1
A	checkForDetailsInComposerFile()	0	3	1
A	hasLicense()	0	3	1
A	exitsOnPackagist()	0	3	1
A	hasComposerFile()	0	3	1

<?php

/**
 * check if everything is in plcae for a module
 * some quick and dirty methods ....
 *
 *
 */

class ModuleChecks extends BuildTask
{
    private static $packagist_user_name = '';

The private property $packagist_user_name is not used, and could be removed.

    /**
     * list of methods to run for each module
     * @var array
     */
    private static $methods_to_check = array(

The private property $methods_to_check is not used, and could be removed.

        "exitsOnPackagist",
        "hasReadMeFile",
        "hasLicense",
        "hasComposerFile",
        "existsOnAddOns",
    );

    protected $title = "Check Modules on Github and Packagist";

    protected $description = "Goes through every module on github and checks for some of the basic requirements. You will need to set your GitHub Username in the configs.";

    public function run($request)
    {
        increase_time_limit_to(3600);

        $modules = GitRepoFinder::get_all_repos();

        $gitUser = Config::inst()->get('GitHubModule', "github_user_name");
        $packagistUser = $this->Config()->get("packagist_user_name");

        if ($gitUser && $packagistUser) {
            //all is good ...
        } else {
            user_error("make sure to set your git user name ($gitUser) and packagist username ($packagistUser) via the standard config system");
        }

        $count = 0;
        echo "<h1>Testing ".count($modules)." modules (git user: $gitUser and packagist user: $packagistUser) ...</h1>";

$modules of type string is incompatible with the type Countable|array expected by parameter $var of count().

        $methodsToCheck = $this->Config()->get("methods_to_check");
        foreach ($modules as $module) {

The expression $modules of type string is not traversable.

            $count++;
            $failures = 0;
            echo "<h3><a href=\"https://github.com/".$gitUser."/silverstripe-".$module."\"></a>$count. checking $module</h3>";
            foreach ($methodsToCheck as $method) {
                if (!$this->$method($module)) {
                    $failures++;
                    DB::alteration_message("bad response for $method", "deleted");
                }
            }
            if ($failures == 0) {
                DB::alteration_message("OK", "created");
            }
            echo '
            ';
            @ob_flush();

It seems like you do not handle an error condition for ob_flush(). This can introduce security issues, and is generally not recommended.

Are you sure the usage of ob_flush() is correct as it seems to always return null.

            @flush();

Are you sure the usage of flush() is correct as it seems to always return null.

It seems like you do not handle an error condition for flush(). This can introduce security issues, and is generally not recommended.

        }
        echo "----------------------------- THE END --------------------------";
    }

    /**
     * @param string $name
     *
     * @return boolean
     */
    protected function exitsOnPackagist($name)
    {
        return GeneralMethods::check_location("https://packagist.org/packages/".$this->Config()->get("packagist_user_name")."/$name");
    }


    /**
     * @param string $name
     *
     * @return boolean
     */
    protected function hasLicense($name)
    {
        return GeneralMethods::check_location("https://raw.githubusercontent.com/".Config::inst()->get('GitHubModule', 'github_user_name')."/silverstripe-".$name."/master/LICENSE");
    }

    /**
     * @param string $name
     *
     * @return boolean
     */
    protected function hasComposerFile($name)
    {
        return GeneralMethods::check_location("https://raw.githubusercontent.com/".Config::inst()->get('GitHubModule', 'github_user_name')."/silverstripe-".$name."/master/composer.json");
    }

    /**
     * @param string $name
     *
     * @return boolean
     */
    protected function hasReadMeFile($name)
    {
        return GeneralMethods::check_location("https://raw.githubusercontent.com/".Config::inst()->get('GitHubModule', 'github_user_name')."/silverstripe-".$name."/master/README.md");
    }

    protected function existsOnAddOns($name)
    {
        return GeneralMethods::check_location("http://addons.silverstripe.org/add-ons/".$this->Config()->get("packagist_user_name")."/$name");
    }


    /**
     * checks if a particular variable is present in the composer.json file
     *
     * @param string $name
     * @param string $variable
     * @return boolean
     */
    protected function checkForDetailsInComposerFile($name, $variable)
    {
        die("to be completed");

Using exit here is not recommended.

    }
}