gloo 4.3.0 → 4.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f68137523fd4bda7f48c75dc97b99da12dd24b4bc12dbe6ec1a5d608b05e7ab3
-  data.tar.gz: 611305b9634cf5d1742ab3241c74c57b14edb19d233606ec1fe0d35401c6dc2f
+  metadata.gz: c0cb1d5428d6f7d2de892b588de73cef44bded6418fd69929d966e25c14a32d9
+  data.tar.gz: bff713e6cc80fab161f0d0070ecfd04c8a1481faa5086d399982e1bfe91bfb03
 SHA512:
-  metadata.gz: ecf31d454b8bcfcaac603c73ab3bcb1b8b0d5e551a919f38e7e80f52add50000284bf5426f1f8c50050f4476bfed0528d7ff74ad1aee02fd0951fe09db1103aa
-  data.tar.gz: 13f51ba5152a76aa032b28f4787ec7bfc67df616339d9ab079fc253fdc37f096c177e4ef81bd3d4e34dd85a5a338d493ada871a0e29e5045db9d2cfedf91dea5
+  metadata.gz: b20fdac6c4dee94e91075e2e72caefc2e448ddeb6198a2e7470b3af8edb0069211ca9d5f425d1cf2fc1149a9c84778b7008d6148528fd2a91c28e4cb6ced48d6
+  data.tar.gz: ca7be6a02372200e9773279b769aaa46aef2df6a8e577cc5446fc7e2af48571fd5a721f68f6c27eeffe37d0c057635544de181502feea9b371400c35e60e7d4c

data/lib/VERSION

@@ -1 +1 @@
-4.3.0
+4.5.0

data/lib/VERSION_NOTES

@@ -1,3 +1,12 @@
+4.5.0 - 2025.08.05
+ - Adds option to use assets in the user lib.
+
+
+4.4.0 - 2025.07.30
+ - Adds form and fields
+ - Adds option to include image_tag and other asset tags in helper rendering.
+
+
 4.3.0 - 2025.07.02
  - Removes postgres dependency (for now)
 

data/lib/gloo/objs/ctrl/function.rb

@@ -71,6 +71,22 @@ module Gloo
         return return_any ? return_any.value : nil
       end
 
+      #
+      # Get the params hash from the child object.
+      # Returns nil if there is none.
+      #
+      def params_hash
+        params_can = find_child PARAMS
+        return nil unless params_can
+
+        h = {}
+        params_can.children.each do |o|
+          h[ o.name ] = o.value
+        end
+
+        return h
+      end
+
 
       # ---------------------------------------------------------------------
       #    Children
@@ -156,7 +172,12 @@ module Gloo
 
         set_params args if args
         run_on_invoke
-        return_value = result
+
+        if @engine.running_app&.obj&.embedded_renderer 
+          return_value = @engine.running_app.obj.embedded_renderer.render result, params_hash
+        else
+          return_value = result
+        end
         @engine.heap.it.set_to return_value
         run_after_invoke
         

data/lib/gloo/objs/web_svr/element.rb

@@ -226,6 +226,8 @@ module Gloo
             e = Gloo::Objs::Alias.resolve_alias( engine, e )
             if e.class == Element
               rendered_obj_content << e.send( render_ƒ )
+            elsif e.class == Form
+              rendered_obj_content << e.render
             elsif e
               data = render_thing e, render_ƒ, engine
               ( rendered_obj_content << data ) if data # e.render( render_ƒ )

data/lib/gloo/objs/web_svr/field.rb

@@ -0,0 +1,429 @@
+# 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 Gloo
+  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
+end

data/lib/gloo/objs/web_svr/form.rb

@@ -0,0 +1,271 @@
+# 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 Gloo
+  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
+end

data/lib/gloo/web_svr/asset.rb

@@ -8,6 +8,7 @@ module Gloo
   module WebSvr
     class Asset
       
