#82 - Improve help docs. Allow remote sources.

Author: stackpr

src/Console/fileconverter.drush.inc

@@ -1,4 +1,5 @@
 <?php
+use FileConverter\drush_print;
 /*
  * This file is part of the FileConverter package.
  *
@@ -47,6 +48,9 @@ function fileconverter_drush_command() {
       'optimize' => array(
         'description' => 'Optimize the destination file',
       ),
+      'allow-remote' => array(
+        'description' => 'Allow remote paths (e.g., http://)',
+      ),
       'replace-string' => array(
         'description' => 'JSON Object: Configure text replacements',
         'example-value' => '{"search":"replace"}',
@@ -123,6 +127,7 @@ function drush_fileconverter_convert($source = NULL, $destination = NULL) {
   $fc = FileConverter\FileConverter::factory();
   $stdin = $stdout = FALSE;
   $force_conversion = trim(drush_get_option('conversion'));
+  $is_remote = FALSE;
   if (preg_match('@^(.*):(.*)$@', $force_conversion, $arr)) {
     $force_conversion = array(
       $arr[1],
@@ -153,8 +158,13 @@ function drush_fileconverter_convert($source = NULL, $destination = NULL) {
       }
     }
     if (!is_file($source)) {
-      drush_print(dt("Error: Unable to locate source file."));
-      return;
+      if (drush_get_option('allow-remote') === TRUE && strpos($source, '://') !== FALSE) {
+        $is_remote = TRUE;
+      }
+      else {
+        drush_print(dt("Error: Unable to locate source file."));
+        return;
+      }
     }
   }
   if ($destination{0} !== '/') {
@@ -183,9 +193,14 @@ function drush_fileconverter_convert($source = NULL, $destination = NULL) {
 
   // Convert the file.
   $fc = FileConverter\FileConverter::factory();
-  if (realpath($source) !== realpath($destination)) {
+  if ($is_remote || realpath($source) !== realpath($destination)) {
     $convert_path = isset($force_conversion) ? join('->', $force_conversion) : NULL;
-    $fc->convertFile(realpath($source), $destination, $convert_path);
+    try {
+      $fc->convertFile($is_remote ? $source : realpath($source), $destination, $convert_path);
+    } catch (\Exception $e) {
+      drush_print($e->getMessage());
+      return;
+    }
   }
 
   // Further commands can work on a single file, so use a default destination.

src/Engine/Convert/PhantomJs.php

@@ -51,7 +51,7 @@ public function getConvertFileShell($source, &$destination) {
       $this->cmd,
       Shell::argOptions($this->cmd_options, $this->configuration, 1),
       realpath(__DIR__ . '/Resources/PhantomJs-rasterize.js'),
-      'file://' . $source,
+      (strpos($source, '://') === FALSE ? 'file://' . $source : $source),
       $destination,
       $dimensions,
       $zoom,
@@ -65,6 +65,7 @@ protected function getHelpInstallation($os, $os_version) {
       'url' => 'http://phantomjs.org/',
     );
     switch ($os) {
+      case 'Ubuntu':
       case 'Ubuntu (12.04 LTS)':
         $help['os'] = 'confirmed on Ubuntu 12.04';
         $help['apt-get'] = 'phantomjs xvfb';

src/Engine/EngineBase.php

@@ -135,8 +135,10 @@ public function getHelp($type = 'installation') {
     switch ($type) {
       case 'installation':
         $help = $this->getHelpInstallation($os, $os_version);
-        if (isset($help) && !is_string($help)) {
-          $help = var_export($help, 1);
+        if (isset($help)) {
+          if (!is_string($help)) {
+            $help = var_export($help, 1);
+          }
         }
         return $help;
     }
@@ -145,16 +147,9 @@ public function getHelp($type = 'installation') {
   }
 
   protected function getHelpInstallation($os, $os_version) {
-    if (isset($os)) {
-      return array(
-        'title' => "No installation instructions available.",
-      );
-    }
-    else {
-      return array(
-        'title' => "No installation instructions available for your platform.",
-      );
-    }
+    return array(
+      'title' => "Unable to confirm installation instructions for OS='$os' Ver='$os_version'",
+    );
   }
 
   public function getTempFile($file_extension = NULL) {