Merge branch 'versioning'

dregad · dregad · commit bb219a634510 · 2017-02-05T18:52:12.000+01:00
Standardize the framework and plugins version numbering and
dependencies.
diff --git a/Source/MantisSourceBase.class.php b/Source/MantisSourceBase.class.php
@@ -0,0 +1,29 @@
+<?php
+
+# Copyright (c) 2017 Damien Regad
+# Licensed under the MIT license
+
+require_once( config_get_global( 'class_path' ) . 'MantisPlugin.class.php' );
+
+/**
+ * Class MantisSourceBase
+ *
+ * Base class for all Source Integration Plugin classes
+ */
+abstract class MantisSourceBase extends MantisPlugin
+{
+	/**
+	 * Source Integration framework version.
+	 *
+	 * Numbering follows Semantic Versioning. Major version increments indicate
+	 * a change in the minimum required MantisBT version: 0=1.2; 1=1.3, 2=2.x.
+	 * The framework version is incremented when the plugin's core file change.
+	 */
+	const FRAMEWORK_VERSION = '1.3.2';
+
+	/**
+	 * Minimum required MantisBT version.
+	 * Used to define the MantisCore dependency for all child plugins
+	 */
+	const MANTIS_VERSION = '1.3.0';
+}
diff --git a/Source/MantisSourcePlugin.class.php b/Source/MantisSourcePlugin.class.php
@@ -3,11 +3,13 @@
 # Copyright (c) 2012 John Reese
 # Licensed under the MIT license
 
+require_once( 'MantisSourceBase.class.php' );
+
 /**
  * Abstract class for simplifying creation of source control plugins.
  * @author John Reese
  */
