Add feature : Git urls can be sortable

Author: root

Diff for: app/controllers/repository_git_extras_controller.rb

@@ -17,4 +17,16 @@ def update
     end
   end
 
+
+  def sort_urls
+    @git_extra = @repository.extra
+    if request.post?
+      if @git_extra.update_attributes(urls_order: params[:repository_git_extra])
+        flash.now[:notice] = l(:notice_gitolite_extra_updated)
+      else
+        flash.now[:error] = l(:notice_gitolite_extra_update_failed)
+      end
+    end
+  end
+
 end

Diff for: app/models/concerns/gitolitable/features.rb

@@ -78,5 +78,10 @@ def public_repo?
       extra[:public_repo]
     end
 
+
+    def urls_order
+      extra[:urls_order]
+    end
+
   end
 end

Diff for: app/models/concerns/gitolitable/urls.rb

@@ -107,5 +107,16 @@ def available_urls
       hash
     end
 
+
+    def available_urls_sorted
+      return available_urls if (urls_order.nil? || urls_order.empty?)
+      hash = {}
+      urls_order.each do |url|
+        next if !available_urls[url.to_sym]
+        hash[url.to_sym] = available_urls[url.to_sym]
+      end
+      hash
+    end
+
   end
 end

Diff for: app/models/repository_git_extra.rb

@@ -9,12 +9,14 @@ class RepositoryGitExtra < ActiveRecord::Base
   ]
 
   DISABLED = 0
-  HTTP     = 1
-  HTTPS    = 2
-  BOTH     = 3
+  HTTP     = 3
+  HTTPS    = 1
+  BOTH     = 2
+
+  ALLOWED_URLS = %w[ssh http https go git git_annex]
 
   ## Attributes
-  attr_accessible :git_http, :git_daemon, :git_notify, :git_annex, :default_branch, :protected_branch, :public_repo, :key
+  attr_accessible :git_http, :git_daemon, :git_notify, :git_annex, :default_branch, :protected_branch, :public_repo, :key, :urls_order
 
   ## Relations
   belongs_to :repository
@@ -25,8 +27,14 @@ class RepositoryGitExtra < ActiveRecord::Base
   validates :default_branch, presence: true
   validates :key,            presence: true
 
+  validate :validate_urls_order
+
+  ## Serializations
+  serialize :urls_order, Array
+
   ## Callbacks
-  after_save :check_if_default_branch_changed
+  before_save :check_urls_order_consistency
+  after_save  :check_if_default_branch_changed
 
   ## Virtual attribute
   attr_accessor :default_branch_has_changed
@@ -41,6 +49,13 @@ def default_branch_has_changed?
   private
 
 
+    def validate_urls_order
+      urls_order.each do |url|
+        errors.add(:urls_order, :invalid) unless ALLOWED_URLS.include?(url)
+      end
+    end
+
+
     # This is Rails method : <attribute>_changed?
     # However, the value is cleared before passing the object to the controller.
     # We need to save it in virtual attribute to trigger Gitolite resync if changed.
@@ -53,4 +68,57 @@ def check_if_default_branch_changed
       end
     end
 
+
+    def check_urls_order_consistency
+      check_ssh_url
+      check_git_http_urls
+      check_go_url
+      check_git_url
+    end
+
+
+    # SSH url should always be present in urls_order Array
+    #
+    def check_ssh_url
+      add_url('ssh')
+    end
+
+
+    def check_git_http_urls
+      case git_http
+      when DISABLED
+        remove_url('http')
+        remove_url('https')
+      when HTTP
+        add_url('http')
+        remove_url('https')
+      when HTTPS
+        add_url('https')
+        remove_url('http')
+      when BOTH
+        add_url('http')
+        add_url('https')
+      end
+    end
+
+
+    def check_go_url
+      repository.go_access_available? ? add_url('go') : remove_url('go')
+    end
+
+
+    def check_git_url
+      git_daemon? ? add_url('git') : remove_url('git')
+    end
+
+
+    def remove_url(url)
+      self.urls_order.delete(url)
+    end
+
+
+    def add_url(url)
+      self.urls_order.push(url).uniq!
+    end
+
 end

