class SiteAuditCheckCodebaseGitContributions in Site Audit 8.2

Class SiteAuditCheckCodebaseGitContributions.

Hierarchy

class \SiteAuditCheckAbstract
- class \SiteAuditCheckCodebaseGitContributions

Expanded class hierarchy of SiteAuditCheckCodebaseGitContributions

File

Check/Codebase/GitContributions.php, line 10: Contains \SiteAudit\Check\Codebase\GitContributions.

View source

class SiteAuditCheckCodebaseGitContributions extends SiteAuditCheckAbstract {

  /**
   * Implements \SiteAudit\Check\Abstract\getLabel().
   */
  public function getLabel() {
    return dt('Git Contributions');
  }

  /**
   * Implements \SiteAudit\Check\Abstract\getDescription().
   */
  public function getDescription() {
    return dt('Determine lines of code added and removed by each contributor.');
  }

  /**
   * Implements \SiteAudit\Check\Abstract\getResultFail().
   */
  public function getResultFail() {
  }

  /**
   * Implements \SiteAudit\Check\Abstract\getResultInfo().
   */
  public function getResultInfo() {
    if (isset($this->registry['not_git'])) {
      return dt('The site is not stored in Git.');
    }
    if (isset($this->registry['git_remote'])) {
      return dt("The repository contains the entire Drupal contribution history and will be ignored.");
    }
    $ret_val = '';
    if (drush_get_option('html') == TRUE) {
      $ret_val .= '<table class="table table-condensed">';
      $ret_val .= '<thead><tr><th>' . dt('Author') . '</th><th>' . dt('Lines Inserted') . '</th><th>' . dt('Lines Deleted') . '</th><th>' . dt('Percentage Contribution') . '</th></tr></thead>';
      foreach ($this->registry['git_contribution_percentage'] as $user => $percentage) {
        $added = number_format($this->registry['git_contribution'][$user]['inserted']);
        $deleted = number_format($this->registry['git_contribution'][$user]['deleted']);
        $ret_val .= "<tr><td>{$user}</td><td>{$added}</td><td>{$deleted}</td><td>{$percentage}%</td></tr>";
      }
      $ret_val .= '</table>';
    }
    else {
      $ret_val = dt('Author: Inserted | Deleted | Percentage') . PHP_EOL;
      if (!drush_get_option('json')) {
        $ret_val .= str_repeat(' ', 4);
      }
      $ret_val .= '-----------------------------';
      foreach ($this->registry['git_contribution_percentage'] as $user => $percentage) {
        $ret_val .= PHP_EOL;
        if (!drush_get_option('json')) {
          $ret_val .= str_repeat(' ', 4);
        }
        $added = number_format($this->registry['git_contribution'][$user]['inserted']);
        $deleted = number_format($this->registry['git_contribution'][$user]['deleted']);
        $ret_val .= "{$user}: {$added} | {$deleted} | {$percentage}%";
      }
    }
    return $ret_val;
  }

  /**
   * Implements \SiteAudit\Check\Abstract\getResultPass().
   */
  public function getResultPass() {
  }

  /**
   * Implements \SiteAudit\Check\Abstract\getResultWarn().
   */
  public function getResultWarn() {
  }

  /**
   * Implements \SiteAudit\Check\Abstract\getAction().
   */
  public function getAction() {
  }

  /**
   * Implements \SiteAudit\Check\Abstract\calculateScore().
   */
  public function calculateScore() {

    // Check if site is a git repository.
    $is_git = exec('git rev-parse --is-inside-work-tree 2> /dev/null');
    if ($is_git !== 'true') {
      $this->registry['not_git'] = TRUE;
      return SiteAuditCheckAbstract::AUDIT_CHECK_SCORE_INFO;
    }

    // Check if the repository is from drupal.org.
    $output = array();
    $remote_url = array(
      'http://git.drupal.org/project/drupal',
      'github.com/drupal/drupal',
      'github.com/pantheon-systems/drops-8',
    );
    exec('git remote -v', $output);
    foreach ($output as $line) {
      $line = explode("\t", $line);
      foreach ($remote_url as $url) {
        if (strpos($line, $url) !== FALSE) {
          $this->registry['git_remote'] = TRUE;
          return SiteAuditCheckAbstract::AUDIT_CHECK_SCORE_INFO;
        }
      }
    }

    // Get all users.
    $users = array();
    exec("git log --format='%aN' | sort -u", $users);

    // Get the lines of code for each user.
    $total = 0;
    foreach ($users as $user) {
      $command = "git log --no-merges --shortstat --author '{$user}' 2> /dev/null ";
      $command .= "| grep 'files\\? changed' 2> /dev/null ";
      $command .= "| awk '{if (\$5==\"insertions(+)\" || \$5==\"insertion(+)\") inserted+=\$4; else deleted+=\$4; deleted+=\$6} END {print inserted, deleted}' 2> /dev/null";
      $output = explode(' ', exec($command));
      $this->registry['git_contribution'][$user] = array(
        'inserted' => $output[0],
        'deleted' => $output[1],
      );
      $total += intval($output[0]) + intval($output[1]);
    }
    foreach ($users as $user) {
      $inserted = intval($this->registry['git_contribution'][$user]['inserted']);
      $deleted = intval($this->registry['git_contribution'][$user]['deleted']);
      $percentage = number_format(($inserted + $deleted) / $total * 100, 2);
      $this->registry['git_contribution_percentage'][$user] = $percentage;
    }
    arsort($this->registry['git_contribution_percentage']);
    return SiteAuditCheckAbstract::AUDIT_CHECK_SCORE_INFO;
  }

}

