forest_admin_datasource_customizer 1.0.0.pre.beta.68 → 1.0.0.pre.beta.70

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eb4ded1e0af9d04763d01c46f38a3badbbf963689a1b1b3160e8b891e0f193bc
-  data.tar.gz: 0bbe747df4a860b4569e8da2e4d794790672e3b797df86ac4bf2e7133fa09756
+  metadata.gz: f034b46ebd5986948532a00416d5035ef436870de4e924f75fe88ff91041faaa
+  data.tar.gz: 22158ab749cfccd936e41bec2f5c6e3277204e75c76ea797b5ec53c72a07f046
 SHA512:
-  metadata.gz: a0556831bfd0cc8cc3c7b3f76eb15cd99d664a5b89f33ba4541eab604efb626c4f3281af486d90683f3ab884318fd390110dc7b1f4fad189dd3bf6caa28ecf29
-  data.tar.gz: e931aa15321451fad8f8d36cd9d3ea615767b9023d008b05f04de4ebc6e46ea932346e50c973fe2bd3434eb380a73aa85e83b74d8d5d8a6672192877fbcd88a8
+  metadata.gz: 147f550e178d540665fe1762dbd47f2ff0c9618f81d9d0d50ef4072e126f0ae42eafe8ed3774e1a85035fd1c653e7742d656a435c2887af7cc3c3e42d9e1959f
+  data.tar.gz: 84e3b3a9920fef9e7b8aa77806d454ee6d9df0215c4ef2fe539509482555ae53c87969aaa979f113ca9ac39177c3c2aeb4472ddd004fe414cca6d29637315d1e

data/lib/forest_admin_datasource_customizer/decorators/action/action_collection_decorator.rb

@@ -11,6 +11,7 @@ module ForestAdminDatasourceCustomizer
 
         def add_action(name, action)
           action.build_elements
+          action.validate_fields_ids
           @actions[name] = action
 
           mark_schema_as_dirty
@@ -43,24 +44,14 @@ module ForestAdminDatasourceCustomizer
           if metas[:search_field]
             # in the case of a search hook,
             # we don't want to rebuild all the fields. only the one searched
-            dynamic_fields = dynamic_fields.select { |field| field.label == metas[:search_field] }
+            dynamic_fields = dynamic_fields.select { |field| field.id == metas[:search_field] }
           end
           dynamic_fields = drop_defaults(context, dynamic_fields, form_values)
           dynamic_fields = drop_ifs(context, dynamic_fields) unless metas[:include_hidden_fields]
 
-          fields = drop_deferred(context, metas[:search_values], dynamic_fields)
+          fields = drop_deferred(context, metas[:search_values], dynamic_fields).compact
 
-          fields.each do |field|
-            next if field.type == 'Layout'
-
-            if field.value.nil?
-              # customer did not define a handler to rewrite the previous value => reuse current one.
-              field.value = form_values[field.label]
-            end
-
-            # fields that were accessed through the context.get_form_value(x) getter should be watched.
-            field.watch_changes = used.include?(field.label)
-          end
+          set_watch_changes_on_fields(form_values, used, fields)
 
           fields
         end
@@ -73,9 +64,34 @@ module ForestAdminDatasourceCustomizer
 
         private
 
+        def set_watch_changes_on_fields(form_values, used, fields)
+          fields.each do |field|
+            if field.type != 'Layout'
+
+              if field.value.nil?
+                # customer did not define a handler to rewrite the previous value => reuse current one.
+                field.value = form_values[field.id]
+              end
+
+              # fields that were accessed through the context.get_form_value(x) getter should be watched.
+              field.watch_changes = used.include?(field.id)
+            elsif field.component == 'Row'
+              set_watch_changes_on_fields(form_values, used, field.fields)
+            end
+          end
+        end
+
+        def execute_on_sub_fields(field)
+          return unless field.type == 'Layout' && field.component == 'Row'
+
+          field.fields = yield(field.fields)
+        end
+
         def drop_defaults(context, fields, data)
           fields.map do |field|
             if field.type == 'Layout'
+              execute_on_sub_fields(field) { |sub_fields| drop_defaults(context, sub_fields, data) }
+
               field
             else
               drop_default(context, field, data)
