Stable Release 1.0.0

Author: marcqualie

README.md

@@ -4,8 +4,8 @@
 [![Total Downloads](https://poser.pugx.org/marcqualie/mongominify/d/total.png)](https://packagist.org/packages/marcqualie/mongominify)
 [![Latest Stable Version](https://poser.pugx.org/marcqualie/mongominify/version.png)](https://packagist.org/packages/marcqualie/mongominify)
 
-A drop-in library which acts as a transparent filter to MongoDB documents and compresses/decompresses data on the fly.
-Entirely namespaced, PSR-0 compliant and works with both PHP 5.3 and 5.4.
+MongoMinify is a drop-in library which acts as a transparent filter to MongoDB documents and compresses/decompresses data on the fly.
+PSR-1 compliant and works with PHP 5.3+.
 
 
 ### Getting started
@@ -15,11 +15,11 @@ You should check out the [Getting Started](https://github.com/marcqualie/mongomi
 
 ### Quick Instalation
 
-Put the following inside your composer.json
+The best way to install this library is via composer.
 
     {
         "require": {
-            "marcqualie/mongominify": "0.0.*"
+            "marcqualie/mongominify": "~1.0"
         }
     }
 
@@ -32,6 +32,12 @@ Myself and many other developers got around this by adding single letter key nam
 MongoMinify gets around this problem by transparently converting documents as they are transfered between the client and the database leaving readable code with compressed storage.
 
 
+## Requirements
+
+- PHP 5.3+
+- MongoDB PHP Driver 1.3+
+
+
 ## Feedback / Contributing
 
-Any feedback, pull requests or documentation would be greatly apreciated.
+Feedback and pull requests on Github are always welcome.

lib/MongoMinify/Client.php

@@ -19,6 +19,10 @@ class Client
     public function __construct($server = 'mongodb://localhost:27017', array $options = array())
     {
 
+        // Link timeouts
+        Cursor::$timeout = \MongoCursor::$timeout;
+        \MongoCursor::$timeout =& Cursor::$timeout;
+
         // Parse MongoDB Path Info
         if (! empty($options['db'])) {
             $db_name = $options['db'];
@@ -39,7 +43,7 @@ public function __construct($server = 'mongodb://localhost:27017', array $option
         if ($db_name) {
             $this->selectDb($db_name);
         }
-        
+
     }
 
 

lib/MongoMinify/Cursor.php

@@ -117,16 +117,11 @@ public function timeout($ms)
 
 
     /**
-     * Array helper for inline cursorts
+     * Array helper for inline cursors
      */
-    public function as_array()
+    public function asArray()
     {
         return iterator_to_array($this, false);
     }
 
 }
-
-// Bind native timeouts
-// TODO: Temporary fix, need a better place to put this code
-Cursor::$timeout = \MongoCursor::$timeout;
-\MongoCursor::$timeout =& Cursor::$timeout;

tests/MongoMinify/Tests/CursorTest.php

@@ -253,7 +253,7 @@ public function testAsArrayHelper()
 			)
 		);
 		$collection->batchInsert($documents);
-		$array = $collection->find()->sort(array('_id' => -1))->as_array();
+		$array = $collection->find()->sort(array('_id' => -1))->asArray();
 		$this->assertTrue(is_array($array));
 		$this->assertEquals($array, array(
 			array('_id' => 3, 'role' => 'moderator'),

tests/MongoMinify/Tests/QueryTest.php

@@ -153,7 +153,7 @@ public function testElemMatch()
             array(
                 '_id' => 1
             )
-        )->as_array();
+        )->asArray();
         $this->assertEquals($find, array(array('_id' => 1), array('_id' => 3)));
 
         // Test operator matching
@@ -170,7 +170,7 @@ public function testElemMatch()
             array(
                 '_id' => 1
             )
-        )->as_array();
+        )->asArray();
         $this->assertEquals($find, array(array('_id' => 1), array('_id' => 3), array('_id' => 4)));
 
     }
@@ -213,7 +213,7 @@ public function testAndOr()
             array(
                 '_id' => 1
             )
-        )->as_array();
+        )->asArray();
         $this->assertEquals($find, array(array('_id' => 2)));
         $find = $collection->find(
             array(
@@ -229,7 +229,7 @@ public function testAndOr()
             array(
                 '_id' => 1
             )
-        )->as_array();
+        )->asArray();
         $this->assertEquals($find, array());
 
         // Test $or
@@ -247,7 +247,7 @@ public function testAndOr()
             array(
                 '_id' => 1
             )
-        )->as_array();
+        )->asArray();
         $this->assertEquals($find, array(array('_id' => 1), array('_id' => 2)));
         $find = $collection->find(
             array(
@@ -263,7 +263,7 @@ public function testAndOr()
             array(
                 '_id' => 1
             )
-        )->as_array();
+        )->asArray();
         $this->assertEquals($find, array());
 
     }