phlexi-display 0.0.3 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3de078e9bdc0e066c1b4f3af7b9b8ef966faf1fec3779358b79fb969ff6ebdf8
-  data.tar.gz: 3ac581e38926c8adaf04ce1b312741d1978d7223aa83df42c18723db7be8382b
+  metadata.gz: 6f519ac0a922ec274d4a45f66208e470d807f7d2fc34f9154ca6758c0de77b8c
+  data.tar.gz: d0a493ad4678d4d41ae0b0e06cdd53b510d72208e45c0fe59d1c351c5392dd62
 SHA512:
-  metadata.gz: a90ec354ee5aa5a18156b6dff6e5c4b0b5220adf2a11e94004595cba305723d8398de25d6e356e0381305378800e48b188404c0c13fd42c597ead9937760eea1
-  data.tar.gz: 3f7a054aa04d8b3862e618370035fed1d89725fcde4ae13792122085c6301f0ea664c8c7064986ad629a7caab367617200f1677f84ef4fd473bd62393edde3d4
+  metadata.gz: e1ac7dfb74665e852aa8e39f14b2dc85583ba8201da09cb22f6821147e7538b9503035285c285ad7dd530ade7b0e5ab9df6f02c4f0b7d5ef3594295235592b5e
+  data.tar.gz: e4a83a95a323eecbdfca20af2601b9291311b9292eae6de6888b3279ba52889bdf0d09b8988d0972377660215a8a10fad5d6eeda4daa0dbbbdbc630dc385a803

data/lib/phlexi/display/base.rb

@@ -15,10 +15,18 @@ module Phlexi
     #
     # @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 Base < Phlexi::Display::HTML
       class Namespace < Phlexi::Field::Structure::Namespace; end
 
-      class Builder < Builder; end
+      class Builder < Phlexi::Display::Builder; end
+
+      def self.inline(*, **, &block)
+        raise ArgumentError, "block is required" unless block
+
+        new(*, **) do |f|
+          f.instance_exec(&block)
+        end
+      end
 
       attr_reader :key, :object
 
@@ -33,7 +41,6 @@ module Phlexi
       # @option options [Class] :namespace_klass Custom namespace class
       # @option options [Class] :builder_klass Custom field builder class
       def initialize(record, attributes: {}, **options)
-        @display_class = options.delete(:class)
         @attributes = attributes
         @namespace_klass = options.delete(:namespace_klass) || self.class::Namespace
         @builder_klass = options.delete(:builder_klass) || self.class::Builder
@@ -46,8 +53,8 @@ module Phlexi
       # Renders the display template.
       #
       # @return [void]
-      def view_template
-        display_template
+      def view_template(&)
+        display_wrapper { display_template(&) }
       end
 
       # Executes the display's content block.
@@ -55,7 +62,7 @@ module Phlexi
       #
       # @return [void]
       def display_template
-        instance_exec(&@_content_block) if @_content_block
+        yield if block_given?
       end
 
       protected
@@ -92,10 +99,13 @@ module Phlexi
       def initialize_namespace
         @namespace = namespace_klass.root(key, object: object, builder_klass: builder_klass)
       end
+
       # Retrieves the display's CSS classes.
       #
       # @return [String] The display's CSS classes
-      attr_reader :display_class
+      def display_class
+        themed(:base)
+      end
 
       # Generates the display attributes hash.
       #
@@ -106,6 +116,12 @@ module Phlexi
           class: display_class
         }, attributes)
       end
+
+      def display_wrapper(&)
+        div(**display_attributes) do
+          yield
+        end
+      end
     end
   end
 end

data/lib/phlexi/display/builder.rb

@@ -5,13 +5,9 @@ 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
+      include Phlexi::Display::Options::InferredTypes
+
       # Creates a label tag for the field.
       #
       # @param attributes [Hash] Additional attributes for the label.
