[#68700] replace score with weight

- add migration for db column name
- update AR relations in code
- update display texts and locale keys
- update test, method, class, variable names
- fix formatting mistake in item base controller

Author: Kharonus

app/components/admin/custom_fields/hierarchy/item_component.rb

@@ -52,8 +52,8 @@ def short_text
         def secondary_text
           if model.short.present?
             "(#{model.short})"
-          elsif model.score.present?
-            model.score.to_s
+          elsif model.weight.present?
+            model.weight.to_s
           end
         end
 

app/components/admin/custom_fields/hierarchy/item_form_component.rb

@@ -63,7 +63,7 @@ def secondary_input_format
           when "hierarchy"
             :short
           when "weighted_item_list"
-            :score
+            :weight
           else
             raise ArgumentError, "Unsupported field format: #{field_format}"
           end

app/contracts/custom_fields/hierarchy/insert_weighted_item_contract.rb

@@ -34,7 +34,7 @@ class InsertWeightedItemContract < DryApplicationContract
       params do
         required(:parent).filled(type?: CustomField::Hierarchy::Item)
         required(:label).filled(:string)
-        required(:score).filled(:decimal)
+        required(:weight).filled(:decimal)
       end
 
       rule(:parent) do

app/contracts/custom_fields/hierarchy/update_weighted_item_contract.rb

@@ -34,7 +34,7 @@ class UpdateWeightedItemContract < DryApplicationContract
       params do
         required(:item).filled(type?: CustomField::Hierarchy::Item)
         required(:label).filled(:string)
-        required(:score).filled(:decimal)
+        required(:weight).filled(:decimal)
       end
 
       rule(:item) do

app/controllers/admin/custom_fields/hierarchy/items_base_controller.rb

@@ -78,7 +78,7 @@ def update
                          item: @active_item,
                          label: input[:label],
                          short: input[:short],
-                         score: input[:score])
+                         weight: input[:weight])
             .either(
               ->(*) { redirect_to action: :show, id: @active_item.parent, status: :see_other },
               lambda do |validation_result|
@@ -135,7 +135,7 @@ def change_parent_dialog
           )
         end
 
-      private
+        private
 
         def item_service
           ::CustomFields::Hierarchy::HierarchicalItemService.new
@@ -144,7 +144,7 @@ def item_service
         def item_input # rubocop:disable Metrics/AbcSize
           input = { parent: @active_item, label: params[:label] }
           input[:short] = params[:short] if params[:short].present?
-          input[:score] = params[:score] if params[:score].present?
+          input[:weight] = params[:weight] if params[:weight].present?
           input[:sort_order] = params[:sort_order].to_i if params[:sort_order].present?
 
           input
@@ -160,73 +160,69 @@ def create_contract
             ::CustomFields::Hierarchy::InsertListItemContract
           when "weighted_item_list"
             ::CustomFields::Hierarchy::InsertWeightedItemContract
-          el se
-            rais e ArgumentError, "unsupported custom field format '#{@custom_field.field_format}'"
-            end
+          else
+            raise ArgumentError, "unsupported custom field format '#{@custom_field.field_format}'"
           end
+        end
 
         def update_contract
           ca se @custom_field.field_format
           wh en "hierarchy"
-            ::CustomFields::Hierarchy::UpdateListItemContract
+          ::CustomFields::Hierarchy::UpdateListItemContract
           wh en "weighted_item_list"
-            ::CustomFields::Hierarchy::UpdateWeightedItemContract
+          ::CustomFields::Hierarchy::UpdateWeightedItemContract
           el se
-            rais e ArgumentError, "unsupported custom field format '#{@custom_field.field_format}'"
-          end
+          rais e ArgumentError, "unsupported custom field format '#{@custom_field.field_format}'"
         end
+      end
 
