├── .gitignore
├── GitHooksLoader.php
├── README.md
└── composer.json


/.gitignore:
--------------------------------------------------------------------------------
 1 | .DS_Store
 2 | Thumbs.db
 3 | 
 4 | ## IDEs
 5 | # PHPStorm
 6 | /.idea/
 7 | # Sublime
 8 | *.sublime-workspace
 9 | 
10 | /vendor/
11 | 
12 | # Let's keep some folders so people get into it without a full setup
13 | !.gitkeep


--------------------------------------------------------------------------------
/GitHooksLoader.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | 
  3 | /**
  4 |  * Class GitHooksLoader
  5 |  * @package WCM\GitPHPHooks
  6 |  */
  7 | class GitHooksLoader
  8 | {
  9 | 	/** @type string */
 10 | 	private $hook;
 11 | 
 12 | 	/** @type string */
 13 | 	private $location;
 14 | 
 15 | 	/** @type \FilesystemIterator */
 16 | 	private $fetched;
 17 | 
 18 | 	/** @type \RegexIterator */
 19 | 	private $filtered;
 20 | 
 21 | 	/** @type \SplPriorityQueue */
 22 | 	private $sorted;
 23 | 
 24 | 	/**
 25 | 	 * Set the hook name, the location and trigger the process
 26 | 	 * @param string $hook
 27 | 	 * @param string $location
 28 | 	 */
 29 | 	public function __construct( $hook, $location )
 30 | 	{
 31 | 		$this->setHook( $hook );
 32 | 		$this->setLocation( $location );
 33 | 
 34 | 		$this->prepare();
 35 | 		$this->load();
 36 | 	}
 37 | 
 38 | 	/**
 39 | 	 * Grabs all files in a dir,
 40 | 	 * filters them to only include PHP files
 41 | 	 * where the file name contains the current hook name
 42 | 	 * and sorts them by the first integer found in the file name.
 43 | 	 */
 44 | 	public function prepare()
 45 | 	{
 46 | 		$this->fetched = $this->fetch( $this->location );
 47 | 		$this->fetched->rewind();
 48 | 
 49 | 		$this->filtered = $this->filter( $this->fetched );
 50 | 		$this->filtered->rewind();
 51 | 
 52 | 		$this->sorted = $this->sort( $this->filtered );
 53 | 		$this->sorted->rewind();
 54 | 	}
 55 | 
 56 | 	/**
 57 | 	 * Loads the pre sorted files
 58 | 	 */
 59 | 	public function load()
 60 | 	{
 61 | 		foreach ( $this->sorted as $it )
 62 | 			include_once $this->sorted->current();
 63 | 	}
 64 | 
 65 | 	/**
 66 | 	 * Sets the current git hook name
 67 | 	 * @param string $file
 68 | 	 * @return $this
 69 | 	 */
 70 | 	public function setHook( $file )
 71 | 	{
 72 | 		$this->hook = pathinfo(
 73 | 			$file,
 74 | 			PATHINFO_FILENAME
 75 | 		);
 76 | 	}
 77 | 
 78 | 	/**
 79 | 	 * Sets the folder/location where the PHP Git Hook files are located
 80 | 	 * @param $location
 81 | 	 */
 82 | 	public function setLocation( $location )
 83 | 	{
 84 | 		$this->location = $location;
 85 | 	}
 86 | 
 87 | 	/**
 88 | 	 * Fetches all files from the target folder
 89 | 	 * @param  string $location
 90 | 	 * @return \FilesystemIterator
 91 | 	 */
 92 | 	public function fetch( $location )
 93 | 	{
 94 | 		return new \FilesystemIterator(
 95 | 			$location,
 96 | 			FilesystemIterator::SKIP_DOTS
 97 | 			| FilesystemIterator::FOLLOW_SYMLINKS
 98 | 		);
 99 | 	}
100 | 
101 | 	/**
102 | 	 * Filters the file list to only include PHP files
103 | 	 * where the file name contains the current hook name
104 | 	 * @param  \Iterator $files
105 | 	 * @return \RegexIterator
106 | 	 */
107 | 	public function filter( \Iterator $files )
108 | 	{
109 | 		return new \RegexIterator(
110 | 			$files,
111 | 			'/('.$this->hook.')[\w-]*?\.php/i'
112 | 		);
113 | 	}
114 | 
115 | 	/**
116 | 	 * Sorts files by the first `int` in the file name
117 | 	 * and adds them to a `\SplPriorityQueue`.
118 | 	 * Files without a priority are ignored to allow easy disabling.
119 | 	 * @param  \Iterator $files
120 | 	 * @return \SplPriorityQueue
121 | 	 */
122 | 	public function sort( \Iterator $files )
123 | 	{
124 | 		$sorted = new \SplPriorityQueue();
125 | 		foreach ( $files as $file )
126 | 		{
127 | 			preg_match(
128 | 				'/\d+/',
129 | 				$files->current(),
130 | 				$priority
131 | 			);
132 | 			if ( empty( $priority ) )
133 | 				continue;
134 | 
135 | 			$sorted->insert(
136 | 				$files->current(),
137 | 				$priority[0]
138 | 			);
139 | 		}
140 | 
141 | 		return $sorted;
142 | 	}
143 | }


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
  1 | [![Latest Stable Version](https://img.shields.io/packagist/v/wcm/git-php-hooks.svg?style=flat-square)](https://packagist.org/packages/wcm/git-php-hooks)
  2 | [![Latest Git Release](https://img.shields.io/github/tag/wecodemore/GitPHPHooks.svg?style=flat-square)](https://github.com/wecodemore/GitPHPHooks/releases)
  3 | [![Total Downloads](https://img.shields.io/packagist/dt/wcm/git-php-hooks.svg?style=flat-square)](https://packagist.org/packages/wcm/git-php-hooks)
  4 | [![License](https://img.shields.io/packagist/l/wcm/git-php-hooks.svg?style=flat-square)](https://packagist.org/packages/wcm/git-php-hooks)
  5 | [![GitHub Stars](https://img.shields.io/github/stars/wecodemore/GitPHPHooks.svg?style=flat-square)](https://github.com/wecodemore/GitPHPHooks/stargazers)
  6 | 
  7 | 
  8 | ![Git Logo](http://i.imgur.com/qzvwT4C.png)
  9 | 
 10 | # Git PHP Hooks
 11 | 
 12 | Write your git hooks in PHP, organize them on a per project base and attach them automatically.
 13 | 
 14 | ## Git Hooks
 15 | 
 16 | > Hooks are little scripts you can place in `$GIT_DIR/hooks` directory to trigger action at certain points.
 17 | 
 18 | There're two types of git hooks:
 19 | 
 20 |  1. pre-push (runs client side)
 21 |  1. post-push (runs server side)
 22 | 
 23 | For more info on Git Hooks, please [take a look at the official docs](http://git-scm.com/docs/githooks) - they are quite good.
 24 | 
 25 | ## How to
 26 | 
 27 | It's really easy:
 28 | 
 29 |  1. Add a folder to your project/repository. The name doesn't matter, as you have to specify
 30 |  it when triggering `GitPHPHooks`. The name in the following example is `'project-hooks'`. (Hint: Not having a name allows you to customize and organize it as you like. It also allows `git clone`ing into a project specific directory.)
 31 |  1. Open your `.git/hooks` directory and add a new Git hook file. For example: `pre-commit`
 32 |  (without file extension).
 33 |  1. Add a new PHP file to the newly created custom Git hooks folder (again, `'project-hooks'` in the example) that performs the task you want.
 34 | 
 35 | That's it.
 36 | 
 37 | All your Git hooks (inside `.git/hooks`) will have the same contents - only the target folder (`'project-hooks'`) name will (maybe) differ.
 38 | 
 39 | ```php
 40 | #!/usr/bin/env php
 41 | <?php
 42 | 
 43 | include 'vendor/wcm/git-php-hooks/GitHooksLoader.php';
 44 | new \GitHooksLoader( __FILE__, 'project-hooks' );
 45 | ```
 46 | 
 47 | **Explanation:**
 48 | 
 49 |  * The first line is a _hashbang_ to specify that we actually have a PHP file on the Command Line.
 50 |  * The 1st argument for `\GitHooksLoader()` is the name of the current file to make the
 51 | current hook identifyable for GitPHPHooks.
 52 |  * The 2nd argument is the target location where your
 53 | custom, pre-project Git PHP hook files for the current task are located.
 54 | 
 55 | ## Naming convention
 56 | 
 57 | There's a naming convention that you ***must*** follow to properly attach PHP files to Git hooks.
 58 | Sorting files is also done by file name.
 59 | 
 60 |  1. If a Git hook name is found in the file name, it will get attached to _this specific_ hook
 61 |  and executed automatically. Example: `pre-commit_`
 62 |  1. If one of your hooking PHP files has a number attached, it will get added with this priority. Example: `_10`
 63 |  If it ain't got any `int` in the file name, it will get skipped. This is useful to temporarily
 64 |  disable files if you are testing the order or a new hook.
 65 |  1. The name in between the Git hook name and the priority is just an identifiyer for yourself. Example: `PHPUnit`
 66 | 
 67 | ### Examples (and ready-to-use tasks)
 68 | 
 69 | Before jumping on examples, I suggest that you simply take a look at the
 70 | [GitPHPHooks Library repo](https://github.com/wecodemore/GitPHPHooksLibrary).
 71 | You will find a PHPLint and a PHP Mess Detector task and some others
 72 | (hint: I happily accept pull requests!).
 73 | 
 74 | A real world scenario (simplified version of the task that is available in the linked library)
 75 | 
 76 | > We want to run PHPLint before we commit
 77 | 
 78 | Add a new file named `pre-commit` in your `.git/hooks` directory. Then add a new directory in the
 79 | root folder of your project/repository, named i.e. `project-hooks`. In there, add a new PHP file
 80 | named `pre-commit_lint_10.php`. This file will automatically get added to your `pre-commit` hook
 81 | where you called the `\GitHooksLoader()` like shown above. It will get added with a priority
 82 | of 10. Then just put the following contents in your new file:
 83 | 
 84 | ```php
 85 | #!/usr/bin/env php
 86 | <?php
 87 | $output = shell_exec( 'php -l' );
 88 | echo $output;
 89 | if ( $output === 1 )
 90 | 	exit 1;
 91 | ```
 92 | 
 93 | Of course, above code is a very poor example. For a more detailed one, please refer to the library
 94 | linked above. The GitPHPHooks Library runs two real world examples. To use **PHP Mess Detector** and **PHPLint**, I can just suggest using the library as those are currently built in. Again: If you have a custom one and want to share, just send a Pull Request.
 95 | 
 96 | ## Grunt integration
 97 | 
 98 | It can easily be integrated with grunt via [`grunt-githooks`](https://github.com/wecodemore/grunt-githooks),
 99 | originally written by [@rhumaric](https://github.com/rhumaric/).
100 | 
101 | Setup your `grunt-githooks` task like this:
102 | 
103 | ```javascript
104 | php : {
105 | 	options      : {
106 | 		hashbang    : '#!/usr/bin/env php',
107 | 		startMarker : '\n<?php',
108 | 		template    : './templates/git-php-hooks.tmpl.hb'
109 | 	},
110 | 	'pre-push'   : 'none'
111 | }
112 | ```
113 | 
114 | Then just add your hooked tasks to your project and use the following template:
115 | 
116 | ```php
117 | include 'vendor/wcm/git-php-hooks/GitHooksLoader.php';
118 | new \GitHooksLoader( __FILE__, 'vendor/wcm/git-php-hooks-library/src' );
119 | ```
120 | 
121 | This example is assuming that you are using the
122 | [GitPHPHooksLibrary](https://github.com/wecodemore/GitPHPHooksLibrary).
123 | The template in this case would be located inside a `templates` directory in the root folder
124 | of your project and be named `git-php-hooks.tmpl.hb`. It's important to set the hooks names
125 | value to `none` as GitPHPHooks doesn't need a task name as it identifies tasks by the filename
126 | by itself.
127 | 
128 | ## Install
129 | 
130 | Add the repo to your stack. You can use Composer (w/o Satis as it's added to Packagist).
131 | Simply add
132 | 
133 | ```json
134 | "wcm/git-php-hooks": "^1.0"
135 | ```
136 | 
137 | to your `composer.json` file. GitHub has a service hook added to this repo to auto-update whenever
138 | this repo is updated. The `^1.0` version number will bring you all patches without breaking anything.
139 | 
140 | To add the repository to the dev-part of the stack in `composer.json`, the following command can be typed in the prompt (assuming composer is in your PATH or aliased ).
141 | 
142 |     composer require --dev --prefer-dist -- wcm/git-php-hooks
143 | 
144 | wcm/git-php-hooks suggests installing a library of pre made hooks and tasks, wcm/git-php-hooks-library . To add this with composer the following can be used:
145 | 
146 |     composer require --dev --prefer-dist -- wcm/git-php-hooks-library
147 | 
148 | 
149 | 


--------------------------------------------------------------------------------
/composer.json:
--------------------------------------------------------------------------------
 1 | {
 2 |     "name"        : "wcm/git-php-hooks",
 3 |     "description" : "Write git hooks with PHP, organize them on a per-project base and automatically add them",
 4 | 	"homepage"    : "https://github.com/wecodemore/GitPHPHooks",
 5 | 	"keywords"    : [ "git", "php", "hooks", "git hook" ],
 6 |     "license"     : "MIT",
 7 |     "authors"     : [
 8 |         {
 9 |             "name"     : "Kaiser Franz Josef",
10 | 			"homepage" : "http://unserkaiser.com",
11 | 			"email"    : "wecodemore@gmail.com"
12 |         }
13 |     ],
14 | 	"support"     : {
15 | 		"issues"  : "https://github.com/wecodemore/GitPHPHooks/issues",
16 | 		"sources" : "https://github.com/wecodemore/GitPHPHooks/releases"
17 | 	},
18 | 	"minimum-stability" : "dev",
19 | 	"require"     : {
20 | 		"php" : ">=5.3"
21 | 	},
22 | 	"suggest": {
23 | 		"wcm/git-php-hooks-library": "A convenient library of pre made hooks and tasks."
24 | 	},
25 | 	"autoload"    : {
26 | 		"classmap" : [ "" ]
27 | 	}
28 | }
29 | 


--------------------------------------------------------------------------------