From 13bef6eb0d7d02d5558520171c5d32ee79b2c282 Mon Sep 17 00:00:00 2001
From: elliot sawyer <elliot@silverstripe.com>
Date: Fri, 21 Apr 2017 13:26:24 +1200
Subject: [PATCH] break out search components with multiple classes into
 individual files and change namespaces

---
 code/search/{ => indexes}/SearchIndex.php     |  2 +-
 .../search/{ => indexes}/SearchIndex_Null.php |  4 +-
 .../{ => indexes}/SearchIndex_Recording.php   |  4 +-
 code/search/{ => queries}/SearchQuery.php     | 31 +------
 code/search/queries/SearchQuery_Range.php     | 34 ++++++++
 code/search/{ => updaters}/SearchUpdater.php  | 80 +------------------
 ...hUpdater_BindManipulationCaptureFilter.php | 23 ++++++
 .../updaters/SearchUpdater_ObjectHandler.php  | 66 +++++++++++++++
 code/search/{ => variants}/SearchVariant.php  | 30 +------
 .../SearchVariantSiteTreeSubsitesPolyhome.php |  2 +-
 .../{ => variants}/SearchVariantSubsites.php  |  2 +-
 .../{ => variants}/SearchVariantVersioned.php |  3 +-
 code/search/variants/SearchVariant_Caller.php | 38 +++++++++
 code/solr/SolrIndex.php                       |  2 +-
 14 files changed, 174 insertions(+), 147 deletions(-)
 rename code/search/{ => indexes}/SearchIndex.php (99%)
 rename code/search/{ => indexes}/SearchIndex_Null.php (70%)
 rename code/search/{ => indexes}/SearchIndex_Recording.php (93%)
 rename code/search/{ => queries}/SearchQuery.php (85%)
 create mode 100644 code/search/queries/SearchQuery_Range.php
 rename code/search/{ => updaters}/SearchUpdater.php (77%)
 create mode 100644 code/search/updaters/SearchUpdater_BindManipulationCaptureFilter.php
 create mode 100644 code/search/updaters/SearchUpdater_ObjectHandler.php
 rename code/search/{ => variants}/SearchVariant.php (91%)
 rename code/search/{ => variants}/SearchVariantSiteTreeSubsitesPolyhome.php (98%)
 rename code/search/{ => variants}/SearchVariantSubsites.php (98%)
 rename code/search/{ => variants}/SearchVariantVersioned.php (97%)
 create mode 100644 code/search/variants/SearchVariant_Caller.php

diff --git a/code/search/SearchIndex.php b/code/search/indexes/SearchIndex.php
similarity index 99%
rename from code/search/SearchIndex.php
rename to code/search/indexes/SearchIndex.php
index f4dc86a..04d3136 100644
--- a/code/search/SearchIndex.php
+++ b/code/search/indexes/SearchIndex.php
@@ -1,6 +1,6 @@
 <?php
 
-namespace SilverStripe\FullTextSearch\Search;
+namespace SilverStripe\FullTextSearch\Search\Indexes;
 
 use SilverStripe\View\ViewableData;
 use SilverStripe\ORM\DataObject;
diff --git a/code/search/SearchIndex_Null.php b/code/search/indexes/SearchIndex_Null.php
similarity index 70%
rename from code/search/SearchIndex_Null.php
rename to code/search/indexes/SearchIndex_Null.php
index 961bcb2..b2a2896 100644
--- a/code/search/SearchIndex_Null.php
+++ b/code/search/indexes/SearchIndex_Null.php
@@ -1,8 +1,8 @@
 <?php
 
-namespace SilverStripe\FullTextSearch\Search;
+namespace SilverStripe\FullTextSearch\Search\Indexes;
 
