phlexi-form 0.4.7 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 26048462a9cc9beca66d75c24a8d477c5bfdadaae27fe5367aad44c386d826c8
-  data.tar.gz: fe670159073f2bb7a6ddb4d4f3cdb7b61fa600d62581838eb2a24770366d647d
+  metadata.gz: 454cb0f7804d3a7c10a6afdb3fe9bb7342e63bc76ee02750ea4a65f95e853449
+  data.tar.gz: 97c56aabb6e2c6b3b83f0c4782ac8724427fd93d211f5ac16f1dd42a4f1c1ac0
 SHA512:
-  metadata.gz: d5a5930ec1776f6fc972d6754fe5e81fb9a9bb67c4a2489d30983497237182087c45ffcef3f062d4241796a951b0247bbd3d8331a59dd79e4dc62532d94d2f30
-  data.tar.gz: 5683debcf1062a1b99e0ac5207c231d6e1a437c1bd75d5a28177af750d15b419ae4fe659fe7eeb0e9fbbb34db2ddfd2f0ce3b67c6832c9cc03790873cbc64afa
+  metadata.gz: 46350c1288b35d787080eff648bf86b23a55a1a122d234dfe2611cf91133d922f0e0747826cbf5a3980af7ebad55c07947953432bc3c700456871e7ab99ccb00
+  data.tar.gz: 31936b709b68353f3c855ec809e582f1d43a2c5669bcadec9499a0ea315ed66c9cf74038176b9106d4f316953a8111669aeaa63bc44f1fe48c92d746b86fcb8c

data/lib/phlexi/form/builder.rb

@@ -8,7 +8,7 @@ module Phlexi
       include Options::Validators
       include Options::InferredTypes
       include Options::Errors
-      include Options::Collection
+      include Options::Choices
       include Options::Hints
       include Options::Required
       include Options::Autofocus

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

@@ -2,58 +2,58 @@
 
 module Phlexi
   module Form
-    # OptionMapper is responsible for converting a collection of objects into a hash of options
+    # ChoicesMapper 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 = OptionMapper.new(collection)
+    #   mapper = ChoicesMapper.new(collection)
     #   mapper.each { |value, label| puts "#{value}: #{label}" }
     #
     # @example Using with ActiveRecord objects
     #   users = User.all
-    #   mapper = OptionMapper.new(users)
+    #   mapper = ChoicesMapper.new(users)
     #   mapper.each { |id, name| puts "#{id}: #{name}" }
     #
     # @example Array access with different value types
-    #   mapper = OptionMapper.new([["Integer", 1], ["String", "2"], ["Symbol", :three]])
+    #   mapper = ChoicesMapper.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 OptionMapper
+    class ChoicesMapper
       include Enumerable
 
-      # Initializes a new OptionMapper instance.
+      # Initializes a new ChoicesMapper 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.
       # @param value_method [Symbol, nil] The method to call on each object to get the value.
       def initialize(collection, label_method: nil, value_method: nil)
-        @raw_collection = collection
+        @collection = collection
         @label_method = label_method
         @value_method = value_method
       end
 
-      # Iterates over the collection, yielding value-label pairs.
+      # Iterates over the choices, yielding value-label pairs.
       #
-      # @yieldparam value [String] The string value for the current item.
-      # @yieldparam label [String] The string label for the current item.
+      # @yieldparam value [String] The string value for the current choice.
+      # @yieldparam label [String] The string label for the current choice.
       # @return [Enumerator] If no block is given.
       def each(&)
-        collection.each(&)
+        choices.each(&)
       end
 
-      # @return [Array<String>] An array of all labels in the collection.
+      # @return [Array<String>] An array of all choice labels.
       def labels
-        collection.values
+        choices.values
       end
 
-      # @return [Array<String>] An array of all values in the collection.
+      # @return [Array<String>] An array of all choice values.
       def values
-        collection.keys
+        choices.keys
       end
 
       # Retrieves the label for a given value.
@@ -61,22 +61,22 @@ module Phlexi
       # @param value [#to_s] The value to look up.
       # @return [String, nil] The label corresponding to the value, or nil if not found.
       def [](value)
-        collection[value.to_s]
+        choices[value.to_s]
       end
 
       private
 
