Merge pull request #15 from joegreen88/master

For release 1.3

Author: joegreen88

CHANGELOG.md

@@ -0,0 +1,37 @@
+Changelog
+=========
+
+## 1.3.0 (wip)
+
+### General Improvements
+
+ - Added a new command: `status`
+ - Added composer parameter loading to CLI commands
+ - Bundle all commands into single script smyver.php
+ - Added port configuration option
+ - Refactor: implemented the command pattern
+ - Refactor: implemented the configuration adapter pattern
+
+### Configuration adapters:
+
+ - Ini (the default adapter)
+ - PhpArray
+ - PhpFile
+
+### Up command:
+
+ - Option `--provisional-version` is relative to project root if not an absolute path
+
+## 1.2.0
+
+### Up command:
+
+ - Added option `--install-provisional-version`
+ - Added option `--provisional-version`
+
+## 1.1.0
+
+### Up command:
+
+ - Added option `--no-schema`
+ - Added option `--versions-path`

README.md

@@ -1,104 +1,110 @@
 mysql-version-control
 =====================
 
-A crude version control system for a mysql database.
+Effective mysql database version control in one library. Quick and simple to use, but with a rich and flexible
+API for those who want to customise the set up.
 
-## Installation
-Use composer.
-Add `"smrtr/mysql-version-control": "~1.0"` to the `requires` section of your project's composer.json then run
-`composer update`.
+## Requirements
+ - PHP >= 5.4
+ - Composer
+ - MySQL client
 
-## Configuration
-Your database configuration will be stored at `<project_root>/db/db.ini`. In this file you will define a list of
-environments and then define database configurations for each environment.
+Install with composer:
 
-### environments
-Define a list of environments under the `[environments]` tag using the format `environments[] = "development"`. The
-CLI tool will add commands for each environment listed here.
+    $ composer require smrtr/mysql-version-control:~1.0
 
-You may also define a list of testing environments using the format `testing_environments[] = "testing"`. The CLI tool
-will only apply test data on the environments listed here.
+# Versioning
+Your database versions will be stored in `<project_root>/db/versions` by default.
+The sql for each version is stored in a directory directly under this directory.
+So the directories are named `db/versions/1`, `db/versions/2` and so on.
+Each version must contain at least one of the following files:
 
-### databases
-You must define two database configurations for each environment using the name of the environment as a tag.
-The two configurations are called `buildtime` and `runtime` and they are used for processing schemas and data
-respectively. Each configuration requires a `host`, `user`, `password` and `database` entry.
+ - `schema.sql` - always runs first, contains `CREATE TABLE IF NOT EXISTS` and `ALTER` statements and the like.
+ - `data.sql` - contains `REPLACE INTO`, `INSERT`, `UPDATE` and `DELETE` statements and the like.
+ - `testing.sql` - same as `data.sql` but with test data which doesn't need to exist outside of testing environments.
+ - `runme.php` - a custom php hook for running php code with your version.
 
-### Example db.ini
+The files for each version are run in the order specified above.
 
-    [environments]
-    environments[] = "development"
-    environments[] = "production"
+# Configuration
+The quickest way to get started is to set up your database configuration in a file at `<project_root>/db/db.ini`.
 
-    testing_environments[] = "development"
+See *examples/db.ini* for an example of this file.
 
-    [development]
-    runtime.host = "localhost"
-    runtime.user = "buzz"
-    runtime.password = "lightyear"
-    runtime.database = "buzz"
+### Environments
+Define a list of environments and testing environments under the tag `[environments]`.
 
-    buildtime.host = "localhost"
-    buildtime.user = "buzz"
-    buildtime.password = "lightyear"
-    buildtime.database = "buzz"
+List out all of the available environments with entries like so: `environments[] = "local-dev"`.
 
-    [production]
-    runtime.host = "localhost"
-    runtime.user = "root"
-    runtime.password = "root"
-    runtime.database = "buzz"
+List the testing environments like so: `testing_environments[] = "local-dev"`.
+This list is a subset of the environments list and comprises those environments which should receive test data.
 
-    buildtime.host = "localhost"
-    buildtime.user = "buzz"
-    buildtime.password = "lightyear"
-    buildtime.database = "buzz"
+### Connections
+You must define two database connection configurations for each environment.
+The two configurations are called `buildtime` and `runtime` and they are used for processing schema changes and data
+changes respectively.
 
-## Versioning
-Your database versions will be stored in `<project_root>/db/versions` by default.
-The sql for each version is stored in a directory directly under this directory.
-So the directories are named `db/versions/1`, `db/versions/2` and so on.
-Each version must contain at least one of the following files:
+Each connection requires a `host`, `user`, `password` and `database`. You can optionally add a `port`.
 
- - `schema.sql` - always runs first, contains `CREATE TABLE IF NOT EXISTS` and `ALTER` statements.
- - `data.sql` - contains `REPLACE INTO`, `INSERT`, `UPDATE` and `DELETE` statements and the like.
- - `testing.sql` - same as `data.sql` but with test data which doesn't need to exist outside of testing environments.
- - `runme.php` - a custom php hook for running, for example, import tasks.
+# Command Line Interface
+The command line tool is located at `vendor/bin/smyver.php`. 
 
