inline_forms 8.1.21 → 8.1.42

data/test/attribute_list_test.rb

@@ -0,0 +1,165 @@
+# frozen_string_literal: true
+
+require_relative "test_helper"
+
+class AttributeListTest < Minitest::Test
+  def build_sample
+    InlineForms::AttributeList.build do
+      header :basics
+      field  :name,     :text_field
+      field  :priority, :dropdown_with_values, values: { 1 => "low", 2 => "high" }
+      field  :flag,     :dropdown_with_values, values: { 1 => "a", 2 => "b" }, disabled: [ 2 ]
+      info   :created_at, :updated_at
+    end
+  end
+
+  # -- array compatibility (the whole point) -----------------------------
+
+  def test_is_an_array
+    assert_kind_of Array, build_sample
+  end
+
+  def test_destructures_like_the_legacy_literal
+    seen = []
+    build_sample.each { |attribute, form_element| seen << [ attribute, form_element ] }
+    assert_includes seen, [ :name, :text_field ]
+    assert_includes seen, [ :priority, :dropdown_with_values ]
+  end
+
+  def test_assoc_positional_values_hash_still_works
+    list = build_sample
+    # Consumers fetch the values hash as list.assoc(attr)[2].
+    assert_equal({ 1 => "low", 2 => "high" }, list.assoc(:priority)[2])
+    assert_equal([ 2 ], list.assoc(:flag)[3])
+    assert_nil list.assoc(:name)[2]
+  end
+
+  def test_build_produces_expected_rows
+    list = build_sample
+    assert_equal(
+      [
+        [ :basics, :header ],
+        [ :name, :text_field ],
+        [ :priority, :dropdown_with_values, { 1 => "low", 2 => "high" } ],
+        [ :flag, :dropdown_with_values, { 1 => "a", 2 => "b" }, [ 2 ] ],
+        [ :created_at, :info ],
+        [ :updated_at, :info ]
+      ],
+      list.to_a
+    )
+  end
+
+  # -- append -------------------------------------------------------------
+
+  def test_field_appends_and_returns_self_for_chaining
+    list = InlineForms::AttributeList.new
+    result = list.field(:a, :text_field).field(:b, :check_box)
+    assert_same list, result
+    assert_equal %i[a b], list.names
+  end
+
+  def test_disabled_without_values_raises
+    assert_raises(ArgumentError) do
+      InlineForms::AttributeList.new.field(:x, :dropdown_with_values, disabled: [ 1 ])
+    end
+  end
+
+  # -- insertion ----------------------------------------------------------
+
+  def test_insert_after
+    list = build_sample.insert_after(:name, :nickname, :text_field)
+    assert_equal :nickname, list.names[list.index_of(:name) + 1]
+  end
+
+  def test_insert_before
+    list = build_sample.insert_before(:priority, :urgent, :check_box)
+    assert_equal :urgent, list.names[list.index_of(:priority) - 1]
+  end
+
+  def test_insert_after_missing_anchor_raises
+    assert_raises(ArgumentError) { build_sample.insert_after(:nope, :x, :text_field) }
+  end
+
+  # -- removal ------------------------------------------------------------
+
+  def test_remove_present
+    list = build_sample.remove(:priority)
+    refute list.include_attribute?(:priority)
+  end
+
+  def test_remove_absent_is_noop
+    list = build_sample
+    before = list.dup
+    list.remove(:does_not_exist)
+    assert_equal before.to_a, list.to_a
+  end
+
+  # -- reordering ---------------------------------------------------------
+
+  def test_move_after
+    list = build_sample.move_after(:name, :updated_at)
+    assert_equal :name, list.names.last
+    assert_equal 1, list.names.count(:name)
+  end
+
+  def test_move_before
+    list = build_sample.move_before(:updated_at, :basics)
+    assert_equal 0, list.index_of(:updated_at)
+    assert_equal 1, list.names.count(:updated_at)
+  end
+
+  def test_move_relative_to_itself_raises
+    assert_raises(ArgumentError) { build_sample.move_after(:name, :name) }
+  end
+
+  # -- replacement --------------------------------------------------------
+
+  def test_replace_element_preserves_position
+    list = build_sample
+    pos = list.index_of(:priority)
+    list.replace_element(:priority, :radio_button, values: { 1 => "x" })
+    assert_equal pos, list.index_of(:priority)
+    assert_equal :radio_button, list.form_element_for(:priority)
+    assert_equal({ 1 => "x" }, list.values_for(:priority))
+  end
+
+  def test_replace_element_absent_is_noop
+    list = build_sample
+    before = list.dup
+    list.replace_element(:nope, :text_field)
+    assert_equal before.to_a, list.to_a
+  end
+
+  # -- queries ------------------------------------------------------------
+
+  def test_query_helpers
+    list = build_sample
+    assert_equal 1, list.index_of(:name)
+    assert list.include_attribute?(:flag)
+    refute list.include_attribute?(:ghost)
+    assert_equal :dropdown_with_values, list.form_element_for(:priority)
+    assert_equal({ 1 => "low", 2 => "high" }, list.values_for(:priority))
+    assert_equal [ :name, :text_field ], list.row_for(:name)
+  end
+
+  # -- wrap ---------------------------------------------------------------
+
+  def test_wrap_existing_array_enables_editing
+    legacy = [ [ :name, :text_field ], [ :email, :text_field ] ]
+    list = InlineForms::AttributeList.wrap(legacy)
+    assert_kind_of InlineForms::AttributeList, list
+    list.insert_after(:name, :phone, :text_field)
+    assert_equal %i[name phone email], list.names
+  end
+
+  def test_wrap_is_idempotent_for_attribute_list
+    list = build_sample
+    assert_same list, InlineForms::AttributeList.wrap(list)
+  end
+
+  def test_module_level_builder
+    list = InlineForms.attribute_list { field :a, :text_field }
+    assert_kind_of InlineForms::AttributeList, list
+    assert_equal %i[a], list.names
+  end
+end

