heartml 1.0.0.beta3 → 1.0.0.beta5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: af1df02bbfde39341b4b9a7df922718be4461b749195d341dece40c6f96a82f5
-  data.tar.gz: c379e7456d7c04d187465a36b8b526a5b1c9668576c1f7e9970f43c6a7f3729a
+  metadata.gz: 053e789d42574715a2f4269205a6dfe549a3d4af6970a6f6446b51735a9be340
+  data.tar.gz: cfe795359ca2e951218853f336057d4751bac7e04564bc857808573c3f2e045a
 SHA512:
-  metadata.gz: 9e7e19aabcec51daeaa138e9601ce5298d41c36326654b3f2362aa6976c74e26bf6376b9e8d0a3cb27db98ea611db07cb3ae80690a2a4f246c97f45d28869113
-  data.tar.gz: af65f1e24ba4eac17f6bf91e521edc141e2d2b856a1702d44203071dd6f06dbf857591481da95d9ca7f11e9b1154ede933a5275a7a1658efe0c71554ba8b5c53
+  metadata.gz: 36c6248a2b135f2d11b20b054d2a6bf8334460d56fe184a6c4d646e92561c2210e1e3a707975930613ed86091812708888b14d1fbd46f5efefe3befe3aeb3558
+  data.tar.gz: a4241d8e092361148f6ce228c0023007c7e97e650ab4c4336ea12b1f61287f1c1b034eff06f97f6718ae1c400fb82f252197de9205bdd7057058ad382cb56ce6

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 ## [Unreleased]
 
+## [1.0.0.beta5] - 2023-09-04
+
+- Fix issue with ViewComponent in Rails apps
+- Add fragment error handling
+
+## [1.0.0.beta4] - 2023-08-27
+
+- Refactor and improve Bridgetown plugin and simplify context handling for template rendering
+
 ## [1.0.0.beta3] - 2023-08-12
 
 - Ensure attributes are processed on component node before it's rendered as component

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    heartml (1.0.0.beta3)
+    heartml (1.0.0.beta5)
       concurrent-ruby (~> 1.2)
       nokolexbor (>= 0.4.2)
 

data/lib/heartml/bridgetown_renderer.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Heartml
+  class BridgetownRenderer < Bridgetown::Builder
+    def build
+      render_heart_modules
+    end
+
+    def render_heart_modules
+      inspect_html do |doc, resource|
+        view_context = Bridgetown::ERBView.new(resource)
+
+        rdr = Heartml::TemplateRenderer.new(body: doc.at_css("body"), context: view_context)
+        #        rdr.define_singleton_method(:view_context) { view_context }
+        rdr.call
+      end
+    end
+  end
+end
+
+Bridgetown.initializer :heartml do |config|
+  Bridgetown::Component.extend ActiveSupport::DescendantsTracker
+
+  Heartml.module_eval do
+    def render_in(view_context, rendering_mode: :string, &block)
+      self.rendering_mode = rendering_mode
+      super(view_context, &block)
+    end
+  end
+
+  # Eager load all components
+  config.hook :site, :after_reset do |site|
+    unless site.config.eager_load_paths.find { _1.end_with?(site.config.components_dir) }
+      site.config.eager_load_paths << site.config.autoload_paths.find { _1.end_with?(site.config.components_dir) }
+    end
+  end
+
+  config.html_inspector_parser "nokolexbor"
+  config.builder Heartml::BridgetownRenderer
+end

data/lib/heartml/fragment.rb

@@ -38,21 +38,25 @@ module Heartml
 
             params.each do |param|
               new_key, v2 = param.split(":").map(&:strip)
+              v2 ||= new_key
+
               new_attrs[new_key] = @component.evaluate_attribute_expression(attr, v2)
             end
             attrs.delete(k)
           end
           attrs.merge!(new_attrs)
           attrs.reject! { |k| k.start_with?("server-") || k.start_with?("iso-") || k.start_with?("host-") }
-          attrs.transform_keys!(&:to_sym)
+          attrs.transform_keys! { _1.tr("-", "_").to_sym }
 
           obj = component.new(**attrs)
           render_output = if obj.respond_to?(:render_in)
-                            obj.render_in(@component.view_context, rendering_mode: :node) do
+                            obj.render_in(@component.context, rendering_mode: :node) do
                               process(fragamatize(node.children))
                             end
                           else
