Merge pull request #433 from zonuexe/feature/project-variables

Add php-project-get-bootstrap-scripts functions

Author: zonuexe

php-project.el

@@ -33,16 +33,28 @@
 ;; Return root directory of current buffer file.  The root directory is
 ;; determined by several marker file or directory.
 ;;
+;; ### `php-project-get-bootstrap-scripts()'
+;;
+;; Return list of path to bootstrap script file.
+;;
 ;; ## `.dir-locals.el' support
 ;;
 ;; - `php-project-coding-style'
 ;;   - Symbol value of the coding style.  (ex.  `pear', `psr2')
-;;
+;; - `php-project-root'
+;;   - Symbol of marker file of project root.  (ex.  `git', `composer')
+;;   - Full path to project root directory.  (ex.  "/path/to/your-project")
+;; - `php-project-bootstrap-scripts'
+;;   - List of path to bootstrap file of project.
+;;     (ex.  (((root . "vendor/autoload.php") (root . "inc/bootstrap.php")))
 ;;
 
 ;;; Code:
 (require 'cl-lib)
 
+;; Constants
+(defconst php-project-composer-autoloader "vendor/autoload.php")
+
 ;; Variables
 (defvar php-project-available-root-files
   '((projectile ".projectile")
@@ -71,6 +83,16 @@ SYMBOL
   (put 'php-project-root 'safe-local-variable
        #'(lambda (v) (assq v php-project-available-root-files))))
 
+;;;###autoload
+(progn
+  (defvar php-project-bootstrap-scripts nil
+    "List of path to bootstrap php script file.
+
+The ideal bootstrap file is silent, it only includes dependent files,
+defines constants, and sets the class loaders.")
+  (make-variable-buffer-local 'php-project-bootstrap-scripts)
+  (put 'php-project-bootstrap-scripts 'safe-local-variable #'php-project--eval-bootstrap-scripts))
+
 ;;;###autoload
 (progn
   (defvar php-project-coding-style nil
@@ -83,15 +105,37 @@ Typically it is `pear', `drupal', `wordpress', `symfony2' and `psr2'.")
 
 ;; Functions
 
+(defun php-project--eval-bootstrap-scripts (val)
+  "Return T when `VAL' is valid list of safe bootstrap php script."
+  (cond
+   ((stringp val) (and (file-exists-p val) val))
+   ((eq 'composer val)
+    (let ((path (expand-file-name php-project-composer-autoloader (php-project-get-root-dir))))
+      (and (file-exists-p path) path)))
+   ((and (consp val) (eq 'root (car val)) (stringp (cdr val)))
+    (let ((path (expand-file-name (cdr val) (php-project-get-root-dir))))
+      (and (file-exists-p path) path)))
+   ((null val) nil)
+   ((listp val)
+    (cl-loop for v in val collect (php-project--eval-bootstrap-scripts v)))
+   (t nil)))
+
+;;;###autoload
+(defun php-project-get-bootstrap-scripts ()
+  "Return list of bootstrap script."
+  (let ((scripts (php-project--eval-bootstrap-scripts php-project-bootstrap-scripts)))
+    (if (stringp scripts) (list scripts) scripts)))
+
 ;;;###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))))))
+  (let ((detect-method
+         (cond
+          ((stringp php-project-root) (list php-project-root))
+          ((eq php-project-root 'auto)
+           (cl-loop for m in php-project-available-root-files
+                    append (cdr m)))
+          (t (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))))