Added Rescore Query

.travis.yml

@@ -17,6 +17,7 @@ env:
     - ES_TRANSPORT_THRIFT_VER=2.0.0.RC2
     - ES_GEOCLUSTER_FACET_VER=0.0.10
     - ES_WAIT_ON_MAPPING_CHANGE=true
+    - MEMCACHE_VER=3.0.8
   matrix:
     - ES_REQUIRE=dev
     - ES_REQUIRE=no-dev

changes.txt

@@ -1,6 +1,17 @@
 CHANGES
+
+2014-03-8
+- Added Query\Rescore
+
+2014-03-08
+- Release v1.0.1.1
+- Enable goecluster-facet again as now compatible with elasticsearch 1.0 on travis
+- Run elasticsearch in the background to not have log output in travis build
+- Set memache php version as environment variable
+- Update to memcache 3.0.8 for travis
+
 2014-03-07
-- Add snapshot / restore functionality (Elastica\Snapshot) #566
+- Issue #566: Add snapshot / restore functionality (Elastica\Snapshot) 
 
 2014-03-04
 - Add PHP 5.6 to travis test environment

lib/Elastica/Query.php

@@ -377,6 +377,16 @@ public function setSuggest(Suggest $suggest)
         $this->addParam(NULL, $suggest->toArray());
         $this->_suggest = 1;
     }
+
+    /**
+     * Add a Rescore
+     *
+     * @param  \Elastica\Rescore\AbstractRescore $suggest suggestion object
+     */
+    public function setRescore($rescore)
+    {
+        $this->setParam('rescore', $rescore->toArray());
+    }
 }
 
 

lib/Elastica/Rescore/AbstractRescore.php

@@ -0,0 +1,36 @@
+<?php
+
+namespace Elastica\Rescore;
+use Elastica\Param;
+
+/**
+ * Abstract rescore object. Should be extended by all rescorers.
+ *
+ * @category Xodoa
+ * @package Elastica
+ * @author Jason Hu <[email protected]>
+ * @link http://www.elasticsearch.org/guide/reference/api/search/rescore/
+ */
+abstract class AbstractRescore extends Param
+{
+	/**
+	 * Overriden to return rescore as name
+     *
+     * @return string name
+     */
+    protected function _getBaseName()
+    {
+        return 'rescore';
+    }
+
+    /**
+     * Sets window_size
+     *
+     * @param int $size
+     * @return \Elastica\Rescore
+     */
+    public function setWindowSize($size)
+    {
+        return $this->setParam('window_size', $size);
+    }
+}

lib/Elastica/Rescore/Query.php

@@ -0,0 +1,90 @@
+<?php
+
+namespace Elastica\Rescore;
+
+use Elastica\Query as BaseQuery;
+
+/**
+ * Query Rescore
+ *
+ * @category Xodoa
+ * @package Elastica
+ * @author Jason Hu <[email protected]>
+ * @link http://www.elasticsearch.org/guide/reference/api/search/rescore/
+ */
+class Query extends AbstractRescore
+{
+    /**
+     * Constructor
+     *
+     * @param string|\Elastica\Query\AbstractQuery $rescoreQuery
+     * @param string|\Elastica\Query\AbstractQuery $query
+     */
+    public function __construct($query = null)
+    {
+        $this->setParam('query', array());
+        $this->setRescoreQuery($query);
+    }
+
+    /**
+     * Override default implementation so params are in the format
+     * expected by elasticsearch
+     *
+     * @return array Rescore array
+     */
+    public function toArray()
+    {
+        $data = $this->getParams();
+
+        if (!empty($this->_rawParams)) {
+            $data = array_merge($data, $this->_rawParams);
+        }
+
+        return $data;
+    }
+
+    /**
+     * Sets rescoreQuery object
+     *
+     * @param  string|\Elastica\Query|\Elastica\Query\AbstractQuery $query
+     * @return \Elastica\Query\Rescore
+     */
+    public function setRescoreQuery($rescoreQuery)
+    {
+        $query = BaseQuery::create($rescoreQuery);
+        $data = $query->toArray();
+
+        $query = $this->getParam('query');
+        $query['rescore_query'] = $data['query'];
+
+        return $this->setParam('query', $query);
+    }
+
+    /**
+     * Sets query_weight
+     *
+     * @param float $weight
+     * @return \Elastica\Query\Rescore
+     */
+    public function setQueryWeight($weight)
+    {
+        $query = $this->getParam('query');
+        $query['query_weight'] = $weight;
+
+        return $this->setParam('query', $query);
+    }
+
+    /**
+     * Sets rescore_query_weight
+     *
+     * @param float $size
+     * @return \Elastica\Query\Rescore
+     */
+    public function setRescoreQueryWeight($weight)
+    {
+        $query = $this->getParam('query');
+        $query['rescore_query_weight'] = $weight;
+
+        return $this->setParam('query', $query);
+    }
+}

