Continue implementation of the license template selector and /licenses API endpoint

Signed-off-by: Rémy Coutable <remy@rymai.me>

13 files changed, 115 insertions, 160 deletions

diff --git a/app/assets/javascripts/api.js.coffee b/app/assets/javascripts/api.js.coffee
index f4757658d54..dd1bbb37551 100644
--- a/app/assets/javascripts/api.js.coffee
+++ b/app/assets/javascripts/api.js.coffee
@@ -93,17 +93,15 @@
     ).done (projects) ->
       callback(projects)
 
-  # Return text for specific license
-  licenseText: (key, fullname, callback) ->
-    url = Api.buildUrl(Api.license_path)
-    url = url.replace(':key', key)
+  # Return text for a specific license
+  licenseText: (key, data, callback) ->
+    url = Api.buildUrl(Api.license_path).replace(':key', key)
 
     $.ajax(
       url: url
-      data:
-        fullname: fullname
-    ).done (projects) ->
-      callback(projects)
+      data: data
+    ).done (license) ->
+      callback(license)
 
   buildUrl: (url) ->
     url = gon.relative_url_root + url if gon.relative_url_root?
diff --git a/app/assets/javascripts/blob/blob_license_selector.js.coffee b/app/assets/javascripts/blob/blob_license_selector.js.coffee
index b43c1ec2bb5..e17eaa75dc1 100644
--- a/app/assets/javascripts/blob/blob_license_selector.js.coffee
+++ b/app/assets/javascripts/blob/blob_license_selector.js.coffee
@@ -1,24 +1,30 @@
 class @BlobLicenseSelector
   licenseRegex: /^(.+\/)?(licen[sc]e|copying)($|\.)/i
 
-  constructor: (editor)->
-    self = this
-    @licenseSelector = $('.js-license-selector')
-    @toggleLicenseSelector($('#file_name').val())
+  constructor: (editor) ->
+    @$licenseSelector = $('.js-license-selector')
+    $fileNameInput = $('#file_name')
 
-    $('#file_name').on 'input', ->
-      self.toggleLicenseSelector($(this).val())
+    initialFileNameValue = if $fileNameInput.length
+      $fileNameInput.val()
+    else if $('.editor-file-name').length
+      $('.editor-file-name').text().trim()
 
-    $('select.license-select').select2(
-      width: 'resolve'
-      dropdownAutoWidth: true
-      placeholder: 'Choose a license template'
-    ).on 'change', (e) ->
-      Api.licenseText $(this).val(), $(this).data('fullname'), (data) ->
-        editor.setValue(data, -1)
+    @toggleLicenseSelector(initialFileNameValue)
+
+    if $fileNameInput
+      $fileNameInput.on 'keyup blur', (e) =>
+        @toggleLicenseSelector($(e.target).val())
+
+    $('select.license-select').on 'change', (e) ->
+      data =
+        project: $(this).data('project')
+        fullname: $(this).data('fullname')
+      Api.licenseText $(this).val(), data, (license) ->
+        editor.setValue(license.content, -1)
 
   toggleLicenseSelector: (fileName) =>
     if @licenseRegex.test(fileName)
-      @licenseSelector.show()
+      @$licenseSelector.show()
     else
-      @licenseSelector.hide()
+      @$licenseSelector.hide()
diff --git a/app/assets/javascripts/blob/edit_blob.js.coffee b/app/assets/javascripts/blob/edit_blob.js.coffee
index 390e41ed8d4..eea9aa972ee 100644
--- a/app/assets/javascripts/blob/edit_blob.js.coffee
+++ b/app/assets/javascripts/blob/edit_blob.js.coffee
@@ -1,44 +1,39 @@
 class @EditBlob
-  constructor: (assets_path, mode)->
-    ace.config.set "modePath", assets_path + '/ace'
+  constructor: (assets_path, ace_mode = null) ->
+    ace.config.set "modePath", "#{assets_path}/ace"
     ace.config.loadModule "ace/ext/searchbox"
-    if mode
-      ace_mode = mode
-    editor = ace.edit("editor")
-    editor.focus()
-    @editor = editor
-
-    if ace_mode
-      editor.getSession().setMode "ace/mode/" + ace_mode
+    @editor = ace.edit("editor")
+    @editor.focus()
+    @editor.getSession().setMode "ace/mode/#{ace_mode}" if ace_mode
 
     # Before a form submission, move the content from the Ace editor into the
     # submitted textarea
