gloo-web 1.0

data/lib/objs/field.rb

@@ -0,0 +1,428 @@
+# Author::    Eric Crane  (mailto:eric.crane@mac.com)
+# Copyright:: Copyright (c) 2025 Eric Crane.  All rights reserved.
+#
+# An HTML Form Field.
+#
+# A Form Field is the definition of a form field, including label, type, etc.
+#
+
+
+module Objs
+  class Field < Gloo::Core::Obj
+
+    KEYWORD = 'field'.freeze
+    KEYWORD_SHORT = 'field'.freeze
+
+    # Form
+    NAME = 'name'.freeze
+    ID = 'id'.freeze
+    TYPE = 'type'.freeze
+    VALUE = 'value'.freeze
+    LABEL = 'label'.freeze
+    PLACEHOLDER = 'placeholder'.freeze
+    AUTOFOCUS = 'autofocus'.freeze
+    COLS = 'cols'.freeze
+    ROWS = 'rows'.freeze
+    DESCRIPTION = 'description'.freeze
+    CHECKED = 'checked'.freeze
+    OPTIONS = 'options'.freeze
+    
+    # Style attributes
+    FIELD_GROUP = 'field_group'.freeze
+    FIELD_LABEL = 'field_label'.freeze
+    FIELD_CONTROL = 'field_control'.freeze
+
+    #
+    # The name of the object type.
+    #
+    def self.typename
+      return KEYWORD
+    end
+
+    #
+    # The short name of the object type.
+    #
+    def self.short_typename
+      return KEYWORD_SHORT
+    end
+
+    # 
+    # Get the name for the form field.
+    # 
+    def name_value
+      o = find_child NAME
+
+      # If there is no child, use the obj's name
+      return self.name unless o
+
+      o = Gloo::Objs::Alias.resolve_alias( @engine, o )
+      return o ? o.value : nil
+    end
+
+    #
+    # Get the type for the form field.
+    # For example, 'text', 'password', 'checkbox', etc.
+    #
+    def type_value
+      o = find_child TYPE
+      o = Gloo::Objs::Alias.resolve_alias( @engine, o )
+      return o ? o.value : nil
+    end
+
+    #
+    # Get the value for the form field.
+    #
+    def field_value
+      o = find_child VALUE
+      o = Gloo::Objs::Alias.resolve_alias( @engine, o )
+      return o ? o.value : nil
+    end
+
+    #
+    # Get the value tag for the form field.
+    #
+    def value_tag
+      value = field_value
+      return "value='#{value}'" if value
+      return ''
+    end
+
+    #
+    # Get the label for the form field.
+    #
+    def label_value
+      o = find_child LABEL
+
+      # If there is no child, use the obj's name
+      return self.name_value.capitalize unless o
+
+      o = Gloo::Objs::Alias.resolve_alias( @engine, o )
+      return o ? o.value : nil
+    end
+
+    #
+    # Get the label tag for the form field.
+    #
+    def label_tag
+      label = label_value
+      label_data = ''
+      if label
+        label_data = <<~HTML
+          <label class="#{field_label_styles}" for="#{name_value}">
+            #{label}
+          </label>
+        HTML
+      end
+      return label_data
+    end
+
+    #
+    # Get the placeholder for the form field.
+    #
+    def placeholder_value
+      o = find_child PLACEHOLDER
+      o = Gloo::Objs::Alias.resolve_alias( @engine, o )
+      return o ? o.value : nil
+    end
+
+    #
+    # Get the placeholder tag for the form field.
+    #
+    def placeholder_tag
+      placeholder = placeholder_value
+      return "placeholder='#{placeholder}'" if placeholder
+      return ''
+    end
+
+    # 
+    # Should this field autofocus?
+    # 
+    def autofocus?
+      o = find_child AUTOFOCUS
+      o = Gloo::Objs::Alias.resolve_alias( @engine, o )
+      return nil unless o
+      return o.value
+    end
+
+    #
+    # Get the autofocus tag for the form field.
+    #
+    def autofocus_tag
+      return "autofocus='autofocus'" if autofocus?
+      return ''
+    end
+
+    # 
+    # Get the cols for the form field.
+    # 
+    def cols_value
+      o = find_child COLS
+      o = Gloo::Objs::Alias.resolve_alias( @engine, o )
+      return o ? o.value : nil
+    end
+
+    #
+    # Get the cols tag for the form field.
+    #
+    def cols_tag
+      cols = cols_value
+      return "col-#{cols}" if cols
+      return ''
+    end
+
+    # 
+    # Get the rows for the form field.
+    # Only applies to textarea fields.
+    # 
+    def rows_value
+      o = find_child ROWS
+      o = Gloo::Objs::Alias.resolve_alias( @engine, o )
+      return o ? o.value : nil
+    end
+
+    #
+    # Get the rows tag for the form field.
+    # Only applies to textarea fields.
+    #
+    def rows_tag
+      rows = rows_value
+      return "rows='#{rows}'" if rows
+      return ''
+    end
+
+    #
+    # Get the description for the form field.
+    #
+    def description_value
+      o = find_child DESCRIPTION
+      o = Gloo::Objs::Alias.resolve_alias( @engine, o )
+      return o ? o.value : nil
+    end
+
+    # 
+    # Should this field be checked?
+    # 
+    def checked?
+      o = find_child CHECKED
+      o = Gloo::Objs::Alias.resolve_alias( @engine, o )
+      return nil unless o
+      return o.value
+    end
+
+    #
+    # Get the checked tag for the form field.
+    #
+    def checked_tag
+      return "checked='checked'" if checked?
+      return ''
+    end
+
+    # 
+    # Get options for the select list.
+    # 
+    def select_options
+      o = find_child OPTIONS
+      o = Gloo::Objs::Alias.resolve_alias( @engine, o )
+      return nil unless o
+
+      selected_value = field_value
+
+      options = ''
+      o.children.each do |child|
+        if selected_value == child.name || selected_value == child.value
+          selected = 'selected="selected"'
+        else
+          selected = ''
+        end
+        options += <<~HTML
+          <option value="#{child.name}" #{selected}>#{child.value}</option>
+        HTML
+      end
+      return options
+    end
+
+    # 
+    # Get the field group styles.
+    # 
+    def field_group_styles
+      o = find_child FIELD_GROUP
+      if o
+        o = Gloo::Objs::Alias.resolve_alias( @engine, o )
+        return o ? o.value : ''
+      end
+      
+      return @styles[FIELD_GROUP] || ''
+    end
+
+    # 
+    # Get the field label styles.
+    # 
+    def field_label_styles
+      o = find_child FIELD_LABEL
+      if o
+        o = Gloo::Objs::Alias.resolve_alias( @engine, o )
+        return o ? o.value : ''
+      end
+      
+      return @styles[FIELD_LABEL] || ''
+    end
+
+    # 
+    # Get the field control styles.
+    # 
+    def field_control_styles
+      o = find_child FIELD_CONTROL
+      if o
+        o = Gloo::Objs::Alias.resolve_alias( @engine, o )
+        return o ? o.value : ''
+      end
+      
+      return @styles[FIELD_CONTROL] || ''
+    end
+
+
+    # ---------------------------------------------------------------------
+    #    Children
+    # ---------------------------------------------------------------------
+
+    #
+    # Does this object have children to add when an object
+    # is created in interactive mode?
+    # This does not apply during obj load, etc.
+    #
+    def add_children_on_create?
+      return true
+    end
+
+    #
+    # Add children to this object.
+    # This is used by containers to add children needed
+    # for default configurations.
+    #
+    def add_default_children
+      fac = @engine.factory
+
+      # Create attributes with ID and Classes
+      fac.create_string NAME, '', self
+      fac.create_string TYPE, 'text', self
+    end
+
+
+    # ---------------------------------------------------------------------
+    #    Messages
+    # ---------------------------------------------------------------------
+
+    #
+    # Get a list of message names that this object receives.
+    #
+    def self.messages
+      return super + [ 'render' ]
+    end
+
+    #
+    # Render the form field.
+    #
+    def msg_render
+      content = self.render
+      @engine.heap.it.set_to content 
+      return content
+    end
+
+
+    # ---------------------------------------------------------------------
+    #    Render
+    # ---------------------------------------------------------------------
+
+    # 
+    # Render the field, switch on type.
+    def render styles = {}
+      @styles = styles
+
+      case type_value
+      when 'text'
+        return render_text
+      when 'hidden'
+        return render_hidden
+      when 'textarea'
+        return render_textarea
+      when 'checkbox'
+        return render_checkbox
+      when 'search'
+        return render_text
+      when 'select'
+        return render_select
+      end
+    end
+
+    # 
+    # Render the hidden field as HTML.
+    # 
+    def render_hidden
+      return <<~HTML
+        <input type="hidden" #{value_tag} name="#{name_value}" id="#{name_value}" />
+      HTML
+    end
+
+    # 
+    # Render the text field as HTML.
+    # 
+    def render_text
+      return <<~HTML
+        <div class="#{field_group_styles} #{cols_tag}">
+          #{label_tag}
+          <input #{placeholder_tag} #{autofocus_tag} #{rows_tag}
+            class="#{field_control_styles}" 
+            type="#{type_value}" #{value_tag}
+            name="#{name_value}" id="#{name_value}" />
+        </div>
+      HTML
+    end
+
+    # 
+    # Render the textarea field as HTML.
+    # 
+    def render_textarea
+      return <<~HTML
+        <div class="#{field_group_styles} #{cols_tag}">
+          #{label_tag}
+          <textarea #{placeholder_tag} #{autofocus_tag} #{rows_tag}
+            class="#{field_control_styles}" 
+            name="#{name_value}" id="#{name_value}">#{field_value}</textarea>
+        </div>
+      HTML
+    end
+
+    # 
+    # Render the checkbox field as HTML.
+    # 
+    def render_checkbox
+      return <<~HTML
+        <div class="#{field_group_styles} #{cols_tag}">
+          #{label_tag}
+          <label class="checkbox #{field_control_styles}">
+            <input type="checkbox" 
+              #{checked_tag} value="true"
+              name="#{name_value}" id="#{name_value}" />
+              #{description_value}
+          </label>
+        </div>
+      HTML
+    end
+
+    # 
+    # Render the select field as HTML.
+    # 
+    def render_select
+      return <<~HTML
+        <div class="#{field_group_styles} #{cols_tag}">
+          #{label_tag}
+          <select class="#{field_control_styles}" 
+            name="#{name_value}" id="#{name_value}">
+            #{select_options}
+          </select>
+        </div>
+      HTML
+    end
+
+  end
+end

