phlex-forms 0.2.5 → 0.2.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '0038bad89aee72fb6b4e162bfc83dc9afbaadbc2280f3ea23be2985e81774d41'
-  data.tar.gz: 9b35b71658c4ffbb14667a79e6e85e4a0437d6953b64921272ae629a443a0ac2
+  metadata.gz: fd321ccbe2bec3d9b8966d0eda0e1036e4143af38b4aa55dec702ce8c6d23137
+  data.tar.gz: 2abe25e3c63dd5d689a6c6d762df3ed6204c0dca0ef6b7d569f6e8c3da4ee1d7
 SHA512:
-  metadata.gz: b8ada79a4a87a79096b16f82d000ea0e5620096ebe4b8fff9560ae5e556ff982ff6e13ccb52c77e0d7ea72e0d094055595870468de9c40d9f498350bab399eb4
-  data.tar.gz: bce76ac9a71f33cab8c15f6f4b529b636da88d802c4b86ba07ee90948daaa1a2e1c0637f898a11be75e37ab4b8dd7abb8f42ce654a9481907b5cbcc5a299263a
+  metadata.gz: fb8b8768817fef4b18e0dacadbfb966cf7356339badfce5e96ea04ccc7e0d5bcc60686e65288413376bbe7873e17993746b35dceefb917a58132505ef88f9094
+  data.tar.gz: e7f775c0c15db6e595f9ac5c93449fb49b12d032f1a615f231b5e23f1aa2ac188fb2eb21a6afccf073758227a3e100a69def8f24185baadd63ddc19e923a48e0

data/CHANGELOG.md

@@ -23,6 +23,13 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
   the Control's own visible `label:` / `hint:` get stable ids and the field wires
   `aria-labelledby` / `aria-describedby` at them (no duplicate markup). Absent a
   name, output is unchanged.
+- **`checkbox_group` `item_label:`** — the per-item text accessor, so a
+  `f.field(:tags, as: :checkbox_group, label: "Tags", item_label: ->(t){…})`
+  renders a visible group heading (`label:`, via the Control) AND custom item
+  labels at once — previously `label:` on the `f.field` path was eaten by the
+  heading and items fell back to `to_s`. `item_label:` wins over `label:` for the
+  item text; on the bare verb `label:` stays the item accessor and `item_label:`
+  is an alias. Absent it, behavior is unchanged.
 
 ### Changed
 

data/README.md

@@ -368,9 +368,13 @@ f.checkbox_group(:tag_ids, Tag.all, value: :id,
   variant: :pill,                             # :stack (default) | :inline | :pill
   size: :sm,                                  # daisyUI checkbox size
   aria: { label: "Tags" })                    # names the group for screen readers
-# ...or through field inference (the field's label/hint name the group):
+# ...or through field inference. Here `label:`/`hint:` are the field's VISIBLE
+# heading + description (rendered by the Control, which also names the group);
+# `item_label:` gives the per-item text, so you get a heading AND custom item
+# labels at once:
 f.field :tag_ids, as: :checkbox_group, collection: Tag.all, value: :id,
