Various changes

More docs for the getter chain inside Result

Author: datashaman

Diff for: README.md

@@ -120,6 +120,16 @@ The returned `response` object is a rich wrapper around the JSON returned from E
 
 Each *hit* is wrapped in the `Result` class.
 
+`Result` has a dynamic getter:
+
+* index, type, id, score and source are pulled from the top-level of the hit.
+  e.g. index is hit[_index], type is hit[_type], etc
+* if not one of the above, it looks for an existing item in the top-level hit.
+  e.g. _version is hit[_version], etc
+* if not one of the above, it looks for an existing item in hit[_source] (the document).
+  e.g. title is hit[_source][title]
+* if nothing resolves from above, it triggers a notice and returns null
+
 The `response` object delegates to an internal `Collection`, so it supports all the usual methods: `map`, `filter`, `each`, etc.
 
 ```php
@@ -202,7 +212,8 @@ You can implement pagination with the `from` and `size` search parameters. Howev
 # Delegates to the results on page 2 with 20 per page
 $response->perPage(20)->page(2);
 
-# Records on page 2 with 20 per page (in the same order as results)
+# Records on page 2 with 20 per page; records ordered the same as results
+# Order of the `page` and `perPage` calls doesn't matter
 $response->page(2)->perPage(20)->records();
 
 # Results on page 2 with (default) 15 results per page

Diff for: ReadmeTest.php

@@ -3,6 +3,7 @@
 namespace Datashaman\Elasticsearch\Model\Tests;
 
 use Datashaman\Elasticsearch\Model\ElasticsearchModel;
+use Datashaman\Elasticsearch\Model\Response\Result;
 use Illuminate\Database\Eloquent\Model as Eloquent;
 use Illuminate\Database\Schema\Blueprint;
 use Schema;
@@ -102,5 +103,48 @@ public function testSearch()
             'Quick brown fox',
             'Fast black dogs',
         ], $ordered);
+
+        /**
+         * Only have 3 results so perPage is going to be 1 for all these examples.
+         */
+        $response = Article::search('*', [
+            'sort' => [
+                'title',
+            ],
+        ]);
+
+        /**
+         * Just so it's clear these are in the expected title order,
+         */
+        $this->assertEquals([
+            'Fast black dogs',
+            'Quick brown fox',
+            'Swift green frogs',
+        ], $response->map(function ($a) { return $a->title; })->all());
+
+        /** Response can be used as an array (of the results) */
+        $page = $response->perPage(1)->page(2);
+
+        $this->assertEquals(1, count($page));
+
+        $this->assertInstanceOf(Result::class, $page[0]);
+
+        /**
+         * Result has a dynamic getter:
+         *
+         * index, type, id, score and source are pulled from the top-level of the hit.
+         * e.g. index is hit[_index], type is hit[_type], etc
+         *
+         * if not one of the above, it looks for an existing item in the top-level hit.
+         * e.g. _version is hit[_version], etc
+         *
+         * if not one of the above, it looks for an existing item in hit[_source] (the document).
+         * e.g. title is hit[_source][title]
+         *
+         * if nothing resolves from above, it triggers a notice and returns null
+         */
+        $article = $page[0];
+
+        $this->assertEquals('Quick brown fox', $article->title);
     }
 }

Diff for: src/Response/Result.php

@@ -13,7 +13,7 @@ public function __construct($hit = [])
 
     public function __get($name)
     {
-        if ($name == 'id' || $name == 'type') {
+        if (in_array($name, ['index', 'type', 'id', 'score', 'source'])) {
             return array_get($this->hit, '_'.$name);
         }
 
@@ -33,5 +33,12 @@ public function __get($name)
             ' in '.$trace[0]['file'].
             ' on line '.$trace[0]['line'],
             E_USER_NOTICE);
+
+        return null;
+    }
+
+    public function toArray()
+    {
+        return $this->hit;
     }
 }

Diff for: tests/Response/ResultTest.php

@@ -51,4 +51,10 @@ public function testGetterEmitsErrorAndReturnsNull()
         $result = new Result([]);
         $this->assertNull($result->foo);
     }
+
+    public function testToArray()
+    {
+        $result = new Result(['foo' => 'bar', '_id' => 1]);
+        $this->assertEquals(['foo' => 'bar', '_id' => 1], $result->toArray());
+    }
 }

Diff for: watch-test.sh

@@ -1,7 +1,9 @@
 #/usr/bin/env bash
 
-inotifywait -m -r -e close_write src/ tests/ | while read LINE
+# inotifywait -m -r -e close_write src/ tests/ | while read LINE
+inotifywait -m -r -e close_write src/ ReadmeTest.php | while read LINE
 do
     echo $LINE
-    phpunit
+    # phpunit
+    phpunit ReadmeTest.php
 done