gloo 3.0.1 → 3.1.0

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

@@ -0,0 +1,299 @@
+# Author::    Eric Crane  (mailto:eric.crane@mac.com)
+# Copyright:: Copyright (c) 2024 Eric Crane.  All rights reserved.
+#
+# A web web server running inside gloo.
+#
+
+module Gloo
+  module Objs
+    class Svr < Gloo::Core::Obj
+
+      KEYWORD = 'server'.freeze
+      KEYWORD_SHORT = 'svr'.freeze
+
+      # Configuration
+      SCHEME = 'scheme'.freeze      
+      HOST = 'host'.freeze
+      PORT = 'port'.freeze
+
+      # Events
+      ON_START = 'on_start'.freeze
+      ON_STOP = 'on_stop'.freeze
+
+      # Container with pages in the web app.
+      PAGES = 'pages'.freeze
+
+      # Default layout for pages.
+      LAYOUT = 'layout'.freeze
+
+      # Alias to the home and error pages
+      HOME = 'home'.freeze
+      ERR_PAGE = 'error'.freeze
+
+
+      # Messages
+      SERVER_NOT_RUNNING = 'The web server is not running and cannot be stopped'.freeze
+
+      # 
+      # Should the current request be redirected?
+      # If the redirect is set, then use that page instead
+      # of the one requested.
+      # 
+      attr_accessor :redirect, :router, :asset, :embedded_renderer
+
+      #
+      # 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
+
+      #
+      # Get the Scheme (http or https) from the child object.
+      # Returns nil if there is none.
+      #
+      def scheme_value
+        scheme = find_child SCHEME
+        return nil unless scheme
+
+        return scheme.value
+      end
+      
+      #
+      # Get the host from the child object.
+      # Returns nil if there is none.
+      #
+      def host_value
+        host = find_child HOST
+        return nil unless host
+
+        return host.value
+      end
+
+      #
+      # Get the port from the child object.
+      # Returns nil if there is none.
+      #
+      def port_value
+        port = find_child PORT
+        return nil unless port
+
+        return port.value
+      end
+
+
+      # 
+      # Get the default layout for the app.
+      # 
+      def default_page_layout
+        o = find_child LAYOUT
+        return nil unless o
+
+        o = Gloo::Objs::Alias.resolve_alias( @engine, o )
+        return o
+      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_string SCHEME, 'http', self
+        fac.create_string HOST, 'localhost', self
+        fac.create_string PORT, '8080', self
+
+        fac.create_script ON_START, '', self
+        fac.create_script ON_STOP, '', self
+
+        fac.create_can PAGES, self
+        fac.create_can HOME, self
+      end
+
+
+      # ---------------------------------------------------------------------
+      #    Messages
+      # ---------------------------------------------------------------------
+
+      #
+      # Get a list of message names that this object receives.
+      #
+      def self.messages
+        return super + [ 'start', 'stop' ]
+      end
+
+      #
+      # Start the gloo web server.
+      #
+      def msg_start
+        @engine.log.debug "Starting web server…"
+        # @engine.log.quiet = true
+
+        # Set running app to this object.
+        @engine.start_running_app( self )
+        # The running app will call the start function (below)
+      end
+
+      #
+      # Stop the running web server.
+      #
+      def msg_stop
+        if @web_server
+          @engine.stop_running_app
+          # The running app will call the stop function (below)
+        else
+          @engine.log.error SERVER_NOT_RUNNING
+        end
+      end
+
+      # ---------------------------------------------------------------------
+      #    Start and Stop Events
+      #    Might come from messages or from other application events.
+      #    RunningApp fires these events.
+      # ---------------------------------------------------------------------
+
+      # 
+      # Start running the web server.
+      # 
+      def start
+        config = Gloo::WebSvr::Config.new( scheme_value, host_value, port_value )
+        @engine.log.info "Web Server URL: #{config.base_url}"
+
+        handler = Gloo::WebSvr::Handler.new( @engine, self )
+        @web_server = Gloo::WebSvr::Server.new( @engine, handler, config )
+        @web_server.start
+
+        @router = Gloo::WebSvr::Router.new( @engine, self )
+        @router.add_page_routes
+
+        @asset = Gloo::WebSvr::Asset.new( @engine, self )
+        @asset.add_asset_routes
+
+        @embedded_renderer = Gloo::WebSvr::EmbeddedRenderer.new( @engine, self )
+
+        run_on_start
+        @engine.log.info "Web server started and listening…"
+      end
+
+      # 
+      # Stop the running web server.
+      # 
+      def stop
+        @engine.log.info "Stopping web server…"
+        @web_server.stop
+        @web_server = nil
+
+        run_on_stop
+        @engine.log.info "Web server stopped…"
+      end
+
+
+      # ---------------------------------------------------------------------
+      #    On Events - Scripts
+      # ---------------------------------------------------------------------
+
+      #
+      # Run the on render script if there is one.
+      #
+      def run_on_start
+        o = find_child ON_START
+        return unless o
+
+        Gloo::Exec::Dispatch.message( @engine, 'run', o )
+      end
+
+      #
+      # Run the on rendered script if there is one.
+      #
+      def run_on_stop
+        o = find_child ON_STOP
+        return unless o
+
+        Gloo::Exec::Dispatch.message( @engine, 'run', o )
+      end
+
+
+      # ---------------------------------------------------------------------
+      #    Pages and standard elements.
+      # ---------------------------------------------------------------------
+
+      # 
+      # Get the pages container.
+      # 
+      def pages_container
+        return find_child PAGES
+      end
+
+      # 
+      # Get the home page, the root/default route.
+      # 
+      def home_page
+        o = find_child HOME
+        return nil unless o
+
+        o = Gloo::Objs::Alias.resolve_alias( @engine, o )
+        return o
+      end
+
+      # 
+      # Get the application error page.
+      # 
+      def err_page
+        o = find_child ERR_PAGE
+        return nil unless o
+
+        o = Gloo::Objs::Alias.resolve_alias( @engine, o )
+        return o
+      end
+
+      # 
+      # Get the default layout for pages.
+      # 
+      def default_layout
+        o = find_child LAYOUT
+        return nil unless o
+
+        o = Gloo::Objs::Alias.resolve_alias( @engine, o )
+        return o
+      end
+
+    end
+  end
+end

