Merge pull request #1664 from riyad/auto-complete-everywhere

Cleanup auto-completion and add it to all GFM inputs

Merge pull request #1664 from riyad/auto-complete-everywhere
Cleanup auto-completion and add it to all GFM inputs
Dmitriy Zaporozhets
2 parents a100c578 4d843d2c
Showing 12 changed files with 89 additions and 66 deletions Show diff stats
app/assets/javascripts/gfm_auto_complete.js.coffee
app/assets/javascripts/issues.js
app/helpers/application_helper.rb
app/helpers/notes_helper.rb
app/views/issues/_form.html.haml
app/views/layouts/_head_panel.html.haml
app/views/layouts/_init_auto_complete.html.haml
app/views/merge_requests/_form.html.haml
app/views/notes/_common_form.html.haml
app/views/notes/_create_common_note.js.haml
app/views/wikis/_form.html.haml
spec/helpers/notes_helper_spec.rb
@@ -0,0 +1,57 @@
+
+###
+  Creates the variables for setting up GFM auto-completion
+###
+# Emoji
+window.autocompleteEmojiData = [];
+window.autocompleteEmojiTemplate = "<li data-value='${insert}'>${name} <img alt='${name}' height='20' src='${image}' width='20' /></li>";
+
+# Team Members
+window.autocompleteMembersUrl = "";
+window.autocompleteMembersParams =
+  private_token: ""
+  page: 1
+window.autocompleteMembersData = [];
+
+
+
+###
+  Add GFM auto-completion to all input fields, that accept GFM input.
+###
+window.setupGfmAutoComplete = ->
+  ###
+    Emoji
+  ###
+  $('.gfm-input').atWho ':',
+    data: autocompleteEmojiData,
+    tpl: autocompleteEmojiTemplate
+
+  ###
+    Team Members
+  ###
+  $('.gfm-input').atWho '@', (query, callback) ->
+    (getMoreMembers = ->
+      $.getJSON(autocompleteMembersUrl, autocompleteMembersParams)
+        .success (members) ->
+          # pick the data we need
+          newMembersData = $.map members, (m) -> m.name
+
+          # add the new page of data to the rest
+          $.merge autocompleteMembersData, newMembersData
+
+          # show the pop-up with a copy of the current data
+          callback autocompleteMembersData[..]
+
+          # are we past the last page?
+          if newMembersData.length == 0
+            # set static data and stop callbacks
+            $('.gfm-input').atWho '@',
+              data: autocompleteMembersData
+              callback: null
+          else
+            # get next page
+            getMoreMembers()
+
+      # so the next request gets the next page
+      autocompleteMembersParams.page += 1;
+    ).call();
 \ No newline at end of file
@@ -6,6 +6,7 @@ function switchToNewIssue(form){
     $("#new_issue_dialog").show("fade", { direction: "right" }, 150);
     $('.top-tabs .add_new').hide();
     disableButtonIfEmptyField("#issue_title", ".save-btn");
+    setupGfmAutoComplete();
   });
 }
  
@@ -17,6 +18,7 @@ function switchToEditIssue(form){
     $("#edit_issue_dialog").show("fade", { direction: "right" }, 150);
     $('.add_new').hide();
     disableButtonIfEmptyField("#issue_title", ".save-btn");
+    setupGfmAutoComplete();
   });
 }
  
@@ -98,6 +98,12 @@ module ApplicationHelper
     [projects, default_nav, project_nav].flatten.to_json
   end
  
+  def emoji_autocomplete_source
+    # should be an array of strings
+    # so to_s can be called, because it is sufficient and to_json is too slow
+    Emoji::NAMES.to_s
+  end
+
   def ldap_enable?
     Devise.omniauth_providers.include?(:ldap)
   end
@@ -14,10 +14,4 @@ module NotesHelper
       "vote downvote"
     end
   end
-
-  def emoji_for_completion
-    # should be an array of strings
-    # so to_s can be called, because it is sufficient and to_json is too slow
-    Emoji::NAMES
-  end
 end
@@ -12,7 +12,7 @@
           = f.label :title do
             %strong= "Subject *"
           .input
-            = f.text_field :title, maxlength: 255, class: "xxlarge"
+            = f.text_field :title, maxlength: 255, class: "xxlarge gfm-input"
       .issue_middle_block
         .issue_assignee
           = f.label :assignee_id do
