Merge branch '7.x-1.x' of github.com:Gizra/message into 7.x-1.x

Author: amitaibu

.travis.yml

@@ -4,12 +4,13 @@ php:
   - 5.3
 
 mysql:
-  database: drupal
+  database: message
   username: root
   encoding: utf8
 
 before_script:
-  # navigate out of module directory to prevent blown stack by recursive module lookup
+  # navigate out of module directory to prevent blown stack by recursive module
+  # lookup
   - cd ../..
 
   # install drush
@@ -21,16 +22,18 @@ before_script:
   - sudo apt-get update > /dev/null
   - sudo apt-get install -y --force-yes php5-cgi php5-mysql
 
-  # create new site, stubbing sendmail path with true to prevent delivery errors and manually resolving drush path
-  - mysql -e 'create database drupal'
-  - php -d sendmail_path=`which true` `pear config-get php_dir`/drush/drush.php --yes core-quick-drupal --profile=testing --no-server --db-url=mysql://root:@127.0.0.1/drupal --enable=simpletest message
+  # create new site, stubbing sendmail path with true to prevent delivery errors
+  # and manually resolving drush path
+  - mysql -e 'create database message'
+  - php -d sendmail_path=`which true` `pear config-get php_dir`/drush/drush.php --yes core-quick-drupal --profile=testing --no-server --db-url=mysql://root:@127.0.0.1/message --enable=simpletest message
 
-  # reference and enable module in build site
+  # reference and enable message in build site
   - ln -s $(readlink -e $(cd -)) message/drupal/sites/all/modules/message
   - cd message/drupal
-  - drush --yes pm-enable message
+  - drush --yes pm-enable message_example
 
-  # start a web server on port 8080, run in the background; wait for initialization
+  # start a web server on port 8080, run in the background; wait for
+  # initialization
   - drush runserver 127.0.0.1:8080 &
   - until netstat -an 2>/dev/null | grep '8080.*LISTEN'; do true; done
 

README.md

