[github/shaarli/Shaarli.git] / Makefile

# Shaarli, the personal, minimalist, super-fast, no-database delicious clone.
# Makefile for PHP code analysis & testing

# Prerequisites:
# - install Composer, either:
#   - from your distro's package manager;
#   - from the official website (https://getcomposer.org/download/);
# - install/update test dependencies:
#   $ composer install  # 1st setup
#   $ composer update
# - install Xdebug for PHPUnit code coverage reports:
#   - see http://xdebug.org/docs/install
#   - enable in php.ini

BIN = vendor/bin
PHP_SOURCE = index.php application tests plugins
PHP_COMMA_SOURCE = index.php,application,tests,plugins

all: static_analysis_summary test

##
# Concise status of the project
# These targets are non-blocking: || exit 0
##

static_analysis_summary: code_sniffer_source copy_paste mess_detector_summary
	@echo

##
# PHP_CodeSniffer
# Detects PHP syntax errors
# Documentation (usage, output formatting):
# - http://pear.php.net/manual/en/package.php.php-codesniffer.usage.php
# - http://pear.php.net/manual/en/package.php.php-codesniffer.reporting.php
##

code_sniffer: code_sniffer_full

### - errors filtered by coding standard: PEAR, PSR1, PSR2, Zend...
PHPCS_%:
	@$(BIN)/phpcs $(PHP_SOURCE) --report-full --report-width=200 --standard=$*

### - errors by Git author
code_sniffer_blame:
	@$(BIN)/phpcs $(PHP_SOURCE) --report-gitblame

### - all errors/warnings
code_sniffer_full:
	@$(BIN)/phpcs $(PHP_SOURCE) --report-full --report-width=200

### - errors grouped by kind
code_sniffer_source:
	@$(BIN)/phpcs $(PHP_SOURCE) --report-source || exit 0

##
# PHP Copy/Paste Detector
# Detects code redundancy
# Documentation: https://github.com/sebastianbergmann/phpcpd
##

copy_paste:
	@echo "-----------------------"
	@echo "PHP COPY/PASTE DETECTOR"
	@echo "-----------------------"
	@$(BIN)/phpcpd $(PHP_SOURCE) || exit 0
	@echo

##
# PHP Mess Detector
# Detects PHP syntax errors, sorted by category
# Rules documentation: http://phpmd.org/rules/index.html
##
MESS_DETECTOR_RULES = cleancode,codesize,controversial,design,naming,unusedcode

mess_title:
	@echo "-----------------"
	@echo "PHP MESS DETECTOR"
	@echo "-----------------"

###  - all warnings
mess_detector: mess_title
	@$(BIN)/phpmd $(PHP_COMMA_SOURCE) text $(MESS_DETECTOR_RULES) | sed 's_.*\/__'

### - all warnings + HTML output contains links to PHPMD's documentation
mess_detector_html:
	@$(BIN)/phpmd $(PHP_COMMA_SOURCE) html $(MESS_DETECTOR_RULES) \
	--reportfile phpmd.html || exit 0

### - warnings grouped by message, sorted by descending frequency order
mess_detector_grouped: mess_title
	@$(BIN)/phpmd $(PHP_SOURCE) text $(MESS_DETECTOR_RULES) \
	| cut -f 2 | sort | uniq -c | sort -nr

### - summary: number of warnings by rule set
mess_detector_summary: mess_title
	@for rule in $$(echo $(MESS_DETECTOR_RULES) | tr ',' ' '); do \
		warnings=$$($(BIN)/phpmd $(PHP_COMMA_SOURCE) text $$rule | wc -l); \
		printf "$$warnings\t$$rule\n"; \
	done;

##
# PHPUnit
# Runs unitary and functional tests
# Generates an HTML coverage report if Xdebug is enabled
#
# See phpunit.xml for configuration
# https://phpunit.de/manual/current/en/appendixes.configuration.html
##
test:
	@echo "-------"
	@echo "PHPUNIT"
	@echo "-------"
	@$(BIN)/phpunit tests

##
# Targets for repository and documentation maintenance
##

### remove all unversioned files
clean:
	@git clean -df

### update the local copy of the documentation
doc: clean
	@rm -rf doc
	@git clone https://github.com/shaarli/Shaarli.wiki.git doc
	@rm -rf doc/.git