@@ -37,7 +37,7 @@
         .clearfix
           = f.label :description, "Details"
           .input
-            = f.text_area :description, maxlength: 2000, class: "xxlarge", rows: 14
+            = f.text_area :description, maxlength: 2000, class: "xxlarge gfm-input", rows: 14
             %p.hint Issues are parsed with #{link_to "GitLab Flavored Markdown", help_markdown_path, target: '_blank'}.
  
  
@@ -28,6 +28,8 @@
             My profile
           = link_to 'Logout', destroy_user_session_path, class: "logout", method: :delete
  
+= render "layouts/init_auto_complete"
+
 :javascript
   $(function(){
     $("#search").autocomplete({
@@ -0,0 +1,17 @@
+:javascript
+  $(function() {
+    autocompleteMembersUrl = "#{ "/api/v2/projects/#{@project.code}/members" if @project }";
+    autocompleteMembersParams.private_token = "#{current_user.authentication_token}";
+
+    autocompleteEmojiData = #{raw emoji_autocomplete_source};
+    // convert the list so that the items have the right format for completion
+    autocompleteEmojiData = $.map(autocompleteEmojiData, function(value) {
+      return {
+        name: value,
+        insert: value+':',
+        image: '#{image_path("emoji")}/'+value+'.png'
+      }
+    });
+
+    setupGfmAutoComplete();
+  });
@@ -38,7 +38,7 @@
       .top_box_content
         = f.label :title do 
           %strong= "Title *"
-        .input= f.text_field :title, class: "input-xxlarge pad", maxlength: 255, rows: 5
+        .input= f.text_field :title, class: "input-xxlarge pad gfm-input", maxlength: 255, rows: 5
       .middle_box_content
         = f.label :assignee_id do 
           %i.icon-user 
@@ -36,49 +36,3 @@
           %a.file_upload.btn.small Upload File
           = f.file_field :attachment, class: "input-file"
         %span.hint Any file less than 10 MB
-
-:javascript
-  $(function(){
-    // init auto-completion of team members
-    var membersUrl = "#{root_url}/api/v2/projects/#{@project.code}/members";
-    var membersParams = {
-      private_token: "#{current_user.authentication_token}",
-      page: 1,
-    };
-    var membersData = [];
-    $('.gfm-input').atWho('@', function(query, callback) {
-      (function getMoreMembers() {
-        $.getJSON(membersUrl, membersParams).
-          success(function(members) {
-            // pick the data we need
-            var newMembersData = $.map(members, function(member) { return member.name });
-
-            // add the new page of data to the rest
-            $.merge(membersData, newMembersData);
-
-            // show the pop-up with a copy of the current data
-            callback(membersData.slice(0));
-
-            // are we past the last page?
-            if (newMembersData.length == 0) {
-              // set static data and stop callbacks
-              $('.gfm-input').atWho('@', { data: membersData, callback: null });
-            } else {
-              // get next page
-              getMoreMembers();
-            }
-          });
-        // next request will get the next page
-        membersParams.page += 1;
-      })();
-    });
-
-    // init auto-completion of emoji
-    var emoji = #{emoji_for_completion};
-    // convert the list so that the items have the right format for completion
-    emoji = $.map(emoji, function(value) {return { key: value+':', name: value }});
-    $('.gfm-input').atWho(':', {
-      data: emoji,
-      tpl: "<li data-value='${key}'>${name} #{escape_javascript image_tag('emoji/${name}.png', :size => '20x20')}</li>"
-    });
-  });
@@ -10,4 +10,5 @@
 - else
   :plain
     $(".note-form-holder").replaceWith("#{escape_javascript(render 'form')}");
+    setupGfmAutoComplete();
  
@@ -21,7 +21,7 @@
  
     .bottom_box_content
       = f.label :content
-      .input= f.text_area :content, class: 'span8'
+      .input= f.text_area :content, class: 'span8 gfm-input'
   .actions
     = f.submit 'Save', class: "save-btn btn"
     = link_to "Cancel", project_wiki_path(@project, :index), class: "btn cancel-btn"
@@ -1,10 +0,0 @@
-require 'spec_helper'
-
-describe NotesHelper do
-  describe "#emoji_for_completion" do
-    it "should be an Array of Strings" do
-      emoji_for_completion.should be_a(Array)
-      emoji_for_completion.each { |emoji| emoji.should be_a(String) }
-    end
-  end
-end
...	...	@@ -0,0 +1,57 @@
	1	+
	2	+###
	3	+ Creates the variables for setting up GFM auto-completion
	4	+###
	5	+# Emoji
	6	+window.autocompleteEmojiData = [];
	7	+window.autocompleteEmojiTemplate = "<li data-value='${insert}'>${name} <img alt='${name}' height='20' src='${image}' width='20' /></li>";
	8	+
	9	+# Team Members
	10	+window.autocompleteMembersUrl = "";
	11	+window.autocompleteMembersParams =
	12	+ private_token: ""
	13	+ page: 1
	14	+window.autocompleteMembersData = [];
	15	+
	16	+
	17	+
	18	+###
	19	+ Add GFM auto-completion to all input fields, that accept GFM input.
	20	+###
	21	+window.setupGfmAutoComplete = ->
	22	+ ###
	23	+ Emoji
	24	+ ###
	25	+ $('.gfm-input').atWho ':',
	26	+ data: autocompleteEmojiData,
	27	+ tpl: autocompleteEmojiTemplate
	28	+
	29	+ ###
	30	+ Team Members
	31	+ ###
	32	+ $('.gfm-input').atWho '@', (query, callback) ->
	33	+ (getMoreMembers = ->
	34	+ $.getJSON(autocompleteMembersUrl, autocompleteMembersParams)
	35	+ .success (members) ->
	36	+ # pick the data we need
	37	+ newMembersData = $.map members, (m) -> m.name
	38	+
	39	+ # add the new page of data to the rest
	40	+ $.merge autocompleteMembersData, newMembersData
	41	+
	42	+ # show the pop-up with a copy of the current data
	43	+ callback autocompleteMembersData[..]
	44	+
	45	+ # are we past the last page?
	46	+ if newMembersData.length == 0
	47	+ # set static data and stop callbacks
	48	+ $('.gfm-input').atWho '@',
	49	+ data: autocompleteMembersData
	50	+ callback: null
	51	+ else
	52	+ # get next page
	53	+ getMoreMembers()
	54	+
	55	+ # so the next request gets the next page
	56	+ autocompleteMembersParams.page += 1;
	57	+ ).call();
0	58	\ No newline at end of file
...	...
...	...	@@ -6,6 +6,7 @@ function switchToNewIssue(form){
6	6	$("#new_issue_dialog").show("fade", { direction: "right" }, 150);
7	7	$('.top-tabs .add_new').hide();
8	8	disableButtonIfEmptyField("#issue_title", ".save-btn");
	9	+ setupGfmAutoComplete();
9	10	});
10	11	}
11	12
...	...	@@ -17,6 +18,7 @@ function switchToEditIssue(form){
17	18	$("#edit_issue_dialog").show("fade", { direction: "right" }, 150);
18	19	$('.add_new').hide();
19	20	disableButtonIfEmptyField("#issue_title", ".save-btn");
	21	+ setupGfmAutoComplete();
20	22	});
21	23	}
22	24
...	...
...	...	@@ -98,6 +98,12 @@ module ApplicationHelper
98	98	[projects, default_nav, project_nav].flatten.to_json
99	99	end
100	100
	101	+ def emoji_autocomplete_source
	102	+ # should be an array of strings
	103	+ # so to_s can be called, because it is sufficient and to_json is too slow
	104	+ Emoji::NAMES.to_s
	105	+ end
	106	+
