Implemented code search feature

Javier Castro · Dmitriy Zaporozhets
1 parent 4353babe
Showing 11 changed files with 98 additions and 7 deletions Show diff stats
.travis.yml
Gemfile
Gemfile.lock
app/contexts/search_context.rb
app/controllers/search_controller.rb
app/models/project.rb
app/views/layouts/_search.html.haml
app/views/search/_result.html.haml
features/project/source/search_code.feature
features/steps/project/project_search_code.rb
lib/gitlab/blob_snippet.rb
@@ -6,7 +6,7 @@ before_install:
   - gem install charlock_holmes -v="0.6.9"
 branches:
   only:
-    - 'master'
+    - 'code-search'
 rvm:
   - 1.9.3-p392
   - 2.0.0
@@ -23,7 +23,7 @@ gem &#39;omniauth-github&#39;
  
 # Extracting information from a git repository
 # We cannot use original git since some bugs
-gem "grit", '~> 2.5.0', git: 'https://github.com/gitlabhq/grit.git', ref: '42297cdcee16284d2e4eff23d41377f52fc28b9d'
+gem "grit", '~> 2.5.0', git: 'https://github.com/gitlabhq/grit.git'
 gem 'gitlab_git', '~> 1.0.6'
  
 # Ruby/Rack Git Smart-HTTP Server Handler
@@ -8,8 +8,7 @@ GIT
  
 GIT
   remote: https://github.com/gitlabhq/grit.git
-  revision: 42297cdcee16284d2e4eff23d41377f52fc28b9d
-  ref: 42297cdcee16284d2e4eff23d41377f52fc28b9d
+  revision: e873bb84ac3c4f8249311490d6a7c6ac9127625f
   specs:
     grit (2.5.0)
       diff-lcs (~> 1.1)
@@ -10,7 +10,11 @@ class SearchContext
  
     return result unless query.present?
  
-    result[:projects] = Project.where(id: project_ids).search(query).limit(10)
+    projects = Project.where(id: project_ids)
+    result[:projects] = projects.search(query).limit(10)
+    if projects.length == 1
+      result[:snippets] = projects.first.files(query, params[:branch_ref])
+    end
     result[:merge_requests] = MergeRequest.where(project_id: project_ids).search(query).limit(10)
     result[:issues] = Issue.where(project_id: project_ids).search(query).limit(10)
     result[:wiki_pages] = []
@@ -22,7 +26,8 @@ class SearchContext
       projects: [],
       merge_requests: [],
       issues: [],
-      wiki_pages: []
+      wiki_pages: [],
+      snippets: []
     }
   end
 end
@@ -18,5 +18,6 @@ class SearchController &lt; ApplicationController
     @merge_requests = result[:merge_requests]
     @issues         = result[:issues]
     @wiki_pages     = result[:wiki_pages]
+    @snippets       = result[:snippets]
   end
 end
@@ -411,4 +411,15 @@ class Project &lt; ActiveRecord::Base
     !(forked_project_link.nil? || forked_project_link.forked_from_project.nil?)
   end
  
+  def files(query, treeish)
+   snippets = []
+   tree = treeish.present? ? treeish : default_branch 
+   if repository && !tree.nil?
+     greps = repository.repo.grep(query, 3, tree)
+     greps.each do |g|
+       snippets << Gitlab::BlobSnippet.new(self, tree, g.content, g.startline, g.filename)
+     end
+   end
+   snippets
+  end
 end
@@ -3,4 +3,13 @@
     = text_field_tag "search", nil, placeholder: "Search", class: "search-input"
     = hidden_field_tag :group_id, @group.try(:id)
     = hidden_field_tag :project_id, @project.try(:id)
-    .search-autocomplete-json.hide{:'data-autocomplete-opts' => search_autocomplete_source }
+    - if @ref
+      - @branch_ref = @ref
+    - else
+      - @branch_ref = @project.try(:default_branch)
+      - if @branch_ref.blank?
+        - @branch_ref = 'master'
+    = hidden_field_tag :branch_ref, @branch_ref
+    - if ENV['RAILS_ENV'] == 'test'
+      = submit_tag 'Go'
+    .search-autocomplete-json.hide{:'data-autocomplete-opts' => search_autocomplete_source }
 \ No newline at end of file
