RubyGems - phlex-forms - Versions diffs - 0.1.0 - Mend

phlex-forms 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (61) hide show

checksums.yaml +7 -0
data/CHANGELOG.md +23 -0
data/LICENSE.txt +21 -0
data/README.md +170 -0
data/app/javascript/phlex_forms/controllers/validations/acceptance_controller.js +23 -0
data/app/javascript/phlex_forms/controllers/validations/base_controller.js +166 -0
data/app/javascript/phlex_forms/controllers/validations/confirmation_controller.js +27 -0
data/app/javascript/phlex_forms/controllers/validations/exclusion_controller.js +19 -0
data/app/javascript/phlex_forms/controllers/validations/form_controller.js +43 -0
data/app/javascript/phlex_forms/controllers/validations/format_controller.js +23 -0
data/app/javascript/phlex_forms/controllers/validations/inclusion_controller.js +19 -0
data/app/javascript/phlex_forms/controllers/validations/length_controller.js +95 -0
data/app/javascript/phlex_forms/controllers/validations/numericality_controller.js +59 -0
data/app/javascript/phlex_forms/controllers/validations/presence_controller.js +14 -0
data/app/javascript/phlex_forms/i18n.js +40 -0
data/app/javascript/phlex_forms/messages.js +100 -0
data/config/importmap.rb +21 -0
data/config/locales/de.yml +12 -0
data/config/locales/en.yml +14 -0
data/config/locales/sv.yml +12 -0
data/config/rubocop.yml +20 -0
data/lib/forms/checkbox.rb +39 -0
data/lib/forms/choices_select.rb +132 -0
data/lib/forms/collection_check_box.rb +26 -0
data/lib/forms/collection_check_box_builder.rb +26 -0
data/lib/forms/collection_label.rb +20 -0
data/lib/forms/email_field.rb +11 -0
data/lib/forms/field.rb +222 -0
data/lib/forms/field_error.rb +26 -0
data/lib/forms/field_hint.rb +24 -0
data/lib/forms/fields_for_builder.rb +58 -0
data/lib/forms/file_input.rb +29 -0
data/lib/forms/form.rb +225 -0
data/lib/forms/form_control.rb +42 -0
data/lib/forms/input.rb +35 -0
data/lib/forms/label.rb +32 -0
data/lib/forms/password_field.rb +11 -0
data/lib/forms/radio.rb +29 -0
data/lib/forms/range.rb +33 -0
data/lib/forms/rich_textarea.rb +43 -0
data/lib/forms/select.rb +73 -0
data/lib/forms/submit.rb +62 -0
data/lib/forms/textarea.rb +27 -0
data/lib/forms/time_zone_select.rb +52 -0
data/lib/forms/toggle.rb +39 -0
data/lib/forms/validations/introspector.rb +224 -0
data/lib/forms/validations/manual_rules.rb +77 -0
data/lib/forms/wrapped_input.rb +67 -0
data/lib/phlex-forms.rb +4 -0
data/lib/phlex_forms/builder.rb +153 -0
data/lib/phlex_forms/class_merge.rb +56 -0
data/lib/phlex_forms/configuration.rb +49 -0
data/lib/phlex_forms/delegated_field.rb +51 -0
data/lib/phlex_forms/engine.rb +35 -0
data/lib/phlex_forms/inline_icons.rb +36 -0
data/lib/phlex_forms/rubocop.rb +14 -0
data/lib/phlex_forms/version.rb +5 -0
data/lib/phlex_forms.rb +80 -0
data/lib/rubocop/phlex_forms/cop/legacy_form_method.rb +103 -0
data/lib/rubocop/phlex_forms/cop/raw_form.rb +51 -0
metadata +181 -0

data/app/javascript/phlex_forms/controllers/validations/numericality_controller.js ADDED Viewed

