stimulus_plumbers 0.3.0 → 0.3.1

data/lib/stimulus_plumbers/form/fields/inputs/select/timezone.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+module StimulusPlumbers
+  module Form
+    module Fields
+      module Inputs
+        module Select
+          module Timezone
+            def time_zone_select(attribute, priority_zones = nil, options = {}, html_options = {})
+              html_native = options.delete(:html_native) { false }
+              Field.new(@template, **options).render(object, attribute, input_id: field_id(attribute)) do |html_opts, opts, error|
+                merged_html_opts = merge_html_options(html_options, html_opts, field_theme(:form_select, error: error))
+                if html_native
+                  super(attribute, priority_zones, opts, merged_html_opts)
+                else
+                  render_select_dropdown(attribute, opts, merged_html_opts, err: error) do
+                    model = opts.delete(:model) { ActiveSupport::TimeZone }
+                    build_zone_choices(priority_zones, model.all)
+                  end
+                end
+              end
+            end
+
+            private
+
+            def build_zone_choices(priority_zones, all_zones)
+              return zone_options(all_zones) unless priority_zones
+
+              priority       = filter_priority_zones(priority_zones, all_zones)
+              priority_names = priority.to_set(&:name)
+              remaining      = all_zones.reject { |z| priority_names.include?(z.name) }
+              [
+                {
+                  label:   I18n.t("helpers.time_zone_select.priority_zones", default: "Suggested"),
+                  options: zone_options(priority)
+                },
+                {
+                  label:   I18n.t("helpers.time_zone_select.other_zones", default: "Other"),
+                  options: zone_options(remaining)
+                }
+              ]
+            end
+
+            def filter_priority_zones(priority_zones, all_zones)
+              case priority_zones
+              when Regexp then all_zones.select { |z| z.name.match?(priority_zones) }
+              else Array(priority_zones)
+              end
+            end
+
+            def zone_options(zones)
+              zones.map { |z| [z.to_s, z.name] }
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/stimulus_plumbers/form/fields/inputs/select/weekday.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module StimulusPlumbers
+  module Form
+    module Fields
+      module Inputs
+        module Select
+          module Weekday
+            if ActionView.version >= Gem::Version.new("7.1")
+              def weekday_select(attribute, options = {}, html_options = {})
+                html_native = options.delete(:html_native) { false }
+                Field.new(@template, **options).render(
+                  object,
+                  attribute,
+                  input_id: field_id(attribute)
+                ) do |html_opts, opts, error|
+                  merged_html_opts = merge_html_options(html_options, html_opts, field_theme(:form_select, error: error))
+                  if html_native
+                    super(attribute, opts, merged_html_opts)
+                  else
+                    render_select_dropdown(attribute, opts, merged_html_opts, err: error) do
+                      build_weekday_choices(opts)
+                    end
+                  end
+                end
+              end
+            end
+
+            private
+
+            def build_weekday_choices(opts)
+              index_as_value    = opts.delete(:index_as_value) { false }
+              day_format        = opts.delete(:day_format) { :day_names }
+              beginning_of_week = opts.delete(:beginning_of_week) { Date.beginning_of_week }
+
+              day_names = I18n.t("date.#{day_format}")
+              choices   = day_names.each_with_index.map { |name, i| index_as_value ? [name, i] : [name, name] }
+              choices.rotate(Date::DAYS_INTO_WEEK.fetch(beginning_of_week))
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/stimulus_plumbers/form/fields/inputs/select.rb

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+module StimulusPlumbers
+  module Form
+    module Fields
+      module Inputs
+        module Select
+          def select(attribute, choices = nil, options = {}, html_options = {})
+            html_native = options.delete(:html_native) { false }
+            Field.new(@template, **options).render(
+              object,
+              attribute,
+              input_id: field_id(attribute)
+            ) do |html_opts, opts, error|
+              merged_html_opts = merge_html_options(html_options, html_opts, field_theme(:form_select, error: error))
+              if html_native
+                super(attribute, choices, opts, merged_html_opts)
+              else
+                render_select_dropdown(attribute, opts, merged_html_opts, err: error) { Array(choices) }
+              end
+            end
+          end
+
+          def collection_select(
+            attribute,
+            collection,
+            value_method,
+            text_method,
+            options = {},
+            html_options = {}
+          )
+            html_native = options.delete(:html_native) { false }
+            Field.new(@template, **options).render(
+              object,
+              attribute,
+              input_id: field_id(attribute)
+            ) do |html_opts, opts, error|
+              merged_html_opts = merge_html_options(html_options, html_opts, field_theme(:form_select, error: error))
+              if html_native
+                super(attribute, collection, value_method, text_method, opts, merged_html_opts)
+              else
+                render_select_dropdown(attribute, opts, merged_html_opts, err: error) do
+                  collection.map { |item| [item.public_send(text_method), item.public_send(value_method)] }
+                end
+              end
+            end
+          end
+
+          private
+
+          def render_select_dropdown(attribute, opts, html_opts, err:)
+            include_blank = opts.delete(:include_blank)
+            prompt        = opts.delete(:prompt)
+            current_value = opts.delete(:selected) { object.respond_to?(attribute) ? object.public_send(attribute) : nil }
+            choices       = build_select_dropdown_choices(yield(current_value), include_blank: include_blank, prompt: prompt)
+
+            combobox_opts = build_select_dropdown_opts(html_opts, current_value)
+            render_combobox(attribute, input_id: html_opts[:id], opts: combobox_opts, err: err) do
+              Components::Combobox::Dropdown.new(@template).render(
+                options:    choices,
+                value:      current_value,
+                labelledby: Field.label_id(html_opts[:id])
+              )
+            end
+          end
+
+          def build_select_dropdown_opts(html_opts, current_value)
+            Components::Combobox::Dropdown.default_opts.deep_merge(
+              input:   { value: current_value },
+              trigger: html_opts
+            )
+          end
+
+          def build_select_dropdown_choices(choices, include_blank:, prompt:)
+            return choices unless include_blank || prompt
+
+            choices = choices.dup
+            choices.unshift([include_blank.is_a?(String) ? include_blank : "", ""]) if include_blank
+            choices.unshift(build_select_dropdown_choice_prompt(prompt)) if prompt
+            choices
+          end
+
+          def build_select_dropdown_choice_prompt(prompt)
+            label = prompt.is_a?(String) ? prompt : I18n.t("helpers.select.prompt", default: "Please select")
+            [label, "", { disabled: true }]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/stimulus_plumbers/form/fields/inputs/submit.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module StimulusPlumbers
+  module Form
+    module Fields
+      module Inputs
+        module Submit
+          def submit(value = nil, options = {})
+            if value.is_a?(Hash)
+              options = value
+              value = nil
+            end
+            value   ||= submit_default_value
+            variant   = options.delete(:variant) { :default }
+            @template.tag.input(
+              type:  "submit",
+              value: value,
+              **merge_html_options(field_theme(:form_submit, variant: variant), options)
+            )
+          end
+        end
+      end
+    end
+  end
+end