@@ -84,14 +100,25 @@ module ForestAdminDatasourceCustomizer
         end
 
         def drop_default(context, field, data)
-          data[field.label] = evaluate(context, field.default_value) unless data.key?(field.label)
+          data[field.id] = evaluate(context, field.default_value) unless data.key?(field.id)
           field.default_value = nil
 
           field
         end
 
         def drop_ifs(context, fields)
-          if_values = fields.map { |field| !field.if_condition || evaluate(context, field.if_condition) }
+          if_values = fields.map do |field|
+            if evaluate(context, field.if_condition) == false
+              false
+            elsif field.type == 'Layout' && field.component == 'Row'
+              field.fields = drop_ifs(context, field.fields || [])
+
+              true unless field.fields.empty?
+            else
+              true
+            end
+          end
+
           new_fields = fields.select.with_index { |_field, index| if_values[index] }
           new_fields.each do |field|
             field = field.dup
@@ -105,6 +132,8 @@ module ForestAdminDatasourceCustomizer
           new_fields = []
           fields.each do |field|
             field = field.dup
+            execute_on_sub_fields(field) { |sub_fields| drop_deferred(context, search_values, sub_fields) }
+
             field.instance_variables.each do |key|
               key = key.to_s.delete('@').to_sym
 
@@ -114,7 +143,7 @@ module ForestAdminDatasourceCustomizer
               value = field.send(key)
               key = key.to_s.concat('=').to_sym
 
-              search_value = field.type == 'Layout' ? nil : search_values&.dig(field.label)
+              search_value = field.type == 'Layout' ? nil : search_values&.dig(field.id)
               field.send(key, evaluate(context, value, search_value))
             end
 

data/lib/forest_admin_datasource_customizer/decorators/action/base_action.rb

@@ -23,6 +23,20 @@ module ForestAdminDatasourceCustomizer
           end
         end
 
+        def validate_fields_ids(form = @form, used = [])
+          form&.each do |element|
+            if element.type == 'Layout' && element.component == 'Row'
+              validate_fields_ids(element.fields, used)
+            else
+              if used.include?(element.id)
+                raise ForestAdminDatasourceToolkit::Exceptions::ForestException,
+                      "All field must have different 'id'. Conflict come from field '#{element.id}'"
+              end
+              used << element.id
+            end
+          end
+        end
+
         def build_widget(field)
           case field[:widget]
           when 'AddressAutocomplete'
@@ -72,6 +86,8 @@ module ForestAdminDatasourceCustomizer
             FormLayoutElement::SeparatorElement.new(**field)
           when 'HtmlBlock'
             FormLayoutElement::HtmlBlockElement.new(**field)
+          when 'Row'
+            FormLayoutElement::RowElement.new(**field)
           else
             raise ForestAdminDatasourceToolkit::Exceptions::ForestException,
                   "Unknow component type: #{field[:component]}"
@@ -79,7 +95,7 @@ module ForestAdminDatasourceCustomizer
         end
 
         def static_form?
-          return form&.all?(&:static?) if form
+          return form&.all?(&:static?) && form&.none? { |field| field.type == 'Layout' } if form
 
           true
         end

data/lib/forest_admin_datasource_customizer/decorators/action/dynamic_field.rb

@@ -3,11 +3,12 @@ module ForestAdminDatasourceCustomizer
     module Action
       class DynamicField < BaseFormElement
         attr_accessor :type, :label, :description, :is_required, :is_read_only, :if_condition, :value, :default_value,
-                      :collection_name, :enum_values, :placeholder
+                      :collection_name, :enum_values, :placeholder, :id
 
         def initialize(
           type:,
-          label:,
+          label: nil,
+          id: nil,
           description: nil,
           is_required: false,
           is_read_only: false,
@@ -21,7 +22,13 @@ module ForestAdminDatasourceCustomizer
         )
           super(type: type)
 
-          @label = label
+          if id.nil? && label.nil?
+            raise ForestAdminDatasourceToolkit::Exceptions::ForestException,
+                  "A field must have an 'id' or a 'label' defined."
+          end
+
+          @label = label.nil? ? id : label
+          @id = id.nil? ? label : id
           @description = description
           @is_required = is_required
           @is_read_only = is_read_only