@@ -0,0 +1,59 @@
+import { FieldValidatorController } from "phlex_forms/controllers/validations/base_controller"
+import { t } from "phlex_forms/i18n"
+// Mirrors ActiveModel::Validations::NumericalityValidator.
+export default class extends FieldValidatorController {
+  static values = {
+    greaterThan: Number,
+    greaterThanOrEqualTo: Number,
+    lessThan: Number,
+    lessThanOrEqualTo: Number,
+    equalTo: Number,
+    otherThan: Number,
+    onlyInteger: { type: Boolean, default: false },
+    odd: { type: Boolean, default: false },
+    even: { type: Boolean, default: false },
+  }
+  check(value) {
+    const raw = String(value ?? "").trim()
+    if (raw === "") return null
+    const number = Number(raw)
+    if (Number.isNaN(number)) return t("js.forms.validations.numericality.not_a_number")
+    if (this.onlyIntegerValue && !Number.isInteger(number)) {
+      return t("js.forms.validations.numericality.not_an_integer")
+    }
+    if (this.hasGreaterThanValue && !(number > this.greaterThanValue)) {
+      return t("js.forms.validations.numericality.greater_than", { count: this.greaterThanValue })
+    }
+    if (this.hasGreaterThanOrEqualToValue && !(number >= this.greaterThanOrEqualToValue)) {
+      return t("js.forms.validations.numericality.greater_than_or_equal_to", {
+        count: this.greaterThanOrEqualToValue,
+      })
+    }
+    if (this.hasLessThanValue && !(number < this.lessThanValue)) {
+      return t("js.forms.validations.numericality.less_than", { count: this.lessThanValue })
+    }
+    if (this.hasLessThanOrEqualToValue && !(number <= this.lessThanOrEqualToValue)) {
+      return t("js.forms.validations.numericality.less_than_or_equal_to", {
+        count: this.lessThanOrEqualToValue,
+      })
+    }
+    if (this.hasEqualToValue && number !== this.equalToValue) {
+      return t("js.forms.validations.numericality.equal_to", { count: this.equalToValue })
+    }
+    if (this.hasOtherThanValue && number === this.otherThanValue) {
+      return t("js.forms.validations.numericality.other_than", { count: this.otherThanValue })
+    }
+    // Rails' NumericalityValidator coerces with `.to_i` before
+    // checking parity, so `2.5` is treated as `2` (even). JS `%` on
+    // a float diverges from that — truncate first to keep client and
+    // server in agreement.
+    const truncated = Math.trunc(number)
+    if (this.oddValue && truncated % 2 === 0) return t("js.forms.validations.numericality.odd")
+    if (this.evenValue && truncated % 2 !== 0) return t("js.forms.validations.numericality.even")
+    return null
+  }
+}

data/app/javascript/phlex_forms/controllers/validations/presence_controller.js ADDED Viewed

@@ -0,0 +1,14 @@
+import { FieldValidatorController } from "phlex_forms/controllers/validations/base_controller"
+import { t } from "phlex_forms/i18n"
+// Mirrors ActiveModel::Validations::PresenceValidator.
+export default class extends FieldValidatorController {
+  static values = {
+    required: { type: Boolean, default: true },
+  }
+  check(value) {
+    if (!this.requiredValue) return null
+    return this.isBlank(value) ? t("js.forms.validations.presence.blank") : null
+  }
+}

data/app/javascript/phlex_forms/i18n.js ADDED Viewed

