forest_admin_datasource_customizer 1.0.0.pre.beta.21 → 1.0.0.pre.beta.57

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

@@ -0,0 +1,67 @@
+module ForestAdminDatasourceCustomizer
+  module Decorators
+    module Action
+      class BaseAction
+        attr_reader :scope, :form, :is_generate_file, :execute
+
+        def initialize(scope:, form: nil, is_generate_file: false, &execute)
+          @scope = scope
+          @form = form
+          @is_generate_file = is_generate_file
+          @execute = execute
+        end
+
+        def build_fields
+          @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)
+            else
+              DynamicField.new(**field)
+            end
+          end
+        end
+
+        def static_form?
+          return form&.all?(&:static?) if form
+
+          true
+        end
+      end
+    end
+  end
+end

data/lib/forest_admin_datasource_customizer/decorators/action/context/action_context.rb

@@ -0,0 +1,56 @@
+module ForestAdminDatasourceCustomizer
+  module Decorators
+    module Action
+      module Context
+        class ActionContext < ForestAdminDatasourceCustomizer::Context::CollectionCustomizationContext
+          include ForestAdminDatasourceToolkit
+
+          attr_reader :filter, :used, :form_values
+
+          def initialize(collection, caller, form_values, filter, used = [], change_field = nil)
+            super(collection, caller)
+            @form_values = form_values
+            @filter = filter
+            @used = used
+            @change_field = change_field
+          end
+
+          def field_changed?(field_name)
+            @used << field_name
+
+            @change_field == field_name
+          end
+
+          def get_form_value(key)
+            @used << key
+
+            @form_values[key]
+          end
+
+          def get_records(fields = [])
+            Validations::ProjectionValidator.validate?(@real_collection, fields)
+
+            @real_collection.list(@caller, @filter, Components::Query::Projection.new)
+          end
+
+          def record_ids
+            composite_ids = composite_record_ids
+
+            composite_ids.map { |id| id[0] }
+          end
+
+          def composite_record_ids
+            projection = Components::Query::Projection.new.with_pks(@real_collection)
+            records = get_records(projection)
+
+            records.map { |record| Utils::Record.primary_keys(@real_collection, record) }
+          end
+
+          alias get_record_ids record_ids
+          alias get_composite_record_ids composite_record_ids
+          alias has_field_changed field_changed?
+        end
+      end
+    end
+  end
+end

data/lib/forest_admin_datasource_customizer/decorators/action/context/action_context_single.rb

@@ -0,0 +1,26 @@
+module ForestAdminDatasourceCustomizer
+  module Decorators
+    module Action
+      module Context
+        class ActionContextSingle < ActionContext
+          include ForestAdminDatasourceToolkit
+
+          def get_record(fields = [])
+            get_records(fields)[0]
+          end
+
+          def record_id
+            composite_record_id[0]
+          end
+
+          def composite_record_id
+            composite_record_ids[0]
+          end
+
+          alias get_record_id record_id
+          alias get_composite_record_id composite_record_id
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,50 @@
+module ForestAdminDatasourceCustomizer
+  module Decorators
+    module Action
+      class DynamicField
+        attr_accessor :type, :label, :description, :is_required, :is_read_only, :if_condition, :value, :default_value,
+                      :collection_name, :enum_values, :placeholder
+
+        def initialize(
+          type:,
+          label:,
+          description: nil,
+          is_required: false,
+          is_read_only: false,
+          if_condition: nil,
+          value: nil,
+          default_value: nil,
+          collection_name: nil,
+          enum_values: nil,
+          placeholder: nil,
+          **_kwargs
+        )
+          @type = type
+          @label = label
+          @description = description
+          @is_required = is_required
+          @is_read_only = is_read_only
+          @if_condition = if_condition
+          @value = value
+          @default_value = default_value
+          @collection_name = collection_name
+          @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
+end

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

@@ -0,0 +1,68 @@
+module ForestAdminDatasourceCustomizer
+  module Decorators
+    module Action
+      class ResultBuilder
+        def initialize
+          @headers = {}
+        end
+
+        def set_header(key, value)
+          @headers[key] = value
+
+          self
+        end
+
+        def success(message: 'Success', options: {})
+          {
+            headers: @headers,
+            type: 'Success',
+            message: message,
+            refresh: { relationships: options.key?(:invalidated) ? options[:invalidated] : [] },
+            html: options.key?(:html) ? options[:html] : nil
+          }
+        end
+
+        def error(message: 'Error', options: {})
+          {
+            headers: @headers,
+            type: 'Error',
+            status: 400,
+            message: message,
+            html: options.key?(:html) ? options[:html] : nil
+          }
+        end
+
+        def webhook(url:, method: 'POST', headers: {}, body: {})
+          {
+            headers: @headers,
+            type: 'Webhook',
+            webhook: {
+              body: body,
+              headers: headers,
+              method: method,
+              url: url
+            }
+          }
+        end
+
+        def file(content:, name: 'file', mime_type: 'application/octet-stream')
+          {
+            headers: @headers,
+            type: 'File',
+            name: name,
+            mime_type: mime_type,
+            stream: content
+          }
+        end
+
+        def redirect_to(path:)
+          {
+            headers: @headers,
+            type: 'Redirect',
+            redirect_to: path
+          }
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,15 @@
+module ForestAdminDatasourceCustomizer
+  module Decorators
+    module Action
+      module Types
+        module ActionScope
+          SINGLE = 'single'.freeze
+
+          BULK = 'bulk'.freeze
+
+          GLOBAL = 'global'.freeze
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,35 @@
+module ForestAdminDatasourceCustomizer
+  module Decorators
+    module Action
+      module Types
+        module FieldType
+          BOOLEAN = 'Boolean'.freeze
+
+          DATE = 'Date'.freeze
+
+          DATE_ONLY = 'Dateonly'.freeze
+
+          COLLECTION = 'Collection'.freeze
+
+          ENUM = 'Enum'.freeze
+
+          ENUM_LIST = 'EnumList'.freeze
+
+          FILE = 'File'.freeze
+
+          FILE_LIST = 'FileList'.freeze
+
+          JSON = 'Json'.freeze
+
+          NUMBER = 'Number'.freeze
+
+          NUMBER_LIST = 'NumberList'.freeze
+
+          STRING = 'String'.freeze
+
+          STRING_LIST = 'StringList'.freeze
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,357 @@
+module ForestAdminDatasourceCustomizer
+  module Decorators
+    module Action
+      module WidgetField
+        include Types
+        def self.validate_arg(options, attribute, rule)
+          case rule[attribute]
+          when 'contains'
+            unless rule[:value].include? options[attribute]
+              raise ForestAdminDatasourceToolkit::Exceptions::ForestException,
+                    "'#{attribute}' must have a value included in [#{rule[:value]}]"
+            end
+          when 'present'
+            unless options.key? attribute
+              raise ForestAdminDatasourceToolkit::Exceptions::ForestException,
+                    "key '#{attribute}' must be defined"
+            end
+          end
+        end
+
+        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