Add new requirement to create obfuscator attribute

AydinHassan · AydinHassan · commit 70f6bf49aee3 · 2021-06-26T20:28:08.000+01:00
diff --git a/exercises/the-attributes-of-success/initial/deserialize.php b/exercises/the-attributes-of-success/initial/deserialize.php
@@ -16,10 +16,29 @@ function deserialize(string $data, string $className): object
 
     $attrs[0]->newInstance();
 
-    $object = new $className;
+    $object = new $className();
 
     $data = json_decode($data, true);
 
+    $obfuscators = array_filter(
+        $reflectionClass->getMethods(),
+        fn (ReflectionMethod $m) => count($m->getAttributes(Obfuscate::class)) > 0
+    );
+
+    $obfuscators = array_combine(
+        array_map(
+            fn(ReflectionMethod $m) => $m->getAttributes(Obfuscate::class)[0]->newInstance()->key,
+            $obfuscators
+        ),
+        $obfuscators
+    );
+
+    foreach ($data as $key => $value) {
+        if (isset($obfuscators[$key])) {
+            $data[$key] = $object->{$obfuscators[$key]->getName()}($value);
+        }
+    }
+
     foreach ($reflectionClass->getProperties() as $property) {
         if ($map = $property->getAttributes(Map::class)) {
             $key = $map[0]->newInstance()->mapFrom;
diff --git a/exercises/the-attributes-of-success/solution/deserialize.php b/exercises/the-attributes-of-success/solution/deserialize.php
@@ -16,10 +16,29 @@ function deserialize(string $data, string $className): object
 
     $attrs[0]->newInstance();
 
-    $object = new $className;
+    $object = new $className();
 
     $data = json_decode($data, true);
 
+    $obfuscators = array_filter(
+        $reflectionClass->getMethods(),
+        fn (ReflectionMethod $m) => count($m->getAttributes(Obfuscate::class)) > 0
+    );
+
+    $obfuscators = array_combine(
+        array_map(
+            fn(ReflectionMethod $m) => $m->getAttributes(Obfuscate::class)[0]->newInstance()->key,
+            $obfuscators
+        ),
+        $obfuscators
+    );
+
+    foreach ($data as $key => $value) {
+        if (isset($obfuscators[$key])) {
+            $data[$key] = $object->{$obfuscators[$key]->getName()}($value);
+        }
+    }
+
     foreach ($reflectionClass->getProperties() as $property) {
         if ($map = $property->getAttributes(Map::class)) {
             $key = $map[0]->newInstance()->mapFrom;
diff --git a/exercises/the-attributes-of-success/solution/solution.php b/exercises/the-attributes-of-success/solution/solution.php
@@ -3,6 +3,14 @@
 require_once __DIR__ . '/deserialize.php';
 require_once __DIR__ . '/attributes.php';
 
+
+#[Attribute(Attribute::TARGET_METHOD)]
+class Obfuscate {
+    public function __construct(public string $key)
+    {
+    }
+}
+
 #[Deserialize]
 class Review {
     public string $comment;
@@ -13,7 +21,15 @@ class Review {
     public string $date;
 
     #[Skip()]
+    public string $id;
+
     public ?string $reviewer = null;
+
+    #[Obfuscate('reviewer')]
+    public function obfuscateReviewer(string $reviewer): string
+    {
+        return md5($reviewer);
+    }
 }
 
 $object = deserialize($argv[1], Review::class);
diff --git a/src/Exercise/TheAttributesOfSuccess.php b/src/Exercise/TheAttributesOfSuccess.php
@@ -4,8 +4,11 @@
 
 use Faker\Generator as FakerGenerator;
 use PhpParser\Node;
+use PhpParser\Node\Scalar\String_;
 use PhpParser\Node\Stmt;
 use PhpParser\Node\Stmt\Class_;
+use PhpParser\Node\Stmt\ClassMethod;
+use PhpParser\Node\Stmt\Property;
 use PhpParser\NodeFinder;
 use PhpParser\Parser;
 use PhpSchool\PhpWorkshop\Check\FileComparisonCheck;
@@ -79,6 +82,7 @@ public function getArgs(): array
         return [
             json_encode(
                 [
+                    'id' => random_int(0, 100),
                     'comment' => $this->faker->sentence(4),
                     'rating' => $this->faker->numberBetween(0, 5),
                     'reviewer' => $this->faker->userName(),
@@ -99,17 +103,108 @@ public function check(Input $input): ResultInterface
             return $node instanceof Class_ && $node->name && $node->name->name === 'Review';
         });
 
-        //not even sure we need this the var_dump will cover it
         if ($classStmt === null) {
             return new Failure($this->getName(), 'A class named Review was not found');
         }
 
+        /** @var ClassMethod|null $method */
+        $method = (new NodeFinder())->findFirst($statements, function (Node $node) {
+            return $node instanceof ClassMethod && $node->name->name === 'obfuscateReviewer';
+        });
+
+        if ($method === null) {
+            return new Failure($this->getName(), 'A method named obfuscateReviewer was not found');
+        }
+
+        if (!isset($method->attrGroups[0]->attrs[0])) {
+            return new Failure($this->getName(), 'No attributes found on method obfuscateReviewer');
+        }
+
+        $attribute = $method->attrGroups[0]->attrs[0];
+
+        if ($attribute->name->toString() !== 'Obfuscate') {
+            return new Failure($this->getName(), 'No attribute named Obfuscate found on method obfuscateReviewer');
+        }
+
+        if (!isset($attribute->args[0])) {
+            return new Failure($this->getName(), 'No property name argument was passed to the Obfuscate attribute');
+        }
+
+        if (!$attribute->args[0]->value instanceof String_ || $attribute->args[0]->value->value !== 'reviewer') {
+            return new Failure($this->getName(), 'The Obfuscate attribute was not passed the correct data property');
+        }
+
+        /** @var Class_|null $attributeClass */
+        $attributeClass = (new NodeFinder())->findFirst($statements, function (Node $node) {
+            return $node instanceof Class_ && $node->name && $node->name->name === 'Obfuscate';
+        });
+
+        if ($attributeClass === null) {
+            return new Failure($this->getName(), 'A class named Obfuscate was not found');
+        }
+
+        if (!isset($attributeClass->attrGroups[0]->attrs[0])) {
+            return new Failure($this->getName(), 'No attributes found on class Obfuscate');
+        }
+
+        $attribute = $attributeClass->attrGroups[0]->attrs[0];
+
+        if ($attribute->name->toString() !== 'Attribute') {
+            return new Failure($this->getName(), 'The Obfuscate class was not defined as an Attribute');
+        }
+
+        if (!isset($attribute->args[0])) {
+            return new Failure($this->getName(), 'No flags were passed to Obfuscate Attribute definition');
+        }
+
+        /** @var \PhpParser\Node\Expr\ClassConstFetch $value */
+        $value = $attribute->args[0]->value;
+
+        if ($value->class->toString() !== 'Attribute' || $value->name->name !== 'TARGET_METHOD') {
+            return new Failure(
+                $this->getName(),
+                'The Obfuscate Attribute was not configured as Attribute::TARGET_METHOD'
+            );
+        }
+
+        $prop = (new NodeFinder())->findFirst($attributeClass->getProperties(), function (Node $node) {
+            return $node instanceof Property
+                && $node->isPublic()
+                && $node->type instanceof \PhpParser\Node\Identifier
+                && $node->type->name === 'string'
+                && $node->props[0] instanceof \PhpParser\Node\Stmt\PropertyProperty
+                && $node->props[0]->name instanceof \PhpParser\Node\VarLikeIdentifier
+                && $node->props[0]->name->name === 'key';
+        });
+
+        $promotedProp = (new NodeFinder())->findFirst($attributeClass->getMethods(), function (Node $node) {
+            return $node instanceof ClassMethod
+                && $node->name->name === '__construct'
+                && isset($node->params[0])
+                && $node->params[0]->flags === 1
+                && $node->params[0]->var->name === 'key'
+                && $node->params[0]->type instanceof \PhpParser\Node\Identifier
+                && $node->params[0]->type->name === 'string';
+
+        });
+
+        if ($prop === null && $promotedProp === null) {
+            return new Failure(
+                $this->getName(),
+                'The Obfuscate Attribute has no public property named "key"'
+            );
+        }
+
+
         return new Success($this->getName());
     }
 
     public function getRequiredFunctions(): array
     {
-        return ['deserialize'];
+        return [
+            'deserialize',
+            'var_dump'
+        ];
     }
 
     public function getBannedFunctions(): array