data/lib/gloo/verbs/cls.rb

@@ -8,7 +8,7 @@ module Gloo
   module Verbs
     class Cls < Gloo::Core::Verb
 
-      KEYWORD = 'cls'.freeze
+      KEYWORD = 'clear'.freeze
       KEYWORD_SHORT = 'cls'.freeze
 
       #

data/lib/gloo/verbs/redirect.rb

@@ -0,0 +1,56 @@
+# Author::    Eric Crane  (mailto:eric.crane@mac.com)
+# Copyright:: Copyright (c) 2024 Eric Crane.  All rights reserved.
+#
+# Redirect the web svr request to a different page.
+# This verb only works in context of a running web server.
+#
+
+module Gloo
+  module Verbs
+    class Redirect < Gloo::Core::Verb
+
+      KEYWORD = 'redirect'.freeze
+      KEYWORD_SHORT = 'go'.freeze
+
+      MISSING_EXPR_ERR = 'Missing Expression!'.freeze
+
+      #
+      # Run the verb.
+      #
+      def run
+        if @tokens.token_count < 2
+          @engine.err MISSING_EXPR_ERR
+          return
+        end
+
+        # Send the redirect page to the running app.
+        if @engine.app_running?
+          obj_name = @tokens.second
+          pn = Gloo::Core::Pn.new( @engine, obj_name )
+          @engine.running_app.obj.redirect = pn.resolve
+        end
+      end
+
+      #
+      # Get the Verb's keyword.
+      #
+      def self.keyword
+        return KEYWORD
+      end
+
+      #
+      # Get the Verb's keyword shortcut.
+      #
+      def self.keyword_shortcut
+        return KEYWORD_SHORT
+      end
+
+      # ---------------------------------------------------------------------
+      #    Private functions
+      # ---------------------------------------------------------------------
+
+      private
+
+    end
+  end
+end

data/lib/gloo/web_svr/asset.rb

