phlexi-display 0.0.1 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b140e54c49ca3a4a8808a12bb7a91dd8d250c91e2d7d29a8d7f9be2c20a7dbf5
-  data.tar.gz: 9c70cec19581873bb9b93fc887571d6c8d5d65c95a25576bdf26a67e2bb30046
+  metadata.gz: 3de078e9bdc0e066c1b4f3af7b9b8ef966faf1fec3779358b79fb969ff6ebdf8
+  data.tar.gz: 3ac581e38926c8adaf04ce1b312741d1978d7223aa83df42c18723db7be8382b
 SHA512:
-  metadata.gz: 466d34728adaedd7c4669a7419ec53929e49e1b4466135e5a7cc1eb42c88aa196b344ca4e29d8f27fb56a1e83437500678a2b003ca95fc82bbf70ab1ad017afc
-  data.tar.gz: 047a28cd2c6afba47d9b6c8a833437ac2c009e626f747663dc9f506ef8d805b7979b8f59e4b0fe6e59a8180538d7e66cf323aba83e26e671e567ff12a3236a2c
+  metadata.gz: a90ec354ee5aa5a18156b6dff6e5c4b0b5220adf2a11e94004595cba305723d8398de25d6e356e0381305378800e48b188404c0c13fd42c597ead9937760eea1
+  data.tar.gz: 3f7a054aa04d8b3862e618370035fed1d89725fcde4ae13792122085c6301f0ea664c8c7064986ad629a7caab367617200f1677f84ef4fd473bd62393edde3d4

data/lib/phlexi/display/base.rb

@@ -1,98 +1,72 @@
 # frozen_string_literal: true
 
 require "active_support/core_ext/module/delegation"
-require "active_support/string_inquirer"
-require "active_support/core_ext/hash/deep_merge"
 require "active_support/core_ext/string/inflections"
 
 module Phlexi
   module Display
-    # A form component for building flexible and customizable forms.
+    # A display component for rendering flexible and customizable data views.
     #
     # @example Basic usage
-    #   Phlexi::Display.new(user, action: '/users', method: 'post') do |f|
-    #     render field(:name).placeholder("Name").input_tag
-    #     render field(:email).placeholder("Email").input_tag
+    #   Phlexi::Display.new(user) do |d|
+    #     render d.field(:name).text
+    #     render d.field(:email).text
     #   end
     #
-    # @attr_reader [Symbol] key The form's key, derived from the record or explicitly set
-    # @attr_reader [ActiveModel::Model, nil] object The form's associated object
+    # @attr_reader [Symbol] key The display's key, derived from the record or explicitly set
+    # @attr_reader [ActiveModel::Model, nil] object The display's associated object
     class Base < COMPONENT_BASE
-      class Namespace < Structure::Namespace; end
+      class Namespace < Phlexi::Field::Structure::Namespace; end
 
-      class FieldBuilder < Structure::FieldBuilder; end
+      class Builder < Builder; end
 
       attr_reader :key, :object
 
-      delegate :field, :submit_button, :nest_one, :nest_many, to: :@namespace
+      delegate :field, :nest_one, :nest_many, to: :@namespace
 
       # Initializes a new Display instance.
       #
-      # @param record [ActiveModel::Model, Symbol, String] The form's associated record or key
-      # @param action [String, nil] The form's action URL
-      # @param method [String, nil] The form's HTTP method
-      # @param attributes [Hash] Additional HTML attributes for the form tag
-      # @param options [Hash] Additional options for form configuration
-      # @option options [String] :class CSS classes for the form
+      # @param record [ActiveModel::Model, Symbol, String] The display's associated record or key
+      # @param attributes [Hash] Additional HTML attributes for the display container
+      # @param options [Hash] Additional options for display configuration
+      # @option options [String] :class CSS classes for the display
       # @option options [Class] :namespace_klass Custom namespace class
       # @option options [Class] :builder_klass Custom field builder class
-      def initialize(record, action: nil, method: nil, attributes: {}, **options)
-        @form_action = action
-        @form_method = method
-        @form_class = options.delete(:class)
+      def initialize(record, attributes: {}, **options)
+        @display_class = options.delete(:class)
         @attributes = attributes
-        @namespace_klass = options.delete(:namespace_klass) || default_namespace_klass
-        @builder_klass = options.delete(:builder_klass) || default_builder_klass
+        @namespace_klass = options.delete(:namespace_klass) || self.class::Namespace
+        @builder_klass = options.delete(:builder_klass) || self.class::Builder
         @options = options
 
         initialize_object_and_key(record)
         initialize_namespace
