heartml 1.0.0.beta6 → 1.0.0.beta8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c09bc70bc5761750cc99010a62b106ff435e0f0ee9f72a259d62631c8913785c
-  data.tar.gz: 44bb47fca2eb847d2e6636ae99eb8446d32b488702a6c8e5dc57d39d571bf076
+  metadata.gz: 9af36d404ea8e79e505dd4ae52f7154d697bccf0722bec8b35a34172a7620d2f
+  data.tar.gz: 7870f15ce64e811f91ccb07c5b20fe5a010af2d2c4eac355b2583ac8e859730c
 SHA512:
-  metadata.gz: 3590d652c24107deb627e3f9aa0114411c3077118b38ad54fdf986019ad5b7a4262682ff407b575796085f4a54c2331a7c82a6a95b6941484242ddc838aa17f8
-  data.tar.gz: 4b302508a049f09c1009d126a41f73220e63a3ffe9647f9acb689de3df5e3df0977a05fce48b62683c0e139dcc0ef2136d27ecafe3ca77bcc4cf87a3565b1c2f
+  metadata.gz: df9a6f3028cccad882c443af444734f969a3be9fce3aad110114c5728692db08a7678645aecac64858ab0454041c7142387b86fe02813a264dafcd77828579e3
+  data.tar.gz: 152c74f825813fe9183fe37f6cb491670804b3ecc53ec5277a0f4a5161ddbb199d4f332333be417d19e59ca99b8d69353dad9270f4370c9814a6c54720fe879c

data/.rubocop.yml

@@ -3,7 +3,7 @@ require:
  - rubocop-rake
 
 AllCops:
-  TargetRubyVersion: 3.0
+  TargetRubyVersion: 3.1
   NewCops: enable
 
 Metrics/MethodLength:

data/CHANGELOG.md

@@ -1,5 +1,16 @@
+# Changelog
+
 ## [Unreleased]
 
+## [1.0.0.beta8] - 2023-09-25
+
+- Simplify modules structure, add tag swap feature, other refactors
+- Bump min Ruby version to 3.1
+
+## [1.0.0.beta7] - 2023-09-25
+
+- Add Railtie for Heartml component support in Rails
+
 ## [1.0.0.beta6] - 2023-09-06
 
 - Improvements to directives syntax (use lambda argument instead of block)

data/Gemfile

@@ -14,4 +14,5 @@ gem "rubocop", "~> 1.21"
 gem "rubocop-minitest", "~> 0.22.1"
 gem "rubocop-rake", "~> 0.6.0"
 
+gem "hash_with_dot_access", "~> 1.2"
 gem "solargraph", "~> 0.47.2", group: :development

data/Gemfile.lock

@@ -1,73 +1,86 @@
 PATH
   remote: .
   specs:
-    heartml (1.0.0.beta6)
+    heartml (1.0.0.beta8)
       concurrent-ruby (~> 1.2)
       nokolexbor (>= 0.4.2)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (7.0.4.3)
+    activesupport (7.1.3)
+      base64
+      bigdecimal
       concurrent-ruby (~> 1.0, >= 1.0.2)
+      connection_pool (>= 2.2.5)
+      drb
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
+      mutex_m
       tzinfo (~> 2.0)
     ast (2.4.2)
     backport (1.2.0)
-    benchmark (0.2.1)
-    concurrent-ruby (1.2.2)
-    diff-lcs (1.5.0)
+    base64 (0.2.0)
+    benchmark (0.3.0)
+    bigdecimal (3.1.6)
+    concurrent-ruby (1.2.3)
+    connection_pool (2.4.1)
+    diff-lcs (1.5.1)
+    drb (2.2.0)
+      ruby2_keywords
     e2mmap (0.1.0)
     hash_with_dot_access (1.2.0)
       activesupport (>= 5.0.0, < 8.0)
-    i18n (1.12.0)
+    i18n (1.14.1)
       concurrent-ruby (~> 1.0)
-    jaro_winkler (1.5.4)
-    json (2.6.3)
+    jaro_winkler (1.5.6)
+    json (2.7.1)
     kramdown (2.4.0)
       rexml
     kramdown-parser-gfm (1.1.0)
       kramdown (~> 2.0)
-    mini_portile2 (2.8.4)
-    minitest (5.18.0)
-    nokogiri (1.14.2)
-      mini_portile2 (~> 2.8.0)
+    language_server-protocol (3.17.0.3)
+    mini_portile2 (2.8.5)
+    minitest (5.22.2)
+    mutex_m (0.2.0)
+    nokogiri (1.16.2)
+      mini_portile2 (~> 2.8.2)
       racc (~> 1.4)
