Add where filter for array

kalimatas · Dec 27, 2023 · 4d2ab5f · 4d2ab5f
1 parent c76f0b8
commit 4d2ab5f
Show file tree

Hide file tree

Showing 7 changed files with 85 additions and 2 deletions.
diff --git a/src/Liquid/StandardFilters.php b/src/Liquid/StandardFilters.php
@@ -162,6 +162,26 @@ public static function json($input)
 		return json_encode($input);
 	}
 
+	/**
+	 * Creates an array including only the objects with a given property value
+	 * @link https://shopify.github.io/liquid/filters/where/
+	 *
+	 * @param array $input
+	 * @param string ...$args
+	 * @return array
+	 * @throws LiquidException
+	 */
+	public static function where(array $input, string ...$args): array
+	{
+		switch (count($args)) {
+			case 1:
+				return array_filter($input, fn($v) => ($v[$args[0]] ?? null) !== null);
+			case 2:
+				return array_filter($input, fn($v) => ($v[$args[0]] ?? '') == $args[1]);
+			default:
+				throw new LiquidException('Wrong number of arguments to function `where`, given ' . count($args) . ', expected 1 or 2');
+		}
+	}
 
 	/**
 	 * Escape a string

diff --git a/src/Liquid/Tag/TagFor.php b/src/Liquid/Tag/TagFor.php
@@ -50,6 +50,11 @@ class TagFor extends AbstractBlock
 	 */
 	private $name;
 
+	/**
+	 * @var string
+	 */
+	private $start;
+
 	/**
 	 * @var string The type of the loop (collection or digit)
 	 */

diff --git a/src/Liquid/Tag/TagPaginate.php b/src/Liquid/Tag/TagPaginate.php
@@ -187,7 +187,7 @@ public function render(Context $context)
 	public function currentUrl($context, $queryPart = [])
 	{
 		// From here we have $url->path and $url->query
-		$url = (object) parse_url($context->get('REQUEST_URI'));
+		$url = (object) parse_url($context->get('REQUEST_URI') ?: '');
 
 		// Let's merge the query part
 		if (isset($url->query)) {

diff --git a/tests/Liquid/ContextTest.php b/tests/Liquid/ContextTest.php
@@ -85,7 +85,7 @@ public function toLiquid()
 
 class CountableObject implements \Countable
 {
-	public function count()
+	public function count(): int
 	{
 		return 2;
 	}
@@ -135,6 +135,8 @@ public function __get($prop)
 
 class HiFilter
 {
+	public Context $context;
+
 	public function hi($value)
 	{
 		return $value . ' hi!';
@@ -143,6 +145,8 @@ public function hi($value)
 
 class GlobalFilter
 {
+	public Context $context;
+
 	public function notice($value)
 	{
 		return "Global $value";
@@ -151,6 +155,8 @@ public function notice($value)
 
 class LocalFilter
 {
+	public Context $context;
+
 	public function notice($value)
 	{
 		return "Local $value";

diff --git a/tests/Liquid/FilterbankTest.php b/tests/Liquid/FilterbankTest.php
@@ -11,6 +11,8 @@
 
 namespace {
 
+	use Liquid\Context;
+
 	/**
 	 * Global function acts as a filter.
 	 *
@@ -28,6 +30,8 @@ function functionFilter($value)
 	 */
 	class ClassFilter
 	{
+		public Context $context;
+
 		private $variable = 'not set';
 
 		public function __construct()
@@ -59,6 +63,8 @@ public function instance_test_two()
 
 	class NamespacedClassFilter
 	{
+		public Context $context;
+
 		public static function static_test2($var)
 		{
 			return "good {$var}";

diff --git a/tests/Liquid/OutputTest.php b/tests/Liquid/OutputTest.php
@@ -13,6 +13,8 @@
 
 class FunnyFilter
 {
+	public Context $context;
+
 	public function make_funny($input)
 	{
 		return 'LOL';
@@ -191,4 +193,26 @@ public function testVariableWithANewLine()
 		$text = "{{ aaa\n }}";
 		$this->assertTemplateResult('', $text, $this->assigns);
 	}
+
+	public function testFilterArray()
+	{
+		$text = ' {{ cars | where: "model", "bmw" | json }} ';
+		$expected = ' [{"model":"bmw"}] ';
+
+		$this->assertTemplateResult($expected, $text, ['cars' => [
+			['model' => 'bmw'],
+			['model' => 'audi'],
+		]]);
+	}
+
+	public function testFilterArrayTruthy()
+	{
+		$text = ' {{ cars | where: "available" | json }} ';
+		$expected = ' [{"model":"bmw","available":1}] ';
+
+		$this->assertTemplateResult($expected, $text, ['cars' => [
+			['model' => 'bmw', 'available' => 1],
+			['model' => 'audi'],
+		]]);
+	}
 }
diff --git a/tests/Liquid/StandardFiltersTest.php b/tests/Liquid/StandardFiltersTest.php
@@ -13,6 +13,8 @@
 
 class MoneyFilter
 {
+	public Context $context;
+
 	public function money($value)
 	{
 		return sprintf(' %d$ ', $value);
@@ -26,6 +28,8 @@ public function money_with_underscore($value)
 
 class CanadianMoneyFilter
 {
+	public Context $context;
+
 	public function money($value)
 	{
 		return sprintf(' %d$ CAD ', $value);
@@ -204,6 +208,24 @@ public function testJson()
 		}
 	}
 
+	public function testWhere()
+	{
+		$data = [
+			[
+				'before' => [['model' => 'bmw'], ['model' => 'audi']],
+				'after' => [['model' => 'bmw']],
+			],
+			[
+				'before' => ['model' => 'bmw'],
+				'after' => [],
+			],
+		];
+
+		foreach ($data as $testCase) {
+			$this->assertEquals($testCase['after'], StandardFilters::where($testCase['before'], 'model', 'bmw'));
+		}
+	}
+
 	public function testEscape()
 	{
 		$data = array(