admin_suite 0.4.0 → 0.5.0

data/test/lib/index_includes_test.rb

@@ -0,0 +1,223 @@
+# frozen_string_literal: true
+
+require "test_helper"
+
+# Fixtures for the `includes:` DSL option (Task 4, phase 2b). A scope that
+# genuinely supports `#includes` and records/validates the call, so the
+# controller's "apply when the scope responds" and "degrade when
+# `.includes` itself raises" paths are both exercisable end-to-end. The
+# `LinkingFixtures::Deal`/`ReadOnlyResourceFixtures::Relation` pair (no
+# `#includes` at all) already covers the "skip silently" path -- reused
+# below rather than duplicated.
+module IndexIncludesFixtures
+  class IncludesCapableRelation
+    include Enumerable
+
+    KNOWN_ASSOCIATIONS = %i[company owner].freeze
+
+    attr_reader :includes_calls
+
+    def initialize(records)
+      @records = records
+      @includes_calls = []
+    end
+
+    def each(&block) = @records.each(&block)
+    def count(*) = @records.count
+    def offset(*) = self
+    def limit(*) = self
+
+    # Mirrors real ActiveRecord's eventual `ActiveRecord::AssociationNotFoundError`
+    # for an unknown association name -- raised here at call time (rather
+    # than lazily, as real AR does) so the controller's rescue path around
+    # the `.includes` call site is directly exercisable.
+    def includes(*associations)
+      flat = associations.flatten
+      invalid = flat.reject { |a| KNOWN_ASSOCIATIONS.include?(a.respond_to?(:to_sym) ? a.to_sym : a) }
+      raise ArgumentError, "Association named #{invalid.first.inspect} was not found" if invalid.any?
+
+      @includes_calls << flat
+      self
+    end
+  end
+
+  class Widget
+    extend ActiveModel::Naming
+
+    attr_reader :id, :name
+
+    def initialize(id:, name:)
+      @id = id
+      @name = name
+    end
+
+    RELATION = IncludesCapableRelation.new([ new(id: 1, name: "Widget One") ])
+
+    def self.all = RELATION
+    def self.column_names = %w[id name]
+    def self.primary_key = "id"
+    def self.columns_hash = { "id" => Struct.new(:type).new(:integer) }
+    def self.find(id) = all.find { |w| w.to_param == id.to_s }
+    def to_param = id.to_s
+    def attributes = { "id" => id, "name" => name }
+  end
+
+  class BadWidget
+    extend ActiveModel::Naming
+
+    attr_reader :id, :name
+
+    def initialize(id:, name:)
+      @id = id
+      @name = name
+    end
+
+    RELATION = IncludesCapableRelation.new([ new(id: 1, name: "Bad Widget") ])
+
+    def self.all = RELATION
+    def self.column_names = %w[id name]
+    def self.primary_key = "id"
+    def self.columns_hash = { "id" => Struct.new(:type).new(:integer) }
+    def self.find(id) = all.find { |w| w.to_param == id.to_s }
+    def to_param = id.to_s
+    def attributes = { "id" => id, "name" => name }
+  end
+
+  # Self-contained (this file is runnable standalone via
+  # `rake test TEST=test/lib/index_includes_test.rb`, so it can't reach
+  # into fixtures defined only in association_linking_test.rb): a scope
+  # with no `#includes` method at all, mirroring
+  # `ReadOnlyResourceFixtures::Relation`, backing a resource that
+  # nonetheless declares `includes :company`. Exercises the "skip
+  # silently, don't raise" path.
+  class NoIncludesWidget
+    extend ActiveModel::Naming
+
+    attr_reader :id, :name
+
+    def initialize(id:, name:)
+      @id = id
+      @name = name
+    end
+
+    def self.all = ReadOnlyResourceFixtures::Relation.new([ new(id: 1, name: "Plain Widget") ])
+    def self.column_names = %w[id name]
+    def self.primary_key = "id"
+    def self.columns_hash = { "id" => Struct.new(:type).new(:integer) }
+    def self.find(id) = all.find { |w| w.to_param == id.to_s }
+    def to_param = id.to_s
+    def attributes = { "id" => id, "name" => name }
+  end
+end
+
+module Admin
+  module Resources
+    class IndexIncludesWidgetResource < Admin::Base::Resource
+      model IndexIncludesFixtures::Widget
+      portal :ops
+      section :observability
+
+      index do
+        columns { column :name }
+        includes :company, :owner
+      end
+    end
+
+    class IndexIncludesBadWidgetResource < Admin::Base::Resource
+      model IndexIncludesFixtures::BadWidget
+      portal :ops
+      section :observability
+
+      index do
+        columns { column :name }
+        includes :nonexistent_association
+      end
+    end
+
+    class IndexIncludesNoIncludesWidgetResource < Admin::Base::Resource
+      model IndexIncludesFixtures::NoIncludesWidget
+      portal :ops
+      section :observability
+
+      index do
+        columns { column :name }
+        includes :company
+      end
+    end
+  end
+end
+
+module AdminSuite
+  class IndexIncludesTest < ActionDispatch::IntegrationTest
+    test "IndexConfig#includes stores the list of associations" do
+      config = Admin::Base::Resource::IndexConfig.new
+      config.includes(:company, :owner)
+      assert_equal [ :company, :owner ], config.includes_list
+    end
+
+    test "IndexConfig#includes defaults to an empty list" do
+      assert_equal [], Admin::Base::Resource::IndexConfig.new.includes_list
+    end
+
+    test "IndexConfig#includes drops a nil association instead of storing garbage" do
+      config = Admin::Base::Resource::IndexConfig.new
+      config.includes(nil)
+      assert_equal [], config.includes_list
+    end
+
+    test "IndexConfig#includes tolerates a String association name" do
+      config = Admin::Base::Resource::IndexConfig.new
+      config.includes("company")
+      assert_equal [ "company" ], config.includes_list
+    end
+
+    test "the DSL exposes includes: on a resource's index_config" do
+      assert_equal [ :company, :owner ], Admin::Resources::IndexIncludesWidgetResource.index_config.includes_list
+    end
+
+    test "the controller applies includes: to a scope that responds to includes" do
+      IndexIncludesFixtures::Widget::RELATION.includes_calls.clear
+
+      get "/internal/admin_suite/ops/index_includes_widgets"
+      assert_response :success
+
+      assert_equal [ [ :company, :owner ] ], IndexIncludesFixtures::Widget::RELATION.includes_calls
+    end
+
+    test "a scope whose includes raises for a bad association degrades instead of 500ing" do
+      logged = []
+      Rails.logger.stub(:warn, ->(msg) { logged << msg }) do
+        get "/internal/admin_suite/ops/index_includes_bad_widgets"
+      end
+
+      assert_response :success
+      assert_includes response.body, "Bad Widget"
+      # The rescue in `apply_index_includes` logs the failure -- pinning
+      # that here so the "skipped silently" test below (which asserts NO
+      # warn fires) is actually distinguishing two different code paths,
+      # not just two tests that both happen to pass.
+      assert_equal 1, logged.size
+      assert_includes logged.first, "nonexistent_association"
+    end
+
+    test "a scope that does not respond to includes is skipped silently, not raised" do
+      refute IndexIncludesFixtures::NoIncludesWidget.all.respond_to?(:includes)
+
+      logged = []
+      Rails.logger.stub(:warn, ->(msg) { logged << msg }) do
+        get "/internal/admin_suite/ops/index_includes_no_includes_widgets"
+      end
+
+      assert_response :success
+      assert_includes response.body, "Plain Widget"
+      # `apply_index_includes`'s `respond_to?(:includes)` guard exists so a
+      # scope that can never support includes doesn't spam a warning on
+      # every request. Deleting that guard would still return a 200 here
+      # (the catch-all rescue produces an identical response), so the
+      # response alone doesn't prove the guard does anything -- this
+      # asserts its actual purpose: no warn fires on this path. Contrast
+      # with the bad-association test above, where one does.
+      assert_empty logged
+    end
+  end
+end

