inline_forms 8.1.44 → 8.1.46

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e8208cb1ccfd70968b65e5a5245b30586ab35034059749a20b4dc27ffde59bbe
-  data.tar.gz: 91f66242ff63e1d1c7ff22aa744939b05140f8b95cb8ac009956a1e70a2c9ca9
+  metadata.gz: 01deab33ac621116f150d6b9cb8b8fed5fe2ee6118a53699c383c08751d9c041
+  data.tar.gz: 433f57953fa315079be2d5c2c8900885b6010478f360719e8aebd319c025cc90
 SHA512:
-  metadata.gz: 6c7060b4c597512ab705c0eb8f104dbdb754ca4aa121e9214906e15e8ba3c64a942159e1a2d6312509465c02ab72f5299973742f317746d6f5ee99399283460f
-  data.tar.gz: 4411cae2c459f7de8b46651abe65a12360854d7434232b6a283c29a9fae4647cc5b49b548ab87fced3847f4e155975de8cf44d5b6d9ff5c610e83248b197edb8
+  metadata.gz: 3366ebb49776ef4307ab2b64b6eb5b43c6d7f1cf8d2986bf5e5c747b6c67b8e7065bdc40ffa446241a56d8f3bdc845d6f79f49f9cab911e3e952a7d14fdda6e6
+  data.tar.gz: f9d4ee91abb242c4ebbf8b13048922cc0da3641c4cf8610b6a48aefeca5071474a605295f4605bce9ce9cbd9d5140434cc8dfa35396e170c636b491fa6f19e32

data/CHANGELOG.md

@@ -4,6 +4,34 @@ All notable changes to this project are documented in this file.
 
 ## [Unreleased]
 
+## [8.1.46] - 2026-07-24
+
+### Fixed
+
+- **Model top bar no longer crashes when `@Klass` is nil.** Bespoke admin pages that render `layouts/inline_forms` from a non-`InlineFormsController` (e.g. a Stats/report controller) now show title-only chrome instead of raising on `new__path` / `link_to_new_record`. The new-record link is guarded with `<% if @Klass %>` as the per-app header did before 8.1.45.
+
+### Lockstep
+
+- validation_hints 8.1.46, inline_forms_installer 8.1.46, inline_forms_schema_edit 8.1.46.
+
+## [8.1.45] - 2026-07-24
+
+### Added
+
+- **Engine-owned model top bar** (`app/views/inline_forms/_model_top_bar.html.erb`): title, new-record button, and optional search region ship from the gem instead of a per-app `_inline_forms_tabs.html.erb` copy. The layout now renders `inline_forms/model_top_bar`; apps can still override via `app/views/inline_forms/_model_top_bar.html.erb`.
+- **`inline_forms_search_on :col, …` macro** (`InlineForms::Searchable`): declarative opt-in for list search — defines `scope :inline_forms_search` and `inline_forms_searchable?`. Only searchable models get the engine's generic single-field search box (`_generic_search.html.erb`); apps can supply a bespoke `app/views/_<model>_search.html.erb` partial instead (bespoke wins).
+- **`+ field` schema link** in the engine top bar when `inline_forms_schema_new_path` is available (replaces installer injection into the retired `_inline_forms_tabs` partial).
+
+### Changed
+
+- **Retired per-app `_inline_forms_tabs.html.erb` scaffolding.** The generator no longer copies `lib/generators/templates/_inline_forms_tabs.html.erb` into new apps. Existing apps must delete their copy and move any bespoke search markup to `_<model>_search.html.erb` (see `stuff/2026-07-24-default-model-top-bar-and-search.md`).
+- **`ApplicationRecord` template:** removed the no-op `scope :inline_forms_search, ->(_q) { all }`; models opt in via `inline_forms_search_on`. `_list_search:<col>` in `rails g inline_forms` / `inline_forms_addto` now emits `inline_forms_search_on :col`.
+- **Installer user model** uses `inline_forms_search_on :name, :email` instead of a hand-written search scope.
+
+### Lockstep
+
+- validation_hints 8.1.45, inline_forms_installer 8.1.45, inline_forms_schema_edit 8.1.45.
+
 ## [8.1.44] - 2026-07-24
 
 ### Fixed

data/app/views/inline_forms/_generic_search.html.erb

@@ -0,0 +1,16 @@
+<%= 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 %>

data/app/views/inline_forms/_model_top_bar.html.erb

