hotwire_combobox 0.3.1 → 0.4.0

data/app/presenters/hotwire_combobox/component/markup/hidden_field.rb

@@ -0,0 +1,28 @@
+module HotwireCombobox::Component::Markup::HiddenField
+  def hidden_field_attrs
+    customize :hidden_field, base: {
+      id: hidden_field_id, name: hidden_field_name, value: hidden_field_value,
+      data: { hw_combobox_target: "hiddenField" } }
+  end
+
+  private
+    def hidden_field_id
+      "#{canonical_id}-hw-hidden-field"
+    end
+
+    def hidden_field_name
+      form&.field_name(name) || name
+    end
+
+    def hidden_field_value
+      return value if value
+
+      if form_object&.try(:defined_enums)&.try(:[], name)
+        form_object.public_send "#{name}_before_type_cast"
+      else
+        form_object&.try(name).then do |value|
+          value.respond_to?(:map) ? value.join(",") : value
+        end
+      end
+    end
+end

data/app/presenters/hotwire_combobox/component/markup/input.rb

@@ -0,0 +1,44 @@
+module HotwireCombobox::Component::Markup::Input
+  def input_attrs
+    customize :input, base: {
+      id: input_id, role: :combobox, type: input_type,
+      class: "hw-combobox__input", autocomplete: :off,
+      data: input_data, aria: input_aria
+    }.merge(combobox_attrs.except(:data, :aria))
+  end
+
+  private
+    def input_id
+      canonical_id
+    end
+
+    def input_type
+      combobox_attrs[:type].to_s.presence_in(%w[ text search ]) || "text"
+    end
+
+    def input_data
+      data = combobox_attrs.fetch(:data, {}).dup
+      action = %w[
+        click->hw-combobox#toggle
+        keydown->hw-combobox#prepareToFilter
+        input->hw-combobox#filterAndSelect
+        keydown->hw-combobox#navigate
+        click@window->hw-combobox#closeOnClickOutside
+        focusin@window->hw-combobox#closeOnFocusOutside
+        turbo:before-stream-render@document->hw-combobox#rerouteListboxStreamToDialog
+        turbo:before-cache@document->hw-combobox#hideChipsForCache
+        turbo:morph-element->hw-combobox#idempotentConnect
+      ].append(data.delete(:action)).compact.join(" ")
+
+      data.merge action: action, hw_combobox_target: "combobox", async_id: canonical_id
+    end
+
+    def input_aria
+      combobox_attrs.fetch(:aria, {}).merge \
+        controls: listbox_id,
+        owns: listbox_id,
+        haspopup: "listbox",
+        autocomplete: autocomplete,
+        activedescendant: ""
+    end
+end

data/app/presenters/hotwire_combobox/component/markup/label.rb

@@ -0,0 +1,5 @@
+module HotwireCombobox::Component::Markup::Label
+  def label_attrs
+    customize :label, base: { class: "hw-combobox__label", for: input_id, hidden: label.blank? }
+  end
+end

data/app/presenters/hotwire_combobox/component/markup/listbox.rb

@@ -0,0 +1,14 @@
+module HotwireCombobox::Component::Markup::Listbox
+  def listbox_attrs
+    customize :listbox, base: {
+      id: listbox_id, role: :listbox, hidden: "",
+      class: "hw-combobox__listbox",
+      data: { hw_combobox_target: "listbox" },
+      aria: { multiselectable: multiselect? } }
+  end
+
+  private
+    def listbox_id
+      "#{canonical_id}-hw-listbox"
+    end
+end

data/app/presenters/hotwire_combobox/component/markup/wrapper.rb

@@ -0,0 +1,7 @@
+module HotwireCombobox::Component::Markup::Wrapper
+  def main_wrapper_attrs
+    customize :main_wrapper, base: {
+      class: "hw-combobox__main__wrapper",
+      data: { action: ("click->hw-combobox#open:self" if multiselect?), hw_combobox_target: "mainWrapper" } }
+  end
+end

data/app/presenters/hotwire_combobox/component/multiselect.rb

@@ -0,0 +1,6 @@
+module HotwireCombobox::Component::Multiselect
+  private
+    def multiselect?
+      multiselect_chip_src.present?
+    end
+end

