|
| 1 | +#!/bin/sh |
| 2 | + |
| 3 | +# |
| 4 | +# Smart little documentation generator. |
| 5 | +# GPL/LGPL |
| 6 | +# (c) Del 2015 http://www.babel.com.au/ |
| 7 | +# |
| 8 | + |
| 9 | +APPNAME='Omnipay Dummy Gateway Documentation' |
| 10 | +CMDFILE=apigen.cmd.$$ |
| 11 | +DESTDIR=./documents |
| 12 | +SRCDIRS="src" |
| 13 | +VENDORDIRS="vendor/guzzle vendor/omnipay" |
| 14 | + |
| 15 | +# |
| 16 | +# Ensure that dependencies are installed (including codeception and phpunit) |
| 17 | +# |
| 18 | +if [ -f composer.lock ]; then |
| 19 | + /usr/local/bin/composer install |
| 20 | +else |
| 21 | + /usr/local/bin/composer update |
| 22 | +fi |
| 23 | + |
| 24 | +# |
| 25 | +# Find apigen, either in the path or as a local phar file |
| 26 | +# |
| 27 | +if [ -f apigen.phar ]; then |
| 28 | + APIGEN="php apigen.phar" |
| 29 | + |
| 30 | +else |
| 31 | + APIGEN=`which apigen` |
| 32 | + if [ ! -f "$APIGEN" ]; then |
| 33 | + |
| 34 | + # Search for phpdoc if apigen is not found. |
| 35 | + if [ -f phpDocumentor.phar ]; then |
| 36 | + PHPDOC="php phpDocumentor.phar" |
| 37 | + |
| 38 | + else |
| 39 | + PHPDOC=`which phpdoc` |
| 40 | + if [ ! -f "$PHPDOC" ]; then |
| 41 | + echo "Neither apigen nor phpdoc is installed in the path or locally, please install one of them" |
| 42 | + echo "see http://www.apigen.org/ or http://www.phpdoc.org/" |
| 43 | + exit 1 |
| 44 | + fi |
| 45 | + fi |
| 46 | + fi |
| 47 | +fi |
| 48 | + |
| 49 | +# |
| 50 | +# As of version 4 of apigen need to use the generate subcommand |
| 51 | +# |
| 52 | +if [ ! -z "$APIGEN" ]; then |
| 53 | + APIGEN="$APIGEN generate" |
| 54 | +fi |
| 55 | + |
| 56 | +# |
| 57 | +# Without any arguments this builds the entire system documentation, |
| 58 | +# making the cache file first if required. |
| 59 | +# |
| 60 | +if [ -z "$1" ]; then |
| 61 | + # |
| 62 | + # Check to see that the cache has been made. |
| 63 | + # |
| 64 | + if [ ! -f dirlist.cache ]; then |
| 65 | + echo "Making dirlist.cache file" |
| 66 | + $0 makecache |
| 67 | + fi |
| 68 | + |
| 69 | + # |
| 70 | + # Build the apigen/phpdoc command in a file. |
| 71 | + # |
| 72 | + if [ ! -z "$APIGEN" ]; then |
| 73 | + echo "$APIGEN --php --tree --title '$APPNAME API Documentation' --destination $DESTDIR/main \\" > $CMDFILE |
| 74 | + cat dirlist.cache | while read dir; do |
| 75 | + echo "--source $dir \\" >> $CMDFILE |
| 76 | + done |
| 77 | + echo "" >> $CMDFILE |
| 78 | + |
| 79 | + elif [ ! -z "$PHPDOC" ]; then |
| 80 | + echo "$PHPDOC --sourcecode --title '$APPNAME API Documentation' --target $DESTDIR/main --directory \\" > $CMDFILE |
| 81 | + cat dirlist.cache | while read dir; do |
| 82 | + echo "${dir},\\" >> $CMDFILE |
| 83 | + done |
| 84 | + echo "" >> $CMDFILE |
| 85 | + |
| 86 | + else |
| 87 | + "Neither apigen nor phpdoc are found, how did I get here?" |
| 88 | + exit 1 |
| 89 | + fi |
| 90 | + |
| 91 | + # |
| 92 | + # Run the apigen command |
| 93 | + # |
| 94 | + rm -rf $DESTDIR/main |
| 95 | + mkdir -p $DESTDIR/main |
| 96 | + . ./$CMDFILE |
| 97 | + |
| 98 | + /bin/rm -f ./$CMDFILE |
| 99 | + |
| 100 | +# |
| 101 | +# The "makecache" argument causes the script to just make the cache file |
| 102 | +# |
| 103 | +elif [ "$1" = "makecache" ]; then |
| 104 | + echo "Find application source directories" |
| 105 | + find $SRCDIRS -name \*.php -print | \ |
| 106 | + ( |
| 107 | + while read file; do |
| 108 | + grep -q 'class' $file && dirname $file |
| 109 | + done |
| 110 | + ) | sort -u | \ |
| 111 | + grep -v -E 'config|docs|migrations|test|Test|views|web' > dirlist.app |
| 112 | + |
| 113 | + echo "Find vendor source directories" |
| 114 | + find $VENDORDIRS -name \*.php -print | \ |
| 115 | + ( |
| 116 | + while read file; do |
| 117 | + grep -q 'class' $file && dirname $file |
| 118 | + done |
| 119 | + ) | sort -u | \ |
| 120 | + grep -v -E 'config|docs|migrations|test|Test|views|codesniffer|phpmd|pdepend|php-parser|codeception|phpunit' > dirlist.vendor |
| 121 | + |
| 122 | + # |
| 123 | + # Filter out any directories for which apigen fails |
| 124 | + # |
| 125 | + echo "Filter source directories" |
| 126 | + mkdir -p $DESTDIR/tmp |
| 127 | + cat dirlist.app dirlist.vendor | while read dir; do |
| 128 | + if [ ! -z "$APIGEN" ]; then |
| 129 | + $APIGEN --quiet --title "Test please ignore" \ |
| 130 | + --source $dir \ |
| 131 | + --destination $DESTDIR/tmp && ( |
| 132 | + echo "Including $dir" |
| 133 | + echo $dir >> dirlist.cache |
| 134 | + ) || ( |
| 135 | + echo "Excluding $dir" |
| 136 | + ) |
| 137 | + |
| 138 | + elif [ ! -z "$PHPDOC" ]; then |
| 139 | + $PHPDOC --quiet --title "Test please ignore" \ |
| 140 | + --directory $dir \ |
| 141 | + --target $DESTDIR/tmp && ( |
| 142 | + echo "Including $dir" |
| 143 | + echo $dir >> dirlist.cache |
| 144 | + ) || ( |
| 145 | + echo "Excluding $dir" |
| 146 | + ) |
| 147 | + |
| 148 | + fi |
| 149 | + done |
| 150 | + echo "Documentation cache dirlist.cache built OK" |
| 151 | + |
| 152 | + # |
| 153 | + # Clean up |
| 154 | + # |
| 155 | + /bin/rm -rf $DESTDIR/tmp |
| 156 | + |
| 157 | +fi |
0 commit comments