Adding a convenient JmesPath\search() function

Author: mtdowling

CHANGELOG.md

@@ -15,6 +15,7 @@
 * Slice syntax is now properly validated (i.e., colons are followed by the
   appropriate value).
 * Lots of code cleanup and performance improvements.
+* Added a convenient `JmesPath\search()` function.
 
 ## 1.1.1 - 2014-10-08
 

README.rst

@@ -22,7 +22,7 @@ using the ``mtdowling/jmespath.php`` package.
         ]
     ];
 
-    JmesPath\Env::search($expression, $data);
+    JmesPath\search($expression, $data);
     // Returns: [1, 2, 3]
 
 - `JMESPath documentation <http://jmespath.readthedocs.org/en/latest/>`_
@@ -32,22 +32,26 @@ using the ``mtdowling/jmespath.php`` package.
 PHP Usage
 =========
 
-The ``JmesPath\Env::search`` function can be used in most cases when using the
+The ``JmesPath\search`` function can be used in most cases when using the
 library. This function utilizes a JMESPath runtime based on your environment.
 The runtime utilized can be configured using environment variables and may at
 some point in the future automatically utilize a C extension if available.
 
 .. code-block:: php
 
-    $result = \JmesPath\Env::search($expression, $data);
+    $result = JmesPath\search($expression, $data);
+
+    // or, if you require PSR-4 compliance.
+    $result = JmesPath\Env::search($expression, $data);
 
 Runtimes
 --------
 
 jmespath.php utilizes *runtimes*. There are currently two runtimes:
 AstRuntime and CompilerRuntime.
 
-AstRuntime is utilized by ``JmesPath\Env::search()`` by default.
+AstRuntime is utilized by ``JmesPath\search()`` and ``JmesPath\Env::search()``
+by default.
 
 AstRuntime
 ~~~~~~~~~~
@@ -92,7 +96,7 @@ before executing them (for example, server-side applications).
 Environment Variables
 ^^^^^^^^^^^^^^^^^^^^^
 
-You can utilize the CompilerRuntime in ``JmesPath\Env::search()`` by setting
+You can utilize the CompilerRuntime in ``JmesPath\search()`` by setting
 the ``JP_PHP_COMPILE`` environment variable to "on" or to a directory
 on disk used to store cached expressions.
 

composer.json

@@ -23,7 +23,8 @@
   "autoload": {
     "psr-4": {
       "JmesPath\\": "src/"
-    }
+    },
+    "files": ["src/JmesPath.php"]
   },
 
   "bin": ["bin/jp.php"],

src/JmesPath.php

@@ -0,0 +1,15 @@
+<?php
+namespace JmesPath;
+
+/**
+ * Returns data from the input array that matches a JMESPath expression.
+ *
+ * @param string $expression Expression to search.
+ * @param mixed  $data       Data to search.
+ *
+ * @return mixed|null
+ */
+function search($expression, $data)
+{
+    return Env::search($expression, $data);
+}

tests/EnvTest.php

@@ -9,4 +9,10 @@ public function testSearchesInput()
         $this->assertEquals(123, \JmesPath\Env::search('foo', $data));
         $this->assertEquals(123, \JmesPath\Env::search('foo', $data));
     }
+
+    public function testSearchesWithFunction()
+    {
+        $data = array('foo' => 123);
+        $this->assertEquals(123, \JmesPath\search('foo', $data));
+    }
 }