Refactor database configuration

leomarquine · Aug 17, 2016 · e49197d · e49197d
1 parent 2c96730
commit e49197d
Show file tree

Hide file tree

Showing 16 changed files with 214 additions and 172 deletions.
diff --git a/docs/index.md b/docs/index.md
@@ -10,63 +10,59 @@ composer require marquine\php-etl
 
 
 ## Setup
-### Global configuration
-Global configuration can be set using the `config` method. You can skip this configuration and use the full path when working with files.
+Global configuration can be set using the `config` method.
 ```php
+use Marquine\Etl\Etl;
+
 $config = [
-    'default_path' => '/path/to/etl/files',
-];
 
-Etl::config($config);
-```
+    // If not provided, you can use the full path when working with files.
+    'path' => '/path/to/etl/files',
 
-### Database
-SQLite connection:
-```php
-$connection = [
-    'driver' => 'sqlite',
-    'database' => '/path/to/database.sqlite'
-];
-```
+    // Currently supported databases: SQLite, MySQL, PostgreSQL
+    'database' => [
 
-MySQL connection
-```php
-$connection = [
-    'host' => localhost,
-    'port' => '3306',
-    'database' => dbname,
-    'username' => user,
-    'password' => pass,
-    'charset' => 'utf8',
-    'collation' => 'utf8_unicode_ci'
-];
-```
+        'default' => 'sqlite',
 
-PostgreSQL connection
-```php
-$connection = [
-    'driver' => 'pgsql',
-    'host' => 'localhost',
-    'port' => '5432',
-    'database' => 'dbname',
-    'username' => 'user',
-    'password' => 'pass',
-    'charset' => 'utf8',
-    'schema' => 'public'
-];
-```
+        'connections' => [
 
-Adding connections:
-```php
-use Marquine\Etl\Job;
+            'sqlite' => [
+                'driver' => 'sqlite',
+                'database' => '/path/to/database.sqlite',
+            ],
+
+            'mysql' => [
+                'driver' => 'mysql',
+                'host' => 'localhost',
+                'port' => '3306',
+                'database' => 'dbname',
+                'username' => 'user',
+                'password' => 'pass',
+                'charset' => 'utf8',
+                'collation' => 'utf8_unicode_ci',
+            ],
+
+            'pgsql' => [
+                'driver' => 'pgsql',
+                'host' => 'localhost',
+                'port' => '5432',
+                'database' => 'dbname',
+                'username' => 'user',
+                'password' => 'pass',
+                'charset' => 'utf8',
+                'schema' => 'public',
+            ],
 
-// default connection
-Etl::addConnection($connection);
+        ],
 
-// named connection
-Etl::addConnection($connection, 'connection_name');
+    ],
+
+];
+
+Etl::config($config);
 ```
 
+
 ## Laravel Setup
 If you are using Laravel, PHP ETL provides a default configuration file and will register all supported connections of your application.
 
@@ -77,7 +73,7 @@ Marquine\Etl\Providers\Laravel\EtlServiceProvider::class,
 
 Publish the configuration file (`config/etl.php`) using the artisan command:
 ```
-php artisan vendor:publish --provider="Marquine\Etl\Providers\Laravel\EtlServiceProvider"
+php artisan vendor:publish
 ```
 
 ## Example

diff --git a/src/Etl.php b/src/Etl.php
@@ -30,42 +30,15 @@ class Etl
     public static function config($config, $default = null)
     {
         if (is_string($config)) {
+            $value = static::$config;
+
             foreach (explode('.', $config) as $segment) {
-                $value = static::$config[$segment];
+                $value = isset($value[$segment]) ? $value[$segment] : null;
             }
 
             return $value ?: $default;
         }
 
         static::$config = $config;
-
-        if (isset($config['connections'])) {
-            foreach ($config['connections'] as $name => $connection) {
-                static::addConnection($connection, $name);
-            }
-        }
-    }
-
-    /**
-     * Add a database connection.
-     *
-     * @param array $connection
-     * @param string $name
-     * @return void
-     */
-    public static function addConnection($connection, $name = 'default')
-    {
-        static::$connections[$name] = ConnectionFactory::make($connection);
-    }
-
-    /**
-    * Get a database connection.
-    *
-    * @param string $name
-    * @return \Marquine\Etl\Database\Connection
-    */
-    public static function connection($name = 'default')
-    {
-        return static::$connections[$name];
     }
 }
diff --git a/src/Extractors/Query.php b/src/Extractors/Query.php
@@ -3,9 +3,11 @@
 namespace Marquine\Etl\Extractors;
 
 use Marquine\Etl\Etl;
+use Marquine\Etl\Traits\Database;
 
 class Query implements ExtractorInterface
 {
+    use Database;
     /**
      * The connection name.
      *
@@ -28,7 +30,9 @@ class Query implements ExtractorInterface
      */
     public function extract($query)
     {
-        $query = Etl::connection($this->connection)->prepare($query);
+        $this->connect($this->connection);
+
+        $query = $this->db->prepare($query);
 
         $query->execute($this->bindings);
 

diff --git a/src/Extractors/Table.php b/src/Extractors/Table.php
@@ -3,9 +3,12 @@
 namespace Marquine\Etl\Extractors;
 
 use Marquine\Etl\Etl;
+use Marquine\Etl\Traits\Database;
 
 class Table implements ExtractorInterface
 {
+    use Database;
+
     /**
      * The connection name.
      *
@@ -35,10 +38,12 @@ class Table implements ExtractorInterface
      */
     public function extract($table)
     {
+        $this->connect($this->connection);
+
         if (is_string($this->columns)) {
             $this->columns = [$this->columns];
         }
 
-        return Etl::connection($this->connection)->select($table, $this->columns, $this->where);
+        return $this->db->select($table, $this->columns, $this->where);
     }
 }
diff --git a/src/Loaders/Table.php b/src/Loaders/Table.php
@@ -3,11 +3,12 @@
 namespace Marquine\Etl\Loaders;
 
 use Marquine\Etl\Etl;
+use Marquine\Etl\Traits\Database;
 use Marquine\Etl\Traits\Indexable;
 
 class Table implements LoaderInterface
 {
-    use Indexable;
+    use Indexable, Database;
 
     /**
      * The connection name.
@@ -102,6 +103,8 @@ class Table implements LoaderInterface
      */
     public function load($table, $items)
     {
+        $this->connect($this->connection);
+
         $this->table = $table;
 
         $this->time = date('Y-m-d G:i:s');
@@ -113,7 +116,7 @@ public function load($table, $items)
         $old = [];
 
         if (! $this->skipDataCheck) {
-            $select = Etl::connection($this->connection)->select($this->table);
+            $select = $this->db->select($this->table);
 
             $old = $this->index($select, $this->keys);
 
@@ -149,7 +152,7 @@ protected function insert($items)
             return;
         }
 
-        $statement = Etl::connection($this->connection)->prepareInsert($this->table, $this->columns);
+        $statement = $this->db->prepareInsert($this->table, $this->columns);
 
         $callback = function ($items) use ($statement) {
             foreach ($items as $item) {
@@ -162,7 +165,7 @@ protected function insert($items)
             }
         };
 
-        Etl::connection($this->connection)->transaction($items, $callback, $this->transaction);
+        $this->db->transaction($items, $callback, $this->transaction);
     }
 
     /**
@@ -178,7 +181,7 @@ protected function update($items, $old)
             return;
         }
 
-        $statement = Etl::connection($this->connection)->prepareUpdate($this->table, $this->columns, $this->keys);
+        $statement = $this->db->prepareUpdate($this->table, $this->columns, $this->keys);
 
         $callback = function($items) use ($statement, $old) {
             foreach ($items as $key => $item) {
@@ -197,7 +200,7 @@ protected function update($items, $old)
             }
         };
 
-        Etl::connection($this->connection)->transaction($items, $callback, $this->transaction);
+        $this->db->transaction($items, $callback, $this->transaction);
     }
 
     /**
@@ -212,15 +215,15 @@ protected function delete($items)
             return;
         }
 
-        $statement = Etl::connection($this->connection)->prepareDelete($this->table, $this->keys);
+        $statement = $this->db->prepareDelete($this->table, $this->keys);
 
         $callback = function ($items) use ($statement) {
             foreach ($items as $item) {
                 $statement->execute(array_intersect_key($item, $this->keys));
             }
         };
 
-        Etl::connection($this->connection)->transaction($items, $callback, $this->transaction);
+        $this->db->transaction($items, $callback, $this->transaction);
     }
 
     /**
@@ -235,7 +238,7 @@ protected function softDelete($items)
             return;
         }
 
-        $statement = Etl::connection($this->connection)->prepareUpdate($this->table, $this->columns, $this->keys);
+        $statement = $this->db->prepareUpdate($this->table, $this->columns, $this->keys);
 
         $callback = function ($items) use ($statement) {
             foreach ($items as $item) {
@@ -245,7 +248,7 @@ protected function softDelete($items)
             }
         };
 
-        Etl::connection($this->connection)->transaction($items, $callback, $this->transaction);
+        $this->db->transaction($items, $callback, $this->transaction);
     }
 
     /**

diff --git a/src/Providers/Laravel/EtlServiceProvider.php b/src/Providers/Laravel/EtlServiceProvider.php
@@ -15,22 +15,10 @@ class EtlServiceProvider extends ServiceProvider
     public function boot()
     {
         $this->publishes([
-            __DIR__ . '/config.php' => config_path('etl.php'),
+            __DIR__ . '/etl.php' => config_path('etl.php'),
         ]);
 
-        foreach (config('database.connections') as $name => $connection) {
-            if (in_array($connection['driver'], ['sqlite', 'mysql'])) {
-                if ($name == config('database.default')) {
-                    Etl::addConnection($connection, 'default');
-                }
-
-                Etl::addConnection($connection, $name);
-            }
-        }
-
-        if (config('etl')) {
-            Etl::config(config('etl'));
-        }
+        Etl::config(config('etl'));
     }
 
     /**

diff --git a/src/Providers/Laravel/config.php b/src/Providers/Laravel/config.php
diff --git a/src/Providers/Laravel/etl.php b/src/Providers/Laravel/etl.php
@@ -0,0 +1,16 @@
+<?php
+
+return [
+
+    // If not provided, you can use the full path when working with files.
+    'path' => env('ETL_PATH', base_path('etl')),
+
+    // Currently supported databases: SQLite, MySQL, PostgreSQL
+    'database' => [
+
+        'default' => config('database.default'),
+
+        'connections' => config('database.connections'),
+    ],
+
+];
diff --git a/src/Traits/Database.php b/src/Traits/Database.php
@@ -0,0 +1,34 @@
+<?php
+
+namespace Marquine\Etl\Traits;
+
+use Marquine\Etl\Etl;
+use Marquine\Etl\Database\Connectors\ConnectionFactory;
+
+
+trait Database
+{
+    /**
+     * Database connection.
+     *
+     * @var \Marquine\Etl\Database\Connection
+     */
+    protected $db;
+
+    /**
+     * Validate the given source.
+     *
+     * @param string $source
+     * @return string
+     */
+    protected function connect($connection)
+    {
+        if ($connection == 'default') {
+            $connection = Etl::config('database.default');
+        }
+
+        $connection = Etl::config("database.connections.$connection");
+
+        $this->db = ConnectionFactory::make($connection);
+    }
+}