-        def add_errors_to_fo(rm(validation_resul)t)
-          @new_ite m = ::CustomField::Hierarchy::Item.ne w(**item_input)
-          validation_result.error s(full: true).to_h.each  do |attribute, errors|
-            @new_item.errors.ad d(attribute, errors.joi n(", "
-))
-          end
+      def add_errors_to_form(validation_result)
+        @new_item = ::CustomField::Hierarchy::Item.new(**item_input)
+        validation_result.errors(full: true).to_h.each do |attribute, errors|
+          @new_item.errors.add(attribute, errors.join(", "))
         end
+      end
 
-        def add_errors_to_edit_fo(rm(validation_resul)t)
-          @active_item.assign_attribute s(**validation_result.to_h.slic e(:label, :short, :score))
+      def add_errors_to_edit_form(validation_result)
+        @active_item.assign_attributes(**validation_result.to_h.slice(:label, :short, :weight))
 
-          validation_result.error s(full: true).to_h.each  do |attribute, errors|
-            @active_item.errors.ad d(attribute, errors.join(", "
-))
-          end
+        validation_result.errors(full: true).to_h.each do |attribute, errors|
+          @active_item.errors.add(attribute, errors.join(", "))
         end
+      end
 
-        def parse_parent_inp(ut(new_parent_inpu)t)
-          ca se new_parent_input
-           in[new_parent]
-            inpu t = MultiJson.loa d(new_parent, symbolize_keys: true)[:value]
-            new_paren t = CustomField::Hierarchy::Item.including_children.find_b y(id: input)
+      def parse_parent_input(new_parent_input)
+        case new_parent_input
+        in [new_parent]
+          input = MultiJson.load(new_parent, symbolize_keys: true)[:value]
+          new_parent = CustomField::Hierarchy::Item.including_children.find_by(id: input)
 
-             if new_parent.present?
-              Succes s(new_parent)
-            el se
-              Failur e(I18n. t(:notice_parent_item_not_found))
-            end
-          el se
-            Failur e("Invalid input: #{new_parent_input}")
+          if new_parent.present?
+            Success(new_parent)
+          else
+            Failure(I18n.t(:notice_parent_item_not_found))
           end
+        else
+          Failure("Invalid input: #{new_parent_input}")
         end
+      end
 
-        def find_model_object
-          @objec t = find_custom_field
-          @custom_fiel d = @object
-        end
+      def find_model_object
+        @object = find_custom_field
+        @custom_field = @object
+      end
 
-        def find_custom_field
-          rais e NotImplementedError, "SubclassResponsibility"
-        end
+      def find_custom_field
+        raise NotImplementedError, "SubclassResponsibility"
+      end
 
-        def find_active_item
-          @active_ite m =  if params[:id].present?
-                           CustomField::Hierarchy::Item.including_children.fin d(params[:id])
-                         el se
-                           @object.hierarchy_root
-                         end
-        end
-        end
+      def find_active_item
+        @active_item = if params[:id].present?
+                         CustomField::Hierarchy::Item.including_children.find(params[:id])
+                       else
+                         @object.hierarchy_root
+                       end
       end
-    en
-d
+    end
+  end
 end

app/forms/custom_fields/hierarchy/item_form.rb

@@ -49,8 +49,8 @@ class ItemForm < ApplicationForm
           case @secondary_input_format
           when :short
             short_input_field(input_group)
-          when :score
-            score_input_field(input_group)
+          when :weight
+            weight_input_field(input_group)
           else
             raise ArgumentError, "Unsupported secondary input format: #{secondary_input_format}"
           end
@@ -93,18 +93,18 @@ def short_input_field(form_group)
         )
       end
 
-      def score_input_field(form_group)
+      def weight_input_field(form_group)
         form_group.text_field(
-          name: :score,
-          label: I18n.t("custom_fields.admin.items.placeholder.score"),
+          name: :weight,
+          label: I18n.t("custom_fields.admin.items.placeholder.weight"),
           type: :number,
           step: :any,
-          value: @target_item.score,
+          value: @target_item.weight,
           visually_hide_label: true,
           full_width: false,
           required: true,
-          placeholder: I18n.t("custom_fields.admin.items.placeholder.score"),
-          validation_message: validation_message_for(:score)
+          placeholder: I18n.t("custom_fields.admin.items.placeholder.weight"),
+          validation_message: validation_message_for(:weight)
         )
       end
 

