From 8d28d3cace765a4887effea9a7bce64213d6f706 Mon Sep 17 00:00:00 2001
From: tza
Date: Fri, 24 Sep 2021 13:25:44 +0200
Subject: bug #16188: enhance project category, add inactive flag

---
 .../issue_categories_controller.rb            | 32 +++++++++++++++++--
 app/controllers/issues_controller.rb          |  1 +
 app/models/issue.rb                           | 10 ++++++
 app/models/project.rb                         |  4 +++
 app/views/context_menus/issues.html.erb       |  4 +--
 app/views/issues/_attributes.html.erb         |  4 +--
 app/views/issues/bulk_edit.html.erb           |  2 +-
 .../settings/_issue_categories.html.erb       |  2 ++
 config/routes.rb                              |  7 ++++
 ...10908145200_issue_categories_add_column.rb |  9 ++++++
 .../issue_categories_controller_test.rb       | 24 ++++++++++++++
 test/unit/issue_test.rb                       | 30 +++++++++++++++++
 test/unit/project_test.rb                     | 20 ++++++++++++
 13 files changed, 142 insertions(+), 7 deletions(-)
 create mode 100644 db/migrate/20210908145200_issue_categories_add_column.rb

diff --git a/app/controllers/issue_categories_controller.rb b/app/controllers/issue_categories_controller.rb
index 196f9bf98..371cf9181 100644
--- a/app/controllers/issue_categories_controller.rb
+++ b/app/controllers/issue_categories_controller.rb
@@ -23,8 +23,8 @@ class IssueCategoriesController < ApplicationController
   before_action :find_model_object, :except => [:index, :new, :create]
   before_action :find_project_from_association, :except => [:index, :new, :create]
   before_action :find_project_by_project_id, :only => [:index, :new, :create]
-  before_action :authorize
-  accept_api_auth :index, :show, :create, :update, :destroy
+  before_action :authorize, :except => [:archive, :unarchive]
+  accept_api_auth :index, :show, :create, :update, :destroy, :archive, :unarchive
 
   def index
     respond_to do |format|
@@ -94,6 +94,34 @@ class IssueCategoriesController < ApplicationController
       end
     end
   end
+  
+  def archive
+    @category.archived = true
+    if @category.save
+      respond_to do |format|
+        format.html do
+          flash[:notice] = l(:notice_successful_update)
+          redirect_to_settings_in_projects
+        end
+        format.js
+        format.api { render :action => 'show', :status => :created, :location => issue_category_path(@category) }
+      end
+    end
+  end
+    
+  def unarchive
+    @category.archived = false
+    if @category.save
+      respond_to do |format|
+        format.html do
+          flash[:notice] = l(:notice_successful_update)
+          redirect_to_settings_in_projects
+        end
+        format.js
+        format.api { render :action => 'show', :status => :created, :location => issue_category_path(@category) }
+      end
+    end
+  end
 
   def destroy
     @issue_count = @category.issues.size
diff --git a/app/controllers/issues_controller.rb b/app/controllers/issues_controller.rb
index 96a8341d0..0c3a753e5 100644
--- a/app/controllers/issues_controller.rb
+++ b/app/controllers/issues_controller.rb
@@ -316,6 +316,7 @@ class IssuesController < ApplicationController
     @assignables = target_projects.map(&:assignable_users).reduce(:&)
     @versions = target_projects.map {|p| p.shared_versions.open}.reduce(:&)
     @categories = target_projects.map {|p| p.issue_categories}.reduce(:&)
+    @active_categories = @categories.reject { |c| c.archived }
     if @copy
       @attachments_present = @issues.detect {|i| i.attachments.any?}.present?
       @subtasks_present = @issues.detect {|i| !i.leaf?}.present?
diff --git a/app/models/issue.rb b/app/models/issue.rb
index 7ce04ad64..e50e7801d 100644
--- a/app/models/issue.rb
+++ b/app/models/issue.rb
@@ -982,6 +982,16 @@ class Issue < ActiveRecord::Base
     users.uniq.sort
   end
 
+  def assignable_issue_categories
+    return [] if project.nil?
+
+    categories = project.active_issue_categories
+    if category && category.archived
+      categories << category
+    end
+    categories.uniq.sort
+  end
+  
   # Versions that the issue can be assigned to
   def assignable_versions
     return @assignable_versions if @assignable_versions
