NamespaceCollection enumerate building enumerable repeatedly

[dhnaranjo]

I don't super understand exactly what happened here. I was doin a lil something like this:

class PageForm < ApplicationForm
  def template
    div do
      collection(:responses).each do |response_fields|
        response = response_fields.object
        item = response.item
        options = item.options.pluck(:id, :label)
        render response_fields.field(:option_id).radio(options)
      end
    end
  end
end

And whenever I'd assign the params it seemed like the NamespaceCollection was building the namespaces array twice, overwriting the first, so that my namespaces didn't have any children, so no update was made.

This makes it work. I'm not really sure why.

module Superform
  class NamespaceCollection < Node
    def enumerate(enumerable)
      enumerable.map.with_index do |object, key|
        build_namespace(key, object:)
      end
    end
  end
end

[dhnaranjo]

I also had some issues with NamespaceCollection#assign, where if a collection had no members I'd get an error and if the array passed into it was an ActionController::Parameters hash with indexed keys style thinger it would fail, so now I'm at

module Superform
  class NamespaceCollection < Node
    def enumerate(enumerable)
      enumerable.map.with_index do |object, key|
        build_namespace(key, object:)
      end
    end

    def assign(array)
      array = array.values if array.is_a?(ActionController::Parameters)
      return if array.blank?

      zip(array) do |namespace, hash|
        namespace.assign hash
      end
    end
  end
end

[bradgessler]

Are you trying to get radio inputs working in the first comment?

I also had some issues with NamespaceCollection#assign, where if a collection had no members I'd get an error and if the array passed into it was an ActionController::Parameters hash with indexed keys style thinger it would fail, so now I'm at

Is that still related to radio buttons?

The short answer is I haven't gotten to radio inputs yet; I think they're different than regular inputs, despite being an input since Rails handles them as a collection.

[dhnaranjo]

I was working on radio inputs, but that's not related to these issues. I have my own radio fieldset component. This is a version with some my-project-specific stuff removed. options is an array of two-element arrays matching [label, value]. Works fine.

class RadioFieldset < FieldComponent
  def initialize(*, options: [], **, &)
    super(*, **, &)
    @options = options
  end

  def template
    fieldset do
      legend { field.key.to_s.titleize }
      @options.each do |(label, value)|
        radio_input(label, value)
      end
    end
  end

  def radio_input(label, value)
    input_id = "#{dom.id}_#{value}"

    label(for: input_id) do
      input(
        id: input_id,
        type: :radio,
        name: dom.name,
        value:,
        checked: field.value == value
      )
      span { label }
    end
  end
end

The only tweak it really needed was appending the value onto the individual inputs IDs to differentiate them.

The issue with assign was not related to radio buttons. Here's a repro script of the two issues, with failing tests pre-monkeypatch and passing post.

# frozen_string_literal: true

require 'bundler/inline'
require 'minitest/autorun'

gemfile(true) do
  source 'https://rubygems.org'

  gem 'rails', '~> 7.1'
  gem 'sqlite3'
  gem 'puma'
  gem 'phlex-rails'
  gem 'superform'
end

require 'rails/all'

database = 'superform_test.sqlite3'
ENV['DATABASE_URL'] = "sqlite3:#{database}"
ActiveRecord::Base.establish_connection(adapter: 'sqlite3', database: database)
ActiveRecord::Base.logger = Logger.new($stdout)
ActiveRecord::Schema.define do
  create_table :parents, if_not_exists: true do |t|
    t.string :name
  end
  create_table :children, if_not_exists: true do |t|
    t.references :parent, null: false, foreign_key: true
    t.string :name
  end
end

class App < Rails::Application
  config.root = __dir__
  config.eager_load = true
  config.consider_all_requests_local = true
  config.secret_key_base = 'Aswertyuioasdfghjkqwertyuiqwerty'
  config.active_storage.service_configurations = { 'local' => { 'service' => 'Disk', 'root' => './storage' } }
end

ApplicationComponent = Phlex::HTML

class Parent < ActiveRecord::Base
  has_many :children
  accepts_nested_attributes_for :children
end

class Child < ActiveRecord::Base
  belongs_to :parent
end

class ParentForm < Superform::Rails::Form
  def template
    field :name
    collection(:children).each do |child|
      child.field :name
    end
  end
end

module EnumeratePatch
  def enumerate(enumerable)
    enumerable.map.with_index do |object, key|
      build_namespace(key, object:)
    end
  end
end

module AssignPatch
  def assign(array)
    return if array.blank?

    super
  end
end

class ParentFormTest < ActiveSupport::TestCase
  def parent
    @parent ||= Parent.create!(name: 'Parent')
  end

  def form
    @form ||= ParentForm
                .new(parent, action: "/")
                .tap { |form| ActionController::Base.renderer.render_to_string(form) }
  end

  # I fail because I just keep on enumerating
  test "parent has children, no monkeypatch" do
    child = parent.children.create!(name: 'Child')
    params = ActionController::Parameters.new(
      parent: {
        name: 'tneraP',
        children: [
          {id: child.id, name: 'dlihC'}
        ]
      }
    )
    form.assign(params.require(:parent))
    assert_equal 'tneraP', parent.name
    assert_equal 'dlihC', child.name
  end

  # I pass
  test "parent has children, with monkeypatch" do
    Superform::NamespaceCollection.prepend(EnumeratePatch)

    child = parent.children.create!(name: 'Child')
    params = ActionController::Parameters.new(
      parent: {
        name: 'tneraP',
        children: [
          {id: child.id, name: 'dlihC'}
        ]
      }
    )
    form.assign(params.require(:parent))
    assert_equal 'tneraP', parent.name
    assert_equal 'dlihC', child.name
  end

  # I fail because I try to zip a nil object
  test "parent has no children, no monkeypatch" do
    params = ActionController::Parameters.new(
      parent: {
        name: 'tneraP'
      }
    )
    form.assign(params.require(:parent))
    assert_equal 'tneraP', parent.name
  end

  # I pass
  test "parent has no children, with monkeypatch" do
    Superform::NamespaceCollection.prepend(AssignPatch)

    params = ActionController::Parameters.new(
      parent: {
        name: 'tneraP'
      }
    )
    form.assign(params.require(:parent))
    assert_equal 'tneraP', parent.name
  end
end

I prolly shoulda sent one of these over in the first place.

[bradgessler]

Closing this issue since I think Radio Buttons will solve some of these problems. Continue the discussion at #13 if it's about Radios. If its related to something else then re-open the issue.