phlexi-form 0.3.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d20cf0d6ccfcdf3cbb3a05a518b25a9b6176ef827e32f9cab47fddb43391f470
-  data.tar.gz: '0788efe146100a6629f679d913a080ff7cc2039881477bc9ffda16dfe0f6dc9f'
+  metadata.gz: aa37fb3ecaded18bae5e7be4d2773c227acc970c588eceb276214f39597cf5cf
+  data.tar.gz: cc06f9e6d21d87e66efe7eb4a27fd1b2e9721b14f9dab5b1ab7df5c74ff58834
 SHA512:
-  metadata.gz: 3e671e22b8daa6e5e243725f79302e26b9b1d5395d92a54013d0aed981bc9eb2dfd756d8214a69446e0328186b339dc21dd3e1853c5236270f048e974c4ae114
-  data.tar.gz: d7441ae010f74f188baf43b6ac90e5cdd49b88563a22261e223b11d3c20de6135e5f610c0f278eaae28d49bc3627df3ec0b3012fe49d5e41626751d15200fd26
+  metadata.gz: d37efe7ef9526991cce1495180edeacab2322c499302dab5e1118731bf2410e708e1404a6dfc1c3bebaf7846366fa05c57acc94669cc6caf60a798159ff9bf8b
+  data.tar.gz: ec2a45b47b89e0215cf034584d7d1d7cd5f60aa3fc640447492ba184a01069150879ddb101e7616b71fbde770222701df50ac96f0361e7a848967bc17c405885

data/README.md