diff --git a/app/models/project.rb b/app/models/project.rb
index 4d5e3c051..32de16828 100644
--- a/app/models/project.rb
+++ b/app/models/project.rb
@@ -974,6 +974,10 @@ class Project < ActiveRecord::Base
       value.custom_field.visible_by?(project, user)
     end
   end
+    
+  def active_issue_categories
+    issue_categories.reject { |c| c.archived }
+  end
 
   private
 
diff --git a/app/views/context_menus/issues.html.erb b/app/views/context_menus/issues.html.erb
index 23ea817ac..d0bfdb695 100644
--- a/app/views/context_menus/issues.html.erb
+++ b/app/views/context_menus/issues.html.erb
@@ -86,11 +86,11 @@
   </li>
   <% end %>
 
-  <% if @safe_attributes.include?('category_id') && @project && @project.issue_categories.any? -%>
+  <% if @safe_attributes.include?('category_id') && @project && @project.active_issue_categories.any? -%>
   <li class="folder">
     <a href="#" class="submenu"><%= l(:field_category) %></a>
     <ul>
-    <% @project.issue_categories.each do |u| -%>
+    <% @project.active_issue_categories.each do |u| -%>
         <li><%= context_menu_link u.name, _bulk_update_issues_path(@issue, :ids => @issue_ids, :issue => {'category_id' => u}, :back_url => @back), :method => :patch,
                                   :selected => (@issue && u == @issue.category), :disabled => !@can[:edit] %></li>
     <% end -%>
diff --git a/app/views/issues/_attributes.html.erb b/app/views/issues/_attributes.html.erb
index b5003c436..babe4ca78 100644
--- a/app/views/issues/_attributes.html.erb
+++ b/app/views/issues/_attributes.html.erb
@@ -29,8 +29,8 @@
 </p>
 <% end %>
 
-<% if @issue.safe_attribute?('category_id') && @issue.project.issue_categories.any? %>
-<p><%= f.select :category_id, (@issue.project.issue_categories.collect {|c| [c.name, c.id]}),
+<% if @issue.safe_attribute?('category_id') && @issue.assignable_issue_categories.any? %>
+<p><%= f.select :category_id, (@issue.assignable_issue_categories.collect {|c| [c.name, c.id]}),
                 {:include_blank => true, :required => @issue.required_attribute?('category_id')},
                  :onchange => ("updateIssueFrom('#{escape_javascript(update_issue_form_path(@project, @issue))}', this)" if @issue.new_record?) %>
 <%= link_to(l(:label_issue_category_new),
diff --git a/app/views/issues/bulk_edit.html.erb b/app/views/issues/bulk_edit.html.erb
index a49617aab..1a5e54036 100644
--- a/app/views/issues/bulk_edit.html.erb
+++ b/app/views/issues/bulk_edit.html.erb
@@ -81,7 +81,7 @@
   <label for='issue_category_id'><%= l(:field_category) %></label>
   <%= select_tag('issue[category_id]', content_tag('option', l(:label_no_change_option), :value => '') +
                                 content_tag('option', l(:label_none), :value => 'none', :selected => (@issue_params[:category_id] == 'none')) +
-                                options_from_collection_for_select(@categories, :id, :name, @issue_params[:category_id])) %>
+                                options_from_collection_for_select(@active_categories, :id, :name, @issue_params[:category_id])) %>
 </p>
 <% end %>
 
diff --git a/app/views/projects/settings/_issue_categories.html.erb b/app/views/projects/settings/_issue_categories.html.erb
index 3cd78e387..5c24847d6 100644
--- a/app/views/projects/settings/_issue_categories.html.erb
+++ b/app/views/projects/settings/_issue_categories.html.erb
@@ -16,6 +16,8 @@
     <td class="buttons">
       <% if User.current.allowed_to?(:manage_categories, @project) %>
         <%= link_to l(:button_edit), edit_issue_category_path(category), :class => 'icon icon-edit' %>
+        <%= link_to(l(:button_archive), archive_issue_category_path(category), :method => :post, :class => 'icon icon-lock') unless category.archived? %>
+        <%= link_to(l(:button_unarchive), unarchive_issue_category_path(category), :method => :post, :class => 'icon icon-lock') if category.archived? %>
         <%= delete_link issue_category_path(category) %>
       <% end %>
     </td>
diff --git a/config/routes.rb b/config/routes.rb
index efb6db8e1..5764acdb0 100644
--- a/config/routes.rb
+++ b/config/routes.rb
@@ -405,4 +405,11 @@ Rails.application.routes.draw do
       end
     end
   end
