Code maintenance/53379 separate filtering from projections in queries

app/components/projects/column_header_component.rb

@@ -0,0 +1,92 @@
+# frozen_string_literal: true
+
+# -- copyright
+# OpenProject is an open source project management software.
+# Copyright (C) 2010-2024 the OpenProject GmbH
+#
+# This program is free software; you can redistribute it and/or
+# modify it under the terms of the GNU General Public License version 3.
+#
+# OpenProject is a fork of ChiliProject, which is a fork of Redmine. The copyright follows:
+# Copyright (C) 2006-2013 Jean-Philippe Lang
+# Copyright (C) 2010-2013 the ChiliProject Team
+#
+# This program is free software; you can redistribute it and/or
+# modify it under the terms of the GNU General Public License
+# as published by the Free Software Foundation; either version 2
+# of the License, or (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+#
+# See COPYRIGHT and LICENSE files for more details.
+# ++
+
+class Projects::ColumnHeaderComponent < Tables::ColumnHeaderComponent
+  def column_caption
+    if lft_column?(column)
+      helpers.op_icon("icon-hierarchy")
+    elsif favored_column?(column)
+      render(Primer::Beta::Octicon.new(icon: "star-fill", color: :subtle, ml: 2, "aria-label": I18n.t(:label_favorite)))
+    else
+      super
+    end
+  end
+
+  def sort_class(column)
+    order = order_string(column)
+
+    order.nil? ? nil : "sort #{order}"
+  end
+
+  def header_options(column)
+    options = super
+
+    if lft_column?(column)
+      options[:id] = "project-table--hierarchy-header"
+    end
+
+    options
+  end
+
+  def sort_header_outer_classes(column)
+    if lft_column?(column)
+      "generic-table--sort-header-outer_no-highlighting"
+    elsif favored_column?(column)
+      "generic-table--header_centered generic-table--header_no-min-width"
+    else
+      super
+    end
+  end
+
+  def sort_link_title(column)
+    if lft_column?(column)
+      t(:label_sort_by, value: %("#{t(:label_project_hierarchy)}"))
+    else
+      super
+    end
+  end
+
+  def sortable_column?(column)
+    (lft_column?(column) && !sorted_by_lft?) ||
+      (!lft_column?(column) && super)
+  end
+
+  def sorted_by_lft?
+    first_order_by&.attribute == :lft
+  end
+
+  def lft_column?(column)
+    column.attribute == :lft
+  end
+
+  def favored_column?(column)
+    column.attribute == :favored
+  end
+end

app/components/projects/row_component.rb

@@ -39,8 +39,8 @@ def level
       model.last
     end
 
-    # Hierarchy cell is just a placeholder
-    def hierarchy
+    # lft (hierarchy) cell is just a placeholder
+    def lft
       ""
     end
 

app/components/projects/table_component.rb

@@ -29,114 +29,31 @@
 #++
 
 module Projects
-  class TableComponent < ::TableComponent
-    options :params # We read collapsed state from params
-    options :current_user # adds this option to those of the base class
-    options :query
-
-    def initialize(**)
-      super(rows: [], **)
-    end
-
-    def before_render
-      @model = projects(query)
-      super
-    end
-
-    def initial_sort
-      %i[lft asc]
-    end
-
-    def table_id
-      "project-table"
-    end
-
-    def container_class
-      "generic-table--container_visible-overflow generic-table--container_height-100"
-    end
-
-    ##
-    # The project sort by is handled differently
-    def build_sort_header(column, options)
-      helpers.projects_sort_header_tag(column, **options, param: :json)
-    end
-
-    # We don't return the project row
-    # but the [project, level] array from the helper
-    def rows
-      @rows ||= begin
-        projects_enumerator = ->(model) { to_enum(:projects_with_levels_order_sensitive, model).to_a }
-        instance_exec(model, &projects_enumerator)
-      end
-    end
-
-    def initialize_sorted_model
-      helpers.sort_clear
-
-      orders = query.orders.select(&:valid?).map { |o| [o.attribute.to_s, o.direction.to_s] }
-      helpers.sort_init orders
-      helpers.sort_update orders.map(&:first)
-    end
-
-    def paginated?
-      true
-    end
-
-    def pagination_options
-      default_pagination_options.merge(optional_pagination_options)
-    end
-
-    def default_pagination_options
-      { allowed_params: %i[query_id filters columns sortBy] }
-    end
-
-    def optional_pagination_options
-      {}
-    end
-
-    def deactivate_class_on_lft_sort
-      if sorted_by_lft?
-        "spot-link_inactive"
-      end
-    end
-
-    def href_only_when_not_sort_lft
-      unless sorted_by_lft?
-        projects_path(
-          sortBy: JSON.dump([%w[lft asc]]),
-          **helpers.projects_query_params.slice(*helpers.projects_query_param_names_for_sort)
-        )
-      end
-    end
-
-    def order_options(select)
-      {
-        caption: select.caption
-      }
-    end
-
-    def sortable_column?(select)
-      sortable? && query.known_order?(select.attribute)
-    end
+  class TableComponent < Tables::QueryComponent
+    self.eager_load = :enabled_modules
 
     def columns
       @columns ||= begin
-        columns = query.selects.reject { |select| select.is_a?(::Queries::Selects::NotExistingSelect) }
+        columns = super
 
         index = columns.index { |column| column.attribute == :name }
-        columns.insert(index, ::Queries::Projects::Selects::Default.new(:hierarchy)) if index
+        columns.insert(index, ::Queries::Projects::Selects::Default.new(:lft)) if index
 
         columns
       end
     end
 
-    def projects(query)
-      query
-        .results
-        .with_required_storage
-        .with_latest_activity
-        .includes(:custom_values, :enabled_modules)
-        .paginate(page: helpers.page_param(params), per_page: helpers.per_page_param(params))
+    def highlight_column?(column)
+      return false if column.attribute == :lft
+
+      super
+    end
+
+    # We don't return the project row
+    # but the [project, level] array from the helper
+    def render_rows
+      render(Projects::RowComponent.with_collection(to_enum(:projects_with_levels_order_sensitive, rows).to_a,
+                                                    table: self))
     end
 
     def projects_with_levels_order_sensitive(projects, &)

app/components/row_component.rb

@@ -45,15 +45,19 @@ def row
   end
 
   def column_value(column)
-    send(column)
+    if column.respond_to?(:attribute)
+      send(column.attribute)
+    else
+      send(column)
+    end
   end
 
   def column_css_class(column)
     column_css_classes[column]
   end
 
   def column_css_classes
-    @column_css_classes ||= columns.to_h { |name| [name, name] }
+    @column_css_classes ||= columns.index_with { |column| column.respond_to?(:attribute) ? column.attribute : column }
   end
 
   def button_links

app/components/table_component.rb

@@ -74,7 +74,7 @@ def add_column(name)
     end
 
     def row_class
-      mod = name.split("::")[0..-2].join("::").presence || "Table"
+      mod = name.deconstantize
 
       "#{mod}::RowComponent".constantize
     rescue NameError

app/components/tables/column_header_component.html.erb

@@ -0,0 +1 @@
+<%= column_header %>