gloo 3.6.1 → 3.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 925f6ae85aafc144e38e327c8a30a4de233991a648e59fb70a8adc304855853b
-  data.tar.gz: 76c73401718f62d0064933305302d9e173f73272eeb11358d7b97b491beebca2
+  metadata.gz: c1dfa24d10974fad30c699b9935d765525ceda2eef22c642be9f30fd8f717ce7
+  data.tar.gz: c631fafd6862b14c03994767ad520cc95380868ea9a1c60a68f0da67399d9fab
 SHA512:
-  metadata.gz: d8c21b97ca1eaf73b574e1f4658fb94e70ca29f46a2d91ac7792d635a30bf5132788c8e266f8cf845bcad5d472ef964ce2fb09319ffd9211c4e11c36cff35bb6
-  data.tar.gz: f62a2718af2f07c8fe320cbe4b31edb7afe684c6f3e30ac2310512664bef7e0273085027fe8b8f965f82d49905bb28c8e73c08d4e67e5b898012af8e709b3004
+  metadata.gz: a020b85943d3fa84e2940dc37a4bf61d541a89e55de775b0a22fd001b7e57de84a852748d0084e92bf1490e5f561761b62cbea9c94cbfa57e422632bf77134c5
+  data.tar.gz: 04ca71cc0e8c3c483d31155799876e336d372d2bee8f1a923f429c3aee0c2902528af4ebe289d3a6e5709274205ca7d5feaaf164e1f8187c48ce6a5c4315a847

data/lib/VERSION

@@ -1 +1 @@
-3.6.1
+3.7.0

data/lib/VERSION_NOTES

@@ -1,3 +1,14 @@
+3.7.0 - 2025.01.09
+ - Adds File message to get SHA256 hash
+ - Asset Fingerprinting
+ - Adds message to web app to show assets (in the terminal)
+ - Adds asset helper tags
+
+
+3.6.2 - 2024.12.19
+ - Bug fix for URI open
+
+
 3.6.1 - 2024.12.19
  - tell URI to open fails on non-Mac platforms, so showing warning for now.
 

data/lib/gloo/app/platform.rb

@@ -12,6 +12,7 @@ module Gloo
     class Platform
 
       DEFAULT_TMP_FILE = 'tmp.txt'.freeze
+      RETURN = "\n".freeze
 
       attr_reader :prompt, :table
 

data/lib/gloo/objs/system/file_handle.rb

@@ -11,6 +11,10 @@ module Gloo
       KEYWORD = 'file'.freeze
       KEYWORD_SHORT = 'dir'.freeze
 
+      FILE_NAME_ERR = 'file and path name expected'.freeze
+      FILE_MISSING_ERR = 'file not found'.freeze
+
+
       #
       # The name of the object type.
       #
@@ -33,7 +37,7 @@ module Gloo
       # Get a list of message names that this object receives.
       #
       def self.messages
-        basic = %w[read write get_name get_ext get_parent]
+        basic = %w[read write get_name get_ext get_parent get_sha256]
         checks = %w[exists? is_file? is_dir?]
         search = %w[find_match]
         show = %w[show page open]
@@ -73,7 +77,7 @@ module Gloo
       # Read the contents of the file into the object.
       #
       def msg_read
-        return unless value && File.file?( value )
+        return unless check_file_exists?
 
         data = File.read( value )
         if @params&.token_count&.positive?
@@ -165,6 +169,44 @@ module Gloo
         end
       end
 
+      #
+      # Get the SHA256 hash of the file contents.
+      #
+      def msg_get_sha256
+        return unless check_file_exists?
+
+        file_hash = FileHandle.hash_for_file( value )
+        @engine.heap.it.set_to file_hash
+      end
+
+      # 
+      # Get the SHA256 hash of the file contents.
+      #
+      def self.hash_for_file( file_path )
+        require 'digest'
+        file_data = File.read( file_path )
+        file_hash = Digest::SHA256.hexdigest( file_data )
+        return file_hash
+      end
+
+      #
+      # Check to see if the file exists.
+      # Show error if not.
+      #
+      def check_file_exists?
+        if value.blank?
+          @engine.log.error FILE_NAME_ERR
+          return false
+        end
+
+        unless File.exist?( value )
+          @engine.log.error FILE_MISSING_ERR
+          return false
+        end
+
+        return true
+      end
+
     end
   end
 end

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

@@ -138,7 +138,7 @@ module Gloo
       def msg_open
         return unless value
 
