Changeset 32005

Timestamp:

02/07/11 16:18:09 (2 years ago)

Author:

lombardot

Message:

[sfProjectAnalyser] Check dockblocks for all your classes & methods

Files:

• plugins/sfProjectAnalyserPlugin/branches/1.4/lib/objects/paInterface.class.php (modified) (4 diffs)
• plugins/sfProjectAnalyserPlugin/branches/1.4/lib/objects/paMethod.class.php (added)
• plugins/sfProjectAnalyserPlugin/branches/1.4/lib/objects/paSfProject.class.php (modified) (11 diffs)

plugins/sfProjectAnalyserPlugin/branches/1.4/lib/objects/paInterface.class.php

@@ -23 +23 @@
-   */
-  protected $codeLength = 0;
+  
+  /**
+   * @var Integer  Comment lines if the code
+   */
+  protected $commentsLength = 0;
+  
+  
+  /**
+   * @var String  The doc comment block of the function is it exists
+   */
+  public $docComment;
+  
+  
+  /**
+   * @var Array The list of PaMethods
+   */
+  protected $paMethods;
+  
-
-  /* GETTERS / SETTERS ********************************************************/
@@ -51 +69 @@
-  }
-
+  public function getCommentsLength()
+  {
+    return $this->commentsLength;
+  }
+  
+  public function getMethods()
+  {
+    return $this->paMethods;
+  }
+  
+  public function setDocComment($docComment)
+  {
+   $this->docComment     = $docComment;
+   $this->commentsLength = !empty($docComment) ? count(explode("\n", $docComment)) : 0;
+  }
+  
-  /* END GETTERS / SETTERS ****************************************************/
-
@@ -86 +120 @@
-  }
-
+ public function getGlobalConfig()
+  {
+    $config = $this->getParent()->getConfig();
+    return $config['global'];
+  }
+
+  
+  
-  /**
-   * Check specific alerts.
@@ -94 +136 @@
-  public function processAlerts()
-  {
+      $globalConfig = $this->getGlobalConfig();
+      $config       = array();
+      $paMethods = array();
+      
+      $this->reflection=new ReflectionClass($this->getName());   
+      $this->processAlert4002($globalConfig,$config);
+      
+      foreach ($this->reflection->getMethods() as $method){
+          $paMethod=new paMethod($this,$method->getName());
+          $paMethod->setDocComment($method->getDocComment());
+          $paMethod->process();
+          $paMethods[] = $paMethod;
+      }
+      
+      $this->paMethods = $paMethods;
+  }
+  
+ /**
+   * @internal See message & help.
+   *
+   * @since V0.9.0 - 30/06/10
+   */
+  protected function processAlert4002($globalConfig, $config)
+  {    
+    if ($globalConfig['check_class_docblock'] && $this->commentsLength == 0)
+    {
+        
+      $alert = new paAlert(
+        paAlert::ALERT_ACTION_CHECK_DOC_BLOCK,
+        paAlert::WARNING,
+        sprintf('The class or interface "%s" does not have a docblock !', $this->getName()),
+        'Take some time to document the class or the interface'
+      );
+
+      $this->addAlert($alert);
+    }
-  }
-}

plugins/sfProjectAnalyserPlugin/branches/1.4/lib/objects/paSfProject.class.php

@@ -270 +270 @@
-    {
-      $countAlerts += $interface->countAlerts($status);
+      foreach($interface->getMethods() as $method){
+          $countAlerts += $method->countAlerts($status);
+      }
-    }
-
@@ -275 +278 @@
-    {
-      $countAlerts += $class->countAlerts($status);
+      foreach($class->getMethods() as $method){
+          $countAlerts += $method->countAlerts($status);
+      }
-    }
-
@@ -335 +341 @@
-      $plugin->process();
-    }
-
-    foreach ($this->classes as $class)
-    {
@@ -423 +428 @@
-      ->in($this->paths['sf_plugins_dir'])
-    ;
- 
+
-    foreach ($results as $pluginDirectory)
-    {
@@ -435 +440 @@
-    }
-
+   if($parseAllPlugin){
+         $this->processLib($this->paths['sf_plugins_dir'],false,
+             array_merge($pluginsToIgnore,
+              array('templates',
+                'actions'
+              )),
+              array('*Generator*'));
+    }
+    
-    $this->plugins = $plugins;
-  }
@@ -443 +457 @@
-   * as symfony native classes.
-   */
-
+$path=null,$required=true,$prune=array(),$not_name=array()
-  {
-    $classes        = array();
-    $interfaces     = array();
-
+
+
+
+
-    $ignoredClasses = $this->getIgnoredObjects('classes');
-
@@ -459 +476 @@
-
-      $object = null;
-
+
-      if (class_exists($class))
-      {
-        // Create the reflection object
-        $reflectionClass = new ReflectionClass($class);
-
+
+
+
+
+
-        
-        while ($parent instanceof ReflectionClass)
@@ -511 +532 @@
-      // Unkown error for this class
-      else
-
+  
-        // Error
-
+
+
+
-      }
-
@@ -520 +543 @@
-
-      // Keep the file name in the object ??
-
-
-
-
-
+
+
+
+
+
+
-  }
-
@@ -532 +556 @@
-   * @see sfAutoloadCore::make
-   */
-
+,$prune=array(),$not_name=array()
-  {
-    $files = sfFinder::type('file')
-      ->prune('plugins')
+      ->prune('fixtures')
-      ->prune('vendor')
-      ->prune('skeleton')
-      ->prune('default')
-      ->prune('helper')
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-    sort($files, SORT_STRING);
-
@@ -549 +588 @@
-    foreach ($files as $file)
-    {
+      sfSimpleAutoload::getInstance()->addFile($file);
-      $file  = str_replace(DIRECTORY_SEPARATOR, '/', $file);
-      $class = basename($file, false === strpos($file, '.class.php') ? '.php' : '.class.php');