Finalize Arcanist Classes

Summary: Mark all applicable Arcanist classes as "final", except PhutilLintEngine, which needs a little finesse. @jungejason / @nh, does this break any Facebook stuff? Test Plan: Linter no longer raises warnings. Ran "testEverythingImplemented" in Phabricator. Reviewers: btrahan, jungejason, nh Reviewed By: btrahan CC: aran, epriestley Maniphest Tasks: T795 Differential Revision: https://secure.phabricator.com/D1519
phacility · Jan 31, 2012 · 8fe38f8 · 8fe38f8
1 parent f70afcd
commit 8fe38f8
Show file tree

Hide file tree

Showing 75 changed files with 123 additions and 116 deletions.
diff --git a/src/branch/BranchInfo.php b/src/branch/BranchInfo.php
@@ -1,7 +1,7 @@
 <?php
 
 /*
- * Copyright 2011 Facebook, Inc.
+ * Copyright 2012 Facebook, Inc.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -20,7 +20,7 @@
  * Holds information about a single git branch, and provides methods
  * for loading and display.
  */
-class BranchInfo {
+final class BranchInfo {
 
   private $branchName;
   private $currentHead = false;

diff --git a/src/configuration/ArcanistConfiguration.php b/src/configuration/ArcanistConfiguration.php
@@ -1,7 +1,7 @@
 <?php
 
 /*
- * Copyright 2011 Facebook, Inc.
+ * Copyright 2012 Facebook, Inc.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -37,6 +37,7 @@
  *      getCustomArgumentsForCommand().
  *
  * @group config
+ * @concrete-extensible
  */
 class ArcanistConfiguration {
 

diff --git a/src/difference/__tests__/ArcanistDiffUtilsTestCase.php b/src/difference/__tests__/ArcanistDiffUtilsTestCase.php
@@ -1,7 +1,7 @@
 <?php
 
 /*
- * Copyright 2011 Facebook, Inc.
+ * Copyright 2012 Facebook, Inc.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -21,7 +21,7 @@
  *
  * @group testcase
  */
-class ArcanistDiffUtilsTestCase extends ArcanistPhutilTestCase {
+final class ArcanistDiffUtilsTestCase extends ArcanistPhutilTestCase {
   public function testLevenshtein() {
     $tests = array(
       array(

diff --git a/src/differential/commitmessage/ArcanistDifferentialCommitMessage.php b/src/differential/commitmessage/ArcanistDifferentialCommitMessage.php
@@ -21,7 +21,7 @@
  *
  * @group differential
  */
-class ArcanistDifferentialCommitMessage {
+final class ArcanistDifferentialCommitMessage {
 
   private $rawCorpus;
   private $revisionID;

diff --git a/src/differential/commitmessage/ArcanistDifferentialCommitMessageParserException.php b/src/differential/commitmessage/ArcanistDifferentialCommitMessageParserException.php
@@ -1,7 +1,7 @@
 <?php
 
 /*
- * Copyright 2011 Facebook, Inc.
+ * Copyright 2012 Facebook, Inc.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -21,7 +21,7 @@
  *
  * @group differential
  */
-class ArcanistDifferentialCommitMessageParserException extends Exception {
+final class ArcanistDifferentialCommitMessageParserException extends Exception {
 
   private $parserErrors;
 

diff --git a/src/differential/revision/ArcanistDifferentialRevisionRef.php b/src/differential/revision/ArcanistDifferentialRevisionRef.php
@@ -1,7 +1,7 @@
 <?php
 
 /*
- * Copyright 2011 Facebook, Inc.
+ * Copyright 2012 Facebook, Inc.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -21,7 +21,7 @@
  *
  * @group differential
  */
-class ArcanistDifferentialRevisionRef {
+final class ArcanistDifferentialRevisionRef {
 
   protected $id;
   protected $name;

diff --git a/src/exception/ArcanistChooseInvalidRevisionException.php b/src/exception/ArcanistChooseInvalidRevisionException.php
@@ -1,7 +1,7 @@
 <?php
 
 /*
- * Copyright 2011 Facebook, Inc.
+ * Copyright 2012 Facebook, Inc.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -21,6 +21,6 @@
  *
  * @group workflow
  */
-class ArcanistChooseInvalidRevisionException extends Exception {
+final class ArcanistChooseInvalidRevisionException extends Exception {
 
 }
diff --git a/src/exception/ArcanistChooseNoRevisionsException.php b/src/exception/ArcanistChooseNoRevisionsException.php
@@ -1,7 +1,7 @@
 <?php
 
 /*
- * Copyright 2011 Facebook, Inc.
+ * Copyright 2012 Facebook, Inc.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -22,6 +22,6 @@
  *
  * @group workflow
  */
-class ArcanistChooseNoRevisionsException extends Exception {
+final class ArcanistChooseNoRevisionsException extends Exception {
 
 }
diff --git a/src/exception/usage/ArcanistUsageException.php b/src/exception/usage/ArcanistUsageException.php
@@ -1,7 +1,7 @@
 <?php
 
 /*
- * Copyright 2011 Facebook, Inc.
+ * Copyright 2012 Facebook, Inc.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -21,6 +21,7 @@
  * than a technical problem.
  *
  * @group workflow
+ * @concrete-extensible
  */
 class ArcanistUsageException extends Exception {
 

diff --git a/src/exception/usage/noeffect/ArcanistNoEffectException.php b/src/exception/usage/noeffect/ArcanistNoEffectException.php
@@ -1,7 +1,7 @@
 <?php
 
 /*
- * Copyright 2011 Facebook, Inc.
+ * Copyright 2012 Facebook, Inc.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -22,5 +22,5 @@
  *
  * @group workflow
  */
-class ArcanistNoEffectException extends ArcanistUsageException {
+final class ArcanistNoEffectException extends ArcanistUsageException {
 }
diff --git a/src/exception/usage/noengine/ArcanistNoEngineException.php b/src/exception/usage/noengine/ArcanistNoEngineException.php
@@ -1,7 +1,7 @@
 <?php
 
 /*
- * Copyright 2011 Facebook, Inc.
+ * Copyright 2012 Facebook, Inc.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -21,5 +21,5 @@
  *
  * @group workflow
  */
-class ArcanistNoEngineException extends ArcanistUsageException {
+final class ArcanistNoEngineException extends ArcanistUsageException {
 }
diff --git a/src/exception/usage/userabort/ArcanistUserAbortException.php b/src/exception/usage/userabort/ArcanistUserAbortException.php
@@ -1,7 +1,7 @@
 <?php
 
 /*
- * Copyright 2011 Facebook, Inc.
+ * Copyright 2012 Facebook, Inc.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -22,7 +22,7 @@
  *
  * @group workflow
  */
-class ArcanistUserAbortException extends ArcanistUsageException {
+final class ArcanistUserAbortException extends ArcanistUsageException {
   public function __construct() {
     parent::__construct('User aborted the workflow.');
   }

diff --git a/src/lint/engine/base/ArcanistLintEngine.php b/src/lint/engine/base/ArcanistLintEngine.php
@@ -56,6 +56,7 @@
  * and Workflows} for more information about configuring lint engines.
  *
  * @group lint
+ * @stable
  */
 abstract class ArcanistLintEngine {
 

diff --git a/src/lint/engine/comprehensive/ComprehensiveLintEngine.php b/src/lint/engine/comprehensive/ComprehensiveLintEngine.php
@@ -21,7 +21,7 @@
  *
  * @group linter
  */
-class ComprehensiveLintEngine extends ArcanistLintEngine {
+final class ComprehensiveLintEngine extends ArcanistLintEngine {
 
   public function buildLinters() {
     $linters = array();

diff --git a/src/lint/engine/example/ExampleLintEngine.php b/src/lint/engine/example/ExampleLintEngine.php
@@ -1,7 +1,7 @@
 <?php
 
 /*
- * Copyright 2011 Facebook, Inc.
+ * Copyright 2012 Facebook, Inc.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -23,7 +23,7 @@
  *
  * @group linter
  */
-class ExampleLintEngine extends ArcanistLintEngine {
+final class ExampleLintEngine extends ArcanistLintEngine {
 
   public function buildLinters() {
 

diff --git a/src/lint/engine/liberate/ArcanistLiberateLintEngine.php b/src/lint/engine/liberate/ArcanistLiberateLintEngine.php
@@ -1,7 +1,7 @@
 <?php
 
 /*
- * Copyright 2011 Facebook, Inc.
+ * Copyright 2012 Facebook, Inc.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -21,7 +21,7 @@
  *
  * @group linter
  */
-class ArcanistLiberateLintEngine extends ArcanistLintEngine {
+final class ArcanistLiberateLintEngine extends ArcanistLintEngine {
 
   public function buildLinters() {
     // We just run the module linter, 'arc liberate' is only interested in

diff --git a/src/lint/engine/phutil/PhutilLintEngine.php b/src/lint/engine/phutil/PhutilLintEngine.php
@@ -19,6 +19,8 @@
 /**
  * Lint engine which enforces libphutil rules.
  *
+ * TODO: Deal with PhabricatorLintEngine extending this and then finalize it.
+ *
  * @group linter
  */
 class PhutilLintEngine extends ArcanistLintEngine {

diff --git a/src/lint/linter/apachelicense/ArcanistApacheLicenseLinter.php b/src/lint/linter/apachelicense/ArcanistApacheLicenseLinter.php
@@ -1,7 +1,7 @@
 <?php
 
 /*
- * Copyright 2011 Facebook, Inc.
+ * Copyright 2012 Facebook, Inc.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -21,7 +21,7 @@
  *
  * @group linter
  */
-class ArcanistApacheLicenseLinter extends ArcanistLicenseLinter {
+final class ArcanistApacheLicenseLinter extends ArcanistLicenseLinter {
   public function getLinterName() {
     return 'APACHELICENSE';
   }

diff --git a/src/lint/linter/apachelicense/__tests__/ArcanistApacheLicenseLinterTestCase.php b/src/lint/linter/apachelicense/__tests__/ArcanistApacheLicenseLinterTestCase.php
@@ -21,7 +21,7 @@
  *
  * @group testcase
  */
-class ArcanistApacheLicenseLinterTestCase extends ArcanistLinterTestCase {
+final class ArcanistApacheLicenseLinterTestCase extends ArcanistLinterTestCase {
 
   public function testApacheLicenseLint() {
     $linter = new ArcanistApacheLicenseLinter();

diff --git a/src/lint/linter/base/ArcanistLinter.php b/src/lint/linter/base/ArcanistLinter.php
@@ -20,6 +20,7 @@
  * Implements lint rules, like syntax checks for a specific language.
  *
  * @group linter
+ * @stable
  */
 abstract class ArcanistLinter {
 

diff --git a/src/lint/linter/conduit/ArcanistConduitLinter.php b/src/lint/linter/conduit/ArcanistConduitLinter.php
@@ -49,7 +49,7 @@
  * This class is intended for customization via instantiation, not via
  * subclassing.
  */
-class ArcanistConduitLinter extends ArcanistLinter {
+final class ArcanistConduitLinter extends ArcanistLinter {
   const CONDUIT_METHOD = 'lint.getalllint';
 
   private $conduitURI;

diff --git a/src/lint/linter/filename/ArcanistFilenameLinter.php b/src/lint/linter/filename/ArcanistFilenameLinter.php
@@ -1,7 +1,7 @@
 <?php
 
 /*
- * Copyright 2011 Facebook, Inc.
+ * Copyright 2012 Facebook, Inc.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -21,7 +21,7 @@
  *
  * @group linter
  */
-class ArcanistFilenameLinter extends ArcanistLinter {
+final class ArcanistFilenameLinter extends ArcanistLinter {
 
   const LINT_BAD_FILENAME = 1;
 

diff --git a/src/lint/linter/generated/ArcanistGeneratedLinter.php b/src/lint/linter/generated/ArcanistGeneratedLinter.php
@@ -1,7 +1,7 @@
 <?php
 
 /*
- * Copyright 2011 Facebook, Inc.
+ * Copyright 2012 Facebook, Inc.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -21,7 +21,7 @@
  *
  * @group linter
  */
-class ArcanistGeneratedLinter extends ArcanistLinter {
+final class ArcanistGeneratedLinter extends ArcanistLinter {
 
   public function willLintPaths(array $paths) {
     return;

diff --git a/src/lint/linter/jshint/ArcanistJSHintLinter.php b/src/lint/linter/jshint/ArcanistJSHintLinter.php
@@ -1,7 +1,7 @@
 <?php
 
 /*
- * Copyright 2011 Facebook, Inc.
+ * Copyright 2012 Facebook, Inc.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -52,7 +52,7 @@
  *
  * @group linter
  */
-class ArcanistJSHintLinter extends ArcanistLinter {
+final class ArcanistJSHintLinter extends ArcanistLinter {
 
   const JSHINT_ERROR = 1;
 

diff --git a/src/lint/linter/nolint/ArcanistNoLintLinter.php b/src/lint/linter/nolint/ArcanistNoLintLinter.php
@@ -1,7 +1,7 @@
 <?php
 
 /*
- * Copyright 2011 Facebook, Inc.
+ * Copyright 2012 Facebook, Inc.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -22,7 +22,7 @@
  *
  * @group linter
  */
-class ArcanistNoLintLinter extends ArcanistLinter {
+final class ArcanistNoLintLinter extends ArcanistLinter {
   public function willLintPaths(array $paths) {
     return;
   }

diff --git a/src/lint/linter/pep8/ArcanistPEP8Linter.php b/src/lint/linter/pep8/ArcanistPEP8Linter.php
@@ -21,7 +21,7 @@
  *
  * @group linter
  */
-class ArcanistPEP8Linter extends ArcanistLinter {
+final class ArcanistPEP8Linter extends ArcanistLinter {
 
   public function willLintPaths(array $paths) {
     return;