gloo 3.0.0 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 85917a19626e03193559e9e779a77f9a50e42083729824d27f8651d629af9b8d
-  data.tar.gz: 5d1cdc8947f63a756dcaee08c59751a104c6c202771a7de6edbb5fcfbebb9fcb
+  metadata.gz: f838e99d917722cd9f9aa5267b26b42fafda5f328a28130f61775a6002c7574c
+  data.tar.gz: c610bd65007e815fa47e6987c016efc24d17348a6f890be9274417368c50d16d
 SHA512:
-  metadata.gz: 991ab79d39d1c9606f4a72b18ac99cc6ab32b6924f7af9e17bd707ad6d32970d7c6f0a994b33152905cfe460c9035fbd19c10a0b522e35ffecc38625a663ca50
-  data.tar.gz: 725741071414ff857311f243e930bb393a3c04e46017bb154c500e96831bead87d7ee5f750ed830291d0657a9f1a5a4e877879fa3705adea28bc93f549e2b4db
+  metadata.gz: 2b72a95de45b3e5421bdfdaf370c852a9483019e3e773bac5e728769b8ff0933f4f1c47271b5297aeee3318dd2869c033bc8f20935fb4a043bc22975e25bf24d
+  data.tar.gz: e4c6ab44ad72f38679c5aec61691e620cbeb09ab03d206a44fc412db7884650559baac07d1f1f5b96ad883aaa8860e3f6315f1a17ebbb42aaf3db7b5c4b18f8f

data/gloo.gemspec

@@ -42,4 +42,5 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'sqlite3', '~> 1.4', '>= 1.4.2'
   spec.add_dependency 'os', '~> 1.1', '>= 1.1.4'
   spec.add_dependency 'pg', '~> 1.5.4'
+  spec.add_dependency 'thin', '~> 1.8.2'
 end

data/lib/VERSION

@@ -1 +1 @@
-3.0.0
+3.1.0

data/lib/VERSION_NOTES

@@ -1,3 +1,13 @@
+3.1.0 - 2024.04.26
+ - Adds gloo web server and related objects.
+ - Adds first pass at functions.
+ - Other changes in support of web apps.
+
+
+3.0.1 - 2023.12.28
+ - Updates the Object Factory to allow for multiple files to contribute to the same container.
+
+
 3.0.0 - 2023.12.27
  - Adds events: on_quit, on_save, on_unload, on_reload
  - More robust JSON object

data/lib/gloo/app/engine.rb

@@ -11,7 +11,7 @@ module Gloo
   module App
     class Engine
 
-      attr_reader :settings, :log
+      attr_reader :settings, :log, :running_app
       attr_reader :args, :mode, :running, :platform,
                   :dictionary, :parser, :heap, :factory
       attr_accessor :last_cmd, :persist_man, :event_manager,
@@ -54,7 +54,7 @@ module Gloo
         @exec_env = Gloo::Exec::ExecEnv.new( self )
         @converter = Gloo::Convert::Converter.new( self )
 
-        @log.debug 'the engine has started'
+        @log.info 'The gloo engine has started'
         run_mode
       end
 
@@ -102,7 +102,7 @@ module Gloo
       # Run gloo in the selected mode.
       #
       def run_mode
-        @log.debug "running gloo in #{@mode} mode"
+        @log.info "Running gloo in #{@mode} mode"
 
         if @mode == Mode::VERSION
           run_version
@@ -216,12 +216,45 @@ module Gloo
       # Do any clean up and quit.
       #
       def quit
+        if app_running?
+          @log.debug 'stopping running app...'
+          stop_running_app
+        end
+
         @log.debug 'triggering on_quit events...'
         @event_manager.on_quit
 
-        @log.debug 'quitting...'
+        @log.info 'Gloo engine is quitting...'
+      end
+
+      # ---------------------------------------------------------------------
+      #    Running app within gloo
+      # ---------------------------------------------------------------------
+
+      # 
+      # Set the running app object within gloo.
+      # 
+      def start_running_app( obj )
+        @running_app = Gloo::App::RunningApp.new( obj, self )
+        @running_app.start
+      end
+
+      # 
+      # Stop the running app object within gloo.
+      # 
+      def stop_running_app
+        @running_app.stop if @running_app
+        @running_app = nil
       end
 