@@ -1,9 +1,9 @@
 [![Build Status](https://travis-ci.org/Gizra/message.svg?branch=7.x-1.x)](https://travis-ci.org/Gizra/message)
 
-Overview
-========
 A general logging utility that can be used as activity module.
 
+Overview
+========
 * In message module, the arguments of a sentence can use tokens, custom
   callbacks or be hard-coded. Making the arguments dynamic means that the
   rendering time is slower than activity, on the other hand you can use
@@ -89,3 +89,56 @@ definition.
   "Override global settings" checkbox will make the global settings ignore the
   current message type and will allow to set purging definitions for the current
   type.
+
+Computed arguments plugin
+============
+When saving a message to the DB the reference to the arguments callbacks stored
+in the DB as well. This will be a problem when we want to change the name of the
+function.
+
+Message allows you to keep the message text with the arguments but the callbacks
+will be handled with a CTools plugin.
+
+Message example define a 'Computed arguments' plugin for the 'Example arguments'
+message type. The name of the plugin need to be the name of the message type.
+
+`example_arguments.inc`:
+```php
+<?php
+
+$plugin = array(
+  'label' => t('Message example create node'),
+  'description' => t('Supply arguments handler for the message example create node bundle.'),
+  'class' => 'ExampleArguments',
+);
+```
+
+The class is implemented in `ExampleArguments.class.php`:
+```php
+<?php
+
+class ExampleArguments extends MessageArgumentsBase {
+
+  /**
+   * @return mixed
+   */
+  public function getNameArgument() {
+    return array(
+      '@name' => array($this, 'processName'),
+      '%time' => array($this, 'processTime'),
+      '!link' => array($this, 'processLink'),
+    );
+  }
+```
+
+The `getNameArgument` method define for each argument which method should handle
+it and calculate the value:
+```php
+  /**
+   * Process the current time.
+   */
+  public function processTime() {
+    return format_date($this->getMessage()->timestamp);
+  }
+}
+```

includes/MessageArgumentInterface.php

@@ -0,0 +1,50 @@
+<?php
+
+/**
+ * Contains MessageArgumentInterface.
+ */
+
+interface MessageArgumentInterface {
+
+  /**
+   * @return Message
+   */
+  public function getMessage();
+
+  /**
+   * @param Message $message
+   *   The message object.
+   *
+   * @return MessageArgumentsBase
+   */
+  public function setMessage(Message $message);
+
+  /**
+   * Retrieve the arguments info.
+   *
+   * @return array
+   *   The arguments as and their values.
+   */
+  public function getArguments();
+
+  /**
+   * The method return information about the arguments for the message and the
+   * callbacks which responsible to compute the argument value.
+   *
+   * @return array
+   *   Associate array with the name of the argument and the callback
+   *   responsible to compute the argument value.
+   *
+   * @code
+   * return array(
+   *  '@name' => array($this, 'processName'),
+   *  '%time' => array($this, 'processTime'),
+   *  '!link' => array($this, 'processLink'),
+   * );
+   * @endcode
+   *
+   * The callback will return the value for the argument. The message object can
+   * be access via the getMessage() method.
+   */
+  public function getNameArgument();
+}

includes/MessageArgumentsBase.php

@@ -0,0 +1,45 @@
+<?php
+
+/**
+ * Contains \MessageArgumentsBase.
+ */
+
+abstract class MessageArgumentsBase implements MessageArgumentInterface {
+
+  /**
+   * @var Message
+   *
+   * The message object.
+   */
+  protected $message;
+
+  /**
+   * {@inheritdoc}
+   */
+  public function getMessage() {
+    return $this->message;
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public function setMessage(Message $message) {
+    $this->message = $message;
+    return $this;
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public function getArguments() {
+    $arguments = array();
+    $callbacks = $this->getNameArgument();
+
+    foreach ($callbacks as $argument => $callback) {
+      $arguments[$argument] = call_user_func($callback);
+    }
+
+    return $arguments;
+  }
+
+}

includes/message.message.inc

@@ -85,6 +85,8 @@ class Message extends Entity {
   }
 
   /**
+   * {@inheritdoc}
+   *
    * Generate an array for rendering the entity's content.
    *
    * Iterate over the extra field settings, and show the visible partials.
@@ -140,10 +142,14 @@ class Message extends Entity {
    * Replace arguments with their placeholders.
    *
    * @param $langcode
-   *   Optional; The language to get the text in. If not set the current language
-   *   will be used.
+   *   Optional; The language to get the text in. If not set the current
+   *   language will be used.
    * @param $options
    *   Optional; Array to be passed to MessageType::getText().
+   *
+   * @return mixed|string
+   *   The message text compiled into a string or an array of the message
+   *   partials.
    */
   public function getText($langcode = LANGUAGE_NONE, $options = array()) {
     $message_type = $this->getType();
@@ -154,6 +160,13 @@ class Message extends Entity {
     }
 
     $arguments = message_get_property_values($this, 'arguments');
+
+    // Check if the current message have any arguments plugin.
+    $handler = message_get_computed_arguments_handler($this);
+    if ($handler && $handler_arguments = $handler->getArguments()) {
+      $arguments = array_merge($arguments, $handler_arguments);
+    }
+
     $output = $message_type->getText($langcode, $options);
 
     if (!empty($arguments)) {

message.api.php

@@ -72,7 +72,7 @@ function hook_message_view_alter(&$build) {
  * @see hook_default_message_type_alter()
  */
 function hook_default_message_type() {
-  $defaults['main'] = entity_create('message_type', array(
+  $defaults['main'] = message_type_create('example_create_node', array(
     'description' => 'Type description',
     'argument_keys' => array(
       '!teaser',

message.info

@@ -1,23 +1,29 @@
-; $Id: message.info,v 1.3 2010/06/07 10:54:11 amitaibu Exp $
 name = Message
 description = "A general message logging utility."
 core = 7.x
 package = Message
+
 dependencies[] = entity
+dependencies[] = ctools
 
-; Entity API includes
+; Entity API includes.
 files[] = message.info.inc
 files[] = includes/message.admin.inc
 files[] = includes/message.exception.inc
-files[] = includes/message.message_type_category.inc
-files[] = includes/message.message_type.inc
 files[] = includes/message.message.inc
+files[] = includes/message.message_type.inc
+files[] = includes/message.message_type_category.inc
 
-; Tests
-files[] = message.test
+; Tests.
+files[] = tests/message.test
+files[] = tests/MessageArgumentsTestCase.test
 
-; Views includes
+; Views includes.
 files[] = includes/views/message.views.inc
 files[] = includes/views/handlers/message_handler_field_message_render.inc
 files[] = includes/views/handlers/message_handler_filter_message_type.inc
 files[] = includes/views/handlers/message_handler_filter_message_type_category.inc
+
+; Message arguments handlers.
+files[] = includes/MessageArgumentsBase.php
+files[] = includes/MessageArgumentInterface.php

message.module

@@ -15,6 +15,52 @@ define('MESSAGE_FIELD_MESSAGE_TEXT', 'message_text');
  */
 define('MESSAGE_PURGE_LIMIT', 100);
 
+/**
+ * Implements hook_ctools_plugin_type().
+ */
+function message_ctools_plugin_type() {
+  $plugins['computed_arguments'] = array(
+    'classes' => array('class'),
+    'child plugins' => TRUE,
+  );
+
+  return $plugins;
+}
+
+/**
+ * Return message arguments plugin by the message type.
+ *
+ * @param Message $message
+ *   The message object.
+ *
+ * @return MessageArgumentsBase | NULL
+ *   The handler object if found else NULL.
+ */
+function message_get_computed_arguments_handler(Message $message) {
+  $plugin = message_get_computed_arguments_plugin($message->bundle());
+
+  if (!$class = ctools_plugin_load_class('message', 'computed_arguments', $message->bundle(), 'class')) {
+    return NULL;
+  }
+
+  $handler = new $class($plugin);
+  return $handler->setMessage($message);
+}
+
+/**
+ * Get the specified message arguments plugin.
+ *
+ * @param string $plugin_name
+ *   Optional. If provided the function will return the desired plugin.
+ *
+ * @return array
+ *   The selected plugin for the message arguments.
+ */
+function message_get_computed_arguments_plugin($plugin_name = '') {
+  ctools_include('plugins');
+  return ctools_get_plugins('message', 'computed_arguments', $plugin_name);
+}
+
 /**
  * Implementation of hook_views_api().
  */
@@ -835,6 +881,8 @@ function message_type_delete($message) {
  * @param $account
  *   Optional; The user object to associate the message with. If empty, the
  *   current user will be used.
+ *
+ * @return Message
  */
 function message_create($type, $values = array(), $account = NULL) {
   global $language;