gloo-web 1.2 → 1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 15a8ed82554f9691848a3595dc35c1514be0993e332050e6743009f46d3f777b
-  data.tar.gz: 0b353704a315cb1e9204deb0f8017f323008e9a65190bf38eb1094ce8eb15345
+  metadata.gz: db9c3c1ddca5986e3acf080e031fd88187c7fc743152d066677908652bf802ae
+  data.tar.gz: cc217525025e16cd209d109aeb5b4b564bf3312854a50236fd022a65ef92cdac
 SHA512:
-  metadata.gz: 778d8d07bc02f32c5810f02ada22eba83d81adb4494f4da094b6a264f6ea381767a074d0cb30f01a2e4fd4381846829d205f8135ab64c58eb69e988cf6512e87
-  data.tar.gz: 36c5287f9c031223729550df5c545c54e746a71ab79fcc6fd3309dc31893fdafffea9a55c8e6b041cbd747d0c3f64d78b06adc2bc3023e99fe5ef72d6069609b
+  metadata.gz: faa216dabd0a11c80e23b697fe55c5caf84a2756451d41d20df0fafd6f8812a5432e40245241e6229771e5898bc40db2c7bf30ed50c448037b887da487704d54
+  data.tar.gz: 5388fb65528f5c1bd6df05e41d64c62fcca58ba77eab5676c12932d721aa041327a822765413f3e9e07fb4a5a623a1fc8c1bca02fad10d5ee5ca4ed2aec19f17

data/README.md

@@ -0,0 +1,26 @@
+# gloo-web
+
+A core gloo library with a web server and web application framework.
+
+Provides pages, forms, and HTML elements, hosted by an in-process web server, with routing, sessions, and AJAX support built in.
+
+## Usage
+
+Load this library in a gloo script:
+
+```gloo
+> load lib web
+```
+
+## Objects
+
+- `server` — a web server running inside gloo
+- `page` — a web page hosted in a gloo web server
+- `partial` — a partial web page (a reusable fragment, rendered into other pages)
+- `form` — an HTML form, containing a collection of form fields
+- `field` — an HTML form field (text field, checkbox, etc.)
+- `element` — an HTML element
+
+## Full Reference
+
+Every object's children and messages are documented in-app once the library is loaded — e.g. `help> object page`.

data/lib/objs/element.rb

@@ -248,5 +248,40 @@ module Objs
       end
     end
 
+    # ---------------------------------------------------------------------
+    #    Object Documentation
+    # ---------------------------------------------------------------------
+
+    #
+    # Get the object's documentation data.
+    #
+    def self.doc_data
+      {
+        :name => KEYWORD,
+        :shortcut => KEYWORD_SHORT,
+        :description => 'An HTML element.',
+        :children => [
+          'attributes (container) — All attributes are optional. The attributes of the HTML element, e.g. id (string) — the element id; classes (string) — element classes and styles (css).',
+          'content (container) — The element contents.'
+        ],
+        :messages => [
+          'render — Manually render the HTML element. Normally the render is called by the web server when the page containing the element is requested.'
+        ],
+        :examples => <<~EXAMPLES.strip
+          div_sub [e] :
+            attributes [can] :
+              id [string] : sub_area
+              class [string] : mt-3
+            content [can] :
+              h2 [e] : Sub
+              p [e] :
+                attributes [can] :
+                  class [string] : lead
+                content [can] :
+                  msg [string] : Sub area text goes here.
+        EXAMPLES
+      }
+    end
+
   end
 end

data/lib/objs/field.rb

@@ -409,14 +409,14 @@ module Objs
       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}" 
+          <select class="#{field_control_styles}"
             name="#{name_value}" id="#{name_value}">
             #{select_options}
           </select>
@@ -424,5 +424,70 @@ module Objs
       HTML
     end
 