data/test/lib/legacy_renderer_deprecation_test.rb

@@ -24,7 +24,14 @@ module AdminSuite
       end
       assert_equal 1, logged.size
       assert_includes logged.first, "deprecated"
-      assert_includes logged.first, "0.5.0"
+      # Deliberately a hardcoded literal, not read off
+      # DEPRECATION_MESSAGE_FORMAT: reading the version out of the constant
+      # under test and asserting the message contains it is true by
+      # construction (format() only substitutes %<key>s, never the version
+      # digits), so it can never fail on a wrong retarget -- exactly the
+      # property this test exists to catch. If the removal target changes
+      # again, this literal must be updated by hand; that's the point.
+      assert_includes logged.first, "0.6.0"
     end
 
     test "the gem no longer includes the host CustomRenderersHelper constant" do

data/test/lib/renderer_test.rb

@@ -116,7 +116,14 @@ module AdminSuite
       assert_equal 1, logged.size
       assert_includes logged.first, key.to_s
       assert_includes logged.first, "deprecated"
-      assert_includes logged.first, "0.5.0"
+      # Deliberately a hardcoded literal, not read off
+      # DEPRECATION_MESSAGE_FORMAT: reading the version out of the constant
+      # under test and asserting the message contains it is true by
+      # construction (format() only substitutes %<key>s, never the version
+      # digits), so it can never fail on a wrong retarget -- exactly the
+      # property this test exists to catch. If the removal target changes
+      # again, this literal must be updated by hand; that's the point.
+      assert_includes logged.first, "0.6.0"
     ensure
       AdminSuite.config.custom_renderers.delete(key)
     end
