Add --shebang-less switch

Author: yannoff

README.md

@@ -51,6 +51,7 @@ Name /  Shorthand   |  Type | Description
 `--file`, `-f`      | multi | Adds a single file to the archive                                                                                                                                                       |n
 `--dir`,  `-d`      | multi | Adds a sources directory to the archive<br/>_Possible dir spec formats:<br/>- `$dir` => include all files in directory<br/>- `$dir:$extension` => filter files on a specific extension_ |n
 `--meta`, `-m`      | multi | Adds a metadata to the archive<br/>_Metadata must be specified in the `$key:$value` format_                                                                                             |n
+`--shebang-less`    | flag  | Produce a stub deprived of the shebang directive<br/>_Useful when the phar is meant to be included instead of being executed directly_                                                  |n
 
 
 ### Examples

src/Command/Compile.php

@@ -41,6 +41,7 @@ public function configure()
             ->addOption('meta', 'm', Option::MULTI, 'Add a metadata property (eg: "-m $key:$value")')
             ->addOption('output', 'o', Option::VALUE, 'Set the compiled archive output name')
             ->addOption('banner', 'b', Option::VALUE, 'Load legal notice from the given banner file')
+            ->addOption('shebang-less', '', Option::FLAG, 'Produce a stub deprived of the shebang directive')
         ;
     }
 
@@ -58,13 +59,15 @@ public function execute()
         $main = $this->require('main');
         $output = $this->require('output');
 
+        $shebang = (!$this->getOption('shebang-less'));
+
         $this
             ->initBuilder($main)
             ->addFiles($files)
             ->addDirectories($dirs)
             ->setNotice($banner)
             ->addMetadata($meta)
-            ->publish($output)
+            ->publish($output, $shebang)
             ->info('Build complete.')
         ;
     }
@@ -202,14 +205,15 @@ protected function setNotice(string $banner = null): self
      * Compile the Phar archive and write contents to disk
      *
      * @param string $output      Path to the phar archive output file
+     * @param bool   $shebang     Whether to include the shebang line
      * @param string $compression Compression type - "GZ" or "BZ2"
      *
      * @return self
      */
-    protected function publish(string $output, string $compression = 'GZ'): self
+    protected function publish(string $output, bool $shebang, string $compression = 'GZ'): self
     {
         $this->info("Writing Phar archive to <strong>$output</strong>...");
-        $this->builder->compile($output, $compression);
+        $this->builder->compile($output, $shebang, $compression);
 
         return $this;
     }

src/PharBuilder.php

@@ -122,9 +122,10 @@ public function setBanner(string $banner): self
      * Compress files, generate the stub and save PHAR to the output file
      *
      * @param string $output      Path to the final output file
+     * @param bool   $shebang     Include a shebang directive line in the stub ?
      * @param string $compression Compression type - "GZ" or "BZ2" (defaults to "GZ")
      */
-    public function compile(string $output, string $compression = 'GZ')
+    public function compile(string $output, bool $shebang, string $compression = 'GZ')
     {
         // Check that entrypoint script contents has been added to the archive before proceeding
         if (!$this->archive->has($this->main)) {
@@ -137,7 +138,7 @@ public function compile(string $output, string $compression = 'GZ')
         $this->archive->compressFiles($c);
 
         // NB: It's important to set the stub AFTER the files compression step so it is kept as plain text
-        $this->archive->setStub($this->stub($this->main, $this->banner));
+        $this->archive->setStub($this->stub($this->main, $shebang, $this->banner));
         // Create file on the disk
         $this->archive->stopBuffering();
         // Make file executable
@@ -159,17 +160,19 @@ public function list(): array
     /**
      * Generate the PHAR stub definition contents
      *
-     * @param string  $main   The main entrypoint script
-     * @param ?string $banner Optional legal notice text
+     * @param string  $main    The main entrypoint script
+     * @param bool    $shebang Whether to include the shebang line
+     * @param ?string $banner  Optional legal notice text
      *
      * @return string
      */
-    protected function stub(string $main, string $banner = null): string
+    protected function stub(string $main, bool $shebang = true, string $banner = null): string
     {
-        $lines = [
-            '#!/usr/bin/env php',
-            '<?php',
-        ];
+        $lines = [];
+        if ($shebang) {
+            $lines[] = '#!/usr/bin/env php';
+        }
+        $lines[] = '<?php';
         if ($banner) {
             $lines[] = $banner;
         }