phlexi-display 0.0.2 → 0.0.4

data/lib/phlexi/display/option_mapper.rb

@@ -1,154 +0,0 @@
-# frozen_string_literal: true
-
-module Phlexi
-  module Display
-    # OptionMapper 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.each { |value, label| puts "#{value}: #{label}" }
-    #
-    # @example Using with ActiveRecord objects
-    #   users = User.all
-    #   mapper = OptionMapper.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]])
-    #   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
-      include Enumerable
-
-      # Initializes a new OptionMapper 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
-        @label_method = label_method
-        @value_method = value_method
-      end
-
-      # Iterates over the collection, yielding value-label pairs.
-      #
-      # @yieldparam value [String] The string value for the current item.
-      # @yieldparam label [String] The string label for the current item.
-      # @return [Enumerator] If no block is given.
-      def each(&)
-        collection.each(&)
-      end
-
-      # @return [Array<String>] An array of all labels in the collection.
-      def labels
-        collection.values
-      end
-
-      # @return [Array<String>] An array of all values in the collection.
-      def values
-        collection.keys
-      end
-
-      # Retrieves the label for a given value.
-      #
-      # @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]
-      end
-
-      private
-
-      # @return [Hash<String, String>] The materialized collection as a hash of string value => string label.
-      def collection
-        @collection ||= materialize_collection(@raw_collection)
-      end
-
-      # Converts the raw collection into a materialized hash.
-      #
-      # @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.
-      # @raise [ArgumentError] If the collection cannot be materialized into an enumerable.
-      def materialize_collection(collection)
-        case collection
-        in Hash => hash
-          hash.transform_keys(&:to_s).transform_values(&:to_s)
-        in Array => arr
-          array_to_hash(arr)
-        in Range => range
-          range_to_hash(range)
-        in Proc => proc
-          materialize_collection(proc.call)
-        in Symbol
-          raise ArgumentError, "Symbol collections are not supported in this context"
-        in Set => set
-          array_to_hash(set.to_a)
-        else
-          array_to_hash(Array(collection))
-        end
-      rescue ArgumentError
-        # Rails.logger.warn("Unhandled inclusion collection type: #{e}")
-        {}
-      end
-
-      # Converts an array to a hash using detected or specified methods.
-      #
-      # @param array [Array] The array to convert.
-      # @return [Hash<String, String>] The resulting hash of string value => string label.
-      def array_to_hash(array)
-        sample = array.first || array.last
-        methods = detect_methods_for_sample(sample)
-
-        array.each_with_object({}) do |item, hash|
-          value = item.public_send(methods[:value]).to_s
-          label = item.public_send(methods[:label]).to_s
-          hash[value] = label
-        end
-      end
-
-      # Converts a range to a hash.
-      #
-      # @param range [Range] The range to convert.
-      # @return [Hash<String, String>] The range converted to a hash of string value => string label.
-      # @raise [ArgumentError] If the range is unbounded.
-      def range_to_hash(range)
-        raise ArgumentError, "Cannot safely materialize an unbounded range" if range.begin.nil? || range.end.nil?
-
-        range.each_with_object({}) { |value, hash| hash[value.to_s] = value.to_s }
-      end
-
-      # Detects suitable methods for label and value from a sample object.
-      #
-      # @param sample [Object] A sample object from the collection.
-      # @return [Hash{Symbol => Symbol}] A hash containing :label and :value keys with corresponding method names.
-      def detect_methods_for_sample(sample)
-        case sample
-        when Array
-          {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) }
-          }
-        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
-      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
-      end
-    end
-  end
-end

data/lib/phlexi/display/structure/dom.rb

@@ -1,42 +0,0 @@
-# frozen_string_literal: true
-
-module Phlexi
-  module Display
-    module Structure
-      # Generates DOM IDs for a Field, Namespace, or Node based on
-      # norms that were established by Rails. These can be used outside of Rails in
-      # other Ruby web frameworks since it has no dependencies on Rails.
-      class DOM
-        def initialize(field:)
-          @field = field
-        end
-
-        # Converts the value of the field to a String, which is required to work
-        # with Phlex. Assumes that `Object#to_s` emits a format suitable for display.
-        def value
-          @field.value.to_s
-        end
-
-        # Walks from the current node to the parent node, grabs the names, and separates
-        # them with a `_` for a DOM ID.
-        def id
-          @id ||= begin
-            root, *rest = lineage
-            root_key = root.respond_to?(:dom_id) ? root.dom_id : root.key
-            rest.map(&:key).unshift(root_key).join("_")
-          end
-        end
-
-        # One-liner way of walking from the current node all the way up to the parent.
-        def lineage
-          @lineage ||= Enumerator.produce(@field, &:parent).take_while(&:itself).reverse
-        end
-
-        # Emit the id and value in an HTML tag-ish that doesn't have an element.
-        def inspect
-          "<#{self.class.name} id=#{id.inspect} value=#{value.inspect}/>"
-        end
-      end
-    end
-  end
-end