@@ -0,0 +1,194 @@
+# Author::    Eric Crane  (mailto:eric.crane@mac.com)
+# Copyright:: Copyright (c) 20124 Eric Crane.  All rights reserved.
+#
+# A helper class for static assets.
+# 
+
+module Gloo
+  module WebSvr
+    class Asset
+      
+      ASSETS_FOLDER = 'assets'.freeze
+      IMAGES_FOLDER = 'images'.freeze
+      STYLESHEETS_FOLDER = 'stylesheets'.freeze
+
+      CSS_TYPE = 'text/css'.freeze
+      JS_TYPE = 'text/javascript'.freeze
+
+      IMAGE_TYPE = 'image/'.freeze
+      FAVICON_TYPE = 'image/x-icon'.freeze
+
+
+      # ---------------------------------------------------------------------
+      #    Initialization
+      # ---------------------------------------------------------------------
+
+      #
+      # Set up the web server.
+      #
+      def initialize( engine, web_svr_obj )
+        @engine = engine
+        @log = @engine.log
+
+        @web_svr_obj = web_svr_obj
+      end
+
+
+      # ---------------------------------------------------------------------
+      #    Asset Helpers
+      # ---------------------------------------------------------------------
+
+      # 
+      # Get the asset folder in the project.
+      #
+      def assets_folder
+        return File.join( @engine.settings.project_path, ASSETS_FOLDER )
+      end
+
+      #
+      # Get the images folder in the project.
+      #
+      def images_folder
+        return File.join( assets_folder, IMAGES_FOLDER )
+      end
+
+      # 
+      # Get the stylesheets folder in the project.
+      #
+      def stylesheets_folder
+        return File.join( assets_folder, STYLESHEETS_FOLDER )
+      end
+
+      # 
+      # Find and return the page for the given route.
+      # 
+      def path_for_file file
+        pn = file.value
+
+        # Is the file's value a recognizable file?
+        return pn if File.exist? pn
+
+        # Look in the web server's asset folder.
+        pn = File.join( assets_folder, pn )
+
+        return pn
+      end
+
+      # 
+      # Get the return type for the given file.
+      # 
+      def type_for_file file
+        ext = File.extname( file ).downcase
+        ext = ext[1..-1] if ext[0] == '.'
+        
+        if ext == 'css'
+          return CSS_TYPE
+        elsif ext == 'js'
+          return JS_TYPE
+        elsif ext == 'ico'
+          return FAVICON_TYPE
+        else
+          return "#{IMAGE_TYPE}#{ext}"
+        end
+      end
+
+
+      # ---------------------------------------------------------------------
+      #    Render Asset
+      # ---------------------------------------------------------------------
+
+      # 
+      # Helper to create a successful image response with the given data.
+      # 
+      def render_file( file )
+        type = type_for_file file
+        data = File.binread file 
+        code = Gloo::WebSvr::ResponseCode::SUCCESS
+
+        return Gloo::WebSvr::Response.new( @engine, code, type, data )
+      end
+
+
+      # ---------------------------------------------------------------------
+      #    Dynamic Add Assets
+      # ---------------------------------------------------------------------
+
+      # 
+      # Add all asssets to the web server pages (routes).
+      # 
+      def add_asset_routes
+        return unless File.exist? assets_folder
+
+        @log.debug 'Adding asset routes to web server…'
+        @factory = @engine.factory
+
+        add_containers
+        add_images
+        add_stylesheets
+      end
+
+      # 
+      # Create the containers for the assets if they do not exist.
+      #
+      def add_containers
+        pages = @web_svr_obj.pages_container
+
+        @assets = pages.find_child( ASSETS_FOLDER ) || 
+          @factory.create_can( ASSETS_FOLDER, pages )
+
+        @images = @assets.find_child( IMAGES_FOLDER ) || 
+          @factory.create_can( IMAGES_FOLDER, @assets )
+
+        @stylesheets = @assets.find_child( STYLESHEETS_FOLDER ) || 
+          @factory.create_can( STYLESHEETS_FOLDER, @assets )
+      end
+
+      #
+      # Add the images to the web server pages.
+      #
+      def add_images
+        @log.debug 'Adding image asset routes to web server…'
+        
+        return unless File.exist? images_folder
+
+        # for each file in the images folder
+        # create a file object and add it to the images container
+        Dir.each_child( images_folder ) do |name|
+          pn = File.join( IMAGES_FOLDER, name )
+          add_file_obj( @images, name, pn )
+        end
+      end
+
+      #
+      # Add the stylesheets to the web server pages.
+      #
+      def add_stylesheets
+        @log.debug 'Adding stylesheet asset routes to web server…'
+
+        return unless File.exist? stylesheets_folder
+
+        # for each file in the stylesheets folder
+        # create a file object and add it to the stylesheets container
+        Dir.each_child( stylesheets_folder ) do |name|
+          pn = File.join( STYLESHEETS_FOLDER, name )
+          add_file_obj( @stylesheets, name, pn )
+        end
+      end
+
+      # 
+      # Add a file object (page route) to the given container.
+      # 
+      def add_file_obj( can, name, pn )
+        name = name.gsub( '.', '_' )
+        @log.debug "Adding route for file: #{name}"
+
+        # First make sure the child doesn't already exist.
+        child = can.find_child( name )
+        return if child
+
+        @factory.create_file( name, pn, can )
+      end
+
+    end
+  end
+end

