Split globals and global variables, provide eloquent global variable repository (#178)

Author: ryanmitchell

composer.json

@@ -24,7 +24,7 @@
     },
     "require": {
         "php": "^8.0",
-        "statamic/cms": "^4.6.0"
+        "statamic/cms": "^4.16"
     },
     "require-dev": {
         "doctrine/dbal": "^3.3",

config/eloquent-driver.php

@@ -47,9 +47,13 @@
     ],
 
     'global_sets' => [
-        'driver'          => 'eloquent',
-        'model'           => \Statamic\Eloquent\Globals\GlobalSetModel::class,
-        'variables_model' => \Statamic\Eloquent\Globals\VariablesModel::class,
+        'driver' => 'eloquent',
+        'model'  => \Statamic\Eloquent\Globals\GlobalSetModel::class,
+    ],
+
+    'global_set_variables' => [
+        'driver' => 'eloquent',
+        'model'  => \Statamic\Eloquent\Globals\VariablesModel::class,
     ],
 
     'navigations' => [

src/Globals/GlobalRepository.php

@@ -3,7 +3,6 @@
 namespace Statamic\Eloquent\Globals;
 
 use Statamic\Contracts\Globals\GlobalSet as GlobalSetContract;
-use Statamic\Contracts\Globals\Variables as VariablesContract;
 use Statamic\Facades\Blink;
 use Statamic\Globals\GlobalCollection;
 use Statamic\Stache\Repositories\GlobalRepository as StacheRepository;
@@ -69,7 +68,6 @@ public static function bindings(): array
     {
         return [
             GlobalSetContract::class => GlobalSet::class,
-            VariablesContract::class => Variables::class,
         ];
     }
 }

src/Globals/GlobalSet.php

@@ -3,7 +3,6 @@
 namespace Statamic\Eloquent\Globals;
 
 use Statamic\Contracts\Globals\GlobalSet as Contract;
-use Statamic\Contracts\Globals\Variables as VariablesContract;
 use Statamic\Eloquent\Globals\GlobalSetModel as Model;
 use Statamic\Globals\GlobalSet as FileEntry;
 
@@ -18,13 +17,6 @@ public static function fromModel(Model $model)
             ->title($model->title)
             ->model($model);
 
-        $variablesModel = app('statamic.eloquent.global_sets.variables_model');
-
-        $localizations = $variablesModel::query()->where('handle', $model->handle)->get();
-        foreach ($localizations as $localization) {
-            $global->addLocalization(app(VariablesContract::class)::fromModel($localization));
-        }
-
         return $global;
     }
 
@@ -37,23 +29,12 @@ public static function makeModelFromContract(Contract $source)
     {
         $class = app('statamic.eloquent.global_sets.model');
 
-        $source->localizations()->each(function ($value) {
-            Variables::makeModelFromContract($value);
-        });
-
         return $class::firstOrNew(['handle' => $source->handle()])->fill([
             'title' => $source->title(),
             'settings'  => [], // future proofing
         ]);
     }
 
