inline_forms 8.1.40 → 8.1.42

data/test/integration/schema_preview_test.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+require_relative "../integration_test_helper"
+
+# Cheap preview of a SchemaIntent against the dummy app: a virtual typed
+# attribute on a throwaway subclass + an AttributeList with the proposed row
+# spliced in — no migration, no column, real class/table untouched.
+class SchemaPreviewTest < InlineFormsIntegrationTestCase
+  def scalar_intent(**overrides)
+    InlineForms::SchemaIntent.new(
+      **{ model_name: "Widget", attribute: :internal_note, form_element: :text_field }.merge(overrides)
+    )
+  end
+
+  test "supported? is true for scalar elements, false for relations/uploaders/virtuals" do
+    assert InlineForms::SchemaPreview.supported?(scalar_intent(form_element: :text_field))
+    assert InlineForms::SchemaPreview.supported?(scalar_intent(form_element: :integer_field))
+    assert InlineForms::SchemaPreview.supported?(scalar_intent(form_element: :date_select))
+    assert InlineForms::SchemaPreview.supported?(scalar_intent(form_element: :check_box))
+    refute InlineForms::SchemaPreview.supported?(scalar_intent(form_element: :dropdown))
+    refute InlineForms::SchemaPreview.supported?(scalar_intent(form_element: :rich_text))
+    refute InlineForms::SchemaPreview.supported?(scalar_intent(form_element: :image_field))
+    refute InlineForms::SchemaPreview.supported?(scalar_intent(form_element: :money_field))
+  end
+
+  test "preview object carries the proposed attribute as a virtual, no column" do
+    object, = InlineForms::SchemaPreview.build(scalar_intent)
+
+    assert object.respond_to?(:internal_note), "preview should expose the virtual attribute"
+    assert_nil object.internal_note, "virtual attribute defaults to nil with no column"
+    object.internal_note = "boiler serviced"
+    assert_equal "boiler serviced", object.internal_note, "virtual attribute is writable in memory"
+
+    # The real class/table are untouched.
+    refute_includes Widget.column_names, "internal_note"
+    assert_equal "Widget", object.class.name, "preview masquerades as the base class"
+  end
+
+  test "preview attribute_list splices the row at --after" do
+    _, list = InlineForms::SchemaPreview.build(scalar_intent(after: :name))
+    assert_kind_of InlineForms::AttributeList, list
+    assert_equal :internal_note, list.names[list.index_of(:name) + 1]
+    # original rows are preserved
+    assert list.include_attribute?(:priority)
+  end
+
+  test "preview attribute_list appends when no anchor given" do
+    _, list = InlineForms::SchemaPreview.build(scalar_intent)
+    assert_equal :internal_note, list.names.last
+  end
+
+  test "preview seeds existing attributes from a base record" do
+    widget = Widget.create!(name: "Base", priority: 2)
+    object, = InlineForms::SchemaPreview.build(scalar_intent, widget)
+    assert_equal "Base", object.name, "existing data is carried into the preview"
+    assert_nil object.internal_note
+  end
+
+  test "building a preview does not add a column to the real table" do
+    before = Widget.column_names.dup
+    InlineForms::SchemaPreview.build(scalar_intent(after: :name))
+    Widget.reset_column_information
+    assert_equal before, Widget.column_names
+  end
+end

data/test/integration_test_helper.rb

@@ -49,6 +49,44 @@ ActiveRecord::Schema.define do
   end
   add_index :parts, :machine_id
 
+  # Gizmo intentionally has NO `pending_note` column: its attribute_list
+  # references one, modeling the inline_forms_addto pre-migrate window that
+  # InlineForms.attribute_pending_migration? gates. See
+  # test/integration/pending_migration_gate_test.rb.
+  create_table :gizmos, force: true do |t|
+    t.string :name
+    t.timestamps
+  end
+
+  # Schema-GUI batch pipeline (inline_forms_schema_edit). Mirrors the gem's
+  # install-generator migration.
+  create_table :inline_forms_schema_batches, force: true do |t|
+    t.string   :status, null: false, default: "draft"
+    t.string   :requested_by
+    t.datetime :submitted_at
+    t.datetime :window_at
+    t.datetime :applied_at
+    t.string   :git_sha
+    t.string   :content_digest
+    t.text     :error
+    t.timestamps
+  end
+  add_index :inline_forms_schema_batches, :status
+
+  create_table :inline_forms_schema_intents, force: true do |t|
+    t.references :batch, null: false, index: true
+    t.string  :target_model, null: false
+    t.string  :attr_name, null: false
+    t.string  :form_element, null: false
+    t.string  :after_attr
+    t.string  :before_attr
+    t.string  :label
+    t.string  :locale
+    t.integer :position
+    t.string  :migration_version
+    t.timestamps
+  end
+
   # PaperTrail (paper_trail 17.x shape).
   create_table :versions, force: true do |t|
     t.string   :item_type, null: false
