phlexi-form 0.2.0 → 0.3.0

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/form/base.rb

@@ -1,28 +1,30 @@
 # frozen_string_literal: true
 
-require "action_view/model_naming"
 require "active_support/core_ext/module/delegation"
 require "active_support/string_inquirer"
-require "active_support/core_ext/object/blank"
+require "active_support/core_ext/hash/deep_merge"
+require "active_support/core_ext/string/inflections"
 
 module Phlexi
   module Form
     # A form component for building flexible and customizable forms.
     #
     # @example Basic usage
-    #   Form.new(user, action: '/users', method: 'post') do |f|
-    #     f.field :name
-    #     f.field :email
+    #   Phlexi::Form(user, action: '/users', method: 'post') do
+    #     render field(:name).placeholder("Name").input_tag
+    #     render field(:email).placeholder("Email").input_tag
     #   end
     #
     # @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 < BaseComponent
-      include ActionView::ModelNaming
+    class Base < COMPONENT_BASE
+      class Namespace < Structure::Namespace; end
+
+      class FieldBuilder < Structure::FieldBuilder; end
 
       attr_reader :key, :object
 
-      delegate :field, :nest_one, :nest_many, to: :@namespace
+      delegate :field, :submit_button, :nest_one, :nest_many, to: :@namespace
 
       # Initializes a new Form instance.
       #
@@ -39,6 +41,8 @@ module Phlexi
         @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
         @options = options
 
         initialize_object_and_key(record)
@@ -61,40 +65,36 @@ module Phlexi
         instance_exec(&@_content_block) if @_content_block
       end
 
-      # Renders the form tag with its contents.
-      #
-      # @yield The form's content
-      # @return [void]
-      def form_tag(&block)
-        form(**form_attributes) do
-          render_hidden_method_field
-          render_authenticity_token if authenticity_token?
-          yield
-        end
+      def extract_input(params)
+        call unless @_rendered
+        @namespace.extract_input(params)
       end
 
       protected
 
-      attr_reader :options, :attributes
+      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 form's associated record or key
       # @return [void]
       def initialize_object_and_key(record)
+        # always pop these keys
+        # add support for `as` to make it more rails friendly
+        @key = options.delete(:key) || options.delete(:as)
+
         case record
         when String, Symbol
           @object = nil
           @key = record
         else
-          @object = convert_to_model(record)
-          @key = options.delete(:as)
-
+          @object = record
           if @key.nil?
-            unless object.respond_to?(:model_name) && object.model_name.respond_to?(:param_key) && object.model_name.param_key
-              raise ArgumentError, "record must respond to #model_name.param_key with a non nil value"
+            @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
-            @key = object.model_name.param_key
           end
         end
         @key = @key.to_sym
@@ -111,7 +111,24 @@ module Phlexi
       #
       # @return [void]
       def initialize_attributes
-        attributes[:accept_charset] ||= "UTF-8"
+        attributes.fetch(:accept_charset) { attributes[:accept_charset] = "UTF-8" }
+      end
+
+      # Retrieves the form's CSS classes.
+      #
+      # @return [String] The form's CSS classes
+      attr_reader :form_class
+
+      # Renders the form tag with its contents.
+      #
+      # @yield The form's content
+      # @return [void]
+      def form_tag(&)
+        form(**form_attributes) do
+          render_hidden_method_field
+          render_authenticity_token if has_authenticity_token?
+          yield
+        end
       end
 
       # Determines the form's action URL.
@@ -137,18 +154,11 @@ module Phlexi
         ActiveSupport::StringInquirer.new(@form_method)
       end
 
-      # Retrieves the form's CSS classes.
-      #
-      # @return [String] The form's CSS classes
-      def form_class
-        @form_class || "flex flex-col space-y-6 px-4 py-2"
-      end
-
       # Checks if the authenticity token should be included.
       #
       # @return [Boolean] True if the authenticity token should be included, false otherwise
-      def authenticity_token?
-        defined?(helpers) && options.fetch(:authenticity_token) { !form_method.get? }
+      def has_authenticity_token?
+        !form_method.get? && ((defined?(helpers) && helpers) || options[:authenticity_token])
       end
 
       # Retrieves the authenticity token.
@@ -171,22 +181,11 @@ module Phlexi
       #
       # @return [String, nil] The appropriate form method
       def object_form_method
-        return unless object
-        object.persisted? ? "patch" : "post"
-      end
-
-      # Retrieves the namespace class.
-      #
-      # @return [Class] The namespace class
-      def namespace_klass
-        @namespace_klass ||= options.delete(:namespace_klass) || Structure::Namespace
-      end
-
-      # Retrieves the builder class.
-      #
-      # @return [Class] The builder class
-      def builder_klass
-        @builder_klass ||= options.delete(:builder_klass) || Structure::FieldBuilder
+        if object.respond_to?(:persisted?)
+          object.persisted? ? "patch" : "post"
+        elsif object.present?
+          "post"
+        end
       end
 
       # Renders the hidden method field for non-standard HTTP methods.
@@ -215,12 +214,12 @@ module Phlexi
       #
       # @return [Hash] The form attributes
       def form_attributes
-        {
-          action: form_action,
-          method: standardized_form_method,
+        mix({
+          id: @namespace.dom_id,
           class: form_class,
-          **attributes
-        }
+          action: form_action,
+          method: standardized_form_method
+        }, attributes)
       end
 
       # Renders the authenticity token if required.
@@ -229,6 +228,16 @@ module Phlexi
       def render_authenticity_token
         authenticity_token_field
       end
+
+      private
+
+      def default_namespace_klass
+        self.class::Namespace
+      end
+
+      def default_builder_klass
+        self.class::FieldBuilder
+      end
     end
   end
 end

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