-        Gloo::Objs::Uri.open_url value
+        Gloo::Objs::Uri.open_url value, @engine
       end
 
 
@@ -149,7 +149,7 @@ module Gloo
       # 
       # Open the given URL with platform command.
       # 
-      def self.open_url url
+      def self.open_url( url, engine=nil )
         cmd = Gloo::Core::GlooSystem.open_for_platform
         cmd_with_param = "#{cmd} \"#{url}\""
 
@@ -158,7 +158,7 @@ module Gloo
         else
           # This does not work in Linux or in WSL on Windows:
           # exec cmd_with_param
-          @engine.log.warn 'Opening URL not supported on this platform.'
+          engine.log.warn 'Opening URL not supported on this platform.' if engine
         end
       end
 

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

@@ -405,7 +405,9 @@ module Gloo
       # Get a list of message names that this object receives.
       #
       def self.messages
-        return super + [ 'start', 'stop', 'routes' ]
+        return super + [ 'start', 'stop', 
+          'list_routes', 'list_assets', 
+          'list_asset_img', 'list_asset_css', 'list_asset_js' ]
       end
 
       #
@@ -434,8 +436,9 @@ module Gloo
 
       # 
       # Helper message to show all routes in the running server.
+      # A Debugging tool.
       # 
-      def msg_routes
+      def msg_list_routes
         if @router
           @router.show_routes
         else
@@ -443,6 +446,54 @@ module Gloo
         end
       end
 
+      # 
+      # Helper message to show all assets in the running server.
+      # A Debugging tool.
+      # 
+      def msg_list_assets
+        if @router
+          Gloo::WebSvr::AssetInfo.list_all( @engine )
+        else
+          @engine.err SERVER_NOT_RUNNING
+        end
+      end
+
+      # 
+      # List all asset images in the running server.
+      # A Debugging tool.
+      # 
+      def msg_list_asset_img
+        if @router
+          @asset.list_image_assets
+        else
+          @engine.err SERVER_NOT_RUNNING
+        end
+      end
+
+      # 
+      # List all asset css in the running server.
+      # A Debugging tool.
+      # 
+      def msg_list_asset_css
+        if @router
+          @asset.list_css_assets
+        else
+          @engine.err SERVER_NOT_RUNNING
+        end
+      end
+
+      # 
+      # List all asset javascript in the running server.
+      # A Debugging tool.
+      # 
+      def msg_list_asset_js
+        if @router
+          @asset.list_js_assets
+        else
+          @engine.err SERVER_NOT_RUNNING
+        end
+      end
+
 
       # ---------------------------------------------------------------------
       #    Start and Stop Events

data/lib/gloo/web_svr/asset.rb

@@ -116,6 +116,38 @@ module Gloo
         return Gloo::WebSvr::Response.new( @engine, code, type, data )
       end
 
+      #
+      # Check if the given name is an asset.
+      # 
+      def is_asset? name
+        return name == ASSET_FOLDER
+      end
+
+
+      # ---------------------------------------------------------------------
+      #    Asset with Fingerprints
+      # ---------------------------------------------------------------------
+
+      # 
+      # Register an asset with the web server.
+      # Adds fingerprint to the file names for later access.
+      # 
+      # full_path is the FILE from which we build the SHA256 hash
+      # pn is the path and name within the assets directory
+      # name is the simple file name (icon.png)
+      # 
+      def register_asset name, pn, full_path
+        asset_pn = "/asset/#{pn}"
+        return AssetInfo.new( @engine, full_path, name, asset_pn ).register
+      end
+
+      # 
+      # Get the published name for the given asset name.
+      #
+      def published_name asset_name
+        return AssetInfo.find_published_name_for( asset_name )
+      end
+
 
       # ---------------------------------------------------------------------
       #    Dynamic Add Assets
@@ -170,7 +202,8 @@ module Gloo
 
             add_files_in_folder( full_path, child, pn )
           else
-            add_file_obj( container, name, pn )
+            info = register_asset( name, pn, full_path )
+            add_file_obj( container, name, pn, info )
           end
         end
       end
@@ -227,7 +260,7 @@ module Gloo
       # 
       # Add a file object (page route) to the given container.
       # 
-      def add_file_obj( can, name, pn )
+      def add_file_obj( can, name, pn, info )
         name = name.gsub( '.', '_' )
         @log.debug "Adding route for file: #{name}"
 
@@ -236,6 +269,66 @@ module Gloo
         return if child
 
         @factory.create_file( name, pn, can )