-    nokogiri (1.14.2-arm64-darwin)
+    nokogiri (1.16.2-arm64-darwin)
       racc (~> 1.4)
-    nokogiri (1.14.2-x86_64-linux)
+    nokogiri (1.16.2-x86_64-linux)
       racc (~> 1.4)
-    nokolexbor (0.5.0)
-    nokolexbor (0.5.0-arm64-darwin)
-    nokolexbor (0.5.0-x86_64-linux)
-    parallel (1.22.1)
-    parser (3.2.2.0)
+    nokolexbor (0.5.2)
+    parallel (1.24.0)
+    parser (3.3.0.5)
       ast (~> 2.4.1)
-    racc (1.6.2)
+      racc
+    racc (1.7.3)
     rainbow (3.1.1)
-    rake (13.0.6)
-    regexp_parser (2.7.0)
+    rake (13.1.0)
+    regexp_parser (2.9.0)
     reverse_markdown (2.1.1)
       nokogiri
-    rexml (3.2.5)
-    rubocop (1.49.0)
+    rexml (3.2.6)
+    rubocop (1.60.2)
       json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
       parallel (~> 1.10)
-      parser (>= 3.2.0.0)
+      parser (>= 3.3.0.2)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.28.0, < 2.0)
+      rubocop-ast (>= 1.30.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 2.4.0, < 3.0)
-    rubocop-ast (1.28.0)
+    rubocop-ast (1.30.0)
       parser (>= 3.2.1.0)
     rubocop-minitest (0.22.2)
       rubocop (>= 0.90, < 2.0)
     rubocop-rake (0.6.0)
       rubocop (~> 1.0)
     ruby-progressbar (1.13.0)
+    ruby2_keywords (0.0.5)
     solargraph (0.47.2)
       backport (~> 1.2)
       benchmark
@@ -83,14 +96,12 @@ GEM
       thor (~> 1.0)
       tilt (~> 2.0)
       yard (~> 0.9, >= 0.9.24)
-    thor (1.2.1)
-    tilt (2.1.0)
+    thor (1.3.0)
+    tilt (2.3.0)
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
-    unicode-display_width (2.4.2)
-    webrick (1.7.0)
-    yard (0.9.28)
-      webrick (~> 1.7.0)
+    unicode-display_width (2.5.0)
+    yard (0.9.34)
 
 PLATFORMS
   arm64-darwin-21

data/heartml.gemspec

@@ -11,7 +11,7 @@ Gem::Specification.new do |spec|
   spec.summary = "Server-rendered web components"
   spec.homepage = "https://github.com/heartml/heartml-ruby#readme"
   spec.license = "MIT"
-  spec.required_ruby_version = ">= 3.0"
+  spec.required_ruby_version = ">= 3.1"
 
   spec.metadata["homepage_uri"] = spec.homepage
   spec.metadata["source_code_uri"] = "https://github.com/heartml/heartml-ruby"
@@ -29,6 +29,4 @@ Gem::Specification.new do |spec|
 
   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/heartml/bridgetown_renderer.rb

@@ -11,7 +11,6 @@ module Heartml
         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
@@ -19,6 +18,7 @@ module Heartml
 end
 
 Bridgetown.initializer :heartml do |config|
+  # TODO: maybe we can ditch this once we're off ActiveSupport in Bridgetown
   Bridgetown::Component.extend ActiveSupport::DescendantsTracker
 
   Heartml.module_eval do

data/lib/heartml/fragment.rb

@@ -13,9 +13,9 @@ module Heartml
     # 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)
+    def traverse(node, &block) # rubocop:disable Style/ArgumentsForwarding
       yield(node)
-      node.children.each { |child| traverse(child, &block) }
+      node.children.each { |child| traverse(child, &block) } # rubocop:disable Style/ArgumentsForwarding
     end
 
     def process(fragment = @fragment) # rubocop:disable Metrics
@@ -79,7 +79,7 @@ module Heartml
           next unless attribute_binding.matcher.match?(name)
           next if attribute_binding.method.receiver._check_stack(node)
 
-          break unless attribute_binding.method.(attribute: attr_node, node: node)
+          break unless attribute_binding.method.(attribute: attr_node, node:)
         end
       rescue Exception => e # rubocop:disable Lint/RescueException
         line_segments = [@component.class.heart_module, @component._line_number_of_node(attr_node)]

