Merge branch 'improve/search_autocomplete' into 'master'

Improve: Search autocomplete * fetch options via ajax * only show options related to user input * add limit to amount of options

Merge branch 'improve/search_autocomplete' into 'master'
Improve: Search autocomplete * fetch options via ajax * only show options related to user input * add limit to amount of options
Dmitriy Zaporozhets
2 parents 96808199 1016b547
Showing 9 changed files with 75 additions and 42 deletions Show diff stats
CHANGELOG
app/assets/javascripts/dispatcher.js.coffee
app/assets/javascripts/search_autocomplete.js.coffee
app/controllers/search_controller.rb
app/helpers/search_helper.rb
app/models/project.rb
app/views/layouts/_search.html.haml
config/routes.rb
spec/helpers/search_helper_spec.rb
@@ -16,6 +16,7 @@ v 6.5.0
   - Use jquery timeago plugin
   - Fix 500 error for rdoc files
   - Ability to customize merge commit message (sponsored by Say Media)
+  - Search autocomplete via ajax
 v6.4.3
   - Don't use unicorn worker killer if PhusionPassenger is defined
@@ -47,5 +47,9 @@ class Dispatcher
   initSearch: ->
-    autocomplete_json = $('.search-autocomplete-json').data('autocomplete-opts')
-    new SearchAutocomplete(autocomplete_json)
+    opts = $('.search-autocomplete-opts')
+    path = opts.data('autocomplete-path')
+    project_id = opts.data('autocomplete-project-id')
+    project_ref = opts.data('autocomplete-project-ref')
+
+    new SearchAutocomplete(path, project_id, project_ref)
 class SearchAutocomplete
-  constructor: (json) ->
+  constructor: (search_autocomplete_path, project_id, project_ref) ->
+    project_id = '' unless project_id
+    project_ref = '' unless project_ref
+    query = "?project_id=" + project_id + "&project_ref=" + project_ref
+
     $("#search").autocomplete
-      source: json
+      source: search_autocomplete_path + query
+      minLength: 1
       select: (event, ui) ->
         location.href = ui.item.url
 class SearchController < ApplicationController
+  include SearchHelper
+
   def show
     @project = Project.find_by_id(params[:project_id]) if params[:project_id].present?
     @group = Group.find_by_id(params[:group_id]) if params[:group_id].present?
@@ -10,4 +12,12 @@ class SearchController &lt; ApplicationController
       @search_results = Search::GlobalService.new(current_user, params).execute
     end
   end
+
+  def autocomplete
+    term = params[:term]
+    @project = Project.find(params[:project_id]) if params[:project_id].present?
+    @ref = params[:project_ref] if params[:project_ref].present?
+
+    render json: search_autocomplete_opts(term).to_json
+  end
 end
 module SearchHelper
-  def search_autocomplete_source
+  def search_autocomplete_opts(term)
     return unless current_user
+
+    resources_results = [
+      groups_autocomplete(term),
+      projects_autocomplete(term),
+      public_projects_autocomplete(term),
+    ].flatten
+
+    generic_results = project_autocomplete + default_autocomplete + help_autocomplete
+    generic_results.select! { |result| result[:label] =~ Regexp.new(term, "i") }
+
     [
-      groups_autocomplete,
-      projects_autocomplete,
-      public_projects_autocomplete,
-      default_autocomplete,
-      project_autocomplete,
-      help_autocomplete
+      resources_results,
+      generic_results
     ].flatten.uniq do |item|
       item[:label]
-    end.to_json
+    end
   end
   private
@@ -43,7 +49,7 @@ module SearchHelper
   # Autocomplete results for the current project, if it's defined
   def project_autocomplete
     if @project && @project.repository.exists? && @project.repository.root_ref