data/lib/phlexi/display/structure/field_builder.rb

@@ -1,160 +0,0 @@
-# frozen_string_literal: true
-
-require "phlex"
-
-module Phlexi
-  module Display
-    module Structure
-      # FieldBuilder class is responsible for building display fields with various options and components.
-      #
-      # @attr_reader [Structure::DOM] dom The DOM structure for the field.
-      # @attr_reader [Hash] options Options for the field.
-      # @attr_reader [Object] object The object associated with the field.
-      # @attr_reader [Hash] attributes Attributes for the field.
-      # @attr_accessor [Object] value The value of the field.
-      class FieldBuilder < Node
-        include Phlex::Helpers
-        include FieldOptions::Themes
-        include FieldOptions::Associations
-        include FieldOptions::Attachments
-        include FieldOptions::InferredTypes
-        include FieldOptions::Labels
-        include FieldOptions::Placeholders
-        include FieldOptions::Description
-        # include FieldOptions::Hints
-
-        attr_reader :dom, :options, :object, :value
-
-        # Initializes a new FieldBuilder instance.
-        #
-        # @param key [Symbol, String] The key for the field.
-        # @param parent [Structure::Namespace] The parent object.
-        # @param object [Object, nil] The associated object.
-        # @param value [Object] The initial value for the field.
-        # @param options [Hash] Additional options for the field.
-        def initialize(key, parent:, object: nil, value: NIL_VALUE, **options)
-          super(key, parent: parent)
-
-          @object = object
-          @value = determine_value(value)
-          @options = options
-          @dom = Structure::DOM.new(field: self)
-        end
-
-        # Creates a label tag for the field.
-        #
-        # @param attributes [Hash] Additional attributes for the label.
-        # @return [Components::Label] The label component.
-        def label_tag(**attributes, &)
-          create_component(Components::Label, :label, **attributes, &)
-        end
-
-        # Creates a Placeholder tag for the field.
-        #
-        # @param attributes [Hash] Additional attributes for the placeholder.
-        # @return [Components::Placeholder] The placeholder component.
-        def placeholder_tag(**attributes, &)
-          create_component(Components::Placeholder, :placeholder, **attributes, &)
-        end
-
-        # Creates a Description tag for the field.
-        #
-        # @param attributes [Hash] Additional attributes for the description.
-        # @return [Components::Description] The description component.
-        def description_tag(**attributes, &)
-          create_component(Components::Description, :description, **attributes, &)
-        end
-
-        # Creates a string display tag for the field.
-        #
-        # @param attributes [Hash] Additional attributes for the string display.
-        # @return [Components::String] The string component.
-        def string_tag(**attributes, &)
-          create_component(Components::String, :string, **attributes, &)
-        end
-
-        # # Creates a text display tag for the field.
-        # #
-        # # @param attributes [Hash] Additional attributes for the text display.
-        # # @return [Components::Text] The text component.
-        # def text_tag(**attributes, &)
-        #   create_component(Components::Text, :text, **attributes, &)
-        # end
-
-        # Creates a number display tag for the field.
-        #
-        # @param attributes [Hash] Additional attributes for the number display.
-        # @return [Components::Number] The number component.
-        def number_tag(**attributes, &)
-          create_component(Components::Number, :number, **attributes, &)
-        end
-
-        # Creates a datetime display for the field.
-        #
-        # @param attributes [Hash] Additional attributes for the datetime display.
-        # @return [Components::DateTime] The datetime component.
-        def datetime_tag(**attributes, &)
-          create_component(Components::DateTime, :datetime, **attributes, &)
-        end
-
-        # # Creates a boolean display tag for the field.
-        # #
-        # # @param attributes [Hash] Additional attributes for the boolean display.
-        # # @return [Components::Boolean] The boolean component.
-        # def boolean_tag(**attributes, &)
-        #   create_component(Components::Boolean, :boolean, **attributes, &)
-        # end
-
-        # # Creates an association display tag for the field.
-        # #
-        # # @param attributes [Hash] Additional attributes for the association display.
-        # # @return [Components::Association] The association component.
-        # def association_tag(**attributes, &)
-        #   create_component(Components::Association, :association, **attributes, &)
-        # end
-
-        # # Creates an attachment display tag for the field.
-        # #
-        # # @param attributes [Hash] Additional attributes for the attachment display.
-        # # @return [Components::Attachment] The attachment component.
-        # def attachment_tag(**attributes, &)
-        #   create_component(Components::Attachment, :attachment, **attributes, &)
-        # end
-
-        # Wraps the field with additional markup.
-        #
-        # @param attributes [Hash] Additional attributes for the wrapper.
-        # @yield [block] The block to be executed within the wrapper.
-        # @return [Components::Wrapper] The wrapper component.
-        def wrapped(**attributes, &)
-          create_component(Components::Wrapper, :wrapper, **attributes, &)
-        end
-
-        # Creates a repeated field collection.
-        #
-        # @param range [#each] The collection of items to generate displays for.
-        # @yield [block] The block to be executed for each item in the collection.
-        # @return [FieldCollection] The field collection.
-        def repeated(collection = [], &)
-          FieldCollection.new(field: self, collection:, &)
-        end
-
-        protected
-
-        def create_component(component_class, theme_key, **attributes, &)
-          component_class.new(self, class: component_class_for(theme_key, attributes), **attributes, &)
-        end
-
-        def component_class_for(theme_key, attributes)
-          attributes.delete(:class) || themed(attributes.key?(:theme) ? attributes.delete(:theme) : theme_key)
-        end
-
-        def determine_value(value)
-          return value unless value == NIL_VALUE
-
-          object.respond_to?(key) ? object.public_send(key) : nil
-        end
-      end
-    end
-  end
-end

