admin_suite 0.2.0 → 0.2.2

data/test/dummy/tmp/local_secret.txt

@@ -0,0 +1 @@
+c02d71d37975d95a2c65ffeee97e37a5a969d38af1782fdc54d86db04188fdd28451c9f3a2be79410e2b66eede3b444ab30145534c96c013f3a6da03a3c32d1e

data/test/integration/dashboard_test.rb

@@ -1,13 +1,69 @@
 # frozen_string_literal: true
 
 require "test_helper"
+require "tmpdir"
 
 module AdminSuite
   class DashboardTest < ActionDispatch::IntegrationTest
     test "GET /internal/admin_suite renders dashboard" do
       get "/internal/admin_suite"
       assert_response :success
-      assert_includes response.body, "Developer Portal"
+      assert_includes response.body, "Admin Suite"
+    end
+
+    test "loads custom root dashboard definition from dashboard_globs" do
+      old_globs = AdminSuite.config.dashboard_globs
+      old_title = AdminSuite.config.root_dashboard_title
+      old_description = AdminSuite.config.root_dashboard_description
+
+      Dir.mktmpdir("admin-suite-dashboard") do |dir|
+        dashboard_rb = File.join(dir, "dashboard.rb")
+
+        File.write(dashboard_rb, <<~'RUBY')
+          # frozen_string_literal: true
+
+          AdminSuite.configure do |config|
+            config.root_dashboard_title = ->(controller) { "Custom Root #{controller.request.path}" }
+            config.root_dashboard_description = ->(_controller) { "Custom root description" }
+          end
+
+          AdminSuite.root_dashboard do
+            row do
+              stat_panel "Custom A", -> { 11 }, span: 6, variant: :mini, color: :slate
+              stat_panel "Custom B", 22, span: 6, variant: :mini, color: :slate
+            end
+          end
+        RUBY
+
+        AdminSuite.reset_root_dashboard!
+        AdminSuite.config.dashboard_globs = [File.join(dir, "*.rb")]
+
+        get "/internal/admin_suite"
+        assert_response :success
+
+        # Title + description should come from the dashboard definition file.
+        assert_includes response.body, "Custom Root /internal/admin_suite"
+        assert_includes response.body, "Custom root description"
+
+        # DSL-driven panels should render.
+        assert_includes response.body, "Custom A"
+        assert_includes response.body, ">11<"
+        assert_includes response.body, "Custom B"
+        assert_includes response.body, ">22<"
+
+        # Ensure spans are emitted (used to drive column layout).
+        assert_includes response.body, "admin-suite-dashboard-row"
+        assert_equal 2, response.body.scan("grid-column: span 6 / span 6;").size
+
+        # Loader should mark the dashboard as loaded in non-dev envs (test).
+        assert AdminSuite.config.root_dashboard_loaded
+        assert AdminSuite.root_dashboard_definition.present?
+      end
+    ensure
+      AdminSuite.config.dashboard_globs = old_globs
+      AdminSuite.config.root_dashboard_title = old_title
+      AdminSuite.config.root_dashboard_description = old_description
+      AdminSuite.reset_root_dashboard!
     end
   end
 end

data/test/lib/action_executor_test.rb

