Changeset 1633724

Timestamp:

04/09/2017 06:32:17 PM (9 years ago)

Author:

akeda

Message:

Updates trunk for 0.6.0

Location:

slack/trunk

Files:

• assets (added)
• includes/autoloader.php (modified) (3 diffs)
• includes/event-manager.php (modified) (10 diffs)
• includes/event-payload.php (modified) (2 diffs)
• includes/notifier.php (modified) (2 diffs)
• includes/plugin.php (modified) (5 diffs)
• includes/post-meta-box.php (modified) (8 diffs)
• includes/post-type.php (modified) (26 diffs)
• includes/submit-meta-box.php (modified) (3 diffs)
• languages (added)
• languages/slack.pot (added)
• readme.txt (modified) (2 diffs)
• slack.php (modified) (3 diffs)
• views/post-meta-box.php (modified) (3 diffs)
• views/submit-meta-box.php (modified) (2 diffs)

slack/trunk/includes/autoloader.php

@@ -1 +1 @@
 <?php
+/**
+ * Autoloader for the plugin.
+ *
+ * @package WP_Slack
+ * @subpackage Autoloader
+ */
+
+if ( ! defined( 'ABSPATH' ) ) {
+    exit;
+}
+
 /**
  * Class loader using SPL autoloader.
@@ -21 +32 @@
     /**
      * Registers Autoloader as an SPL autoloader.
+     *
+     * @param string $class_prefix Prefix on class name to be autoloaded.
+     * @param string $base_path    Path to load the classes.
      */
     public static function register( $class_prefix, $base_path ) {
@@ -32 +46 @@
      * Handles autoloading of classes.
      *
-     * @param string $classname Class name
+     * @param string $classname Class name.
      */
     public static function autoload( $classname ) {

slack/trunk/includes/event-manager.php

@@ -1 +1 @@
 <?php
-
+/**
+ * Event manager.
+ *
+ * @package WP_Slack
+ * @subpackage Event
+ */
+
+if ( ! defined( 'ABSPATH' ) ) {
+    exit;
+}
+
+/**
+ * Dispatch registered events.
+ *
+ * Event registered in WP_Slack is an array with following structure:
+ *
+ * {
+ *
+ *     @type string   $action      WordPress hook.
+ *     @type string   $description Description for the event. Appears in integration
+ *                                 setting.
+ *     @type bool     $default     Default value for integration setting. True
+ *                                 means it's checked by default.
+ *     @type function $message     The callback for $action. This function must
+ *                                 returns a string to notify to Slack.
+ *
+ * }
+ */
 class WP_Slack_Event_Manager {
 
     /**
+     * Plugin's instance.
+     *
      * @var WP_Slack_Plugin
      */
     private $plugin;
 
+    /**
+     * Constructor.
+     *
+     * @param WP_Slack_Plugin $plugin Plugin's instance.
+     */
     public function __construct( WP_Slack_Plugin $plugin ) {
         $this->plugin = $plugin;
@@ -14 +48 @@
     }
 
+    /**
+     * Dispatch events.
+     */
     private function dispatch_events() {
 
@@ -42 +79 @@
             }
 
-            // For each checked event calls the callback, that's,
-            // hooking into event's action-name to let notifier
-            // deliver notification based on current integration
-            // setting.
+            // For each checked event calls the callback, that's, hooking into
+            // event's action-name to let notifier deliver notification based on
+            // current integration setting.
             foreach ( $setting['events'] as $event => $is_enabled ) {
                 if ( ! empty( $events[ $event ] ) && $is_enabled ) {
@@ -51 +87 @@
                 }
             }
-
         }
     }
 
     /**
-     * Get list of events. There's filter `slack_get_events`
-     * to extend available events that can be notified to
-     * Slack.
+     * Get list of events. There's filter `slack_get_events` to extend available
+     * events that can be notified to Slack.
+     *
+     * @return array List of events
      */
     public function get_events() {
@@ -82 +118 @@
 
                         return sprintf(
-                            'New post published: *<%1$s|%2$s>* by *%3$s*' . "\n" .
+                            /* translators: 1) URL, 2) post title, and 3) post author. */
+                            __( 'New post published: *<%1$s|%2$s>* by *%3$s*', 'slack' ) . "\n" .
                             '> %4$s',
-
                             get_permalink( $post->ID ),
                             html_entity_decode( get_the_title( $post->ID ), ENT_QUOTES, get_bloginfo( 'charset' ) ),
@@ -114 +150 @@
 
                         return sprintf(
-                            'New post needs review: *<%1$s|%2$s>* by *%3$s*' . "\n" .
+                            /* translators: 1) URL, 2) post title and 3) post author. */
+                            __( 'New post needs review: *<%1$s|%2$s>* by *%3$s*', 'slack' ) . "\n" .
                             '> %4$s',
-
                             admin_url( sprintf( 'post.php?post=%d&action=edit', $post->ID ) ),
                             html_entity_decode( get_the_title( $post->ID ), ENT_QUOTES, get_bloginfo( 'charset' ) ),
@@ -152 +188 @@
 
                     return sprintf(
-                        '<%1$s|New comment> by *%2$s* on *<%3$s|%4$s>* (_%5$s_)' . "\n" .
+                        /* translators: 1) edit URL, 2) comment author, 3) post URL, 4) post title, and 5) comment status. */
+                        __( '<%1$s|New comment> by *%2$s* on *<%3$s|%4$s>* (_%5$s_)', 'slack' ) . "\n" .
                         '>%6$s',
-
                         admin_url( "comment.php?c=$comment_id&action=editcomment" ),
                         $comment->comment_author,
@@ -167 +203 @@
     }
 
+    /**
+     * Notify Slack from invoked action callback.
+     *
+     * @param array $event   Event.
+     * @param array $setting Integration setting.
+     */
     public function notifiy_via_action( array $event, array $setting ) {
-        $notifier = $this->plugin->notifier;
-
         $priority = 10;
         if ( ! empty( $event['priority'] ) ) {
@@ -175 +215 @@
         }
 
-        $callback = function() use( $event, $setting, $notifier ) {
-            $message = '';
+        $callback = $this->get_event_callback( $event, $setting );
+
+        add_action( $event['action'], $callback, $priority, 5 );
+    }
+
+    /**
+     * Get event callback for a given event and setting.
+     *
+     * @since 0.6.0
+     *
+     * @param array $event   Event.
+     * @param array $setting Integration setting.
+     *
+     * @return function Callback for a given event and setting
+     */
+    public function get_event_callback( array $event, array $setting ) {
+        $notifier = $this->plugin->notifier;
+
+        return function() use ( $event, $setting, $notifier ) {
+            $callback_args = array();
+            $message       = '';
+
             if ( is_string( $event['message'] ) ) {
                 $message = $event['message'];
-            } else if ( is_callable( $event['message'] ) ) {
-                $message = call_user_func_array( $event['message'], func_get_args() );
+            } elseif ( is_callable( $event['message'] ) ) {
+                $callback_args = func_get_args();
+                $message       = call_user_func_array( $event['message'], $callback_args );
             }
 
@@ -191 +252 @@
                 );
 
-                $notifier->notify( new WP_Slack_Event_Payload( $setting ) );
+                $resp = $notifier->notify( new WP_Slack_Event_Payload( $setting ) );
+
+                /**
+                 * Fires after notify an event to Slack.
+                 *
+                 * @since 0.6.0
+                 *
+                 * @param array|WP_Error $resp          Results from wp_remote_post.
+                 * @param array          $event         Event.
+                 * @param array          $setting       Integration setting.
+                 * @param array          $callback_args Callback arguments.
+                 */
+                do_action( 'slack_after_notify', $resp, $event, $setting, $callback_args );
             }
         };
-        add_action( $event['action'], $callback, $priority, 5 );
     }
 }

slack/trunk/includes/event-payload.php

@@ -1 +1 @@
 <?php
+/**
+ * Event Payload.
+ *
+ * @package WP_Slack
+ * @subpackage Event
+ */
 
+/**
+ * Event payload representation.
+ */
 class WP_Slack_Event_Payload {
 
     /**
+     * Setting.
+     *
      * @var array
      */
     private $setting;
 
+    /**
+     * Constructor.
+     *
+     * @param array $setting Setting values.
+     */
     public function __construct( array $setting ) {
         $this->setting = $setting;
     }
 
+    /**
+     * Get service URL.
+     *
+     * @return string Service URL
+     */
     public function get_url() {
         return $this->setting['service_url'];
     }
 
-    public function toJSON() {
+    /**
+     * Get JSON string for the setting.
+     *
+     * @return string JSON string
+     */
+    public function get_json_string() {
         return json_encode( array(
             'channel'      => $this->setting['channel'],
@@ -24 +50 @@
         ) );
     }
+
+    /**
+     * Get JSON string for the setting.
+     *
+     * @deprecated 0.6.0 Use get_json_string()
+     * @see WP_Slack_Event_Payload::get_json_string()
+     *
+     * @return string JSON string
+     * @codingStandardsIgnoreStart
+     */
+    public function toJSON() {
+        // @codingStandardsIgnoreEnd
+        _deprecated_function( __METHOD__, '0.6.0', 'WP_Slack_Event_Payload::get_json_string()' );
+        return $this->get_json_string();
+    }
 }

slack/trunk/includes/notifier.php

@@ -1 +1 @@
 <?php
+/**
+ * Slack Notifier.
+ *
+ * @package WP_Slack
+ * @subpackage Notifier
+ */
 
+if ( ! defined( 'ABSPATH' ) ) {
+    exit;
+}
+
+/**
+ * Notify Slack via Incoming Webhook API.
+ *
+ * @see https://api.slack.com/incoming-webhooks
+ */
 class WP_Slack_Notifier {
 
     /**
+     * Plugin's instance.
+     *
      * @var WP_Slack_Plugin
      */
     private $plugin;
 
+    /**
+     * Constructor.
+     *
+     * @param WP_Slack_Plugin $plugin Plugin instance.
+     */
     public function __construct( WP_Slack_Plugin $plugin ) {
         $this->plugin = $plugin;
@@ -15 +37 @@
      * Notify Slack with given payload.
      *
-     * @var WP_Slack_Event_Payload $payload
+     * @param WP_Slack_Event_Payload $payload Payload to send via POST.
      *
      * @return mixed True if success, otherwise WP_Error
      */
     public function notify( WP_Slack_Event_Payload $payload ) {
-        $payload_json = $payload->toJSON();
+        $payload_json = $payload->get_json_string();
 
         $resp = wp_remote_post( $payload->get_url(), array(
             'user-agent' => $this->plugin->name . '/' . $this->plugin->version,
             'body'       => $payload_json,
-            'headers'=> array(
+            'headers' => array(
                 'Content-Type' => 'application/json',
             ),

slack/trunk/includes/plugin.php

@@ -1 +1 @@
 <?php
+/**
+ * Main Plugin Class.
+ *
+ * @package WP_Slack
+ */
+
 /**
  * This is the plugin class and acts as container for component instances and
@@ -9 +15 @@
 
     /**
+     * Items for setter and getter.
+     *
      * @var array
      */
@@ -14 +22 @@
 
     /**
-     * @param string $path Path to main plugin file
+     * Run the plugin.
+     *
+     * @param string $path Path to main plugin file.
      */
     public function run( $path ) {
-        // Basic plugin information.
-        $this->name    = 'wp_slack'; // This maybe used to prefix options, slug of menu or page, and filters/actions.
-        $this->version = '0.5.1';
+        // This maybe used to prefix options, slug of menu or page, and
+        // filters/actions.
+        $this->name    = 'wp_slack';
+
+        $this->version = '0.6.0';
 
         // Path.
@@ -34 +46 @@
     }
 
+    /**
+     * Store item's value with a given key.
+     *
+     * @param string $key   Item's key.
+     * @param mixed  $value Item's value.
+     */
     public function __set( $key, $value ) {
         $this->items[ $key ] = $value;
     }
 
+    /**
+     * Retrieve item with given key.
+     *
+     * @param string $key Item's key.
+     *
+     * @return mixed Item's value
+     */
     public function __get( $key ) {
         if ( isset( $this->items[ $key ] ) ) {
@@ -46 +71 @@
     }
 
+    /**
+     * Checks whether an item with given key exists.
+     *
+     * @param string $key Item's key.
+     *
+     * @return bool Returns true if item with given key exists.
+     */
     public function __isset( $key ) {
         return isset( $this->items[ $key ] );
     }
 
+    /**
+     * Unset item with given key.
+     *
+     * @param string $key Item's key.
+     */
     public function __unset( $key ) {
         if ( isset( $this->items[ $key ] ) ) {

slack/trunk/includes/post-meta-box.php

@@ -1 +1 @@
 <?php
-
+/**
+ * Integration Setting Meta Box.
+ *
+ * @package WP_Slack
+ * @subpackage Integration
+ */
+
+/**
+ * Handles Integration Setting Meta Box in Edit Slack Integration screen.
+ */
 class WP_Slack_Post_Meta_Box {
 
     /**
+     * Plugin's instance.
+     *
      * @var WP_Slack_Plugin
      */
     private $plugin;
 
+    /**
+     * Plugin's instance.
+     *
+     * @param WP_Slack_Plugin $plugin Plugin instance.
+     */
     public function __construct( WP_Slack_Plugin $plugin ) {
         $this->plugin = $plugin;
@@ -19 +35 @@
     }
 
+    /**
+     * Add the meta box.
+     */
     public function add_meta_box() {
         add_meta_box(
-            // ID.
-            'slack_setting_metabox',
-
-            // Title.
-            __( 'Integration Setting', 'slack' ),
-
-            // Callback.
-            array( $this, 'render_meta_box' ),
-
-            // Screen.
-            $this->plugin->post_type->name,
-
-            // Context.
-            'advanced',
-
-            // Priority.
-            'high'
+            'slack_setting_metabox',              // ID.
+            __( 'Integration Setting', 'slack' ), // Title.
+            array( $this, 'render_meta_box' ),    // Renderer callback.
+            $this->plugin->post_type->name,       // Screen to render
+            'advanced',                           // Context
+            'high'                                // Priority.
         );
     }
@@ -44 +52 @@
      * Display the meta box.
      *
-     * @param object $post
+     * @param WP_Post $post Post object.
      */
     public function render_meta_box( $post ) {
         wp_nonce_field(
-            // Action
-            $this->plugin->post_type->name,
-
-            // Name.
-            $this->plugin->post_type->name . '_nonce'
+            $this->plugin->post_type->name,            // Action.
+            $this->plugin->post_type->name . '_nonce'  // Name.
         );
 
@@ -70 +75 @@
      */
     public function save_post( $post_id ) {
-        if ( $this->plugin->post_type->name !== get_post_type( $post_id ) ) {
+        if ( get_post_type( $post_id ) !== $this->plugin->post_type->name ) {
             return;
         }
@@ -109 +114 @@
                 }
             },
-            'events' => function( $val ) use( $events ) {
+            'events' => function( $val ) use ( $events ) {
                 $saved = array_fill_keys( $events , 0 );
 
@@ -119 +124 @@
 
                 return $saved;
-            }
+            },
         );
 
@@ -138 +143 @@
     }
 
+    /**
+     * AJAX handler for test notify in edit Slack integration screen.
+     */
     public function ajax_test_notify() {
         try {
@@ -148 +156 @@
             foreach ( $expected_params as $param ) {
                 if ( ! isset( $_REQUEST[ $param ] ) ) {
+                    /* translators: placeholder is request parameter for test notify AJAX. */
                     throw new Exception( sprintf( __( 'Missing param %s', 'slack' ), $param ) );
                 }

slack/trunk/includes/post-type.php

@@ -1 +1 @@
 <?php
+/**
+ * Custom Post Type for WP_Slack.
+ *
+ * @package WP_Slack
+ * @subpackage Integration
+ */
+
 /**
  * Custom post type where each post stores Slack integration settings.
@@ -13 +20 @@
 
     /**
+     * Plugin's instance.
+     *
      * @var WP_Slack_Plugin
      */
     private $plugin;
 
+    /**
+     * Constructor.
+     *
+     * @param WP_Slack_Plugin $plugin Plugin's instance.
+     */
     public function __construct( WP_Slack_Plugin $plugin ) {
         $this->plugin = $plugin;
@@ -48 +62 @@
         add_action( 'all_admin_notices', array( $this, 'admin_notices' ) );
 
-        // Custom columns
+        // Custom columns.
         add_filter( sprintf( 'manage_%s_posts_columns', $this->name ), array( $this, 'columns_header' ) );
         add_action( sprintf( 'manage_%s_posts_custom_column', $this->name ), array( $this, 'custom_column_row' ), 10, 2 );
@@ -62 +76 @@
     }
 
+    /**
+     * Register the custom post type.
+     */
     public function register_post_type() {
         $args = array(
@@ -74 +91 @@
             'show_in_menu'        => true,
 
-            'menu_position'       => 75, // Below tools
+            'menu_position'       => 75, // Below tools.
             'menu_icon'           => $this->plugin->plugin_url . 'img/logo.png',
             'can_export'          => true,
@@ -85 +102 @@
             'capabilities' => array(
 
-                // meta caps (don't assign these to roles)
+                // Meta caps (don't assign these to roles).
                 'edit_post'              => 'manage_options',
                 'read_post'              => 'manage_options',
                 'delete_post'            => 'manage_options',
 
-                // primitive/meta caps
+                // Primitive/meta caps.
                 'create_posts'           => 'manage_options',
 
-                // primitive caps used outside of map_meta_cap()
+                // Primitive caps used outside of map_meta_cap().
                 'edit_posts'             => 'manage_options',
                 'edit_others_posts'      => 'manage_options',
@@ -99 +116 @@
                 'read_private_posts'     => 'manage_options',
 
-                // primitive caps used inside of map_meta_cap()
+                // Primitive caps used inside of map_meta_cap().
                 'read'                   => 'manage_options',
                 'delete_posts'           => 'manage_options',
@@ -138 +155 @@
     }
 
+    /**
+     * Remove default submit meta box.
+     */
     public function remove_submitdiv() {
         remove_meta_box( 'submitdiv', $this->name, 'side' );
     }
 
+    /**
+     * Enqueue scripts for Slack Integration screens.
+     */
     public function enqueue_scripts() {
-        if ( $this->name === get_post_type() ) {
+        if ( get_post_type() === $this->name ) {
             wp_dequeue_script( 'autosave' );
 
             wp_enqueue_style(
-                // Handle.
-                'slack-admin',
-
-                // Src.
-                $this->plugin->plugin_url . 'css/admin.css',
-
-                // Deps
-                array(),
-
-                // Version.
-                filemtime( $this->plugin->plugin_path . 'css/admin.css' ),
-
-                // Media.
-                'all'
+                'slack-admin',                                             // Handle.
+                $this->plugin->plugin_url . 'css/admin.css',               // Src.
+                array(),                                                   // Deps
+                filemtime( $this->plugin->plugin_path . 'css/admin.css' ), // Version.
+                'all'                                                      // Media.
             );
 
             wp_enqueue_script(
-                // Handle.
-                'slack-admin-js',
-
-                // Src.
-                $this->plugin->plugin_url . 'js/admin.js',
-
-                // Deps
-                array( 'jquery' ),
-
-                // Ver.
-                filemtime( $this->plugin->plugin_path . 'js/admin.js' )
+                'slack-admin-js',                                       // Handle.
+                $this->plugin->plugin_url . 'js/admin.js',              // Src.
+                array( 'jquery' ),                                      // Deps.
+                filemtime( $this->plugin->plugin_path . 'js/admin.js' ) // Ver.
             );
         }
     }
 
+    /**
+     * Filter message notice when integration setting is updated.
+     *
+     * @param array $messages List of messages when post is updated.
+     *
+     * @return array Updated messages
+     */
     public function post_updated_messages( $messages ) {
         $messages[ $this->plugin->post_type->name ] = array_fill( 0, 11,  __( 'Setting updated.', 'slack' ) );
@@ -186 +200 @@
 
     /**
-     * @param array $bulk_messages Arrays of messages, each keyed by the corresponding post type. Messages are
-     *                             keyed with 'updated', 'locked', 'deleted', 'trashed', and 'untrashed'.
-     * @param array $bulk_counts   Array of item counts for each message, used to build internationalized strings.
+     * Filter message notice when integration settings were bulk-updated.
+     *
+     * @param array $bulk_messages Arrays of messages, each keyed by the
+     *                             corresponding post type. Messages are keyed with
+     *                             'updated', 'locked', 'deleted', 'trashed', and
+     *                             'untrashed'.
+     * @param array $bulk_counts   Array of item counts for each message, used to
+     *                             build internationalized strings.
+     *
+     * @return array Updated bulk messages
      */
     public function bulk_post_updated_messages( $bulk_messages, $bulk_counts ) {
@@ -195 +216 @@
         if ( $this->name === $screen->post_type ) {
             $bulk_messages['post'] = array(
-                'updated'   => _n( '%s integration updated.', '%s integrations updated.', $bulk_counts['updated'] ),
-                'locked'    => _n( '%s integration not updated, somebody is editing it.', '%s integrations not updated, somebody is editing them.', $bulk_counts['locked'] ),
-                'deleted'   => _n( '%s integration permanently deleted.', '%s integrations permanently deleted.', $bulk_counts['deleted'] ),
-                'trashed'   => _n( '%s integration moved to the Trash.', '%s integrations moved to the Trash.', $bulk_counts['trashed'] ),
-                'untrashed' => _n( '%s integration restored from the Trash.', '%s integrations restored from the Trash.', $bulk_counts['untrashed'] ),
+                /* translators: placeholder is number of updated integrations. */
+                'updated'   => _n( '%s integration updated.', '%s integrations updated.', $bulk_counts['updated'], 'slack' ),
+                /* translators: placeholder is number of updated integrations. */
+                'locked'    => _n( '%s integration not updated, somebody is editing it.', '%s integrations not updated, somebody is editing them.', $bulk_counts['locked'], 'slack' ),
+                /* translators: placeholder is number of deleted integrations. */
+                'deleted'   => _n( '%s integration permanently deleted.', '%s integrations permanently deleted.', $bulk_counts['deleted'], 'slack' ),
+                /* translators: placeholder is number of trashed integrations. */
+                'trashed'   => _n( '%s integration moved to the Trash.', '%s integrations moved to the Trash.', $bulk_counts['trashed'], 'slack' ),
+                /* translators: placeholder is number of restored integrations. */
+                'untrashed' => _n( '%s integration restored from the Trash.', '%s integrations restored from the Trash.', $bulk_counts['untrashed'], 'slack' ),
             );
         }
@@ -209 +235 @@
      * Custom bulk actions.
      *
-     * @param  array $actions
-     * @return array
+     * @param  array $actions List of actions.
+     * @return array List of actions
      *
      * @filter bulk_actions-edit-slack_integration
@@ -217 +243 @@
         unset( $actions['edit'] );
 
+        // @codingStandardsIgnoreStart
         // Unfortunately adding bulk actions won't work here.
         // @see https://core.trac.wordpress.org/ticket/16031
@@ -222 +249 @@
         // $actions['activate']   = __( 'Activate', 'slack' );
         // $actions['deactivate'] = __( 'Deactivate', 'slack' );
+        // @codingStandardsIgnoreEnd
 
         return $actions;
@@ -229 +257 @@
      * Custom row actions for this post type.
      *
-     * @param  array $actions
-     * @return array
+     * @param  array $actions List of actions.
+     *
+     * @return array List of actions
      *
      * @filter post_row_actions
@@ -237 +266 @@
         $post = get_post();
 
-        if ( $this->plugin->post_type->name === get_post_type( $post ) ) {
+        if ( get_post_type( $post ) === $this->plugin->post_type->name ) {
             unset( $actions['inline hide-if-no-js'] );
             unset( $actions['view'] );
@@ -245 +274 @@
 
             if ( $setting['active'] ) {
-                $actions['deactivate'] = "<a title='" . esc_attr( __( 'Deactivate this integration setting' ) ) . "' href='" . wp_nonce_url( admin_url( sprintf( $post_type_object->_edit_link . '&amp;action=deactivate', $post->ID ) ), 'deactivate-post_' . $post->ID ) . "'>" . __( 'Deactivate' ) . "</a>";
+                $actions['deactivate'] = sprintf(
+                    '<a title="%1$s" href="%2$s">%3$s</a>',
+                    esc_attr__( 'Deactivate this integration setting', 'slack' ),
+                    wp_nonce_url( admin_url( sprintf( $post_type_object->_edit_link . '&amp;action=deactivate', $post->ID ) ), 'deactivate-post_' . $post->ID ),
+                    esc_html__( 'Deactivate', 'slack' )
+                );
             } else {
-                $actions['activate'] = "<a title='" . esc_attr( __( 'Activate this integration setting' ) ) . "' href='" . wp_nonce_url( admin_url( sprintf( $post_type_object->_edit_link . '&amp;action=activate', $post->ID ) ), 'activate-post_' . $post->ID ) . "'>" . __( 'Activate' ) . "</a>";
+                $actions['activate'] = sprintf(
+                    '<a title="%1$s" href="%2$s">%3$s</a>',
+                    esc_attr__( 'Activate this integration setting', 'slack' ),
+                    wp_nonce_url( admin_url( sprintf( $post_type_object->_edit_link . '&amp;action=activate', $post->ID ) ), 'activate-post_' . $post->ID ),
+                    esc_html__( 'Activate', 'slack' )
+                );
             }
         }
@@ -275 +314 @@
      * Action handler for activating/deactivating integration setting(s).
      *
-     * @param bool $activate
+     * @param bool $activate Flag to indicated whether this is activattion action.
      */
     private function _set_active_setting( $activate = true ) {
@@ -286 +325 @@
         if ( ! $post ) {
             wp_die(
+                /* translators: placeholder is action type, either 'activate' or 'deactivate'. */
                 sprintf( __( 'The integration you are trying to %s is no longer exists.', 'slack' ), $activate ? 'activate' : 'deactivate' )
             );
@@ -300 +340 @@
         $key_arg = $activate ? 'activated' : 'deactivated';
 
-        wp_redirect( add_query_arg( array( "$key_arg" => 1, 'ids' => $post->ID ), $sendback ) );
+        wp_redirect( add_query_arg(
+            array(
+                "$key_arg" => 1,
+                'ids'      => $post->ID,
+            ),
+            $sendback
+        ) );
+
         exit;
     }
 
     /**
+     * Display notice when integration is activated or deactivated.
      *
      * @action all_admin_notices
@@ -310 +358 @@
     public function admin_notices() {
         $screen = get_current_screen();
-        if ( $screen->id !== 'edit-' . $this->name ) {
+        if ( 'edit-' . $this->name !== $screen->id ) {
             return;
         }
@@ -320 +368 @@
 
         $bulk_messages = array(
-            'activated'   => _n( '%s integration activated.',   '%s integrations activated.',   $bulk_counts['activated'] ),
-            'deactivated' => _n( '%s integration deactivated.', '%s integrations deactivated.', $bulk_counts['deactivated'] ),
+            /* translators: number of activated integrations. */
+            'activated'   => _n( '%s integration activated.', '%s integrations activated.', $bulk_counts['activated'], 'slack' ),
+            /* translators: number of deactivated integrations. */
+            'deactivated' => _n( '%s integration deactivated.', '%s integrations deactivated.', $bulk_counts['deactivated'], 'slack' ),
         );
 
         $bulk_counts = array_filter( $bulk_counts );
 
-        // If we have a bulk message to issue:
+        // If we have a bulk message to display.
         $messages = array();
         foreach ( $bulk_counts as $message => $count ) {
@@ -342 +392 @@
      * Custom columns for this post type.
      *
-     * @param  array $columns
-     * @return array
+     * @param  array $columns Post list columns.
+     * @return array Post list columns
      *
      * @filter manage_{post_type}_posts_columns
@@ -361 +411 @@
      * Custom column appears in each row.
      *
-     * @param string $column  Column name
-     * @param int    $post_id Post ID
+     * @param string $column  Column name.
+     * @param int    $post_id Post ID.
      *
      * @action manage_{post_type}_posts_custom_column
@@ -398 +448 @@
      *
      * @param array  $classes An array of post classes.
-     * @param string $class   A comma-separated list of additional classes added to the post.
+     * @param string $class   A comma-separated list of additional classes added
+     *                        to the post.
      * @param int    $post_id The post ID.
+     *
+     * @return array Array of post classes
      *
      * @filter post_class
@@ -427 +480 @@
      * Hides subsubsub top nav.
      *
-     * @return array
+     * @return array Top nav links
      */
     public function hide_subsubsub() {
@@ -433 +486 @@
     }
 
+    /**
+     * Change title placeholder for Slack Integration post.
+     *
+     * @param string $title Title placeholder.
+     *
+     * @return string Updated title placeholder
+     */
     public function title_placeholder( $title ) {
         $screen = get_current_screen();

slack/trunk/includes/submit-meta-box.php

@@ -1 +1 @@
 <?php
 /**
- * Replacement for builtin submitdiv meta box
- * for our custom post type.
+ * Submit Meta Box.
+ *
+ * @package WP_Slack
+ * @subpackage Integration
+ */
+
+/**
+ * Replacement for builtin submitdiv meta box for Slack integration CPT.
  */
 class WP_Slack_Submit_Meta_Box {
 
     /**
+     * Plugin's instance.
+     *
      * @var WP_Slack_Plugin
      */
     private $plugin;
 
+    /**
+     * Constructor.
+     *
+     * @param WP_Slack_Plugin $plugin Plugin's instance.
+     */
     public function __construct( WP_Slack_Plugin $plugin ) {
         $this->plugin = $plugin;
@@ -20 +33 @@
      * Register submit meta box.
      *
-     * @param
+     * @param string $post_type Post type.
      */
     public function register_meta_box( $post_type ) {
@@ -31 +44 @@
      * Display post submit form fields.
      *
-     * @param object $post
+     * @param WP_Post $post Post object.
      */
     public function slack_submitdiv( $post ) {

slack/trunk/readme.txt

@@ -3 +3 @@
 Donate link:       http://goo.gl/DELyuR
 Tags:              slack, api, chat, notification
-Requires at least: 3.6
-Tested up to:      4.7
-Stable tag:        0.5.1
+Requires at least: 4.3
+Tested up to:      4.7.3
+Stable tag:        0.6.0
 License:           GPLv2 or later
 License URI:       http://www.gnu.org/licenses/gpl-2.0.html
@@ -49 +49 @@
 == Changelog ==
 
+= 0.6.0 =
+* Fix spinner is not showing when sending test notification.
+* Convert HTML entities in Slack notifications.
+* Bump tested up to 4.7.3.
+* For developers, unit tests and end-to-end tests were added.
+
 = 0.5.1 =
 * Removed bin directory for published plugin in WP.org. Props otto42

slack/trunk/slack.php

@@ -1 +1 @@
 <?php
+/**
+ * Main plugin's file.
+ *
+ * @package WP_Slack
+ */
+
 /**
  * Plugin Name: Slack
  * Plugin URI: http://gedex.web.id/wp-slack/
  * Description: This plugin allows you to send notifications to Slack channels when certain events in WordPress occur.
- * Version: 0.5.1
+ * Version: 0.6.0
  * Author: Akeda Bagus
  * Author URI: http://gedex.web.id
@@ -10 +16 @@
  * Domain Path: /languages
  * License: GPL v2 or later
- * Requires at least: 3.6
- * Tested up to: 3.9
+ * Requires at least: 4.3
+ * Tested up to: 4.7.3
  *
  * This program is free software; you can redistribute it and/or modify
@@ -29 +35 @@
 WP_Slack_Autoloader::register( 'WP_Slack', trailingslashit( plugin_dir_path( __FILE__ ) ) . '/includes/' );
 
-// Runs this plugin.
-$GLOBALS['wp_slack'] = new WP_Slack_Plugin();
-$GLOBALS['wp_slack']->run( __FILE__ );
+// Runs this plugin after all plugins are loaded.
+add_action( 'plugins_loaded', function() {
+    $GLOBALS['wp_slack'] = new WP_Slack_Plugin();
+    $GLOBALS['wp_slack']->run( __FILE__ );
+});

slack/trunk/views/post-meta-box.php

@@ +1 @@
+<?php
+/**
+ * View for Integration Setting Meta Box.
+ *
+ * @package WP_Slack
+ * @subpackage View
+ */
+
+?>
 <table class="form-table">
     <tbody>
@@ -44 +53 @@
                 <input type="text" class="regular-text" name="slack_setting[icon_emoji]" id="slack_setting[icon_emoji]" value="<?php echo ! empty( $setting['icon_emoji'] ) ? esc_attr( $setting['icon_emoji'] ) : ''; ?>">
                 <p class="description">
-                    <?php printf( __( 'Icon (short name) of the bot that delivers the notification. For available icon short name, see <a href="%s" target="blank" title="Emoji Catalog">here</a>. Short name must be wrapped with colon, for instance <code>:rocket:</code>.', 'slack' ), esc_url( 'http://unicodey.com/emoji-data/table.htm' ) ); ?>
+                    <?php
+                    /* translators: placeholder is URL */
+                    printf( __( 'Icon (short name) of the bot that delivers the notification. For available icon short name, see <a href="%s" target="blank" title="Emoji Catalog">here</a>. Short name must be wrapped with colon, for instance <code>:rocket:</code>.', 'slack' ), esc_url( 'http://unicodey.com/emoji-data/table.htm' ) );
+                    ?>
                 </p>
             </td>
@@ -74 +86 @@
             </th>
             <td>
-                <input type="checkbox" name="slack_setting[active]" id="slack_setting[active]" <?php checked( ! empty( $setting['active'] ) ? $setting['active'] : false ); ?>>
+                <label>
+                    <input type="checkbox" name="slack_setting[active]" id="slack_setting[active]" <?php checked( ! empty( $setting['active'] ) ? $setting['active'] : false ); ?>>
+                    <?php _e( 'Activate Notifications.', 'slack' ); ?>
+                </label>
                 <p class="description">
                     <?php _e( 'Notification will not be sent if not checked.', 'slack' ); ?>

slack/trunk/views/submit-meta-box.php

@@ +1 @@
+<?php
+/**
+ * View for Save Setting Meta Box in Edit Slack Integration screen.
+ *
+ * @package WP_Slack
+ * @subpackage View
+ */
+
+?>
 <div class="submitbox" id="submitpost">
 
-    <?php // Hidden submit button early on so that the browser chooses the right button when form is submitted with Return key ?>
+    <?php
+    /**
+     * Hidden submit button early on so that the browser chooses the right
+     * button when form is submitted with Return key.
+     */
+    ?>
     <div style="display:none;">
-        <?php submit_button( __( 'Save' ), 'button', 'save' ); ?>
+        <?php submit_button( __( 'Save', 'slack' ), 'button', 'save' ); ?>
     </div>
 
@@ -25 +39 @@
             <span class="spinner"></span>
 
-            <input name="original_publish" type="hidden" id="original_publish" value="<?php esc_attr_e( 'Save' ) ?>" />
-            <input name="save" type="submit" class="button button-primary button-large" id="publish" accesskey="p" value="<?php esc_attr_e('Save' ) ?>" />
+            <input name="original_publish" type="hidden" id="original_publish" value="<?php esc_attr_e( 'Save', 'slack' ) ?>" />
+            <input name="save" type="submit" class="button button-primary button-large" id="publish" accesskey="p" value="<?php esc_attr_e( 'Save', 'slack' ); ?>" />
         </div>
         <div class="clear"></div>