funicular 0.5.0 → 0.5.2

data/mrblib/router.rb

@@ -1,6 +1,6 @@
 module Funicular
   class Router
-    attr_reader :routes, :current_component, :current_path, :url_helpers, :route_helpers
+    attr_reader :routes, :current_path, :url_helpers, :route_helpers, :current_route, :current_layouts
 
     def initialize(container)
       @container = container
@@ -8,6 +8,10 @@ module Funicular
       @default_route = nil
       @current_component = nil
       @current_path = nil
+      @current_route = nil
+      @current_layouts = []
+      @layout_stack = [] #: Array[singleton(Component)]
+      @layout_root = nil
       @popstate_callback_id = nil
       @beforeunload_callback_id = nil
       @url_helpers = Module.new
@@ -47,6 +51,27 @@ module Funicular
       @default_route = path
     end
 
+    def layout(component_class)
+      @layout_stack.push(component_class)
+      yield
+    ensure
+      @layout_stack.pop
+    end
+
+    def current_component
+      layout_root = @layout_root
+      route = @current_route
+      return @current_component unless layout_root && route
+
+      instance = layout_root #: Component?
+      chain = (@current_layouts[1..-1] || []) + [route[0]]
+      chain.each do |klass|
+        return nil unless instance
+        instance = find_component_instance(instance.vdom, klass)
+      end
+      instance
+    end
+
     # Resolve a path to [component_class, params] without any DOM/JS work.
     # Public entry point used by server-side rendering.
     def match(path)
@@ -91,7 +116,7 @@ module Funicular
       # a guard is active. sync: the decision must be made on the JS
       # event dispatch stack, so the guard must not suspend.
       @beforeunload_callback_id = JS.global.addEventListener('beforeunload', sync: true) do |event|
-        if @current_component&.navigation_guard
+        if current_component&.navigation_guard
           event.preventDefault
           event[:returnValue] = ''
         end
@@ -136,7 +161,7 @@ module Funicular
     # allowed; a String from the guard prompts the user via
     # Funicular.confirm. True when no component or no guard.
     def leave_allowed?
-      message = @current_component&.navigation_guard
+      message = current_component&.navigation_guard
       return true unless message
       Funicular.confirm(message)
     end
@@ -160,16 +185,19 @@ module Funicular
       @hydrate_initial = false
 
       # Find matching route
-      component_class, params = find_route(path)
+      route, params = match_route(path)
 
-      unless component_class
+      unless route
         # Maybe render a 404 component?
         return
       end
+      component_class = route[:component]
 
       # Don't remount if already on this path
       return if @current_path == path
 
+      return render_with_layouts(route, params, path, hydrate_now) unless route[:layouts].empty?
+
       # Unmount current component
       unmount_current_component
 
@@ -198,10 +226,56 @@ module Funicular
       @current_component.mount(@container)
     end
 
+    def render_with_layouts(route, params, path, hydrate_now)
+      if hydrate_now && Funicular.first_element_child(@container)
+        puts '[Funicular] Layouts do not support hydration; rendering fresh.'
+        @container[:innerHTML] = ''
+      end
+
+      layouts = route[:layouts]
+      layout_root = @layout_root
+      # Reuse the mounted chain only under the same outermost layout, and
+      # only when that root is not mid-render: Component#patch drops nested
+      # calls, so a page that navigates from component_mounted during a
+      # re-render would otherwise change the URL and leave the old page in
+      # the DOM. Remounting the chain matches what bare routes do.
+      reusable = layout_root && layout_root.mounted && !layout_root.updating? &&
+                 @current_layouts.first == layouts.first
+      unmount_current_component unless reusable
+
+      @current_path = path
+      @current_route = [route[:component], params]
+      @current_layouts = layouts
+
+      if layout_root && reusable
+        layout_root.patch(__route__: path)
+      else
+        layout_root = layouts.first.new
+        layout_root.runtime = @runtime
+        @layout_root = layout_root
+        layout_root.mount(@container)
+      end
+    end
+
+    def find_component_instance(vnode, component_class)
+      return unless vnode.is_a?(VDOM::Element) || vnode.is_a?(VDOM::Component)
+      return vnode.instance if vnode.is_a?(VDOM::Component) && vnode.component_class == component_class
+
+      vnode.children.each do |child|
+        found = find_component_instance(child, component_class)
+        return found if found
+      end
+      nil
+    end
+
     # Unmount current component
     def unmount_current_component
       @current_component&.unmount
       @current_component = nil
+      @layout_root&.unmount
+      @layout_root = nil
+      @current_layouts = []
+      @current_route = nil
       @current_path = nil
     end
 
