phlexi-display 0.0.2 → 0.0.4

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

@@ -0,0 +1,35 @@
+module Phlexi
+  module Display
+    class Theme < Phlexi::Field::Theme
+      def self.theme
+        @theme ||= {
+          base: nil,
+          label: nil,
+          description: nil,
+          placeholder: 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
+end

data/lib/phlexi/display/version.rb

@@ -2,6 +2,6 @@
 
 module Phlexi
   module Display
-    VERSION = "0.0.2"
+    VERSION = "0.0.4"
   end
 end

data/lib/phlexi/display.rb

@@ -2,6 +2,7 @@
 
 require "zeitwerk"
 require "phlex"
+require "phlexi-field"
 require "active_support/core_ext/object/blank"
 
 module Phlexi
@@ -11,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.2
+  version: 0.0.4
 platform: ruby
 authors:
 - Stefan Froelich
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-08-26 00:00:00.000000000 Z
+date: 2024-09-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: phlex
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: phlexi-field
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
@@ -185,31 +199,29 @@ files:
 - lib/phlexi-display.rb
 - 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/field_options/associations.rb
-- lib/phlexi/display/field_options/attachments.rb
-- lib/phlexi/display/field_options/description.rb
-- lib/phlexi/display/field_options/hints.rb
-- lib/phlexi/display/field_options/inferred_types.rb
-- lib/phlexi/display/field_options/labels.rb
-- lib/phlexi/display/field_options/placeholders.rb
-- lib/phlexi/display/field_options/themes.rb
-- lib/phlexi/display/option_mapper.rb
-- lib/phlexi/display/structure/dom.rb
-- lib/phlexi/display/structure/field_builder.rb
-- lib/phlexi/display/structure/field_collection.rb
-- lib/phlexi/display/structure/namespace.rb
-- lib/phlexi/display/structure/namespace_collection.rb
-- lib/phlexi/display/structure/node.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
 homepage: https://github.com/radioactive-labs/phlexi-display

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

@@ -1,21 +0,0 @@
-# frozen_string_literal: true
-
-module Phlexi
-  module Display
-    module FieldOptions
-      module Associations
-        protected
-
-        def association_reflection
-          @association_reflection ||= find_association_reflection
-        end
-
-        def find_association_reflection
-          if object.class.respond_to?(:reflect_on_association)
-            object.class.reflect_on_association(key)
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,21 +0,0 @@
-# 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

@@ -1,22 +0,0 @@
-# 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

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

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

@@ -1,129 +0,0 @@
-# frozen_string_literal: true
-
-require "bigdecimal"
-
-module Phlexi
-  module Display
-    module FieldOptions
-      module InferredTypes
-        def inferred_db_type
-          @inferred_db_type ||= infer_db_type
-        end
-
-        def inferred_display_component
-          @inferred_display_component ||= infer_display_component
-        end
-
-        private
-
-        def infer_display_component
-          case inferred_db_type
-          when :string, :text
-            infer_string_display_type(key)
-          when :integer, :float, :decimal
-            :number
-          when :date, :datetime, :time
-            :date
-          when :boolean
-            :boolean
-          when :json, :jsonb, :hstore
-            :code
-          else
-            if association_reflection
-              :association
-            elsif attachment_reflection
-              :attachment
-            else
-              :text
-            end
-          end
-        end
-
-        def infer_db_type
-          if object.class.respond_to?(:columns_hash)
-            # ActiveRecord object
-            column = object.class.columns_hash[key.to_s]
-            return column.type if column
-          end
-
-          if object.class.respond_to?(:attribute_types)
-            # ActiveModel::Attributes
-            custom_type = object.class.attribute_types[key.to_s]
-            return custom_type.type if custom_type
-          end
-
-          # Check if object responds to the key
-          if object.respond_to?(key)
-            # Fallback to inferring type from the value
-            return infer_db_type_from_value(object.send(key))
-          end
-
-          # Default to string if we can't determine the type
-          :string
-        end
-
-        def infer_db_type_from_value(value)
-          case value
-          when Integer
-            :integer
-          when Float
-            :float
-          when BigDecimal
-            :decimal
-          when TrueClass, FalseClass
-            :boolean
-          when Date
-            :date
-          when Time, DateTime
-            :datetime
-          when Hash
-            :json
-          else
-            :string
-          end
-        end
-
-        def infer_string_display_type(key)
-          key = key.to_s.downcase
-
-          return :password if is_password_field?
-
-          custom_type = custom_string_display_type(key)
-          return custom_type if custom_type
-
-          :text
-        end
-
-        def custom_string_display_type(key)
-          custom_mappings = {
-            /url$|^link|^site/ => :url,
-            /^email/ => :email,
-            /phone|tel(ephone)?/ => :phone,
-            /^time/ => :time,
-            /^date/ => :date,
-            /^number|_count$|_amount$/ => :number,
-            /^color/ => :color
-          }
-
-          custom_mappings.each do |pattern, type|
-            return type if key.match?(pattern)
-          end
-
-          nil
-        end
-
-        def is_password_field?
-          key = self.key.to_s.downcase
-
-          exact_matches = ["password"]
-          prefixes = ["encrypted_"]
-          suffixes = ["_password", "_digest", "_hash"]
-
-          exact_matches.include?(key) ||
-            prefixes.any? { |prefix| key.start_with?(prefix) } ||
-            suffixes.any? { |suffix| key.end_with?(suffix) }
-        end
-      end
-    end
-  end
-end

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

@@ -1,28 +0,0 @@
-# frozen_string_literal: true
-
-module Phlexi
-  module Display
-    module FieldOptions
-      module Labels
-        def label(label = nil)
-          if label.nil?
-            options[:label] = options.fetch(:label) { calculate_label }
-          else
-            options[:label] = label
-            self
-          end
-        end
-
-        private
-
-        def calculate_label
-          if object.class.respond_to?(:human_attribute_name)
-            object.class.human_attribute_name(key.to_s, {base: object})
-          else
-            key.to_s.humanize
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,18 +0,0 @@
-# frozen_string_literal: true
-
-module Phlexi
-  module Display
-    module FieldOptions
-      module Placeholders
-        def placeholder(placeholder = nil)
-          if placeholder.nil?
-            options[:placeholder] || "-"
-          else
-            options[:placeholder] = placeholder
-            self
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,132 +0,0 @@
-# frozen_string_literal: true
-
-module Phlexi
-  module Display
-    module FieldOptions
-      module Themes
-        # Resolves theme classes for components based on their type.
-        #
-        # This method is responsible for determining the appropriate CSS classes for a given display component.
-        # It supports a hierarchical theming system, allowing for cascading themes and easy customization.
-        #
-        # @param component [Symbol, String] The type of display component (e.g., :text, :date, :boolean)
-        #
-        # @return [String, nil] A string of CSS classes for the component, or nil if no theme is applied
-        #
-        # @example Basic usage
-        #   themed(:text)
-        #   # => "text-gray-700 text-sm"
-        #
-        # @example Cascading themes
-        #   # Assuming email inherits from text in the theme definition
-        #   themed(:email)
-        #   # => "text-gray-700 text-sm text-blue-600 underline"
-        #
-        # @note The actual CSS classes returned will depend on the theme definitions in the `theme` hash
-        #       and any overrides specified in the `options` hash.
-        #
-        # @see #resolve_theme
-        # @see #theme
-        def themed(component)
-          return unless component
-
-          resolve_theme(component)
-        end
-
-        protected
-
-        # Recursively resolves the theme for a given property, handling nested symbol references
-        #
-        # @param property [Symbol, String] The theme property to resolve
-        # @param visited [Set] Set of already visited properties to prevent infinite recursion
-        # @return [String, nil] The resolved theme value or nil if not found
-        #
-        # @example Resolving a nested theme
-        #   # Assuming the theme is: { email: :text, text: "text-gray-700" }
-        #   resolve_theme(:email)
-        #   # => "text-gray-700"
-        def resolve_theme(property, visited = Set.new)
-          return nil if !property.present? || visited.include?(property)
-          visited.add(property)
-
-          result = theme[property]
-          if result.is_a?(Symbol)
-            resolve_theme(result, visited)
-          else
-            result
-          end
-        end
-
-        # Retrieves or initializes the theme hash for the display builder.
-        #
-        # This method returns a hash containing theme definitions for various display components.
-        # If a theme has been explicitly set in the options, it returns that. Otherwise, it
-        # initializes and returns a default theme.
-        #
-        # The theme hash defines CSS classes or references to other theme keys for different
-        # components.
-        #
-        # @return [Hash] A hash containing theme definitions for display components
-        #
-        # @example Accessing the theme
-        #   theme[:text]
-        #   # => "text-gray-700 text-sm"
-        #
-        # @example Theme inheritance
-        #   theme[:email] # Returns :text, indicating email inherits text's theme
-        #
-        # @note The actual content of the theme hash depends on the default_theme method
-        #       and any theme overrides specified in the options when initializing the field builder.
-        #
-        # @see #default_theme
-        def theme
-          @theme ||= options[:theme] || default_theme
-        end
-
-        # Defines and returns the default theme hash for the display builder.
-        #
-        # This method returns a hash containing the base theme definitions for various components.
-        # It sets up the default styling and relationships between different components.
-        # The theme uses a combination of explicit CSS classes and symbolic references to other theme keys,
-        # allowing for a flexible and inheritance-based theming system.
-        #
-        # @return [Hash] A frozen hash containing default theme definitions for components
-        #
-        # @example Accessing the default theme
-        #   default_theme[:text]
-        #   # => "text-gray-700 text-sm"
-        #
-        # @example Theme inheritance
-        #   default_theme[:email]
-        #   # => :text (indicates that :email inherits from :text)
-        #
-        # @note This method returns a frozen hash to prevent accidental modifications.
-        #       To customize the theme, users should provide their own theme hash when initializing the display builder.
-        #
-        # @see #theme
-        def default_theme
-          {
-            label: "text-base font-bold text-gray-500 dark:text-gray-400 mb-1",
-            description: "text-sm text-gray-400 dark:text-gray-500",
-            placeholder: "text-xl font-semibold text-gray-500 dark:text-gray-300 mb-1 italic",
-            string: "text-xl font-semibold text-gray-900 dark:text-white mb-1",
-            # text: :string,
-            number: :string,
-            datetime: :string,
-            # boolean: :string,
-            # code: :string,
-            # email: :text,
-            # url: :text,
-            # phone: :text,
-            # color: :text,
-            # search: :text,
-            # password: :string,
-            # association: :string,
-            attachment: :string,
-            wrapper: nil
-          }.freeze
-        end
-      end
-    end
-  end
-end