-    $('form').submit ->
-      $("#file-content").val(editor.getValue())
+    $('form').submit =>
+      $("#file-content").val(@editor.getValue())
+
+    @initModePanesAndLinks()
+    new BlobLicenseSelector(@editor)
 
-    editModePanes = $(".js-edit-mode-pane")
-    editModeLinks = $(".js-edit-mode a")
-    editModeLinks.click (event) ->
-      event.preventDefault()
-      currentLink = $(this)
-      paneId = currentLink.attr("href")
-      currentPane = editModePanes.filter(paneId)
-      editModeLinks.parent().removeClass "active hover"
-      currentLink.parent().addClass "active hover"
-      editModePanes.hide()
-      if paneId is "#preview"
-        currentPane.fadeIn 200
-        $.post currentLink.data("preview-url"),
-          content: editor.getValue()
-        , (response) ->
-          currentPane.empty().append response
-          currentPane.syntaxHighlight()
-          return
+  initModePanesAndLinks: ->
+    @$editModePanes = $(".js-edit-mode-pane")
+    @$editModeLinks = $(".js-edit-mode a")
+    @$editModeLinks.click @editModeLinkClickHandler
 
-      else
-        currentPane.fadeIn 200
-        editor.focus()
-      return
+  editModeLinkClickHandler: (event) =>
+    event.preventDefault()
+    currentLink = $(event.target)
+    paneId = currentLink.attr("href")
+    currentPane = @$editModePanes.filter(paneId)
+    @$editModeLinks.parent().removeClass "active hover"
+    currentLink.parent().addClass "active hover"
+    @$editModePanes.hide()
+    currentPane.fadeIn 200
+    if paneId is "#preview"
+      $.post currentLink.data("preview-url"),
+        content: @editor.getValue()
+      , (response) ->
+        currentPane.empty().append response
+        currentPane.syntaxHighlight()
 
-  editor: ->
-    return @editor
+    else
+      @editor.focus()
diff --git a/app/assets/javascripts/blob/new_blob.js.coffee b/app/assets/javascripts/blob/new_blob.js.coffee
deleted file mode 100644
index 68c5e5195e3..00000000000
--- a/app/assets/javascripts/blob/new_blob.js.coffee
+++ /dev/null
@@ -1,20 +0,0 @@
-class @NewBlob
-  constructor: (assets_path, mode)->
-    ace.config.set "modePath", assets_path + '/ace'
-    ace.config.loadModule "ace/ext/searchbox"
-    if mode
-      ace_mode = mode
-    editor = ace.edit("editor")
-    editor.focus()
-    @editor = editor
-
-    if ace_mode
-      editor.getSession().setMode "ace/mode/" + ace_mode
-
-    # Before a form submission, move the content from the Ace editor into the
-    # submitted textarea
-    $('form').submit ->
-      $("#file-content").val(editor.getValue())
-
-  editor: ->
-    return @editor
diff --git a/app/controllers/projects/blob_controller.rb b/app/controllers/projects/blob_controller.rb
index 6960562d15f..cd8b2911674 100644
--- a/app/controllers/projects/blob_controller.rb
+++ b/app/controllers/projects/blob_controller.rb
@@ -122,15 +122,6 @@ class Projects::BlobController < Projects::ApplicationController
   end
 
   def editor_variables
-    @licenses = {
-      'Popular' => Licensee::License.all(featured: true).map!{ |license| [license.name, license.key] },
-      'Other' => Licensee::License.all(featured: false).map!{ |license| [license.name, license.key] }
-    }
-
-    unless @repository.empty?
-      @current_license_key = Licensee.license(@repository.path).try(:key)
-    end
-
     @target_branch = params[:target_branch]
 
     @file_path =
diff --git a/app/helpers/blob_helper.rb b/app/helpers/blob_helper.rb
index 9e59a295fc4..a4d7c425d0f 100644
--- a/app/helpers/blob_helper.rb
+++ b/app/helpers/blob_helper.rb
@@ -173,4 +173,15 @@ module BlobHelper
     response.etag = @blob.id
     !stale
   end
+
+  def licenses_for_select
+    return @licenses_for_select if defined?(@licenses_for_select)
+
+    licenses = Licensee::License.all
+
+    @licenses_for_select = {
+      Popular: licenses.select(&:featured).map { |license| [license.name, license.key] },
+      Other: licenses.reject(&:featured).map { |license| [license.name, license.key] }
+    }
+  end
 end