+        # @factory.create_file( info.published_name, pn, can )
+      end
+
+
+      # ---------------------------------------------------------------------
+      #    List Asset Helpers
+      # ---------------------------------------------------------------------
+
+      # 
+      # List all image assets.
+      # This looks in the image container and lists the images found earlier.
+      # A Debugging tool.
+      # 
+      def list_image_assets
+        data = []
+        @images.children.each do |o|
+          data << [ o.name, o.pn, o.value ]
+        end
+        headers = [ "Name", "PN", "Value" ]
+
+        puts Gloo::App::Platform::RETURN
+        title = "Image Assets with Routes"
+        @engine.platform.table.show headers, data, title
+        puts Gloo::App::Platform::RETURN
+      end
+
+      # 
+      # List all js assets.
+      # This looks in the js container and lists the js files found earlier.
+      # A Debugging tool.
+      # 
+      def list_js_assets
+        data = []
+        @javascript.children.each do |o|
+          data << [ o.name, o.pn, o.value ]
+        end
+        headers = [ "Name", "PN", "Value" ]
+
+        puts Gloo::App::Platform::RETURN
+        title = "JavaScript Assets with Routes"
+        @engine.platform.table.show headers, data, title
+        puts Gloo::App::Platform::RETURN
+      end
+
+      # 
+      # List all css assets.
+      # This looks in the css container and lists the css files found earlier.
+      # A Debugging tool.
+      #
+      def list_css_assets
+        data = []
+        @stylesheets.children.each do |o|
+          data << [ o.name, o.pn, o.value ]
+        end
+        headers = [ "Name", "PN", "Value" ]
+
+        puts Gloo::App::Platform::RETURN
+        title = "Stylesheet Assets with Routes"
+        @engine.platform.table.show headers, data, title        
+        puts Gloo::App::Platform::RETURN
       end
 
     end

data/lib/gloo/web_svr/asset_info.rb

@@ -0,0 +1,112 @@
+# Author::    Eric Crane  (mailto:eric.crane@mac.com)
+# Copyright:: Copyright (c) 2025 Eric Crane.  All rights reserved.
+#
+# Information about a single asset.
+# 
+# Full Path is the full path to the file in the file system.
+# Name is the name of the file with extension.
+# PN is the path within assets and the name. 
+#    ie: /asset/stylesheet/stylesheet.css
+# Hash is the SHA256 hash of the file.
+# Published Name is the name of the file that is published
+#    to the web server, and includes the hash.
+# 
+
+module Gloo
+  module WebSvr
+    class AssetInfo
+
+      # Class Variables
+      @@index_by_published = {}
+      @@index_by_pn = {}
+
+      attr_reader :name, :pn, :published_name, :published_pn, :hash
+
+
+      # ---------------------------------------------------------------------
+      #    Initialization
+      # ---------------------------------------------------------------------
+
+      #
+      # Set up an asset information object.
+      #
+      def initialize( engine, full_path, name, pn )
+        @engine = engine
+        @log = @engine.log
+
+        @full_path = full_path
+        @name = name
+        @pn = pn
+      end
+
+
+      # ---------------------------------------------------------------------
+      #    Functions
+      # ---------------------------------------------------------------------
+
+      # 
+      # Register the asset with indexes, inflating all needed data elements.
+      # 
+      def register
+        @log.debug "*** REGISTERING ASSET: #{@name}"
+        @log.debug "*** #{@full_path} "
+        @log.debug "*** #PN: #{@pn} name: #{@name}"
+
+        @hash = Gloo::Objs::FileHandle.hash_for_file( @full_path )
+
+        # Build published name
+        ext = File.extname( @pn )           # Gets just the extension
+        n = @name[ 0..-ext.length - 1 ]
+        pn = @pn[ 0..-ext.length - 1 ]
+
+        @published_name = "#{n}-#{@hash}#{ext}"
+        @published_pn = "#{pn}-#{@hash}#{ext}"
+
+        @log.debug "*** Published Name: #{@published_name}"
+        @log.debug "*** Published Path: #{@published_pn}"
+
+        # Add to indexes
+        AssetInfo.index self
+      end
+
+      # 
+      # Index the the given asset info record.
+      # 
+      def self.index info
+        @@index_by_pn[ info.pn ] = info
+        @@index_by_published[ info.published_pn ] = info
+      end
+
+      #
+      # Find the asset info for the given published name.
+      #
+      def self.find_published_name_for pn
+        return @@index_by_pn[ pn ].published_pn
+      end
+
+      # 
+      # Find the asset info for the given published name.
+      # 
+      def self.find_info_for pn
+        return @@index_by_published[ pn ]
+      end
+
+      # 
+      # List All assets.
+      # 
+      def self.list_all engine
+        data = []
+        @@index_by_pn.each do |pn, info|
+          data << [ info.name, info.pn, info.published_pn ]
+        end
+        headers = [ "Name", "Asset Path", "Published" ]
+
+        puts Gloo::App::Platform::RETURN
+        title = "Assets in Running Web App"
+        engine.platform.table.show headers, data, title
+        puts Gloo::App::Platform::RETURN
+      end
+
+    end
+  end
+end

