Merge pull request #3824 from dbwinger/feature/select-editor-allow-clear

Add allow_clear support and required attribute to SelectEditor

Author: tvdeyen

app/components/alchemy/ingredients/select_editor.rb

@@ -20,18 +20,23 @@ def input_field
             options_for_select(select_values, value)
           end
           select_tag form_field_name, options_tags, {
+            include_blank: allow_clear?,
             id: form_field_id,
             class: ["ingredient-editor-select"],
             is: "alchemy-select",
+            required: presence_validation?,
             multiple: settings[:multiple],
-            disabled: !editable?
+            disabled: !editable?,
+            data: allow_clear? ? {"allow-clear": true} : {}
           }
         end
       end
 
       private
 
       def select_values = settings[:select_values]
+
+      def allow_clear? = settings[:allow_clear]
     end
   end
 end

app/models/alchemy/ingredients/select.rb

@@ -5,8 +5,7 @@ module Ingredients
     # A text value from a select box
     #
     class Select < Alchemy::Ingredient
-      allow_settings %i[display_inline select_values]
-      allow_settings %i[display_inline select_values multiple]
+      allow_settings %i[allow_clear display_inline select_values multiple]
 
       serialize :value, coder: JSON
 

spec/components/alchemy/ingredients/select_editor_spec.rb

@@ -98,4 +98,53 @@
       is_expected.not_to have_css("select[multiple]")
     end
   end
+
+  context "with allow_clear enabled" do
+    before do
+      expect(ingredient).to receive(:settings).at_least(:once) do
+        {
+          allow_clear: true,
+          select_values: ["handhelds", "fridges", "watches"]
+        }
+      end
+    end
+
+    it "renders a select box with a blank option" do
+      is_expected.to have_css("select option[value='']", visible: :all)
+    end
+
+    it "renders a select box with data-allow-clear attribute" do
+      is_expected.to have_css("select[data-allow-clear]")
+    end
+  end
+
+  context "without allow_clear" do
+    before do
+      expect(ingredient).to receive(:settings).at_least(:once) do
+        {
+          select_values: ["handhelds", "fridges", "watches"]
+        }
+      end
+    end
+
+    it "renders a select box without a blank option" do
+      is_expected.not_to have_css("select option[value='']", visible: :all)
+    end
+
+    it "renders a select box without data-allow-clear attribute" do
+      is_expected.not_to have_css("select[data-allow-clear]")
+    end
+  end
+
+  context "with presence validation" do
+    before do
+      allow(ingredient).to receive(:definition) do
+        Alchemy::IngredientDefinition.new(role: "select", type: "Select", validate: [:presence], settings: {select_values: ["a", "b"]})
+      end
+    end
+
+    it "renders a select box with required attribute" do
+      is_expected.to have_css("select[required]")
+    end
+  end
 end