view_component_css_dsl 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 49d5390931f1620f410e179868a1ab08cfcf4a0fa05164c8b4e7e7ba860fa1b2
-  data.tar.gz: 1f51a210129bd2ee1cfd414697e923c60e5be7c0c8870788e193482aacfda6ee
+  metadata.gz: eba29c79b834ffc0651fc3ff6b244e860de04218b6b29ca31df90634211fc6a6
+  data.tar.gz: fb7183fa91dc0bb773d61dc0953df0cf17fed601d39609cc1b2e2d44da725f51
 SHA512:
-  metadata.gz: '0086317b10dbb3b32225d9b7eb9b1695d176c40ea6adad370ca6259366edbb1952038170fa4499ecaa2ad5edfff2af7c2459214140bc2be8dd61b6441fac7e05'
-  data.tar.gz: f2286966bae1f1c1b12b2f10e09f58d983281cbfdf0d96c863d98f28b3b7feefae85229d17a440f19d156a51ff7d0dbd2d525660186cb310d6273f15bce4d112
+  metadata.gz: d28bfc76e89df1e4899fa396f0d45be296bbef32bed288d4893f908ad9038f28bc3f3e444675acf1408e01859f2cd6b007cb4fc346bad8389377765768952ff9
+  data.tar.gz: 9353657fc812e95881ec400152852886d05f2292f978d590dc0475abb64cb87dfe61ba38c1cde972d8c2c6f22eb74d0e88bd2f2c632455d1caa5d368f6d230e4

data/CHANGELOG.md

@@ -2,15 +2,15 @@
 
 
 
+## [0.1.2] - 2026-05-15
+
+### Added
+
+- data, aria, and attribute DSL declarators for first-class HTML attribute declarations (cf37050)
+
 ## [0.1.1] - 2026-05-15
 
 ### Changed
 
 - `view_component` dependency pinned to `~> 4.0` (was `>= 4.0`) — RubyGems-recommended SemVer-aware constraint
 - Minimum Ruby version raised to 3.2 (was 3.1), matching the floor for `view_component >= 4.0`
-
-## [0.1.0] - 2026-05-15
-
-### Added
-
-- Initial release. Extracted from SOFware/forge.

data/README.md

@@ -237,6 +237,124 @@ css -> { "pl-#{@indent * 4}" }
 
 Procs returning `nil` are dropped. Procs participate in smart_merge.
 
