Out: Refine display of Request objects

SMillerDev · SMillerDev · commit f17083d0d0e4 · 2017-08-10T10:09:27.000+02:00
diff --git a/build.xml b/build.xml
@@ -73,9 +73,14 @@
                 <include name="**/*.php"/>
             </fileset>
         </copy>
+        <copy todir="${basedir}/build/phar/phpdraft/src/Lukasoppermann/Httpstatus">
+            <fileset dir="vendor/lukasoppermann/http-status/src">
+                <include name="**/*.php"/>
+            </fileset>
+        </copy>
         <copy todir="${basedir}/build/phar/phpdraft">
             <fileset dir="${basedir}">
-                <include name="**/index.php"/>
+                <include name="**/phpdraft"/>
                 <exclude name="vendor/**"/>
             </fileset>
         </copy>
@@ -84,7 +89,7 @@
             <arg value="-pi"/>
             <arg value="-e"/>
             <arg value="s/\'vendor\/autoload.php/__DIR__\ .\ \'\/src\/PHPDraft\/Core\/Autoloader.php/g"/>
-            <arg value="${basedir}/build/phar/phpdraft/index.php"/>
+            <arg value="${basedir}/build/phar/phpdraft/phpdraft"/>
         </exec>
 
         <exec executable="${basedir}/build/phar-version.php" outputproperty="_version">
@@ -153,7 +158,7 @@
     <target name="-phar-determine-version">
         <exec executable="bash" outputproperty="version">
             <arg value="-c"/>
-            <arg value="php ${basedir}/index.php -v | grep -ohE '([0-9]{1,}\.)+[0-9]{1,}'"/>
+            <arg value="php ${basedir}/phpdraft -v | grep -ohE '([0-9]{1,}\.)+[0-9]{1,}'"/>
         </exec>
     </target>
 </project>
diff --git a/build/binary-phar-autoload.php.in b/build/binary-phar-autoload.php.in
@@ -28,7 +28,7 @@ if ($execute) {
         exit;
     }
 
-    require_once __PHPDRAFT_PHAR_ROOT__.DIRECTORY_SEPARATOR.'phpdraft'.DIRECTORY_SEPARATOR.'index.php';
+    require_once __PHPDRAFT_PHAR_ROOT__.DIRECTORY_SEPARATOR.'phpdraft'.DIRECTORY_SEPARATOR.'phpdraft';
 }
 
 __HALT_COMPILER();
diff --git a/build/phar-version.php b/build/phar-version.php
@@ -5,11 +5,11 @@
 }
 
 file_put_contents(
-    __DIR__ . '/phar/phpdraft/index.php',
+    __DIR__ . '/phar/phpdraft/phpdraft',
     str_replace(
         "define('VERSION', '0');",
         "define('VERSION', '" . $argv[1] . "');",
-        file_get_contents(__DIR__ . '/phar/phpdraft/index.php')
+        file_get_contents(__DIR__ . '/phar/phpdraft/phpdraft')
     )
 );
 
diff --git a/composer.json b/composer.json
@@ -3,6 +3,7 @@
   "description": "This is a parser for API Blueprint files in PHP.",
   "minimum-stability": "stable",
   "license": "GPL-3.0",