+    # ---------------------------------------------------------------------
+    #    Object Documentation
+    # ---------------------------------------------------------------------
+
+    #
+    # Get the object's documentation data.
+    #
+    def self.doc_data
+      {
+        :name => KEYWORD,
+        :shortcut => KEYWORD_SHORT,
+        :description => 'An HTML form field. Might be a text field, a ' \
+          'checkbox, a select list or other type of form field.',
+        :children => [
+          'name (string) — Optional; if not specified, the name of the object is used. Used for both the name and the id of the field element.',
+          'type (string) — Required. Examples: text, checkbox, hidden, textarea, select, etc. Some other children depend on the type of the field.',
+          'value (string) — Optional. The value of the field.',
+          'label (string) — Optional; if not specified, the name of the field is used. The label for the field.',
+          'autofocus (boolean) — Optional, default false. Whether the field should be focused when the page loads.',
+          'placeholder (string) — Optional. The placeholder text for the field.',
+          'cols (string) — Optional. The number of columns for the field, appended to the bootstrap column class (can also add offset or other column classes). Example: 6.',
+          'rows (integer) — Optional. The number of rows for a textarea field; only used for textarea fields.',
+          'field_group (string) — Optional override for form styles: the field group style classes.',
+          'field_label (string) — Optional override for form styles: the field label style classes.',
+          'field_control (string) — Optional override for form styles: the field control style classes.',
+          'options (container) — Optional; only used for select fields. The options for the select field.',
+          'checked (boolean) — Optional; only used for checkbox fields. Whether the checkbox field is checked.'
+        ],
+        :messages => [
+          'render — Manually render the HTML field. Normally the render is called by the web server when the page containing the element is requested.'
+        ],
+        :examples => <<~EXAMPLES.strip
+          f [form] :
+            name [string] : message_form
+            action [string] : /messages
+            method [string] : post
+            cancel_path [string] : /messages
+            styles [alias] : form_styles
+            content [can] :
+              id [field] :
+                type [string] : hidden
+                value [string] : 13
+              message [field] :
+                type [string] : text
+                autofocus [boolean] : true
+                placeholder [string] : the message goes here…
+              description [field] :
+                type [string] : text
+                placeholder [string] : longer description…
+              opt [field] :
+                label [string] : Option
+                type [string] : select
+                value [string] : Option 3
+                options [can] :
+                  1 [string] : Option 1
+                  2 [string] : Option 2
+                  3 [string] : Option 3
+              box [field] :
+                type [string] : checkbox
+                checked [boolean] : false
+                description [string] : Check this box if you want to box it.
+        EXAMPLES
+      }
+    end
+
   end
 end

data/lib/objs/form.rb

@@ -253,9 +253,9 @@ module Objs
       return fields
     end
 
-    # 
+    #
     # Render a string or other object.
-    # 
+    #
     def render_thing e
       begin
         return e.render( 'render_html' )
@@ -265,5 +265,60 @@ module Objs
       end
     end
 
+    # ---------------------------------------------------------------------
+    #    Object Documentation
+    # ---------------------------------------------------------------------
+
+    #
+    # Get the object's documentation data.
+    #
+    def self.doc_data
+      {
+        :name => KEYWORD,
+        :shortcut => KEYWORD_SHORT,
+        :description => 'An HTML form. Contains a collection of form fields.',
+        :children => [
+          'name (string) — The name of the form, used for both the name and the id of the form element.',
+          'action (string) — The URL to which the form is submitted.',
+          "method (string) — Optional, default 'post'. The HTTP method used to submit the form.",
+          'cancel_path (string) — The URL to which the form is submitted when the cancel button is clicked.',
+          'styles (container) — Container of style classes for the form. Children: actions_div, submit, cancel, field_group, field_label, field_control.',
+          'content (container) — The collection of form fields. Other elements can also be included here, for formatting or extra buttons.'
+        ],
+        :messages => [
+          'render — Manually render the HTML form. Normally the render is called by the web server when the page containing the element is requested.'
+        ],
+        :examples => <<~EXAMPLES.strip
+          page [can] :
+            messages [can] :
+              new [page] :
+
+                head [e] :
+                  content [can] :
+                    title [e] : New Message
+
+                body [e] :
+                  content [can] :
+                    nav [alias] : shared.nav
+                    h2 [e] : New Message
+                    f [form] :
+                      name [string] : message_form
+                      action [string] : /messages
+                      method [string] : post
+                      cancel_path [string] : /messages
+                      styles [alias] : form_styles
+                      content [can] :
+                        id [field] :
+                          type [string] : hidden
+                          value [string] : 13
+                        message [field] :
+                          type [string] : text
+                          autofocus [boolean] : true
+                          placeholder [string] : the message goes here…
+                          …
+        EXAMPLES
+      }
+    end
+
   end
 end

data/lib/objs/page.rb

@@ -551,10 +551,56 @@ module Objs
       fname = file_name
       download = download_file
 