-        initialize_attributes
       end
 
-      # Renders the form template.
+      # Renders the display template.
       #
       # @return [void]
       def view_template
-        form_tag { form_template }
+        display_template
       end
 
-      # Executes the form's content block.
-      # Override this in subclasses to defie a static form.
+      # Executes the display's content block.
+      # Override this in subclasses to define a static display.
       #
       # @return [void]
-      def form_template
+      def display_template
         instance_exec(&@_content_block) if @_content_block
       end
 
-      # Renders the form tag with its contents.
-      #
-      # @yield The form's content
-      # @return [void]
-      def form_tag(&)
-        form(**form_attributes) do
-          render_hidden_method_field
-          render_authenticity_token if authenticity_token?
-          yield
-        end
-      end
-
-      def extract_input(params)
-        call unless @_rendered
-        @namespace.extract_input(params)
-      end
-
       protected
 
       attr_reader :options, :attributes, :namespace_klass, :builder_klass
 
       # Initializes the object and key based on the given record.
       #
-      # @param record [ActiveModel::Model, Symbol, String] The form's associated record or key
+      # @param record [ActiveModel::Model, Symbol, String] The display's associated record or key
       # @return [void]
       def initialize_object_and_key(record)
-        # always pop these keys
-        # add support for `as` to make it more rails friendly
         @key = options.delete(:key) || options.delete(:as)
 
         case record
@@ -102,141 +76,35 @@ module Phlexi
         else
           @object = record
           if @key.nil?
-            unless object.respond_to?(:model_name) && object.model_name.respond_to?(:param_key) && object.model_name.param_key.present?
-              raise ArgumentError, "record must respond to #model_name.param_key with a non nil value or set `key` option e.g. Phlexi::Display(record, key: :record)"
+            @key = if object.respond_to?(:model_name) && object.model_name.respond_to?(:param_key) && object.model_name.param_key.present?
+              object.model_name.param_key
+            else
+              object.class.name.demodulize.underscore
             end
-            @key = object.model_name.param_key
           end
         end
         @key = @key.to_sym
       end
 
-      # Initializes the namespace for the form.
+      # Initializes the namespace for the display.
       #
       # @return [void]
       def initialize_namespace
         @namespace = namespace_klass.root(key, object: object, builder_klass: builder_klass)
       end
-
-      # Initializes form attributes.
-      #
-      # @return [void]
-      def initialize_attributes
-        attributes.fetch(:accept_charset) { attributes[:accept_charset] = "UTF-8" }
-      end
-
-      # Determines the form's action URL.
-      #
-      # @return [String, nil] The form's action URL
-      def form_action
-        puts ""
-        # if @form_action != false
-        #   @form_action ||= if options[:format].nil?
-        #     polymorphic_path(object, {})
-        #   else
-        #     polymorphic_path(object, format: options[:format])
-        #   end
-        # end
-        @form_action
-      end
-
-      # Determines the form's HTTP method.
+      # Retrieves the display's CSS classes.
       #
-      # @return [ActiveSupport::StringInquirer] The form's HTTP method
-      def form_method
-        @form_method ||= (object_form_method || "get").to_s.downcase
-        ActiveSupport::StringInquirer.new(@form_method)
-      end
+      # @return [String] The display's CSS classes
+      attr_reader :display_class
 
-      # Retrieves the form's CSS classes.
+      # Generates the display attributes hash.
       #
