Fix menu UI and rewrite CLI usage

Fixes #67 #65 #64 #63

Author: SMillerDev

.travis.yml

@@ -14,16 +14,15 @@ matrix:
 before_script:
 - travis_retry composer self-update
 - travis_retry composer install --no-interaction --prefer-source --dev
-- if [[ ${TRAVIS_PHP_VERSION:0:3} == "5.6" ]]; then pecl install runkit; else pecl install uopz; fi
-- if [[ ${TRAVIS_PHP_VERSION:0:3} == "5.6" ]]; then echo "runkit.internal_override=1" >> ~/.phpenv/versions/$(phpenv version-name)/etc/php.ini; fi
+- pecl install uopz
 - export PATH=$PATH:$PWD
 script: vendor/bin/phpunit --configuration tests/phpunit.xml --coverage-clover=coverage.xml
 
 after_success:
     - bash <(curl -s https://codecov.io/bash)
 
 before_deploy:
-- ant phar
+- ./vendor/bin/phing phar
 - sha256sum build/out/*
 deploy:
   provider: releases
@@ -35,4 +34,4 @@ deploy:
   on:
     tags: true
 after_deploy:
-  - ant clean
+  - ./vendor/bin/phing clean

build.xml

@@ -78,6 +78,11 @@
                 <include name="**/*.php"/>
             </fileset>
         </copy>
+        <copy todir="${basedir}/build/phar/phpdraft/src/Garden/Cli">
+            <fileset dir="vendor/vanilla/garden-cli/src">
+                <include name="**/*.php"/>
+            </fileset>
+        </copy>
         <copy todir="${basedir}/build/phar/phpdraft">
             <fileset dir="${basedir}">
                 <include name="**/phpdraft"/>

composer.json

@@ -19,15 +19,18 @@
   ],
   "require": {
     "php": "~7.1",
-    "ql/uri-template": "1.*",
-    "michelf/php-markdown": "1.*",
-    "lukasoppermann/http-status": "2.*",
-    "ext-json": "*"
+    "ql/uri-template": "~1.0",
+    "vanilla/garden-cli": "~2.0",
+    "michelf/php-markdown": "~1.8",
+    "lukasoppermann/http-status": "~2.0",
+    "ext-json": "*",
+    "ext-curl": "*"
   },
   "require-dev": {
     "lunr/halo": "*",
     "phpunit/phpunit": "~7.0",
-    "theseer/autoload": "1.*"
+    "theseer/autoload": "~1.0",
+    "phing/phing": "~2.0"
   },
   "autoload": {
     "psr-4": { "PHPDraft\\": "src/PHPDraft" }

phpdraft

@@ -12,16 +12,44 @@ set_include_path(get_include_path() . ":" . __DIR__ . '/src/');
 //require_once 'PHPDraft/Core/Autoloader.php';
 require_once 'vendor/autoload.php';
 
+use Garden\Cli\Cli;
 use PHPDraft\In\ApibFileParser;
-use PHPDraft\Out\UI;
+use PHPDraft\Out\Sorting;
+use PHPDraft\Out\Version;
+use PHPDraft\Parse\ExecutionException;
 use PHPDraft\Parse\JsonToHTML;
 use PHPDraft\Parse\ParserFactory;
+use PHPDraft\Parse\ResourceException;
 
 define('VERSION', '0');
 try
 {
-    $values  = UI::main($argv);
-    $apib    = new ApibFileParser($values['file']);
+    // Define the cli options.
+    $cli = new Cli();
+    $cli->description('Parse API Blueprint files.')
+        ->opt('file:f', 'Specifies the file to parse.', true, 'string')
+        ->opt('yes:y', 'Always accept using the online mode.', false)
+        ->opt('online:o', 'Always use the online mode.', false)
+        ->opt('template:t', 'Specifies the template to use. (defaults to \'default\').', false, 'string')
+        ->opt('sort:s', 'Sort displayed values [All|None|Structures|Webservices] (defaults to the way the objects are in the file).', false, 'string')
+        ->opt('header_image:i', 'Specifies an image to display in the header.', false, 'string')
+        ->opt('css:c', 'Specifies a CSS file to include (value is put in a link element without checking).', false, 'string')
+        ->opt('javascript:j', 'Specifies a JS file to include (value is put in a script element without checking).', false, 'string')
+        ->opt('version:v', 'Print the version for PHPDraft.', false);
+
+    // Parse and return cli args.
+    $args = $cli->parse($argv, FALSE);
+    if (isset($args['version'])) {
+        Version::version();
+        throw new ExecutionException('', 0);
+    }
+
+    define('THIRD_PARTY_ALLOWED', getenv('PHPDRAFT_THIRD_PARTY') !== '0');
+    if ((isset($args['y']) || isset($args['o'])) && THIRD_PARTY_ALLOWED) {
+        define('DRAFTER_ONLINE_MODE', 1);
+    }
+
+    $apib    = new ApibFileParser($args->getOpt('file'));
     $apib    = $apib->parse();
     $offline = FALSE;
     $online  = FALSE;
@@ -31,17 +59,31 @@ try
         $parser = ParserFactory::get();
         $parser = $parser->init($apib);
     }
-    catch (\PHPDraft\Parse\ResourceException $exception)
+    catch (ResourceException $exception)
     {
         file_put_contents('php://stderr', "No drafter available.\n");
         return;
     }
 
     $html          = new JsonToHTML($parser->parseToJson());
-    $html->sorting = $values['sorting'];
-    $generator     = $html->get_html($values['template'], $values['image'], $values['css'], $values['js']);
+    $name          = 'PHPD_SORT_' . strtoupper($args->getOpt('sort', ''));
+    $html->sorting = Sorting::${$name} ?? -1;
+
+    $color1        = getenv('COLOR_PRIMARY') === FALSE ? NULL : getenv('COLOR_PRIMARY');
+    $color2        = getenv('COLOR_SECONDARY') === FALSE ? NULL : getenv('COLOR_SECONDARY');
+    $colors        = (is_null($color1) || is_null($color2)) ? '' : '__' . $color1 . '__' . $color2;
+    $generator     = $html->get_html(
+            $args->getOpt('template', 'default') . $colors,
+            $args['header_image'],
+            $args['css'],
+            $args['javascript']);
+}
+catch (ExecutionException $exception)
+{
+    file_put_contents('php://stderr', $exception->getMessage() . PHP_EOL);
+    exit($exception->getCode());
 }