data/app/presenters/hotwire_combobox/component/paginated.rb

@@ -0,0 +1,18 @@
+module HotwireCombobox::Component::Paginated
+  def paginated?
+    async_src.present?
+  end
+
+  def pagination_attrs
+    { for_id: canonical_id, src: async_src, loading: preload_next_page? ? :eager : :lazy }
+  end
+
+  private
+    def preload_next_page?
+      view.hw_first_page? && preload?
+    end
+
+    def preload?
+      preload.present?
+    end
+end

data/app/presenters/hotwire_combobox/component.rb

@@ -1,36 +1,38 @@
 require "securerandom"
 
 class HotwireCombobox::Component
-  include Customizable
-  include ActiveModel::Validations
+  include Announced, Associations, Async, Customizable, Freetext, Multiselect, Paginated
 
-  attr_reader :options, :label
+  # Markup modules depend on Customizable
+  include Markup::Dialog, Markup::Fieldset, Markup::Form, Markup::Handle,
+    Markup::HiddenField, Markup::Input, Markup::Label, Markup::Listbox, Markup::Wrapper
 
-  validate :name_when_new_on_multiselect_must_match_original_name
+  attr_reader :options, :label
 
-  def initialize \
-        view, name,
-        association_name:     nil,
-        async_src:            nil,
-        autocomplete:         :both,
-        data:                 {},
-        dialog_label:         nil,
-        form:                 nil,
-        free_text:            false,
-        id:                   nil,
-        input:                {},
-        label:                nil,
-        mobile_at:            "640px",
-        multiselect_chip_src: nil,
-        name_when_new:        nil,
-        open:                 false,
-        options:              [],
-        value:                nil,
-        **rest
-    @view, @autocomplete, @id, @name, @value, @form, @async_src, @label, @free_text,
-    @name_when_new, @open, @data, @mobile_at, @multiselect_chip_src, @options, @dialog_label =
-      view, autocomplete, id, name.to_s, value, form, async_src, label, free_text,
-      name_when_new, open, data, mobile_at, multiselect_chip_src, options, dialog_label
+  def initialize(
+    view, name,
+    association_name: nil,
+    async_src: nil,
+    autocomplete: :both,
+    data: {},
+    dialog_label: nil,
+    form: nil,
+    free_text: false,
+    id: nil,
+    input: {},
+    label: nil,
+    mobile_at: "640px",
+    multiselect_chip_src: nil,
+    name_when_new: nil,
+    open: false,
+    options: [],
+    preload: false,
+    request: nil,
+    value: nil, **rest)
+    @view, @autocomplete, @id, @name, @value, @form, @async_src, @label, @free_text, @request,
+    @preload, @name_when_new, @open, @data, @mobile_at, @multiselect_chip_src, @options, @dialog_label =
+      view, autocomplete, id, name.to_s, value, form, async_src, label, free_text, request,
+      preload, name_when_new, open, data, mobile_at, multiselect_chip_src, options, dialog_label
 
     @combobox_attrs = input.reverse_merge(rest).deep_symbolize_keys
     @association_name = association_name || infer_association_name
@@ -40,382 +42,14 @@ class HotwireCombobox::Component
 
   def render_in(view_context, &block)
     block.call(self) if block_given?