101	107	def ldap_enable?
102	108	Devise.omniauth_providers.include?(:ldap)
103	109	end
...	...
...	...	@@ -14,10 +14,4 @@ module NotesHelper
14	14	"vote downvote"
15	15	end
16	16	end
17		-
18		- def emoji_for_completion
19		- # should be an array of strings
20		- # so to_s can be called, because it is sufficient and to_json is too slow
21		- Emoji::NAMES
22		- end
23	17	end
...	...
...	...	@@ -12,7 +12,7 @@
12	12	= f.label :title do
13	13	%strong= "Subject *"
14	14	.input
15		- = f.text_field :title, maxlength: 255, class: "xxlarge"
	15	+ = f.text_field :title, maxlength: 255, class: "xxlarge gfm-input"
16	16	.issue_middle_block
17	17	.issue_assignee
18	18	= f.label :assignee_id do
...	...	@@ -37,7 +37,7 @@
37	37	.clearfix
38	38	= f.label :description, "Details"
39	39	.input
40		- = f.text_area :description, maxlength: 2000, class: "xxlarge", rows: 14
	40	+ = f.text_area :description, maxlength: 2000, class: "xxlarge gfm-input", rows: 14
41	41	%p.hint Issues are parsed with #{link_to "GitLab Flavored Markdown", help_markdown_path, target: '_blank'}.
42	42
43	43
...	...
...	...	@@ -28,6 +28,8 @@
28	28	My profile
29	29	= link_to 'Logout', destroy_user_session_path, class: "logout", method: :delete
30	30
	31	+= render "layouts/init_auto_complete"
	32	+
