hot_module 1.0.0.alpha9 → 1.0.0.alpha11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8ee386965712348631ddb7f2727e757c6a3665de96bad4ce22e5d92cc41bff07
-  data.tar.gz: 4ae0fce88ec73e62512105db857cd6406778dbf75d850bfce3bdb1ef02a7321b
+  metadata.gz: d90f5f3aee3f096c2b0dc962592cef3ff02563a5a8b5bef47cab9adc9eabf309
+  data.tar.gz: cdda20661fa3aab05d14f793a4b6ef3cf6d9c0bfc116a28a49a1118ab1286d2c
 SHA512:
-  metadata.gz: 829ba7ad837dd654893f48c381930ec50144094d0c4c2efd06efbd9925175d35e784a9a6097aedbf756cd018cfe11737be6f59d9eb994e4ff1ccba7d3fd04096
-  data.tar.gz: 5435dc0c0e835c12ce9458787a8681d1a86d259af1fd086edc8e8844f082ce6e75e820914befb5bb2ac88848a57d61219dacef3813d629b8bc554090c05199aa
+  metadata.gz: ff109253d98e063cfcf6a79481a3cde7934afca492dcca0edd865266cc1401918ba858f04f1cd7ae125d424332f9cdbfd1e562fe4e9914c55313a08070aa61cc
+  data.tar.gz: bb1864cc03b42c1612bd53aa29ef7278d38ad46b8d3362ab31b6093aa8abe907a7a2d1587b04338b2e2b74b868136235181a6871ef27eecb2690e59765d9e3c7

data/CHANGELOG.md

@@ -1,8 +1,12 @@
 ## [Unreleased]
 
+## [1.0.0.alpha10] - 2023-04-04
+
+- Update debugging features based on Nokolexbor fixes
+
 ## [1.0.0.alpha9] - 2023-04-02
 
