vident 0.10.1 → 0.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a56c925065ab67c7c41493cd5ab9a1c19fedde171ebc2fcc60477359318ef258
-  data.tar.gz: 595d0ae7292a2548aece9749cbd7dc4e8f177faa6ea49aebfe90a1864c0014ce
+  metadata.gz: 503019b8aac7501339acff5c350afbca9abb55599a696f348321554da15183c0
+  data.tar.gz: 175ffd2794c1b7c81bf879a8bb3c9f65c42fa16cc92748be77df255c0b5fdcff
 SHA512:
-  metadata.gz: c0ee94c716fee4aa83d496beac7f2d7053e82742006ca1483dbd6ba38ba5ec32fc6f8c8b9f0ca691b05ff2c42947f52aa7937a35c5aef6cfd1bacc6454a7d90c
-  data.tar.gz: 399b0db4d117ee191f871eb5bb23d5419065ca083a58ba778e9a871839e9de1950837868b4b4043a8d72b7e97f18138678f41ef12813905543bc4c4a1619428a
+  metadata.gz: 0c76ae38a7c66032e99b130e21d67ba52f6c9fc946e3476fc945b682e5916ad406f90c12e0db2ab189ddf961e8c4f1a6e2cd64fc7e79bd6464ea5ccb1387e0de
+  data.tar.gz: f25903b4f38418a6752f33190713f0d8c9b3f5c2e251fb83476a35b2894df4dc848a3e104c13cf1d10ad448e774f924194020781f23b2c6d9732b061e0351e34

data/CHANGELOG.md

@@ -14,6 +14,25 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 
 ### Fixed
 
+
+## [0.12.0] - 2024-02-25
+
+### Added
+
+- `outlet` DSL methods updated so that the selector is scoped to the component's root element by default. This 
+  is probably the most common use case, and it's now the default.
+- `with_outlets` DSL method added to generate the data-* attributes for the outlets and return as a fragment  
+  of HTML
+
+
+## [0.11.0] - 2024-02-21
+
+### Added
+
+- `outlet_host` DSL method to support components hooking themselves into a host component's outlets
+
+
+
 ## [0.10.1] - 2024-02-21
 
 ### Added

data/lib/vident/base.rb

@@ -151,6 +151,7 @@ module Vident
         actions: attribute(:actions) + Array.wrap(options[:actions]),
         targets: attribute(:targets) + Array.wrap(options[:targets]),
         outlets: attribute(:outlets) + Array.wrap(options[:outlets]),
+        outlet_host: attribute(:outlet_host),
         named_classes: merge_stimulus_option(options, :named_classes),
         data_maps: prepare_stimulus_option(options, :data_maps)
       }

data/lib/vident/component.rb

@@ -17,6 +17,7 @@ module Vident
       attribute :actions, default: [], delegates: false
       attribute :targets, default: [], delegates: false
       attribute :outlets, default: [], delegates: false
+      attribute :outlet_host, delegates: false
       attribute :data_maps, default: [], delegates: false
       attribute :named_classes, delegates: false
     end

data/lib/vident/root_component.rb

@@ -7,6 +7,7 @@ module Vident
       actions: nil,
       targets: nil,
       outlets: nil,
+      outlet_host: nil,
       named_classes: nil, # https://stimulus.hotwired.dev/reference/css-classes
       data_maps: nil,
       element_tag: nil,
@@ -23,6 +24,13 @@ module Vident
       @named_classes = named_classes
       @data_map_kvs = {}
       @data_maps = data_maps
+
+      outlet_host.connect_outlet(self) if outlet_host.respond_to?(:connect_outlet)
+    end
+
+    def connect_outlet(outlet)
+      @outlets ||= []
+      @outlets << outlet
     end
 
     # The view component's helpers for setting stimulus data-* attributes on this component.
@@ -61,6 +69,20 @@ module Vident
       build_target_data_attributes([target(name)])
     end
 
+    def build_outlet_selector(outlet_selector)
+      prefix = @id ? "##{@id} " : ""
+      "#{prefix}[data-controller~=#{outlet_selector}]"
+    end
+
+    def outlet(css_selector: nil)
+      controller = implied_controller_name
+      if css_selector.nil?
+        [controller, build_outlet_selector(controller)]
+      else
+        [controller, css_selector]
+      end
+    end
+
     # Getter for a named classes list so can be used in view to set initial state on SSR
     # Returns a String of classes that can be used in a `class` attribute.
     def named_classes(*names)
@@ -87,6 +109,13 @@ module Vident
     end
     alias_method :with_action, :with_actions
 
+    # Return the HTML `data-` attribute for the given outlets
+    def with_outlets(*outlets)
+      attrs = build_outlet_data_attributes(outlets)
+      attrs.map { |dt, n| "data-#{dt}=\"#{n}\"" }.join(" ").html_safe
+    end
+    alias_method :with_outlet, :with_outlets
+
     private
 
     # An implicit Stimulus controller name is built from the implicit controller path
@@ -133,17 +162,29 @@ module Vident
 
     def outlet_list
       return {} unless @outlets&.size&.positive?
+      build_outlet_data_attributes(@outlets)
+    end
 
-      @outlets.each_with_object({}) do |outlet_config, obj|
-        identifier, css_selector = if outlet_config.is_a?(String)
-          [outlet_config, "[data-controller~=#{outlet_config}]"]
-        elsif outlet_config.is_a?(Array)
-          outlet_config[..1]
-        elsif respond_to?(:stimulus_identifier)
-          [outlet_config.stimulus_identifier, "[data-controller~=#{outlet_config.stimulus_identifier}]"]
-        else
-          raise ArgumentError, "Invalid outlet config: #{outlet_config}"
-        end
+    def parse_outlet(outlet_config)
+      if outlet_config.is_a?(String)
+        [outlet_config, build_outlet_selector(outlet_config)]
+      elsif outlet_config.is_a?(Symbol)
+        outlet_config = outlet_config.to_s.tr("_", "-")
+        [outlet_config, build_outlet_selector(outlet_config)]
+      elsif outlet_config.is_a?(Array)
+        outlet_config[..1]
+      elsif outlet_config.respond_to?(:stimulus_identifier) # Is a Component
+        [outlet_config.stimulus_identifier, build_outlet_selector(outlet_config.stimulus_identifier)]
+      elsif outlet_config.send(:implied_controller_name) # Is a RootComponent ?
+        [outlet_config.send(:implied_controller_name), build_outlet_selector(outlet_config.send(:implied_controller_name))]
+      else
+        raise ArgumentError, "Invalid outlet config: #{outlet_config}"
+      end
+    end
+
+    def build_outlet_data_attributes(outlets)
+      outlets.each_with_object({}) do |outlet_config, obj|
+        identifier, css_selector = parse_outlet(outlet_config)
         obj[:"#{implied_controller_name}-#{identifier}-outlet"] = css_selector
       end
     end

data/lib/vident/stable_id.rb

@@ -1,6 +1,12 @@
 # frozen_string_literal: true
 
-require "random/formatter"
+begin
+  # Introduced in Ruby 3.1
+  require "random/formatter"
+rescue LoadError
+  # to support Ruby 3.0
+  require "securerandom"
+end
 
 module Vident
   class StableId

data/lib/vident/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Vident
-  VERSION = "0.10.1"
+  VERSION = "0.12.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vident
 version: !ruby/object:Gem::Version
-  version: 0.10.1
+  version: 0.12.0
 platform: ruby
 authors:
 - Stephen Ierodiaconou
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-02-21 00:00:00.000000000 Z
+date: 2024-02-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties