Contents

require "formalist/element/attributes"
require "formalist/element/class_interface"
require "formalist/types"

module Formalist
  class Element
    extend ClassInterface

    # @api private
    attr_reader :attributes, :children, :input, :errors

    # @api private
    def initialize(*args, attributes, children, input, errors)
      # Set supplied attributes or their defaults
      full_attributes = self.class.attributes_schema.each_with_object({}) { |(name, defn), memo|
        value = attributes[name] || defn[:default]
        memo[name] = value unless value.nil?
      }

      # Then run them through the schema
      @attributes = Types::Hash.schema(self.class.attributes_schema.map { |name, defn| [name, defn[:type]] }.to_h).(full_attributes)

      @children = []
      @input = input
      @errors = errors
    end

    # Returns the element's type, which is a symbolized, camlized
    # representation of the element's class name.
    #
    # This is a critical hook for customising form rendering when using custom
    # form elements, since the type in this case will be based on the name of
    # form element's sublass.
    #
    # @example Basic element
    #   field.type # => :field
    #
    # @example Custom element
    #   my_field.type # => :my_field
    #
    # @return [Symbol] the element type.
    def type
      self.class.type
    end

    # @abstract
    def to_ast
      raise NotImplementedError
    end
  end
end

Version data entries

2 entries across 2 versions & 1 rubygems

Version	Path
formalist-0.3.0	lib/formalist/element.rb
formalist-0.2.3	lib/formalist/element.rb