[5.x] Separate globals config and content

database/migrations/2024_03_07_100000_create_global_variables_table.php

@@ -12,7 +12,6 @@ public function up()
             $table->id();
             $table->string('handle')->index();
             $table->string('locale')->nullable();
-            $table->string('origin')->nullable();
             $table->jsonb('data');
             $table->timestamps();
         });

database/migrations/updates/drop_origin_on_global_set_variables.php.stub

@@ -0,0 +1,21 @@
+<?php
+
+use Illuminate\Database\Schema\Blueprint;
+use Illuminate\Support\Facades\Schema;
+use Statamic\Eloquent\Database\BaseMigration as Migration;
+
+return new class extends Migration {
+    public function up()
+    {
+        Schema::table($this->prefix('global_set_variables'), function (Blueprint $table) {
+            $table->dropColumn('origin');
+        });
+    }
+
+    public function down()
+    {
+        Schema::table($this->prefix('global_set_variables'), function (Blueprint $table) {
+            $table->string('origin')->nullable();
+        });
+    }
+};

src/Globals/GlobalSet.php

@@ -5,6 +5,7 @@
 use Statamic\Contracts\Globals\GlobalSet as Contract;
 use Statamic\Eloquent\Globals\GlobalSetModel as Model;
 use Statamic\Globals\GlobalSet as FileEntry;
+use Statamic\Support\Arr;
 
 class GlobalSet extends FileEntry
 {
@@ -15,6 +16,7 @@ public static function fromModel(Model $model)
         $global = (new static)
             ->handle($model->handle)
             ->title($model->title)
+            ->sites(Arr::get($model->settings, 'sites'))
             ->model($model);
 
         return $global;
@@ -31,7 +33,11 @@ public static function makeModelFromContract(Contract $source)
 
         return $class::firstOrNew(['handle' => $source->handle()])->fill([
             'title' => $source->title(),
-            'settings'  => [], // future proofing
+            'settings' => [
+                'sites' => $source->sites()
+                    ->mapWithKeys(fn ($site) => [$site => $source->origins()->get($site)])
+                    ->all(),
+            ],
         ]);
     }
 

src/Globals/Variables.php

@@ -16,7 +16,6 @@ public static function fromModel(Model $model)
             ->globalSet($model->handle)
             ->locale($model->locale)
             ->data($model->data)
-            ->origin($model->origin ?? null)
             ->model($model);
     }
 
@@ -31,31 +30,14 @@ public static function makeModelFromContract(Contract $source)
 
         $data = $source->data();
 
-        if ($source->hasOrigin()) {
-            $data = $source->origin()->data()->merge($data);
-        }
-
         return $class::firstOrNew([
             'handle' => $source->globalSet()->handle(),
             'locale' => $source->locale,
         ])->fill([
             'data'   => $data->filter(fn ($v) => $v !== null),
-            'origin' => $source->hasOrigin() ? $source->origin()->locale() : null,
         ]);
     }
 