-      return WebSvr::Response.new( 
+      return WebSvr::Response.new(
         @engine, code, type, data, true, fname, download )
     end
 
+    # ---------------------------------------------------------------------
+    #    Object Documentation
+    # ---------------------------------------------------------------------
+
+    #
+    # Get the object's documentation data.
+    #
+    def self.doc_data
+      {
+        :name => KEYWORD,
+        :shortcut => KEYWORD_SHORT,
+        :description => 'A web page hosted in a gloo web server.',
+        :children => [
+          'layout (partial) — Optional, uses the server default if not specified.',
+          'on_prerender (script) — Optional. Run before the page is rendered. Mostly used if you need to manually update parameters to the page.',
+          'on_render (script) — Run when the page is going to be rendered.',
+          'after_render (script) — Run after the page has been rendered.',
+          'params (container) — Optional. Parameters to the page when rendered — values populated by scripts, or query parameters mapped to children of the same name (children are not auto-created to match query params; they must be declared to specify which ones are expected).',
+          'head (element) — Elements to be added to the page header.',
+          'body (element) — Elements to be added to the page body.',
+          'For file-rendering pages (rendering a file instead of HTML):',
+          "content_type (string) — Value 'file'. Indicates that this page renders a file rather than HTML.",
+          'file_type (string) — Example: image/png. The type of file to be rendered.',
+          'file_path (file) — Optional; used when the content refers to a file on disk. Either file_path or file_data must be specified, not both.',
+          'file_data (text) — Optional; used when the content is dynamically generated. Either file_path or file_data must be specified, not both.',
+          'file_name (string) — Optional. Name of the file to be rendered; may differ from the URL used to access it.',
+          'download_file (boolean) — Optional, default false. If true, the browser is instructed to download the file instead of rendering it.'
+        ],
+        :messages => [
+          'render — Manually render the content of the page. Normally the render is called by the web server when the page is requested.'
+        ],
+        :examples => <<~EXAMPLES.strip
+          page [can] :
+            home [page] :
+              layout [alias] : layout.primary
+              params [container] :
+                msg [string] : Hello World!
+              head [can] :
+                title [e] : My Page
+              body [e] :
+                content [can] :
+                  h1 [e] : Hello!
+                  p [e] : message <%= msg %>
+        EXAMPLES
+      }
+    end
 
   end
 end

data/lib/objs/partial.rb

@@ -204,5 +204,49 @@ module Objs
       return part_content
     end
 
+    # ---------------------------------------------------------------------
+    #    Object Documentation
+    # ---------------------------------------------------------------------
+
+    #
+    # Get the object's documentation data.
+    #
+    def self.doc_data
+      {
+        :name => KEYWORD,
+        :shortcut => KEYWORD_SHORT,
+        :description => 'A partial web page hosted in a gloo web ' \
+          'server. By convention use an underscore prefix in the name ' \
+          "of the partial — e.g. _icons.gloo — to set it apart from " \
+          'pages and other gloo files.',
+        :children => [
+          'on_render (script) — Run when the partial page is going to be rendered.',
+          'after_render (script) — Run after the partial page has been rendered.',
+          'params (container) — Optional. Parameters to the partial page when rendered.',
+          'content (element) — The contents of the partial page.'
+        ],
+        :messages => [
+          'render — Manually render the content of the partial page. Normally the render is called by the web server when the page containing the partial is requested.'
+        ],
+        :examples => <<~EXAMPLES.strip
+          shared [can] :
+            nav [part] :
+              on_render [script] :
+                put ^.params.cnt + 1 into ^.params.cnt
+              params [container] :
+                cnt [int] : 0
+              content [can] :
+                div_nav [e] : BEGIN
+                  <div class="mt-1 mb-3">
+                    <a href="/">
+                      <button type="button" class="btn btn-primary">
+                      Home </button></a>
+                    <%= cnt %>
+                  </div>
+                  END
+        EXAMPLES
+      }
+    end
+
   end
 end

data/lib/objs/svr.rb

@@ -696,9 +696,9 @@ module Objs
       return o
     end
 
-    # 
+    #
     # Get the default layout for pages.
-    # 
+    #
     def default_layout
       o = find_child LAYOUT
       return nil unless o
@@ -707,5 +707,80 @@ module Objs
       return o
     end
 
+    # ---------------------------------------------------------------------
+    #    Object Documentation
+    # ---------------------------------------------------------------------
+
+    #
+    # Get the object's documentation data.
+    #
+    def self.doc_data
+      {
+        :name => KEYWORD,
+        :shortcut => KEYWORD_SHORT,
+        :description => 'A web server running inside gloo.',
+        :children => [
+          'config (container) — Configuration and settings for the server. See below for its children.',
+          'on_start (script) — Run when the web server is started.',
+          'on_stop (script) — Run when the web server is stopped.',
+          "layout (partial) — By convention an alias pointing to the layout used for all pages (layouts live in the layout root-level folder).",
+          'home (page) — By convention an alias pointing to the home page object (pages live in the page root-level folder).',
+          'error (page) — By convention an alias pointing to the default error page object.',
+          'pages (container) — Routes. By convention, aliases pointing to pages in the page root-level folder.',
+          'config.scheme (string) — \'http\' or \'https\'.',
+          "config.host (string) — Default: 'localhost'.",
+          "config.port (string) — Default: '8080'.",
+          'config.session_name (string) — Optional. Example: \'_myapp_session\'. The name of the session cookie.',
+          'config.encryption_key (string) — Optional. Encryption key for the session cookie.',
+          'config.encryption_iv (string) — Optional. Initialization vector for the session cookie encryption key.',
+          "config.cookie_expires (string) — Optional, default 'in 1 week'. When the session expires.",
+          "config.cookie_path (string) — Optional, default '/'. The path for the session cookie.",
+          'config.ssl_cert (string) — Optional, required for SSL. Path to certificate.pem.',
+          'config.ssl_key (string) — Optional, required for SSL. Path to key.pem.',
+          'on_request (script) — Optional. Run when the web server receives a request.',
+          'request_data (container) — Optional. Data available for use in on_request or elsewhere in the page rendering life-cycle: method, host, path, query, ip (all string, all optional, populated only if present).',
+          'on_response (script) — Optional. Run when the web server is done rendering and about to return a response.',
+          'response_data (container) — Optional. Data available for use in on_response (request_data is also available at this point): page, type, code, elapsed, db (all string, all optional, populated only if present).'
+        ],
+        :messages => [
+          'start — Start the web server.',
+          'stop — Stop the web server.',
+          'list_routes — Show the routing table. A debugging tool.',
+          'list_assets — Show the list of assets. A debugging tool.',
+          'list_asset_img — Show the list of image assets. A debugging tool.',
+          'list_asset_css — Show the list of CSS assets. A debugging tool.',
+          'list_asset_js — Show the list of JavaScript assets. A debugging tool.',
+          'add_session_to_response — Tell the gloo web server to include the session data in the response (put in the session cookie). Use when the user successfully authenticates.',
+          'clear_session_data — Clear the session data and tell the gloo web server to include the session data in the response. This destroys the session; use when the user logs out.'
+        ],
+        :examples => <<~EXAMPLES.strip
+          app [can] :
+            # The address of the running web server.
+            url [uri] : http://localhost:8083/
+
+            svr [svr] :
+              # Configuration for the web server.
+              config [container] :
+                scheme [string] : http
+                host [string] : localhost
+                port [string] : 8083
+
+              # Scripts to run when the server starts and stops.
+              on_start [script] : show '*** started ***'
+              on_stop [script] : show '*** stopped ***'
+
+              # Default Routes for the web server.
+              layout [alias] : layout.primary
+              home [alias] : page.home
+              error [alias] : page.err
+
+              # Routes for the web server.
+              pages [container] :
+                home [alias] : page.home
+                other [alias] : page.other
+        EXAMPLES
+      }
+    end
+
   end
 end

data/lib/web_svr/session.rb

@@ -163,8 +163,13 @@ module WebSvr
     def decode_decrypt( data )
       return nil unless data && key && iv
 
-      data = Gloo::Objs::Cipher.decrypt( data, key, iv )
-      return JSON.parse( data )
+      begin
+        data = Gloo::Objs::Cipher.decrypt( data, key, iv )
+        return JSON.parse( data )
+      rescue => e
+        @engine.log_exception e
+        return nil
+      end
     end
 
     # 

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: gloo-web
 version: !ruby/object:Gem::Version
-  version: '1.2'
+  version: '1.4'
 platform: ruby
 authors:
 - Eric Crane
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-02-15 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thin
@@ -31,6 +30,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- README.md
 - lib/gloo-web.rb
 - lib/objs/element.rb
 - lib/objs/field.rb
@@ -54,12 +54,12 @@ files:
 - lib/web_svr/session.rb
 - lib/web_svr/table_renderer.rb
 - lib/web_svr/web_method.rb
-homepage: https://gloo.ecrane.us/
+homepage: https://github.com/ecrane/gloo
 licenses:
 - MIT
 metadata:
   gloo.type: core-library
-post_install_message:
+  documentation_uri: https://github.com/ecrane/gloo
 rdoc_options: []
 require_paths:
 - lib
@@ -74,8 +74,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.16
-signing_key:
+rubygems_version: 4.0.17
 specification_version: 4
 summary: Gloo core library. Web Server and framework.
 test_files: []