-  label: "Tags", hint: "Pick any"
+  label: "Tags", hint: "Pick any",
+  item_label: ->(t) { t.name.presence || t.slug }, variant: :pill
 
 f.collection_select(:country_id, Country.all, :id, :name, prompt: "Select…")
 ```
@@ -381,6 +385,13 @@ set comes from the model's current value matched by each item's resolved
 `value:` — re-rendering an edit form pre-checks the right boxes. The `:pill`
 variant styles the active chip with Tailwind's `has-[:checked]:` (no JS).
 
+**Two labels, no collision.** Through `f.field`, `label:` is the field's visible
+group heading (the Control renders it); the per-item text comes from `item_label:`
+(a Symbol method or Proc). On the bare `f.checkbox_group` verb there is no Control
+heading, so `label:` *is* the per-item accessor (and `item_label:` is accepted as
+an alias). Either way `value:` is the submitted value; `item_label:` wins over
+`label:` for the item text when both are present.
+
 A `role="group"` needs an **accessible name** for assistive tech. The verb has
 no bespoke naming option — HTML/ARIA attributes pass straight through to the
 group, so name it with plain `aria:` (`aria: { label: "Tags" }` for a literal

data/lib/forms/checkbox_group.rb

@@ -8,10 +8,13 @@ module Forms
   # resolved value: of its item against the model's current set.
   #
   #   f.checkbox_group(:tag_ids, Tag.all, value: :id,
-  #     label: ->(t) { t.name.presence || t.slug }, variant: :pill, size: :sm)
+  #     item_label: ->(t) { t.name.presence || t.slug }, variant: :pill, size: :sm)
   #
-  # value:   method or proc -> the submitted value of each item (default :id)
-  # label:   method or proc -> the visible text of each item (default :to_s)
+  # The item value/text accessors (value:/label:/item_label:) live on the BUILDER
+  # (Forms::Field#checkbox_group), which pre-resolves each item to
+  # { value:, label:, checked:, id: } before this leaf renders. This leaf is
+  # presentation-only — it receives the resolved options: array, never the raw
+  # accessors.
   # variant: :stack (default) | :inline | :pill — layout only, zero JS
   # size:    daisyUI checkbox size modifier (:xs :sm :md :lg :xl)
   #

data/lib/forms/field.rb

@@ -112,8 +112,20 @@ module Forms
     #
     #   field.checkbox_group(Tag.all, value: :id, label: ->(t) { t.name })
     #
-    # value:/label: are a method name (Symbol) or a proc taking the item.
-    def checkbox_group(collection, value: :id, label: :to_s, **)
+    # value: is a method name (Symbol) or a proc taking the item -> its submitted
+    # value. The per-item visible text comes from item_label: (Symbol/Proc/String)
+    # if given, else label:; when NEITHER is given each item is labelled by the
+    # first of name/title/label/to_s it responds to (the same LABEL_METHODS chain
+    # Inference uses for association choices) — so a plain
+    # `f.field(:tags, as: :checkbox_group, label: "Tags")` shows readable item
+    # text without an explicit accessor.
+    #
+    # item_label: exists so the `f.field` path can pass a visible group heading as
+    # `label:` (consumed by the Control) AND still customize the per-item text
+    # here — the two no longer collide. item_label: is consumed here; it never
+    # leaks to the group div.
+    def checkbox_group(collection, value: :id, label: nil, item_label: nil, **)
+      text = item_label || label
       # The model's current value is already the raw values (e.g. record.tag_ids
       # => [1, 3]), so compare against them directly — don't re-resolve value:.
       selected = Array(field_value)
@@ -121,7 +133,7 @@ module Forms
         item_value = resolve_item(item, value)
         {
           value: item_value,
-          label: resolve_item(item, label),
+          label: text ? resolve_item(item, text) : infer_item_label(item),
           checked: selected.include?(item_value),
           id: "#{field_id}_#{item_value}"
         }
@@ -256,9 +268,25 @@ module Forms
       validator.options.key?(:if) || validator.options.key?(:unless) || validator.options.key?(:on)
     end
 
-    # value:/label: for checkbox_group: a Proc taking the item, or a method name.
+    # value:/label:/item_label: for checkbox_group. A Proc is called with the
+    # item; a String is literal text (the same for every item — no method
+    # dispatch, so a stray string can't NoMethodError); anything else (a Symbol)
+    # is sent to the item as a method name.
     def resolve_item(item, accessor)
-      accessor.respond_to?(:call) ? accessor.call(item) : item.public_send(accessor)
+      case accessor
+      when Proc   then accessor.call(item)
+      when String then accessor
+      else item.public_send(accessor)
+      end
+    end
+
+    # Default per-item label when no label:/item_label: was given: the first of
+    # name/title/label/to_s the item responds to (mirrors PhlexForms::Inference's
+    # LABEL_METHODS for association choices, so option text is picked the same way
+    # across the gem).
+    def infer_item_label(item)
+      method = PhlexForms::Inference::LABEL_METHODS.find { |m| item.respond_to?(m) }
+      item.public_send(method || :to_s)
     end
 
     def field_attributes

data/lib/phlex_forms/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module PhlexForms
-  VERSION = "0.2.5"
+  VERSION = "0.2.6"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: phlex-forms
 version: !ruby/object:Gem::Version
-  version: 0.2.5
+  version: 0.2.6
 platform: ruby
 authors:
 - Mikael Henriksson