@@ -215,7 +289,8 @@ module Funicular
         component: component_class,
         name: name,
         pattern_segments: pattern_segments,
-        constraints: constraints || {}
+        constraints: constraints || {},
+        layouts: @layout_stack.dup
       }
       # @type var route: Funicular::route_definition_t
       @routes << route
@@ -273,6 +348,11 @@ module Funicular
     end
 
     def find_route(path)
+      route, params = match_route(path)
+      [route && route[:component], params]
+    end
+
+    def match_route(path)
       path_segments = path.split('/').reject { |s| s.empty? }
       params = {} #: Hash[Symbol, untyped]
 
@@ -302,7 +382,7 @@ module Funicular
           end
         end
 
-        return [route[:component], params] if match
+        return [route, params] if match
       end
 
       [nil, params] # No route found

data/mrblib/vdom.rb

@@ -39,6 +39,16 @@ module Funicular
       true
     end
 
+    def self.text(child)
+      return child if child.is_a?(String)
+      child.content.to_s if child.is_a?(Text)
+    end
+
+    def self.child_nodes(element)
+      nodes = element[:childNodes]
+      nodes.is_a?(JS::Object) ? nodes.to_a : [] #: Array[untyped]
+    end
+
     def self.event_attribute?(name)
       name.to_s.downcase.start_with?('on')
     end
@@ -100,6 +110,11 @@ module Funicular
         @children = normalize_children(children || [])
       end
 
+      def ==(other)
+        return false unless other.is_a?(Element)
+        @tag == other.tag && @props == other.props && @children == other.children
+      end
+
       private
 
       def normalize_children(children)
@@ -115,8 +130,8 @@ module Funicular
             # Recursively normalize nested arrays
             # @type var child: Array[Funicular::VDOM::child_t]
             result.concat(normalize_children(child))
-          when nil
-            # Skip nil values
+          when nil, false
+            result << ''
           else
             # Convert other types to strings
             result << child.to_s
@@ -124,11 +139,6 @@ module Funicular
         end
         result
       end
-
-      def ==(other)
-        return false unless other.is_a?(Element)
-        @tag == other.tag && @props == other.props && @children == other.children
-      end
     end
 
     class Text < VNode

data/mrblib/version.rb

@@ -0,0 +1,11 @@
+# Single source of truth for the Funicular version.
+#
+# This file lives in mrblib so that it is compiled into PicoRuby.wasm along
+# with the rest of the runtime. The CRuby gem reuses it via
+# lib/funicular/version.rb, so the version is defined in exactly one place.
+#
+# Keep this file free of any dependency: it must evaluate standalone in
+# both PicoRuby and CRuby, regardless of load order.
+module Funicular
+  VERSION = '0.5.2'
+end

data/sig/component.rbs

@@ -61,6 +61,7 @@ module Funicular
     def render_suspense: (Symbol name, fallback: untyped, ?error: untyped) { (ResourceAccessor) -> untyped } -> untyped
 
     def navigation_guard: () -> String?
+    def updating?: () -> bool
     def patch: (Hash[Symbol, untyped] new_state) -> void
     def mount: (JS::Element container) -> void
     def hydrate: (JS::Element dom_element) -> void
@@ -75,6 +76,7 @@ module Funicular
     def __view__: () -> ViewContext
     def routes: () -> untyped
     def component: (singleton(Component) component_class, ?Hash[Symbol, untyped] props) ?{ () -> untyped } -> VDOM::Component
+    def outlet: () -> VDOM::Component?
     def form_for: (Symbol model_key, ?Hash[Symbol, untyped] options) { (FormBuilder) -> void } -> VDOM::Element
     def link_to: (String path, **untyped options) ?{ -> untyped } -> VDOM::Element
     def button_to: (String path, ?method: Symbol, **untyped options) ?{ -> untyped } -> VDOM::Element

data/sig/debug.rbs

@@ -20,7 +20,12 @@ module Funicular
     def self.last_error: () -> Hash[Symbol, untyped]?
     def self.error_count: () -> Integer
 
+    INSPECT_MAX_DEPTH: Integer
+    INSPECT_MAX_ITEMS: Integer
+
     private def self.error_registry: () -> Array[Hash[Symbol, untyped]]
+    private def self.safe_inspect: (untyped value, ?Integer depth) -> String
+    private def self.safe_inspect_object: (untyped value, Integer depth) -> String
     private def self.get_state_keys: (Funicular::Component) -> Array[String]
     private def self.get_child_ids: (Funicular::Component) -> Array[Integer]
     private def self.collect_direct_children: (Funicular::VDOM::VNode, Array[Funicular::Component]) -> void