data/lib/stimulus_plumbers/form/fields/inputs/text.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module StimulusPlumbers
+  module Form
+    module Fields
+      module Inputs
+        module Text
+          FIELD_TYPES = %i[
+            color_field
+            datetime_local_field
+            email_field
+            month_field
+            number_field
+            range_field
+            telephone_field
+            text_field
+            url_field
+            week_field
+          ].freeze
+
+          FIELD_TYPES.each do |method_name|
+            define_method(method_name) do |attribute, options = {}|
+              Field.new(@template, **options).render(
+                object,
+                attribute,
+                input_id: field_id(attribute)
+              ) do |html_opts, opts, error|
+                html_options = merge_html_options(opts, html_opts, field_theme(:form_input, error: error))
+                super(attribute, html_options)
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/stimulus_plumbers/form/fields/inputs/text_area.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module StimulusPlumbers
+  module Form
+    module Fields
+      module Inputs
+        module TextArea
+          def text_area(attribute, options = {})
+            Field.new(@template, **options).render(
+              object,
+              attribute,
+              input_id: field_id(attribute)
+            ) do |html_opts, opts, error|
+              html_options = merge_html_options(opts, html_opts, field_theme(:form_textarea, error: error))
+              super(attribute, html_options)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/stimulus_plumbers/form/fields/label.rb

