From 0c4a051859f35c2a61cb190c65d9d5d67bd5d941 Mon Sep 17 00:00:00 2001 From: Gabriel Date: Mon, 15 Jun 2015 12:42:47 +0200 Subject: [PATCH] ISSUE: Including a non-gpl 3rd party library breaks the Terms of Service --- smartest/smartest.board.inc | 1 - smartest/smartest.info | 6 +- smartest/smartest.module | 62 ++++ smartest/smartest.php | 782 -------------------------------------------- 4 files changed, 67 insertions(+), 784 deletions(-) delete mode 100644 smartest/smartest.php diff --git a/smartest/smartest.board.inc b/smartest/smartest.board.inc index bf14fe6..3576bcf 100644 --- a/smartest/smartest.board.inc +++ b/smartest/smartest.board.inc @@ -339,7 +339,6 @@ function smartest_close_widget_form_submit($form, &$form_state){ db_delete('smartest_widget') ->condition('title', $title) ->execute(); - } function update_statistics(){ diff --git a/smartest/smartest.info b/smartest/smartest.info index e05b6a8..5216dc0 100644 --- a/smartest/smartest.info +++ b/smartest/smartest.info @@ -5,13 +5,17 @@ description = A testing module. package = Drupal 7 Development version = "7.x-1" core = 7.x + dependencies[] = simpletest dependencies[] = charts +dependencies[] = libraries + files[] = smartest.module files[] = smartest.pages.inc -files[] = smartest.php files[] = smartest.install files[] = smartest.css +files[] = smartest.board.css files[] = drupal_web_test_case.php +files[] = ../../../all/libraries/phploc/Analyser.php datestamp = "1416429488" \ No newline at end of file diff --git a/smartest/smartest.module b/smartest/smartest.module index 7fdae37..b59001e 100644 --- a/smartest/smartest.module +++ b/smartest/smartest.module @@ -36,6 +36,68 @@ function smartest_theme() { } /** + * Implements hook_requeriments(). + * + * PHPLOC version: 2.1.3 + * latests commit: 4b21840dfe + * branch: master. + * + * Expected to be extracted into 'sites/all/libraries/phploc' + */ +function smartest_requirements($phase) { + $requirements = array(); + // Ensure translations do not break at install time + $t = get_t(); + + $requirements['phploc'] = array( + 'title' => $t('PHPLOC'), + ); + + $libraries = libraries_get_libraries(); + if (isset($libraries['phploc'])) { + $requirements['phploc']['value'] = $t('Installed'); + $requirements['phploc']['severity'] = REQUIREMENT_OK; + } + else { + $requirements['phploc']['value'] = $t('Not Installed'); + $requirements['phploc']['severity'] = REQUIREMENT_ERROR; + $requirements['phploc']['description'] = $t('Please install the Alalyser class of phploc library %url.', array('%url' => 'https://github.com/isa-group/phploc/blob/master/src/Analyser.php')); + } + + return $requirements; +} + +function smartest_autoload_info() { + $path = libraries_get_path('phploc'); + return array( + 'Analizer' => array( + 'file' => 'Analyser.php', + 'file path' => $path, + ), + ); +} + +function smartest_phploc_libraries_info() { + + // Expected to be extracted into 'sites/all/libraries/simple'. + $libraries['phploc'] = array( + 'name' => 'phploc', + 'vendor url' => 'https://github.com/isa-group/phploc/blob/master/src/Analyser.php', + 'download url' => 'https://github.com/isa-group/phploc/blob/master/src/Analyser.php', + 'version arguments' => array( + 'file' => 'Analyser.php', + 'pattern' => '/Class available since Release (\d+1.0.0)/', + 'lines' => 30, + ), + 'files' => array( + 'php' => array('Analyser.php'), + ), + ); + + return $libraries; +} + +/** * Implements hook_menu(). */ function smartest_menu() { diff --git a/smartest/smartest.php b/smartest/smartest.php deleted file mode 100644 index f5cb72c..0000000 --- a/smartest/smartest.php +++ /dev/null @@ -1,782 +0,0 @@ - - * - * For the full copyright and license information, please view the LICENSE - * file that was distributed with this source code. - */ - - - -/** - * PHPLOC code analyser. - * - * @author Sebastian Bergmann - * @copyright Sebastian Bergmann - * @license http://www.opensource.org/licenses/BSD-3-Clause The BSD 3-Clause License - * @link http://github.com/sebastianbergmann/phploc/tree - * @since Class available since Release 1.0.0 - */ -class Analyser -{ - /** - * @var array - */ - private $namespaces = []; - - /** - * @var array - */ - private $classes = []; - - /** - * @var array - */ - private $constants = []; - - /** - * @var array - */ - private $possibleConstantAccesses = []; - - /** - * @var array - */ - private $count = [ - 'files' => 0,//1 files parsed - 'loc' => 0,//2 lines of code - 'lloc' => 0,//3 logical lines of code - 'llocClasses' => 0,//4 - 'llocFunctions' => 0,//5 - 'llocGlobal' => 0,//6 - 'cloc' => 0,//7 comment lines - 'ccn' => 0,//8 ciclomatic complexity - 'ccnMethods' => 0,//9 - 'interfaces' => 0,//10 - 'traits' => 0,//11 - 'classes' => 0,//12 - 'abstractClasses' => 0,//13 - 'concreteClasses' => 0,//14 - 'functions' => 0,//15 - 'namedFunctions' => 0,//16 - 'anonymousFunctions' => 0,//17 - 'methods' => 0,//18 - 'publicMethods' => 0,//19 - 'nonPublicMethods' => 0,//20 - 'nonStaticMethods' => 0,//21 - 'staticMethods' => 0,//22 - 'constants' => 0,//23 - 'classConstants' => 0,//24 - 'globalConstants' => 0,//25 - 'testClasses' => 0,//26 - 'testMethods' => 0,//27 - 'ccnByLloc' => 0,//28 - 'llocByNof' => 0,//29 - 'methodCalls' => 0,//30 - 'staticMethodCalls' => 0,//31 - 'instanceMethodCalls' => 0,//32 - 'attributeAccesses' => 0,//33 - 'staticAttributeAccesses' => 0,//34 - 'instanceAttributeAccesses' => 0,//35 - 'globalAccesses' => 0,//36 - 'globalVariableAccesses' => 0,//37 - 'superGlobalVariableAccesses' => 0,//38 - 'globalConstantAccesses' => 0,//39 - //40 directories - //41 namespaces - 'ncloc' => 0,//42 ncloc (real code lines) - //43 classCcnMin - //44 classCcnAvg - //45 classCcnMax - //46 methodCcnMin - //47 methodCcnAvg - 'methodCcnMax' => 0 //48 methodCcnMax - //49 classllocMin - //50 classllocAvg - //51 classllocMax - //52 methodllocMin - //53 methodllocAvg - //54 methodllocMax - ]; - - /** - * @var array - */ - private $superGlobals = [ - '$_ENV' => true, - '$_POST' => true, - '$_GET' => true, - '$_COOKIE' => true, - '$_SERVER' => true, - '$_FILES' => true, - '$_REQUEST' => true, - '$HTTP_ENV_VARS' => true, - '$HTTP_POST_VARS' => true, - '$HTTP_GET_VARS' => true, - '$HTTP_COOKIE_VARS' => true, - '$HTTP_SERVER_VARS' => true, - '$HTTP_POST_FILES' => true - ]; - - /** - * @var array - */ - private $classCcn = []; - - /** - * @var array - */ - private $classLloc = []; - - /** - * @var array - */ - private $methodCcn = []; - - /** - * @var array - */ - private $methodLloc = []; - - /** - * Processes a set of files. - * - * @param array $files - * @param boolean $countTests - * @return array - * @since Method available since Release 1.2.0 - */ - public function countFiles(array $files, $countTests) - { - if ($countTests) { - foreach ($files as $file) { - $this->preProcessFile($file); - } - } - - $directories = []; - - foreach ($files as $file) { - $directory = dirname($file); - - if (!isset($directories[$directory])) { - $directories[$directory] = true; - } - - $this->countFile($file, $countTests); - } - - $count = $this->count; - - $count['directories'] = count($directories) - 1; - $count['namespaces'] = count($this->namespaces); - $count['classes'] = $count['abstractClasses'] + - $count['concreteClasses']; - $count['functions'] = $count['namedFunctions'] + - $count['anonymousFunctions']; - $count['constants'] = $count['classConstants'] + - $count['globalConstants']; - $count['attributeAccesses'] = $count['staticAttributeAccesses'] + - $count['instanceAttributeAccesses']; - $count['methodCalls'] = $count['staticMethodCalls'] + - $count['instanceMethodCalls']; - $count['llocGlobal'] = $count['lloc'] - - $count['llocClasses'] - - $count['llocFunctions']; - $count['ncloc'] = $count['loc'] - $count['cloc']; - - foreach ($this->possibleConstantAccesses as $possibleConstantAccess) { - if (in_array($possibleConstantAccess, $this->constants)) { - $count['globalConstantAccesses']++; - } - } - - $count['globalAccesses'] = $count['globalConstantAccesses'] + - $count['globalVariableAccesses'] + - $count['superGlobalVariableAccesses']; - - if ($count['lloc'] > 0) { - $count['ccnByLloc'] = $count['ccn'] / $count['lloc']; - } - - if (count($this->classCcn) > 0) { - $count['classCcnMin'] = min($this->classCcn); - $count['classCcnAvg'] = array_sum($this->classCcn) / count($this->classCcn); - $count['classCcnMax'] = max($this->classCcn); - } - - if (count($this->methodCcn) > 0) { - $count['methodCcnMin'] = min($this->methodCcn); - $count['methodCcnAvg'] = array_sum($this->methodCcn) / count($this->methodCcn); - $count['methodCcnMax'] = max($this->methodCcn); - } - - if (count($this->classLloc) > 0) { - $count['classLlocMin'] = min($this->classLloc); - $count['classLlocAvg'] = array_sum($this->classLloc) / count($this->classLloc); - $count['classLlocMax'] = max($this->classLloc); - } - - if (count($this->methodLloc) > 0) { - $count['methodLlocMin'] = min($this->methodLloc); - $count['methodLlocAvg'] = array_sum($this->methodLloc) / count($this->methodLloc); - $count['methodLlocMax'] = max($this->methodLloc); - } - - if ($count['functions'] > 0) { - $count['llocByNof'] = $count['llocFunctions'] / $count['functions']; - } - - return $count; - } - - /** - * Pre-processes a single file. - * - * @param string $filename - * @since Method available since Release 1.2.0 - */ - public function preProcessFile($filename) - { - $tokens = token_get_all(file_get_contents($filename)); - $numTokens = count($tokens); - $namespace = false; - - for ($i = 0; $i < $numTokens; $i++) { - if (is_string($tokens[$i])) { - continue; - } - - switch ($tokens[$i][0]) { - case T_NAMESPACE: - $namespace = $this->getNamespaceName($tokens, $i); - break; - - case T_CLASS: - if (!$this->isClassDeclaration($tokens, $i)) { - continue; - } - - $className = $this->getClassName($namespace, $tokens, $i); - - if (isset($tokens[$i+4]) && is_array($tokens[$i+4]) && - $tokens[$i+4][0] == T_EXTENDS) { - $parent = $this->getClassName($namespace, $tokens, $i + 4); - } else { - $parent = null; - } - - $this->classes[$className] = $parent; - break; - } - } - } - - /** - * Processes a single file. - * - * @param string $filename - * @param boolean $countTests - */ - public function countFile($filename, $countTests) - { - $buffer = file_get_contents($filename); - $this->count['loc'] += substr_count($buffer, "\n"); - $tokens = token_get_all($buffer); - $numTokens = count($tokens); - - unset($buffer); - - $this->count['files']++; - - $blocks = []; - $currentBlock = false; - $namespace = false; - $className = null; - $functionName = null; - $testClass = false; - $currentClassData = null; - $currentMethodData = null; - - for ($i = 0; $i < $numTokens; $i++) { - if (is_string($tokens[$i])) { - $token = trim($tokens[$i]); - - if ($token == ';') { - if ($className !== null && !$testClass) { - $this->count['llocClasses']++; - $currentClassData['lloc']++; - - if ($functionName !== null) { - $currentMethodData['lloc']++; - } - } elseif ($functionName !== null) { - $this->count['llocFunctions']++; - } - - $this->count['lloc']++; - } elseif ($token == '?' && !$testClass) { - if ($className !== null) { - $this->count['ccnMethods']++; - $currentClassData['ccn']++; - $currentMethodData['ccn']++; - } - - $this->count['ccn']++; - } elseif ($token == '{') { - if ($currentBlock == T_CLASS) { - $block = $className; - } elseif ($currentBlock == T_FUNCTION) { - $block = $functionName; - } else { - $block = false; - } - - array_push($blocks, $block); - - $currentBlock = false; - } elseif ($token == '}') { - $block = array_pop($blocks); - - if ($block !== false && $block !== null) { - if ($block == $functionName) { - $functionName = null; - - if ($currentMethodData !== null) { - $this->methodCcn[] = $currentMethodData['ccn']; - $this->methodLloc[] = $currentMethodData['lloc']; - $currentMethodData = null; - } - } elseif ($block == $className) { - $className = null; - $testClass = false; - $this->classCcn[] = $currentClassData['ccn']; - $this->classLloc[] = $currentClassData['lloc']; - $currentClassData = null; - } - } - } - - continue; - } - - list ($token, $value) = $tokens[$i]; - - switch ($token) { - case T_NAMESPACE: - $namespace = $this->getNamespaceName($tokens, $i); - - if (!isset($this->namespaces[$namespace])) { - $this->namespaces[$namespace] = true; - } - break; - - case T_CLASS: - case T_INTERFACE: - case T_TRAIT: - if (!$this->isClassDeclaration($tokens, $i)) { - continue; - } - - $currentClassData = ['ccn' => 1, 'lloc' => 0]; - $className = $this->getClassName($namespace, $tokens, $i); - $currentBlock = T_CLASS; - - if ($token == T_TRAIT) { - $this->count['traits']++; - } elseif ($token == T_INTERFACE) { - $this->count['interfaces']++; - } else { - if ($countTests && $this->isTestClass($className)) { - $testClass = true; - $this->count['testClasses']++; - } else { - if (isset($tokens[$i-2]) && - is_array($tokens[$i-2]) && - $tokens[$i-2][0] == T_ABSTRACT) { - $this->count['abstractClasses']++; - } else { - $this->count['concreteClasses']++; - } - } - } - break; - - case T_FUNCTION: - $currentBlock = T_FUNCTION; - - if (is_array($tokens[$i+2]) && - $tokens[$i+2][0] == T_STRING) { - $functionName = $tokens[$i+2][1]; - } elseif ($tokens[$i+2] == '&' && - is_array($tokens[$i+3]) && - $tokens[$i+3][0] == T_STRING) { - $functionName = $tokens[$i+3][1]; - } else { - $currentBlock = 'anonymous function'; - $functionName = 'anonymous function'; - $this->count['anonymousFunctions']++; - } - - if ($currentBlock == T_FUNCTION) { - if ($className === null && - $functionName != 'anonymous function') { - $this->count['namedFunctions']++; - } else { - $static = false; - $visibility = T_PUBLIC; - - for ($j = $i; $j > 0; $j--) { - if (is_string($tokens[$j])) { - if ($tokens[$j] == '{' || - $tokens[$j] == '}' || - $tokens[$j] == ';') { - break; - } - - continue; - } - - if (isset($tokens[$j][0])) { - switch ($tokens[$j][0]) { - case T_PRIVATE: - $visibility = T_PRIVATE; - break; - - case T_PROTECTED: - $visibility = T_PROTECTED; - break; - - case T_STATIC: - $static = true; - break; - } - } - } - - if ($testClass && - $this->isTestMethod($functionName, $visibility, $static, $tokens, $i)) { - $this->count['testMethods']++; - } elseif (!$testClass) { - $currentMethodData = ['ccn' => 1, 'lloc' => 0]; - - if (!$static) { - $this->count['nonStaticMethods']++; - } else { - $this->count['staticMethods']++; - } - - if ($visibility == T_PUBLIC) { - $this->count['publicMethods']++; - } else { - $this->count['nonPublicMethods']++; - } - - $this->count['methods']++; - } - } - } - break; - - case T_CURLY_OPEN: - $currentBlock = T_CURLY_OPEN; - array_push($blocks, $currentBlock); - break; - - case T_DOLLAR_OPEN_CURLY_BRACES: - $currentBlock = T_DOLLAR_OPEN_CURLY_BRACES; - array_push($blocks, $currentBlock); - break; - - case T_IF: - case T_ELSEIF: - case T_FOR: - case T_FOREACH: - case T_WHILE: - case T_CASE: - case T_CATCH: - case T_BOOLEAN_AND: - case T_LOGICAL_AND: - case T_BOOLEAN_OR: - case T_LOGICAL_OR: - if (!$testClass) { - if ($currentMethodData !== null) { - $this->count['ccnMethods']++; - $currentClassData['ccn']++; - $currentMethodData['ccn']++; - } - - $this->count['ccn']++; - } - break; - - case T_COMMENT: - case T_DOC_COMMENT: - $lf = substr_count($value, "\n"); - - $this->count['cloc'] += $lf; - - if ($lf > 1) { - $this->count['cloc']++; - } - break; - - case T_CONST: - $this->count['classConstants']++; - break; - - case T_STRING: - if ($value == 'define') { - $this->count['globalConstants']++; - - $j = $i + 1; - - while (isset($tokens[$j]) && $tokens[$j] != ';') { - if (is_array($tokens[$j]) && - $tokens[$j][0] == T_CONSTANT_ENCAPSED_STRING) { - $this->constants[] = str_replace('\'', '', $tokens[$j][1]); - - break; - } - - $j++; - } - } else { - $this->possibleConstantAccesses[] = $value; - } - break; - - case T_DOUBLE_COLON: - case T_OBJECT_OPERATOR: - $n = $this->getNextNonWhitespaceTokenPos($tokens, $i); - $nn = $this->getNextNonWhitespaceTokenPos($tokens, $n); - - if ($n && $nn && - isset($tokens[$n][0]) && - ($tokens[$n][0] == T_STRING || - $tokens[$n][0] == T_VARIABLE) && - $tokens[$nn] == '(') { - if ($token == T_DOUBLE_COLON) { - $this->count['staticMethodCalls']++; - } else { - $this->count['instanceMethodCalls']++; - } - } else { - if ($token == T_DOUBLE_COLON && - $tokens[$n][0] == T_VARIABLE) { - $this->count['staticAttributeAccesses']++; - } elseif ($token == T_OBJECT_OPERATOR) { - $this->count['instanceAttributeAccesses']++; - } - } - break; - - case T_GLOBAL: - $this->count['globalVariableAccesses']++; - break; - - case T_VARIABLE: - if ($value == '$GLOBALS') { - $this->count['globalVariableAccesses']++; - } elseif (isset($this->superGlobals[$value])) { - $this->count['superGlobalVariableAccesses']++; - } - break; - } - } - } - - /** - * @param array $tokens - * @param integer $i - * @return string - * @since Method available since Release 1.3.0 - */ - private function getNamespaceName(array $tokens, $i) - { - if (isset($tokens[$i+2][1])) { - $namespace = $tokens[$i+2][1]; - - for ($j = $i+3;; $j += 2) { - if (isset($tokens[$j]) && $tokens[$j][0] == T_NS_SEPARATOR) { - $namespace .= '\\' . $tokens[$j+1][1]; - } else { - break; - } - } - - return $namespace; - } - - return false; - } - - /** - * @param string $namespace - * @param array $tokens - * @param integer $i - * @return string - * @since Method available since Release 1.3.0 - */ - private function getClassName($namespace, array $tokens, $i) - { - $i += 2; - $namespaced = false; - - if (!isset($tokens[$i][1])) { - return 'invalid class name'; - } - - $className = $tokens[$i][1]; - - if ($className === '\\') { - $namespaced = true; - } - - while (is_array($tokens[$i+1]) && $tokens[$i+1][0] !== T_WHITESPACE) { - $className .= $tokens[++$i][1]; - } - - if (!$namespaced && $namespace !== false) { - $className = $namespace . '\\' . $className; - } - - return $className; - } - - /** - * @param string $className - * @return boolean - * @since Method available since Release 1.2.0 - */ - private function isTestClass($className) - { - $parent = $this->classes[$className]; - $result = false; - $count = 0; - - // Check ancestry for PHPUnit_Framework_TestCase. - while ($parent !== null) { - $count++; - - if ($count > 100) { - // Prevent infinite loops and just bail - break; - } - - if ($parent == 'PHPUnit_Framework_TestCase' || - $parent == '\\PHPUnit_Framework_TestCase') { - $result = true; - break; - } - - if (isset($this->classes[$parent]) && $parent !== $this->classes[$parent]) { - $parent = $this->classes[$parent]; - } else { - // Class has a parent that is declared in a file - // that was not pre-processed. - break; - } - } - - // Fallback: Treat the class as a test case class if the name - // of the parent class ends with "TestCase". - if (!$result) { - if (substr($this->classes[$className], -8) == 'TestCase') { - $result = true; - } - } - - return $result; - } - - /** - * @param string $functionName - * @param integer $visibility - * @param boolean $static - * @param array $tokens - * @param integer $currentToken - * @return boolean - * @since Method available since Release 2.0.0 - */ - private function isTestMethod($functionName, $visibility, $static, array $tokens, $currentToken) - { - if ($static || $visibility != T_PUBLIC) { - return false; - } - - if (strpos($functionName, 'test') === 0) { - return true; - } - - while ($tokens[$currentToken][0] != T_DOC_COMMENT) { - if ($tokens[$currentToken] == '{' || $tokens[$currentToken] == '}') { - return false; - } - - --$currentToken; - } - - return strpos($tokens[$currentToken][1], '@test') !== false || - strpos($tokens[$currentToken][1], '@scenario') !== false; - } - - /** - * @param array $tokens - * @param integer $start - * @return boolean - */ - private function getNextNonWhitespaceTokenPos(array $tokens, $start) - { - if (isset($tokens[$start+1])) { - if (isset($tokens[$start+1][0]) && - $tokens[$start+1][0] == T_WHITESPACE && - isset($tokens[$start+2])) { - return $start + 2; - } else { - return $start + 1; - } - } - - return false; - } - - /** - * @param array $tokens - * @param integer $start - * @return boolean - */ - private function getPreviousNonWhitespaceTokenPos(array $tokens, $start) - { - if (isset($tokens[$start-1])) { - if (isset($tokens[$start-1][0]) && - $tokens[$start-1][0] == T_WHITESPACE && - isset($tokens[$start-2])) { - return $start - 2; - } else { - return $start - 1; - } - } - - return false; - } - - /** - * @param array $tokens - * @param integer $i - * @return boolean - */ - private function isClassDeclaration(array $tokens, $i) - { - $n = $this->getPreviousNonWhitespaceTokenPos($tokens, $i); - - if (isset($tokens[$n]) && is_array($tokens[$n]) && - $tokens[$n][0] == T_DOUBLE_COLON) { - return false; - } - - return true; - } -} -- 1.9.5.msysgit.0