Fix php 7.2 compatibility for Elasticsearch 2 (#860)

* fix php 7.2 compatibility for ongr 1.x

* ugprade phpunit for compatibility of mocks

* fixed phpunit deprecations

* fix exception test

* Revert "fixed phpunit deprecations"

This reverts commit c96ba36.

* fix phpunit compatibility for php 5.5

Author: alexander-schranz

.travis.yml

@@ -4,6 +4,8 @@ php:
   - 5.5
   - 5.6
   - 7.0
+  - 7.1
+  - 7.2
   - hhvm
 env:
   global:

Annotation/Object.php

@@ -11,12 +11,7 @@
 
 namespace ONGR\ElasticsearchBundle\Annotation;
 
-/**
- * Annotation to mark a class as an object during the parsing process.
- *
- * @Annotation
- * @Target("CLASS")
- */
-final class Object
-{
+if (version_compare(PHP_VERSION, '7.2.0') < 0) {
+    class_alias('ONGR\ElasticsearchBundle\Annotation\ObjectType', 'ONGR\ElasticsearchBundle\Annotation\Object', false);
+    class_exists('ONGR\ElasticsearchBundle\Annotation\ObjectType');
 }

Annotation/ObjectType.php

@@ -0,0 +1,22 @@
+<?php
+
+/*
+ * This file is part of the ONGR package.
+ *
+ * (c) NFQ Technologies UAB <info@nfq.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace ONGR\ElasticsearchBundle\Annotation;
+
+/**
+ * Annotation to mark a class as an object during the parsing process.
+ *
+ * @Annotation
+ * @Target("CLASS")
+ */
+final class ObjectType
+{
+}

Mapping/DocumentParser.php

@@ -29,7 +29,7 @@ class DocumentParser
     const PROPERTY_ANNOTATION = 'ONGR\ElasticsearchBundle\Annotation\Property';
     const EMBEDDED_ANNOTATION = 'ONGR\ElasticsearchBundle\Annotation\Embedded';
     const DOCUMENT_ANNOTATION = 'ONGR\ElasticsearchBundle\Annotation\Document';
-    const OBJECT_ANNOTATION = 'ONGR\ElasticsearchBundle\Annotation\Object';
+    const OBJECT_ANNOTATION = 'ONGR\ElasticsearchBundle\Annotation\ObjectType';
     const NESTED_ANNOTATION = 'ONGR\ElasticsearchBundle\Annotation\Nested';
 
     // Meta fields
@@ -354,7 +354,7 @@ private function registerAnnotations()
             'Document',
             'Property',
             'Embedded',
-            'Object',
+            'ObjectType',
             'Nested',
             'Id',
             'ParentDocument',
@@ -366,6 +366,10 @@ private function registerAnnotations()
         foreach ($annotations as $annotation) {
             AnnotationRegistry::registerFile(__DIR__ . "/../Annotation/{$annotation}.php");
         }
+
+        if (version_compare(PHP_VERSION, '7.2.0') < 0) {
+            AnnotationRegistry::registerFile(__DIR__ . "/../Annotation/Object.php");
+        }
     }
 
     /**
@@ -491,7 +495,7 @@ private function getObjectMapping($className)
             default:
                 throw new \LogicException(
                     sprintf(
-                        '%s should have @Object or @Nested annotation to be used as embeddable object.',
+                        '%s should have @ObjectType or @Nested annotation to be used as embeddable object.',
                         $className
                     )
                 );

Resources/doc/mapping.md

@@ -157,7 +157,7 @@ namespace AppBundle\Document;
 use ONGR\ElasticsearchBundle\Annotation as ES;
 
 /**
- * @ES\Object
+ * @ES\ObjectType
  */
 class ContentMetaObject
 {

Tests/Functional/Mapping/DocumentParserTest.php

@@ -22,7 +22,7 @@ class DocumentParserTest extends WebTestCase
      * Test if exception is thrown when Document is used as embeddable.
      *
      * @expectedException \LogicException
-     * @expectedExceptionMessage should have @Object or @Nested annotation
+     * @expectedExceptionMessage should have @ObjectType or @Nested annotation
      */
     public function testGetDocumentTypeException()
     {

Tests/Unit/DependencyInjection/Compiler/MappingPassTest.php

@@ -140,6 +140,10 @@ function ($parameter) use ($metadataCollectorMock) {
      */
     public function testProcessWithSeveralManagers(array $connections, array $managers)
     {
+        if (version_compare(PHP_VERSION, '5.6.0') > 0) {
+            $this->markTestSkipped('Skipped because of a bug in phpunit 4 mock which is needed for php 5.5 tests');
+        }
+
         $compilerPass = new MappingPass();
         $compilerPass->process($this->getContainerMock($connections, $managers));
     }

Tests/app/fixture/Acme/BarBundle/Document/CategoryObject.php

@@ -16,7 +16,7 @@
 /**
  * Category document for testing.
  *
- * @ES\Object
+ * @ES\ObjectType
  */
 class CategoryObject
 {

Tests/app/fixture/Acme/BarBundle/Document/Person/Address.php

@@ -16,7 +16,7 @@
 /**
  * Category document for testing.
  *
- * @ES\Object
+ * @ES\ObjectType
  */
 class Address
 {

composer.json

@@ -22,7 +22,7 @@
     },
     "require-dev": {
         "mikey179/vfsStream": "~1.4",
-        "phpunit/phpunit": "~4.4",
+        "phpunit/phpunit": "~4.8 || ~5.6",
         "squizlabs/php_codesniffer": "~2.0",
         "satooshi/php-coveralls": "~1.0"
     },