+      # 
+      # Is there a running app?
+      # 
+      def app_running?
+        return @running_app ? true : false
+      end
+
+
       # ---------------------------------------------------------------------
       #    Helpers
       # ---------------------------------------------------------------------

data/lib/gloo/app/log.rb

@@ -108,11 +108,10 @@ module Gloo
 
       #
       # Write an information message to the log.
-      # Also write to the console unless quiet.
       #
       def info( msg )
         @logger.info msg
-        puts msg.blue unless @quiet
+        # puts msg.blue unless @quiet
       end
 
       #

data/lib/gloo/app/running_app.rb

@@ -0,0 +1,41 @@
+# Author::    Eric Crane  (mailto:eric.crane@mac.com)
+# Copyright:: Copyright (c) 2024 Eric Crane.  All rights reserved.
+#
+# The running application object within gloo.
+# It is set and accessed from the engine.
+# There can ever only be one runnign app within the instance of gloo.
+#
+
+module Gloo
+  module App
+    class RunningApp
+
+      attr_reader :obj
+
+      #
+      # Set up the running app for the given object.
+      #
+      def initialize( obj, engine )
+        @engine = engine
+        @log = @engine.log
+        @obj = obj
+      end
+
+      # 
+      # Start the running app.
+      def start
+        obj.start
+        @log.debug "running app started for #{@obj.pn}"
+      end
+
+      #
+      # The running app has been stopped.
+      #
+      def stop
+        obj.stop
+        @log.debug "running app stopped for #{@obj.pn}"
+      end
+
+    end
+  end
+end

data/lib/gloo/core/factory.rb

@@ -168,6 +168,9 @@ module Gloo
           return nil
         end
 
+        # Check to see if the object exists already
+        return parent.find_child( name ) if parent.contains_child?( name )
+
         o = type.new( @engine )
         o.name = name
         o.set_value value

data/lib/gloo/core/gloo_system.rb

@@ -178,6 +178,11 @@ module Gloo
         return @engine.settings.project_path
       end
 
+      # The running app directory.
+      def msg_app
+        return @engine.settings.project_path
+      end
+
       # Get the Gloo log directory
       def msg_gloo_log
         return @engine.settings.log_path

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

@@ -0,0 +1,169 @@
+# Author::    Eric Crane  (mailto:eric.crane@mac.com)
+# Copyright:: Copyright (c) 2024 Eric Crane.  All rights reserved.
+#
+# A Function that can be invoked inline in a script.
+# It is also used as a helper for web pages.
+#
+
+module Gloo
+  module Objs
+    class Function < Gloo::Core::Obj
+
+      KEYWORD = 'function'.freeze
+      KEYWORD_SHORT = 'ƒ'.freeze
+
+      # Events
+      ON_INVOKE = 'on_invoke'.freeze
+
+      # Parameters to the function invocation.
+      PARAMS = 'params'.freeze
+
+      # Return Value or container of objects
+      RESULT = 'result'.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
+
+      #
+      # Set the value with any necessary type conversions.
+      #
+      def set_value( new_value )
+        self.value = new_value.to_s
+      end
+
+      #
+      # Set the value as an array.
+      #
+      def set_array_value( arr )
+        self.value = arr
+      end
+
+      #
+      # Does this object support multi-line values?
+      # Initially only true for scripts.
+      #
+      def multiline_value?
+        return false
+      end
+
+      # 
+      # Get the result, the return value or container of objects.
+      # 
+      def result
+        return_any = find_child RESULT
+
+        # TODO: what does it look like to return objects?
+        # if return_any is a container with children, return the container
+
+        return return_any ? return_any.value : nil
+      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
+
+        fac.create_can PARAMS, self
+        fac.create_script ON_INVOKE, '', self
+        fac.create_untyped RESULT, '', self
+      end
+
+
+      # ---------------------------------------------------------------------
+      #    Messages
+      # ---------------------------------------------------------------------
+
+      #
+      # Get a list of message names that this object receives.
+      #
+      def self.messages
+        return super + [ 'invoke' ]
+      end
+
+      #
+      # Send the object the invoke message.
+      # Invoke the functdion and return the result.
+      #
+      def msg_invoke
+        return invoke( nil )
+      end
+
+
+      # ---------------------------------------------------------------------
+      #    Events
+      # ---------------------------------------------------------------------
+
+      #
+      # Run the on invoke script if there is one.
+      #
+      def run_on_invoke
+        o = find_child ON_INVOKE
+        return unless o
+
+        Gloo::Exec::Dispatch.message( @engine, 'run', o )
+      end
+
+
+      # ---------------------------------------------------------------------
+      #    Messages
+      # ---------------------------------------------------------------------
+
+      # 
+      # Invoke the function, run the script and return the result.
+      # 
+      def invoke args
+        @engine.log.debug "Invoking function: #{name}"
+
+        set_params args if args
+        run_on_invoke
+        return_value = result
+        @engine.heap.it.set_to return_value
+        
+        return return_value
+      end
+
+      # 
+      # Set parameters from the arguments given.
+      # 
+      def set_params args
+        params = find_child PARAMS
+        return unless params
+
+        args.each_with_index do |arg, i|
+          param = params.children[i]
+          param.value = arg if param
+        end
+      end
+
+    end
+  end
+end