-    public function makeLocalization($site)
-    {
-        return app(VariablesContract::class)
-            ->globalSet($this)
-            ->locale($site);
-    }
-
     public function model($model = null)
     {
         if (func_num_args() === 0) {

src/Globals/GlobalVariablesRepository.php

@@ -0,0 +1,71 @@
+<?php
+
+namespace Statamic\Eloquent\Globals;
+
+use Statamic\Contracts\Globals\Variables;
+use Statamic\Globals\VariablesCollection;
+use Statamic\Stache\Repositories\GlobalVariablesRepository as StacheRepository;
+use Statamic\Support\Str;
+
+class GlobalVariablesRepository extends StacheRepository
+{
+    public function all(): VariablesCollection
+    {
+        return VariablesCollection::make(
+            VariablesModel::all()
+            ->each(function ($model) {
+                return app(Variables::class)::fromModel($model);
+            })
+        );
+    }
+
+    public function find($id): ?Variables
+    {
+        $id = Str::split($id, '::');
+
+        $model = VariablesModel::query()
+            ->where('handle', $id[0])
+            ->when(count($id) > 1, function ($query) use ($id) {
+                $query->where('locale', $id[1]);
+            })
+            ->first();
+
+        if (! $model) {
+            return null;
+        }
+
+        return app(Variables::class)::fromModel($model);
+    }
+
+    public function whereSet($handle): VariablesCollection
+    {
+        return VariablesCollection::make(
+            VariablesModel::query()
+                ->where('handle', $handle)
+                ->get()
+                ->map(function ($model) {
+                    return app(Variables::class)::fromModel($model);
+                })
+        );
+    }
+
+    public function save($variable)
+    {
+        $model = $variable->toModel();
+        $model->save();
+
+        $variable->model($model->fresh());
+    }
+
+    public function delete($variable)
+    {
+        $variable->model()->delete();
+    }
+
+    public static function bindings(): array
+    {
+        return [
+            Variables::class => \Statamic\Eloquent\Globals\Variables::class,
+        ];
+    }
+}

src/Globals/Variables.php

@@ -2,19 +2,22 @@
 
 namespace Statamic\Eloquent\Globals;
 
+use Illuminate\Database\Eloquent\Model;
 use Statamic\Contracts\Globals\Variables as Contract;
-use Statamic\Eloquent\Globals\VariablesModel as Model;
 use Statamic\Globals\Variables as FileEntry;
 
 class Variables extends FileEntry
 {
+    protected $model;
+
     public static function fromModel(Model $model)
     {
         return (new static())
             ->globalSet($model->handle)
             ->locale($model->locale)
             ->data($model->data)
-            ->origin($model->origin ?? null);
+            ->origin($model->origin ?? null)
+            ->model($model);
     }
 
     public function toModel()
@@ -24,7 +27,7 @@ public function toModel()
 
     public static function makeModelFromContract(Contract $source)
     {
-        $class = app('statamic.eloquent.global_sets.variables_model');
+        $class = app('statamic.eloquent.global_set_variables.model');
 
         $data = $source->data();
 
@@ -52,4 +55,15 @@ public function save()
 
         return $this;
     }
+
+    public function model($model = null)
+    {
+        if (func_num_args() === 0) {
+            return $this->model;
+        }
+
+        $this->model = $model;
+
+        return $this;
+    }
 }

src/ServiceProvider.php

@@ -9,6 +9,7 @@
 use Statamic\Contracts\Entries\EntryRepository as EntryRepositoryContract;
 use Statamic\Contracts\Forms\FormRepository as FormRepositoryContract;
 use Statamic\Contracts\Globals\GlobalRepository as GlobalRepositoryContract;
+use Statamic\Contracts\Globals\GlobalVariablesRepository as GlobalVariablesRepositoryContract;
 use Statamic\Contracts\Revisions\RevisionRepository as RevisionRepositoryContract;
 use Statamic\Contracts\Structures\CollectionTreeRepository as CollectionTreeRepositoryContract;
 use Statamic\Contracts\Structures\NavigationRepository as NavigationRepositoryContract;
@@ -22,6 +23,7 @@
 use Statamic\Eloquent\Entries\EntryRepository;
 use Statamic\Eloquent\Forms\FormRepository;
 use Statamic\Eloquent\Globals\GlobalRepository;
+use Statamic\Eloquent\Globals\GlobalVariablesRepository;
 use Statamic\Eloquent\Listeners\UpdateStructuredEntryOrder;
 use Statamic\Eloquent\Revisions\RevisionRepository;
 use Statamic\Eloquent\Structures\CollectionTreeRepository;
@@ -127,6 +129,7 @@ public function register()
         $this->registerEntries();
         $this->registerForms();
         $this->registerGlobals();
+        $this->registerGlobalVariables();
         $this->registerRevisions();
         $this->registerStructures();
         $this->registerStructureTrees();
@@ -280,9 +283,20 @@ private function registerGlobals()
         $this->app->bind('statamic.eloquent.global_sets.model', function () {
             return config('statamic.eloquent-driver.global_sets.model');
         });
+    }
+
+    private function registerGlobalVariables()
+    {
+        $usingOldConfigKeys = config()->has('statamic.eloquent-driver.global_sets.variables_model');
+
+        if (config($usingOldConfigKeys ? 'statamic.eloquent-driver.global_sets.driver' : 'statamic.eloquent-driver.global_set_variables.driver', 'file') != 'eloquent') {
+            return;
+        }
+
+        Statamic::repository(GlobalVariablesRepositoryContract::class, GlobalVariablesRepository::class);
 
-        $this->app->bind('statamic.eloquent.global_sets.variables_model', function () {
-            return config('statamic.eloquent-driver.global_sets.variables_model');
+        $this->app->bind('statamic.eloquent.global_set_variables.model', function () use ($usingOldConfigKeys) {
+            return config($usingOldConfigKeys ? 'statamic.eloquent-driver.global_sets.variables_model' : 'statamic.eloquent-driver.global_set_variables.model');
         });
 
         Statamic::repository(GlobalRepositoryContract::class, GlobalRepository::class);

tests/Data/Globals/VariablesTest.php

@@ -63,6 +63,10 @@ public function it_gets_file_contents_for_saving_a_localized_set()
             'empty'  => [],  // and this should get stripped out because there's no origin to fall back to.
         ]);
 
+        $global->addLocalization($a);
+        $global->addLocalization($b);
+        $global->addLocalization($c);
+
         $expected = <<<'EOT'
 array:
   - 'first one'
@@ -130,6 +134,12 @@ public function if_the_value_is_explicitly_set_to_null_then_it_should_not_fall_b
             'two' => null,
         ]);
 
+        $global->addLocalization($a);
+        $global->addLocalization($b);
+        $global->addLocalization($c);
+        $global->addLocalization($d);
+        $global->addLocalization($e);
+
         $this->assertEquals([
             'one'   => 'alfa',
             'two'   => 'bravo',