-      prefix = simple_sanitize(@project.name_with_namespace)
+      prefix = search_result_sanitize(@project.name_with_namespace)
       ref    = @ref || @project.repository.root_ref
       [
@@ -65,23 +71,36 @@ module SearchHelper
   end
   # Autocomplete results for the current user's groups
-  def groups_autocomplete
-    current_user.authorized_groups.map do |group|
-      { label: "group: #{simple_sanitize(group.name)}", url: group_path(group) }
+  def groups_autocomplete(term, limit = 5)
+    current_user.authorized_groups.search(term).limit(limit).map do |group|
+      {
+        label: "group: #{search_result_sanitize(group.name)}",
+        url: group_path(group)
+      }
     end
   end
   # Autocomplete results for the current user's projects
-  def projects_autocomplete
-    current_user.authorized_projects.non_archived.map do |p|
-      { label: "project: #{simple_sanitize(p.name_with_namespace)}", url: project_path(p) }
+  def projects_autocomplete(term, limit = 5)
+    current_user.authorized_projects.search_by_title(term).non_archived.limit(limit).map do |p|
+      {
+        label: "project: #{search_result_sanitize(p.name_with_namespace)}",
+        url: project_path(p)
+      }
     end
   end
   # Autocomplete results for the current user's projects
-  def public_projects_autocomplete
-    Project.public_or_internal_only(current_user).non_archived.map do |p|
-      { label: "project: #{simple_sanitize(p.name_with_namespace)}", url: project_path(p) }
+  def public_projects_autocomplete(term, limit = 5)
+    Project.public_or_internal_only(current_user).search_by_title(term).non_archived.limit(limit).map do |p|
+      {
+        label: "project: #{search_result_sanitize(p.name_with_namespace)}",
+        url: project_path(p)
+      }
     end
   end
+
+  def search_result_sanitize(str)
+    Sanitize.clean(str)
+  end
 end
@@ -138,6 +138,10 @@ class Project &lt; ActiveRecord::Base
       joins(:namespace).where("projects.archived = ?", false).where("projects.name LIKE :query OR projects.path LIKE :query OR namespaces.name LIKE :query OR projects.description LIKE :query", query: "%#{query}%")
     end
+    def search_by_title query
+      where("projects.archived = ?", false).where("LOWER(projects.name) LIKE :query", query: "%#{query.downcase}%")
+    end
+
     def find_with_namespace(id)
       if id.include?("/")
         id = id.split("/")
@@ -7,4 +7,4 @@
       = hidden_field_tag :search_code, true
     = hidden_field_tag :repository_ref, @ref
     = submit_tag 'Go' if ENV['RAILS_ENV'] == 'test'
-    .search-autocomplete-json.hide{:'data-autocomplete-opts' => search_autocomplete_source }
+    .search-autocomplete-opts.hide{:'data-autocomplete-path' => search_autocomplete_path, :'data-autocomplete-project-id' => @project.try(:id), :'data-autocomplete-project-ref' => @ref }
@@ -6,6 +6,7 @@ Gitlab::Application.routes.draw do
   # Search
   #
   get 'search' => "search#show"
+  get 'search/autocomplete' => "search#autocomplete", as: :search_autocomplete
   # API
   API::API.logger Rails.logger
@@ -13,52 +13,41 @@ describe SearchHelper do
       end
       it "it returns nil" do
-        search_autocomplete_source.should be_nil
+        search_autocomplete_opts("q").should be_nil
       end
     end
     context "with a user" do
       let(:user)   { create(:user) }
-      let(:result) { JSON.parse(search_autocomplete_source) }
       before do
         allow(self).to receive(:current_user).and_return(user)
       end
       it "includes Help sections" do
-        result.select { |h| h['label'] =~ /^help:/ }.length.should == 9
+        search_autocomplete_opts("hel").size.should == 9
       end
       it "includes default sections" do
-        result.count { |h| h['label'] =~ /^(My|Admin)\s/ }.should == 4
+        search_autocomplete_opts("adm").size.should == 1
       end
       it "includes the user's groups" do
         create(:group).add_owner(user)
-        result.count { |h| h['label'] =~ /^group:/ }.should == 1
+        search_autocomplete_opts("gro").size.should == 1
       end
       it "includes the user's projects" do
-        create(:project, namespace: create(:namespace, owner: user))
-        result.count { |h| h['label'] =~ /^project:/ }.should == 1
+        project = create(:project, namespace: create(:namespace, owner: user))
+        search_autocomplete_opts(project.name).size.should == 1
       end
       context "with a current project" do
         before { @project = create(:project_with_code) }
         it "includes project-specific sections" do
-          result.count { |h| h['label'] =~ /^#{@project.name_with_namespace} - / }.should == 11
-        end
-
-        it "uses @ref in urls if defined" do
-          @ref = "foo_bar"
-          result.count { |h| h['url'] == project_tree_path(@project, @ref) }.should == 1
-        end
-      end
-
-      context "with no current project" do
-        it "does not include project-specific sections" do
-          result.count { |h| h['label'] =~ /Files$/ }.should == 0
+          search_autocomplete_opts("Files").size.should == 1
+          search_autocomplete_opts("Commits").size.should == 1
         end
       end
     end
	@@ -16,6 +16,7 @@ v 6.5.0		@@ -16,6 +16,7 @@ v 6.5.0
16	- Use jquery timeago plugin	16	- Use jquery timeago plugin
17	- Fix 500 error for rdoc files	17	- Fix 500 error for rdoc files
18	- Ability to customize merge commit message (sponsored by Say Media)	18	- Ability to customize merge commit message (sponsored by Say Media)
		19	+ - Search autocomplete via ajax
19		20
20	v6.4.3	21	v6.4.3
21	- Don't use unicorn worker killer if PhusionPassenger is defined	22	- Don't use unicorn worker killer if PhusionPassenger is defined
	@@ -47,5 +47,9 @@ class Dispatcher		@@ -47,5 +47,9 @@ class Dispatcher
47		47
48		48
49	initSearch: ->	49	initSearch: ->
50	- autocomplete_json = $('.search-autocomplete-json').data('autocomplete-opts')
51	- new SearchAutocomplete(autocomplete_json)	50	+ opts = $('.search-autocomplete-opts')
		51	+ path = opts.data('autocomplete-path')
		52	+ project_id = opts.data('autocomplete-project-id')
		53	+ project_ref = opts.data('autocomplete-project-ref')
		54	+
		55	+ new SearchAutocomplete(path, project_id, project_ref)
1	class SearchController < ApplicationController	1	class SearchController < ApplicationController
		2	+ include SearchHelper
		3	+
2	def show	4	def show
3	@project = Project.find_by_id(params[:project_id]) if params[:project_id].present?	5	@project = Project.find_by_id(params[:project_id]) if params[:project_id].present?
4	@group = Group.find_by_id(params[:group_id]) if params[:group_id].present?	6	@group = Group.find_by_id(params[:group_id]) if params[:group_id].present?
	@@ -10,4 +12,12 @@ class SearchController < ApplicationController		@@ -10,4 +12,12 @@ class SearchController < ApplicationController
10	@search_results = Search::GlobalService.new(current_user, params).execute	12	@search_results = Search::GlobalService.new(current_user, params).execute
11	end	13	end
12	end	14	end
		15	+
		16	+ def autocomplete
		17	+ term = params[:term]
		18	+ @project = Project.find(params[:project_id]) if params[:project_id].present?
		19	+ @ref = params[:project_ref] if params[:project_ref].present?
		20	+
		21	+ render json: search_autocomplete_opts(term).to_json
		22	+ end
13	end	23	end
	@@ -7,4 +7,4 @@		@@ -7,4 +7,4 @@
7	= hidden_field_tag :search_code, true	7	= hidden_field_tag :search_code, true
8	= hidden_field_tag :repository_ref, @ref	8	= hidden_field_tag :repository_ref, @ref
9	= submit_tag 'Go' if ENV['RAILS_ENV'] == 'test'	9	= submit_tag 'Go' if ENV['RAILS_ENV'] == 'test'
10	- .search-autocomplete-json.hide{:'data-autocomplete-opts' => search_autocomplete_source }	10	+ .search-autocomplete-opts.hide{:'data-autocomplete-path' => search_autocomplete_path, :'data-autocomplete-project-id' => @project.try(:id), :'data-autocomplete-project-ref' => @ref }
	@@ -6,6 +6,7 @@ Gitlab::Application.routes.draw do		@@ -6,6 +6,7 @@ Gitlab::Application.routes.draw do
6	# Search	6	# Search
7	#	7	#
8	get 'search' => "search#show"	8	get 'search' => "search#show"
		9	+ get 'search/autocomplete' => "search#autocomplete", as: :search_autocomplete
9		10
10	# API	11	# API
11	API::API.logger Rails.logger	12	API::API.logger Rails.logger