foo
' } @@ -336,6 +304,69 @@ module Schema end end + context 'with row element' do + before do + @collection = collection_build( + schema: { + actions: { + 'Charge credit card' => BaseAction.new( + scope: Types::ActionScope::SINGLE + ) + } + }, + get_form: [ + ActionLayoutElement::RowElement.new( + fields: [ + ActionField.new(label: 'label', type: 'String'), + ActionField.new(label: 'amount', type: 'String') + ] + ) + ] + ) + end + + it 'generate schema correctly' do + schema = described_class.build_schema(@collection, 'Charge credit card') + + expect(schema).to eq( + { + id: 'collection-0-charge-credit-card', + name: 'Charge credit card', + type: 'single', + baseUrl: nil, + endpoint: '/forest/_actions/collection/0/charge-credit-card', + httpMethod: 'POST', + redirect: nil, + download: false, + fields: [ + { + field: 'label', + type: 'String', + description: nil, + isRequired: false, + isReadOnly: false, + widgetEdit: nil, + defaultValue: nil + }, + { + field: 'amount', + type: 'String', + description: nil, + isRequired: false, + isReadOnly: false, + widgetEdit: nil, + defaultValue: nil + } + ], + # layout: [ + # { component: 'row', type: 'Layout', fields: ['label'] } + # ], + hooks: { load: false, change: ['changeHook'] } + } + ) + end + end + describe 'extract_fields_and_layout' do before do @collection = collection_build( diff --git a/packages/forest_admin_datasource_customizer/lib/forest_admin_datasource_customizer/decorators/action/action_collection_decorator.rb b/packages/forest_admin_datasource_customizer/lib/forest_admin_datasource_customizer/decorators/action/action_collection_decorator.rb index 35b445961..d70206579 100644 --- a/packages/forest_admin_datasource_customizer/lib/forest_admin_datasource_customizer/decorators/action/action_collection_decorator.rb +++ b/packages/forest_admin_datasource_customizer/lib/forest_admin_datasource_customizer/decorators/action/action_collection_decorator.rb @@ -48,7 +48,7 @@ def get_form(caller, name, data = nil, filter = nil, metas = {}) 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' diff --git a/packages/forest_admin_datasource_customizer/lib/forest_admin_datasource_customizer/decorators/action/base_action.rb b/packages/forest_admin_datasource_customizer/lib/forest_admin_datasource_customizer/decorators/action/base_action.rb index 96c49dbd5..cc5771161 100644 --- a/packages/forest_admin_datasource_customizer/lib/forest_admin_datasource_customizer/decorators/action/base_action.rb +++ b/packages/forest_admin_datasource_customizer/lib/forest_admin_datasource_customizer/decorators/action/base_action.rb @@ -72,6 +72,8 @@ def build_layout_element(field) 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 +81,7 @@ def build_layout_element(field) end def static_form? - return form&.all?(&:static?) if form + return form&.all?(&:static?) && form&.none? { |field| field.type == 'Layout' } if form true end diff --git a/packages/forest_admin_datasource_customizer/lib/forest_admin_datasource_customizer/decorators/action/form_layout_element.rb b/packages/forest_admin_datasource_customizer/lib/forest_admin_datasource_customizer/decorators/action/form_layout_element.rb index 69331c78f..3fa62a401 100644 --- a/packages/forest_admin_datasource_customizer/lib/forest_admin_datasource_customizer/decorators/action/form_layout_element.rb +++ b/packages/forest_admin_datasource_customizer/lib/forest_admin_datasource_customizer/decorators/action/form_layout_element.rb @@ -3,13 +3,13 @@ module Decorators 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,39 @@ def initialize(content:, **options) @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| + ForestAdminDatasourceToolkit::Components::Actions::ActionFieldFactory.build(field.to_h) + end + end + end end end end diff --git a/packages/forest_admin_datasource_customizer/spec/lib/forest_admin_datasource_customizer/decorators/action/base_action_spec.rb b/packages/forest_admin_datasource_customizer/spec/lib/forest_admin_datasource_customizer/decorators/action/base_action_spec.rb index e9fc6aacd..5e74903f7 100644 --- a/packages/forest_admin_datasource_customizer/spec/lib/forest_admin_datasource_customizer/decorators/action/base_action_spec.rb +++ b/packages/forest_admin_datasource_customizer/spec/lib/forest_admin_datasource_customizer/decorators/action/base_action_spec.rb @@ -225,6 +225,27 @@ module Action expect(result.content).to eq('foo
') end end + + context 'when element is a Row' do + let(:element) { { type: 'Layout', component: 'Row', fields: [field_send_notification, field_message] } } + + it 'returns a row element' do + result = action.build_layout_element(element) + expect(result).to be_a(ForestAdminDatasourceCustomizer::Decorators::Action::FormLayoutElement::RowElement) + expect(result.fields[0].label).to eq('Send a notification') + expect(result.fields[1].label).to eq('Notification message') + end + + it 'raises an exception when fields are missing' do + element.delete(:fields) + expect { action.build_layout_element(element) }.to raise_error(ForestAdminDatasourceToolkit::Exceptions::ForestException) + end + + it 'raises an exception when fields contain a layout element' do + element[:fields] << { type: 'Layout' } + expect { action.build_layout_element(element) }.to raise_error(ForestAdminDatasourceToolkit::Exceptions::ForestException) + end + end end describe 'when check form is static' do @@ -237,7 +258,7 @@ module Action end context 'when all fields are static' do - let(:form) { [instance_double(DynamicField, static?: true), instance_double(DynamicField, static?: true)] } + let(:form) { [instance_double(DynamicField, static?: true, type: 'String'), instance_double(DynamicField, static?: true, type: 'String')] } let(:action) { described_class.new(scope: :single, form: form) } it 'returns true' do diff --git a/packages/forest_admin_datasource_toolkit/lib/forest_admin_datasource_toolkit/components/actions/action_field_factory.rb b/packages/forest_admin_datasource_toolkit/lib/forest_admin_datasource_toolkit/components/actions/action_field_factory.rb index 1c91d60fc..0a7fd1183 100644 --- a/packages/forest_admin_datasource_toolkit/lib/forest_admin_datasource_toolkit/components/actions/action_field_factory.rb +++ b/packages/forest_admin_datasource_toolkit/lib/forest_admin_datasource_toolkit/components/actions/action_field_factory.rb @@ -18,6 +18,10 @@ def self.build_layout_element(field) ActionLayoutElement::SeparatorElement.new(**field) when 'HtmlBlock' ActionLayoutElement::HtmlBlockElement.new(**field) + when 'Row' + return ActionLayoutElement::RowElement.new(**field) unless field[:fields].empty? + + nil end end diff --git a/packages/forest_admin_datasource_toolkit/lib/forest_admin_datasource_toolkit/components/actions/action_layout_element.rb b/packages/forest_admin_datasource_toolkit/lib/forest_admin_datasource_toolkit/components/actions/action_layout_element.rb index 35fd24c13..3ab0569b3 100644 --- a/packages/forest_admin_datasource_toolkit/lib/forest_admin_datasource_toolkit/components/actions/action_layout_element.rb +++ b/packages/forest_admin_datasource_toolkit/lib/forest_admin_datasource_toolkit/components/actions/action_layout_element.rb @@ -43,6 +43,15 @@ def initialize(**options) super(component: 'Separator', **options) end end + + class RowElement < BaseLayoutElement + attr_accessor :fields + + def initialize(fields:, **options) + super(component: 'Row', **options) + @fields = fields + end + end end end end