vident 0.11.0 → 0.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ea398d33c180c2198ac689bd70d6f830dc625f9e70fd17bd94cb1acbaa7ec690
-  data.tar.gz: 86b1e7379929fbbe3e5b83b9356debfa18490a9cca60599a1a7ecbd9537d97f7
+  metadata.gz: 503019b8aac7501339acff5c350afbca9abb55599a696f348321554da15183c0
+  data.tar.gz: 175ffd2794c1b7c81bf879a8bb3c9f65c42fa16cc92748be77df255c0b5fdcff
 SHA512:
-  metadata.gz: 3e36f069043b62f9d300993e7be4d2cc8666aac6f782ee4ba04fd5efeaffe9ebd28ace5dbfd1022f90f515b253b9778d1123e516606fc20255b0d1bcb5a7bfe5
-  data.tar.gz: abf930b3b049e617544a8fe274b0c7deac1ad4f8226642d88fe120246fa0935b90cbcd3206480604290e2f2b9ff540dbf234ab72df8fb4051d8b6838cbecbc11
+  metadata.gz: 0c76ae38a7c66032e99b130e21d67ba52f6c9fc946e3476fc945b682e5916ad406f90c12e0db2ab189ddf961e8c4f1a6e2cd64fc7e79bd6464ea5ccb1387e0de
+  data.tar.gz: f25903b4f38418a6752f33190713f0d8c9b3f5c2e251fb83476a35b2894df4dc848a3e104c13cf1d10ad448e774f924194020781f23b2c6d9732b061e0351e34

data/CHANGELOG.md

@@ -15,6 +15,16 @@ 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

data/lib/vident/root_component.rb

@@ -69,10 +69,15 @@ 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, "[data-controller~=#{controller}]"]
+        [controller, build_outlet_selector(controller)]
       else
         [controller, css_selector]
       end
@@ -104,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
@@ -150,19 +162,29 @@ module Vident
 
     def outlet_list
       return {} unless @outlets&.size&.positive?
+      build_outlet_data_attributes(@outlets)
+    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
 
-      @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 outlet_config.respond_to?(:stimulus_identifier) # Is a Component
-          [outlet_config.stimulus_identifier, "[data-controller~=#{outlet_config.stimulus_identifier}]"]
-        elsif outlet_config.send(:implied_controller_name) # Is a RootComponent ?
-          [outlet_config.send(:implied_controller_name), "[data-controller~=#{outlet_config.send(:implied_controller_name)}]"]
-        else
-          raise ArgumentError, "Invalid outlet config: #{outlet_config}"
-        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.11.0"
+  VERSION = "0.12.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vident
 version: !ruby/object:Gem::Version
-  version: 0.11.0
+  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