-use SilverStripe\FullTextSearch\Search\SearchIndex;
+use SilverStripe\FullTextSearch\Search\Indexes\SearchIndex;
 
 /**
  * A search index that does nothing. Useful for testing
diff --git a/code/search/SearchIndex_Recording.php b/code/search/indexes/SearchIndex_Recording.php
similarity index 93%
rename from code/search/SearchIndex_Recording.php
rename to code/search/indexes/SearchIndex_Recording.php
index c8e8f89..d9dc869 100644
--- a/code/search/SearchIndex_Recording.php
+++ b/code/search/indexes/SearchIndex_Recording.php
@@ -1,8 +1,8 @@
 <?php
 
-namespace SilverStripe\FullTextSearch\Search;
+namespace SilverStripe\FullTextSearch\Search\Indexes;
 
-use SilverStripe\FullTextSearch\Search\SearchIndex;
+use SilverStripe\FullTextSearch\Search\Indexes\SearchIndex;
 
 /**
  * A search index that just records actions. Useful for testing
diff --git a/code/search/SearchQuery.php b/code/search/queries/SearchQuery.php
similarity index 85%
rename from code/search/SearchQuery.php
rename to code/search/queries/SearchQuery.php
index 37a28d3..d40fea4 100644
--- a/code/search/SearchQuery.php
+++ b/code/search/queries/SearchQuery.php
@@ -1,5 +1,5 @@
 <?php
-namespace SilverStripe\FullTextSearch\Search;
+namespace SilverStripe\FullTextSearch\Search\Indexes;
 /**
  * Represents a search query
  *
@@ -121,33 +121,4 @@ class SearchQuery extends ViewableData
     }
 }
 
-/**
- * Create one of these and pass as one of the values in filter or exclude to filter or exclude by a (possibly
- * open ended) range
- */
-class SearchQuery_Range
-{
-    public $start = null;
-    public $end = null;
 
-    public function __construct($start = null, $end = null)
-    {
-        $this->start = $start;
-        $this->end = $end;
-    }
-
-    public function start($start)
-    {
-        $this->start = $start;
-    }
-
-    public function end($end)
-    {
-        $this->end = $end;
-    }
-
-    public function isfiltered()
-    {
-        return $this->start !== null || $this->end !== null;
-    }
-}
diff --git a/code/search/queries/SearchQuery_Range.php b/code/search/queries/SearchQuery_Range.php
new file mode 100644
index 0000000..33b35e5
--- /dev/null
+++ b/code/search/queries/SearchQuery_Range.php
@@ -0,0 +1,34 @@
+<?php
+
+namespace SilverStripe\FullTextSearch\Search\Queries;
+
+/**
+ * Create one of these and pass as one of the values in filter or exclude to filter or exclude by a (possibly
+ * open ended) range
+ */
+class SearchQuery_Range
+{
+    public $start = null;
+    public $end = null;
+
+    public function __construct($start = null, $end = null)
+    {
+        $this->start = $start;
+        $this->end = $end;
+    }
+
+    public function start($start)
+    {
+        $this->start = $start;
+    }
+
+    public function end($end)
+    {
+        $this->end = $end;
+    }
+
+    public function isfiltered()
+    {
+        return $this->start !== null || $this->end !== null;
+    }
+}
\ No newline at end of file
diff --git a/code/search/SearchUpdater.php b/code/search/updaters/SearchUpdater.php
similarity index 77%
rename from code/search/SearchUpdater.php
rename to code/search/updaters/SearchUpdater.php
index b1fa58d..90a1500 100644
--- a/code/search/SearchUpdater.php
+++ b/code/search/updaters/SearchUpdater.php
@@ -1,5 +1,5 @@
 <?php
-namespace SilverStripe\FullTextSearch\Search;
+namespace SilverStripe\FullTextSearch\Search\Updaters;
 /**
  * This class is responsible for capturing changes to DataObjects and triggering index updates of the resulting dirty index
  * items.
@@ -13,11 +13,6 @@ namespace SilverStripe\FullTextSearch\Search;
  * TODO: The way we bind in is awful hacky.
  */
 use SilverStripe\Core\Object;
-use SilverStripe\Control\RequestFilter;
-use SilverStripe\Control\HTTPRequest;
-use SilverStripe\Control\Session;
-use SilverStripe\ORM\DataModel;
-use SilverStripe\Control\HTTPResponse;
 use SilverStripe\ORM\DataExtension;
 
 class SearchUpdater extends Object
@@ -212,78 +207,5 @@ class SearchUpdater extends Object
     }
 }
 
