Merge branch 'master' into php7-compatibility

Author: ruflin

.editorconfig

@@ -19,3 +19,7 @@ indent_style = space
 [Vagrantfile]
 indent_size = 2
 indent_style = space
+
+[Makefile]
+indent_size = 4
+indent_style = tab

.travis.yml

@@ -20,6 +20,9 @@ env:
     - ES_COMPOSER_NODEV=no
     - ES_COMPOSER_NODEV=yes
 
+before_insll:
+  - pip install codecov
+
 install:
   - /bin/bash ansible/provision.sh
 
@@ -37,3 +40,6 @@ after_script:
   - cat build/logs/phpunit-tap.log
   - sudo composer require satooshi/php-coveralls --no-ansi --no-progress --no-interaction
   - php vendor/bin/coveralls -v
+
+after_success:
+  - codecov

changes.txt renamed to CHANGELOG.md

@@ -15,7 +15,7 @@ Contributing
 ------------
 Help is very welcomed, but code contributions must be done in respect of [PSR-2](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-2-coding-style-guide.md). More details on how to contribute and guidelines for [pull requests](http://elastica.io/contribute/pull-request.html) can be found [here](http://elastica.io/contribute/).
 
-See [Coding guidelines](http://elastica.io/contribute/coding-guidelines.html) for tips on how to do so. All changes which are made to the project are added to the [changes.txt](https://github.com/ruflin/Elastica/blob/master/changes.txt).
+See [Coding guidelines](http://elastica.io/contribute/coding-guidelines.html) for tips on how to do so. All changes which are made to the project are added to the [CHANGELOG.md](https://github.com/ruflin/Elastica/blob/master/CHANGELOG.md).
 
 
 Dependencies

README.markdown

@@ -16,9 +16,7 @@
         "psr/log": "~1.0"
     },
     "require-dev": {
-        "munkie/elasticsearch-thrift-php": "1.4.*",
-        "phpunit/phpunit": "4.1.*",
-        "fabpot/php-cs-fixer": "~1.4"
+        "munkie/elasticsearch-thrift-php": "1.4.*"
     },
     "suggest": {
         "munkie/elasticsearch-thrift-php": "Allow using thrift transport",
@@ -34,7 +32,7 @@
     },
     "extra": {
         "branch-alias": {
-            "dev-master": "1.4.x-dev"
+            "dev-master": "2.0.x-dev"
         }
     }
 }

composer.json

@@ -0,0 +1,88 @@
+<?php
+
+namespace Elastica\Aggregation;
+
+/**
+ * Class AbstractTermsAggergation
+ * @package Elastica\Aggregation
+ */
+abstract class AbstractTermsAggregation extends AbstractSimpleAggregation
+{
+
+    /**
+     * Set the minimum number of documents in which a term must appear in order to be returned in a bucket
+     * @param  int   $count
+     * @return $this
+     */
+    public function setMinimumDocumentCount($count)
+    {
+        return $this->setParam("min_doc_count", $count);
+    }
+
+    /**
+     * Filter documents to include based on a regular expression
+     * @param  string $pattern a regular expression
+     * @param  string $flags   Java Pattern flags
+     * @return $this
+     */
+    public function setInclude($pattern, $flags = null)
+    {
+        if (is_null($flags)) {
+            return $this->setParam("include", $pattern);
+        }
+
+        return $this->setParam("include", array(
+            "pattern" => $pattern,
+            "flags" => $flags,
+        ));
+    }
+
+    /**
+     * Filter documents to exclude based on a regular expression
+     * @param  string $pattern a regular expression
+     * @param  string $flags   Java Pattern flags
+     * @return $this
+     */
+    public function setExclude($pattern, $flags = null)
+    {
+        if (is_null($flags)) {
+            return $this->setParam("exclude", $pattern);
+        }
+
+        return $this->setParam("exclude", array(
+            "pattern" => $pattern,
+            "flags" => $flags,
+        ));
+    }
+
+    /**
+     * Sets the amount of terms to be returned.
+     * @param  int   $size The amount of terms to be returned.
+     * @return $this
+     */
+    public function setSize($size)
+    {
+        return $this->setParam('size', $size);
+    }
+
+    /**
+     * Sets how many terms the coordinating node will request from each shard.
+     * @param  int   $shard_size The amount of terms to be returned.
+     * @return $this
+     */
+    public function setShardSize($shard_size)
+    {
+        return $this->setParam('shard_size', $shard_size);
+    }
+
+    /**
+     * Instruct Elasticsearch to use direct field data or ordinals of the field values to execute this aggregation.
+     * The execution hint will be ignored if it is not applicable.
+     * @param  string $hint map or ordinals
+     * @return $this
+     */
+    public function setExecutionHint($hint)
+    {
+        return $this->setParam("execution_hint", $hint);
+    }
+}

lib/Elastica/Aggregation/AbstractTermsAggregation.php

@@ -0,0 +1,28 @@
+<?php
+
+namespace Elastica\Aggregation;
+
+use Elastica\Filter\AbstractFilter;
+
+/**
+ * Class SignificantTerms
+ * @package Elastica\Aggregation
+ * @link http://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-significantterms-aggregation.html
+ */
+class SignificantTerms extends AbstractTermsAggregation
+{
+
+    /**
+     * The default source of statistical information for background term frequencies is the entire index and this scope can
+     * be narrowed through the use of a background_filter to focus in on significant terms within a narrower context
+     * @param AbstractFilter $filter
+     * @return $this
+     * @see https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-significantterms-aggregation.html#_custom_background_context
+     *
+     */
+    public function setBackgroundFilter(AbstractFilter $filter)
+    {
+        return $this->setParam("background_filter", $filter->toArray());
+    }
+
+}

lib/Elastica/Aggregation/SignificantTerms.php

@@ -7,7 +7,7 @@
  * @package Elastica\Aggregation
  * @link http://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-terms-aggregation.html
  */
-class Terms extends AbstractSimpleAggregation
+class Terms extends AbstractTermsAggregation
 {
     /**
      * Set the bucket sort order
@@ -20,80 +20,4 @@ public function setOrder($order, $direction)
         return $this->setParam("order", array($order => $direction));
     }
 
-    /**
-     * Set the minimum number of documents in which a term must appear in order to be returned in a bucket
-     * @param  int   $count
-     * @return $this
-     */
-    public function setMinimumDocumentCount($count)
-    {
-        return $this->setParam("min_doc_count", $count);
-    }
-
-    /**
-     * Filter documents to include based on a regular expression
-     * @param  string $pattern a regular expression
-     * @param  string $flags   Java Pattern flags
-     * @return $this
-     */
-    public function setInclude($pattern, $flags = null)
-    {
-        if (is_null($flags)) {
-            return $this->setParam("include", $pattern);
-        }
-
-        return $this->setParam("include", array(
-            "pattern" => $pattern,
-            "flags" => $flags,
-        ));
-    }
-
-    /**
-     * Filter documents to exclude based on a regular expression
-     * @param  string $pattern a regular expression
-     * @param  string $flags   Java Pattern flags
-     * @return $this
-     */
-    public function setExclude($pattern, $flags = null)
-    {
-        if (is_null($flags)) {
-            return $this->setParam("exclude", $pattern);
-        }
-
-        return $this->setParam("exclude", array(
-            "pattern" => $pattern,
-            "flags" => $flags,
-        ));
-    }
-
-    /**
-     * Sets the amount of terms to be returned.
-     * @param  int   $size The amount of terms to be returned.
-     * @return $this
-     */
-    public function setSize($size)
-    {
-        return $this->setParam('size', $size);
-    }
-
-    /**
-     * Sets how many terms the coordinating node will request from each shard.
-     * @param  int   $shard_size The amount of terms to be returned.
-     * @return $this
-     */
-    public function setShardSize($shard_size)
-    {
-        return $this->setParam('shard_size', $shard_size);
-    }
-
-    /**
-     * Instruct Elasticsearch to use direct field data or ordinals of the field values to execute this aggregation.
-     * The execution hint will be ignored if it is not applicable.
-     * @param  string $hint map or ordinals
-     * @return $this
-     */
-    public function setExecutionHint($hint)
-    {
-        return $this->setParam("execution_hint", $hint);
-    }
 }

lib/Elastica/Aggregation/Terms.php

@@ -37,6 +37,12 @@ class Connection extends Param
      */
     const TIMEOUT = 300;
 
+    /**
+     * Number of seconds after a connection timeout occurs for every request during the connection phase.
+     * @see Connection::setConnectTimeout();
+     */
+    const CONNECT_TIMEOUT = 0;
+
     /**
      * Creates a new connection object. A connection is enabled by default
      *
@@ -159,6 +165,29 @@ public function getTimeout()
         return (int) $this->hasParam('timeout') ? $this->getParam('timeout') : self::TIMEOUT;
     }
 
+    /**
+     * Number of seconds after a connection timeout occurs for every request during the connection phase.
+     * Use a small value if you need a fast fail in case of dead, unresponsive or unreachable servers (~5 sec).
+     *
+     * Set to zero to switch to the default built-in connection timeout (300 seconds in curl).
+     * @see http://curl.haxx.se/libcurl/c/CURLOPT_CONNECTTIMEOUT.html
+     *
+     * @param  int   $timeout Connect timeout in seconds
+     * @return $this
+     */
+    public function setConnectTimeout($timeout)
+    {
+        return $this->setParam('connectTimeout', $timeout);
+    }
+
+    /**
+     * @return int Connection timeout in seconds
+     */
+    public function getConnectTimeout()
+    {
+        return (int) $this->hasParam('connectTimeout') ? $this->getParam('connectTimeout') : self::CONNECT_TIMEOUT;
+    }
+
     /**
      * Enables a connection
      *

lib/Elastica/Connection.php

@@ -401,12 +401,23 @@ public function setSuggest(Suggest $suggest)
     /**
      * Add a Rescore
      *
-     * @param  \Elastica\Rescore\AbstractRescore $rescore suggestion object
+     * @param  mixed $rescore suggestion object
      * @return $this
      */
     public function setRescore($rescore)
     {
-        return $this->setParam('rescore', $rescore->toArray());
+        if (is_array($rescore)) {
+            $buffer = array();
+
+            foreach($rescore as $rescoreQuery) {
+                $buffer []= $rescoreQuery->toArray();
+            }
+        }
+        else {
+            $buffer = $rescore->toArray();
+        }
+
+        return $this->setParam('rescore', $buffer);
     }
 
     /**

lib/Elastica/Query.php

@@ -25,6 +25,7 @@
 use Elastica\Aggregation\Stats;
 use Elastica\Aggregation\Sum;
 use Elastica\Aggregation\Terms;
+use Elastica\Aggregation\SignificantTerms;
 use Elastica\Aggregation\TopHits;
 use Elastica\Aggregation\ValueCount;
 use Elastica\Exception\NotImplementedException;
@@ -318,10 +319,11 @@ public function terms($name)
      *
      * @link http://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-significantterms-aggregation.html
      * @param string $name
+     * @return SignificantTerms
      */
     public function significant_terms($name)
     {
-        throw new NotImplementedException();
+        return new SignificantTerms($name);
     }
 
     /**

lib/Elastica/QueryBuilder/DSL/Aggregation.php

@@ -72,6 +72,12 @@ public function exec(Request $request, array $params)
         curl_setopt($conn, CURLOPT_TIMEOUT, $connection->getTimeout());
         curl_setopt($conn, CURLOPT_FORBID_REUSE, 0);
 
+        /* @see Connection::setConnectTimeout() */
+        $connectTimeout = $connection->getConnectTimeout();
+        if ($connectTimeout>0) {
+            curl_setopt($conn, CURLOPT_CONNECTTIMEOUT, $connectTimeout);
+        }
+
         $proxy = $connection->getProxy();
 
         // See: https://github.com/facebook/hhvm/issues/4875