forest_admin_datasource_customizer 1.0.0.pre.beta.65 → 1.0.0.pre.beta.67

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6ff06d84529de19b6e3d26bb2c13bf90ec9777198f3fe817ee5232bf395e1b31
-  data.tar.gz: b84c75a15e00e7865e9ed37b14cc8a8b60fd1120d9c8d712f514656b46f7abe8
+  metadata.gz: dc7be9cd681f1268f79a3196e2df52f823bf27435addf2bafd6149d54c2cccae
+  data.tar.gz: 4ec5d39db429e15805cd46c0ae414a1486c24c42df2f2bd89c00b171e01bb7ab
 SHA512:
-  metadata.gz: b5ec8e8088d0d82a6089795dba63674e589c3ca90e226808c5c73d6d3f78dffd5ce6f3862a5699f9cbe9505eeb3d2f7ca5a744a84ed495969954e13c0743aa0d
-  data.tar.gz: 9f124ec9a5a2e75741ce5d405fb6968bda58f5c231727bb6ea99d5b6c82603426f278ad93851720cd25f98aa0a406ce575f1d2294d46e4cc0d274c06c0593b15
+  metadata.gz: d7f31dd4e49979ecd1b488b505eaf7c87ed8a41f2301578a2b4b26458075e64fd491c15b58638663d166da004d2c1f972412c5c4418809e77533b4bdc736de9c
+  data.tar.gz: 928ae535652f6eba9f2ccf93686d09e71b0a51d0d8a98e24fd70a702e37f8734f5f0358b2b2c30bfc30d5972135b31ff02b37fadda364d9116f12304986e98f9

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

@@ -10,7 +10,7 @@ module ForestAdminDatasourceCustomizer
         end
 
         def add_action(name, action)
-          action.build_fields
+          action.build_elements
           @actions[name] = action
 
           mark_schema_as_dirty
@@ -51,6 +51,8 @@ module ForestAdminDatasourceCustomizer
           fields = drop_deferred(context, metas[:search_values], dynamic_fields)
 
           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]
@@ -72,13 +74,20 @@ module ForestAdminDatasourceCustomizer
         private
 
         def drop_defaults(context, fields, data)
-          unvalued_fields = fields.reject { |field| data.key?(field.label) }
-          defaults = unvalued_fields.map { |field| evaluate(context, field.default_value) }
-          unvalued_fields.each_with_index { |field, index| data[field.label] = defaults[index] }
+          fields.map do |field|
+            if field.type == 'Layout'
+              field
+            else
+              drop_default(context, field, data)
+            end
+          end
+        end
 
-          fields.each { |field| field.default_value = nil }
+        def drop_default(context, field, data)
+          data[field.label] = evaluate(context, field.default_value) unless data.key?(field.label)
+          field.default_value = nil
 
-          fields
+          field
         end
 
         def drop_ifs(context, fields)
@@ -105,7 +114,8 @@ module ForestAdminDatasourceCustomizer
               value = field.send(key)
               key = key.to_s.concat('=').to_sym
 
-              field.send(key, evaluate(context, value, search_values&.dig(field.label)))
+              search_value = field.type == 'Layout' ? nil : search_values&.dig(field.label)
+              field.send(key, evaluate(context, value, search_value))
             end
 
             new_fields << Actions::ActionFieldFactory.build(field.to_h)

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

@@ -11,51 +11,71 @@ module ForestAdminDatasourceCustomizer
           @execute = execute
         end
 
-        def build_fields
+        def build_elements
           @form = @form&.map do |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)
+            if field.key? :widget
+              build_widget(field)
+            elsif field[:type] == 'Layout'
+              build_layout_element(field)
             else
               DynamicField.new(**field)
             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)
+          else
+            raise ForestAdminDatasourceToolkit::Exceptions::ForestException,
+                  "Unknow component type: #{field[:component]}"
+          end
+        end
+
         def static_form?
           return form&.all?(&:static?) if form
 

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

@@ -0,0 +1,29 @@
+module ForestAdminDatasourceCustomizer
+  module Decorators
+    module Action
+      class BaseFormElement
+        attr_accessor :type
+
+        def initialize(
+          type:,
+          **_kwargs
+        )
+          @type = type
+        end
+
+        def static?
+          instance_variables.all? { |attribute| !instance_variable_get(attribute).respond_to?(:call) }
+        end
+
+        def to_h
+          result = {}
+          instance_variables.each do |attribute|
+            result[attribute.to_s.delete('@').to_sym] = instance_variable_get(attribute)
+          end
+
+          result
+        end
+      end
+    end
+  end
+end

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

@@ -1,7 +1,7 @@
 module ForestAdminDatasourceCustomizer
   module Decorators
     module Action
-      class DynamicField
+      class DynamicField < BaseFormElement
         attr_accessor :type, :label, :description, :is_required, :is_read_only, :if_condition, :value, :default_value,
                       :collection_name, :enum_values, :placeholder
 
@@ -19,7 +19,8 @@ module ForestAdminDatasourceCustomizer
           placeholder: nil,
           **_kwargs
         )
-          @type = type
+          super(type: type)
+
           @label = label
           @description = description
           @is_required = is_required
@@ -31,19 +32,6 @@ module ForestAdminDatasourceCustomizer
           @enum_values = enum_values
           @placeholder = placeholder
         end
-
-        def static?
-          instance_variables.all? { |attribute| !instance_variable_get(attribute).respond_to?(:call) }
-        end
-
-        def to_h
-          result = {}
-          instance_variables.each do |attribute|
-            result[attribute.to_s.delete('@').to_sym] = instance_variable_get(attribute)
-          end
-
-          result
-        end
       end
     end
   end

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

@@ -0,0 +1,26 @@
+module ForestAdminDatasourceCustomizer
+  module Decorators
+    module Action
+      module FormLayoutElement
+        include Types
+
+        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
+        end
+
+        class SeparatorElement < LayoutElement
+          def initialize(options)
+            super(component: 'Separator', **options)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,343 @@
+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

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

@@ -246,7 +246,7 @@ module ForestAdminDatasourceCustomizer
               'type',
               {
                 type: 'contains',
-                value: [Types::FieldType::DATE, Types::FieldType::DATEONLY, Types::FieldType::NUMBER,
+                value: [Types::FieldType::DATE, Types::FieldType::DATE_ONLY, Types::FieldType::NUMBER,
                         Types::FieldType::STRING]
               }
             )
@@ -326,7 +326,7 @@ module ForestAdminDatasourceCustomizer
               }
             )
 
-            @widget = 'TextInput'
+            @widget = 'TextInputList'
             @allow_duplicates = options[:allow_duplicates] || nil
             @allow_empty_values = options[:allow_empty_values] || nil
             @enable_reorder = options[:enable_reorder] || nil

data/lib/forest_admin_datasource_customizer/version.rb

@@ -1,3 +1,3 @@
 module ForestAdminDatasourceCustomizer
-  VERSION = "1.0.0-beta.65"
+  VERSION = "1.0.0-beta.67"
 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.65
+  version: 1.0.0.pre.beta.67
 platform: ruby
 authors:
 - Matthieu
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-08-23 00:00:00.000000000 Z
+date: 2024-09-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -81,9 +81,12 @@ files:
 - lib/forest_admin_datasource_customizer/datasource_customizer.rb
 - lib/forest_admin_datasource_customizer/decorators/action/action_collection_decorator.rb
 - lib/forest_admin_datasource_customizer/decorators/action/base_action.rb
+- lib/forest_admin_datasource_customizer/decorators/action/base_form_element.rb
 - 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_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