+  
+  resources :issue_categories do
+    member do
+      post 'archive'
+      post 'unarchive'
+    end
+  end
 end
diff --git a/db/migrate/20210908145200_issue_categories_add_column.rb b/db/migrate/20210908145200_issue_categories_add_column.rb
new file mode 100644
index 000000000..a7abb1541
--- /dev/null
+++ b/db/migrate/20210908145200_issue_categories_add_column.rb
@@ -0,0 +1,9 @@
+class IssueCategoriesAddColumn < ActiveRecord::Migration[6.1]
+  def self.up
+    add_column :issue_categories, :archived, :boolean, :default => false
+  end
+
+  def self.down
+    remove_column :issue_categories, :archived
+  end
+end
\ No newline at end of file
diff --git a/test/functional/issue_categories_controller_test.rb b/test/functional/issue_categories_controller_test.rb
index 4433e8b01..7e435ac92 100644
--- a/test/functional/issue_categories_controller_test.rb
+++ b/test/functional/issue_categories_controller_test.rb
@@ -216,4 +216,28 @@ class IssueCategoriesControllerTest < Redmine::ControllerTest
     # check that the issue category was nullified
     assert_nil issue.reload.category_id
   end
+  
+  def test_archive_unarchive
+    assert_no_difference 'IssueCategory.count' do
+      put(
+        :archive,
+        :params => {
+          :id => 2,
+        }
+      )
+    end
+    assert_redirected_to '/projects/ecookbook/settings/categories'
+    assert_equal true, IssueCategory.find(2).archived
+    
+    assert_no_difference 'IssueCategory.count' do
+          put(
+            :unarchive,
+            :params => {
+              :id => 2,
+            }
+          )
+    end
+    assert_redirected_to '/projects/ecookbook/settings/categories'
+    assert_equal false, IssueCategory.find(2).archived
+  end
 end
diff --git a/test/unit/issue_test.rb b/test/unit/issue_test.rb
index e298f4d68..2b5fb341d 100644
--- a/test/unit/issue_test.rb
+++ b/test/unit/issue_test.rb
@@ -3406,4 +3406,34 @@ class IssueTest < ActiveSupport::TestCase
 
     assert_equal [5], issue2.filter_projects_scope('').ids.sort
   end
+  
+  def test_issue_categories_archived
+    issue = Issue.new(:project_id => 1, :tracker_id => 1, :author_id => 1, :subject => 'Default')
+    assert_save issue
+    
+    project = issue.project
+    
+    assert_nil issue.category_id
+    assert_nil issue.category
+    assert_equal 1, project.id
+    assert_equal 2, project.issue_categories.size  
+    assert_equal 2, project.active_issue_categories.size
+    assert_equal 2, issue.assignable_issue_categories.size
+    
+    category = project.issue_categories.first
+    category.archived = true    
+    
+    assert_equal 2, project.issue_categories.size  
+    assert_equal 1, project.active_issue_categories.size
+    assert_equal 1, issue.assignable_issue_categories.size
+    assert_not_equal category, issue.assignable_issue_categories.first
+    
+    issue.category = category
+    assert_equal 1, project.active_issue_categories.size
+    assert_equal 2, issue.assignable_issue_categories.size
+    
+    category.archived = false
+    assert_equal 2, project.active_issue_categories.size
+    assert_equal 2, issue.assignable_issue_categories.size
+  end
 end
diff --git a/test/unit/project_test.rb b/test/unit/project_test.rb
index 7a0e9934f..2caece627 100644
--- a/test/unit/project_test.rb
+++ b/test/unit/project_test.rb
@@ -1127,4 +1127,24 @@ class ProjectTest < ActiveSupport::TestCase
     assert_equal 'valuea', project.custom_field_value(cf1)
     assert_nil project.custom_field_value(cf2)
   end
+  
+  def test_issue_categories_archived
+    project = Project.find(1)
+    assert_equal 2, project.issue_categories.size
+    assert_equal 2, project.active_issue_categories.size
+    
+    project.issue_categories.each do |cat|
+      cat.archived = true
+    end
+    
+    assert_equal 2, project.issue_categories.size
+    assert_equal 0, project.active_issue_categories.size
+    
+    project.issue_categories.each do |cat|
+      cat.archived = false
+    end
+    
+    assert_equal 2, project.issue_categories.size
+    assert_equal 2, project.active_issue_categories.size
+  end
 end
-- 
2.31.1