hugo
/
phpinspect.el
1
1
Fork 0
Code Issues 12 Pull Requests Projects Releases Wiki Activity

Improve codestyle and documentation + add tests for indexation

Browse Source 
This commit contains one logic change: Changed add-to-list usage to cl-pushnew in
phpinspect-merge-indexes implementation for classes. The resulting function output should
be the same.
remotes/local/master
Hugo Thunnissen 3 years ago
parent b338aa9b75
commit e8f486f095
22 changed files with 349 additions and 111 deletions
Show Stats Download Patch File Download Diff File

187
phpinspect.el
Unescape Escape View File

@ -4,6 +4,7 @@
;; Author: Hugo Thunnissen <devel@hugot.nl> ;; Author: Hugo Thunnissen <devel@hugot.nl>
;; Keywords: php, languages, tools, convenience ;; Keywords: php, languages, tools, convenience
;; Version: 0
;; This program is free software; you can redistribute it and/or modify ;; 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 ;; it under the terms of the GNU General Public License as published by
@ -38,9 +39,6 @@
"The result of the last successfull parse + index action "The result of the last successfull parse + index action
executed by phpinspect for the current buffer") executed by phpinspect for the current buffer")
(defvar phpinspect-projects '()
"Currently active phpinspect projects and their buffers")
(defvar phpinspect--debug nil (defvar phpinspect--debug nil
"Enable debug logs for phpinspect by setting this variable to true") "Enable debug logs for phpinspect by setting this variable to true")
@ -183,7 +181,7 @@ Type can be any of the token types returned by
(defun phpinspect-function-argument-list (php-func) (defun phpinspect-function-argument-list (php-func)
"Get the argument list of a function" "Get the argument list of a function"
(seq-find 'phpinspect-list-p (seq-find 'phpinspect-declaration-p php-func nil) nil)) (seq-find #'phpinspect-list-p (seq-find #'phpinspect-declaration-p php-func nil) nil))
(defsubst phpinspect-variable-p (token) (defsubst phpinspect-variable-p (token)
(phpinspect-type-p token :variable)) (phpinspect-type-p token :variable))
@ -293,7 +291,8 @@ text at point and returns the resulting token."
;; every time the parser advances one character and has to check for the regexp ;; every time the parser advances one character and has to check for the regexp
;; occurence. ;; occurence.
(setq attribute-plist (plist-put attribute-plist 'regexp (setq attribute-plist (plist-put attribute-plist 'regexp
(eval (plist-get attribute-plist 'regexp)))) (eval (plist-get attribute-plist 'regexp)
t)))
(let ((name (symbol-name name))) (let ((name (symbol-name name)))
`(progn `(progn
(set (intern ,name phpinspect-handler-obarray) (quote ,attribute-plist)) (set (intern ,name phpinspect-handler-obarray) (quote ,attribute-plist))
@ -316,7 +315,8 @@ parser function is then returned in byte-compiled form."
(let ((parser-name (symbol-name tree-type))) (let ((parser-name (symbol-name tree-type)))
(or (intern-soft parser-name phpinspect-parser-obarray) (or (intern-soft parser-name phpinspect-parser-obarray)
(defalias (intern parser-name phpinspect-parser-obarray) (defalias (intern parser-name phpinspect-parser-obarray)
(byte-compile (apply 'phpinspect-make-parser `(,tree-type ,@parser-parameters))))))) (byte-compile (apply #'phpinspect-make-parser
`(,tree-type ,@parser-parameters)))))))
(defun phpinspect-purge-parser-cache () (defun phpinspect-purge-parser-cache ()
"Empty `phpinspect-parser-obarray`. "Empty `phpinspect-parser-obarray`.
@ -381,12 +381,12 @@ token is \";\", which marks the end of a statement in PHP."
(t (forward-char)))) (t (forward-char))))
(push ,tree-type tokens)))))) (push ,tree-type tokens))))))
(phpinspect-defhandler comma (comma &rest ignored) (phpinspect-defhandler comma (comma &rest _ignored)
"Handler for comma tokens" "Handler for comma tokens"
(regexp ",") (regexp ",")
(phpinspect-munch-token-without-attribs comma :comma)) (phpinspect-munch-token-without-attribs comma :comma))
(phpinspect-defhandler word (word &rest ignored) (phpinspect-defhandler word (word &rest _ignored)
"Handler for bareword tokens" "Handler for bareword tokens"
(regexp "[A-Za-z_\\][\\A-Za-z_0-9]*") (regexp "[A-Za-z_\\][\\A-Za-z_0-9]*")
(let ((length (length word))) (let ((length (length word)))
@ -414,7 +414,7 @@ token is \";\", which marks the end of a statement in PHP."
(push (funcall variable-handler (match-string 0)) words)))) (push (funcall variable-handler (match-string 0)) words))))
(nreverse words))) (nreverse words)))
(phpinspect-defhandler annotation (start-token &rest ignored) (phpinspect-defhandler annotation (start-token &rest _ignored)
"Handler for in-comment @annotations" "Handler for in-comment @annotations"
(regexp "@") (regexp "@")
(forward-char (length start-token)) (forward-char (length start-token))
@ -462,11 +462,11 @@ token is \";\", which marks the end of a statement in PHP."
(forward-char 2) (forward-char 2)
doc-block)) doc-block))
(t (t
(let ((parser (phpinspect-get-parser-create :comment '(tag) 'phpinspect-html-p)) (let ((parser (phpinspect-get-parser-create :comment '(tag) #'phpinspect-html-p))
(end-position (line-end-position))) (end-position (line-end-position)))
(funcall parser (current-buffer) end-position))))) (funcall parser (current-buffer) end-position)))))
(phpinspect-defhandler variable (start-token &rest ignored) (phpinspect-defhandler variable (start-token &rest _ignored)
"Handler for tokens indicating reference to a variable" "Handler for tokens indicating reference to a variable"
(regexp "\\$") (regexp "\\$")
(forward-char (length start-token)) (forward-char (length start-token))
@ -474,22 +474,22 @@ token is \";\", which marks the end of a statement in PHP."
(phpinspect-munch-token-without-attribs (match-string 0) :variable) (phpinspect-munch-token-without-attribs (match-string 0) :variable)
(list :variable nil))) (list :variable nil)))
(phpinspect-defhandler whitespace (whitespace &rest ignored) (phpinspect-defhandler whitespace (whitespace &rest _ignored)
"Handler that discards whitespace" "Handler that discards whitespace"
(regexp "[[:blank:]]+") (regexp "[[:blank:]]+")
(forward-char (length whitespace))) (forward-char (length whitespace)))
(phpinspect-defhandler equals (equals &rest ignored) (phpinspect-defhandler equals (equals &rest _ignored)
"Handler for strict and unstrict equality comparison tokens." "Handler for strict and unstrict equality comparison tokens."
(regexp "===?") (regexp "===?")
(phpinspect-munch-token-without-attribs equals :equals)) (phpinspect-munch-token-without-attribs equals :equals))
(phpinspect-defhandler assignment-operator (operator &rest ignored) (phpinspect-defhandler assignment-operator (operator &rest _ignored)
"Handler for tokens indicating that an assignment is taking place" "Handler for tokens indicating that an assignment is taking place"
(regexp "[+-]?=") (regexp "[+-]?=")
(phpinspect-munch-token-without-attribs operator :assignment)) (phpinspect-munch-token-without-attribs operator :assignment))
(phpinspect-defhandler terminator (terminator &rest ignored) (phpinspect-defhandler terminator (terminator &rest _ignored)
"Handler for statement terminators." "Handler for statement terminators."
(regexp ";") (regexp ";")
(phpinspect-munch-token-without-attribs terminator :terminator)) (phpinspect-munch-token-without-attribs terminator :terminator))
@ -503,10 +503,10 @@ token is \";\", which marks the end of a statement in PHP."
(let ((parser (phpinspect-get-parser-create (let ((parser (phpinspect-get-parser-create
:use :use
'(word tag block-without-classes terminator) '(word tag block-without-classes terminator)
'phpinspect-end-of-use-p))) #'phpinspect-end-of-use-p)))
(funcall parser (current-buffer) max-point))) (funcall parser (current-buffer) max-point)))
(phpinspect-defhandler attribute-reference (start-token &rest ignored) (phpinspect-defhandler attribute-reference (start-token &rest _ignored)
"Handler for references to object attributes, or static class attributes." "Handler for references to object attributes, or static class attributes."
(regexp "->\\|::") (regexp "->\\|::")
(forward-char (length start-token)) (forward-char (length start-token))
@ -535,7 +535,7 @@ token is \";\", which marks the end of a statement in PHP."
:namespace :namespace
max-point max-point
(lambda () (not (looking-at (phpinspect-handler-regexp 'namespace)))) (lambda () (not (looking-at (phpinspect-handler-regexp 'namespace))))
'phpinspect-block-p)) #'phpinspect-block-p))
(phpinspect-defhandler const-keyword (start-token max-point) (phpinspect-defhandler const-keyword (start-token max-point)
"Handler for the const keyword." "Handler for the const keyword."
@ -546,13 +546,13 @@ token is \";\", which marks the end of a statement in PHP."
:const :const
'(word comment assignment-operator string array '(word comment assignment-operator string array
terminator) terminator)
'phpinspect-end-of-statement-p)) #'phpinspect-end-of-statement-p))
(token (funcall parser (current-buffer) max-point))) (token (funcall parser (current-buffer) max-point)))
(when (phpinspect-incomplete-token-p (car (last token))) (when (phpinspect-incomplete-token-p (car (last token)))
(setcar token :incomplete-const)) (setcar token :incomplete-const))
token)) token))
(phpinspect-defhandler string (start-token &rest ignored) (phpinspect-defhandler string (start-token &rest _ignored)
"Handler for strings" "Handler for strings"
(regexp "\"\\|'") (regexp "\"\\|'")
(list :string (phpinspect--munch-string start-token))) (list :string (phpinspect--munch-string start-token)))
@ -599,7 +599,7 @@ token is \";\", which marks the end of a statement in PHP."
(setcar parsed :incomplete-block)) (setcar parsed :incomplete-block))
parsed)) parsed))
(phpinspect-defhandler here-doc (start-token &rest ignored) (phpinspect-defhandler here-doc (start-token &rest _ignored)
"Handler for heredocs. Discards their contents." "Handler for heredocs. Discards their contents."
(regexp "<<<") (regexp "<<<")
(forward-char (length start-token)) (forward-char (length start-token))
@ -654,7 +654,7 @@ nature like argument lists"
(defsubst phpinspect-get-or-create-declaration-parser () (defsubst phpinspect-get-or-create-declaration-parser ()
(phpinspect-get-parser-create :declaration (phpinspect-get-parser-create :declaration
'(comment word list terminator tag) '(comment word list terminator tag)
'phpinspect-end-of-statement-p)) #'phpinspect-end-of-statement-p))
(phpinspect-defhandler function-keyword (start-token max-point) (phpinspect-defhandler function-keyword (start-token max-point)
@ -685,7 +685,7 @@ nature like argument lists"
((string= start-token "protected") :protected)) ((string= start-token "protected") :protected))
'(function-keyword static-keyword const-keyword '(function-keyword static-keyword const-keyword
variable here-doc string terminator tag comment) variable here-doc string terminator tag comment)
'phpinspect--scope-terminator-p) #'phpinspect--scope-terminator-p)
(current-buffer) (current-buffer)
max-point)) max-point))
@ -698,11 +698,11 @@ nature like argument lists"
:static :static
'(comment function-keyword variable array word '(comment function-keyword variable array word
terminator tag) terminator tag)
'phpinspect--static-terminator-p) #'phpinspect--static-terminator-p)
(current-buffer) (current-buffer)
max-point)) max-point))
(phpinspect-defhandler fat-arrow (arrow &rest ignored) (phpinspect-defhandler fat-arrow (arrow &rest _ignored)
"Handler for the \"fat arrow\" in arrays and foreach expressions" "Handler for the \"fat arrow\" in arrays and foreach expressions"
(regexp "=>") (regexp "=>")
(phpinspect-munch-token-without-attribs arrow :fat-arrow)) (phpinspect-munch-token-without-attribs arrow :fat-arrow))
@ -868,7 +868,7 @@ candidate. Candidates can be indexed functions and variables.")
(when phpinspect--debug (when phpinspect--debug
(with-current-buffer (get-buffer-create "**phpinspect-logs**") (with-current-buffer (get-buffer-create "**phpinspect-logs**")
(goto-char (buffer-end 1)) (goto-char (buffer-end 1))
(insert (concat (apply 'format args) "\n"))))) (insert (concat (apply #'format args) "\n")))))
(defsubst phpinspect-cache-project-class (project-root indexed-class) (defsubst phpinspect-cache-project-class (project-root indexed-class)
(phpinspect--project-add-class (phpinspect--project-add-class
@ -897,7 +897,7 @@ candidate. Candidates can be indexed functions and variables.")
(nreverse (nreverse
(append (alist-get (if static 'static-methods 'methods) (append (alist-get (if static 'static-methods 'methods)
index) index)
(apply 'append (apply #'append
(mapcar (lambda (class-fqn) (mapcar (lambda (class-fqn)
(phpinspect-get-cached-project-class-methods (phpinspect-get-cached-project-class-methods
project-root class-fqn static)) project-root class-fqn static))
@ -1015,7 +1015,7 @@ TODO:
;; else ;; else
(setq type-resolver (phpinspect--make-type-resolver (setq type-resolver (phpinspect--make-type-resolver
(phpinspect--uses-to-types (phpinspect--uses-to-types
(seq-filter 'phpinspect-use-p token-tree))))) (seq-filter #'phpinspect-use-p token-tree)))))
(let* ((previous-statement (phpinspect--get-last-statement-in-token (butlast enclosing-token 2))) (let* ((previous-statement (phpinspect--get-last-statement-in-token (butlast enclosing-token 2)))
(type-of-previous-statement (type-of-previous-statement
(phpinspect-get-type-of-derived-statement-in-token (phpinspect-get-type-of-derived-statement-in-token
@ -1039,7 +1039,7 @@ TODO:
(when method (when method
(let ((arg-count -1) (let ((arg-count -1)
(comma-count (comma-count
(length (seq-filter 'phpinspect-comma-p incomplete-token)))) (length (seq-filter #'phpinspect-comma-p incomplete-token))))
(concat (truncate-string-to-width (concat (truncate-string-to-width
(phpinspect--function-name method) 14) ": (" (phpinspect--function-name method) 14) ": ("
(mapconcat (mapconcat
@ -1073,10 +1073,10 @@ TODO:
(phpinspect-block-p elt))) (phpinspect-block-p elt)))
token))) token)))
(dolist (statement statements) (dolist (statement statements)
(cond ((seq-find 'phpinspect-assignment-p statement) (cond ((seq-find #'phpinspect-assignment-p statement)
(phpinspect--log "Found assignment statement") (phpinspect--log "Found assignment statement")
(push statement assignments)) (push statement assignments))
((setq code-block (seq-find 'phpinspect-block-p statement)) ((setq code-block (seq-find #'phpinspect-block-p statement))
(setq assignments (setq assignments
(append (append
(phpinspect--find-assignments-in-token code-block) (phpinspect--find-assignments-in-token code-block)
@ -1095,7 +1095,7 @@ TODO:
(all-assignments (phpinspect--find-assignments-in-token token))) (all-assignments (phpinspect--find-assignments-in-token token)))
(dolist (assignment all-assignments) (dolist (assignment all-assignments)
(if (or (member `(:variable ,variable-name) (if (or (member `(:variable ,variable-name)
(seq-take-while 'phpinspect-not-assignment-p (seq-take-while #'phpinspect-not-assignment-p
assignment)) assignment))
(and (phpinspect-list-p (car assignment)) (and (phpinspect-list-p (car assignment))
(member `(:variable ,variable-name) (car assignment)))) (member `(:variable ,variable-name) (car assignment))))
@ -1118,9 +1118,9 @@ ClassName::method();
$variable = ClassName::method(); $variable = ClassName::method();
$variable = $variable->method();" $variable = $variable->method();"
;; A derived statement can be an assignment itself. ;; A derived statement can be an assignment itself.
(when (seq-find 'phpinspect-assignment-p statement) (when (seq-find #'phpinspect-assignment-p statement)
(phpinspect--log "Derived statement is an assignment: %s" statement) (phpinspect--log "Derived statement is an assignment: %s" statement)
(setq statement (cdr (seq-drop-while 'phpinspect-not-assignment-p statement)))) (setq statement (cdr (seq-drop-while #'phpinspect-not-assignment-p statement))))
(phpinspect--log "Get derived statement type in block: %s" statement) (phpinspect--log "Get derived statement type in block: %s" statement)
(let* ((first-token (pop statement)) (let* ((first-token (pop statement))
(current-token) (current-token)
@ -1134,7 +1134,7 @@ $variable = $variable->method();"
;; that the caller is trying to derive. Therefore we just try to ;; that the caller is trying to derive. Therefore we just try to
;; resolve the type of the last bare word in the statement. ;; resolve the type of the last bare word in the statement.
(or (when (and (phpinspect-word-p first-token) (or (when (and (phpinspect-word-p first-token)
(seq-every-p 'phpinspect-word-p statement)) (seq-every-p #'phpinspect-word-p statement))
(setq statement (last statement)) (setq statement (last statement))
(funcall type-resolver (cadr (pop statement)))) (funcall type-resolver (cadr (pop statement))))
@ -1222,7 +1222,7 @@ resolve types of function argument variables."
(let* ((assignments (let* ((assignments
(phpinspect--find-assignments-of-variable-in-token variable-name php-block)) (phpinspect--find-assignments-of-variable-in-token variable-name php-block))
(last-assignment (when assignments (car (last assignments)))) (last-assignment (when assignments (car (last assignments))))
(right-of-assignment (when assignments (cdr (seq-drop-while 'phpinspect-not-assignment-p (right-of-assignment (when assignments (cdr (seq-drop-while #'phpinspect-not-assignment-p
last-assignment))))) last-assignment)))))
(phpinspect--log "Assignments: %s" assignments) (phpinspect--log "Assignments: %s" assignments)
(phpinspect--log "Last assignment: %s" right-of-assignment) (phpinspect--log "Last assignment: %s" right-of-assignment)
@ -1234,7 +1234,7 @@ resolve types of function argument variables."
(string= (cadar right-of-assignment) "new")) (string= (cadar right-of-assignment) "new"))
(funcall type-resolver (cadadr right-of-assignment))) (funcall type-resolver (cadadr right-of-assignment)))
((and (> (length right-of-assignment) 2) ((and (> (length right-of-assignment) 2)
(seq-find 'phpinspect-attrib-p right-of-assignment)) (seq-find #'phpinspect-attrib-p right-of-assignment))
(phpinspect--log "Variable was assigned with a derived statement") (phpinspect--log "Variable was assigned with a derived statement")
(phpinspect-get-derived-statement-type-in-block right-of-assignment (phpinspect-get-derived-statement-type-in-block right-of-assignment
php-block php-block
@ -1364,7 +1364,7 @@ said FQN's by class name"
(concat "\\" namespace "\\" type)) (concat "\\" namespace "\\" type))
;; Clas|interface|trait name ;; Clas|interface|trait name
(t (concat "\\" (or (assoc-default type types 'string=) (concat namespace "\\" type)))))) (t (concat "\\" (or (assoc-default type types #'string=) (concat namespace "\\" type))))))
(defun phpinspect-var-annotation-p (token) (defun phpinspect-var-annotation-p (token)
(phpinspect-type-p token :var-annotation)) (phpinspect-type-p token :var-annotation))
@ -1395,7 +1395,7 @@ said FQN's by class name"
(cadar (last declaration)) (cadar (last declaration))
;; @return annotation ;; @return annotation
(cadadr (cadadr
(seq-find 'phpinspect-return-annotation-p (seq-find #'phpinspect-return-annotation-p
comment-before))))) comment-before)))))
(phpinspect--make-function (phpinspect--make-function
:scope `(,(car scope)) :scope `(,(car scope))
@ -1411,7 +1411,7 @@ said FQN's by class name"
:name (cadr (cadr (cadr scope))))) :name (cadr (cadr (cadr scope)))))
(defun phpinspect--var-annotations-from-token (token) (defun phpinspect--var-annotations-from-token (token)
(seq-filter 'phpinspect-var-annotation-p token)) (seq-filter #'phpinspect-var-annotation-p token))
(defun phpinspect--index-variable-from-scope (type-resolver scope comment-before) (defun phpinspect--index-variable-from-scope (type-resolver scope comment-before)
"Index the variable inside `scope`." "Index the variable inside `scope`."
@ -1535,7 +1535,7 @@ said FQN's by class name"
(let ((constructor-parameter-type (let ((constructor-parameter-type
(car (alist-get (phpinspect--variable-name variable) (car (alist-get (phpinspect--variable-name variable)
(phpinspect--function-arguments constructor) (phpinspect--function-arguments constructor)
nil nil 'string=)))) nil nil #'string=))))
(if constructor-parameter-type (if constructor-parameter-type
(setf (phpinspect--variable-type variable) (setf (phpinspect--variable-type variable)
(funcall type-resolver constructor-parameter-type)))))))) (funcall type-resolver constructor-parameter-type))))))))
@ -1576,12 +1576,12 @@ namespace if not provided"
(cons type-name fqn))) (cons type-name fqn)))
(defun phpinspect--uses-to-types (uses) (defun phpinspect--uses-to-types (uses)
(mapcar 'phpinspect--use-to-type uses)) (mapcar #'phpinspect--use-to-type uses))
(defun phpinspect--index-namespace (namespace) (defun phpinspect--index-namespace (namespace)
(phpinspect--index-classes (phpinspect--index-classes
(phpinspect--uses-to-types (seq-filter 'phpinspect-use-p namespace)) (phpinspect--uses-to-types (seq-filter #'phpinspect-use-p namespace))
(seq-filter 'phpinspect-class-p namespace) (seq-filter #'phpinspect-class-p namespace)
(cadadr namespace))) (cadadr namespace)))
(defun phpinspect--index-namespaces (namespaces &optional indexed) (defun phpinspect--index-namespaces (namespaces &optional indexed)
@ -1589,9 +1589,9 @@ namespace if not provided"
(progn (progn
(push (phpinspect--index-namespace (pop namespaces)) indexed) (push (phpinspect--index-namespace (pop namespaces)) indexed)
(phpinspect--index-namespaces namespaces indexed)) (phpinspect--index-namespaces namespaces indexed))
(apply 'append (nreverse indexed)))) (apply #'append (nreverse indexed))))
(defun phpinspect--index-functions (&rest args) (defun phpinspect--index-functions (&rest _args)
"TODO: implement function indexation. This is a stub function.") "TODO: implement function indexation. This is a stub function.")
(defun phpinspect--index-tokens (tokens) (defun phpinspect--index-tokens (tokens)
@ -1599,10 +1599,10 @@ namespace if not provided"
`(phpinspect--root-index `(phpinspect--root-index
,(append ,(append
(append '(classes) (append '(classes)
(phpinspect--index-namespaces (seq-filter 'phpinspect-namespace-p tokens)) (phpinspect--index-namespaces (seq-filter #'phpinspect-namespace-p tokens))
(phpinspect--index-classes (phpinspect--index-classes
(phpinspect--uses-to-types (seq-filter 'phpinspect-use-p tokens)) (phpinspect--uses-to-types (seq-filter #'phpinspect-use-p tokens))
(seq-filter 'phpinspect-class-p tokens)))) (seq-filter #'phpinspect-class-p tokens))))
(functions)) (functions))
;; TODO: Implement function indexation ;; TODO: Implement function indexation
) )
@ -1643,7 +1643,7 @@ namespace if not provided"
(alist-get class-fqn (alist-get 'classes new-index) (alist-get class-fqn (alist-get 'classes new-index)
nil nil
nil nil
'string=))))))) #'string=)))))))
(defun phpinspect--index-current-buffer () (defun phpinspect--index-current-buffer ()
@ -1654,7 +1654,7 @@ namespace if not provided"
(phpinspect--index-tokens (phpinspect-parse-current-buffer))) (phpinspect--index-tokens (phpinspect-parse-current-buffer)))
(defun phpinspect--get-variables-for-class (buffer-classes class &optional static) (defun phpinspect--get-variables-for-class (buffer-classes class &optional static)
(let ((class-index (or (assoc-default class buffer-classes 'string=) (let ((class-index (or (assoc-default class buffer-classes #'string=)
(phpinspect--get-or-create-index-for-class-file class)))) (phpinspect--get-or-create-index-for-class-file class))))
(when class-index (when class-index
(if static (if static
@ -1667,7 +1667,7 @@ namespace if not provided"
"Extract all possible methods for a class from `buffer-classes` and the class index. "Extract all possible methods for a class from `buffer-classes` and the class index.
`buffer-classes` will be preferred because their data should be `buffer-classes` will be preferred because their data should be
more recent" more recent"
(let ((class-index (or (alist-get class buffer-classes nil nil 'string=) (let ((class-index (or (alist-get class buffer-classes nil nil #'string=)
(phpinspect--get-or-create-index-for-class-file class)))) (phpinspect--get-or-create-index-for-class-file class))))
(phpinspect--log "Getting methods for class (%s)" class) (phpinspect--log "Getting methods for class (%s)" class)
(phpinspect--log "index: %s" class-index) (phpinspect--log "index: %s" class-index)
@ -1677,7 +1677,7 @@ more recent"
;; TODO: Merge this somehow with phpinspect-get-cached-project-class-methods ;; TODO: Merge this somehow with phpinspect-get-cached-project-class-methods
(nreverse (nreverse
(append (alist-get (if static 'static-methods 'methods) class-index) (append (alist-get (if static 'static-methods 'methods) class-index)
(apply 'append (apply #'append
(mapcar (lambda (inherit-class) (mapcar (lambda (inherit-class)
(phpinspect--log "Inherit class: %s" inherit-class) (phpinspect--log "Inherit class: %s" inherit-class)
(phpinspect--get-methods-for-class (phpinspect--get-methods-for-class
@ -1693,24 +1693,29 @@ more recent"
"Initialize the phpinspect minor mode for the current buffer." "Initialize the phpinspect minor mode for the current buffer."
(make-local-variable 'company-backends) (make-local-variable 'company-backends)
(add-to-list 'company-backends 'phpinspect-company-backend) (add-to-list 'company-backends #'phpinspect-company-backend)
(make-local-variable 'eldoc-documentation-function) (set (make-local-variable 'eldoc-documentation-function)
(setq eldoc-documentation-function 'phpinspect-eldoc-function) #'phpinspect-eldoc-function)
(make-local-variable 'eldoc-message-commands) (make-local-variable 'eldoc-message-commands)
(eldoc-add-command 'c-electric-paren) (eldoc-add-command 'c-electric-paren)
(eldoc-add-command 'c-electric-backspace) (eldoc-add-command 'c-electric-backspace)
(phpinspect--after-save-action) (phpinspect--after-save-action)
(add-hook 'after-save-hook 'phpinspect--after-save-action nil 'local)) (add-hook 'after-save-hook #'phpinspect--after-save-action nil 'local))
(defun phpinspect--after-save-action () (defun phpinspect--after-save-action ()
"Hook that should be run after saving a buffer that has "This is intended to be run every time a phpinspect buffer is saved.
phpinspect-mode enabled. Indexes the entire buffer and updates
`phpinspect--buffer-index`. Merges the buffer index into the It indexes the entire buffer and updates
project-wide index afterwards." `phpinspect--buffer-index'. The buffer index is merged into the
(when (and (boundp phpinspect-mode) phpinspect-mode) project-wide index (stored in `phpinspect-cache') afterwards.
Assuming that files are only changed from within Emacs, this
keeps the cache valid. If changes are made outside of Emacs,
users will have to use \\[phpinspect-purge-cache]."
(when (and (boundp 'phpinspect-mode) phpinspect-mode)
(setq phpinspect--buffer-index (phpinspect--index-current-buffer)) (setq phpinspect--buffer-index (phpinspect--index-current-buffer))
(dolist (class (alist-get 'classes phpinspect--buffer-index)) (dolist (class (alist-get 'classes phpinspect--buffer-index))
(when class (when class
@ -1725,7 +1730,7 @@ project-wide index afterwards."
(kill-local-variable 'eldoc-message-commands)) (kill-local-variable 'eldoc-message-commands))
(defun phpinspect--mode-function () (defun phpinspect--mode-function ()
(if (and (boundp phpinspect-mode) phpinspect-mode) (if (and (boundp 'phpinspect-mode) phpinspect-mode)
(phpinspect--init-mode) (phpinspect--init-mode)
(phpinspect--disable-mode))) (phpinspect--disable-mode)))
@ -1812,11 +1817,11 @@ level of a token. Nested variables are ignored."
(let* ((class1-methods (alist-get 'methods (cdr class1))) (let* ((class1-methods (alist-get 'methods (cdr class1)))
(class1-variables (alist-get 'variables (cdr class1)))) (class1-variables (alist-get 'variables (cdr class1))))
(dolist (method (alist-get 'methods (cdr class2))) (dolist (method (alist-get 'methods (cdr class2)))
(add-to-list 'class1-methods method)) (cl-pushnew method class1-methods :test #'equal))
(setf (alist-get 'methods (cdr class1)) class1-methods) (setf (alist-get 'methods (cdr class1)) class1-methods)
(dolist (variable (alist-get 'variables (cdr class2))) (dolist (variable (alist-get 'variables (cdr class2)))
(add-to-list 'class1-variables variable)) (cl-pushnew variable class1-variables :test #'equal))
(setf (alist-get 'variables (cdr class1)) class1-variables)) (setf (alist-get 'variables (cdr class1)) class1-variables))
class1) class1)
@ -1907,7 +1912,7 @@ level of a token. Nested variables are ignored."
(defun phpinspect--make-type-resolver-for-namespace (namespace-token &optional token-tree) (defun phpinspect--make-type-resolver-for-namespace (namespace-token &optional token-tree)
(phpinspect--make-type-resolver (phpinspect--make-type-resolver
(phpinspect--uses-to-types (phpinspect--uses-to-types
(seq-filter 'phpinspect-use-p namespace-token)) (seq-filter #'phpinspect-use-p namespace-token))
token-tree token-tree
(cadadr namespace-token))) (cadadr namespace-token)))
@ -1967,7 +1972,7 @@ level of a token. Nested variables are ignored."
(phpinspect--suggest-variables-at-point token-tree incomplete-token))))) (phpinspect--suggest-variables-at-point token-tree incomplete-token)))))
(defun phpinspect-company-backend (command &optional arg &rest ignored) (defun phpinspect-company-backend (command &optional arg &rest _ignored)
(interactive (list 'interactive)) (interactive (list 'interactive))
(cond (cond
((eq command 'interactive) ((eq command 'interactive)
@ -2002,7 +2007,7 @@ level of a token. Nested variables are ignored."
completion))) completion)))
(seq-uniq (phpinspect--completion-list-completions (seq-uniq (phpinspect--completion-list-completions
completion-list) completion-list)
'string=))) #'string=)))
(setq phpinspect--last-completion-list completion-list) (setq phpinspect--last-completion-list completion-list)
candidates)) candidates))
((eq command 'annotation) ((eq command 'annotation)
@ -2042,7 +2047,7 @@ indexed classes in the project"))
(cl-defgeneric phpinspect--cache-getproject (cl-defgeneric phpinspect--cache-getproject
((cache phpinspect--cache) (project-name string)) ((cache phpinspect--cache) (project-name string))
"Get project that is located in `project-root`.") "Get project by PROJECT-NAME that is located in CACHE.")
(cl-defmethod phpinspect--cache-getproject (cl-defmethod phpinspect--cache-getproject
((cache phpinspect--cache) (project-root string)) ((cache phpinspect--cache) (project-root string))
@ -2050,7 +2055,9 @@ indexed classes in the project"))
(cl-defgeneric phpinspect--cache-get-project-create (cl-defgeneric phpinspect--cache-get-project-create
((cache phpinspect--cache) (project-root string)) ((cache phpinspect--cache) (project-root string))
"Get a project that is located in `project-root` from the cache. If no such project exists in the cache yet, it is created and then returned.") "Get a project that is located in PROJECT-ROOT from CACHE.
If no such project exists in the cache yet, it is created and
then returned.")
(cl-defmethod phpinspect--cache-get-project-create (cl-defmethod phpinspect--cache-get-project-create
((cache phpinspect--cache) (project-root string)) ((cache phpinspect--cache) (project-root string))
@ -2061,7 +2068,7 @@ indexed classes in the project"))
(cl-defgeneric phpinspect--project-add-class (cl-defgeneric phpinspect--project-add-class
((project phpinspect--project) (class (head phpinspect--class))) ((project phpinspect--project) (class (head phpinspect--class)))
"Add an indexed class to a `phpinspect--project`") "Add an indexed CLASS to PROJECT.")
(cl-defmethod phpinspect--project-add-class (cl-defmethod phpinspect--project-add-class
((project phpinspect--project) (class (head phpinspect--class))) ((project phpinspect--project) (class (head phpinspect--class)))
@ -2076,7 +2083,7 @@ indexed classes in the project"))
(cl-defgeneric phpinspect--project-get-class (cl-defgeneric phpinspect--project-get-class
((project phpinspect--project) (class-fqn string)) ((project phpinspect--project) (class-fqn string))
"Get indexed class by name of CLASS-FQN stored in PROJECT") "Get indexed class by name of CLASS-FQN stored in PROJECT.")
(cl-defmethod phpinspect--project-get-class (cl-defmethod phpinspect--project-get-class
((project phpinspect--project) (class-fqn string)) ((project phpinspect--project) (class-fqn string))
@ -2084,21 +2091,24 @@ indexed classes in the project"))
(phpinspect--project-class-index project))) (phpinspect--project-class-index project)))
(defun phpinspect--get-or-create-global-cache () (defun phpinspect--get-or-create-global-cache ()
"Get `phpinspect-cache'.
If its value is nil, it is created and then returned."
(or phpinspect-cache (or phpinspect-cache
(setq phpinspect-cache (phpinspect--make-cache)))) (setq phpinspect-cache (phpinspect--make-cache))))
(defun phpinspect-purge-cache () (defun phpinspect-purge-cache ()
"Assign a fresh, empty cache object to `phpinspect-cache'.
This effectively purges any cached code information from all
currently opened projects."
(interactive) (interactive)
(setq phpinspect-cache (phpinspect--make-cache))) (setq phpinspect-cache (phpinspect--make-cache)))
(defun phpinspect--locate-dominating-project-file (start-file) (defun phpinspect--locate-dominating-project-file (start-file)
"Locate the first dominating file in `phpinspect-project-root-file-list`. "Locate the first dominating file in `phpinspect-project-root-file-list`.
Starts looking at START-FILE and then recurses up the directory Starts looking at START-FILE and then recurses up the directory
hierarchy as long as no matching files are found. See also hierarchy as long as no matching files are found. See also
`locate-dominating-file`." `locate-dominating-file'."
(let ((dominating-file)) (let ((dominating-file))
(seq-find (lambda (file) (seq-find (lambda (file)
(setq dominating-file (locate-dominating-file start-file file))) (setq dominating-file (locate-dominating-file start-file file)))
@ -2109,7 +2119,7 @@ hierarchy as long as no matching files are found. See also
"(Attempt to) Find the root directory of the visited PHP project. "(Attempt to) Find the root directory of the visited PHP project.
If a found project root has a parent directory called \"vendor\", If a found project root has a parent directory called \"vendor\",
the search continues upwards. See also the search continues upwards. See also
`phpinspect--locate-dominating-project-file`. `phpinspect--locate-dominating-project-file'.
If START-FILE is provided, searching starts at the directory If START-FILE is provided, searching starts at the directory
level of START-FILE in stead of `default-directory`." level of START-FILE in stead of `default-directory`."
@ -2134,18 +2144,18 @@ level of START-FILE in stead of `default-directory`."
;;;###autoload ;;;###autoload
(defun phpinspect-fix-uses-interactive () (defun phpinspect-fix-uses-interactive ()
"Add missing use statements to the currently visited PHP file." "Add missing use statements to the currently visited PHP file."
(interactive) (interactive)
(save-buffer) (save-buffer)
(let* ((phpinspect-json (shell-command-to-string (let* ((phpinspect-json (shell-command-to-string
(format "cd %s && %s fxu --json %s" (format "cd %s && %s fxu --json %s"
(shell-quote-argument (phpinspect--get-project-root)) (shell-quote-argument (phpinspect--get-project-root))
(shell-quote-argument phpinspect-index-executable) (shell-quote-argument phpinspect-index-executable)
(shell-quote-argument buffer-file-name))))) (shell-quote-argument buffer-file-name)))))
(let* ((json-object-type 'hash-table) (let* ((json-object-type 'hash-table)
(json-array-type 'list) (json-array-type 'list)
(json-key-type 'string) (json-key-type 'string)
(phpinspect-json-data (json-read-from-string phpinspect-json))) (phpinspect-json-data (json-read-from-string phpinspect-json)))
(maphash 'phpinspect-handle-phpinspect-json phpinspect-json-data)))) (maphash #'phpinspect-handle-phpinspect-json phpinspect-json-data))))
(defun phpinspect-handle-phpinspect-json (class-name candidates) (defun phpinspect-handle-phpinspect-json (class-name candidates)
"Handle key value pair of classname and FQN's" "Handle key value pair of classname and FQN's"
@ -2157,6 +2167,7 @@ level of START-FILE in stead of `default-directory`."
(t (t
(phpinspect-add-use (completing-read "Class: " candidates)))))) (phpinspect-add-use (completing-read "Class: " candidates))))))
;; TODO: Implement this using the parser in stead of regexes.
(defun phpinspect-add-use (fqn) "Add use statement to a php file" (defun phpinspect-add-use (fqn) "Add use statement to a php file"
(save-excursion (save-excursion
(let ((current-char (point))) (let ((current-char (point)))

2
test/fixtures/Array.el → test/fixtures/Array.eld vendored
Unescape Escape View File

@ -1 +1 @@
(:root (:array (:string "item1") (:comma ",") (:string "item2") (:comma ",") (:string "item3")) (:terminator ";") (:array (:string "item1") (:fat-arrow "=>") (:string "item2") (:comma ",") (:string "item3") (:fat-arrow "=>") (:string "item4"))) (:root (:array (:string "item1") (:comma ",") (:string "item2") (:comma ",") (:string "item3")) (:terminator ";") (:array (:string "item1") (:fat-arrow "=>") (:string "item2") (:comma ",") (:string "item3") (:fat-arrow "=>") (:string "item4")))

2
test/fixtures/Block.el → test/fixtures/Block.eld vendored
Unescape Escape View File

@ -1 +1 @@
(:root (:block (:word "return") (:word "new") (:word "Response") (:list (:variable "this") (:object-attrib (:word "twig")) (:object-attrib (:word "render")) (:list (:string "domain/manage.html.twig") (:comma ",") (:array (:string "domain") (:fat-arrow "=>") (:variable "this") (:object-attrib (:word "repo")) (:object-attrib (:word "find")) (:list (:variable "name")) (:comma ",") (:string "users") (:fat-arrow "=>") (:variable "this") (:object-attrib (:word "user_repo")) (:object-attrib (:word "findBy")) (:list (:array (:string "domain") (:fat-arrow "=>") (:variable "name")))))) (:terminator ";"))) (:root (:block (:word "return") (:word "new") (:word "Response") (:list (:variable "this") (:object-attrib (:word "twig")) (:object-attrib (:word "render")) (:list (:string "domain/manage.html.twig") (:comma ",") (:array (:string "domain") (:fat-arrow "=>") (:variable "this") (:object-attrib (:word "repo")) (:object-attrib (:word "find")) (:list (:variable "name")) (:comma ",") (:string "users") (:fat-arrow "=>") (:variable "this") (:object-attrib (:word "user_repo")) (:object-attrib (:word "findBy")) (:list (:array (:string "domain") (:fat-arrow "=>") (:variable "name")))))) (:terminator ";")))

2
test/fixtures/Functions.el → test/fixtures/Functions.eld vendored
Unescape Escape View File

@ -1 +1 @@
(:root (:function (:declaration (:word "function") (:word "MergeTwoArraysAndSomeOtherStuff") (:list (:word "array") (:variable "array1") (:comma ",") (:variable "untyped_variable")) (:word "Response")) (:block (:variable "merged") (:assignment "=") (:word "array_merge") (:list (:variable "array_1") (:comma ",") (:variable "untyped_variable")) (:terminator ";") (:variable "mapped") (:assignment "=") (:word "arrap_map") (:list (:function (:declaration (:word "function") (:list (:variable "item"))) (:block (:word "return") (:variable "item") (:terminator ";"))) (:comma ",") (:variable "merged")) (:terminator ";") (:variable "user") (:assignment "=") (:variable "this") (:object-attrib (:word "user_repo")) (:object-attrib (:word "findOne")) (:list (:variable "req") (:object-attrib (:word "get")) (:list (:string "user"))) (:terminator ";") (:word "return") (:word "new") (:word "Response") (:list (:variable "this") (:object-attrib (:word "twig")) (:object-attrib (:word "render")) (:list (:string "address/create.html.twig") (:comma ",") (:array (:string "user") (:fat-arrow "=>") (:variable "user") (:comma ",")))) (:terminator ";"))) (:function (:declaration (:word "function") (:word "BeTheSecondFunctionInTheFile") (:list)) (:block (:word "return") (:array (:string "Very Impressive Result") (:fat-arrow "=>") (:variable "result")) (:terminator ";")))) (:root (:function (:declaration (:word "function") (:word "MergeTwoArraysAndSomeOtherStuff") (:list (:word "array") (:variable "array1") (:comma ",") (:variable "untyped_variable")) (:word "Response")) (:block (:variable "merged") (:assignment "=") (:word "array_merge") (:list (:variable "array_1") (:comma ",") (:variable "untyped_variable")) (:terminator ";") (:variable "mapped") (:assignment "=") (:word "arrap_map") (:list (:function (:declaration (:word "function") (:list (:variable "item"))) (:block (:word "return") (:variable "item") (:terminator ";"))) (:comma ",") (:variable "merged")) (:terminator ";") (:variable "user") (:assignment "=") (:variable "this") (:object-attrib (:word "user_repo")) (:object-attrib (:word "findOne")) (:list (:variable "req") (:object-attrib (:word "get")) (:list (:string "user"))) (:terminator ";") (:word "return") (:word "new") (:word "Response") (:list (:variable "this") (:object-attrib (:word "twig")) (:object-attrib (:word "render")) (:list (:string "address/create.html.twig") (:comma ",") (:array (:string "user") (:fat-arrow "=>") (:variable "user") (:comma ",")))) (:terminator ";"))) (:function (:declaration (:word "function") (:word "BeTheSecondFunctionInTheFile") (:list)) (:block (:word "return") (:array (:string "Very Impressive Result") (:fat-arrow "=>") (:variable "result")) (:terminator ";"))))

1
test/fixtures/IndexClass1-indexed.eld vendored
Unescape Escape View File

@ -0,0 +1 @@
(phpinspect--root-index (classes ("\\App\\Entity\\AuthToken" phpinspect--class (methods #s(phpinspect--function "getCreationTime" (:public) nil "\\DateTime") #s(phpinspect--function "isValid" (:public) nil "\\bool") #s(phpinspect--function "hasStudentRole" (:public) nil "\\bool") #s(phpinspect--function "getUser" (:public) nil "\\App\\Entity\\User") #s(phpinspect--function "getToken" (:public) nil "\\string") #s(phpinspect--function "__construct" (:public) (("token" "\\string") ("user" "\\App\\Entity\\User") ("valid" "\\bool") ("creation_time" "\\DateTime")) nil)) (class-name . "\\App\\Entity\\AuthToken") (static-methods) (static-variables) (variables #s(phpinspect--variable "creation_time" (:private) "\\DateTime") #s(phpinspect--variable "valid" (:private) "\\bool") #s(phpinspect--variable "user" (:private) "\\App\\Entity\\App\\\\Entity\\\\User") #s(phpinspect--variable "token" (:private) "\\string")) (constants) (extends) (implements))) (functions))

1
test/fixtures/IndexClass1.eld vendored
Unescape Escape View File

@ -0,0 +1 @@
(:root (:word "declare") (:list (:word "strict_types") (:assignment "=")) (:terminator ";") (:namespace (:word "App\\Entity") (:terminator ";") (:use (:word "Doctrine\\ORM\\Mapping") (:word "as") (:word "ORM") (:terminator ";")) (:doc-block (:annotation "ORM\\Entity")) (:class (:declaration (:word "class") (:word "AuthToken")) (:block (:private (:variable "token") (:terminator ";")) (:doc-block (:var-annotation (:word "App\\\\Entity\\\\User"))) (:private (:variable "user") (:terminator ";")) (:doc-block (:var-annotation (:word "bool"))) (:private (:variable "valid") (:terminator ";")) (:doc-block (:var-annotation (:word "\\DateTime"))) (:private (:variable "creation_time") (:terminator ";")) (:public (:function (:declaration (:word "function") (:word "__construct") (:list (:word "string") (:variable "token") (:comma ",") (:word "User") (:variable "user") (:comma ",") (:word "bool") (:variable "valid") (:assignment "=") (:word "false") (:comma ",") (:word "\\DateTime") (:variable "creation_time") (:assignment "=") (:word "null"))) (:block (:variable "this") (:object-attrib (:word "token")) (:assignment "=") (:variable "token") (:terminator ";") (:variable "this") (:object-attrib (:word "user")) (:assignment "=") (:variable "user") (:terminator ";") (:variable "this") (:object-attrib (:word "valid")) (:assignment "=") (:variable "valid") (:terminator ";") (:variable "this") (:object-attrib (:word "creation_time")) (:assignment "=") (:variable "creation_time") (:word "new") (:word "\\DateTime") (:list) (:terminator ";")))) (:public (:function (:declaration (:word "function") (:word "getToken") (:list) (:word "string")) (:block (:word "return") (:variable "this") (:object-attrib (:word "token")) (:terminator ";")))) (:public (:function (:declaration (:word "function") (:word "getUser") (:list) (:word "User")) (:block (:word "return") (:variable "this") (:object-attrib (:word "user")) (:terminator ";")))) (:public (:function (:declaration (:word "function") (:word "hasStudentRole") (:list) (:word "bool")) (:block (:word "return") (:variable "this") (:object-attrib (:word "role_student")) (:terminator ";")))) (:public (:function (:declaration (:word "function") (:word "isValid") (:list) (:word "bool")) (:block (:word "return") (:variable "this") (:object-attrib (:word "valid")) (:terminator ";")))) (:public (:function (:declaration (:word "function") (:word "getCreationTime") (:list) (:word "\\DateTime")) (:block (:word "return") (:variable "this") (:object-attrib (:word "creation_time")) (:terminator ";"))))))))

66
test/fixtures/IndexClass1.php vendored
Unescape Escape View File

@ -0,0 +1,66 @@
<?php
declare(strict_types=1);
namespace App\Entity;
use Doctrine\ORM\Mapping as ORM;
/**
* @ORM\Entity
*/
class AuthToken
{
private $token;
/**
* @var App\\Entity\\User
*/
private $user;
/**
* @var bool
*/
private $valid = false;
/**
* @var \DateTime
*/
private $creation_time;
public function __construct(
string $token,
User $user,
bool $valid = false,
?\DateTime $creation_time = null
) {
$this->token = $token;
$this->user = $user;
$this->valid = $valid;
$this->creation_time = $creation_time ?? new \DateTime();
}
public function getToken(): string
{
return $this->token;
}
public function getUser(): User
{
return $this->user;
}
public function hasStudentRole(): bool
{
return $this->role_student;
}
public function isValid(): bool
{
return $this->valid;
}
public function getCreationTime(): \DateTime
{
return $this->creation_time;
}
}

1
test/fixtures/IndexClass2-indexed.eld vendored
Unescape Escape View File

@ -0,0 +1 @@
(phpinspect--root-index (classes ("\\App\\Entity\\AuthToken" phpinspect--class (methods #s(phpinspect--function "getCreationTime" (:public) nil "\\DateTime") #s(phpinspect--function "anAddedFunction" (:public) nil nil) #s(phpinspect--function "isValid" (:public) nil "\\bool") #s(phpinspect--function "hasStudentRole" (:public) nil "\\bool") #s(phpinspect--function "getUser" (:public) nil "\\App\\Entity\\User") #s(phpinspect--function "getToken" (:public) nil "\\bool") #s(phpinspect--function "__construct" (:public) (("token" "\\string") ("user" "\\App\\Entity\\User") ("valid" "\\bool") ("creation_time" "\\DateTime")) nil)) (class-name . "\\App\\Entity\\AuthToken") (static-methods) (static-variables) (variables #s(phpinspect--variable "creation_time" (:private) "\\DateTime") #s(phpinspect--variable "valid" (:private) "\\bool") #s(phpinspect--variable "user" (:private) "\\App\\Entity\\App\\\\Entity\\\\User") #s(phpinspect--variable "extra" (:private) nil) #s(phpinspect--variable "token" (:private) "\\string")) (constants) (extends) (implements))) (functions))

1
test/fixtures/IndexClass2.eld vendored
Unescape Escape View File

@ -0,0 +1 @@
(:root (:word "declare") (:list (:word "strict_types") (:assignment "=")) (:terminator ";") (:namespace (:word "App\\Entity") (:terminator ";") (:use (:word "Doctrine\\ORM\\Mapping") (:word "as") (:word "ORM") (:terminator ";")) (:doc-block (:annotation "ORM\\Entity")) (:class (:declaration (:word "class") (:word "AuthToken")) (:block (:private (:variable "token") (:terminator ";")) (:private (:variable "extra") (:terminator ";")) (:doc-block (:var-annotation (:word "App\\\\Entity\\\\User"))) (:private (:variable "user") (:terminator ";")) (:doc-block (:var-annotation (:word "bool"))) (:private (:variable "valid") (:terminator ";")) (:doc-block (:var-annotation (:word "\\DateTime"))) (:private (:variable "creation_time") (:terminator ";")) (:public (:function (:declaration (:word "function") (:word "__construct") (:list (:word "string") (:variable "token") (:comma ",") (:word "User") (:variable "user") (:comma ",") (:word "bool") (:variable "valid") (:assignment "=") (:word "false") (:comma ",") (:word "\\DateTime") (:variable "creation_time") (:assignment "=") (:word "null"))) (:block (:variable "this") (:object-attrib (:word "token")) (:assignment "=") (:variable "token") (:terminator ";") (:variable "this") (:object-attrib (:word "user")) (:assignment "=") (:variable "user") (:terminator ";") (:variable "this") (:object-attrib (:word "valid")) (:assignment "=") (:variable "valid") (:terminator ";") (:variable "this") (:object-attrib (:word "creation_time")) (:assignment "=") (:variable "creation_time") (:word "new") (:word "\\DateTime") (:list) (:terminator ";")))) (:public (:function (:declaration (:word "function") (:word "getToken") (:list) (:word "bool")) (:block (:word "return") (:variable "this") (:object-attrib (:word "token")) (:terminator ";")))) (:public (:function (:declaration (:word "function") (:word "getUser") (:list) (:word "User")) (:block (:word "return") (:variable "this") (:object-attrib (:word "user")) (:terminator ";")))) (:public (:function (:declaration (:word "function") (:word "hasStudentRole") (:list) (:word "bool")) (:block (:word "return") (:variable "this") (:object-attrib (:word "role_student")) (:terminator ";")))) (:public (:function (:declaration (:word "function") (:word "isValid") (:list) (:word "bool")) (:block (:word "return") (:variable "this") (:object-attrib (:word "valid")) (:terminator ";")))) (:public (:function (:declaration (:word "function") (:word "anAddedFunction") (:list)) (:block (:word "return") (:variable "this") (:object-attrib (:word "extra")) (:terminator ";")))) (:public (:function (:declaration (:word "function") (:word "getCreationTime") (:list) (:word "\\DateTime")) (:block (:word "return") (:variable "this") (:object-attrib (:word "creation_time")) (:terminator ";"))))))))

73
test/fixtures/IndexClass2.php vendored
Unescape Escape View File

@ -0,0 +1,73 @@
<?php
declare(strict_types=1);
namespace App\Entity;
use Doctrine\ORM\Mapping as ORM;
/**
* @ORM\Entity
*/
class AuthToken
{
private $token;
private $extra;
/**
* @var App\\Entity\\User
*/
private $user;
/**
* @var bool
*/
private $valid = false;
/**
* @var \DateTime
*/
private $creation_time;
public function __construct(
string $token,
User $user,
bool $valid = false,
?\DateTime $creation_time = null
) {
$this->token = $token;
$this->user = $user;
$this->valid = $valid;
$this->creation_time = $creation_time ?? new \DateTime();
}
public function getToken(): bool
{
return $this->token;
}
public function getUser(): User
{
return $this->user;
}
public function hasStudentRole(): bool
{
return $this->role_student;
}
public function isValid(): bool
{
return $this->valid;
}
public function anAddedFunction()
{
return $this->extra;
}
public function getCreationTime(): \DateTime
{
return $this->creation_time;
}
}

2
test/fixtures/NamespacedClass.el → test/fixtures/NamespacedClass.eld vendored
Unescape Escape View File

@ -1 +1 @@
(:root (:word "declare") (:list (:word "strict_types") (:assignment "=")) (:terminator ";") (:namespace (:word "App\\Controller") (:terminator ";") (:use (:word "Symfony\\Component\\HttpFoundation\\Response") (:terminator ";")) (:use (:word "App\\Entity\\Address") (:terminator ";")) (:use (:word "Symfony\\Component\\HttpFoundation\\RedirectResponse") (:terminator ";")) (:use (:word "App\\Repository\\AddressRepository") (:terminator ";")) (:use (:word "App\\Repository\\UserRepository") (:terminator ";")) (:use (:word "Doctrine\\ORM\\EntityManagerInterface") (:terminator ";")) (:use (:word "Twig\\Environment") (:terminator ";")) (:use (:word "Symfony\\Component\\HttpFoundation\\Request") (:terminator ";")) (:use (:word "Symfony\\Component\\Routing\\Annotation\\Route") (:terminator ";")) (:class (:declaration (:word "class") (:word "AddressController")) (:block (:const (:word "A_CONSTANT_FOR_THE_SAKE_OF_HAVING_ONE") (:assignment "=") (:string "a value") (:terminator ";")) (:public (:const (:word "ARRAY_CONSTANT") (:assignment "=") (:array (:string "key") (:fat-arrow "=>") (:string "value") (:comma ",") (:string "key") (:fat-arrow "=>")) (:terminator ";"))) (:private (:variable "repo") (:terminator ";")) (:private (:variable "user_repo") (:terminator ";")) (:private (:variable "twig") (:terminator ";")) (:private (:variable "em") (:terminator ";")) (:public (:function (:declaration (:word "function") (:word "__construct") (:list (:word "AddressRepository") (:variable "repo") (:comma ",") (:word "UserRepository") (:variable "user_repo") (:comma ",") (:word "Environment") (:variable "twig") (:comma ",") (:word "EntityManagerInterface") (:variable "em"))) (:block (:variable "this") (:object-attrib (:word "repo")) (:assignment "=") (:variable "repo") (:terminator ";") (:variable "this") (:object-attrib (:word "user_repo")) (:assignment "=") (:variable "user_repo") (:terminator ";") (:variable "this") (:object-attrib (:word "twig")) (:assignment "=") (:variable "twig") (:terminator ";") (:variable "this") (:object-attrib (:word "em")) (:assignment "=") (:variable "em") (:terminator ";")))) (:doc-block (:annotation "Route")) (:public (:function (:declaration (:word "function") (:word "addAddressPage") (:list (:word "Request") (:variable "req")) (:word "Response")) (:block (:variable "user") (:assignment "=") (:variable "this") (:object-attrib (:word "user_repo")) (:object-attrib (:word "findOne")) (:list (:variable "req") (:object-attrib (:word "get")) (:list (:string "user"))) (:terminator ";") (:word "return") (:word "new") (:word "Response") (:list (:variable "this") (:object-attrib (:word "twig")) (:object-attrib (:word "render")) (:list (:string "address/create.html.twig") (:comma ",") (:array (:string "user") (:fat-arrow "=>") (:variable "user") (:comma ",")))) (:terminator ";")))) (:doc-block (:annotation "Route")) (:public (:function (:declaration (:word "function") (:word "addAddressAction") (:list (:word "Request") (:variable "req")) (:word "Response")) (:block (:variable "user") (:assignment "=") (:variable "this") (:object-attrib (:word "user_repo")) (:object-attrib (:word "findOne")) (:list (:variable "req") (:object-attrib (:word "request")) (:object-attrib (:word "get")) (:list (:string "user"))) (:terminator ";") (:variable "address_string") (:assignment "=") (:variable "req") (:object-attrib (:word "request")) (:object-attrib (:word "get")) (:list (:string "address")) (:terminator ";") (:variable "address") (:assignment "=") (:word "new") (:word "Address") (:list (:variable "user") (:comma ",") (:variable "address_string")) (:terminator ";") (:variable "this") (:object-attrib (:word "em")) (:object-attrib (:word "persist")) (:list (:variable "address")) (:terminator ";") (:variable "this") (:object-attrib (:word "em")) (:object-attrib (:word "flush")) (:list) (:terminator ";") (:word "return") (:word "new") (:word "RedirectResponse") (:list (:string "/user/") (:variable "user") (:object-attrib (:word "getLoginName")) (:list) (:string "/manage")) (:terminator ";")))) (:doc-block (:annotation "Route")) (:public (:function (:declaration (:word "function") (:word "deleteAddressAction") (:list (:word "Request") (:variable "req")) (:word "Response")) (:block (:variable "address") (:assignment "=") (:variable "this") (:object-attrib (:word "repo")) (:object-attrib (:word "find")) (:list (:variable "req") (:object-attrib (:word "request")) (:object-attrib (:word "get")) (:list (:string "address"))) (:terminator ";") (:variable "this") (:object-attrib (:word "em")) (:object-attrib (:word "remove")) (:list (:variable "address")) (:terminator ";") (:variable "this") (:object-attrib (:word "em")) (:object-attrib (:word "flush")) (:list) (:terminator ";") (:word "return") (:word "new") (:word "RedirectResponse") (:list (:string "/user/") (:variable "address") (:object-attrib (:word "getUser")) (:list) (:object-attrib (:word "getLoginName")) (:list) (:string "/manage")) (:terminator ";")))))))) (:root (:word "declare") (:list (:word "strict_types") (:assignment "=")) (:terminator ";") (:namespace (:word "App\\Controller") (:terminator ";") (:use (:word "Symfony\\Component\\HttpFoundation\\Response") (:terminator ";")) (:use (:word "App\\Entity\\Address") (:terminator ";")) (:use (:word "Symfony\\Component\\HttpFoundation\\RedirectResponse") (:terminator ";")) (:use (:word "App\\Repository\\AddressRepository") (:terminator ";")) (:use (:word "App\\Repository\\UserRepository") (:terminator ";")) (:use (:word "Doctrine\\ORM\\EntityManagerInterface") (:terminator ";")) (:use (:word "Twig\\Environment") (:terminator ";")) (:use (:word "Symfony\\Component\\HttpFoundation\\Request") (:terminator ";")) (:use (:word "Symfony\\Component\\Routing\\Annotation\\Route") (:terminator ";")) (:class (:declaration (:word "class") (:word "AddressController")) (:block (:const (:word "A_CONSTANT_FOR_THE_SAKE_OF_HAVING_ONE") (:assignment "=") (:string "a value") (:terminator ";")) (:public (:const (:word "ARRAY_CONSTANT") (:assignment "=") (:array (:string "key") (:fat-arrow "=>") (:string "value") (:comma ",") (:string "key") (:fat-arrow "=>")) (:terminator ";"))) (:private (:variable "repo") (:terminator ";")) (:private (:variable "user_repo") (:terminator ";")) (:private (:variable "twig") (:terminator ";")) (:private (:variable "em") (:terminator ";")) (:public (:function (:declaration (:word "function") (:word "__construct") (:list (:word "AddressRepository") (:variable "repo") (:comma ",") (:word "UserRepository") (:variable "user_repo") (:comma ",") (:word "Environment") (:variable "twig") (:comma ",") (:word "EntityManagerInterface") (:variable "em"))) (:block (:variable "this") (:object-attrib (:word "repo")) (:assignment "=") (:variable "repo") (:terminator ";") (:variable "this") (:object-attrib (:word "user_repo")) (:assignment "=") (:variable "user_repo") (:terminator ";") (:variable "this") (:object-attrib (:word "twig")) (:assignment "=") (:variable "twig") (:terminator ";") (:variable "this") (:object-attrib (:word "em")) (:assignment "=") (:variable "em") (:terminator ";")))) (:doc-block (:annotation "Route")) (:public (:function (:declaration (:word "function") (:word "addAddressPage") (:list (:word "Request") (:variable "req")) (:word "Response")) (:block (:variable "user") (:assignment "=") (:variable "this") (:object-attrib (:word "user_repo")) (:object-attrib (:word "findOne")) (:list (:variable "req") (:object-attrib (:word "get")) (:list (:string "user"))) (:terminator ";") (:word "return") (:word "new") (:word "Response") (:list (:variable "this") (:object-attrib (:word "twig")) (:object-attrib (:word "render")) (:list (:string "address/create.html.twig") (:comma ",") (:array (:string "user") (:fat-arrow "=>") (:variable "user") (:comma ",")))) (:terminator ";")))) (:doc-block (:annotation "Route")) (:public (:function (:declaration (:word "function") (:word "addAddressAction") (:list (:word "Request") (:variable "req")) (:word "Response")) (:block (:variable "user") (:assignment "=") (:variable "this") (:object-attrib (:word "user_repo")) (:object-attrib (:word "findOne")) (:list (:variable "req") (:object-attrib (:word "request")) (:object-attrib (:word "get")) (:list (:string "user"))) (:terminator ";") (:variable "address_string") (:assignment "=") (:variable "req") (:object-attrib (:word "request")) (:object-attrib (:word "get")) (:list (:string "address")) (:terminator ";") (:variable "address") (:assignment "=") (:word "new") (:word "Address") (:list (:variable "user") (:comma ",") (:variable "address_string")) (:terminator ";") (:variable "this") (:object-attrib (:word "em")) (:object-attrib (:word "persist")) (:list (:variable "address")) (:terminator ";") (:variable "this") (:object-attrib (:word "em")) (:object-attrib (:word "flush")) (:list) (:terminator ";") (:word "return") (:word "new") (:word "RedirectResponse") (:list (:string "/user/") (:variable "user") (:object-attrib (:word "getLoginName")) (:list) (:string "/manage")) (:terminator ";")))) (:doc-block (:annotation "Route")) (:public (:function (:declaration (:word "function") (:word "deleteAddressAction") (:list (:word "Request") (:variable "req")) (:word "Response")) (:block (:variable "address") (:assignment "=") (:variable "this") (:object-attrib (:word "repo")) (:object-attrib (:word "find")) (:list (:variable "req") (:object-attrib (:word "request")) (:object-attrib (:word "get")) (:list (:string "address"))) (:terminator ";") (:variable "this") (:object-attrib (:word "em")) (:object-attrib (:word "remove")) (:list (:variable "address")) (:terminator ";") (:variable "this") (:object-attrib (:word "em")) (:object-attrib (:word "flush")) (:list) (:terminator ";") (:word "return") (:word "new") (:word "RedirectResponse") (:list (:string "/user/") (:variable "address") (:object-attrib (:word "getUser")) (:list) (:object-attrib (:word "getLoginName")) (:list) (:string "/manage")) (:terminator ";"))))))))

2
test/fixtures/NamespacedFunctions.el → test/fixtures/NamespacedFunctions.eld vendored
Unescape Escape View File

@ -1 +1 @@
(:root (:namespace (:word "App\\Functions") (:terminator ";") (:function (:declaration (:word "function") (:word "MergeTwoArraysAndSomeOtherStuff") (:list (:word "array") (:variable "array1") (:comma ",") (:variable "untyped_variable")) (:word "Response")) (:block (:variable "merged") (:assignment "=") (:word "array_merge") (:list (:variable "array_1") (:comma ",") (:variable "untyped_variable")) (:terminator ";") (:variable "mapped") (:assignment "=") (:word "arrap_map") (:list (:function (:declaration (:word "function") (:list (:variable "item"))) (:block (:word "return") (:variable "item") (:terminator ";"))) (:comma ",") (:variable "merged")) (:terminator ";") (:variable "user") (:assignment "=") (:variable "this") (:object-attrib (:word "user_repo")) (:object-attrib (:word "findOne")) (:list (:variable "req") (:object-attrib (:word "get")) (:list (:string "user"))) (:terminator ";") (:word "return") (:word "new") (:word "Response") (:list (:variable "this") (:object-attrib (:word "twig")) (:object-attrib (:word "render")) (:list (:string "address/create.html.twig") (:comma ",") (:array (:string "user") (:fat-arrow "=>") (:variable "user") (:comma ",")))) (:terminator ";"))) (:function (:declaration (:word "function") (:word "BeTheSecondFunctionInTheFile") (:list)) (:block (:word "return") (:array (:string "Very Impressive Result") (:fat-arrow "=>") (:variable "result")) (:terminator ";"))))) (:root (:namespace (:word "App\\Functions") (:terminator ";") (:function (:declaration (:word "function") (:word "MergeTwoArraysAndSomeOtherStuff") (:list (:word "array") (:variable "array1") (:comma ",") (:variable "untyped_variable")) (:word "Response")) (:block (:variable "merged") (:assignment "=") (:word "array_merge") (:list (:variable "array_1") (:comma ",") (:variable "untyped_variable")) (:terminator ";") (:variable "mapped") (:assignment "=") (:word "arrap_map") (:list (:function (:declaration (:word "function") (:list (:variable "item"))) (:block (:word "return") (:variable "item") (:terminator ";"))) (:comma ",") (:variable "merged")) (:terminator ";") (:variable "user") (:assignment "=") (:variable "this") (:object-attrib (:word "user_repo")) (:object-attrib (:word "findOne")) (:list (:variable "req") (:object-attrib (:word "get")) (:list (:string "user"))) (:terminator ";") (:word "return") (:word "new") (:word "Response") (:list (:variable "this") (:object-attrib (:word "twig")) (:object-attrib (:word "render")) (:list (:string "address/create.html.twig") (:comma ",") (:array (:string "user") (:fat-arrow "=>") (:variable "user") (:comma ",")))) (:terminator ";"))) (:function (:declaration (:word "function") (:word "BeTheSecondFunctionInTheFile") (:list)) (:block (:word "return") (:array (:string "Very Impressive Result") (:fat-arrow "=>") (:variable "result")) (:terminator ";")))))

2
test/fixtures/ShortFunction.el → test/fixtures/ShortFunction.eld vendored
Unescape Escape View File

@ -1 +1 @@
(:root (:function (:declaration (:word "function") (:word "work") (:list)) (:block (:word "return") (:variable "variable") (:terminator ";")))) (:root (:function (:declaration (:word "function") (:word "work") (:list)) (:block (:word "return") (:variable "variable") (:terminator ";"))))

2
test/fixtures/SmallNamespacedClass.el → test/fixtures/SmallNamespacedClass.eld vendored
Unescape Escape View File

@ -1 +1 @@
(:root (:word "declare") (:list (:word "strict_types") (:assignment "=")) (:terminator ";") (:namespace (:word "App\\Controller") (:terminator ";") (:class (:declaration (:word "class") (:word "Controller")) (:block)))) (:root (:word "declare") (:list (:word "strict_types") (:assignment "=")) (:terminator ";") (:namespace (:word "App\\Controller") (:terminator ";") (:class (:declaration (:word "class") (:word "Controller")) (:block))))

2
test/fixtures/TwoShortFunctions.el → test/fixtures/TwoShortFunctions.eld vendored
Unescape Escape View File

@ -1 +1 @@
(:root (:function (:declaration (:word "function") (:word "work") (:list)) (:block (:word "return") (:variable "variable") (:terminator ";"))) (:function (:declaration (:word "function") (:word "work2") (:list)) (:block (:word "return") (:variable "paper") (:terminator ";")))) (:root (:function (:declaration (:word "function") (:word "work") (:list)) (:block (:word "return") (:variable "variable") (:terminator ";"))) (:function (:declaration (:word "function") (:word "work2") (:list)) (:block (:word "return") (:variable "paper") (:terminator ";"))))

1
test/fixtures/Variable.el vendored
Unescape Escape View File

@ -1 +0,0 @@
(:root (:variable "variable"))

1
test/fixtures/Variable.eld vendored
Unescape Escape View File

@ -0,0 +1 @@
(:root (:variable "variable"))

1
test/fixtures/Word.el vendored
Unescape Escape View File

@ -1 +0,0 @@
(:root (:word "bareword"))

1
test/fixtures/Word.eld vendored
Unescape Escape View File

@ -0,0 +1 @@
(:root (:word "bareword"))

53
test/fixtures/class-index-1-2-undestructive-merge.eld vendored
Unescape Escape View File

@ -0,0 +1,53 @@
(phpinspect--root-index
(classes
("\\App\\Entity\\AuthToken" phpinspect--class
(methods #s(phpinspect--function "getToken"
(:public)
nil "\\bool") ;; A changed function
#s(phpinspect--function "anAddedFunction"
(:public)
nil nil) ;; A new function
#s(phpinspect--function "getCreationTime"
(:public)
nil "\\DateTime")
#s(phpinspect--function "isValid"
(:public)
nil "\\bool")
#s(phpinspect--function "hasStudentRole"
(:public)
nil "\\bool")
#s(phpinspect--function "getUser"
(:public)
nil "\\App\\Entity\\User")
#s(phpinspect--function "getToken"
(:public)
nil "\\string")
#s(phpinspect--function "__construct"
(:public)
(("token" "\\string")
("user" "\\App\\Entity\\User")
("valid" "\\bool")
("creation_time" "\\DateTime"))
nil))
(class-name . "\\App\\Entity\\AuthToken")
(static-methods)
(static-variables)
(variables #s(phpinspect--variable "extra" ;; an added variable attribute
(:private)
nil)
#s(phpinspect--variable "creation_time"
(:private)
"\\DateTime")
#s(phpinspect--variable "valid"
(:private)
"\\bool")
#s(phpinspect--variable "user"
(:private)
"\\App\\Entity\\App\\\\Entity\\\\User")
#s(phpinspect--variable "token"
(:private)
"\\string"))
(constants)
(extends)
(implements)))
(functions))

46
test/phpinspect-test.el
Unescape Escape View File

@ -34,9 +34,9 @@
"/fixtures") "/fixtures")
"Directory with syntax trees of example PHP files.") "Directory with syntax trees of example PHP files.")
(defun phpinspect-test-read-fixture-tree (name) (defun phpinspect-test-read-fixture-data (name)
(with-temp-buffer (with-temp-buffer
(insert-file-contents-literally (concat phpinspect-test-php-file-directory "/" name ".el")) (insert-file-contents-literally (concat phpinspect-test-php-file-directory "/" name ".eld"))
(read (current-buffer)))) (read (current-buffer))))
(defun phpinspect-test-parse-fixture-code (name) (defun phpinspect-test-parse-fixture-code (name)
@ -46,64 +46,86 @@
(ert-deftest phpinspect-parse-namespaced-class () (ert-deftest phpinspect-parse-namespaced-class ()
"Test phpinspect-parse on a namespaced class" "Test phpinspect-parse on a namespaced class"
(should (should
(equal (phpinspect-test-read-fixture-tree "NamespacedClass") (equal (phpinspect-test-read-fixture-data "NamespacedClass")
(phpinspect-test-parse-fixture-code "NamespacedClass")))) (phpinspect-test-parse-fixture-code "NamespacedClass"))))
(ert-deftest phpinspect-parse-block () (ert-deftest phpinspect-parse-block ()
"Test phpinspect-parse for php blocks" "Test phpinspect-parse for php blocks"
(should (should
(equal (phpinspect-test-read-fixture-tree "Block") (equal (phpinspect-test-read-fixture-data "Block")
(phpinspect-test-parse-fixture-code "Block")))) (phpinspect-test-parse-fixture-code "Block"))))
(ert-deftest phpinspect-parse-functions () (ert-deftest phpinspect-parse-functions ()
"Test phpinspect-parse for php functions" "Test phpinspect-parse for php functions"
(should (should
(equal (phpinspect-test-read-fixture-tree "Functions") (equal (phpinspect-test-read-fixture-data "Functions")
(phpinspect-test-parse-fixture-code "Functions")))) (phpinspect-test-parse-fixture-code "Functions"))))
(ert-deftest phpinspect-parse-namespaced-functions () (ert-deftest phpinspect-parse-namespaced-functions ()
"Test phpinspect-parse for php blocks" "Test phpinspect-parse for php blocks"
(should (should
(equal (phpinspect-test-read-fixture-tree "NamespacedFunctions") (equal (phpinspect-test-read-fixture-data "NamespacedFunctions")
(phpinspect-test-parse-fixture-code "NamespacedFunctions")))) (phpinspect-test-parse-fixture-code "NamespacedFunctions"))))
(ert-deftest phpinspect-parse-variable () (ert-deftest phpinspect-parse-variable ()
"Test phpinspect-parse for php blocks" "Test phpinspect-parse for php blocks"
(should (should
(equal (phpinspect-test-read-fixture-tree "Variable") (equal (phpinspect-test-read-fixture-data "Variable")
(phpinspect-test-parse-fixture-code "Variable")))) (phpinspect-test-parse-fixture-code "Variable"))))
(ert-deftest phpinspect-parse-word () (ert-deftest phpinspect-parse-word ()
"Test phpinspect-parse for php blocks" "Test phpinspect-parse for php blocks"
(should (should
(equal (phpinspect-test-read-fixture-tree "Word") (equal (phpinspect-test-read-fixture-data "Word")
(phpinspect-test-parse-fixture-code "Word")))) (phpinspect-test-parse-fixture-code "Word"))))
(ert-deftest phpinspect-parse-array () (ert-deftest phpinspect-parse-array ()
"Test phpinspect-parse for php blocks" "Test phpinspect-parse for php blocks"
(should (should
(equal (phpinspect-test-read-fixture-tree "Array") (equal (phpinspect-test-read-fixture-data "Array")
(phpinspect-test-parse-fixture-code "Array")))) (phpinspect-test-parse-fixture-code "Array"))))
(ert-deftest phpinspect-parse-short-function () (ert-deftest phpinspect-parse-short-function ()
"Test phpinspect-parse for php blocks" "Test phpinspect-parse for php blocks"
(should (should
(equal (phpinspect-test-read-fixture-tree "ShortFunction") (equal (phpinspect-test-read-fixture-data "ShortFunction")
(phpinspect-test-parse-fixture-code "ShortFunction")))) (phpinspect-test-parse-fixture-code "ShortFunction"))))
(ert-deftest phpinspect-parse-two-short-functions () (ert-deftest phpinspect-parse-two-short-functions ()
"Test phpinspect-parse for php blocks" "Test phpinspect-parse for php blocks"
(should (should
(equal (phpinspect-test-read-fixture-tree "TwoShortFunctions") (equal (phpinspect-test-read-fixture-data "TwoShortFunctions")
(phpinspect-test-parse-fixture-code "TwoShortFunctions")))) (phpinspect-test-parse-fixture-code "TwoShortFunctions"))))
(ert-deftest phpinspect-parse-small-namespaced-class () (ert-deftest phpinspect-parse-small-namespaced-class ()
"Test phpinspect-parse for php blocks" "Test phpinspect-parse for php blocks"
(should (should
(equal (phpinspect-test-read-fixture-tree "SmallNamespacedClass") (equal (phpinspect-test-read-fixture-data "SmallNamespacedClass")
(phpinspect-test-parse-fixture-code "SmallNamespacedClass")))) (phpinspect-test-parse-fixture-code "SmallNamespacedClass"))))
;; If this test fails, the syntax tree has a breaking change in it. Regenerate the
;; fixtures and fix anything that is broken.
(ert-deftest phpinspect-syntax-tree-change ()
(let ((index (phpinspect--index-tokens
(phpinspect-test-parse-fixture-code "IndexClass1")))
(expected-result (phpinspect--index-tokens
(phpinspect-test-read-fixture-data "IndexClass1"))))
(should (equal index expected-result))))
(ert-deftest phpinspect-index-tokens ()
(should (equal
(phpinspect--index-tokens
(phpinspect-test-read-fixture-data "IndexClass1"))
(phpinspect-test-read-fixture-data "IndexClass1-indexed"))))
(ert-deftest phpinspect-merge-class-indexes ()
(should (equal
(phpinspect--merge-indexes
(phpinspect-test-read-fixture-data "IndexClass1-indexed")
(phpinspect-test-read-fixture-data "IndexClass2-indexed"))
(phpinspect-test-read-fixture-data
"class-index-1-2-undestructive-merge"))))
(provide 'phpinspect-test) (provide 'phpinspect-test)
;;; phpinspect-test.el ends here ;;; phpinspect-test.el ends here

11
test/util/generate-test-data.el
Unescape Escape View File

@ -10,4 +10,13 @@
(let ((result (phpinspect-parse-current-buffer))) (let ((result (phpinspect-parse-current-buffer)))
(with-temp-buffer (with-temp-buffer
(insert (prin1-to-string result)) (insert (prin1-to-string result))
(write-file (concat (string-remove-suffix ".php" file) ".el"))))))) (write-file (concat (string-remove-suffix ".php" file) ".eld"))))))
(dolist (class '("IndexClass1" "IndexClass2"))
(let ((index-class
(with-temp-buffer
(insert-file-contents-literally (concat here "/../fixtures/" class ".eld"))
(read (current-buffer)))))
(with-temp-buffer
(insert (prin1-to-string (phpinspect--index-tokens index-class)))
(write-file (concat here "/../fixtures/" class "-indexed.eld"))))))

Write Preview
Loading…
Cancel
Save