test/bin/install_php_memcache.sh

@@ -1,7 +1,8 @@
 #!/bin/bash
 
 # Build and install PHP Memcache extension
-wget http://pecl.php.net/get/memcache-2.2.7.tgz
-tar -xzf memcache-2.2.7.tgz
-sh -c "cd memcache-2.2.7 && phpize && ./configure --enable-memcache && make && sudo make install"
+wget http://pecl.php.net/get/memcache-${MEMCACHE_VER}.tgz
+tar -xzf memcache-${MEMCACHE_VER}.tgz
+sh -c "cd memcache-${MEMCACHE_VER} && phpize && ./configure --enable-memcache && make && sudo make install"
 echo "extension=memcache.so" >> `php --ini | grep "Loaded Configuration" | sed -e "s|.*:\s*||"`
+

test/bin/run_elasticsearch.sh

@@ -10,8 +10,7 @@ tar -xzf elasticsearch-${ES_VER}.tar.gz
 
 elasticsearch-${ES_VER}/bin/plugin -install elasticsearch/elasticsearch-mapper-attachments/${ES_MAPPER_ATTACHMENTS_VER}
 elasticsearch-${ES_VER}/bin/plugin -install elasticsearch/elasticsearch-transport-thrift/${ES_TRANSPORT_THRIFT_VER}
-# geocluster-facet has not been updated for ES 1.0.0.RC1
-#elasticsearch-${ES_VER}/bin/plugin -install geocluster-facet --url https://github.com/zenobase/geocluster-facet/releases/download/${ES_GEOCLUSTER_FACET_VER}/geocluster-facet-${ES_GEOCLUSTER_FACET_VER}.jar
+elasticsearch-${ES_VER}/bin/plugin -install geocluster-facet --url https://github.com/zenobase/geocluster-facet/releases/download/${ES_GEOCLUSTER_FACET_VER}/geocluster-facet-${ES_GEOCLUSTER_FACET_VER}.jar
 
 export JAVA_OPTS="-server"
 
@@ -40,7 +39,7 @@ do
 
     echo "Starting server on http port: $http_port"
 
-    elasticsearch-${ES_VER}/bin/elasticsearch -Des.config=$config_yml &
+    elasticsearch-${ES_VER}/bin/elasticsearch -d -Des.config=$config_yml &
 
     while ! check_port_http_code $http_port 200; do
         echo -n "."

test/lib/Elastica/Test/Query/RescoreTest.php

