Add an annotation @filter-default-field (#20)

Author: greg-1-anderson

src/Cli/OpCommands.php

@@ -34,6 +34,7 @@ public function parse($expr, $options = ['format' => 'yaml', 'dump' => false])
      *
      * @command edit
      * @aliases ed
+     * @filter-default-field color
      * @filter-output
      * @return array
      */

src/FactoryInterface.php

@@ -17,5 +17,5 @@ interface FactoryInterface
      * @param string $expression
      * @return OperatorInterface
      */
-    public function evaluate($expression);
+    public function evaluate($expression, $defaultField = false);
 }

src/Hooks/FilterHooks.php

@@ -17,11 +17,12 @@ class FilterHooks
     public function filterOutput($result, CommandData $commandData)
     {
         $expr = $commandData->input()->getOption('filter');
+        $default_field = $commandData->annotationData()->get('filter-default-field');
         if (!empty($expr)) {
             $factory = LogicalOpFactory::get();
-            $op = $factory->evaluate($expr);
+            $op = $factory->evaluate($expr, $default_field);
             $filter = new FilterOutputData();
-            $result = $this->wrapFilteredResult($filter->filter($result, $op), get_class($result));
+            $result = $this->wrapFilteredResult($filter->filter($result, $op), $result);
         }
 
         return $result;
@@ -31,11 +32,12 @@ public function filterOutput($result, CommandData $commandData)
      * If the source data was wrapped in a marker class such
      * as RowsOfFields, then re-apply the wrapper.
      */
-    protected function wrapFilteredResult($data, $sourceClass)
+    protected function wrapFilteredResult($data, $source)
     {
-        if (!$sourceClass) {
+        if (!$source instanceof \ArrayObject) {
             return $data;
         }
+        $sourceClass = get_class($source);
 
         return new $sourceClass($data);
     }

src/LogicalOpFactory.php

@@ -38,15 +38,15 @@ public static function get()
      * @param string $expression
      * @return OperatorInterface
      */
-    public function evaluate($expression)
+    public function evaluate($expression, $default_field = false)
     {
         $exprSet = $this->splitByLogicOp($expression);
         $result = false;
 
         foreach ($exprSet as $exprWithLogicOp) {
             $logicOp = $exprWithLogicOp[1];
             $expr = $exprWithLogicOp[2];
-            $rhs = $this->factory->evaluate($expr);
+            $rhs = $this->factory->evaluate($expr, $default_field);
             $result = $this->combineUsingLogicalOp($result, $logicOp, $rhs);
         }
 

src/OperatorFactory.php

@@ -34,18 +34,18 @@ public function __construct()
      * @param string $expression
      * @return OperatorInterface
      */
-    public function evaluate($expression)
+    public function evaluate($expression, $defaultField = false)
     {
         if ($expression[0] == '!') {
-            $op = $this->evaluateNonNegated(substr($expression, 1));
+            $op = $this->evaluateNonNegated(substr($expression, 1), $defaultField);
             return new NotOp($op);
         }
-        return $this->evaluateNonNegated($expression);
+        return $this->evaluateNonNegated($expression, $defaultField);
     }
 
-    protected function evaluateNonNegated($expression)
+    protected function evaluateNonNegated($expression, $defaultField = false)
     {
-        list($key, $op, $comparitor) = $this->splitOnOperator($expression);
+        list($key, $op, $comparitor) = $this->splitOnOperator($expression, $defaultField);
         if (empty($key) || empty($op)) {
             throw new \Exception('Could not parse expression ' . $expression);
         }
@@ -79,8 +79,13 @@ protected function instantiate($key, $op, $comparitor)
      * @param string @expression
      * @return array
      */
-    protected function splitOnOperator($expression)
+    protected function splitOnOperator($expression, $defaultField = false)
     {
+        // If there is a default field, then any expression that is missing
+        // an operator will be interpreted as "default field contains value".
+        if (preg_match('#^[a-zA-Z0-9_.:-]+$#', $expression) && ($defaultField !== false)) {
+            return [$defaultField, '*=', $expression];
+        }
         if (!preg_match('#([^!~*=]*)(!?~?\*?=)(.*)#', $expression, $matches)) {
             return ['', '', ''];
         }

tests/OpCommandsTest.php

@@ -69,6 +69,13 @@ public function exampleTestCommandParameters()
                 'edit', 'tests/fixtures/data.yml', '--filter=color=red',
             ],
 
+            [
+                'b:
+  color: blue
+  shape: square', self::STATUS_OK,
+                'edit', 'tests/fixtures/data.yml', '--filter=blue',
+            ],
+
         ];
     }