stimulus-rails-helpers 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ab19e9c3efbc6ab8b6631c0094ef7a320bbf28c2f110f942f9ea6abb740ce775
+  data.tar.gz: 8a51ffae0265d1737530bc360da6de7519ad0980747bb4f0d0b9b678e1219b87
+SHA512:
+  metadata.gz: 4e061768233c231107ef8823b11e743ba7680e6acb44492b4c616886842efdce39237f3ed7940a2c86f7cbd12beedc0f87873630b268828c4cc4382e15f1293e
+  data.tar.gz: 8fbc2b845f999eb192e3a922098c34148f221154db1323b123c3b991fcd37890c4cdb51eb7732dc9979d178bc50d8c683e423e31962f02c099a58011822bce3d

data/lib/stimulus-rails-helpers.rb

@@ -0,0 +1,3 @@
+require_relative "stimulus_rails_helpers/rails_helpers"
+require_relative "stimulus_rails_helpers/stimulus_renderer"
+require_relative "stimulus_rails_helpers/railtie"

data/lib/stimulus_rails_helpers/rails_helpers.rb

@@ -0,0 +1,18 @@
+module StimulusRailsHelpers
+  module RailsHelpers
+    def stimulus_namespace(*namespaces)
+      yield(*namespaces.map { |ns| StimulusRenderer.new(namespace: ns, view_context: self) })
+    end
+    alias stim_ns stimulus_namespace
+
+    def stimulus_element(element = :div, namespace: nil, controllers: [], values: {}, outlets: {}, actions: {}, targets: {}, **other_attributes, &block)
+      StimulusRenderer.new(namespace:, view_context: self).element(element, controllers:, values:, outlets:, actions:, targets:, **other_attributes, &block)
+    end
+    alias stim_el stimulus_element
+
+    def stimulus_data(namespace: nil, controllers: [], values: {}, outlets: {}, actions: {}, targets: {}, **other_data_attributes)
+      StimulusRenderer.new(namespace:, view_context: self).data(controllers:, values:, outlets:, actions:, targets:, **other_data_attributes)
+    end
+    alias stim_data stimulus_data
+  end
+end

data/lib/stimulus_rails_helpers/railtie.rb

@@ -0,0 +1,9 @@
+module StimulusRailsHelpers
+  class Railtie < Rails::Railtie
+    initializer "stimulus_rails_helpers.action_view" do
+      ActiveSupport.on_load(:action_view) do
+        include StimulusRailsHelpers::RailsHelpers
+      end
+    end
+  end
+end

data/lib/stimulus_rails_helpers/stimulus_renderer/attribute_renderers.rb

@@ -0,0 +1,114 @@
+module StimulusRailsHelpers
+  class StimulusRenderer
+    module AttributeRenderers
+      class Base
+        include ActionView::Helpers::OutputSafetyHelper
+
+        attr_reader :descriptors, :namespace
+
+        def initialize(descriptors, namespace: [])
+          @descriptors = descriptors
+          @namespace = namespace
+        end
+
+        private
+
+        def prefix
+          @prefix ||= namespace.present? ? parse_namespace(namespace) : ""
+        end
+
+        def parse_namespace(namespace)
+          if namespace.is_a?(String) || namespace.is_a?(Symbol)
+            kebabize(namespace.to_s) + "--"
+          elsif namespace.is_a?(Array)
+            namespace.map { |name| parse_namespace(name) }.join
+          elsif namespace.is_a?(Hash)
+            namespace.map { |name, children| parse_namespace(name) + parse_namespace(children) }.join
+          end
+        end
+
+        def kebabize(string_or_symbol)
+          string_or_symbol.to_s.underscore.tr("_", "-")
+        end
+      end
+
+      class Controllers < Base
+        def to_s
+          Array(descriptors).map { |controller_name| "#{prefix}#{kebabize(controller_name)}" }.join(" ")
+        end
+      end
+
+      class Values < Base
+        def to_h
+          {}.tap do |out|
+            descriptors.each do |controller, values|
+              values.each do |value_name, value_value|
+                out["#{prefix}#{kebabize(controller)}-#{kebabize(value_name)}-value"] = value_value
+              end
+            end
+          end
+        end
+      end
+
+      class Outlets < Base
+        def to_h
+          {}.tap do |out|
+            descriptors.each do |controller, outlets|
+              outlets.each do |target_controller, outlet_selector|
+                out["#{prefix}#{kebabize(controller)}-#{prefix}#{kebabize(target_controller)}-outlet"] = outlet_selector
+              end
+            end
+          end
+        end
+      end
+
+      class Actions < Base
+        def to_s
+          # Have to consider escaping due to action notation containing `->`
+          safe_join(to_a, " ")
+        end
+
+        def to_a
+          [].tap do |out|
+            descriptors.each do |controller, action_descriptor|
+              Array(parse_action_names(controller, action_descriptor)).each { |el| out << el }
+            end
+          end
+        end
+
+        private
+
+        # Note that this can return a string, or array of strings
+        def parse_action_names(controller_name, descriptor)
+          # actions: { controller: :action }
+          if descriptor.is_a?(String) || descriptor.is_a?(Symbol)
+            # Have to consider escaping due to action notation containing `->`
+            "#{prefix}#{kebabize(controller_name)}##{descriptor.to_s.camelize(:lower)}".html_safe
+
+          # actions: { controller: { event: :action } }
+          elsif descriptor.is_a?(Hash)
+            dom_event = descriptor.keys.first
+            stimulus_function = descriptor.values.first
+
+            # Have to consider escaping due to action notation containing `->`
+            "#{dom_event}->#{parse_action_names(controller_name, stimulus_function)}".html_safe
+
+          # actions: { controller: [:action, { event: :action }] }
+          elsif descriptor.is_a?(Array)
+            descriptor.map { |element| parse_action_names(controller_name, element) }
+          end
+        end
+      end
+
+      class Targets < Base
+        def to_h
+          {}.tap do |out|
+            descriptors.each do |controller, target_name|
+              out["#{prefix}#{kebabize(controller)}-target"] = target_name.to_s.camelize(:lower)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/stimulus_rails_helpers/stimulus_renderer.rb