@@ -0,0 +1,172 @@
+# frozen_string_literal: true
+
+require "test_helper"
+require "tmpdir"
+
+module Admin
+  module Base
+    class ActionExecutorTest < ActiveSupport::TestCase
+      setup do
+        @temp_dir = Dir.mktmpdir("admin_suite_test")
+        @original_config = AdminSuite.config.action_globs.dup
+
+        # Reset the handlers_loaded flag before each test
+        ActionExecutor.handlers_loaded = false
+      end
+
+      teardown do
+        FileUtils.rm_rf(@temp_dir) if @temp_dir && File.exist?(@temp_dir)
+        AdminSuite.config.action_globs = @original_config
+
+        # Reset the flag after each test
+        ActionExecutor.handlers_loaded = false
+      end
+
+      test "handlers_loaded flag starts as false" do
+        ActionExecutor.handlers_loaded = false
+        assert_equal false, ActionExecutor.handlers_loaded
+      end
+
+      test "handlers_loaded flag can be set to true" do
+        ActionExecutor.handlers_loaded = true
+        assert_equal true, ActionExecutor.handlers_loaded
+      end
+
+      test "load_action_handlers_for_admin_suite sets handlers_loaded to true after loading" do
+        # Create a temporary action handler file
+        actions_dir = File.join(@temp_dir, "actions")
+        FileUtils.mkdir_p(actions_dir)
+        File.write(
+          File.join(actions_dir, "test_action.rb"),
+          "module Admin\n  module Actions\n    class TestAction\n    end\n  end\nend"
+        )
+
+        # Configure AdminSuite to look in our temp directory
+        AdminSuite.config.action_globs = [ File.join(actions_dir, "*.rb") ]
+
+        # Create an executor instance and call the loading method
+        resource_class = Struct.new(:resource_name).new("test")
+        executor = ActionExecutor.new(resource_class, :test, nil)
+
+        # Ensure flag starts as false
+        ActionExecutor.handlers_loaded = false
+
+        # Call the private method
+        executor.send(:load_action_handlers_for_admin_suite!)
+
+        # Verify the flag is now true
+        assert ActionExecutor.handlers_loaded, "Expected handlers_loaded to be true after loading"
+      end
+
+      test "load_action_handlers_for_admin_suite skips loading when handlers_loaded is true" do
+        # Create a temporary action handler file
+        actions_dir = File.join(@temp_dir, "actions")
+        FileUtils.mkdir_p(actions_dir)
+        action_file = File.join(actions_dir, "test_action.rb")
+        File.write(action_file, "# Test action")
+
+        # Configure AdminSuite to look in our temp directory
+        AdminSuite.config.action_globs = [ File.join(actions_dir, "*.rb") ]
+
+        # Create an executor instance
+        resource_class = Struct.new(:resource_name).new("test")
+        executor = ActionExecutor.new(resource_class, :test, nil)
+
+        # Set the flag to true to simulate already loaded
+        ActionExecutor.handlers_loaded = true
+
+        # Mock Dir[] to verify it's not called
+        glob_called = false
+        original_bracket = Dir.method(:[])
+        Dir.define_singleton_method(:[]) do |pattern|
+          glob_called = true
+          original_bracket.call(pattern)
+        end
+
+        begin
+          # Call the loading method
+          executor.send(:load_action_handlers_for_admin_suite!)
+
+          # Verify glob was not called because handlers were already loaded
+          assert_not glob_called, "Expected Dir[] to not be called when handlers_loaded is true"
+        ensure
+          # Restore Dir.[] method
+          Dir.define_singleton_method(:[], original_bracket)
+        end
+      end
+
+      test "load_action_handlers_for_admin_suite returns early when AdminSuite is not defined" do
+        # Temporarily undefine AdminSuite to test early return
+        admin_suite_defined = defined?(AdminSuite)
+
+        skip "Cannot test AdminSuite undefined condition when AdminSuite is required" if admin_suite_defined
+
+        resource_class = Struct.new(:resource_name).new("test")
+        executor = ActionExecutor.new(resource_class, :test, nil)
+
+        # This should return early without error
+        assert_nil executor.send(:load_action_handlers_for_admin_suite!)
+      end
+
+      test "load_action_handlers_for_admin_suite handles empty action_globs gracefully" do
+        # Set action_globs to empty
+        AdminSuite.config.action_globs = []
+
+        resource_class = Struct.new(:resource_name).new("test")
+        executor = ActionExecutor.new(resource_class, :test, nil)
+
+        ActionExecutor.handlers_loaded = false
+
+        # This should not raise an error
+        assert_nothing_raised do
+          executor.send(:load_action_handlers_for_admin_suite!)
+        end
+
+        # Flag should be set even when no files exist to avoid repeated expensive globs
+        assert ActionExecutor.handlers_loaded, "Expected handlers_loaded to be true even when no files exist"
+      end
+
+      test "load_action_handlers_for_admin_suite handles errors gracefully" do
+        # Configure a glob pattern that will cause an error
+        AdminSuite.config.action_globs = [ "/nonexistent/path/*.rb" ]
+
+        resource_class = Struct.new(:resource_name).new("test")
+        executor = ActionExecutor.new(resource_class, :test, nil)
+
+        ActionExecutor.handlers_loaded = false
+
+        # This should not raise an error even if globbing fails
+        assert_nothing_raised do
+          executor.send(:load_action_handlers_for_admin_suite!)
+        end
+      end
+
+      test "load_action_handlers_for_admin_suite does not set flag when file loading fails" do
+        # Create a temporary action handler file with invalid Ruby
+        actions_dir = File.join(@temp_dir, "actions")
+        FileUtils.mkdir_p(actions_dir)
+        File.write(
+          File.join(actions_dir, "bad_action.rb"),
+          "this is not valid ruby syntax @#$%"
+        )
+
+        # Configure AdminSuite to look in our temp directory
+        AdminSuite.config.action_globs = [ File.join(actions_dir, "*.rb") ]
+
+        resource_class = Struct.new(:resource_name).new("test")
+        executor = ActionExecutor.new(resource_class, :test, nil)
+
+        ActionExecutor.handlers_loaded = false
+
+        # In test, we fail fast so syntax errors in handler files are discoverable.
+        assert_raises(SyntaxError) do
+          executor.send(:load_action_handlers_for_admin_suite!)
+        end
+
+        # Flag should remain false when loading fails, allowing retry
+        assert_not ActionExecutor.handlers_loaded,
+                   "Expected handlers_loaded to remain false when file loading fails"
+      end
+    end
+  end
+end

