Merge branch 'feature/new-structure' of github.com:basdenooijer/solarium into feature/new-structure

library/Solarium/Document/ReadWrite.php

@@ -202,6 +202,19 @@ class Solarium_Document_ReadWrite extends Solarium_Document_ReadOnly
         return $this->_boost;
     }
 
+    /**
+     * Clear all fields
+     *
+     * @return Solarium_Document_ReadWrite Provides fluent interface
+     **/
+    public function clear()
+    {
+        $this->_fields = array();
+        $this->_fieldBoosts = array();
+        
+        return $this;
+    }
+
     /**
      * Set field value
      *

library/Solarium/Query/Update/Command/Add.php

@@ -68,7 +68,7 @@ class Solarium_Query_Update_Command_Add extends Solarium_Query_Update_Command
      * Add a single document
      *
      * @param object $document
-     * @return Solarium_Query_Update_Add Provides fluent interface
+     * @return Solarium_Query_Update_Command_Add Provides fluent interface
      */
     public function addDocument($document)
     {
@@ -80,12 +80,26 @@ class Solarium_Query_Update_Command_Add extends Solarium_Query_Update_Command
     /**
      * Add multiple documents
      *
-     * @param array $documents
-     * @return Solarium_Query_Update_Add Provides fluent interface
+     * @param array|Traversable $documents
+     * @return Solarium_Query_Update_Command_Add Provides fluent interface
      */
     public function addDocuments($documents)
     {
-        $this->_documents = array_merge($this->_documents, $documents);
+        //if we don't have documents so far, accept arrays or Traversable objects as-is
+        if (empty($this->_documents)) {
+            $this->_documents = $documents;
+            return $this;
+        }
+
+        //if something Traversable is passed in, and there are existing documents, convert all to arrays before merging
+        if ($documents instanceof Traversable) {
+            $documents = iterator_to_array($documents);
+        }
+        if ($this->_documents instanceof Traversable) {
+            $this->_documents = array_merge(iterator_to_array($this->_documents), $documents);
+        } else {
+            $this->_documents = array_merge($this->_documents, $documents);
+        }
 
         return $this;
     }
@@ -104,7 +118,7 @@ class Solarium_Query_Update_Command_Add extends Solarium_Query_Update_Command
      * Set overwrite option
      *
      * @param boolean $overwrite
-     * @return Solarium_Query_Update_Add Provides fluent interface
+     * @return Solarium_Query_Update_Command_Add Provides fluent interface
      */
     public function setOverwrite($overwrite)
     {
@@ -125,7 +139,7 @@ class Solarium_Query_Update_Command_Add extends Solarium_Query_Update_Command
      * Get commitWithin option
      *
      * @param boolean $commitWithin
-     * @return Solarium_Query_Update_Add Provides fluent interface
+     * @return Solarium_Query_Update_Command_Add Provides fluent interface
      */
     public function setCommitWithin($commitWithin)
     {

library/Solarium/Query/Update/Command/Commit.php

@@ -71,7 +71,7 @@ class Solarium_Query_Update_Command_Commit extends Solarium_Query_Update_Command
      * Set waitFlush option
      * 
      * @param boolean $waitFlush
-     * @return Solarium_Query_Update_Commit Provides fluent interface
+     * @return Solarium_Query_Update_Command_Commit Provides fluent interface
      */
     public function setWaitFlush($waitFlush)
     {
@@ -92,7 +92,7 @@ class Solarium_Query_Update_Command_Commit extends Solarium_Query_Update_Command
      * Set waitSearcher option
      * 
      * @param boolean $waitSearcher
-     * @return Solarium_Query_Update_Commit Provides fluent interface
+     * @return Solarium_Query_Update_Command_Commit Provides fluent interface
      */
     public function setWaitSearcher($waitSearcher)
     {
@@ -113,7 +113,7 @@ class Solarium_Query_Update_Command_Commit extends Solarium_Query_Update_Command
      * Set expungeDeletes option
      * 
      * @param boolean $expungeDeletes
-     * @return Solarium_Query_Update_Commit Provides fluent interface
+     * @return Solarium_Query_Update_Command_Commit Provides fluent interface
      */
     public function setExpungeDeletes($expungeDeletes)
     {

library/Solarium/Query/Update/Command/Delete.php

@@ -101,7 +101,7 @@ class Solarium_Query_Update_Command_Delete extends Solarium_Query_Update_Command
      * Add a single ID to the delete command
      *
      * @param int|string $id
-     * @return Solarium_Query_Update_Delete Provides fluent interface
+     * @return Solarium_Query_Update_Command_Delete Provides fluent interface
      */
     public function addId($id)
     {
@@ -114,7 +114,7 @@ class Solarium_Query_Update_Command_Delete extends Solarium_Query_Update_Command
      * Add multiple IDs to the delete command
      *
      * @param array $id
-     * @return Solarium_Query_Update_Delete Provides fluent interface
+     * @return Solarium_Query_Update_Command_Delete Provides fluent interface
      */
     public function addIds($ids)
     {
@@ -127,7 +127,7 @@ class Solarium_Query_Update_Command_Delete extends Solarium_Query_Update_Command
      * Add a single query to the delete command
      *
      * @param string $query
-     * @return Solarium_Query_Update_Delete Provides fluent interface
+     * @return Solarium_Query_Update_Command_Delete Provides fluent interface
      */
     public function addQuery($query)
     {
@@ -140,7 +140,7 @@ class Solarium_Query_Update_Command_Delete extends Solarium_Query_Update_Command
      * Add multiple queries to the delete command
      *
      * @param array $queries
-     * @return Solarium_Query_Update_Delete Provides fluent interface
+     * @return Solarium_Query_Update_Command_Delete Provides fluent interface
      */
     public function addQueries($queries)
     {

library/Solarium/Query/Update/Command/Optimize.php

@@ -71,7 +71,7 @@ class Solarium_Query_Update_Command_Optimize
      * Set waitFlush option
      *
      * @param boolean $waitFlush
-     * @return Solarium_Query_Update_Optimize Provides fluent interface
+     * @return Solarium_Query_Update_Command_Optimize Provides fluent interface
      */
     public function setWaitFlush($waitFlush)
     {
@@ -92,7 +92,7 @@ class Solarium_Query_Update_Command_Optimize
      * Set waitSearcher option
      *
      * @param boolean $waitSearcher
-     * @return Solarium_Query_Update_Optimize Provides fluent interface
+     * @return Solarium_Query_Update_Command_Optimize Provides fluent interface
      */
     public function setWaitSearcher($waitSearcher)
     {
@@ -113,7 +113,7 @@ class Solarium_Query_Update_Command_Optimize
      * Set maxSegments option
      * 
      * @param boolean $maxSegments
-     * @return Solarium_Query_Update_Optimize Provides fluent interface
+     * @return Solarium_Query_Update_Command_Optimize Provides fluent interface
      */
     public function setMaxSegments($maxSegments)
     {

tests/Solarium/Document/ReadWriteTest.php

@@ -272,5 +272,30 @@ class Solarium_Document_ReadWriteTest extends PHPUnit_Framework_TestCase
             $this->_doc->getFields()
         );
     }
+
+    public function testClearFields()
+    {
+        $this->_doc->clear();
+
+        $expectedFields = array();
+
+        $this->assertEquals(
+            $expectedFields,
+            $this->_doc->getFields()
+        );
+    }
+
+    public function testClearFieldsBoostRemoval()
+    {
+        $this->_doc->setFieldBoost('name', 3.2);
+        $this->_doc->clear();
+
+        $expectedFields = array();
+
+        $this->assertEquals(
+            null,
+            $this->_doc->getFieldBoost('name')
+        );
+    }
     
 }

tests/Solarium/Query/Update/Command/AddTest.php

@@ -67,6 +67,74 @@ class Solarium_Query_Update_Command_AddTest extends PHPUnit_Framework_TestCase
         );
     }
 
+    public function testAddDocumentsIteration()
+    {
+        $doc1 = new Solarium_Document_ReadWrite(array('id' => 1));
+        $doc2 = new Solarium_Document_ReadWrite(array('id' => 2));
+
+        $it = new ArrayIterator(array($doc1, $doc2));
+
+        $this->_command->addDocuments($it);
+
+        if ($this->_command->getDocuments() instanceof Traversable) {
+            $command_documents = iterator_to_array($this->_command->getDocuments());
+        } else {
+            $command_documents = $this->_command->getDocuments();
+        }
+
+        $this->assertEquals(
+            array($doc1, $doc2),
+            $command_documents,
+            'checking first two documents are added correctly'
+        );
+
+        $doc3 = new Solarium_Document_ReadWrite(array('id' => 3));
+        $doc4 = new Solarium_Document_ReadWrite(array('id' => 4));
+        $doc5 = new Solarium_Document_ReadWrite(array('id' => 5));
+
+        $it2 = new ArrayIterator(array($doc3, $doc4, $doc5));
+
+        $this->_command->addDocuments($it2);
+
+        if ($this->_command->getDocuments() instanceof Traversable) {
+            $command_documents = iterator_to_array($this->_command->getDocuments());
+        } else {
+            $command_documents = $this->_command->getDocuments();
+        }
+
+        $this->assertEquals(
+            array($doc1, $doc2, $doc3, $doc4, $doc5),
+            $command_documents,
+            'checking second three documents are added correctly to first two'
+        );
+    }
+
+    /**
+     * @depends testAddDocumentsIteration
+     */
+    public function testAddDocumentToIteration()
+    {
+        $doc1 = new Solarium_Document_ReadWrite(array('id' => 1));
+        $doc2 = new Solarium_Document_ReadWrite(array('id' => 2));
+
+        $this->_command->addDocuments(new ArrayIterator(array($doc1, $doc2)));
+
+        $doc3 = new Solarium_Document_ReadWrite(array('id' => 3));
+
+        $this->_command->addDocument($doc3);
+
+        if ($this->_command->getDocuments() instanceof Traversable) {
+            $command_documents = iterator_to_array($this->_command->getDocuments());
+        } else {
+            $command_documents = $this->_command->getDocuments();
+        }
+
+        $this->assertEquals(
+            array($doc1, $doc2, $doc3),
+            $command_documents
+        );
+    }
+
     public function testGetAndSetOverwrite()
     {
         $this->_command->setOverwrite(false);