-class SearchUpdater_BindManipulationCaptureFilter implements RequestFilter
-{
 
-    public function preRequest(HTTPRequest $request, Session $session, DataModel $model)
-    {
-        SearchUpdater::bind_manipulation_capture();
-    }
 
-    public function postRequest(HTTPRequest $request, HTTPResponse $response, DataModel $model)
-    {
-        /* NOP */
-    }
-}
-
-/**
- * Delete operations do not use database manipulations.
- *
- * If a delete has been requested, force a write on objects that should be
- * indexed.  This causes the object to be marked for deletion from the index.
- */
-
-class SearchUpdater_ObjectHandler extends DataExtension
-{
-    public function onAfterDelete()
-    {
-        // Calling delete() on empty objects does nothing
-        if (!$this->owner->ID) {
-            return;
-        }
-
-        // Force SearchUpdater to mark this record as dirty
-        $manipulation = array(
-            $this->owner->ClassName => array(
-                'fields' => array(),
-                'id' => $this->owner->ID,
-                'command' => 'update'
-            )
-        );
-        $this->owner->extend('augmentWrite', $manipulation);
-        SearchUpdater::handle_manipulation($manipulation);
-    }
-
-    /**
-     * Forces this object to trigger a re-index in the current state
-     */
-    public function triggerReindex()
-    {
-        if (!$this->owner->ID) {
-            return;
-        }
-
-        $id = $this->owner->ID;
-        $class = $this->owner->ClassName;
-        $state = SearchVariant::current_state($class);
-        $base = ClassInfo::baseDataClass($class);
-        $key = "$id:$base:".serialize($state);
-
-        $statefulids = array(array(
-            'id' => $id,
-            'state' => $state
-        ));
-
-        $writes = array(
-            $key => array(
-                'base' => $base,
-                'class' => $class,
-                'id' => $id,
-                'statefulids' => $statefulids,
-                'fields' => array()
-            )
-        );
-
-        SearchUpdater::process_writes($writes);
-    }
-}
diff --git a/code/search/updaters/SearchUpdater_BindManipulationCaptureFilter.php b/code/search/updaters/SearchUpdater_BindManipulationCaptureFilter.php
new file mode 100644
index 0000000..e6b4e05
--- /dev/null
+++ b/code/search/updaters/SearchUpdater_BindManipulationCaptureFilter.php
@@ -0,0 +1,23 @@
+<?php
+
+namespace SilverStripe\FullTextSearch\Search\Updaters;
+
+use SilverStripe\Control\RequestFilter;
+use SilverStripe\Control\HTTPRequest;
+use SilverStripe\Control\Session;
+use SilverStripe\ORM\DataModel;
+use SilverStripe\Control\HTTPResponse;
+
+class SearchUpdater_BindManipulationCaptureFilter implements RequestFilter
+{
+
+    public function preRequest(HTTPRequest $request, Session $session, DataModel $model)
+    {
+        SearchUpdater::bind_manipulation_capture();
+    }
+
+    public function postRequest(HTTPRequest $request, HTTPResponse $response, DataModel $model)
+    {
+        /* NOP */
+    }
+}
\ No newline at end of file
diff --git a/code/search/updaters/SearchUpdater_ObjectHandler.php b/code/search/updaters/SearchUpdater_ObjectHandler.php
new file mode 100644
index 0000000..da248ba
--- /dev/null
+++ b/code/search/updaters/SearchUpdater_ObjectHandler.php
@@ -0,0 +1,66 @@
+<?php
+
+namespace SilverStripe\FullTextSearch\Search\Updaters;
+use SilverStripe\ORM\DataExtension;
+
+/**
+ * Delete operations do not use database manipulations.
+ *
+ * If a delete has been requested, force a write on objects that should be
+ * indexed.  This causes the object to be marked for deletion from the index.
+ */
+
+class SearchUpdater_ObjectHandler extends DataExtension
+{
+    public function onAfterDelete()
+    {
+        // Calling delete() on empty objects does nothing
+        if (!$this->owner->ID) {
+            return;
+        }
+
+        // Force SearchUpdater to mark this record as dirty
+        $manipulation = array(
+            $this->owner->ClassName => array(
+                'fields' => array(),
+                'id' => $this->owner->ID,
+                'command' => 'update'
+            )
+        );
+        $this->owner->extend('augmentWrite', $manipulation);
+        SearchUpdater::handle_manipulation($manipulation);
+    }
+
+    /**
+     * Forces this object to trigger a re-index in the current state
+     */
+    public function triggerReindex()
+    {
+        if (!$this->owner->ID) {
+            return;
+        }
+
+        $id = $this->owner->ID;
+        $class = $this->owner->ClassName;
+        $state = SearchVariant::current_state($class);
+        $base = ClassInfo::baseDataClass($class);
+        $key = "$id:$base:".serialize($state);
+
+        $statefulids = array(array(
+            'id' => $id,
+            'state' => $state
+        ));
+
+        $writes = array(
+            $key => array(
+                'base' => $base,
+                'class' => $class,
+                'id' => $id,
+                'statefulids' => $statefulids,
+                'fields' => array()
+            )
+        );
+
+        SearchUpdater::process_writes($writes);
+    }
+}
\ No newline at end of file
diff --git a/code/search/SearchVariant.php b/code/search/variants/SearchVariant.php
similarity index 91%
rename from code/search/SearchVariant.php
rename to code/search/variants/SearchVariant.php
index f8a68ad..57f6479 100644
--- a/code/search/SearchVariant.php
+++ b/code/search/variants/SearchVariant.php
@@ -1,5 +1,5 @@
 <?php
