phlexi-form 0.7.2 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5efa476cb7e4856462046b6658c996843537b102f807e5c7c08a2d8e88520d11
-  data.tar.gz: 1938daa8358013cee51abd0b4d50188c99459c6b714470002e4ec26a77e0b224
+  metadata.gz: 8747d53fec5851c3ad3f78d2c60fecfea530de3b033eb074ee5f4ce41bcd3181
+  data.tar.gz: 51c02f430a3a81a4ee05197463a14aa9b00804c0a5b3a1837f36533b006d9860
 SHA512:
-  metadata.gz: a0b9918b54df47959563f801982e0cbfae8b2a22f21ea2900cb64be952c891b7df7702361255c09063b45a858ed4fc9445911bc73d1766edf3f91ed91000417a
-  data.tar.gz: 73de9965cf5106cefe30081ba2d2a822d725ec203cb26d4d1fd2f2be53b336fd56aa227c2935b85b6d405ddf9a4dca35096f010d98d4724285d9dbfd9c2d8df8
+  metadata.gz: 7434f1529fda38b7e02318c01be2fba09a97de755c874d2319730e4118d747a20bac457e7421bb34f0280f7e405079717df55e3d5ba3f32934f51deb1ebf43d7
+  data.tar.gz: 7457a359784b5404fee4a86ecdce99769f7899e080b7148aaff045719d536499efb4c6103c04334675258af94b74dbd10a9acacb7f327fb3a0f5f1508223f5bd

data/lib/phlexi/form/components/concerns/accepts_choices.rb

@@ -9,13 +9,17 @@ module Phlexi
 
           def build_attributes
             super
-            @choice_collection = attributes.delete(:choices) || field.choices
             @label_method = attributes.delete(:label_method)
             @value_method = attributes.delete(:value_method)
+            @group_method = attributes.delete(:group_method)
+            @group_label_method = attributes.delete(:group_label_method)
           end
 
           def choices
-            @choices ||= ChoicesMapper.new(@choice_collection, label_method: @label_method, value_method: @value_method)
+            @choices ||= begin
+              collection = attributes.delete(:choices) || field.choices
+              build_choice_mapper(collection)
+            end
           end
 
           def selected?(option)
@@ -35,8 +39,27 @@ module Phlexi
           end
 
           def normalize_simple_input(input_value)
+            # ensure that choice is in the list
             ([super] & choices.values)[0]
           end
+
+          def build_choice_mapper(collection)
+            if @group_method
+              GroupedChoicesMapper.new(
+                collection,
+                group_method: @group_method,
+                group_label_method: @group_label_method,
+                label_method: @label_method,
+                value_method: @value_method
+              )
+            else
+              SimpleChoicesMapper.new(
+                collection,
+                label_method: @label_method,
+                value_method: @value_method
+              )
+            end
+          end
         end
       end
     end

data/lib/phlexi/form/components/select.rb

@@ -19,8 +19,18 @@ module Phlexi
         protected
 
         def options
-          choices.each do |value, label|
-            option(selected: selected?(value), value: value) { label }
+          if choices.is_a?(GroupedChoicesMapper)
+            choices.each do |group_label, group_choices|
+              optgroup(label: group_label) do
+                group_choices.each do |value, label|
+                  option(selected: selected?(value), value: value) { label }
+                end
+              end
+            end
+          else
+            choices.each do |value, label|
+              option(selected: selected?(value), value: value) { label }
+            end
           end
         end
 

data/lib/phlexi/form/grouped_choices_mapper.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+module Phlexi
+  module Form
+    class GroupedChoicesMapper
+      include Enumerable
+
+      def initialize(collection, group_method:, group_label_method: :to_s, label_method: nil, value_method: nil)
+        @collection = collection
+        @group_method = group_method
+        @group_label_method = group_label_method
+        @label_method = label_method
+        @value_method = value_method
+      end
+
+      def each(&)
+        grouped_choices.each(&)
+      end
+
+      def grouped_choices
+        @grouped_choices ||= materialize_grouped_choices(@collection)
+      end
+
+      def materialize_grouped_choices(collection)
+        case collection
+        in Hash => hash
+          hash.transform_values { |items| to_choices_mapper(items) }
+        in Array => arr
+          array_to_grouped_hash(arr)
+        in Proc => proc
+          materialize_grouped_choices(proc.call)
+        else
+          record_collection_to_hash
+        end
+      end
+
+      private
+
+      def array_to_grouped_hash(array)
+        sample = array.first
+        if group_method == :last && sample.is_a?(Array) && sample.size == 2
+          array.each_with_object({}) do |(label, items), hash|
+            hash[label.to_s] = to_choices_mapper(items)
+          end
+        else
+          record_collection_to_hash
+        end
+      end
+
+      def record_collection_to_hash
+        @collection.group_by do |item|
+          group = item.public_send(@group_method)
+          group.public_send(@group_label_method).to_s
+        end.transform_values { |items| to_choices_mapper(items) }
+      end
+
+      def to_choices_mapper(items)
+        SimpleChoicesMapper.new(items, label_method: @label_method, value_method: @value_method)
+      end
+    end
+  end
+end