@@ -75,6 +113,9 @@ class InlineFormsIntegrationTestCase < ActionDispatch::IntegrationTest
     Kind.delete_all
     Part.delete_all
     Machine.delete_all
+    Gizmo.delete_all
     PaperTrail::Version.delete_all
+    InlineForms::SchemaIntentRecord.delete_all
+    InlineForms::SchemaBatch.delete_all
   end
 end

data/test/schema_apply_test.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+require_relative "test_helper"
+require "tmpdir"
+require "fileutils"
+
+class SchemaApplyTest < Minitest::Test
+  def intent(**overrides)
+    InlineForms::SchemaIntent.new(
+      **{ model_name: "Apartment", attribute: :internal_note, form_element: :text_field }.merge(overrides)
+    )
+  end
+
+  def test_generator_command
+    apply = InlineForms::SchemaApply.new(intent(after: :name))
+    assert_equal(
+      %w[bundle exec rails g inline_forms_addto Apartment internal_note:text_field --after=name],
+      apply.generator_command
+    )
+  end
+
+  def test_commands_are_ordered_generate_then_migrate
+    apply = InlineForms::SchemaApply.new(intent)
+    assert_equal %i[generate migrate], apply.commands.keys
+    assert_equal %w[bundle exec rails db:migrate], apply.commands[:migrate]
+  end
+
+  def test_preview_plan_is_human_readable
+    plan = InlineForms::SchemaApply.new(intent).preview_plan
+    assert_equal 2, plan.size
+    assert_match(/\Agenerate: bundle exec rails g inline_forms_addto Apartment/, plan.first)
+  end
+
+  def test_run_bang_executes_in_order_with_injected_runner
+    calls = []
+    runner = ->(cmd) { calls << cmd; true }
+    result = InlineForms::SchemaApply.new(intent, runner: runner).run!
+    assert_nil result, "expected success (nil)"
+    assert_equal 2, calls.size
+    assert_equal %w[bundle exec rails g inline_forms_addto Apartment internal_note:text_field], calls.first
+    assert_equal %w[bundle exec rails db:migrate], calls.last
+  end
+
+  def test_generate_returns_only_a_newly_created_migration
+    Dir.mktmpdir("schema_apply_generate") do |root|
+      migrate_dir = File.join(root, "db", "migrate")
+      FileUtils.mkdir_p(migrate_dir)
+      # A pre-existing addto migration must NOT be reported when this run
+      # creates nothing (the :header case).
+      FileUtils.touch(File.join(migrate_dir, "20200101000000_inline_forms_add_to_widgets_old.rb"))
+
+      header_executor = ->(_args, _root) { } # header: no migration created
+      result = InlineForms::SchemaApply.new(intent(form_element: :header))
+                                       .generate!(destination_root: root, executor: header_executor)
+      assert_nil result, "header apply must report no migration, not a stale one"
+
+      # A run that creates a migration reports that one.
+      creating = lambda do |_args, _root|
+        FileUtils.touch(File.join(migrate_dir, "20260101000000_inline_forms_add_to_widgets_note.rb"))
+      end
+      created = InlineForms::SchemaApply.new(intent).generate!(destination_root: root, executor: creating)
+      assert_equal "20260101000000_inline_forms_add_to_widgets_note.rb", File.basename(created)
+    end
+  end
+
+  def test_run_bang_stops_at_first_failure
+    calls = []
+    runner = ->(cmd) { calls << cmd; false } # generate fails
+    result = InlineForms::SchemaApply.new(intent, runner: runner).run!
+    assert_equal :generate, result
+    assert_equal 1, calls.size, "must not run migrate after generate failed"
+  end
+end