@@ -144,6 +151,12 @@ module AdminSuite
       assert_includes html, "host-class-7"
       refute_includes html, "Hello 7"
     ensure
+      # `register_default` seeds AdminSuite's *permanent* default store (the
+      # same one the built-ins live in), so this probe key must be removed
+      # via `unregister_default` -- unlike `unregister`, which only ever
+      # touches the explicit store and would silently leave this key behind
+      # for every test that runs afterward.
+      AdminSuite::RendererRegistry.unregister_default(key)
       if Admin::Renderers.const_defined?(:HostBeatsDefaultProbeRenderer, false)
         Admin::Renderers.send(:remove_const, :HostBeatsDefaultProbeRenderer)
       end
@@ -172,12 +185,15 @@ module AdminSuite
     test "a registered renderer class wins over the built-in case branches" do
       # :json_preview has a legacy case branch; a registered class must take it over.
       #
-      # Task 4 registers :json_preview as a permanent alias to JsonRenderer
-      # at require time, so — unlike when this test was first written —
-      # there is now always a prior registration to restore. Unregistering
-      # unconditionally in `ensure` would delete that alias process-wide for
-      # every test that runs after this one (a real, order-dependent bug
-      # this exact test used to hide).
+      # Task 4 registers :json_preview as a permanent alias to JsonRenderer,
+      # but via `register_default` (the gem-defaults store), not `register`
+      # (the explicit store). `lookup` below only ever reads the explicit
+      # store, so `previous` is nil here -- there is no explicit registration
+      # to save or restore, and the `ensure` branch's plain `unregister` is
+      # a safe no-op that cannot touch the permanent default alias (which
+      # only `unregister_default` could remove). This test still needs the
+      # save/restore shape below in case some future test registers
+      # :json_preview explicitly and forgets to clean up after itself.
       previous = AdminSuite::RendererRegistry.lookup(:json_preview)
       AdminSuite::RendererRegistry.register(:json_preview, GreetingRenderer)
       assert_includes render_custom_section(Record.new(6), :json_preview), "Hello 6"

data/test/lib/resource_exportable_deprecation_test.rb

@@ -25,7 +25,7 @@ module AdminSuite
       refute LegacyExportableResource.instance_variable_defined?(:@export_formats)
     end
 
-    test "exportable warns once per resource class, naming the class and the 0.5.0 removal" do
+    test "exportable warns once per resource class, naming the class and the 0.6.0 removal" do
       logged = []
       LegacyExportableResource.stub(:warn_once_sink, ->(msg) { logged << msg }) do
         2.times { LegacyExportableResource.exportable(:json, :csv) }
@@ -33,7 +33,15 @@ module AdminSuite
 
       assert_equal 1, logged.size
       assert_includes logged.first, "LegacyExportableResource"
-      assert_includes logged.first, "0.5.0"
+      # Deliberately a hardcoded literal, not read off
+      # EXPORTABLE_DEPRECATION_MESSAGE_FORMAT: reading the version out of
+      # the constant under test and asserting the message contains it is
+      # true by construction (format() only substitutes %<resource>s, never
+      # the version digits), so it can never fail on a wrong retarget --
+      # exactly the property this test exists to catch. If the removal
+      # target changes again, this literal must be updated by hand; that's
+      # the point.
+      assert_includes logged.first, "0.6.0"
     end
   end
 end

data/test/test_helper.rb

@@ -43,14 +43,6 @@ unless defined?(ActiveRecord::Base)
   end
 end
 
-module TurboFrameTestHelper
-  def turbo_frame_tag(name, **options, &block)
-    content_tag(:turbo_frame, capture(&block), id: name, **options)
-  end
-end
-
-ActionView::Base.include(TurboFrameTestHelper)
-
 module ReadOnlyResourceFixtures
   class Relation
     include Enumerable
@@ -142,3 +134,50 @@ module Admin
     end
   end
 end