Diff for: app/presenters/repository_presenter.rb

@@ -33,7 +33,7 @@ def render_git_urls
 
     def render_url_list
       s = ''
-      repository.available_urls.each do |key, value|
+      repository.available_urls_sorted.each do |key, value|
         s << content_tag(:li, link_to(key.upcase, 'javascript:void(0)').html_safe, options_for_git_url(key, value))
       end
       s.html_safe

Diff for: app/use_cases/update_project.rb

@@ -29,10 +29,9 @@ def update_project
     def disable_git_daemon_if_not_public
       # Go through all gitolite repos and disable Git daemon if necessary
       project.gitolite_repos.each do |repository|
-        if repository.extra[:git_daemon] && !project.is_public
-          repository.extra[:git_daemon] = false
-          repository.extra.save
-        end
+        repository.extra[:git_daemon] = false if repository.git_daemon_enabled? && !project.is_public
+        # Save GitExtra in all cases to trigger urls order consistency checks
+        repository.extra.save
       end
     end
 

Diff for: app/views/common/_git_urls.html.haml

@@ -6,17 +6,17 @@
   = stylesheet_link_tag    'git_urls',    plugin: 'redmine_git_hosting'
   = javascript_include_tag 'application', plugin: 'redmine_git_hosting'
 
+  :javascript
+    $(document).ready(function() { setFirstGitUrl('.git_url_list'); setGitUrls('.git_url'); });
+
 - repositories = Array.wrap(repository) unless repositories
-- if repositories.map(&:available_urls).reject { |h| h.empty? }.any?
+- if repositories.map(&:available_urls_sorted).reject { |h| h.empty? }.any?
   - repositories.sort_by { |r| r.is_default ? 0 : 1 }.each do |repository|
-    - next if repository.available_urls.empty?
+    - next if repository.available_urls_sorted.empty?
     - present repository do |p|
       .repository-urls
         = p.link_to_repository if repositories.count > 1
         = p.git_urls_box
 
 - else
   #git_url_box= l(:label_repository_access_not_configured)
-
-:javascript
-  $(document).ready(function() { setFirstGitUrl('.git_url_list'); setGitUrls('.git_url'); });

Diff for: app/views/repositories/_edit_top.html.haml

@@ -2,5 +2,8 @@
   = render 'common/git_hosting_js_headers'
 
   %div{ class: 'git_hosting box' }
-    %h3= l(:label_repository_access_url)
+    %h3
+      = l(:label_repository_access_url)
+      = link_to l(:label_sort_urls), sort_urls_repository_git_extras_path(@repository), class: 'modal-box-close-only'
+
     = render partial: 'common/git_urls', locals: { repository: @repository }

Diff for: app/views/repository_git_extras/sort_urls.html.haml

@@ -0,0 +1,8 @@
+#sortable-url-messages
+
+%ul{ id: 'sortable-url', data: { 'update-url' => sort_urls_repository_git_extras_path(@repository), remote: true } }
+  - @repository.available_urls_sorted.keys.each do |url|
+    %li{ id: "repository_git_extra_#{url}" }= url
+
+:javascript
+  $(document).ready(function() { setSortableElement('#sortable-url', '#sortable-url'); });

Diff for: app/views/repository_git_extras/sort_urls.js.erb

@@ -0,0 +1 @@
+$('#sortable-url-messages').html("<%= escape_javascript render_flash_messages %>");

Diff for: config/locales/models/repository_xitolite/en.yml

@@ -39,6 +39,7 @@ en:
   label_repository_exists_in_gitolite: Repository exists in Gitolite
   label_git_objects_count: Git objects count
   label_empty_repository: Empty repository?
+  label_sort_urls: (Sort urls)
 
   notice_gitolite_extra_updated: Options successfully updated
   notice_gitolite_extra_update_failed: Errors while updating options

Diff for: config/locales/models/repository_xitolite/fr.yml