@@ -43,14 +39,15 @@ module Phlexi
       def string_tag(**, &)
         create_component(Components::String, :string, **, &)
       end
+      alias_method :search_tag, :string_tag
 
-      # # 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
+      def text_tag(**, &)
+        create_component(Components::String, :text, **, &)
+      end
+
+      def phone_tag(**, &)
+        create_component(Components::String, :phone, **, &)
+      end
 
       # Creates a number display tag for the field.
       #
@@ -60,6 +57,18 @@ module Phlexi
         create_component(Components::Number, :number, **, &)
       end
 
+      def integer_tag(**, &)
+        create_component(Components::Integer, :integer, **, &)
+      end
+
+      def json_tag(**, &)
+        create_component(Components::JSON, :json, **, &)
+      end
+
+      def hstore_tag(**, &)
+        create_component(Components::JSON, :hstore, **, &)
+      end
+
       # Creates a datetime display for the field.
       #
       # @param attributes [Hash] Additional attributes for the datetime display.
@@ -68,6 +77,14 @@ module Phlexi
         create_component(Components::DateTime, :datetime, **, &)
       end
 
+      def date_tag(**, &)
+        create_component(Components::DateTime, :date, **, &)
+      end
+
+      def time_tag(**, &)
+        create_component(Components::Time, :time, **, &)
+      end
+
       # # Creates a boolean display tag for the field.
       # #
       # # @param attributes [Hash] Additional attributes for the boolean display.
@@ -76,13 +93,53 @@ module Phlexi
       #   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 a color display tag for the field.
+      #
+      # @param attributes [Hash] Additional attributes for the color display.
+      # @return [Components::Color] The color component.
+      def color_tag(**, &)
+        create_component(Components::Color, :color, **, &)
+      end
+
+      # Creates a password display tag for the field.
+      #
+      # @param attributes [Hash] Additional attributes for the password display.
+      # @return [Components::Password] The password component.
+      def password_tag(**, &)
+        create_component(Components::Password, :password, **, &)
+      end
+
+      # Creates a enum display tag for the field.
+      #
+      # @param attributes [Hash] Additional attributes for the enum display.
+      # @return [Components::Enum] The enum component.
+      def enum_tag(**, &)
+        create_component(Components::Enum, :enum, **, &)
+      end
+
+      # Creates a email display tag for the field.
+      #
+      # @param attributes [Hash] Additional attributes for the email display.
+      # @return [Components::Email] The email component.
+      def email_tag(**, &)
+        create_component(Components::Email, :email, **, &)
+      end
+
+      # Creates a url display tag for the field.
+      #
+      # @param attributes [Hash] Additional attributes for the url display.
+      # @return [Components::Url] The url component.
+      def url_tag(**, &)
+        create_component(Components::Url, :url, **, &)
+      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.
       # #

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

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module Phlexi
+  module Display
+    module Components
+      class Association < Base
+        include Concerns::DisplaysValue
+
+        def render_value(value)
+          p(**attributes) {
+            display_name_of(value)
+          }
+        end
+
+        protected
+
+        def display_name_of(obj, separator: ", ")
+          return unless obj.present?
+
+          # Retrieve the value from a predefined list
+          %i[to_label name title].each do |method|
+            name = obj.public_send(method) if obj.respond_to?(method)
+            return name if name.present?
+          end
+
+          # Maybe this is a record?
+          if (primary_key = Phlexi::Field.object_primary_key(obj))
+            return "#{obj.class.model_name.human} ##{primary_key}"
+          end
+
+          # Oh well. Just convert it to a string.
+          obj.to_s
+        end
+
+        def normalize_value(value)
+          value
+        end
+      end
+    end
+  end
+end

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

@@ -4,6 +4,7 @@ module Phlexi
   module Display
     module Components
       class Base < Phlexi::Field::Components::Base
+        include Phlexi::Display::HTML::Behaviour
       end
     end
   end

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

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Phlexi
+  module Display
+    module Components
+      class Color < Base
+        include Concerns::DisplaysValue
+
+        def render_value(value)
+          div(**attributes) {
+            div(class: themed(:color_indicator), style: "background-color: #{value};") {
+              whitespace
+            }
+            p { value }
+          }
+        end
+      end
+    end
+  end
+end

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

@@ -6,11 +6,34 @@ module Phlexi
       module Concerns
         module DisplaysValue
           def view_template
-            value = normalize_value(field.value)
-            if value.blank?
-              render field.placeholder_tag(**@placeholder_attributes)
+            return render(field.placeholder_tag(**@placeholder_attributes)) unless field.has_value?
+
+            if field.multiple? && field.value.respond_to?(:each)
+              wrapped {
+                field.value.each { |value|
+                  value = normalize_value(value)
+                  render_value(value)
+                }
+              }
             else
-              render_value(value)
+              wrapped {
+                value = normalize_value(field.value)
+                render_value(value)
+              }
+            end
+          end
+
+          def wrapped(&)
+            div(
+              id: attributes.delete(:id),
+              class: tokens(component_name, "value_wrapper", themed(:value_wrapper), themed(:"#{component_name}_value_wrapper")),
+              &
+            )
+          end
+
+          def render_values(values)
+            values.each do |value|
+              render_value(normalize_value(value))
             end
           end
 
@@ -19,7 +42,6 @@ module Phlexi
           # @return [String] the formatted field value for display.
           def render_value(value)
             raise NotImplementedError, "#{self.class}#render_value"
-            # format_value()
           end
 
           protected
@@ -31,18 +53,12 @@ module Phlexi
             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 build_component_class
+            return if attributes[:class] == false
+
+            super
+            attributes[:class] = tokens(component_name, "value", attributes[:class].sub(component_name, ""))
+          end
 
           def normalize_value(value)
             value.to_s

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

@@ -11,8 +11,7 @@ module Phlexi
         # @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 }
+          p(**attributes) { value }
         end
 
         protected
@@ -20,27 +19,28 @@ module Phlexi
         def build_attributes
           super
 
-          @options = {
-            format: default_format
-          }.merge(attributes.delete(:options) || {}).compact
+          @options = attributes.delete(:options) || {}
+          @formats = Array(@options.delete(:format)).compact + default_formats
         end
 
-        private
-
-        def format_date_time(value)
-          I18n.l(value, **@options)
+        def format_value(value)
+          @formats.each do |fmt|
+            return I18n.l(value, **@options, format: fmt)
+          rescue
+            nil
+          end
         end
 
-        def default_format
-          :long
+        def default_formats
+          [:long]
         end
 
         def normalize_value(value)
           case value
-          when Date, DateTime, Time, nil
-            value
+          when ::DateTime, ::Date, ::Time
+            format_value(value)
           else
-            raise ArgumentError, "Value must be a Date, DateTime or Time object. #{value.inspect} given."
+            value.to_s
           end
         end
       end

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

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module Phlexi
+  module Display
+    module Components
+      class Email < Base
+        include Concerns::DisplaysValue
+
+        def render_value(value)
+          a(**attributes, href: "mailto:#{value}", target: "_blank") {
+            icon
+            plain value
+          }
+        end
+
+        protected
+
+        def icon
+          icon_theme = themed(:prefixed_icon)
+          svg(
+            xmlns: "http://www.w3.org/2000/svg",
+            width: icon_theme || "24",
+            height: icon_theme || "24",
+            class: icon_theme,
+            viewbox: "0 0 24 24",
+            fill: "none",
+            stroke: "currentColor",
+            stroke_width: "2",
+            stroke_linecap: "round",
+            stroke_linejoin: "round"
+          ) do |s|
+            s.path(stroke: "none", d: "M0 0h24v24H0z", fill: "none")
+            s.path(
+              d:
+                "M3 7a2 2 0 0 1 2 -2h14a2 2 0 0 1 2 2v10a2 2 0 0 1 -2 2h-14a2 2 0 0 1 -2 -2v-10z"
+            )
+            s.path(d: "M3 7l9 6l9 -6")
+          end
+        end
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require "active_support/number_helper"
+
+module Phlexi
+  module Display
+    module Components
+      class Integer < Number
+        private
+
+        def normalize_value(value)
+          value.to_i
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require "json"
+
+module Phlexi
+  module Display
+    module Components
+      class JSON < Base
+        include Concerns::DisplaysValue
+
+        def render_value(value)
+          pre(**attributes) {
+            value
+          }
+        end
+
+        private
+
+        def normalize_value(value)
+          ::JSON.pretty_generate(value)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Phlexi
+  module Display
+    module Components
+      class Password < Base
+        include Concerns::DisplaysValue
+
+        def render_value(value)
+          p(**attributes) {
+            value
+          }
+        end
+
+        protected
+
+        def normalize_value(value)
+          "••••••••"
+        end
+      end
+    end
+  end
+end

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

@@ -6,7 +6,7 @@ module Phlexi
       class Placeholder < Base
         def view_template
           p(**attributes) {
-            field.placeholder
+            field.placeholder || "-"
           }
         end
       end

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

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Phlexi
+  module Display
+    module Components
+      class Time < DateTime
+        protected
+
+        def default_formats
+          [:time, "%H:%M"]
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module Phlexi
+  module Display
+    module Components
+      class Url < Base
+        include Concerns::DisplaysValue
+
+        def render_value(value)
+          a(**attributes, href: value, target: "_blank") {
+            icon
+            plain value
+          }
+        end
+
+        protected
+
+        def icon
+          icon_theme = themed(:prefixed_icon)
+          svg(
+            xmlns: "http://www.w3.org/2000/svg",
+            width: icon_theme || "24",
+            height: icon_theme || "24",
+            class: icon_theme,
+            viewbox: "0 0 24 24",
+            fill: "none",
+            stroke: "currentColor",
+            stroke_width: "2",
+            stroke_linecap: "round",
+            stroke_linejoin: "round"
+          ) do |s|
+            s.path(stroke: "none", d: "M0 0h24v24H0z", fill: "none")
+            s.path(d: "M9 15l6 -6")
+            s.path(d: "M11 6l.463 -.536a5 5 0 0 1 7.071 7.072l-.534 .464")
+            s.path(
+              d:
+                "M13 18l-.397 .534a5.068 5.068 0 0 1 -7.127 0a4.972 4.972 0 0 1 0 -7.071l.524 -.463"
+            )
+          end
+        end
+      end
+    end
+  end
+end

data/lib/phlexi/display/html.rb

@@ -0,0 +1,15 @@
+module Phlexi
+  module Display
+    class HTML < (defined?(::ApplicationComponent) ? ::ApplicationComponent : Phlex::HTML)
+      module Behaviour
+        protected
+
+        def themed(component)
+          Phlexi::Display::Theme.instance.resolve_theme(component)
+        end
+      end
+
+      include Behaviour
+    end
+  end
+end

data/lib/phlexi/display/options/inferred_types.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Phlexi
+  module Display
+    module Options
+      module InferredTypes
+        private
+
+        def infer_field_component
+          case inferred_field_type
+          when :string, :text
+            infer_string_field_type || inferred_field_type
+          when :float, :decimal
+            :number
+          when :json, :jsonb
+            :json
+          # when :attachment, :binary
+          #   :attachment
+          # end
+          when :integer, :association, :hstore, :date, :time, :datetime
+            inferred_field_type
+          else
+            :string
+          end
+        end
+      end
+    end
+  end
+end

data/lib/phlexi/display/theme.rb

@@ -1,21 +1,35 @@
 module Phlexi
   module Display
