Merge branch 'dhp_solr_fix' into 'development'

[REVIEW] Fix Solr search

See merge request !7

app/controllers/products_controller.rb

@@ -2,6 +2,7 @@ class ProductsController < ApplicationController
   before_action :authenticate_user!, only: [:new, :edit, :create, :update, :destroy]
   before_action :set_product, only: :show
   before_action :user_can_edit_product, only: [:edit, :update, :destroy]
+  before_action :set_solr, only: [:create, :update, :destroy]
 
   # GET /products/new
   def new
@@ -12,6 +13,7 @@ class ProductsController < ApplicationController
   def create
     @product = Product.new(product_params.merge(user_id: current_user.id))
     if @product.save
+      @solr.add_product(@product)
       redirect_to root_url, flash: { success: "Product #{@product.title} is sucessfully created" }
     else
       render 'new'
@@ -21,6 +23,7 @@ class ProductsController < ApplicationController
   # PATCH/PUT /products/1
   def update
     if @product.update(product_params)
+      @solr.update_product(@product)
       redirect_to root_url, flash: { success: "Product #{@product.title} is sucessfully updated" }
     else
       render 'edit'
@@ -31,6 +34,7 @@ class ProductsController < ApplicationController
   def destroy
     if @product.destroy
       flash[:success] = "Product #{@product.title} deleted"
+      @solr.delete_product(@product)
     else
       flash[:alert] = "Product #{@product.title} can't be deleted"
     end
@@ -56,4 +60,8 @@ class ProductsController < ApplicationController
     @product = current_user.products.find_by(id: params[:id])
     redirect_to root_url, flash: { alert: 'You do not have permission to edit this product' } if @product.blank?
   end
+
+  def set_solr
+    @solr = Solr.new
+  end
 end
\ No newline at end of file

app/controllers/search_controller.rb

@@ -13,10 +13,10 @@ class SearchController < ApplicationController
   private
 
   def set_search_result
-    @search_result = if params[:q].present?
-                       Search.new(params[:q]).products
-                     else
-                       Product.all
-                     end
+    search = Search.new
+    @search_result = search.products(params[:q])
+    if @search_result.blank?
+      @suggested_keywords = search.suggested_keywords(params[:q])
+    end
   end
 end
\ No newline at end of file

app/helpers/search_helper.rb

 module SearchHelper
-  def render_search_result(search_result)
+  def render_search_result(search_result, suggested_keywords)
     if search_result.blank?
-      render html: 'Sorry! There are no products matched your query'
+      keys = suggested_keywords.map { |kw| link_to kw, search_result_url(q: kw) }.\
+             to_sentence(last_word_connector: ' or ')
+      suggestion_msg = keys.present? ? " You can try different keywords like #{keys}" : ''
+      render html: "Sorry! There are no products matched your query. #{suggestion_msg}".html_safe
     else
       render(partial: 'products/product_list',
              locals: { products: search_result })

app/services/product_filter.rb

+class ProductFilter
+  def self.filter_search_query(query)
+    return '*' if query.blank?
+    filtered_query = RSolr.solr_escape(query)
+    filtered_query[/\D+/] == filtered_query ? "title:#{filtered_query}" : filtered_query
+  end
+
+  def self.filter_suggest_keyword(keyword)
+    RSolr.solr_escape(keyword)
+  end
+end
\ No newline at end of file

app/services/search.rb

 class Search
-  def initialize(search_query)
-    @solr = SolrSearch.new
-    @search_query = search_query
+  def initialize
+    @solr = Solr.new
   end
 
-  def products
-    @solr.search_for(@search_query)
-    filter_products(@solr.docs)
+  # Get matched products with keyword
+  def products(search_query)
+    @products_indexes = @solr.exec_select_request(ProductFilter.filter_search_query(search_query))
+    matched_products(@products_indexes)
+  end
+
+  # Get suggested keywords
+  def suggested_keywords(keyword)
+    keywords = @solr.exec_suggest_request(ProductFilter.filter_suggest_keyword(keyword))
+    keywords.map { |kw| kw['term'] }
   end
 
   private
 
