Merge pull request #81 from algolia/slaves-replicas-renaming

Change slaves to replicas

Author: maxiloc

README.md

@@ -20,7 +20,7 @@ This PHP package integrates the Algolia Search API to the Laravel Eloquent ORM.
 4. [Ranking & Relevance](#ranking--relevance)
 5. [Options](#options)
 6. [Indexing](#indexing)
-7. [Master/Slave](#masterslave)
+7. [Primary/Replica](#primaryreplica)
 8. [Target multiple indexes](#target-multiple-indexes)
 
 <!--/NO_HTML-->
@@ -123,7 +123,7 @@ Contact::setSettings();
 
 Synonyms are used to tell the engine about words or expressions that should be considered equal in regard to the textual relevance.
 
-Our [synonyms API](https://www.algolia.com/doc/relevance/synonyms) has been designed to manage as easily as possible a large set of synonyms for an index and its slaves.
+Our [synonyms API](https://www.algolia.com/doc/relevance/synonyms) has been designed to manage as easily as possible a large set of synonyms for an index and its replicas.
 
 You can use the synonyms API by adding a `synonyms` in `$algoliaSettings` class property like this:
 
@@ -393,9 +393,9 @@ Contact::clearIndices();
 
 ## Manage indices
 
-### Master/Slave
+### Primary/Replica
 
-You can define slave indexes using the `$algolia_settings` variable:
+You can define replica indexes using the `$algolia_settings` variable:
 
 ```php
 use Illuminate\Database\Eloquent\Model;
@@ -413,12 +413,12 @@ class Contact extends Model
             'desc(popularity)',
             'asc(name)',
         ],
-        'slaves' => [
+        'replicas' => [
             'contacts_desc',
         ],
     ];
 
-    public $slavesSettings = [
+    public $replicasSettings = [
         'contacts_desc' => [
             'ranking' => [
                 'desc(name)',
@@ -435,7 +435,7 @@ class Contact extends Model
 }
 ```
 
-To search using a slave use the following code:
+To search using a replica use the following code:
 
 ```php
 Book::search('foo bar', ['index' => 'contacts_desc']);

src/AlgoliaEloquentTrait.php

@@ -156,15 +156,25 @@ public function _setSettings($setToTmpIndices = false)
             $indices = $modelHelper->getIndicesTmp($this);
         }
 
-        $slaves_settings = $modelHelper->getSlavesSettings($this);
-        $slaves = isset($settings['slaves']) ? $settings['slaves'] : [];
+        $replicas_settings = $modelHelper->getReplicasSettings($this);
+        $replicas = isset($settings['replicas']) ? $settings['replicas'] : [];
+
+        // Backward compatibility
+        if ($replicas === [] && isset($settings['slaves'])) {
+            $replicas = $settings['slaves'];
+        }
 
         $b = true;
 
         /** @var \AlgoliaSearch\Index $index */
         foreach ($indices as $index) {
 
-            if ($b && isset($settings['slaves'])) {
+            if ($b && isset($settings['replicas'])) {
+                $settings['replicas'] = array_map(function ($indexName) use ($modelHelper) {
+                    return $modelHelper->getFinalIndexName($this, $indexName);
+                }, $settings['replicas']);
+            } elseif ($b && isset($settings['slaves'])) {
+                // Backward compatibility
                 $settings['slaves'] = array_map(function ($indexName) use ($modelHelper) {
                     return $modelHelper->getFinalIndexName($this, $indexName);
                 }, $settings['slaves']);
@@ -187,17 +197,21 @@ public function _setSettings($setToTmpIndices = false)
                 $index->setSettings($settingsWithoutSynonyms);
             }
 
-            if ($b && isset($settings['slaves'])) {
+            if ($b && isset($settings['replicas'])) {
+                $b = false;
+                unset($settings['replicas']);
+            } else if ($b && isset($settings['slaves'])) {
+                // Backward compatibility
                 $b = false;
                 unset($settings['slaves']);
             }
         }
 
-        foreach ($slaves as $slave) {
-            if (isset($slaves_settings[$slave])) {
-                $index = $modelHelper->getIndices($this, $slave)[0];
+        foreach ($replicas as $replica) {
+            if (isset($replicas_settings[$replica])) {
+                $index = $modelHelper->getIndices($this, $replica)[0];
 
-                $s = array_merge($settings, $slaves_settings[$slave]);
+                $s = array_merge($settings, $replicas_settings[$replica]);
                 unset($s['synonyms']);
 
                 if (count(array_keys($s)) > 0)

src/ModelHelper.php

@@ -80,9 +80,23 @@ public function getSettings(Model $model)
         return property_exists($model, 'algoliaSettings') ? $model->algoliaSettings : [];
     }
 
+    public function getReplicasSettings(Model $model)
+    {
+        $replicas_settings = property_exists($model, 'replicasSettings') ? $model->replicasSettings : [];
+
+        // Backward compatibility
+        if ($replicas_settings === [] && property_exists($model, 'slavesSettings')) {
+            $replicas_settings = $model->slavesSettings;
+        }
+
+        return $replicas_settings;
+    }
+
     public function getSlavesSettings(Model $model)
     {
-        return property_exists($model, 'slavesSettings') ? $model->slavesSettings : [];
+        trigger_error("getSlavesSettings was renamed to getReplicasSettings", E_USER_DEPRECATED);
+
+        return $this->getReplicasSettings($model);
     }
 
     public function getFinalIndexName(Model $model, $indexName)

tests/AlgoliaEloquentTraitTest.php

@@ -3,6 +3,7 @@
 namespace AlgoliaSearch\Tests;
 
 use AlgoliaSearch\Tests\Models\Model11;
+use AlgoliaSearch\Tests\Models\Model12;
 use AlgoliaSearch\Tests\Models\Model2;
 use AlgoliaSearch\Tests\Models\Model4;
 use AlgoliaSearch\Tests\Models\Model6;
@@ -68,7 +69,7 @@ public function testRemoveFromIndex()
     public function testSetSettings()
     {
         $index = Mockery::mock('\AlgoliaSearch\Index');
-        $index->shouldReceive('setSettings')->with(['slaves' => ['model_6_desc_testing']]);
+        $index->shouldReceive('setSettings')->with(['replicas' => ['model_6_desc_testing']]);
         $index->shouldReceive('setSettings')->with(['ranking' => ['desc(name)']]);
         $index->shouldReceive('clearSynonyms');
 
@@ -82,11 +83,21 @@ public function testSetSettings()
         $modelHelper->shouldReceive('getSettings')->andReturn($realModelHelper->getSettings($model6));
         $modelHelper->shouldReceive('getIndices')->andReturn([$index]);
         $modelHelper->shouldReceive('getFinalIndexName')->andReturn($realModelHelper->getFinalIndexName($model6, 'model_6_desc'));
-        $modelHelper->shouldReceive('getSlavesSettings')->andReturn($realModelHelper->getSlavesSettings($model6));
+        $modelHelper->shouldReceive('getReplicasSettings')->andReturn($realModelHelper->getReplicasSettings($model6));
 
-        $this->assertEquals($modelHelper->getFinalIndexName($model6, $realModelHelper->getSettings($model6)['slaves'][0]), 'model_6_desc_testing');
+        $this->assertEquals($modelHelper->getFinalIndexName($model6, $realModelHelper->getSettings($model6)['replicas'][0]), 'model_6_desc_testing');
 
         $model6->setSettings();
+
+        $model12 = new Model12();
+        $modelHelper->shouldReceive('getSettings')->andReturn($realModelHelper->getSettings($model12));
+        $modelHelper->shouldReceive('getIndices')->andReturn([$index]);
+        $modelHelper->shouldReceive('getFinalIndexName')->andReturn($realModelHelper->getFinalIndexName($model12, 'model_6_desc'));
+        $modelHelper->shouldReceive('getReplicasSettings')->andReturn($realModelHelper->getReplicasSettings($model12));
+
+        $this->assertEquals($modelHelper->getFinalIndexName($model12, $realModelHelper->getSettings($model12)['slaves'][0]), 'model_6_desc_testing');
+
+        $model12->setSettings();
     }
 
     public function testSetSynonyms()
@@ -116,7 +127,7 @@ public function testSetSynonyms()
         $model10 = new Model10();
         $modelHelper->shouldReceive('getSettings')->andReturn($realModelHelper->getSettings($model10));
         $modelHelper->shouldReceive('getIndices')->andReturn([$index]);
-        $modelHelper->shouldReceive('getSlavesSettings')->andReturn($realModelHelper->getSlavesSettings($model10));
+        $modelHelper->shouldReceive('getReplicasSettings')->andReturn($realModelHelper->getReplicasSettings($model10));
 
         $this->assertEquals(null, $model10->setSettings());
     }

tests/Models/Model12.php

@@ -0,0 +1,27 @@
+<?php
+
+namespace AlgoliaSearch\Tests\Models;
+
+use AlgoliaSearch\Laravel\AlgoliaEloquentTrait;
+use Illuminate\Database\Eloquent\Model;
+
+class Model12 extends Model
+{
+    use AlgoliaEloquentTrait;
+
+    public static $perEnvironment = true;
+
+    public $algoliaSettings = [
+        'slaves' => [
+            'model_6_desc',
+        ],
+    ];
+
+    public $slavesSettings = [
+        'model_6_desc' => [
+            'ranking' => [
+                'desc(name)'
+            ]
+        ]
+    ];
+}

tests/Models/Model6.php

@@ -12,12 +12,12 @@ class Model6 extends Model
     public static $perEnvironment = true;
 
     public $algoliaSettings = [
-        'slaves' => [
+        'replicas' => [
             'model_6_desc',
         ],
     ];
 
-    public $slavesSettings = [
+    public $replicasSettings = [
         'model_6_desc' => [
             'ranking' => [
                 'desc(name)'