-    view_context.render partial: "hotwire_combobox/component", locals: { component: self }
-  end
-
-
-  def fieldset_attrs
-    apply_customizations_to :fieldset, base: {
-      class: [ "hw-combobox", { "hw-combobox--multiple": multiselect? } ],
-      data: fieldset_data
-    }
-  end
-
-
-  def label_attrs
-    apply_customizations_to :label, base: {
-      class: "hw-combobox__label",
-      for: input_id,
-      hidden: label.blank?
-    }
-  end
-
-
-  def hidden_field_attrs
-    apply_customizations_to :hidden_field, base: {
-      id: hidden_field_id,
-      name: hidden_field_name,
-      data: hidden_field_data,
-      value: hidden_field_value
-    }
-  end
-
-
-  def main_wrapper_attrs
-    apply_customizations_to :main_wrapper, base: {
-      class: "hw-combobox__main__wrapper",
-      data: main_wrapper_data
-    }
-  end
-
-
-  def announcer_attrs
-    {
-      class: "hw-combobox__announcer",
-      aria: announcer_aria,
-      data: announcer_data
-    }
-  end
-
-
-  def input_attrs
-    nested_attrs = %i[ data aria ]
-
-    base = {
-      id: input_id,
-      role: :combobox,
-      class: "hw-combobox__input",
-      type: input_type,
-      data: input_data,
-      aria: input_aria,
-      autocomplete: :off
-    }.merge combobox_attrs.except(*nested_attrs)
-
-    apply_customizations_to :input, base: base
-  end
-
-
-  def handle_attrs
-    apply_customizations_to :handle, base: {
-      class: "hw-combobox__handle",
-      data: handle_data
-    }
-  end
-
-
-  def listbox_attrs
-    apply_customizations_to :listbox, base: {
-      id: listbox_id,
-      role: :listbox,
-      class: "hw-combobox__listbox",
-      hidden: "",
-      data: listbox_data,
-      aria: listbox_aria
-    }
-  end
-
-
-  def dialog_wrapper_attrs
-    apply_customizations_to :dialog_wrapper, base: {
-      class: "hw-combobox__dialog__wrapper"
-    }
-  end
-
-  def dialog_attrs
-    apply_customizations_to :dialog, base: {
-      class: "hw-combobox__dialog",
-      role: :dialog,
-      data: dialog_data
-    }
-  end
-
-  def dialog_label
-    @dialog_label || label
-  end
-
-  def dialog_label_attrs
-    apply_customizations_to :dialog_label, base: {
-      class: "hw-combobox__dialog__label",
-      for: dialog_input_id
-    }
-  end
-
-  def dialog_input_attrs
-    apply_customizations_to :dialog_input, base: {
-      id: dialog_input_id,
-      role: :combobox,
-      class: "hw-combobox__dialog__input",
-      autofocus: "",
-      type: input_type,
-      data: dialog_input_data,
-      aria: dialog_input_aria
-    }
-  end
-
-  def dialog_listbox_attrs
-    apply_customizations_to :dialog_listbox, base: {
-      id: dialog_listbox_id,
-      class: "hw-combobox__dialog__listbox",
-      role: :listbox,
-      data: dialog_listbox_data,
-      aria: dialog_listbox_aria
-    }
-  end
-
-  def dialog_focus_trap_attrs
-    {
-      tabindex: "-1",
-      data: dialog_focus_trap_data
-    }
-  end
-
-
-  def paginated?
-    async_src.present?
-  end
-
-  def pagination_attrs
-    { for_id: canonical_id, src: async_src }
+    view_context.render partial: "hotwire_combobox/component", locals: { component: self }, formats: [ :html ]
   end
 
   private
