gloo-web 1.0

data/lib/routing/resource_router.rb

@@ -0,0 +1,43 @@
+# Author::    Eric Crane  (mailto:eric.crane@mac.com)
+# Copyright:: Copyright (c) 2024 Eric Crane.  All rights reserved.
+#
+# A helper class for Resource routing.
+# 
+
+module Routing
+  class ResourceRouter
+    
+    INDEX = 'index'.freeze
+    SHOW = 'show'.freeze
+    DELETE = 'delete'.freeze
+    UPDATE = 'update'.freeze
+
+    POST_ROUTE = 'create'.freeze
+
+
+    # 
+    # Is the given route segment an implicit create resource?
+    # It is explicit if it is 'create' 
+    #  and implicit if it is a POST to the resource.
+    # 
+    def self.is_implicit_create?( method, route_segment )
+      return false unless WebSvr::WebMethod.is_post?( method )
+
+      return ! route_segment.eql?( POST_ROUTE )
+    end
+
+    # 
+    # Add the segment based on the method.
+    # 
+    def self.segment_for_method( method ) 
+      if WebSvr::WebMethod.is_delete?( method )
+        return DELETE
+      elsif WebSvr::WebMethod.is_patch?( method )
+        return UPDATE
+      else
+        return SHOW
+      end
+    end
+    
+  end
+end

data/lib/routing/router.rb

@@ -0,0 +1,228 @@
+# Author::    Eric Crane  (mailto:eric.crane@mac.com)
+# Copyright:: Copyright (c) 2024 Eric Crane.  All rights reserved.
+#
+# A helper class for page routing.
+# 
+
+module Routing
+  class Router
+    
+    PAGE_CONTAINER = 'page'.freeze
+    SEGMENT_DIVIDER = '/'.freeze
+
+    attr_reader :route_segments
+
+
+    # ---------------------------------------------------------------------
+    #    Initialization
+    # ---------------------------------------------------------------------
+
+    #
+    # Set up the web server.
+    #
+    def initialize( engine, web_svr_obj )
+      @engine = engine
+      @log = @engine.log
+
+      @web_svr_obj = web_svr_obj
+      @show_routes = ShowRoutes.new( @engine )
+    end
+
+
+    # ---------------------------------------------------------------------
+    #    Routing
+    # ---------------------------------------------------------------------
+
+    # 
+    # Find and return the page for the given route.
+    # 
+    def page_for_route( path, method )
+      @log.info "routing to #{path} for method #{method}"
+      @method = method
+      route_params = nil
+      @id = nil
+      
+      detect_segments path
+
+      return @web_svr_obj.home_page if is_root_path?
+
+      pages = @web_svr_obj.pages_container
+      if pages
+        # If the method is POST and the last segment is NOT 'create',
+        # we'll add create to the route segments.
+        if Routing::ResourceRouter.is_implicit_create?( method, @route_segments.last )
+          @route_segments << Routing::ResourceRouter::POST_ROUTE
+          page = find_route_segment( pages.children )
+          return [ page, @id, route_params ] if page
+
+          # We didn't find the page, so remove the last segment and try again 
+          # posting to the resource.
+          @route_segments.pop
+        end
+
+        page = find_route_segment( pages.children ) 
+        
+        # Are there any remaining segments to be added as route parameters?
+        if @route_segments.count > 0
+          route_params = @route_segments
+        end
+
+        return [ page, @id, route_params ] if page
+      end
+
+      return nil
+    end
+
+
+    # ---------------------------------------------------------------------
+    #    Dynamic Add Page Routes
+    # ---------------------------------------------------------------------
+
+    # 
+    # Get the root level page container.
+    #
+    def page_container
+      pn = Gloo::Core::Pn.new( @engine, PAGE_CONTAINER )
+      return pn.resolve
+    end
+
+    # 
+    # Add all page routes to the web server pages (routes).
+    # 
+    def add_page_routes
+      can = page_container
+      return unless can
+
+      @log.debug 'Adding page routes to web server…'
+      @factory = @engine.factory
+
+      add_pages can, @web_svr_obj.pages_container
+    end
+
+    #
+    # Add the pages to the web server pages.
+    # This is a recursive function that will add all
+    # pages in the folder and subfolders.
+    #
+    def add_pages can, parent
+      # for each file in the page container
+      # create a page object and add it to the routes
+      can.children.each do |obj|
+        if obj.class == Gloo::Objs::Container
+          child_can = parent.find_add_child( obj.name, 'container' )
+          add_pages( obj, child_can )
+        elsif obj.class == Objs::Page
+          add_route_alias( parent, obj.name, obj.pn )
+        end
+      end
+    end
+
+    # 
+    # Add route alias to the page.
+    # 
+    def add_route_alias( parent, name, pn )
+      name = name.gsub( '.', '_' )
+
+      # First make sure the child doesn't already exist.
+      child = parent.find_child( name )
+      return if child
+
+      @factory.create_alias( name, pn, parent )
+    end
+
+    
+    # ---------------------------------------------------------------------
+    #    Helper funcions
+    # ---------------------------------------------------------------------
+
+    # 
+    # Show the routes in the running app.
+    # This uses the ShowRoutes helper class.
+    #
+    def show_routes
+      @show_routes.show page_container
+    end
+
+    # 
+    # Find the route segment in the object container.
+    # 
+    def find_route_segment objs
+      this_segment = next_segment
+
+      if this_segment.blank? # && WebSvr::WebMethod.is_post?( @method )
+        this_segment = Routing::ResourceRouter::INDEX 
+      end
+
+      objs.each do |o|
+        o = Gloo::Objs::Alias.resolve_alias( @engine, o )
+
+        if o.name == this_segment
+          if o.class == Objs::Page
+            @log.debug "found page for route: #{o.pn}"
+            return o
+          elsif o.class == Gloo::Objs::FileHandle
+            @log.debug "found static file for route: #{o.pn}"
+            return o
+          else
+            return nil unless o.child_count > 0
+
+            return find_route_segment( o.children )
+          end
+        end
+      end
+
+      return nil 
+    end
+
+    # 
+    # Get the next segment in the route.
+    # 
+    def next_segment
+      this_segment = @route_segments.shift
+      return nil if this_segment.nil?
+
+      # A URL might include a dot in a name, but we can't do that
+      # because dot is a reserve path thing. So we replace it with
+      # an underscore.
+      this_segment = this_segment.gsub( '.', '_' )
+
+      return this_segment
+    end
+
+    # 
+    # Is this the root path?
+    def is_root_path?
+      return @route_segments.count == 0
+    end
+
+    # 
+    # 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 = 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
+
+      # Remove the first segment if it is empty.
+      @route_segments.shift if @route_segments.first.blank?
+
+      @route_segments.each do |seg|
+        if seg.to_i.to_s == seg
+          @id = seg.to_i
+          @log.info "found id for route: #{@id}"
+          @route_segments.delete seg
+          @route_segments << ResourceRouter.segment_for_method( @method )
+        end
+      end
+
+      return @route_segments
+    end
+
+  end
+end

