phlexi-display 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b140e54c49ca3a4a8808a12bb7a91dd8d250c91e2d7d29a8d7f9be2c20a7dbf5
-  data.tar.gz: 9c70cec19581873bb9b93fc887571d6c8d5d65c95a25576bdf26a67e2bb30046
+  metadata.gz: 6269ae20b09b902ba613e2f158eae3de8c5b6a900264225a0580b97fb77e6ebe
+  data.tar.gz: 776a1c152a6e8e877f27747db06575c327ab042923b5068749631351938bae8a
 SHA512:
-  metadata.gz: 466d34728adaedd7c4669a7419ec53929e49e1b4466135e5a7cc1eb42c88aa196b344ca4e29d8f27fb56a1e83437500678a2b003ca95fc82bbf70ab1ad017afc
-  data.tar.gz: 047a28cd2c6afba47d9b6c8a833437ac2c009e626f747663dc9f506ef8d805b7979b8f59e4b0fe6e59a8180538d7e66cf323aba83e26e671e567ff12a3236a2c
+  metadata.gz: 6e0b53271d6d515923b6c05f0fd5d83a8f54e413058b0cd023a662e3a1e1d02c62f0205ccf411cd64daf22b1ae2457676aa9d52399444421a2cabe211509a352
+  data.tar.gz: 11bb8cd334e94ed31bcd096684cb1e7c844a13704df363dab0a540b0268440f0dcbf5a87973b7cd7ed7016e3bb45c8fe0ddbf0450a61332fd534bd0ae1f04e8d

data/lib/phlexi/display/base.rb

@@ -1,22 +1,20 @@
 # 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
 
@@ -24,22 +22,18 @@ module Phlexi
 
       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
@@ -47,52 +41,32 @@ module Phlexi
 
         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.
-      #
-      # @return [void]
-      def form_template
-        instance_exec(&@_content_block) if @_content_block
-      end
+      protected
+
+      attr_reader :options, :attributes, :namespace_klass, :builder_klass
 
-      # Renders the form tag with its contents.
+      # Executes the display's content block.
+      # Override this in subclasses to define a static display.
       #
-      # @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)
+      def display_template
+        instance_exec(&@_content_block) if @_content_block
       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
@@ -101,134 +75,37 @@ module Phlexi
           @key = record
         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)"
-            end
-            @key = object.model_name.param_key
+          @key = if @key.nil? && 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
           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.
-      #
-      # @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
-
-      # Retrieves the form's CSS classes.
-      #
-      # @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.
+      # Retrieves the display's CSS classes.
       #
-      # @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
+      # @return [String] The display's CSS classes
+      attr_reader :display_class
 
-      # Renders the hidden method field for non-standard HTTP methods.
+      # Generates the display attributes hash.
       #
-      # @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
         {
           id: @namespace.dom_id,
-          action: form_action,
-          method: standardized_form_method,
-          class: form_class,
+          class: display_class,
           **attributes
         }
       end
 
-      # Renders the authenticity token if required.
-      #
-      # @return [void]
-      def render_authenticity_token
-        authenticity_token_field
-      end
-
       private
 
       def default_namespace_klass

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

@@ -25,12 +25,7 @@ module Phlexi
 
           attributes[:class] = tokens(
             component_name,
-            attributes[:class],
-            -> { attributes[:required] } => "required",
-            -> { !attributes[:required] } => "optional",
-            -> { field.has_errors? } => "invalid",
-            -> { attributes[:readonly] } => "readonly",
-            -> { attributes[:disabled] } => "disabled"
+            attributes[:class]
           )
         end
 
@@ -41,11 +36,3 @@ module Phlexi
     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

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

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Phlexi
+  module Display
+    module Components
+      class String < Base
+        include Concerns::DisplaysValue
+
+        def render_value(value)
+          p(**attributes) {
+            value
+          }
+        end
+      end
+    end
+  end
+end

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

@@ -4,26 +4,12 @@ module Phlexi
   module Display
     module Components
       class Wrapper < Base
-        attr_reader :inner_attributes
-
         def view_template
-          div(**attributes) do
+          div(**attributes) {
             render field.label_tag
-            div(**inner_attributes) do
-              yield field if block_given?
-              render field.full_error_tag
-              render field.hint_tag
-            end
-          end
-        end
-
-        protected
-
-        def build_attributes
-          super
-
-          @inner_attributes = attributes.delete(:inner) || {}
-          inner_attributes[:class] = tokens("inner-wrapper", inner_attributes[:class])
+            yield field if block_given?
+            render field.description_tag
+          }
         end
       end
     end

data/lib/phlexi/display/field_options/associations.rb

@@ -6,8 +6,8 @@ module Phlexi
       module Associations
         protected
 
-        def reflection
-          @reflection ||= find_association_reflection
+        def association_reflection
+          @association_reflection ||= find_association_reflection
         end
 
         def find_association_reflection

data/lib/phlexi/display/field_options/attachments.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Phlexi
+  module Display
+    module FieldOptions
+      module Attachments
+        protected
+
+        def attachment_reflection
+          @attachment_reflection ||= find_attachment_reflection
+        end
+
+        def find_attachment_reflection
+          if object.class.respond_to?(:reflect_on_attachment)
+            object.class.reflect_on_attachment(key)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/phlexi/display/field_options/description.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Phlexi
+  module Display
+    module FieldOptions
+      module Description
+        def description(description = nil)
+          if description.nil?
+            options[:description]
+          else
+            options[:description] = description
+            self
+          end
+        end
+
+        def has_description?
+          description.present?
+        end
+      end
+    end
+  end
+end

data/lib/phlexi/display/field_options/hints.rb

@@ -14,7 +14,7 @@ module Phlexi
         end
 
         def has_hint?
-          options[:hint] != false && hint.present?
+          hint.present?
         end
       end
     end