Support timezones

Author: jasonmccreary

src/Blueprint.php

@@ -14,7 +14,7 @@ class Blueprint
 
     public function parse($content)
     {
-        $content = preg_replace_callback('/^(\s+)(id|timestamps|soft[dD]eletes)$/m', function ($matches) {
+        $content = preg_replace_callback('/^(\s+)(id|timestamps(Tz)?|softDeletes(Tz)?)$/mi', function ($matches) {
             return $matches[1] . strtolower($matches[2]) . ': ' . $matches[2];
         }, $content);
 

src/Generators/MigrationGenerator.php

@@ -83,8 +83,12 @@ protected function buildDefinition(Model $model)
             $definition .= ';' . PHP_EOL;
         }
 
+        if ($model->usesSoftDeletes()) {
+            $definition .= self::INDENT . '$table->' . $model->softDeletesDataType() . '();' . PHP_EOL;
+        }
+
         if ($model->usesTimestamps()) {
-            $definition .= self::INDENT . '$table->timestamps();' . PHP_EOL;
+            $definition .= self::INDENT . '$table->' . $model->timestampsDataType() . '();' . PHP_EOL;
         }
 
         return trim($definition);

src/Lexers/ModelLexer.php

@@ -109,11 +109,17 @@ private function buildModel(string $name, array $columns)
             }
 
             unset($columns['timestamps']);
+        } elseif (isset($columns['timestampstz'])) {
+            $model->enableTimestamps(true);
+            unset($columns['timestampstz']);
         }
 
         if (isset($columns['softdeletes'])) {
             $model->enableSoftDeletes();
             unset($columns['softdeletes']);
+        } elseif (isset($columns['softdeletestz'])) {
+            $model->enableSoftDeletes(true);
+            unset($columns['softdeletestz']);
         }
 
         if (!isset($columns['id'])) {

src/Models/Model.php

@@ -7,7 +7,7 @@
 class Model
 {
     private $name;
-    private $timestamps = true;
+    private $timestamps = 'timestamps';
     private $softDeletes = false;
     private $columns = [];
 
@@ -34,34 +34,49 @@ public function columns(): array
         return $this->columns;
     }
 
-    public function usesTimestamps()
+    public function primaryKey()
+    {
+        return 'id';
+    }
+
+    public function tableName()
+    {
+        return Str::snake(Str::pluralStudly($this->name));
+    }
+
+    public function timestampsDataType(): string
     {
         return $this->timestamps;
     }
 
+    public function usesTimestamps(): bool
+    {
+        return $this->timestamps !== false;
+    }
+
     public function disableTimestamps()
     {
         $this->timestamps = false;
     }
 
-    public function primaryKey()
+    public function enableTimestamps(bool $withTimezone = false)
     {
-
+        $this->timestamps = $withTimezone ? 'timestampsTz' : 'timestamps';
     }
 
-    public function tableName()
+    public function softDeletesDataType(): string
     {
-        return Str::snake(Str::pluralStudly($this->name));
+        return $this->softDeletes;
     }
 
     public function usesSoftDeletes(): bool
     {
-        return $this->softDeletes;
+        return $this->softDeletes !== false;
     }
 
-    public function enableSoftDeletes()
+    public function enableSoftDeletes(bool $withTimezone = false)
     {
-        $this->softDeletes = true;
+        $this->softDeletes = $withTimezone ? 'softDeletesTz' : 'softDeletes';
     }
 
     public function hasColumn(string $name)

tests/Feature/BlueprintTest.php

@@ -8,6 +8,9 @@
 use Symfony\Component\Yaml\Exception\ParseException;
 use Tests\TestCase;
 
+/**
+ * @see Blueprint
+ */
 class BlueprintTest extends TestCase
 {
     /**
@@ -87,6 +90,23 @@ public function it_parses_shorthands()
         ], $this->subject->parse($blueprint));
     }
 
+    /**
+     * @test
+     */
+    public function it_parses_shorthands_with_timezones()
+    {
+        $blueprint = $this->fixture('definitions/with-timezones.bp');
+
+        $this->assertEquals([
+            'models' => [
+                'Comment' => [
+                    'softdeletestz' => 'softDeletesTz',
+                    'timestampstz' => 'timestampstz',
+                ],
+            ],
+        ], $this->subject->parse($blueprint));
+    }
+
     /**
      * @test
      */

tests/Feature/Generator/MigrationGeneratorTest.php

@@ -7,6 +7,9 @@
 use Carbon\Carbon;
 use Tests\TestCase;
 
+/**
+ * @see MigrationGenerator
+ */
 class MigrationGeneratorTest extends TestCase
 {
     private $blueprint;
@@ -66,13 +69,14 @@ public function output_writes_migration_for_model_tree($definition, $path, $migr
         $this->assertEquals(['created' => [$timestamp_path]], $this->subject->output($tree));
     }
 
-
     public function modelTreeDataProvider()
     {
         return [
             ['definitions/readme-example.bp', 'database/migrations/timestamp_create_posts_table.php', 'migrations/readme-example.php'],
             ['definitions/model-identities.bp', 'database/migrations/timestamp_create_relationships_table.php', 'migrations/identity-columns.php'],
             ['definitions/model-modifiers.bp', 'database/migrations/timestamp_create_modifiers_table.php', 'migrations/modifiers.php'],
+            ['definitions/soft-deletes.bp', 'database/migrations/timestamp_create_comments_table.php', 'migrations/soft-deletes.php'],
+            ['definitions/with-timezones.bp', 'database/migrations/timestamp_create_comments_table.php', 'migrations/with-timezones.php'],
         ];
     }
 }

tests/Feature/Generator/ModelGeneratorTest.php

@@ -83,6 +83,7 @@ public function modelTreeDataProvider()
         return [
             ['definitions/readme-example.bp', 'app/Post.php', 'models/readme-example.php'],
             ['definitions/soft-deletes.bp', 'app/Comment.php', 'models/soft-deletes.php'],
+            ['definitions/with-timezones.bp', 'app/Comment.php', 'models/soft-deletes.php'],
         ];
     }
 }

tests/fixtures/definitions/shorthands.bp

@@ -2,4 +2,4 @@ models:
   Name:
     softDeletes
     id
-    timestamps
+    timestamps

tests/fixtures/definitions/with-timezones.bp

@@ -0,0 +1,4 @@
+models:
+  Comment:
+    softDeletesTz
+    timestampstz

tests/fixtures/migrations/soft-deletes.php

@@ -0,0 +1,32 @@
+<?php
+
+use Illuminate\Database\Migrations\Migration;
+use Illuminate\Database\Schema\Blueprint;
+use Illuminate\Support\Facades\Schema;
+
+class CreateCommentsTable extends Migration
+{
+    /**
+     * Run the migrations.
+     *
+     * @return void
+     */
+    public function up()
+    {
+        Schema::create('comments', function (Blueprint $table) {
+            $table->increments('id');
+            $table->softDeletes();
+            $table->timestamps();
+        });
+    }
+
+    /**
+     * Reverse the migrations.
+     *
+     * @return void
+     */
+    public function down()
+    {
+        Schema::dropIfExists('comments');
+    }
+}