-    attr_reader :view, :autocomplete, :id, :name, :value, :form,
-      :free_text, :open, :data, :combobox_attrs, :mobile_at,
-      :association_name, :multiselect_chip_src
-
-    def name_when_new
-      if free_text && @name_when_new.blank?
-        hidden_field_name
-      else
-        @name_when_new
-      end
-    end
-
-    def name_when_new_on_multiselect_must_match_original_name
-      return unless multiselect? && name_when_new.present?
-
-      unless name_when_new.to_s == hidden_field_name
-        errors.add :name_when_new, :must_match_original_name,
-          message: "must match the regular name ('#{hidden_field_name}', in this case) on multiselect comboboxes."
-      end
-    end
-
-    def multiselect?
-      multiselect_chip_src.present?
-    end
-
-    def infer_association_name
-      if name.end_with?("_id")
-        name.sub(/_id\z/, "")
-      end
-    end
-
-    def fieldset_data
-      data.merge \
-        async_id: canonical_id,
-        controller: view.token_list("hw-combobox", data[:controller]),
-        hw_combobox_expanded_value: open,
-        hw_combobox_name_when_new_value: name_when_new,
-        hw_combobox_original_name_value: hidden_field_name,
-        hw_combobox_autocomplete_value: autocomplete,
-        hw_combobox_small_viewport_max_width_value: mobile_at,
-        hw_combobox_async_src_value: async_src,
-        hw_combobox_prefilled_display_value: prefilled_display,
-        hw_combobox_selection_chip_src_value: multiselect_chip_src,
-        hw_combobox_filterable_attribute_value: "data-filterable-as",
-        hw_combobox_autocompletable_attribute_value: "data-autocompletable-as",
-        hw_combobox_selected_class: "hw-combobox__option--selected",
-        hw_combobox_invalid_class: "hw-combobox__input--invalid"
-    end
-
-    def prefilled_display
-      return if multiselect? || !hidden_field_value
-
-      if async_src && associated_object
-        associated_object.to_combobox_display
-      elsif async_src && form_object&.respond_to?(name)
-        form_object.public_send name
-      else
-        options.find_by_value(hidden_field_value)&.autocompletable_as
-      end
-    end
-
-    def associated_object
-      @associated_object ||= if association_exists?
-        form_object&.public_send association_name
-      end
-    end
-
-    def association_exists?
-      association_name && form_object&.respond_to?(association_name)
-    end
-
-    def form_object
-      form&.object
-    end
-
-    def async_src
-      view.hw_uri_with_params @async_src, for_id: canonical_id, format: :turbo_stream
-    end
-
+    attr_reader :view, :autocomplete, :id, :name, :value, :form, :free_text, :open, :request,
+      :data, :combobox_attrs, :mobile_at, :association_name, :multiselect_chip_src, :preload
 
     def canonical_id
       @canonical_id ||= id || form&.field_id(name) || SecureRandom.uuid
     end
-
-
-    def main_wrapper_data
-      {
-        action: ("click->hw-combobox#openByFocusing:self" if multiselect?),
-        hw_combobox_target: "mainWrapper"
-      }
-    end
-
-
-    def announcer_aria
-      {
-        live: :polite,
-        atomic: true
-      }
-    end
-
-    def announcer_data
-      { hw_combobox_target: "announcer" }
-    end
-
-
-    def hidden_field_id
-      "#{canonical_id}-hw-hidden-field"
-    end
-
-    def hidden_field_name
-      form&.field_name(name) || name
-    end
-
-    def hidden_field_data
-      { hw_combobox_target: "hiddenField" }
-    end
-
-    def hidden_field_value
-      return value if value
-
-      if form_object&.try(:defined_enums)&.try(:[], name)
-        form_object.public_send "#{name}_before_type_cast"
-      else
-        form_object&.try(name).then do |value|
-          value.respond_to?(:map) ? value.join(",") : value
-        end
-      end
-    end
-
-
-    def input_id
-      canonical_id
-    end
-
-    def input_type
-      combobox_attrs[:type].to_s.presence_in(%w[ text search ]) || "text"
-    end
-
-    def input_data
-      combobox_attrs.fetch(:data, {}).merge \
-        action: "
-          focus->hw-combobox#open
-          input->hw-combobox#filterAndSelect
-          keydown->hw-combobox#navigate
-          click@window->hw-combobox#closeOnClickOutside
-          focusin@window->hw-combobox#closeOnFocusOutside
-          turbo:before-stream-render@document->hw-combobox#rerouteListboxStreamToDialog
-          turbo:before-cache@document->hw-combobox#hideChipsForCache
-          turbo:morph-element->hw-combobox#idempotentConnect".squish,
-        hw_combobox_target: "combobox",
-        async_id: canonical_id
-    end
-
-    def input_aria
-      combobox_attrs.fetch(:aria, {}).merge \
-        controls: listbox_id,
-        owns: listbox_id,
-        haspopup: "listbox",
-        autocomplete: autocomplete,
-        activedescendant: ""
-    end
-
-
-    def handle_data
-      {
-        action: "click->hw-combobox#clearOrToggleOnHandleClick",
-        hw_combobox_target: "handle"
-      }
-    end
-
-
-    def listbox_id
-      "#{canonical_id}-hw-listbox"
-    end
-
-    def listbox_data
-      { hw_combobox_target: "listbox" }
-    end
-
-    def listbox_aria
-      { multiselectable: multiselect? }
-    end
-
-
-    def dialog_data
-      {
-        action: "keydown->hw-combobox#navigate",
-        hw_combobox_target: "dialog"
-      }
-    end
-
-    def dialog_input_id
-      "#{canonical_id}-hw-dialog-combobox"
-    end
-
-    def dialog_input_data
-      {
-        action: "
-          input->hw-combobox#filterAndSelect
-          keydown->hw-combobox#navigate
-          click@window->hw-combobox#closeOnClickOutside".squish,
-        hw_combobox_target: "dialogCombobox"
-      }
-    end
-
-    def dialog_input_aria
-      {
-        controls: dialog_listbox_id,
-        owns: dialog_listbox_id,
-        autocomplete: autocomplete,
-        activedescendant: ""
-      }
-    end
-
-    def dialog_listbox_id
-      "#{canonical_id}-hw-dialog-listbox"
-    end
-
-    def dialog_listbox_data
-      { hw_combobox_target: "dialogListbox" }
-    end
-
-    def dialog_listbox_aria
-      { multiselectable: multiselect? }
-    end
-
-    def dialog_focus_trap_data
-      { hw_combobox_target: "dialogFocusTrap" }
-    end
 end