### Generate a custom sidebar
#
# Sidebar content:
#  - convert GitHub-flavoured relative links to standard Markdown
#  - trim HTML, only keep the list (<ul>[...]</ul>) part
htmlsidebar:
	@echo '<div id="local-sidebar">' > doc/sidebar.html
	@awk 'BEGIN { FS = "[\\[\\]]{2}" }'\
	'm = /\[/ { t=$$2; gsub(/ /, "-", $$2); print $$1"["t"]("$$2".html)"$$3 }'\
	'!m { print $$0 }' doc/_Sidebar.md > doc/tmp.md
	@pandoc -f markdown -t html5 -s doc/tmp.md | awk '/(ul>|li>)/' >> doc/sidebar.html
	@echo '</div>' >> doc/sidebar.html
	@rm doc/tmp.md

### Convert local markdown documentation to HTML
#
# For all pages:
#  - infer title from the file name
#  - convert GitHub-flavoured relative links to standard Markdown
#  - insert the sidebar menu
htmlpages:
	@for file in `find doc/ -maxdepth 1 -name "*.md"`; do \
		base=`basename $$file .md`; \
		sed -i "1i #$${base//-/ }" $$file; \
		awk 'BEGIN { FS = "[\\[\\]]{2}" }'\
	'm = /\[/ { t=$$2; gsub(/ /, "-", $$2); print $$1"["t"]("$$2".html)"$$3 }'\
	'!m { print $$0 }' $$file > doc/tmp.md; \
		mv doc/tmp.md $$file; \
		pandoc -f markdown_github -t html5 -s \
			-c "github-markdown.css" \
			-T Shaarli -M pagetitle:"$${base//-/ }" -B doc/sidebar.html \
			-o doc/$$base.html $$file; \
	done;

htmldoc: doc htmlsidebar htmlpages
Commit	Line	Data
	1	# Shaarli, the personal, minimalist, super-fast, no-database delicious clone.
	2	# Makefile for PHP code analysis & testing
	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 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	# PHPUnit
	103	# Runs unitary and functional tests
	104	# Generates an HTML coverage report if Xdebug is enabled
	105	#
	106	# See phpunit.xml for configuration
	107	# https://phpunit.de/manual/current/en/appendixes.configuration.html
	108	##
	109	test:
	110	@echo "-------"
	111	@echo "PHPUNIT"
	112	@echo "-------"
	113	@$(BIN)/phpunit tests
	114
	115	##
	116	# Targets for repository and documentation maintenance
	117	##
	118
	119	### remove all unversioned files
	120	clean:
	121	@git clean -df
	122
	123	### update the local copy of the documentation
	124	doc: clean
	125	@rm -rf doc
	126	@git clone https://github.com/shaarli/Shaarli.wiki.git doc
	127	@rm -rf doc/.git
	128
	129	### Generate a custom sidebar
	130	#
	131	# Sidebar content:
	132	# - convert GitHub-flavoured relative links to standard Markdown
	133	# - trim HTML, only keep the list (<ul>[...]</ul>) part
	134	htmlsidebar:
	135	@echo '<div id="local-sidebar">' > doc/sidebar.html
	136	@awk 'BEGIN { FS = "[\\[\\]]{2}" }'\
	137	'm = /\[/ { t=$$2; gsub(/ /, "-", $$2); print $$1"["t"]("$$2".html)"$$3 }'\
	138	'!m { print $$0 }' doc/_Sidebar.md > doc/tmp.md
	139	@pandoc -f markdown -t html5 -s doc/tmp.md \| awk '/(ul>\|li>)/' >> doc/sidebar.html
	140	@echo '</div>' >> doc/sidebar.html
	141	@rm doc/tmp.md
	142
	143	### Convert local markdown documentation to HTML
	144	#
	145	# For all pages:
	146	# - infer title from the file name
	147	# - convert GitHub-flavoured relative links to standard Markdown
	148	# - insert the sidebar menu
	149	htmlpages:
	150	@for file in `find doc/ -maxdepth 1 -name "*.md"`; do \
	151	base=`basename $$file .md`; \
	152	sed -i "1i #$${base//-/ }" $$file; \
	153	awk 'BEGIN { FS = "[\\[\\]]{2}" }'\
	154	'm = /\[/ { t=$$2; gsub(/ /, "-", $$2); print $$1"["t"]("$$2".html)"$$3 }'\
	155	'!m { print $$0 }' $$file > doc/tmp.md; \
	156	mv doc/tmp.md $$file; \
	157	pandoc -f markdown_github -t html5 -s \
	158	-c "github-markdown.css" \
	159	-T Shaarli -M pagetitle:"$${base//-/ }" -B doc/sidebar.html \
	160	-o doc/$$base.html $$file; \
	161	done;
	162
	163	htmldoc: doc htmlsidebar htmlpages