@@ -0,0 +1,39 @@
+<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>
+        <% if respond_to?(:inline_forms_schema_new_path) %>
+          <li class="menu-text">
+            <%= link_to "+ field", inline_forms_schema_new_path, data: { turbo: false }, title: "Add a field to a model (dev only)" %>
+          </li>
+        <% end %>
+      </ul>
+    </div>
+    <div class="top-bar-right">
+      <ul class="menu">
+        <% search_partial = "#{controller_name}_search" %>
+        <% if lookup_context.exists?(search_partial, [], true) %>
+          <li>
+            <%= render partial: "/#{search_partial}" %>
+          </li>
+        <% elsif @Klass.respond_to?(:inline_forms_searchable?) && @Klass.inline_forms_searchable? %>
+          <li>
+            <%= render "inline_forms/generic_search" %>
+          </li>
+        <% end %>
+        <% if @Klass %>
+          <li>
+            <%= link_to_new_record(@Klass, "new_#{@Klass.to_s.singularize.underscore}_path", @Klass.to_s.pluralize.downcase + "_list") %>
+          </li>
+        <% end %>
+      </ul>
+    </div>
+  </nav>
+</div>

data/app/views/layouts/inline_forms.html.erb

@@ -24,7 +24,7 @@
         <% if flash_alert.present? %><div class="flash alert"><%= flash_alert %></div><% end %>
       </div>
     <% end %>
-    <%= render "/inline_forms_tabs" %>
+    <%= render "inline_forms/model_top_bar" %>
     <div id="outer_container">
       <%= yield %>
     </div>

data/lib/generators/inline_forms_addto_generator.rb

@@ -444,11 +444,15 @@ class InlineFormsAddtoGenerator < Rails::Generators::NamedBase
         end
       when "_list_search"
         col = attribute.type
-        new_scope = "  scope :inline_forms_search, ->(q) { where(\"#{col} LIKE ?\", \"%\#{q}%\") }\n"
-        if File.read(File.join(destination_root, model_file_path)).match?(/scope :inline_forms_search\b/)
-          gsub_file model_file_path, /  scope :inline_forms_search, ->.*\n/, new_scope
+        new_line = "  inline_forms_search_on :#{col}\n"
+        path = File.join(destination_root, model_file_path)
+        content = File.read(path)
+        if content.match?(/inline_forms_search_on\b/)
+          gsub_file model_file_path, /  inline_forms_search_on[^\n]*\n/, new_line
+        elsif content.match?(/scope :inline_forms_search\b/)
+          gsub_file model_file_path, /  scope :inline_forms_search, ->.*\n/, new_line
         else
-          inject_into_class model_file_path, model_class_name, new_scope
+          inject_into_class model_file_path, model_class_name, new_line
         end
       end
     end

data/lib/generators/inline_forms_generator.rb

@@ -116,7 +116,7 @@ module InlineForms
             @list_scopes << "  scope :inline_forms_list, -> { order(:#{attribute.type}, :id) }\n"
           end
           if attribute.name == '_list_search'
-            @list_scopes << "  scope :inline_forms_search, ->(q) { where(\"#{attribute.type} LIKE ?\", \"%\#{q}%\") }\n"
+            @list_scopes << "  inline_forms_search_on :#{attribute.type}\n"
           end
           if attribute.attribute?
             attribute.attribute_type == :unknown ? commenter = '#' : commenter = ' '
@@ -196,10 +196,6 @@ module InlineForms
       end
     end
 
-    def add_second_top_bar
-      copy_file "_inline_forms_tabs.html.erb", "app/views/_inline_forms_tabs.html.erb" unless File.exist?('app/views/_inline_forms_tabs.html.erb')
-    end
-
     def add_tab
       return if @flag_not_accessible_through_html
 

data/lib/generators/templates/application_record.rb

@@ -1,6 +1,8 @@
 class ApplicationRecord < ActiveRecord::Base
   self.abstract_class = true
 
+  include InlineForms::Searchable
+
   # PaperTrail 16 defaults to `on: [:create, :update, :destroy, :touch]`.
   # ActionText's `belongs_to :record, polymorphic: true, touch: true` (set by
   # `has_rich_text`) calls `parent.touch` on every rich-text save, which
@@ -24,12 +26,6 @@ class ApplicationRecord < ActiveRecord::Base
   # `unscope`/`reorder` cleanly.
   scope :inline_forms_list, -> { all }
 
-  # Default list search; no-op so the gem's search box is inert until a model
-  # opts in via
-  #   scope :inline_forms_search, ->(q) { where("col LIKE ?", "%#{q}%") }
-  # (emitted by `_list_search:<col>` in the generator).
-  scope :inline_forms_search, ->(_q) { all }
-
   # Wrapper for @model.human_attribute_name -> Model.human_attribute_name
   def human_attribute_name(*args)
     self.class.human_attribute_name(*args)

