Changes requested by reviewers

Author: javiereguiluz

app/Resources/views/blog/search.html.twig

@@ -15,3 +15,9 @@
     <div id="results">
     </div>
 {% endblock %}
+
+{% block sidebar %}
+    {{ parent() }}
+
+    {{ show_source_code(_self) }}
+{% endblock %}

assets/js/search.js

@@ -1,5 +1,7 @@
 import './jquery.instantSearch.js';
 
 $(function() {
-    $('.search-field').instantSearch();
+    $('.search-field').instantSearch({
+        previewDelay: 100,
+    });
 });

assets/scss/app.scss

@@ -67,20 +67,6 @@ header .locales a {
   padding-right: 10px
 }
 
-header .search-bar {
-    padding: 0.8em 0;
-}
-
-header .search-bar form {
-    position: relative;
-}
-
-header .search-preview {
-    position: absolute;
-    width: 100%;
-    top: 100%;
-}
-
 .body-container {
   flex: 1;
   /* needed to prevent pages with a very small height and browsers not supporting flex */

src/AppBundle/Controller/BlogController.php

@@ -156,7 +156,7 @@ public function commentFormAction(Post $post)
      * @Route("/search", name="blog_search")
      * @Method("GET")
      *
-     * @return JsonResponse
+     * @return Response|JsonResponse
      */
     public function searchAction(Request $request)
     {
@@ -176,6 +176,6 @@ public function searchAction(Request $request)
             ];
         }
 
-        return new JsonResponse($results);
+        return $this->json($results);
     }
 }

src/AppBundle/Repository/PostRepository.php

@@ -60,18 +60,24 @@ private function createPaginator(Query $query, $page)
         return $paginator;
     }
 
+    /**
+     * @param string $rawQuery The search query as input by the user
+     * @param int $limit       The maximum number of results returned
+     *
+     * @return array
+     */
     public function findBySearchQuery($rawQuery, $limit = Post::NUM_ITEMS)
     {
         $query = $this->sanitizeSearchQuery($rawQuery);
-        $terms = $this->extractSearchTerms($query);
+        $searchTerms = $this->extractSearchTerms($query);
 
-        if (empty($terms)) {
+        if (0 === count($searchTerms)) {
             return [];
         }
 
         $queryBuilder = $this->createQueryBuilder('p');
 
-        foreach ($terms as $key => $term) {
+        foreach ($searchTerms as $key => $term) {
             $queryBuilder
                 ->orWhere('p.title LIKE :t_'.$key)
                 ->setParameter('t_'.$key, '%'.$term.'%')
@@ -85,14 +91,20 @@ public function findBySearchQuery($rawQuery, $limit = Post::NUM_ITEMS)
             ->getResult();
     }
 
+    /**
+     * Removes all non-alphanumeric characters except whitespaces
+     *
+     * @param string $query
+     *
+     * @return string
+     */
     private function sanitizeSearchQuery($query)
     {
-        // remove all non-alphanumeric characters except whitespaces
         return preg_replace('/[^[:alnum:] ]/', '', trim(preg_replace('/[[:space:]]+/', ' ', $query)));
     }
 
     /**
-     * Splits the query into terms and removes the ones which are too short.
+     * Splits the search query into terms and removes the ones which are irrelevant.
      *
      * @param string $query
      *

web/build/css/app.css

@@ -1,4 +1,4 @@
-webpackJsonp([5],{nxx7:/*!****************************!*\
+webpackJsonp([6],{137:/*!****************************!*\
   !*** ./assets/js/login.js ***!
   \****************************/
-function(n,a,l){(function(n){n(function(){var a=n("#username"),l=n("#password");a.val()||l.val()||(a.val("jane_admin"),l.val("kitten"))})}).call(a,l(/*! jquery */"7t+N"))}},["nxx7"]);
+function(a,n,l){(function(a){a(function(){var n=a("#username"),l=a("#password");n.val()||l.val()||(n.val("jane_admin"),l.val("kitten"))})}).call(n,l(/*! jquery */1))}},[137]);

web/build/js/admin.js

@@ -23,5 +23,6 @@
   "build/js/app.js": "/build/js/app.js",
   "build/js/common.js": "/build/js/common.js",
   "build/js/login.js": "/build/js/login.js",
+  "build/js/search.js": "/build/js/search.js",
   "build/manifest.js": "/build/manifest.js"
 }