@@ -4,16 +4,20 @@ module StimulusPlumbers
   module Form
     module Fields
       class Label < Plumber::Base
-        def render(text:, for_id:, required: false, hidden: false)
-          klass = theme.resolve(:form_label, required: required, hidden: hidden).fetch(:classes, "")
-
-          inner = text.dup.html_safe
-          if required
-            mark_klass = theme.resolve(:form_required_mark).fetch(:classes, "")
-            inner += template.content_tag(:span, "*", "aria-hidden": "true", class: mark_klass.presence)
+        def render(text:, for_id: nil, id: nil, required: false, hidden: false, tag: :label)
+          mark_options = required && merge_html_options(
+            { aria: { hidden: true } },
+            theme.resolve(:form_required_mark)
+          )
+          html_options = merge_html_options(theme.resolve(:form_label, required: required, hidden: hidden))
+          template.content_tag(tag, for: for_id, id: id, **html_options) do
+            template.safe_join(
+              [
+                text,
+                mark_options ? template.content_tag(:span, "*", **mark_options) : nil
+              ]
+            )
           end
-
-          template.content_tag(:label, inner, for: for_id, class: klass.presence)
         end
       end
     end

data/lib/stimulus_plumbers/helpers/calendar_helper.rb

@@ -5,7 +5,7 @@ module StimulusPlumbers
     module CalendarHelper
       def sp_calendar_month(date: nil, **html_options, &block)
         if date
