Initial Redis source (WIP)

.travis.yml

@@ -4,6 +4,10 @@ php:
   - 5.3
   - 5.4
   - 5.5
+  - 5.6
+
+services:
+  - redis-server
 
 env:
   global:
@@ -30,6 +34,8 @@ matrix:
         - FOC_VALIDATE=1
 
 before_script:
+  - echo "extension = redis.so" >> ~/.phpenv/versions/$(phpenv version-name)/etc/php.ini
+  - phpenv rehash
   - git clone -b master https://github.com/FriendsOfCake/travis.git --depth 1 ../travis
   - ../travis/before_script.sh
 
@@ -41,3 +47,6 @@ after_success:
 
 notifications:
   email: false
+  hipchat:
+    rooms:
+      secure: BgtN4zIM+HqmIIvGb5aJz3vuu2ACF5k/1iJb32B/BSZE7hQxJ9iSsnY0naZzv81cmFVXmndzp4I4dM8wLrISScqSz3iM7NNVxMSm+FVQt63DckikO39Slyh8HfSyY3pxuIzPuecuIs85Li1z2KnBue34QRyMqmaAYS+sdTXZONM=

Model/Datasource/RedisSource.php

@@ -0,0 +1,264 @@
+<?php
+App::uses('DataSource', 'Model/Datasource');
+
+/**
+ * Redis Source class
+ *
+ */
+class RedisSource extends DataSource {
+
+/**
+ * Datasource description.
+ *
+ * @var string
+ */
+	public $description = 'Redis Data Source';
+
+/**
+ * Base configuration.
+ *
+ * @var array
+ */
+	protected $_baseConfig = array(
+		'host' => '127.0.0.1',
+		'port' => 6379,
+		'password' => '',
+		'database' => 0,
+		'timeout' => 0,
+		'persistent' => false,
+		'unix_socket' => '',
+		'prefix' => '',
+	);
+
+/**
+ * Configuration.
+ *
+ * @var array
+ */
+	public $config = array();
+
+/**
+ * A reference to the physical connection of this DataSource.
+ *
+ * @var Redis
+ */
+	protected $_connection = null;
+
+/**
+ * Whether or not we are connected to the DataSource.
+ *
+ * @var bool
+ */
+	public $connected = false;
+
+/**
+ * Whether or not source data like available tables and schema descriptions should be cached.
+ *
+ * @var bool
+ */
+	public $cacheSources = false;
+
+/**
+ * Constructor.
+ *
+ * @param array $config Array of configuration information for the Datasource
+ * @return bool True if connecting to the DataSource succeeds, else false
+ */
+	public function __construct($config = array()) {
+		parent::__construct($config);
+
+		if (!$this->enabled()) {
+			return false;
+		}
+
+		$this->_connection = new Redis();
+
+		return $this->connect();
+	}
+
+/**
+ * Destructor.
+ *
+ *  Closes the connection to the host (if needed).
+ *
+ * @return void
+ * @todo Write test
+ */
+	public function __destruct() {
+		if (!$this->config['persistent']) {
+			$this->close();
+		}
+	}
+
+/**
+ * Passes (non-existing) method calls to `Redis`.
+ *
+ * @param string $name The name of the method being called
+ * @param array $arguments An enumerated array containing the parameters passed to the method
+ * @return mixed Method return value
+ * @todo Throw exception(s)
+ */
+	public function __call($name, $arguments) {
+		if (!method_exists($this->_connection, $name)) {
+			return false;
+		}
+
+		return call_user_func_array(array($this->_connection, $name), $arguments);
+	}
+
+/**
+ * Check that the redis extension is loaded.
+ *
+ * @return bool Whether or not the extension is loaded
+ */
+	public function enabled() {
+		return extension_loaded('redis');
+	}
+
+/**
+ * Connects to the database using options in the given configuration array.
+ *
+ *  "Connects mean:
+ *  - connect
+ *  - authenticate
+ *  - select
+ *  - setPrefix
+ *
+ * @return bool
+ */
+	public function connect() {
+		$this->connected = $this->_connect();
+		$this->connected = $this->connected && $this->_authenticate();
+		$this->connected = $this->connected && $this->_select();
+		$this->connected = $this->connected && $this->_setPrefix();
+
+		return $this->connected;
+	}
+
+/**
+ * Connects to the database using options in the given configuration array.
+ *
+ * @return bool True if connecting to the DataSource succeeds, else false
+ */
+	protected function _connect() {
+		// TODO: Remove useless try / catch?
+		try {
+			if ($this->config['unix_socket']) {
+				return $this->_connection->connect($this->config['unix_socket']);
+			} elseif (!$this->config['persistent']) {
+				return $this->_connection->connect(
+					$this->config['host'], $this->config['port'], $this->config['timeout']
+				);
+			} else {
+				$persistentId = crc32(serialize($this->config));
+
+				return $this->_connection->pconnect(
+					$this->config['host'], $this->config['port'], $this->config['timeout'], $persistentId
+				);
+			}
+		} catch (RedisException $e) {
+			return false;
+		}
+	}
+
+/**
+ * Authenticates to the database (if needed) using options in the given configuration array.
+ *
+ * @return bool True if the authentication succeeded or no password was specified, else false
+ */
+	protected function _authenticate() {
+		if ($this->config['password']) {
+			return $this->_connection->auth($this->config['password']);
+		}
+
+		return true;
+	}
+
+/**
+ * Selects a database (if needed) using options in the given configuration array.
+ *
+ * @return bool True if the select succeeded or no database was specified, else false
+ */
+	protected function _select() {
+		if ($this->config['database']) {
+			return $this->_connection->select($this->config['database']);
+		}
+
+		return true;
+	}
+
+/**
+ * Sets a prefix for all keys (if needed) using options in the given configuration array.
+ *
+ * @return bool True if setting the prefix succeeded or no prefix was specified, else false
+ */
+	protected function _setPrefix() {
+		if ($this->config['prefix']) {
+			return $this->_connection->setOption(Redis::OPT_PREFIX, $this->config['prefix']);
+		}
+
+		return true;
+	}
+
+/**
+ * Closes a connection.
+ *
+ * @return bool Always true
+ */
+	public function close() {
+		// TODO: Remove useless condition
+		if ($this->isConnected()) {
+			$this->_connection->close();
+		}
+
+		$this->connected = false;
+		$this->_connection = null;
+
+		return true;
+	}
+
+/**
+ * Checks if the source is connected to the database.
+ *
+ * @return bool True if the database is connected, else false
+ */
+	public function isConnected() {
+		return $this->connected;
+	}
+
+/**
+ * Caches/returns cached results for child instances.
+ *
+ * @param mixed $data List of tables
+ * @return array Array of sources available in this datasource
+ * @todo: Remove useless method?
+ */
+	public function listSources($data = null) {
+		return parent::listSources($data);
+	}
+
+/**
+ * Returns a Model description (metadata) or null if none found.
+ *
+ * @param Model|string $model Name of database table to inspect or model instance
+ * @return array Array of Metadata for the $model
+ * @todo: Remove useless method?
+ */
+	public function describe($model) {
+		return parent::describe($model);
+	}
+
+/**
+ * Returns an SQL calculation, i.e. COUNT() or MAX()
+ *
+ * @param Model $Model The model to get a calculated field for
+ * @param string $func Lowercase name of SQL function, i.e. 'count' or 'max'
+ * @param array $params Function parameters (any values must be quoted manually)
+ * @return string An SQL calculation function
+ * @todo Remove useless method?
+ */
+	public function calculate(Model $Model, $func, $params = array()) {
+		return array('count' => true);
+	}
+
+}

README.md

@@ -1,6 +1,6 @@
 # Redis (DataSource) plugin for CakePHP
 
-[![Build Status](https://travis-ci.org/Oefenweb/cakephp-redis.png?branch=master)](https://travis-ci.org/Oefenweb/cakephp-redis) [![Coverage Status](https://coveralls.io/repos/Oefenweb/cakephp-redis/badge.png)](https://coveralls.io/r/Oefenweb/cakephp-redis)
+[![Build Status](https://travis-ci.org/Oefenweb/cakephp-redis.png?branch=master)](https://travis-ci.org/Oefenweb/cakephp-redis) [![Coverage Status](https://coveralls.io/repos/Oefenweb/cakephp-redis/badge.png)](https://coveralls.io/r/Oefenweb/cakephp-redis) [![Packagist downloads](http://img.shields.io/packagist/dt/Oefenweb/cakephp-redis.svg)](https://packagist.org/packages/oefenweb/cakephp-redis)
 
 The Redis (DataSource) plugin ...