data/lib/routing/show_routes.rb

@@ -0,0 +1,90 @@
+# Author::    Eric Crane  (mailto:eric.crane@mac.com)
+# Copyright:: Copyright (c) 2024 Eric Crane.  All rights reserved.
+#
+# A helper class for to show routes for a running app.
+# 
+
+module Routing
+  class ShowRoutes
+
+    SEGMENT_DIVIDER = '/'.freeze
+
+
+    # ---------------------------------------------------------------------
+    #    Initialization
+    # ---------------------------------------------------------------------
+
+    #
+    # Set up the web server.
+    #
+    def initialize( engine )
+      @engine = engine
+      @log = @engine.log
+    end
+
+    
+    # ---------------------------------------------------------------------
+    #    Show Routes
+    # ---------------------------------------------------------------------
+
+    # 
+    # Show all available routes.
+    # 
+    def show page_container
+      @log.debug "showing routes"
+
+      @found_routes = []
+      @log.debug "building route table"
+      add_container_routes( page_container, SEGMENT_DIVIDER )
+
+      show_table
+    end
+
+    #
+    # Show the routes in the given container.
+    # This is a recursive function travese the object tree.
+    # 
+    def add_container_routes can, route_path
+      can.children.each do |obj|
+        if obj.class == Gloo::Objs::Container
+          add_container_routes obj, "#{route_path}#{obj.name}#{SEGMENT_DIVIDER}"
+        elsif obj.class == Gloo::Objs::Page
+          route = "#{route_path}#{obj.name}"
+          @found_routes << [ obj.name, obj.pn, route, WebSvr::WebMethod::GET ]
+
+          # If the method is POST, add a route alias for the create.
+          if obj.name.eql? ResourceRouter::POST_ROUTE
+            @found_routes << [ '', '', route_path, WebSvr::WebMethod::POST ]
+          elsif obj.name.eql? ResourceRouter::UPDATE
+            @found_routes << [ '', '', route_path, WebSvr::WebMethod::PATCH ]
+          elsif obj.name.eql? ResourceRouter::DELETE
+            @found_routes << [ '', '', route_path, WebSvr::WebMethod::DELETE ]
+          end
+        end
+      end
+    end
+
+
+    # ---------------------------------------------------------------------
+    #    Show Routes
+    # ---------------------------------------------------------------------
+
+    # 
+    # Show the Routes title.
+    # 
+    def show_table
+      puts Gloo::App::Platform::RETURN
+      title = "Routes in Running Web App"
+      @engine.platform.table.show headers, @found_routes, title
+      puts Gloo::App::Platform::RETURN
+    end
+
+    # 
+    # Get the table headers.
+    # 
+    def headers
+      return [ 'Obj Name', 'Obj Path', 'Route', 'Method' ]
+    end
+
+  end
+end