-abstract class MantisSourcePlugin extends MantisPlugin {
+abstract class MantisSourcePlugin extends MantisSourceBase {
 	public function hooks() {
 		return array(
 			'EVENT_SOURCE_INTEGRATION'		=> 'integration',
@@ -172,7 +174,7 @@ final public function _precommit( $p_event ) {
 class SourceGenericPlugin extends MantisSourcePlugin {
 	function register() {
 		$this->name = plugin_lang_get( 'title', 'Source' );
-		$this->version = SourcePlugin::$framework_version;
+		$this->version = self::FRAMEWORK_VERSION;
 	}
 
 	public $type = 'generic';
diff --git a/Source/Source.php b/Source/Source.php
@@ -3,14 +3,14 @@
 # Copyright (c) 2012 John Reese
 # Licensed under the MIT license
 
-require_once( config_get_global( 'class_path' ) . 'MantisPlugin.class.php' );
+require_once( 'MantisSourceBase.class.php' );
 
 /**
  * Creates an extensible API for integrating source control applications
  * with the Mantis bug tracker software.
  */
-class SourcePlugin extends MantisPlugin {
-	static $framework_version = '1.3.1';
+class SourcePlugin extends MantisSourceBase {
+
 	static $cache = array();
 
 	/**
@@ -28,18 +28,15 @@ function register() {
 		$this->name = plugin_lang_get( 'title' );
 		$this->description = plugin_lang_get( 'description' );
 
-		$this->version = self::$framework_version;
+		$this->version = self::FRAMEWORK_VERSION;
 		$this->requires = array(
-			'MantisCore' => '1.3.0',
-		);
-		$this->uses = array(
-			'jQuery' => '1.3',
+			'MantisCore' => self::MANTIS_VERSION,
 		);
 		$this->page		= 'manage_config_page';
 
 		$this->author	= 'John Reese';
 		$this->contact	= 'john@noswap.com';
-		$this->url		= 'http://noswap.com';
+		$this->url		= 'https://github.com/mantisbt-plugins/source-integration/';
 	}
 
 	function config() {
diff --git a/Source/SourceIntegration.php b/Source/SourceIntegration.php
@@ -3,10 +3,15 @@
 # Copyright (c) 2012 John Reese
 # Licensed under the MIT license
 
-final class SourceIntegrationPlugin extends MantisPlugin {
+/**
+ * Class SourceIntegrationPlugin
+ *
+ * Child plugin handling the framework's integration with the MantisBT UI
+ */
+final class SourceIntegrationPlugin extends MantisSourceBase {
 	function register() {
 		$this->name = plugin_lang_get( 'title', 'Source' );
-		$this->version = SourcePlugin::$framework_version;
+		$this->version = self::FRAMEWORK_VERSION;
 	}
 
 	function hooks() {
diff --git a/SourceBitBucket/SourceBitBucket.php b/SourceBitBucket/SourceBitBucket.php
@@ -10,6 +10,10 @@
 require_once(config_get( 'core_path' ) . 'json_api.php');
 
 class SourceBitBucketPlugin extends MantisSourcePlugin {
+
+	const PLUGIN_VERSION = '1.0.0';
+	const FRAMEWORK_VERSION_REQUIRED = '1.3.2';
+
 	protected $main_url = "https://bitbucket.org/";
 	protected $api_url_10 = 'https://bitbucket.org/api/1.0/';
 	protected $api_url_20 = 'https://bitbucket.org/api/2.0/';
@@ -20,15 +24,15 @@ public function register() {
 		$this->name        = plugin_lang_get( 'title' );
 		$this->description = plugin_lang_get( 'description' );
 
-		$this->version  = '0.19';
+		$this->version = self::PLUGIN_VERSION;
 		$this->requires = array(
-			'MantisCore' => '1.3.0',
-			'Source'     => '0.18',
+			'MantisCore' => self::MANTIS_VERSION,
+			'Source'     => self::FRAMEWORK_VERSION_REQUIRED,
 		);
 
 		$this->author  = 'Sergey Marchenko';
 		$this->contact = 'sergey@mzsl.ru';
-		$this->url     = 'http://zetabyte.ru';
+		$this->url     = 'https://github.com/mantisbt-plugins/source-integration/';
 
 	}
 
diff --git a/SourceBitBucket/lang/strings_english.txt b/SourceBitBucket/lang/strings_english.txt
@@ -2,7 +2,7 @@
 
 $s_plugin_SourceBitBucket_ = '';
 $s_plugin_SourceBitBucket_bitbucket = 'BitBucket';
-$s_plugin_SourceBitBucket_title = 'BitBucket Integration';
+$s_plugin_SourceBitBucket_title = 'Source BitBucket Integration';
 $s_plugin_SourceBitBucket_description = 'Adds BitBucket integration to the Source Integration framework.';
 
 $s_plugin_SourceBitBucket_bit_basic_login = 'BitBucket login (for basic auth)';
diff --git a/SourceCgit/SourceCgit.php b/SourceCgit/SourceCgit.php
@@ -15,19 +15,23 @@
 }
 
 class SourceCgitPlugin extends MantisSourcePlugin {
+
+	const PLUGIN_VERSION = '1.0.0';
+	const FRAMEWORK_VERSION_REQUIRED = '1.3.2';
+
 	public function register() {
 		$this->name = plugin_lang_get( 'title' );
 		$this->description = plugin_lang_get( 'description' );
 
-		$this->version = '0.16';
+		$this->version = self::PLUGIN_VERSION;
 		$this->requires = array(
-			'MantisCore' => '1.3.0',
-			'Source' => '0.16',
+			'MantisCore' => self::MANTIS_VERSION,
+			'Source' => self::FRAMEWORK_VERSION_REQUIRED,
 		);
 
 		$this->author = 'Alexander';
 		$this->contact = 'iam.asm89@gmail.com';
-		$this->url = 'http://noswap.com/';
+		$this->url = 'https://github.com/mantisbt-plugins/source-integration/';
 	}
 
 	public $type = 'cgit';
diff --git a/SourceCgit/lang/strings_english.txt b/SourceCgit/lang/strings_english.txt
@@ -5,7 +5,7 @@
 
 $s_plugin_SourceCgit_ = '';
 $s_plugin_SourceCgit_cgit = 'Cgit';
-$s_plugin_SourceCgit_title = 'Cgit Integration';
+$s_plugin_SourceCgit_title = 'Source Cgit Integration';
 $s_plugin_SourceCgit_description = 'Adds Cgit integration to the Source Integration framework.';
 
 $s_plugin_SourceCgit_cgit_root = 'Cgit Root URL<br/><span class="small">(including trailing /)</span>';
diff --git a/SourceGithub/SourceGithub.php b/SourceGithub/SourceGithub.php
@@ -11,6 +11,9 @@
 
 class SourceGithubPlugin extends MantisSourcePlugin {
 
+	const PLUGIN_VERSION = '1.3.1';
+	const FRAMEWORK_VERSION_REQUIRED = '1.3.2';
+
 	const ERROR_INVALID_PRIMARY_BRANCH = 'invalid_branch';
 
 	public $linkPullRequest = '/pull/%s';
@@ -19,15 +22,15 @@ public function register() {
 		$this->name = plugin_lang_get( 'title' );
 		$this->description = plugin_lang_get( 'description' );
 
-		$this->version = '1.3.0';
+		$this->version = self::PLUGIN_VERSION;
 		$this->requires = array(
-			'MantisCore' => '1.3.0',
-			'Source' => '1.3.0',
+			'MantisCore' => self::MANTIS_VERSION,
+			'Source' => self::FRAMEWORK_VERSION_REQUIRED,
 		);
 
 		$this->author = 'John Reese';
 		$this->contact = 'john@noswap.com';
-		$this->url = 'http://noswap.com';
+		$this->url = 'https://github.com/mantisbt-plugins/source-integration/';
 	}
 
 	public function errors() {
diff --git a/SourceGithub/lang/strings_english.txt b/SourceGithub/lang/strings_english.txt
@@ -5,7 +5,7 @@
 
 $s_plugin_SourceGithub_ = '';
 $s_plugin_SourceGithub_github = 'GitHub';
-$s_plugin_SourceGithub_title = 'GitHub Integration';
+$s_plugin_SourceGithub_title = 'Source GitHub Integration';
 $s_plugin_SourceGithub_description = 'Adds GitHub integration to the Source Integration framework.';
 
 $s_plugin_SourceGithub_hub_username = 'GitHub Username';
diff --git a/SourceGitlab/SourceGitlab.php b/SourceGitlab/SourceGitlab.php
@@ -13,21 +13,24 @@
 
 class SourceGitlabPlugin extends MantisSourcePlugin {
 
+	const PLUGIN_VERSION = '1.0.5';
+	const FRAMEWORK_VERSION_REQUIRED = '1.3.2';
+
 	const ERROR_INVALID_PRIMARY_BRANCH = 'invalid_branch';
 
 	public function register() {
 		$this->name = plugin_lang_get( 'title' );
 		$this->description = plugin_lang_get( 'description' );
 
-		$this->version = '1.0.4';
+		$this->version = self::PLUGIN_VERSION;
 		$this->requires = array(
-			'MantisCore' => '1.3.0',
-			'Source' => '1.3.0',
+			'MantisCore' => self::MANTIS_VERSION,
+			'Source' => self::FRAMEWORK_VERSION_REQUIRED,
 		);
 
 		$this->author = 'Johannes Goehr';
 		$this->contact = 'johannes.goehr@mobilexag.de';
-		$this->url = 'http://www.mobilexag.de';
+		$this->url = 'https://github.com/mantisbt-plugins/source-integration/';
 	}
 
 	public function errors() {
diff --git a/SourceGitlab/lang/strings_english.txt b/SourceGitlab/lang/strings_english.txt
@@ -6,7 +6,7 @@
 
 $s_plugin_SourceGitlab_ = '';
 $s_plugin_SourceGitlab_gitlab = 'GitLab';
-$s_plugin_SourceGitlab_title = 'GitLab Integration';
+$s_plugin_SourceGitlab_title = 'Source GitLab Integration';
 $s_plugin_SourceGitlab_description = 'Adds GitLab integration to the Source Integration framework.';
 
 $s_plugin_SourceGitlab_hub_root = 'GitLab Root<br /><span class="small">The full URL of your GitLab instance</span>';
diff --git a/SourceGitweb/SourceGitweb.php b/SourceGitweb/SourceGitweb.php
@@ -10,19 +10,23 @@
 require_once( config_get( 'core_path' ) . 'url_api.php' );
 
 class SourceGitwebPlugin extends MantisSourcePlugin {
+
+	const PLUGIN_VERSION = '1.0.0';
+	const FRAMEWORK_VERSION_REQUIRED = '1.3.2';
+
 	public function register() {
 		$this->name = plugin_lang_get( 'title' );
 		$this->description = plugin_lang_get( 'description' );
 
-		$this->version = '0.18';
+		$this->version = self::PLUGIN_VERSION;
 		$this->requires = array(
-			'MantisCore' => '1.3.0',
-			'Source' => '0.16',
+			'MantisCore' => self::MANTIS_VERSION,
+			'Source' => self::FRAMEWORK_VERSION_REQUIRED,
 		);
 
 		$this->author = 'John Reese';
 		$this->contact = 'john@noswap.com';
-		$this->url = 'http://noswap.com';
+		$this->url = 'https://github.com/mantisbt-plugins/source-integration/';
 	}
 
 	public $type = 'gitweb';
diff --git a/SourceGitweb/lang/strings_english.txt b/SourceGitweb/lang/strings_english.txt
@@ -5,7 +5,7 @@
 
 $s_plugin_SourceGitweb_ = '';
 $s_plugin_SourceGitweb_gitweb = 'Gitweb';
-$s_plugin_SourceGitweb_title = 'Gitweb Integration';
+$s_plugin_SourceGitweb_title = 'Source Gitweb Integration';
 $s_plugin_SourceGitweb_description = 'Adds Gitweb integration to the Source Integration framework.';
 
 $s_plugin_SourceGitweb_gitweb_root = 'Gitweb Root URL';
diff --git a/SourceHgWeb/SourceHgWeb.php b/SourceHgWeb/SourceHgWeb.php
@@ -18,19 +18,23 @@
 require_once( config_get( 'core_path' ) . 'url_api.php' );
 
 class SourceHgWebPlugin extends MantisSourcePlugin {
+
+	const PLUGIN_VERSION = '1.0.0';
+	const FRAMEWORK_VERSION_REQUIRED = '1.3.2';
+
 	function register() {
 		$this->name = plugin_lang_get( 'title' );
 		$this->description = plugin_lang_get( 'description' );
 
-		$this->version = '0.15';
+		$this->version = self::PLUGIN_VERSION;
 		$this->requires = array(
-			'MantisCore' => '1.3.0',
-			'Source' => '0.14',
+			'MantisCore' => self::MANTIS_VERSION,
+			'Source' => self::FRAMEWORK_VERSION_REQUIRED,
 		);
 
 		$this->author = 'David Hicks';
 		$this->contact = '';
-		$this->url = '';
+		$this->url = 'https://github.com/mantisbt-plugins/source-integration/';
 	}
 
 	public $type = 'hgweb';
diff --git a/SourceHgWeb/lang/strings_english.txt b/SourceHgWeb/lang/strings_english.txt
@@ -13,7 +13,7 @@
 
 $s_plugin_SourceHgWeb_ = '';
 $s_plugin_SourceHgWeb_hgweb = 'HgWeb';
-$s_plugin_SourceHgWeb_title = 'HgWeb Integration';
+$s_plugin_SourceHgWeb_title = 'Source HgWeb Integration';
 $s_plugin_SourceHgWeb_description = 'Adds HgWeb integration to the Source Integration framework.';
 
 $s_plugin_SourceHgWeb_hgweb_root = 'HgWeb Root URL';
diff --git a/SourceSFSVN/SourceSFSVN.php b/SourceSFSVN/SourceSFSVN.php
@@ -8,20 +8,25 @@
 }
 
 class SourceSFSVNPlugin extends SourceSVNPlugin {
+
+	const PLUGIN_VERSION = '1.0.0';
+	const FRAMEWORK_VERSION_REQUIRED = '1.3.2';
+	const SOURCESVN_VERSION_REQUIRED = '1.0';
+
 	public function register() {
 		$this->name = lang_get( 'plugin_SourceSFSVN_title' );
 		$this->description = lang_get( 'plugin_SourceSFSVN_description' );
 
-		$this->version = '0.16';
+		$this->version = self::PLUGIN_VERSION;
 		$this->requires = array(
-			'MantisCore' => '1.3.0',
-			'Source' => '0.16',
-			'SourceSVN' => '0.16',
+			'MantisCore' => self::MANTIS_VERSION,
+			'Source' => self::FRAMEWORK_VERSION_REQUIRED,
+			'SourceSVN' => self::SOURCESVN_VERSION_REQUIRED,
 		);
 
 		$this->author = 'John Reese';
 		$this->contact = 'john@noswap.com';
-		$this->url = 'http://noswap.com';
+		$this->url = 'https://github.com/mantisbt-plugins/source-integration/';
 	}
 
 	public $type = 'sfsvn';
diff --git a/SourceSFSVN/lang/strings_english.txt b/SourceSFSVN/lang/strings_english.txt
@@ -4,7 +4,7 @@
 # Licensed under the MIT license
 
 $s_plugin_SourceSFSVN_ = '';
-$s_plugin_SourceSFSVN_title = 'Subversion / SourceForge Integration';
+$s_plugin_SourceSFSVN_title = 'Source Subversion / SourceForge Integration';
 $s_plugin_SourceSFSVN_description = 'Adds Subversion integration to the Source plugin framework using SourceForge.net.';
 
 $s_plugin_SourceSFSVN_svn = 'SourceForge SVN';
diff --git a/SourceSVN/SourceSVN.php b/SourceSVN/SourceSVN.php
diff --git a/SourceSVN/lang/strings_english.txt b/SourceSVN/lang/strings_english.txt
diff --git a/SourceViewVC/SourceViewVC.php b/SourceViewVC/SourceViewVC.php
diff --git a/SourceViewVC/lang/strings_english.txt b/SourceViewVC/lang/strings_english.txt
diff --git a/SourceWebSVN/SourceWebSVN.php b/SourceWebSVN/SourceWebSVN.php
diff --git a/SourceWebSVN/lang/strings_english.txt b/SourceWebSVN/lang/strings_english.txt
diff --git a/docs/Classes.md b/docs/Classes.md
