done adapter

Author: AdelDaniel

structural_design_pattern/adapter/README.md

@@ -0,0 +1,101 @@
+# Adapter Structural Design Pattern
+Also known as: `Wrapper`
+
+  - is a Structural Design Pattern.
+  - Adapter pattern works as a` bridge between two incompatible interfaces.`
+  - A construct which adapts an
+  existing interface X to conform to the required interface Y.
+ 
+<table>
+  <tr>
+    <td><img src="assets/adapter.jpeg"></td>
+    <td><img src="assets/adapter-diagram.png"><td>
+  </tr>
+  <tr>
+    <td></td>
+    <td><img src="assets/adapter_explanation.jpg"><td>
+  </tr>
+</table>
+
+- An adapter wraps one of the objects to hide the complexity of conversion happening behind the scenes.
+
+      The wrapped object isn’t even aware of the adapter. For example, you can wrap an object that operates in meters and kilometers with an adapter that converts all of the data to imperial units such as feet and miles.
+- Sometimes it’s even possible to create a two-way adapter that can convert the calls in both directions.
+
+## Sections
+
+- [Types](#Types)
+    - [Object Adapter](#Object-Adapter)
+    - [Class Adapter](#Class-Adapter)
+- [How to Implement](#How-to-Implement)
+- [Examples](#Examples)
+    - [square pegs and round holes Example](#square-pegs-and-round-holes-Example)
+    - [Xml and json](#Xml-and-json)
+    - [vessel volume Example](#vessel-volume-Example)
+    - [Example in Arabic with explanation](#Example-in-Arabic-with-explanation)
+    - [TO DO](#TO-DO)
+
+
+## Types
+<center> `Object Adapter && Class Adapter` </center>
+
+<table>
+  <tr>
+    <th>Object Adapter</th>
+    <th>Class Adapter</th>
+  </tr>
+  <tr>
+    <td>This implementation uses the object composition principle: the adapter implements the interface of one object and wraps the other one. It can be implemented in all popular programming languages.</td>
+    <td>This implementation uses inheritance: the adapter inherits interfaces from both objects at the same time. Note that this approach can only be implemented in programming languages that support multiple inheritance, such as C++.</td>
+  </tr>
+  <tr>
+    <td><img src="assets/structure-object-adapter.png"></td>
+    <td><img src="assets/structure-class-adapter.png"></td>
+  </tr>
+   <tr>
+    <td>The Adapter is a class that’s able to work with both the client and the service: (1-it implements the client interface), (2-while wrapping the service object).The adapter receives calls from the client via the adapter interface and translates them into calls to the wrapped service object in a format it can understand.</td>
+    <td>The Class Adapter doesn’t need to wrap any objects because it inherits behaviors from both the client and the service. The adaptation happens within the overridden methods. The resulting adapter can be used in place of an existing client class.</td>
+  </tr>
+  
+</table>
+
+  ---
+## How to Implement
+1. Make sure that you have at least two classes with incompatible interfaces:
+    1. A useful service class, which you can’t change (often 3rd-party, legacy or with lots of existing dependencies).
+    1. One or several client classes that would benefit from using the service class.
+
+1. Declare the client interface and describe how clients communicate with the service.
+
+1. Create the adapter class and make it follow the client interface. Leave all the methods empty for now.
+
+1. Add a field to the adapter class to store a reference to the service object. The common practice is to initialize this field via the constructor, but sometimes it’s more convenient to pass it to the adapter when calling its methods.
+
+1. One by one, implement all methods of the client interface in the adapter class. The adapter should delegate most of the real work to the service object, handling only the interface or data format conversion.
+
+1. Clients should use the adapter via the client interface. This will let you change or extend the adapters without affecting the client code.
+
+    
+## Examples
+
+### square pegs and round holes Example
+ - Example in dart: <a href="square_pegs_and_round_holes/README.md" target="_blank">square pegs and round holes Example </a>
+ - Example Source:  <a href="https://refactoring.guru/design-patterns/adapter" target="_blank">refactoring.guru/design-patterns/adapter</a> 
+
+### Xml and json
+ - Example in dart: <a href="xml_and_json/README.md" target="_blank">Xml and json</a>
+- Example Source: <a href="https://www.c-sharpcorner.com/article/adapter-design-pattern/" target="_blank">https://www.c-sharpcorner.com/article/adapter-design-pattern/</a> 
+
+### ToyDuck and Bird  
+- Example in dart: <a href="bird_and_toy_duck/README.md" target="_blank">bird and toy duck</a>
+- Example Source: <a href="https://www.geeksforgeeks.org/adapter-pattern/" target="_blank">https://www.geeksforgeeks.org/adapter-pattern/</a> 
+
+### Example in Arabic with explanation 
+-  Source: <a href="https://www.linkedin.com/pulse/design-patterns-arabic-7-adapter-hassan-elseoudy/?originalSubdomain=ae" target="_blank">https://www.linkedin.com/pulse/design-patterns-arabic-7-adapter-hassan-elseoudy/?originalSubdomain=ae</a> 
+
+
+## TO DO 
+
+- convert sms example to dart
+  -    Example: <a href="sms_example/README.md" target="_blank">sms example</a>
+  - <a href="https://youtu.be/LP0PZ7WPJPo" target="_blank">https://youtu.be/LP0PZ7WPJPo</a>

structural_design_pattern/adapter/assets/adapter-diagram.png

@@ -0,0 +1,98 @@
+# Example: ToyDuck and Bird 
+
+- Suppose you have a Bird class with fly(), with makeSound()methods.
+- And also a ToyDuck class with squeak() method.
+- Let’s assume that you are short on ToyDuck objects and you would like to use Bird objects in their place.
+- Birds have some similar functionality but implement a different interface, so we can’t use them directly.
+- So we will use adapter pattern. Here our client would be ToyDuck and adaptee would be Bird.
+
+  ---
+Example Source: <a href="https://www.geeksforgeeks.org/adapter-pattern/" target="_blank">https://www.geeksforgeeks.org/adapter-pattern/</a>  
+
+
+## This is how our UML would look:
+
+<img src="../assets/bird_and_duck_toy_diagram.jpg">
+<img src="../assets/toy_duck_and_bird.drawio.svg">
+
+## Dart implementation of Adapter pattern
+
+``` dart
+abstract class Bird {
+  // birds implement Bird interface that allows
+  // them to fly and make sounds adaptee interface
+  void fly();
+  void makeSound();
+}
+
+// a concrete implementation of bird
+class Sparrow implements Bird {
+  void fly() => print("Flying");
+  void makeSound() => print("Chirp Chirp");
+}
+
+abstract class ToyDuck {
+  // target interface
+  // toyducks dont fly they just make
+  // squeaking sound
+  void squeak();
+}
+
+class PlasticToyDuck implements ToyDuck {
+  void squeak() => print("Squeak");
+}
+
+class BirdAdapter implements ToyDuck {
+  // You need to implement the interface your
+  // client expects to use.
+  Bird bird;
+
+  // we need reference to the object we
+  // are adapting
+  BirdAdapter(Bird this.bird);
+
+  // translate the methods appropriately
+  @override
+  void squeak() => bird.makeSound();
+}
+
+void main() {
+  Sparrow sparrow = Sparrow();
+  ToyDuck toyDuck = PlasticToyDuck();
+
+  // Wrap a bird in a birdAdapter so that it
+  // behaves like toy duck
+  ToyDuck birdAdapter = BirdAdapter(sparrow);
+
+  print("Sparrow...");
+  sparrow.fly();
+  sparrow.makeSound();
+
+  print("ToyDuck...");
+  toyDuck.squeak();
+
+  // toy duck behaving like a bird
+  print("BirdAdapter...");
+  birdAdapter.squeak();
+}
+```
+## Output
+  
+     Sparrow...
+     Flying
+     Chirp Chirp
+     ToyDuck...
+     Squeak
+     BirdAdapter...
+     Chirp Chirp
+
+
+ ## Explanation 
+- Suppose we have a `bird` that can makeSound(),
+- and we have a `plastic toyDuck` that can squeak().
+- Now suppose our client changes the requirement and he wants the toyDuck to makeSound
+- than ? Simple solution is that we will just change the implementation class to the adapter class and tell the client to pass the instance of the bird(which wants to squeak()) to that class.
+
+      Before : ToyDuck toyDuck = PlasticToyDuck();
+      After : ToyDuck toyDuck = BirdAdapter(sparrow);
+You can see that by changing just one line the toyDuck can now do Chirp Chirp !!

structural_design_pattern/adapter/assets/adapter.jpeg

@@ -0,0 +1,82 @@
+// Example:
+// Suppose you have a Bird class with fly() ,
+// and makeSound()methods.
+// And also a ToyDuck class
+// with squeak() method.
+// Let’s assume that you are short on ToyDuck objects
+// and you would like to use Bird objects in their place.
+// Birds have some similar functionality but implement a different interface,
+// so we can’t use them directly.
+// So we will use adapter pattern.
+// Here our client would be ToyDuck and adaptee would be Bird.
+
+// Dart implementation of Adapter pattern
+// source:: https://www.geeksforgeeks.org/adapter-pattern/
+
+abstract class Bird {
+  // birds implement Bird interface that allows
+  // them to fly and make sounds adaptee interface
+  void fly();
+  void makeSound();
+}
+
+// a concrete implementation of bird
+class Sparrow implements Bird {
+  void fly() => print("Flying");
+  void makeSound() => print("Chirp Chirp");
+}
+
+abstract class ToyDuck {
+  // target interface
+  // toyducks dont fly they just make
+  // squeaking sound
+  void squeak();
+}
+
+class PlasticToyDuck implements ToyDuck {
+  void squeak() => print("Squeak");
+}
+
+class BirdAdapter implements ToyDuck {
+  // You need to implement the interface your
+  // client expects to use.
+  Bird bird;
+
+  // we need reference to the object we
+  // are adapting
+  BirdAdapter(Bird this.bird);
+
+  // translate the methods appropriately
+  @override
+  void squeak() => bird.makeSound();
+}
+
+void main() {
+  Bird sparrow = Sparrow();
+  ToyDuck toyDuck = PlasticToyDuck();
+
+  // Wrap a bird in a birdAdapter so that it
+  // behaves like toy duck
+  ToyDuck birdAdapter = BirdAdapter(sparrow);
+
+  print("Sparrow...");
+  sparrow.fly();
+  sparrow.makeSound();
+
+  print("ToyDuck...");
+  toyDuck.squeak();
+
+  // toy duck behaving like a bird
+  print("BirdAdapter...");
+  birdAdapter.squeak();
+}
+
+// Output:
+
+// Sparrow...
+// Flying
+// Chirp Chirp
+// ToyDuck...
+// Squeak
+// BirdAdapter...
+// Chirp Chirp

structural_design_pattern/adapter/assets/adapter_explanation.jpg

@@ -0,0 +1 @@
+<mxfile host="app.diagrams.net" modified="2022-03-22T23:58:43.927Z" agent="5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/99.0.4844.74 Safari/537.36 Edg/99.0.1150.46" etag="-yQQP4eiU_0fDsAhoVIs" version="17.1.3" type="device"><diagram name="Page-1" id="9f46799a-70d6-7492-0946-bef42562c5a5">7Vxbc5s4FP41nkkf7OFmsB9ju9ntTnaaaTrts2xko0YgCnIc99evJMRdGHLBdrLOZBI4up/znYsOgoE595/+ikDo/UtciAeG5j4NzMXAMAzT0Nk/TtknFN2aWgllEyFX0nLCPfoDJVGT1C1yYVyqSAnBFIVl4ooEAVzREg1EEdmVq60JLo8agg2sEe5XANepP5FLPUnVNS0v+BuijSeHnoxlwRKsHjYR2QZyvIAEMCnxQdqNrBp7wCW7Asn8PDDnESE0ufKf5hBzvqYcS9rdNJRmU45gQLs0GMbgy6/YcW52P3788+3rbHO/2A+NcdLNI8BbyQs5W7pPmSOWB3kv+sCc7TxE4X0IVrx0x/DAaB71sSzGYAnxLOPKnGASsSLBF3O2JgGV0p/K27TGwDA18cPpCONKSzlNGFH41MgAPWMrgyokPqTRnlWRDYap0CRKh0Yq3l0u86kjaV5B3E5aEUicbbLOc4azC8lzNf+dydTW9fF0rdlwOoGToanVeD9DkXvtgpDCqCaGeId8DAQzCvwWHJWV+D3AaBOw6xVjCuvEnHGWIYb0a1lACZfYykPYvQV7suVLjCkTWHo380iE/rBuQToGK45SsRl2qcY9b8nIXGoRjFmdu1Qeeka6BTGVdVYEYxDGaJlN2AfRBgUzQinxZaV0pTcFGDB4rMUP77UEyEyvkv59tJLXh6EY04g8ZNquq1HHuXsDfIQ5ZH7AyAUBKMNYNzJw1pCowGsjOE17XAKnbkxq2DRMBTb1idMHNvUaNgfGjBs8htCBec2uOFZrIGWrpWWAJnyu8rXO6hS4GK5pI2xjZndQsLkVdRZWTvkmGWI1WCjC+ltjARMPuS4MBIwooCBBIsdLSFBABRPHM/bLeD3XRuPBmK1rzu71/J798uoRM14BWx9AQuyQwXwHOdQrCK3Do9kWtANGAoQpYid8pPXeFh6TdreBUdVWdVK5Fhz4THoY5oL/znGxGOo1cJh1cJgKoQsjcUdiRBHh/UdJ3QoYzkDeY6ObvCd9iHvaYA2EvwqFv7qiHopH3Dx8yu2DLBsYNuZsWvKrDRUssoHPFTNYxmHGsoshOQGw7HoQdDxDYtVjoARZ8e8tBA9XEkt0H8ILRE4GkckpfY1lKiAirQcu2RJx94XHvWsukJRcNjjpXcUgKaOZ8wi5LecScvcRcttOeT+o2/WQW7dVIbfWR8idOviaKfTBA7zn7Eyt4SNBl8j7raxhZl46W0PL6QaTXqzhWGUNOUrWeH/Bx1ngwzFPiI+pKqGXODsXPZYgYf/e8tyjMK3DtTS5HD+Zr2QewLSEiQ9igtk8qwWi8lzdZBshHvlrAdw1t/NJQGIBCENL6GI2sbD0fC66FT5lZXxLOUxZKEqnvDRdSGFzIRbMOg6UK86ztsNVgnXeWbRZXhnjcTa3yvWn+kAMyjz5nI7HhJUMWZ4GIwvWp9SzDDIueb3jBBmmYrultA6TN9jIK1P+elNq7+JBXuxBWp5LNFjp5+T2evMgaow0bcsvseh5IUWRFTxerKFrqjTwm2/Nv5P9Ysu80Xk6TmtycZx9OE5LKzvOYVfHOe0jA67rjtoiVtPYLZHnO4i1q0FukoltiXE/0oKvPnVarKQV8tMNjS7O8U024rm36Z6p6ZjQ6y+OUuX0KniAgXstdpHmYokJdx4zF8RexhpWzu2+lAC7KxraAorKDG06WpMMD93aeaiaqY6Zkq3gwbCEAZ85K3g4dVKXjkocEcSAosfyrFTykN3dcSTm3mKil72FNamc2ElWI1vlUq11NHVaOkpWXOtIwCNb4ysQU8/vIT/E0IdyvBJ0mBhvuVMvI6E15MkeootwpFG/Fwdw1DG2lQf25BCD7DBcEW8HNKf5LJc2Msd6SVL664CUViHrdQz7Ea1VE+0d83tMMucd4ZraJcJtiHBfdR6xmho6aoSrRqgqeXwJcj/igi9B7plmgA64jsY41+xoOPqLc+2PEece9NsHY125OzlKsOvYZcdh2+bLgt3WjvoOdutJlbMMdnsIb+228Fa3JuOzj2g7HAN+D2rfeETufFS+sr8dOpUuuqq8XU2rVjvqW+XrR4n/LyrfgJb3pfLpcjuqvIsAC1Dd7x4KDui6YZ1Q19MDPgd13dTUwutD1SuvqekvTWWNpy0dNag6kx3YF6pJpekDTKrDbAobkGY7WKTtkQ0JAP6cUytoyevcEvFuCCf+gpTuJdjAlhJFQqX9rcSX4U29cKOLf0nCozroOgPsVTF9Osd3e5Ks4bSYepd88CDZwfW29JEckNB8tjnke25t4DQeDHv9YPVUjXxNT4vTo2qa6FSTR9f4MY7jzifLdWo0u0qmVE6GHn9mXF34r/aT5wqYRg3k645MUYLCffaCLtNzvgwPcKOL6Gkmu4QeeISxwPsDTNjK/rqCsyeRa5lHiWwLLzZfSSgeXb5hxPzYVV5VqsBoNMppR5+UZMZIHr47zeClU12nFYqE0WmFIi3TKH8J7USWqKjLiaajYJOrem6hTiixgmqfVmoFu3MkyTmLw523nfz2QMgvA0J5HNvyZY380PrXLU1erhZ0F0QPX3n2m/I4Xxtp40E1Jn6Tj3JUEvONG+TuD8CqOQ3dksmB4nuGU0Ue23yL73Gog17VMa+P9/Snqj0MUeE2iZIPPhQqvcD9jrYCYja7wlYgIJEP8GGmveylk5LCSzNeijTajFGl7Q3eC5v/3HZzD0Vh/v+5zUt++Jlt76sPUzu2q3mS/pb8kS1zP19PqhhrU/HtJKWt1m3j2baa3ebfxUqSTfmHx8zP/wE=</diagram></mxfile>

structural_design_pattern/adapter/assets/bird_and_duck_toy_diagram.jpg

@@ -0,0 +1,39 @@
+<?php
+namespace App\Patterns\Structural\Adapter\SMSAdapter\Adapters\ABCSMSManager;
+
+class SMSManager
+{
+    public function send(array $messages)
+    {
+        if($this->checkConnection() && $this->authenticate() && $this->connect()) {
+            foreach ($messages as $message) {
+                echo "Your message {$message['text']} is being sent to {$message['number']}'\n";
+            }
+        }
+    }
+
+    public function connect(): bool
+    {
+        return true;
+    }
+
+    public function checkConnection(): bool
+    {
+        return true;
+    }
+
+    public function authenticate(): bool
+    {
+        return true;
+    }
+
+    public function validatePhoneNumber(string $phoneNumber): bool
+    {
+        return strlen($phoneNumber) < 8;
+    }
+
+    public function getDeliveryStatus(): string
+    {
+        return rand(5,8);
+    }
+}

structural_design_pattern/adapter/assets/json_xml_Adapter_design_pattern.jpg

@@ -0,0 +1,47 @@
+<?php
+namespace App\Patterns\Structural\Adapter\SMSAdapter\Adapters;
+
+use App\Patterns\Structural\Adapter\SMSAdapter\Adapters\ABCSMSManager\SMSManager;
+use App\Patterns\Structural\Adapter\SMSAdapter\Messages\Message;
+use App\Patterns\Structural\Adapter\SMSAdapter\SMSClient;
+use App\Patterns\Structural\Adapter\SMSAdapter\SMSDeliveryStatus;
+
+class ABSSMSClientAdapter extends SMSClient
+{
+    private ?SMSManager $manager = null;
+
+    public function __construct(array $messages = [])
+    {
+        parent::__construct($messages);
+        $this->manager = new SMSManager();
+    }
+
+    public function filterNumbers(): bool
+    {
+        $this->messages = array_filter(
+            $this->messages,
+            fn (Message $message) => $this->manager->validatePhoneNumber($message->getNumber())
+        );
+        return !empty($this->messages);
+    }
+
+    public function send(): bool
+    {
+        if($this->filterNumbers()) {
+            $this->manager->send(
+                array_map(function (Message $message): array {
+                    return [
+                        'number' => $message->getNumber(),
+                        'text' => $message->getMessage()
+                    ];
+                }, $this->messages)
+            );
+        }
+        return $this->getDeliveryStatus() === SMSDeliveryStatus::SENT;
+    }
+
+    public function getDeliveryStatus(): string
+    {
+        return $this->manager->getDeliveryStatus() - 4;
+    }
+}

structural_design_pattern/adapter/assets/square_pegs_and_round_holes._example.png

@@ -0,0 +1,10 @@
+<?php
+namespace App\Patterns\Structural\Adapter\SMSAdapter\Messages;
+
+interface Message
+{
+    public function getMessage(): string;
+    public function getNumber(): string;
+    public function validateMessage(): bool;
+    public function validateNumber(): bool;
+}