TAN-3586 Add matrix field

back/app/controllers/web_api/v1/custom_field_matrix_statements_controller.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+class WebApi::V1::CustomFieldMatrixStatementsController < ApplicationController
+  before_action :set_statement, only: %i[show]
+  before_action :set_custom_field, only: %i[index]
+  skip_before_action :authenticate_user
+
+  def index
+    @statements = policy_scope(CustomFieldMatrixStatement).where(custom_field: @custom_field).order(:ordering)
+    render json: WebApi::V1::CustomFieldMatrixStatementSerializer.new(@statements, params: jsonapi_serializer_params).serializable_hash
+  end
+
+  def show
+    render json: WebApi::V1::CustomFieldMatrixStatementSerializer.new(@statement, params: jsonapi_serializer_params).serializable_hash
+  end
+
+  private
+
+  def set_custom_field
+    @custom_field = CustomField.find(params[:custom_field_id])
+  end
+
+  def set_statement
+    @statement = CustomFieldMatrixStatement.find(params[:id])
+    authorize @statement
+  end
+end

back/app/models/custom_field.rb

@@ -48,6 +48,7 @@ class CustomField < ApplicationRecord
   acts_as_list column: :ordering, top_of_list: 0, scope: [:resource_id]
 
   has_many :options, -> { order(:ordering) }, dependent: :destroy, class_name: 'CustomFieldOption', inverse_of: :custom_field
+  has_many :matrix_statements, -> { order(:ordering) }, dependent: :destroy, class_name: 'CustomFieldMatrixStatement', inverse_of: :custom_field
   has_many :text_images, as: :imageable, dependent: :destroy
   accepts_nested_attributes_for :text_images
 