diff --git a/app/helpers/projects_helper.rb b/app/helpers/projects_helper.rb
index 0b0cb658b17..81be73937a9 100644
--- a/app/helpers/projects_helper.rb
+++ b/app/helpers/projects_helper.rb
@@ -216,40 +216,14 @@ module ProjectsHelper
     end
   end
 
-  def add_contribution_guide_path(project)
-    if project && !project.repository.contribution_guide
-      namespace_project_new_blob_path(
-        project.namespace,
-        project,
-        project.default_branch,
-        file_name:      "CONTRIBUTING.md",
-        commit_message: "Add contribution guide"
-      )
-    end
-  end
-
-  def add_changelog_path(project)
-    if project && !project.repository.changelog
-      namespace_project_new_blob_path(
-        project.namespace,
-        project,
-        project.default_branch,
-        file_name:      "CHANGELOG",
-        commit_message: "Add changelog"
-      )
-    end
-  end
-
-  def add_license_path(project)
-    if project && !project.repository.license
-      namespace_project_new_blob_path(
-        project.namespace,
-        project,
-        project.default_branch,
-        file_name:      "LICENSE",
-        commit_message: "Add license"
-      )
-    end
+  def add_special_file_path(project, file_name:, commit_message: nil)
+    namespace_project_new_blob_path(
+      project.namespace,
+      project,
+      project.default_branch || 'master',
+      file_name:      file_name,
+      commit_message: commit_message || "Add #{file_name.downcase}"
+    )
   end
 
   def contribution_guide_path(project)
@@ -272,7 +246,7 @@ module ProjectsHelper
   end
 
   def license_path(project)
-    filename_path(project, :license)
+    filename_path(project, :license_blob)
   end
 
   def version_path(project)
@@ -342,6 +316,12 @@ module ProjectsHelper
     @ref || @repository.try(:root_ref)
   end
 
+  def license_short_name(project)
+    license = Licensee::License.new(project.repository.license_key)
+
+    license.nickname || license.name
+  end
+
   private
 
   def filename_path(project, filename)
diff --git a/app/models/repository.rb b/app/models/repository.rb
index 589756f8531..5d6fe017b5e 100644
--- a/app/models/repository.rb
+++ b/app/models/repository.rb
@@ -228,7 +228,8 @@ class Repository
 
   def cache_keys
     %i(size branch_names tag_names commit_count
-       readme version contribution_guide changelog license)
+       readme version contribution_guide changelog
+       license_blob license_key)
   end
 
   def build_cache
@@ -461,27 +462,21 @@ class Repository
     end
   end
 
-  def license
-    cache.fetch(:license) do
-      licenses =  tree(:head).blobs.find_all do |file|
-                    file.name =~ /\A(copying|license|licence)/i
-                  end
-
-      preferences = [
-        /\Alicen[sc]e\z/i,        # LICENSE, LICENCE
-        /\Alicen[sc]e\./i,        # LICENSE.md, LICENSE.txt
-        /\Acopying\z/i,           # COPYING
-        /\Acopying\.(?!lesser)/i, # COPYING.txt
-        /Acopying.lesser/i        # COPYING.LESSER
-      ]
+  def license_blob
+    return nil if !exists? || empty?
 
-      license = nil
-      preferences.each do |r|
-        license = licenses.find { |l| l.name =~ r }
-        break if license
+    cache.fetch(:license_blob) do
+      if licensee_project.license
+        blob_at_branch(root_ref, licensee_project.matched_file.filename)
       end
+    end
+  end
 
-      license
+  def license_key
+    return nil if !exists? || empty?
+
+    cache.fetch(:license_key) do
+      licensee_project.license.try(:key) || 'no-license'
     end
   end
 
@@ -925,4 +920,8 @@ class Repository
   def cache
     @cache ||= RepositoryCache.new(path_with_namespace)
   end
+
+  def licensee_project
+    @licensee_project ||= Licensee.project(path)
+  end
 end
diff --git a/app/views/projects/_readme.html.haml b/app/views/projects/_readme.html.haml
index d1191928d4f..a9908eaecca 100644
--- a/app/views/projects/_readme.html.haml
+++ b/app/views/projects/_readme.html.haml
@@ -9,7 +9,7 @@
 - else
   .gray-content-block.second-block.center
     %h3.page-title