data/lib/heartml/railtie.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Heartml
+  class Railtie < ::Rails::Railtie
+    module ReloadDocsInDevelopment
+      extend ActiveSupport::Concern
+
+      included do
+        before_action :reload_docs
+      end
+
+      def reload_docs
+        Heartml.registered_elements.each { _1.instance_variable_set(:@doc, nil) }
+      end
+    end
+
+    initializer "heartml.reload_docs_in_development" do |_app|
+      unless Rails.env.production?
+        ActiveSupport.on_load(:action_controller_base) do
+          include ReloadDocsInDevelopment
+        end
+      end
+    end
+
+    config.to_prepare do
+      next if Rails.env.production?
+
+      components_folder = Rails.root.join("app", "components")
+      unless File.directory?(components_folder)
+        Rails.logger.error "Heartml: missing `app/components' folder, cannot load elements"
+        next
+      end
+
+      Rails.autoloaders.main.eager_load_dir components_folder
+    end
+  end
+end

data/lib/heartml/server_effects.rb

@@ -36,7 +36,7 @@ module Heartml
 
     # @param klass [Class]
     # @return [void]
-    def self.included(klass) # rubocop:disable Metrics
+    def self.included_extras(klass) # rubocop:disable Metrics
       klass.attribute_binding "server-effect", :_server_effect_binding
       klass.attribute_binding "iso-effect", :_iso_effect_binding
 
@@ -58,7 +58,7 @@ module Heartml
     end
 
     def _server_effect_binding(attribute:, node:)
-      _iso_effect_binding(attribute: attribute, node: node)
+      _iso_effect_binding(attribute:, node:)
       node.remove_attribute "host-effect"
     end
 

data/lib/heartml/template_renderer.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module Heartml
+  class ServerComponent
+    def self.source_location
+      caller_locations(1, 10).reject do |l|
+        l.label == "inherited"
+      end[1].absolute_path
+    end
+
+    def self.inherited(klass)
+      super
+      klass.include Heartml
+    end
+  end
+
+  class TemplateRenderer < ServerComponent
+    def self.heart_module
+      "eval"
+    end
+
+    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
+      @context = context
+    end
+
+    def call
+      Fragment.new(@body, self).process
+      @body
+    end
+
+    def respond_to_missing?(key)
+      context.respond_to?(key)
+    end
+
+    # TODO: delegate instead?
+    def method_missing(key, *args, **kwargs)
+      context.send(key, *args, **kwargs)
+    end
+  end
+end

data/lib/heartml/version.rb

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

data/lib/heartml.rb

@@ -26,6 +26,8 @@ module Heartml
   require_relative "heartml/query_selection"
   require "heartml/server_effects"
 
+  include ServerEffects
+
   def self.registered_elements
     @registered_elements ||= Concurrent::Set.new
 
@@ -50,8 +52,9 @@ module Heartml
   def self.included(klass)
     klass.extend ClassMethods
 
-    klass.attribute_binding "server-children", :_server_children_binding, only: :template
-    klass.attribute_binding "server-unsafe-eval", :_server_replace_binding
+    klass.attribute_binding "server-children", :_server_children, only: :template
+    klass.attribute_binding "server-content", :_server_content, only: :template
+    klass.attribute_binding "server-unsafe-eval", :_server_unsafe_eval
 
     # Don't stomp on a superclass's `content` method
     has_content_method = begin
@@ -61,6 +64,8 @@ module Heartml
     end
 
     klass.include ContentMethod unless has_content_method
+
+    ServerEffects.included_extras(klass)
   end
 
   # Extends the component class
@@ -112,6 +117,8 @@ module Heartml
       end
     end
 
+    def output_tag_name(value = nil) = @output_tag_name ||= value
+
     # @param value [String]
     # @return [String]
     def heart_module(value = nil) = @heart_module ||= value
@@ -136,7 +143,7 @@ module Heartml
     def attribute_binding(matcher, method_name, only: nil)
       attribute_bindings << AttributeBinding.new(
         matcher: Regexp.new(matcher),
-        method_name: method_name,
+        method_name:,
         only_for_tag: only
       )
     end
@@ -247,7 +254,17 @@ module Heartml
       tmpl_el.remove
     end
 
-    rendering_mode == :node ? doc : doc.to_html
+    if self.class.output_tag_name
+      swap_doc = doc.document.create_element(self.class.output_tag_name)
+      doc.attrs.each do |attr, value|
+        swap_doc[attr] = value
+      end
+      swap_doc << doc.children
+
+      rendering_mode == :node ? swap_doc : swap_doc.to_html
+    else
+      rendering_mode == :node ? doc : doc.to_html
+    end
   end
 
   def call(...) = render_element(...)
@@ -319,7 +336,7 @@ module Heartml
       # TODO: handle objects inside of an array?
       obj
     else
-      Array[obj]
+      [obj]
     end.join(" ")
   end
 
@@ -353,12 +370,12 @@ module Heartml
     @_context_locals = previous_context
   end
 