data/test/lib/zeitwerk_integration_test.rb

@@ -17,34 +17,55 @@ module AdminSuite
     def create_tracked_loader
       loader = Zeitwerk::Loader.new
       ignored_dirs = []
+      pushed_dirs = []
 
       loader.define_singleton_method(:ignore) do |path|
         ignored_dirs << path.to_s
       end
 
-      [loader, ignored_dirs]
+      loader.define_singleton_method(:push_dir) do |path, namespace:|
+        pushed_dirs << { path: path.to_s, namespace: namespace }
+      end
+
+      [loader, ignored_dirs, pushed_dirs]
     end
 
     # Helper method that simulates the Zeitwerk integration logic from engine.rb
     def simulate_zeitwerk_integration(app_root, loader)
-      host_dsl_dirs = [app_root.join("app/admin_suite")]
-      host_admin_portals_dir = app_root.join("app/admin/portals")
+      admin_suite_app_dir = app_root.join("app/admin_suite")
+      admin_dir = app_root.join("app/admin")
+      admin_portals_dir = app_root.join("app/admin/portals")
 
-      if host_admin_portals_dir.exist?
-        portal_files = Dir[host_admin_portals_dir.join("**/*.rb").to_s]
-        contains_admin_suite_portals =
-          portal_files.any? do |file|
+      # Map app/admin -> Admin namespace if files define Admin::* constants.
+      if admin_dir.exist?
+        rb_files = Dir[admin_dir.join("**/*.rb").to_s]
+        rb_files.reject! { |f| f.include?("/portals/") }
+
+        host_uses_admin_namespace =
+          rb_files.any? do |file|
             content = File.binread(file).encode("UTF-8", invalid: :replace, undef: :replace, replace: "")
-            content.include?("AdminSuite.portal")
+            content.match?(/\b(module|class)\s+Admin\b/) || content.match?(/\b(module|class)\s+Admin::/)
           rescue StandardError
             false
           end
 
-        host_dsl_dirs << host_admin_portals_dir if contains_admin_suite_portals
+        loader.push_dir(admin_dir, namespace: Admin) if host_uses_admin_namespace
       end
 
-      host_dsl_dirs.each do |dir|
-        loader.ignore(dir) if dir.exist?
+      loader.ignore(admin_suite_app_dir) if admin_suite_app_dir.exist?
+
+      # Ignore portal DSL files (side-effect DSL, not constants).
+      if admin_portals_dir.exist?
+        portal_files = Dir[admin_portals_dir.join("**/*.rb").to_s]
+        contains_admin_suite_portals =
+          portal_files.any? do |file|
+            content = File.binread(file).encode("UTF-8", invalid: :replace, undef: :replace, replace: "")
+            content.match?(/(::)?AdminSuite\s*\.\s*portal\b/)
+          rescue StandardError
+            false
+          end
+
+        loader.ignore(admin_portals_dir) if contains_admin_suite_portals
       end
     end
 
@@ -59,7 +80,7 @@ module AdminSuite
 
       # Create loader and simulate initializer logic
       app_root = Pathname.new(@temp_dir)
-      loader, ignored_dirs = create_tracked_loader
+      loader, ignored_dirs, _pushed_dirs = create_tracked_loader
       simulate_zeitwerk_integration(app_root, loader)
 
       # Verify that app/admin/portals was ignored
