Skip to content

OpenProject is the leading open source project management software for product, project and portfolio management. A powerful Jira alternative with agile planning, issue tracking, roadmaps, Gantt charts, time tracking, collaboration features, and more. Available on premises or in the cloud. ⭐ Star us on GitHub

[#64351] Display calculated values in the project list

Tobias Dillmannacbae269a110
diff --git a/app/models/custom_field/order_statements.rb b/app/models/custom_field/order_statements.rb
index 9e209932b2e..45d02cc493f 100644
--- a/app/models/custom_field/order_statements.rb
+++ b/app/models/custom_field/order_statements.rb
@@ -29,34 +29,27 @@
#++
module CustomField::OrderStatements
+ ORDER_JOIN_METHOD_BY_FIELD_FORMAT = OpenProject::MultiKeyHash.expand(
+ %w[string date bool link] => :join_for_order_by_string_sql,
+ "int" => :join_for_order_by_int_sql,
+ %w[float calculated_value] => :join_for_order_by_float_sql,
+ "list" => :join_for_order_by_list_sql,
+ "user" => :join_for_order_by_user_sql,
+ "version" => :join_for_order_by_version_sql,
+ "hierarchy" => :join_for_order_by_hierarchy_sql
+ ).freeze
+
# Returns the expression to use in ORDER BY clause to sort objects by their
# value of the custom field.
def order_statement
- case field_format
- when "string", "date", "bool", "link", "int", "float", "list", "user", "version", "hierarchy"
- "cf_order_#{id}.value"
- end
+ "cf_order_#{id}.value" if ORDER_JOIN_METHOD_BY_FIELD_FORMAT.key?(field_format)
end
# Returns the join statement that is required to sort objects by their value
# of the custom field.
def order_join_statement
- case field_format
- when "string", "date", "bool", "link"
- join_for_order_by_string_sql
- when "int"
- join_for_order_by_int_sql
- when "float"
- join_for_order_by_float_sql
- when "list"
- join_for_order_by_list_sql
- when "user"
- join_for_order_by_user_sql
- when "version"
- join_for_order_by_version_sql
- when "hierarchy"
- join_for_order_by_hierarchy_sql
- end
+ method_name = ORDER_JOIN_METHOD_BY_FIELD_FORMAT[field_format]
+ send(method_name) if method_name
end
# Returns the ORDER BY option defining order of objects without value for the
diff --git a/app/models/queries/filters/shared/custom_fields/base.rb b/app/models/queries/filters/shared/custom_fields/base.rb
index 8e3cb9ba99a..b92a0bcc031 100644
--- a/app/models/queries/filters/shared/custom_fields/base.rb
+++ b/app/models/queries/filters/shared/custom_fields/base.rb
@@ -83,7 +83,7 @@ module Queries::Filters::Shared
def type
case custom_field.field_format
- when "float"
+ when "float", "calculated_value"
:float
when "int"
:integer
diff --git a/app/models/queries/projects/orders/custom_field_order.rb b/app/models/queries/projects/orders/custom_field_order.rb
index 96dac15c31e..b03ac629772 100644
--- a/app/models/queries/projects/orders/custom_field_order.rb
+++ b/app/models/queries/projects/orders/custom_field_order.rb
@@ -64,12 +64,16 @@ class Queries::Projects::Orders::CustomFieldOrder < Queries::Orders::Base
scope = scope.joins(join_statement)
end
- order_statement = "#{custom_field.order_statement} #{direction}"
+ if (order_statement = custom_field.order_statement)
+ order_statement = "#{order_statement} #{direction}"
- if (null_handling = custom_field.order_null_handling(direction == :asc))
- order_statement = "#{order_statement} #{null_handling}"
+ if (null_handling = custom_field.order_null_handling(direction == :asc))
+ order_statement = "#{order_statement} #{null_handling}"
+ end
+
+ scope = scope.order(Arel.sql(order_statement))
end
- scope.order(Arel.sql(order_statement))
+ scope
end
end
diff --git a/spec/features/projects/lists/columns_spec.rb b/spec/features/projects/lists/columns_spec.rb
index cf737b2209f..76d2917888c 100644
--- a/spec/features/projects/lists/columns_spec.rb
+++ b/spec/features/projects/lists/columns_spec.rb
@@ -53,7 +53,7 @@ RSpec.describe "Projects lists columns", :js, with_settings: { login_required?:
include ProjectStatusHelper
describe "column selection", with_settings: { enabled_projects_columns: %w[name created_at] } do
- # Will still receive the :view_project permission
+ # Will still receive the `view_project` permission
shared_let(:user) do
create(:user, member_with_permissions: { project => %i(view_project_attributes),
development_project => %i(view_project_attributes) })
@@ -400,4 +400,42 @@ RSpec.describe "Projects lists columns", :js, with_settings: { login_required?:
end
end
end
+
+ context "with calculated value columns", with_flag: { calculated_value_project_attribute: true } do
+ let!(:static_calculated_value) do
+ create(:calculated_value_project_custom_field,
+ name: "Calculated value field",
+ formula: "2.4 * 2",
+ projects: [project])
+ end
+
+ let!(:static_int_calculated_value) do
+ create(:calculated_value_project_custom_field,
+ name: "Calculated value int field",
+ formula: "6 / 3",
+ projects: [project])
+ end
+
+ before do
+ login_as(admin)
+
+ project.calculate_custom_fields([static_calculated_value, static_int_calculated_value])
+ project.save!
+
+ projects_page.visit!
+ end
+
+ it "displays calculated value columns" do
+ projects_page.set_columns("Name", static_calculated_value.name, static_int_calculated_value.name)
+
+ projects_page.within_row(project) do
+ expect(page)
+ .to have_css(".name", text: project.name)
+ expect(page)
+ .to have_css(".cf_#{static_calculated_value.id}", text: 4.8)
+ expect(page)
+ .to have_css(".cf_#{static_int_calculated_value.id}", text: 2)
+ end
+ end
+ end
end
diff --git a/spec/features/projects/lists/filters_spec.rb b/spec/features/projects/lists/filters_spec.rb
index 4066ed562b6..8b456a01518 100644
--- a/spec/features/projects/lists/filters_spec.rb
+++ b/spec/features/projects/lists/filters_spec.rb
@@ -37,11 +37,18 @@ RSpec.describe "Projects list filters", :js, with_settings: { login_required?: f
shared_let(:custom_field) { create(:text_project_custom_field) }
shared_let(:invisible_custom_field) { create(:project_custom_field, admin_only: true) }
+ shared_let(:integer_custom_field) { create(:integer_project_custom_field) }
- shared_let(:project) { create(:project, name: "Plain project", identifier: "plain-project") }
+ shared_let(:project) do
+ create(:project, name: "Plain project", identifier: "plain-project") do |project|
+ project.custom_field_values = { integer_custom_field.id => 41 }
+ project.save!
+ end
+ end
shared_let(:public_project) do
create(:project, name: "Public Pr", identifier: "public-pr", public: true) do |project|
- project.custom_field_values = { invisible_custom_field.id => "Secret CF" }
+ project.custom_field_values = { invisible_custom_field.id => "Secret CF", integer_custom_field.id => 42 }
+ project.save!
end
end
shared_let(:development_project) { create(:project, name: "Development project", identifier: "development-project") }
@@ -672,6 +679,43 @@ RSpec.describe "Projects list filters", :js, with_settings: { login_required?: f
end
end
+ context "when filtering via calculated values", with_flag: { calculated_value_project_attribute: true } do
+ let(:projects_with_calculated_value) do
+ [project, public_project]
+ end
+
+ let!(:calculated_value) do
+ create(:calculated_value_project_custom_field,
+ :skip_validations,
+ name: "Calculated value",
+ formula: "1.5 * {{cf_#{integer_custom_field.id}}}",
+ projects: projects_with_calculated_value)
+ end
+
+ let(:filters) do
+ JSON.dump([{ active: { operator: "=", values: ["t"] } },
+ { "cf_#{calculated_value.id}": { operator: ">=", values: ["63"] } }])
+ end
+
+ before do
+ login_as(admin) # permitted user necessary to perform the calculations
+
+ projects_with_calculated_value.each do |proj|
+ proj.calculate_custom_fields([calculated_value])
+ proj.save!
+ end
+
+ Setting.enabled_projects_columns += [calculated_value.column_name]
+ end
+
+ it "allows filtering by the calculated value" do
+ visit "#{projects_page.path}?filters=#{filters}"
+
+ projects_page.expect_projects_not_listed(project, development_project)
+ projects_page.expect_projects_listed(public_project)
+ end
+ end
+
describe "filtering for any lifecycle step" do
context "with the necessary permissions" do
before do
diff --git a/spec/features/projects/lists/order_spec.rb b/spec/features/projects/lists/order_spec.rb
index ec8bc789826..d4772a39c59 100644
--- a/spec/features/projects/lists/order_spec.rb
+++ b/spec/features/projects/lists/order_spec.rb
@@ -273,6 +273,43 @@ RSpec.describe "Projects lists ordering", :js, with_settings: { login_required?:
projects_page.expect_project_at_place(project, 1)
end
+ context "when sorting calculated value custom fields", with_flag: { calculated_value_project_attribute: true } do
+ let(:projects_with_calculated_value) do
+ [project, development_project, public_project, child_project_m, child_project_a]
+ end
+
+ let!(:calculated_value) do
+ create(:calculated_value_project_custom_field,
+ name: "Calculated value",
+ formula: "1 + {{cf_#{integer_custom_field.id}}}",
+ projects: projects_with_calculated_value)
+ end
+
+ before do
+ projects_with_calculated_value.each do |proj|
+ proj.calculate_custom_fields([calculated_value])
+ proj.save!
+ end
+
+ Setting.enabled_projects_columns += [calculated_value.column_name]
+ visit projects_path
+ end
+
+ it "sorts by calculated value custom fields" do
+ projects_page.click_table_header_to_open_action_menu(calculated_value.column_name)
+ projects_page.sort_via_action_menu(calculated_value.column_name, direction: :asc)
+ wait_for_reload
+
+ projects_page
+ .expect_projects_in_order(child_project_z,
+ project,
+ development_project,
+ public_project,
+ child_project_a,
+ child_project_m)
+ end
+ end
+
context "when sorting by project phase" do
let(:stage_def) { create(:project_phase_definition) }
let(:stage) do