-  def filter_products(products)
+  def matched_products(products)
     product_ids = products.map { |product| product[:id.to_s] }
     Product.find(product_ids)
   end

app/services/solr.rb

+require 'rsolr'
+
+class Solr
+  attr_accessor :rsolr
+
+  def initialize
+    @rsolr = RSolr.connect url: Settings.rsolr.address
+  end
+
+  def exec_select_request(query)
+    response = rsolr.get 'select', params: { q: query }
+    response['response']['docs']
+  end
+
+  def exec_suggest_request(query)
+    response = rsolr.get 'suggest', params: { 'suggest.q' => query }
+    response['suggest']['productSuggester'][query]['suggestions']
+  end
+
+  def add_products(products)
+    rsolr.add products
+  end
+
+  def update_product(product)
+    add_product(product)
+    delete_product(product)
+  end
+
+  def add_product(product)
+    rsolr.add(id: product.id,
+              title: product.title,
+              price: product.price)
+    rsolr.optimize
+  end
+
+  def delete_product(product)
+    rsolr.delete_by_id product.id
+    rsolr.optimize
+  end
+
+  def delete_all_products
+    rsolr.update(data: '<delete><query>*:*</query></delete>',
+                 headers: { 'Content-Type' => 'text/xml',
+                            'charset' => 'utf-8' })
+    rsolr.commit
+  end
+end
\ No newline at end of file

app/services/solr_search.rb

-require 'rsolr'
-
-class SolrSearch
-  attr_accessor :rsolr
-
-  def initialize
-    @rsolr = RSolr.connect url: Settings.rsolr.address
-    @response = nil
-  end
-
-  def search_for(search_query)
-    search_query ||= ''
-    @response = rsolr.get 'select', params: { q: sanitize_query(search_query) }
-  end
-
-  def docs
-    @response['response']['docs']
-  end
-
-  def sanitize_query(query)
-    query.gsub(/[^0-9A-Za-z]/, '')
-  end
-end
\ No newline at end of file

app/views/layouts/header/_search_form.html.erb

@@ -2,7 +2,7 @@
   <a href="#" class="search-toggle"><i class="fa fa-search"></i></a>
   <%= form_tag search_result_path, method: :get do %>
     <div class="header-search-wrapper">
-      <%= text_field_tag :q, params[:q], class: 'form-control', placeholder: 'Search...' %>
+      <%= text_field_tag :q, params[:q], class: 'form-control', placeholder: 'Enter product title...' %>
       <%= button_tag raw('<i class="fa fa-search"></i>'), class: 'btn btn-default'  %>
     </div>
   <% end %>

app/views/search/show.html.erb

@@ -4,7 +4,7 @@
       <h2 class="h2 heading-primary mt-lg clearfix">
         <span>Search result</span>
       </h2>
-      <%= render_search_result(@products) %>
+      <%= render_search_result(@products, @suggested_keywords) %>
 
       <div class="toolbar-bottom">
         <div class="toolbar">

lib/tasks/import_solr_data.rake

-namespace :import_solr_data do
-  desc "Import product data from database"
-  task product: :environment do
-    documents = []
-    Product.all.each do |product|
-      documents << { id: product.id, title: product.title, price: product.price }
-    end
-    solr_search = SolrSearch.new
-    solr_search.rsolr.add documents
-  end
-end

lib/tasks/vs_solr.rake

+namespace :vs_solr do
+  desc 'Import product data from database'
+  task product: :environment do
+    products = []
+    Product.all.each do |product|
+      products << { id: product.id,
+                    title: product.title,
+                    price: product.price }
+    end
+    Solr.new.add_products(products)
+  end
+
+  desc 'Remove all index from Solr'
+  task remove: :environment do
+    Solr.new.delete_all_products
+  end
+end