first commit

Author: Geekimo

.gitignore

@@ -0,0 +1,9 @@
+composer.lock
+vendor/
+_builds/
+_cache/
+_projects/
+_steps/
+rethinkdb_data/
+wercker
+

.travis.yml

@@ -0,0 +1,35 @@
+language: php
+
+sudo: true
+
+php:
+  - 5.3
+  - 5.4
+  - 5.5
+  - 5.6
+  - 7.0
+  - hhvm
+
+matrix:
+  allow_failures:
+    - php: hhvm
+
+cache:
+  directories:
+    - $HOME/.composer/cache
+
+before_install:
+  - source /etc/lsb-release && echo "deb http://download.rethinkdb.com/apt $DISTRIB_CODENAME main" | sudo tee /etc/apt/sources.list.d/rethinkdb.list
+  - wget -qO- https://download.rethinkdb.com/apt/pubkey.gpg | sudo apt-key add -
+  - sudo apt-get update
+  - sudo apt-get install -y rethinkdb
+  - nohup rethinkdb &
+  - travis_retry composer self-update
+
+install:
+  - travis_retry composer update --no-interaction --prefer-source
+
+script:
+  - php vendor/bin/parallel-lint --exclude vendor .
+  - php vendor/bin/phpcs -n --standard=PSR2 rdb/
+  - composer test

README.md

@@ -0,0 +1,74 @@
+PHP-RQL
+=======
+
+A PHP client driver for the RethinkDB query language (ReQL).
+
+PHP-RQL is licensed under the terms of the Apache License 2.0 http://www.apache.org/licenses/LICENSE-2.0
+
+Continuous Integration
+-----------------------
+Master branch:
+[![master branch](https://travis-ci.org/danielmewes/php-rql.svg?branch=master)](https://travis-ci.org/danielmewes/php-rql)
+
+Development branch:
+[![dev branch](https://travis-ci.org/danielmewes/php-rql.svg?branch=dev)](https://travis-ci.org/danielmewes/php-rql)
+
+To run the tests at the command line, issue `composer install` and then `composer test` at the package root. This requires `composer` to be available in `$PATH`.
+
+Documentation
+----------------
+
+Read the PHP-RQL [API documentation](http://danielmewes.dnsalias.net/~daniel/php-rql-api/).
+
+The official [JavaScript driver documentation](http://rethinkdb.com/api/javascript/) has more details on the available terms. Most examples for the JavaScript driver can be translated to PHP-RQL with few changes.
+
+Example
+----------------
+
+```php
+<?php
+    // Load the driver
+    require_once("rdb/rdb.php");
+
+    // Connect to localhost
+    $conn = r\connect('localhost');
+
+    // Create a test table
+    r\db("test")->tableCreate("tablePhpTest")->run($conn);
+
+    // Insert a document
+    $document = array('someKey' => 'someValue');
+    $result = r\table("tablePhpTest")->insert($document)
+        ->run($conn);
+    echo "Insert: $result\n";
+
+    // How many documents are in the table?
+    $result = r\table("tablePhpTest")->count()->run($conn);
+    echo "Count: $result\n";
+
+    // List the someKey values of the documents in the table
+    // (using a mapping-function)
+    $result = r\table("tablePhpTest")->map(function($x) {
+            return $x('someKey');
+        })->run($conn);
+
+    foreach ($result as $doc) {
+        print_r($doc);
+    }
+
+    // Delete the test table
+    r\db("test")->tableDrop("tablePhpTest")->run($conn);
+?>
+```
+
+Release Notes
+----------------
+
+...are available on the main website: http://php-rql.dnsalias.net
+
+
+Attributions
+------------
+* PHP-RQL uses pb4php http://code.google.com/p/pb4php/ by Nikolai Kordulla.
+* The API documentation is based on the official RethinkDB API documentation.
+* The API documentation is built using jTokenizer by Tim Whitlock (http://timwhitlock.info) and PHP Markdown by Michel Fortin (https://michelf.ca/).

composer.json

@@ -0,0 +1,44 @@
+{
+    "name": "geekimo/php-rql",
+    "type": "library",
+    "description": "A PHP client driver for the RethinkDB query language (ReQL)",
+    "keywords": ["rethinkdb","driver","database","reql"],
+    "homepage": "https://github.com/Geekimo/php-rql/",
+    "license": "Apache-2.0",
+    "authors": [
+        {
+            "name": "Daniel Mewes",
+            "email": "danielmewes@onlinehome.de",
+            "homepage": "http://dmewes.com",
+            "role": "Developer"
+        },
+        {
+            "name": "Morgan Abraham",
+            "email": "morgan@tramicms.net",
+            "role": "Developer"
+        }
+    ],
+    "require": {
+        "php": ">=5.3.0"
+    },
+    "require-dev": {
+        "phpunit/phpunit": "~4.8",
+        "jakub-onderka/php-parallel-lint": "dev-master",
+        "squizlabs/php_codesniffer": "~2.5"
+    },
+    "autoload": {
+        "files": ["rdb/rdb.php"],
+        "psr-4": {
+            "r\\": "rdb/",
+            "r\\Tests\\": "tests/"
+        }
+    },
+    "scripts": {
+        "test": "tests/phpunit.sh"
+    },
+    "config": {
+        "preferred-install": "dist",
+        "optimize-autoloader": true,
+        "process-timeout": 300
+    }
+}

docs/README

@@ -0,0 +1,6 @@
+The API documentation is generated in three steps.
+1. Based on the documentation for RethinkDB's JavaScript driver (available from <https://github.com/rethinkdb/docs/tree/master/api/javascript>), some heuristics are automatically applied to translate examples into PHP-RQL syntax. This is done by the `jsToPhp.php` script.
+2. Since some terms work differently in PHP-RQL and the automatic translation isn't perfect, a patch is applied to the result of step 1. This patch is the file `php-patches.patch`.
+3. From the patched markdown file, an HTML page is generated by the script `mdToHtml.php`. This also applied a few additional filters on the markdown to account for aspects not currently supported by the PHP-RQL documentation system.
+
+All three steps are performed automatically by the `generate.sh` script.

docs/api.css

@@ -0,0 +1,37 @@
+@charset "UTF-8";
+
+a {
+    color: #773333;
+}
+
+h1 {
+    font-family: Sans-Serif;
+    background-color: #e5b0b0;
+    padding: 0.7cm;
+}
+
+h2 {
+    margin-top: 2cm;
+    font-family: Sans-Serif;
+    background-color: #f0c0c0;
+    padding: 0.5cm;
+}
+
+h3 {
+    margin-top: 1cm;
+    font-family: Sans-Serif;
+    background-color: #f5e0e0;
+    padding: 0.1cm;
+}
+
+pre.syntax {
+    border: solid;
+    border-width: 1px;
+    border-color: #f5e0e0;
+    padding: 0.1cm;
+    color: #555555;
+}
+
+pre.example {
+    padding: 0.3cm;
+}

docs/generate.sh

@@ -0,0 +1,4 @@
+#!/bin/bash
+cat js-index.md | php5 jsToPhp.php > php-index.md
+cat php-patches.patch | patch php-index.md
+cat php-index.md | php5 mdToHtml.php > index.html