phlexi-field 0.0.1

data/gemfiles/rails_7.gemfile.lock

@@ -0,0 +1,282 @@
+PATH
+  remote: ..
+  specs:
+    phlexi-form (0.3.0.rc1)
+      activesupport
+      phlex (~> 1.11)
+      zeitwerk
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actioncable (7.1.3.4)
+      actionpack (= 7.1.3.4)
+      activesupport (= 7.1.3.4)
+      nio4r (~> 2.0)
+      websocket-driver (>= 0.6.1)
+      zeitwerk (~> 2.6)
+    actionmailbox (7.1.3.4)
+      actionpack (= 7.1.3.4)
+      activejob (= 7.1.3.4)
+      activerecord (= 7.1.3.4)
+      activestorage (= 7.1.3.4)
+      activesupport (= 7.1.3.4)
+      mail (>= 2.7.1)
+      net-imap
+      net-pop
+      net-smtp
+    actionmailer (7.1.3.4)
+      actionpack (= 7.1.3.4)
+      actionview (= 7.1.3.4)
+      activejob (= 7.1.3.4)
+      activesupport (= 7.1.3.4)
+      mail (~> 2.5, >= 2.5.4)
+      net-imap
+      net-pop
+      net-smtp
+      rails-dom-testing (~> 2.2)
+    actionpack (7.1.3.4)
+      actionview (= 7.1.3.4)
+      activesupport (= 7.1.3.4)
+      nokogiri (>= 1.8.5)
+      racc
+      rack (>= 2.2.4)
+      rack-session (>= 1.0.1)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.2)
+      rails-html-sanitizer (~> 1.6)
+    actiontext (7.1.3.4)
+      actionpack (= 7.1.3.4)
+      activerecord (= 7.1.3.4)
+      activestorage (= 7.1.3.4)
+      activesupport (= 7.1.3.4)
+      globalid (>= 0.6.0)
+      nokogiri (>= 1.8.5)
+    actionview (7.1.3.4)
+      activesupport (= 7.1.3.4)
+      builder (~> 3.1)
+      erubi (~> 1.11)
+      rails-dom-testing (~> 2.2)
+      rails-html-sanitizer (~> 1.6)
+    activejob (7.1.3.4)
+      activesupport (= 7.1.3.4)
+      globalid (>= 0.3.6)
+    activemodel (7.1.3.4)
+      activesupport (= 7.1.3.4)
+    activerecord (7.1.3.4)
+      activemodel (= 7.1.3.4)
+      activesupport (= 7.1.3.4)
+      timeout (>= 0.4.0)
+    activestorage (7.1.3.4)
+      actionpack (= 7.1.3.4)
+      activejob (= 7.1.3.4)
+      activerecord (= 7.1.3.4)
+      activesupport (= 7.1.3.4)
+      marcel (~> 1.0)
+    activesupport (7.1.3.4)
+      base64
+      bigdecimal
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      connection_pool (>= 2.2.5)
+      drb
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      mutex_m
+      tzinfo (~> 2.0)
+    addressable (2.8.7)
+      public_suffix (>= 2.0.2, < 7.0)
+    ansi (1.5.0)
+    appraisal (2.5.0)
+      bundler
+      rake
+      thor (>= 0.14.0)
+    ast (2.4.2)
+    base64 (0.2.0)
+    bigdecimal (3.1.8)
+    builder (3.3.0)
+    bundle-audit (0.1.0)
+      bundler-audit
+    bundler-audit (0.9.1)
+      bundler (>= 1.2.0, < 3)
+      thor (~> 1.0)
+    capybara (3.40.0)
+      addressable
+      matrix
+      mini_mime (>= 0.1.3)
+      nokogiri (~> 1.11)
+      rack (>= 1.6.0)
+      rack-test (>= 0.6.3)
+      regexp_parser (>= 1.5, < 3.0)
+      xpath (~> 3.2)
+    combustion (1.5.0)
+      activesupport (>= 3.0.0)
+      railties (>= 3.0.0)
+      thor (>= 0.14.6)
+    concurrent-ruby (1.3.3)
+    connection_pool (2.4.1)
+    crass (1.0.6)
+    date (3.3.4)
+    drb (2.2.1)
+    erubi (1.13.0)
+    globalid (1.2.1)
+      activesupport (>= 6.1)
+    i18n (1.14.5)
+      concurrent-ruby (~> 1.0)
+    io-console (0.7.2)
+    irb (1.14.0)
+      rdoc (>= 4.0.0)
+      reline (>= 0.4.2)
+    json (2.7.2)
+    language_server-protocol (3.17.0.3)
+    lint_roller (1.1.0)
+    loofah (2.22.0)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.12.0)
+    mail (2.8.1)
+      mini_mime (>= 0.1.1)
+      net-imap
+      net-pop
+      net-smtp
+    marcel (1.0.4)
+    matrix (0.4.2)
+    mini_mime (1.1.5)
+    minitest (5.24.1)
+    minitest-reporters (1.7.1)
+      ansi
+      builder
+      minitest (>= 5.0)
+      ruby-progressbar
+    mutex_m (0.2.0)
+    net-imap (0.4.14)
+      date
+      net-protocol
+    net-pop (0.1.2)
+      net-protocol
+    net-protocol (0.2.2)
+      timeout
+    net-smtp (0.5.0)
+      net-protocol
+    nio4r (2.7.3)
+    nokogiri (1.16.7-x86_64-darwin)
+      racc (~> 1.4)
+    parallel (1.25.1)
+    parser (3.3.4.0)
+      ast (~> 2.4.1)
+      racc
+    phlex (1.11.0)
+    phlex-testing-capybara (0.1.0)
+      capybara (~> 3.38)
+      phlex (>= 0.5)
+    psych (5.1.2)
+      stringio
+    public_suffix (6.0.1)
+    racc (1.8.1)
+    rack (3.1.7)
+    rack-session (2.0.0)
+      rack (>= 3.0.0)
+    rack-test (2.1.0)
+      rack (>= 1.3)
+    rackup (2.1.0)
+      rack (>= 3)
+      webrick (~> 1.8)
+    rails (7.1.3.4)
+      actioncable (= 7.1.3.4)
+      actionmailbox (= 7.1.3.4)
+      actionmailer (= 7.1.3.4)
+      actionpack (= 7.1.3.4)
+      actiontext (= 7.1.3.4)
+      actionview (= 7.1.3.4)
+      activejob (= 7.1.3.4)
+      activemodel (= 7.1.3.4)
+      activerecord (= 7.1.3.4)
+      activestorage (= 7.1.3.4)
+      activesupport (= 7.1.3.4)
+      bundler (>= 1.15.0)
+      railties (= 7.1.3.4)
+    rails-dom-testing (2.2.0)
+      activesupport (>= 5.0.0)
+      minitest
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.6.0)
+      loofah (~> 2.21)
+      nokogiri (~> 1.14)
+    railties (7.1.3.4)
+      actionpack (= 7.1.3.4)
+      activesupport (= 7.1.3.4)
+      irb
+      rackup (>= 1.0.0)
+      rake (>= 12.2)
+      thor (~> 1.0, >= 1.2.2)
+      zeitwerk (~> 2.6)
+    rainbow (3.1.1)
+    rake (13.2.1)
+    rdoc (6.7.0)
+      psych (>= 4.0.0)
+    regexp_parser (2.9.2)
+    reline (0.5.9)
+      io-console (~> 0.5)
+    rexml (3.3.2)
+      strscan
+    rubocop (1.64.1)
+      json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
+      parallel (~> 1.10)
+      parser (>= 3.3.0.2)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.31.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.31.3)
+      parser (>= 3.3.1.0)
+    rubocop-performance (1.21.1)
+      rubocop (>= 1.48.1, < 2.0)
+      rubocop-ast (>= 1.31.1, < 2.0)
+    ruby-progressbar (1.13.0)
+    sqlite3 (1.7.3-x86_64-darwin)
+    standard (1.39.2)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.0)
+      rubocop (~> 1.64.0)
+      standard-custom (~> 1.0.0)
+      standard-performance (~> 1.4)
+    standard-custom (1.0.2)
+      lint_roller (~> 1.0)
+      rubocop (~> 1.50)
+    standard-performance (1.4.0)
+      lint_roller (~> 1.1)
+      rubocop-performance (~> 1.21.0)
+    stringio (3.1.1)
+    strscan (3.1.0)
+    thor (1.3.1)
+    timeout (0.4.1)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.5.0)
+    webrick (1.8.1)
+    websocket-driver (0.7.6)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.5)
+    xpath (3.2.0)
+      nokogiri (~> 1.8)
+    zeitwerk (2.6.17)
+
+PLATFORMS
+  x86_64-darwin
+
+DEPENDENCIES
+  appraisal
+  bundle-audit
+  combustion
+  minitest
+  minitest-reporters
+  phlex-testing-capybara
+  phlexi-form!
+  rails (~> 7.1.3, >= 7.1.3.4)
+  rake
+  sqlite3 (~> 1.4)
+  standard
+
+BUNDLED WITH
+   2.5.16