@@ -32,6 +32,15 @@
           %strong.term
             = truncate wiki_page.title, length: 50
         %span.light (#{wiki_page.project.name_with_namespace})
+    - @snippets.each do |snippet|
+      %li
+        code:
+        = link_to project_blob_path(snippet.project, tree_join(snippet.tree, snippet.filename), :anchor => "L" + snippet.startline.to_s) do
+          %strong.term
+            = snippet.filename
+          .file_content.code
+            %div{class: user_color_scheme_class}
+              = raw snippet.colorize( formatter: :gitlab, options: { first_line_number: snippet.startline } )
  
 :javascript
   $(function() {
@@ -0,0 +1,9 @@
+Feature: Project Search code
+  Background:
+    Given I sign in as a user
+    And I own project "Shop"
+    Given I visit project source page
+
+  Scenario: Search for term "Welcome to Gitlab"
+    When I search for term "Welcome to Gitlab"
+    Then I should see files from repository containing "Welcome to Gitlab" 
@@ -0,0 +1,16 @@
+class ProjectSearchCode < Spinach::FeatureSteps
+  include SharedAuthentication
+  include SharedProject
+  include SharedPaths
+
+  When 'I search for term "Welcome to Gitlab"' do
+    fill_in "search", with: "Welcome to Gitlab"
+    click_button "Go"
+  end
+
+  Then 'I should see files from repository containing "Welcome to Gitlab"' do
+    page.should have_content "Welcome to Gitlab"
+    page.should have_content "GitLab is a free project and repository management application"
+  end
+
+end
@@ -0,0 +1,32 @@
+module Gitlab
+  class BlobSnippet
+    include Linguist::BlobHelper
+
+    attr_accessor :project
+    attr_accessor :tree
+    attr_accessor :lines
+    attr_accessor :filename
+    attr_accessor :startline
+    
+    def initialize(project, tree, lines, startline, filename)
+      @project, @tree, @lines, @startline, @filename = project, tree, lines, startline, filename
+    end
+    
+    def data
+      lines.join("\n")
+    end
+    
+    def name
+      filename
+    end
+    
+    def size
+      data.length
+    end
+    
+    def mode
+      nil
+    end
+    
+  end
+end
 \ No newline at end of file
...	...	@@ -6,7 +6,7 @@ before_install:
6	6	- gem install charlock_holmes -v="0.6.9"
7	7	branches:
8	8	only:
9		- - 'master'
	9	+ - 'code-search'
10	10	rvm:
11	11	- 1.9.3-p392
12	12	- 2.0.0
...	...
...	...	@@ -23,7 +23,7 @@ gem 'omniauth-github'
23	23
24	24	# Extracting information from a git repository
25	25	# We cannot use original git since some bugs
26		-gem "grit", '~> 2.5.0', git: 'https://github.com/gitlabhq/grit.git', ref: '42297cdcee16284d2e4eff23d41377f52fc28b9d'
	26	+gem "grit", '~> 2.5.0', git: 'https://github.com/gitlabhq/grit.git'
27	27	gem 'gitlab_git', '~> 1.0.6'
28	28
29	29	# Ruby/Rack Git Smart-HTTP Server Handler
...	...
...	...	@@ -8,8 +8,7 @@ GIT
8	8
9	9	GIT
10	10	remote: https://github.com/gitlabhq/grit.git
11		- revision: 42297cdcee16284d2e4eff23d41377f52fc28b9d
12		- ref: 42297cdcee16284d2e4eff23d41377f52fc28b9d
	11	+ revision: e873bb84ac3c4f8249311490d6a7c6ac9127625f
13	12	specs:
14	13	grit (2.5.0)
15	14	diff-lcs (~> 1.1)
...	...
...	...	@@ -10,7 +10,11 @@ class SearchContext
10	10
11	11	return result unless query.present?
12	12
13		- result[:projects] = Project.where(id: project_ids).search(query).limit(10)
	13	+ projects = Project.where(id: project_ids)
	14	+ result[:projects] = projects.search(query).limit(10)
	15	+ if projects.length == 1
	16	+ result[:snippets] = projects.first.files(query, params[:branch_ref])
	17	+ end
14	18	result[:merge_requests] = MergeRequest.where(project_id: project_ids).search(query).limit(10)
15	19	result[:issues] = Issue.where(project_id: project_ids).search(query).limit(10)
16	20	result[:wiki_pages] = []
...	...	@@ -22,7 +26,8 @@ class SearchContext
22	26	projects: [],
23	27	merge_requests: [],
24	28	issues: [],
25		- wiki_pages: []
	29	+ wiki_pages: [],
	30	+ snippets: []
26	31	}
27	32	end
28	33	end
...	...
...	...	@@ -18,5 +18,6 @@ class SearchController < ApplicationController
18	18	@merge_requests = result[:merge_requests]
19	19	@issues = result[:issues]
20	20	@wiki_pages = result[:wiki_pages]
	21	+ @snippets = result[:snippets]
21	22	end
22	23	end
...	...
...	...	@@ -411,4 +411,15 @@ class Project < ActiveRecord::Base
411	411	!(forked_project_link.nil? \|\| forked_project_link.forked_from_project.nil?)
412	412	end
413	413
	414	+ def files(query, treeish)
	415	+ snippets = []
	416	+ tree = treeish.present? ? treeish : default_branch
	417	+ if repository && !tree.nil?
	418	+ greps = repository.repo.grep(query, 3, tree)
	419	+ greps.each do \|g\|
	420	+ snippets << Gitlab::BlobSnippet.new(self, tree, g.content, g.startline, g.filename)
	421	+ end
	422	+ end
	423	+ snippets
	424	+ end
414	425	end
...	...
...	...	@@ -3,4 +3,13 @@
3	3	= text_field_tag "search", nil, placeholder: "Search", class: "search-input"
4	4	= hidden_field_tag :group_id, @group.try(:id)
5	5	= hidden_field_tag :project_id, @project.try(:id)
6		- .search-autocomplete-json.hide{:'data-autocomplete-opts' => search_autocomplete_source }
	6	+ - if @ref
	7	+ - @branch_ref = @ref
	8	+ - else
	9	+ - @branch_ref = @project.try(:default_branch)
	10	+ - if @branch_ref.blank?
	11	+ - @branch_ref = 'master'
	12	+ = hidden_field_tag :branch_ref, @branch_ref
	13	+ - if ENV['RAILS_ENV'] == 'test'
	14	+ = submit_tag 'Go'
	15	+ .search-autocomplete-json.hide{:'data-autocomplete-opts' => search_autocomplete_source }
7	16	\ No newline at end of file
...	...
...	...	@@ -32,6 +32,15 @@
32	32	%strong.term
33	33	= truncate wiki_page.title, length: 50
34	34	%span.light (#{wiki_page.project.name_with_namespace})
	35	+ - @snippets.each do \|snippet\|
	36	+ %li
	37	+ code:
	38	+ = link_to project_blob_path(snippet.project, tree_join(snippet.tree, snippet.filename), :anchor => "L" + snippet.startline.to_s) do
	39	+ %strong.term
	40	+ = snippet.filename
	41	+ .file_content.code
	42	+ %div{class: user_color_scheme_class}
	43	+ = raw snippet.colorize( formatter: :gitlab, options: { first_line_number: snippet.startline } )
35	44
36	45	:javascript
37	46	$(function() {
...	...
...	...	@@ -0,0 +1,9 @@
	1	+Feature: Project Search code
	2	+ Background:
	3	+ Given I sign in as a user
	4	+ And I own project "Shop"
	5	+ Given I visit project source page
	6	+
	7	+ Scenario: Search for term "Welcome to Gitlab"
	8	+ When I search for term "Welcome to Gitlab"
	9	+ Then I should see files from repository containing "Welcome to Gitlab"
...	...
...	...	@@ -0,0 +1,16 @@
	1	+class ProjectSearchCode < Spinach::FeatureSteps
	2	+ include SharedAuthentication
	3	+ include SharedProject
	4	+ include SharedPaths
	5	+
	6	+ When 'I search for term "Welcome to Gitlab"' do
	7	+ fill_in "search", with: "Welcome to Gitlab"
	8	+ click_button "Go"
	9	+ end
	10	+
	11	+ Then 'I should see files from repository containing "Welcome to Gitlab"' do
	12	+ page.should have_content "Welcome to Gitlab"
	13	+ page.should have_content "GitLab is a free project and repository management application"
	14	+ end
	15	+
	16	+end
...	...