18 search with sphinx

* add questions index

* user can search in questions

* user can search in questions, users, answers, comments and everywhere

* add SearchesHelper

Author: pavel-sazonov

.gitignore

@@ -29,3 +29,6 @@
 config/database.yml
 
 /dump.rdb
+
+config/*.sphinx.conf
+db/sphinx

Gemfile

@@ -43,6 +43,7 @@ gem 'devise'
 gem 'doorkeeper', '4.2.6'
 gem 'gon'
 gem 'jquery-rails'
+gem 'mysql2'
 gem 'oj'
 gem 'oj_mimic_json'
 gem 'omniauth'
@@ -53,6 +54,7 @@ gem 'sidekiq'
 gem 'sinatra', require: nil
 gem 'skim'
 gem 'slim-rails'
+gem 'thinking-sphinx'
 gem 'whenever'
 
 group :development, :test do
@@ -82,6 +84,7 @@ group :test do
   gem 'chromedriver-helper'
   gem 'launchy'
   gem 'json_spec'
+  gem 'database_cleaner'
 end
 
 # Windows does not include zoneinfo files, so bundle the tzinfo-data gem

Gemfile.lock

@@ -88,6 +88,7 @@ GEM
     concurrent-ruby (1.0.5)
     connection_pool (2.2.2)
     crass (1.0.4)
+    database_cleaner (1.7.0)
     devise (4.4.3)
       bcrypt (~> 3.0)
       orm_adapter (~> 0.1)
@@ -116,10 +117,13 @@ GEM
     hashie (3.5.7)
     i18n (1.0.1)
       concurrent-ruby (~> 1.0)
+    innertube (1.1.0)
     io-like (0.3.0)
     jbuilder (2.7.0)
       activesupport (>= 4.2.0)
       multi_json (>= 1.2)
+    joiner (0.4.2)
+      activerecord (>= 5.2.beta1)
     jquery-rails (4.3.3)
       rails-dom-testing (>= 1, < 3)
       railties (>= 4.2.0)
@@ -143,6 +147,7 @@ GEM
     marcel (0.3.2)
       mimemagic (~> 0.3.2)
     method_source (0.9.0)
+    middleware (0.1.0)
     mime-types (3.1)
       mime-types-data (~> 3.2015)
     mime-types-data (3.2016.0521)
@@ -155,6 +160,7 @@ GEM
     multi_xml (0.6.0)
     multipart-post (2.0.0)
     mustermann (1.0.3)
+    mysql2 (0.5.2)
     nio4r (2.3.0)
     nokogiri (1.8.2)
       mini_portile2 (~> 2.3.0)
@@ -228,6 +234,7 @@ GEM
     responders (2.4.0)
       actionpack (>= 4.2.0, < 5.3)
       railties (>= 4.2.0, < 5.3)
+    riddle (2.3.1)
     rspec (3.7.0)
       rspec-core (~> 3.7.0)
       rspec-expectations (~> 3.7.0)
@@ -297,6 +304,13 @@ GEM
       activesupport (>= 4.0)
       sprockets (>= 3.0.0)
     temple (0.8.0)
+    thinking-sphinx (4.0.0)
+      activerecord (>= 3.1.0)
+      builder (>= 2.1.2)
+      innertube (>= 1.0.2)
+      joiner (>= 0.2.0)
+      middleware (>= 0.1.0)
+      riddle (~> 2.3)
     thor (0.20.0)
     thread_safe (0.3.6)
     tilt (2.0.8)
@@ -335,6 +349,7 @@ DEPENDENCIES
   chromedriver-helper
   cocoon
   coffee-rails (~> 4.2)
+  database_cleaner
   devise
   doorkeeper (= 4.2.6)
   factory_bot_rails
@@ -344,6 +359,7 @@ DEPENDENCIES
   json_spec
   launchy
   listen (>= 3.0.5, < 3.2)
+  mysql2
   oj
   oj_mimic_json
   omniauth
@@ -364,6 +380,7 @@ DEPENDENCIES
   slim-rails
   spring
   spring-watcher-listen (~> 2.0.0)
+  thinking-sphinx
   turbolinks (~> 5)
   tzinfo-data
   uglifier (>= 1.3.0)

app/controllers/searches_controller.rb

@@ -0,0 +1,16 @@
+class SearchesController < ApplicationController
+  respond_to :js, only: :result
+
+  def result
+    authorize! :do, :search
+
+    return render :show if params[:q].empty?
+
+    model = params[:model].constantize
+    respond_with(@result = model.search(params[:q], { per_page: 20, order: 'created_at DESC' }))
+  end
+
+  def show
+    authorize! :do, :search
+  end
+end

app/helpers/searches_helper.rb

@@ -0,0 +1,13 @@
+module SearchesHelper
+  def result_handler(result)
+    type = result.class.name
+    case type
+    when 'User'
+      tag.div(result.email)
+    when 'Question'
+      tag.div(link_to result.title, question_path(result))
+    else
+      tag.div(type + ': ' + result.body.truncate(20))
+    end
+  end
+end

app/indices/answers_index.rb

@@ -0,0 +1,5 @@
+ThinkingSphinx::Index.define :answer, with: :active_record do
+  indexes body
+
+  has created_at
+end

app/indices/comments_index.rb

@@ -0,0 +1,5 @@
+ThinkingSphinx::Index.define :comment, with: :active_record do
+  indexes body
+
+  has created_at
+end

app/indices/questions_index.rb

@@ -0,0 +1,7 @@
+ThinkingSphinx::Index.define :question, with: :active_record do
+  # fields
+  indexes title
+  indexes body
+
+  has created_at
+end

app/indices/users_index.rb

@@ -0,0 +1,5 @@
+ThinkingSphinx::Index.define :user, with: :active_record do
+  indexes email
+
+  has created_at
+end

app/models/ability.rb

@@ -3,6 +3,7 @@ class Ability
 
   def initialize(user)
     can :read, :all
+    can :do, :search
 
     return unless user.present?
     can :me, User

app/views/searches/_result.html.slim

@@ -0,0 +1,7 @@
+p
+  = 'Results: '
+  = @result.size
+
+- @result.each do |el|
+  = result_handler el
+

app/views/searches/result.js.erb

@@ -0,0 +1 @@
+$('.results').html('<%= j render 'result' %>');

app/views/searches/show.html.slim

@@ -0,0 +1,10 @@
+p
+  = form_tag '/search/result', method: :get, remote: true  do
+    p
+      = label_tag :q, "Search for:"
+      br
+      = text_field_tag :q
+    p= select_tag(:model, options_for_select([['Everywhere', ThinkingSphinx],['Question', Question],['Answer', Answer],['Comment', Comment], ['User', User]]))
+    p= submit_tag "Search"
+
+.results

app/views/shared/_header.html.slim

@@ -9,4 +9,5 @@ nav
       = ' '
       => link_to 'Register', new_user_registration_path
 
-  = link_to 'Questions', root_path
+  => link_to 'Questions', root_path
+  => link_to 'Search', search_path

config/routes.rb

@@ -31,6 +31,10 @@
 
   resources :attachments, only: :destroy
 
+  resource :search, only: :show do
+    get :result, on: :member
+  end
+
   namespace :api do
     namespace :v1 do
       resources :profiles, only: :index do

config/thinking_sphinx.yml

@@ -0,0 +1,2 @@
+test:
+  mysql41: 9307

spec/acceptance/acceptance_helper.rb

@@ -8,12 +8,119 @@
 
   config.include AcceptanceHelpers, type: :feature
   config.include OmniauthMacros
+  config.include SphinxHelpers, type: :feature
 
-  config.after(:all) do
-    if Rails.env.test?
-      FileUtils.rm_rf(Dir["#{Rails.root}/public/uploads/test/attachment/"])
+
+  config.use_transactional_fixtures = false
+
+  config.before(:suite) do
+    if config.use_transactional_fixtures?
+      raise(<<-MSG)
+        Delete line `config.use_transactional_fixtures = true` from rails_helper.rb
+        (or set it to false) to prevent uncommitted transactions being used in
+        JavaScript-dependent specs.
+        During testing, the app-under-test that the browser driver connects to
+        uses a different database connection to the database connection used by
+        the spec. The app's database connection would not be able to access
+        uncommitted transaction data setup over the spec's database connection.
+      MSG
+    end
+    DatabaseCleaner.clean_with(:truncation)
+  end
+
+  config.before(:each) do
+    DatabaseCleaner.strategy = :transaction
+  end
+
+  config.before(:each, type: :feature) do
+    # :rack_test driver's Rack app under test shares database connection
+    # with the specs, so continue to use transaction strategy for speed.
+    driver_shares_db_connection_with_specs = Capybara.current_driver == :rack_test
+
+    unless driver_shares_db_connection_with_specs
+      # Driver is probably for an external browser with an app
+      # under test that does *not* share a database connection with the
+      # specs, so use truncation strategy.
+      DatabaseCleaner.strategy = :truncation
     end
   end
 
+  config.before(:suite) do
+    # Ensure sphinx directories exist for the test environment
+      ThinkingSphinx::Test.init
+      # Configure and start Sphinx, and automatically
+      # stop Sphinx at the end of the test suite.
+      ThinkingSphinx::Test.start_with_autostop
+  end
+
+  config.before(:each, js: true) do
+    DatabaseCleaner.strategy = :truncation
+  end
+
+  config.before(:each) do
+    DatabaseCleaner.start
+  end
+
+  config.append_after(:each) do
+    DatabaseCleaner.clean
+  end
+
   OmniAuth.config.test_mode = true
 end
+
+  # config.include AcceptanceHelpers, type: :feature
+  # config.include OmniauthMacros
+  # config.include SphinxHelpers, type: :feature
+
+  # config.before(:suite) do
+  #   # Ensure sphinx directories exist for the test environment
+  #   ThinkingSphinx::Test.init
+  #   # Configure and start Sphinx, and automatically
+  #   # stop Sphinx at the end of the test suite.
+  #   ThinkingSphinx::Test.start_with_autostop
+  # end
+
+  # # config.before(:each) do
+  # #   # Index data when running an acceptance spec.
+  # #   index if example.metadata[:js]
+  # # end
+
+  # config.after(:all) do
+  #   if Rails.env.test?
+  #     FileUtils.rm_rf(Dir["#{Rails.root}/public/uploads/test/attachment/"])
+  #   end
+  # end
+
+  # config.use_transactional_fixtures = false
+
+  # # config.before(:suite) do
+  # #   DatabaseCleaner.clean_with :truncation
+  # # end
+
+  # config.before(:each) do
+  #   DatabaseCleaner.strategy = :transaction
+  # end
+
+  # config.before(:each, :sphinx => true) do
+  #   # For tests tagged with Sphinx, use deletion (or truncation)
+  #   DatabaseCleaner.strategy = :deletion
+  # end
+
+  # # config.before(:each, js: true) do
+  # #   DatabaseCleaner.strategy = :truncation
+  # # end
+
+  # config.before(:each) do
+  #   DatabaseCleaner.start
+  # end
+
+  # # config.after(:each) do
+  # #   DatabaseCleaner.clean
+  # # end
+
+  # config.append_after(:each) do
+  #   DatabaseCleaner.clean
+  # end
+
+  # OmniAuth.config.test_mode = true
+# end

spec/acceptance/search_spec.rb

@@ -0,0 +1,44 @@
+require_relative 'acceptance_helper'
+
+feature 'Search', %q(
+  As an user
+  I want to be able to search resources
+) do
+  given!(:user) { create :user, email: '[email protected]' }
+  given!(:question) { create :question, title: 'search-question' }
+  given!(:answer) { create :answer, body: 'search-answer' }
+
+  scenario 'user searches', js: true do
+    ThinkingSphinx::Test.run do
+      visit search_path
+      fill_in 'q', with: 'search-question'
+      select 'Question', from: 'model'
+      click_button 'Search'
+
+      expect(page).to have_link question.title
+      expect(page).to_not have_content answer.body
+
+      fill_in 'q', with: 'search-answer'
+      select 'Answer', from: 'model'
+      click_button 'Search'
+
+      expect(page).to_not have_link question.title
+      expect(page).to have_content answer.body
+
+      fill_in 'q', with: 'search-user'
+      select 'User', from: 'model'
+      click_button 'Search'
+
+      expect(page).to_not have_link question.title
+      expect(page).to have_content user.email
+
+      fill_in 'q', with: 'search'
+      select 'Everywhere', from: 'model'
+      click_button 'Search'
+
+      expect(page).to have_link question.title
+      expect(page).to have_content user.email
+      expect(page).to have_content answer.body
+    end
+  end
+end