data/lib/phlexi/field/builder.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+require "phlex"
+
+module Phlexi
+  module Field
+    # Builder class is responsible for building 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 < Structure::Node
+      include Phlex::Helpers
+      include Options::Associations
+      include Options::Attachments
+      include Options::Descriptions
+      include Options::Hints
+      include Options::InferredTypes
+      include Options::Labels
+      include Options::Placeholders
+
+      class DOM < Structure::DOM; end
+
+      class FieldCollection < Structure::FieldCollection; end
+
+      attr_reader :dom, :options, :object, :value
+
+      # Initializes a new FieldBuilder instance.
+      #
+      # @param key [Symbol, String] The key for the field.
+      # @param parent [Structure::Namespace] The parent object.
+      # @param object [Object, nil] The associated object.
+      # @param value [Object] The initial value for the field.
+      # @param options [Hash] Additional options for the field.
+      def initialize(key, parent:, object: nil, value: NIL_VALUE, **options)
+        super(key, parent: parent)
+
+        @object = object
+        @value = determine_initial_value(value)
+        @options = options
+        @dom = self.class::DOM.new(field: self)
+      end
+
+      # Creates a repeated field collection.
+      #
+      # @param range [#each] The collection of items to generate displays for.
+      # @yield [block] The block to be executed for each item in the collection.
+      # @return [FieldCollection] The field collection.
+      def repeated(collection = nil, &)
+        self.class::FieldCollection.new(field: self, collection:, &)
+      end
+
+      protected
+
+      def has_value?
+        value.present?
+      end
+
+      def determine_initial_value(value)
+        return value unless value == NIL_VALUE
+
+        determine_value_from_object
+      end
+
+      def determine_value_from_object
+        object.respond_to?(key) ? object.public_send(key) : nil
+      end
+    end
+  end
+end

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

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Phlexi
+  module Field
+    module Components
+      class Base < COMPONENT_BASE
+        attr_reader :field, :attributes
+
+        def initialize(field, **attributes)
+          @field = field
+          @attributes = attributes
+
+          build_attributes
+          build_component_class
+        end
+
+        protected
+
+        def build_attributes
+          attributes.fetch(:id) { attributes[:id] = "#{field.dom.id}_#{component_name}" }
+        end
+
+        def build_component_class
+          return if attributes[:class] == false
+
+          attributes[:class] = tokens(component_name, attributes[:class])
+        end
+
+        def component_name
+          @component_name ||= self.class.name.demodulize.underscore
+        end
+      end
+    end
+  end
+end

