]>
Commit | Line | Data |
---|---|---|
1 | # The personal, minimalist, super-fast, database free, bookmarking service. | |
2 | # Makefile for PHP code analysis & testing, documentation and release generation | |
3 | ||
4 | # Prerequisites: | |
5 | # - install Composer, either: | |
6 | # - from your distro's package manager; | |
7 | # - from the official website (https://getcomposer.org/download/); | |
8 | # - install/update test dependencies: | |
9 | # $ composer install # 1st setup | |
10 | # $ composer update | |
11 | # - install Xdebug for PHPUnit code coverage reports: | |
12 | # - see http://xdebug.org/docs/install | |
13 | # - enable in php.ini | |
14 | ||
15 | BIN = vendor/bin | |
16 | PHP_SOURCE = index.php application tests plugins | |
17 | PHP_COMMA_SOURCE = index.php,application,tests,plugins | |
18 | ||
19 | all: static_analysis_summary check_permissions test | |
20 | ||
21 | ## | |
22 | # Concise status of the project | |
23 | # These targets are non-blocking: || exit 0 | |
24 | ## | |
25 | ||
26 | static_analysis_summary: code_sniffer_source copy_paste mess_detector_summary | |
27 | @echo | |
28 | ||
29 | ## | |
30 | # PHP_CodeSniffer | |
31 | # Detects PHP syntax errors | |
32 | # Documentation (usage, output formatting): | |
33 | # - http://pear.php.net/manual/en/package.php.php-codesniffer.usage.php | |
34 | # - http://pear.php.net/manual/en/package.php.php-codesniffer.reporting.php | |
35 | ## | |
36 | ||
37 | code_sniffer: code_sniffer_full | |
38 | ||
39 | ### - errors filtered by coding standard: PEAR, PSR1, PSR2, Zend... | |
40 | PHPCS_%: | |
41 | @$(BIN)/phpcs $(PHP_SOURCE) --report-full --report-width=200 --standard=$* | |
42 | ||
43 | ### - errors by Git author | |
44 | code_sniffer_blame: | |
45 | @$(BIN)/phpcs $(PHP_SOURCE) --report-gitblame | |
46 | ||
47 | ### - all errors/warnings | |
48 | code_sniffer_full: | |
49 | @$(BIN)/phpcs $(PHP_SOURCE) --report-full --report-width=200 | |
50 | ||
51 | ### - errors grouped by kind | |
52 | code_sniffer_source: | |
53 | @$(BIN)/phpcs $(PHP_SOURCE) --report-source || exit 0 | |
54 | ||
55 | ## | |
56 | # PHP Copy/Paste Detector | |
57 | # Detects code redundancy | |
58 | # Documentation: https://github.com/sebastianbergmann/phpcpd | |
59 | ## | |
60 | ||
61 | copy_paste: | |
62 | @echo "-----------------------" | |
63 | @echo "PHP COPY/PASTE DETECTOR" | |
64 | @echo "-----------------------" | |
65 | @$(BIN)/phpcpd $(PHP_SOURCE) || exit 0 | |
66 | @echo | |
67 | ||
68 | ## | |
69 | # PHP Mess Detector | |
70 | # Detects PHP syntax errors, sorted by category | |
71 | # Rules documentation: http://phpmd.org/rules/index.html | |
72 | ## | |
73 | MESS_DETECTOR_RULES = cleancode,codesize,controversial,design,naming,unusedcode | |
74 | ||
75 | mess_title: | |
76 | @echo "-----------------" | |
77 | @echo "PHP MESS DETECTOR" | |
78 | @echo "-----------------" | |
79 | ||
80 | ### - all warnings | |
81 | mess_detector: mess_title | |
82 | @$(BIN)/phpmd $(PHP_COMMA_SOURCE) text $(MESS_DETECTOR_RULES) | sed 's_.*\/__' | |
83 | ||
84 | ### - all warnings + HTML output contains links to PHPMD's documentation | |
85 | mess_detector_html: | |
86 | @$(BIN)/phpmd $(PHP_COMMA_SOURCE) html $(MESS_DETECTOR_RULES) \ | |
87 | --reportfile phpmd.html || exit 0 | |
88 | ||
89 | ### - warnings grouped by message, sorted by descending frequency order | |
90 | mess_detector_grouped: mess_title | |
91 | @$(BIN)/phpmd $(PHP_SOURCE) text $(MESS_DETECTOR_RULES) \ | |
92 | | cut -f 2 | sort | uniq -c | sort -nr | |
93 | ||
94 | ### - summary: number of warnings by rule set | |
95 | mess_detector_summary: mess_title | |
96 | @for rule in $$(echo $(MESS_DETECTOR_RULES) | tr ',' ' '); do \ | |
97 | warnings=$$($(BIN)/phpmd $(PHP_COMMA_SOURCE) text $$rule | wc -l); \ | |
98 | printf "$$warnings\t$$rule\n"; \ | |
99 | done; | |
100 | ||
101 | ## | |
102 | # Checks source file & script permissions | |
103 | ## | |
104 | check_permissions: | |
105 | @echo "----------------------" | |
106 | @echo "Check file permissions" | |
107 | @echo "----------------------" | |
108 | @for file in `git ls-files`; do \ | |
109 | if [ -x $$file ]; then \ | |
110 | errors=true; \ | |
111 | echo "$${file} is executable"; \ | |
112 | fi \ | |
113 | done; [ -z $$errors ] || false | |
114 | ||
115 | ## | |
116 | # PHPUnit | |
117 | # Runs unitary and functional tests | |
118 | # Generates an HTML coverage report if Xdebug is enabled | |
119 | # | |
120 | # See phpunit.xml for configuration | |
121 | # https://phpunit.de/manual/current/en/appendixes.configuration.html | |
122 | ## | |
123 | test: | |
124 | @echo "-------" | |
125 | @echo "PHPUNIT" | |
126 | @echo "-------" | |
127 | @mkdir -p sandbox | |
128 | @$(BIN)/phpunit tests | |
129 | ||
130 | ## | |
131 | # Custom release archive generation | |
132 | # | |
133 | # For each tagged revision, GitHub provides tar and zip archives that correspond | |
134 | # to the output of git-archive | |
135 | # | |
136 | # These targets produce similar archives, featuring 3rd-party dependencies | |
137 | # to ease deployment on shared hosting. | |
138 | ## | |
139 | ARCHIVE_VERSION := shaarli-$$(git describe)-full | |
140 | ||
141 | release_archive: release_tar release_zip | |
142 | ||
143 | ### download 3rd-party PHP libraries | |
144 | composer_dependencies: clean | |
145 | composer update --no-dev | |
146 | find vendor/ -name ".git" -type d -exec rm -rf {} + | |
147 | ||
148 | ### generate a release tarball and include 3rd-party dependencies | |
149 | release_tar: composer_dependencies | |
150 | git archive -o $(ARCHIVE_VERSION).tar HEAD | |
151 | tar rvf $(ARCHIVE_VERSION).tar vendor/ | |
152 | ||
153 | ### generate a release zip and include 3rd-party dependencies | |
154 | release_zip: composer_dependencies | |
155 | git archive -o $(ARCHIVE_VERSION).zip -9 HEAD | |
156 | zip -r $(ARCHIVE_VERSION).zip vendor/ | |
157 | ||
158 | ## | |
159 | # Targets for repository and documentation maintenance | |
160 | ## | |
161 | ||
162 | ### remove all unversioned files | |
163 | clean: | |
164 | @git clean -df | |
165 | @rm -rf sandbox | |
166 | ||
167 | ### generate Doxygen documentation | |
168 | doxygen: clean | |
169 | @rm -rf doxygen | |
170 | @( cat Doxyfile ; echo "PROJECT_NUMBER=`git describe`" ) | doxygen - | |
171 | ||
172 | ### update the local copy of the documentation | |
173 | doc: clean | |
174 | @rm -rf doc | |
175 | @git clone https://github.com/shaarli/Shaarli.wiki.git doc | |
176 | @rm -rf doc/.git | |
177 | ||
178 | ### Generate a custom sidebar | |
179 | # | |
180 | # Sidebar content: | |
181 | # - convert GitHub-flavoured relative links to standard Markdown | |
182 | # - trim HTML, only keep the list (<ul>[...]</ul>) part | |
183 | htmlsidebar: | |
184 | @echo '<div id="local-sidebar">' > doc/sidebar.html | |
185 | @awk 'BEGIN { FS = "[\\[\\]]{2}" }'\ | |
186 | 'm = /\[/ { t=$$2; gsub(/ /, "-", $$2); print $$1"["t"]("$$2".html)"$$3 }'\ | |
187 | '!m { print $$0 }' doc/_Sidebar.md > doc/tmp.md | |
188 | @pandoc -f markdown -t html5 -s doc/tmp.md | awk '/(ul>|li>)/' >> doc/sidebar.html | |
189 | @echo '</div>' >> doc/sidebar.html | |
190 | @rm doc/tmp.md | |
191 | ||
192 | ### Convert local markdown documentation to HTML | |
193 | # | |
194 | # For all pages: | |
195 | # - infer title from the file name | |
196 | # - convert GitHub-flavoured relative links to standard Markdown | |
197 | # - insert the sidebar menu | |
198 | htmlpages: | |
199 | @for file in `find doc/ -maxdepth 1 -name "*.md"`; do \ | |
200 | base=`basename $$file .md`; \ | |
201 | sed -i "1i #$${base//-/ }" $$file; \ | |
202 | awk 'BEGIN { FS = "[\\[\\]]{2}" }'\ | |
203 | 'm = /\[/ { t=$$2; gsub(/ /, "-", $$2); print $$1"["t"]("$$2".html)"$$3 }'\ | |
204 | '!m { print $$0 }' $$file > doc/tmp.md; \ | |
205 | mv doc/tmp.md $$file; \ | |
206 | pandoc -f markdown_github -t html5 -s \ | |
207 | -c "github-markdown.css" \ | |
208 | -T Shaarli -M pagetitle:"$${base//-/ }" -B doc/sidebar.html \ | |
209 | -o doc/$$base.html $$file; \ | |
210 | done; | |
211 | ||
212 | htmldoc: doc htmlsidebar htmlpages |