data/lib/phlexi/form/{choices_mapper.rb → simple_choices_mapper.rb}

@@ -2,31 +2,31 @@
 
 module Phlexi
   module Form
-    # ChoicesMapper is responsible for converting a collection of objects into a hash of options
+    # SimpleChoicesMapper is responsible for converting a collection of objects into a hash of options
     # suitable for form controls, such as `select > options`.
     # Both values and labels are converted to strings.
     #
     # @example Basic usage
     #   collection = [["First", 1], ["Second", 2]]
-    #   mapper = ChoicesMapper.new(collection)
+    #   mapper = SimpleChoicesMapper.new(collection)
     #   mapper.each { |value, label| puts "#{value}: #{label}" }
     #
     # @example Using with ActiveRecord objects
     #   users = User.all
-    #   mapper = ChoicesMapper.new(users)
+    #   mapper = SimpleChoicesMapper.new(users)
     #   mapper.each { |id, name| puts "#{id}: #{name}" }
     #
     # @example Array access with different value types
-    #   mapper = ChoicesMapper.new([["Integer", 1], ["String", "2"], ["Symbol", :three]])
+    #   mapper = SimpleChoicesMapper.new([["Integer", 1], ["String", "2"], ["Symbol", :three]])
     #   puts mapper["1"]      # Output: "Integer"
     #   puts mapper["2"]      # Output: "String"
     #   puts mapper["three"]  # Output: "Symbol"
     #
     # @note This class is thread-safe as it doesn't maintain mutable state.
-    class ChoicesMapper
+    class SimpleChoicesMapper
       include Enumerable
 
-      # Initializes a new ChoicesMapper instance.
+      # Initializes a new SimpleChoicesMapper instance.
       #
       # @param collection [#call, #to_a] The collection to be mapped.
       # @param label_method [Symbol, nil] The method to call on each object to get the label.
@@ -93,9 +93,9 @@ module Phlexi
         else
           array_to_hash(Array(collection))
         end
-      rescue ArgumentError
-        # Rails.logger.warn("Unhandled inclusion collection type: #{e}")TODO
-        {}
+        # rescue ArgumentError
+        #   # Rails.logger.warn("Unhandled inclusion collection type: #{e}")TODO
+        #   {}
       end
 
       # Converts an array to a hash using detected or specified methods.

data/lib/phlexi/form/version.rb

@@ -2,6 +2,6 @@
 
 module Phlexi
   module Form
-    VERSION = "0.7.2"
+    VERSION = "0.8.0"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: phlexi-form
 version: !ruby/object:Gem::Version
-  version: 0.7.2
+  version: 0.8.0
 platform: ruby
 authors:
 - Stefan Froelich
@@ -205,7 +205,6 @@ files:
 - lib/phlexi/form.rb
 - lib/phlexi/form/base.rb
 - lib/phlexi/form/builder.rb
-- lib/phlexi/form/choices_mapper.rb
 - lib/phlexi/form/components/base.rb
 - lib/phlexi/form/components/belongs_to.rb
 - lib/phlexi/form/components/checkbox.rb
@@ -231,6 +230,7 @@ files:
 - lib/phlexi/form/components/submit_button.rb
 - lib/phlexi/form/components/textarea.rb
 - lib/phlexi/form/components/wrapper.rb
+- lib/phlexi/form/grouped_choices_mapper.rb
 - lib/phlexi/form/html.rb
 - lib/phlexi/form/options/autofocus.rb
 - lib/phlexi/form/options/choices.rb
@@ -247,6 +247,7 @@ files:
 - lib/phlexi/form/options/required.rb
 - lib/phlexi/form/options/step.rb
 - lib/phlexi/form/options/validators.rb
+- lib/phlexi/form/simple_choices_mapper.rb
 - lib/phlexi/form/structure/field_collection.rb
 - lib/phlexi/form/structure/manages_fields.rb
 - lib/phlexi/form/structure/namespace.rb