-                            obj.render_element(content: process(fragamatize(node.children)))
+                            obj.render_element(
+                              content: process(fragamatize(node.children)), context: @component.context
+                            )
                           end
 
           node.replace(render_output)
@@ -78,7 +82,7 @@ module Heartml
           break unless attribute_binding.method.(attribute: attr_node, node: node)
         end
       rescue Exception => e # rubocop:disable Lint/RescueException
-        line_segments = [@component.class.heart_module, @component.class.line_number_of_node(attr_node)]
+        line_segments = [@component.class.heart_module, @component._line_number_of_node(attr_node)]
         raise e.class, e.message.lines.first, [line_segments.join(":"), *e.backtrace]
       end
     end

data/lib/heartml/version.rb

@@ -2,5 +2,5 @@
 
 module Heartml
   # @return [String]
-  VERSION = "1.0.0.beta3"
+  VERSION = "1.0.0.beta5"
 end

data/lib/heartml.rb

@@ -54,9 +54,13 @@ module Heartml
     klass.attribute_binding "server-unsafe-eval", :_server_replace_binding
 
     # Don't stomp on a superclass's `content` method
-    return if klass.instance_methods.include?(:content)
+    has_content_method = begin
+      klass.instance_method(:content)
+    rescue NameError
+      false
+    end
 
-    klass.include ContentMethod
+    klass.include ContentMethod unless has_content_method
   end
 
   # Extends the component class
@@ -124,10 +128,8 @@ module Heartml
       end
     end
 
-    def line_number_of_node(node)
-      loc = node.source_location
-      instance_variable_get(:@doc_html)[0..loc].count("\n") + 1
-    end
+    # @return [String]
+    def doc_html = @doc_html
 
     def attribute_bindings = @attribute_bindings ||= []
 
@@ -149,6 +151,14 @@ module Heartml
     @_replaced_content = new_content
   end
 
+  def context
+    return @context if @context
+
+    return unless respond_to?(:view_context)
+
+    view_context # compatibility with other Ruby component systems
+  end
+
   # Override in component
   #
   # @return [Hash]
@@ -165,9 +175,11 @@ module Heartml
 
   # @param attributes [Hash]
   # @param content [String, Nokolexbor::Element]
-  def render_element(attributes: self.attributes, content: self.content) # rubocop:disable Metrics
+  def render_element(attributes: self.attributes, content: self.content, context: self.context) # rubocop:disable Metrics
     doc = self.class.doc.clone
+    @doc_html ||= self.class.doc_html # keep a spare copy for determining error line number
     @_content = content
+    @context = context
 
     tmpl_el = doc.css("> template").find do |node|
       node.attributes.empty? ||
@@ -184,33 +196,6 @@ module Heartml
     # Process all the template bits
     process_fragment(tmpl_el)
 
-    # Heartml.registered_elements.each do |component|
-    #   tmpl_el.children[0].css(component.tag_name).reverse.each do |node|
-    #     if node["server-ignore"]
-    #       node.remove_attribute("server-ignore")
-    #       next
-    #     end
-
-    #     attrs = node.attributes.transform_values(&:value)
-    #     attrs.reject! { |k| k.start_with?("server-") }
-    #     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.heart_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.remove_attribute("server-ignore")
-    #   end
-    # end
-
     # Set attributes on the custom element
     attributes.each { |k, v| doc[k.to_s.tr("_", "-")] = value_to_attribute(v) if v }
 
@@ -323,7 +308,7 @@ module Heartml
     _context_locals.keys.reverse_each do |name|
       eval_code = "#{name} = _context_locals[\"#{name}\"];" + eval_code
     end
-    instance_eval(eval_code, self.class.heart_module, self.class.line_number_of_node(attribute))
+    instance_eval(eval_code, self.class.heart_module, _line_number_of_node(attribute))
   end
 
   def class_list_for(obj)
@@ -338,6 +323,11 @@ module Heartml
     end.join(" ")
   end
 
+  def _line_number_of_node(node)
+    loc = node.source_location
+    instance_variable_get(:@doc_html)[0..loc].count("\n") + 1
+  end
+
   def _context_nodes = @_context_nodes ||= []
 
   def _context_locals = @_context_locals ||= {}
@@ -381,26 +371,6 @@ module Heartml
     end
   end
 
