phlexi-form 0.2.0

data/gemfiles/default.gemfile.lock

@@ -0,0 +1,174 @@
+PATH
+  remote: ..
+  specs:
+    phlexi-form (0.1.0)
+      activesupport
+      phlex (~> 1.10)
+      zeitwerk
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    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)
+    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)
+    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)
+    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)
+    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)
+    drb (2.2.1)
+    erubi (1.13.0)
+    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)
+    minitest (5.24.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)
+      ast (~> 2.4.1)
+      racc
+    phlex (1.11.0)
+    psych (5.1.2)
+      stringio
+    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-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)
+    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)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.5.0)
+    webrick (1.8.1)
+    zeitwerk (2.6.17)
+
+PLATFORMS
+  x86_64-darwin
+
+DEPENDENCIES
+  appraisal
+  bundle-audit
+  combustion
+  minitest
+  minitest-reporters
+  phlexi-form!
+  rake
+  standard
+
+BUNDLED WITH
+   2.5.16

data/lib/generators/superform/install/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Installs Phlex Rails and Superform
+
+Example:
+    bin/rails generate superform:install
+
+    This will create:
+        app/views/forms/application_form.rb

data/lib/generators/superform/install/install_generator.rb

@@ -0,0 +1,34 @@
+require "bundler"
+
+class Superform::InstallGenerator < Rails::Generators::Base
+  source_root File.expand_path("templates", __dir__)
+
+  APPLICATION_CONFIGURATION_PATH = Rails.root.join("config/application.rb")
+
+  def install_phlex_rails
+    return if gem_in_bundle? "phlex-rails"
+
+    gem "phlex-rails"
+    generate "phlex:install"
+  end
+
+  def autoload_components
+    return unless APPLICATION_CONFIGURATION_PATH.exist?
+
+    inject_into_class(
+      APPLICATION_CONFIGURATION_PATH,
+      "Application",
+      %(    config.autoload_paths << "\#{root}/app/views/forms"\n)
+    )
+  end
+
+  def create_application_form
+    template "application_form.rb", Rails.root.join("app/views/forms/application_form.rb")
+  end
+
+  private
+
+  def gem_in_bundle?(gem_name)
+    Bundler.load.specs.any? { |spec| spec.name == gem_name }
+  end
+end

data/lib/generators/superform/install/templates/application_form.rb

@@ -0,0 +1,31 @@
+class ApplicationForm < Superform::Rails::Form
+  include Phlex::Rails::Helpers::Pluralize
+
+  def row(component)
+    div do
+      render component.field.label(style: "display: block;")
+      render component
+    end
+  end
+
+  def around_template(&)
+    super do
+      error_messages
+      yield
+      submit
+    end
+  end
+
+  def error_messages
+    if model.errors.any?
+      div(style: "color: red;") do
+        h2 { "#{pluralize model.errors.count, "error"} prohibited this post from being saved:" }
+        ul do
+          model.errors.each do |error|
+            li { error.full_message }
+          end
+        end
+      end
+    end
+  end
+end

data/lib/phlexi/form/base.rb

