Merge branch 'release/1.1.0'

Author: szaleq

.actionspanel/buttons.yml

@@ -0,0 +1,6 @@
+buttons:
+  - title: Release new version
+    action: "release"
+    description: Releases new version
+    arguments:
+      - name: new_version

.github/workflows/release.yml

@@ -0,0 +1,48 @@
+name: Release
+
+on: repository_dispatch
+
+jobs:
+  release:
+    if: github.event.action == 'release'
+    name: Release
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout master
+        uses: actions/checkout@v1
+        with:
+          ref: 'master'
+      - name: Checkout develop
+        uses: actions/checkout@v1
+        with:
+          ref: 'develop'
+          clean: false
+      - name: Install git-flow
+        run: sudo apt-get install git-flow -y
+      - name: Configure commiter
+        run: |
+          git config --local user.email "${{ secrets.WORKER_EMAIL }}"
+          git config --local user.name "${{ secrets.WORKER_NAME }}"
+      - name: Init git-flow
+        run: git flow init -d
+      - name: Start release
+        run: git flow release start ${{ github.event.client_payload.new_version }}
+      - name: Replace [Next] tags with new version number
+        uses: jacobtomlinson/gha-find-replace@master
+        with:
+          find: "(?i)\\[Next\\]"
+          replace: "${{ github.event.client_payload.new_version }}"
+      - name: Commit version bump
+        run: git commit -am "Version bump"
+      - name: Finish release
+        run: git flow release finish ${{ github.event.client_payload.new_version }} -m "v${{ github.event.client_payload.new_version }}"
+      - name: Push develop and tags
+        uses: ad-m/github-push-action@master
+        with:
+          github_token: ${{ secrets.WORKER_TOKEN }}
+          branch: 'develop'
+      - name: Push master
+        uses: ad-m/github-push-action@master
+        with:
+          github_token: ${{ secrets.WORKER_TOKEN }}
+          branch: 'master'

.github/workflows/stable.yml

@@ -0,0 +1,29 @@
+name: Stable
+
+on:
+  push:
+    tags:
+      - '*'
+
+jobs:
+
+  # Release on GitHub
+  github-release:
+    name: Release on GitHub
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+      - name: Parse changelog
+        run: |
+          START="## ${{ steps.vars.outputs.version }}"
+          END="## [0-9]+.[0-9]+.[0-9]+|\$"
+          grep -oPz "(?s)${START}.*?\n\K.*?(?=${END})" CHANGELOG.md > changelog.txt
+          truncate -s-3 changelog.txt
+          sed -i '1d' changelog.txt
+      - name: Release
+        uses: softprops/action-gh-release@v1
+        with:
+          body_path: changelog.txt
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/test.yml

@@ -0,0 +1,15 @@
+name: Test
+
+on: ['pull_request', 'push']
+
+jobs:
+  phpcs:
+    name: WordPress Coding Standards
+    runs-on: ubuntu-latest
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v2
+    - name: Install dependencies
+      run: composer install --no-progress
+    - name: Coding Standards
+      run: composer phpcs

CHANGELOG.md

@@ -1,6 +1,25 @@
 # Changelog
 All notable changes to this project will be documented in this file.
 
-## [1.0.0] - 07.01.2020
+## 1.1.0
+
+### Added
+- Central Hooks class storing hooked objects
+- `dump-hooks` binary
+
+## 1.0.2
+
+### Added
+- HookTrait Trait
+
+### Changed
+- HookAnnotations now uses HookTrait
+
+## 1.0.1
+
+### Fixed
+- AnnotationTest class giving a fatal error because of a wrong file name, issue #1
+
+## 1.0.0
 
 Initial release

README.md