@@ -0,0 +1,40 @@
+// Minimal, self-contained i18n for phlex-forms' client-side validation
+// messages. Bundles the validation strings for every shipped locale so the
+// gem needs no host i18n runtime. Host apps can override a message by defining
+// window.PhlexForms.messages[locale] before the controllers connect.
+//
+// Locale is read from <html lang> (falling back to a <meta name="locale">, then
+// "en"), matching the convention Rails apps already set.
+import { messages } from "phlex_forms/messages"
+function detectLocale() {
+  if (typeof document === "undefined") return "en"
+  const htmlLang = document.documentElement.lang
+  if (htmlLang) return htmlLang.split("-")[0]
+  const meta = document.querySelector('meta[name="locale"]')?.content
+  return meta ? meta.split("-")[0] : "en"
+}
+function overrides() {
+  if (typeof window === "undefined") return {}
+  return (window.PhlexForms && window.PhlexForms.messages) || {}
+}
+function lookup(scope, locale) {
+  const table = { ...(messages[locale] || {}), ...(overrides()[locale] || {}) }
+  return scope.split(".").reduce((node, key) => (node == null ? undefined : node[key]), table)
+}
+function interpolate(string, vars) {
+  return string.replace(/%\{(\w+)\}/g, (_, key) => (key in vars ? String(vars[key]) : `%{${key}}`))
+}
+// t("js.forms.validations.presence.blank", { count: 3 })
+// Falls back to English, then to the raw key, so a missing translation never
+// throws or renders blank.
+export function t(scope, vars = {}) {
+  const locale = detectLocale()
+  const message = lookup(scope, locale) ?? lookup(scope, "en") ?? scope
+  return typeof message === "string" ? interpolate(message, vars) : scope
+}

data/app/javascript/phlex_forms/messages.js ADDED Viewed

@@ -0,0 +1,100 @@
+// Bundled validation messages for phlex-forms, keyed by locale then by the
+// `js.forms.validations.*` dotted scope. Combined from the Cosmos (en/sv/de) and
+// getzazu/app (en/fr/af) locale sets; sv/de start from English and are refined
+// by the locallingo translation pass. Host apps override via
+// window.PhlexForms.messages.
+export const messages = {
+  en: {
+    js: {
+      forms: {
+        validations: {
+          acceptance: { accepted: "must be accepted" },
+          confirmation: { confirmation: "doesn't match confirmation" },
+          exclusion: { exclusion: "is reserved" },
+          format: { invalid: "is invalid" },
+          inclusion: { inclusion: "is not included in the list" },
+          length: {
+            too_long: "is too long (maximum is %{count} characters)",
+            too_short: "is too short (minimum is %{count} characters)",
+            wrong_length: "is the wrong length (should be %{count} characters)",
+          },
+          numericality: {
+            equal_to: "must be equal to %{count}",
+            even: "must be even",
+            greater_than: "must be greater than %{count}",
+            greater_than_or_equal_to: "must be greater than or equal to %{count}",
+            less_than: "must be less than %{count}",
+            less_than_or_equal_to: "must be less than or equal to %{count}",
+            not_a_number: "is not a number",
+            not_an_integer: "must be an integer",
+            odd: "must be odd",
+            other_than: "must be other than %{count}",
+          },
+          presence: { blank: "can't be blank" },
+        },
+      },
+    },
+  },
+  fr: {
+    js: {
+      forms: {
+        validations: {
+          acceptance: { accepted: "doit être accepté(e)" },
+          confirmation: { confirmation: "ne concorde pas avec la confirmation" },
+          exclusion: { exclusion: "n'est pas disponible" },
+          format: { invalid: "n'est pas valide" },
+          inclusion: { inclusion: "n'est pas inclus(e) dans la liste" },
+          length: {
+            too_long: "est trop long (pas plus de %{count} caractères)",
+            too_short: "est trop court (au moins %{count} caractères)",
+            wrong_length: "ne fait pas la bonne longueur (doit comporter %{count} caractères)",
+          },
+          numericality: {
+            equal_to: "doit être égal à %{count}",
+            even: "doit être pair",
+            greater_than: "doit être supérieur à %{count}",
+            greater_than_or_equal_to: "doit être supérieur ou égal à %{count}",
+            less_than: "doit être inférieur à %{count}",
+            less_than_or_equal_to: "doit être inférieur ou égal à %{count}",
+            not_a_number: "n'est pas un nombre",
+            not_an_integer: "doit être un nombre entier",
+            odd: "doit être impair",
+            other_than: "doit être différent de %{count}",
+          },
+          presence: { blank: "doit être rempli(e)" },
+        },
+      },
+    },
+  },
+  af: {
+    js: {
+      forms: {
+        validations: {
+          acceptance: { accepted: "moet aanvaar word" },
+          confirmation: { confirmation: "pas nie by bevestiging nie" },
+          exclusion: { exclusion: "is bespreek" },
+          format: { invalid: "is ongeldig" },
+          inclusion: { inclusion: "is nie by die lys ingesluit nie" },
+          length: {
+            too_long: "is te lank (maksimum is %{count} karakters)",
+            too_short: "is te kort (minimum is %{count} karakters)",
+            wrong_length: "is die verkeerde lengte (moet %{count} karakters wees)",
+          },
+          numericality: {
+            equal_to: "moet gelyk wees aan %{count}",
+            even: "moet ewe wees",
+            greater_than: "moet meer wees as %{count}",
+            greater_than_or_equal_to: "moet meer of gelykstaande wees aan %{count}",
+            less_than: "moet minder wees as %{count}",
+            less_than_or_equal_to: "moet minder of gelykstaande wees aan %{count}",
+            not_a_number: "is nie 'n getal nie",
+            not_an_integer: "moet 'n heelgetal wees",
+            odd: "moet onewe wees",
+            other_than: "moet anders wees as %{count}",
+          },
+          presence: { blank: "mag nie leeg wees nie" },
+        },
+      },
+    },
+  },
+}

