From 73497688fcafcede6013f354a7ebd6fa0e42ae03 Mon Sep 17 00:00:00 2001
From: "J. King" <jking@jkingweb.ca>
Date: Mon, 18 Apr 2022 22:04:48 -0400
Subject: [PATCH] Break contexts up into traits

This will make their expansion easier and will also be useful for using
typed properties later
---
 lib/Context/AbstractContext.php     |  46 +++++
 lib/Context/BooleanMethods.php      |  29 +++
 lib/Context/BooleanProperties.php   |  15 ++
 lib/Context/Context.php             |  32 +---
 lib/Context/ExclusionContext.php    | 264 +---------------------------
 lib/Context/ExclusionMethods.php    | 202 +++++++++++++++++++++
 lib/Context/ExclusionProperties.php |  40 +++++
 7 files changed, 341 insertions(+), 287 deletions(-)
 create mode 100644 lib/Context/AbstractContext.php
 create mode 100644 lib/Context/BooleanMethods.php
 create mode 100644 lib/Context/BooleanProperties.php
 create mode 100644 lib/Context/ExclusionMethods.php
 create mode 100644 lib/Context/ExclusionProperties.php

diff --git a/lib/Context/AbstractContext.php b/lib/Context/AbstractContext.php
new file mode 100644
index 0000000..f6065f8
--- /dev/null
+++ b/lib/Context/AbstractContext.php
@@ -0,0 +1,46 @@
+<?php
+/** @license MIT
+ * Copyright 2017 J. King, Dustin Wilson et al.
+ * See LICENSE and AUTHORS files for details */
+
+declare(strict_types=1);
+namespace JKingWeb\Arsse\Context;
+
+abstract class AbstractContext {
+    protected $props = [];
+    protected $parent = null;
+
+    public function __construct(self $c = null) {
+        $this->parent = $c;
+    }
+
+    public function __clone() {
+        // if the context was cloned because its parent was cloned, change the parent to the clone
+        if ($this->parent) {
+            $t = debug_backtrace(\DEBUG_BACKTRACE_IGNORE_ARGS | \DEBUG_BACKTRACE_PROVIDE_OBJECT, 2)[1];
+            if (($t['object'] ?? null) instanceof self && $t['function'] === "__clone") {
+                $this->parent = $t['object'];
+            }
+        }
+    }
+
+    /** @codeCoverageIgnore */
+    public function __destruct() {
+        unset($this->parent);
+    }
+
+    protected function act(string $prop, int $set, $value) {
+        if ($set) {
+            if (is_null($value)) {
+                unset($this->props[$prop]);
+                $this->$prop = (new \ReflectionClass($this))->getDefaultProperties()[$prop];
+            } else {
+                $this->props[$prop] = true;
+                $this->$prop = $value;
+            }
+            return $this->parent ?? $this;
+        } else {
+            return isset($this->props[$prop]);
+        }
+    }
+}
diff --git a/lib/Context/BooleanMethods.php b/lib/Context/BooleanMethods.php
new file mode 100644
index 0000000..e28101e
--- /dev/null
+++ b/lib/Context/BooleanMethods.php
@@ -0,0 +1,29 @@
+<?php
+/** @license MIT
+ * Copyright 2017 J. King, Dustin Wilson et al.
+ * See LICENSE and AUTHORS files for details */
+
+declare(strict_types=1);
+namespace JKingWeb\Arsse\Context;
+
+trait BooleanMethods {
+    public function unread(bool $spec = null) {
+        return $this->act(__FUNCTION__, func_num_args(), $spec);
+    }
+
+    public function starred(bool $spec = null) {
+        return $this->act(__FUNCTION__, func_num_args(), $spec);
+    }
+
+    public function hidden(bool $spec = null) {
+        return $this->act(__FUNCTION__, func_num_args(), $spec);
+    }
+
+    public function labelled(bool $spec = null) {
+        return $this->act(__FUNCTION__, func_num_args(), $spec);
+    }
+
+    public function annotated(bool $spec = null) {
+        return $this->act(__FUNCTION__, func_num_args(), $spec);
+    }
+}
diff --git a/lib/Context/BooleanProperties.php b/lib/Context/BooleanProperties.php
new file mode 100644
index 0000000..a6f6901
--- /dev/null
+++ b/lib/Context/BooleanProperties.php
@@ -0,0 +1,15 @@
+<?php
+/** @license MIT
+ * Copyright 2017 J. King, Dustin Wilson et al.
+ * See LICENSE and AUTHORS files for details */
+
+declare(strict_types=1);
+namespace JKingWeb\Arsse\Context;
+
+trait BooleanProperties {
+    public $unread = null;
+    public $starred = null;
+    public $hidden = null;
+    public $labelled = null;
+    public $annotated = null;
+}
diff --git a/lib/Context/Context.php b/lib/Context/Context.php
index 8e1b699..48ec2d2 100644
--- a/lib/Context/Context.php
+++ b/lib/Context/Context.php
@@ -6,16 +6,16 @@
 declare(strict_types=1);
 namespace JKingWeb\Arsse\Context;
 
