Merge pull request #142 from php-school/builder-namesapce

AydinHassan · web-flow · commit bd1249d6d11a · 2018-05-14T17:13:50.000+02:00
Builder namespace
diff --git a/README.md b/README.md
@@ -25,6 +25,7 @@
 
   * [Minimum Requirements](#minimum-requirements)
   * [Installation](#installation)
+  * [Upgrading](#upgrading)
   * [Usage](#usage)
     * [Quick Setup](#quick-setup)
     * [Examples](#examples)
@@ -75,6 +76,11 @@
 composer require php-school/cli-menu
 ```
 
+## Upgrading
+
+Please refer to the [Upgrade Documentation](UPGRADE.md) documentation to see what is required to upgrade your installed 
+`cli-menu` version.
+
 ## Usage
 
 ### Quick Setup
@@ -740,7 +746,7 @@ below we change the background color on the flash to green.
 
 ```php
 use PhpSchool\CliMenu\CliMenu;
-use PhpSchool\CliMenu\CliMenuBuilder;
+use PhpSchool\CliMenu\Builder\CliMenuBuilder;
 
 require_once(__DIR__ . '/../vendor/autoload.php');
     
@@ -768,7 +774,7 @@ text can be customised.
 
 ```php
 use PhpSchool\CliMenu\CliMenu;
-use PhpSchool\CliMenu\CliMenuBuilder;
+use PhpSchool\CliMenu\Builder\CliMenuBuilder;
 
 require_once(__DIR__ . '/../vendor/autoload.php');
 
@@ -808,7 +814,7 @@ placeholder text (the default is empty) and the validation failed text (the defa
 <?php
 
 use PhpSchool\CliMenu\CliMenu;
-use PhpSchool\CliMenu\CliMenuBuilder;
+use PhpSchool\CliMenu\Builder\CliMenuBuilder;
 
 require_once(__DIR__ . '/../vendor/autoload.php');
 
@@ -844,7 +850,7 @@ When entering a number you can use the up/down keys to increment and decrement t
 <?php
 
 use PhpSchool\CliMenu\CliMenu;
-use PhpSchool\CliMenu\CliMenuBuilder;
+use PhpSchool\CliMenu\Builder\CliMenuBuilder;
 
 require_once(__DIR__ . '/../vendor/autoload.php');
 
@@ -881,7 +887,7 @@ Ask for a password with the default validation:
 <?php
 
 use PhpSchool\CliMenu\CliMenu;
-use PhpSchool\CliMenu\CliMenuBuilder;
+use PhpSchool\CliMenu\Builder\CliMenuBuilder;
 
 require_once(__DIR__ . '/../vendor/autoload.php');
 
@@ -918,7 +924,7 @@ password is longer than 20 characters.
 <?php
 
 use PhpSchool\CliMenu\CliMenu;
-use PhpSchool\CliMenu\CliMenuBuilder;
+use PhpSchool\CliMenu\Builder\CliMenuBuilder;
 
 require_once(__DIR__ . '/../vendor/autoload.php');
 
@@ -951,7 +957,7 @@ Ask for a password with custom validation and set the validation failure message
 <?php
 
 use PhpSchool\CliMenu\CliMenu;
-use PhpSchool\CliMenu\CliMenuBuilder;
+use PhpSchool\CliMenu\Builder\CliMenuBuilder;
 
 require_once(__DIR__ . '/../vendor/autoload.php');
 
@@ -997,7 +1003,7 @@ your menu item actions like so:
 <?php
 
 use PhpSchool\CliMenu\CliMenu;
-use PhpSchool\CliMenu\CliMenuBuilder;
+use PhpSchool\CliMenu\Builder\CliMenuBuilder;
 use PhpSchool\CliMenu\Input\Text;
 use PhpSchool\CliMenu\Input\InputIO;
 
@@ -1041,7 +1047,7 @@ you can build up a `MenuStyle` object and pass it to the dialogue and input meth
 
 ```php
 use PhpSchool\CliMenu\CliMenu;
-use PhpSchool\CliMenu\CliMenuBuilder;
+use PhpSchool\CliMenu\Builder\CliMenuBuilder;
 
 require_once(__DIR__ . '/../vendor/autoload.php');
 
diff --git a/UPGRADE.md b/UPGRADE.md
@@ -0,0 +1,14 @@
+# Upgrade Documentation
+
+This document serves as a reference to upgrade your current cli-menu installation if improvements, deprecations
+or backwards compatibility (BC) breakages occur.
+
+## 3.0.0
+
+### BC breaks
+
+* Class `PhpSchool\CliMenu\CliMenuBuilder` has been moved, use 
+  `PhpSchool\CliMenu\Builder\CliMenuBuilder` instead. The old class has been aliased for now, but will be removed in 
+  `3.1`.
+* Removed `PhpSchool\CliMenu\Terminal` namespace, the code has been migrated to the `php-school/terminal` package and is 
+  largely modified.
diff --git a/composer.json b/composer.json
@@ -27,7 +27,8 @@
     "autoload" : {
         "psr-4" : {
             "PhpSchool\\CliMenu\\": "src"
-        }
+        },
+        "files": ["src/deprecated.php"]
     },
     "autoload-dev": {
         "psr-4": { "PhpSchool\\CliMenuTest\\": "test/" }
diff --git a/examples/ascii-art.php b/examples/ascii-art.php
@@ -1,7 +1,7 @@
 <?php
 
 use PhpSchool\CliMenu\CliMenu;
-use PhpSchool\CliMenu\CliMenuBuilder;
+use PhpSchool\CliMenu\Builder\CliMenuBuilder;
 
 require_once(__DIR__ . '/../vendor/autoload.php');
 
diff --git a/examples/basic-centered.php b/examples/basic-centered.php
@@ -1,7 +1,7 @@
 <?php
 
 use PhpSchool\CliMenu\CliMenu;
-use PhpSchool\CliMenu\CliMenuBuilder;
+use PhpSchool\CliMenu\Builder\CliMenuBuilder;
 
 require_once(__DIR__ . '/../vendor/autoload.php');
 
diff --git a/examples/basic-separation.php b/examples/basic-separation.php
@@ -1,7 +1,7 @@
 <?php
 
 use PhpSchool\CliMenu\CliMenu;
-use PhpSchool\CliMenu\CliMenuBuilder;
+use PhpSchool\CliMenu\Builder\CliMenuBuilder;
 
 require_once(__DIR__ . '/../vendor/autoload.php');
 
diff --git a/examples/basic.php b/examples/basic.php
@@ -1,7 +1,7 @@
 <?php
 
 use PhpSchool\CliMenu\CliMenu;
-use PhpSchool\CliMenu\CliMenuBuilder;
+use PhpSchool\CliMenu\Builder\CliMenuBuilder;
 
 require_once(__DIR__ . '/../vendor/autoload.php');
 
diff --git a/examples/borders.php b/examples/borders.php
@@ -1,7 +1,7 @@
 <?php
 
 use PhpSchool\CliMenu\CliMenu;
-use PhpSchool\CliMenu\CliMenuBuilder;
+use PhpSchool\CliMenu\Builder\CliMenuBuilder;
 
 require_once(__DIR__ . '/../vendor/autoload.php');
 
diff --git a/examples/confirm.php b/examples/confirm.php
@@ -1,7 +1,7 @@
 <?php
 
 use PhpSchool\CliMenu\CliMenu;
-use PhpSchool\CliMenu\CliMenuBuilder;
+use PhpSchool\CliMenu\Builder\CliMenuBuilder;
 
 require_once(__DIR__ . '/../vendor/autoload.php');
 
diff --git a/examples/crazy-redraw.php b/examples/crazy-redraw.php
@@ -1,7 +1,7 @@
 <?php
 
 use PhpSchool\CliMenu\CliMenu;
-use PhpSchool\CliMenu\CliMenuBuilder;
+use PhpSchool\CliMenu\Builder\CliMenuBuilder;
 use PhpSchool\CliMenu\MenuItem\LineBreakItem;
 use PhpSchool\CliMenu\MenuItem\MenuItemInterface;
 
diff --git a/examples/crazy-separation.php b/examples/crazy-separation.php
@@ -1,7 +1,7 @@
 <?php
 
 use PhpSchool\CliMenu\CliMenu;
-use PhpSchool\CliMenu\CliMenuBuilder;
+use PhpSchool\CliMenu\Builder\CliMenuBuilder;
 
 require_once(__DIR__ . '/../vendor/autoload.php');
 
diff --git a/examples/custom-mapping.php b/examples/custom-mapping.php
@@ -1,7 +1,7 @@
 <?php
 
 use PhpSchool\CliMenu\CliMenu;
-use PhpSchool\CliMenu\CliMenuBuilder;
+use PhpSchool\CliMenu\Builder\CliMenuBuilder;
 
 require_once(__DIR__ . '/../vendor/autoload.php');
 
diff --git a/examples/custom-styles.php b/examples/custom-styles.php
@@ -1,7 +1,7 @@
 <?php
 
 use PhpSchool\CliMenu\CliMenu;
-use PhpSchool\CliMenu\CliMenuBuilder;
+use PhpSchool\CliMenu\Builder\CliMenuBuilder;
 
 require_once(__DIR__ . '/../vendor/autoload.php');
 
diff --git a/examples/disabled-items.php b/examples/disabled-items.php
@@ -1,7 +1,7 @@
 <?php
 
 use PhpSchool\CliMenu\CliMenu;
-use PhpSchool\CliMenu\CliMenuBuilder;
+use PhpSchool\CliMenu\Builder\CliMenuBuilder;
 
 require_once(__DIR__ . '/../vendor/autoload.php');
 
diff --git a/examples/flash.php b/examples/flash.php
@@ -1,7 +1,7 @@
 <?php
 
 use PhpSchool\CliMenu\CliMenu;
-use PhpSchool\CliMenu\CliMenuBuilder;
+use PhpSchool\CliMenu\Builder\CliMenuBuilder;
 
 require_once(__DIR__ . '/../vendor/autoload.php');
 
diff --git a/examples/input-advanced.php b/examples/input-advanced.php
@@ -1,7 +1,7 @@
 <?php
 
 use PhpSchool\CliMenu\CliMenu;
-use PhpSchool\CliMenu\CliMenuBuilder;
+use PhpSchool\CliMenu\Builder\CliMenuBuilder;
 
 require_once(__DIR__ . '/../vendor/autoload.php');
 
diff --git a/examples/input-custom.php b/examples/input-custom.php
@@ -1,7 +1,7 @@
 <?php
 
 use PhpSchool\CliMenu\CliMenu;
-use PhpSchool\CliMenu\CliMenuBuilder;
+use PhpSchool\CliMenu\Builder\CliMenuBuilder;
 use PhpSchool\CliMenu\Input\Text;
 use PhpSchool\CliMenu\Input\InputIO;
 use PhpSchool\CliMenu\MenuStyle;
diff --git a/examples/input-number.php b/examples/input-number.php
@@ -1,7 +1,7 @@
 <?php
 
 use PhpSchool\CliMenu\CliMenu;
-use PhpSchool\CliMenu\CliMenuBuilder;
+use PhpSchool\CliMenu\Builder\CliMenuBuilder;
 
 require_once(__DIR__ . '/../vendor/autoload.php');
 
diff --git a/examples/input-password.php b/examples/input-password.php
@@ -1,7 +1,7 @@
 <?php
 
 use PhpSchool\CliMenu\CliMenu;
-use PhpSchool\CliMenu\CliMenuBuilder;
+use PhpSchool\CliMenu\Builder\CliMenuBuilder;
 
 require_once(__DIR__ . '/../vendor/autoload.php');
 
diff --git a/examples/input-text.php b/examples/input-text.php
@@ -1,7 +1,7 @@
 <?php
 
 use PhpSchool\CliMenu\CliMenu;
-use PhpSchool\CliMenu\CliMenuBuilder;
+use PhpSchool\CliMenu\Builder\CliMenuBuilder;
 
 require_once(__DIR__ . '/../vendor/autoload.php');
 
diff --git a/examples/item-extra.php b/examples/item-extra.php
@@ -1,7 +1,7 @@
 <?php
 
 use PhpSchool\CliMenu\CliMenu;
-use PhpSchool\CliMenu\CliMenuBuilder;
+use PhpSchool\CliMenu\Builder\CliMenuBuilder;
 
 require_once(__DIR__ . '/../vendor/autoload.php');
 
diff --git a/examples/nested-submenu.php b/examples/nested-submenu.php
@@ -1,7 +1,7 @@
 <?php
 
 use PhpSchool\CliMenu\CliMenu;
-use PhpSchool\CliMenu\CliMenuBuilder;
+use PhpSchool\CliMenu\Builder\CliMenuBuilder;
 
 require_once(__DIR__ . '/../vendor/autoload.php');
 
diff --git a/examples/redraw.php b/examples/redraw.php
@@ -1,7 +1,7 @@
 <?php
 
 use PhpSchool\CliMenu\CliMenu;
-use PhpSchool\CliMenu\CliMenuBuilder;
+use PhpSchool\CliMenu\Builder\CliMenuBuilder;
 
 require_once(__DIR__ . '/../vendor/autoload.php');
 
diff --git a/examples/remove-defaults.php b/examples/remove-defaults.php
@@ -1,7 +1,7 @@
 <?php
 
 use PhpSchool\CliMenu\CliMenu;
-use PhpSchool\CliMenu\CliMenuBuilder;
+use PhpSchool\CliMenu\Builder\CliMenuBuilder;
 
 require_once(__DIR__ . '/../vendor/autoload.php');
 
diff --git a/examples/split-item.php b/examples/split-item.php
@@ -1,7 +1,7 @@
 <?php
 
 use PhpSchool\CliMenu\CliMenu;
-use PhpSchool\CliMenu\CliMenuBuilder;
+use PhpSchool\CliMenu\Builder\CliMenuBuilder;
 
 require_once(__DIR__ . '/../vendor/autoload.php');
 
diff --git a/examples/submenu.php b/examples/submenu.php
@@ -1,7 +1,7 @@
 <?php
 
 use PhpSchool\CliMenu\CliMenu;
-use PhpSchool\CliMenu\CliMenuBuilder;
+use PhpSchool\CliMenu\Builder\CliMenuBuilder;
 
 require_once(__DIR__ . '/../vendor/autoload.php');
 
diff --git a/examples/toggle-item-extra.php b/examples/toggle-item-extra.php
@@ -1,7 +1,7 @@
 <?php
 
 use PhpSchool\CliMenu\CliMenu;
-use PhpSchool\CliMenu\CliMenuBuilder;
+use PhpSchool\CliMenu\Builder\CliMenuBuilder;
 use PhpSchool\CliMenu\MenuItem\MenuItemInterface;
 
 require_once(__DIR__ . '/../vendor/autoload.php');
diff --git a/examples/useful-separation.php b/examples/useful-separation.php
@@ -1,7 +1,7 @@
 <?php
 
 use PhpSchool\CliMenu\CliMenu;
-use PhpSchool\CliMenu\CliMenuBuilder;
+use PhpSchool\CliMenu\Builder\CliMenuBuilder;
 use PhpSchool\CliMenu\MenuItem\MenuItem;
 
 require_once(__DIR__ . '/../vendor/autoload.php');
diff --git a/src/Builder/Builder.php b/src/Builder/Builder.php
@@ -1,7 +1,8 @@
 <?php
 
-namespace PhpSchool\CliMenu;
+namespace PhpSchool\CliMenu\Builder;
 
+use PhpSchool\CliMenu\MenuStyle;
 use PhpSchool\Terminal\Terminal;
 
 /**
diff --git a/src/Builder/BuilderUtils.php b/src/Builder/BuilderUtils.php
@@ -1,6 +1,6 @@
 <?php
 
-namespace PhpSchool\CliMenu;
+namespace PhpSchool\CliMenu\Builder;
 
 use PhpSchool\CliMenu\MenuItem\LineBreakItem;
 use PhpSchool\CliMenu\MenuItem\MenuMenuItem;
diff --git a/src/Builder/CliMenuBuilder.php b/src/Builder/CliMenuBuilder.php
@@ -1,16 +1,15 @@
 <?php
 
-namespace PhpSchool\CliMenu;
+namespace PhpSchool\CliMenu\Builder;
 
 use PhpSchool\CliMenu\Action\ExitAction;
 use PhpSchool\CliMenu\Action\GoBackAction;
 use PhpSchool\CliMenu\MenuItem\AsciiArtItem;
-use PhpSchool\CliMenu\MenuItem\LineBreakItem;
 use PhpSchool\CliMenu\MenuItem\MenuItemInterface;
-use PhpSchool\CliMenu\MenuItem\MenuMenuItem;
 use PhpSchool\CliMenu\MenuItem\SelectableItem;
 use PhpSchool\CliMenu\MenuItem\SplitItem;
-use PhpSchool\CliMenu\MenuItem\StaticItem;
+use PhpSchool\CliMenu\CliMenu;
+use PhpSchool\CliMenu\MenuStyle;
 use PhpSchool\CliMenu\Terminal\TerminalFactory;
 use PhpSchool\CliMenu\Util\ColourUtil;
 use PhpSchool\Terminal\Terminal;
diff --git a/src/Builder/SplitItemBuilder.php b/src/Builder/SplitItemBuilder.php
diff --git a/src/deprecated.php b/src/deprecated.php
