forest_admin_datasource_customizer 1.0.0.pre.beta.70 → 1.0.0.pre.beta.72

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f034b46ebd5986948532a00416d5035ef436870de4e924f75fe88ff91041faaa
-  data.tar.gz: 22158ab749cfccd936e41bec2f5c6e3277204e75c76ea797b5ec53c72a07f046
+  metadata.gz: 658c563d6a1a05ba3895d6ee03f130816566313ca15c3db156d729bac9c6f309
+  data.tar.gz: 67b1718e466dde2ec435a41d5a86f98d3265cd1ee0208336c7e5cc469875e1e1
 SHA512:
-  metadata.gz: 147f550e178d540665fe1762dbd47f2ff0c9618f81d9d0d50ef4072e126f0ae42eafe8ed3774e1a85035fd1c653e7742d656a435c2887af7cc3c3e42d9e1959f
-  data.tar.gz: 84e3b3a9920fef9e7b8aa77806d454ee6d9df0215c4ef2fe539509482555ae53c87969aaa979f113ca9ac39177c3c2aeb4472ddd004fe414cca6d29637315d1e
+  metadata.gz: 7198979d8381dd56cce59bbe447fb51a9132d4d635d6fa4673b5b6cbee55eab1e0d65ff0c249b2fa6f6706a2cb4e2079401f10c001352fe0f17735a36b6ce4ac
+  data.tar.gz: b9296fc4ed968c4d42c0b978e772807f758f0a81ec09a6662c5bb49dd97b2364b64a6ff5fd3265870e965779a0b08a32cacb4dd8f61c5876cd82890fd7aa2127

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

@@ -10,6 +10,7 @@ module ForestAdminDatasourceCustomizer
         end
 
         def add_action(name, action)
+          ensure_form_is_correct(action.form, name)
           action.build_elements
           action.validate_fields_ids
           @actions[name] = action
@@ -41,15 +42,13 @@ module ForestAdminDatasourceCustomizer
           context = get_context(caller, action, form_values, filter, used, metas[:change_field])
 
           dynamic_fields = action.form
-          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.id == metas[:search_field] }
-          end
+          dynamic_fields = select_in_form_fields(dynamic_fields, metas[:search_field]) if metas[:search_field]
           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).compact
+          fields = drop_deferred(context, metas[:search_values], dynamic_fields)
+
+          fields.compact
 
           set_watch_changes_on_fields(form_values, used, fields)
 
@@ -64,6 +63,31 @@ module ForestAdminDatasourceCustomizer
 
         private
 
+        def ensure_form_is_correct(form, action_name)
+          return if form.nil? || form.empty?
+
+          is_page_component = ->(element) { element[:type] == 'Layout' && element[:component] == 'Page' }
+          pages = is_page_component.call(form.first)
+
+          form.each do |element|
+            if pages != is_page_component.call(element)
+              raise ForestAdminDatasourceToolkit::Exceptions::ForestException,
+                    "You cannot mix pages and other form elements in smart action '#{action_name}' form"
+            end
+          end
+        end
+
+        def select_in_form_fields(fields, search_field)
+          fields.select do |field|
+            if nested_layout_element?(field)
+              key = field.component == 'Page' ? :elements : :fields
+              select_in_form_fields(field.public_send(:"#{key}"), search_field)
+            else
+              field.id == search_field
+            end
+          end
+        end
+
         def set_watch_changes_on_fields(form_values, used, fields)
           fields.each do |field|
             if field.type != 'Layout'
@@ -77,14 +101,20 @@ module ForestAdminDatasourceCustomizer
               field.watch_changes = used.include?(field.id)
             elsif field.component == 'Row'
               set_watch_changes_on_fields(form_values, used, field.fields)
+            elsif field.component == 'Page'
+              set_watch_changes_on_fields(form_values, used, field.elements)
             end
           end
         end
 
         def execute_on_sub_fields(field)
-          return unless field.type == 'Layout' && field.component == 'Row'
+          return unless nested_layout_element?(field)
 
-          field.fields = yield(field.fields)
+          if field.component == 'Page'
+            field.elements = yield(field.elements)
+          elsif field.component == 'Row'
+            field.fields = yield(field.fields)
+          end
         end
 
         def drop_defaults(context, fields, data)
@@ -110,10 +140,12 @@ module ForestAdminDatasourceCustomizer
           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 || [])
+            elsif nested_layout_element?(field)
+              key = field.component == 'Page' ? :elements : :fields
+              field.public_send(:"#{key}=", drop_ifs(context, field.public_send(:"#{key}") || []))
+
+              true unless field.public_send(:"#{key}").empty?
 
-              true unless field.fields.empty?
             else
               true
             end