data/lib/inline_forms/searchable.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module InlineForms
+  # Opt-in list search for inline_forms index views. Models declare searchable
+  # columns with `inline_forms_search_on :col, …`; only those models get the
+  # engine's generic search box (or a bespoke `_<model>_search` partial).
+  module Searchable
+    extend ActiveSupport::Concern
+
+    class_methods do
+      def inline_forms_searchable?
+        @inline_forms_searchable == true
+      end
+
+      def inline_forms_search_on(*columns)
+        cols = columns.flatten.map(&:to_s)
+        if cols.empty?
+          raise ArgumentError, "inline_forms_search_on requires at least one column"
+        end
+
+        @inline_forms_searchable = true
+        table = table_name
+        clause = cols.map { |c|
+          "#{connection.quote_table_name(table)}.#{connection.quote_column_name(c)} LIKE :q"
+        }.join(" OR ")
+        scope :inline_forms_search, ->(q) {
+          where(clause, q: "%#{sanitize_sql_like(q.to_s)}%")
+        }
+      end
+    end
+  end
+end

data/lib/inline_forms/version.rb

@@ -1,5 +1,5 @@
 # -*- encoding : utf-8 -*-
 
 module InlineForms
-  VERSION = "8.1.44"
+  VERSION = "8.1.46"
 end

data/lib/inline_forms.rb

@@ -7,6 +7,7 @@ require "inline_forms/schema_preview"
 require "inline_forms/schema_apply"
 require "inline_forms/schema_label"
 require "inline_forms/form_element_from_callee"
+require "inline_forms/searchable"
 require "inline_forms/archived_form_elements"
 require "inline_forms/form_element_registry"
 require "inline_forms/form_elements"

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

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+# Bespoke report page: uses the inline_forms admin layout but is not an
+# InlineFormsController, so @Klass is never set (mirrors StProject Stats).
+class StatsController < ApplicationController
+  layout "inline_forms"
+
+  def show
+  end
+end

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

@@ -7,6 +7,8 @@
 class ApplicationRecord < ActiveRecord::Base
   self.abstract_class = true
 
+  include InlineForms::Searchable
+
   has_paper_trail on: [ :create, :update, :destroy ]
 
   attr_writer :inline_forms_attribute_list
@@ -14,7 +16,6 @@ class ApplicationRecord < ActiveRecord::Base
   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)

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

@@ -8,7 +8,7 @@ class Widget < ApplicationRecord
   validates :name, presence: true
 
   scope :inline_forms_list, -> { order(:name, :id) }
-  scope :inline_forms_search, ->(q) { where("name LIKE ?", "%#{q}%") }
+  inline_forms_search_on :name
 
   def _presentation
     "#{name}"

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

@@ -0,0 +1,3 @@
+<%= form_tag request.path, method: :get do %>
+  <span id="bespoke_gizmo_search">bespoke gizmo search</span>
+<% end %>

data/test/dummy/app/views/stats/show.html.erb

@@ -0,0 +1 @@
+<p id="stats_report">Stats report</p>

data/test/dummy/config/routes.rb

@@ -25,6 +25,8 @@ Rails.application.routes.draw do
     get "list_versions", on: :member
   end
 
+  get "stats", to: "stats#show"
+
   # 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)

data/test/inline_forms_generator_test.rb

@@ -155,7 +155,7 @@ class InlineFormsGeneratorTest < Minitest::Test
 
     model = read("app/models/apartment.rb")
     assert_includes(model, "scope :inline_forms_list, -> { order(:name, :id) }")
-    assert_includes(model, "scope :inline_forms_search, ->(q) { where(\"name LIKE ?\", \"%\#{q}%\") }")
+    assert_includes(model, "inline_forms_search_on :name")
     migration = read_single_migration_for("apartments")
     refute_includes(migration, "_list_order")
     refute_includes(migration, "_list_search")

data/test/integration/model_top_bar_test.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+require_relative "../integration_test_helper"
+
+# Engine-owned model top bar: title + new-record + optional search region.
+class ModelTopBarTest < InlineFormsIntegrationTestCase
+  setup do
+    @widget = Widget.create!(name: "Alpha")
+    @machine = Machine.create!(name: "Press")
+  end
+
+  test "searchable model renders the engine generic search box" do
+    get widgets_path
+
+    assert_response :success
+    assert_includes response.body, %(id="input_search")
+    assert_includes response.body, %(id="inline_forms_model_top_bar")
+    refute_includes response.body, "bespoke gizmo search"
+  end
+
+  test "non-searchable model renders no search box" do
+    get machines_path
+
+    assert_response :success
+    assert_includes response.body, %(id="inline_forms_model_top_bar")
+    refute_includes response.body, %(id="input_search")
+  end
+
+  test "bespoke _<model>_search partial wins over generic search" do
+    get gizmos_path
+
+    assert_response :success
+    assert_includes response.body, %(id="bespoke_gizmo_search")
+    refute_includes response.body, %(id="input_search")
+  end
+
+  test "generic search box filters the list via inline_forms_search_on" do
+    Widget.create!(name: "Beta")
+
+    get widgets_path(search: "Alp")
+
+    assert_response :success
+    assert_includes response.body, "Alpha"
+    refute_includes response.body, "Beta"
+  end
+
+  test "non-model page with no @Klass renders title only, no new-record link" do
+    get stats_path
+
+    assert_response :success
+    assert_includes response.body, %(id="inline_forms_model_top_bar")
+    assert_includes response.body, %(id="stats_report")
+    refute_includes response.body, "new_button"
+    refute_includes response.body, %(id="input_search")
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: inline_forms
 version: !ruby/object:Gem::Version