@@ -6,6 +6,10 @@
 [![Total Downloads](https://poser.pugx.org/micropackage/dochooks/downloads)](https://packagist.org/packages/micropackage/dochooks)
 [![License](https://poser.pugx.org/micropackage/dochooks/license)](https://packagist.org/packages/micropackage/dochooks)
 
+<p align="center">
+    <img src="https://bracketspace.com/extras/micropackage/micropackage-small.png" alt="Micropackage logo"/>
+</p>
+
 ## 🧬 About DocHooks
 
 The Laravel or Symfony projects are using method annotations for various things. This helps to have the project organized without too much code. WordPress has no implementation of such concept and this package is a remedy.
@@ -82,7 +86,11 @@ use Micropackage\DocHooks\Helper;
 
 ### Using within the class
 
+You can extend the HookAnnotations class:
+
 ```php
+use Micropackage\DocHooks\HookAnnotations;
+
 class Example extends HookAnnotations {
 
 	/**
@@ -96,6 +104,26 @@ $example = new Example();
 $example->add_hooks();
 ```
 
+Or use the Trait:
+
+```php
+use Micropackage\DocHooks\HookTrait;
+
+class Example {
+
+	use HookTrait;
+
+	/**
+	 * @action test
+	 */
+	public function test_action() {}
+
+}
+
+$example = new Example();
+$example->add_hooks();
+```
+
 ### Using as a standalone object
 
 ```php

bin/dump-hooks

@@ -0,0 +1,17 @@
+#!/usr/bin/env php
+<?php
+/**
+ * This file uses wp-cli to run real hook dumper.
+ *
+ * @package micropackage/dochooks
+ */
+
+$file = __DIR__ . '/dump-hooks.php';
+
+$output_file = $_SERVER['argc'] >= 2 ? $_SERVER['argv'][1] : null;
+
+if ( $output_file ) {
+	$output_file = realpath( __DIR__ . '../../../../../' . $output_file );
+}
+
+echo shell_exec( "wp eval-file {$file} {$output_file}" );

bin/dump-hooks.php

@@ -0,0 +1,75 @@
+<?php
+/**
+ * This file dumps all the Dochooks to an external file: /src/inc/hooks.php
+ * It's used only when OP Cache has `save_comments` setting saved to false.
+ *
+ * @usage: wp eval-file dump-hooks.php
+ * @usage: wp eval-file wp-content/plugins/{plugin-name}/vendor/bin/dump-hooks.php
+ *
+ * @package micropackage/dochooks
+ */
+
+use Micropackage\DocHooks\Hooks;
+
+if ( ! isset( $args[0] ) ) {
+	WP_CLI::error( 'Output file not specified.' );
+	return;
+}
+
+$hooks_file = $args[0];
+
+$hooks   = Hooks::get();
+$objects = $hooks->get_hooked_objects();
+
+$hook_functions = [];
+
+// Loop over each class who added own hooks.
+foreach ( $objects as $class_name => $data ) {
+	$count = 0;
+
+	$callback_object_name = '$this->objects[\'' . $class_name . '\'][\'instance\']';
+
+	foreach ( $data['hooks'] as $hook ) {
+		$hook_functions[] = sprintf(
+			"add_%s( '%s', [ %s, '%s' ], %d, %d );",
+			$hook['type'],
+			$hook['name'],
+			$callback_object_name,
+			$hook['callback'],
+			$hook['priority'],
+			$hook['arg_count']
+		);
+
+		$count++;
+	}
+
+	WP_CLI::log( "{$class_name} added {$count} hooks" );
+}
+
+// // Clear the hooks file.
+// $hooks_file = EW_DIR_PATH . '/src/inc/hooks.php';
+
+if ( file_exists( $hooks_file ) ) {
+	unlink( $hooks_file );
+}
+
+$hook_functions = implode( "\n", $hook_functions );
+
+// Save the content.
+$file_content = <<<EOT
+<?php
+/**
+ * Hooks compatibilty file.
+ *
+ * Automatically generated with bin/dump-hooks.php file.
+ */
+
+// phpcs:disable
+
+{$hook_functions}
+
+EOT;
+
+// phpcs:ignore WordPress.WP.AlternativeFunctions.file_system_read_file_put_contents
+file_put_contents( $hooks_file, $file_content );
+WP_CLI::success( 'All the hooks dumped!' );

composer.json

@@ -13,16 +13,18 @@
 		"phpcbf": "phpcbf"
 	},
 	"require": {
-		"php": ">=5.6"
+		"php": ">=5.6",
+		"micropackage/singleton": "^1.1"
 	},
 	"require-dev": {
-		"dealerdirect/phpcodesniffer-composer-installer": "^0.5.0",
-		"phpcompatibility/php-compatibility": "^9.1",
-		"wp-coding-standards/wpcs": "^2.0"
+		"dealerdirect/phpcodesniffer-composer-installer": "^0.7",
+		"phpcompatibility/php-compatibility": "^9.3",
+		"wp-coding-standards/wpcs": "^2.3"
 	},
 	"autoload": {
 		"psr-4" : {
 			"Micropackage\\DocHooks\\" : "src"
 		}
-	}
+	},
+  "bin": ["bin/dump-hooks"]
 }