-    protected function getOriginByString($origin)
-    {
-        return $this->globalSet()->in($origin);
-    }
-
-    public function save()
-    {
-        $this->toModel()->save();
-
-        return $this;
-    }
-
     public function model($model = null)
     {
         if (func_num_args() === 0) {

src/ServiceProvider.php

@@ -57,6 +57,8 @@ class ServiceProvider extends AddonServiceProvider
         \Statamic\Eloquent\Updates\RelateFormSubmissionsByHandle::class,
         \Statamic\Eloquent\Updates\DropStatusOnEntries::class,
         \Statamic\Eloquent\Updates\ChangeFormSubmissionsIdType::class,
+        \Statamic\Eloquent\Updates\DropOriginOnGlobalSetVariables::class,
+        \Statamic\Eloquent\Updates\UpdateGlobalVariables::class,
     ];
 
     public function boot()

src/Updates/DropOriginOnGlobalSetVariables.php

@@ -0,0 +1,24 @@
+<?php
+
+namespace Statamic\Eloquent\Updates;
+
+use Statamic\UpdateScripts\UpdateScript;
+
+class DropOriginOnGlobalSetVariables extends UpdateScript
+{
+    public function shouldUpdate($newVersion, $oldVersion)
+    {
+        return $this->isUpdatingTo('5.0.0');
+    }
+
+    public function update()
+    {
+        $source = __DIR__.'/../../database/migrations/updates/drop_origin_on_global_set_variables.php.stub';
+        $dest = database_path('migrations/'.date('Y_m_d_His').'_drop_origin_on_global_set_variables.php');
+
+        $this->files->copy($source, $dest);
+
+        $this->console()->info('Migrations created');
+        $this->console()->comment('Remember to run `php artisan migrate` to apply it to your database.');
+    }
+}

src/Updates/UpdateGlobalVariables.php

@@ -0,0 +1,40 @@
+<?php
+
+namespace Statamic\Eloquent\Updates;
+
+use Statamic\Facades\GlobalSet;
+use Statamic\Facades\GlobalVariables;
+use Statamic\Facades\Site;
+use Statamic\UpdateScripts\UpdateScript;
+
+class UpdateGlobalVariables extends UpdateScript
+{
+    public function shouldUpdate($newVersion, $oldVersion)
+    {
+        return $this->isUpdatingTo('5.0.0');
+    }
+
+    public function update()
+    {
+        // This update script deals with reading and & writing from the database. There's an
+        // equivalent update script for Stache-driven sites that deals with reading & writing YAML files.
+        if (config('statamic.eloquent-driver.global_set_variables.driver') !== 'eloquent') {
+            return;
+        }
+
+        // We don't need to do anything for single-site installs.
+        if (! Site::multiEnabled()) {
+            return;
+        }
+
+        GlobalSet::all()->each(function ($globalSet) {
+            $variables = GlobalVariables::whereSet($globalSet->handle());
+
+            $sites = $variables->mapWithKeys(function ($variable) {
+                return [$variable->locale() => $variable->model()->origin];
+            });
+
+            $globalSet->sites($sites)->save();
+        });
+    }
+}

tests/Commands/ImportGlobalsTest.php

@@ -35,8 +35,7 @@ protected function setUp(): void
     public function it_imports_global_sets_and_variables()
     {
         $globalSet = tap(GlobalSet::make('footer')->title('Footer'))->save();
-        $variables = $globalSet->makeLocalization('en')->data(['foo' => 'bar']);
-        $globalSet->addLocalization($variables)->save();
+        $globalSet->in('en')->data(['foo' => 'bar'])->save();
 
         $this->assertCount(0, GlobalSetModel::all());
         $this->assertCount(0, VariablesModel::all());
@@ -58,8 +57,7 @@ public function it_imports_global_sets_and_variables()
     public function it_imports_global_sets_and_variables_with_force_argument()
     {
         $globalSet = tap(GlobalSet::make('footer')->title('Footer'))->save();
-        $variables = $globalSet->makeLocalization('en')->data(['foo' => 'bar']);
-        $globalSet->addLocalization($variables)->save();
+        $globalSet->in('en')->data(['foo' => 'bar'])->save();
 
         $this->assertCount(0, GlobalSetModel::all());
         $this->assertCount(0, VariablesModel::all());
@@ -79,8 +77,7 @@ public function it_imports_global_sets_and_variables_with_force_argument()
     public function it_imports_only_global_sets_with_console_question()
     {
         $globalSet = tap(GlobalSet::make('footer')->title('Footer'))->save();
-        $variables = $globalSet->makeLocalization('en')->data(['foo' => 'bar']);
-        $globalSet->addLocalization($variables)->save();
+        $globalSet->in('en')->data(['foo' => 'bar'])->save();
 
         $this->assertCount(0, GlobalSetModel::all());
         $this->assertCount(0, VariablesModel::all());
@@ -102,8 +99,7 @@ public function it_imports_only_global_sets_with_console_question()
     public function it_imports_only_global_sets_with_only_global_sets_argument()
     {
         $globalSet = tap(GlobalSet::make('footer')->title('Footer'))->save();
-        $variables = $globalSet->makeLocalization('en')->data(['foo' => 'bar']);
-        $globalSet->addLocalization($variables)->save();
+        $globalSet->in('en')->data(['foo' => 'bar'])->save();
 
         $this->assertCount(0, GlobalSetModel::all());
         $this->assertCount(0, VariablesModel::all());
@@ -123,8 +119,7 @@ public function it_imports_only_global_sets_with_only_global_sets_argument()
     public function it_imports_only_variables_with_console_question()
     {
         $globalSet = tap(GlobalSet::make('footer')->title('Footer'))->save();
-        $variables = $globalSet->makeLocalization('en')->data(['foo' => 'bar']);
-        $globalSet->addLocalization($variables)->save();
+        $globalSet->in('en')->data(['foo' => 'bar'])->save();
 
         $this->assertCount(0, GlobalSetModel::all());
         $this->assertCount(0, VariablesModel::all());
@@ -146,8 +141,7 @@ public function it_imports_only_variables_with_console_question()
     public function it_imports_only_variables_with_only_global_variables_argument()
     {
         $globalSet = tap(GlobalSet::make('footer')->title('Footer'))->save();
-        $variables = $globalSet->makeLocalization('en')->data(['foo' => 'bar']);
-        $globalSet->addLocalization($variables)->save();
+        $globalSet->in('en')->data(['foo' => 'bar'])->save();
 
         $this->assertCount(0, GlobalSetModel::all());
         $this->assertCount(0, VariablesModel::all());

tests/Data/Globals/GlobalSetTest.php

@@ -9,46 +9,8 @@
 class GlobalSetTest extends TestCase
 {
     #[Test]
-    public function it_gets_file_contents_for_saving_with_a_single_site()
+    public function it_gets_file_contents_for_saving()
     {
-        config()->set('statamic.system.multisite', false);
-
-        $this->setSites([
-            'en' => ['name' => 'English', 'locale' => 'en_US', 'url' => 'http://test.com/'],
-        ]);
-
-        $set = (new GlobalSet)->title('The title');
-
-        $variables = $set->makeLocalization('en')->data([
-            'array'  => ['first one', 'second one'],
-            'string' => 'The string',
-        ]);
-
-        $set->addLocalization($variables);
-
-        $expected = <<<'EOT'
-title: 'The title'
-data:
-  array:
-    - 'first one'
-    - 'second one'
-  string: 'The string'
-
-EOT;
-        $this->assertEquals($expected, $set->fileContents());
-    }
-
-    #[Test]
-    public function it_gets_file_contents_for_saving_with_multiple_sites()
-    {
-        config()->set('statamic.system.multisite', true);
-
-        $this->setSites([
-            'en' => ['name' => 'English', 'locale' => 'en_US', 'url' => 'http://test.com/'],
-            'fr' => ['name' => 'French', 'locale' => 'fr_FR', 'url' => 'http://fr.test.com/'],
-            'de' => ['name' => 'German', 'locale' => 'de_DE', 'url' => 'http://test.com/de/'],
-        ]);
-
         $set = (new GlobalSet)->title('The title');
 
         // We set the data but it's basically irrelevant since it won't get saved to this file.
@@ -58,12 +20,6 @@ public function it_gets_file_contents_for_saving_with_multiple_sites()
                 'string' => 'The string',
             ]);
         });
-        $set->in('fr', function ($loc) {
-            $loc->data([
-                'array'  => ['le first one', 'le second one'],
-                'string' => 'Le string',
-            ]);
-        });
 
         $expected = <<<'EOT'
 title: 'The title'