data/config/importmap.rb ADDED Viewed

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+# Auto-pins the gem's bundled Stimulus controllers for importmap-rails consumers.
+# Register them in the host app (lazy loading recommended):
+#
+#   // app/javascript/controllers/index.js
+#   import { lazyLoadControllersFrom } from "@hotwired/stimulus-loading"
+#   lazyLoadControllersFrom("phlex_forms/controllers", application)
+#
+# The `choices` controller expects the `choices.js` package to be available in
+# the host importmap (peer dependency); document it in the host README.
+pin_all_from PhlexForms::Engine.root.join("app/javascript/phlex_forms/controllers"),
+  under: "phlex_forms/controllers",
+  to: "phlex_forms/controllers"
+# The client-side validation controllers import the gem's own i18n helper and
+# bundled messages; pin those modules so importmap can resolve them.
+pin "phlex_forms/i18n",
+  to: "phlex_forms/i18n.js"
+pin "phlex_forms/messages",
+  to: "phlex_forms/messages.js"

data/config/locales/de.yml ADDED Viewed

@@ -0,0 +1,12 @@
+de:
+  cmd:
+    create: Erstellen
+    create_model: "%{model} erstellen"
+    update: Aktualisieren
+    update_model: "%{model} aktualisieren"
+  components:
+    searchable_select:
+      no_results: Keine Ergebnisse gefunden
+      placeholder: Auswählen...
+      search_placeholder: Suchen...
+      no_choices: Keine Auswahl verfügbar

data/config/locales/en.yml ADDED Viewed

@@ -0,0 +1,14 @@
+en:
+  # Default submit-button text for Forms::Submit. Host apps override by defining
+  # the same keys (their locale files load after the gem's).
+  cmd:
+    create: Create
+    create_model: Create %{model}
+    update: Update
+    update_model: Update %{model}
+  components:
+    searchable_select:
+      no_results: No results found
+      placeholder: Select...
+      search_placeholder: Search...
+      no_choices: No choices to choose from

data/config/locales/sv.yml ADDED Viewed

@@ -0,0 +1,12 @@
+sv:
+  cmd:
+    create: Skapa
+    create_model: Skapa %{model}
+    update: Uppdatera
+    update_model: Uppdatera %{model}
+  components:
+    searchable_select:
+      no_results: Inga resultat hittades
+      placeholder: Välj...
+      search_placeholder: Sök...
+      no_choices: Inga alternativ att välja

data/config/rubocop.yml ADDED Viewed

