-
Notifications
You must be signed in to change notification settings - Fork 119
/
Copy pathphp-mode-test.el
980 lines (842 loc) · 42.9 KB
/
php-mode-test.el
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
;;; php-mode-test.el --- Tests for php-mode
;; Copyright (C) 2013 Daniel Hackney
;; 2014, 2015 Eric James Michael Ritz
;; Author: Daniel Hackney <[email protected]>
;; URL: https://github.com/emacs-php/php-mode
;;; License
;; This file 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 file 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 file; if not, write to the Free Software
;; Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
;; 02110-1301, USA.
;;; Commentary:
;; Automate tests from the "tests" directory using `ert', which comes bundled
;; with Emacs >= 24.1.
;;; Code:
(require 'php-mode)
(require 'php-project)
(require 'ert)
(require 'cl-lib)
(require 'imenu)
;; Work around bug #14325
;; <http://debbugs.gnu.org/cgi/bugreport.cgi?bug=14325>.
(c-after-font-lock-init)
(defvar php-mode-test-dir (expand-file-name "tests"
(if load-file-name
(file-name-directory load-file-name)
default-directory))
"Directory containing the `php-mode' test files.")
(defvar php-mode-test-valid-magics '(indent)
"List of allowed \"magic\" directives which can appear in test cases.")
(defvar php-mode-test-magic-regexp "###php-mode-test### \\((.+)\\)"
"Regexp which identifies a magic comment.")
;; cl-letf does not work for global function on Emacs 24.3 or lower versions
(when (and (= emacs-major-version 24) (<= emacs-minor-version 3))
(defun indent ()))
(defun php-mode-test-process-magics ()
"Process the test directives in the current buffer.
These are the ###php-mode-test### comments. Valid magics are
listed in `php-mode-test-valid-magics'; no other directives will
be processed."
(cl-letf (((symbol-function 'indent)
(lambda (offset) (equal (current-indentation) offset))))
(let (directives answers)
(save-excursion
(goto-char (point-min))
(while (re-search-forward php-mode-test-magic-regexp nil t)
(setq directives (read (buffer-substring (match-beginning 1)
(match-end 1))))
(setq answers
(append (mapcar (lambda (curr)
(let ((fn (car curr))
(args (mapcar 'eval (cdr-safe curr))))
(if (memq fn php-mode-test-valid-magics)
(apply fn args))))
directives)
answers))))
answers)))
(defun php-mode-test--buffer-face-list (buffer)
"Return list of (STRING . FACE) from `BUFFER'."
(with-temp-buffer
(jit-lock-mode -1)
(insert (with-current-buffer buffer (buffer-substring (point-min) (point-max))))
(goto-char (point-min))
(let (retval begin-pos last-face current-face str)
(setq last-face (get-text-property (point) 'face))
(setq begin-pos (point))
(forward-char 1)
(while (< (point) (point-max))
(setq current-face (get-text-property (point) 'face))
(unless (equal current-face last-face)
(setq str (buffer-substring-no-properties begin-pos (point)))
(setq retval (nconc retval (list (cons str last-face))))
(setq begin-pos (point))
(setq last-face current-face))
(forward-char 1))
(setq str (buffer-substring-no-properties begin-pos (point)))
(nconc retval (list (cons str last-face))))))
(defun php-mode-test--parse-list-file (file-path)
"Return list from `FILE-PATH'."
(with-temp-buffer
(insert-file-contents file-path)
(let ((read-circle t))
(read (current-buffer)))))
(cl-defmacro with-php-mode-test ((file &key style indent magic custom faces) &rest body)
"Set up environment for testing `php-mode'.
Execute BODY in a temporary buffer containing the contents of
FILE, in `php-mode'. Optional keyword `:style' can be used to set
the coding style to one of the following:
1. `pear'
2. `drupal'
3. `wordpress'
4. `symfony2'
5. `psr2'
Using any other symbol for STYLE results in undefined behavior.
The test will use the PHP style by default.
If the `:custom' keyword is set, customized variables are not reset to
their default state prior to starting the test. Use this if the test should
run with specific customizations set.
If the `:faces' keyword is set, read the file with `.faces' added to that
file name and check that the faces of the fonts in the buffer match."
(declare (indent 1))
`(with-temp-buffer
(setq php-mode-enable-backup-style-variables nil)
(insert-file-contents (expand-file-name ,file php-mode-test-dir))
(php-mode)
,(if (fboundp 'font-lock-ensure)
'(font-lock-ensure)
'(with-no-warnings (font-lock-fontify-buffer)))
,(cl-case style
(pear '(php-enable-pear-coding-style))
(drupal '(php-enable-drupal-coding-style))
(wordpress '(php-enable-wordpress-coding-style))
(symfony2 '(php-enable-symfony2-coding-style))
(psr2 '(php-enable-psr2-coding-style))
(t '(php-enable-default-coding-style)))
,(unless custom '(custom-set-variables '(php-lineup-cascaded-calls nil)))
,(if indent
'(let ((inhibit-message t)) (indent-region (point-min) (point-max))))
,(if magic
'(should (cl-reduce (lambda (l r) (and l r))
(php-mode-test-process-magics))))
,(if faces
`(should (equal
(php-mode-test--parse-list-file
(concat (expand-file-name ,file php-mode-test-dir) ".faces"))
(php-mode-test--buffer-face-list (current-buffer)))))
(goto-char (point-min))
(let ((case-fold-search nil))
,@body)))
(ert-deftest php-mode-test-namespace-block ()
"Proper indentation for classs and functions in namespace block."
(with-php-mode-test ("namespace-block.php" :indent t :magic t)))
(ert-deftest php-mode-test-issue-8 ()
"Annotation highlighting."
(with-php-mode-test ("issue-8.php" :faces t)))
(ert-deftest php-mode-test-issue-9 ()
"Single quote in text in HTML misinterpreted.
The next character after \">We\" is a single quote. It should not
have a string face."
:expected-result :failed
(with-php-mode-test ("issue-9.php")
(search-forward ">We")
(forward-char) ;; Jump to after the opening apostrophe
(should-not (eq
(get-text-property (point) 'face)
'php-string))))
(ert-deftest php-mode-test-issue-14 ()
"Array indentation."
(with-php-mode-test ("issue-14.php" :indent t :magic t)))
(ert-deftest php-mode-test-issue-16 ()
"Comma separated \"use\" (namespaces).
Gets the face of the text after the comma."
(with-php-mode-test ("issue-16.php")
(re-search-forward "^use " nil nil 3)
(should (eq
(get-text-property (search-forward ", ") 'face)
'font-lock-type-face))))
(ert-deftest php-mode-test-issue-18 ()
"Indentation of strings which include \"//\"."
(with-php-mode-test ("issue-18.php" :indent t :magic t)))
(ert-deftest php-mode-test-issue-19 ()
"Alignment of arrow operators."
(custom-set-variables '(php-lineup-cascaded-calls t))
(with-php-mode-test ("issue-19.php" :indent t :custom t)
(while (search-forward "$object->" (point-max) t)
;; Point is just after `->'
(let ((col (current-column)))
(search-forward "->")
(should (= (current-column) col)))))
;; Test indentation again, but without php-lineup-cascaded-calls enabled
(with-php-mode-test ("issue-19.php" :indent t)
(while (search-forward "\\($object->\\)" (point-max) t)
(match-beginning 0)
;; Point is just on `$'
(let ((col (current-column)))
(search-forward "->")
(should (= (current-column) (+ col c-basic-offset)))))))
(ert-deftest php-mode-test-issue-21 ()
"Font locking multi-line string."
(with-php-mode-test ("issue-21.php")
(search-forward "= ")
(while (not (looking-at ";"))
(should (eq (get-text-property (point) 'face)
'php-string))
(forward-char))))
(ert-deftest php-mode-test-issue-22 ()
"Font lock quotes within comments as regular comments.
This applies for both single and double quotes."
(with-php-mode-test ("issue-21.php")
(while (search-forward "#" nil t)
(while (not (looking-at "\n"))
(should (eq (get-text-property (point) 'face)
'font-lock-comment-face))
(forward-char)))))
(ert-deftest php-mode-test-issue-27 ()
"Indentation in a file with a shebang."
(with-php-mode-test ("issue-27.php" :indent t :magic t)))
(ert-deftest php-mode-test-issue-28 ()
"Slowdown when scrolling.
No obvious way to test this. One possibility is to record time it
takes to scroll down the whole buffer using `next-line'. This may
not cause the desired fontification, and it could take different
amounts of time on different machines, so an absolute time would
not be very useful.
This doesn't test anything, for now."
(should t))
(ert-deftest php-mode-test-issue-29 ()
"Indentation of anonymous functions as arguments.
The closing brace and parenthesis should be at column 0."
(with-php-mode-test ("issue-29.php" :indent t :magic t)))
(ert-deftest php-mode-test-issue-42 ()
"Error while indenting closures.
If the bug has been fixed, indenting the buffer should not cause
an error."
(with-php-mode-test ("issue-42.php" :indent t)))
(ert-deftest php-mode-test-issue-53 ()
"Check if whitespace effects are undone when changing coding
style from Drupal."
(with-php-mode-test
("issue-53.php")
(search-forward "return $this->bar;")
;; the file written to has no significance, only the buffer
(let ((tmp-filename (concat (make-temp-name temporary-file-directory) ".php")))
(dolist (mode '(pear wordpress symfony2))
(php-set-style "drupal")
(php-set-style (symbol-name mode))
(should-not show-trailing-whitespace)
(php-set-style "psr2")
(php-set-style (symbol-name mode))
(should-not show-trailing-whitespace)
(php-set-style "drupal")
(write-file tmp-filename)
(should (looking-at-p "$"))))))
(ert-deftest php-mode-test-issue-73 ()
"The `delete-indentation' function should work properly for PHP.
This means modifying the logic of `fixup-whitespace' so that it
eliminates spaces before ',', ';', '->' amd '::' and after '->' and
'::'."
(with-php-mode-test ("issue-73.php")
(when (search-forward "# Correct" nil t)
(forward-line 1)
(let ((correct-line (thing-at-point 'line)))
(while (search-forward "# Test" nil t)
(forward-line 1)
(let ((current-line (line-number-at-pos)))
(catch 'eob
(while (not (looking-at-p "$"))
(unless (zerop (forward-line 1))
(throw 'eob t))))
(forward-line -1)
(while (not (eq (line-number-at-pos) current-line))
(delete-indentation))
(beginning-of-line)
(should (string= (thing-at-point 'line) correct-line))))))))
(ert-deftest php-mode-test-issue-83 ()
"All static method should appear on imenu whether 'static' keyword is placed before or after visibility"
(with-php-mode-test
("issue-83.php")
(let* ((index-alist (imenu--make-index-alist))
(public-methods (mapcar 'car (cdr (assoc "Public Methods" index-alist))))
(all-methods (mapcar 'car (cdr (assoc "All Methods" index-alist)))))
(should (member "staticBeforeVisibility" public-methods))
(should (member "staticBeforeVisibility" all-methods))
(should (member "staticAfterVisibility" public-methods))
(should (member "staticAfterVisibility" all-methods)))))
(ert-deftest php-mode-test-issue-99 ()
"Proper indentation for 'foreach' statements without braces."
(with-php-mode-test ("issue-99.php" :indent t :magic t)))
(ert-deftest php-mode-test-issue-115 ()
"Proper alignment for chained method calls inside arrays."
(custom-set-variables '(php-lineup-cascaded-calls t))
(with-php-mode-test ("issue-115.php" :indent t :magic t :custom t)))
(ert-deftest php-mode-test-issue-135 ()
"Proper alignment multiline statements."
(custom-set-variables '(php-lineup-cascaded-calls t))
(with-php-mode-test ("issue-135.php" :indent t :magic t :custom t)))
(ert-deftest php-mode-test-issue-130 ()
"Proper alignment array elements."
(with-php-mode-test ("issue-130.php" :indent t :magic t)))
(ert-deftest php-mode-test-issue-124 ()
"Proper syntax propertizing when a quote appears in a heredoc."
(with-php-mode-test ("issue-124.php" :indent t)
(search-forward "Start of heredoc")
;; The heredoc should be recognized as a string.
(dolist (syntax (c-guess-basic-syntax))
(should (eq (car syntax) 'string)))
(search-forward "function bar")
;; After the heredoc should *not* be recognized as a string.
(dolist (syntax (c-guess-basic-syntax))
(should (not (eq (car syntax) 'string))))))
(ert-deftest php-mode-test-issue-136 ()
"Proper highlighting for variable interpolation."
(with-php-mode-test ("issue-136.php") :faces t))
(ert-deftest php-mode-test-issue-144 ()
"Indentation test '#' comment line has single quote."
(with-php-mode-test ("issue-144.php" :indent t)
(search-forward "$a" nil nil 3)
(should (= (current-indentation) c-basic-offset))))
(ert-deftest php-mode-test-issue-145 ()
"Closure indentation."
(with-php-mode-test ("issue-145.php" :indent t)))
(ert-deftest php-mode-test-comments ()
"Proper highlighting for comments and doc-blocks."
(with-php-mode-test ("comments.php")
(search-forward "/**")
(should (eq (get-text-property (match-beginning 0) 'face)
'font-lock-doc-face))
(search-forward "@copyright")
(should (equal (get-text-property (match-beginning 0) 'face)
'(php-doc-annotation-tag font-lock-doc-face)))
(search-forward-regexp "@link +\\(https://github.com/emacs-php/php-mode\\)")
(should (equal (get-text-property (match-beginning 1) 'face)
'(link font-lock-doc-face)))
(search-forward-regexp "@package +\\(Emacs\\\\PHPMode\\)")
(should (equal (get-text-property (match-beginning 0) 'face)
'(php-doc-annotation-tag font-lock-doc-face)))
(should (equal (get-text-property (match-beginning 1) 'face)
'(php-string font-lock-doc-face)))
(search-forward-regexp "// \\(@annotation This is NOT annotation. 1\\)")
(should (eq (get-text-property (match-beginning 0) 'face)
'font-lock-comment-delimiter-face))
(should (eq (get-text-property (match-beginning 1) 'face)
'font-lock-comment-face))
(search-forward-regexp "\\* \\(@annotation This is NOT annotation. 2\\)")
(should (eq (get-text-property (match-beginning 0) 'face)
'font-lock-comment-face))
(should (eq (get-text-property (match-beginning 1) 'face)
'font-lock-comment-face))
;; Comment outed doc-block
(search-forward "/**")
(should (eq (get-text-property (match-beginning 0) 'face)
'font-lock-comment-face))
(search-forward-regexp "\\* \\(@annotation This is NOT annotation. 3\\)")
(should (equal (get-text-property (match-beginning 0) 'face)
'font-lock-comment-face))
(should (equal (get-text-property (match-beginning 1) 'face)
'font-lock-comment-face))
(search-forward "class CommentOuted")
(should (eq (get-text-property (match-beginning 0) 'face)
'font-lock-comment-face))
;; Class level doc-comment
(search-forward-regexp "{@internal \\(Description\\)}")
(should (equal (get-text-property (match-beginning 0) 'face)
'(php-doc-annotation-tag font-lock-doc-face)))
(should (equal (get-text-property (match-beginning 1) 'face)
'(php-string php-doc-annotation-tag font-lock-doc-face)))
(should (equal (get-text-property (1- (match-end 0)) 'face)
'(php-doc-annotation-tag font-lock-doc-face)))
(should (equal (get-text-property (match-end 0) 'face)
'font-lock-doc-face))
(search-forward-regexp "@property\\(-read\\)")
(should (equal (get-text-property (match-beginning 0) 'face)
'(php-doc-annotation-tag font-lock-doc-face)))
(should (equal (get-text-property (match-beginning 1) 'face)
'(php-doc-annotation-tag font-lock-doc-face)))
(search-forward-regexp "@ORM\\(\\\\Table\\)")
(should (equal (get-text-property (match-beginning 0) 'face)
'(php-doc-annotation-tag font-lock-doc-face)))
(should (equal (get-text-property (match-beginning 1) 'face)
'(php-doc-annotation-tag font-lock-doc-face)))
(search-forward-regexp "@var \\(string\\) \\(sample property doc-comment\\)")
(should (equal (get-text-property (match-beginning 0) 'face)
'(php-doc-annotation-tag font-lock-doc-face)))
(should (equal (get-text-property (match-beginning 1) 'face)
'(font-lock-type-face php-string font-lock-doc-face)))
(should (equal (get-text-property (match-beginning 2) 'face)
'font-lock-doc-face))
(search-forward-regexp "// \\(comment in after code\\)")
(should (eq (get-text-property (match-beginning 0) 'face)
'font-lock-comment-delimiter-face))
(should (eq (get-text-property (match-beginning 1) 'face)
'font-lock-comment-face))
(search-forward-regexp "@var \\(string\\)|\\(bool\\)|\\(array\\)\\([[]]\\)|\\(ArrayObject\\) \\*/$")
(should (equal (get-text-property (match-beginning 0) 'face) ;; matches `@'
'(php-doc-annotation-tag font-lock-doc-face)))
(should (equal (get-text-property (match-beginning 1) 'face) ;; matches `s'
'(font-lock-type-face php-string font-lock-doc-face)))
(should (equal (get-text-property (match-end 1) 'face) ;; matches `|'
'(php-string font-lock-doc-face)))
(should (equal (get-text-property (match-beginning 2) 'face) ;; matches `b'
'(font-lock-type-face php-string font-lock-doc-face)))
(should (equal (get-text-property (match-end 2) 'face) ;; matches `|'
'(php-string font-lock-doc-face)))
(should (equal (get-text-property (match-beginning 3) 'face) ;; matches `a'
'(font-lock-type-face php-string font-lock-doc-face)))
(should (equal (get-text-property (match-beginning 4) 'face) ;; matches `['
'(php-string font-lock-doc-face)))
(should (equal (get-text-property (match-end 4) 'face) ;; matches `|'
'(php-string font-lock-doc-face)))
(should (equal (get-text-property (match-beginning 5) 'face) ;; matches `A'
'(php-string font-lock-doc-face)))
(should (equal (get-text-property (match-end 5) 'face) ;; matches ` '
' font-lock-doc-face))
(search-forward-regexp "// \\(one-line comment\\)")
(should (eq (get-text-property (match-beginning 0) 'face)
'font-lock-comment-delimiter-face))
(should (eq (get-text-property (match-beginning 1) 'face)
'font-lock-comment-face))
(search-forward-regexp "// \\(@annotation This is NOT annotation. 4\\)")
(should (eq (get-text-property (match-beginning 0) 'face)
'font-lock-comment-delimiter-face))
(should (eq (get-text-property (match-beginning 1) 'face)
'font-lock-comment-face))
(search-forward-regexp "@var \\(int\\) \\(internal linter variable\\) \\*/$")
(should (equal (get-text-property (match-beginning 0) 'face) ;; matches `@'
'(php-doc-annotation-tag font-lock-doc-face)))
(should (equal (get-text-property (match-beginning 1) 'face) ;; matches `i'
'(font-lock-type-face php-string font-lock-doc-face)))
(should (equal (get-text-property (match-end 1) 'face) ;; matches ` '
'font-lock-doc-face))
(should (equal (get-text-property (match-beginning 2) 'face) ;; matches `i'
'font-lock-doc-face))
(should (equal (get-text-property (match-end 2) 'face) ;; matches ` '
'font-lock-doc-face))
(search-forward-regexp "@throws \\(\\\\RuntimeException\\)$")
(should (equal (get-text-property (match-beginning 0) 'face) ;; matches `@'
'(php-doc-annotation-tag font-lock-doc-face)))
(should (equal (get-text-property (match-beginning 1) 'face) ;; matches `\'
'(php-string font-lock-doc-face)))
(should (equal (get-text-property (1+ (match-beginning 1)) 'face) ;; matches `R'
'(php-string font-lock-doc-face)))))
(ert-deftest php-mode-test-comment-return-type ()
"Proper highlighting for type annotation in doc-block."
(with-php-mode-test ("doc-comment-return-type.php")
;; Test for premitive type (int)
(search-forward-regexp "@return \\(int\\) +\\(A integer value\\)")
(should (equal (get-text-property (match-beginning 1) 'face) ;; matches `i'
'(font-lock-type-face php-string font-lock-doc-face)))
(should (eq (get-text-property (match-beginning 2) 'face) ;; matches `A'
'font-lock-doc-face))
(search-forward-regexp "@return \\(\\?int\\) +\\(A nullable integer value\\)")
(should (equal (get-text-property (match-beginning 1) 'face) ;; matches `?'
'(php-string font-lock-doc-face)))
(should (equal (get-text-property (1+ (match-beginning 1)) 'face) ;; matches `i'
'(font-lock-type-face php-string font-lock-doc-face)))
(should (eq (get-text-property (match-beginning 2) 'face) ;; matches `A'
'font-lock-doc-face))
(search-forward-regexp "@return \\(\\int\\[\\]\\) +\\(A list of integer values\\)")
(should (equal (get-text-property (match-beginning 1) 'face) ;; matches `i'
'(font-lock-type-face php-string font-lock-doc-face)))
(should (equal (get-text-property (1- (match-end 1)) 'face) ;; matches `]'
'(php-string font-lock-doc-face)))
(should (eq (get-text-property (match-beginning 2) 'face) ;; matches `A'
'font-lock-doc-face))
;; Test for class type (DateTime)
(search-forward-regexp "@return \\(DateTime\\) +\\(A DateTime object value\\)")
(should (equal (get-text-property (match-beginning 1) 'face) ;; matches `D'
'(php-string font-lock-doc-face)))
(should (eq (get-text-property (match-beginning 2) 'face) ;; matches `A'
'font-lock-doc-face))
(search-forward-regexp "@return \\(\\?DateTime\\) +\\(A nullable DateTime object value\\)")
(should (equal (get-text-property (match-beginning 1) 'face) ;; matches `?'
'(php-string font-lock-doc-face)))
(should (equal (get-text-property (1+ (match-beginning 1)) 'face) ;; matches `D'
'(php-string font-lock-doc-face)))
(should (eq (get-text-property (match-beginning 2) 'face) ;; matches `A'
'font-lock-doc-face))
(search-forward-regexp "@return \\(\\DateTime\\[]\\) +\\(A list of DateTime object values\\)")
(should (equal (get-text-property (match-beginning 1) 'face) ;; matches `D'
'(php-string font-lock-doc-face)))
(should (equal (get-text-property (1- (match-end 1)) 'face) ;; matches `]'
'(php-string font-lock-doc-face)))
(should (eq (get-text-property (match-beginning 2) 'face) ;; matches `A'
'font-lock-doc-face))
;; Test for class type (stdClass)
(search-forward-regexp "@return \\(stdClass\\) +\\(A stdClass object value\\)")
(should (equal (get-text-property (match-beginning 1) 'face) ;; matches `s'
'(php-string font-lock-doc-face)))
(should (eq (get-text-property (match-beginning 2) 'face) ;; matches `A'
'font-lock-doc-face))
(search-forward-regexp "@return \\(\\?stdClass\\) +\\(A nullable stdClass object value\\)")
(should (equal (get-text-property (match-beginning 1) 'face) ;; matches `?'
'(php-string font-lock-doc-face)))
(should (equal (get-text-property (1+ (match-beginning 1)) 'face) ;; matches `s'
'(php-string font-lock-doc-face)))
(should (eq (get-text-property (match-beginning 2) 'face) ;; matches `A'
'font-lock-doc-face))
(search-forward-regexp "@return \\(stdClass\\[]\\) +\\(A list of stdClass object values\\)")
(should (equal (get-text-property (match-beginning 1) 'face) ;; matches `s'
'(php-string font-lock-doc-face)))
(should (equal (get-text-property (1- (match-end 1)) 'face) ;; matches `]'
'(php-string font-lock-doc-face)))
(should (eq (get-text-property (match-beginning 2) 'face) ;; matches `A'
'font-lock-doc-face))
;; Test for class type (\App\User)
(search-forward-regexp "@return \\(\\\\App\\\\User\\) +\\(A \\\\App\\\\User object value\\)")
(should (equal (get-text-property (match-beginning 1) 'face) ;; matches `\'
'(php-string font-lock-doc-face)))
(should (equal (get-text-property (1+ (match-beginning 1)) 'face) ;; matches `A'
'(php-string font-lock-doc-face)))
(should (eq (get-text-property (match-beginning 2) 'face) ;; matches `A'
'font-lock-doc-face))
(search-forward-regexp "@return \\(\\?\\\\App\\\\User\\) +\\(A nullable \\\\App\\\\User object value\\)")
(should (equal (get-text-property (match-beginning 1) 'face) ;; matches `?'
'(php-string font-lock-doc-face)))
(should (equal (get-text-property (1+ (match-beginning 1)) 'face) ;; matches `\\'
'(php-string font-lock-doc-face)))
(should (eq (get-text-property (match-beginning 2) 'face) ;; matches `A'
'font-lock-doc-face))
(search-forward-regexp "@return \\(\\\\App\\\\User\\[]\\) +\\(A list of \\\\App\\\\User object values\\)")
(should (equal (get-text-property (match-beginning 1) 'face) ;; matches `\'
'(php-string font-lock-doc-face)))
(should (equal (get-text-property (1- (match-end 1)) 'face) ;; matches `]'
'(php-string font-lock-doc-face)))
(should (eq (get-text-property (match-beginning 2) 'face) ;; matches `A'
'font-lock-doc-face))
;; Test for multiple types
(search-forward-regexp "@return \\(int\\)\\(|\\)\\(string\\) +\\(Multiple types by int and string\\)")
(should (equal (get-text-property (match-beginning 1) 'face) ;; matches `i'
'(font-lock-type-face php-string font-lock-doc-face)))
(should (equal (get-text-property (match-beginning 2) 'face) ;; matches `|'
'(php-string font-lock-doc-face)))
(should (equal (get-text-property (match-beginning 3) 'face) ;; matches `s'
'(font-lock-type-face php-string font-lock-doc-face)))
(should (eq (get-text-property (match-beginning 4) 'face) ;; matches `M'
'font-lock-doc-face))
(search-forward-regexp "@return \\(int\\[]\\)\\(|\\)\\(string\\) +\\(Multiple types by list of int and string\\)")
(should (equal (get-text-property (match-beginning 1) 'face) ;; matches `i'
'(font-lock-type-face php-string font-lock-doc-face)))
(should (equal (get-text-property (1- (match-end 1)) 'face) ;; matches `]'
'(php-string font-lock-doc-face)))
(should (equal (get-text-property (match-beginning 2) 'face) ;; matches `|'
'(php-string font-lock-doc-face)))
(should (equal (get-text-property (match-beginning 3) 'face) ;; matches `s'
'(font-lock-type-face php-string font-lock-doc-face)))
(should (eq (get-text-property (match-beginning 4) 'face) ;; matches `M'
'font-lock-doc-face))
(search-forward-regexp "@return \\(int\\)\\(|\\)\\(stdClass\\) +\\(Multiple types by int and stdClass\\)")
(should (equal (get-text-property (match-beginning 1) 'face) ;; matches `i'
'(font-lock-type-face php-string font-lock-doc-face)))
(should (equal (get-text-property (match-beginning 2) 'face) ;; matches `|'
'(php-string font-lock-doc-face)))
(should (equal (get-text-property (match-beginning 3) 'face) ;; matches `s'
'(php-string font-lock-doc-face)))
(should (eq (get-text-property (match-beginning 4) 'face) ;; matches `M'
'font-lock-doc-face))
(search-forward-regexp "@return \\(int\\)\\(|\\)\\(\\\\App\\\\User\\) +\\(Multiple types by int and \\\\App\\\\User\\)")
(should (equal (get-text-property (match-beginning 1) 'face) ;; matches `i'
'(font-lock-type-face php-string font-lock-doc-face)))
(should (equal (get-text-property (match-beginning 2) 'face) ;; matches `|'
'(php-string font-lock-doc-face)))
(should (equal (get-text-property (match-beginning 3) 'face) ;; matches `\'
'(php-string font-lock-doc-face)))
(should (eq (get-text-property (match-beginning 4) 'face) ;; matches `M'
'font-lock-doc-face))
(search-forward-regexp "@return \\(DateTime\\)\\(|\\)\\(int\\) +\\(Multiple types by DateTime and int\\)")
(should (equal (get-text-property (match-beginning 1) 'face) ;; matches `D'
'(php-string font-lock-doc-face)))
(should (equal (get-text-property (match-beginning 2) 'face) ;; matches `|'
'(php-string font-lock-doc-face)))
(should (equal (get-text-property (match-beginning 3) 'face) ;; matches `i'
'(font-lock-type-face php-string font-lock-doc-face)))
(should (eq (get-text-property (match-beginning 4) 'face) ;; matches `M'
'font-lock-doc-face))
(search-forward-regexp "@return \\(\\\\App\\\\User\\)\\(|\\)\\(int\\) +\\(Multiple types by \\\\App\\\\User and int\\)")
(should (equal (get-text-property (match-beginning 1) 'face) ;; matches `\'
'(php-string font-lock-doc-face)))
(should (equal (get-text-property (1+ (match-beginning 1)) 'face) ;; matches `A'
'(php-string font-lock-doc-face)))
(should (equal (get-text-property (match-beginning 2) 'face) ;; matches `|'
'(php-string font-lock-doc-face)))
(should (equal (get-text-property (match-beginning 3) 'face) ;; matches `i'
'(font-lock-type-face php-string font-lock-doc-face)))
(should (eq (get-text-property (match-beginning 4) 'face) ;; matches `M'
'font-lock-doc-face))
(search-forward-regexp "@return \\(\\$this\\) +\\(this is special variable\\)")
(should (equal (get-text-property (match-beginning 1) 'face) ;; matches `$'
'(php-doc-$this-sigil php-doc-variable-sigil font-lock-doc-face)))
(should (equal (get-text-property (1+ (match-beginning 1)) 'face) ;; matches `t'
'(php-doc-$this php-variable-name font-lock-doc-face)))
(should (eq (get-text-property (match-beginning 2) 'face) ;; matches `M'
'font-lock-doc-face))
(search-forward-regexp "@return \\(\\$that\\) +\\(that is NOT special variable\\)")
(should (equal (get-text-property (match-beginning 1) 'face) ;; matches `$'
'(php-doc-variable-sigil font-lock-doc-face)))
(should (equal (get-text-property (1+ (match-beginning 1)) 'face) ;; matches `t'
'(php-variable-name font-lock-doc-face)))
(should (eq (get-text-property (match-beginning 2) 'face) ;; matches `M'
'font-lock-doc-face))
))
(ert-deftest php-mode-test-constants ()
"Proper highlighting for constants."
(custom-set-variables '(php-extra-constants (quote ("extraconstant"))))
(with-php-mode-test ("constants.php")
(let ((variables '(
"true" "TRUE"
"false" "FALSE"
"null" "NULL"
"IS_CONSTANT"
"__IS_CONSTANT__"
"IS_CONSTANT99"
"extraconstant"
"ClassName"
"class;")))
(dolist (variable variables)
(search-forward variable)
(goto-char (match-beginning 0))
(should (eq 'php-constant
(get-text-property (point) 'face))))))
;; Set default
(custom-set-variables '(php-extra-constants (quote ())))
(with-php-mode-test ("constants.php" :faces t)))
(ert-deftest php-mode-test-identifiers()
"Proper highlighting for identifiers including their namespace."
(with-php-mode-test ("identifiers.php" :faces t)))
(ert-deftest php-mode-test-variables ()
"Proper highlighting for variables."
(with-php-mode-test ("variables.php" :faces t)
(let ((variables '("regularVariable"
"variableVariable"
"staticVariable")))
(dolist (variable variables)
(save-excursion
(search-forward variable)
(goto-char (match-beginning 0))
(should (eq 'php-variable-name
(get-text-property (point) 'face))))))
(search-forward "memberVariable")
(should (eq 'php-property-name
(get-text-property (match-beginning 0) 'face)))
(search-forward "funCall")
(should-not (eq 'php-property-name
(get-text-property (match-beginning 0) 'face)))))
(ert-deftest php-mode-test-arrays()
"Proper highlighting for array keyword."
(with-php-mode-test ("arrays.php" :faces t)))
(ert-deftest php-mode-test-issue-174 ()
"Test escaped quotes in string literals"
(with-php-mode-test ("issue-174.php")
(while (search-forward "quotation mark" nil t)
(should (eq 'php-string
(get-text-property (- (point) 1) 'face))))))
(ert-deftest php-mode-test-issue-175 ()
"Not highlight more than 2 digit number"
(with-php-mode-test ("issue-175.php")
(search-forward "10")
(goto-char (match-beginning 0))
(should-not (get-text-property (point) 'face))))
(ert-deftest php-mode-test-language-constructs()
"Test highlighting of language constructs and reserved keywords"
(with-php-mode-test ("language-constructs.php")
(while (search-forward "ClassName" nil t)
(backward-char)
(should (eq 'font-lock-type-face
(get-text-property (point) 'face)))))
(with-php-mode-test ("language-constructs.php")
(search-forward "Start:")
(while (not (= (line-number-at-pos) (count-lines (point-min) (point-max))))
(forward-line 1)
(should (eq 'php-keyword
(get-text-property (point) 'face))))))
(ert-deftest php-mode-test-issue-178 ()
"Highligth as keyword and following symbol"
(with-php-mode-test ("issue-178.php")
(search-forward "use Test as")
(should (eq 'php-keyword
(get-text-property (- (point) 1) 'face)))
(should (eq 'font-lock-type-face
(get-text-property (+ (point) 1) 'face)))
(search-forward "$values as")
(should (eq 'php-keyword
(get-text-property (- (point) 1) 'face)))
(should (eq 'php-variable-name
(get-text-property (+ (point) 2) 'face)))
(search-forward "test as")
(should (eq 'php-keyword
(get-text-property (- (point) 1) 'face)))
(should (eq 'php-keyword
(get-text-property (+ (point) 1) 'face)))))
(ert-deftest php-mode-test-issue-186 ()
"Indentation of switch case body preceeded by multiple case statements"
(with-php-mode-test ("issue-186.php" :indent t :magic t)))
(ert-deftest php-mode-test-issue-197 ()
"Test highlighting of member and function names (should not have type face)"
(with-php-mode-test ("issue-197.php" :faces t)))
(ert-deftest php-mode-test-issue-200 ()
"Test highlighting and elimination of extraneous whitespace in PSR-2 mode"
(with-php-mode-test ("issue-200.php")
(php-set-style "psr2")
(should show-trailing-whitespace)
(should (and (listp before-save-hook) (member 'delete-trailing-whitespace before-save-hook)))))
(ert-deftest php-mode-test-issue-201 ()
"Test highlighting of special variables"
(with-php-mode-test ("issue-201.php" :faces t)))
(ert-deftest php-mode-test-issue-211 ()
"Test indentation of string concatination"
(with-php-mode-test ("issue-211.php")
(search-forward "\$str =")
(let ((equal-indentation (1- (current-column)))) ;; because cursor is after '='
(forward-line 1)
(call-interactively 'indent-for-tab-command)
(should (= (current-column) equal-indentation)))
(search-forward "\$str_long_name =")
(let ((equal-indentation (1- (current-column))))
(forward-line 1)
(call-interactively 'indent-for-tab-command)
(should (= (current-column) equal-indentation)))
(search-forward "\$sql =")
(let ((equal-indentation (1- (current-column))))
(forward-line 2)
(call-interactively 'indent-for-tab-command)
(should (= (current-column) equal-indentation)))))
(ert-deftest php-mode-test-issue-184()
"Test indent-line for statements and heredoc end at beginning of lines"
(with-php-mode-test ("issue-184.php")
(search-forward "html;")
(php-cautious-indent-line)
(should (= (current-indentation) 0))
(search-forward "return;")
(php-cautious-indent-line)
(should (= (current-indentation) c-basic-offset))))
(ert-deftest php-mode-test-switch-statements()
"Test indentation inside switch statements"
(with-php-mode-test ("switch-statements.php" :indent t :style pear)
(search-forward "case true:")
(should (eq (current-indentation) 0))
(search-forward "break")
(should (eq (current-indentation) c-basic-offset)))
(with-php-mode-test ("switch-statements.php" :indent t :style psr2)
(search-forward "case true:")
(should (eq (current-indentation) c-basic-offset))
(search-forward "break")
(should (eq (current-indentation) (* 2 c-basic-offset)))
(search-forward "return")
(should (eq (current-indentation) (* 2 c-basic-offset)))))
(ert-deftest php-mode-test-issue-227 ()
"multi-line strings indents "
(custom-set-variables '(php-lineup-cascaded-calls t))
(with-php-mode-test ("issue-227.php" :indent t :style pear)))
(ert-deftest php-mode-test-issue-237 ()
"Indent chaining method for PSR2."
(with-php-mode-test ("issue-237.php" :indent t :style psr2 :magic t)))
(ert-deftest php-mode-test-issue-253 ()
"Test highlight after string literal which contains many escaped quotes."
(with-php-mode-test ("issue-253.php")
(search-forward "$x" nil nil 3)
(should (eq 'php-variable-name (get-text-property (1- (point)) 'face)))
(search-forward "$this")
(should (eq 'php-$this-sigil (get-text-property (match-beginning 0) 'face)))
(should (eq 'php-$this (get-text-property (1+ (match-beginning 0)) 'face)))
(search-forward "$x")
(should (eq 'php-variable-sigil (get-text-property (match-beginning 0) 'face)))
(should (eq 'php-variable-name (get-text-property (1+ (match-beginning 0)) 'face)))))
(ert-deftest psr-5-style-tag-annotation ()
"PSR-5 style tag annotation."
(with-php-mode-test ("annotation.php" :faces t)))
(ert-deftest php-mode-test-issue-305 ()
"Test highlighting variables which contains 'this' or 'that'."
(with-php-mode-test ("issue-305.php" :faces t)))
(ert-deftest php-mode-test-issue-307 ()
"Activating php-mode should not mark the buffer as modified."
(with-php-mode-test ("issue-307.php")
(set-buffer-modified-p nil)
(php-mode)
(should-not (buffer-modified-p))))
(ert-deftest php-mode-test-issue-314 ()
"Activating php-mode should not move point."
(with-php-mode-test ("issue-314.php")
(let ((orig-point (point)))
(php-mode)
(should (eq (point) orig-point)))))
(ert-deftest php-mode-test-issue-310 ()
"Proper indentation after function with return type."
(with-php-mode-test ("issue-310.php" :indent t :magic t)))
(ert-deftest php-mode-test-issue-333 ()
"Do not freeze Emacs by font-lock regexp pattern."
(with-php-mode-test ("issue-333.php")))
(ert-deftest php-mode-test-issue-357 ()
"Match version-specific interpreters."
(dolist (on (if (version< emacs-version "24.4")
'("php" "php5" "php7")
'("php" "php3" "php5" "php7" "php-5" "php-5.5" "php7.0.1")))
(with-temp-buffer
(insert "#!" on)
(set-auto-mode)
(should (eq 'php-mode major-mode))))
(dolist (off '("php2" "xphp5" "foo" "php8" "php7x"))
(with-temp-buffer
(insert "#!" off)
(set-auto-mode)
(should (not (eq 'php-mode major-mode))))))
(ert-deftest php-mode-test-issue-439 ()
"Various heredoc/nowdoc formats are highlighted appropriately."
(with-php-mode-test ("issue-439.php" :faces t)))
(ert-deftest php-mode-test-issue-443 ()
"This case allows you to color things that are not authentic PHP tags
(ex. `<?xml', `<?hh') as false positives."
(with-php-mode-test ("issue-443.php" :faces t)))
(ert-deftest php-mode-test-type-hints ()
"Test highlighting of type hints and return types."
(with-php-mode-test ("type-hints.php" :faces t)))
(ert-deftest php-mode-test-static-method-calls ()
"Test highlighting of static method calls which are named the same
as a keyword."
(with-php-mode-test ("static-method-calls.php" :faces t)))
(ert-deftest php-mode-debug-test ()
"Test running php-mode-debug and php-mode-debug--buffer."
(with-temp-buffer
(php-mode)
(php-mode-debug)
(should (string= (buffer-name) "*PHP Mode DEBUG*"))
(php-mode-debug--buffer 'top)
(search-forward "--- PHP-MODE DEBUG BEGIN ---")
(search-forward "--- PHP-MODE DEBUG END ---"))
(with-current-buffer (php-mode-debug--buffer 'init)
(should (eq 0 (- (point-max) (point-min))))))
(ert-deftest php-project-root ()
(should (string= (abbreviate-file-name default-directory)
(php-project-get-root-dir))))
(defun php-mode-test-in-function-p (&optional pos)
"Determine whether POS is inside a function.
Meant for `php-mode-test-issue-503'."
(let (bof (pos (or pos (point))))
(save-excursion
(when (beginning-of-defun)
(setq bof (point))
(end-of-defun)
(and (> pos bof)
(< pos (point)))))))
(ert-deftest php-mode-test-issue-503 ()
"Function `php-beginning-of-defun' should return non-nil on success."
(with-php-mode-test
("issue-503.php")
(php-mode)
(goto-char (point-max))
(should (eq (php-mode-test-in-function-p) nil))
(should (eq (php-mode-test-in-function-p (1- (point))) t))
(should (eq (php-mode-test-in-function-p 1) nil))
(should (eq (php-mode-test-in-function-p 24) t))
(goto-char (point-min))
(should (eq (php-mode-test-in-function-p nil) nil))))
(ert-deftest php-mode-test-php74-arrow-fn ()
"Test highlighting arrow funcsion (short closure syntax) added in PHP 7.4."
(with-php-mode-test ("7.4/arrow-function.php" :faces t)))
;;; php-mode-test.el ends here