@@ -59,7 +60,7 @@ class CustomField < ApplicationRecord
   INPUT_TYPES = %w[
     checkbox date file_upload files html html_multiloc image_files linear_scale multiline_text multiline_text_multiloc
     multiselect multiselect_image number page point line polygon select select_image shapefile_upload text text_multiloc
-    topic_ids section cosponsor_ids ranking
+    topic_ids section cosponsor_ids ranking matrix_linear_scale
   ].freeze
   CODES = %w[
     author_id birthyear body_multiloc budget domicile gender idea_files_attributes idea_images_attributes
@@ -125,6 +126,20 @@ def supports_xlsx_export?
     %w[page section].exclude?(input_type)
   end
 
+  def supports_geojson?
+    return false if code == 'idea_images_attributes' # Is this still applicable?
+
+    %w[page section].exclude?(input_type)
+  end
+
+  def supports_linear_scale?
+    %w[linear_scale matrix_linear_scale].include?(input_type)
+  end
+
+  def supports_matrix_statements?
+    input_type == 'matrix_linear_scale'
+  end
+
   def average_rankings(scope)
     # This basically starts from all combinations of scope ID, option key (value)
     # and position (ordinality) and then calculates the average position for each
@@ -338,7 +353,7 @@ def generate_key
     title = title_multiloc.values.first
     return unless title
 
-    self.key = CustomFieldService.new.generate_key(title, false) do |key_proposal|
+    self.key = CustomFieldService.new.generate_key(title) do |key_proposal|
       self.class.find_by(key: key_proposal, resource_type: resource_type)
     end
   end

back/app/models/custom_field_matrix_statement.rb

@@ -0,0 +1,42 @@
+# == Schema Information
+#
+# Table name: custom_field_matrix_statements
+#
+#  id              :uuid             not null, primary key
+#  custom_field_id :uuid             not null
+#  title_multiloc  :jsonb            not null
+#  key             :string           not null
+#  ordering        :integer          not null
+#  created_at      :datetime         not null
+#  updated_at      :datetime         not null
+#
+# Indexes
+#
+#  index_custom_field_matrix_statements_on_custom_field_id  (custom_field_id)
+#  index_custom_field_matrix_statements_on_key              (key)
+#
+# Foreign Keys
+#
+#  fk_rails_...  (custom_field_id => custom_fields.id)
+#
+class CustomFieldMatrixStatement < ApplicationRecord
+  # non-persisted attribute to enable form copying
+  attribute :temp_id, :string, default: nil
+
+  belongs_to :custom_field
+
+  before_validation :generate_key, on: :create
+  acts_as_list column: :ordering, top_of_list: 0, scope: :custom_field
+
+  validates :title_multiloc, presence: true, multiloc: { presence: true }
+  validates :key, presence: true, uniqueness: { scope: [:custom_field_id] },
+    format: { with: /\A[\w-]+\z/ } # Can only consist of word characters or dashes
+  validates :custom_field, presence: true
+
+  private
+
+  def generate_key
+    title = title_multiloc.values.first
+    self.key ||= title && CustomFieldService.new.generate_key(title)
+  end
+end

back/app/models/custom_field_option.rb

@@ -76,7 +76,7 @@ def generate_key
     title = title_multiloc.values.first
     return unless title
 
-    self.key = CustomFieldService.new.generate_key(title, other) do |key_proposal|
+    self.key = CustomFieldService.new.generate_key(title, other_option: other) do |key_proposal|
       self.class.find_by(key: key_proposal, custom_field: custom_field)
     end
   end

back/app/policies/custom_field_matrix_statement_policy.rb

@@ -0,0 +1,11 @@
+class CustomFieldMatrixStatementPolicy < ApplicationPolicy
+  class Scope < ApplicationPolicy::Scope
+    def resolve
+      scope
+    end
+  end
+
+  def show?
+    true
+  end
+end

back/app/serializers/web_api/v1/custom_field_matrix_statement_serializer.rb

@@ -0,0 +1,7 @@
+class WebApi::V1::CustomFieldMatrixStatementSerializer < WebApi::V1::BaseSerializer
+  attributes :key, :title_multiloc, :ordering, :created_at, :updated_at
+
+  attribute :temp_id, if: proc { |object|
+    object.temp_id.present?
+  }
+end

back/app/serializers/web_api/v1/custom_field_serializer.rb

@@ -40,13 +40,16 @@ class WebApi::V1::CustomFieldSerializer < WebApi::V1::BaseSerializer
     :linear_scale_label_5_multiloc,
     :linear_scale_label_6_multiloc,
     :linear_scale_label_7_multiloc,
-    if: proc { |object, _params| object.linear_scale? }
+    if: proc { |object, _params| object.supports_linear_scale? }
 
   attributes :select_count_enabled, :maximum_select_count, :minimum_select_count, if: proc { |object, _params|
     object.multiselect?
   }
 
   has_many :options, record_type: :custom_field_option, serializer: ::WebApi::V1::CustomFieldOptionSerializer
+  has_many :matrix_statements, record_type: :custom_field_matrix_statement, serializer: ::WebApi::V1::CustomFieldMatrixStatementSerializer, if: proc { |field|
+    field.supports_matrix_statements?
+  }
   has_one :resource, record_type: :custom_form, serializer: ::WebApi::V1::CustomFormSerializer
 end
 

back/app/services/custom_field_params_service.rb

@@ -57,6 +57,8 @@ def supported_keys_in_custom_field_values(custom_field)
       %i[id content name]
     when 'html_multiloc', 'multiline_text_multiloc', 'text_multiloc'
       CL2_SUPPORTED_LOCALES
+    when 'matrix_linear_scale'
+      custom_field.matrix_statements.pluck(:key).map(&:to_sym)
     end
   end
 

back/app/services/custom_field_service.rb

@@ -75,8 +75,8 @@ def fields_to_ui_schema(fields, locale = 'en')
     end
   end
 
-  def generate_key(title, other)
-    return 'other' if other == true
+  def generate_key(title, other_option: false)
+    return 'other' if other_option == true
 
     keyify(title)
   end

back/app/services/export/geojson/geojson_generator.rb

@@ -10,7 +10,7 @@ def initialize(phase, field)
         @phase = phase
         @field = field
         @inputs = phase.ideas.native_survey.published
-        @fields_in_form = IdeaCustomFieldsService.new(phase.custom_form).all_fields.filter(&:supports_xlsx_export?)
+        @fields_in_form = IdeaCustomFieldsService.new(phase.custom_form).geojson_supported_fields
         @multiloc_service = MultilocService.new(app_configuration: @app_configuration)
         @value_visitor = Geojson::ValueVisitor
       end

back/app/services/export/xlsx/input_sheet_generator.rb

@@ -73,6 +73,13 @@ def longitude_report_field
         ComputedFieldForReport.new(column_header_for('longitude'), ->(input) { input.location_point&.coordinates&.first })
       end
 
+      def matrix_statement_report_field(statement)
+        ComputedFieldForReport.new(
+          multiloc_service.t(statement.title_multiloc),
+          ->(input) { input.custom_field_values.dig(statement.custom_field.key, statement.key) }
+        )
+      end
+
       def created_at_report_field
         ComputedFieldForReport.new(column_header_for('created_at'), ->(input) { input.created_at })
       end
@@ -144,6 +151,12 @@ def input_report_fields
               input_fields << latitude_report_field
               input_fields << longitude_report_field
             end
+            if field.input_type == 'matrix_linear_scale'
+              field.matrix_statements.each do |statement|
+                input_fields << matrix_statement_report_field(statement)
+              end
+              next
+            end
             input_fields << Export::CustomFieldForExport.new(field, @value_visitor)
             input_fields << Export::CustomFieldForExport.new(field.other_option_text_field, @value_visitor) if field.other_option_text_field
           end

back/app/services/field_visitor_service.rb

@@ -81,6 +81,10 @@ def visit_linear_scale(field)
     default(field)
   end
 
+  def visit_matrix_linear_scale(field)
+    default(field)
+  end
+
   def visit_file_upload(field)
     default(field)
   end

back/app/services/idea_custom_fields_service.rb

@@ -40,13 +40,13 @@ def submittable_fields_with_other_options
 
   # Used in the printable PDF export
   def printable_fields
-    ignore_field_types = %w[section page date files image_files point file_upload shapefile_upload topic_ids cosponsor_ids ranking]
+    ignore_field_types = %w[section page date files image_files point file_upload shapefile_upload topic_ids cosponsor_ids ranking matrix_linear_scale]
     fields = enabled_fields.reject { |field| ignore_field_types.include? field.input_type }
     insert_other_option_text_fields(fields)
   end
 
   def importable_fields
-    ignore_field_types = %w[page section date files image_files file_upload shapefile_upload point line polygon cosponsor_ids ranking]
+    ignore_field_types = %w[page section date files image_files file_upload shapefile_upload point line polygon cosponsor_ids ranking matrix_linear_scale]
     enabled_fields_with_other_options.reject { |field| ignore_field_types.include? field.input_type }
   end
 
@@ -141,6 +141,13 @@ def duplicate_all_fields
       end
       copied_field.options = copied_options
 
+      # Duplicate statements
+      copied_field.matrix_statements = field.matrix_statements.map do |statement|
+        copied_statement = statement.dup
+        copied_statement.id = SecureRandom.uuid
+        copied_statement
+      end
+
       # Duplicate and persist map config for custom_fields that can have an associated map_config
       if CustomField::MAP_CONFIG_INPUT_TYPES.include?(copied_field.input_type) && field.map_config
         original_map_config = CustomMaps::MapConfig.find(field.map_config.id)

back/app/services/json_schema_generator_service.rb

@@ -283,6 +283,21 @@ def visit_shapefile_upload(field)
     visit_file_upload(field)
   end
 
+  def visit_matrix_linear_scale(field)
+    {
+      type: 'object',
+      minProperties: (field.required ? field.matrix_statement_ids.size : 0),
+      maxProperties: field.matrix_statement_ids.size,
+      properties: field.matrix_statements.pluck(:key).map(&:to_sym).index_with do
+        {
+          type: 'number',
+          minimum: 1,
+          maximum: field.maximum
+        }
+      end
+    }
+  end
+
   private
 
   attr_reader :locales, :multiloc_service

back/app/services/side_fx_custom_field_matrix_statement_service.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+class SideFxCustomFieldMatrixStatementService
+  include SideFxHelper
+
+  def after_create(statement, current_user)
+    LogActivityJob.perform_later(statement, 'created', current_user, statement.created_at.to_i)
+  end
+
+  def after_update(statement, current_user)
+    LogActivityJob.perform_later(statement, 'changed', current_user, statement.updated_at.to_i)
+  end
+
+  def after_destroy(frozen_statement, current_user)
+    serialized_statement = clean_time_attributes(frozen_statement.attributes)
+    LogActivityJob.perform_later(
+      encode_frozen_resource(frozen_statement),
+      'deleted',
+      current_user,
+      Time.now.to_i,
+      payload: { custom_field_matrix_statement: serialized_statement }
+    )
+  end
+end