data/sig/html_serializer.rbs

@@ -3,6 +3,8 @@ module Funicular
     class HTMLSerializer
       VOID_ELEMENTS: Array[String]
       SKIP_PROPS: Array[Symbol]
+      RAW_TEXT_ELEMENTS: Array[String]
+      NEWLINE_STRIPPING_ELEMENTS: Array[String]
 
       def self.serialize: (VNode? vnode, ?Runtime? runtime) -> String
       def initialize: (?Runtime? runtime) -> void
@@ -10,7 +12,7 @@ module Funicular
 
       private
       def render_element: (Element element) -> String
-      def render_children: (Array[child_t] children) -> String
+      def render_children: (Array[child_t] children, bool marks) -> String
       def render_text: (Text text) -> String
       def render_component: (Component component_vnode) -> String
       def serialize_props: (Hash[Symbol, untyped] props) -> String

data/sig/router.rbs

@@ -1,10 +1,11 @@
 module Funicular
   type route_constraints_t = Hash[Symbol, Regexp]
-  type route_definition_t = { method: Symbol, path: String, component: singleton(Component), name: String?, pattern_segments: Array[String], constraints: route_constraints_t }
+  type route_definition_t = { method: Symbol, path: String, component: singleton(Component), name: String?, pattern_segments: Array[String], constraints: route_constraints_t, layouts: Array[singleton(Component)] }
 
   class Router
     attr_reader routes: Array[route_definition_t]
-    attr_reader current_component: Component?
+    attr_reader current_route: [singleton(Component), Hash[Symbol, untyped]]?
+    attr_reader current_layouts: Array[singleton(Component)]
     attr_reader current_path: String?
     attr_reader url_helpers: Module
     attr_reader route_helpers: untyped
@@ -17,6 +18,8 @@ module Funicular
     def delete: (String path, to: singleton(Component), ?as: String?, ?constraints: route_constraints_t?) -> void
     def add_route: (String path, singleton(Component) component_class, ?as: String?, ?constraints: route_constraints_t?) -> void
     def set_default: (String path) -> void
+    def layout: (singleton(Component) component_class) { () -> void } -> void
+    def current_component: () -> Component?
     def match: (String path) -> [singleton(Component)?, Hash[Symbol, untyped]]
     def start: (?hydrate: bool) -> void
     def stop: () -> void
@@ -28,7 +31,10 @@ module Funicular
     private def generate_url_helper: (String name, String path_pattern) -> void
     private def extract_param_names: (String path_pattern) -> Array[Symbol]
     private def handle_route_change: () -> void
+    private def render_with_layouts: (route_definition_t route, Hash[Symbol, untyped] params, String path, bool? hydrate_now) -> void
+    private def find_component_instance: (untyped vnode, singleton(Component) component_class) -> Component?
     private def unmount_current_component: () -> void
     private def find_route: (String path) -> [singleton(Component) | nil, Hash[Symbol, untyped]]
+    private def match_route: (String path) -> [route_definition_t?, Hash[Symbol, untyped]]
   end
 end

data/sig/vdom.rbs

@@ -7,6 +7,8 @@ module Funicular
     SCRIPTING_ELEMENTS: Array[String]
 
     def self.valid_tag_name?: (untyped name) -> bool
+    def self.text: (untyped child) -> String?
+    def self.child_nodes: (untyped element) -> Array[untyped]
     def self.valid_attribute_name?: (untyped name) -> bool
     def self.event_attribute?: (untyped name) -> bool
     def self.unsafe_url?: (untyped name, untyped value) -> bool

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: funicular
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.5.2
 platform: ruby
 authors:
 - HASUMI Hitoshi
@@ -156,6 +156,7 @@ files:
 - mrblib/store_singleton.rb
 - mrblib/styles.rb
 - mrblib/vdom.rb
+- mrblib/version.rb
 - mrblib/view_context.rb
 - sig/cable.rbs
 - sig/component.rbs
@@ -186,7 +187,7 @@ homepage: https://github.com/picoruby/funicular
 licenses:
 - MIT
 metadata:
-  homepage_uri: https://picoruby.org/funicular-getting-started
+  homepage_uri: https://picoruby.org/funicular
   source_code_uri: https://github.com/picoruby/funicular
   changelog_uri: https://github.com/picoruby/funicular/blob/master/CHANGELOG.md
 post_install_message: |2+
@@ -223,8 +224,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.10
+rubygems_version: 4.0.20
 specification_version: 4
-summary: Rails plugin for client-side Ruby development with mruby
+summary: Rails plugin for client-side Ruby development with PicoRuby
 test_files: []
 ...