1
0
Fork 0
discourse-custom-wizard-unl.../lib/custom_wizard/field.rb
2021-07-15 18:30:33 +05:30

187 Zeilen
4,7 KiB
Ruby

# frozen_string_literal: true
class CustomWizard::Field
include ActiveModel::SerializerSupport
##
# type: step
# number: 3
# title: Add the field name to attribute map
# description: The attribute map serves as a global registry for field attributes. Set the
# key as the attribute name and value as an array of properties. Use the properties according to
# your usecase. Here's a list and description of each of the properties.
# ```
# accessible: The attribute is set as a CustomWizard::Field attr_accessor
# serializable: The attribute is serialized to the client
# permitted: The attribute is permitted in the admin controller
# mapped: The attribute is mapped and permitted (see above)
# excluded: The attribute is not initialized in the constructor
# ```
##
def self.attribute_map
{
raw: [],
id: [:serializable, :permitted],
index: [:accessible, :serializable, :permitted, :mapped],
type: [:serializable, :permitted],
step: [:accessible],
required: [:serializable, :permitted],
value: [:serializable],
description: [:serializable, :permitted],
image: [:serializable, :permitted],
key: [:permitted],
validations: [:serializable],
min_length: [:permitted],
max_length: [:serializable, :permitted],
char_counter: [:serializable, :permitted],
file_types: [:serializable, :permitted],
format: [:serializable, :permitted],
limit: [:serializable, :permitted],
property: [:serializable, :permitted],
# label is excluded so that it isn't initialized and the value
# returned by `label` method is used for serialization
label: [:excluded, :serializable, :permitted],
content: [:serializable, :permitted, :mapped],
prefill: [:permitted, :mapped],
condition: [:permitted, :mapped],
preview_template: [:serializable, :permitted, :mapped],
placeholder: [:serializable, :permitted, :mapped],
}
end
def self.all_attributes
attribute_map.keys
end
def self.included_attributes
all_attributes - excluded_attributes
end
def self.type_attributes(type)
attribute_map.map { |attribute, props| props.include?(type.to_sym) ? attribute : nil }.compact
end
def self.accessible_attributes
type_attributes(:accessible)
end
def self.excluded_attributes
type_attributes(:excluded)
end
def self.readonly_attributes
included_attributes - accessible_attributes
end
def self.serializable_attributes
type_attributes(:serializable)
end
attr_reader *readonly_attributes
attr_accessor *accessible_attributes
def initialize(attrs)
attrs.each do |k, v|
if self.singleton_class.included_attributes.include?(k.to_sym)
instance_variable_set("@#{k}", v)
end
end
@raw = attrs || {}
@required = !!attrs[:required]
@value = attrs[:value] || default_value
end
def label
@label ||= PrettyText.cook(@raw[:label])
end
def default_value
if @type == 'checkbox'
false
end
end
def self.types
@types ||= {
text: {
min_length: nil,
max_length: nil,
prefill: nil,
char_counter: nil,
validations: nil,
placeholder: nil
},
textarea: {
min_length: nil,
max_length: nil,
prefill: nil,
char_counter: nil,
placeholder: nil
},
composer: {
min_length: nil,
max_length: nil,
char_counter: nil,
placeholder: nil
},
text_only: {},
composer_preview: {
preview_template: nil,
},
date: {
format: "YYYY-MM-DD"
},
time: {
format: "HH:mm"
},
date_time: {
format: ""
},
number: {},
checkbox: {},
url: {
min_length: nil
},
upload: {
file_types: '.jpg,.jpeg,.png'
},
dropdown: {
prefill: nil,
content: nil
},
tag: {
limit: nil,
prefill: nil,
content: nil
},
category: {
limit: 1,
property: 'id',
prefill: nil,
content: nil
},
group: {
prefill: nil,
content: nil
},
user_selector: {}
}
end
def self.require_assets
@require_assets ||= {}
end
def self.register(type, plugin = nil, asset_paths = [], opts = {})
if type
types[type.to_sym] ||= {}
types[type.to_sym] = opts[:type_opts] if opts[:type_opts].present?
end
if plugin && asset_paths
require_assets[plugin] = asset_paths
end
end
end