@@ -170,6 +202,10 @@ module ForestAdminDatasourceCustomizer
 
           Context::ActionContext.new(self, caller, form_values, filter, used, change_field)
         end
+
+        def nested_layout_element?(field)
+          field.type == 'Layout' && %w[Page Row].include?(field.component)
+        end
       end
     end
   end

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

@@ -2,31 +2,34 @@ module ForestAdminDatasourceCustomizer
   module Decorators
     module Action
       class BaseAction
-        attr_reader :scope, :form, :is_generate_file, :execute
+        attr_reader :scope, :form, :is_generate_file, :description, :submit_button_label, :execute
 
-        def initialize(scope:, form: nil, is_generate_file: false, &execute)
+        def initialize(scope:, form: nil, is_generate_file: false, description: nil, submit_button_label: nil, &execute)
           @scope = scope
           @form = form
           @is_generate_file = is_generate_file
+          @description = description
+          @submit_button_label = submit_button_label
           @execute = execute
         end
 
         def build_elements
-          @form = @form&.map do |field|
-            if field.key? :widget
-              build_widget(field)
-            elsif field[:type] == 'Layout'
-              build_layout_element(field)
-            else
-              DynamicField.new(**field)
-            end
-          end
+          @form = FormFactory.build_elements(form)
+        end
+
+        def static_form?
+          return form&.all?(&:static?) && form&.none? { |field| field.type == 'Layout' } if form
+
+          true
         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)
+            if element.type == 'Layout'
+              if %w[Page Row].include?(element.component)
+                key = element.component == 'Page' ? :elements : :fields
+                validate_fields_ids(element.public_send(key), used)
+              end
             else
               if used.include?(element.id)
                 raise ForestAdminDatasourceToolkit::Exceptions::ForestException,
@@ -36,69 +39,6 @@ module ForestAdminDatasourceCustomizer
             end
           end
         end
-
-        def build_widget(field)
-          case field[:widget]
-          when 'AddressAutocomplete'
-            WidgetField::AddressAutocompleteField.new(**field)
-          when 'Checkbox'
-            WidgetField::CheckboxField.new(**field)
-          when 'CheckboxGroup'
-            WidgetField::CheckboxGroupField.new(**field)
-          when 'ColorPicker'
-            WidgetField::ColorPickerField.new(**field)
-          when 'CurrencyInput'
-            WidgetField::CurrencyInputField.new(**field)
-          when 'DatePicker'
-            WidgetField::DatePickerField.new(**field)
-          when 'Dropdown'
-            WidgetField::DropdownField.new(**field)
-          when 'FilePicker'
-            WidgetField::FilePickerField.new(**field)
-          when 'JsonEditor'
-            WidgetField::JsonEditorField.new(**field)
-          when 'NumberInput'
-            WidgetField::NumberInputField.new(**field)
-          when 'NumberInputList'
-            WidgetField::NumberInputListField.new(**field)
-          when 'RadioGroup'
-            WidgetField::RadioGroupField.new(**field)
-          when 'RichText'
-            WidgetField::RichTextField.new(**field)
-          when 'TextArea'
-            WidgetField::TextAreaField.new(**field)
-          when 'TextInput'
-            WidgetField::TextInputField.new(**field)
-          when 'TextInputList'
-            WidgetField::TextInputListField.new(**field)
-          when 'TimePicker'
-            WidgetField::TimePickerField.new(**field)
-          when 'UserDropdown'
-            WidgetField::UserDropdownField.new(**field)
-          else
-            raise ForestAdminDatasourceToolkit::Exceptions::ForestException, "Unknow widget type: #{field[:widget]}"
-          end
-        end
-
-        def build_layout_element(field)
-          case field[:component]
-          when 'Separator'
-            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]}"
-          end
-        end
-
-        def static_form?
-          return form&.all?(&:static?) && form&.none? { |field| field.type == 'Layout' } if form
-
-          true
-        end
       end
     end
   end

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