@@ -159,7 +159,7 @@ Phlexi::Form supports theming through a flexible theming system:
 
 ```ruby
 class ThemedForm < Phlexi::Form::Base
-  class FieldBuilder < FieldBuilder
+  class Builder < Builder
     private
     
     def default_theme

data/gemfiles/default.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ..
   specs:
-    phlexi-form (0.3.0.rc1)
+    phlexi-form (0.3.1)
       activesupport
       phlex (~> 1.11)
       zeitwerk
@@ -9,32 +9,34 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    actionpack (7.1.3.4)
-      actionview (= 7.1.3.4)
-      activesupport (= 7.1.3.4)
+    actionpack (7.2.1)
+      actionview (= 7.2.1)
+      activesupport (= 7.2.1)
       nokogiri (>= 1.8.5)
       racc
-      rack (>= 2.2.4)
+      rack (>= 2.2.4, < 3.2)
       rack-session (>= 1.0.1)
       rack-test (>= 0.6.3)
       rails-dom-testing (~> 2.2)
       rails-html-sanitizer (~> 1.6)
-    actionview (7.1.3.4)
-      activesupport (= 7.1.3.4)
+      useragent (~> 0.16)
+    actionview (7.2.1)
+      activesupport (= 7.2.1)
       builder (~> 3.1)
       erubi (~> 1.11)
       rails-dom-testing (~> 2.2)
       rails-html-sanitizer (~> 1.6)
-    activesupport (7.1.3.4)
+    activesupport (7.2.1)
       base64
       bigdecimal
-      concurrent-ruby (~> 1.0, >= 1.0.2)
+      concurrent-ruby (~> 1.0, >= 1.3.1)
       connection_pool (>= 2.2.5)
       drb
       i18n (>= 1.6, < 2)
+      logger (>= 1.4.2)
       minitest (>= 5.1)
-      mutex_m
-      tzinfo (~> 2.0)
+      securerandom (>= 0.3)
+      tzinfo (~> 2.0, >= 2.0.5)
     addressable (2.8.7)
       public_suffix (>= 2.0.2, < 7.0)
     ansi (1.5.0)
@@ -48,7 +50,7 @@ GEM
     builder (3.3.0)
     bundle-audit (0.1.0)
       bundler-audit
-    bundler-audit (0.9.1)
+    bundler-audit (0.9.2)
       bundler (>= 1.2.0, < 3)
       thor (~> 1.0)
     capybara (3.40.0)
@@ -64,7 +66,7 @@ GEM
       activesupport (>= 3.0.0)
       railties (>= 3.0.0)
       thor (>= 0.14.6)
-    concurrent-ruby (1.3.3)
+    concurrent-ruby (1.3.4)
     connection_pool (2.4.1)
     crass (1.0.6)
     drb (2.2.1)
@@ -78,22 +80,22 @@ GEM
     json (2.7.2)
     language_server-protocol (3.17.0.3)
     lint_roller (1.1.0)
+    logger (1.6.1)
     loofah (2.22.0)
       crass (~> 1.0.2)
       nokogiri (>= 1.12.0)
     matrix (0.4.2)
     mini_mime (1.1.5)
-    minitest (5.24.1)
+    minitest (5.25.1)
     minitest-reporters (1.7.1)
       ansi
       builder
       minitest (>= 5.0)
       ruby-progressbar
-    mutex_m (0.2.0)
     nokogiri (1.16.7-x86_64-darwin)
       racc (~> 1.4)
-    parallel (1.25.1)
-    parser (3.3.4.0)
+    parallel (1.26.3)
+    parser (3.3.5.0)
       ast (~> 2.4.1)
       racc
     phlex (1.11.0)
@@ -119,10 +121,10 @@ GEM
     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
+    railties (7.2.1)
+      actionpack (= 7.2.1)
+      activesupport (= 7.2.1)
+      irb (~> 1.13)
       rackup (>= 1.0.0)
       rake (>= 12.2)
       thor (~> 1.0, >= 1.2.2)
@@ -132,31 +134,31 @@ GEM
     rdoc (6.7.0)
       psych (>= 4.0.0)
     regexp_parser (2.9.2)
-    reline (0.5.9)
+    reline (0.5.10)
       io-console (~> 0.5)
-    rexml (3.3.2)
-      strscan
-    rubocop (1.64.1)
+    rexml (3.3.7)
+    rubocop (1.65.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)
+      regexp_parser (>= 2.4, < 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)
+    rubocop-ast (1.32.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)
-    standard (1.39.2)
+    securerandom (0.3.1)
+    standard (1.40.0)
       language_server-protocol (~> 3.17.0.2)
       lint_roller (~> 1.0)
-      rubocop (~> 1.64.0)
+      rubocop (~> 1.65.0)
       standard-custom (~> 1.0.0)
       standard-performance (~> 1.4)
     standard-custom (1.0.2)
@@ -166,15 +168,15 @@ GEM
       lint_roller (~> 1.1)
       rubocop-performance (~> 1.21.0)
     stringio (3.1.1)
-    strscan (3.1.0)
-    thor (1.3.1)
+    thor (1.3.2)
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
     unicode-display_width (2.5.0)
+    useragent (0.16.10)
     webrick (1.8.1)
     xpath (3.2.0)
       nokogiri (~> 1.8)
-    zeitwerk (2.6.17)
+    zeitwerk (2.6.18)
 
 PLATFORMS
   x86_64-darwin

data/gemfiles/rails_7.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ..
   specs:
-    phlexi-form (0.3.0.rc1)
+    phlexi-form (0.3.1)
       activesupport
       phlex (~> 1.11)
       zeitwerk
@@ -96,7 +96,7 @@ GEM
     builder (3.3.0)
     bundle-audit (0.1.0)
       bundler-audit
-    bundler-audit (0.9.1)
+    bundler-audit (0.9.2)
       bundler (>= 1.2.0, < 3)
       thor (~> 1.0)
     capybara (3.40.0)
@@ -112,7 +112,7 @@ GEM
       activesupport (>= 3.0.0)
       railties (>= 3.0.0)
       thor (>= 0.14.6)
-    concurrent-ruby (1.3.3)
+    concurrent-ruby (1.3.4)
     connection_pool (2.4.1)
     crass (1.0.6)
     date (3.3.4)
@@ -140,14 +140,14 @@ GEM
     marcel (1.0.4)
     matrix (0.4.2)
     mini_mime (1.1.5)
-    minitest (5.24.1)
+    minitest (5.25.1)
     minitest-reporters (1.7.1)
       ansi
       builder
       minitest (>= 5.0)
       ruby-progressbar
     mutex_m (0.2.0)
-    net-imap (0.4.14)
+    net-imap (0.4.16)
       date
       net-protocol
     net-pop (0.1.2)
@@ -159,8 +159,8 @@ GEM
     nio4r (2.7.3)
     nokogiri (1.16.7-x86_64-darwin)
       racc (~> 1.4)
-    parallel (1.25.1)
-    parser (3.3.4.0)
+    parallel (1.26.3)
+    parser (3.3.5.0)
       ast (~> 2.4.1)
       racc
     phlex (1.11.0)
@@ -213,32 +213,31 @@ GEM
     rdoc (6.7.0)
       psych (>= 4.0.0)
     regexp_parser (2.9.2)
-    reline (0.5.9)
+    reline (0.5.10)
       io-console (~> 0.5)
-    rexml (3.3.2)
-      strscan
-    rubocop (1.64.1)
+    rexml (3.3.7)
+    rubocop (1.65.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)
+      regexp_parser (>= 2.4, < 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)
+    rubocop-ast (1.32.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)
+    standard (1.40.0)
       language_server-protocol (~> 3.17.0.2)
       lint_roller (~> 1.0)
-      rubocop (~> 1.64.0)
+      rubocop (~> 1.65.0)
       standard-custom (~> 1.0.0)
       standard-performance (~> 1.4)
     standard-custom (1.0.2)
@@ -248,8 +247,7 @@ GEM
       lint_roller (~> 1.1)
       rubocop-performance (~> 1.21.0)
     stringio (3.1.1)
-    strscan (3.1.0)
-    thor (1.3.1)
+    thor (1.3.2)
     timeout (0.4.1)
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
@@ -260,7 +258,7 @@ GEM
     websocket-extensions (0.1.5)
     xpath (3.2.0)
       nokogiri (~> 1.8)
-    zeitwerk (2.6.17)
+    zeitwerk (2.6.18)
 
 PLATFORMS
   x86_64-darwin

data/lib/phlexi/form/base.rb

@@ -17,10 +17,18 @@ module Phlexi
     #
     # @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
-    class Base < COMPONENT_BASE
-      class Namespace < Structure::Namespace; end
+    class Base < Phlexi::Form::HTML
+      class Namespace < Phlexi::Form::Structure::Namespace; end
 
-      class FieldBuilder < Structure::FieldBuilder; end
+      class Builder < Phlexi::Form::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
 
@@ -39,7 +47,6 @@ module Phlexi
       def initialize(record, action: nil, method: nil, attributes: {}, **options)
         @form_action = action
         @form_method = method
-        @form_class = options.delete(:class)
         @attributes = attributes
         @namespace_klass = options.delete(:namespace_klass) || default_namespace_klass
         @builder_klass = options.delete(:builder_klass) || default_builder_klass
@@ -53,8 +60,8 @@ module Phlexi
       # Renders the form template.
       #
       # @return [void]
-      def view_template
-        form_tag { form_template }
+      def view_template(&)
+        form_tag { form_template(&) }
       end
 
       # Executes the form's content block.
@@ -62,7 +69,7 @@ module Phlexi
       #
       # @return [void]
       def form_template
-        instance_exec(&@_content_block) if @_content_block
+        yield if block_given?
       end
 
       def extract_input(params)
@@ -117,7 +124,9 @@ module Phlexi
       # Retrieves the form's CSS classes.
       #
       # @return [String] The form's CSS classes
-      attr_reader :form_class
+      def form_class
+        themed(:base, nil)
+      end
 
       # Renders the form tag with its contents.
       #
@@ -236,7 +245,7 @@ module Phlexi
       end
 
       def default_builder_klass
-        self.class::FieldBuilder
+        self.class::Builder
       end
     end
   end

data/lib/phlexi/form/builder.rb

@@ -0,0 +1,297 @@
+# frozen_string_literal: true
+
+module Phlexi
+  module Form
+    # Builder class is responsible for building form fields with various options and components.
+    class Builder < Phlexi::Field::Builder
+      include Phlexi::Form::HTML::Behaviour
+      include Options::Validators
+      include Options::InferredTypes
+      include Options::Errors
+      include Options::Collection
+      include Options::Hints
+      include Options::Required
+      include Options::Autofocus
+      include Options::Disabled
+      include Options::Readonly
+      include Options::Length
+      include Options::Max
+      include Options::Min
+      include Options::Pattern
+      include Options::Limit
+      include Options::Step
+
+      class FieldCollection < Phlexi::Form::Structure::FieldCollection; end
+
+      attr_reader :input_attributes
+
+      # Initializes a new Builder 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 input_attributes [Hash] Default attributes to apply to input fields.
+      # @param options [Hash] Additional options for the field.
+      def initialize(*, input_attributes: {}, **)
+        super(*, **)
+
+        @input_attributes = input_attributes
+      end
+
+      # Creates an input tag for the field.
+      #
+      # @param attributes [Hash] Additional attributes for the input.
+      # @return [Components::Input] The input component.
+      def input_tag(**, &)
+        create_component(Components::Input, :input, **, &)
+      end
+
+      def string_tag(**, &)
+        input_tag(type: :text, theme: :string, **, &)
+      end
+
+      def number_tag(**, &)
+        input_tag(type: :number, theme: :number, **, &)
+      end
+
+      def date_tag(**, &)
+        input_tag(type: :date, theme: :date, **, &)
+      end
+
+      def time_tag(**, &)
+        input_tag(type: :time, theme: :time, **, &)
+      end
+
+      def datetime_local_tag(**, &)
+        input_tag(type: :"datetime-local", theme: :datetime, **, &)
+      end
+      alias_method :datetime_tag, :datetime_local_tag
+
+      def email_tag(**, &)
+        input_tag(type: :email, theme: :email, **, &)
+      end
+
+      def password_tag(**, &)
+        input_tag(type: :password, theme: :password, **, &)
+      end
+
+      def phone_tag(**, &)
+        input_tag(type: :tel, theme: :phone, **, &)
+      end
+
+      def color_tag(**, &)
+        input_tag(type: :color, theme: :color, **, &)
+      end
+
+      def url_tag(**, &)
+        input_tag(type: :url, theme: :url, **, &)
+      end
+
+      def search_tag(**, &)
+        input_tag(type: :search, theme: :search, **, &)
+      end
+
+      # Creates a checkbox tag for the field.
+      #
+      # @param attributes [Hash] Additional attributes for the checkbox.
+      # @return [Components::Checkbox] The checkbox component.
+      def checkbox_tag(**, &)
+        create_component(Components::Checkbox, :checkbox, **, &)
+      end
+
+      def boolean_tag(**, &)
+        checkbox_tag(**, theme: :boolean, &)
+      end
+
+      def file_input_tag(**, &)
+        create_component(Components::FileInput, :file, **, &)
+      end
+      alias_method :file_tag, :file_input_tag
+
+      # Creates collection checkboxes for the field.
+      #
+      # @param attributes [Hash] Additional attributes for the collection checkboxes.
+      # @yield [block] The block to be executed for each checkbox.
+      # @return [Components::CollectionCheckboxes] The collection checkboxes component.
+      def collection_checkboxes_tag(**, &)
+        create_component(Components::CollectionCheckboxes, :collection_checkboxes, **, &)
+      end
+
+      # Creates a radio button tag for the field.
+      #
+      # @param attributes [Hash] Additional attributes for the radio button.
+      # @return [Components::RadioButton] The radio button component.
+      def radio_button_tag(**, &)
+        create_component(Components::RadioButton, :radio, **, &)
+      end
+
+      # Creates collection radio buttons for the field.
+      #
+      # @param attributes [Hash] Additional attributes for the collection radio buttons.
+      # @yield [block] The block to be executed for each radio button.
+      # @return [Components::CollectionRadioButtons] The collection radio buttons component.
+      def collection_radio_buttons_tag(**, &)
+        create_component(Components::CollectionRadioButtons, :collection_radio_buttons, **, &)
+      end
+
+      # Creates a textarea tag for the field.
+      #
+      # @param attributes [Hash] Additional attributes for the textarea.
+      # @return [Components::Textarea] The textarea component.
+      def textarea_tag(**, &)
+        create_component(Components::Textarea, :textarea, **, &)
+      end
+      alias_method :text_tag, :textarea_tag
+
+      def hstore_tag(**, &)
+        @value = @value.to_s.tr("{}", "")
+        textarea_tag(**, theme: :hstore, &)
+      end
+
+      # Creates a select tag for the field.
+      #
+      # @param attributes [Hash] Additional attributes for the select.
+      # @return [Components::Select] The select component.
+      def select_tag(**, &)
+        create_component(Components::Select, :select, **, &)
+      end
+
+      def belongs_to_tag(**options, &)
+        options.fetch(:input_param) {
+          options[:input_param] = if association_reflection.respond_to?(:options) && association_reflection.options[:foreign_key]
+            association_reflection.options[:foreign_key]
+          else
+            :"#{association_reflection.name}_id"
+          end
+        }
+        select_tag(**options, &)
+      end
+
+      def polymorphic_belongs_to_tag(**, &)
+        # TODO: this requires a grouped_select component
+        # see: Plutonium::Core::Fields::Inputs::PolymorphicBelongsToAssociationInput
+        raise NotImplementedError, "polymorphic belongs_to associations are not YET supported"
+      end
+
+      def has_one_tag(**, &)
+        raise NotImplementedError, "has_one associations are NOT supported"
+      end
+
+      def has_many_tag(**options, &)
+        options.fetch(:input_param) {
+          options[:input_param] = :"#{association_reflection.name.to_s.singularize}_ids"
+        }
+
+        select_tag(**options, &)
+      end
+
+      def input_array_tag(**, &)
+        create_component(Components::InputArray, :array, **, &)
+      end
+
+      # 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 hint tag for the field.
+      #
+      # @param attributes [Hash] Additional attributes for the hint.
+      # @return [Components::Hint] The hint component.
+      def hint_tag(**, &)
+        create_component(Components::Hint, :hint, **, &)
+      end
+
+      # Creates an error tag for the field.
+      #
+      # @param attributes [Hash] Additional attributes for the error.
+      # @return [Components::Error] The error component.
+      def error_tag(**, &)
+        create_component(Components::Error, :error, **, &)
+      end
+
+      # Creates a full error tag for the field.
+      #
+      # @param attributes [Hash] Additional attributes for the full error.
+      # @return [Components::FullError] The full error component.
+      def full_error_tag(**, &)
+        create_component(Components::FullError, :full_error, **, &)
+      end
+
+      # Wraps the field with additional markup.
+      #
+      # @param inner [Hash] Attributes for the inner wrapper.
+      # @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(inner: {}, **attributes, &)
+        attributes = apply_component_theme(attributes, :wrapper)
+        inner = apply_component_theme(inner, :inner_wrapper)
+        Components::Wrapper.new(self, inner: inner, **attributes, &)
+      end
+
+      # Creates a submit button
+      #
+      # @param attributes [Hash] Additional attributes for the submit.
+      # @return [Components::SubmitButton] The submit button component.
+      def submit_button_tag(**, &)
+        create_component(Components::SubmitButton, :submit_button, **, &)
+      end
+
+      def extract_input(params)
+        raise "field##{dom.name} did not define an input component" unless @field_input_extractor
+
+        @field_input_extractor.extract_input(params)
+      end
+
+      protected
+
+      def create_component(component_class, theme_key, **attributes, &)
+        attributes = mix(input_attributes, attributes) if component_class.include?(Phlexi::Form::Components::Concerns::HandlesInput)
+        component = component_class.new(self, **apply_component_theme(attributes, theme_key), &)
+        if component_class.include?(Components::Concerns::ExtractsInput)
+          raise "input component already defined: #{@field_input_extractor.inspect}" if @field_input_extractor
+
+          @field_input_extractor = component
+        end
+
+        component
+      end
+
+      def apply_component_theme(attributes, theme_key)
+        return attributes if attributes.key?(:class!)
+
+        theme_key = attributes.delete(:theme) || theme_key
+        mix({class: themed(theme_key, self)}, attributes)
+      end
+
+      def determine_initial_value(value)
+        return value unless value == NIL_VALUE
+
+        determine_value_from_association || super
+      end
+
+      def determine_value_from_object
+        object.respond_to?(key) ? object.public_send(key) : nil
+      end
+
+      def determine_value_from_association
+        return nil unless association_reflection.present?
+
+        value = object.public_send(key)
+        case association_reflection.macro
+        when :has_many, :has_and_belongs_to_many
+          value&.map { |v| v.public_send(association_reflection.klass.primary_key) }
+        when :belongs_to, :has_one
+          value&.public_send(association_reflection.klass.primary_key)
+        else
+          raise ArgumentError, "Unsupported association type: #{association_reflection.macro}"
+        end
+      end
+    end
+  end
+end

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

@@ -3,7 +3,7 @@
 module Phlexi
   module Form
     module Components
-      class Base < COMPONENT_BASE
+      class Base < Phlexi::Form::HTML
         attr_reader :field, :attributes
 
         def initialize(field, **attributes)