data/test/schema_intent_test.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+require_relative "test_helper"
+
+class SchemaIntentTest < Minitest::Test
+  def intent(**overrides)
+    InlineForms::SchemaIntent.new(
+      **{ model_name: "Apartment", attribute: :internal_note, form_element: :text_field }.merge(overrides)
+    )
+  end
+
+  def test_normalizes_types
+    i = intent(attribute: "note", form_element: "text_field", after: "name")
+    assert_equal "Apartment", i.model_name
+    assert_equal :note, i.attribute
+    assert_equal :text_field, i.form_element
+    assert_equal :name, i.after
+    assert_equal :draft, i.status
+  end
+
+  def test_column_token
+    assert_equal "internal_note:text_field", intent.column_token
+  end
+
+  def test_generator_args_plain
+    assert_equal [ "Apartment", "internal_note:text_field" ], intent.generator_args
+  end
+
+  def test_generator_args_with_after
+    assert_equal [ "Apartment", "internal_note:text_field", "--after=name" ],
+                 intent(after: :name).generator_args
+  end
+
+  def test_generator_args_with_before
+    assert_equal [ "Apartment", "internal_note:text_field", "--before=created_at" ],
+                 intent(before: :created_at).generator_args
+  end
+
+  def test_status_validation
+    assert_raises(ArgumentError) { intent(status: :bogus) }
+    i = intent
+    i.status = :applied
+    assert_equal :applied, i.status
+  end
+
+  def test_to_h_round_trips_core_fields
+    h = intent(after: :name, values: { 1 => "a" }).to_h
+    assert_equal "Apartment", h[:model_name]
+    assert_equal :internal_note, h[:attribute]
+    assert_equal({ 1 => "a" }, h[:values])
+    assert_equal :name, h[:after]
+  end
+end

data/test/schema_label_test.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+require_relative "test_helper"
+require "tmpdir"
+require "fileutils"
+
+class SchemaLabelTest < Minitest::Test
+  # Minimal stand-in for an AR model name (avoids booting ActiveRecord).
+  ModelName = Struct.new(:i18n_key)
+  class FakeModel
+    def self.model_name = ModelName.new(:apartment)
+  end
+
+  def setup
+    @root = Dir.mktmpdir("schema_label_test")
+    FileUtils.mkdir_p(File.join(@root, "config", "locales"))
+  end
+
+  def teardown
+    FileUtils.remove_entry(@root) if @root && Dir.exist?(@root)
+  end
+
+  def read_yaml(path)
+    YAML.safe_load(File.read(path))
+  end
+
+  def test_writes_label_under_the_human_attribute_name_key
+    path = InlineForms::SchemaLabel.write(
+      destination_root: @root, model_class: FakeModel,
+      attribute: :internal_note, label: "Internal note", locale: :en
+    )
+    assert_equal File.join(@root, "config/locales/inline_forms_labels.en.yml"), path
+    doc = read_yaml(path)
+    assert_equal "Internal note",
+                 doc.dig("en", "activerecord", "attributes", "apartment", "internal_note")
+  end
+
+  def test_merges_without_clobbering_existing_labels
+    InlineForms::SchemaLabel.write(destination_root: @root, model_class: FakeModel,
+                                   attribute: :first_field, label: "First", locale: :en)
+    InlineForms::SchemaLabel.write(destination_root: @root, model_class: FakeModel,
+                                   attribute: :second_field, label: "Second", locale: :en)
+
+    attrs = read_yaml(InlineForms::SchemaLabel.file_path(@root, :en))
+             .dig("en", "activerecord", "attributes", "apartment")
+    assert_equal "First", attrs["first_field"]
+    assert_equal "Second", attrs["second_field"]
+  end
+
+  def test_separate_file_per_locale
+    InlineForms::SchemaLabel.write(destination_root: @root, model_class: FakeModel,
+                                   attribute: :note, label: "Note", locale: :en)
+    InlineForms::SchemaLabel.write(destination_root: @root, model_class: FakeModel,
+                                   attribute: :note, label: "Notitie", locale: :nl)
+
+    assert_equal "Note", read_yaml(InlineForms::SchemaLabel.file_path(@root, :en))
+                          .dig("en", "activerecord", "attributes", "apartment", "note")
+    assert_equal "Notitie", read_yaml(InlineForms::SchemaLabel.file_path(@root, :nl))
+                            .dig("nl", "activerecord", "attributes", "apartment", "note")
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: inline_forms
 version: !ruby/object:Gem::Version
-  version: 8.1.40
+  version: 8.1.42
 platform: ruby
 authors:
 - Ace Suares
@@ -102,6 +102,7 @@ files:
 - ".rubocop_todo.yml"
 - ".ruby-version"
 - CHANGELOG.md
+- CLAUDE.md
 - Gemfile
 - LICENSE.txt
 - README.rdoc
@@ -150,11 +151,13 @@ files:
 - app/views/inline_forms/_list.html.erb
 - app/views/inline_forms/_new.html.erb
 - app/views/inline_forms/_new_nested.html.erb
