Rename selections to highlights [API-32]

Author: nikhiltri

app/Console/Commands/Import/ImportWebFull.php

@@ -11,7 +11,7 @@
 use App\Models\Web\Exhibition;
 use App\Models\Web\Experience;
 use App\Models\Web\InteractiveFeature;
-use App\Models\Web\Selection;
+use App\Models\Web\Highlight;
 use App\Models\Web\GenericPage;
 use App\Models\Web\PressRelease;
 use App\Models\Web\EducatorResource;
@@ -70,7 +70,7 @@ protected function reset($endpoint = null)
             Exhibition::class => 'web_exhibitions',
             Experience::class => 'experiences',
             InteractiveFeature::class => 'interactive_features',
-            Selection::class => 'selections',
+            Highlight::class => 'highlights',
             GenericPage::class => 'generic_pages',
             PressRelease::class => 'press_releases',
             EducatorResource::class => 'educator_resources',
@@ -102,7 +102,7 @@ protected function importEndpoints()
         $this->importFromWeb('exhibitions');
         $this->importFromWeb('experiences');
         $this->importFromWeb('interactive-features');
-        $this->importFromWeb('selections');
+        $this->importFromWeb('highlights');
 
         $this->importFromWeb('genericpages');
         $this->importFromWeb('pressreleases');

app/Http/Middleware/RestrictContent.php

@@ -47,7 +47,7 @@ public static function getSearchRestrictForEndpoint($endpoint)
             'generic-pages',
             'press-releases',
             'printed-catalogues',
-            'selections',
+            'highlights',
             'sponsors',
             'static-pages',
             'web-exhibitions',

app/Models/BaseModel.php

@@ -20,7 +20,7 @@
 use App\Models\Web\GenericPage;
 use App\Models\Web\PressRelease;
 use App\Models\Web\PrintedCatalog;
-use App\Models\Web\Selection;
+use App\Models\Web\Highlight;
 use App\Models\Web\Sponsor;
 use App\Models\Web\StaticPage;
 
@@ -140,7 +140,7 @@ public static function addRestrictContentScopes($isDump = false)
         GenericPage::addGlobalScope(new PublishedScope);
         PressRelease::addGlobalScope(new PublishedScope);
         PrintedCatalog::addGlobalScope(new PublishedScope);
-        Selection::addGlobalScope(new PublishedScope);
+        Highlight::addGlobalScope(new PublishedScope);
         Sponsor::addGlobalScope(new PublishedScope);
         StaticPage::addGlobalScope(new PublishedScope);
         WebExhibition::addGlobalScope(new PublishedScope);

app/Models/Web/Selection.php renamed to app/Models/Web/Highlight.php

@@ -5,9 +5,9 @@
 use App\Models\WebModel;
 
 /**
- * Selections are a grouping of artworks on the website
+ * Highlights are a grouping of artworks on the website
  */
-class Selection extends WebModel
+class Highlight extends WebModel
 {
 
     protected $casts = [

app/Transformers/Inbound/Web/Selection.php renamed to app/Transformers/Inbound/Web/Highlight.php

@@ -5,7 +5,7 @@
 use App\Transformers\Datum;
 use App\Transformers\Inbound\WebTransformer;
 
-class Selection extends WebTransformer
+class Highlight extends WebTransformer
 {
 
     // Technically, we only need `copy`, but `imgix_url` gets pruned

app/Transformers/Outbound/Web/Selection.php renamed to app/Transformers/Outbound/Web/Highlight.php

@@ -6,7 +6,7 @@
 
 use App\Transformers\Outbound\AbstractTransformer as BaseTransformer;
 
-class Selection extends BaseTransformer
+class Highlight extends BaseTransformer
 {
 
     use HasPublishDates;
@@ -22,12 +22,12 @@ protected function getFields()
                 'is_restricted' => true,
             ],
             'short_copy' => [
-                'doc' => 'A brief summary of what is contained in the selection',
+                'doc' => 'A brief summary of what is contained in the highlight',
                 'type' => 'string',
                 'elasticsearch' => 'text',
             ],
             'copy' => [
-                'doc' => 'The text of the selection description',
+                'doc' => 'The text of the highlight description',
                 'type' => 'string',
                 'elasticsearch' => [
                     'default' => true,

config/resources/inbound.php

@@ -195,9 +195,9 @@
             'model' => \App\Models\Web\InteractiveFeature::class,
             'transformer' => \App\Transformers\Inbound\Web\InteractiveFeature::class,
         ],
-        'selections' => [
-            'model' => \App\Models\Web\Selection::class,
-            'transformer' => \App\Transformers\Inbound\Web\Selection::class,
+        'highlights' => [
+            'model' => \App\Models\Web\Highlight::class,
+            'transformer' => \App\Transformers\Inbound\Web\Highlight::class,
         ],
         'staticpages' => [
             'model' => \App\Models\Web\StaticPage::class,

config/resources/outbound.php

@@ -363,9 +363,9 @@
             'is_searchable' => true,
         ],
         [
-            'endpoint' => 'selections',
-            'model' => \App\Models\Web\Selection::class,
-            'transformer' => \App\Transformers\Outbound\Web\Selection::class,
+            'endpoint' => 'highlights',
+            'model' => \App\Models\Web\Highlight::class,
+            'transformer' => \App\Transformers\Outbound\Web\Highlight::class,
             'is_searchable' => true,
         ],
         [

database/factories/WebFactory.php

@@ -53,7 +53,7 @@
     ];
 });
 
-$factory->define(App\Models\Web\Selection::class, function (Faker\Generator $faker) {
+$factory->define(App\Models\Web\Highlight::class, function (Faker\Generator $faker) {
     return [
         'id' => $faker->unique()->randomNumber(4) + 999 * pow(10, 4),
         'title' => ucfirst($faker->words(3, true)),

database/migrations/2021_09_20_125600_rename_selections_to_highlights.php

@@ -0,0 +1,28 @@
+<?php
+
+use Illuminate\Support\Facades\Schema;
+use Illuminate\Database\Schema\Blueprint;
+use Illuminate\Database\Migrations\Migration;
+
+class RenameSelectionsToHighlights extends Migration
+{
+    /**
+     * Run the migrations.
+     *
+     * @return void
+     */
+    public function up()
+    {
+        Schema::rename('selections', 'highlights');
+    }
+
+    /**
+     * Reverse the migrations.
+     *
+     * @return void
+     */
+    public function down()
+    {
+        Schema::rename('highlights', 'selections');
+    }
+}