-    class Theme
-      include Phlexi::Field::Theme
-
-      DEFAULT_THEME = {
-        label: nil,
-        description: nil,
-        placeholder: nil,
-        string: nil,
-        number: :string,
-        datetime: :string,
-        attachment: :string,
-        wrapper: nil
-      }.freeze
-
-      def theme
-        DEFAULT_THEME
+    class Theme < Phlexi::Field::Theme
+      def self.theme
+        @theme ||= {
+          base: nil,
+          label: nil,
+          description: nil,
+          placeholder: nil,
+          value_wrapper: nil,
+          string: nil,
+          text: :string,
+          phone: :string,
+          number: :string,
+          integer: :string,
+          datetime: :string,
+          date: :datetime,
+          time: :datetime,
+          association: :string,
+          attachment: :string,
+          color: :string,
+          color_icon: :string,
+          email: :string,
+          url: :email,
+          json: :string,
+          hstore: :json,
+          password: :string,
+          enum: :string,
+          prefixed_icon: nil,
+          link: nil,
+          wrapper: nil
+        }.freeze
       end
     end
   end

data/lib/phlexi/display/version.rb

@@ -2,6 +2,6 @@
 
 module Phlexi
   module Display
-    VERSION = "0.0.3"
+    VERSION = "0.0.5"
   end
 end

data/lib/phlexi/display.rb

@@ -12,20 +12,17 @@ module Phlexi
       loader.inflector.inflect(
         "phlexi-display" => "Phlexi",
         "phlexi" => "Phlexi",
-        "dom" => "DOM"
+        "html" => "HTML",
+        "json" => "JSON"
       )
       loader.push_dir(File.expand_path("..", __dir__))
       loader.setup
     end
 
-    COMPONENT_BASE = (defined?(::ApplicationComponent) ? ::ApplicationComponent : Phlex::HTML)
-
-    NIL_VALUE = :__i_phlexi_display_nil_value_i__
-
     class Error < StandardError; end
   end
 end
 
 def Phlexi.Display(...)
-  Phlexi::Display::Base.new(...)
+  Phlexi::Display::Base.inline(...)
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: phlexi-display
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.5
 platform: ruby
 authors:
 - Stefan Froelich
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-09-07 00:00:00.000000000 Z
+date: 2024-09-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: phlex
@@ -25,7 +25,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.11'
 - !ruby/object:Gem::Dependency
-  name: activesupport
+  name: phlexi-field
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -39,7 +39,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: zeitwerk
+  name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -53,7 +53,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: phlexi-field
+  name: zeitwerk
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -200,16 +200,27 @@ files:
 - lib/phlexi/display.rb
 - lib/phlexi/display/base.rb
 - lib/phlexi/display/builder.rb
+- lib/phlexi/display/components/association.rb
 - lib/phlexi/display/components/base.rb
+- lib/phlexi/display/components/color.rb
 - lib/phlexi/display/components/concerns/displays_value.rb
 - lib/phlexi/display/components/date_time.rb
 - lib/phlexi/display/components/description.rb
+- lib/phlexi/display/components/email.rb
+- lib/phlexi/display/components/enum.rb
 - lib/phlexi/display/components/hint.rb
+- lib/phlexi/display/components/integer.rb
+- lib/phlexi/display/components/json.rb
 - lib/phlexi/display/components/label.rb
 - lib/phlexi/display/components/number.rb
+- lib/phlexi/display/components/password.rb
 - lib/phlexi/display/components/placeholder.rb
 - lib/phlexi/display/components/string.rb
+- lib/phlexi/display/components/time.rb
+- lib/phlexi/display/components/url.rb
 - lib/phlexi/display/components/wrapper.rb
+- lib/phlexi/display/html.rb
+- lib/phlexi/display/options/inferred_types.rb
 - lib/phlexi/display/theme.rb
 - lib/phlexi/display/version.rb
 - sig/phlexi/display.rbs