Extract project query for admins to a separate ProjectAdminQuery model (#42352).

Patch by Holger Just (user:hjust).

git-svn-id: https://svn.redmine.org/redmine/trunk@23531 e93f8b46-1217-0410-a6f0-8f06a7374b81

app/controllers/admin_controller.rb

@@ -36,9 +36,7 @@ class AdminController < ApplicationController
   end
 
   def projects
-    retrieve_query(ProjectQuery, false, :defaults => @default_columns_names)
-    @query.admin_projects = 1
-
+    retrieve_query(ProjectAdminQuery, false, :defaults => @default_columns_names)
     @entry_count = @query.result_count
     @entry_pages = Paginator.new @entry_count, per_page_option, params['page']
     @projects = @query.results_scope(:limit => @entry_pages.per_page, :offset => @entry_pages.offset).to_a

app/controllers/queries_controller.rb

@@ -64,7 +64,7 @@ class QueriesController < ApplicationController
 
     if @query.save
       flash[:notice] = l(:notice_successful_create)
-      redirect_to_items(:query_id => @query, :admin_projects => params[:admin_projects])
+      redirect_to_items(:query_id => @query)
     else
       render :action => 'new', :layout => !request.xhr?
     end
@@ -78,7 +78,7 @@ class QueriesController < ApplicationController
 
     if @query.save
       flash[:notice] = l(:notice_successful_update)
-      redirect_to_items(:query_id => @query, :admin_projects => params[:admin_projects])
+      redirect_to_items(:query_id => @query)
     else
       render :action => 'edit'
     end
@@ -122,7 +122,6 @@ class QueriesController < ApplicationController
 
   def find_query
     @query = Query.find(params[:id])
-    @query.admin_projects = params[:admin_projects] if @query.is_a?(ProjectQuery)
     @project = @query.project
     render_403 unless @query.editable_by?(User.current)
   rescue ActiveRecord::RecordNotFound
@@ -173,11 +172,11 @@ class QueriesController < ApplicationController
   end
 
   def redirect_to_project_query(options)
-    if params[:admin_projects]
-      redirect_to admin_projects_path(options)
-    else
-      redirect_to projects_path(options)
-    end
+    redirect_to projects_path(options)
+  end
+
+  def redirect_to_project_admin_query(options)
+    redirect_to admin_projects_path(options)
   end
 
   def redirect_to_user_query(options)

app/helpers/queries_helper.rb

@@ -480,8 +480,6 @@ module QueriesHelper
     url_params =
       if controller_name == 'issues'
         {:controller => 'issues', :action => 'index', :project_id => @project}
-      elsif controller_name == 'admin' && action_name == 'projects'
-        {:admin_projects => '1'}
       else
         {}
       end

app/models/project_query.rb

@@ -18,8 +18,6 @@
 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 
 class ProjectQuery < Query
-  attr_accessor :admin_projects
-
   self.queried_class = Project
   self.view_permission = :search_project
 
@@ -28,6 +26,13 @@ class ProjectQuery < Query
     errors.add(:project_id, :exclusion) if query.project_id.present?
   end
 
+  # Inheriting ProjectAdminQuery from ProjectQuery introduces the problem that
+  # ProjectQuery.visible also yields ProjectAdminQueries, as
+  # well. We fix that by adding a condition on the actual class name.
+  def self.visible(*)
+    super.where type: name
+  end
+
   self.available_columns = [
     QueryColumn.new(:name, :sortable => "#{Project.table_name}.name"),
     QueryColumn.new(:status, :sortable => "#{Project.table_name}.status"),
@@ -83,12 +88,6 @@ class ProjectQuery < Query
     add_custom_fields_filters(project_custom_fields)
   end
 
-  def build_from_params(params, defaults={})
-    query = super
-    query.admin_projects = params[:admin_projects]
-    query
-  end
-
   def available_columns
     return @available_columns if @available_columns
 
@@ -99,28 +98,7 @@ class ProjectQuery < Query
   end
 
   def available_display_types
-    if self.admin_projects
-      ['list']
-    else
-      ['board', 'list']
-    end
-  end
-
-  def display_type
-    if self.admin_projects
-      'list'
-    else
-      super
-    end
-  end
-
-  def project_statuses_values
-    values = super
-    if self.admin_projects
-      values << [l(:project_status_archived), Project::STATUS_ARCHIVED.to_s]
-      values << [l(:project_status_scheduled_for_deletion), Project::STATUS_SCHEDULED_FOR_DELETION.to_s]
-    end
-    values
+    ['board', 'list']
   end
 
   def default_columns_names
@@ -136,11 +114,7 @@ class ProjectQuery < Query
   end
 
   def base_scope
-    if self.admin_projects
-      Project.where(statement)
-    else
-      Project.visible.where(statement)
-    end
+    Project.visible.where(statement)
   end
 
   # Returns the project count
@@ -174,8 +148,4 @@ class ProjectQuery < Query
 
     scope
   end
-
-  def layout
-    admin_projects ? 'admin' : super
-  end
 end

app/models/query.rb

@@ -1006,7 +1006,7 @@ class Query < ApplicationRecord
         end
       end
 
-      if field == 'project_id' || (self.type == 'ProjectQuery' && %w[id parent_id].include?(field))
+      if field == 'project_id' || (is_a?(ProjectQuery) && %w[id parent_id].include?(field))
         if v.delete('mine')
           v += User.current.memberships.pluck(:project_id).map(&:to_s)
         end

app/views/admin/projects.html.erb

@@ -6,7 +6,6 @@
 <%= @query.persisted? && @query.description.present? ? content_tag('p', @query.description, class: 'subtitle') : '' %>
 
 <%= form_tag(admin_projects_path(@project, nil), :method => :get, :id => 'query_form') do %>
-<%= hidden_field_tag 'admin_projects', '1' %>
 <%= render :partial => 'queries/query_form' %>
 <% end %>
 
@@ -19,5 +18,6 @@
 <% end %>
 
 <% content_for :sidebar do %>
-  <%= render :partial => 'projects/sidebar' %>
+  <%= render_sidebar_queries(ProjectAdminQuery, @project) %>
+  <%= call_hook(:view_admin_projects_sidebar_queries_bottom) %>
 <% end %>

app/views/queries/_form.html.erb

@@ -4,7 +4,6 @@
 <div class="tabular">
 <%= hidden_field_tag 'gantt', '1' if params[:gantt] %>
 <%= hidden_field_tag 'calendar', '1' if params[:calendar] %>
-<%= hidden_field_tag 'admin_projects', '1' if params[:admin_projects] %>
 
 <p>
   <label for="query_name">
@@ -21,7 +20,7 @@
 <p><label><%=l(:field_visible)%></label>
   <label class="block"><%= radio_button 'query', 'visibility', Query::VISIBILITY_PRIVATE %> <%= l(:label_visibility_private) %></label>
   <label class="block"><%= radio_button 'query', 'visibility', Query::VISIBILITY_PUBLIC %> <%= l(:label_visibility_public) %></label>
-  <% unless @query.type == 'ProjectQuery' %>
+  <% unless @query.is_a?(ProjectQuery) %>
     <label class="block"><%= radio_button 'query', 'visibility', Query::VISIBILITY_ROLES %> <%= l(:label_visibility_roles) %>:</label>
       <% Role.givable.sorted.each do |role| %>
         <label class="block role-visibility"><%= check_box_tag 'query[role_ids][]', role.id, @query.roles.include?(role), :id => nil %> <%= role.name %></label>
@@ -31,7 +30,7 @@
 </p>
 <% end %>
 
-<% unless @query.type == 'ProjectQuery' %>
+<% unless @query.is_a?(ProjectQuery) %>
   <p><label for="query_is_for_all"><%=l(:field_is_for_all)%></label>
   <%= check_box_tag 'query_is_for_all', 1, @query.project.nil?, :class => (User.current.admin? ? '' : 'disable-unless-private') %></p>
 <% end %>

app/views/queries/_query_form.html.erb

@@ -69,9 +69,8 @@
     <% end %>
   <% else %>
     <% if @query.editable_by?(User.current) %>
-      <% redirect_params = (controller_name == 'admin' && action_name == 'projects') ? {:admin_projects => 1} : {} %>
-      <%= link_to sprite_icon('edit', l(:button_edit_object, object_name: l(:label_query)).capitalize), edit_query_path(@query, redirect_params), :class => 'icon icon-edit' %>
-      <%= delete_link query_path(@query, redirect_params), {}, l(:button_delete_object, object_name: l(:label_query)).capitalize %>
+      <%= link_to sprite_icon('edit', l(:button_edit_object, object_name: l(:label_query)).capitalize), edit_query_path(@query), :class => 'icon icon-edit' %>
+      <%= delete_link query_path(@query), {}, l(:button_delete_object, object_name: l(:label_query)).capitalize %>
     <% end %>
   <% end %>
 </p>

test/functional/queries_controller_test.rb

@@ -600,11 +600,11 @@ class QueriesControllerTest < Redmine::ControllerTest
   def test_create_admin_projects_query_should_redirect_to_admin_projects
     @request.session[:user_id] = 1
 
-    q = new_record(ProjectQuery) do
+    q = new_record(ProjectAdminQuery) do
       post(
         :create,
         :params => {
-          :type => 'ProjectQuery',
+          :type => 'ProjectAdminQuery',
           :default_columns => '1',
           :f => ["status"],
           :op => {
@@ -615,13 +615,12 @@ class QueriesControllerTest < Redmine::ControllerTest
           },
           :query => {
             "name" => "test_new_project_public_query", "visibility" => "2"
-          },
-          :admin_projects => 1
+          }
         }
       )
     end
 
-    assert_redirected_to :controller => 'admin', :action => 'projects', :query_id => q.id, :admin_projects => 1
+    assert_redirected_to :controller => 'admin', :action => 'projects', :query_id => q.id
   end
 
   def test_edit_global_public_query
@@ -738,7 +737,7 @@ class QueriesControllerTest < Redmine::ControllerTest
   end
 
   def test_update_admin_projects_query
-    q = ProjectQuery.create(:name => 'project_query')
+    q = ProjectAdminQuery.create(:name => 'project_query')
     @request.session[:user_id] = 1
 
     put(
@@ -755,12 +754,11 @@ class QueriesControllerTest < Redmine::ControllerTest
         },
         :query => {
           "name" => "test_project_query_updated", "visibility" => "2"
-        },
-        :admin_projects => 1
+        }
       }
     )
 