data/lib/phlexi/display/structure/field_collection.rb

@@ -1,39 +0,0 @@
-# frozen_string_literal: true
-
-module Phlexi
-  module Display
-    module Structure
-      class FieldCollection
-        include Enumerable
-
-        class Builder
-          attr_reader :key, :index
-
-          def initialize(key, field, index)
-            @key = key.to_s
-            @field = field
-            @index = index
-          end
-
-          def field(**)
-            @field.class.new(key, **, parent: @field).tap do |field|
-              yield field if block_given?
-            end
-          end
-        end
-
-        def initialize(field:, collection:, &)
-          @field = field
-          @collection = collection
-          each(&) if block_given?
-        end
-
-        def each(&)
-          @collection.each.with_index do |item, index|
-            yield Builder.new(item, @field, index)
-          end
-        end
-      end
-    end
-  end
-end

data/lib/phlexi/display/structure/namespace.rb

@@ -1,123 +0,0 @@
-# frozen_string_literal: true
-
-module Phlexi
-  module Display
-    module Structure
-      # A Namespace maps an object to values, but doesn't actually have a value itself. For
-      # example, a `User` object or ActiveRecord model could be passed into the `:user` namespace.
-      #
-      # To access single values on a Namespace, #field can be used.
-      #
-      # To access nested objects within a namespace, two methods are available:
-      #
-      # 1. #nest_one: Used for single nested objects, such as if a `User belongs_to :profile` in
-      #    ActiveRecord. This method returns another Namespace object.
-      #
-      # 2. #nest_many: Used for collections of nested objects, such as if a `User has_many :addresses` in
-      #    ActiveRecord. This method returns a NamespaceCollection object.
-      class Namespace < Structure::Node
-        include Enumerable
-
-        attr_reader :builder_klass, :object
-
-        def initialize(key, parent:, builder_klass:, object: nil)
-          super(key, parent: parent)
-          @builder_klass = builder_klass
-          @object = object
-          @children = {}
-          yield self if block_given?
-        end
-
-        def field(key, **attributes)
-          create_child(key, attributes.delete(:builder_klass) || builder_klass, object: object, **attributes).tap do |field|
-            yield field if block_given?
-          end
-        end
-
-        # Creates a `Namespace` child instance with the parent set to the current instance, adds to
-        # the `@children` Hash to ensure duplicate child namespaces aren't created, then calls the
-        # method on the `@object` to get the child object to pass into that namespace.
-        #
-        # For example, if a `User#permission` returns a `Permission` object, we could map that to a
-        # display like this:
-        #
-        # ```ruby
-        # Phlexi::Display(user) do |display|
-        #   display.nest_one :profile do |profile|
-        #     render profile.field(:gender).text
-        #   end
-        # end
-        # ```
-        def nest_one(key, object: nil, &)
-          object ||= object_value_for(key: key)
-          create_child(key, self.class, object:, builder_klass:, &)
-        end
-
-        # Wraps an array of objects in Namespace classes. For example, if `User#addresses` returns
-        # an enumerable or array of `Address` classes:
-        #
-        # ```ruby
-        # Phlexi::Display(user) do |display|
-        #   render display.field(:email).text
-        #   render display.field(:name).text
-        #   display.nest_many :addresses do |address|
-        #     render address.field(:street).text
-        #     render address.field(:state).text
-        #     render address.field(:zip).text
-        #   end
-        # end
-        # ```
-        # The object within the block is a `Namespace` object that maps each object within the enumerable
-        # to another `Namespace` or `Field`.
-        def nest_many(key, collection: nil, &)
-          collection ||= Array(object_value_for(key: key))
-          create_child(key, NamespaceCollection, collection:, &)
-        end
-
-        # Iterates through the children of the current namespace, which could be `Namespace` or `Field`
-        # objects.
-        def each(&)
-          @children.values.each(&)
-        end
-
-        def dom_id
-          @dom_id ||= begin
-            id = if object.nil?
-              nil
-            elsif object.class.respond_to?(:primary_key)
-              object.public_send(object.class.primary_key) || :new
-            elsif object.respond_to?(:id)
-              object.id || :new
-            end
-            [key, id].compact.join("_").underscore
-          end
-        end
-
-        # Creates a root Namespace
-        def self.root(*, builder_klass:, **, &)
-          new(*, parent: nil, builder_klass:, **, &)
-        end
-
-        protected
-
-        # Calls the corresponding method on the object for the `key` name, if it exists. For example
-        # if the `key` is `email` on `User`, this method would call `User#email` if the method is
-        # present.
-        #
-        # This method could be overwritten if the mapping between the `@object` and `key` name is not
-        # a method call. For example, a `Hash` would be accessed via `user[:email]` instead of `user.send(:email)`
-        def object_value_for(key:)
-          @object.send(key) if @object.respond_to? key
-        end
-
-        private
-
-        # Checks if the child exists. If it does then it returns that. If it doesn't, it will
-        # build the child.
-        def create_child(key, child_class, **kwargs, &block)
-          @children.fetch(key) { @children[key] = child_class.new(key, parent: self, **kwargs, &block) }
-        end
-      end
-    end
-  end
-end