data/lib/phlexi/field/options/associations.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Phlexi
+  module Field
+    module Options
+      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/field/options/attachments.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Phlexi
+  module Field
+    module Options
+      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/field/options/descriptions.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Phlexi
+  module Field
+    module Options
+      module Descriptions
+        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/field/options/hints.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Phlexi
+  module Field
+    module Options
+      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/field/options/inferred_types.rb

@@ -0,0 +1,130 @@
+# frozen_string_literal: true
+
+require "bigdecimal"
+
+module Phlexi
+  module Field
+    module Options
+      module InferredTypes
+        def inferred_field_type
+          @inferred_field_type ||= infer_field_type
+        end
+
+        def inferred_field_component
+          @inferred_component ||= infer_field_component
+        end
+
+        private
+
+        def infer_field_component
+          case inferred_field_type
+          when :string, :text
+            infer_string_field_component(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_field_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&.type
+          end
+
+          # Check if object responds to the key
+          if object.respond_to?(key)
+            # Fallback to inferring type from the value
+            return infer_field_type_from_value(object.send(key))
+          end
+
+          # Default to string if we can't determine the type
+          :string
+        end
+
+        def infer_field_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_field_component(key)
+          key = key.to_s.downcase
+
+          return :password if is_password_field?
+
+          custom_type = custom_string_field_type(key)
+          return custom_type if custom_type
+
+          :text
+        end
+
+        def custom_string_field_type(key)
+          custom_mappings = {
+            /url$|^link|^site/ => :url,
+            /^email/ => :email,
+            /^search/ => :search,
+            /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", "_token"]
+
+          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/field/options/labels.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Phlexi
+  module Field
+    module Options
+      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/field/options/placeholders.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Phlexi
+  module Field
+    module Options
+      module Placeholders
+        def placeholder(placeholder = nil)
+          if placeholder.nil?
+            options[:placeholder]
+          else
+
+            options[:placeholder] = placeholder
+            self
+          end
+        end
+      end
+    end
+  end
+end