Pass select list options to Rails form builder (#1505)

primer · Oct 18, 2022 · 5d3448b · 5d3448b
1 parent 27be01b
commit 5d3448b
Show file tree

Hide file tree

Showing 5 changed files with 17 additions and 3 deletions.
diff --git a/.changeset/gentle-stingrays-protect.md b/.changeset/gentle-stingrays-protect.md
@@ -0,0 +1,5 @@
+---
+'@primer/view-components': patch
+---
+
+Pass select list options to Rails form builder
diff --git a/app/forms/select_list_form.rb b/app/forms/select_list_form.rb
@@ -3,7 +3,7 @@
 # :nodoc:
 class SelectListForm < ApplicationForm
   form do |check_form|
-    check_form.select_list(name: "cities", label: "Cool cities", caption: "Select your favorite!") do |city_list|
+    check_form.select_list(name: "cities", label: "Cool cities", caption: "Select your favorite!", include_blank: true) do |city_list|
       city_list.option(label: "Lopez Island", value: "lopez_island")
       city_list.option(label: "Bellevue", value: "bellevue")
       city_list.option(label: "Seattle", value: "seattle")

diff --git a/lib/primer/forms/dsl/select_list_input.rb b/lib/primer/forms/dsl/select_list_input.rb
@@ -5,6 +5,8 @@ module Forms
     module Dsl
       # :nodoc:
       class SelectListInput < Input
+        SELECT_ARGUMENTS = %i[multiple disabled include_blank prompt].freeze
+
         # :nodoc:
         class Option
           attr_reader :label, :value, :system_arguments
@@ -16,13 +18,19 @@ def initialize(label:, value:, **system_arguments)
           end
         end
 
-        attr_reader :name, :label, :options
+        attr_reader :name, :label, :options, :select_arguments
 
         def initialize(name:, label:, **system_arguments)
           @name = name
           @label = label
           @options = []
 
+          @select_arguments = {}.tap do |select_args|
+            SELECT_ARGUMENTS.each do |select_arg|
+              select_args[select_arg] = system_arguments.delete(select_arg)
+            end
+          end
+
           super(**system_arguments)
 
           yield(self) if block_given?

diff --git a/lib/primer/forms/select_list.html.erb b/lib/primer/forms/select_list.html.erb
@@ -1,5 +1,5 @@
 <%= render(FormControl.new(input: @input)) do %>
   <%= content_tag(:div, class: @field_wrap_classes) do %>
-    <%= builder.select(@input.name, options, {}, **@input.input_arguments) %>
+    <%= builder.select(@input.name, options, @input.select_arguments, **@input.input_arguments) %>
   <% end %>
 <% end %>
diff --git a/test/primer/forms/forms_test.rb b/test/primer/forms/forms_test.rb
@@ -240,6 +240,7 @@ def test_radio_button_group_form
   def test_select_list_form
     render_preview :select_list_form
 
+    assert_selector ".FormControl-select option[value='']"
     assert_selector ".FormControl-select option[value=lopez_island]"
     assert_selector ".FormControl-select option[value=bellevue]"
     assert_selector ".FormControl-select option[value=seattle]"