app/models/custom_field.rb

@@ -232,7 +232,7 @@ def cast_value(value)
       value.to_f
     when "user", "version"
       field_format.classify.constantize.find_by(id: value.to_i)
-    when "hierarchy", "scored_list"
+    when "hierarchy", "weighted_item_list"
       CustomField::Hierarchy::Item.find_by(id: value.to_i)
     end
   end

app/models/custom_value/scored_list_strategy.rb renamed to app/models/custom_value/weighted_item_list_strategy.rb

@@ -28,8 +28,8 @@
 # See COPYRIGHT and LICENSE files for more details.
 #++
 
-class CustomValue::ScoredListStrategy < CustomValue::HierarchyStrategy
+class CustomValue::WeightedItemListStrategy < CustomValue::HierarchyStrategy
   def typed_value
-    cached_ar_object&.score
+    cached_ar_object&.weight
   end
 end

app/services/custom_fields/hierarchy/hierarchical_item_service.rb

@@ -50,13 +50,13 @@ def generate_root(custom_field)
       # @param parent [CustomField::Hierarchy::Item] the parent of the node
       # @param label [String] the node label/name that must be unique at the same tree level
       # @param short [String] an alias for the node
-      # @param score [Decimal] a numeric value for the node
+      # @param weight [Decimal] a numeric value for the node
       # @param sort_order [Integer] the position into which insert the item.
       # @return [Success(CustomField::Hierarchy::Item), Failure(Dry::Validation::Result), Failure(ActiveModel::Errors)]
-      def insert_item(contract_class:, parent:, label:, short: nil, score: nil, sort_order: nil)
+      def insert_item(contract_class:, parent:, label:, short: nil, weight: nil, sort_order: nil)
         contract_class
           .new
-          .call({ parent:, label:, short:, score: })
+          .call({ parent:, label:, short:, weight: })
           .to_monad
           .bind { |validation| create_child_item(validation:, sort_order:) }
       end
@@ -67,12 +67,12 @@ def insert_item(contract_class:, parent:, label:, short: nil, score: nil, sort_o
       # @param item [CustomField::Hierarchy::Item] the item to be updated
       # @param label [String] the node label/name that must be unique at the same tree level
       # @param short [String] an alias for the node
-      # @param score [Decimal] a numeric value for the node
+      # @param weight [Decimal] a numeric value for the node
       # @return [Success(CustomField::Hierarchy::Item), Failure(Dry::Validation::Result), Failure(ActiveModel::Errors)]
-      def update_item(contract_class:, item:, label: nil, short: nil, score: nil)
+      def update_item(contract_class:, item:, label: nil, short: nil, weight: nil)
         contract_class
           .new
-          .call({ item:, label:, short:, score: })
+          .call({ item:, label:, short:, weight: })
           .to_monad
           .bind { |attributes| update_item_attributes(item:, attributes:) }
       end
@@ -188,8 +188,8 @@ def create_child_item(validation:, sort_order: nil)
       end
 
       def update_item_attributes(item:, attributes:)
-        if item.update(label: attributes[:label], short: attributes[:short], score: attributes[:score])
-          if item.score_previously_changed?
+        if item.update(label: attributes[:label], short: attributes[:short], weight: attributes[:weight])
+          if item.weight_previously_changed?
             # Only changes to item are of interest, so no need to pass descendant ids
             update_calculated_values_for_hierarchy(item_ids: item.id, custom_field: item.root&.custom_field)
           end

config/initializers/custom_field_format.rb

@@ -95,7 +95,7 @@
                                                      label: :label_weighted_item_list,
                                                      only: %w(Project WorkPackage),
                                                      order: 13,
-                                                     formatter: "CustomValue::ScoredListStrategy")
+                                                     formatter: "CustomValue::WeightedItemListStrategy")
 
   fields.register OpenProject::CustomFieldFormat.new("calculated_value",
                                                      label: :label_calculated_value,