phlexi-display 0.0.2 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6269ae20b09b902ba613e2f158eae3de8c5b6a900264225a0580b97fb77e6ebe
-  data.tar.gz: 776a1c152a6e8e877f27747db06575c327ab042923b5068749631351938bae8a
+  metadata.gz: b0c24a5fa14dc380439a665f86ab750dce0dfc4533960518e2ebd62c4a4a3a38
+  data.tar.gz: c3a8f5f8c11819831b77a43b30b6ddebce4cdc349b0a1087407b1cb3ca9e8860
 SHA512:
-  metadata.gz: 6e0b53271d6d515923b6c05f0fd5d83a8f54e413058b0cd023a662e3a1e1d02c62f0205ccf411cd64daf22b1ae2457676aa9d52399444421a2cabe211509a352
-  data.tar.gz: 11bb8cd334e94ed31bcd096684cb1e7c844a13704df363dab0a540b0268440f0dcbf5a87973b7cd7ed7016e3bb45c8fe0ddbf0450a61332fd534bd0ae1f04e8d
+  metadata.gz: 35e8e3cb43b9949317ed4ea0df9ff5fa98e408a3fd78f8ce16315343a91aed8748f6a987f068927f73c1c682e4f3c560d28f9876176de841987ef932f5afe0ec
+  data.tar.gz: 6a0016904df13b9c35e5463a0f5f5e72963c2766be0513e76b21d4bfd1c94258ced23e1a0d23487d6feb6ec1ed555556df8f01de5d73692d84d3e5a30e7f3181

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 Namespace < Structure::Namespace; end
+    class Base < Phlexi::Display::HTML
+      class Namespace < Phlexi::Field::Structure::Namespace; end
 
-      class FieldBuilder < Structure::FieldBuilder; 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,10 +41,9 @@ 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) || 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)
@@ -46,22 +53,22 @@ module Phlexi
       # Renders the display template.
       #
       # @return [void]
-      def view_template
-        display_template
+      def view_template(&)
+        display_wrapper { display_template(&) }
       end
 
-      protected
-
-      attr_reader :options, :attributes, :namespace_klass, :builder_klass
-
       # Executes the display's content block.
       # Override this in subclasses to define a static display.
       #
       # @return [void]
       def display_template
-        instance_exec(&@_content_block) if @_content_block
+        yield if block_given?
       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 display's associated record or key
@@ -75,10 +82,12 @@ module Phlexi
           @key = record
         else
           @object = record
-          @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
+          if @key.nil?
+            @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
           end
         end
         @key = @key.to_sym
@@ -90,30 +99,28 @@ 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.
       #
       # @return [Hash] The display attributes
       def display_attributes
-        {
+        mix({
           id: @namespace.dom_id,
-          class: display_class,
-          **attributes
-        }
+          class: display_class
+        }, attributes)
       end
 
-      private
-
-      def default_namespace_klass
-        self.class::Namespace
-      end
-
-      def default_builder_klass
-        self.class::FieldBuilder
+      def display_wrapper(&)
+        div(**display_attributes) do
+          yield
+        end
       end
     end
   end

data/lib/phlexi/display/builder.rb

@@ -0,0 +1,174 @@
+# frozen_string_literal: true
+
+require "phlex"
+
+module Phlexi
+  module Display
+    # Builder class is responsible for building display fields with various options and components.
+    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.
+      # @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
+      alias_method :search_tag, :string_tag
+
+      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.
+      #
+      # @param attributes [Hash] Additional attributes for the number display.
+      # @return [Components::Number] The number component.
+      def number_tag(**, &)
+        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.
+      # @return [Components::DateTime] The datetime component.
+      def datetime_tag(**, &)
+        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.
+      # # @return [Components::Boolean] The boolean component.
+      # def boolean_tag(**, &)
+      #   create_component(Components::Boolean, :boolean, **, &)
+      # 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.
+      # #
+      # # @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/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

@@ -3,35 +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]
-          )
-        end
-
-        def component_name
-          @component_name ||= self.class.name.demodulize.underscore
-        end
+      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,11 @@ module Phlexi
       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)
+            return render(field.placeholder_tag(**@placeholder_attributes)) unless field.has_value?
+
+            values = (field.multiple? && field.value.respond_to?(:each)) ? field.value : [field.value]
+            values.each do |value|
+              render_value(normalize_value(value))
             end
           end
 
@@ -19,7 +19,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,19 +30,6 @@ 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 normalize_value(value)
             value.to_s
           end

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