Merge pull request #42 from shadowhand/feature/commit-message-review

Add commit message review

Author: sjparkinson

README.md

@@ -38,9 +38,12 @@ $ bin/static-review.php hook:install hooks/example-pre-commit.php ~/.../.git/hoo
 
 [composer]: https://getcomposer.org/
 
-## Example Hook
+## Example Hooks
 
-Below is a basic hook that you can extend upon.
+Static Review can be used for both files and commit message review. Below are
+basic hooks for each.
+
+### For Files
 
 ```php
 #!/usr/bin/env php
@@ -50,6 +53,7 @@ include __DIR__ . '/../../../autoload.php';
 
 // Reference the required classes.
 use StaticReview\StaticReview;
+use StaticReview\Review\General\LineEndingsReview;
 [...]
 
 $reporter = new Reporter();
@@ -61,17 +65,47 @@ $review->addReview(new LineEndingsReview());
 $git = new GitVersionControl();
 
 // Review the staged files.
-$review->review($git->getStagedFiles());
+$review->files($git->getStagedFiles());
 
 // Check if any issues were found.
 // Exit with a non-zero status to block the commit.
 ($reporter->hasIssues()) ? exit(1) : exit(0);
 ```
 
-## Example Review
+### For Commit Messages
 
 ```php
-class NoCommitTagReview extends AbstractReview
+#!/usr/bin/env php
+<?php
+
+include __DIR__ . '/../../../autoload.php';
+
+// Reference the required classes.
+use StaticReview\StaticReview;
+use StaticReview\Review\Message\BodyLineLengthReview;
+[...]
+
+$reporter = new Reporter();
+$review   = new StaticReview($reporter);
+
+// Add any reviews to the StaticReview instance, supports a fluent interface.
+$review->addReview(new BodyLineLengthReview());
+
+$git = new GitVersionControl();
+
+// Review the current commit message.
+// The hook is passed the file holding the commit message as the first argument.
+$review->message($git->getCommitMessage($argv[1]));
+
+// Check if any issues were found.
+// Exit with a non-zero status to block the commit.
+($reporter->hasIssues()) ? exit(1) : exit(0);
+```
+
+## Example Review For Files
+
+```php
+class NoCommitTagReview extends AbstractFileReview
 {
     // Review any text based file.
     public function canReviewFile(FileInterface $file)
@@ -98,6 +132,24 @@ class NoCommitTagReview extends AbstractReview
 }
 ```
 
+## Example Review For Messages
+
+```php
+class WorkInProgressReview extends AbstractMessageReview
+{
+    // Check if the commit message contains "wip"
+    public function review(ReporterInterface $reporter, ReviewableInterface $commit)
+    {
+        $fulltext = $commit->getSubject() . PHP_EOL . $commit->getBody();
+
+        if (preg_match('/\bwip\b/i', $fulltext)) {
+            $message = 'Do not commit WIP to shared branches';
+            $reporter->error($message, $this, $commit);
+        }
+    }
+}
+```
+
 ## Unit Tests
 
 See [vagrantup.com][vagrant] and [phpunit.de][phpunit].

hooks/static-review-commit-msg.php

@@ -0,0 +1,80 @@
+#!/usr/bin/env php
+<?php
+
+/*
+ * This file is part of StaticReview
+ *
+ * Copyright (c) 2015 Woody Gilk <@shadowhand>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ *
+ * @see http://github.com/sjparkinson/static-review/blob/master/LICENSE
+ */
+
+$included = include file_exists(__DIR__ . '/../vendor/autoload.php')
+    ? __DIR__ . '/../vendor/autoload.php'
+    : __DIR__ . '/../../../autoload.php';
+
+if (! $included) {
+    echo 'You must set up the project dependencies, run the following commands:' . PHP_EOL
+       . 'curl -sS https://getcomposer.org/installer | php' . PHP_EOL
+       . 'php composer.phar install' . PHP_EOL;
+
+    exit(1);
+}
+
+if (empty($argv[1]) || !is_file($argv[1])) {
+    echo 'WARNING: Skipping commit message check because the Git hook was not ' . PHP_EOL
+       . 'passed the commit message file path; normally `.git/COMMIT_EDITMSG`' . PHP_EOL;
+
+    exit(1);
+}
+
+// Reference the required classes and the reviews you want to use.
+use League\CLImate\CLImate;
+use StaticReview\Issue\Issue;
+use StaticReview\Reporter\Reporter;
+use StaticReview\Review\Message\BodyLineLengthReview;
+use StaticReview\Review\Message\SubjectImperativeReview;
+use StaticReview\Review\Message\SubjectLineCapitalReview;
+use StaticReview\Review\Message\SubjectLineLengthReview;
+use StaticReview\Review\Message\SubjectLinePeriodReview;
+use StaticReview\Review\Message\WorkInProgressReview;
+use StaticReview\StaticReview;
+use StaticReview\VersionControl\GitVersionControl;
+
+$reporter = new Reporter();
+$climate  = new CLImate();
+$git      = new GitVersionControl();
+
+$review   = new StaticReview($reporter);
+
+// Add any reviews to the StaticReview instance, supports a fluent interface.
+$review->addReview(new BodyLineLengthReview())
+       ->addReview(new SubjectImperativeReview())
+       ->addReview(new SubjectLineCapitalReview())
+       ->addReview(new SubjectLineLengthReview())
+       ->addReview(new SubjectLinePeriodReview())
+       ->addReview(new WorkInProgressReview());
+
+// Check the commit message.
+$review->message($git->getCommitMessage($argv[1]));
+
+// Check if any matching issues were found.
+if ($reporter->hasIssues()) {
+    $climate->out('')->out('');
+
+    foreach ($reporter->getIssues() as $issue) {
+        $climate->red($issue);
+    }
+
+    $climate->out('')->red('✘ Please fix the errors above.');
+
+    exit(1);
+
+} else {
+    $climate->green('✔ That commit looks good!');
+
+    exit(0);
+}