-      This project does not have README yet
+      This project does not have a README yet
     - if can?(current_user, :push_code, @project)
       %p
         A
@@ -18,5 +18,5 @@
         distributed with computer software, forming part of its documentation.
       %p
         We recommend you to
-        = link_to "add README", new_readme_path, class: 'underlined-link'
+        = link_to "add a README", new_readme_path, class: 'underlined-link'
         file to the repository and GitLab will render it here instead of this message.
diff --git a/app/views/projects/blob/_editor.html.haml b/app/views/projects/blob/_editor.html.haml
index 8ebbc91f81d..fefa652a3da 100644
--- a/app/views/projects/blob/_editor.html.haml
+++ b/app/views/projects/blob/_editor.html.haml
@@ -14,7 +14,7 @@
 
     .pull-right
       .license-selector.js-license-selector.hide
-        = select_tag :license_type, grouped_options_for_select(@licenses, @current_license_key), include_blank: true, class: 'select2 license-select', data: { fullname: @repository.project.creator.name }
+        = select_tag :license_type, grouped_options_for_select(licenses_for_select, @project.repository.license_key), include_blank: true, class: 'select2 license-select', data: {placeholder: 'Choose a license template', project: @project.name, fullname: @project.namespace.human_name}
 
       .encoding-selector
         = select_tag :encoding, options_for_select([ "base64", "text" ], "text"), class: 'select2'
@@ -26,8 +26,3 @@
         .center
           %h2
             %i.icon-spinner.icon-spin
-
-:javascript
-  window.onload = function() {
-    new BlobLicenseSelector(blob.editor)
-  }
diff --git a/app/views/projects/blob/new.html.haml b/app/views/projects/blob/new.html.haml
index 1dd2b5c0af7..0459699432e 100644
--- a/app/views/projects/blob/new.html.haml
+++ b/app/views/projects/blob/new.html.haml
@@ -14,5 +14,5 @@
               cancel_path: namespace_project_tree_path(@project.namespace, @project, @id)
 
 :javascript
-  blob = new NewBlob(gon.relative_url_root + "#{Gitlab::Application.config.assets.prefix}", null)
+  blob = new EditBlob(gon.relative_url_root + "#{Gitlab::Application.config.assets.prefix}")
   new NewCommitForm($('.js-new-blob-form'))
diff --git a/app/views/projects/empty.html.haml b/app/views/projects/empty.html.haml
index 2eb79703304..52d093871b4 100644
--- a/app/views/projects/empty.html.haml
+++ b/app/views/projects/empty.html.haml
@@ -14,10 +14,10 @@
     %p
       If you already have files you can push them using command line instructions below.
     %p
-      Otherwise you can start with adding
+      Otherwise you can start with adding a
       = link_to "README", new_readme_path, class: 'underlined-link'
-      or
-      = link_to "LICENSE", new_license_path, class: 'underlined-link'
+      or a
+      = link_to "LICENSE", add_special_file_path(@project, file_name: 'LICENSE'), class: 'underlined-link'
       file to this project.
 
 - if can?(current_user, :push_code, @project)
diff --git a/app/views/projects/show.html.haml b/app/views/projects/show.html.haml
index 4310f038fc9..d854ac21725 100644
--- a/app/views/projects/show.html.haml
+++ b/app/views/projects/show.html.haml
@@ -36,9 +36,9 @@
       %li
         = link_to 'Changelog', changelog_path(@project)
 
-    - if @repository.license
+    - if @repository.license_blob
       %li
-        = link_to 'License', license_path(@project)
+        = link_to license_short_name(@project), license_path(@project)
 
     - if @repository.contribution_guide
       %li
@@ -47,15 +47,15 @@
     - if current_user && can_push_branch?(@project, @project.default_branch)
       - unless @repository.changelog
         %li.missing
-          = link_to add_changelog_path(@project) do
+          = link_to add_special_file_path(@project, file_name: 'CHANGELOG') do
             Add Changelog
-      - unless @repository.license
+      - unless @repository.license_blob
         %li.missing
-          = link_to add_license_path(@project) do
+          = link_to add_special_file_path(@project, file_name: 'LICENSE') do
             Add License
       - unless @repository.contribution_guide
         %li.missing
-          = link_to add_contribution_guide_path(@project) do
+          = link_to add_special_file_path(@project, file_name: 'CONTRIBUTING.md', commit_message: 'Add contribution guide') do
             Add Contribution guide
 
 - if @repository.commit