@@ -0,0 +1,87 @@
+module ForestAdminDatasourceCustomizer
+  module Decorators
+    module Action
+      class FormFactory
+        def self.build_elements(form)
+          form&.map do |field|
+            case field
+            when Hash
+              if field.key?(:widget)
+                build_widget(field)
+              elsif field[:type] == 'Layout'
+                build_layout_element(field)
+              else
+                DynamicField.new(**field)
+              end
+            when FormLayoutElement::RowElement
+              build_elements(field.fields)
+            when FormLayoutElement::PageElement
+              build_elements(field.elements)
+            else
+              field
+            end
+          end
+        end
+
+        def self.build_widget(field)
+          case field[:widget]
+          when 'AddressAutocomplete'
+            WidgetField::AddressAutocompleteField.new(**field)
+          when 'Checkbox'
+            WidgetField::CheckboxField.new(**field)
+          when 'CheckboxGroup'
+            WidgetField::CheckboxGroupField.new(**field)
+          when 'ColorPicker'
+            WidgetField::ColorPickerField.new(**field)
+          when 'CurrencyInput'
+            WidgetField::CurrencyInputField.new(**field)
+          when 'DatePicker'
+            WidgetField::DatePickerField.new(**field)
+          when 'Dropdown'
+            WidgetField::DropdownField.new(**field)
+          when 'FilePicker'
+            WidgetField::FilePickerField.new(**field)
+          when 'JsonEditor'
+            WidgetField::JsonEditorField.new(**field)
+          when 'NumberInput'
+            WidgetField::NumberInputField.new(**field)
+          when 'NumberInputList'
+            WidgetField::NumberInputListField.new(**field)
+          when 'RadioGroup'
+            WidgetField::RadioGroupField.new(**field)
+          when 'RichText'
+            WidgetField::RichTextField.new(**field)
+          when 'TextArea'
+            WidgetField::TextAreaField.new(**field)
+          when 'TextInput'
+            WidgetField::TextInputField.new(**field)
+          when 'TextInputList'
+            WidgetField::TextInputListField.new(**field)
+          when 'TimePicker'
+            WidgetField::TimePickerField.new(**field)
+          when 'UserDropdown'
+            WidgetField::UserDropdownField.new(**field)
+          else
+            raise ForestAdminDatasourceToolkit::Exceptions::ForestException, "Unknow widget type: #{field[:widget]}"
+          end
+        end
+
+        def self.build_layout_element(field)
+          case field[:component]
+          when 'Separator'
+            FormLayoutElement::SeparatorElement.new(**field)
+          when 'HtmlBlock'
+            FormLayoutElement::HtmlBlockElement.new(**field)
+          when 'Row'
+            FormLayoutElement::RowElement.new(**field)
+          when 'Page'
+            FormLayoutElement::PageElement.new(**field)
+          else
+            raise ForestAdminDatasourceToolkit::Exceptions::ForestException,
+                  "Unknow component type: #{field[:component]}"
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -58,10 +58,44 @@ module ForestAdminDatasourceCustomizer
           end
 
           def instantiate_subfields(fields)
-            fields.map do |field|
-              DynamicField.new(**field.to_h)
+            FormFactory.build_elements(fields)
+          end
+        end
+
+        class PageElement < LayoutElement
+          include ForestAdminDatasourceToolkit::Exceptions
+
+          attr_accessor :elements, :next_button_label, :previous_button_label
+
+          def initialize(options)
+            super(component: 'Page', **options)
+
+            validate_elements_presence!(options)
+            validate_no_page_elements!(options[:elements])
+            @next_button_label = options[:next_button_label]
+            @previous_button_label = options[:previous_button_label]
+            @elements = instantiate_elements(options[:elements] || [])
+          end
+
+          private
+
+          def validate_elements_presence!(options)
+            return if options.key?(:elements)
+
+            raise ForestException, "Using 'elements' in a 'Page' configuration is mandatory"
+          end
+
+          def validate_no_page_elements!(elements)
+            elements&.each do |element|
+              if element[:component] == 'Page'
+                raise ForestException, "'Page' component cannot be used within 'elements'"
+              end
             end
           end
+
+          def instantiate_elements(elements)
+            FormFactory.build_elements(elements)
+          end
         end
       end
     end

data/lib/forest_admin_datasource_customizer/decorators/action/types/field_type.rb

@@ -21,6 +21,8 @@ module ForestAdminDatasourceCustomizer
 
           JSON = 'Json'.freeze
 
+          LAYOUT = 'Layout'.freeze
+
           NUMBER = 'Number'.freeze
 
           NUMBER_LIST = 'NumberList'.freeze

data/lib/forest_admin_datasource_customizer/version.rb

@@ -1,3 +1,3 @@
 module ForestAdminDatasourceCustomizer
-  VERSION = "1.0.0-beta.70"
+  VERSION = "1.0.0-beta.72"
 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.70
+  version: 1.0.0.pre.beta.72
 platform: ruby
 authors:
 - Matthieu
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-09-27 00:00:00.000000000 Z
+date: 2024-10-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -85,6 +85,7 @@ files:
 - lib/forest_admin_datasource_customizer/decorators/action/context/action_context.rb
 - 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_factory.rb
 - lib/forest_admin_datasource_customizer/decorators/action/form_layout_element.rb
 - lib/forest_admin_datasource_customizer/decorators/action/result_builder.rb
 - lib/forest_admin_datasource_customizer/decorators/action/types/action_scope.rb