Merge pull request #112 from emacs-php/merge/develop

Merge develop branch

Author: zonuexe

.travis.yml

@@ -0,0 +1,38 @@
+# matrix:
+#   include:
+#     - language: emacs-lisp
+#       sudo: no
+#       env:
+#           - EVM_EMACS=emacs-25.1-travis
+#       before_install:
+#           - curl -fsSkL https://gist.github.com/rejeep/ebcd57c3af83b049833b/raw > travis.sh && source ./travis.sh
+#           - evm install "$EVM_EMACS" --use --skip
+#       install:
+#           - cask --debug --verbose
+#       script:
+#           - cask exec buttercup -L . -p phpactor-install-or-update
+#           - cd ~/.emacs.d/phpactor && composer install --no-dev
+#           - cd -
+
+#     - language: php
+#       php:
+#           - 7.2
+#       script:
+#           - cd ~/.emacs.d/phpactor && composer install --no-dev
+
+language: php
+php:
+    - 7.1
+sudo: no
+env:
+  - EVM_EMACS=emacs-25.1-travis
+before_install:
+  - curl -fsSkL https://gist.github.com/rejeep/ebcd57c3af83b049833b/raw > travis.sh && source ./travis.sh
+  - evm install "$EVM_EMACS" --use --skip
+install:
+  - cask --debug --verbose
+script:
+  - cask exec buttercup -L .
+  # - cask exec buttercup -L . -p phpactor-install-or-update # running only this test prepares ./emacs.d/phpactor folder
+  # - cd ~/.emacs.d/phpactor && composer install --no-dev
+  # - cd - &&  cask exec buttercup -L .

Cask

@@ -1,9 +1,10 @@
 (package "phpactor" "0.1.0" "Interface to Phpactor")
 (source melpa)
+(source gnu)
 
 (package-file "phpactor.el")
 (package-file "company-phpactor.el")
 
 (development
  (depends-on "php-mode")
- (depends-on "auto-complete"))
+ (depends-on "buttercup"))

README.org

@@ -11,17 +11,47 @@ This package is Emacs interface to [[http://phpactor.github.io/phpactor/][Phpact
 #+END_HTML
 ** Instalation
 
-After having installed this package, run `phpactor-update` (this will install a supported version of phpactor inside phpactor.el's installation folder).
-*NOTICE*: To ensure the appropriate version of Phpactor is installed, please run this command after every upgrade of phpactor.el
+*Requirement*: You need to have composer globally installed.
+
+Installation with use-package :
+
+#+BEGIN_SRC emacs-lisp
+(use-package phpactor :ensure t)
+(use-package company-phpactor :ensure t)
+(use-package php-mode
+  ;;
+  :hook ((php-mode . (lambda () (set (make-local-variable 'company-backends)
+       '(;; list of backends
+         company-phpactor
+         company-files
+         ))))))
+#+END_SRC
+
+After having installed this package, run `phpactor-install-or-update` (this will install a supported version of phpactor inside `.emacs.d/phpactor`).
+
+*NOTICE*: To ensure the supported version of Phpactor is installed, you might need to run this command again after an upgrade of this package.
 
 Alternatively, you can install Phpactor on your own and configure `phpactor-executable` but please be aware that any change in Phpactor's rpc protocol can introduce breakages.
 
 
 ** Configuration
+*** eldoc integration
+
+#+BEGIN_SRC elisp
+  (add-hook 'php-mode-hook
+            (lambda ()
+              (make-local-variable 'eldoc-documentation-function)
+              (setq eldoc-documentation-function
+                    'phpactor-hover)))
+#+END_SRC
+
+*** phpactor itself
 See https://phpactor.github.io/phpactor/configuration.html
 
 ** Troubleshooting
 
 You can run ``phpactor-status`` while visiting a project file.
 
 If needed, configure [[https://github.com/emacs-php/php-mode/blob/1f04813f46219e626b385d0d96abefad914bfae0/php-project.el#L54][the way the project root is detected]] via .dir-locals.el
+
+"*Phpactor Output*" buffer might also contain useful informations.

company-phpactor.el

@@ -7,7 +7,7 @@
 ;; Created: 18 Apr 2018
 ;; Version: 0.1.0
 ;; Keywords: tools, php
-;; Package-Requires: ((emacs "24.3") (cl-lib "0.5") (company "0.9.6") (phpactor "0.1.0"))
+;; Package-Requires: ((emacs "24.3") (company "0.9.6") (phpactor "0.1.0"))
 ;; URL: https://github.com/emacs-php/phpactor.el
 ;; License: GPL-3.0-or-later
 
@@ -67,7 +67,9 @@ Here we create a temporary syntax table in order to add $ to symbols."
 (defun company-phpactor--post-completion (arg)
   "Trigger auto-import of completed item ARG when relevant."
   (if (get-text-property 0 'class_import arg)
-      (phpactor-import-class (get-text-property 0 'class_import arg))))
+      (phpactor-import-class (get-text-property 0 'class_import arg)))
+  (if (member (get-text-property 0 'type arg) '(list "method" "function"))
+      (let ((parens-require-spaces nil)) (insert-parentheses))))
 
 (defun company-phpactor--annotation (arg)
   "Show additional info (ARG) from phpactor as lateral annotation."
@@ -77,14 +79,15 @@ Here we create a temporary syntax table in order to add $ to symbols."
 (defun company-phpactor (command &optional arg &rest ignored)
   "`company-mode' completion backend for Phpactor."
   (interactive (list 'interactive))
-  (save-restriction
-    (widen)
-    (cl-case command
-      (post-completion (company-phpactor--post-completion arg))
-      (annotation (company-phpactor--annotation arg))
-      (interactive (company-begin-backend 'company-phpactor))
-      (prefix (company-phpactor--grab-symbol))
-      (candidates (all-completions arg (company-phpactor--get-candidates))))))
+  (when (phpactor-find-executable)
+    (save-restriction
+      (widen)
+      (pcase command
+        (`post-completion (company-phpactor--post-completion arg))
+        (`annotation (company-phpactor--annotation arg))
+        (`interactive (company-begin-backend 'company-phpactor))
+        (`prefix (company-phpactor--grab-symbol))
+        (`candidates (company-phpactor--get-candidates))))))
 
 (provide 'company-phpactor)
 ;;; company-phpactor.el ends here

composer.json

@@ -18,7 +18,7 @@
         "psr-4": {"EmacsPHP\\Phpactor\\Sample\\": "tests/src/"}
     },
     "require": {
-        "phpactor/phpactor": "^0.11.1"
+        "phpactor/phpactor": "^0.12.0"
     },
     "config": {
         "classmap-authoritative": true,