dsfr-form_builder 0.0.8 → 0.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3a0c8e3318e640b14b7afd55c5537fe023032157365a84b21511711f838953f8
-  data.tar.gz: 0a4bb1ea72d2b0b10adcb0ceeeb3352f53e0085129be6ca9b92b2a5444cd6516
+  metadata.gz: 9bd7c63d280b90c223ac24825d70fd3b529c71fb1d242335785235a5a6e7370c
+  data.tar.gz: c90dbb0f5479e9401afebcd99e199c0d2c95be725b2333d84f1b2dd03b24bdee
 SHA512:
-  metadata.gz: f7c13e694c9ed5e71a2d337fcd144ceae3ab7be5a432a7bd6a23c1f5148edd9529c2000910dcbc597640a6b41b84a99663b176b9c3cc59cc98fde7c2ce903cff
-  data.tar.gz: '0428eb812019cb50208f820a582f8bdf37786f979cb660bd6b5952e905286142bbaefeffc9f84c61583180bd0c4c21eb3df17af110b06916f81894ba1eeefc04'
+  metadata.gz: f8d706444e7afec231c0bd8cf094be44c9a8ad4b0c5af3149749fca02d9da74b51d13c69b884183ad97fda19d8f847006f4f7501b9df43b5dbf8436c5764397f
+  data.tar.gz: e1297220a5fef326d01d1381d70fe85543b9d3371327f25f7d294ac7564ccea48d28d54db4edc747ce199e8765b0fa474ae67ffafa2f340ebcf9d1a2914b33d2

data/lib/dsfr-form_builder.rb

@@ -1,7 +1,6 @@
 module Dsfr
   include ActiveSupport::Configurable
 
-
   class FormBuilder < ActionView::Helpers::FormBuilder
     include ActionView::Helpers::OutputSafetyHelper
 
@@ -12,188 +11,194 @@ module Dsfr
       self.display_required_tags = options.fetch(:display_required_tags, true)
     end
 
-    def dsfr_text_field(attribute, opts = {})
-      dsfr_input_field(attribute, :text_field, opts)
-    end
-
-    def dsfr_text_area(attribute, opts = {})
-      dsfr_input_field(attribute, :text_area, opts)
-    end
-
-    def dsfr_email_field(attribute, opts = {})
-      dsfr_input_field(attribute, :email_field, opts)
-    end
-
-    def dsfr_url_field(attribute, opts = {})
-      dsfr_input_field(attribute, :url_field, opts)
+    def dsfr_button(value = nil, options = {}, &block)
+      if block_given?
+        options = value || {}
+        value = @template.capture { yield(value) }
+      end
+      options[:type] ||= :button
+      options[:class] = @template.class_names("fr-btn", options[:class])
+      button(value, options)
     end
 
-    def dsfr_phone_field(attribute, opts = {})
-      dsfr_input_field(attribute, :phone_field, opts)
+    def dsfr_submit(value = nil, options = {}, &block)
+      if block_given?
+        options = value || {}
+        value = @template.capture { yield(value) }
+      end
+      options[:type] = :submit
+      dsfr_button(value, options)
     end
 
-    def dsfr_number_field(attribute, opts = {})
-      dsfr_input_field(attribute, :number_field, opts)
+    %i[text_field text_area email_field url_field phone_field number_field].each do |field_type|
+      define_method("dsfr_#{field_type}") do |attribute, **options|
+        dsfr_input_field(attribute, field_type, **options)
+      end
     end
 
-    def dsfr_input_group(attribute, opts, &block)
-      @template.content_tag(:div, class: input_group_classes(attribute, opts), data: opts[:data]) do
-        yield(block)
-      end
+    def dsfr_input_group(attribute, opts, kind: :input, &block)
+      @template.tag.div(
+        yield(block),
+        data: opts[:data],
+        class: @template.class_names(
+              "fr-#{kind}-group",
+              opts[:class],
+              "fr-#{kind}-group--error" => @object&.errors&.include?(attribute)
+        )
+      )
     end
 
     def dsfr_input_field(attribute, input_kind, opts = {})
       dsfr_input_group(attribute, opts) do
-        @template.safe_join(
-          [
-            dsfr_label_with_hint(attribute, opts),
-            public_send(input_kind, attribute, class: "fr-input", **opts.except(:class, :hint, :label, :data)),
-            dsfr_error_message(attribute)
-          ]
-        )
+        @template.safe_join([
+          dsfr_label_with_hint(attribute, opts),
+          public_send(input_kind, attribute, class: "fr-input", **opts.except(:class, :hint, :label, :data)),
+          dsfr_error_message(attribute)
+        ])
       end
     end
 
     def dsfr_file_field(attribute, opts = {})