src/Collection/ReviewCollection.php

@@ -13,6 +13,7 @@
 
 namespace StaticReview\Collection;
 
+use StaticReview\Commit\CommitMessageInterface;
 use StaticReview\File\FileInterface;
 use StaticReview\Review\ReviewInterface;
 
@@ -69,4 +70,24 @@ public function forFile(FileInterface $file)
 
         return $this->select($filter);
     }
+
+    /**
+     * Returns a filtered ReviewCollection that should be run against the given
+     * message.
+     *
+     * @param  CommitMessage $message
+     * @return ReviewCollection
+     */
+    public function forMessage(CommitMessageInterface $message)
+    {
+        $filter = function ($review) use ($message) {
+            if ($review->canReview($message)) {
+                return true;
+            }
+
+            return false;
+        };
+
+        return $this->select($filter);
+    }
 }

src/Commit/CommitMessage.php

@@ -0,0 +1,92 @@
+<?php
+
+/*
+ * This file is part of StaticReview
+ *
+ * Copyright (c) 2014 Samuel Parkinson <@samparkinson_>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ *
+ * @see http://github.com/sjparkinson/static-review/blob/master/LICENSE
+ */
+
+namespace StaticReview\Commit;
+
+class CommitMessage implements CommitMessageInterface
+{
+    /**
+     * @var string Commit message subject.
+     */
+    protected $subject;
+
+    /**
+     * @var string Commit message body.
+     */
+    protected $body = '';
+
+    /**
+     * @var boolean Commit identifier.
+     */
+    protected $hash;
+
+    /**
+     * Initializes a new instance of the CommitMessage class.
+     *
+     * @param string $message
+     * @param string $hash
+     */
+    public function __construct($message, $hash = null)
+    {
+        $message = preg_replace('/^#.*/m', '', $message);
+        $message = preg_split('/(\r?\n)+/', trim($message));
+
+        $this->subject = array_shift($message);
+
+        if ($message) {
+            $this->body = implode("\n", $message);
+        }
+
+        $this->hash = $hash;
+    }
+
+    /**
+     * Get the commit message subject.
+     *
+     * @return string
+     */
+    public function getSubject()
+    {
+        return $this->subject;
+    }
+
+    /**
+     * Get the commit message body.
+     *
+     * @return string
+     */
+    public function getBody()
+    {
+        return $this->body;
+    }
+
+    /**
+     * Is the commit current or historical?
+     *
+     * @return string|null
+     */
+    public function getHash()
+    {
+        return $this->hash ?: null;
+    }
+
+    /**
+     * Get the reviewable name for the commit.
+     *
+     * @return string
+     */
+    public function getName()
+    {
+        return $this->getHash() ?: 'current commit';
+    }
+}

src/Commit/CommitMessageInterface.php

@@ -0,0 +1,25 @@
+<?php
+
+/*
+ * This file is part of StaticReview
+ *
+ * Copyright (c) 2015 Woody Gilk <@shadowhand>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ *
+ * @see http://github.com/sjparkinson/static-review/blob/master/LICENSE
+ */
+
+namespace StaticReview\Commit;
+
+use StaticReview\Review\ReviewableInterface;
+
+interface CommitMessageInterface extends ReviewableInterface
+{
+    public function getSubject();
+
+    public function getBody();
+
+    public function getHash();
+}

src/Review/AbstractFileReview.php

@@ -0,0 +1,25 @@
+<?php
+
+/*
+ * This file is part of StaticReview
+ *
+ * Copyright (c) 2015 Woody Gilk <@shadowhand>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ *
+ * @see http://github.com/sjparkinson/static-review/blob/master/LICENSE
+ */
+
+namespace StaticReview\Review;
+
+use StaticReview\Commit\CommitMessageInterface;
+use Symfony\Component\Process\Process;
+
+abstract class AbstractFileReview extends AbstractReview
+{
+    protected function canReviewMessage(CommitMessageInterface $message)
+    {
+        return false;
+    }
+}

src/Review/AbstractMessageReview.php

@@ -0,0 +1,31 @@
+<?php
+
+/*
+ * This file is part of StaticReview
+ *
+ * Copyright (c) 2015 Woody Gilk <@shadowhand>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ *
+ * @see http://github.com/sjparkinson/static-review/blob/master/LICENSE
+ */
+
+namespace StaticReview\Review;
+
+use StaticReview\Commit\CommitMessageInterface;
+use StaticReview\File\FileInterface;
+use Symfony\Component\Process\Process;
+
+abstract class AbstractMessageReview extends AbstractReview
+{
+    protected function canReviewFile(FileInterface $file)
+    {
+        return false;
+    }
+
+    protected function canReviewMessage(CommitMessageInterface $message)
+    {
+        return true;
+    }
+}