vident 1.0.0.alpha2 → 1.0.0.alpha3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7144408178f3fedee324dc23604af7baca5db589520d3cb4ea1413a88e4c93c0
-  data.tar.gz: 742e8db9df1d0f72e701ccec290693be799408b70263fd5a7c75a1c1987a0acb
+  metadata.gz: 1ae2c093011a8047255f21fff2b284520d9be75660af61afc511c85bfdcc9f76
+  data.tar.gz: 47bbde103e62632fca8a11bb1ddd6321dd8c6c8711d21790a51a3e657e3d6f66
 SHA512:
-  metadata.gz: c1ccac1a695a9a915e87675973c7a09143582cb7775d6fd9a89d24c426a35cad5aa2d0e7adc424d680ae02d4cb767645a11394c05981cff2724c01482ccf44f2
-  data.tar.gz: 315951c114e8ecb5db720d45dc8236aabb34b7442eec520e47d8eb4b9472728b50c0b6a430e9ead6e85c292640eb6cafe03f034bf7ca6606e422e3c0c837c544
+  metadata.gz: df35e4be8597d580ad4f50b63f99c1e0a8032fd52c9c06676b6d4db9ee15a781f80d00c5112c87047238361560b5a131e60f11800e07c03f904d1e781fed3312
+  data.tar.gz: 5794832b1bb4a4abbc532beabdbe9133c3a45b7ef42eca8d11660051466a7b64298af3bcb8c7c90c55381a25bfec0680afe389f319c2b8ffc1602f1fb3f47d16

data/CHANGELOG.md

