glimmer-dsl-web 0.2.8 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a9f4b7e33522df500ca481bf4b9ba138c6cb3dad3847bee24f3f506fa985ac11
-  data.tar.gz: fd7fd300d3519276ffb27de97049daf2b59cec4a5f1c2882b7386257dddc25d7
+  metadata.gz: 6147bc2c609c3b5d7871c0d7f16b84f57c5b10c83c22a8ab63fb7e7120a69e65
+  data.tar.gz: e469cc54afb68870470d1bb5ab4a265000d87901873119e01c68f7586ebd883e
 SHA512:
-  metadata.gz: dbfcc16bf944ef8726912ee31e2ab8f045bba776a63d4377fea70c0fa28d990907b17f94b59ea0cc8e6e4855a4bba2bd965a66bea44fb53fd20ce3539cb09518
-  data.tar.gz: 1220943c86ee1455654901700c1bf90834b81af96e355b86ebb7a91275a6130030917ce13eaa755cd0a8388d3fb9497b57a75372f1409989b9ffe0646774df32
+  metadata.gz: dadb81d22299adef771b31cc9152881a61f2cde0a93bd4a46223669d688fd78bae4fe33311875baa2cf6ee30f6f53d534ba2d4af2b5d57a49e3e902b00605dad
+  data.tar.gz: a3426ea5baa49c13d0091bd1e3410f43ac168b1c3f04dbff5b7c7eb4c584b61bf9463b9ad59e89d3e7827abc6a48ad5c468219762a9b58332b46c8980a74397d

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Change Log
 
+## 0.3.0
+
+- Optimize performance (~170%-226% faster) by building GUI with a bulk_render call that assembles html as a string from all nested elements and mounts all HTML at once (instead of making many small DOM mount calls). The trade-off is not being able to interact with elements until rendering of the complete hierarchy is complete, which is acceptable because interactions do not happen till after everything is rendered anyways. Can be disabled by passing `bulk_render: false` option to the top-level element of a frontend app.
+- Fix issue with not being able to add content to a custom control by opening a block that should add content inside its markup root element
+
 ## 0.2.8
 
 - Support Content Data-Binding to multiple model attributes via `computed_by` option (e.g. `content(@game, :scale, computed_by: [:width, :height])` or `content(@game, computed_by: [:scale, :width, :height])` will re-render content on changes to `:scale`, `:width`, or `:height`)

data/README.md