data/lib/forest_admin_datasource_customizer/decorators/action/form_layout_element.rb

@@ -3,13 +3,13 @@ module ForestAdminDatasourceCustomizer
     module Action
       module FormLayoutElement
         include Types
+        include ForestAdminDatasourceToolkit::Exceptions
 
         class LayoutElement < BaseFormElement
           attr_accessor :if_condition, :component
 
           def initialize(component:, if_condition: nil, **kwargs)
             super(type: 'Layout', **kwargs)
-
             @component = component
             @if_condition = if_condition
           end
@@ -29,6 +29,40 @@ module ForestAdminDatasourceCustomizer
             @content = content
           end
         end
+
+        class RowElement < LayoutElement
+          include ForestAdminDatasourceToolkit::Exceptions
+
+          attr_accessor :fields
+
+          def initialize(options)
+            super(component: 'Row', **options)
+            validate_fields_presence!(options)
+            validate_no_layout_subfields!(options[:fields])
+            @fields = instantiate_subfields(options[:fields] || [])
+          end
+
+          private
+
+          def validate_fields_presence!(options)
+            raise ForestException, "Using 'fields' in a 'Row' configuration is mandatory" unless options.key?(:fields)
+          end
+
+          def validate_no_layout_subfields!(fields)
+            fields.each do |field|
+              if (field.is_a?(DynamicField) && field.type == 'Layout') ||
+                 (field.is_a?(Hash) && field[:type] == 'Layout')
+                raise ForestException, "A 'Row' form element doesn't allow layout elements as subfields"
+              end
+            end
+          end
+
+          def instantiate_subfields(fields)
+            fields.map do |field|
+              DynamicField.new(**field.to_h)
+            end
+          end
+        end
       end
     end
   end

data/lib/forest_admin_datasource_customizer/version.rb

@@ -1,3 +1,3 @@
 module ForestAdminDatasourceCustomizer
-  VERSION = "1.0.0-beta.68"
+  VERSION = "1.0.0-beta.70"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: forest_admin_datasource_customizer
 version: !ruby/object:Gem::Version
-  version: 1.0.0.pre.beta.68
+  version: 1.0.0.pre.beta.70
 platform: ruby
 authors:
 - Matthieu
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-09-23 00:00:00.000000000 Z
+date: 2024-09-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -86,7 +86,6 @@ files:
 - lib/forest_admin_datasource_customizer/decorators/action/context/action_context_single.rb
 - lib/forest_admin_datasource_customizer/decorators/action/dynamic_field.rb
 - lib/forest_admin_datasource_customizer/decorators/action/form_layout_element.rb
-- lib/forest_admin_datasource_customizer/decorators/action/layout_element.rb
 - lib/forest_admin_datasource_customizer/decorators/action/result_builder.rb
 - lib/forest_admin_datasource_customizer/decorators/action/types/action_scope.rb
 - lib/forest_admin_datasource_customizer/decorators/action/types/field_type.rb

data/lib/forest_admin_datasource_customizer/decorators/action/layout_element.rb