data/test/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+class ApplicationController < ActionController::Base
+  # Devise/role stand-in. The full `layouts/inline_forms` chrome (rendered by
+  # create/new HTML responses) calls `current_user.name` and
+  # `current_user.role?`, so a nil current_user cannot render it. The stub is
+  # superadmin so `destroy_permitted?` allows hard destroy, matching the
+  # generated apps' test user.
+  DummyUser = Struct.new(:id, :name) do
+    def role?(role)
+      role.to_sym == :superadmin
+    end
+  end
+
+  helper_method :current_user
+
+  def current_user
+    @current_user ||= DummyUser.new(1, "Dummy User")
+  end
+
+  def devise_controller?
+    false
+  end
+end

data/test/dummy/app/controllers/gizmos_controller.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+class GizmosController < InlineFormsController
+end

data/test/dummy/app/controllers/machines_controller.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+class MachinesController < InlineFormsController
+end

data/test/dummy/app/controllers/parts_controller.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+class PartsController < InlineFormsController
+end

data/test/dummy/app/controllers/widgets_controller.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+class WidgetsController < InlineFormsController
+end

data/test/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+# Mirrors the helper the installer writes into host apps (installer_core.rb);
+# the full `layouts/inline_forms` chrome needs it.
+module ApplicationHelper
+  def application_name
+    "Dummy"
+  end
+
+  def application_title
+    "Dummy"
+  end
+end

data/test/dummy/app/models/application_record.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+# Mirrors the host-app contract the installer's application_record.rb template
+# establishes (lib/generators/templates/application_record.rb): paper_trail on
+# every model, will_paginate per_page, inline_forms list/search scopes, and
+# the not_accessible_through_html? default the engine controller consults.
+class ApplicationRecord < ActiveRecord::Base
+  self.abstract_class = true
+
+  has_paper_trail on: [ :create, :update, :destroy ]
+
+  attr_writer :inline_forms_attribute_list
+
+  self.per_page = 7
+
+  scope :inline_forms_list, -> { all }
+  scope :inline_forms_search, ->(_q) { all }
+
+  def human_attribute_name(*args)
+    self.class.human_attribute_name(*args)
+  end
+
+  def self.not_accessible_through_html?
+    false
+  end
+end

data/test/dummy/app/models/gizmo.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+# Models the `inline_forms_addto` pre-migrate window: the attribute_list has a
+# row (`:pending_note`) whose column does NOT exist on the gizmos table yet, so
+# it exercises InlineForms.attribute_pending_migration? end to end. `:name` and
+# `:created_at` are real columns; `:section` is a header. See
+# test/integration/pending_migration_gate_test.rb.
+class Gizmo < ApplicationRecord
+  validates :name, presence: true
+
+  scope :inline_forms_list, -> { order(:name, :id) }
+
+  def _presentation
+    "#{name}"
+  end
+
+  def inline_forms_attribute_list
+    @inline_forms_attribute_list ||= [
+      [ :name, :text_field ],
+      [ :section, :header ],
+      [ :pending_note, :text_field ],
+      [ :created_at, :info ]
+    ]
+  end
+end