@@ -5,6 +5,14 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](http://semver.org/).
 
+## [1.0.0.alpha3] - 2025-07-21
+
+### Breaking
+- `element_classes` is now `root_element_classes` to make more consistent with the other root element methods.
+
+### Added
+
+-`.prop_names` and `#prop_values` methods to `Vident::Component` to return the names and values of the component's properties.
 
 ## [1.0.0.alpha2] - 2025-07-08
 

data/README.md

@@ -76,21 +76,23 @@ class ButtonComponent < Vident::ViewComponent::Base
   
   # Configure Stimulus integration
   stimulus do
-    actions [:click, :handle_click]
-    # Static values
-    values loading_duration: 1000
+    # Setup actions, including with proc to evaluate on instance 
+    actions [:click, :handle_click], 
+            -> { [stimulus_scoped_event(:my_custom_event), :handle_this] if should_handle_this? }
     # Map the clicked_count prop as a Stimulus value
     values_from_props :clicked_count
     # Dynamic values using procs (evaluated in component context)
-    values item_count: -> { @items.count }
-    values api_url: -> { Rails.application.routes.url_helpers.api_items_path }
+    values item_count: -> { @items.count },
+           api_url: -> { Rails.application.routes.url_helpers.api_items_path },
+           loading_duration: 1000 # or set static values
     # Static and dynamic classes
-    classes loading: "opacity-50 cursor-wait"
-    classes size: -> { @items.count > 10 ? "large" : "small" }
+    classes loading: "opacity-50 cursor-wait",
+            size: -> { @items.count > 10 ? "large" : "small" }
   end
 
   def call
     root_element do |component|
+      # Wire up targets etc
       component.tag(:span, stimulus_target: :status) do
         @text
       end
@@ -99,6 +101,7 @@ class ButtonComponent < Vident::ViewComponent::Base
 
   private
 
+  # Configure your components root HTML element
   def root_element_attributes
     {
       element_tag: @url ? :a : :button,
@@ -106,7 +109,8 @@ class ButtonComponent < Vident::ViewComponent::Base
     }
   end
 
-  def element_classes
+  # optionally add logic to determine initial classes
+  def root_element_classes
     base_classes = "btn"
     case @style
     when :primary
@@ -263,7 +267,7 @@ The `root_element` helper method renders your component's root element with all
 
 ```ruby
 # In your component class
-def element_classes
+def root_element_classes
   ["card", featured? ? "card-featured" : nil]
 end
 
@@ -619,7 +623,7 @@ class StyledComponent < Vident::ViewComponent::Base
   private
   
   # Classes on the root element
-  def element_classes
+  def root_element_classes
     ["base-class", variant_class]
   end
   
@@ -653,7 +657,7 @@ class TailwindComponent < Vident::ViewComponent::Base
   
   private
   
-  def element_classes
+  def root_element_classes
     # Conflicts with size_class will be resolved automatically
     "p-2 text-sm #{size_class}"
   end

data/lib/vident/class_list_builder.rb

@@ -6,12 +6,23 @@ module Vident
   class ClassListBuilder
     CLASSNAME_SEPARATOR = " "
 
-    def initialize(tailwind_merger: nil, component_name: nil, element_classes: nil, html_class: nil, additional_classes: nil)
+    # If the HTML "class" option is provided, it is taken in order of precedence of source.
+    # The order of precedence is:
+    # lowest  | root_element_classes => whatever is returned
+    # ....... | root_element_attributes => the `html_options[:class]` value
+    # ....... | root_element(class: ...) => the `class` value of the arguments passed to the root element
+    # highest | render MyComponent.new(html_options: { class: ... }) => the `html_options[:class]` value
+    # The "classes" prop on the component on the other hand is used to add additional classes to the component.
+    # eg: render MyComponent.new(classes: "my-additional-class another-class")
+    def initialize(tailwind_merger: nil, component_name: nil, root_element_attributes_classes: nil, root_element_classes: nil, root_element_html_class: nil, html_class: nil, additional_classes: nil)
       @class_list = component_name ? [component_name] : []
-      @class_list.concat(Array.wrap(element_classes)) if element_classes
+      @class_list.concat(Array.wrap(root_element_classes)) if root_element_classes && !root_element_attributes_classes && !root_element_html_class && !html_class
+      @class_list.concat(Array.wrap(root_element_attributes_classes)) if root_element_attributes_classes && !root_element_html_class && !html_class
+      @class_list.concat(Array.wrap(root_element_html_class)) if root_element_html_class && !html_class
       @class_list.concat(Array.wrap(html_class)) if html_class
       @class_list.concat(Array.wrap(additional_classes)) if additional_classes
       @class_list.compact!
+
       @tailwind_merger = tailwind_merger
 
       if @tailwind_merger && !defined?(::TailwindMerge::Merger)

data/lib/vident/component.rb

@@ -16,6 +16,13 @@ module Vident
       prop :html_options, Hash, default: -> { {} }
     end
 
+    class_methods do
+      # Returns the names of the properties defined in the component class.
+      def prop_names
+        literal_properties.properties_index.keys.map(&:to_sym)
+      end
+    end
+
     include StimulusComponent
     include ComponentClassLists
     include ComponentAttributeResolver
@@ -29,7 +36,7 @@ module Vident
     end
 
     # This can be overridden to return an array of extra class names, or a string of class names.
-    def element_classes
+    def root_element_classes
     end
 
     # Properties/attributes passed to the "root" element of the component. You normally override this method to
@@ -50,6 +57,12 @@ module Vident
     # attributes which require elements to reference by ID. Note this overrides the `id` accessor
     def id = @id.presence || random_id
 
+
+    # Return the names of the properties defined in the component class.
+    def prop_names
+      self.class.prop_names
+    end
+
     private
 
     # Called by Literal::Properties after the component is initialized.
@@ -66,14 +79,6 @@ module Vident
       root_element(...)
     end
 
-    def root_element_tag_options
-      options = @html_options&.dup || {}
-      data_attrs = stimulus_data_attributes
-      options[:data] = options[:data].present? ? data_attrs.merge(options[:data]) : data_attrs
-      return options unless @id
-      options.merge(id: @id)
-    end
-
     def root_element_tag_type
       @element_tag.presence&.to_sym || :div
     end

data/lib/vident/component_attribute_resolver.rb

@@ -4,7 +4,7 @@ module Vident
   module ComponentAttributeResolver
     private
 
-    # FIXME: in a view_component the parsing of html_options might have to be in `before_render`
+    # Prepare attributes set at initialization, which will later be merged together before rendering.
     def prepare_component_attributes
       prepare_stimulus_collections
 
@@ -14,8 +14,8 @@ module Vident
       # Process root_element_attributes (higher precedence)
       extra = root_element_attributes
       @html_options = (extra[:html_options] || {}).merge(@html_options) if extra.key?(:html_options)
-      @html_options[:class] = render_classes(extra[:classes])
-      @html_options[:id] = (extra[:id] || id) unless @html_options.key?(:id)
+      @root_element_attributes_classes = extra[:classes]
+      @root_element_attributes_id = (extra[:id] || id)
       @element_tag = extra[:element_tag] if extra.key?(:element_tag)
 
       add_stimulus_controllers(extra[:stimulus_controllers]) if extra.key?(:stimulus_controllers)
@@ -26,6 +26,32 @@ module Vident
       add_stimulus_classes(extra[:stimulus_classes]) if extra.key?(:stimulus_classes)
     end
 
+    def resolve_root_element_attributes_before_render(root_element_html_options = nil)
+      extra = root_element_html_options || {}
+
+      # Options set on component at render time take precedence over attributes set by methods on the component
+      # or attributes passed to root_element in the template
+      final_attributes = {
+        data: stimulus_data_attributes  # Lowest precedence
+      }
+      if root_element_html_options.present? # Mid precedence
+        root_element_tag_html_options_merge(final_attributes, root_element_html_options)
+      end
+      if @html_options.present? # Highest precedence
+        root_element_tag_html_options_merge(final_attributes, @html_options)
+      end
+      final_attributes[:class] = render_classes(extra[:class])
+      final_attributes[:id] = (extra[:id] || @root_element_attributes_id) unless final_attributes.key?(:id)
+      final_attributes
+    end
+
+    def root_element_tag_html_options_merge(final_attributes, other_html_options)
+      if other_html_options[:data].present?
+        final_attributes[:data].merge!(other_html_options[:data])
+      end
+      final_attributes.merge!(other_html_options.except(:data))
+    end
+
     # Add stimulus attributes from DSL declarations using existing add_* methods
     def add_stimulus_attributes_from_dsl
       dsl_attrs = self.class.stimulus_dsl_attributes(self)

data/lib/vident/component_class_lists.rb

@@ -3,7 +3,7 @@
 module Vident
   module ComponentClassLists
     # Generates the full list of HTML classes for the component
-    def render_classes(extra_classes = nil) = class_list_builder.build(extra_classes)
+    def render_classes(root_element_html_class = nil) = class_list_builder(root_element_html_class).build
 
     # Getter for a stimulus 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.
@@ -15,11 +15,13 @@ module Vident
 
     # Get or create a class list builder instance
     # Automatically detects if Tailwind module is included and TailwindMerge gem is available
-    def class_list_builder
+    def class_list_builder(root_element_html_class = nil)
       @class_list_builder ||= ClassListBuilder.new(
         tailwind_merger:,
         component_name:,
-        element_classes:,
+        root_element_attributes_classes: @root_element_attributes_classes,
+        root_element_classes:,
+        root_element_html_class:,
         additional_classes: @classes,
         html_class: @html_options&.fetch(:class, nil)
       )

data/lib/vident/version.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Vident
-  VERSION = "1.0.0.alpha2"
+  VERSION = "1.0.0.alpha3"
 
   # Shared version for all vident gems
   def self.version

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: vident
 version: !ruby/object:Gem::Version
-  version: 1.0.0.alpha2
+  version: 1.0.0.alpha3
 platform: ruby
 authors:
 - Stephen Ierodiaconou
 bindir: bin
 cert_chain: []
-date: 2025-07-08 00:00:00.000000000 Z
+date: 2025-07-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties