Merge branch 'release/3.3.0'

trilbymedia · Dec 2, 2020 · 8897097 · 8897097
2 parents 75e382b + f001ae1
commit 8897097
Show file tree

Hide file tree

Showing 37 changed files with 648 additions and 183 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,13 @@
+# v3.3.0
+## 12/02/2020
+
+1. [](#new)
+    * Upgraded to TNTSearch version 2.5
+    * Pass phpstan level 7 tests
+1. [](#bugfix)
+    * Fixed FlexPages events for add+delete
+    * Fixed running scheduled index job [#104](https://github.com/trilbymedia/grav-plugin-tntsearch/pull/104) 
+
 # v3.2.1
 ## 09/04/2020
 

diff --git a/blueprints.yaml b/blueprints.yaml
@@ -1,7 +1,7 @@
 name: TNT Search
-slug: tntsearch
 type: plugin
-version: 3.2.1
+slug: tntsearch
+version: 3.3.0
 testing: false
 description: Powerful indexed-based full text search engine powered by TNTSearch
 icon: binoculars

diff --git a/classes/GravConnector.php b/classes/GravConnector.php
@@ -14,11 +14,19 @@ public function __construct()
 
     }
 
+    /**
+     * @param int $attribute
+     * @return bool
+     */
     public function getAttribute($attribute): bool
     {
         return false;
     }
 
+    /**
+     * @param string $query
+     * @return GravResultObject
+     */
     public function query($query)
     {
         $counter = 0;

diff --git a/classes/GravResultObject.php b/classes/GravResultObject.php
@@ -3,14 +3,25 @@
 
 class GravResultObject
 {
+    /** @var array */
     protected $items;
+    /** @var int */
     protected $counter;
 
+    /**
+     * GravResultObject constructor.
+     * @param array $items
+     */
     public function __construct($items)
     {
         $this->counter = 0;
         $this->items   = $items;
     }
+
+    /**
+     * @param array $options
+     * @return array
+     */
     public function fetch($options)
     {
         return $this->items[$this->counter++];

diff --git a/classes/GravTNTSearch.php b/classes/GravTNTSearch.php
@@ -18,10 +18,15 @@
 
 class GravTNTSearch
 {
+    /** @var TNTSearch */
     public $tnt;
+    /** @var array */
     protected $options;
+    /** @var string[] */
     protected $bool_characters = ['-', '(', ')', 'or'];
+    /** @var string */
     protected $index = 'grav.index';
+    /** @var false|string */
     protected $language;
 
     /**
@@ -78,7 +83,7 @@ public function __construct($options = [])
     }
 
     /**
-     * @param $query
+     * @param string $query
      * @return object|string
      * @throws IndexNotFoundException
      */
@@ -97,6 +102,7 @@ public function search($query)
         $limit = (int)$this->options['limit'];
         $type = $type ?? $this->options['search_type'];
 
+        // TODO: Multiword parameter has been removed from $tnt->search(), please check if this works
         $multiword = null;
         if (isset($this->options['phrases']) && $this->options['phrases']) {
             if (strlen($query) > 2) {
@@ -111,7 +117,7 @@ public function search($query)
 
         switch ($type) {
             case 'basic':
-                $results = $this->tnt->search($query, $limit, $multiword);
+                $results = $this->tnt->search($query, $limit);
                 break;
             case 'boolean':
                 $results = $this->tnt->searchBoolean($query, $limit);
@@ -170,7 +176,7 @@ protected function processResults($res, $query)
         }
 
         if ($this->options['json']) {
-            return json_encode($data, JSON_PRETTY_PRINT);
+            return json_encode($data, JSON_PRETTY_PRINT) ?: '';
         }
 
         return $data;
@@ -193,14 +199,16 @@ public static function getCleanContent($page)
         $twig = $grav['twig'];
         $header = $page->header();
 
+        // @phpstan-ignore-next-line
         if (isset($header->tntsearch['template'])) {
             $processed_page = $twig->processTemplate($header->tntsearch['template'] . '.html.twig', ['page' => $page]);
             $content = $processed_page;
         } else {
             $content = $page->content();
         }
 
-        $content = preg_replace('/[ \t]+/', ' ', preg_replace('/\s*$^\s*/m', "\n", strip_tags($content)));
+        $content = strip_tags($content);
+        $content = preg_replace('/[ \t]+/', ' ', preg_replace('/\s*$^\s*/m', "\n", $content));
 
         // Restore active page in Grav.
         unset($grav['page']);
@@ -209,6 +217,9 @@ public static function getCleanContent($page)
         return $content;
     }
 
+    /**
+     * @return void
+     */
     public function createIndex()
     {
         $this->tnt->setDatabaseHandle(new GravConnector);
@@ -222,13 +233,18 @@ public function createIndex()
         $indexer->run();
     }
 
+    /**
+     * @return void
+     * @throws IndexNotFoundException
+     */
     public function selectIndex()
     {
         $this->tnt->selectIndex($this->index);
     }
 
     /**
      * @param object $object
+     * @return void
      */
     public function deleteIndex($object)
     {
@@ -251,6 +267,7 @@ public function deleteIndex($object)
 
     /**
      * @param object $object
+     * @return void
      */
     public function updateIndex($object)
     {
@@ -282,7 +299,8 @@ public function updateIndex($object)
             /** @var Collection $collection */
             $collection = $apage->collection($filter, false);
 
-            if (array_key_exists($object->path(), $collection->toArray())) {
+            $path = $object->path();
+            if ($path && array_key_exists($path, $collection->toArray())) {
                 $fields = $this->indexPageData($object);
                 $document = (array) $fields;
 

diff --git a/cli/TNTSearchIndexerCommand.php b/cli/TNTSearchIndexerCommand.php
@@ -31,7 +31,7 @@ class TNTSearchIndexerCommand extends ConsoleCommand
     ];
 
     /**
-     *
+     * @return void
      */
     protected function configure()
     {
@@ -54,7 +54,7 @@ protected function configure()
     }
 
     /**
-     * @return int|null|void
+     * @return void
      */
     protected function serve()
     {

diff --git a/cli/TNTSearchQueryCommand.php b/cli/TNTSearchQueryCommand.php
@@ -32,10 +32,8 @@ class TNTSearchQueryCommand extends ConsoleCommand
         'EMERGENCY' => 'magenta'
     ];
 
-    protected $tnt;
-
     /**
-     *
+     * @return void
      */
     protected function configure()
     {
@@ -58,7 +56,7 @@ protected function configure()
     }
 
     /**
-     * @return int|null|void
+     * @return void
      */
     protected function serve()
     {
@@ -69,6 +67,9 @@ protected function serve()
         $this->output->writeln('');
     }
 
+    /**
+     * @return void
+     */
     private function doQuery()
     {
         $gtnt = TNTSearchPlugin::getSearchObjectType(['json' => true]);

diff --git a/composer.json b/composer.json
@@ -1,5 +1,5 @@
 {
-  "name": "grav-plugin-tntsearch",
+  "name": "trilbymedia/grav-plugin-tntsearch",
   "type": "grav-plugin",
   "description": "TNTSearch plugin for Grav CMS",
   "keywords": ["tntsearch","search"],

diff --git a/composer.lock b/composer.lock