@@ -39,6 +39,7 @@ fr:
   label_repository_exists_in_gitolite: Le dépôt existe dans Gitolite
   label_git_objects_count: Nombre d'objets dans Git
   label_empty_repository: Dépot vide?
+  label_sort_urls: (Trier les urls)
 
   notice_gitolite_extra_updated: Options mises à jour avec succès
   notice_gitolite_extra_update_failed: Erreurs lors de la mise à jour des options

Diff for: config/routes.rb

@@ -10,7 +10,10 @@
     get 'download_revision', to: 'download_git_revision#index', as: 'download_git_revision'
   end
 
-  resource  :git_extras,        controller: 'repository_git_extras', only: [:update]
+  resource  :git_extras, controller: 'repository_git_extras', only: [:update] do
+    match 'sort_urls', via: [:get, :post]
+  end
+
   resource  :git_notifications, controller: 'repository_git_notifications'
 
   resources :post_receive_urls,      controller: 'repository_post_receive_urls'

Diff for: db/migrate/20150410031920_add_urls_order_to_repository_git_extra.rb

@@ -0,0 +1,11 @@
+class AddUrlsOrderToRepositoryGitExtra < ActiveRecord::Migration
+
+  def self.up
+    add_column :repository_git_extras, :urls_order, :text
+  end
+
+  def self.down
+    remove_column :repository_git_extras, :urls_order
+  end
+
+end

Diff for: lib/tasks/migration_tools.rake

@@ -117,18 +117,26 @@ namespace :redmine_git_hosting do
       puts ""
 
       Repository::Xitolite.all.each do |repository|
-        next if !repository.extra.nil?
-        puts " - Repository '#{repository.redmine_name}' has no entry in RepositoryGitExtras table, create it :"
-        default_extra_options = {
-          git_http:       RedmineGitHosting::Config.gitolite_http_by_default?,
-          git_daemon:     RedmineGitHosting::Config.gitolite_daemon_by_default?,
-          git_notify:     RedmineGitHosting::Config.gitolite_notify_by_default?,
-          git_annex:      false,
-          default_branch: 'master',
-          key:            RedmineGitHosting::Utils.generate_secret(64)
-        }
-        extra = repository.build_extra(default_extra_options)
-        extra.save!
+        if repository.project.nil?
+          puts " - ERROR : Repository with id '##{repository.id}' has no associated project ! You should take a look at it !"
+          puts ""
+          next
+        elsif !repository.extra.nil?
+          puts " - Repository '#{repository.redmine_name}' has an entry in RepositoryGitExtras table, update it :"
+          repository.extra.save!
+        else
+          puts " - Repository '#{repository.redmine_name}' has no entry in RepositoryGitExtras table, create it :"
+          default_extra_options = {
+            git_http:       RedmineGitHosting::Config.gitolite_http_by_default?,
+            git_daemon:     RedmineGitHosting::Config.gitolite_daemon_by_default?,
+            git_notify:     RedmineGitHosting::Config.gitolite_notify_by_default?,
+            git_annex:      false,
+            default_branch: 'master',
+            key:            RedmineGitHosting::Utils.generate_secret(64)
+          }
+          extra = repository.build_extra(default_extra_options)
+          extra.save!
+        end
         puts "   Done!"
         puts ""
       end

Diff for: spec/models/repository_git_extra_spec.rb

@@ -18,6 +18,7 @@
     it { should allow_mass_assignment_of(:protected_branch) }
     it { should allow_mass_assignment_of(:public_repo) }
     it { should allow_mass_assignment_of(:key) }
+    it { should allow_mass_assignment_of(:urls_order) }
 
     ## Relations
     it { should belong_to(:repository) }
@@ -36,6 +37,10 @@
 
     it { should validate_inclusion_of(:git_http).in_array(%w(0 1 2 3)) }
 
+    ## Serializations
+    it { should serialize(:urls_order) }
+
+
     it "should have default values for git_http" do
       expect(@git_extra.git_http).to eq 0
     end