data/lib/phlexi/display/structure/namespace_collection.rb

@@ -1,40 +0,0 @@
-# frozen_string_literal: true
-
-module Phlexi
-  module Display
-    module Structure
-      class NamespaceCollection < Node
-        include Enumerable
-
-        def initialize(key, parent:, collection: nil, &block)
-          raise ArgumentError, "block is required" unless block.present?
-
-          super(key, parent: parent)
-
-          @collection = collection
-          @block = block
-          each(&block)
-        end
-
-        private
-
-        def each(&)
-          namespaces.each(&)
-        end
-
-        # Builds and memoizes namespaces for the collection.
-        #
-        # @return [Array<Namespace>] An array of namespace objects.
-        def namespaces
-          @namespaces ||= @collection.map.with_index do |object, key|
-            build_namespace(key, object: object)
-          end
-        end
-
-        def build_namespace(index, **)
-          parent.class.new(index, parent: self, builder_klass: parent.builder_klass, **)
-        end
-      end
-    end
-  end
-end

data/lib/phlexi/display/structure/node.rb

@@ -1,24 +0,0 @@
-# frozen_string_literal: true
-
-module Phlexi
-  module Display
-    module Structure
-      # Superclass for Namespace and Field classes. Represents a node in the display tree structure.
-      #
-      # @attr_reader [Symbol] key The node's key
-      # @attr_reader [Node, nil] parent The node's parent in the tree structure
-      class Node
-        attr_reader :key, :parent
-
-        # Initializes a new Node instance.
-        #
-        # @param key [Symbol, String] The key for the node
-        # @param parent [Node, nil] The parent node
-        def initialize(key, parent:)
-          @key = :"#{key}"
-          @parent = parent
-        end
-      end
-    end
-  end
-end