+  "bin": ["phpdraft"],
   "authors": [
     {
       "name": "Sean Molenaar",
diff --git a/phpdraft b/phpdraft
diff --git a/src/PHPDraft/Out/HTML/default.phtml b/src/PHPDraft/Out/HTML/default.phtml
@@ -201,7 +201,6 @@ use Enjoy\HttpStatusCode\Statuscodes;
                                                     <?php endforeach; ?>
                                                 <?php endif; ?>
                                                 <?php if (!empty($request->struct)): ?>
-
                                                     <h5>Structure</h5>
                                                     <div class="row">
                                                         <?= $request->struct ?>
@@ -216,7 +215,7 @@ use Enjoy\HttpStatusCode\Statuscodes;
                                                 <?php endif; ?>
 
                                                 <?php if ($transition->data_variables !== null): ?>
-                                                    <h5>Data object</h5>
+                                                    <h5>Request object</h5>
                                                     <?= $transition->data_variables ?>
                                                 <?php endif; ?>
                                             </div>
diff --git a/src/PHPDraft/Out/HTML/material.phtml b/src/PHPDraft/Out/HTML/material.phtml
@@ -143,7 +143,7 @@ use Enjoy\HttpStatusCode\Statuscodes;
                                                     <?= $transition->url_variables; ?>
                                                 <?php endif; ?>
                                                 <?php if ($transition->data_variables !== null): ?>
-                                                    <h5>Data object</h5>
+                                                    <h5>Request object</h5>
                                                     <?= $transition->data_variables ?>
                                                 <?php endif; ?>
                                             </div>
diff --git a/tests/statics/drafter/html_basic b/tests/statics/drafter/html_basic
@@ -401,7 +401,7 @@
                                                     <span class="base-url">https://owner-api.teslamotors.com</span><em>/oauth/token</em>
                                                                                                                                                                                                 
                                                 
-                                                                                                    <h5>Data object</h5>
+                                                                                                    <h5>Request object</h5>
                                                     <table class="table table-striped mdl-data-table mdl-js-data-table "><table class="table table-striped mdl-data-table mdl-js-data-table "><tr><td><span>grant_type</span></td><td><code>string</code></td><td> <span class="status"></span></td><td><p>The type of oAuth grant. Always &quot;password&quot;</p>
 </td><td><span class="example-value pull-right">password</span></td></tr><tr><td><span>client_id</span></td><td><code>string</code></td><td> <span class="status"></span></td><td><p>The oAuth client ID</p>
 </td><td><span class="example-value pull-right">abc</span></td></tr><tr><td><span>client_secret</span></td><td><code>string</code></td><td> <span class="status"></span></td><td><p>The oAuth client secret</p>
diff --git a/tests/statics/drafter/html_material b/tests/statics/drafter/html_material
@@ -187,7 +187,7 @@
                                                                                                                 <div class="mdl-tabs__panel is-active" id="authentication-tokens-get-an-access-token-request-panel">
                                                                                                                                                     <h5>Example URI</h5>
                                                     <span class="base-url">https://owner-api.teslamotors.com</span><em>/oauth/token</em>
-                                                                                                                                                                                                                                                                                                                                                    <h5>Data object</h5>
+                                                                                                                                                                                                                                                                                                                                                    <h5>Request object</h5>
                                                     <table class="table table-striped mdl-data-table mdl-js-data-table "><table class="table table-striped mdl-data-table mdl-js-data-table "><tr><td><span>grant_type</span></td><td><code>string</code></td><td> <span class="status"></span></td><td><p>The type of oAuth grant. Always &quot;password&quot;</p>
 </td><td><span class="example-value pull-right">password</span></td></tr><tr><td><span>client_id</span></td><td><code>string</code></td><td> <span class="status"></span></td><td><p>The oAuth client ID</p>
 </td><td><span class="example-value pull-right">abc</span></td></tr><tr><td><span>client_secret</span></td><td><code>string</code></td><td> <span class="status"></span></td><td><p>The oAuth client secret</p>
diff --git a/tests/statics/full_test.apib b/tests/statics/full_test.apib
@@ -73,6 +73,24 @@ their feed. Posts are closely tied to the follow graph...
 ### Retrieve a Post [GET]
 Returns a specific Post.
 
++ Response 200
+
+    [Post][]
+
+### Update a Post [PUT]
+Updates a specific Post.
+
++ Parameters
+    + post_id: `2` (string) - The id of the Post.
+
++ Attributes
+    + Key: `key` (string) - Key for the object
+    + Object
+        + Key1: `key1` (string) - Key1 for the object
+        + Key2: `key2` (string) - Key2 for the object
+
++ Request (application/json)
+
 + Response 200
 
     [Post][]

Original file line number	Diff line number	Diff line change
`@@ -28,7 +28,7 @@ if ($execute) {`
`28`	`28`	`exit;`
`29`	`29`	`}`
`30`	`30`
`31`		`- require_once __PHPDRAFT_PHAR_ROOT__.DIRECTORY_SEPARATOR.'phpdraft'.DIRECTORY_SEPARATOR.'index.php';`
	`31`	`+ require_once __PHPDRAFT_PHAR_ROOT__.DIRECTORY_SEPARATOR.'phpdraft'.DIRECTORY_SEPARATOR.'phpdraft';`
`32`	`32`	`}`
`33`	`33`
`34`	`34`	`__HALT_COMPILER();`
Original file line number	Diff line number	Diff line change
`@@ -5,11 +5,11 @@`
`5`	`5`	`}`
`6`	`6`
`7`	`7`	`file_put_contents(`
`8`		`- __DIR__ . '/phar/phpdraft/index.php',`
	`8`	`+ __DIR__ . '/phar/phpdraft/phpdraft',`
`9`	`9`	`str_replace(`
`10`	`10`	`"define('VERSION', '0');",`
`11`	`11`	`"define('VERSION', '" . $argv[1] . "');",`
`12`		`- file_get_contents(__DIR__ . '/phar/phpdraft/index.php')`
	`12`	`+ file_get_contents(__DIR__ . '/phar/phpdraft/phpdraft')`
`13`	`13`	`)`
`14`	`14`	`);`
`15`	`15`
Original file line number	Diff line number	Diff line change
`@@ -3,6 +3,7 @@`
`3`	`3`	`"description": "This is a parser for API Blueprint files in PHP.",`
`4`	`4`	`"minimum-stability": "stable",`
`5`	`5`	`"license": "GPL-3.0",`
	`6`	`+ "bin": ["phpdraft"],`
`6`	`7`	`"authors": [`
`7`	`8`	`{`
`8`	`9`	`"name": "Sean Molenaar",`