-The files are run in the order specified above.
+*Remember it!* It stands for **S**mrtr **MY**sql **VER**sion control.
 
-## Usage
-This package will put two CLI scripts into your project's `vendor/bin` directory.
+## status
+Run `vendor/bin/smyver.php status <environment>` to get the current status of the database for that environment.
 
-### up
-Run `vendor/bin/up <environment>` to install or update the database on the given environment.
+## up
+Run `vendor/bin/smyver.php up <environment>` to install or update the database on the given environment.
 This command looks at the available versions in the `db/versions` directory and applies new versions sequentially
 from the current version.
 
 If this is the first run on the given environment, then a table called `db_config` is created and used to store the
 current database version.
 
+You may optionally provide a second argument specifying the mysql client binary to use.
+This argument is required if mysql is not on your $PATH.
+
 #### `--no-schema`
 Use this flag to skip the schema files. This can be useful if you use an ORM to build the database schema.
 
-#### `--versions-path`
-Use this option, or `-p` for short, to provide a custom path to your versions.
-This allows you to override the default versions path which is `<project_root>/db/versions`.
-
 #### `--install-provisional-version`
 Use this flag to install a provisional version. This allows you to test out your database version, which may currently
 be in development, before you commit to it by giving it a version number. This command looks for your provisional
 version in `<project_root>/db/versions/new` by default.
 
-#### `--provisional-version`
-Use this option to provide a custom path to your provisional version. Your custom path is relative to the versions path.
+## teardown
+Run `vendor/bin/smyver.php teardown <environment>` to tear down the tables on the given environment.
 
-### teardown
-Run `vendor/bin/teardown <environment>` to tear down the tables on the given environment.
-
-This command is useful for development & testing developments where you may wish to, for example, tear down your
-database between test runs.
+This command is useful for development & testing environments.
 
 Use the `confirm` option to bypass the confirmation prompt, e.g.
 
-    vendor/bin/teardown <environment> --confirm
+    vendor/bin/smyver.php <environment> --confirm
+
+## Global CLI options
+These options can be used with all console commands.
+
+#### `--config-adapter`
+Specify a configuration adapter to use instead of the Ini adapter which is used by default.
+
+If you are using one of the standard adapters shipped with this package you only need to enter the class name,
+e.g. PhpFile.
+
+If you are using your own custom adapter class then you must provide a fully qualified class name and your class
+must implement `Smrtr\MysqlVersionControl\DbConfigAdapter\ConfigAdapterInterface`.
+
+#### `--config-adapter-param`
+You can specify one or more constructor parameters for the configuration adapter class with this option.
+
+To specify multiple parameters simply use the option more than once, e.g.
+`--config-adapter-param="One" --config-adapter-param="Two"`
+would result in the configuration adapter being instantiated like so: `new $adapter("One", "Two")`.
+
+#### `--provisional-version`
+Use this option to provide a custom path to your provisional version. Your custom path is relative to the versions path.
+
+#### `--versions-path`
+Use this option, or `-p` for short, to provide a custom path to your versions.
+This allows you to override the default versions path which is `<project_root>/db/versions`.
+If the path provided is not an absolute path then it is assumed to be relative to the project root.

bin/smyver.php

@@ -0,0 +1,16 @@
+#!/usr/bin/env php
+<?php
+/**
+ * @package Smrtr\MysqlVersionControl\Bin
+ * @author Joe Green <joe.green@smrtr.co.uk>
+ */
+
+require_once realpath(dirname(__FILE__).'/../../../autoload.php');
+
+$app = new \Symfony\Component\Console\Application('smyver');
+
+$app->add(new \Smrtr\MysqlVersionControl\Command\Status);
+$app->add(new \Smrtr\MysqlVersionControl\Command\Up);
+$app->add(new \Smrtr\MysqlVersionControl\Command\Teardown);
+
+$app->run();

bin/teardown

@@ -1,3 +1,5 @@
-#!/usr/bin/env php
-<?php
-include('teardown.php');
+#!/usr/bin/env bash
+
+this_dir="$(cd "$(dirname "${BASH_SOURCE[0]}" )" && pwd )"
+
+php "$this_dir/smyver.php" teardown "$@"

bin/teardown.php

@@ -1,3 +1,5 @@
-#!/usr/bin/env php
-<?php
-include('up.php');
+#!/usr/bin/env bash
+
+this_dir="$(cd "$(dirname "${BASH_SOURCE[0]}" )" && pwd )"
+
+php "$this_dir/smyver.php" up "$@"

bin/up

@@ -2,7 +2,7 @@
     "name": "smrtr/mysql-version-control",
     "description": "A crude version control system for mysql written in php",
     "keywords": ["database", "db", "mysql", "version control", "version", "migration", "update", "data", "structure"],
-    "bin": ["bin/up", "bin/teardown"],
+    "bin": ["bin/up", "bin/teardown", "bin/smyver.php"],
     "license": "MIT",
     "authors": [
         {
@@ -11,8 +11,8 @@
         }
     ],
     "require": {
-        "symfony/console": "~2.3",
-        "symfony/process": "~2.5",
+        "symfony/console": "~2.7",
+        "symfony/process": "~2.7",
         "hearstuk/zf1-component-config": "~1.1"
     },
     "autoload": {