Accept an options array at Type::updateDocument()

[rmruano]

Allows setting options when updating Documents with Scripts:

$myType->updateDocument($myScript, array("retry_on_conflict"=>3, "refresh"=>true);

It's even being used at TypeTest::testUpdateDocument():

public function testUpdateDocument()
{
    ...
    ...
    ...
    $document = new Document();
    $script = new Script(
        "ctx._source.name = name; ctx._source.counter += count",
        array(
            'name' => $newName,
            'count' => 2,
        ),
        null,
        $id
    );
    $script->setUpsert($document);

    $type->updateDocument($script, array('refresh' => true));
    $updatedDoc = $type->getDocument($id)->getData();
    $this->assertEquals($newName, $updatedDoc['name'], "Name was not updated");
    $this->assertEquals(3, $updatedDoc['counter'], "Counter was not incremented");
}

[ruflin]

Makes sense. Can you update the changes.txt file with this change?

Strange that it was already used in the tests. Do have an idea how we could write a specific test for this options?

[rmruano]

Done!

Updating an existing doc with a non-matching version number parameter will rise a VersionConflictEngineException and won't update the document. Perhaps something like this?:

public function testUpdateDocumentWithParameter()
{
    $client = $this->_getClient();
    $index = $client->getIndex('elastica_test');
    $type = $index->getType('update_type');
    $id = 1;
    $type->addDocument(new Document($id, array('name' => 'bruce wayne batman', 'counter' => 1)));
    $newName = 'batman';

    $document = new Document();
    $script = new Script(
        "ctx._source.name = name; ctx._source.counter += count",
        array(
            'name' => $newName,
            'count' => 2,
        ),
        null,
        $id
    );
    $script->setUpsert($document);

    try {
        $type->updateDocument($script, array('version' => 999)); // Wrong version number to make the update fail
    } catch (ResponseException $e) {
        $this->assertContains('VersionConflictEngineException', $e->getMessage());
    }
    $updatedDoc = $type->getDocument($id)->getData();
    $this->assertNotEquals($newName, $updatedDoc['name'], "Name was updated");
    $this->assertNotEquals(3, $updatedDoc['counter'], "Counter was incremented");
}

[ruflin]

Looks good. Can you add this to the pull request?

I made a release yesterday, so make sure to merge in the master branch and please add the pull request id to the changes.txt

[rmruano]

Done, I've added the testUpdateDocumentWithParameter() test, could you take a look?.

[ruflin]

Please update the date here and move it on top of the release. Otherwise it will be missing in the next release notes.

[ruflin]

Looks good. Almost ready to merge. See my small comment above.

[ruflin]

Merged.