-class Context extends ExclusionContext {
+class Context extends AbstractContext {
+    use BooleanMethods;
+    use BooleanProperties;
+    use ExclusionMethods;
+    use ExclusionProperties;
+
     /** @var ExclusionContext */
     public $not;
     public $limit = 0;
     public $offset = 0;
-    public $unread;
-    public $starred;
-    public $hidden;
-    public $labelled;
-    public $annotated;
 
     public function __construct() {
         $this->not = new ExclusionContext($this);
@@ -38,24 +38,4 @@ class Context extends ExclusionContext {
     public function offset(int $spec = null) {
         return $this->act(__FUNCTION__, func_num_args(), $spec);
     }
-
-    public function unread(bool $spec = null) {
-        return $this->act(__FUNCTION__, func_num_args(), $spec);
-    }
-
-    public function starred(bool $spec = null) {
-        return $this->act(__FUNCTION__, func_num_args(), $spec);
-    }
-
-    public function hidden(bool $spec = null) {
-        return $this->act(__FUNCTION__, func_num_args(), $spec);
-    }
-
-    public function labelled(bool $spec = null) {
-        return $this->act(__FUNCTION__, func_num_args(), $spec);
-    }
-
-    public function annotated(bool $spec = null) {
-        return $this->act(__FUNCTION__, func_num_args(), $spec);
-    }
 }
diff --git a/lib/Context/ExclusionContext.php b/lib/Context/ExclusionContext.php
index e7323ea..d72e814 100644
--- a/lib/Context/ExclusionContext.php
+++ b/lib/Context/ExclusionContext.php
@@ -6,265 +6,7 @@
 declare(strict_types=1);
 namespace JKingWeb\Arsse\Context;
 
-use JKingWeb\Arsse\Misc\ValueInfo;
-use JKingWeb\Arsse\Misc\Date;
-
-class ExclusionContext {
-    public $folder;
-    public $folders;
-    public $folderShallow;
-    public $foldersShallow;
-    public $tag;
-    public $tags;
-    public $tagName;
-    public $tagNames;
-    public $subscription;
-    public $subscriptions;
-    public $edition;
-    public $editions;
-    public $article;
-    public $articles;
-    public $label;
-    public $labels;
-    public $labelName;
-    public $labelNames;
-    public $annotationTerms;
-    public $searchTerms;
-    public $titleTerms;
-    public $authorTerms;
-    public $oldestArticle;
-    public $latestArticle;
-    public $oldestEdition;
-    public $latestEdition;
-    public $modifiedSince;
-    public $notModifiedSince;
-    public $markedSince;
-    public $notMarkedSince;
-
-    protected $props = [];
-    protected $parent;
-
-    public function __construct(self $c = null) {
-        $this->parent = $c;
-    }
-
-    public function __clone() {
-        // if the context was cloned because its parent was cloned, change the parent to the clone
-        if ($this->parent) {
-            $t = debug_backtrace(\DEBUG_BACKTRACE_IGNORE_ARGS | \DEBUG_BACKTRACE_PROVIDE_OBJECT, 2)[1];
-            if (($t['object'] ?? null) instanceof self && $t['function'] === "__clone") {
-                $this->parent = $t['object'];
-            }
-        }
-    }
-
-    /** @codeCoverageIgnore */
-    public function __destruct() {
-        unset($this->parent);
-    }
-
-    protected function act(string $prop, int $set, $value) {
-        if ($set) {
-            if (is_null($value)) {
-                unset($this->props[$prop]);
-                $this->$prop = (new \ReflectionClass($this))->getDefaultProperties()[$prop];
-            } else {
-                $this->props[$prop] = true;
-                $this->$prop = $value;
-            }
-            return $this->parent ?? $this;
-        } else {
-            return isset($this->props[$prop]);
-        }
-    }
-
-    protected function cleanIdArray(array $spec, bool $allowZero = false): array {
-        $spec = array_values($spec);
-        for ($a = 0; $a < sizeof($spec); $a++) {
-            if (ValueInfo::id($spec[$a], $allowZero)) {
-                $spec[$a] = (int) $spec[$a];
-            } else {
-                $spec[$a] = null;
-            }
-        }
-        return array_values(array_unique(array_filter($spec, function($v) {
-            return !is_null($v);
-        })));
-    }
-
-    protected function cleanStringArray(array $spec): array {
-        $spec = array_values($spec);
-        $stop = sizeof($spec);
-        for ($a = 0; $a < $stop; $a++) {
-            if (strlen($str = ValueInfo::normalize($spec[$a], ValueInfo::T_STRING | ValueInfo::M_DROP) ?? "")) {
-                $spec[$a] = $str;
-            } else {
-                unset($spec[$a]);
-            }
-        }
-        return array_values(array_unique($spec));
-    }
-
-    public function folder(int $spec = null) {
-        return $this->act(__FUNCTION__, func_num_args(), $spec);
-    }
-
-    public function folders(array $spec = null) {
-        if (isset($spec)) {
-            $spec = $this->cleanIdArray($spec, true);
-        }
-        return $this->act(__FUNCTION__, func_num_args(), $spec);
-    }
-
-    public function folderShallow(int $spec = null) {
-        return $this->act(__FUNCTION__, func_num_args(), $spec);
-    }
-
-    public function foldersShallow(array $spec = null) {
-        if (isset($spec)) {
-            $spec = $this->cleanIdArray($spec, true);
-        }
-        return $this->act(__FUNCTION__, func_num_args(), $spec);
-    }
-
-    public function tag(int $spec = null) {
-        return $this->act(__FUNCTION__, func_num_args(), $spec);
-    }
-
-    public function tags(array $spec = null) {
-        if (isset($spec)) {
-            $spec = $this->cleanIdArray($spec);
-        }
-        return $this->act(__FUNCTION__, func_num_args(), $spec);
-    }
-
-    public function tagName(string $spec = null) {
-        return $this->act(__FUNCTION__, func_num_args(), $spec);
-    }
-
-    public function tagNames(array $spec = null) {
-        if (isset($spec)) {
-            $spec = $this->cleanStringArray($spec);
-        }
-        return $this->act(__FUNCTION__, func_num_args(), $spec);
-    }
-
-    public function subscription(int $spec = null) {
-        return $this->act(__FUNCTION__, func_num_args(), $spec);
-    }
-
-    public function subscriptions(array $spec = null) {
-        if (isset($spec)) {
-            $spec = $this->cleanIdArray($spec);
-        }
-        return $this->act(__FUNCTION__, func_num_args(), $spec);
-    }
-
-    public function edition(int $spec = null) {
-        return $this->act(__FUNCTION__, func_num_args(), $spec);
-    }
-
-    public function article(int $spec = null) {
-        return $this->act(__FUNCTION__, func_num_args(), $spec);
-    }
-
-    public function editions(array $spec = null) {
-        if (isset($spec)) {
-            $spec = $this->cleanIdArray($spec);
-        }
-        return $this->act(__FUNCTION__, func_num_args(), $spec);
-    }
-
-    public function articles(array $spec = null) {
-        if (isset($spec)) {
-            $spec = $this->cleanIdArray($spec);
-        }
-        return $this->act(__FUNCTION__, func_num_args(), $spec);
-    }
-
-    public function label(int $spec = null) {
-        return $this->act(__FUNCTION__, func_num_args(), $spec);
-    }
-
-    public function labels(array $spec = null) {
-        if (isset($spec)) {
-            $spec = $this->cleanIdArray($spec);
-        }
-        return $this->act(__FUNCTION__, func_num_args(), $spec);
-    }
-
-    public function labelName(string $spec = null) {
-        return $this->act(__FUNCTION__, func_num_args(), $spec);
-    }
-
-    public function labelNames(array $spec = null) {
-        if (isset($spec)) {
-            $spec = $this->cleanStringArray($spec);
-        }
-        return $this->act(__FUNCTION__, func_num_args(), $spec);
-    }
-
-    public function annotationTerms(array $spec = null) {
-        if (isset($spec)) {
-            $spec = $this->cleanStringArray($spec);
-        }
-        return $this->act(__FUNCTION__, func_num_args(), $spec);
-    }
-
-    public function searchTerms(array $spec = null) {
-        if (isset($spec)) {
-            $spec = $this->cleanStringArray($spec);
-        }
-        return $this->act(__FUNCTION__, func_num_args(), $spec);
-    }
-
-    public function titleTerms(array $spec = null) {
-        if (isset($spec)) {
-            $spec = $this->cleanStringArray($spec);
-        }
-        return $this->act(__FUNCTION__, func_num_args(), $spec);
-    }
-
-    public function authorTerms(array $spec = null) {
-        if (isset($spec)) {
-            $spec = $this->cleanStringArray($spec);
-        }
-        return $this->act(__FUNCTION__, func_num_args(), $spec);
-    }
-
-    public function latestArticle(int $spec = null) {
-        return $this->act(__FUNCTION__, func_num_args(), $spec);
-    }
-
-    public function oldestArticle(int $spec = null) {
-        return $this->act(__FUNCTION__, func_num_args(), $spec);
-    }
-
-    public function latestEdition(int $spec = null) {
-        return $this->act(__FUNCTION__, func_num_args(), $spec);
-    }
-
-    public function oldestEdition(int $spec = null) {
-        return $this->act(__FUNCTION__, func_num_args(), $spec);
-    }
-
-    public function modifiedSince($spec = null) {
-        $spec = Date::normalize($spec);
-        return $this->act(__FUNCTION__, func_num_args(), $spec);
-    }
-
-    public function notModifiedSince($spec = null) {
-        $spec = Date::normalize($spec);
-        return $this->act(__FUNCTION__, func_num_args(), $spec);
-    }
-
-    public function markedSince($spec = null) {
-        $spec = Date::normalize($spec);
-        return $this->act(__FUNCTION__, func_num_args(), $spec);
-    }
-
-    public function notMarkedSince($spec = null) {
-        $spec = Date::normalize($spec);
-        return $this->act(__FUNCTION__, func_num_args(), $spec);
-    }
+class ExclusionContext extends AbstractContext {
+    use ExclusionMethods;
+    use ExclusionProperties;
 }
diff --git a/lib/Context/ExclusionMethods.php b/lib/Context/ExclusionMethods.php
new file mode 100644
index 0000000..7b7ecc4
--- /dev/null
+++ b/lib/Context/ExclusionMethods.php
@@ -0,0 +1,202 @@
+<?php
+/** @license MIT
+ * Copyright 2017 J. King, Dustin Wilson et al.
+ * See LICENSE and AUTHORS files for details */
+
+declare(strict_types=1);
+namespace JKingWeb\Arsse\Context;
+
+use JKingWeb\Arsse\Misc\ValueInfo;
+use JKingWeb\Arsse\Misc\Date;
+
+trait ExclusionMethods {
+    protected function cleanIdArray(array $spec, bool $allowZero = false): array {
+        $spec = array_values($spec);
+        for ($a = 0; $a < sizeof($spec); $a++) {
+            if (ValueInfo::id($spec[$a], $allowZero)) {
+                $spec[$a] = (int) $spec[$a];
+            } else {
+                $spec[$a] = null;
+            }
+        }
+        return array_values(array_unique(array_filter($spec, function($v) {
+            return !is_null($v);
+        })));
+    }
+
+    protected function cleanStringArray(array $spec): array {
+        $spec = array_values($spec);
+        $stop = sizeof($spec);
+        for ($a = 0; $a < $stop; $a++) {
+            if (strlen($str = ValueInfo::normalize($spec[$a], ValueInfo::T_STRING | ValueInfo::M_DROP) ?? "")) {
+                $spec[$a] = $str;
+            } else {
+                unset($spec[$a]);
+            }
+        }
+        return array_values(array_unique($spec));
+    }
+
+    public function folder(int $spec = null) {
+        return $this->act(__FUNCTION__, func_num_args(), $spec);
+    }
+
+    public function folders(array $spec = null) {
+        if (isset($spec)) {
+            $spec = $this->cleanIdArray($spec, true);
+        }
+        return $this->act(__FUNCTION__, func_num_args(), $spec);
+    }
+
+    public function folderShallow(int $spec = null) {
+        return $this->act(__FUNCTION__, func_num_args(), $spec);
+    }
+
+    public function foldersShallow(array $spec = null) {
+        if (isset($spec)) {
+            $spec = $this->cleanIdArray($spec, true);
+        }
+        return $this->act(__FUNCTION__, func_num_args(), $spec);
+    }
+
+    public function tag(int $spec = null) {
+        return $this->act(__FUNCTION__, func_num_args(), $spec);
+    }
+
+    public function tags(array $spec = null) {
+        if (isset($spec)) {
+            $spec = $this->cleanIdArray($spec);
+        }
+        return $this->act(__FUNCTION__, func_num_args(), $spec);
+    }
+
+    public function tagName(string $spec = null) {
+        return $this->act(__FUNCTION__, func_num_args(), $spec);
+    }
+
+    public function tagNames(array $spec = null) {
+        if (isset($spec)) {
+            $spec = $this->cleanStringArray($spec);
+        }
+        return $this->act(__FUNCTION__, func_num_args(), $spec);
+    }
+
+    public function subscription(int $spec = null) {
+        return $this->act(__FUNCTION__, func_num_args(), $spec);
+    }
+
+    public function subscriptions(array $spec = null) {
+        if (isset($spec)) {
+            $spec = $this->cleanIdArray($spec);
+        }
+        return $this->act(__FUNCTION__, func_num_args(), $spec);
+    }
+
+    public function edition(int $spec = null) {
+        return $this->act(__FUNCTION__, func_num_args(), $spec);
+    }
+
+    public function article(int $spec = null) {
+        return $this->act(__FUNCTION__, func_num_args(), $spec);
+    }
+
+    public function editions(array $spec = null) {
+        if (isset($spec)) {
+            $spec = $this->cleanIdArray($spec);
+        }
+        return $this->act(__FUNCTION__, func_num_args(), $spec);
+    }
+
+    public function articles(array $spec = null) {
+        if (isset($spec)) {
+            $spec = $this->cleanIdArray($spec);
+        }
+        return $this->act(__FUNCTION__, func_num_args(), $spec);
+    }
+
+    public function label(int $spec = null) {
+        return $this->act(__FUNCTION__, func_num_args(), $spec);
+    }
+
+    public function labels(array $spec = null) {
+        if (isset($spec)) {
+            $spec = $this->cleanIdArray($spec);
+        }
+        return $this->act(__FUNCTION__, func_num_args(), $spec);
+    }
+
+    public function labelName(string $spec = null) {
+        return $this->act(__FUNCTION__, func_num_args(), $spec);
+    }
+
+    public function labelNames(array $spec = null) {
+        if (isset($spec)) {
+            $spec = $this->cleanStringArray($spec);
+        }
+        return $this->act(__FUNCTION__, func_num_args(), $spec);
+    }
+
+    public function annotationTerms(array $spec = null) {
+        if (isset($spec)) {
+            $spec = $this->cleanStringArray($spec);
+        }
+        return $this->act(__FUNCTION__, func_num_args(), $spec);
+    }
+
+    public function searchTerms(array $spec = null) {
+        if (isset($spec)) {
+            $spec = $this->cleanStringArray($spec);
+        }
+        return $this->act(__FUNCTION__, func_num_args(), $spec);
+    }
+
+    public function titleTerms(array $spec = null) {
+        if (isset($spec)) {
+            $spec = $this->cleanStringArray($spec);
+        }
+        return $this->act(__FUNCTION__, func_num_args(), $spec);
+    }
+
+    public function authorTerms(array $spec = null) {
+        if (isset($spec)) {
+            $spec = $this->cleanStringArray($spec);
+        }
+        return $this->act(__FUNCTION__, func_num_args(), $spec);
+    }
+
+    public function latestArticle(int $spec = null) {
+        return $this->act(__FUNCTION__, func_num_args(), $spec);
+    }
+
+    public function oldestArticle(int $spec = null) {
+        return $this->act(__FUNCTION__, func_num_args(), $spec);
+    }
+
+    public function latestEdition(int $spec = null) {
+        return $this->act(__FUNCTION__, func_num_args(), $spec);
+    }
+
+    public function oldestEdition(int $spec = null) {
+        return $this->act(__FUNCTION__, func_num_args(), $spec);
+    }
+
+    public function modifiedSince($spec = null) {
+        $spec = Date::normalize($spec);
+        return $this->act(__FUNCTION__, func_num_args(), $spec);
+    }
+
+    public function notModifiedSince($spec = null) {
+        $spec = Date::normalize($spec);
+        return $this->act(__FUNCTION__, func_num_args(), $spec);
+    }
+
+    public function markedSince($spec = null) {
+        $spec = Date::normalize($spec);
+        return $this->act(__FUNCTION__, func_num_args(), $spec);
+    }
+
+    public function notMarkedSince($spec = null) {
+        $spec = Date::normalize($spec);
+        return $this->act(__FUNCTION__, func_num_args(), $spec);
+    }
+}
diff --git a/lib/Context/ExclusionProperties.php b/lib/Context/ExclusionProperties.php
new file mode 100644
index 0000000..426adb2
--- /dev/null
+++ b/lib/Context/ExclusionProperties.php
@@ -0,0 +1,40 @@
+<?php
+/** @license MIT
+ * Copyright 2017 J. King, Dustin Wilson et al.
+ * See LICENSE and AUTHORS files for details */
+
+declare(strict_types=1);
+namespace JKingWeb\Arsse\Context;
+
+trait ExclusionProperties {
+    public $folder = null;
+    public $folders = null;
+    public $folderShallow = null;
+    public $foldersShallow = null;
+    public $tag = null;
+    public $tags = null;
+    public $tagName = null;
+    public $tagNames = null;
+    public $subscription = null;
+    public $subscriptions = null;
+    public $edition = null;
+    public $editions = null;
+    public $article = null;
+    public $articles = null;
+    public $label = null;
+    public $labels = null;
+    public $labelName = null;
+    public $labelNames = null;
+    public $annotationTerms = null;
+    public $searchTerms = null;
+    public $titleTerms = null;
+    public $authorTerms = null;
+    public $oldestArticle = null;
+    public $latestArticle = null;
+    public $oldestEdition = null;
+    public $latestEdition = null;
+    public $modifiedSince = null;
+    public $notModifiedSince = null;
+    public $markedSince = null;
+    public $notMarkedSince = null;
+}