data/app/presenters/hotwire_combobox/listbox/group.rb

@@ -9,7 +9,7 @@ class HotwireCombobox::Listbox::Group
   end
 
   def render_in(view)
-    view.tag.ul **group_attrs do
+    view.tag.ul(**group_attrs) do
       view.concat view.tag.li(name, **label_attrs)
 
       options.map do |option|
@@ -26,22 +26,10 @@ class HotwireCombobox::Listbox::Group
     end
 
     def group_attrs
-      {
-        class: "hw-combobox__group",
-        role: :group,
-        aria: group_aria
-      }
-    end
-
-    def group_aria
-      { labelledby: id }
+      { class: "hw-combobox__group", role: :group, aria: { labelledby: id } }
     end
 
     def label_attrs
-      {
-        id: id,
-        class: "hw-combobox__group__label",
-        role: :presentation
-      }
+      { id: id, class: "hw-combobox__group__label", role: :presentation }
     end
 end

data/app/presenters/hotwire_combobox/listbox/item.rb

@@ -6,11 +6,8 @@ class HotwireCombobox::Listbox::Item
   end
 
   def initialize(view, options, render_in:, include_blank:, **custom_methods)
-    @view = view
-    @options = options
-    @render_in = render_in
-    @include_blank = include_blank
-    @custom_methods = custom_methods
+    @view, @options, @render_in, @include_blank, @custom_methods =
+      view, options, render_in, include_blank, custom_methods
   end
 
   def collection
@@ -37,8 +34,7 @@ class HotwireCombobox::Listbox::Item
 
     def create_listbox_group(options)
       options.map do |group_name, group_options|
-        HotwireCombobox::Listbox::Group.new group_name,
-          options: create_listbox_options(group_options)
+        HotwireCombobox::Listbox::Group.new group_name, options: create_listbox_options(group_options)
       end
     end
 
@@ -47,7 +43,7 @@ class HotwireCombobox::Listbox::Item
         options
       else
         options.map do |option|
-          HotwireCombobox::Listbox::Option.new **option_attrs(option)
+          HotwireCombobox::Listbox::Option.new(**option_attrs(option))
         end
       end
     end
@@ -86,9 +82,7 @@ class HotwireCombobox::Listbox::Item
     end
 
     def render_content(render_opts: render_in, object:, attrs:)
-      view.render **render_opts.reverse_merge(
-        object: object,
-        locals: { combobox_display: attrs[:display], combobox_value: attrs[:value] })
+      view.render(**render_opts.reverse_merge(object: object, locals: { combobox_display: attrs[:display], combobox_value: attrs[:value] }))
     end
 
     def blank_option
@@ -100,7 +94,6 @@ class HotwireCombobox::Listbox::Item
       case include_blank
       when Hash
         text = include_blank.delete(:text)
-
         [ text, render_content(render_opts: include_blank, object: text, attrs: { display: text, value: "" }) ]
       when String
         [ include_blank, include_blank ]