+- app/views/inline_forms/_pending_migration_row.html.erb
 - app/views/inline_forms/_show.html.erb
 - app/views/inline_forms/_versions.html.erb
 - app/views/inline_forms/_versions_list.html.erb
 - app/views/inline_forms/create_list_frame.html.erb
 - app/views/inline_forms/field_edit.html.erb
+- app/views/inline_forms/field_pending.html.erb
 - app/views/inline_forms/field_show.html.erb
 - app/views/inline_forms/new_record.html.erb
 - app/views/inline_forms/row_close.html.erb
@@ -206,6 +209,7 @@ files:
 - lib/generators/templates/test.erb
 - lib/inline_forms.rb
 - lib/inline_forms/archived_form_elements.rb
+- lib/inline_forms/attribute_list.rb
 - lib/inline_forms/form_element_from_callee.rb
 - lib/inline_forms/form_element_registry.rb
 - lib/inline_forms/form_elements.rb
@@ -245,6 +249,10 @@ files:
 - lib/inline_forms/form_elements/text_field_helper.rb
 - lib/inline_forms/form_elements/time_helper.rb
 - lib/inline_forms/gem_files.rb
+- lib/inline_forms/schema_apply.rb
+- lib/inline_forms/schema_intent.rb
+- lib/inline_forms/schema_label.rb
+- lib/inline_forms/schema_preview.rb
 - lib/inline_forms/tabs.rb
 - lib/inline_forms/turbo_tabs_builder.rb
 - lib/inline_forms/version.rb
@@ -256,12 +264,15 @@ files:
 - lib/vagrant/vagrantbox-inline_forms.zip
 - script/migrate_form_elements.rb
 - test/archived_form_elements_test.rb
+- test/attribute_list_test.rb
 - test/dummy/app/controllers/application_controller.rb
+- test/dummy/app/controllers/gizmos_controller.rb
 - test/dummy/app/controllers/machines_controller.rb
 - test/dummy/app/controllers/parts_controller.rb
 - test/dummy/app/controllers/widgets_controller.rb
 - test/dummy/app/helpers/application_helper.rb
 - test/dummy/app/models/application_record.rb
+- test/dummy/app/models/gizmo.rb
 - test/dummy/app/models/kind.rb
 - test/dummy/app/models/machine.rb
 - test/dummy/app/models/part.rb
@@ -281,8 +292,15 @@ files:
 - test/integration/legacy_elements_test.rb
 - test/integration/native_inputs_test.rb
 - test/integration/open_after_create_test.rb
+- test/integration/pending_migration_gate_test.rb
+- test/integration/schema_batch_pipeline_test.rb
+- test/integration/schema_edit_test.rb
+- test/integration/schema_preview_test.rb
 - test/integration_test_helper.rb
 - test/plain_text_configuration_test.rb
+- test/schema_apply_test.rb
+- test/schema_intent_test.rb
+- test/schema_label_test.rb
 - test/tabs_test.rb
 - test/test_helper.rb
 - test/user_model_config_test.rb
@@ -314,12 +332,15 @@ specification_version: 4
 summary: Inline editing of forms for Rails 8.
 test_files:
 - test/archived_form_elements_test.rb
+- test/attribute_list_test.rb
 - test/dummy/app/controllers/application_controller.rb
+- test/dummy/app/controllers/gizmos_controller.rb
 - test/dummy/app/controllers/machines_controller.rb
 - test/dummy/app/controllers/parts_controller.rb
 - test/dummy/app/controllers/widgets_controller.rb
 - test/dummy/app/helpers/application_helper.rb
 - test/dummy/app/models/application_record.rb
+- test/dummy/app/models/gizmo.rb
 - test/dummy/app/models/kind.rb
 - test/dummy/app/models/machine.rb
 - test/dummy/app/models/part.rb
@@ -339,8 +360,15 @@ test_files:
 - test/integration/legacy_elements_test.rb
 - test/integration/native_inputs_test.rb
 - test/integration/open_after_create_test.rb
+- test/integration/pending_migration_gate_test.rb
+- test/integration/schema_batch_pipeline_test.rb
+- test/integration/schema_edit_test.rb
+- test/integration/schema_preview_test.rb
 - test/integration_test_helper.rb
 - test/plain_text_configuration_test.rb
+- test/schema_apply_test.rb
+- test/schema_intent_test.rb
+- test/schema_label_test.rb
 - test/tabs_test.rb
 - test/test_helper.rb
 - test/user_model_config_test.rb