-      # @return [Hash<String, String>] The materialized collection as a hash of string value => string label.
-      def collection
-        @collection ||= materialize_collection(@raw_collection)
+      # @return [Hash<String, String>] The choices as a hash of {"string value" => "string label"}.
+      def choices
+        @choices ||= materialize_choices(@collection)
       end
 
-      # Converts the raw collection into a materialized hash.
+      # Converts a collection into a materialized hash of choices.
       #
       # @param collection [#call, #to_a] The collection to be materialized.
-      # @return [Hash<String, String>] The materialized collection as a hash of string value => string label.
+      # @return [Hash<String, String>] The materialized choices as a hash of {"string value" => "string label"}.
       # @raise [ArgumentError] If the collection cannot be materialized into an enumerable.
-      def materialize_collection(collection)
+      def materialize_choices(collection)
         case collection
         in Hash => hash
           hash.transform_keys(&:to_s).transform_values(&:to_s)
@@ -85,7 +85,7 @@ module Phlexi
         in Range => range
           range_to_hash(range)
         in Proc => proc
-          materialize_collection(proc.call)
+          materialize_choices(proc.call)
         in Symbol
           raise ArgumentError, "Symbol collections are not supported in this context"
         in Set => set
@@ -94,7 +94,7 @@ module Phlexi
           array_to_hash(Array(collection))
         end
       rescue ArgumentError
-        # Rails.logger.warn("Unhandled inclusion collection type: #{e}")
+        # Rails.logger.warn("Unhandled inclusion collection type: #{e}")TODO
         {}
       end
 
@@ -134,20 +134,20 @@ module Phlexi
           {value: :last, label: :first}
         else
           {
-            value: @value_method || collection_value_methods.find { |m| sample.respond_to?(m) },
-            label: @label_method || collection_label_methods.find { |m| sample.respond_to?(m) }
+            value: @value_method || choice_value_methods.find { |m| sample.respond_to?(m) },
+            label: @label_method || choice_label_methods.find { |m| sample.respond_to?(m) }
           }
         end
       end
 
-      # @return [Array<Symbol>] An array of method names to try for collection values.
-      def collection_value_methods
-        @collection_value_methods ||= %i[id to_s].freeze
+      # @return [Array<Symbol>] An array of method names to try for choice values.
+      def choice_value_methods
+        @choice_value_methods ||= %i[to_value id to_s].freeze
       end
 
-      # @return [Array<Symbol>] An array of method names to try for collection labels.
-      def collection_label_methods
-        @collection_label_methods ||= %i[to_label name title to_s].freeze
+      # @return [Array<Symbol>] An array of method names to try for choice labels.
+      def choice_label_methods
+        @choice_label_methods ||= %i[to_label name title to_s].freeze
       end
     end
   end

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

@@ -6,15 +6,15 @@ module Phlexi
       class CollectionCheckboxes < Base
         include Concerns::HandlesInput
         include Concerns::HandlesArrayInput
-        include Concerns::HasOptions
+        include Concerns::AcceptsChoices
 
         def view_template
           div(**attributes.slice(:id, :class)) do
