Adding version control and commands

Author: stygiansabyss

composer.json

@@ -18,6 +18,7 @@
     },
     "autoload": {
         "classmap": [
+            "src/commands",
             "src/controllers",
             "src/database/migrations",
             "src/database/seeds",

src/Syntax/Forum/ForumServiceProvider.php

@@ -11,6 +11,8 @@ class ForumServiceProvider extends ServiceProvider {
 	 */
 	protected $defer = false;
 
+	const version = '1.0.0';
+
 	/**
 	 * Bootstrap the application events.
 	 *

src/commands/UpdateForumCommand.php

@@ -0,0 +1,171 @@
+<?php
+
+use Illuminate\Console\Command;
+use Symfony\Component\Console\Input\InputOption;
+use Symfony\Component\Console\Input\InputArgument;
+use Symfony\Component\Console\Output\StreamOutput;
+
+class UpdateForumCommand extends Command {
+
+	/**
+	 * The console command name.
+	 *
+	 * @var string
+	 */
+	protected $name = 'syntax:update-forum';
+
+	/**
+	 * The console command description.
+	 *
+	 * @var string
+	 */
+	protected $description = 'Perform any steps needed for syntax\chat updates.';
+
+	/**
+	 * The output stream for any artisan commands
+	 *
+	 * @var string
+	 */
+	protected $stream;
+
+	/**
+	 * Create a new command instance.
+	 *
+	 * @return void
+	 */
+	public function __construct()
+	{
+		parent::__construct();
+
+		$this->stream      = fopen('php://output', 'w');
+	}
+
+	/**
+	 * Execute the console command.
+	 *
+	 * @return mixed
+	 */
+	public function fire()
+	{
+		// Handle Forum
+		if ($this->confirm('Do you want to update Syntax\Forum? [yes|no]')) {
+			$requestedVersion = $this->ask('What version of forum do you require?  [Hit enter to leave as dev-master]', 'dev-master');
+
+			$this->comment('Running composer update...');
+			$this->composerUpdate($requestedVersion);
+
+			$currentVersion = Config::get('forum::version');
+			$newVersion     = Syntax\Forum\ForumServiceProvider::version;
+
+			$this->comment('Checking for update steps to perform...');
+			$this->update($currentVersion, $newVersion);
+
+			$this->comment('Updating the version in the config...');
+			$this->updateVersion($newVersion);
+		}
+
+		$this->comment('Done!');
+	}
+
+	/********************************************************************
+	 * Update Methods
+	 *******************************************************************/
+	public function update($start, $end)
+	{
+		$versionRange = range($this->cleanVersion($start), $this->cleanVersion($end));
+
+		if (count($versionRange) == 1) {
+			$this->comment('Already on the latest version: '. $end);
+			return true;
+		}
+
+		$performedUpdate = false;
+
+		foreach ($versionRange as $version) {
+			if ($version == $start) {
+				$previousVersion = $version;
+				continue;
+			}
+
+			$method = 'update'. $previousVersion .'To'. $version;
+
+			if (method_exists($this, $method)) {
+				$performedUpdate = true;
+
+				$this->comment('Updating from version '. $previousVersion .' to '. $version .'...');
+			}
+
+			$previousVersion = $version;
+		}
+
+		if ($performedUpdate === false) {
+			$this->comment('No updates needed...');
+		}
+	}
+
+	/********************************************************************
+	 * Helper Methods
+	 *******************************************************************/
+	protected function composerUpdate($version)
+	{
+		$commands = [
+			'cd '. base_path(),
+			'composer update syntax/forum:'. $version,
+		];
+
+		SSH::run($commands, function ($line) {
+			echo $line.PHP_EOL;
+		});
+	}
+
+	protected function cleanVersion($version)
+	{
+		return str_replace('.', '', $version);
+	}
+
+	protected function updateVersion($version)
+	{
+		list($path, $contents) = $this->getConfig('packages/syntax/forum/config.php');
+
+		$contents = str_replace($this->laravel['config']['forum::version'], $version, $contents);
+
+		File::put($path, $contents);
+	}
+
+	/********************************************************************
+	 * Extra Methods
+	 *******************************************************************/
+	protected function getConfig($file)
+	{
+		$path = $this->laravel['path'].'/config/'. $file;
+
+		$contents = File::get($path);
+
+		return array($path, $contents);
+	}
+
+	/**
+	 * Get the console command arguments.
+	 *
+	 * @return array
+	 */
+	protected function getArguments()
+	{
+		return array(
+			// array('example', InputArgument::REQUIRED, 'An example argument.'),
+		);
+	}
+
+	/**
+	 * Get the console command options.
+	 *
+	 * @return array
+	 */
+	protected function getOptions()
+	{
+		return array(
+			// array('example', null, InputOption::VALUE_OPTIONAL, 'An example option.', null),
+		);
+	}
+
+}

src/config/config.php

@@ -2,6 +2,15 @@
 
 return array(
 
+	/*
+	|--------------------------------------------------------------------------
+	| Current version
+	|--------------------------------------------------------------------------
+	|
+	| The current version of Syntax\Forum the site is using
+	*/
+	'version' => '1.0.0',
+
 	/*
 	|--------------------------------------------------------------------------
 	| Application Forum for News