-    assert_redirected_to :controller => 'admin', :action => 'projects', :query_id => q.id, :admin_projects => 1
+    assert_redirected_to :controller => 'admin', :action => 'projects', :query_id => q.id
     assert Query.find_by_name('test_project_query_updated')
   end
 

test/unit/project_query_test.rb

@@ -56,16 +56,9 @@ class ProjectQueryTest < ActiveSupport::TestCase
 
   def test_available_display_types_should_returns_bord_and_list
     query = ProjectQuery.new
-    query.admin_projects = nil
     assert_equal ['board', 'list'], query.available_display_types
   end
 
-  def test_available_display_types_should_always_returns_list_when_admin_projects_is_set
-    query = ProjectQuery.new
-    query.admin_projects = 1
-    assert_equal ['list'], query.available_display_types
-  end
-
   def test_display_type_default_should_equal_with_setting_project_list_display_type
     ProjectQuery.new.available_display_types.each do |t|
       with_settings :project_list_display_type => t do
@@ -81,8 +74,10 @@ class ProjectQueryTest < ActiveSupport::TestCase
     user_query = ProjectQuery.find(12)
     user_query.update(visibility: Query::VISIBILITY_PUBLIC)
 
-    [nil, user, User.anonymous].each do |u|
-      assert_nil IssueQuery.default(user: u)
+    with_settings :default_project_query => nil do
+      [nil, user, User.anonymous].each do |u|
+        assert_nil ProjectQuery.default(user: u)
+      end
     end
 
     # only global default is set
