feat(toHaveStringID): add new matcher

Checks if a GeoJSON Feature has a string ID. Passes if the Feature object has any string ID (no argument provided), or if the ID exactly matches the optional argument (single string or RegExp provided), or any value within an array of any combination of strings or RegExp. The test fails if the object does not have an ID, or if it has an ID that does not match the SearchID. Passing a number type to SearchID will not pass the test, even if the ID exactly matches. Resolves: #37
M-Scott-Lassiter · Jun 8, 2022 · cefddd6 · cefddd6
1 parent 4636be6
commit cefddd6
Show file tree

Hide file tree

Showing 61 changed files with 1,158 additions and 5 deletions.
diff --git a/.cz-config.js b/.cz-config.js
@@ -18,7 +18,8 @@ const allMatchers = [
     { name: 'toBePointGeometry' },
     { name: 'toBePolygonGeometry' },
     { name: 'toBeValidGeoJSON' },
-    { name: 'toHaveID' }
+    { name: 'toHaveID' },
+    { name: 'toHaveStringID' }
 ]
 
 const documentationScopes = [

diff --git a/README.md b/README.md
@@ -157,12 +157,12 @@ _Future_
 
 -   [toBeFeature](https://m-scott-lassiter.github.io/jest-geojson/Matchers.Features.html#.toBeFeature)
 -   [toHaveID](https://m-scott-lassiter.github.io/jest-geojson/Matchers.Features.html#.toHaveID)
+-   [toHaveStringID](https://m-scott-lassiter.github.io/jest-geojson/Matchers.Features.html#.toHaveStringID)
 
 ---
 
 _Future_
 
--   [ ] toHaveStringID
 -   [ ] toHaveNumericID
 -   [ ] toHaveProperties (array of [property, optional values])
 

diff --git a/docs/Core.BoundingBoxes.html b/docs/Core.BoundingBoxes.html
@@ -224,6 +224,9 @@ <h3>Namespaces</h3>
                         <li data-type="method">
                             <a href="Matchers.Features.html#.toHaveID">toHaveID</a>
                         </li>
+                        <li data-type="method">
+                            <a href="Matchers.Features.html#.toHaveStringID">toHaveStringID</a>
+                        </li>
                     </ul>
                 </li>
                 <li>

diff --git a/docs/Core.Coordinates.html b/docs/Core.Coordinates.html
@@ -224,6 +224,9 @@ <h3>Namespaces</h3>
                         <li data-type="method">
                             <a href="Matchers.Features.html#.toHaveID">toHaveID</a>
                         </li>
+                        <li data-type="method">
+                            <a href="Matchers.Features.html#.toHaveStringID">toHaveStringID</a>
+                        </li>
                     </ul>
                 </li>
                 <li>

diff --git a/docs/Core.FeatureCollections.html b/docs/Core.FeatureCollections.html
@@ -224,6 +224,9 @@ <h3>Namespaces</h3>
                         <li data-type="method">
                             <a href="Matchers.Features.html#.toHaveID">toHaveID</a>
                         </li>
+                        <li data-type="method">
+                            <a href="Matchers.Features.html#.toHaveStringID">toHaveStringID</a>
+                        </li>
                     </ul>
                 </li>
                 <li>

diff --git a/docs/Core.Features.html b/docs/Core.Features.html
@@ -224,6 +224,9 @@ <h3>Namespaces</h3>
                         <li data-type="method">
                             <a href="Matchers.Features.html#.toHaveID">toHaveID</a>
                         </li>
+                        <li data-type="method">
+                            <a href="Matchers.Features.html#.toHaveStringID">toHaveStringID</a>
+                        </li>
                     </ul>
                 </li>
                 <li>

diff --git a/docs/Core.Geometries.html b/docs/Core.Geometries.html
@@ -224,6 +224,9 @@ <h3>Namespaces</h3>
                         <li data-type="method">
                             <a href="Matchers.Features.html#.toHaveID">toHaveID</a>
                         </li>
+                        <li data-type="method">
+                            <a href="Matchers.Features.html#.toHaveStringID">toHaveStringID</a>
+                        </li>
                     </ul>
                 </li>
                 <li>

diff --git a/docs/Core.Utilities.html b/docs/Core.Utilities.html
@@ -224,6 +224,9 @@ <h3>Namespaces</h3>
                         <li data-type="method">
                             <a href="Matchers.Features.html#.toHaveID">toHaveID</a>
                         </li>
+                        <li data-type="method">
+                            <a href="Matchers.Features.html#.toHaveStringID">toHaveStringID</a>
+                        </li>
                     </ul>
                 </li>
                 <li>

diff --git a/docs/Core.html b/docs/Core.html
@@ -224,6 +224,9 @@ <h3>Namespaces</h3>
                         <li data-type="method">
                             <a href="Matchers.Features.html#.toHaveID">toHaveID</a>
                         </li>
+                        <li data-type="method">
+                            <a href="Matchers.Features.html#.toHaveStringID">toHaveStringID</a>
+                        </li>
                     </ul>
                 </li>
                 <li>

diff --git a/docs/Matchers.BoundingBoxes.html b/docs/Matchers.BoundingBoxes.html
@@ -224,6 +224,9 @@ <h3>Namespaces</h3>
                         <li data-type="method">
                             <a href="Matchers.Features.html#.toHaveID">toHaveID</a>
                         </li>
+                        <li data-type="method">
+                            <a href="Matchers.Features.html#.toHaveStringID">toHaveStringID</a>
+                        </li>
                     </ul>
                 </li>
                 <li>

diff --git a/docs/Matchers.Coordinates.html b/docs/Matchers.Coordinates.html
@@ -224,6 +224,9 @@ <h3>Namespaces</h3>
                         <li data-type="method">
                             <a href="Matchers.Features.html#.toHaveID">toHaveID</a>
                         </li>
+                        <li data-type="method">
+                            <a href="Matchers.Features.html#.toHaveStringID">toHaveStringID</a>
+                        </li>
                     </ul>
                 </li>
                 <li>

diff --git a/docs/Matchers.FeatureCollections.html b/docs/Matchers.FeatureCollections.html
@@ -224,6 +224,9 @@ <h3>Namespaces</h3>
                         <li data-type="method">
                             <a href="Matchers.Features.html#.toHaveID">toHaveID</a>
                         </li>
+                        <li data-type="method">
+                            <a href="Matchers.Features.html#.toHaveStringID">toHaveStringID</a>
+                        </li>
                     </ul>
                 </li>
                 <li>

diff --git a/docs/Matchers.Features.html b/docs/Matchers.Features.html
@@ -224,6 +224,9 @@ <h3>Namespaces</h3>
                         <li data-type="method">
                             <a href="Matchers.Features.html#.toHaveID">toHaveID</a>
                         </li>
+                        <li data-type="method">
+                            <a href="Matchers.Features.html#.toHaveStringID">toHaveStringID</a>
+                        </li>
                     </ul>
                 </li>
                 <li>
@@ -584,6 +587,145 @@ <h5>Parameters:</h5>
                             </tr>
                         </tbody>
                     </table>
+
+                    <h4 class="name" id=".toHaveStringID">
+                        <span class="type-signature">(static) </span>toHaveStringID<span
+                            class="signature"
+                            >(featureObject, SearchID<span class="signature-attributes">opt</span
+                            >)</span
+                        ><span class="type-signature"></span>
+                    </h4>
+
+                    <dl class="details">
+                        <dt class="tag-source">Source:</dt>
+                        <dd class="tag-source">
+                            <ul class="dummy">
+                                <li>
+                                    <a href="matchers_features_toHaveStringID.js.html"
+                                        >matchers/features/toHaveStringID.js</a
+                                    >,
+                                    <a href="matchers_features_toHaveStringID.js.html#line57"
+                                        >line 57</a
+                                    >
+                                </li>
+                            </ul>
+                        </dd>
+
+                        <dt class="tag-see">See:</dt>
+                        <dd class="tag-see">
+                            <ul>
+                                <li>
+                                    <a
+                                        href="https://github.com/M-Scott-Lassiter/jest-geojson/issues/37"
+                                        >https://github.com/M-Scott-Lassiter/jest-geojson/issues/37</a
+                                    >
+                                </li>
+                            </ul>
+                        </dd>
+                    </dl>
+
+                    <div class="description usertext">
+                        Checks if a GeoJSON Feature has a string ID. Passes if the Feature object
+                        has any string ID (no argument provided), or if the ID exactly matches the
+                        optional argument (single string or RegExp provided), or any value within an
+                        array of any combination of strings or RegExp. The test fails if the object
+                        does not have an ID, or if it has an ID that does not match the SearchID.
+                        Passing a number type to SearchID will not pass the test, even if the ID
+                        exactly matches.
+                    </div>
+
+                    <h5>Examples</h5>
+
+                    <pre class="prettyprint"><code>const testFeature = {
+    type: 'Feature',
+    id: 'f1',
+    geometry: {...},
+    properties: {...}
+}
+
+test('Feature Has an ID', () => {
+    expect(testFeature).toHaveStringID()
+    expect(testFeature).toHaveStringID([])
+    expect(testFeature).toHaveStringID('f1')
+    expect(testFeature).toHaveStringID(['1', 'F', 'F12', /[a-z]+[0-9]+/])
+
+    expect(testFeature).not.toHaveStringID('f2')
+    expect(testFeature).not.toHaveStringID([1, 'F', 'F12', /SomeID/])
+})</code></pre>
+
+                    <pre class="prettyprint"><code>const testFeatureNoID = {
+    type: 'Feature',
+    geometry: {...},
+    properties: {...}
+}
+const testFeatureNumID = {
+    type: 'Feature',
+    id: 2,
+    geometry: {...},
+    properties: {...}
+}
+
+test('Feature Does not Have an ID', () => {
+    expect(testFeature).not.toHaveStringID('f2')
+    expect(testFeature).not.toHaveStringID([1, 'F', 'F12', /SomeID/])
+
+    expect(testFeatureNoID).not.toHaveStringID()
+    expect(testFeatureNumID).not.toHaveStringID()
+    expect(testFeatureNumID).not.toHaveStringID(2)
+})</code></pre>
+
+                    <h5>Parameters:</h5>
+
+                    <table class="params">
+                        <thead>
+                            <tr>
+                                <th>Name</th>
+
+                                <th>Type</th>
+
+                                <th>Attributes</th>
+
+                                <th class="last">Description</th>
+                            </tr>
+                        </thead>
+
+                        <tbody>
+                            <tr>
+                                <td class="name"><code>featureObject</code></td>
+
+                                <td class="type">
+                                    <span class="param-type">object</span>
+                                </td>
+
+                                <td class="attributes"></td>
+
+                                <td class="description last">any GeoJSON Feature object</td>
+                            </tr>
+
+                            <tr>
+                                <td class="name"><code>SearchID</code></td>
+
+                                <td class="type">
+                                    <span class="param-type">string</span>
+                                    |
+
+                                    <span class="param-type">RegExp</span>
+                                    |
+
+                                    <span class="param-type">Array.&lt;string></span>
+                                    |
+
+                                    <span class="param-type">Array.&lt;RegExp></span>
+                                </td>
+
+                                <td class="attributes">&lt;optional><br /></td>
+
+                                <td class="description last">
+                                    Specific value or array of possible values to search for.
+                                </td>
+                            </tr>
+                        </tbody>
+                    </table>
                 </article>
             </section>
         </div>

diff --git a/docs/Matchers.Functional.html b/docs/Matchers.Functional.html
@@ -224,6 +224,9 @@ <h3>Namespaces</h3>
                         <li data-type="method">
                             <a href="Matchers.Features.html#.toHaveID">toHaveID</a>
                         </li>
+                        <li data-type="method">
+                            <a href="Matchers.Features.html#.toHaveStringID">toHaveStringID</a>
+                        </li>
                     </ul>
                 </li>
                 <li>

diff --git a/docs/Matchers.Geometries.html b/docs/Matchers.Geometries.html
@@ -224,6 +224,9 @@ <h3>Namespaces</h3>
                         <li data-type="method">
                             <a href="Matchers.Features.html#.toHaveID">toHaveID</a>
                         </li>
+                        <li data-type="method">
+                            <a href="Matchers.Features.html#.toHaveStringID">toHaveStringID</a>
+                        </li>
                     </ul>
                 </li>
                 <li>

diff --git a/docs/Matchers.html b/docs/Matchers.html
@@ -224,6 +224,9 @@ <h3>Namespaces</h3>
                         <li data-type="method">
                             <a href="Matchers.Features.html#.toHaveID">toHaveID</a>
                         </li>
+                        <li data-type="method">
+                            <a href="Matchers.Features.html#.toHaveStringID">toHaveStringID</a>
+                        </li>
                     </ul>
                 </li>
                 <li>

diff --git a/docs/core_boundingBoxes_valid2DBoundingBox.js.html b/docs/core_boundingBoxes_valid2DBoundingBox.js.html
@@ -224,6 +224,9 @@ <h3>Namespaces</h3>
                         <li data-type="method">
                             <a href="Matchers.Features.html#.toHaveID">toHaveID</a>
                         </li>
+                        <li data-type="method">
+                            <a href="Matchers.Features.html#.toHaveStringID">toHaveStringID</a>
+                        </li>
                     </ul>
                 </li>
                 <li>

diff --git a/docs/core_boundingBoxes_valid3DBoundingBox.js.html b/docs/core_boundingBoxes_valid3DBoundingBox.js.html
@@ -224,6 +224,9 @@ <h3>Namespaces</h3>
                         <li data-type="method">
                             <a href="Matchers.Features.html#.toHaveID">toHaveID</a>
                         </li>
+                        <li data-type="method">
+                            <a href="Matchers.Features.html#.toHaveStringID">toHaveStringID</a>
+                        </li>
                     </ul>
                 </li>
                 <li>

diff --git a/docs/core_boundingBoxes_validBoundingBox.js.html b/docs/core_boundingBoxes_validBoundingBox.js.html
@@ -224,6 +224,9 @@ <h3>Namespaces</h3>
                         <li data-type="method">
                             <a href="Matchers.Features.html#.toHaveID">toHaveID</a>
                         </li>
+                        <li data-type="method">
+                            <a href="Matchers.Features.html#.toHaveStringID">toHaveStringID</a>
+                        </li>
                     </ul>
                 </li>
                 <li>

diff --git a/docs/core_coordinates_valid2DCoordinate.js.html b/docs/core_coordinates_valid2DCoordinate.js.html
@@ -224,6 +224,9 @@ <h3>Namespaces</h3>
                         <li data-type="method">
                             <a href="Matchers.Features.html#.toHaveID">toHaveID</a>
                         </li>
+                        <li data-type="method">
+                            <a href="Matchers.Features.html#.toHaveStringID">toHaveStringID</a>
+                        </li>
                     </ul>
                 </li>
                 <li>

diff --git a/docs/core_coordinates_valid3DCoordinate.js.html b/docs/core_coordinates_valid3DCoordinate.js.html
@@ -224,6 +224,9 @@ <h3>Namespaces</h3>
                         <li data-type="method">
                             <a href="Matchers.Features.html#.toHaveID">toHaveID</a>
                         </li>
+                        <li data-type="method">
+                            <a href="Matchers.Features.html#.toHaveStringID">toHaveStringID</a>
+                        </li>
                     </ul>
                 </li>
                 <li>

diff --git a/docs/core_coordinates_validCoordinate.js.html b/docs/core_coordinates_validCoordinate.js.html
@@ -224,6 +224,9 @@ <h3>Namespaces</h3>
                         <li data-type="method">
                             <a href="Matchers.Features.html#.toHaveID">toHaveID</a>
                         </li>
+                        <li data-type="method">
+                            <a href="Matchers.Features.html#.toHaveStringID">toHaveStringID</a>
+                        </li>
                     </ul>
                 </li>
                 <li>

diff --git a/docs/core_featureCollections_featureCollection.js.html b/docs/core_featureCollections_featureCollection.js.html
@@ -224,6 +224,9 @@ <h3>Namespaces</h3>
                         <li data-type="method">
                             <a href="Matchers.Features.html#.toHaveID">toHaveID</a>
                         </li>
+                        <li data-type="method">
+                            <a href="Matchers.Features.html#.toHaveStringID">toHaveStringID</a>
+                        </li>
                     </ul>
                 </li>
                 <li>

diff --git a/docs/core_features_feature.js.html b/docs/core_features_feature.js.html
@@ -224,6 +224,9 @@ <h3>Namespaces</h3>
                         <li data-type="method">
                             <a href="Matchers.Features.html#.toHaveID">toHaveID</a>
                         </li>
+                        <li data-type="method">
+                            <a href="Matchers.Features.html#.toHaveStringID">toHaveStringID</a>
+                        </li>
                     </ul>
                 </li>
                 <li>

diff --git a/docs/core_features_hasID.js.html b/docs/core_features_hasID.js.html
@@ -224,6 +224,9 @@ <h3>Namespaces</h3>
                         <li data-type="method">
                             <a href="Matchers.Features.html#.toHaveID">toHaveID</a>
                         </li>
+                        <li data-type="method">
+                            <a href="Matchers.Features.html#.toHaveStringID">toHaveStringID</a>
+                        </li>
                     </ul>
                 </li>
                 <li>