-namespace SilverStripe\FullTextSearch\Search;
+namespace SilverStripe\FullTextSearch\Search\Variants;
 use SilverStripe\Core\ClassInfo;
 /**
  * A Search Variant handles decorators and other situations where the items to reindex or search through are modified
@@ -253,31 +253,3 @@ abstract class SearchVariant
     }
 }
 
-/**
- * Internal utility class used to hold the state of the SearchVariant::with call
- */
-class SearchVariant_Caller
-{
-    protected $variants = null;
-
-    public function __construct($variants)
-    {
-        $this->variants = $variants;
-    }
-
-    public function call($method, &$a1=null, &$a2=null, &$a3=null, &$a4=null, &$a5=null, &$a6=null, &$a7=null)
-    {
-        $values = array();
-
-        foreach ($this->variants as $variant) {
-            if (method_exists($variant, $method)) {
-                $value = $variant->$method($a1, $a2, $a3, $a4, $a5, $a6, $a7);
-                if ($value !== null) {
-                    $values[] = $value;
-                }
-            }
-        }
-
-        return $values;
-    }
-}
diff --git a/code/search/SearchVariantSiteTreeSubsitesPolyhome.php b/code/search/variants/SearchVariantSiteTreeSubsitesPolyhome.php
similarity index 98%
rename from code/search/SearchVariantSiteTreeSubsitesPolyhome.php
rename to code/search/variants/SearchVariantSiteTreeSubsitesPolyhome.php
index 100788a..5101dd1 100644
--- a/code/search/SearchVariantSiteTreeSubsitesPolyhome.php
+++ b/code/search/variants/SearchVariantSiteTreeSubsitesPolyhome.php
@@ -1,5 +1,5 @@
 <?php
-namespace SilverStripe\FullTextSearch\Search;
+namespace SilverStripe\FullTextSearch\Search\Variants;
 
 class SearchVariantSiteTreeSubsitesPolyhome extends SearchVariant
 {
diff --git a/code/search/SearchVariantSubsites.php b/code/search/variants/SearchVariantSubsites.php
similarity index 98%
rename from code/search/SearchVariantSubsites.php
rename to code/search/variants/SearchVariantSubsites.php
index 3a00d23..1f62f71 100644
--- a/code/search/SearchVariantSubsites.php
+++ b/code/search/variants/SearchVariantSubsites.php
@@ -1,5 +1,5 @@
 <?php
-namespace SilverStripe\FullTextSearch\Search;
+namespace SilverStripe\FullTextSearch\Search\Variants;
 class SearchVariantSubsites extends SearchVariant
 {
     public function appliesToEnvironment()
diff --git a/code/search/SearchVariantVersioned.php b/code/search/variants/SearchVariantVersioned.php
similarity index 97%
rename from code/search/SearchVariantVersioned.php
rename to code/search/variants/SearchVariantVersioned.php
index cdeaebe..767bdec 100644
--- a/code/search/SearchVariantVersioned.php
+++ b/code/search/variants/SearchVariantVersioned.php
@@ -1,5 +1,6 @@
 <?php
-namespace SilverStripe\FullTextSearch\Search;
+namespace SilverStripe\FullTextSearch\Search\Variants;
+
 class SearchVariantVersioned extends SearchVariant
 {
     public function appliesToEnvironment()
diff --git a/code/search/variants/SearchVariant_Caller.php b/code/search/variants/SearchVariant_Caller.php
new file mode 100644
index 0000000..c95c648
--- /dev/null
+++ b/code/search/variants/SearchVariant_Caller.php
@@ -0,0 +1,38 @@
+<?php
+/**
+ * Created by PhpStorm.
+ * User: elliot
+ * Date: 21/04/17
+ * Time: 1:13 PM
+ */
+
+namespace SilverStripe\FullTextSearch\Search\Variants;
+
+/**
+ * Internal utility class used to hold the state of the SearchVariant::with call
+ */
+class SearchVariant_Caller
+{
+    protected $variants = null;
+
+    public function __construct($variants)
+    {
+        $this->variants = $variants;
+    }
+
+    public function call($method, &$a1=null, &$a2=null, &$a3=null, &$a4=null, &$a5=null, &$a6=null, &$a7=null)
+    {
+        $values = array();
+
+        foreach ($this->variants as $variant) {
+            if (method_exists($variant, $method)) {
+                $value = $variant->$method($a1, $a2, $a3, $a4, $a5, $a6, $a7);
+                if ($value !== null) {
+                    $values[] = $value;
+                }
+            }
+        }
+
+        return $values;
+    }
+}
\ No newline at end of file
diff --git a/code/solr/SolrIndex.php b/code/solr/SolrIndex.php
index 2a7f655..76842a2 100644
--- a/code/solr/SolrIndex.php
+++ b/code/solr/SolrIndex.php
@@ -3,7 +3,7 @@ namespace SilverStripe\FullTextSearch\Solr;
 Solr::include_client_api();
 
 use SilverStripe\Control\Director;
-use SilverStripe\FulltextSearch\Search\SearchIndex;
+use SilverStripe\FulltextSearch\Search\Indexes\SearchIndex;
 
 abstract class SolrIndex extends SearchIndex
 {