Merge pull request #6 from joegreen88/master

Teardown + readme

Author: joegreen88

README.md

@@ -1,4 +1,84 @@
 mysql-version-control
 =====================
 
-A crude version control system for mysql
+A crude version control system for a mysql database.
+
+## Installation
+Use composer.
+Add `"smrtr/mysql-version-control": "~1.0"` to the `requires` section of your project's composer.json then run
+`composer update`.
+
+## 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.
+
+### 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.
+
+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.
+
+### 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.
+
+### Example db.ini
+
+    [environments]
+    environments[] = "development"
+    environments[] = "production"
+
+    testing_environments[] = "development"
+
+    [development]
+    runtime.host = "localhost"
+    runtime.user = "buzz"
+    runtime.password = "lightyear"
+    runtime.database = "buzz"
+
+    buildtime.host = "localhost"
+    buildtime.user = "buzz"
+    buildtime.password = "lightyear"
+    buildtime.database = "buzz"
+
+    [production]
+    runtime.host = "localhost"
+    runtime.user = "root"
+    runtime.password = "root"
+    runtime.database = "buzz"
+
+    buildtime.host = "localhost"
+    buildtime.user = "buzz"
+    buildtime.password = "lightyear"
+    buildtime.database = "buzz"
+
+## Versioning
+Your database versions will be stored in `<project_root>/db/versions`. 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:
+
+ - `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.
+
+The files are run in the order specified above.
+
+## Usage
+This package will put two CLI scripts into your project's `vendor/bin` directory.
+
+### up
+Run `vendor/bin/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.
+
+### 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.

bin/teardown

@@ -0,0 +1,3 @@
+#!/usr/bin/env php
+<?php
+include('teardown.php');

bin/teardown.php

@@ -0,0 +1,14 @@
+<?php
+
+require_once realpath(dirname(__FILE__).'/../../../autoload.php');
+
+$app = new \Symfony\Component\Console\Application('teardown');
+
+foreach (\Smrtr\MysqlVersionControl\DbConfig::getEnvironments() as $env) {
+
+    $app->add(
+        new \Smrtr\MysqlVersionControl\TeardownCommand($env)
+    );
+}
+
+$app->run();

composer.lock

@@ -0,0 +1,79 @@
+<?php
+
+namespace Smrtr\MysqlVersionControl;
+
+use Symfony\Component\Console\Command\Command;
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Output\OutputInterface;
+
+/**
+ * Class TeardownCommand
+ * @package Smrtr\MysqlVersionControl
+ * @author Joe Green
+ */
+class TeardownCommand extends Command
+{
+    protected $env;
+
+    public function __construct($env)
+    {
+        $this->env = $env;
+        parent::__construct();
+    }
+
+    protected function configure()
+    {
+        $this
+            ->setName($this->env)
+            ->setDescription('Install the '.$this->env.' versions')
+            ->addArgument(
+                'mysqlbin',
+                InputArgument::OPTIONAL,
+                'Where is the MySQL binary located?'
+            )
+            ->addOption(
+                'confirm',
+                null,
+                InputOption::VALUE_NONE,
+                'If set, the command will bypass the confirmation prompt'
+            )
+        ;
+    }
+    /**
+     * Confirmation prompt then tear down the database tables
+     *
+     * @param InputInterface $input
+     * @param OutputInterface $output
+     * @return int|null|void
+     */
+    protected function execute(InputInterface $input, OutputInterface $output)
+    {
+        $con = DbConfig::getPDO($this->env, true);
+        $stmt = $con->query("SHOW TABLES");
+        $result = $stmt->fetchAll();
+
+        $tables = array();
+        foreach ($result as $row) {
+            $tables[] = array_shift($row);
+        }
+
+        $dialogue = $this->getHelperSet()->get('dialog');
+        if (!$input->getOption('confirm')) {
+            $tableCount = count($tables);
+            $answer = $dialogue->askConfirmation(
+                $output,
+                "<question>Tear down $tableCount tables(y/n)?</question>",
+                false
+            );
+            if (!$answer) {
+                exit;
+            }
+        }
+
+        foreach ($tables as $table) {
+            $con->exec("DROP TABLE IF EXISTS `$table`");
+            $output->writeln("Dropped table $table");
+        }
+    }
+
+}

src/Smrtr/MysqlVersionControl/TeardownCommand.php

@@ -34,12 +34,6 @@ protected function configure()
                 InputArgument::OPTIONAL,
                 'Where is the MySQL binary located?'
             )
-            ->addOption(
-                'confirm',
-                null,
-                InputOption::VALUE_NONE,
-                'If set, the command will bypass the confirmation prompt'
-            )
         ;
     }