@@ -1,343 +0,0 @@
-module ForestAdminDatasourceCustomizer
-  module Decorators
-    module Action
-      module LayoutElement
-        include Types
-
-        class TimePickerField < DynamicField
-          attr_accessor :widget
-
-          def initialize(options)
-            super(**options)
-            WidgetField.validate_arg(options, :type, { type: 'contains', value: ['Time'] })
-            @widget = 'TimePicker'
-          end
-        end
-
-        class AddressAutocompleteField < DynamicField
-          attr_accessor :widget
-
-          def initialize(options)
-            super(**options)
-            WidgetField.validate_arg(options, :type, { type: 'contains', value: ['String'] })
-
-            @widget = 'AddressAutocomplete'
-          end
-        end
-
-        class CheckboxField < DynamicField
-          attr_accessor :widget
-
-          def initialize(options)
-            super(**options)
-            WidgetField.validate_arg(
-              options,
-              :type,
-              { type: 'contains', value: [Types::FieldType::BOOLEAN] }
-            )
-
-            @widget = 'Checkbox'
-          end
-        end
-
-        class CheckboxGroupField < DynamicField
-          attr_accessor :widget, :options
-
-          def initialize(options)
-            super(**options)
-
-            WidgetField.validate_arg(options, :options, { type: 'present' })
-            WidgetField.validate_arg(
-              options,
-              :type,
-              { type: 'contains', value: [Types::FieldType::STRING_LIST, Types::FieldType::NUMBER_LIST] }
-            )
-
-            @widget = 'CheckboxGroup'
-            @options = options[:options]
-          end
-        end
-
-        class ColorPickerField < DynamicField
-          attr_accessor :widget, :enable_opacity, :quick_palette
-
-          def initialize(options)
-            super(**options)
-
-            WidgetField.validate_arg(options, :enable_opacity, { type: 'contains', value: [Types::FieldType::STRING] })
-
-            @widget = 'ColorPicker'
-            @enable_opacity = options[:enable_opacity] || nil
-            @quick_palette = options[:quick_palette] || nil
-          end
-        end
-
-        class CurrencyInputField < DynamicField
-          attr_accessor :widget, :currency, :base, :min, :max, :step
-
-          def initialize(options)
-            super(**options)
-
-            WidgetField.validate_arg(options, :type, { type: 'contains', value: [Types::FieldType::NUMBER] })
-            WidgetField.validate_arg(options, :currency, { type: 'present' })
-
-            @widget = 'CurrencyInput'
-            @currency = options[:currency]
-            @base = options[:base] || 'Unit'
-            @min = options[:min] || nil
-            @max = options[:max] || nil
-            @step = options[:step] || nil
-          end
-        end
-
-        class DatePickerField < DynamicField
-          attr_accessor :widget, :min, :max, :format, :step
-
-          def initialize(options)
-            super(**options)
-
-            WidgetField.validate_arg(
-              options,
-              'type',
-              { type: 'contains',
-                value: [Types::FieldType::DATE, Types::FieldType::DATE_ONLY, Types::FieldType::STRING] }
-            )
-
-            @widget = 'DatePicker'
-            @format = options[:format] || nil
-            @min = options[:min] || nil
-            @max = options[:max] || nil
-            @step = options[:step] || nil
-          end
-        end
-
-        class DropdownField < DynamicField
-          attr_accessor :widget, :options, :search
-
-          def initialize(options)
-            super(**options)
-            WidgetField.validate_arg(options, :options, { type: 'present' })
-            WidgetField.validate_arg(
-              options,
-              'type',
-              {
-                type: 'contains',
-                value: [Types::FieldType::DATE, Types::FieldType::DATE_ONLY, Types::FieldType::STRING,
-                        Types::FieldType::STRING_LIST]
-              }
-            )
-
-            @widget = 'Dropdown'
-            @options = options[:options]
-            @search = options[:search] || nil
-          end
-        end
-
-        class FilePickerField < DynamicField
-          attr_accessor :widget, :extensions, :max_count, :max_size_mb
-
-          def initialize(options)
-            super(**options)
-            WidgetField.validate_arg(options, :options, { type: 'present' })
-            WidgetField.validate_arg(
-              options,
-              'type',
-              {
-                type: 'contains',
-                value: [Types::FieldType::FILE, Types::FieldType::FILE_LIST]
-              }
-            )
-
-            @widget = 'FilePicker'
-            @extensions = options[:extensions] || nil
-            @max_size_mb = options[:max_size_mb] || nil
-            @max_count = options[:max_count] || nil
-          end
-        end
-
-        class NumberInputField < DynamicField
-          attr_accessor :widget, :step, :min, :max
-
-          def initialize(options)
-            super(**options)
-            WidgetField.validate_arg(options, :options, { type: 'present' })
-            WidgetField.validate_arg(
-              options,
-              'type',
-              {
-                type: 'contains',
-                value: [Types::FieldType::NUMBER]
-              }
-            )
-
-            @widget = 'NumberInput'
-            @step = options[:step] || nil
-            @min = options[:min] || nil
-            @max = options[:max] || nil
-          end
-        end
-
-        class JsonEditorField < DynamicField
-          attr_accessor :widget
-
-          def initialize(options)
-            super(**options)
-            WidgetField.validate_arg(
-              options,
-              'type',
-              {
-                type: 'contains',
-                value: [Types::FieldType::DATE, Types::FieldType::DATE_ONLY, Types::FieldType::STRING,
-                        Types::FieldType::STRING_LIST]
-              }
-            )
-
-            @widget = 'JsonEditor'
-          end
-        end
-
-        class NumberInputListField < DynamicField
-          attr_accessor :widget, :allow_duplicates, :allow_empty_values, :enable_reorder, :min, :max, :step
-
-          def initialize(options)
-            super(**options)
-            WidgetField.validate_arg(options, :options, { type: 'present' })
-            WidgetField.validate_arg(
-              options,
-              'type',
-              {
-                type: 'contains',
-                value: [Types::FieldType::NUMBER_LIST]
-              }
-            )
-
-            @widget = 'NumberInputList'
-            @allow_duplicates = options[:allow_duplicates] || nil
-            @allow_empty_values = options[:allow_empty_values] || nil
-            @enable_reorder = options[:enable_reorder] || nil
-            @min = options[:min] || nil
-            @max = options[:max] || nil
-            @step = options[:step] || nil
-          end
-        end
-
-        class RadioGroupField < DynamicField
-          attr_accessor :widget, :options
-
-          def initialize(options)
-            super(**options)
-            WidgetField.validate_arg(options, :options, { type: 'present' })
-            WidgetField.validate_arg(
-              options,
-              'type',
-              {
-                type: 'contains',
-                value: [Types::FieldType::DATE, Types::FieldType::DATEONLY, Types::FieldType::NUMBER,
-                        Types::FieldType::STRING]
-              }
-            )
-
-            @widget = 'RadioGroup'
-            @options = options[:options]
-          end
-        end
-
-        class RichTextField < DynamicField
-          attr_accessor :widget
-
-          def initialize(options)
-            super(**options)
-            WidgetField.validate_arg(options, :options, { type: 'present' })
-            WidgetField.validate_arg(
-              options,
-              'type',
-              {
-                type: 'contains',
-                value: [Types::FieldType::STRING]
-              }
-            )
-
-            @widget = 'RichText'
-          end
-        end
-
-        class TextAreaField < DynamicField
-          attr_accessor :widget, :rows
-
-          def initialize(options)
-            super(**options)
-            WidgetField.validate_arg(
-              options,
-              'type',
-              {
-                type: 'contains',
-                value: [Types::FieldType::STRING]
-              }
-            )
-
-            @widget = 'TextArea'
-            @rows = options[:rows] || nil
-          end
-        end
-
-        class TextInputField < DynamicField
-          attr_accessor :widget
-
-          def initialize(options)
-            super(**options)
-            WidgetField.validate_arg(
-              options,
-              'type',
-              {
-                type: 'contains',
-                value: [Types::FieldType::STRING]
-              }
-            )
-
-            @widget = 'TextInput'
-          end
-        end
-
-        class TextInputListField < DynamicField
-          attr_accessor :widget, :allow_duplicates, :allow_empty_values, :enable_reorder
-
-          def initialize(options)
-            super(**options)
-            WidgetField.validate_arg(
-              options,
-              'type',
-              {
-                type: 'contains',
-                value: [Types::FieldType::STRING_LIST]
-              }
-            )
-
-            @widget = 'TextInput'
-            @allow_duplicates = options[:allow_duplicates] || nil
-            @allow_empty_values = options[:allow_empty_values] || nil
-            @enable_reorder = options[:enable_reorder] || nil
-          end
-        end
-
-        class UserDropdownField < DynamicField
-          attr_accessor :widget
-
-          def initialize(options)
-            super(**options)
-            WidgetField.validate_arg(options, :options, { type: 'present' })
-            WidgetField.validate_arg(
-              options,
-              'type',
-              {
-                type: 'contains',
-                value: [Types::FieldType::STRING, Types::FieldType::STRING_LIST]
-              }
-            )
-
-            @widget = 'UserDropdown'
-          end
-        end
-      end
-    end
-  end
-end