+      LIB_FOLDER = 'lib'.freeze
       ASSET_FOLDER = 'asset'.freeze
       IMAGE_FOLDER = 'image'.freeze
       STYLESHEET_FOLDER = 'stylesheet'.freeze
@@ -35,6 +36,55 @@ module Gloo
       end
 
 
+      # ---------------------------------------------------------------------
+      #    lib asset Helpers
+      # ---------------------------------------------------------------------
+
+      # 
+      # Get the asset folder in the User's lib.
+      # Returns nil if it does not exist.
+      #
+      def lib_asset_folder
+        dir = File.join( @engine.settings.user_root, LIB_FOLDER, ASSET_FOLDER )
+        return dir if Dir.exist?( dir )
+
+        return nil
+      end
+
+      # 
+      # Get the stylesheets folder in the User's lib.
+      # Returns nil if it does not exist.
+      #
+      def lib_stylesheet_folder
+        dir = File.join( lib_asset_folder, STYLESHEET_FOLDER )
+        return dir if Dir.exist?( dir )
+
+        return nil
+      end
+
+      # 
+      # Get the javascript folder in the User's lib.
+      # Returns nil if it does not exist.
+      #
+      def lib_javascript_folder
+        dir = File.join( lib_asset_folder, JAVASCRIPT_FOLDER )
+        return dir if Dir.exist?( dir )
+
+        return nil
+      end
+
+      # 
+      # Get the images folder in the User's lib.
+      # Returns nil if it does not exist.
+      #
+      def lib_image_folder
+        dir = File.join( lib_asset_folder, IMAGE_FOLDER )
+        return dir if Dir.exist?( dir )
+
+        return nil
+      end
+
+
       # ---------------------------------------------------------------------
       #    Asset Helpers
       # ---------------------------------------------------------------------
@@ -79,6 +129,12 @@ module Gloo
         # Look in the web server's asset folder.
         pn = File.join( asset_folder, pn )
 
+        # Try the lib assets if not found
+        unless File.exist? pn
+          lib = lib_asset_folder
+          pn = File.join( lib, file.value ) if lib
+        end
+
         return pn
       end
 
@@ -214,6 +270,11 @@ module Gloo
       def add_images
         @log.debug 'Adding image asset routes to web server…'
         
+        lib = lib_image_folder
+        if lib
+          add_files_in_folder( lib, @images, IMAGE_FOLDER )
+        end
+
         return unless File.exist? image_folder
 
         # for each file in the images folder
@@ -227,6 +288,11 @@ module Gloo
       def add_stylesheets
         @log.debug 'Adding stylesheet asset routes to web server…'
 
+        lib = lib_stylesheet_folder
+        if lib
+          add_files_in_folder( lib, @stylesheets, STYLESHEET_FOLDER )
+        end
+
         return unless File.exist? stylesheet_folder
 
         # for each file in the stylesheets folder
@@ -245,6 +311,11 @@ module Gloo
       def add_javascript
         @log.debug 'Adding javascript asset routes to web server…'
 
+        lib = lib_javascript_folder
+        if lib
+          add_files_in_folder( lib, @javascript, JAVASCRIPT_FOLDER )
+        end
+
         return unless File.exist? javascript_folder
 
         # for each file in the javascript folder

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gloo
 version: !ruby/object:Gem::Version
-  version: 4.3.0
+  version: 4.5.0
 platform: ruby
 authors:
 - Eric Crane
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-07-02 00:00:00.000000000 Z
+date: 2025-08-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -482,6 +482,8 @@ files:
 - lib/gloo/objs/web/teams.rb
 - lib/gloo/objs/web/uri.rb
 - lib/gloo/objs/web_svr/element.rb
+- lib/gloo/objs/web_svr/field.rb
+- lib/gloo/objs/web_svr/form.rb
 - lib/gloo/objs/web_svr/page.rb
 - lib/gloo/objs/web_svr/partial.rb
 - lib/gloo/objs/web_svr/svr.rb