data/lib/gloo/objs/basic/untyped.rb

@@ -9,7 +9,7 @@ module Gloo
     class Untyped < Gloo::Core::Obj
 
       KEYWORD = 'untyped'.freeze
-      KEYWORD_SHORT = 'un'.freeze
+      KEYWORD_SHORT = 'any'.freeze
 
       #
       # The name of the object type.

data/lib/gloo/objs/web/json.rb

@@ -136,10 +136,23 @@ module Gloo
       #    JSON Helper functions
       # ---------------------------------------------------------------------
 
+      # 
+      # Convert the object to JSON.
+      # 
+      def self.convert_obj_to_json( obj )
+
+        # TODO: put container objects in an array
+        
+        h = obj ? convert_obj_to_hash( obj ) : {}
+        json = JSON.parse( h.to_json )
+        json = JSON.pretty_generate( json )
+        return json
+      end
+
       # 
       # Convert the object to a hash of name and values.
       # 
-      def convert_obj_to_hash( obj )
+      def self.convert_obj_to_hash( obj )
         h = {}
 
         if obj.child_count > 0

data/lib/gloo/objs/web/uri.rb

@@ -138,8 +138,20 @@ module Gloo
       def msg_open
         return unless value
 
+        Gloo::Objs::Uri.open_url value
+      end
+
+
+      # ---------------------------------------------------------------------
+      #    Helper functiont to open a URL
+      # ---------------------------------------------------------------------
+
+      # 
+      # Open the given URL with platform command.
+      # 
+      def self.open_url url
         cmd = Gloo::Core::GlooSystem.open_for_platform
-        cmd_with_param = "#{cmd} \"#{value}\""
+        cmd_with_param = "#{cmd} \"#{url}\""
 
         if OS.mac?
           `#{cmd_with_param}`

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