-  def _server_children_binding(attribute:, node:) # rubocop:disable Lint/UnusedMethodArgument
+  def _server_children(attribute:, node:) # rubocop:disable Lint/UnusedMethodArgument
     self.replaced_content = node.children[0]
     node.remove
   end
 
-  def _server_replace_binding(attribute:, node:)
+  def _server_unsafe_eval(attribute:, node:)
     node_name = node.name
     correct_node = node_name == "template" ? node.children[0] : node
     result = node_or_string(evaluate_attribute_expression(attribute, correct_node.inner_html))
@@ -371,39 +388,12 @@ module Heartml
     end
   end
 
-  class ServerComponent
-    def self.inherited(klass)
-      super
-      klass.include Heartml
-      klass.include Heartml::ServerEffects
-    end
-  end
-
-  class TemplateRenderer < ServerComponent
-    def self.heart_module
-      "eval"
-    end
-
-    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
-      @context = context
-    end
-
-    def call
-      Fragment.new(@body, self).process
-      @body
-    end
-
-    def respond_to_missing?(key)
-      context.respond_to?(key)
-    end
-
-    # TODO: delegate instead?
-    def method_missing(key, *args, **kwargs)
-      context.send(key, *args, **kwargs)
-    end
+  def _server_content(attribute:, node:)
+    result = evaluate_attribute_expression(attribute, "content")
+    node.swap(result)
   end
 end
 
+require_relative "heartml/template_renderer"
 require_relative "heartml/bridgetown_renderer" if defined?(Bridgetown)
+require_relative "heartml/railtie" if defined?(Rails::Railtie)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: heartml
 version: !ruby/object:Gem::Version
-  version: 1.0.0.beta6
+  version: 1.0.0.beta8
 platform: ruby
 authors:
 - Jared White
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-09-06 00:00:00.000000000 Z
+date: 2024-02-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -38,20 +38,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.4.2
-- !ruby/object:Gem::Dependency
-  name: hash_with_dot_access
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.2'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.2'
 description:
 email:
 - jared@whitefusion.studio
@@ -72,9 +58,10 @@ files:
 - lib/heartml.rb
 - lib/heartml/bridgetown_renderer.rb
 - lib/heartml/fragment.rb
-- lib/heartml/petite.rb
 - lib/heartml/query_selection.rb
+- lib/heartml/railtie.rb
 - lib/heartml/server_effects.rb
+- lib/heartml/template_renderer.rb
 - lib/heartml/version.rb
 homepage: https://github.com/heartml/heartml-ruby#readme
 licenses:
@@ -92,14 +79,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '3.0'
+      version: '3.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
-rubygems_version: 3.3.3
+rubygems_version: 3.5.3
 signing_key:
 specification_version: 4
 summary: Server-rendered web components

data/lib/heartml/petite.rb

@@ -1,57 +0,0 @@
-# frozen_string_literal: true
-
-require "heartml"
-
-module Heartml
-  module Petite
-    # @param klass [Class]
-    # @return [void]
-    def self.included(klass)
-      klass.attribute_binding "v-for", :_petite_for_binding, only: :template
-      klass.attribute_binding "v-text", :_petite_text_binding
-      klass.attribute_binding "v-html", :_petite_html_binding
-      klass.attribute_binding "v-bind", :_petite_bound_attribute
-      klass.attribute_binding %r{^:}, :_petite_bound_attribute
-    end
-
-    protected
-
-    def _petite_for_binding(attribute:, node:)
-      delimiter = node["v-for"].include?(" of ") ? " of " : " in "
-      expression = node["v-for"].split(delimiter)
-
-      process_list(
-        attribute: attribute,
-        node: node,
-        item_node: node.children[0].first_element_child,
-        for_in: expression
-      )
-    end
-
-    def _petite_text_binding(attribute:, node:)
-      node.content = evaluate_attribute_expression(attribute).to_s
-    end
-
-    def _petite_html_binding(attribute:, node:)
-      node.inner_html = evaluate_attribute_expression(attribute).to_s
-    end
-
-    def _petite_bound_attribute(attribute:, node:) # rubocop:disable Metrics
-      return if attribute.name == ":key"
-
-      real_attribute = if attribute.name.start_with?(":")
-                         attribute.name.delete_prefix(":")
-                       elsif attribute.name.start_with?("v-bind:")
-                         attribute.name.delete_prefix("v-bind:")
-                       end
-
-      obj = evaluate_attribute_expression(attribute)
-
-      if real_attribute == "class"
-        node[real_attribute] = class_list_for(obj)
-      elsif real_attribute != "style" # style bindings aren't SSRed
-        node[real_attribute] = obj if obj
-      end
-    end
-  end
-end