data/lib/gloo/web_svr/embedded_renderer.rb

@@ -29,6 +29,50 @@ module Gloo
       end
 
 
+      # ---------------------------------------------------------------------
+      #    Tag Helpers
+      # ---------------------------------------------------------------------
+
+      # 
+      # Render a favicon tag.
+      # By default the name is 'favicon.ico' and does not need to be provided
+      # if that is the correct file name.
+      # 
+      def favicon_tag( name = 'favicon.ico' )
+        icon_path = "/#{Asset::ASSET_FOLDER}/#{Asset::IMAGE_FOLDER}/#{name}"
+        published_name = @engine.running_app.obj.asset.published_name( icon_path )
+        return "<link rel='shortcut icon' type='image/x-icon' href='#{published_name}' />"
+      end
+
+      # 
+      # Render an image tag for the given image name.
+      # Include optional proterties as part of the tag.
+      #
+      def image_tag( img_name, properties = '' )
+        image_path = "/#{Asset::ASSET_FOLDER}/#{Asset::IMAGE_FOLDER}/#{img_name}"
+        published_name = @engine.running_app.obj.asset.published_name( image_path )
+        return "<image src='#{published_name}' #{properties} />"
+      end
+
+      # 
+      # Render a script tag for the given script name.
+      #
+      def js_tag( name )
+        js_path = "/#{Asset::ASSET_FOLDER}/#{Asset::JAVASCRIPT_FOLDER}/#{name}"
+        published_name = @engine.running_app.obj.asset.published_name( js_path )
+        return "<script src='#{published_name}'></script>"
+      end
+
+      #
+      # Render a stylesheet tag for the given stylesheet name.
+      #
+      def css_tag( name )
+        css_path = "/#{Asset::ASSET_FOLDER}/#{Asset::STYLESHEET_FOLDER}/#{name}"
+        published_name = @engine.running_app.obj.asset.published_name( css_path )
+        return "<link rel='stylesheet' media='all' href='#{published_name}' />"
+      end
+
+
       # ---------------------------------------------------------------------
       #    Obj Helper Functions
       # ---------------------------------------------------------------------

data/lib/gloo/web_svr/routing/router.rb

@@ -201,6 +201,13 @@ module Gloo
         # Create a list of path segments.
         # 
         def detect_segments path
+          # For Assets, substitute the published name with fingerprint
+          # for the simple asset name (if it is found).
+          asset_info = Gloo::WebSvr::AssetInfo.find_info_for( path )
+          unless asset_info.blank?
+            path = asset_info.pn
+          end
+
           # Split the path into segments.
           @route_segments = path.split SEGMENT_DIVIDER
 

data/lib/gloo/web_svr/routing/show_routes.rb

@@ -10,7 +10,6 @@ module Gloo
       class ShowRoutes
 
         SEGMENT_DIVIDER = '/'.freeze
-        RETURN = "\n".freeze
 
 
         # ---------------------------------------------------------------------
@@ -76,10 +75,10 @@ module Gloo
         # Show the Routes title.
         # 
         def show_table
-          puts RETURN
+          puts Gloo::App::Platform::RETURN
           title = "Routes in Running Web App"
           @engine.platform.table.show headers, @found_routes, title
-          puts RETURN
+          puts Gloo::App::Platform::RETURN
         end
 
         # 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gloo
 version: !ruby/object:Gem::Version
-  version: 3.6.1
+  version: 3.7.0
 platform: ruby
 authors:
 - Eric Crane
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-12-19 00:00:00.000000000 Z
+date: 2025-01-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -514,6 +514,7 @@ files:
 - lib/gloo/verbs/version.rb
 - lib/gloo/verbs/wait.rb
 - lib/gloo/web_svr/asset.rb
+- lib/gloo/web_svr/asset_info.rb
 - lib/gloo/web_svr/config.rb
 - lib/gloo/web_svr/embedded_renderer.rb
 - lib/gloo/web_svr/handler.rb