-            field.repeated(option_mapper.values) do |builder|
+            field.repeated(choices.values) do |builder|
               render builder.hidden_field_tag if builder.index == 0
 
               field = builder.field(
-                label: option_mapper[builder.key],
+                label: choices[builder.key],
                 # We set the attributes here so they are applied to all input components even if the user decides to use a block
                 input_attributes: {
                   checked_value: builder.key,

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

@@ -5,15 +5,15 @@ module Phlexi
     module Components
       class CollectionRadioButtons < Base
         include Concerns::HandlesInput
-        include Concerns::HasOptions
+        include Concerns::AcceptsChoices
 
         def view_template
           div(**attributes.slice(:id, :class)) do
-            field.repeated(option_mapper.values) do |builder|
+            field.repeated(choices.values) do |builder|
               render builder.hidden_field_tag if builder.index == 0
 
               field = builder.field(
-                label: option_mapper[builder.key],
+                label: choices[builder.key],
                 # We set the attributes here so they are applied to all input components even if the user decides to use a block
                 input_attributes: {
                   checked_value: builder.key,

data/lib/phlexi/form/components/concerns/{has_options.rb → accepts_choices.rb}

@@ -4,18 +4,18 @@ module Phlexi
   module Form
     module Components
       module Concerns
-        module HasOptions
+        module AcceptsChoices
           protected
 
           def build_attributes
             super
-            @collection = attributes.delete(:collection) || field.collection
+            @choice_collection = attributes.delete(:choices) || field.choices
             @label_method = attributes.delete(:label_method)
             @value_method = attributes.delete(:value_method)
           end
 
-          def option_mapper
-            @option_mapper ||= OptionMapper.new(@collection, label_method: @label_method, value_method: @value_method)
+          def choices
+            @choices ||= ChoicesMapper.new(@choice_collection, label_method: @label_method, value_method: @value_method)
           end
 
           def selected?(option)
@@ -28,7 +28,7 @@ module Phlexi
           end
 
           def normalize_simple_input(input_value)
-            ([super] & option_mapper.values)[0]
+            ([super] & choices.values)[0]
           end
         end
       end

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

@@ -6,7 +6,7 @@ module Phlexi
       class Select < Base
         include Concerns::HandlesInput
         include Concerns::HandlesArrayInput
-        include Concerns::HasOptions
+        include Concerns::AcceptsChoices
 
         def view_template
           input(type: :hidden, name: attributes[:name], value: "", autocomplete: "off", hidden: true) if include_hidden?
@@ -19,7 +19,7 @@ module Phlexi
         protected
 
         def options
-          option_mapper.each do |value, label|
+          choices.each do |value, label|
             option(selected: selected?(value), value: value) { label }
           end
         end

data/lib/phlexi/form/options/{collection.rb → choices.rb}

@@ -3,27 +3,27 @@
 module Phlexi
   module Form
     module Options
-      module Collection
-        def collection(collection = nil)
-          if collection.nil?
-            options.fetch(:collection) { options[:collection] = infer_collection }
+      module Choices
+        def choices(choices = nil)
+          if choices.nil?
+            options.fetch(:choices) { options[:choices] = infer_choices }
           else
-            options[:collection] = collection
+            options[:choices] = choices
             self
           end
         end
 
         private
 
-        def infer_collection
+        def infer_choices
           if object.class.respond_to?(:defined_enums)
             return object.class.defined_enums.fetch(key.to_s).keys if object.class.defined_enums.key?(key.to_s)
           end
 
-          collection_value_from_association || collection_value_from_validator
+          choices_from_association || choices_from_validator
         end
 
-        def collection_value_from_association
+        def choices_from_association
           return unless association_reflection
 
           relation = association_reflection.klass.all
@@ -46,7 +46,7 @@ module Phlexi
           relation
         end
 
-        def collection_value_from_validator
+        def choices_from_validator
           return unless has_validators?
 
           inclusion_validator = find_validator(:inclusion)

data/lib/phlexi/form/version.rb

@@ -2,6 +2,6 @@
 
 module Phlexi
   module Form
-    VERSION = "0.4.7"
+    VERSION = "0.5.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: phlexi-form
 version: !ruby/object:Gem::Version
-  version: 0.4.7
+  version: 0.5.0
 platform: ruby
 authors:
 - Stefan Froelich
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-10-27 00:00:00.000000000 Z
+date: 2024-10-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: phlex
@@ -205,14 +205,15 @@ 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/checkbox.rb
 - lib/phlexi/form/components/collection_checkboxes.rb
 - lib/phlexi/form/components/collection_radio_buttons.rb
+- lib/phlexi/form/components/concerns/accepts_choices.rb
 - lib/phlexi/form/components/concerns/extracts_input.rb
 - lib/phlexi/form/components/concerns/handles_array_input.rb
 - lib/phlexi/form/components/concerns/handles_input.rb
-- lib/phlexi/form/components/concerns/has_options.rb
 - lib/phlexi/form/components/concerns/submits_form.rb
 - lib/phlexi/form/components/error.rb
 - lib/phlexi/form/components/file_input.rb
@@ -228,9 +229,8 @@ files:
 - lib/phlexi/form/components/textarea.rb
 - lib/phlexi/form/components/wrapper.rb
 - lib/phlexi/form/html.rb
-- lib/phlexi/form/option_mapper.rb
 - lib/phlexi/form/options/autofocus.rb
-- lib/phlexi/form/options/collection.rb
+- lib/phlexi/form/options/choices.rb
 - lib/phlexi/form/options/disabled.rb
 - lib/phlexi/form/options/errors.rb
 - lib/phlexi/form/options/hints.rb