@@ -0,0 +1,20 @@
+# Shareable RuboCop config for phlex-forms' cops. Inherit it in a host app:
+#
+#   require:
+#     - phlex_forms/rubocop
+#   inherit_gem:
+#     phlex-forms: config/rubocop.yml
+#
+# Both cops target Phlex view/component files by default; adjust Include in the
+# host if your components live elsewhere.
+PhlexForms/RawForm:
+  Enabled: true
+  Include:
+    - "app/components/**/*.rb"
+    - "app/views/**/*.rb"
+PhlexForms/LegacyFormMethod:
+  Enabled: true
+  Include:
+    - "app/components/**/*.rb"
+    - "app/views/**/*.rb"

data/lib/forms/checkbox.rb ADDED Viewed

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+module Forms
+  # A model-bound checkbox, delegating to DaisyUI::Checkbox. Emits a hidden field
+  # carrying the unchecked value so an unchecked box still submits (the Rails
+  # checkbox convention).
+  class Checkbox < Phlex::HTML
+    include PhlexForms::DelegatedField
+    def initialize(*modifiers, name: nil, id: nil, value: "1", unchecked_value: "0",
+                   checked: false, error: false, disabled: false, required: false, **attributes)
+      @modifiers = normalize_modifiers(modifiers)
+      @name = name
+      @id = id
+      @value = value
+      @unchecked_value = unchecked_value
+      @checked = checked
+      @error = error
+      @disabled = disabled
+      @required = required
+      @full_width = false
+      @attributes = attributes
+      super()
+    end
+    def view_template
+      input(type: "hidden", name: @name, value: @unchecked_value) if @unchecked_value && @name
+      render DaisyUI::Checkbox.new(*daisy_modifiers, value: @value, **checkbox_attributes)
+    end
+    private
+    def checkbox_attributes
+      attrs = binding_attributes
+      attrs[:checked] = true if @checked
+      attrs
+    end
+  end
+end

data/lib/forms/choices_select.rb ADDED Viewed

@@ -0,0 +1,132 @@
+# frozen_string_literal: true
+module Forms
+  # A searchable/multi-select `<select>` enhanced by the choices.js Stimulus
+  # controller (shipped with the gem). Renders a normal `<select>` server-side;
+  # the `choices` controller upgrades it on connect. choices.js replaces the
+  # element, so size/color positional modifiers are passed as data values and
+  # applied to the choices.js wrapper by the controller (not as daisyui classes).
+  class ChoicesSelect < Phlex::HTML
+    SIZE_MODIFIERS = %i[xs sm md lg xl].freeze
+    COLOR_MODIFIERS = %i[primary secondary accent neutral info success warning error].freeze
+    def initialize(*modifiers, name: nil, id: nil, choices: [], selected: nil, multiple: false,
+                   searchable: false, remove_item_button: nil, placeholder: nil,
+                   include_blank: false, prompt: nil, error: false, disabled: false, required: false, **options)
+      @modifiers = modifiers
+      @name = name
+      @id = id
+      @choices = choices
+      @selected = selected
+      @multiple = multiple
+      @searchable = searchable
+      @remove_item_button = remove_item_button.nil? ? multiple : remove_item_button
+      @placeholder = placeholder
+      @include_blank = include_blank
+      @prompt = prompt
+      @error = error
+      @disabled = disabled
+      @required = required
+      @options = options
+      super()
+    end
+    def view_template
+      select(**attrs) do
+        render_prompt if @prompt || @include_blank
+        render_choices
+      end
+    end
+    private
+    def attrs
+      a = {
+        name: select_name,
+        id: @id,
+        class: PhlexForms::ClassMerge.merge("choices-select w-full", @options[:class]),
+        data: stimulus_data,
+        **@options.except(:class, :value, :data)
+      }
+      a[:multiple] = true if @multiple
+      a[:disabled] = true if @disabled
+      a[:required] = true if @required
+      a.compact
+    end
+    def select_name
+      return nil unless @name
+      @multiple ? "#{@name}[]" : @name
+    end
+    def stimulus_data
+      base = @options[:data] || {}
+      {
+        controller: [base[:controller], "choices"].compact.join(" "),
+        choices_searchable_value: @searchable,
+        choices_remove_item_button_value: @remove_item_button,
+        choices_placeholder_value: @placeholder.to_s,
+        choices_size_value: size_value,
+        choices_color_value: color_value,
+        **base.except(:controller)
+      }
+    end
+    def size_value
+      (@modifiers & SIZE_MODIFIERS).first.to_s
+    end
+    def color_value
+      ((@modifiers & COLOR_MODIFIERS).first || :primary).to_s
+    end
+    def render_prompt
+      text = @prompt || (@include_blank.is_a?(String) ? @include_blank : "")
+      option(value: "", selected: blank_selected?) { text }
+    end
+    def blank_selected?
+      @multiple ? Array(@selected).empty? : @selected.blank?
+    end
+    def render_choices
+      case @choices
+      when Hash then render_hash_choices(@choices)
+      else render_array_choices(Array(@choices))
+      end
+    end
+    def render_array_choices(choices)
+      choices.each do |choice|
+        if choice.is_a?(Array)
+          render_option(choice[1], choice[0])
+        else
+          render_option(choice, choice)
+        end
+      end
+    end
+    def render_hash_choices(choices)
+      choices.each do |label, value|
+        if value.is_a?(Array) || value.is_a?(Hash)
+          optgroup(label:) { value.is_a?(Array) ? render_array_choices(value) : render_hash_choices(value) }
+        else
+          render_option(value, label)
+        end
+      end
+    end
+    def render_option(value, label)
+      option(value: value.to_s, selected: selected?(value) || nil) { label.to_s }
+    end
+    def selected?(value)
+      if @multiple
+        Array(@selected).map(&:to_s).include?(value.to_s)
+      else
+        @selected.to_s == value.to_s
+      end
+    end
+  end
+end