@@ -0,0 +1,244 @@
+# Author::    Eric Crane  (mailto:eric.crane@mac.com)
+# Copyright:: Copyright (c) 2024 Eric Crane.  All rights reserved.
+#
+# An HTML Element.
+# Note that the object name is the tag!
+# 
+# An Element's content can be in a container of that nane,
+# or it can be the simple value of the obj.  If there is no
+# content child, the simple value will be used.
+# 
+# Attibutes is a container with all attributes of the tag.
+# ID and CLASSES attributes can be called out more simply
+# as children of the element obj.
+#
+
+module Gloo
+  module Objs
+    class Element < Gloo::Core::Obj
+
+      KEYWORD = 'element'.freeze
+      KEYWORD_SHORT = 'e'.freeze
+
+      # Element
+      ID = 'id'.freeze
+      CLASSES = 'classes'.freeze
+      ATTRIBUTES = 'attributes'.freeze
+      CONTENT = 'content'.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
+
+      #
+      # Set the value with any necessary type conversions.
+      #
+      def set_value( new_value )
+        self.value = new_value.to_s
+      end
+
+      #
+      # Does this object support multi-line values?
+      # Initially only true for scripts.
+      #
+      def multiline_value?
+        return false
+      end
+
+      # 
+      # Return the array of attributes if there are any.
+      # 
+      def attributes_hash
+        attr_can = find_child ATTRIBUTES
+
+        if attr_can && attr_can.children.size > 0
+          h = {}
+          attr_can.children.each do |o|
+            h[ o.name ] = o.value
+          end
+          return h
+        end
+
+        return {}
+      end
+
+      # 
+      # Get all attributes of the tag.
+      # 
+      def tag_attributes
+        attr_h = attributes_hash
+        return nil unless attr_h && attr_h.size > 0
+
+        attr_str = ''
+        attr_h.each do |k,v|
+          unless v.blank?
+            attr_str << " #{k}=\"#{v}\"" 
+          end
+        end
+
+        return attr_str
+      end
+
+      #
+      # Get the tag.
+      # This is the name, up until an '_' char.
+      # Because name must be unique in the parent, and with HTML
+      # we need a way to have multiple of the same tag at the
+      # same level.
+      #
+      def tag
+        i = self.name.index( '_' )        
+        return i ? self.name[ 0..(i-1) ] : self.name
+      end
+
+      #
+      # Get the opening tag.
+      #
+      def tag_open
+        tag_attributes = self.tag_attributes
+        if tag_attributes
+          return "<#{tag}#{tag_attributes}>"
+        else
+          return "<#{tag}>"
+        end
+      end
+
+      #
+      # Get the closing tag.
+      #
+      def tag_close
+        return "</#{tag}>"
+      end
+
+      # 
+      # Get all the children elements of the content.
+      # 
+      def content_child
+        return find_child CONTENT
+      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
+        attr = fac.create_can ATTRIBUTES, self
+        fac.create_string ID, '', attr
+        fac.create_string CLASSES, '', attr
+
+        fac.create_can CONTENT, self
+      end
+
+
+      # ---------------------------------------------------------------------
+      #    Messages
+      # ---------------------------------------------------------------------
+
+      #
+      # Get a list of message names that this object receives.
+      #
+      def self.messages
+        return super + [ 'render' ]
+      end
+
+      #
+      # Get the expiration date for the certificate.
+      #
+      def msg_render
+        content = self.render
+        @engine.heap.it.set_to content 
+        return content
+      end
+
+
+      # ---------------------------------------------------------------------
+      #    Render
+      # ---------------------------------------------------------------------
+
+      # 
+      # Render the element as HTML.
+      # 
+      def render_html
+        content_text = render_content :render_html
+
+        return "#{tag_open}#{content_text}#{tag_close}"
+      end
+
+      #
+      # Render the element as text, without tags.
+      # 
+      def render_text
+        content_text = render_content :render_text
+
+        return "#{content_text}"
+      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 render_ƒ
+        obj = content_child
+        obj = self if obj.nil?
+
+        return Element.render_obj( obj, render_ƒ, @engine )
+      end
+
+      # 
+      # Render an object which might be an element,
+      # a container of items, or something else.
+      # 
+      def self.render_obj obj, render_ƒ, engine
+        rendered_obj_content = ''
+        return nil unless obj
+
+        if obj.children.size > 0
+          obj.children.each do |e|
+
+            e = Gloo::Objs::Alias.resolve_alias( engine, e )
+            if e.class == Element
+              rendered_obj_content << e.send( render_ƒ )
+            elsif e.class == Partial
+              rendered_obj_content << e.render( render_ƒ )
+            else
+              rendered_obj_content << e.value.to_s
+            end
+          end
+        else
+          rendered_obj_content << obj.value
+        end
+
+        return rendered_obj_content
+      end
+                    
+    end
+  end
+end