-catch (\PHPDraft\Parse\ExecutionException $exception)
+catch (Exception $exception)
 {
     file_put_contents('php://stderr', $exception->getMessage() . PHP_EOL);
     exit($exception->getCode());

src/PHPDraft/In/ApibFileParser.php

@@ -42,7 +42,7 @@ class ApibFileParser
      *
      * @param string $filename File to parse
      */
-    public function __construct($filename = 'index.apib')
+    public function __construct(string $filename = 'index.apib')
     {
         $this->filename = $filename;
         $this->location = pathinfo($this->filename, PATHINFO_DIRNAME) . '/';
@@ -53,9 +53,11 @@ public function __construct($filename = 'index.apib')
     /**
      * Get parse the apib file.
      *
+     * @throws ExecutionException
+     *
      * @return $this self reference.
      */
-    public function parse()
+    public function parse(): self
     {
         $this->full_apib = $this->get_apib($this->filename, $this->location);
 
@@ -73,7 +75,7 @@ public function parse()
      *
      * @return string The full API blueprint file.
      */
-    private function get_apib($filename, $rel_path = NULL)
+    private function get_apib(string $filename, ?string $rel_path = NULL): string
     {
         $path    = $this->file_path($filename, $rel_path);
         $file    = file_get_contents($path);
@@ -95,22 +97,22 @@ private function get_apib($filename, $rel_path = NULL)
     /**
      * Check if an APIB file exists.
      *
-     * @param string $filename File to check
+     * @param string      $filename File to check
      * @param string|null $rel_path File location to look.
      *
      * @throws ExecutionException when the file could not be found.
      *
      * @return string
      */
-    private function file_path($filename, $rel_path = NULL)
+    private function file_path(string $filename, ?string $rel_path = NULL): string
     {
         // Absolute path
         if (file_exists($filename)) {
             return $filename;
         }
 
         // Path relative to the top file
-        if ($rel_path !== null && file_exists($rel_path . $filename)) {
+        if ($rel_path !== NULL && file_exists($rel_path . $filename)) {
             return $rel_path . $filename;
         }
 
@@ -134,7 +136,7 @@ private function file_path($filename, $rel_path = NULL)
      *
      * @return string The schema as a string
      */
-    private function get_schema($url)
+    private function get_schema(string $url): string
     {
         $ch = curl_init();
         curl_setopt($ch, CURLOPT_URL, $url);
@@ -151,7 +153,7 @@ private function get_schema($url)
      *
      * @return string
      */
-    public function __toString()
+    public function __toString(): string
     {
         return $this->full_apib;
     }

src/PHPDraft/Model/Category.php

@@ -10,6 +10,7 @@
 namespace PHPDraft\Model;
 
 use PHPDraft\Model\Elements\ObjectStructureElement;
+use stdClass;
 
 /**
  * Class Category.
@@ -26,11 +27,11 @@ class Category extends HierarchyElement
     /**
      * Fill class values based on JSON object.
      *
-     * @param \stdClass $object JSON object
+     * @param stdClass $object JSON object
      *
      * @return $this self-reference
      */
-    public function parse($object)
+    public function parse(stdClass $object)
     {
         parent::parse($object);
         foreach ($object->content as $item) {

src/PHPDraft/Model/Comparable.php

@@ -17,5 +17,5 @@ interface Comparable
      *
      * @return bool
      */
-    public function is_equal_to($b);
+    public function is_equal_to($b): bool;
 }

src/PHPDraft/Model/Elements/ArrayStructureElement.php

@@ -22,7 +22,7 @@ class ArrayStructureElement extends BasicStructureElement
      *
      * @return self Self reference
      */
-    public function parse($object, &$dependencies)
+    public function parse($object, array &$dependencies): StructureElement
     {
         $this->element = (isset($object->element)) ? $object->element : 'array';
 
@@ -52,7 +52,7 @@ public function parse($object, &$dependencies)
      *
      * @return string
      */
-    public function __toString()
+    public function __toString(): string
     {
         $return = '<ul class="list-group mdl-list">';
 
@@ -77,7 +77,7 @@ public function __toString()
      *
      * @return self
      */
-    protected function new_instance()
+    protected function new_instance(): StructureElement
     {
         return new self();
     }

src/PHPDraft/Model/Elements/BasicStructureElement.php

@@ -9,6 +9,7 @@
 namespace PHPDraft\Model\Elements;
 
 use Michelf\MarkdownExtra;
+use stdClass;
 
 abstract class BasicStructureElement implements StructureElement
 {
@@ -58,26 +59,26 @@ abstract class BasicStructureElement implements StructureElement
     /**
      * Parse a JSON object to a structure.
      *
-     * @param \stdClass $object       An object to parse
-     * @param array     $dependencies Dependencies of this object
+     * @param stdClass $object       An object to parse
+     * @param array    $dependencies Dependencies of this object
      *
      * @return StructureElement self reference
      */
-    abstract public function parse($object, &$dependencies);
+    abstract public function parse($object, array &$dependencies): StructureElement;
 
     /**
      * Print a string representation.
      *
      * @return string
      */
-    abstract public function __toString();
+    abstract public function __toString(): string;
 
     /**
      * Get a new instance of a class.
      *
      * @return self
      */
-    abstract protected function new_instance();
+    abstract protected function new_instance(): StructureElement;
 
     /**
      * Parse common fields to give context.
@@ -87,7 +88,7 @@ abstract protected function new_instance();
      *
      * @return void
      */
-    protected function parse_common($object, &$dependencies)
+    protected function parse_common($object, array &$dependencies): void
     {
         $this->key          = (isset($object->content->key->content)) ? $object->content->key->content : NULL;
         $this->type         = (isset($object->content->value->element)) ? $object->content->value->element : NULL;
@@ -107,12 +108,14 @@ protected function parse_common($object, &$dependencies)
      *
      * @return void
      */
-    public function description_as_html()
+    public function description_as_html(): void
     {
         $this->description = MarkdownExtra::defaultTransform($this->description);
     }
 
     /**
+     * Get a string representation of the value.
+     *
      * @return mixed|ObjectStructureElement|ObjectStructureElement[]
      */
     public function string_value()

src/PHPDraft/Model/Elements/EnumStructureElement.php

@@ -19,7 +19,7 @@ class EnumStructureElement extends BasicStructureElement
      *
      * @return $this
      */
-    public function parse($object, &$dependencies)
+    public function parse($object, array &$dependencies): StructureElement
     {
         $this->element = (isset($object->element)) ? $object->element : 'enum';
 
@@ -52,7 +52,7 @@ public function parse($object, &$dependencies)
      *
      * @return string
      */
-    public function __toString()
+    public function __toString(): string
     {
         $return = '<ul class="list-group mdl-list">';
 
@@ -84,7 +84,7 @@ public function __toString()
      *
      * @return self
      */
-    protected function new_instance()
+    protected function new_instance(): StructureElement
     {
         return new self();
     }