-      @template.content_tag(:div, class: upload_group_classes(attribute, opts), data: opts[:data]) do
-        @template.safe_join(
-          [
-            dsfr_label_with_hint(attribute, opts.except(:class)),
-            file_field(attribute, class: "fr-upload", **opts.except(:class, :hint, :label, :data)),
-            dsfr_error_message(attribute)
-          ].compact
-        )
+      dsfr_input_group(attribute, opts, kind: :upload) do
+        @template.safe_join([
+          dsfr_label_with_hint(attribute, opts.except(:class)),
+          file_field(attribute, class: "fr-upload", **opts.except(:class, :hint, :label, :data)),
+          dsfr_error_message(attribute)
+        ])
       end
     end
 
     def dsfr_check_box(attribute, opts = {}, checked_value = "1", unchecked_value = "0")
-      @template.content_tag(:div, class: "fr-fieldset__element") do
-        @template.content_tag(:div, class: "fr-checkbox-group") do
-          @template.safe_join(
-            [
-              check_box(attribute, opts, checked_value, unchecked_value),
-              dsfr_label_with_hint(attribute, opts)
-            ]
-          )
+      @template.tag.div(class: @template.class_names("fr-fieldset__element", "fr-fieldset__element--inline" => opts.delete(:inline))) do
+        dsfr_input_group(attribute, opts, kind: :checkbox) do
+          @template.safe_join([
+            check_box(attribute, opts.except(:label, :hint), checked_value, unchecked_value),
+            dsfr_label_with_hint(attribute, opts)
+          ])
         end
       end
     end
 
+    def dsfr_collection_check_boxes(method, collection, value_method, text_method, opts = {}, html_options = {})
+      legend = opts.delete(:legend) || @object&.class&.human_attribute_name(method)
+      if legend.blank?
+        raise ArgumentError.new("Please provide the legend option, or use an object whose class responds to :human_attribute_name")
+      end
+      legend = @template.safe_join([ legend, hint_tag(opts.delete(:hint)) ])
+      name = opts.delete(:name) || "#{@object_name}[#{method}][]"
+      html_options[:class] = @template.class_names("fr-fieldset", html_options[:class])
+      @template.tag.fieldset(**html_options) do
+        @template.safe_join([
+          @template.tag.legend(legend, class: "fr-fieldset__legend--regular fr-fieldset__legend"),
+          @template.hidden_field_tag(name, "", id: nil),
+          collection.map do |item|
+            value = item.send(value_method)
+            checkbox_options = {
+              name: name,
+              value: value,
+              id: field_id(method, value),
+              label: item.send(text_method),
+              inline: opts[:inline],
+              checked: selected?(method, value),
+              include_hidden: false
+            }
+            dsfr_check_box(method, checkbox_options, value, "")
+          end
+        ])
+      end
+    end
+
     def dsfr_select(attribute, choices, input_options: {}, **opts)
-      @template.content_tag(:div, class: "fr-select-group") do
-        @template.safe_join(
-          [
-            dsfr_label_with_hint(attribute, opts),
-            dsfr_select_tag(attribute, choices, **opts, **(input_options)),
-            dsfr_error_message(attribute)
-          ]
-        )
+      dsfr_input_group(attribute, opts, kind: :select) do
+        @template.safe_join([
+          dsfr_label_with_hint(attribute, opts),
+          dsfr_select_tag(attribute, choices, opts.merge(input_options).except(:hint, :name)),
+          dsfr_error_message(attribute)
+        ])
       end
     end
 
     def dsfr_select_tag(attribute, choices, opts)
-      select(attribute, choices, { include_blank: opts[:include_blank] }, class: "fr-select")
+      opts[:class] = @template.class_names("fr-select", opts[:class])
+      options = opts.slice(:include_blank, :selected, :disabled)
+      html_options = opts.except(:include_blank, :selected, :disabled)
+      select(attribute, choices, options, **html_options)
     end
 
     def dsfr_radio_buttons(attribute, choices, legend: nil, hint: nil, **opts)
       legend_content = @template.safe_join([
         legend || @object.class.human_attribute_name(attribute),
-        hint ? hint_tag(hint) : nil
-      ].compact)
-      @template.content_tag(:fieldset, class: "fr-fieldset") do
-        @template.safe_join(
-          [
-            @template.content_tag(:legend, legend_content, class: "fr-fieldset__legend--regular fr-fieldset__legend"),
-            choices.map { |c| dsfr_radio_option(attribute, value: c[:value], label_text: c[:label], hint: c[:hint], checked: c[:checked], **opts) }
-          ]
-        )
+        hint_tag(hint)
+      ])
+      @template.tag.fieldset(class: "fr-fieldset") do
+        @template.safe_join([
+          @template.tag.legend(legend_content, class: "fr-fieldset__legend--regular fr-fieldset__legend"),
+          choices.map do |choice|
+            dsfr_radio_option(
+              attribute,
+              value: choice[:value],
+              label_text: choice[:label],
+              hint: choice[:hint],
+              checked: choice[:checked],
+              **opts
+            )
+          end
+        ])
       end
     end
 
     def dsfr_radio_option(attribute, value:, label_text:, hint:, checked:, rich: false, **opts)
