Merge pull request #147 from martiis/issue-75

Annotations are now allowed to put camel or underscore case properties

Author: saimaz

Annotation/AbstractProperty.php

@@ -0,0 +1,42 @@
+<?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;
+
+use ONGR\ElasticsearchBundle\Mapping\AbstractAnnotationCamelizer;
+use ONGR\ElasticsearchBundle\Mapping\DumperInterface;
+
+/**
+ * Makes sure thats annotations are well formated.
+ */
+abstract class AbstractProperty extends AbstractAnnotationCamelizer implements DumperInterface
+{
+    /**
+     * {@inheritdoc}
+     */
+    public function dump(array $exclude = [])
+    {
+        $array = array_diff_key(
+            array_filter(get_object_vars($this)),
+            array_flip(array_merge(['name', 'objectName', 'multiple'], $exclude))
+        );
+
+        return array_combine(
+            array_map(
+                function ($key) {
+                    return $this->underscore($key);
+                },
+                array_keys($array)
+            ),
+            array_values($array)
+        );
+    }
+}

Annotation/Inherit.php

@@ -31,7 +31,7 @@ final class Inherit
      *
      * @throws \InvalidArgumentException
      */
-    public function __constructor(array $values)
+    public function __construct(array $values)
     {
         if (is_string($values['value'])) {
             $this->value = [$values['value']];

Annotation/MultiField.php

@@ -19,7 +19,7 @@
  * @Annotation
  * @Target("ANNOTATION")
  */
-final class MultiField
+final class MultiField extends AbstractProperty
 {
     /**
      * @var string
@@ -48,23 +48,10 @@ final class MultiField
     /**
      * @var string
      */
-    public $index_analyzer;
+    public $indexAnalyzer;
 
     /**
      * @var string
      */
-    public $search_analyzer;
-
-    /**
-     * Filters object values.
-     *
-     * @return array
-     */
-    public function filter()
-    {
-        return array_diff_key(
-            array_filter(get_object_vars($this)),
-            array_flip(['name'])
-        );
-    }
+    public $searchAnalyzer;
 }

Annotation/Property.php

@@ -19,7 +19,7 @@
  * @Annotation
  * @Target("PROPERTY")
  */
-final class Property
+final class Property extends AbstractProperty
 {
     /**
      * @var string
@@ -48,12 +48,12 @@ final class Property
     /**
      * @var string
      */
-    public $index_analyzer;
+    public $indexAnalyzer;
 
     /**
      * @var string
      */
-    public $search_analyzer;
+    public $searchAnalyzer;
 
     /**
      * @var float
@@ -84,17 +84,4 @@ final class Property
      * @var bool OneToOne or OneToMany.
      */
     public $multiple;
-
-    /**
-     * Filters object null values and name.
-     *
-     * @return array
-     */
-    public function filter()
-    {
-        return array_diff_key(
-            array_filter(get_object_vars($this)),
-            array_flip(['name', 'objectName', 'multiple'])
-        );
-    }
 }

Annotation/Skip.php

@@ -31,7 +31,7 @@ final class Skip
      *
      * @throws \InvalidArgumentException
      */
-    public function __constructor(array $values)
+    public function __construct(array $values)
     {
         if (is_string($values['value'])) {
             $this->value = [$values['value']];

Annotation/Suggester/AbstractSuggesterProperty.php

@@ -12,11 +12,12 @@
 namespace ONGR\ElasticsearchBundle\Annotation\Suggester;
 
 use Doctrine\Common\Annotations\Annotation\Required;
+use ONGR\ElasticsearchBundle\Annotation\AbstractProperty;
 
 /**
  * Abstract class for various suggester annotations.
  */
-abstract class AbstractSuggesterProperty
+abstract class AbstractSuggesterProperty extends AbstractProperty
 {
     /**
      * @var string
@@ -40,45 +41,30 @@ abstract class AbstractSuggesterProperty
     /**
      * @var string
      */
-    public $index_analyzer;
+    public $indexAnalyzer;
 
     /**
      * @var string
      */
-    public $search_analyzer;
+    public $searchAnalyzer;
 
     /**
      * @var int
      */
-    public $preserve_separators;
+    public $preserveSeparators;
 
     /**
      * @var bool
      */
-    public $preserve_position_increments;
+    public $preservePositionIncrements;
 
     /**
      * @var int
      */
-    public $max_input_length;
+    public $maxInputLength;
 
     /**
      * @var bool
      */
     public $payloads;
-
-    /**
-     * Returns required properties.
-     *
-     * @param array $extraExclude Extra object variables to exclude.
-     *
-     * @return array
-     */
-    public function filter($extraExclude = [])
-    {
-        return array_diff_key(
-            array_filter(get_object_vars($this)),
-            array_flip(array_merge(['name', 'objectName', 'classObjectName'], $extraExclude))
-        );
-    }
 }

Annotation/Suggester/Context/AbstractContext.php

@@ -12,11 +12,12 @@
 namespace ONGR\ElasticsearchBundle\Annotation\Suggester\Context;
 
 use Doctrine\Common\Annotations\Annotation\Required;
+use ONGR\ElasticsearchBundle\Mapping\DumperInterface;
 
 /**
  * Abstract class for various context annotations.
  */
-abstract class AbstractContext
+abstract class AbstractContext implements DumperInterface
 {
     /**
      * @var array
@@ -43,11 +44,9 @@ abstract class AbstractContext
     abstract public function getType();
 
     /**
-     * Returns filtered object data.
-     *
-     * @return array
+     * {@inheritdoc}
      */
-    public function filter()
+    public function dump(array $exclude = [])
     {
         $vars = array_diff_key(
             array_filter(get_object_vars($this)),

Annotation/Suggester/ContextSuggesterProperty.php

@@ -20,13 +20,13 @@ class ContextSuggesterProperty extends AbstractSuggesterProperty
     /**
      * {@inheritdoc}
      */
-    public function filter($extraExclude = [])
+    public function dump(array $exclude = [])
     {
-        $data = parent::filter(['context']);
+        $data = parent::dump(['context']);
 
         /** @var AbstractContext $singleContext */
         foreach ($this->context as $singleContext) {
-            $data['context'][$singleContext->name] = $singleContext->filter();
+            $data['context'][$singleContext->name] = $singleContext->dump();
         }
 
         return $data;

DataCollector/ElasticsearchDataCollector.php

@@ -12,8 +12,8 @@
 namespace ONGR\ElasticsearchBundle\DataCollector;
 
 use Monolog\Logger;
+use ONGR\ElasticsearchBundle\Common\JsonFormatter;
 use ONGR\ElasticsearchBundle\Logger\Handler\CollectionHandler;
-use ONGR\ElasticsearchBundle\Service\JsonFormatter;
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpFoundation\Response;
 use Symfony\Component\HttpKernel\DataCollector\DataCollectorInterface;
@@ -174,9 +174,10 @@ private function handleRecords($route, $records)
     private function addQuery($route, $record, $queryBody)
     {
         parse_str(parse_url($record['context']['uri'], PHP_URL_QUERY), $httpParameters);
+        $body = json_decode(trim($queryBody, "'"), true);
         $this->queries[$route][] = array_merge(
             [
-                'body' => JsonFormatter::prettify(trim($queryBody, "'")),
+                'body' => $body !== null ? json_encode($body, JSON_PRETTY_PRINT) : '',
                 'method' => $record['context']['method'],
                 'httpParameters' => $httpParameters,
                 'time' => $record['context']['duration'] * 100,

Mapping/AbstractAnnotationCamelizer.php

@@ -0,0 +1,47 @@
+<?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\Mapping;
+
+use Doctrine\Common\Inflector\Inflector;
+
+/**
+ * Transforms document properties from underscore case to camel case. 
+ */
+abstract class AbstractAnnotationCamelizer
+{
+    /**
+     * Camelizes properties when reading from document.
+     *
+     * @param array $values Key-value for properties to be defined in this class.
+     */
+    public function __construct(array $values)
+    {
+        foreach ($values as $key => $value) {
+            $this->{Inflector::camelize($key)} = $value;
+        }
+    }
+
+    /**
+     * Converts string from camel into underscore case (port from rails).
+     *
+     * @param string $word
+     *
+     * @return string
+     */
+    protected function underscore($word)
+    {
+        $word = preg_replace('#([A-Z\d]+)([A-Z][a-z])#', '\1_\2', $word);
+        $word = preg_replace('#([a-z\d])([A-Z])#', '\1_\2', $word);
+
+        return strtolower(strtr($word, '-', '_'));
+    }
+}