-      # @return [String] The form's CSS classes
-      attr_reader :form_class
-
-      # Checks if the authenticity token should be included.
-      #
-      # @return [Boolean] True if the authenticity token should be included, false otherwise
-      def authenticity_token?
-        defined?(helpers) && options.fetch(:authenticity_token) { !form_method.get? }
-      end
-
-      # Retrieves the authenticity token.
-      #
-      # @return [String] The authenticity token
-      def authenticity_token
-        options.fetch(:authenticity_token) { helpers.form_authenticity_token }
-      end
-
-      # Renders the authenticity token field.
-      #
-      # @param name [String] The name attribute for the authenticity token field
-      # @param value [String] The value for the authenticity token field
-      # @return [void]
-      def authenticity_token_field(name = "authenticity_token", value = authenticity_token)
-        input(name: name, value: value, type: "hidden", hidden: true)
-      end
-
-      # Determines the appropriate form method based on the object's state.
-      #
-      # @return [String, nil] The appropriate form method
-      def object_form_method
-        if object.respond_to?(:persisted?)
-          object.persisted? ? "patch" : "post"
-        elsif object.present?
-          "post"
-        end
-      end
-
-      # Renders the hidden method field for non-standard HTTP methods.
-      #
-      # @return [void]
-      def render_hidden_method_field
-        return if standard_form_method?
-        input(name: "_method", value: form_method, type: "hidden", hidden: true)
-      end
-
-      # Checks if the form method is standard (GET or POST).
-      #
-      # @return [Boolean] True if the form method is standard, false otherwise
-      def standard_form_method?
-        form_method.get? || form_method.post?
-      end
-
-      # Returns the standardized form method for the HTML form tag.
-      #
-      # @return [String] The standardized form method
-      def standardized_form_method
-        standard_form_method? ? form_method : "post"
-      end
-
-      # Generates the form attributes hash.
-      #
-      # @return [Hash] The form attributes
-      def form_attributes
-        {
+      # @return [Hash] The display attributes
+      def display_attributes
+        mix({
           id: @namespace.dom_id,
-          action: form_action,
-          method: standardized_form_method,
-          class: form_class,
-          **attributes
-        }
-      end
-
-      # Renders the authenticity token if required.
-      #
-      # @return [void]
-      def render_authenticity_token
-        authenticity_token_field
-      end
-
-      private
-
-      def default_namespace_klass
-        self.class::Namespace
-      end
-
-      def default_builder_klass
-        self.class::FieldBuilder
+          class: display_class
+        }, attributes)
       end
     end
   end

data/lib/phlexi/display/builder.rb

@@ -0,0 +1,117 @@
+# frozen_string_literal: true
+
+require "phlex"
+
+module Phlexi
+  module Display
+    # Builder 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 Builder < Phlexi::Field::Builder
+      # Creates a label tag for the field.
+      #
+      # @param attributes [Hash] Additional attributes for the label.
+      # @return [Components::Label] The label component.
+      def label_tag(**, &)
+        create_component(Components::Label, :label, **, &)
+      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(**, &)
+        create_component(Components::Placeholder, :placeholder, **, &)
+      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(**, &)
+        create_component(Components::Description, :description, **, &)
+      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(**, &)
+        create_component(Components::String, :string, **, &)
+      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(**, &)
+      #   create_component(Components::Text, :text, **, &)
+      # 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(**, &)
+        create_component(Components::Number, :number, **, &)
+      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(**, &)
+        create_component(Components::DateTime, :datetime, **, &)
+      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(**, &)
+      #   create_component(Components::Boolean, :boolean, **, &)
+      # 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(**, &)
+      #   create_component(Components::Association, :association, **, &)
+      # 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(**, &)
+      #   create_component(Components::Attachment, :attachment, **, &)
+      # 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(**, &)
+        create_component(Components::Wrapper, :wrapper, **, &)
+      end
+
+      protected
+
+      def create_component(component_class, theme_key, **attributes, &)
+        theme_key = attributes.delete(:theme) || theme_key
+        attributes = mix({class: themed(theme_key)}, attributes) unless attributes.key?(:class!)
+        component_class.new(self, **attributes, &)
+      end
+
+      def themed(component)
+        Phlexi::Display::Theme.instance.resolve_theme(component)
+      end
+    end
+  end
+end

data/lib/phlexi/display/components/base.rb

@@ -3,49 +3,8 @@
 module Phlexi
   module Display
     module Components
-      class Base < COMPONENT_BASE
-        attr_reader :field, :attributes
-
-        def initialize(field, **attributes)
-          @field = field
-          @attributes = attributes
-
-          build_attributes
-          append_attribute_classes
-        end
-
-        protected
-
-        def build_attributes
-          attributes.fetch(:id) { attributes[:id] = "#{field.dom.id}_#{component_name}" }
-        end
-
-        def append_attribute_classes
-          return if attributes[:class] == false
-
-          attributes[:class] = tokens(
-            component_name,
-            attributes[:class],
-            -> { attributes[:required] } => "required",
-            -> { !attributes[:required] } => "optional",
-            -> { field.has_errors? } => "invalid",
-            -> { attributes[:readonly] } => "readonly",
-            -> { attributes[:disabled] } => "disabled"
-          )
-        end
-
-        def component_name
-          @component_name ||= self.class.name.demodulize.underscore
-        end
+      class Base < Phlexi::Field::Components::Base
       end
     end
   end
 end