-  version: 8.1.44
+  version: 8.1.46
 platform: ruby
 authors:
 - Ace Suares
@@ -148,8 +148,10 @@ files:
 - app/views/inline_forms/_close.html.erb
 - app/views/inline_forms/_edit.html.erb
 - app/views/inline_forms/_flash.html.erb
+- app/views/inline_forms/_generic_search.html.erb
 - app/views/inline_forms/_header.html.erb
 - app/views/inline_forms/_list.html.erb
+- app/views/inline_forms/_model_top_bar.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
@@ -202,7 +204,6 @@ files:
 - lib/generators/inline_forms_addto_generator.rb
 - lib/generators/inline_forms_attribute_overrides.rb
 - lib/generators/inline_forms_generator.rb
-- lib/generators/templates/_inline_forms_tabs.html.erb
 - lib/generators/templates/application_record.rb
 - lib/generators/templates/controller.erb
 - lib/generators/templates/migration.erb
@@ -254,6 +255,7 @@ files:
 - lib/inline_forms/schema_intent.rb
 - lib/inline_forms/schema_label.rb
 - lib/inline_forms/schema_preview.rb
+- lib/inline_forms/searchable.rb
 - lib/inline_forms/tabs.rb
 - lib/inline_forms/turbo_tabs_builder.rb
 - lib/inline_forms/version.rb
@@ -270,6 +272,7 @@ files:
 - 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/stats_controller.rb
 - test/dummy/app/controllers/widgets_controller.rb
 - test/dummy/app/helpers/application_helper.rb
 - test/dummy/app/models/application_record.rb
@@ -278,7 +281,8 @@ files:
 - test/dummy/app/models/machine.rb
 - test/dummy/app/models/part.rb
 - test/dummy/app/models/widget.rb
-- test/dummy/app/views/_inline_forms_tabs.html.erb
+- test/dummy/app/views/_gizmos_search.html.erb
+- test/dummy/app/views/stats/show.html.erb
 - test/dummy/config/application.rb
 - test/dummy/config/database.yml
 - test/dummy/config/environment.rb
@@ -291,6 +295,7 @@ files:
 - test/inline_forms_generator_test.rb
 - test/integration/inline_forms_crud_test.rb
 - test/integration/legacy_elements_test.rb
+- test/integration/model_top_bar_test.rb
 - test/integration/native_inputs_test.rb
 - test/integration/open_after_create_test.rb
 - test/integration/pending_migration_gate_test.rb
@@ -338,6 +343,7 @@ test_files:
 - 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/stats_controller.rb
 - test/dummy/app/controllers/widgets_controller.rb
 - test/dummy/app/helpers/application_helper.rb
 - test/dummy/app/models/application_record.rb
@@ -346,7 +352,8 @@ test_files:
 - test/dummy/app/models/machine.rb
 - test/dummy/app/models/part.rb
 - test/dummy/app/models/widget.rb
-- test/dummy/app/views/_inline_forms_tabs.html.erb
+- test/dummy/app/views/_gizmos_search.html.erb
+- test/dummy/app/views/stats/show.html.erb
 - test/dummy/config/application.rb
 - test/dummy/config/database.yml
 - test/dummy/config/environment.rb
@@ -359,6 +366,7 @@ test_files:
 - test/inline_forms_generator_test.rb
 - test/integration/inline_forms_crud_test.rb
 - test/integration/legacy_elements_test.rb
+- test/integration/model_top_bar_test.rb
 - test/integration/native_inputs_test.rb
 - test/integration/open_after_create_test.rb
 - test/integration/pending_migration_gate_test.rb

data/lib/generators/templates/_inline_forms_tabs.html.erb

@@ -1,40 +0,0 @@
-<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/app/views/_inline_forms_tabs.html.erb

@@ -1,40 +0,0 @@
-<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>