data/lib/gloo/web_svr/config.rb

@@ -0,0 +1,56 @@
+# Author::    Eric Crane  (mailto:eric.crane@mac.com)
+# Copyright:: Copyright (c) 20124 Eric Crane.  All rights reserved.
+#
+# Configuration for a gloo web server.
+#
+
+module Gloo
+  module WebSvr
+    class Config
+
+      SCHEME_SEPARATOR = '://'
+      HTTP = 'http'
+      HTTPS = 'https'
+      LOCALHOST = 'localhost'
+      PORT_DEFAULT = '8080'
+      
+      attr_reader :scheme, :host, :port
+      
+
+      # ---------------------------------------------------------------------
+      #    Initialization
+      # ---------------------------------------------------------------------
+
+      #
+      # Set up the web server.
+      #
+      def initialize( scheme = HTTP, host = LOCALHOST, port = PORT_DEFAULT )
+        @scheme = scheme
+        @host = host
+        @port = port
+      end
+
+
+      # ---------------------------------------------------------------------
+      #    Static Helper Functions
+      # ---------------------------------------------------------------------
+
+
+      # ---------------------------------------------------------------------
+      #    Helper Functions
+      # ---------------------------------------------------------------------
+
+      # 
+      # The base url, including scheme, host and port.
+      # 
+      def base_url
+        url = "#{self.scheme}#{SCHEME_SEPARATOR}#{self.host}"
+        unless self.port.blank? 
+          url << ":#{self.port}"
+        end
+        return url
+      end
+
+    end
+  end
+end

data/lib/gloo/web_svr/embedded_renderer.rb

@@ -0,0 +1,91 @@
+# Author::    Eric Crane  (mailto:eric.crane@mac.com)
+# Copyright:: Copyright (c) 20124 Eric Crane.  All rights reserved.
+#
+# A helper class used to render parameters (ERB) in text.
+# Also uses helper functions to render.
+# 
+
+module Gloo
+  module WebSvr
+    class EmbeddedRenderer
+      
+      HELPER = 'helper'.freeze
+
+      attr_reader :engine, :log, :web_svr_obj
+
+
+      # ---------------------------------------------------------------------
+      #    Initialization
+      # ---------------------------------------------------------------------
+
+      #
+      # Set up the web server.
+      #
+      def initialize( engine, web_svr_obj )
+        @engine = engine
+        @log = @engine.log
+
+        @web_svr_obj = web_svr_obj
+      end
+
+
+      # ---------------------------------------------------------------------
+      #    Obj Helper Functions
+      # ---------------------------------------------------------------------
+
+      # 
+      # Handle a missing method by looking for a helper function.
+      # If there is one, then call it and return the result.
+      # If not, log an error and return nil.
+      # 
+      def method_missing( method_name, *args )
+        @log.debug "missing method '#{method_name}' with args #{args}"
+
+        helper_pn = "#{HELPER}.#{method_name}"
+        @log.debug "looking for function: #{helper_pn}"
+
+        pn = Gloo::Core::Pn.new( @engine, helper_pn )
+        obj = pn.resolve
+        if obj
+          @log.debug "found obj: #{obj.pn}"
+          return obj.invoke args
+        else
+          @log.error "Function not found: #{helper_pn}"        
+        end
+
+        return nil
+      end
+
+
+      # ---------------------------------------------------------------------
+      #    Renderer
+      # ---------------------------------------------------------------------
+
+      # 
+      # Render content with the given params.
+      # Params might be nil, in which case the content
+      # is returned with no changes.
+      # 
+      def render content, params
+        # If the params is nil, let's make it an empty hash.
+        params = {} unless params
+
+        # Get the binding context for this render.
+        b = binding
+
+        # Add the params to the binding context.
+        params.each_pair do |key, value|
+          b.local_variable_set key.to_sym, value
+        end
+      
+        # Render in the current binding content.
+        renderer = ERB.new( content )
+        content = renderer.result( b )
+      
+        return content
+      end
+
+    end
+    
+  end
+end