@@ -0,0 +1,234 @@
+# 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"
+
+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
+    #   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
+
+      attr_reader :key, :object
+
+      delegate :field, :nest_one, :nest_many, to: :@namespace
+
+      # Initializes a new Form instance.
+      #
+      # @param record [ActiveModel::Model, Symbol, String] The form's associated record or key
+      # @param action [String, nil] The form's action URL
+      # @param method [String, nil] The form's HTTP method
+      # @param attributes [Hash] Additional HTML attributes for the form tag
+      # @param options [Hash] Additional options for form configuration
+      # @option options [String] :class CSS classes for the form
+      # @option options [Class] :namespace_klass Custom namespace class
+      # @option options [Class] :builder_klass Custom field builder class
+      def initialize(record, action: nil, method: nil, attributes: {}, **options)
+        @form_action = action
+        @form_method = method
+        @form_class = options.delete(:class)
+        @attributes = attributes
+        @options = options
+
+        initialize_object_and_key(record)
+        initialize_namespace
+        initialize_attributes
+      end
+
+      # Renders the form template.
+      #
+      # @return [void]
+      def view_template
+        form_tag { form_template }
+      end
+
+      # Executes the form's content block.
+      # Override this in subclasses to defie a static form.
+      #
+      # @return [void]
+      def form_template
+        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
+      end
+
+      protected
+
+      attr_reader :options, :attributes
+
+      # 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)
+        case record
+        when String, Symbol
+          @object = nil
+          @key = record
+        else
+          @object = convert_to_model(record)
+          @key = options.delete(:as)
+
+          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"
+            end
+            @key = object.model_name.param_key
+          end
+        end
+        @key = @key.to_sym
+      end
+
+      # Initializes the namespace for the form.
+      #
+      # @return [void]
+      def initialize_namespace
+        @namespace = namespace_klass.root(key, object: object, builder_klass: builder_klass)
+      end
+
+      # Initializes form attributes.
+      #
+      # @return [void]
+      def initialize_attributes
+        attributes[:accept_charset] ||= "UTF-8"
+      end
+
+      # Determines the form's action URL.
+      #
+      # @return [String, nil] The form's action URL
+      def form_action
+        puts ""
+        # if @form_action != false
+        #   @form_action ||= if options[:format].nil?
+        #     polymorphic_path(object, {})
+        #   else
+        #     polymorphic_path(object, format: options[:format])
+        #   end
+        # end
+        @form_action
+      end
+
+      # Determines the form's HTTP method.
+      #
+      # @return [ActiveSupport::StringInquirer] The form's HTTP method
+      def form_method
+        @form_method ||= (object_form_method || "get").to_s.downcase
+        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? }
+      end
+
+      # Retrieves the authenticity token.
+      #
+      # @return [String] The authenticity token
+      def authenticity_token
+        options.fetch(:authenticity_token) { helpers.form_authenticity_token }
+      end
+
+      # Renders the authenticity token field.
+      #
+      # @param name [String] The name attribute for the authenticity token field
+      # @param value [String] The value for the authenticity token field
+      # @return [void]
+      def authenticity_token_field(name = "authenticity_token", value = authenticity_token)
+        input(name: name, value: value, type: "hidden", hidden: true)
+      end
+
+      # Determines the appropriate form method based on the object's state.
+      #
+      # @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
+      end
+
+      # Renders the hidden method field for non-standard HTTP methods.
+      #
+      # @return [void]
+      def render_hidden_method_field
+        return if standard_form_method?
+        input(name: "_method", value: form_method, type: "hidden", hidden: true)
+      end
+
+      # Checks if the form method is standard (GET or POST).
+      #
+      # @return [Boolean] True if the form method is standard, false otherwise
+      def standard_form_method?
+        form_method.get? || form_method.post?
+      end
+
+      # Returns the standardized form method for the HTML form tag.
+      #
+      # @return [String] The standardized form method
+      def standardized_form_method
+        standard_form_method? ? form_method : "post"
+      end
+
+      # Generates the form attributes hash.
+      #
+      # @return [Hash] The form attributes
+      def form_attributes
+        {
+          action: form_action,
+          method: standardized_form_method,
+          class: form_class,
+          **attributes
+        }
+      end
+
+      # Renders the authenticity token if required.
+      #
+      # @return [void]
+      def render_authenticity_token
+        authenticity_token_field
+      end
+    end
+  end
+end

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

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Phlexi
+  module Form
+    module Components
+      class Base < BaseComponent
+        attr_reader :field, :attributes
+
+        def initialize(field, **attributes)
+          @field = field
+          @attributes = attributes
+
+          build_attributes
+        end
+
+        protected
+
+        def build_attributes
+          attributes[:id] ||= "#{field.dom.id}_#{component_name}"
+          attributes[:class] = tokens(
+            component_name,
+            attributes[:class],
+            -> { field.required? } => "required",
+            -> { !field.required? } => "optional",
+            -> { field.has_errors? } => "invalid",
+            -> { field.readonly? } => "readonly",
+            -> { field.disabled? } => "disabled"
+          )
+        end
+
+        def component_name
+          @component_name ||= self.class.name.demodulize.underscore
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module Phlexi
+  module Form
+    module Components
+      class Checkbox < Input
+        def view_template
+          input(type: :hidden, name: attributes[:name], value: @unchecked_value, autocomplete: "off", hidden: true) if include_hidden?
+          input(**attributes, value: @checked_value)
+        end
+
+        protected
+
+        def build_input_attributes
+          attributes[:type] = :checkbox
+          super
+
+          @include_hidden = attributes.delete(:include_hidden)
+          @checked_value = (attributes.key?(:checked_value) ? attributes.delete(:checked_value) : "1").to_s
+          @unchecked_value = (attributes.key?(:unchecked_value) ? attributes.delete(:unchecked_value) : "0").to_s
+
+          attributes[:value] = @checked_value
+          attributes[:checked] = attributes.fetch(:checked) { checked? }
+        end
+
+        def include_hidden?
+          @include_hidden != false
+        end
+
+        def checked?
+          return false if field.dom.value == @unchecked_value
+
+          if @checked_value == "1" # using default values
+            # handle nils, numbers and booleans
+            !["", "0", "false"].include?(field.dom.value)
+          else # custom value, so explicit match
+            field.dom.value == @checked_value
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Phlexi
+  module Form
+    module Components
+      class CollectionCheckboxes < Base
+        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
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Phlexi
+  module Form
+    module Components
+      class CollectionRadioButtons < Base
+        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
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Phlexi
+  module Form
+    module Components
+      module Concerns
+        module HasOptions
+          protected
+
+          def build_attributes
+            super
+            @collection = attributes.delete(:collection) || field.collection
+            @label_method = attributes.delete(:label_method)
+            @value_method = attributes.delete(:value_method)
+          end
+
+          def option_mapper
+            @option_mapper ||= OptionMapper.new(@collection, label_method: @label_method, value_method: @value_method)
+          end
+
+          def selected?(option)
+            if field.multiple?
+              @options_list ||= Array(field.value)
+              @options_list.any? { |item| item.to_s == option.to_s }
+            else
+              field.dom.value == option.to_s
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Phlexi
+  module Form
+    module Components
+      class Error < Base
+        def view_template
+          p(**attributes) do
+            field.error
+          end
+        end
+
+        private
+
+        def render?
+          field.show_errors? && field.has_errors?
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Phlexi
+  module Form
+    module Components
+      class FullError < Base
+        def view_template
+          p(**attributes) do
+            field.full_error
+          end
+        end
+
+        private
+
+        def render?
+          field.show_errors? && field.has_errors?
+        end
+      end
+    end
+  end
+end