Add an abstract collection option to the configuration class

lib/alchemy/configuration.rb

@@ -7,10 +7,9 @@
 require "alchemy/configuration/class_option"
 require "alchemy/configuration/class_set_option"
 require "alchemy/configuration/integer_option"
-require "alchemy/configuration/integer_list_option"
 require "alchemy/configuration/regexp_option"
-require "alchemy/configuration/string_list_option"
 require "alchemy/configuration/string_option"
+require "alchemy/configuration/collection_option"
 
 module Alchemy
   class Configuration

lib/alchemy/configuration/collection_option.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require "alchemy/configuration/base_option"
+
+module Alchemy
+  class Configuration
+    class CollectionOption < BaseOption
+      attr_reader :collection_class
+      attr_reader :item_class
+
+      def initialize(value:, name:, item_class:, collection_class: Array, **args)
+        @collection_class = collection_class
+        @item_class = item_class
+        value = collection_class.new(value)
+        super
+      end
+
+      private
+
+      def validate(value)
+        unless value.is_a?(collection_class) && value.all? { _1.is_a?(item_class) }
+          raise TypeError, "#{@name} must be a #{collection_class} of #{item_class.name.downcase.pluralize}, given #{value.inspect}"
+        end
+        value
+      end
+    end
+  end
+end

lib/alchemy/configurations/mailer.rb

@@ -9,8 +9,8 @@ class Mailer < Alchemy::Configuration
       option :mail_from, :string, default: "[email protected]"
       option :mail_to, :string, default: "[email protected]"
       option :subject, :string, default: "A new contact form message"
-      option :fields, :string_list, default: %w[salutation firstname lastname address zip city phone email message]
-      option :validate_fields, :string_list, default: %w[lastname email]
+      option :fields, :collection, item_class: String, default: %w[salutation firstname lastname address zip city phone email message]
+      option :validate_fields, :collection, item_class: String, default: %w[lastname email]
     end
   end
 end

lib/alchemy/configurations/main.rb

@@ -154,7 +154,7 @@ class Main < Alchemy::Configuration
       #     user_roles:
       #       rolename: Name of the role
       #
-      option :user_roles, :string_list, default: %w[member author editor admin]
+      option :user_roles, :collection, item_class: String, default: %w[member author editor admin]
 
       # === Uploader Settings
       #
@@ -176,7 +176,7 @@ class Main < Alchemy::Configuration
       #
       #   jQuery(a[data-link-target="overlay"]).dialog();
       #
-      option :link_target_options, :string_list, default: %w[blank]
+      option :link_target_options, :collection, item_class: String, default: %w[blank]
 
       # === Format matchers
       #
@@ -193,7 +193,7 @@ class Main < Alchemy::Configuration
       option :admin_page_preview_layout, :string, default: "application"
 
       # The sizes for the preview size select in the page editor.
-      option :page_preview_sizes, :integer_list, default: [360, 640, 768, 1024, 1280, 1440]
+      option :page_preview_sizes, :collection, item_class: Integer, default: [360, 640, 768, 1024, 1280, 1440]
 
       # Enable full text search configuration
       #

lib/alchemy/configurations/uploader.rb

@@ -4,8 +4,8 @@ module Alchemy
   module Configurations
     class Uploader < Alchemy::Configuration
       class AllowedFileTypes < Alchemy::Configuration
-        option :alchemy_attachments, :string_list, default: ["*"]
-        option :alchemy_pictures, :string_list, default: %w[jpg jpeg gif png svg webp]
+        option :alchemy_attachments, :collection, item_class: String, default: ["*"]
+        option :alchemy_pictures, :collection, item_class: String, default: %w[jpg jpeg gif png svg webp]
 
         def set(configuration_hash)
           super(configuration_hash.transform_keys { transform_key(_1) })

spec/libraries/alchemy/configuration/collection_option_spec.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require "rails_helper"
+
+RSpec.describe Alchemy::Configuration::CollectionOption do
+  subject(:option) { described_class.new(value:, name: :my_option, item_class:, collection_class:) }
+
+  context "with a set of integers" do
+    let(:collection_class) { Set }
+    let(:item_class) { Integer }
+    let(:value) { [1] }
+
+    describe "#value" do
+      subject { option.value }
+      it { is_expected.to be_a(Set) }
+      it { is_expected.to contain_exactly(1) }
+    end
+  end
+
+  context "with an array of strings" do
+    let(:collection_class) { Array }
+    let(:item_class) { String }
+    let(:value) { %w[foo bar] }
+
+    describe "#value" do
+      subject { option.value }
+      it { is_expected.to be_a(Array) }
+      it { is_expected.to contain_exactly("foo", "bar") }
+    end
+  end
+
+  context "with an array of configurations" do
+    let(:collection_class) { Array }
+    let(:item_class) { Alchemy::Configurations::Sitemap }
+    let(:value) do
+      [
+        Alchemy::Configurations::Sitemap.new(
+          show_root: true,
+          show_flag: false
+        )
+      ]
+    end
+
+    it "contains configurations" do
+      expect(subject.value.first.show_root).to be true
+    end
+  end
+end

spec/libraries/alchemy/configuration_spec.rb

@@ -111,7 +111,7 @@
   describe "integer lists" do
     let(:configuration) do
       Class.new(described_class) do
-        option :page_preview_sizes, :integer_list, default: [1, 2]
+        option :page_preview_sizes, :collection, item_class: Integer, default: [1, 2]
       end.new
     end
 
@@ -122,14 +122,14 @@
     it "can only be set with an integer list" do
       expect do
         configuration.page_preview_sizes = ["1"]
-      end.to raise_exception(TypeError, 'page_preview_sizes must be an Array of integers, given ["1"]')
+      end.to raise_exception(TypeError, 'page_preview_sizes must be a Array of integers, given ["1"]')
     end
   end
 
   describe "string lists" do
     let(:configuration) do
       Class.new(described_class) do
-        option :link_target_options, :string_list, default: ["blank"]
+        option :link_target_options, :collection, item_class: String, default: ["blank"]
       end.new
     end
 
@@ -140,7 +140,7 @@
     it "can only be set with an Array of strings" do
       expect do
         configuration.link_target_options = [:blank]
-      end.to raise_exception(TypeError, "link_target_options must be an Array of strings, given [:blank]")
+      end.to raise_exception(TypeError, "link_target_options must be a Array of strings, given [:blank]")
     end
   end
 
@@ -184,7 +184,7 @@
     let(:configuration_class) do
       Class.new(described_class) do
         option :mail_success_page, :string, default: "thanks"
-        option :link_target_options, :string_list, default: ["blank"]
+        option :link_target_options, :collection, item_class: String, default: ["blank"]
       end
     end
 
@@ -202,7 +202,7 @@
     let(:configuration_class) do
       Class.new(described_class) do
         option :mail_success_page, :string, default: "thanks"
-        option :link_target_options, :string_list, default: ["blank"]
+        option :link_target_options, :collection, item_class: String, default: ["blank"]
       end
     end
 
@@ -221,7 +221,7 @@
     let(:configuration) do
       Class.new(described_class) do
         option :mail_success_page, :string, default: "thanks"
-        option :link_target_options, :string_list, default: ["blank"]
+        option :link_target_options, :collection, item_class: String, default: ["blank"]
       end.new
     end