Fixes #1730. Correctly parse PHPCBF version and improve handling of E…

…xecutable
Glavin001 · Jun 20, 2017 · 3411fad · 3411fad
1 parent e1d9da1
commit 3411fad
Show file tree

Hide file tree

Showing 4 changed files with 62 additions and 67 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,4 +1,5 @@
 # Next
+- Fixes [#1730](https://github.com/Glavin001/atom-beautify/issues/1730). Correctly parse PHPCBF version and improve handling of Executable
 - ...
 
 # v0.30.1 (2017-06-19)

diff --git a/README.md b/README.md
@@ -98,7 +98,7 @@ Some of the supported beautifiers are developed for Node.js and are automaticall
 | ocp-indent | :warning: Manual installation | :construction: Not an executable | :page_facing_up: Go to https://www.typerex.org/ocp-indent.html and follow the instructions. |
 | Perltidy | :warning: Manual installation | :construction: Not an executable | :page_facing_up: Go to http://perltidy.sourceforge.net/ and follow the instructions. |
 | PHP-CS-Fixer | :warning: 2 executables | :warning: Only 1 of 2 executables | :whale: With [Docker](https://www.docker.com/):<br/>1. Install [PHP-CS-Fixer (`php-cs-fixer`)](https://github.com/FriendsOfPHP/PHP-CS-Fixer) with `docker pull unibeautify/php-cs-fixer`<br/><br/>:bookmark_tabs: Manually:<br/>1. Install [PHP (`php`)](http://php.net/) by following http://php.net/manual/en/install.php<br/>2. Install [PHP-CS-Fixer (`php-cs-fixer`)](https://github.com/FriendsOfPHP/PHP-CS-Fixer) by following https://github.com/FriendsOfPHP/PHP-CS-Fixer#installation<br/> |
-| PHPCBF | :warning: 1 executable | :white_check_mark: :100:% of executables | :whale: With [Docker](https://www.docker.com/):<br/>1. Install [PHPCBF (`phpcbf`)](https://github.com/squizlabs/PHP_CodeSniffer) with `docker pull unibeautify/phpcbf`<br/><br/>:bookmark_tabs: Manually:<br/>1. Install [PHPCBF (`phpcbf`)](https://github.com/squizlabs/PHP_CodeSniffer) by following https://github.com/squizlabs/PHP_CodeSniffer#installation<br/> |
+| PHPCBF | :warning: 2 executables | :warning: Only 1 of 2 executables | :whale: With [Docker](https://www.docker.com/):<br/>1. Install [PHPCBF (`phpcbf`)](https://github.com/squizlabs/PHP_CodeSniffer) with `docker pull unibeautify/phpcbf`<br/><br/>:bookmark_tabs: Manually:<br/>1. Install [PHP (`php`)](http://php.net/) by following http://php.net/manual/en/install.php<br/>2. Install [PHPCBF (`phpcbf`)](https://github.com/squizlabs/PHP_CodeSniffer) by following https://github.com/squizlabs/PHP_CodeSniffer#installation<br/> |
 | Pretty Diff | :white_check_mark: | :ok_hand: Not necessary | :smiley: Nothing! |
 | Pug Beautify | :white_check_mark: | :ok_hand: Not necessary | :smiley: Nothing! |
 | puppet-lint | :warning: Manual installation | :construction: Not an executable | :page_facing_up: Go to http://puppet-lint.com/ and follow the instructions. |

diff --git a/src/beautifiers/php-cs-fixer.coffee b/src/beautifiers/php-cs-fixer.coffee
@@ -96,8 +96,8 @@ module.exports = class PHPCSFixer extends Beautifier
     @Promise.all([
       @which(options.cs_fixer_path) if options.cs_fixer_path
       phpCsFixer.path()
-      tempFile = @tempFile("temp", text, '.php')
-    ]).then(([customPhpCsFixerPath, phpCsFixerPath]) =>
+      @tempFile("temp", text, '.php')
+    ]).then(([customPhpCsFixerPath, phpCsFixerPath, tempFile]) =>
       # Get first valid, absolute path
       finalPhpCsFixerPath = if customPhpCsFixerPath and path.isAbsolute(customPhpCsFixerPath) then \
         customPhpCsFixerPath else phpCsFixerPath

diff --git a/src/beautifiers/phpcbf.coffee b/src/beautifiers/phpcbf.coffee
@@ -9,20 +9,28 @@ module.exports = class PHPCBF extends Beautifier
   name: "PHPCBF"
   link: "http://php.net/manual/en/install.php"
   executables: [
+    {
+      name: "PHP"
+      cmd: "php"
+      homepage: "http://php.net/"
+      installation: "http://php.net/manual/en/install.php"
+      version: {
+        parse: (text) -> text.match(/PHP (.*) \(cli\)/)[1]
+      }
+    }
     {
       name: "PHPCBF"
       cmd: "phpcbf"
       homepage: "https://github.com/squizlabs/PHP_CodeSniffer"
       installation: "https://github.com/squizlabs/PHP_CodeSniffer#installation"
       version: {
-        args: ['--version']
+        parse: (text) -> text.match(/version (\d+\.\d+\.\d+)/)[1]
       }
       docker: {
         image: "unibeautify/phpcbf"
       }
     }
   ]
-  isPreInstalled: false
 
   options: {
     PHP:
@@ -38,69 +46,55 @@ module.exports = class PHPCBF extends Beautifier
 
     options.standard = standardFile if standardFile
 
-    isWin = @isWindows
-    if isWin
-      # Find phpcbf.phar script
-      @Promise.all([
-        @which(options.phpcbf_path) if options.phpcbf_path
-        @which('phpcbf')
-      ]).then((paths) =>
-        @debug('phpcbf paths', paths)
-        _ = require 'lodash'
-        path = require 'path'
-        # Get first valid, absolute path
-        phpcbfPath = _.find(paths, (p) -> p and path.isAbsolute(p) )
-        @verbose('phpcbfPath', phpcbfPath)
-        @debug('phpcbfPath', phpcbfPath, paths)
-        # Check if phpcbf path was found
-        if phpcbfPath?
-          # Found phpcbf path
+    php = @exe('php')
+    phpcbf = @exe('phpcbf')
 
-          # Check if phpcbf is an executable
-          isExec = path.extname(phpcbfPath) isnt ''
-          exec = if isExec then phpcbfPath else "php"
+    if options.phpcbf_path
+      deprecationMessage = "The \"PHP - PHPCBF Path (phpcbf_path)\" configuration option has been deprecated. Please switch to using the option named \"Executables - PHPCBF - Path\" in Atom-Beautify package settings now."
+      @deprecate(deprecationMessage)
 
-          @run(exec, [
-            phpcbfPath unless isExec
-            "--no-patch" unless options.phpcbf_version is 3
-            "--standard=#{options.standard}" if options.standard
-            tempFile = @tempFile("temp", text, ".php")
-            ], {
-              ignoreReturnCode: true
-              help: {
-                link: "http://php.net/manual/en/install.php"
-              }
-              onStdin: (stdin) ->
-                stdin.end()
-            })
-            .then(=>
-              @readFile(tempFile)
-            )
-        else
-          @verbose('phpcbf not found!')
-          # Could not find phpcbf path
-          @Promise.reject(@commandNotFoundError(
-            'phpcbf'
-            {
-            link: "https://github.com/squizlabs/PHP_CodeSniffer"
-            program: "phpcbf.phar"
-            pathOption: "PHPCBF Path"
-            })
+    # Find phpcbf.phar script
+    @Promise.all([
+      @which(options.phpcbf_path) if options.phpcbf_path
+      phpcbf.path()
+      @tempFile("temp", text, ".php")
+    ]).then(([customPhpcbfPath, phpcbfPath, tempFile]) =>
+      # Get first valid, absolute path
+      finalPhpcbfPath = if customPhpcbfPath and path.isAbsolute(customPhpcbfPath) then \
+        customPhpcbfPath else phpcbfPath
+      @verbose('finalPhpcbfPath', finalPhpcbfPath, phpcbfPath, customPhpcbfPath)
+
+      isVersion3 = ((phpcbf.isInstalled and phpcbf.isVersion('3.x')) or \
+        (options.phpcbf_version and phpcbf.versionSatisfies("#{options.phpcbf_version}.0.0", '3.x')))
+
+      isPhpScript = (finalPhpcbfPath.indexOf(".phar") isnt -1) or (finalPhpcbfPath.indexOf(".php") isnt -1)
+      @verbose('isPhpScript', isPhpScript)
+
+      if isPhpScript
+        php.run([
+          phpcbfPath,
+          "--no-patch" unless isVersion3
+          "--standard=#{options.standard}" if options.standard
+          tempFile
+          ], {
+            ignoreReturnCode: true
+            onStdin: (stdin) ->
+              stdin.end()
+          })
+          .then(=>
+            @readFile(tempFile)
+          )
+      else
+        phpcbf.run([
+          "--no-patch" unless isVersion3
+          "--standard=#{options.standard}" if options.standard
+          tempFile = @tempFile("temp", text, ".php")
+          ], {
+            ignoreReturnCode: true
+            onStdin: (stdin) ->
+              stdin.end()
+          })
+          .then(=>
+            @readFile(tempFile)
           )
       )
-    else
-      @run("phpcbf", [
-        "--no-patch" unless options.phpcbf_version is 3
-        "--standard=#{options.standard}" if options.standard
-        tempFile = @tempFile("temp", text, ".php")
-        ], {
-          ignoreReturnCode: true
-          help: {
-            link: "https://github.com/squizlabs/PHP_CodeSniffer"
-          }
-          onStdin: (stdin) ->
-            stdin.end()
-        })
-        .then(=>
-          @readFile(tempFile)
-        )