Merge pull request #7 from francisek/feature/build-extensions

Added ability to build pecl or custom extensions.
Improved code quality.

Author: francisek

.codeclimate.yml

@@ -0,0 +1,17 @@
+---
+engines:
+  fixme:
+    enabled: false
+  shellcheck:
+    enabled: true
+ratings:
+  paths:
+  - "**.sh"
+  - "bin/php-band"
+exclude_paths:
+- archs/
+- config/
+- test/
+- inst/
+- src/
+

.gitignore

@@ -1,2 +1,5 @@
 /bats/
+/inst/
+/src/
+/config/*
 

CHANGELOG.md

@@ -1,5 +1,10 @@
 # Changelog
 
+0.3.0 :
+
+- Added variable `php_band_php_extension_dir`
+- Added extension building support
+
 0.2.0 : 
 
 - Added a check of configuration files modification date to rebuild

README.md

@@ -1,6 +1,7 @@
 # php-band
 
 <img src="https://circleci.com/gh/francisek/php-band/tree/master.svg?style=shield&circle-token=0e2b5681405bbc52e77bce982d74c449b46636d8" />
+[![Code Climate](https://codeclimate.com/github/francisek/php-band/badges/gpa.svg)](https://codeclimate.com/github/francisek/php-band)
 
 A simple bash tool to compile php versions
 
@@ -69,6 +70,8 @@ What does php-band is :
     + marks the version as built
 + installs php to inst/<version>
 + runs *post_install_php()* function if installation was successfull
++ builds pecl extensions
++ builds external extensions
 
 # Custom configuration
 
@@ -110,19 +113,108 @@ Its default value is defined to "--disable-all".
 
 The pre_\* and post_\* functions are called with the working directory set to the php source directory.
 
+## Building extensions
+
+Extensions are built and installed after php itself.
+
+It is of your responsability to provide the loading and parameters of the extension to php, generally by creating an extension_name.ini file in the `${php_band_php_install_dir}/conf.d/` directory.
+
+### Using pecl
+
+You add some pecl extensions to build in your *configure-php.sh* file by using the function *php_band_pecl_add_package*.
+It takes the package name as first parameter and eventually a string representing user inputs as second parameter.
+The pecl package name must be a string accordingly to [pecl documentation](http://php.net/manual/en/install.pecl.pear.php).
+For example to install the xdebug package, use either :
+
+```
+php_band_pecl_add_package 'xdebug'
+```
+
+or
+
+```
+php_band_pecl_add_package 'xdebug-2.5.0'
+```
+
+or
+
+```
+php_band_pecl_add_package 'pecl.php.net/xdebug-stable'
+```
+
+You may know some extensions defined in a lower config file are not compatible with a specific version (for example, xhprof does not work on 7.x).
+You can remove the building extension request with the function *php_band_pecl_remove_package* :
+
+```
+php_band_pecl_remove_package 'xhprof'
+```
+
+### Building custom extensions
+
+You can request building a custom extension with function *php_band_external_add*.
+It takes a request identifer string as first parameter. Any other parameter will be passed to a callback function of your own named *extension_<identifier>*.
+
+For example, let's build the extension xhprof. The pecl version builds untin php 5.99.
+Our `config/configure-php.sh` may look like:
+
+```bash
+#!/bin/bash -e
+
+php_band_pecl_add_package 'xhprof-stable'
+```
+
+In the `config/7/configure-php.sh` file we won't install pecl version but the git version from branch 'php7':
+
+```bash
+#!/bin/bash -e
+
+php_band_pecl_remove_package 'xhprof-stable'
+php_band_external_add 'custom_xhprof' 'https://github.com/RustJason/xhprof.git' 'php7'
+
+# @param $1 Git repository
+# @param $2 Git branch
+extension_custom_xhprof() {
+    local repo="$1"
+    local branch="${2:-master}"
+    local xhprof_src_dir="${PHP_BAND_SOURCE_DIR}/$(php_band_build_php_source_dirname)/ext/xhprof"
+
+    if [ -f "${php_band_php_extension_dir}/xhprof.so" ]; then
+        echo "Xhprof already installed"
+        return 0
+    fi
+
+    [ -d "$xhprof_src_dir" ] && rm -rf "$xhprof_src_dir"
+    git clone --depth 1 --branch "$branch" $repo "${xhprof_src_dir}"
+    cd "$xhprof_src_dir/extension"
+    ${php_band_php_install_dir}/bin/phpize
+    ./configure --with-php-config=${php_band_php_install_dir}/bin/php-config
+    make ${MAKE_OPTS} && make install
+
+    echo "extension=${php_band_php_extension_dir}/xhprof.so" > ${php_band_php_install_dir}/conf.d/xhprof.ini
+}
+```
+
+And finally there is no current branch working with PHP 7.1 line, so our file `config/7/1/configure-php.sh` would look like:
+
+```bash
+#!/bin/bash -e
+
+php_band_external_remove 'custom_xhprof'
+```
+
 ## Readonly variables
 
 Those variables can be used but should not be modified:
 
 + *PHP_BAND_INST_DIR* Directory for all installations
 + *PHP_BAND_SOURCE_DIR* Directory for all sources
-+ *php_band_php_install_dir* Directory into wich the current php will installed
++ *php_band_php_install_dir* Directory into which the current php version will be installed
 + *php_version* The full php version string (for example 5.6.3RC2)
 + *php_version_major* The php major version (for example 5)
 + *php_version_minor* The php minor version (for example 6)
 + *php_version_patch* The php patch version (for example 3)
 + *php_version_addon* The php version (for example RC2)
-+ *php_band_php_install_dir* The directory where php is installed
++ *php_band_php_extension_dir* The directory where php looks extensions for. Available from the post_install_php() stage.
 
 ## Usefull functions
 
@@ -144,6 +236,9 @@ Some core functions may be usefull in your functions :
   + {{php_version_patch}} The php patch version (for example 3)
   + {{php_version_addon}} The php version (for example RC2)
   + {{php_band_php_install_dir}} The directory where php is installed
+  + {{php_band_php_extension_dir}} The directory where php loads its extensions. Available after installation.
++ *php_band_build_php_source_dirname()*
+  Returns the php dirname where php sources resides. This is used in conjonction with *${PHP_BAND_SOURCE_DIR}*
 
 # Best practises in writing configuration files
 

bin/php-band

@@ -1,8 +1,8 @@
 #!/bin/bash
 
 PHP_BAND_NAME=$(basename "$0")
-pushd "$(dirname $0)" > /dev/null
-PHP_BAND_ROOT_DIR=$(dirname $(pwd -P))
+pushd "$(dirname "$0")" > /dev/null
+PHP_BAND_ROOT_DIR=$(dirname "$(pwd -P)")
 popd > /dev/null
 PHP_BAND_ASSETS_DIR=${PHP_BAND_ASSETS_DIR:-$PHP_BAND_ROOT_DIR}
 PHP_BAND_ARCH_DIR=${PHP_BAND_ASSETS_DIR}/archs
@@ -18,14 +18,16 @@ php_version_major=
 php_version_minor=
 php_version_patch=
 php_version_addon=
+# shellcheck disable=SC2016
 php_prefered_sites=(
     'http://museum.php.net/php${php_version_major}/${php_band_archive_filename}' 
     'http://docs.php.net/distributions/${php_band_archive_filename}'
 )
 # configurable options
 php_band_php_install_dir=
 php_band_php_config_options=
-
+php_band_php_extension_dir=
+# shellcheck source=lib/core.sh
 source $PHP_BAND_ROOT_DIR/lib/core.sh
 # Commands
 
@@ -45,13 +47,13 @@ EOM
 }
 
 command_version() {
-    echo "0.2.0"
+    echo "0.3.0"
     exit 0
 }
 
 command_download() {
     php_band_parse_version $php_version
-    if [ "$php_version_major" = "" -o "$php_version_minor" = "" -o "$php_version_patch" = "" ]; then
+    if [ "$php_version_major" = "" ] || [ "$php_version_minor" = "" ] || [ "$php_version_patch" = "" ] ; then
         error_exit "The version format is not valid" 1
     fi
     php_band_build_source_filename
@@ -70,7 +72,8 @@ command_src_format() {
 }
 
 command_list_installed() {
-    local list=$(ls -1bv "$PHP_BAND_INST_DIR")
+    local list
+    list=$(ls -1bv "$PHP_BAND_INST_DIR")
     if [ "$list" != "" ]; then
         log_info "$list"
     fi