Built Inspector structure

Signed-off-by: Tom Wright <[email protected]>

Author: betterthanclay

CHANGELOG.md

@@ -5,3 +5,6 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## Unreleased
+- Built Inspector structure
+- Implemented Dumpable interface
+- Ported SensitiveProperty and LazyType

composer.json

@@ -2,18 +2,21 @@
     "name": "decodelabs/nuance",
     "description": "Type inspection tools",
     "type": "library",
-    "keywords": [],
+    "keywords": [ ],
     "license": "MIT",
-    "authors": [{
-        "name": "Tom Wright",
-        "email": "[email protected]"
-    }],
+    "authors": [ {
+            "name": "Tom Wright",
+            "email": "[email protected]"
+        } ],
     "require": {
         "php": "^8.4",
-        "decodelabs/exceptional": "^0.5.3"
+        "decodelabs/coercion": "^0.3.2",
+        "decodelabs/exceptional": "^0.5.3",
+        "decodelabs/glitch-support": "^0.5.1"
     },
     "require-dev": {
-        "decodelabs/phpstan-decodelabs": "^0.7.0"
+        "decodelabs/phpstan-decodelabs": "^0.7.0",
+        "php-ds/php-ds": "^1.5"
     },
     "autoload": {
         "psr-4": {

src/Dumpable.php

@@ -0,0 +1,17 @@
+<?php
+
+/**
+ * @package Nuance
+ * @license http://opensource.org/licenses/MIT
+ */
+
+declare(strict_types=1);
+
+namespace DecodeLabs\Nuance;
+
+use DecodeLabs\Nuance\Entity\NativeObject;
+
+interface Dumpable
+{
+    public function nuanceDump(): NativeObject;
+}

src/Entity.php

@@ -0,0 +1,14 @@
+<?php
+
+/**
+ * @package Nuance
+ * @license http://opensource.org/licenses/MIT
+ */
+
+declare(strict_types=1);
+
+namespace DecodeLabs\Nuance;
+
+interface Entity
+{
+}

src/Entity/Binary.php

@@ -0,0 +1,20 @@
+<?php
+
+/**
+ * @package Nuance
+ * @license http://opensource.org/licenses/MIT
+ */
+
+declare(strict_types=1);
+
+namespace DecodeLabs\Nuance\Entity;
+
+class Binary extends NativeString implements Structured
+{
+    use StructuredTrait;
+
+    public function getHex(): string
+    {
+        return bin2hex($this->value);
+    }
+}

src/Entity/ClassString.php

@@ -0,0 +1,35 @@
+<?php
+
+/**
+ * @package Nuance
+ * @license http://opensource.org/licenses/MIT
+ */
+
+declare(strict_types=1);
+
+namespace DecodeLabs\Nuance\Entity;
+
+class ClassString implements Value
+{
+    public string $value;
+
+    public string $type {
+        get {
+            if(trait_exists($this->value)) {
+                return 'trait';
+            }
+
+            if(interface_exists($this->value)) {
+                return 'interface';
+            }
+
+            return 'class';
+        }
+    }
+
+    public function __construct(
+        string $value
+    ) {
+        $this->value = $value;
+    }
+}

src/Entity/ConstOption.php

@@ -0,0 +1,55 @@
+<?php
+
+/**
+ * @package Nuance
+ * @license http://opensource.org/licenses/MIT
+ */
+
+declare(strict_types=1);
+
+namespace DecodeLabs\Nuance\Entity;
+
+class ConstOption implements Value, Structured
+{
+    use StructuredTrait;
+
+    public string|bool|int|float|null $value;
+
+    /**
+     * @var array<string,string|bool|int|float|null>
+     */
+    protected(set) array $options = [];
+
+    /**
+     * @param list<string> $constNames
+     */
+    public function __construct(
+        string|bool|int|float|null $value,
+        array $constNames = []
+    ) {
+        $this->value = $value;
+        $this->options = [];
+
+        foreach($constNames as $name) {
+            $name = ltrim($name, '\\');
+
+            // @phpstan-ignore-next-line
+            $this->options[$name] = constant($name);
+        }
+    }
+
+    public function getSelectedConstName(): ?string
+    {
+        if ($this->value === null) {
+            return null;
+        }
+
+        foreach ($this->options as $name => $constValue) {
+            if ($constValue === $this->value) {
+                return $name;
+            }
+        }
+
+        return null;
+    }
+}

src/Entity/FlagSet.php

@@ -0,0 +1,69 @@
+<?php
+
+/**
+ * @package Nuance
+ * @license http://opensource.org/licenses/MIT
+ */
+
+declare(strict_types=1);
+
+namespace DecodeLabs\Nuance\Entity;
+
+use DecodeLabs\Coercion;
+
+class FlagSet implements Value
+{
+    public int $value;
+
+    /**
+     * @var array<string,int>
+     */
+    protected(set) array $options = [];
+
+    /**
+     * @param list<string> $constNames
+     */
+    public function __construct(
+        int $value,
+        array $constNames = []
+    ) {
+        $this->value = $value;
+        $this->options = [];
+
+        foreach($constNames as $name) {
+            $name = ltrim($name, '\\');
+            $option = Coercion::tryInt(constant($name));
+
+            if($option === null) {
+                continue;
+            }
+
+            $this->options[$name] = $option;
+        }
+    }
+
+    /**
+     * @return array<string,int>
+     */
+    public function getSelectedConstValues(): array
+    {
+        $output = [];
+
+        foreach ($this->options as $name => $constValue) {
+            if (
+                (
+                    $constValue !== 0 &&
+                    ($this->value & $constValue) === $constValue
+                ) ||
+                (
+                    $this->value === 0 &&
+                    $constValue === 0
+                )
+            ) {
+                $output[$name] = $constValue;
+            }
+        }
+
+        return $output;
+    }
+}

src/Entity/NativeArray.php

@@ -0,0 +1,71 @@
+<?php
+
+/**
+ * @package Nuance
+ * @license http://opensource.org/licenses/MIT
+ */
+
+declare(strict_types=1);
+
+namespace DecodeLabs\Nuance\Entity;
+
+class NativeArray implements Value, Structured
+{
+    use StructuredTrait;
+
+    private static ?string $cookieKey = null;
+
+    /**
+     * @var array<mixed>
+     */
+    public array $value;
+
+    public int $length {
+        get => count($this->value) - 1;
+    }
+
+    public ?string $hash {
+        get {
+            if (isset($this->hash)) {
+                return $this->hash;
+            }
+
+            if(!$this->length) {
+                return null;
+            }
+
+            $cookieKey = self::getCookieKey();
+            $value = $this->value;
+            unset($value[$cookieKey]);
+
+            return md5(print_r($value, true));
+        }
+    }
+
+    protected(set) bool $referenced = false;
+
+    /**
+     * @param array<mixed> $value
+     */
+    public function __construct(
+        array &$value
+    ) {
+        $this->value = &$value;
+        $cookieKey = self::getCookieKey();
+
+        $this->referenced = array_key_exists($cookieKey, $this->value);
+
+        if (!$this->referenced) {
+            $this->value[$cookieKey] = $this->hash;
+        }
+    }
+
+    public static function getCookieKey(): string
+    {
+        if(self::$cookieKey === null) {
+            self::$cookieKey = uniqid('__nuance_array_');
+        }
+
+        return self::$cookieKey;
+    }
+}

src/Entity/NativeBoolean.php

@@ -0,0 +1,21 @@
+<?php
+
+/**
+ * @package Nuance
+ * @license http://opensource.org/licenses/MIT
+ */
+
+declare(strict_types=1);
+
+namespace DecodeLabs\Nuance\Entity;
+
+class NativeBoolean implements Value
+{
+    public bool $value;
+
+    public function __construct(
+        bool $value
+    ) {
+        $this->value = $value;
+    }
+}