-          html_options.deep_merge!(
+          html_options = html_options.deep_merge(
             data: {
               "calendar-month-year-value":  date.year,
               "calendar-month-month-value": date.month - 1,

data/lib/stimulus_plumbers/helpers/combobox_helper.rb

@@ -4,70 +4,63 @@ module StimulusPlumbers
   module Helpers
     module ComboboxHelper
       def sp_combobox_date(label: nil, value: nil, **html_options)
+        id   = sp_dom_id
         opts = Components::Combobox::Date.default_opts.deep_merge(
           input:   { value: value },
-          popover: { content: Components::Combobox::Date.new(self).render(value: value) }
+          trigger: { id: id, aria_label: label }.compact
         )
-        opts = opts.deep_merge(trigger: { aria_label: label }) if label
         Components::Combobox.new(self).render(
-          base_id: sp_dom_id,
-          options: opts,
-          data:    { input_format_type_value: "date" },
+          **opts,
+          data: { input_format_type_value: "date" },
           **html_options
-        )
+        ) do |popover_id|
+          Components::Combobox::Date.new(self).render(value: value, popover_id: popover_id)
+        end
       end
 
       def sp_combobox_dropdown(label: nil, options: [], value: nil, **html_options)
+        id   = sp_dom_id
         opts = Components::Combobox::Dropdown.default_opts.deep_merge(
           input:   { value: value },
-          popover: { content: Components::Combobox::Dropdown.new(self).render(options: options, value: value, label: label) }
-        )
-        opts = opts.deep_merge(trigger: { aria_label: label }) if label
-        Components::Combobox.new(self).render(
-          base_id: sp_dom_id,
-          options: opts,
-          **html_options
+          trigger: { id: id, aria_label: label }.compact
         )
+        Components::Combobox.new(self).render(**opts, **html_options) do
+          Components::Combobox::Dropdown.new(self).render(options: options, value: value, label: label)
+        end
       end
 
       def sp_combobox_autocomplete(label: nil, options: [], value: nil, url: nil, **html_options)
-        id         = sp_dom_id
-        popover_id = "#{id}_popover"
-        opts       = Components::Combobox::Autocomplete.default_opts.deep_merge(
+        id   = sp_dom_id
+        opts = Components::Combobox::Autocomplete.default_opts.deep_merge(
           input:   { value: value },
-          popover: {
-            content: Components::Combobox::Autocomplete.new(self).render(
-              options: options,
-              value:   value,
-              label:   label
-            ),
-            data:    url ? { combobox_dropdown_url_value: url } : {}
-          }
+          trigger: { id: id, aria_label: label }.compact,
+          popover: { data: url ? { combobox_dropdown_url_value: url } : {} }
         )
-        opts = opts.deep_merge(trigger: { aria_label: label }) if label
         Components::Combobox.new(self).render(
-          base_id: id,
-          options: opts,
-          data:    {
-            input_combobox_combobox_dropdown_outlet: "##{popover_id}",
+          **opts,
+          data: {
+            input_combobox_combobox_dropdown_outlet: "##{Components::Combobox.popover_id_for(id)}",
             action:                                  "input->input-combobox#onInput"
           },
           **html_options
-        )
+        ) do
+          Components::Combobox::Autocomplete.new(self).render(options: options, value: value, label: label)
+        end
       end
 
       def sp_combobox_time(format: :h12, label: nil, step: 1, value: nil, **html_options)
+        id   = sp_dom_id
         opts = Components::Combobox::Time.default_opts.deep_merge(
           input:   { value: value },
-          popover: { content: Components::Combobox::Time.new(self).render(format: format, step: step, value: value) }
+          trigger: { id: id, aria_label: label }.compact
         )
-        opts = opts.deep_merge(trigger: { aria_label: label }) if label
         Components::Combobox.new(self).render(
-          base_id: sp_dom_id,
-          options: opts,
-          data:    { input_format_type_value: "time", input_format_options_value: { format: format }.to_json },
+          **opts,
+          data: { input_format_type_value: "time", input_format_options_value: { format: format }.to_json },
           **html_options
-        )
+        ) do
+          Components::Combobox::Time.new(self).render(format: format, step: step, value: value)
+        end
       end
     end
   end

data/lib/stimulus_plumbers/helpers/divider_helper.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module StimulusPlumbers
+  module Helpers
+    module DividerHelper
+      def sp_divider(**html_options)
+        Components::Divider.new(self).render(**html_options)
+      end
+    end
+  end
+end

data/lib/stimulus_plumbers/helpers.rb

@@ -8,6 +8,7 @@ require_relative "helpers/calendar_helper"
 require_relative "helpers/calendar_turbo_helper"
 require_relative "helpers/card_helper"
 require_relative "helpers/combobox_helper"
+require_relative "helpers/divider_helper"
 require_relative "helpers/popover_helper"
 
 module StimulusPlumbers
@@ -20,6 +21,7 @@ module StimulusPlumbers
     include CalendarTurboHelper
     include CardHelper
     include ComboboxHelper
+    include DividerHelper
     include PopoverHelper
   end
 end

data/lib/stimulus_plumbers/themes/base.rb

@@ -13,6 +13,7 @@ module StimulusPlumbers
         **Schema::CARD,
         **Schema::COMBOBOX,
         **Schema::FORM,
+        **Schema::ICON,
         **Schema::LAYOUT
       }.freeze
 

data/lib/stimulus_plumbers/themes/schema.rb

@@ -87,13 +87,19 @@ module StimulusPlumbers
         form_radio:         { error: { default: false, range: Ranges::BOOL } }.freeze,
         form_input_group:   { error: { default: false, range: Ranges::BOOL } }.freeze,
         form_combobox:      { error: { default: false, range: Ranges::BOOL } }.freeze,
-        form_input_reveal:  {}.freeze,
+        form_input_reveal:  { error: { default: false, range: Ranges::BOOL } }.freeze,
+        form_input_search:  {}.freeze,
         form_button_reveal: {}.freeze,
+        form_button_clear:  {}.freeze,
         form_submit:        {
           variant: { default: :default, range: Form::Ranges::SUBMIT_VARIANT }
         }.freeze
       }.freeze
 