@@ -110,38 +105,17 @@ class ProjectQueryTest < ActiveSupport::TestCase
     assert_nil ProjectQuery.default
   end
 
-  def test_display_type_should_returns_list_when_admin_projects_is_set
-    q = ProjectQuery.new
-    q.admin_projects = 1
-    assert_equal 'list', q.display_type
-  end
-
   def test_project_statuses_values_should_equal_ancestors_return
     ancestor = Query.new
     q = ProjectQuery.new
     assert_equal ancestor.project_statuses_values, q.project_statuses_values
   end
 
-  def test_project_statuses_values_should_includes_project_status_archeved_when_admin_projects_is_set
-    q = ProjectQuery.new
-    q.admin_projects = 1
-    assert_includes q.project_statuses_values, [l(:project_status_archived), Project::STATUS_ARCHIVED.to_s]
-    Query.new.project_statuses_values.each do |status|
-      assert_includes q.project_statuses_values, status
-    end
-  end
-
   def test_base_scope_should_return_visible_projects
     q = ProjectQuery.new
     assert_equal Project.visible, q.base_scope
   end
 
-  def test_base_scope_should_return_all_projects_when_admin_projects_is_set
-    q = ProjectQuery.new
-    q.admin_projects = 1
-    assert_equal Project.all, q.base_scope
-  end
-
   def test_results_scope_has_last_activity_date
     q = ProjectQuery.generate!(column_names: [:last_activity_date])
     result_projects = q.results_scope({})