data/lib/objs/form.rb

@@ -0,0 +1,269 @@
+# Author::    Eric Crane  (mailto:eric.crane@mac.com)
+# Copyright:: Copyright (c) 2025 Eric Crane.  All rights reserved.
+#
+# An HTML Form.
+#
+# A Form is the definition of a form, with a collection of form fields
+#
+
+module Objs
+  class Form < Gloo::Core::Obj
+
+    KEYWORD = 'form'.freeze
+    KEYWORD_SHORT = 'form'.freeze
+
+    # Form
+    NAME = 'name'.freeze
+    ID = 'id'.freeze
+    METHOD = 'method'.freeze
+    METHOD_DEFAULT = 'post'.freeze
+    ACTION = 'action'.freeze
+    CANCEL_PATH = 'cancel_path'.freeze
+    CONTENT = 'content'.freeze
+    STYLES = 'styles'.freeze
+
+
+    #
+    # The name of the object type.
+    #
+    def self.typename
+      return KEYWORD
+    end
+
+    #
+    # The short name of the object type.
+    #
+    def self.short_typename
+      return KEYWORD_SHORT
+    end
+
+    # 
+    # Get the name for the form.
+    # 
+    def name_value
+      o = find_child NAME
+      o = Gloo::Objs::Alias.resolve_alias( @engine, o )
+      return o ? o.value : nil
+    end
+    
+    # 
+    # Get the method for the form.
+    # 'post' is the default.
+    # 
+    def method_value
+      o = find_child METHOD
+      o = Gloo::Objs::Alias.resolve_alias( @engine, o )
+      return o.value || METHOD_DEFAULT
+    end
+
+    # 
+    # Get the action for the form.
+    # This is the path to POST to, for example.
+    # 
+    def action_value
+      o = find_child ACTION
+      o = Gloo::Objs::Alias.resolve_alias( @engine, o )
+      return o ? o.value : nil
+    end
+
+    # 
+    # Get the cancel path for the form.
+    # 
+    def cancel_path_value
+      o = find_child CANCEL_PATH
+      o = Gloo::Objs::Alias.resolve_alias( @engine, o )
+      return o ? o.value : nil
+    end
+
+    # 
+    # Get all the form content, the collection of form fields.
+    # 
+    def form_content
+      o = find_child CONTENT
+      o = Gloo::Objs::Alias.resolve_alias( @engine, o )
+      return o
+    end
+
+    # 
+    # Get the styles for the form.
+    # Retuns styles in the form of a hash:
+    # { 'field_group' => 'form-group mt-3', … }
+    # 
+    def styles
+      style_h = {} 
+      o = find_child STYLES
+      return style_h unless o
+      o = Gloo::Objs::Alias.resolve_alias( @engine, o )
+
+      o.children.each do |c|
+        style_h[ c.name ] = c.value
+      end
+
+      # puts "styles: #{style_h}"
+      return style_h
+    end
+
+    # 
+    # Get the form styles.
+    # Use the name if none is provided.
+    # 
+    def form_styles
+      return @styles['form'] || name_value
+    end
+
+    # 
+    # Get the submit button styles.
+    # 
+    def submit_button_styles
+      return @styles['submit'] || ''
+    end
+
+    # 
+    # Get the cancel button styles.
+    # 
+    def cancel_button_styles
+      return @styles['cancel'] || ''
+    end
+
+
+    # ---------------------------------------------------------------------
+    #    Children
+    # ---------------------------------------------------------------------
+
+    #
+    # Does this object have children to add when an object
+    # is created in interactive mode?
+    # This does not apply during obj load, etc.
+    #
+    def add_children_on_create?
+      return true
+    end
+
+    #
+    # Add children to this object.
+    # This is used by containers to add children needed
+    # for default configurations.
+    #
+    def add_default_children
+      fac = @engine.factory
+
+      # Create attributes with ID and Classes
+      fac.create_string NAME, '', self
+      fac.create_string METHOD, 'post', self
+      fac.create_string ACTION, '', self
+      fac.create_string CANCEL_PATH, '', self
+
+      fac.create_can CONTENT, self
+    end
+
+
+    # ---------------------------------------------------------------------
+    #    Messages
+    # ---------------------------------------------------------------------
+
+    #
+    # Get a list of message names that this object receives.
+    #
+    def self.messages
+      return super + [ 'render' ]
+    end
+
+    #
+    # Render the form and all contained fields.
+    #
+    def msg_render
+      content = self.render
+      @engine.heap.it.set_to content 
+      return content
+    end
+
+
+    # ---------------------------------------------------------------------
+    #    Render
+    # ---------------------------------------------------------------------
+
+    # 
+    # Open the form.
+    # 
+    def open_form
+      name = name_value
+
+      cancel_button = ""
+      if cancel_path_value
+        cancel_button = <<~HTML
+          <a class="#{cancel_button_styles}"
+            href="#{cancel_path_value}"> 
+            Cancel</a>
+        HTML
+      end
+      return <<~HTML
+        <form class='#{form_styles}'
+              id='#{name}'
+              method='#{method_value}'
+              action='#{action_value}'
+              accept-charset='UTF-8'>
+          <div class="actions">
+            <input type="submit" 
+              name="commit" 
+              value="Save" 
+              class="#{submit_button_styles}" 
+              data-disable-with="Saving..." />
+
+          #{cancel_button}
+          </div>
+      HTML
+    end
+
+    # 
+    # Close the form.
+    # 
+    def close_form
+      return "</form>"
+    end
+
+    # 
+    # Render the Form as HTML.
+    # 
+    def render
+      @styles = styles
+      return open_form + render_content + close_form
+    end
+
+    # 
+    # Render the element content using the specified render function.
+    # This is a recursive function (through one of the other render functions).
+    # 
+    def render_content 
+      fields = ""
+      field_can = form_content
+      return "" if field_can.nil?
+
+      field_can.children.each do |o|
+        o = Gloo::Objs::Alias.resolve_alias( @engine, o )
+        if o.class == Field
+          fields << o.render( @styles )
+        elsif o.class == Element
+          fields << o.render_html
+        elsif o
+          data = render_thing o
+          ( fields << data ) if data 
+        end
+      end
+
+      return fields
+    end
+
+    # 
+    # Render a string or other object.
+    # 
+    def render_thing e
+      begin
+        return e.render( 'render_html' )
+      rescue => e
+        @engine.log_exception e
+        return ''
+      end
+    end
+
+  end
+end