Add tag support (#48)

* Remove unused geolocation field

* Add support for tags

* Update docs

* Fix CS

Author: ethanhann

docs-src/indexing.md

@@ -10,6 +10,7 @@ They are instantiated like this:
 new TextField('author', 'Charles Dickens');
 new NumericField('price', 9.99);
 new GeoField('place', new GeoLocation(-77.0366, 38.8977));
+new TagField('color', 'red');
 ```
 
 Fields can also be made with the FieldFactory class:
@@ -23,6 +24,9 @@ FieldFactory::make('price', 9.99);
 
 // Alternative syntax for: new GeoField('place', new GeoLocation(-77.0366, 38.8977));
 FieldFactory::make('place', new GeoLocation(-77.0366, 38.8977));
+
+// Alternative syntax for: new TagField('color', 'red');
+FieldFactory::make('color', 'red');
 ```
 
 ## Adding Documents
@@ -35,6 +39,7 @@ $bookIndex->add([
     new TextField('author', 'Charles Dickens'),
     new NumericField('price', 9.99),
     new GeoField('place', new GeoLocation(-77.0366, 38.8977)),
+    new TagField('color', 'red'),
 ]);
 ```
 
@@ -46,6 +51,7 @@ $bookIndex->add([
     'author' => 'Charles Dickens',
     'price' => 9.99,
     'place' => new GeoLocation(-77.0366, 38.8977),
+    'color' => new TagField('color', 'red'),,
 ]);
 ```
 

docs-src/searching.md

@@ -19,19 +19,40 @@ $result = $bookIndex->search('two cities', true);
 $result->documents(); // Array of arrays.
 ```
 
+## Filtering Tag Fields
+
+Tag fields can be filtered with the index's tagFilter method. 
+
+Specifying multiple tags creates a union of documents.
+
+```php-inline
+$result = $bookIndex
+    ->tagFilter('color', ['blue', 'red'])
+    ->search('two cities');
+```
+
+Use multiple separate tagFilter calls to create an intersection of documents.
+
+```php-inline
+$result = $bookIndex
+    ->tagFilter('color', ['blue'])
+    ->tagFilter('color', ['red'])
+    ->search('two cities');
+```
+
 ## Filtering Numeric Fields
 
-Numeric fields can be filtered with the index's filter method.
+Numeric fields can be filtered with the index's numericFilter method.
 
 ```php-inline
 $result = $bookIndex
-    ->filter('price', 4.99, 19.99)
+    ->numericFilter('price', 4.99, 19.99)
     ->search('two cities');
 ```
 
 ## Filtering Geo Fields
 
-Numeric fields can be filtered with the index's filter method.
+Numeric fields can be filtered with the index's geoFilter method.
 
 ```php-inline
 $result = $bookIndex

docs/indexing/index.html

@@ -500,6 +500,7 @@ <h2 id="field-types">Field Types<a class="headerlink" href="#field-types" title=
 <div class="codehilite"><pre><span></span><span class="k">new</span> <span class="nx">TextField</span><span class="p">(</span><span class="s1">&#39;author&#39;</span><span class="p">,</span> <span class="s1">&#39;Charles Dickens&#39;</span><span class="p">);</span>
 <span class="k">new</span> <span class="nx">NumericField</span><span class="p">(</span><span class="s1">&#39;price&#39;</span><span class="p">,</span> <span class="mf">9.99</span><span class="p">);</span>
 <span class="k">new</span> <span class="nx">GeoField</span><span class="p">(</span><span class="s1">&#39;place&#39;</span><span class="p">,</span> <span class="k">new</span> <span class="nx">GeoLocation</span><span class="p">(</span><span class="o">-</span><span class="mf">77.0366</span><span class="p">,</span> <span class="mf">38.8977</span><span class="p">));</span>
+<span class="k">new</span> <span class="nx">TagField</span><span class="p">(</span><span class="s1">&#39;color&#39;</span><span class="p">,</span> <span class="s1">&#39;red&#39;</span><span class="p">);</span>
 </pre></div>
 
 <p>Fields can also be made with the FieldFactory class:</p>
@@ -511,6 +512,9 @@ <h2 id="field-types">Field Types<a class="headerlink" href="#field-types" title=
 
 <span class="c1">// Alternative syntax for: new GeoField(&#39;place&#39;, new GeoLocation(-77.0366, 38.8977));</span>
 <span class="nx">FieldFactory</span><span class="o">::</span><span class="na">make</span><span class="p">(</span><span class="s1">&#39;place&#39;</span><span class="p">,</span> <span class="k">new</span> <span class="nx">GeoLocation</span><span class="p">(</span><span class="o">-</span><span class="mf">77.0366</span><span class="p">,</span> <span class="mf">38.8977</span><span class="p">));</span>
+
+<span class="c1">// Alternative syntax for: new TagField(&#39;color&#39;, &#39;red&#39;);</span>
+<span class="nx">FieldFactory</span><span class="o">::</span><span class="na">make</span><span class="p">(</span><span class="s1">&#39;color&#39;</span><span class="p">,</span> <span class="s1">&#39;red&#39;</span><span class="p">);</span>
 </pre></div>
 
 <h2 id="adding-documents">Adding Documents<a class="headerlink" href="#adding-documents" title="Permanent link">&para;</a></h2>
@@ -520,6 +524,7 @@ <h2 id="adding-documents">Adding Documents<a class="headerlink" href="#adding-do
     <span class="k">new</span> <span class="nx">TextField</span><span class="p">(</span><span class="s1">&#39;author&#39;</span><span class="p">,</span> <span class="s1">&#39;Charles Dickens&#39;</span><span class="p">),</span>
     <span class="k">new</span> <span class="nx">NumericField</span><span class="p">(</span><span class="s1">&#39;price&#39;</span><span class="p">,</span> <span class="mf">9.99</span><span class="p">),</span>
     <span class="k">new</span> <span class="nx">GeoField</span><span class="p">(</span><span class="s1">&#39;place&#39;</span><span class="p">,</span> <span class="k">new</span> <span class="nx">GeoLocation</span><span class="p">(</span><span class="o">-</span><span class="mf">77.0366</span><span class="p">,</span> <span class="mf">38.8977</span><span class="p">)),</span>
+    <span class="k">new</span> <span class="nx">TagField</span><span class="p">(</span><span class="s1">&#39;color&#39;</span><span class="p">,</span> <span class="s1">&#39;red&#39;</span><span class="p">),</span>
 <span class="p">]);</span>
 </pre></div>
 
@@ -529,6 +534,7 @@ <h2 id="adding-documents">Adding Documents<a class="headerlink" href="#adding-do
     <span class="s1">&#39;author&#39;</span> <span class="o">=&gt;</span> <span class="s1">&#39;Charles Dickens&#39;</span><span class="p">,</span>
     <span class="s1">&#39;price&#39;</span> <span class="o">=&gt;</span> <span class="mf">9.99</span><span class="p">,</span>
     <span class="s1">&#39;place&#39;</span> <span class="o">=&gt;</span> <span class="k">new</span> <span class="nx">GeoLocation</span><span class="p">(</span><span class="o">-</span><span class="mf">77.0366</span><span class="p">,</span> <span class="mf">38.8977</span><span class="p">),</span>
+    <span class="s1">&#39;color&#39;</span> <span class="o">=&gt;</span> <span class="k">new</span> <span class="nx">TagField</span><span class="p">(</span><span class="s1">&#39;color&#39;</span><span class="p">,</span> <span class="s1">&#39;red&#39;</span><span class="p">),,</span>
 <span class="p">]);</span>
 </pre></div>
 

docs/search/search_index.json

@@ -325,6 +325,13 @@
     Simple Text Search
   </a>
 
+</li>
+      
+        <li class="md-nav__item">
+  <a href="#filtering-tag-fields" title="Filtering Tag Fields" class="md-nav__link">
+    Filtering Tag Fields
+  </a>
+  
 </li>
 
         <li class="md-nav__item">
@@ -458,6 +465,13 @@
     Simple Text Search
   </a>
 
+</li>
+      
+        <li class="md-nav__item">
+  <a href="#filtering-tag-fields" title="Filtering Tag Fields" class="md-nav__link">
+    Filtering Tag Fields
+  </a>
+  
 </li>
 
         <li class="md-nav__item">
@@ -536,15 +550,30 @@ <h2 id="simple-text-search">Simple Text Search<a class="headerlink" href="#simpl
 <span class="nv">$result</span><span class="o">-&gt;</span><span class="na">documents</span><span class="p">();</span> <span class="c1">// Array of arrays.</span>
 </pre></div>
 
+<h2 id="filtering-tag-fields">Filtering Tag Fields<a class="headerlink" href="#filtering-tag-fields" title="Permanent link">&para;</a></h2>
+<p>Tag fields can be filtered with the index's tagFilter method. </p>
+<p>Specifying multiple tags creates a union of documents.</p>
+<div class="codehilite"><pre><span></span><span class="nv">$result</span> <span class="o">=</span> <span class="nv">$bookIndex</span>
+    <span class="o">-&gt;</span><span class="na">tagFilter</span><span class="p">(</span><span class="s1">&#39;color&#39;</span><span class="p">,</span> <span class="p">[</span><span class="s1">&#39;blue&#39;</span><span class="p">,</span> <span class="s1">&#39;red&#39;</span><span class="p">])</span>
+    <span class="o">-&gt;</span><span class="na">search</span><span class="p">(</span><span class="s1">&#39;two cities&#39;</span><span class="p">);</span>
+</pre></div>
+
+<p>Use multiple separate tagFilter calls to create an intersection of documents.</p>
+<div class="codehilite"><pre><span></span><span class="nv">$result</span> <span class="o">=</span> <span class="nv">$bookIndex</span>
+    <span class="o">-&gt;</span><span class="na">tagFilter</span><span class="p">(</span><span class="s1">&#39;color&#39;</span><span class="p">,</span> <span class="p">[</span><span class="s1">&#39;blue&#39;</span><span class="p">])</span>
+    <span class="o">-&gt;</span><span class="na">tagFilter</span><span class="p">(</span><span class="s1">&#39;color&#39;</span><span class="p">,</span> <span class="p">[</span><span class="s1">&#39;red&#39;</span><span class="p">])</span>
+    <span class="o">-&gt;</span><span class="na">search</span><span class="p">(</span><span class="s1">&#39;two cities&#39;</span><span class="p">);</span>
+</pre></div>
+
 <h2 id="filtering-numeric-fields">Filtering Numeric Fields<a class="headerlink" href="#filtering-numeric-fields" title="Permanent link">&para;</a></h2>
-<p>Numeric fields can be filtered with the index's filter method.</p>
+<p>Numeric fields can be filtered with the index's numericFilter method.</p>
 <div class="codehilite"><pre><span></span><span class="nv">$result</span> <span class="o">=</span> <span class="nv">$bookIndex</span>
-    <span class="o">-&gt;</span><span class="na">filter</span><span class="p">(</span><span class="s1">&#39;price&#39;</span><span class="p">,</span> <span class="mf">4.99</span><span class="p">,</span> <span class="mf">19.99</span><span class="p">)</span>
+    <span class="o">-&gt;</span><span class="na">numericFilter</span><span class="p">(</span><span class="s1">&#39;price&#39;</span><span class="p">,</span> <span class="mf">4.99</span><span class="p">,</span> <span class="mf">19.99</span><span class="p">)</span>
     <span class="o">-&gt;</span><span class="na">search</span><span class="p">(</span><span class="s1">&#39;two cities&#39;</span><span class="p">);</span>
 </pre></div>
 
 <h2 id="filtering-geo-fields">Filtering Geo Fields<a class="headerlink" href="#filtering-geo-fields" title="Permanent link">&para;</a></h2>
-<p>Numeric fields can be filtered with the index's filter method.</p>
+<p>Numeric fields can be filtered with the index's geoFilter method.</p>
 <div class="codehilite"><pre><span></span><span class="nv">$result</span> <span class="o">=</span> <span class="nv">$bookIndex</span>
     <span class="o">-&gt;</span><span class="na">geoFilter</span><span class="p">(</span><span class="s1">&#39;place&#39;</span><span class="p">,</span> <span class="o">-</span><span class="mf">77.0366</span><span class="p">,</span> <span class="mf">38.897</span><span class="p">,</span> <span class="mi">100</span><span class="p">)</span>
     <span class="o">-&gt;</span><span class="na">search</span><span class="p">(</span><span class="s1">&#39;two cities&#39;</span><span class="p">);</span>

docs/searching/index.html

@@ -2,37 +2,37 @@
 <urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
     <url>
      <loc>None</loc>
-     <lastmod>2019-02-18</lastmod>
+     <lastmod>2019-05-25</lastmod>
      <changefreq>daily</changefreq>
     </url>
     <url>
      <loc>None</loc>
-     <lastmod>2019-02-18</lastmod>
+     <lastmod>2019-05-25</lastmod>
      <changefreq>daily</changefreq>
     </url>
     <url>
      <loc>None</loc>
-     <lastmod>2019-02-18</lastmod>
+     <lastmod>2019-05-25</lastmod>
      <changefreq>daily</changefreq>
     </url>
     <url>
      <loc>None</loc>
-     <lastmod>2019-02-18</lastmod>
+     <lastmod>2019-05-25</lastmod>
      <changefreq>daily</changefreq>
     </url>
     <url>
      <loc>None</loc>
-     <lastmod>2019-02-18</lastmod>
+     <lastmod>2019-05-25</lastmod>
      <changefreq>daily</changefreq>
     </url>
     <url>
      <loc>None</loc>
-     <lastmod>2019-02-18</lastmod>
+     <lastmod>2019-05-25</lastmod>
      <changefreq>daily</changefreq>
     </url>
     <url>
      <loc>None</loc>
-     <lastmod>2019-02-18</lastmod>
+     <lastmod>2019-05-25</lastmod>
      <changefreq>daily</changefreq>
     </url>
 </urlset>

docs/sitemap.xml

@@ -5,4 +5,4 @@
 trait Aliasable
 {
     public $alias;
-}
+}

docs/sitemap.xml.gz

@@ -8,6 +8,9 @@ class FieldFactory
 {
     public static function make($name, $value)
     {
+        if ($value instanceof Tag) {
+            return new TagField($name, $value);
+        }
         if (is_string($value)) {
             return new TextField($name, $value);
         }

src/Aggregate/Reducers/Aliasable.php

@@ -4,7 +4,6 @@
 
 class GeoLocation
 {
-    protected $name;
     protected $longitude;
     protected $latitude;