Skip to content

feat(form): add support of static form with layout elements #76

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
nicolasalexandre9 merged 2 commits into from
Oct 10, 2024
Merged

feat(form): add support of static form with layout elements #76

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
77b8254
feat(form): add support of static form with layout elements
nicolasalexandre9 Oct 9, 2024
587014c
test: update test on generator action and add test with dynamic layou…
nicolasalexandre9 Oct 9, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions packages/forest_admin_agent/lib/forest_admin_agent/utils/schema/generator_action.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ def self.build_schema(collection, name)
layout = form_elements[:layout]
else
fields = DEFAULT_FIELDS
layout = nil
layout = []
end

schema = {
Expand All @@ -57,9 +57,9 @@ def self.build_schema(collection, name)
}
}

return schema unless layout && !layout.empty?
return schema if layout.all? { |element| element.component == 'Input' }

# schema[:layout] = build_layout(layout)
schema[:layout] = build_layout(layout)

schema
end
Expand Down
180 changes: 166 additions & 14 deletions ...ages/forest_admin_agent/spec/lib/forest_admin_agent/utils/schema/generator_action_spec.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -266,10 +266,10 @@ module Schema
widgetEdit: nil
}
],
# layout: [
# { component: 'input', fieldId: 'label', type: 'Layout' },
# { component: 'separator', type: 'Layout' }
# ],
layout: [
{ component: 'input', fieldId: 'label', type: 'Layout' },
{ component: 'separator', type: 'Layout' }
],
hooks: { load: false, change: ['changeHook'] }
}
)
Expand Down Expand Up @@ -320,10 +320,10 @@ module Schema
widgetEdit: nil
}
],
# layout: [
# { component: 'input', fieldId: 'label', type: 'Layout' },
# { component: 'htmlBlock', type: 'Layout', content: '<p>foo</p>' }
# ],
layout: [
{ component: 'input', fieldId: 'label_id', type: 'Layout' },
{ component: 'htmlBlock', type: 'Layout', content: '<p>foo</p>' }
],
hooks: { load: false, change: ['changeHook'] }
}
)
Expand Down Expand Up @@ -388,9 +388,16 @@ module Schema
defaultValue: nil
}
],
# layout: [
# { component: 'row', type: 'Layout', fields: ['label'] }
# ],
layout: [
{
component: 'row',
type: 'Layout',
fields: [
{ component: 'input', fieldId: 'label_id', type: 'Layout' },
{ component: 'input', fieldId: 'amount_id', type: 'Layout' }
]
}
],
hooks: { load: false, change: ['changeHook'] }
}
)
Expand Down Expand Up @@ -462,15 +469,160 @@ module Schema
defaultValue: nil
}
],
# layout: [
# { component: 'page', type: 'Layout', elements: ['htmlBlock', 'row'] }
# ],
layout: [
{
component: 'page',
type: 'Layout',
nextButtonLabel: 'Next',
previousButtonLabel: 'Previous',
elements: [
{
component: 'htmlBlock',
content: '<h1>Charge the credit card of the customer</h1>',
type: 'Layout'
},
{
component: 'row',
type: 'Layout',
fields: [
{ component: 'input', fieldId: 'label', type: 'Layout' },
{ component: 'input', fieldId: 'amount', type: 'Layout' }
]
}
]
}
],
hooks: { load: false, change: ['changeHook'] }
}
)
end
end

context 'with dynamic element' do
before do
@collection = collection_build(
schema: {
actions: {
'Charge credit card' => BaseAction.new(
scope: Types::ActionScope::SINGLE,
form: [
FormLayoutElement::PageElement.new(
if_condition: proc { true },
elements: []
)
]
)
}
}
)
end

it 'generate default loading schema' do
schema = described_class.build_schema(@collection, 'Charge credit card')

expect(schema).to eq(
{
id: 'collection-0-charge-credit-card',
name: 'Charge credit card',
submitButtonLabel: nil,
description: nil,
type: 'single',
baseUrl: nil,
endpoint: '/forest/_actions/collection/0/charge-credit-card',
httpMethod: 'POST',
redirect: nil,
download: false,
fields: [
{
defaultValue: 'Form is loading',
description: '',
enums: nil,
field: 'Loading...',
hook: nil,
isReadOnly: true,
isRequired: false,
label: 'Loading...',
reference: nil,
type: 'String',
value: nil,
widgetEdit: nil
}
],
hooks: { load: true, change: ['changeHook'] }
}
)
end
end

context 'with nested dynamic element in page' do
before do
@collection = collection_build(
schema: {
actions: {
'Charge credit card' => BaseAction.new(
scope: Types::ActionScope::SINGLE,
form: [
FormLayoutElement::PageElement.new(
elements: [
{
type: 'Layout',
component: 'HtmlBlock',
content: '<h1>Charge the credit card of the customer</h1>'
},
{
type: 'Layout',
component: 'Row',
fields: [
{ id: 'label', label: 'label', type: 'String', if_condition: proc { true } },
{ id: 'amount', label: 'amount', type: 'String' }
]
}
]
)
]
)
}
}
)
end

it 'generate default loading schema' do
schema = described_class.build_schema(@collection, 'Charge credit card')

expect(schema).to eq(
{
id: 'collection-0-charge-credit-card',
name: 'Charge credit card',
submitButtonLabel: nil,
description: nil,
type: 'single',
baseUrl: nil,
endpoint: '/forest/_actions/collection/0/charge-credit-card',
httpMethod: 'POST',
redirect: nil,
download: false,
fields: [
{
defaultValue: 'Form is loading',
description: '',
enums: nil,
field: 'Loading...',
hook: nil,
isReadOnly: true,
isRequired: false,
label: 'Loading...',
reference: nil,
type: 'String',
value: nil,
widgetEdit: nil
}
],
hooks: { load: true, change: ['changeHook'] }
}
)
end
end

describe 'extract_fields_and_layout' do
before do
@collection = collection_build(
Expand Down
2 changes: 1 addition & 1 deletion ...source_customizer/lib/forest_admin_datasource_customizer/decorators/action/base_action.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ def build_elements
end

def static_form?
return form&.all?(&:static?) && form&.none? { |field| field.type == 'Layout' } if form
return form&.all?(&:static?) if form

true
end
Expand Down
8 changes: 8 additions & 0 deletions ...ustomizer/lib/forest_admin_datasource_customizer/decorators/action/form_layout_element.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,10 @@ def initialize(options)
@fields = instantiate_subfields(options[:fields] || [])
end

def static?
super && fields&.all?(&:static?)
end

private

def validate_fields_presence!(options)
Expand Down Expand Up @@ -77,6 +81,10 @@ def initialize(options)
@elements = instantiate_elements(options[:elements] || [])
end

def static?
super && elements&.all?(&:static?)
end

private

def validate_elements_presence!(options)
Expand Down