-- Add support for [@crystallized/shadow-effects](https://github.com/whitefusionhq/crystallized/tree/main/packages/shadow-effects) template syntax
+- Add support for [@crystallized/shadow-effects](https://github.com/hotmodule/crystallized/tree/main/packages/shadow-effects) template syntax
 - Let `camelcased` handle symbol arrays, so it works with `attr_reader`
 
 ## [1.0.0.alpha8] - 2023-03-23

data/Gemfile.lock

@@ -1,8 +1,9 @@
 PATH
   remote: .
   specs:
-    hot_module (1.0.0.alpha9)
-      nokolexbor (~> 0.4)
+    hot_module (1.0.0.alpha11)
+      concurrent-ruby (~> 1.2)
+      nokolexbor (>= 0.4.2)
 
 GEM
   remote: https://rubygems.org/
@@ -33,9 +34,9 @@ GEM
       racc (~> 1.4)
     nokogiri (1.14.2-x86_64-linux)
       racc (~> 1.4)
-    nokolexbor (0.4.0-arm64-darwin)
+    nokolexbor (0.4.2-arm64-darwin)
     parallel (1.22.1)
-    parser (3.2.1.1)
+    parser (3.2.2.0)
       ast (~> 2.4.1)
     racc (1.6.2)
     rainbow (3.1.1)
@@ -44,17 +45,17 @@ GEM
     reverse_markdown (2.1.1)
       nokogiri
     rexml (3.2.5)
-    rubocop (1.48.1)
+    rubocop (1.49.0)
       json (~> 2.3)
       parallel (~> 1.10)
       parser (>= 3.2.0.0)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.26.0, < 2.0)
+      rubocop-ast (>= 1.28.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 2.4.0, < 3.0)
-    rubocop-ast (1.27.0)
+    rubocop-ast (1.28.0)
       parser (>= 3.2.1.0)
     rubocop-minitest (0.22.2)
       rubocop (>= 0.90, < 2.0)

data/README.md

@@ -2,7 +2,7 @@
 
 Parse, mutate, and render custom elements in Ruby using [HTML Modules](https://github.com/WICG/webcomponents/blob/gh-pages/proposals/html-modules-explainer.md).
 
-Great for pairing with [esbuild-plugin-html-modules](https://github.com/whitefusionhq/esbuild-plugin-html-modules) for a full-stack component rendering pipeline.
+Great for pairing with [esbuild-plugin-html-modules](https://github.com/hotmodule/esbuild-plugin-html-modules) for a full-stack component rendering pipeline.
 
 ## Installation
 
@@ -26,7 +26,7 @@ To install this gem onto your local machine, run `bin/rake install`. To release
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/whitefusionhq/hot_module. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/whitefusionhq/hot_module/blob/main/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at https://github.com/hotmodule/hot_module. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/hotmodule/hot_module/blob/main/CODE_OF_CONDUCT.md).
 
 ## License
 
@@ -34,4 +34,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the HoTModuLe project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/whitefusionhq/hot_module/blob/main/CODE_OF_CONDUCT.md).
+Everyone interacting in the HoTModuLe project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/hotmodule/hot_module/blob/main/CODE_OF_CONDUCT.md).

data/hot_module.gemspec

@@ -9,13 +9,13 @@ Gem::Specification.new do |spec|
   spec.email = ["jared@whitefusion.studio"]
 
   spec.summary = "Parse, mutate, and render HTML Modules in Ruby."
-  spec.homepage = "https://github.com/whitefusionhq/hot_module#readme"
+  spec.homepage = "https://github.com/hotmodule/hot_module#readme"
   spec.license = "MIT"
   spec.required_ruby_version = ">= 3.0"
 
   spec.metadata["homepage_uri"] = spec.homepage
-  spec.metadata["source_code_uri"] = "https://github.com/whitefusionhq/hot_module"
-  spec.metadata["changelog_uri"] = "https://github.com/whitefusionhq/hot_module/blob/main/CHANGELOG.md"
+  spec.metadata["source_code_uri"] = "https://github.com/hotmodule/hot_module"
+  spec.metadata["changelog_uri"] = "https://github.com/hotmodule/hot_module/blob/main/CHANGELOG.md"
   spec.metadata["rubygems_mfa_required"] = "true"
 
   # Specify which files should be added to the gem when it is released.
@@ -27,7 +27,8 @@ Gem::Specification.new do |spec|
   end
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "nokolexbor", "~> 0.4"
+  spec.add_dependency "concurrent-ruby", "~> 1.2"
+  spec.add_dependency "nokolexbor", ">= 0.4.2"
 
   spec.add_development_dependency "hash_with_dot_access", "~> 1.2"
 end

data/lib/hot_module/component_renderer.rb

@@ -7,21 +7,16 @@ module HoTModuLe
 
   class ComponentRenderer < Bridgetown::Builder
     def build
-      registered_tags = {}
-      Bridgetown::Component.subclasses.each do |component|
-        next unless component.respond_to?(:tag_name)
-
-        registered_tags[component.tag_name] = component
-      end
-
-      render_html_modules(registered_tags)
+      render_html_modules
     end
 
-    def render_html_modules(registered_tags) # rubocop:todo Metrics
-      inspect_html do |doc, resource| # rubocop:todo Metrics
+    # rubocop:todo Metrics
+    def render_html_modules
+      inspect_html do |doc, resource|
         view_context = HoTModuLe::View.new(resource)
 
-        registered_tags.each do |tag_name, component|
+        HoTModuLe.registered_elements.each do |component|
+          tag_name = component.tag_name
           doc.xpath("//#{tag_name}").reverse.each do |node|
             if node["hmod:ignore"]
               node.attribute("hmod:ignore").remove
@@ -33,9 +28,9 @@ module HoTModuLe
 
             new_attrs = {}
             attrs.each do |k, v|
-              next unless k.start_with?("ruby:")
+              next unless k.start_with?("arg:")
 
-              new_key = k.delete_prefix("ruby:")
+              new_key = k.delete_prefix("arg:")
               attrs.delete(k)
               new_attrs[new_key] = resource.instance_eval(v)
             end
@@ -54,5 +49,6 @@ module HoTModuLe
         end
       end
     end
+    # rubocop:enable Metrics
   end
 end

data/lib/hot_module/fragment.rb

@@ -2,15 +2,17 @@
 
 module HoTModuLe
   class Fragment
-    def initialize(fragment, attribute_bindings, html_module:)
+    def initialize(fragment, component)
       @fragment = fragment
-      @attribute_bindings = attribute_bindings
-      @html_module = html_module
+      @component = component
+      @attribute_bindings = component.class.attribute_bindings.each do |attr_def|
+        attr_def.method = component.method(attr_def.method_name)
+      end
     end
 
-    # NOTE: for some reason, the Nokogiri traverse method yields node children first, then the
-    # parent node. That doesn't work for our case. We want to go strictly in source order. So this
-    # is our own implementation of that.
+    # NOTE: for some reason, the traverse method yields node children first, then the
+    # parent node. That doesn't work for our case. We want to go strictly in source order.
+    # So this is our own implementation of that.
     def traverse(node, &block)
       yield(node)
       node.children.each { |child| traverse(child, &block) }
@@ -32,7 +34,8 @@ module HoTModuLe
           break unless attribute_binding.method.(attribute: attr_node, node: node)
         end
       rescue Exception => e # rubocop:disable Lint/RescueException
-        raise e.class, e.message.lines.first, ["#{@html_module}:#{attr_node}", *e.backtrace]
+        line_segments = [@component.class.html_module, @component.class.line_number_of_node(attr_node)]
+        raise e.class, e.message.lines.first, [line_segments.join(":"), *e.backtrace]
       end
     end
   end

data/lib/hot_module/petite.rb

@@ -23,7 +23,7 @@ module HoTModuLe
       process_list(
         attribute: attribute,
         node: node,
-        item_node: node.children[0].element_children.first,
+        item_node: node.children[0].first_element_child,
         for_in: expression
       )
     end

data/lib/hot_module/query_selection.rb

@@ -1,14 +1,14 @@
 # frozen_string_literal: true
 
 module HoTModuLe
-  # Add a couple familar DOM API features to Nokogiri
+  # Add a couple familar DOM API features to Nokolexbor
   module QuerySelection
     # @param selector [String]
-    # @return [Nokogiri::XML::Element]
+    # @return [Nokolexbor::Element]
     def query_selector(selector) = at_css(selector)
 
     # @param selector [String]
-    # @return [Nokogiri::XML::Element]
+    # @return [Nokolexbor::Element]
     def query_selector_all(selector) = css(selector)
   end
 

data/lib/hot_module/version.rb

@@ -2,5 +2,5 @@
 
 module HoTModuLe
   # @return [String]
-  VERSION = "1.0.0.alpha9"
+  VERSION = "1.0.0.alpha11"
 end

data/lib/hot_module.rb

@@ -3,6 +3,7 @@
 require_relative "hot_module/version"
 
 require "nokolexbor"
+require "concurrent"
 
 # Include this module into your own component class
 module HoTModuLe
@@ -23,10 +24,30 @@ module HoTModuLe
   require_relative "hot_module/fragment"
   require_relative "hot_module/query_selection"
 
+  def self.registered_elements
+    @registered_elements ||= Concurrent::Set.new
+
+    @registered_elements.each do |component|
+      begin
+        next if Kernel.const_get(component.to_s) == component # thin out unloaded consts
+      rescue NameError; end # rubocop:disable Lint/SuppressedException
+
+      @registered_elements.delete component
+    end
+
+    @registered_elements
+  end
+
   # @param klass [Class]
   # @return [void]
   def self.included(klass)
     klass.extend ClassMethods
+
+    klass.attribute_binding "hmod:children", :_hmod_children_binding, only: :template
+    klass.attribute_binding "hmod:replace", :_hmod_replace_binding
+    klass.attribute_binding "hmod:text", :_hmod_expr_binding
+    klass.attribute_binding "hmod:html", :_hmod_expr_binding
+
     # Don't stomp on a superclass's `content` method
     return if klass.instance_methods.include?(:content)
 
@@ -41,7 +62,8 @@ module HoTModuLe
       end
     end
 
-    def html_file_extensions = %w[module.html tmpl.html html].freeze
+    def html_file_extensions = %w[module.html mod.html html].freeze
+
     def processed_css_extension = "css-local"
 
     # @param tag_name [String]
@@ -54,53 +76,56 @@ module HoTModuLe
         raise HoTModuLe::Error, "You must either supply a file path argument or respond to `source_location'"
       end
 
-      @tag_name = tag_name
+      self.tag_name tag_name
 
       if html_module
-        @html_module = html_module
+        self.html_module html_module
       else
         basepath = File.join(File.dirname(source_location), File.basename(source_location, ".*"))
 
-        @html_module = html_file_extensions.lazy.filter_map do |ext|
+        self.html_module(html_file_extensions.lazy.filter_map do |ext|
           path = "#{basepath}.#{ext}"
           File.exist?(path) ? path : nil
-        end.first
+        end.first)
 
         raise HoTModuLe::Error, "Cannot find sidecar HTML module for `#{self}'" unless @html_module
       end
 
-      @shadow_root = shadow_root
+      self.shadow_root shadow_root
     end
 
     # @param value [String]
     # @return [String]
     def tag_name(value = nil)
-      @tag_name ||= value
+      @tag_name ||= begin
+        HoTModuLe.registered_elements << self
+        value
+      end
     end
 
     # @param value [String]
     # @return [String]
-    def html_module(value = nil)
-      @html_module ||= value
-    end
+    def html_module(value = nil) = @html_module ||= value
 
     # @param value [Boolean]
     # @return [Boolean]
-    def shadow_root(value = nil)
-      @shadow_root ||= value
-    end
+    def shadow_root(value = nil) = @shadow_root ||= value
 
-    # @return [Nokogiri::XML::Element]
+    # @return [Nokolexbor::Element]
     def doc
-      @doc ||= Nokolexbor::DocumentFragment.parse(
-        "<#{tag_name}>#{File.read(html_module).strip}</#{tag_name}>"
-      ).element_children.first
+      @doc ||= begin
+        @doc_html = "<#{tag_name}>#{File.read(html_module).strip}</#{tag_name}>"
+        Nokolexbor::DocumentFragment.parse(@doc_html).first_element_child
+      end
     end
 
-    def attribute_bindings
-      @attribute_bindings ||= []
+    def line_number_of_node(node)
+      loc = node.source_location
+      instance_variable_get(:@doc_html)[0..loc].count("\n") + 1
     end
 
+    def attribute_bindings = @attribute_bindings ||= []
+
     def attribute_binding(matcher, method_name, only: nil)
       attribute_bindings << AttributeBinding.new(
         matcher: Regexp.new(matcher),
@@ -111,22 +136,21 @@ module HoTModuLe
   end
 
   module ContentMethod
-    # @return [String, Nokogiri::XML::Element]
-    def content; end
+    # @return [String, Nokolexbor::Element]
+    def content = @_content
   end
 
   # Override in component
   #
   # @return [Hash]
-  def attributes
-    {}
-  end
+  def attributes = {}
 
   # @param attributes [Hash]
-  # @param content [String, Nokogiri::XML::Element]
+  # @param content [String, Nokolexbor::Element]
   # @param return_node [Boolean]
   def render_element(attributes: self.attributes, content: self.content, return_node: false) # rubocop:disable Metrics
     doc = self.class.doc.clone
+    @_content = content
 
     tmpl_el = doc.css("> template").find { _1.attributes.empty? }
 
@@ -140,6 +164,33 @@ module HoTModuLe
     # Process all the template bits
     process_fragment(tmpl_el)
 
+    HoTModuLe.registered_elements.each do |component|
+      tmpl_el.children[0].css(component.tag_name).reverse.each do |node|
+        if node["hmod:ignore"]
+          node.attribute("hmod:ignore").remove
+          next
+        end
+
+        attrs = node.attributes.transform_values(&:value)
+        attrs.reject! { |k| k.start_with?("hmod:") }
+        new_attrs = {}
+        attrs.each do |k, v|
+          next unless k.start_with?("arg:")
+
+          new_key = k.delete_prefix("arg:")
+          attrs.delete(k)
+          new_attrs[new_key] = instance_eval(v, self.class.html_module, self.class.line_number_of_node(node))
+        end
+        attrs.merge!(new_attrs)
+        attrs.transform_keys!(&:to_sym)
+
+        new_node = node.replace(
+          component.new(**attrs).render_element(content: node.children)
+        )
+        new_node.first.attribute("hmod:ignore")&.remove
+      end
+    end
+
     # Set attributes on the custom element
     attributes.each { |k, v| doc[k.to_s.tr("_", "-")] = value_to_attribute(v) if v }
 
@@ -176,14 +227,15 @@ module HoTModuLe
       style_tag.content = output_styles
     end
 
+    child_content = @_replaced_children || content
     if self.class.shadow_root
       # Guess what? We can reuse the same template tag! =)
       tmpl_el["shadowrootmode"] = "open"
       tmpl_el.children[0] << style_tag if style_tag
-      doc << content if content
+      doc << child_content if child_content
     else
       tmpl_el.children[0] << style_tag if style_tag
-      tmpl_el.children[0].at_css("slot:not([name])")&.swap(content) if content
+      tmpl_el.children[0].at_css("slot:not([name])")&.swap(child_content) if child_content
       tmpl_el.children[0].children.each do |node|
         doc << node
       end
@@ -194,13 +246,9 @@ module HoTModuLe
     return_node ? doc : doc.to_html
   end
 
-  def call(...)
-    render_element(...)
-  end
+  def call(...) = render_element(...)
 
-  def inspect
-    "#<#{self.class.name} #{attributes}>"
-  end
+  def inspect = "#<#{self.class.name} #{attributes}>"
 
   def value_to_attribute(val)
     case val
@@ -213,16 +261,15 @@ module HoTModuLe
     end
   end
 
+  def node_or_string(val)
+    val.is_a?(Nokolexbor::Node) ? val : val.to_s
+  end
+
   # Override in component if need be, otherwise we'll use the node walker/binding pipeline
   #
-  # @param fragment [Nokogiri::XML::Element]
+  # @param fragment [Nokolexbor::Element]
   # @return [void]
-  def process_fragment(fragment)
-    Fragment.new(
-      fragment, self.class.attribute_bindings.each { _1.method = method(_1.method_name) },
-      html_module: self.class.html_module
-    ).process
-  end
+  def process_fragment(fragment) = Fragment.new(fragment, self).process
 
   def process_list(attribute:, node:, item_node:, for_in:) # rubocop:disable Metrics
     _context_nodes.push(node)
@@ -247,10 +294,7 @@ module HoTModuLe
         _context_locals[lh[0]] = list_item
         _context_locals[lh[1]] = index if lh[1]
 
-        Fragment.new(
-          new_node, self.class.attribute_bindings,
-          html_module: self.class.html_module
-        ).process
+        Fragment.new(new_node, self).process
       end
     end
   end
@@ -260,7 +304,7 @@ module HoTModuLe
     _context_locals.keys.reverse_each do |name|
       eval_code = "#{name} = _context_locals[\"#{name}\"];" + eval_code
     end
-    instance_eval(eval_code, self.class.html_module) # , attribute.line)
+    instance_eval(eval_code, self.class.html_module, self.class.line_number_of_node(attribute))
   end
 
   def class_list_for(obj)
@@ -275,13 +319,9 @@ module HoTModuLe
     end.join(" ")
   end
 
-  def _context_nodes
-    @_context_nodes ||= []
-  end
+  def _context_nodes = @_context_nodes ||= []
 
-  def _context_locals
-    @_context_locals ||= {}
-  end
+  def _context_locals = @_context_locals ||= {}
 
   def _check_stack(node)
     node_and_ancestors = [node, *node.ancestors.to_a]
@@ -303,6 +343,31 @@ module HoTModuLe
     yield previous_context
     @_context_locals = previous_context
   end
+
+  def _hmod_children_binding(attribute:, node:) # rubocop:disable Lint/UnusedMethodArgument
+    @_replaced_children = node.children[0]
+    node.remove
+  end
+
+  def _hmod_replace_binding(attribute:, node:)
+    if node.name == "template"
+      node.children[0].inner_html = node_or_string(evaluate_attribute_expression(attribute))
+      node.replace(node.children[0].children)
+    else
+      node.inner_html = node_or_string(evaluate_attribute_expression(attribute))
+      node.replace(node.children)
+    end
+  end
+
+  def _hmod_expr_binding(attribute:, node:)
+    if attribute.name.end_with?(":text")
+      node.content = node_or_string(evaluate_attribute_expression(attribute))
+      attribute.parent.delete(attribute.name)
+    elsif attribute.name.end_with?(":html")
+      node.inner_html = node_or_string(evaluate_attribute_expression(attribute))
+      attribute.parent.delete(attribute.name)
+    end
+  end
 end
 
 if defined?(Bridgetown)

metadata

@@ -1,29 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: hot_module
 version: !ruby/object:Gem::Version
-  version: 1.0.0.alpha9
+  version: 1.0.0.alpha11
 platform: ruby
 authors:
 - Jared White
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-04-02 00:00:00.000000000 Z
+date: 2023-04-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: nokolexbor
+  name: concurrent-ruby
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.4'
+        version: '1.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.4'
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: nokolexbor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.4.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.4.2
 - !ruby/object:Gem::Dependency
   name: hash_with_dot_access
   requirement: !ruby/object:Gem::Requirement
@@ -62,13 +76,13 @@ files:
 - lib/hot_module/query_selection.rb
 - lib/hot_module/shadow_effects.rb
 - lib/hot_module/version.rb
-homepage: https://github.com/whitefusionhq/hot_module#readme
+homepage: https://github.com/hotmodule/hot_module#readme
 licenses:
 - MIT
 metadata:
-  homepage_uri: https://github.com/whitefusionhq/hot_module#readme
-  source_code_uri: https://github.com/whitefusionhq/hot_module
-  changelog_uri: https://github.com/whitefusionhq/hot_module/blob/main/CHANGELOG.md
+  homepage_uri: https://github.com/hotmodule/hot_module#readme
+  source_code_uri: https://github.com/hotmodule/hot_module
+  changelog_uri: https://github.com/hotmodule/hot_module/blob/main/CHANGELOG.md
   rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []