Merge pull request #427 from zonuexe/feature/php-project

New php-project.el

Author: zonuexe

Makefile

@@ -1,22 +1,23 @@
 EMACS ?= emacs
-ELS = php-mode.el php-mode-test.el
+ELS = php-project.el php-mode.el php-mode-test.el
+AUTOLOADS = php-project-autoloads.el php-mode-autoloads.el
 ELCS = $(ELS:.el=.elc)
 
 %.elc: %.el
 	$(EMACS) -Q -batch -L . -f batch-byte-compile $<
 
 all: autoloads $(ELCS)
 
-autoloads: php-mode-autoloads.el
+autoloads: $(AUTOLOADS)
 
-php-mode-autoloads.el:
+$(AUTOLOADS): php-project.el php-mode.el
 	$(EMACS) -Q -batch -L . --eval \
 	"(progn \
-           (require 'package) \
-           (package-generate-autoloads \"php-mode\" default-directory))"
+	   (require 'package) \
+	   (package-generate-autoloads \"php-mode\" default-directory))"
 
 clean:
-	rm -f $(ELCS) php-mode-autoloads.el
+	rm -f $(ELCS) $(AUTOLOADS)
 
 # Runs all unit tests from php-mode-test.el and shows the results. The
 # script will exit with the status code zero if all tests pass. If any

php-mode-test.el

@@ -31,6 +31,7 @@
 ;;; Code:
 
 (require 'php-mode)
+(require 'php-project)
 (require 'ert)
 (require 'cl-lib)
 (require 'imenu)
@@ -1075,6 +1076,10 @@ style from Drupal."
           (search-forward variable)
           (should (eq 'font-lock-type-face (get-text-property (- (point) 1) 'face))))))))
 
+(ert-deftest php-project-root ()
+  (should (string= (abbreviate-file-name default-directory)
+                   (php-project-get-root-dir))))
+
 ;;; php-mode-test.el ends here
 
 ;; Local Variables:

php-mode.el

@@ -83,6 +83,7 @@
 (require 'etags)
 (require 'speedbar)
 (require 'imenu)
+(require 'php-project nil t)
 
 (require 'cl-lib)
 (require 'mode-local)
@@ -388,30 +389,8 @@ This variable can take one of the following symbol values:
   (message "PHP Mode %s of %s"
            php-mode-version-number php-mode-modified))
 
-(defvar php-available-project-root-files
-  '((projectile ".projectile")
-    (composer   "composer.json" "composer.lock")
-    (git        ".git")
-    (mercurial  ".hg")
-    (subversion ".svn")
-    ;; NOTICE: This method does not detect the top level of .editorconfig
-    ;;         However, we can integrate it by adding the editorconfig.el's API.
-    ;;(editorconfig . ".editorconfig")
-    ))
-
 ;;;###autoload
-(progn
-  (defvar php-project-root 'auto
-    "Method of searching for the top level directory.
-
-`auto' (default)
-      Try to search file in order of `php-available-project-root-files'.
-
-SYMBOL
-      Key of `php-available-project-root-files'.")
-  (make-variable-buffer-local 'php-project-root)
-  (put 'php-project-root 'safe-local-variable
-       #'(lambda (v) (assq v php-available-project-root-files))))
+(define-obsolete-variable-alias 'php-available-project-root-files 'php-project-available-root-files "1.19.0")
 
 (defvar php-mode-map
   (let ((map (make-sparse-keymap)))
@@ -1743,18 +1722,6 @@ The output will appear in the buffer *PHP*."
     (when (re-search-backward re-pattern nil t)
       (match-string-no-properties 1))))
 
-;;;###autoload
-(defun php-project-get-root-dir ()
-  "Return path to current PHP project."
-  (let ((detect-method (if (stringp php-project-root)
-                           (list php-project-root)
-                         (if (eq php-project-root 'auto)
-                             (cl-loop for m in php-available-project-root-files
-                                      append (cdr m))
-                           (cdr-safe (assq php-project-root php-available-project-root-files))))))
-    (cl-loop for m in detect-method
-             thereis (locate-dominating-file default-directory m))))
-
 ;;;###autoload
 (defun php-current-class ()
   "Insert current class name if cursor in class context."

php-project.el

@@ -0,0 +1,83 @@
+;;; php-project.el --- Project support for PHP application  -*- lexical-binding: t; -*-
+
+;; Copyright (C) 2018  Friends of Emacs-PHP development
+
+;; Author: USAMI Kenta <tadsan@zonu.me>
+;; Keywords: tools, files
+;; URL: https://github.com/ejmr/php-mode
+;; Version: 1.18.4
+;; Package-Requires: ((emacs "24") (cl-lib "0.5"))
+;; License: GPL-3.0-or-later
+
+;; This program is free software; you can redistribute it and/or modify
+;; it under the terms of the GNU General Public License as published by
+;; the Free Software Foundation, either version 3 of the License, or
+;; (at your option) any later version.
+
+;; This program is distributed in the hope that it will be useful,
+;; but WITHOUT ANY WARRANTY; without even the implied warranty of
+;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+;; GNU General Public License for more details.
+
+;; You should have received a copy of the GNU General Public License
+;; along with this program.  If not, see <https://www.gnu.org/licenses/>.
+
+;;; Commentary:
+
+;; Define project specific functions and variables for PHP application.
+;;
+;; ## API
+;;
+;; ### `php-project-get-root-dir()'
+;;
+;; Return root directory of current buffer file.  The root directory is
+;; determined by several marker file or directory.
+;;
+
+;;; Code:
+(require 'cl-lib)
+
+;; Variables
+(defvar php-project-available-root-files
+  '((projectile ".projectile")
+    (composer   "composer.json" "composer.lock")
+    (git        ".git")
+    (mercurial  ".hg")
+    (subversion ".svn")
+    ;; NOTICE: This method does not detect the top level of .editorconfig
+    ;;         However, we can integrate it by adding the editorconfig.el's API.
+    ;;(editorconfig . ".editorconfig")
+    ))
+
+;; Buffer local variables
+
+;;;###autoload
+(progn
+  (defvar php-project-root 'auto
+    "Method of searching for the top level directory.
+
+`auto' (default)
+      Try to search file in order of `php-project-available-root-files'.
+
+SYMBOL
+      Key of `php-project-available-root-files'.")
+  (make-variable-buffer-local 'php-project-root)
+  (put 'php-project-root 'safe-local-variable
+       #'(lambda (v) (assq v php-project-available-root-files))))
+
+;; Functions
+
+;;;###autoload
+(defun php-project-get-root-dir ()
+  "Return path to current PHP project."
+  (let ((detect-method (if (stringp php-project-root)
+                           (list php-project-root)
+                         (if (eq php-project-root 'auto)
+                             (cl-loop for m in php-project-available-root-files
+                                      append (cdr m))
+                           (cdr-safe (assq php-project-root php-project-available-root-files))))))
+    (cl-loop for m in detect-method
+             thereis (locate-dominating-file default-directory m))))
+
+(provide 'php-project)
+;;; php-project.el ends here