+## Declaring `data`, `aria`, and HTML attributes
+
+The gem provides three sibling declarators that mirror `css`'s shape: `data`, `aria`, and `attribute`. Use them to declare attributes alongside your styles instead of overriding methods.
+
+```ruby
+class ButtonComponent < ApplicationComponent
+  css "rounded px-4 py-2 bg-blue-500 text-white"
+
+  data variant: :variant, size: :size
+  aria label: "Submit"
+  attribute target: "_blank"
+
+  def initialize(variant: :primary, size: :default)
+    @variant = variant
+    @size = size
+  end
+
+  attr_reader :variant, :size
+end
+```
+
+All three declarators share the same patterns. The only difference is *where* the attribute lands in the rendered HTML — `data` produces `data-*`, `aria` produces `aria-*`, and `attribute` produces a top-level attribute.
+
+### Static values
+
+Always emitted. Stringified at render time (booleans, integers, etc. all become strings; `nil` drops the attribute).
+
+```ruby
+data controller: "modal"
+aria label: "Close dialog"
+attribute target: "_blank"
+```
+
+### Symbol values — call an instance method
+
+When the value is a Symbol, the DSL calls that instance method at render time and uses the result. Standard pattern for streaming an ivar or computed value into a data attribute.
+
+```ruby
+data variant: :variant       # calls #variant; renders as data-variant="<value>"
+attribute tabindex: :tab_index
+
+def tab_index
+  focusable? ? 0 : -1
+end
+```
+
+If the method returns `nil`, the attribute is dropped.
+
+### Proc values — inline computation
+
+For one-off computed values that don't deserve a named method:
+
+```ruby
+aria label: -> { "#{@variant} Notification".titleize }
+data turbo_permanent: -> { true if turbo_permanent? }
+```
+
+Procs are `instance_exec`'d at render time, so they see instance state. Procs returning `nil` drop the attribute.
+
+### Conditional inclusion via positional predicate
+
+Mirrors the `css :method?, style: "..."` pattern — a positional Symbol or Proc as the first argument acts as a predicate. When truthy, the declaration applies; when falsy, it's skipped entirely.
+
+```ruby
+data :auto_dismiss?, timeout: "5000", animation: "fade"
+aria :loud?, label: "Important"
+attribute -> { @disabled }, disabled: true
+```
+
+The Symbol form calls the named instance method; the Proc form is `instance_exec`'d.
+
+### Multiple attributes per declaration
+
+Each declaration accepts a hash of attributes. All share the same predicate (if any).
+
+```ruby
+data controller: "modal",
+     modal_dismiss_action: "click->modal#dismiss"
+```
+
+### Multiple declarations: how they compose
+
+For `aria` and `attribute`, repeated keys across declarations *replace* — the last declaration wins.
+
+For `data`, **the keys `:controller` and `:action` accumulate** (they're space-separated lists in HTML), and everything else replaces. This matches how the gem already merges component defaults with caller-passed values.
+
+```ruby
+data :modal?,        controller: "modal"
+data :trap_focus?,   controller: "trap-focus"
+# Both predicates true → data-controller="modal trap-focus"
+# Only :modal? true   → data-controller="modal"
+# Neither true        → data-controller attribute is omitted
+```
+
+### Caller customization
+
+Whatever a caller passes for `class:`, `data:`, `aria:`, or any HTML attribute layers on top of your declarations using the same rules:
+
+- `class:` smart-merged (see Smart merge behavior below)
+- `data:` controller/action keys concatenate, others replace
+- `aria:` and other attrs: caller wins
+
+### Inheritance
+
+Subclass declarations stack on top of parent declarations using the same rules. `data controller:` declarations in a child class concatenate with the parent's; `data role:` in a child class replaces the parent's. `aria` and `attribute` keys in a child class replace the parent's.
+
+```ruby
+class CardComponent < ApplicationComponent
+  data controller: "card"
+  data role: "region"
+end
+
+class HighlightedCardComponent < CardComponent
+  data controller: "highlighted"   # appends → data-controller="card highlighted"
+  data role: "alert"                # replaces → data-role="alert"
+end
+```
+
 ## Caller customization
 
 Callers can pass `class:` (smart-merged with the component's defaults), plus any other HTML attribute (`data:`, `id:`, `aria:`, etc.) — they all land on the top-level element without the component having to opt each one in.

data/lib/view_component_css_dsl/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ViewComponentCssDsl
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

data/lib/view_component_css_dsl.rb

@@ -133,6 +133,10 @@ module ViewComponentCssDsl
     class_attribute :_css_cache, instance_writer: false, default: nil
     # Memoization cache for smart_merge results (axis + method + proc combinations)
     class_attribute :_css_merge_cache, instance_writer: false, default: nil
+    # Rules for the data/aria/attribute DSLs. Each entry: {predicate:, attrs:}
+    class_attribute :_data_rules, instance_writer: false, default: []
+    class_attribute :_aria_rules, instance_writer: false, default: []
+    class_attribute :_attribute_rules, instance_writer: false, default: []
   end
 
   class_methods do
@@ -198,6 +202,60 @@ module ViewComponentCssDsl
       end
     end
 
+    # Declares one or more `data-*` attributes on the top-level element.
+    #
+    #   data controller: "modal"                      # static
+    #   data variant: :variant                        # Symbol value -> calls instance method
+    #   data foo: -> { computed_value }               # Proc value -> instance_exec'd
+    #   data :auto_dismiss?, timeout_value: "5000"    # Symbol predicate
+    #   data -> { complex_check? }, foo: "bar"        # Proc predicate
+    def data(*args, **kwargs)
+      self._data_rules = _data_rules.dup
+      _data_rules << _build_attr_rule(:data, *args, **kwargs)
+    end
+
+    # Declares one or more `aria-*` attributes on the top-level element.
+    # See `data` for the full pattern.
+    def aria(*args, **kwargs)
+      self._aria_rules = _aria_rules.dup
+      _aria_rules << _build_attr_rule(:aria, *args, **kwargs)
+    end
+
+    # Declares one or more top-level HTML attributes (`target`, `role`, `tabindex`,
+    # etc.) on the rendered element. See `data` for the full pattern.
+    def attribute(*args, **kwargs)
+      self._attribute_rules = _attribute_rules.dup
+      _attribute_rules << _build_attr_rule(:attribute, *args, **kwargs)
+    end
+
+    private
+
+    # Builds the rule entry used by `data`, `aria`, and `attribute`.
+    # Returns {predicate:, attrs:} where predicate is nil, Symbol, or Proc and
+    # attrs is the hash of attribute key -> (literal | Symbol | Proc).
+    def _build_attr_rule(namespace, *args, **kwargs)
+      if args.size > 1
+        raise ArgumentError,
+          "#{namespace} accepts at most one positional arg (a predicate Symbol or Proc)"
+      end
+
+      predicate = args.first
+      if predicate && !predicate.is_a?(Symbol) && !predicate.is_a?(Proc)
+        raise ArgumentError,
+          "#{namespace} positional predicate must be a Symbol or Proc " \
+          "(got #{predicate.class})"
+      end
+
+      if kwargs.empty?
+        raise ArgumentError,
+          "#{namespace} requires at least one attribute kwarg"
+      end
+
+      {predicate:, attrs: kwargs}
+    end
+
+    public
+
     # Override `new` to auto-extract HTML attributes from kwargs into @html_attrs,
     # so components don't need to declare **html_attrs in their initialize signature.
     # Anything in HTML_ATTR_KEYS that wasn't declared as a kwarg is captured.
@@ -401,7 +459,10 @@ module ViewComponentCssDsl
   def html_attrs
     return {} unless @html_attrs
 
-    result = @html_attrs.except(:aria, :class, :data)
+    # Start with DSL-declared top-level attrs; caller's html_attrs layer on top
+    # (caller wins on collision, mirroring the css behavior).
+    dsl_attrs = resolved_attr_rules(:attribute)
+    result = dsl_attrs.merge(@html_attrs.except(:aria, :class, :data))
 
     # Only include aria/data if they have content, otherwise they'd override
     # inline attrs in templates like: tag.div data: {foo: "bar"}, **html_attrs
@@ -462,16 +523,11 @@ module ViewComponentCssDsl
   # - In contrast, data-label from the caller overwrites the default
   #
   def final_data_attrs
-    incoming_data = @html_attrs.fetch(:data, {})
-    incoming_data.each_with_object(data_attrs) do |(key, value), final_data|
-      final_value = if key.in?(DATA_MERGE_KEYS)
-        [data_attrs[key], value].compact.join(" ")
-      else
-        value
-      end
-
-      final_data[key] = final_value
-    end
+    # Merge in order: DSL declarations -> method override -> caller's :data.
+    # Each layer uses DATA_MERGE_KEYS semantics (controller/action concatenate,
+    # everything else replaces).
+    combined = merge_data_layer(resolved_attr_rules(:data), data_attrs)
+    merge_data_layer(combined, @html_attrs.fetch(:data, {}))
   end
 
   # Overwrite in subclass to define default aria-attrs
@@ -479,14 +535,75 @@ module ViewComponentCssDsl
     {}
   end
 
-  # Using merge allows for default value #aria_attrs, but also for dev to override
-  # that value per-instance as needed
+  # Merge in order: DSL declarations -> method override -> caller's :aria.
+  # Hash#merge throughout — caller wins on collision (no additive semantics).
   def final_aria_attrs
-    aria_attrs.merge(@html_attrs.fetch(:aria, {}))
+    resolved_attr_rules(:aria).merge(aria_attrs).merge(@html_attrs.fetch(:aria, {}))
   end
 
   private
 
+  # Walks the DSL rules for the given namespace (:data, :aria, :attribute),
+  # evaluates each predicate, resolves each value, and returns a hash. For
+  # the :data namespace, DATA_MERGE_KEYS keys accumulate space-separated when
+  # the same key appears in multiple included rules.
+  def resolved_attr_rules(namespace)
+    rules = case namespace
+    when :data then self.class._data_rules
+    when :aria then self.class._aria_rules
+    when :attribute then self.class._attribute_rules
+    end
+
+    rules.each_with_object({}) do |rule, result|
+      next unless predicate_met?(rule[:predicate])
+
+      rule[:attrs].each do |key, value|
+        resolved = resolve_attr_value(value)
+        next if resolved.nil?
+
+        result[key] = if namespace == :data && DATA_MERGE_KEYS.include?(key) && result.key?(key)
+          "#{result[key]} #{resolved}"
+        else
+          resolved
+        end
+      end
+    end
+  end
+
+  # Layers `addition` on top of `base` using DATA_MERGE_KEYS semantics: keys
+  # in DATA_MERGE_KEYS concatenate space-separated, every other key replaces.
+  def merge_data_layer(base, addition)
+    addition.each_with_object(base.dup) do |(key, value), result|
+      result[key] = if DATA_MERGE_KEYS.include?(key)
+        [result[key], value].compact.join(" ")
+      else
+        value
+      end
+    end
+  end
+
+  # Resolves a predicate. nil predicate -> always true. Symbol -> call instance
+  # method. Proc -> instance_exec.
+  def predicate_met?(predicate)
+    case predicate
+    when nil then true
+    when Symbol then send(predicate)
+    when Proc then instance_exec(&predicate)
+    end
+  end
+
+  # Resolves a value for a DSL-declared attribute. Symbols become method calls
+  # on the instance; Procs are instance_exec'd; literals pass through. Result
+  # is stringified unless nil (which drops the attribute).
+  def resolve_attr_value(value)
+    resolved = case value
+    when Symbol then send(value)
+    when Proc then instance_exec(&value)
+    else value
+    end
+    resolved&.to_s
+  end
+
   def build_classes
     validate_axes!
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: view_component_css_dsl
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Jeff Lange