@@ -3,7 +3,7 @@
 module Phlexi
   module Form
     module Components
-      class Base < BaseComponent
+      class Base < COMPONENT_BASE
         attr_reader :field, :attributes
 
         def initialize(field, **attributes)
@@ -11,21 +11,27 @@ module Phlexi
           @attributes = attributes
 
           build_attributes
+          append_attribute_classes
         end
 
         protected
 
         def build_attributes
-          attributes[:id] ||= "#{field.dom.id}_#{component_name}"
-          attributes[:class] = tokens(
+          attributes.fetch(:id) { attributes[:id] = "#{field.dom.id}_#{component_name}" }
+        end
+
+        def append_attribute_classes
+          return if attributes[:class] == false
+
+          default_classes = tokens(
             component_name,
-            attributes[:class],
-            -> { field.required? } => "required",
-            -> { !field.required? } => "optional",
+            -> { attributes[:required] } => "required",
+            -> { !attributes[:required] } => "optional",
             -> { field.has_errors? } => "invalid",
-            -> { field.readonly? } => "readonly",
-            -> { field.disabled? } => "disabled"
+            -> { attributes[:readonly] } => "readonly",
+            -> { attributes[:disabled] } => "disabled"
           )
+          attributes[:class] = tokens(default_classes, attributes[:class])
         end
 
         def component_name

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

@@ -37,6 +37,11 @@ module Phlexi
             field.dom.value == @checked_value
           end
         end
+
+        def normalize_input(...)
+          input_value = super
+          [@checked_value, @unchecked_value].include?(input_value) ? input_value : @unchecked_value
+        end
       end
     end
   end

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

@@ -4,26 +4,40 @@ module Phlexi
   module Form
     module Components
       class CollectionCheckboxes < Base
+        include Concerns::HandlesInput
+        include Concerns::HandlesArrayInput
         include Concerns::HasOptions
 
         def view_template
-          render field.input_tag(type: :hidden, value: "", theme: false, hidden: true, autocomplete: "off", multiple: true)
-          field.multi(option_mapper.values) do |builder|
-            field = builder.field(
-              label: option_mapper[builder.key],
-              attributes: {
-                checked_value: builder.key,
-                include_hidden: false
-              }
-            )
-            if block_given?
-              yield field
-            else
-              render field.checkbox_tag
-              render field.label_tag
+          div(**attributes.slice(:id, :class)) do
+            field.repeated(option_mapper.values) do |builder|
+              render builder.hidden_field_tag if builder.index == 0
+
+              field = builder.field(
+                label: option_mapper[builder.key],
+                # We set the attributes here so they are applied to all input components even if the user decides to use a block
+                input_attributes: {
+                  checked_value: builder.key,
+                  include_hidden: false,
+                  checked: selected?(builder.key)
+                }
+              )
+              if block_given?
+                yield field
+              else
+                render field.checkbox_tag
+                render field.label_tag
+              end
             end
           end
         end
+
+        protected
+
+        def build_attributes
+          super
+          attributes[:multiple] = true
+        end
       end
     end
   end

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

@@ -4,22 +4,28 @@ module Phlexi
   module Form
     module Components
       class CollectionRadioButtons < Base
+        include Concerns::HandlesInput
         include Concerns::HasOptions
 
         def view_template
-          render field.input_tag(type: :hidden, value: "", theme: false, hidden: true, autocomplete: "off")
-          field.multi(option_mapper.values) do |builder|
-            field = builder.field(
-              label: option_mapper[builder.key],
-              attributes: {
-                checked_value: builder.key
-              }
-            )
-            if block_given?
-              yield field
-            else
-              render field.radio_button_tag
-              render field.label_tag
+          div(**attributes.slice(:id, :class)) do
+            field.repeated(option_mapper.values) do |builder|
+              render builder.hidden_field_tag if builder.index == 0
+
+              field = builder.field(
+                label: option_mapper[builder.key],
+                # We set the attributes here so they are applied to all input components even if the user decides to use a block
+                input_attributes: {
+                  checked_value: builder.key,
+                  checked: selected?(builder.key)
+                }
+              )
+              if block_given?
+                yield field
+              else
+                render field.radio_button_tag
+                render field.label_tag
+              end
             end
           end
         end

data/lib/phlexi/form/components/concerns/extracts_input.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module Phlexi
+  module Form
+    module Components
+      module Concerns
+        module ExtractsInput
+          # Collects parameters matching the input field's param key.
+          #
+          # @param params [Hash] the parameters to collect from.
+          # @return [Hash] the collected parameters.
+          def extract_input(params)
+            # # Handles multi parameter attributes
+            # # https://www.cookieshq.co.uk/posts/rails-spelunking-date-select
+            # # https://www.cookieshq.co.uk/posts/multiparameter-attributes
+
+            # # Matches
+            # # - parameter
+            # # - parameter(1)
+            # # - parameter(2)
+            # # - parameter(1i)
+            # # - parameter(2f)
+            # regex = /^#{param}(\(\d+[if]?\))?$/
+            # keys = params.select { |key, _| regex.match?(key) }.keys
+            # params.slice(*keys)
+
+            params ||= {}
+            {input_param => normalize_input(params[field.key])}
+          end
+
+          protected
+
+          def build_attributes
+            super
+            @input_param = attributes.delete(:input_param) || field.key
+          end
+
+          def input_param
+            @input_param
+          end
+
+          def normalize_input(input_value)
+            normalize_simple_input(input_value)
+          end
+
+          def normalize_simple_input(input_value)
+            input_value.to_s.presence
+          end
+        end
+      end
+    end
+  end
+end