data/test/dummy/app/models/kind.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+# Lookup model for Widget's dropdown_with_other (kind / kind_other).
+class Kind < ApplicationRecord
+  def _presentation
+    name
+  end
+end

data/test/dummy/app/models/machine.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+# Parent with an :associated (has_many) panel, shaped like the example app's
+# Apartment (photos:has_many photos:associated). Exercises the
+# open-after-create flow (InlineFormsController#render_created_row_open_streams).
+class Machine < ApplicationRecord
+  has_many :parts
+
+  validates :name, presence: true
+
+  scope :inline_forms_list, -> { order(:name, :id) }
+
+  def _presentation
+    "#{name}"
+  end
+
+  def inline_forms_attribute_list
+    @inline_forms_attribute_list ||= [
+      [ :name, :text_field ],
+      [ :parts, :associated ]
+    ]
+  end
+end

data/test/dummy/app/models/part.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+# Child of Machine (see machine.rb); shaped like the example app's Photo.
+class Part < ApplicationRecord
+  belongs_to :machine, optional: true
+
+  def _presentation
+    "#{name}"
+  end
+
+  def inline_forms_attribute_list
+    @inline_forms_attribute_list ||= [
+      [ :name, :text_field ]
+    ]
+  end
+end

data/test/dummy/app/models/widget.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+# Exercises one representative of each form-element family the integration
+# tests cover; shaped exactly like a `rails g inline_forms` model.
+class Widget < ApplicationRecord
+  belongs_to :kind, optional: true
+
+  validates :name, presence: true
+
+  scope :inline_forms_list, -> { order(:name, :id) }
+  scope :inline_forms_search, ->(q) { where("name LIKE ?", "%#{q}%") }
+
+  def _presentation
+    "#{name}"
+  end
+
+  def inline_forms_attribute_list
+    @inline_forms_attribute_list ||= [
+      [ :name, :text_field ],
+      [ :notes, :plain_text_area ],
+      [ :released_on, :date_select ],
+      [ :meeting_at, :time_select ],
+      [ :start_month, :month_year_picker ],
+      [ :priority, :dropdown_with_values, { 1 => "low", 2 => "mid", 3 => "high" } ],
+      [ :active, :check_box, { 0 => "no", 1 => "yes" } ],
+      [ :kind, :dropdown_with_other ],
+      [ :rating, :slider_with_values, { 1 => "one", 2 => "two", 3 => "three", 4 => "four", 5 => "five" } ],
+      # simple_file_field's values entry names the host download route method
+      # (attribute_values(...)[0][1]); only used when a file is present.
+      [ :manual, :simple_file_field, { 0 => "download" } ],
+      [ :accent, :color_field ],
+      [ :report, :pdf_link ]
+    ]
+  end
+
+  def <=>(other)
+    name <=> other.name
+  end
+end

data/test/dummy/app/views/_inline_forms_tabs.html.erb

@@ -0,0 +1,40 @@
+<div class="contain-to-grid fixed" id="inline_forms_model_top_bar_container">
+  <nav id="inline_forms_model_top_bar" class="top-bar">
+    <div class="top-bar-left">
+      <ul class="menu">
+        <li class="menu-text" id="inline_forms_menu">
+          <h1 style="margin: 0; font-size: inherit;">
+            <a>
+              <%= t(controller_name) %>
+            </a>
+          </h1>
+        </li>
+      </ul>
+    </div>
+    <div class="top-bar-right">
+      <ul class="menu">
+        <li>
+          <%= form_tag request.path, :method => 'get' do %>
+            <div class="row collapse">
+              <div class="large-1 small-1 columns">
+                <%= link_to "<i class='fi-x'></i>".html_safe, request.path, :title => 'reset', :class => "button expanded inline_forms_model_top_bar_buttons" %>
+              </div>
+              <div class="large-6 small-6 columns">
+                <%= text_field_tag :search,  params[:search], :placeholder => 'zoek op naam...', :id => 'input_search' %>
+              </div>
+              <div class="large-3 small-3 columns">
+                <%= submit_tag 'zoek', :class => "button expanded inline_forms_model_top_bar_buttons" %>
+              </div>
+              <div class="large-2 small-2 columns">
+                &nbsp;
+              </div>
+            </div>
+          <% end %>
+        </li>
+        <li>
+          <%= link_to_new_record(@Klass, "new_#{@Klass.to_s.singularize.underscore}_path", @Klass.to_s.pluralize.downcase + '_list') %>
+        </li>
+      </ul>
+    </div>
+  </nav>
+</div>