@@ -0,0 +1,165 @@
+<?php
+
+namespace Elastica\Test\Query;
+
+use Elastica\Rescore\Query as QueryRescore;
+use Elastica\Query\Term;
+use Elastica\Query\Match;
+use Elastica\Query;
+use Elastica\Test\Base as BaseTest;
+
+class RescoreTest extends BaseTest
+{
+    /**
+     * @var Index
+     */
+    protected $_index;
+
+    protected function setUp()
+    {
+        parent::setUp();
+        $this->_index = $this->_createIndex("rescore_test");
+        $this->_index->refresh();
+    }
+
+    public function testToArray()
+    {
+        $query = new Query();
+        $mainQuery = new Match();
+        $mainQuery = $mainQuery->setFieldQuery('test1', 'foo');
+        $secQuery = new Term();
+        $secQuery = $secQuery->setTerm('test2', 'bar', 2);
+        $queryRescore = new QueryRescore($secQuery);
+        $query->setQuery($mainQuery);
+        $query->setRescore($queryRescore);
+        $data = $query->toArray();
+
+        $expected = array(
+            'query' => array(
+                'match' => array(
+                    'test1' => array(
+                        'query' => 'foo',
+                    ),
+                ),
+            ),
+            'rescore' => array(
+                'query' => array(
+                    'rescore_query' => array(
+                        'term' => array(
+                            'test2' => array(
+                                'value' => 'bar',
+                                'boost' => 2,
+                            ),
+                        ),
+                    ),
+                ),
+            ),
+        );
+
+        $this->assertEquals($expected, $data);
+    }
+
+    public function testSetSize()
+    {
+        $query = new Query();
+        $mainQuery = new Match();
+        $mainQuery = $mainQuery->setFieldQuery('test1', 'foo');
+        $secQuery = new Term();
+        $secQuery = $secQuery->setTerm('test2', 'bar', 2);
+        $queryRescore = new QueryRescore($secQuery);
+        $queryRescore->setWindowSize(50);
+        $query->setQuery($mainQuery);
+        $query->setRescore($queryRescore);
+        $data = $query->toArray();
+
+        $expected = array(
+            'query' => array(
+                'match' => array(
+                    'test1' => array(
+                        'query' => 'foo',
+                    ),
+                ),
+            ),
+            'rescore' => array(
+                'window_size' => 50,
+                'query' => array(
+                    'rescore_query' => array(
+                        'term' => array(
+                            'test2' => array(
+                                'value' => 'bar',
+                                'boost' => 2,
+                            ),
+                        ),
+                    ),
+                ),
+            ),
+        );
+
+        $this->assertEquals($expected, $data);
+    }
+
+    public function testSetWeights()
+    {
+        $query = new Query();
+        $mainQuery = new Match();
+        $mainQuery = $mainQuery->setFieldQuery('test1', 'foo');
+        $secQuery = new Term();
+        $secQuery = $secQuery->setTerm('test2', 'bar', 2);
+        $queryRescore = new QueryRescore($secQuery);
+        $queryRescore->setWindowSize(50);
+        $queryRescore->setQueryWeight(.7);
+        $queryRescore->setRescoreQueryWeight(1.2);
+        $query->setQuery($mainQuery);
+        $query->setRescore($queryRescore);
+        $data = $query->toArray();
+
+        $expected = array(
+            'query' => array(
+                'match' => array(
+                    'test1' => array(
+                        'query' => 'foo',
+                    ),
+                ),
+            ),
+            'rescore' => array(
+                'window_size' => 50,
+                'query' => array(
+                    'rescore_query' => array(
+                        'term' => array(
+                            'test2' => array(
+                                'value' => 'bar',
+                                'boost' => 2,
+                            ),
+                        ),
+                    ),
+                    'query_weight' => 0.7,
+                    'rescore_query_weight' => 1.2
+                ),
+            ),
+        );
+
+        $this->assertEquals($expected, $data);
+    }
+
+    public function testQuery()
+    {
+        $query = new Query();
+        $mainQuery = new Match();
+        $mainQuery = $mainQuery->setFieldQuery('test1', 'foo');
+        $secQuery = new Term();
+        $secQuery = $secQuery->setTerm('test2', 'bar', 2);
+        $queryRescore = new QueryRescore($secQuery);
+        $queryRescore->setWindowSize(50);
+        $queryRescore->setQueryWeight(.7);
+        $queryRescore->setRescoreQueryWeight(1.2);
+        $query->setQuery($mainQuery);
+        $query->setRescore($queryRescore);
+        $data = $query->toArray();
+
+        $results = $this->_index->search($query);
+        $response = $results->getResponse();
+
+        $this->assertEquals(true, $response->isOk());
+        $this->assertEquals(0, $results->getTotalHits());
+    }
+}