-
-
-
-User
- name: :string
- validate :name, presence: true
-
-f.input :name

data/lib/phlexi/display/components/concerns/displays_value.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module Phlexi
+  module Display
+    module Components
+      module Concerns
+        module DisplaysValue
+          def view_template
+            value = normalize_value(field.value)
+            if value.blank?
+              render field.placeholder_tag(**@placeholder_attributes)
+            else
+              render_value(value)
+            end
+          end
+
+          # Renders the field value for display.
+          #
+          # @return [String] the formatted field value for display.
+          def render_value(value)
+            raise NotImplementedError, "#{self.class}#render_value"
+            # format_value()
+          end
+
+          protected
+
+          def build_attributes
+            super
+
+            @placeholder_attributes = attributes.delete(:placeholder_attributes) || {}
+            attributes[:id] = field.dom.id if attributes[:id] == "#{field.dom.id}_#{component_name}"
+          end
+
+          # def format_value(value)
+          #   case value
+          #   when Array
+          #     format_array_value(value)
+          #   else
+          #     format_single_value(value)
+          #   end
+          # end
+
+          # def format_array_value(array)
+          #   array.map { |item| format_single_value(item) }.join(", ")
+          # end
+
+          def normalize_value(value)
+            value.to_s
+          end
+        end
+      end
+    end
+  end
+end

data/lib/phlexi/display/components/date_time.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module Phlexi
+  module Display
+    module Components
+      class DateTime < Base
+        include Concerns::DisplaysValue
+
+        # Renders the date time value
+        #
+        # @param value [String, Date, Time, DateTime] The value to be rendered
+        # @return [void]
+        def render_value(value)
+          formatted_value = format_date_time(value)
+          p(**attributes) { formatted_value }
+        end
+
+        protected
+
+        def build_attributes
+          super
+
+          @options = {
+            format: default_format
+          }.merge(attributes.delete(:options) || {}).compact
+        end
+
+        private
+
+        def format_date_time(value)
+          I18n.l(value, **@options)
+        end
+
+        def default_format
+          :long
+        end
+
+        def normalize_value(value)
+          case value
+          when Date, DateTime, Time, nil
+            value
+          else
+            raise ArgumentError, "Value must be a Date, DateTime or Time object. #{value.inspect} given."
+          end
+        end
+      end
+    end
+  end
+end

data/lib/phlexi/display/components/{error.rb → description.rb}

@@ -3,17 +3,17 @@
 module Phlexi
   module Display
     module Components
-      class Error < Base
+      class Description < Base
         def view_template
-          p(**attributes) do
-            field.error
-          end
+          p(**attributes) {
+            field.description
+          }
         end
 
         private
 
         def render?
-          field.show_errors? && field.has_errors?
+          field.has_description?
         end
       end
     end

data/lib/phlexi/display/components/hint.rb

@@ -13,7 +13,7 @@ module Phlexi
         private
 
         def render?
-          field.hint.present? && (!field.show_errors? || !field.has_errors?)
+          field.has_hint?
         end
       end
     end

data/lib/phlexi/display/components/label.rb

@@ -5,21 +5,9 @@ module Phlexi
     module Components
       class Label < Base
         def view_template
-          label(**attributes) do
-            if field.required?
-              abbr(title: "required") { "*" }
-              whitespace
-            end
-            plain field.label
-          end
-        end
-
-        protected
-
-        def build_attributes
-          super
-
-          attributes.fetch(:for) { attributes[:for] = field.dom.id }
+          h5(**attributes) {
+            field.label
+          }
         end
       end
     end

data/lib/phlexi/display/components/number.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require "active_support/number_helper"
+
+module Phlexi
+  module Display
+    module Components
+      class Number < Base
+        include Concerns::DisplaysValue
+
+        def render_value(value)
+          p(**attributes) {
+            format_number(value)
+          }
+        end
+
+        protected
+
+        def build_attributes
+          super
+
+          @options = attributes.delete(:options) || {}
+        end
+
+        private
+
+        def format_number(value)
+          ActiveSupport::NumberHelper.number_to_delimited(value, **@options)
+        end
+
+        def normalize_value(value)
+          Float(value.to_s)
+        end
+      end
+    end
+  end
+end

data/lib/phlexi/display/components/placeholder.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Phlexi
+  module Display
+    module Components
+      class Placeholder < Base
+        def view_template
+          p(**attributes) {
+            field.placeholder
+          }
+        end
+      end
+    end
+  end
+end