+      ICON = {
+        icon: {}.freeze
+      }.freeze
+
       LAYOUT = {
         divider: {}.freeze,
         popover: {}.freeze

data/lib/stimulus_plumbers/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module StimulusPlumbers
-  VERSION = "0.3.0"
+  VERSION = "0.3.1"
 end

data/lib/stimulus_plumbers.rb

@@ -26,6 +26,7 @@ require_relative "stimulus_plumbers/components/card/section"
 require_relative "stimulus_plumbers/components/action_list"
 require_relative "stimulus_plumbers/components/action_list/section"
 require_relative "stimulus_plumbers/components/action_list/item"
+require_relative "stimulus_plumbers/components/divider"
 require_relative "stimulus_plumbers/components/popover"
 require_relative "stimulus_plumbers/components/popover/builder"
 
@@ -54,10 +55,11 @@ require_relative "stimulus_plumbers/components/combobox/time/drum"
 
 # -- Form --
 require_relative "stimulus_plumbers/form/field"
+require_relative "stimulus_plumbers/form/fields/error"
 require_relative "stimulus_plumbers/form/fields/group"
-require_relative "stimulus_plumbers/form/fields/label"
 require_relative "stimulus_plumbers/form/fields/hint"
-require_relative "stimulus_plumbers/form/fields/error"
+require_relative "stimulus_plumbers/form/fields/input_group"
+require_relative "stimulus_plumbers/form/fields/label"
 require_relative "stimulus_plumbers/form/builder"
 
 module StimulusPlumbers

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: stimulus_plumbers
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Ryan Chang
@@ -69,6 +69,7 @@ files:
 - lib/stimulus_plumbers/components/combobox/trigger.rb
 - lib/stimulus_plumbers/components/date_picker/navigation.rb
 - lib/stimulus_plumbers/components/date_picker/navigator.rb
+- lib/stimulus_plumbers/components/divider.rb
 - lib/stimulus_plumbers/components/icon.rb
 - lib/stimulus_plumbers/components/popover.rb
 - lib/stimulus_plumbers/components/popover/builder.rb
@@ -76,20 +77,24 @@ files:
 - lib/stimulus_plumbers/engine.rb
 - lib/stimulus_plumbers/form/builder.rb
 - lib/stimulus_plumbers/form/field.rb
-- lib/stimulus_plumbers/form/fields/choice.rb
-- lib/stimulus_plumbers/form/fields/combobox.rb
 - lib/stimulus_plumbers/form/fields/error.rb
-- lib/stimulus_plumbers/form/fields/file.rb
+- lib/stimulus_plumbers/form/fields/fieldset.rb
 - lib/stimulus_plumbers/form/fields/group.rb
 - lib/stimulus_plumbers/form/fields/hint.rb
+- lib/stimulus_plumbers/form/fields/input_group.rb
+- lib/stimulus_plumbers/form/fields/inputs/choice.rb
+- lib/stimulus_plumbers/form/fields/inputs/datetime.rb
+- lib/stimulus_plumbers/form/fields/inputs/file.rb
+- lib/stimulus_plumbers/form/fields/inputs/password.rb
+- lib/stimulus_plumbers/form/fields/inputs/search.rb
+- lib/stimulus_plumbers/form/fields/inputs/select.rb
+- lib/stimulus_plumbers/form/fields/inputs/select/grouped.rb
+- lib/stimulus_plumbers/form/fields/inputs/select/timezone.rb
+- lib/stimulus_plumbers/form/fields/inputs/select/weekday.rb
+- lib/stimulus_plumbers/form/fields/inputs/submit.rb
+- lib/stimulus_plumbers/form/fields/inputs/text.rb
+- lib/stimulus_plumbers/form/fields/inputs/text_area.rb
 - lib/stimulus_plumbers/form/fields/label.rb
-- lib/stimulus_plumbers/form/fields/password.rb
-- lib/stimulus_plumbers/form/fields/renderer.rb
-- lib/stimulus_plumbers/form/fields/search.rb
-- lib/stimulus_plumbers/form/fields/select.rb
-- lib/stimulus_plumbers/form/fields/submit.rb
-- lib/stimulus_plumbers/form/fields/text.rb
-- lib/stimulus_plumbers/form/fields/text_area.rb
 - lib/stimulus_plumbers/helpers.rb
 - lib/stimulus_plumbers/helpers/action_list_helper.rb
 - lib/stimulus_plumbers/helpers/avatar_helper.rb
@@ -98,6 +103,7 @@ files:
 - lib/stimulus_plumbers/helpers/calendar_turbo_helper.rb
 - lib/stimulus_plumbers/helpers/card_helper.rb
 - lib/stimulus_plumbers/helpers/combobox_helper.rb
+- lib/stimulus_plumbers/helpers/divider_helper.rb
 - lib/stimulus_plumbers/helpers/plumber_helper.rb
 - lib/stimulus_plumbers/helpers/popover_helper.rb
 - lib/stimulus_plumbers/logger.rb

data/lib/stimulus_plumbers/form/fields/choice.rb

@@ -1,25 +0,0 @@
-# frozen_string_literal: true
-
-module StimulusPlumbers
-  module Form
-    module Fields
-      module Choice
-        def check_box(attribute, options = {}, checked_value = "1", unchecked_value = "0")
-          rails_opts, form_field_opts = extract_options(options)
-          form_field_opts[:layout] ||= :inline
-          field     = build_field(attribute, form_field_opts)
-          html_opts = merge_html_options(rails_opts, field_theme(:form_checkbox, error: field.error?), field.html_opts)
-          render_field(field, super(attribute, html_opts, checked_value, unchecked_value))
-        end
-
-        def radio_button(attribute, tag_value, options = {})
-          rails_opts, form_field_opts = extract_options(options)
-          form_field_opts[:layout] ||= :inline
-          field     = build_field(attribute, form_field_opts, input_id: field_id(attribute, tag_value))
-          html_opts = merge_html_options(rails_opts, field_theme(:form_radio, error: field.error?), field.html_opts)
-          render_field(field, super(attribute, tag_value, html_opts))
-        end
-      end
-    end
-  end
-end

data/lib/stimulus_plumbers/form/fields/combobox.rb

@@ -1,44 +0,0 @@
-# frozen_string_literal: true
-
-module StimulusPlumbers
-  module Form
-    module Fields
-      module Combobox
-        COMPONENT_CLASS = {
-          autocomplete: Components::Combobox::Autocomplete,
-          date:         Components::Combobox::Date,
-          dropdown:     Components::Combobox::Dropdown,
-          time:         Components::Combobox::Time
-        }.freeze
-
-        def combobox_field(attribute, type:, options: [], **html_options)
-          klass = COMPONENT_CLASS.fetch(type) do
-            raise ArgumentError,
-                  "unsupported combobox type #{type.inspect}. Must be one of: #{COMPONENT_CLASS.keys.join(", ")}"
-          end
-
-          rails_opts, field_opts = extract_options(html_options)
-          field         = build_field(attribute, field_opts)
-          current_value = object&.public_send(attribute)
-
-          wrapper = build_combobox_wrapper(klass, attribute, field, current_value, options, rails_opts)
-          render_field(field, wrapper)
-        end
-
-        def build_combobox_wrapper(klass, attribute, field, current_value, options, rails_opts)
-          popover = klass.new(@template).render(options: options, value: current_value, **rails_opts)
-          opts    = klass.default_opts.deep_merge(
-            input:   { name: field_name(attribute), value: current_value },
-            popover: { content: popover }
-          )
-          Components::Combobox.new(@template).render(
-            base_id: field_id(attribute),
-            options: opts,
-            **field_theme(:form_combobox, error: field.error?),
-            **field.html_opts
-          )
-        end
-      end
-    end
-  end
-end

data/lib/stimulus_plumbers/form/fields/file.rb

@@ -1,16 +0,0 @@
-# frozen_string_literal: true
-
-module StimulusPlumbers
-  module Form
-    module Fields
-      module File
-        def file_field(attribute, options = {})
-          rails_opts, form_field_opts = extract_options(options)
-          field     = build_field(attribute, form_field_opts)
-          html_opts = merge_html_options(rails_opts, field_theme(:form_file, error: field.error?), field.html_opts)
-          render_field(field, super(attribute, html_opts))
-        end
-      end
-    end
-  end
-end