data/lib/forms/collection_check_box.rb ADDED Viewed

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+module Forms
+  # A single checkbox within a collection_check_boxes group.
+  class CollectionCheckBox < Phlex::HTML
+    def initialize(name:, id:, value:, checked:, **options)
+      @name = name
+      @id = id
+      @value = value
+      @checked = checked
+      @options = options
+      super()
+    end
+    def view_template
+      input(
+        type: "checkbox",
+        name: @name,
+        id: @id,
+        value: @value,
+        class: @options[:class] || "checkbox",
+        checked: @checked || nil
+      )
+    end
+  end
+end

data/lib/forms/collection_check_box_builder.rb ADDED Viewed

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+module Forms
+  # Yielded for each item by Form#collection_check_boxes. Provides check_box and
+  # label builders mirroring Rails' collection_check_boxes API.
+  class CollectionCheckBoxBuilder
+    attr_reader :object, :value, :text
+    def initialize(object:, value:, text:, checked:, name:, id:)
+      @object = object
+      @value = value
+      @text = text
+      @checked = checked
+      @name = name
+      @id = id
+    end
+    def check_box(options = {})
+      Forms::CollectionCheckBox.new(name: @name, id: @id, value: @value, checked: @checked, **options)
+    end
+    def label(options = {}, &)
+      Forms::CollectionLabel.new(for_id: @id, text: @text, **options, &)
+    end
+  end
+end

data/lib/forms/collection_label.rb ADDED Viewed

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+module Forms
+  # A label for a single collection checkbox item.
+  class CollectionLabel < Phlex::HTML
+    def initialize(for_id:, text:, **options, &block)
+      @for_id = for_id
+      @text = text
+      @options = options
+      @block = block
+      super()
+    end
+    def view_template
+      label(for: @for_id, class: @options[:class]) do
+        @block ? yield_content(&@block) : plain(@text)
+      end
+    end
+  end
+end

data/lib/forms/email_field.rb ADDED Viewed

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+module Forms
+  # Convenience: an Input pre-typed as email with a sensible default placeholder.
+  #   EmailField(:primary, name: "user[email]")
+  class EmailField < Input
+    def initialize(*, placeholder: "email@example.com", **)
+      super(*, type: "email", placeholder:, **)
+    end
+  end
+end