data/test/dummy/config/application.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+# Minimal host app for the engine's integration tests (test/integration/).
+# Boots the inline_forms engine against an in-memory SQLite database with the
+# host-side gems the engine expects (will_paginate, paper_trail, turbo-rails)
+# but without Devise, CanCanCan, Sprockets or ActionText: authorization is
+# optional in the engine (cancan_enabled? rescues NameError), tests drive the
+# UI through Turbo-Frame requests (the frame layout never renders the
+# current_user header), and the asset-precompile initializer skips hosts
+# without a pipeline.
+require "rails"
+require "active_record/railtie"
+require "action_controller/railtie"
+require "action_view/railtie"
+
+Bundler.require(*Rails.groups)
+
+require "inline_forms"
+# The schema-GUI engine (separate gem, same repo; on the load path via the
+# Gemfile's test group). Its integration tests live in test/integration/.
+require "inline_forms_schema_edit"
+
+module Dummy
+  class Application < Rails::Application
+    config.load_defaults 8.1
+    config.root = File.expand_path("..", __dir__)
+    config.eager_load = false
+    config.secret_key_base = "inline_forms_dummy_test_secret"
+    config.logger = ActiveSupport::Logger.new(File::NULL)
+    config.active_support.deprecation = :stderr
+    config.action_controller.allow_forgery_protection = false
+    # Schema is defined by test/integration_test_helper.rb on the in-memory DB.
+    config.active_record.maintain_test_schema = false
+    # Raise in-place so integration failures carry the real backtrace.
+    config.action_dispatch.show_exceptions = :none
+  end
+end

data/test/dummy/config/database.yml

@@ -0,0 +1,3 @@
+test:
+  adapter: sqlite3
+  database: ":memory:"

data/test/dummy/config/environment.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+require_relative "application"
+
+Rails.application.initialize!

data/test/dummy/config/initializers/inline_forms.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+# Mirrors the initializer the installer seeds in host apps; the header
+# (`inline_forms/_header`) iterates MODEL_TABS for admin users. Kept empty so
+# the dummy needs no CanCan (`can?` is only called per entry).
+MODEL_TABS = %w[].freeze

data/test/dummy/config/initializers/paper_trail_yaml_safe_load.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+# Mirrors the initializer the installer writes into generated apps
+# (installer_core.rb): PaperTrail serializes object/object_changes as YAML,
+# and Psych safe-loading needs these classes permitted or version.changeset /
+# version.reify silently degrade (empty changeset) or raise.
+permitted = [
+  Symbol,
+  Date,
+  Time,
+  BigDecimal,
+  ActiveSupport::TimeWithZone,
+  ActiveSupport::TimeZone,
+  ActiveSupport::HashWithIndifferentAccess
+]
+
+%w[
+  ActiveRecord::Type::Time::Value
+  ActiveRecord::Type::Date::Value
+  ActiveRecord::Type::DateTime::Value
+].each do |const_name|
+  klass = const_name.safe_constantize
+  permitted << klass if klass
+end
+
+Rails.application.config.active_record.yaml_column_permitted_classes ||= []
+Rails.application.config.active_record.yaml_column_permitted_classes |= permitted
+ActiveRecord.yaml_column_permitted_classes |= Rails.application.config.active_record.yaml_column_permitted_classes

data/test/dummy/config/routes.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+# Mirrors the routes `rails g inline_forms` injects for each resource.
+Rails.application.routes.draw do
+  # Devise stand-in: the inline_forms header links destroy_user_session_path.
+  delete "logout", to: proc { [ 204, {}, [] ] }, as: :destroy_user_session
+
+  resources :widgets do
+    post "revert", on: :member
+    get "list_versions", on: :member
+  end
+
+  resources :machines do
+    post "revert", on: :member
+    get "list_versions", on: :member
+  end
+
+  resources :parts do
+    post "revert", on: :member
+    get "list_versions", on: :member
+  end
+
+  resources :gizmos do
+    post "revert", on: :member
+    get "list_versions", on: :member
+  end
+
+  # Schema-change GUI (opt-in in real installs; routed here for the engine's
+  # fast test suite). One line, so gem upgrades can add routes freely.
+  InlineFormsSchemaEdit.draw_routes(self)
+end