+
+# The dummy app is database-free and `ActiveRecord::Base` above is a bare
+# stub class, so every other fixture in this suite is a PORO and
+# `active_record_base?` is false for all of them -- every AR-dependent path
+# (`auto_admin_suite_path_for`, `format_table_cell`'s AR branch) is
+# otherwise unreachable by tests. Subclassing the stub gives a fixture that
+# genuinely satisfies `active_record_base?`, with no database and no
+# railtie required. Established here (Task 3, phase 2b) because it's
+# reused by later tasks (4, 7); those tasks' own test files each `require
+# "test_helper"`, so this is visible to them even when a single test file
+# is run in isolation via `rake test TEST=...` -- unlike a fixture defined
+# only in association_linking_test.rb, which would not be.
+module LinkingFixtures
+  class Company < ActiveRecord::Base
+    extend ActiveModel::Naming
+
+    attr_reader :id, :name
+
+    def initialize(id: 7, name: "Acme Corp")
+      @id = id
+      @name = name
+    end
+
+    def self.all = ReadOnlyResourceFixtures::Relation.new([ new ])
+    def self.column_names = %w[id name]
+    def self.primary_key = "id"
+    def self.columns_hash = { "id" => Struct.new(:type).new(:integer) }
+    def self.find(_id) = new
+    def to_param = id.to_s
+    def attributes = { "id" => id, "name" => name }
+  end
+end
+
+module Admin
+  module Resources
+    # Registered so `auto_admin_suite_path_for` can resolve a real path for
+    # `LinkingFixtures::Company` instances (it looks up `registered_resources`
+    # by `model_class`). Never call `Admin::Base::Resource.reset_registry!` in
+    # a test: `inherited` fires only on class creation, so a reset-then-reload
+    # would permanently empty the registry for the rest of the run.
+    class LinkingCompanyResource < Admin::Base::Resource
+      model LinkingFixtures::Company
+      portal :ops
+      section :observability
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: admin_suite
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - TechWright Labs
@@ -36,20 +36,40 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '9.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '10'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '9.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '10'
+- !ruby/object:Gem::Dependency
+  name: turbo-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '11.0'
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '2.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '11.0'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: lucide-rails
   requirement: !ruby/object:Gem::Requirement
@@ -126,6 +146,7 @@ files:
 - app/assets/builds/admin_suite_tailwind.css
 - app/assets/rouge.css
 - app/assets/tailwind/admin_suite.css
+- app/assets/vendor/chart.umd.min.js
 - app/assets/vendor/easymde.min.css
 - app/assets/vendor/easymde.min.js
 - app/controllers/admin_suite/application_controller.rb
@@ -139,6 +160,7 @@ files:
 - app/helpers/admin_suite/resources_helper.rb
 - app/helpers/admin_suite/theme_helper.rb
 - app/javascript/admin_suite_application.js
+- app/javascript/controllers/admin_suite/chart_controller.js
 - app/javascript/controllers/admin_suite/click_actions_controller.js
 - app/javascript/controllers/admin_suite/clipboard_controller.js
 - app/javascript/controllers/admin_suite/code_editor_controller.js
@@ -260,15 +282,21 @@ files:
 - test/dummy/public/robots.txt
 - test/dummy/test/test_helper.rb
 - test/fixtures/docs/progress/PROGRESS_REPORT.md
+- test/integration/association_linking_test.rb
 - test/integration/authentication_test.rb
 - test/integration/authorization_test.rb
+- test/integration/chart_panel_test.rb
 - test/integration/dashboard_test.rb
 - test/integration/docs_test.rb
+- test/integration/index_table_test.rb
 - test/integration/layout_assets_test.rb
 - test/integration/navigation_sections_test.rb
 - test/integration/pagination_and_stats_test.rb
 - test/integration/read_only_resource_test.rb
+- test/integration/searchable_select_search_test.rb
+- test/integration/show_hide_blank_test.rb
 - test/integration/theme_test.rb
+- test/integration/toggle_test.rb
 - test/lib/action_executor_redirect_test.rb
 - test/lib/action_executor_test.rb
 - test/lib/auth_http_basic_test.rb
@@ -278,6 +306,8 @@ files:
 - test/lib/definition_loader_test.rb
 - test/lib/engine_defaults_test.rb
 - test/lib/form_field_renderer_test.rb
+- test/lib/format_table_cell_test.rb
+- test/lib/index_includes_test.rb
 - test/lib/legacy_renderer_deprecation_test.rb
 - test/lib/markdown_renderer_test.rb
 - test/lib/renderer_test.rb