@@ -0,0 +1,50 @@
+require_relative "stimulus_renderer/attribute_renderers"
+
+module StimulusRailsHelpers
+  class StimulusRenderer
+    attr_reader :namespace, :view_context
+
+    def initialize(view_context:, namespace: nil)
+      @namespace = namespace
+      @view_context = view_context
+    end
+
+    def element(element = :div, controllers: [], values: {}, outlets: {}, actions: {}, targets: {}, **other_attributes, &block)
+      generated_data_attributes = data(controllers:, values:, outlets:, actions:, targets:)
+      generated_data_attributes.merge!(other_attributes.delete(:data)) if other_attributes[:data]
+
+      if block_given?
+        view_context.content_tag(element, data: generated_data_attributes, **other_attributes, &block)
+      else
+        view_context.content_tag(element, "", data: generated_data_attributes, **other_attributes)
+      end
+    end
+    alias el element
+
+    def data(controllers: [], values: {}, outlets: {}, actions: {}, targets: {}, **other_data_attributes)
+      returned_attributes = {}
+
+      if controllers.present?
+        returned_attributes[:controller] = AttributeRenderers::Controllers.new(controllers, namespace:).to_s
+      end
+
+      if values.present?
+        returned_attributes.merge!(AttributeRenderers::Values.new(values, namespace:).to_h)
+      end
+
+      if outlets.present?
+        returned_attributes.merge!(AttributeRenderers::Outlets.new(outlets, namespace:).to_h)
+      end
+
+      if actions.present?
+        returned_attributes[:action] = AttributeRenderers::Actions.new(actions, namespace:).to_s
+      end
+
+      if targets.present?
+        returned_attributes.merge!(AttributeRenderers::Targets.new(targets, namespace:).to_h)
+      end
+
+      returned_attributes.merge(other_data_attributes)
+    end
+  end
+end

data/stimulus-rails-helpers.gemspec

@@ -0,0 +1,13 @@
+Gem::Specification.new do |s|
+  s.name          = "stimulus-rails-helpers"
+  s.version       = "0.1.0"
+  s.summary       = "Some helpers to help tame the task of wrangling Stimulus' data attributes."
+  s.authors       = ["Jon Gilbraith"]
+  s.files         = ["stimulus-rails-helpers.gemspec"] + Dir["lib/**/*.rb"]
+  s.metadata      = { "source_code_uri" => "https://github.com/jongilbraith/stimulus-rails-helpers" }
+  s.license       = "MIT"
+  s.homepage      = "https://github.com/jongilbraith/stimulus-rails-helpers"
+
+  s.add_runtime_dependency "actionview", "~> 3.0.0"
+  s.add_runtime_dependency "activesupport", "~> 3.0.0"
+end

metadata

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification
+name: stimulus-rails-helpers
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jon Gilbraith
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2026-06-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: actionview
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+description: 
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/stimulus-rails-helpers.rb
+- lib/stimulus_rails_helpers/rails_helpers.rb
+- lib/stimulus_rails_helpers/railtie.rb
+- lib/stimulus_rails_helpers/stimulus_renderer.rb
+- lib/stimulus_rails_helpers/stimulus_renderer/attribute_renderers.rb
+- stimulus-rails-helpers.gemspec
+homepage: https://github.com/jongilbraith/stimulus-rails-helpers
+licenses:
+- MIT
+metadata:
+  source_code_uri: https://github.com/jongilbraith/stimulus-rails-helpers
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3.1
+signing_key: 
+specification_version: 4
+summary: Some helpers to help tame the task of wrangling Stimulus' data attributes.
+test_files: []