@@ -1,4 +1,4 @@
-# [<img src="https://raw.githubusercontent.com/AndyObtiva/glimmer/master/images/glimmer-logo-hi-res.png" height=85 />](https://github.com/AndyObtiva/glimmer) Glimmer DSL for Web 0.2.8 (Beta)
+# [<img src="https://raw.githubusercontent.com/AndyObtiva/glimmer/master/images/glimmer-logo-hi-res.png" height=85 />](https://github.com/AndyObtiva/glimmer) Glimmer DSL for Web 0.3.0 (Beta)
 ## Ruby in the Browser Web Frontend Framework
 ### Finally, Ruby Developer Productivity, Happiness, and Fun in the Frontend!!!
 [![Gem Version](https://badge.fury.io/rb/glimmer-dsl-web.svg)](http://badge.fury.io/rb/glimmer-dsl-web)
@@ -1329,7 +1329,7 @@ rails new glimmer_app_server
 Add the following to `Gemfile`:
 
 ```
-gem 'glimmer-dsl-web', '~> 0.2.8'
+gem 'glimmer-dsl-web', '~> 0.3.0'
 ```
 
 Run:
@@ -1556,7 +1556,7 @@ Disable the `webpacker` gem line in `Gemfile`:
 Add the following to `Gemfile`:
 
 ```ruby
-gem 'glimmer-dsl-web', '~> 0.2.8'
+gem 'glimmer-dsl-web', '~> 0.3.0'
 ```
 
 Run:

data/VERSION

@@ -1 +1 @@
-0.2.8
+0.3.0

data/glimmer-dsl-web.gemspec

@@ -2,16 +2,16 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: glimmer-dsl-web 0.2.8 ruby lib
+# stub: glimmer-dsl-web 0.3.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "glimmer-dsl-web".freeze
-  s.version = "0.2.8"
+  s.version = "0.3.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib".freeze]
   s.authors = ["Andy Maleh".freeze]
-  s.date = "2024-06-21"
+  s.date = "2024-06-25"
   s.description = "Glimmer DSL for Web (Ruby in the Browser Web Frontend Framework) enables building Web Frontends using Ruby in the Browser, as per Matz's recommendation in his RubyConf 2022 keynote speech to replace JavaScript with Ruby. It aims at providing the simplest, most intuitive, most straight-forward, and most productive frontend framework in existence. The framework follows the Ruby way (with DSLs and TIMTOWTDI) and the Rails way (Convention over Configuration) in building Isomorphic Ruby on Rails Applications. It provides a Ruby HTML DSL, which uniquely enables writing both structure code and logic code in one language. It supports both Unidirectional (One-Way) Data-Binding (using <=) and Bidirectional (Two-Way) Data-Binding (using <=>). Dynamic rendering (and re-rendering) of HTML content is also supported via Content Data-Binding. Modular design is supported with Glimmer Web Components. And, a Ruby CSS DSL is supported with the included Glimmer DSL for CSS. Many samples are demonstrated in the Rails sample app (there is a very minimal Standalone [No Rails] sample app too). You can finally live in pure Rubyland on the Web in both the frontend and backend with Glimmer DSL for Web! This gem relies on Opal Ruby.".freeze
   s.email = "andy.am@gmail.com".freeze
   s.extra_rdoc_files = [

data/lib/glimmer/dsl/web/general_element_expression.rb

@@ -12,11 +12,9 @@ module Glimmer
         end
         
         def add_content(parent, keyword, *args, &block)
-          if parent.rendered? || parent.skip_content_on_render_blocks?
+          if parent.bulk_render? || parent.rendered? || parent.skip_content_on_render_blocks?
             return_value = super(parent, keyword, *args, &block)
-            if return_value.is_a?(String) && parent.dom_element.text.to_s.empty?
-              parent.add_text_content(return_value)
-            end
+            parent.add_text_content(return_value, on_empty: true) if return_value.is_a?(String)
             parent.post_add_content
             return_value
           else

data/lib/glimmer/dsl/web/style_expression.rb

@@ -14,12 +14,10 @@ module Glimmer
         end
         
         def add_content(parent, keyword, *args, &block)
-          if parent.rendered? || parent.skip_content_on_render_blocks?
+          if parent.bulk_render? || parent.rendered? || parent.skip_content_on_render_blocks?
             return_value = css(&block).to_s
             return_value = super(parent, keyword, *args, &block) if return_value.to_s.empty?
-            if return_value.is_a?(String) && parent.dom_element.text.to_s.empty?
-              parent.add_text_content(return_value)
-            end
+            parent.add_text_content(return_value, on_empty: true) if return_value.is_a?(String)
             parent.post_add_content
             return_value
           else

data/lib/glimmer/web/element_proxy.rb

@@ -83,6 +83,11 @@ module Glimmer
             "<#{element}#{attributes}>#{content}</#{element}>"
           end
         end
+        
+        def unrendered_dom_element(keyword)
+          @unrendered_dom_elements ||= {}
+          @unrendered_dom_elements[keyword] ||= Element["<#{keyword} />"]
+        end
       end
       
       include Glimmer
@@ -118,22 +123,28 @@ module Glimmer
       REGEX_FORMAT_DATE = /^\d{4}-\d{2}-\d{2}$/
       REGEX_FORMAT_TIME = /^\d{2}:\d{2}$/
       
-      attr_reader :keyword, :parent, :args, :options, :children, :enabled, :foreground, :background, :removed?, :rendered
+      attr_reader :keyword, :parent, :parent_component, :args, :options, :children, :enabled, :foreground, :background, :removed?, :rendered
       alias rendered? rendered
       
       def initialize(keyword, parent, args, block)
         @keyword = keyword
-        @parent = parent
+        @parent = parent.is_a?(Glimmer::Web::Component) ? parent.markup_root : parent
+        @parent_component = parent if parent.is_a?(Glimmer::Web::Component)
         @options = args.last.is_a?(Hash) ? args.last.symbolize_keys : {}
         if parent.nil?
           options[:parent] ||= Component.interpretation_stack.last&.options&.[](:parent)
           options[:render] ||= Component.interpretation_stack.last&.options&.[](:render)
+          options[:bulk_render] ||= Component.interpretation_stack.last&.options&.[](:bulk_render)
         end
         @args = args
         @block = block
         @children = []
         @parent&.post_initialize_child(self)
-        render if !@rendered && render_after_create?
+        render if !bulk_render? && !@rendered && render_after_create?
+      end
+      
+      def bulk_render?
+        options[:bulk_render] != false && (@parent.nil? || @parent.bulk_render?)
       end
       
       def render_after_create?
@@ -143,7 +154,7 @@ module Glimmer
       # Executes for the parent of a child that just got added
       def post_initialize_child(child)
         @children << child
-        child.render if !render_after_create?
+        child.render if !bulk_render? && !render_after_create?
       end
       
       # Executes for the parent of a child that just got removed
@@ -153,21 +164,22 @@ module Glimmer
       
       # Executes at the closing of a parent widget curly braces after all children/properties have been added/set
       def post_add_content
-        # TODO double check every place we should call this method
-        # No Op
+        render if bulk_render? && @parent.nil?
       end
       
       def css_classes
-        dom_element.attr('class').to_s.split
+        dom_element.attr('class').to_s.split if rendered?
       end
       
       def remove
-        @children.dup.each do |child|
-          child.remove
-        end
         on_remove_listeners = listeners_for('on_remove').dup
-        remove_all_listeners
-        dom_element.remove
+        if rendered?
+          @children.dup.each do |child|
+            child.remove
+          end
+          remove_all_listeners
+          dom_element.remove
+        end
         parent&.post_remove_child(self)
         @removed = true
         on_remove_listeners.each do |listener|
@@ -222,20 +234,32 @@ module Glimmer
       end
 
       def enabled=(value)
-        @enabled = value
-        dom_element.prop('disabled', !@enabled)
+        if rendered?
+          @enabled = value
+          dom_element.prop('disabled', !@enabled)
+        else
+          enqueue_post_render_method_call('enabled=', value)
+        end
       end
       
       def foreground=(value)
-        value = ColorProxy.new(value) if value.is_a?(String)
-        @foreground = value
-        dom_element.css('color', foreground.to_css) unless foreground.nil?
+        if rendered?
+          value = ColorProxy.new(value) if value.is_a?(String)
+          @foreground = value
+          dom_element.css('color', foreground.to_css) unless foreground.nil?
+        else
+          enqueue_post_render_method_call('foreground=', value)
+        end
       end
       
       def background=(value)
-        value = ColorProxy.new(value) if value.is_a?(String)
-        @background = value
-        dom_element.css('background-color', background.to_css) unless background.nil?
+        if rendered?
+          value = ColorProxy.new(value) if value.is_a?(String)
+          @background = value
+          dom_element.css('background-color', background.to_css) unless background.nil?
+        else
+          enqueue_post_render_method_call('background=', value)
+        end
       end
       
       def parent_selector
@@ -243,8 +267,8 @@ module Glimmer
       end
       
       def parent_dom_element
-        if parent_selector
-          Document.find(parent_selector)
+        if parent
+          parent.dom_element
         else
           options[:parent] ||= 'body'
           the_element = Document.find(options[:parent])
@@ -272,26 +296,12 @@ module Glimmer
         else
           reattach(old_element)
         end
-        observation_requests&.each do |keyword, event_listener_set|
-          event_listener_set.each do |event_listener|
-            handle_observation_request(keyword, event_listener)
-          end
-        end
-        unless render_after_create?
-          children.each do |child|
-            child.render
-          end
-        end
-        @rendered = true
-        unless skip_content_on_render_blocks?
-          content_on_render_blocks.each do |content_block|
-            content(&content_block)
-          end
-        end
-        # TODO replace following line with a method call like (`notify_listeners('on_render')`)
-        listeners_for('on_render').each do |listener|
-          listener.original_event_listener.call(EventProxy.new(listener: listener))
-        end
+        mark_rendered
+        invoke_post_render_method_calls if bulk_render?
+        handle_observation_requests
+        children.each(&:render) if !bulk_render? && !render_after_create?
+        add_contents_for_render_blocks
+        notify_on_render_listeners
       end
       alias rerender render
         
@@ -303,8 +313,17 @@ module Glimmer
         old_element.replace_with(@dom)
       end
       
-      def add_text_content(text)
-        dom_element.append(text.to_s)
+      def mark_rendered
+        @rendered = true
+        children.each(&:mark_rendered) if bulk_render?
+      end
+      
+      def add_text_content(text, on_empty: false)
+        if rendered?
+          dom_element.append(text.to_s) if !on_empty || dom_element.text.to_s.empty?
+        else
+          enqueue_post_render_method_call('add_text_content', text, on_empty:)
+        end
       end
       
       def content_on_render_blocks
@@ -332,11 +351,16 @@ module Glimmer
         # TODO auto-convert known glimmer attributes like parent to data attributes like data-parent
         # TODO check if we need to avoid rendering content block if no content is available
         @dom ||= begin
-          content = args.first if args.first.is_a?(String)
+          content = args.first.is_a?(String) ? args.first : ''
+          content += children_dom_content if bulk_render?
           ElementProxy.render_html(keyword, html_options, content)
         end
       end
       
+      def children_dom_content
+        children.map(&:dom).join
+      end
+      
       def html_options
         body_class = ([name, element_id] + css_classes.to_a).join(' ')
         html_options = options.dup
@@ -351,8 +375,12 @@ module Glimmer
         html_options
       end
       
-      def content(&block)
-        Glimmer::DSL::Engine.add_content(self, Glimmer::DSL::Web::ElementExpression.new, keyword, &block)
+      def content(bulk_render: false, &block)
+        original_bulk_render = options[:bulk_render]
+        options[:bulk_render] = bulk_render if rendered?
+        return_value = Glimmer::DSL::Engine.add_content(self, Glimmer::DSL::Web::ElementExpression.new, keyword, &block)
+        options[:bulk_render] = original_bulk_render if rendered?
+        return_value
       end
       
       # Subclasses must override with their own mappings
@@ -372,13 +400,21 @@ module Glimmer
       end
       
       def class_name=(value)
-        value = value.is_a?(Array) ? value.join(' ') : value.to_s
-        new_class_name = "#{name} #{element_id} #{value}"
-        dom_element.prop('className', new_class_name)
+        if rendered?
+          value = value.is_a?(Array) ? value.join(' ') : value.to_s
+          new_class_name = "#{name} #{element_id} #{value}"
+          dom_element.prop('className', new_class_name)
+        else
+          enqueue_post_render_method_call('class_name=', value)
+        end
       end
       
       def add_css_class(css_class)
-        dom_element.add_class(css_class)
+        if rendered?
+          dom_element.add_class(css_class)
+        else
+          enqueue_post_render_method_call('class_name=', value)
+        end
       end
       
       def add_css_classes(css_classes_to_add)
@@ -386,7 +422,11 @@ module Glimmer
       end
       
       def remove_css_class(css_class)
-        dom_element.remove_class(css_class)
+        if rendered?
+          dom_element.remove_class(css_class)
+        else
+          enqueue_post_render_method_call('class_name=', value)
+        end
       end
       
       def remove_css_classes(css_classes_to_remove)
@@ -397,38 +437,17 @@ module Glimmer
         css_classes.each {|css_class| remove_css_class(css_class)}
       end
       
-      def has_style?(symbol)
-        @args.include?(symbol) # not a very solid implementation. Bring SWT constants eventually
-      end
-      
       def dom_element
-        # TODO consider making this pick an element in relation to its parent, allowing unhooked dom elements to be built if needed (unhooked to the visible page dom)
-        Document.find(selector)
-      end
-      
-      # TODO consider adding a default #dom method implementation for the common case, automatically relying on #element and other methods to build the dom html
-      
-      def style_element
-        style_element_id = "#{id}-style"
-        style_element_selector = "style##{style_element_id}"
-        element = dom_element.find(style_element_selector)
-        if element.empty?
-          new_element = Element.new(:style)
-          new_element.attr('id', style_element_id)
-          new_element.attr('class', "#{name.gsub('_', '-')}-instance-style widget-instance-style")
-          dom_element.prepend(new_element)
-          element = dom_element.find(style_element_selector)
+        if rendered?
+          # TODO consider making this pick an element in relation to its parent, allowing unhooked dom elements to be built if needed (unhooked to the visible page dom)
+          Document.find(selector)
+        else
+          # Using a fill-in dom element until self is rendered
+          ElementProxy.unrendered_dom_element(keyword)
         end
-        element
-      end
-      
-      def listener_selector
-        selector
       end
       
-      def listener_dom_element
-        Document.find(listener_selector)
-      end
+      # TODO consider adding a default #dom method implementation for the common case, automatically relying on #element and other methods to build the dom html
       
       def observation_requests
         @observation_requests ||= {}
@@ -473,16 +492,20 @@ module Glimmer
       end
       
       def handle_observation_request(keyword, original_event_listener)
-        listener = ListenerProxy.new(
-          element: self,
-          selector: selector,
-          dom_element: dom_element,
-          event_attribute: keyword,
-          original_event_listener: original_event_listener,
-        )
-        listener.register
-        listeners_for(keyword) << listener
-        listener
+        if rendered?
+          listener = ListenerProxy.new(
+            element: self,
+            selector: selector,
+            dom_element: dom_element,
+            event_attribute: keyword,
+            original_event_listener: original_event_listener,
+          )
+          listener.register
+          listeners_for(keyword) << listener
+          listener
+        else
+          enqueue_post_render_method_call('handle_observation_request', keyword, original_event_listener)
+        end
       end
       
       def remove_event_listener_proxies
@@ -492,10 +515,29 @@ module Glimmer
         event_listener_proxies.clear
       end
       
+      def notify_listeners(event)
+        listeners_for(event).each do |listener|
+          listener.original_event_listener.call(EventProxy.new(listener: listener))
+        end
+      end
+      
+      def notify_on_render_listeners
+        notify_listeners('on_render')
+        children.each(&:notify_on_render_listeners) if bulk_render?
+      end
+      
       def data_bindings
         @data_bindings ||= {}
       end
       
+      def type
+        if rendered?
+          super
+        else
+          options[:type] || 'text'
+        end
+      end
+      
       def data_bind(property, model_binding)
         element_binding_translator = value_converters_for_input_type(type)[:model_to_view]
         element_binding_parameters = [self, property, element_binding_translator]
@@ -521,10 +563,20 @@ module Glimmer
       # Data-binds the generation of nested content to a model/property (in binding args)
       # consider providing an option to avoid initial rendering without any changes happening
       def bind_content(*binding_args, &content_block)
-        # TODO in the future, consider optimizing code by diffing content if that makes sense
         content_binding_work = proc do |*values|
+          # TODO in the future, consider optimizing code by diffing content if that makes sense (e.g. using opal-virtual-dom)
+          # To do so, we must avoid generating new content with new unique IDs/Classes and only append the new IDs classes after mounting
+          # TODO consider optimizing remove performance by doing clear instead and removing listeners separately
           children.dup.each { |child| child.remove }
-          content(&content_block)
+          content(bulk_render: true, &content_block)
+          if bulk_render? && rendered?
+            self.inner_html = children_dom_content
+            children.each(&:mark_rendered)
+            children.each(&:invoke_post_render_method_calls)
+            children.each(&:handle_observation_requests)
+            children.each(&:add_contents_for_render_blocks)
+            children.each(&:notify_on_render_listeners)
+          end
         end
         model_binding_observer = Glimmer::DataBinding::ModelBinding.new(*binding_args)
         content_binding_observer = Glimmer::DataBinding::Observer.proc(&content_binding_work)
@@ -552,35 +604,86 @@ module Glimmer
         if method_name.to_s.start_with?('on_')
           handle_observation_request(method_name, block)
         elsif dom_element.respond_to?(method_name)
-          dom_element.send(method_name, *args, &block)
+          if rendered?
+            dom_element.send(method_name, *args, &block)
+          else
+            enqueue_post_render_method_call(method_name, *args, &block)
+          end
         elsif !dom_element.prop(property_name).nil? && !dom_element.prop(property_name).is_a?(Proc)
-          if method_name.end_with?('=')
-            dom_element.prop(property_name, *args)
+          if rendered?
+            if method_name.end_with?('=')
+              dom_element.prop(property_name, *args)
+            else
+              dom_element.prop(property_name)
+            end
           else
-            dom_element.prop(property_name)
+            enqueue_post_render_method_call(method_name, *args, &block)
           end
         elsif !dom_element.prop(unnormalized_property_name).nil? && !dom_element.prop(unnormalized_property_name).is_a?(Proc)
-          if method_name.end_with?('=')
-            dom_element.prop(unnormalized_property_name, *args)
+          if rendered?
+            if method_name.end_with?('=')
+              dom_element.prop(unnormalized_property_name, *args)
+            else
+              dom_element.prop(unnormalized_property_name)
+            end
           else
-            dom_element.prop(unnormalized_property_name)
+            enqueue_post_render_method_call(method_name, *args, &block)
           end
         elsif dom_element && dom_element.length > 0
-          js_args = block.nil? ? args : (args + [block])
-          begin
-            Native.call(dom_element, '0').method_missing(method_name.to_s.camelcase, *js_args)
-          rescue Exception => e
+          if rendered?
+            js_args = block.nil? ? args : (args + [block])
             begin
-              Native.call(dom_element, '0').method_missing(method_name.to_s, *js_args)
+              Native.call(dom_element, '0').method_missing(method_name.to_s.camelcase, *js_args)
             rescue Exception => e
-              super(method_name, *args, &block)
+              begin
+                Native.call(dom_element, '0').method_missing(method_name.to_s, *js_args)
+              rescue Exception => e
+                super(method_name, *args, &block)
+              end
             end
+          else
+            enqueue_post_render_method_call(method_name, *args, &block)
           end
         else
           super(method_name, *args, &block)
         end
       end
       
+      def post_render_method_calls
+        @post_render_method_calls ||= []
+      end
+      
+      def enqueue_post_render_method_call(method_name, *args, &block)
+        post_render_method_calls << [method_name, args, block]
+        nil
+      end
+      
+      def invoke_post_render_method_calls
+        return unless rendered?
+        post_render_method_calls.each do |method_name, args, block|
+          send(method_name, *args, &block)
+        end
+        children.each(&:invoke_post_render_method_calls) if bulk_render?
+      end
+      
+      def handle_observation_requests
+        observation_requests&.each do |keyword, event_listener_set|
+          event_listener_set.each do |event_listener|
+            handle_observation_request(keyword, event_listener)
+          end
+        end
+        children.each(&:handle_observation_requests) if bulk_render?
+      end
+      
+      def add_contents_for_render_blocks
+        unless skip_content_on_render_blocks?
+          content_on_render_blocks.each do |content_block|
+            content(&content_block)
+          end
+        end
+        children.each(&:add_contents_for_render_blocks) if bulk_render?
+      end
+      
       def property_name_for(method_name)
         attribute_name = method_name.end_with?('=') ? method_name.to_s[0...-1] : method_name.to_s
         PROPERTY_ALIASES[attribute_name] || attribute_name.camelcase

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: glimmer-dsl-web
 version: !ruby/object:Gem::Version
-  version: 0.2.8
+  version: 0.3.0
 platform: ruby
 authors:
 - Andy Maleh
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-06-21 00:00:00.000000000 Z
+date: 2024-06-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: glimmer