-  # def _server_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 _server_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
-
   class ServerComponent
     def self.inherited(klass)
       super
@@ -409,19 +379,15 @@ module Heartml
     end
   end
 
-  class FragmentRenderComponent < ServerComponent
+  class TemplateRenderer < ServerComponent
     def self.heart_module
       "eval"
     end
 
-    def self.line_number_of_node(_node)
-      # FIXME: this should actually work!
-      0
-    end
-
-    def initialize(body:, scope:) # rubocop:disable Lint/MissingSuper
+    def initialize(body:, context:) # rubocop:disable Lint/MissingSuper
+      @doc_html = body.is_a?(String) ? body : body.to_html
       @body = body.is_a?(String) ? Nokolexbor::DocumentFragment.parse(body) : body
-      @scope = scope
+      @context = context
     end
 
     def call
@@ -430,36 +396,14 @@ module Heartml
     end
 
     def respond_to_missing?(key)
-      @scope.respond_to?(key)
+      context.respond_to?(key)
     end
 
     # TODO: delegate instead?
     def method_missing(key, *args, **kwargs)
-      @scope.send(key, *args, **kwargs)
+      context.send(key, *args, **kwargs)
     end
   end
 end
 
-if defined?(Bridgetown)
-  Bridgetown.initializer :heartml do |config|
-    Bridgetown::Component.extend ActiveSupport::DescendantsTracker
-
-    Heartml.module_eval do
-      def render_in(view_context, rendering_mode = :string, &block)
-        self.rendering_mode = rendering_mode
-        super(view_context, &block)
-      end
-    end
-
-    # Eager load all components
-    config.hook :site, :after_reset do |site|
-      unless site.config.eager_load_paths.find { _1.end_with?(site.config.components_dir) }
-        site.config.eager_load_paths << site.config.autoload_paths.find { _1.end_with?(site.config.components_dir) }
-      end
-    end
-
-    config.html_inspector_parser "nokolexbor"
-    require_relative "heartml/component_renderer"
-    config.builder Heartml::ComponentRenderer
-  end
-end
+require_relative "heartml/bridgetown_renderer" if defined?(Bridgetown)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: heartml
 version: !ruby/object:Gem::Version
-  version: 1.0.0.beta3
+  version: 1.0.0.beta5
 platform: ruby
 authors:
 - Jared White
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-08-13 00:00:00.000000000 Z
+date: 2023-09-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -70,7 +70,7 @@ files:
 - benchmark.rb
 - heartml.gemspec
 - lib/heartml.rb
-- lib/heartml/component_renderer.rb
+- lib/heartml/bridgetown_renderer.rb
 - lib/heartml/fragment.rb
 - lib/heartml/petite.rb
 - lib/heartml/query_selection.rb

data/lib/heartml/component_renderer.rb

@@ -1,52 +0,0 @@
-# frozen_string_literal: true
-
-module Heartml
-  class ComponentRenderer < Bridgetown::Builder
-    def build
-      render_heart_modules
-    end
-
-    # TODO: rework this using new server effects and component context!
-    def render_heart_modules
-      inspect_html do |doc, resource|
-        view_context = Bridgetown::ERBView.new(resource)
-
-        rdr = FragmentRenderComponent.new(body: doc.at_css("body"), scope: view_context)
-        rdr.define_singleton_method(:view_context) { view_context }
-        rdr.call
-
-        # Heartml.registered_elements.each do |component|
-        #   tag_name = component.tag_name
-        #   doc.xpath("//#{tag_name}").reverse.each do |node|
-        #     if node["server-ignore"]
-        #       node.remove_attribute("server-ignore")
-        #       next
-        #     end
-
-        #     attrs = node.attributes.transform_values(&:value)
-        #     attrs.reject! { |k| k.start_with?("server-") }
-
-        #     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] = resource.instance_eval(v)
-        #     end
-        #     attrs.merge!(new_attrs)
-        #     attrs.transform_keys!(&:to_sym)
-
-        #     new_node = node.replace(
-        #       component.new(**attrs).render_in(view_context, rendering_mode: :node) { node.children }
-        #     )
-        #     new_node.remove_attribute("server-ignore")
-        #   end
-        # rescue StandardError => e
-        #   Bridgetown.logger.error "Unable to render <#{tag_name}> (#{component}) in #{resource.path}"
-        #   raise e
-        # end
-      end
-    end
-  end
-end