Merge pull request #28 from ilopX/refacotring-v0.17.17

neochief · web-flow · commit a69760d88119 · 2022-02-09T15:14:34.000+02:00
Refactoring v0.17.17
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,21 @@
+## 0.17.16 - refactoring
+- Simplifying the ternary construction.
+- Remove multiline comment from main README.
+- Replace repository urls to relative.
+- Fix relative urls.
+- Fix name on diagram "Builder", rename JsonFormat to JsonConverter.
+- Select pattern "Command" at the diagram.
+- Add client code to "Bridge" pattern.
+- Fix url position & add example name to ProductsAndBoxes example.
+- Add example name to Decorator pattern.
+- Format app_observer.dart.
+- Connect Application to events on the AppObserver diagram.
+- Split into separate files the "Memento" project.
+- Remover unnecessary import.
+- Move hash generator to application.
+- Update SubscriberWidget diagram.
+- Fix url position in FlutterAdapter README.md.
+
 ## 0.17.0
 Add "Adapter" pattern: adapt a non-reactive classic type application for Flutter.
 
diff --git a/README.md b/README.md
@@ -4,31 +4,31 @@ It contains **Dart** examples for all classic **GoF** design patterns.
 
 # Implementation checklist:
 - [ ] **Creation**
-    - [ ] [**Abstract Factory**](https://refactoring.guru/design-patterns/abstract-factory)
-    - [x] [**Builder**](https://refactoring.guru/design-patterns/builder) - [[Color Text Format](https://github.com/RefactoringGuru/design-patterns-dart/tree/master/patterns/builder/color_text_format)]
-    - [ ] [**Factory Method**](https://refactoring.guru/design-patterns/factory-method)
-    - [x] [**Prototype**](https://refactoring.guru/design-patterns/prototype) - [[Shapes](https://github.com/RefactoringGuru/design-patterns-dart/tree/master/patterns/prototype/shapes)] 
-    - [ ] [**Singleton**](https://refactoring.guru/design-patterns/singleton)
+    - [ ] **Abstract Factory**
+    - [x] **Builder** - [[Color Text Format](https://github.com/RefactoringGuru/design-patterns-dart/tree/master/patterns/builder/color_text_format)]
+    - [ ] **Factory Method**
+    - [x] **Prototype**] - [[Shapes](https://github.com/RefactoringGuru/design-patterns-dart/tree/master/patterns/prototype/shapes)] 
+    - [ ] **Singleton**
 - [ ]  **Behavioral**
-    - [x] [**Chain of Responsibility**](https://refactoring.guru/design-patterns/chain-of-esponsibility) - [[Server Middleware](https://github.com/RefactoringGuru/design-patterns-dart/tree/master/patterns/chain_of_responsibility/server_middleware)]
-    - [x] [**Command**](https://refactoring.guru/design-patterns/command) - [[Text Editor](https://github.com/RefactoringGuru/design-patterns-dart/tree/master/patterns/command/text_editor)] 
+    - [x] **Chain of Responsibility** - [[Server Middleware](https://github.com/RefactoringGuru/design-patterns-dart/tree/master/patterns/chain_of_responsibility/server_middleware)]
+    - [x] **Command** - [[Text Editor](https://github.com/RefactoringGuru/design-patterns-dart/tree/master/patterns/command/text_editor)] 
     - [ ] Interpreter
-    - [ ] [**Iterator**](https://refactoring.guru/design-patterns/iterator)
-    - [ ] [**Mediator**](https://refactoring.guru/design-patterns/mediator)
-    - [x] [**Memento**](https://refactoring.guru/design-patterns/memento) - [[Conceptual](https://github.com/RefactoringGuru/design-patterns-dart/tree/master/patterns/memento/conceptual)]
-    - [x] [**Observer**](https://refactoring.guru/design-patterns/observer) - [[Open-Close Editor Events](https://github.com/RefactoringGuru/design-patterns-dart/tree/master/patterns/observer/open_close_editor_events)] [[AppObserver](https://github.com/RefactoringGuru/design-patterns-dart/tree/master/patterns/observer/app_observer)] [[Subscriber Flutter Widget](https://github.com/RefactoringGuru/design-patterns-dart/tree/master/patterns/observer/subscriber_flutter_widget)]
-    - [ ] [**State**](https://refactoring.guru/design-patterns/state)
-    - [ ] [**Template Method**](https://refactoring.guru/design-patterns/template-method)
-    - [ ] [**Visitor**](https://refactoring.guru/design-patterns/visitor)
-    - [ ] [**Strategy**](https://refactoring.guru/design-patterns/strategy)
+    - [ ] **Iterator**
+    - [ ] **Mediator**
+    - [x] **Memento** - [[Conceptual](https://github.com/RefactoringGuru/design-patterns-dart/tree/master/patterns/memento/conceptual)]
+    - [x] **Observer** - [[Open-Close Editor Events](https://github.com/RefactoringGuru/design-patterns-dart/tree/master/patterns/observer/open_close_editor_events)] [[AppObserver](https://github.com/RefactoringGuru/design-patterns-dart/tree/master/patterns/observer/app_observer)] [[Subscriber Flutter Widget](https://github.com/RefactoringGuru/design-patterns-dart/tree/master/patterns/observer/subscriber_flutter_widget)]
+    - [ ] **State**
+    - [ ] **Template Method**
+    - [ ] **Visitor**
+    - [ ] **Strategy**
 - [ ] **Structural**
-    - [x] [**Adapter**](https://refactoring.guru/design-patterns/adapter) - [[Text Graphics](https://github.com/RefactoringGuru/design-patterns-dart/tree/master/patterns/adapter/text_graphics)] [[Square Round conflict](https://github.com/RefactoringGuru/design-patterns-dart/tree/master/patterns/adapter/square_round_conflict)] [[Flutter Adapter](https://github.com/RefactoringGuru/design-patterns-dart/tree/master/patterns/adapter/flutter_adapter)] 
-    - [x] [**Bridge**](https://refactoring.guru/design-patterns/bridge) - [[Remote Device Control](https://github.com/RefactoringGuru/design-patterns-dart/tree/master/patterns/bridge/devices_remote_control)] [[Clock](https://github.com/RefactoringGuru/design-patterns-dart/tree/master/patterns/bridge/clock)] 
-    - [x] [**Composite**](https://refactoring.guru/design-patterns/composite) - [[Image Editor](https://github.com/RefactoringGuru/design-patterns-dart/tree/master/patterns/composite/image_editor)] [[Products and Boxes](https://github.com/RefactoringGuru/design-patterns-dart/tree/master/patterns/composite/products_and_boxes)] 
-    - [x] [**Decorator**](https://refactoring.guru/design-patterns/decorator) - [[Data Source Decoder](https://github.com/RefactoringGuru/design-patterns-dart/tree/master/patterns/decorator/data_source_decoder)]
-    - [ ] [**Facade**](https://refactoring.guru/design-patterns/facade)
-    - [ ] [**Flyweight**](https://refactoring.guru/design-patterns/flyweight)
-    - [ ] [**Proxy**](https://refactoring.guru/design-patterns/proxy)
+    - [x] **Adapter** - [[Text Graphics](https://github.com/RefactoringGuru/design-patterns-dart/tree/master/patterns/adapter/text_graphics)] [[Square Round conflict](https://github.com/RefactoringGuru/design-patterns-dart/tree/master/patterns/adapter/square_round_conflict)] [[Flutter Adapter](https://github.com/RefactoringGuru/design-patterns-dart/tree/master/patterns/adapter/flutter_adapter)] 
+    - [x] **Bridge** - [[Remote Device Control](https://github.com/RefactoringGuru/design-patterns-dart/tree/master/patterns/bridge/devices_remote_control)] [[Clock](https://github.com/RefactoringGuru/design-patterns-dart/tree/master/patterns/bridge/clock)] 
+    - [x] **Composite** - [[Image Editor](https://github.com/RefactoringGuru/design-patterns-dart/tree/master/patterns/composite/image_editor)] [[Products and Boxes](https://github.com/RefactoringGuru/design-patterns-dart/tree/master/patterns/composite/products_and_boxes)] 
+    - [x] **Decorator** - [[Data Source Decoder](https://github.com/RefactoringGuru/design-patterns-dart/tree/master/patterns/decorator/data_source_decoder)]
+    - [ ] **Facade**
+    - [ ] **Flyweight**
+    - [ ] **Proxy**
 
 ## Requirements
 
@@ -50,20 +50,16 @@ Here's a style guide which might help you to keep your changes consistent with o
 4. File names should match following convention: `some_class_name.dart`
 
 5. Comments may or may not have language tags in them, such as this:
-
     ```dart
-    /**
-     * EN: All products families have the same varieties (MacOS/Windows).
-     *
-     * This is a MacOS variant of a button.
-     *
-     * RU: Все семейства продуктов имеют одни и те же вариации (MacOS/Windows).
-     *
-     * Это вариант кнопки под MacOS.
-     */
+        // EN: All products families have the same varieties (MacOS/Windows).
+        // This is a MacOS variant of a button.
+        
+        // RU: Все семейства продуктов имеют одни и те же вариации (MacOS/Windows).
+        // Это вариант кнопки под MacOS.
     ```
-
-    Don't be scared and ignore the non-English part of such comments. If you want to change something in a comment like this, then do it. Even if you do it wrong, we'll tell you how to fix it during the Pull Request.
+    Don't be scared and ignore the non-English part of such comments. If you want to change 
+    something in a comment like this, then do it. Even if you do it wrong, we'll tell you how 
+    to fix it during the Pull Request.
 
 
 ### Build Flutter examples
@@ -73,7 +69,7 @@ flutter build web -t bin\main.dart --web-renderer html
 ```
 
 ### Deploy flutter demos
-1. Fork this repo: https://github.com/RefactoringGuru/design-patterns-dart
+1. Fork this repo: `https://github.com/RefactoringGuru/design-patterns-dart`
 2. Apply your changes.
 3. Run the script `dart bin\deploy_flutter_demos.dart`.
 This script will build a web platform flutter app and push the changes to your **web-demos** branch on github.
diff --git a/patterns/adapter/flutter_adapter/README.md b/patterns/adapter/flutter_adapter/README.md
@@ -14,20 +14,8 @@ This complex example includes these implementations:
 
 ### Online demo:
 Click on the picture to see a [demo](https://refactoringguru.github.io/design-patterns-dart/#/adapter/flutter_adapter).
-[![image](https://user-images.githubusercontent.com/8049534/152689272-d4bed484-e216-4eda-8833-928ada7d4051.png)](https://refactoringguru.github.io/design-patterns-dart/#/adapter/flutter_adapter)
-
-### Diagram:
-![image](https://user-images.githubusercontent.com/8049534/152753162-1b9006ad-a633-4132-91b6-bb348559adec.png)
-
-### Sequence [Classic application -> Change Text color]
-When user clicked to "Flutter Adapter" text. 
 
-![image](https://user-images.githubusercontent.com/8049534/152753714-84af5abd-85c0-4845-af2d-616f512ef633.png)
-
-### Sequence [Flutter Widget -> Change Text color]
-When the user has selected a color in the color bar.
-
-![image](https://user-images.githubusercontent.com/8049534/152753870-edeab3ae-8e79-4e9d-9049-7cd5a2100afa.png)
+[![image](https://user-images.githubusercontent.com/8049534/152689272-d4bed484-e216-4eda-8833-928ada7d4051.png)](https://refactoringguru.github.io/design-patterns-dart/#/adapter/flutter_adapter)
 
 ### Client code:
 ```dart
@@ -56,5 +44,17 @@ void main() {
     classicApp: app,
   );
 }
-
 ```
+
+### Diagram:
+![image](https://user-images.githubusercontent.com/8049534/152753162-1b9006ad-a633-4132-91b6-bb348559adec.png)
+
+### Sequence [Classic application -> Change Text color]
+When user clicked to "Flutter Adapter" text. 
+
+![image](https://user-images.githubusercontent.com/8049534/152753714-84af5abd-85c0-4845-af2d-616f512ef633.png)
+
+### Sequence [Flutter Widget -> Change Text color]
+When the user has selected a color in the color bar.
+
+![image](https://user-images.githubusercontent.com/8049534/152753870-edeab3ae-8e79-4e9d-9049-7cd5a2100afa.png)
diff --git a/patterns/bridge/devices_remote_control/README.md b/patterns/bridge/devices_remote_control/README.md
@@ -2,13 +2,37 @@
 This example rewrite from [java example](https://github.com/RefactoringGuru/design-patterns-java/tree/master/src/refactoring_guru/bridge/example)
 But removed the ability to use null for devices. Instead, the EmptyDevice class is used.
 
-**Diagram:**
+### Remote device example
+
+Example describe this: https://refactoring.guru/design-patterns/bridge?#pseudocode
+
+### Diagram:
 
 ![image](https://user-images.githubusercontent.com/8049534/145878324-3cbc52f5-51f4-4642-921d-69fbe2886f8c.png)
 
-**Description:**
+### Client code:
+```dart
+void main() {
+  testDevice(Tv());
+  testDevice(Radio());
+  testDevice(EmptyDevice());
+}
 
-https://refactoring.guru/design-patterns/bridge?#pseudocode
+void testDevice(Device device) {
+  print(''.padRight(36, '='));
+  print(device.runtimeType);
+  print("Tests with basic remote.");
+  final basicRemote = BasicRemote.fromDevice(device);
+  basicRemote.power();
+  device.printStatus();
+
+  print("Tests with advanced remote.");
+  final advancedRemote = AdvancedRemote.fromDevice(device);
+  advancedRemote.power();
+  advancedRemote.mute();
+  device.printStatus();
+}
+```
 
 **Output:**
 
diff --git a/patterns/builder/color_text_format/README.md b/patterns/builder/color_text_format/README.md
@@ -8,7 +8,7 @@ https://refactoring.guru/design-patterns/builder
 Using different text formats. 
 
 ### Class diagram
-![image](https://user-images.githubusercontent.com/8049534/146023073-5d7644a4-d3b9-4420-bffe-f72ac3fd83dd.png)
+![image](https://user-images.githubusercontent.com/8049534/152780645-4eed27fc-a483-432e-99b0-4a77f2adbd5d.png)
 
 ### Client code:
 ```dart
diff --git a/patterns/command/text_editor/README.md b/patterns/command/text_editor/README.md
@@ -17,7 +17,7 @@ But slightly changed, see the class diagram.
 ## Diagram:
 ![image](https://user-images.githubusercontent.com/8049534/149918792-fccae912-2e67-4068-88d1-5cf824f0df2c.png)
 
-## Client code:
+### Client code:
 ```dart
 void main() {
   final app = Application();
diff --git a/patterns/command/text_editor/application/editor.dart b/patterns/command/text_editor/application/editor.dart
@@ -62,16 +62,10 @@ class Editor {
 
   @override
   String toString() {
-    return cursor.isTextSelected
-        ? _text.replaceRange(
-            cursor.startSelection,
-            cursor.endSelection,
-            '[$selectedText]',
-          )
-        : _text.replaceRange(
-            cursor.position,
-            cursor.position,
-            '|',
-          );
+    return _text.replaceRange(
+      cursor.startSelection,
+      cursor.endSelection,
+      cursor.isTextSelected ? '[$selectedText]' : '|',
+    );
   }
 }
diff --git a/patterns/composite/image_editor/README.md b/patterns/composite/image_editor/README.md
@@ -7,10 +7,10 @@ https://refactoring.guru/design-patterns/composite?#pseudocode
 ## Origin source code:
 This example rewrite from [java example](https://github.com/RefactoringGuru/design-patterns-java/tree/master/src/refactoring_guru/composite/example)
 
-## Diagram:
+### Diagram:
 ![image](https://user-images.githubusercontent.com/8049534/149174388-25ca21b1-d762-40b5-a853-528abe18b66c.png)
 
-**Client code:**
+### Client code:
 ```dart
 void main() {
   final editor = ImageEditor();
diff --git a/patterns/composite/products_and_boxes/README.md b/patterns/composite/products_and_boxes/README.md
@@ -2,9 +2,14 @@
 Composite is a structural design pattern that lets you compose objects into tree structures and then
 work with these structures as if they were individual objects.
 
-## Problem description:
+## Example: Products and boxes
 ![problem-en](https://user-images.githubusercontent.com/8049534/147579298-0c60c4a7-6acb-4ab3-a973-e06524c5a061.png)
-https://refactoring.guru/design-patterns/composite?#problem
+
+For example, imagine that you have two types of objects: Products and Boxes. A Box can contain 
+several Products as well as a number of smaller Boxes. These little Boxes can also hold some 
+Products or even smaller Boxes, and so on.
+
+Full description can be found [here](https://refactoring.guru/design-patterns/composite?#problem)
 
 ### Folder description:
 - `/products` - represent product and box (composite pattern)
diff --git a/patterns/composite/products_and_boxes/diagram/diagram.dart b/patterns/composite/products_and_boxes/diagram/diagram.dart
@@ -1,5 +1,4 @@
 import 'package:design_patterns_dart/text_canvas.dart';
-import 'package:design_patterns_dart/text_canvas/primitives.dart';
 
 import '../products/product.dart';
 import '../render_elements/render_connecting_lines.dart';
diff --git a/patterns/composite/products_and_boxes/render_elements/render_connecting_lines.dart b/patterns/composite/products_and_boxes/render_elements/render_connecting_lines.dart
@@ -1,6 +1,4 @@
 import 'package:design_patterns_dart/text_canvas.dart';
-import 'package:design_patterns_dart/text_canvas/canvas.dart';
-import 'package:design_patterns_dart/text_canvas/primitives.dart';
 
 import '../render_elements/render_column.dart';
 import 'render_element.dart';
diff --git a/patterns/composite/products_and_boxes/render_elements/render_text.dart b/patterns/composite/products_and_boxes/render_elements/render_text.dart
@@ -1,5 +1,4 @@
 import 'package:design_patterns_dart/text_canvas.dart';
-import 'package:design_patterns_dart/text_canvas/primitives.dart';
 
 import 'render_element.dart';
 
diff --git a/patterns/decorator/data_source_decoder/README.md b/patterns/decorator/data_source_decoder/README.md
@@ -1,13 +1,15 @@
 # Pattern Decorator
 Decorator is a structural design pattern that lets you attach new behaviors to objects by placing these objects inside special wrapper objects that contain the behaviors.
 
-## Example Description:
-https://refactoring.guru/design-patterns/decorator?#pseudocode
+## Data source decoder example
+In this example, the Decorator pattern lets you compress and encrypt sensitive data independently 
+from the code that actually uses this data.
+
+Full description can be found [here](https://refactoring.guru/design-patterns/decorator?#pseudocode)
 
 ### Diagram:
 ![image](https://user-images.githubusercontent.com/8049534/148954932-edc22d7b-becd-4e2f-bae8-d0d8200d8918.png)
 
-
 ### Client code:
 ```dart
 void main() {
diff --git a/patterns/memento/conceptual/app/command.dart b/patterns/memento/conceptual/app/command.dart
@@ -0,0 +1,25 @@
+import 'editor.dart';
+import 'snapshot.dart';
+
+/// EN: A command object can act as a caretaker. In that case, the
+/// command gets a memento just before it changes the
+/// originator's state. When undo is requested, it restores the
+/// originator's state from a memento.
+///
+/// RU: Опекуном может выступать класс команд (см. паттерн Команда).
+/// В этом случае команда сохраняет снимок состояния объекта-
+/// получателя, перед тем как передать ему своё действие. А в
+/// случае отмены команда вернёт объект в прежнее состояние.
+class Command {
+  Snapshot _backup;
+
+  Command._(this._backup);
+
+  factory Command.makeBackup(Editor editor) {
+    return Command._(editor.createSnapshot());
+  }
+
+  void undo() {
+    _backup.restore();
+  }
+}
diff --git a/patterns/memento/conceptual/app/editor.dart b/patterns/memento/conceptual/app/editor.dart
@@ -0,0 +1,28 @@
+import 'snapshot.dart';
+
+/// EN: The originator holds some important data that may change over
+/// time. It also defines a method for saving its state inside a
+/// memento and another method for restoring the state from it.
+///
+/// RU: Класс создателя должен иметь специальный метод, который.
+/// сохраняет состояние создателя в новом объекте-снимке.
+class Editor {
+  var text = '';
+  var curX = 0;
+  var curY = 0;
+  var selectionWidth = 0;
+
+  Editor(this.text);
+
+  /// EN: Saves the current state inside a memento.
+  Snapshot createSnapshot() {
+    /// EN: Memento is an immutable object; that's why the
+    /// originator passes its state to the memento's
+    /// constructor parameters.
+    ///
+    /// RU: Снимок — неизменяемый объект, поэтому Создатель
+    /// передаёт все своё состояние через параметры
+    /// конструктора.
+    return Snapshot(this, text, curX, curY, selectionWidth);
+  }
+}
diff --git a/patterns/memento/conceptual/app/snapshot.dart b/patterns/memento/conceptual/app/snapshot.dart
@@ -0,0 +1,33 @@
+import 'editor.dart';
+
+/// EN: The memento class stores the past state of the editor.
+///
+/// RU: Снимок хранит прошлое состояние редактора.
+class Snapshot {
+  final Editor _editor;
+  final String _text;
+  final int _curX;
+  final int _curY;
+  final int _selectionWidth;
+
+  Snapshot(
+      this._editor,
+      this._text,
+      this._curX,
+      this._curY,
+      this._selectionWidth,
+      );
+
+  /// EN: At some point, a previous state of the editor can be
+  /// restored using a memento object.
+  ///
+  /// RU: В нужный момент владелец снимка может восстановить
+  /// состояние редактора.
+  void restore() {
+    _editor
+      ..text = _text
+      ..curX = _curX
+      ..curY = _curY
+      ..selectionWidth = _selectionWidth;
+  }
+}
diff --git a/patterns/memento/conceptual/main.dart b/patterns/memento/conceptual/main.dart
diff --git a/patterns/observer/app_observer/README.md b/patterns/observer/app_observer/README.md
diff --git a/patterns/observer/app_observer/main.dart b/patterns/observer/app_observer/main.dart
diff --git a/patterns/observer/subscriber_flutter_widget/README.md b/patterns/observer/subscriber_flutter_widget/README.md
diff --git a/patterns/observer/subscriber_flutter_widget/main.dart b/patterns/observer/subscriber_flutter_widget/main.dart
diff --git a/patterns/observer/subscriber_flutter_widget/widgets/hash_generator_widget.dart b/patterns/observer/subscriber_flutter_widget/widgets/hash_generator_widget.dart
diff --git a/pubspec.yaml b/pubspec.yaml

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,4 @@`
`1`	`1`	`import 'package:design_patterns_dart/text_canvas.dart';`
`2`		`-import 'package:design_patterns_dart/text_canvas/primitives.dart';`
`3`	`2`
`4`	`3`	`import '../products/product.dart';`
`5`	`4`	`import '../render_elements/render_connecting_lines.dart';`