@@ -79,7 +100,7 @@ module AdminSuite
 
       # Create loader and simulate initializer logic
       app_root = Pathname.new(@temp_dir)
-      loader, ignored_dirs = create_tracked_loader
+      loader, ignored_dirs, _pushed_dirs = create_tracked_loader
       simulate_zeitwerk_integration(app_root, loader)
 
       # Verify that app/admin/portals was NOT ignored
@@ -99,7 +120,7 @@ module AdminSuite
 
       # Create loader and simulate initializer logic
       app_root = Pathname.new(@temp_dir)
-      loader, ignored_dirs = create_tracked_loader
+      loader, ignored_dirs, _pushed_dirs = create_tracked_loader
       simulate_zeitwerk_integration(app_root, loader)
 
       # Verify that app/admin_suite was ignored
@@ -127,7 +148,7 @@ module AdminSuite
 
       # Create loader and simulate initializer logic
       app_root = Pathname.new(@temp_dir)
-      loader, ignored_dirs = create_tracked_loader
+      loader, ignored_dirs, _pushed_dirs = create_tracked_loader
       simulate_zeitwerk_integration(app_root, loader)
 
       # Verify that app/admin/portals was ignored due to presence of portal DSL
@@ -145,7 +166,7 @@ module AdminSuite
 
       # Create loader
       app_root = Pathname.new(@temp_dir)
-      loader, ignored_dirs = create_tracked_loader
+      loader, ignored_dirs, _pushed_dirs = create_tracked_loader
 
       # Temporarily override File.binread to simulate read errors
       original_binread = File.singleton_class.instance_method(:binread)
@@ -171,5 +192,37 @@ module AdminSuite
         File.singleton_class.define_method(:binread, original_binread)
       end
     end
+
+    test "maps app/admin to Admin namespace when files define Admin constants" do
+      resources_dir = File.join(@temp_dir, "app", "admin", "resources")
+      FileUtils.mkdir_p(resources_dir)
+      File.write(
+        File.join(resources_dir, "user_resource.rb"),
+        "module Admin\n  module Resources\n    class UserResource; end\n  end\nend\n"
+      )
+
+      app_root = Pathname.new(@temp_dir)
+      loader, _ignored_dirs, pushed_dirs = create_tracked_loader
+      simulate_zeitwerk_integration(app_root, loader)
+
+      assert pushed_dirs.any? { |h| h[:path] == app_root.join("app/admin").to_s && h[:namespace] == Admin },
+             "Expected app/admin to be pushed with namespace Admin when files define Admin::* constants"
+    end
+
+    test "does not map app/admin when it contains only top-level constants" do
+      resources_dir = File.join(@temp_dir, "app", "admin", "resources")
+      FileUtils.mkdir_p(resources_dir)
+      File.write(
+        File.join(resources_dir, "user_resource.rb"),
+        "module Resources\n  class UserResource; end\nend\n"
+      )
+
+      app_root = Pathname.new(@temp_dir)
+      loader, _ignored_dirs, pushed_dirs = create_tracked_loader
+      simulate_zeitwerk_integration(app_root, loader)
+
+      assert pushed_dirs.none? { |h| h[:path] == app_root.join("app/admin").to_s },
+             "Expected app/admin to NOT be pushed when files contain only top-level constants"
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: admin_suite
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.2
 platform: ruby
 authors:
 - TechWright Labs
@@ -237,6 +237,7 @@ files:
 - test/dummy/config/puma.rb
 - test/dummy/config/routes.rb
 - test/dummy/db/seeds.rb
+- test/dummy/log/test.log
 - test/dummy/public/400.html
 - test/dummy/public/404.html
 - test/dummy/public/406-unsupported-browser.html
@@ -246,10 +247,12 @@ files:
 - test/dummy/public/icon.svg
 - test/dummy/public/robots.txt
 - test/dummy/test/test_helper.rb
+- test/dummy/tmp/local_secret.txt
 - test/fixtures/docs/progress/PROGRESS_REPORT.md
 - test/integration/dashboard_test.rb
 - test/integration/docs_test.rb
 - test/integration/theme_test.rb
+- test/lib/action_executor_test.rb
 - test/lib/markdown_renderer_test.rb
 - test/lib/theme_palette_test.rb
 - test/lib/zeitwerk_integration_test.rb