31	33	:javascript
32	34	$(function(){
33	35	$("#search").autocomplete({
...	...
...	...	@@ -0,0 +1,17 @@
	1	+:javascript
	2	+ $(function() {
	3	+ autocompleteMembersUrl = "#{ "/api/v2/projects/#{@project.code}/members" if @project }";
	4	+ autocompleteMembersParams.private_token = "#{current_user.authentication_token}";
	5	+
	6	+ autocompleteEmojiData = #{raw emoji_autocomplete_source};
	7	+ // convert the list so that the items have the right format for completion
	8	+ autocompleteEmojiData = $.map(autocompleteEmojiData, function(value) {
	9	+ return {
	10	+ name: value,
	11	+ insert: value+':',
	12	+ image: '#{image_path("emoji")}/'+value+'.png'
	13	+ }
	14	+ });
	15	+
	16	+ setupGfmAutoComplete();
	17	+ });
...	...
...	...	@@ -38,7 +38,7 @@
38	38	.top_box_content
39	39	= f.label :title do
40	40	%strong= "Title *"
41		- .input= f.text_field :title, class: "input-xxlarge pad", maxlength: 255, rows: 5
	41	+ .input= f.text_field :title, class: "input-xxlarge pad gfm-input", maxlength: 255, rows: 5
42	42	.middle_box_content
43	43	= f.label :assignee_id do
44	44	%i.icon-user
...	...
...	...	@@ -36,49 +36,3 @@
36	36	%a.file_upload.btn.small Upload File
37	37	= f.file_field :attachment, class: "input-file"
38	38	%span.hint Any file less than 10 MB
39		-
40		-:javascript
41		- $(function(){
42		- // init auto-completion of team members
43		- var membersUrl = "#{root_url}/api/v2/projects/#{@project.code}/members";
44		- var membersParams = {
45		- private_token: "#{current_user.authentication_token}",
46		- page: 1,
47		- };
48		- var membersData = [];
49		- $('.gfm-input').atWho('@', function(query, callback) {
50		- (function getMoreMembers() {
51		- $.getJSON(membersUrl, membersParams).
52		- success(function(members) {
53		- // pick the data we need
54		- var newMembersData = $.map(members, function(member) { return member.name });
55		-
56		- // add the new page of data to the rest
57		- $.merge(membersData, newMembersData);
58		-
59		- // show the pop-up with a copy of the current data
60		- callback(membersData.slice(0));
61		-
62		- // are we past the last page?
63		- if (newMembersData.length == 0) {
64		- // set static data and stop callbacks
65		- $('.gfm-input').atWho('@', { data: membersData, callback: null });
66		- } else {
67		- // get next page
68		- getMoreMembers();
69		- }
70		- });
71		- // next request will get the next page
72		- membersParams.page += 1;
73		- })();
74		- });
75		-
76		- // init auto-completion of emoji
77		- var emoji = #{emoji_for_completion};
78		- // convert the list so that the items have the right format for completion
79		- emoji = $.map(emoji, function(value) {return { key: value+':', name: value }});
80		- $('.gfm-input').atWho(':', {
81		- data: emoji,
82		- tpl: "<li data-value='${key}'>${name} #{escape_javascript image_tag('emoji/${name}.png', :size => '20x20')}</li>"
83		- });
84		- });
...	...
...	...	@@ -10,4 +10,5 @@
10	10	- else
11	11	:plain
12	12	$(".note-form-holder").replaceWith("#{escape_javascript(render 'form')}");
	13	+ setupGfmAutoComplete();
13	14
...	...