-      @template.content_tag(:div, class: "fr-fieldset__element") do
-        classes = rich ? "fr-radio-group fr-radio-rich" : "fr-radio-group"
-        @template.content_tag(:div, class: classes) do
-          @template.safe_join(
-            [
-              radio_button(attribute, value, checked:, **opts),
-              label([ attribute, value ].join("_").to_sym) do
-                @template.safe_join(
-                  [
-                    label_text,
-                    hint.present? ? @template.content_tag(:span, hint, class: "fr-hint-text") : nil
-                  ]
-                )
-              end
-            ]
-          )
+      @template.tag.div(class: "fr-fieldset__element") do
+        @template.tag.div(class: @template.class_names("fr-radio-group", "fr-radio-rich" => rich)) do
+          @template.safe_join([
+            radio_button(attribute, value, checked:, **opts),
+            dsfr_label_with_hint(attribute, opts.merge(label_text: label_text, hint: hint, value: value))
+          ])
         end
       end
     end
 
     def dsfr_label_with_hint(attribute, opts = {})
-      label_class = "fr-label #{opts[:class]}"
-      label(attribute, class: label_class) do
-        label_and_tags = [ label_value(attribute, opts) ]
-        label_and_tags.push(required_tag) if opts[:required] && display_required_tags
-        label_and_tags.push(hint_tag(opts[:hint])) if opts[:hint]
-
-        @template.safe_join(label_and_tags)
+      label(attribute, class: @template.class_names("fr-label", opts[:class]), value: opts[:value]) do
+        @template.safe_join([
+          opts[:label_text] || label_value(attribute, opts),
+          (required_tag if opts[:required] && display_required_tags),
+          (hint_tag(opts[:hint]) if opts[:hint])
+        ])
       end
     end
 
     def required_tag
-      @template.content_tag(:span, "*", class: "fr-text-error")
+      @template.tag.span("*", class: "fr-text-error")
     end
 
     def dsfr_error_message(attr)
-      return if @object.errors[attr].none?
+      return if @object.nil? || @object.errors[attr].none?
 
-      @template.content_tag(:p, class: "fr-messages-group") do
+      @template.tag.p(class: "fr-messages-group") do
         safe_join(@object.errors.full_messages_for(attr).map do |msg|
-          @template.content_tag(:span, msg, class: "fr-message fr-message--error")
+          @template.tag.span(msg, class: "fr-message fr-message--error")
         end)
       end
     end
 
     def hint_tag(text)
-      return "" unless text
-
-      @template.content_tag(:span, class: "fr-hint-text") do
-        text
-      end
-
-      @template.content_tag(:span, text, class: "fr-hint-text")
+      @template.tag.span(text, class: "fr-hint-text") if text
     end
 
-    def join_classes(arr)
-      arr.compact.join(" ")
-    end
+    def label_value(attribute, opts)
+      return opts[:label] if opts[:label]
 
-    def input_group_classes(attribute, opts)
-      join_classes(
-        [
-          "fr-input-group",
-          @object.errors[attribute].any? ? "fr-input-group--error" : nil,
-          opts[:class]
-        ]
-      )
+      (@object.try(:object) || @object).class.human_attribute_name(attribute)
     end
 
-    def upload_group_classes(attribute, opts)
-      join_classes(
-        [
-          "fr-upload-group",
-          @object.errors[attribute].any? ? "fr-upload-group--error" : nil,
-          opts[:class]
-        ]
-      )
-    end
+    private
 
-    def label_value(attribute, opts)
-      return opts[:label] if opts[:label]
+    # TODO: Allow this helper to be used by select options and radio buttons.
+    def selected?(method, value)
+      return unless @object.respond_to?(method)
 
-      (@object.try(:object) || @object).class.human_attribute_name(attribute)
+      (@object.send(method) || []).include?(value)
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dsfr-form_builder
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 0.0.9
 platform: ruby
 authors:
 - BetaGouv developers
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-03-25 00:00:00.000000000 Z
+date: 2026-01-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionview
@@ -104,7 +104,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.13
+rubygems_version: 3.4.1
 signing_key:
 specification_version: 4
 summary: Ruby on Rails form builder pour le Système de Design de l'État (DSFR)