Members

Name	Modifiers	Type	Description
SiteAuditCheckAbstract::$abort	protected	property	Indicate that no other checks should be run after this check.
SiteAuditCheckAbstract::$customCode	private static	property	Use for checking whether custom code paths have been validated.
SiteAuditCheckAbstract::$optOut	protected	property	User has opted out of this check in configuration.
SiteAuditCheckAbstract::$percentOverride	protected	property	If set, will override the Report's percentage.
SiteAuditCheckAbstract::$registry	protected	property	Use for passing data between checks within a report.
SiteAuditCheckAbstract::$score	protected	property	Quantifiable number associated with result on a scale of 0 to 2.
SiteAuditCheckAbstract::AUDIT_CHECK_SCORE_FAIL		constant
SiteAuditCheckAbstract::AUDIT_CHECK_SCORE_INFO		constant
SiteAuditCheckAbstract::AUDIT_CHECK_SCORE_PASS		constant
SiteAuditCheckAbstract::AUDIT_CHECK_SCORE_WARN		constant
SiteAuditCheckAbstract::getCustomCodePaths	public	function	Returns an array containing custom code paths or AUDIT_CHECK_SCORE_INFO.
SiteAuditCheckAbstract::getExecPath	public	function	Returns the path of the executable.
SiteAuditCheckAbstract::getOptions	public	function	Returns the values of the valid options for a command.
SiteAuditCheckAbstract::getPercentOverride	public	function	Get the report percent override, if any.
SiteAuditCheckAbstract::getRegistry	public	function	Get the check registry.
SiteAuditCheckAbstract::getRelativePath	public	function	Gives path relative to DRUPAL_ROOT of the path is inside Drupal.
SiteAuditCheckAbstract::getResult	public	function	Determine the result message based on the score.
SiteAuditCheckAbstract::getScore	public	function	Get a quantifiable number representing a check result; lazy initialization.
SiteAuditCheckAbstract::getScoreCssClass	public	function	Get the CSS class associated with a score.
SiteAuditCheckAbstract::getScoreDrushLevel	public	function	Get the Drush message level associated with a score.
SiteAuditCheckAbstract::getScoreLabel	public	function	Get a human readable label for a score.
SiteAuditCheckAbstract::logXmlError	public	function	Logs error if unable to parse XML output.
SiteAuditCheckAbstract::renderAction	public	function	Display action items for a user to perform.
SiteAuditCheckAbstract::shouldAbort	public	function	Determine whether the check failed so badly that the report must stop.
SiteAuditCheckAbstract::__construct	public	function	Constructor.
SiteAuditCheckCodebaseGitContributions::calculateScore	public	function	Implements \SiteAudit\Check\Abstract\calculateScore(). Overrides SiteAuditCheckAbstract::calculateScore
SiteAuditCheckCodebaseGitContributions::getAction	public	function	Implements \SiteAudit\Check\Abstract\getAction(). Overrides SiteAuditCheckAbstract::getAction
SiteAuditCheckCodebaseGitContributions::getDescription	public	function	Implements \SiteAudit\Check\Abstract\getDescription(). Overrides SiteAuditCheckAbstract::getDescription
SiteAuditCheckCodebaseGitContributions::getLabel	public	function	Implements \SiteAudit\Check\Abstract\getLabel(). Overrides SiteAuditCheckAbstract::getLabel
SiteAuditCheckCodebaseGitContributions::getResultFail	public	function	Implements \SiteAudit\Check\Abstract\getResultFail(). Overrides SiteAuditCheckAbstract::getResultFail
SiteAuditCheckCodebaseGitContributions::getResultInfo	public	function	Implements \SiteAudit\Check\Abstract\getResultInfo(). Overrides SiteAuditCheckAbstract::getResultInfo
SiteAuditCheckCodebaseGitContributions::getResultPass	public	function	Implements \SiteAudit\Check\Abstract\getResultPass(). Overrides SiteAuditCheckAbstract::getResultPass
SiteAuditCheckCodebaseGitContributions::getResultWarn	public	function	Implements \SiteAudit\Check\Abstract\getResultWarn(). Overrides SiteAuditCheckAbstract::getResultWarn

You are here

class SiteAuditCheckCodebaseGitContributions in Site Audit 8.2

Hierarchy

File

Members

API Navigation