admin_suite 0.2.7 → 0.2.9

data/test/controllers/resources_controller_test.rb

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+require "test_helper"
+
+module AdminSuite
+  class ResourcesControllerTest < ActiveSupport::TestCase
+    class TestController < ResourcesController
+      attr_writer :test_resource_config
+      attr_reader :filter_calls, :paginated_scope
+
+      def initialize
+        super
+        @filter_calls = 0
+      end
+
+      private
+
+      def resource_config
+        @test_resource_config
+      end
+
+      def filtered_collection
+        @filter_calls += 1
+        { total: 37 }
+      end
+
+      def paginate_collection(scope)
+        @paginated_scope = scope
+        [ Object.new, :paginated ]
+      end
+    end
+
+    class StatsResource < Admin::Base::Resource
+      index do
+        stats do
+          stat :legacy, -> { 11 }
+          stat :filtered, ->(scope) { scope.fetch(:total) }
+        end
+      end
+    end
+
+    class BrokenStatsResource < Admin::Base::Resource
+      index do
+        stats do
+          stat :broken, ->(_scope) { raise "boom" }
+        end
+      end
+    end
+
+    test "stats preserve zero arity calculators and pass the filtered scope to one arity calculators" do
+      controller = TestController.new
+      controller.test_resource_config = StatsResource
+      scope = { total: 37 }
+
+      stats = controller.send(:calculate_stats, scope)
+
+      assert_equal 11, stats.first[:value]
+      assert_equal 37, stats.second[:value]
+    end
+
+    test "stats preserve the existing calculator rescue behavior" do
+      controller = TestController.new
+      controller.test_resource_config = BrokenStatsResource
+
+      assert_equal "N/A", controller.send(:calculate_stats, Object.new).first[:value]
+    end
+
+    test "index reuses one filtered unpaginated scope for stats and pagination" do
+      controller = TestController.new
+      controller.test_resource_config = StatsResource
+
+      controller.index
+
+      assert_equal 1, controller.filter_calls
+      assert_equal({ total: 37 }, controller.paginated_scope)
+      assert_equal 37, controller.instance_variable_get(:@stats).second[:value]
+      assert_equal :paginated, controller.instance_variable_get(:@collection)
+    end
+  end
+end

data/test/integration/read_only_resource_test.rb

@@ -0,0 +1,143 @@
+# frozen_string_literal: true
+
+require "test_helper"
+
+# The dummy app is intentionally database-free, while the generic controller
+# supports Active Record hosts. Supply only the exception type its lookup path
+# rescues so show-page behavior can be exercised with an in-memory fixture.
+unless defined?(ActiveRecord::RecordNotFound)
+  module ActiveRecord
+    class RecordNotFound < StandardError; end
+  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
+
+    def initialize(records)
+      @records = records
+    end
+
+    def each(&block)
+      @records.each(&block)
+    end
+
+    def count(*)
+      @records.count
+    end
+
+    def offset(*)
+      self
+    end
+
+    def limit(*)
+      self
+    end
+  end
+
+  class Widget
+    extend ActiveModel::Naming
+
+    attr_reader :id, :name
+
+    def initialize(id: 1, name: "Observed widget")
+      @id = id
+      @name = name
+    end
+
+    def self.all
+      Relation.new([ new ])
+    end
+
+    def self.column_names
+      %w[id name]
+    end
+
+    def self.primary_key
+      "id"
+    end
+
+    def self.columns_hash
+      { "id" => Struct.new(:type).new(:integer) }
+    end
+
+    def self.find(id)
+      raise ActiveRecord::RecordNotFound unless id.to_s == "1"
+
+      new
+    end
+
+    def to_param
+      id.to_s
+    end
+
+    def attributes
+      { "id" => id, "name" => name }
+    end
+  end
+end
+
+module Admin
+  module Resources
+    class ReadOnlyWidgetResource < Admin::Base::Resource
+      model ReadOnlyResourceFixtures::Widget
+      portal :ops
+      section :observability
+      read_only
+
+      index do
+        columns do
+          column :name
+        end
+      end
+    end
+  end
+end
+
+module AdminSuite
+  class ReadOnlyResourceTest < ActionDispatch::IntegrationTest
+    BASE_PATH = "/internal/admin_suite/ops/read_only_widgets"
+
+    test "direct built in mutation endpoints are rejected" do
+      get "#{BASE_PATH}/new"
+      assert_response :not_found
+
+      post BASE_PATH, params: { read_only_resource_fixtures_widget: { name: "changed" } }
+      assert_response :not_found
+
+      get "#{BASE_PATH}/1/edit"
+      assert_response :not_found
+
+      patch "#{BASE_PATH}/1", params: { read_only_resource_fixtures_widget: { name: "changed" } }
+      assert_response :not_found
+
+      delete "#{BASE_PATH}/1"
+      assert_response :not_found
+    end
+
+    test "index hides create and edit controls" do
+      get BASE_PATH
+
+      assert_response :success
+      assert_includes response.body, "Observed widget"
+      refute_includes response.body, "New Widget"
+      refute_match(/>\s*Edit\s*</, response.body)
+    end
+
+    test "show mutation controls are conditional on write access" do
+      template = AdminSuite::Engine.root.join("app/views/admin_suite/resources/show.html.erb").read
+
+      assert_includes template, "has_edit_route = !resource_config.read_only?"
+      assert_includes template, "has_destroy_route = !resource_config.read_only?"
+    end
+  end
+end

data/test/lib/resource_observability_extensions_test.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+require "test_helper"
+
+module AdminSuite
+  class ResourceObservabilityExtensionsTest < ActiveSupport::TestCase
+    FakeScope = Struct.new(:filters) do
+      def where(*arguments)
+        self.class.new(filters + [ arguments ])
+      end
+    end
+
+    class FilteredResource < Admin::Base::Resource
+      index do
+        filters do
+          filter :window, type: :select, default: "24h",
+            apply: ->(scope, value) { scope.where(window: value) }
+          filter :status, type: :select
+        end
+      end
+    end
+
+    class ReadOnlyResource < Admin::Base::Resource
+      read_only
+    end
+
+    test "resources are writable by default and may be declared read only" do
+      refute Admin::Base::Resource.read_only?
+      assert ReadOnlyResource.read_only?
+    end
+
+    test "filter defaults apply when the parameter is absent" do
+      scope = Admin::Base::FilterBuilder.new(FilteredResource, ActionController::Parameters.new)
+        .apply(FakeScope.new([]))
+
+      assert_equal [ [ { window: "24h" } ] ], scope.filters
+    end
+
+    test "filter defaults apply when the parameter is blank and compose with explicit filters" do
+      params = ActionController::Parameters.new(window: "", status: "failed")
+      scope = Admin::Base::FilterBuilder.new(FilteredResource, params).apply(FakeScope.new([]))
+
+      assert_equal [ [ { window: "24h" } ], [ { status: "failed" } ] ], scope.filters
+    end
+
+    test "an explicit filter overrides its default" do
+      params = ActionController::Parameters.new(window: "7d")
+      scope = Admin::Base::FilterBuilder.new(FilteredResource, params).apply(FakeScope.new([]))
+
+      assert_equal [ [ { window: "7d" } ] ], scope.filters
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: admin_suite
 version: !ruby/object:Gem::Version
-  version: 0.2.7
+  version: 0.2.9
 platform: ruby
 authors:
 - TechWright Labs
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-02-28 00:00:00.000000000 Z
+date: 2026-07-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -136,9 +136,11 @@ files:
 - app/helpers/admin_suite/panels_helper.rb
 - 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/click_actions_controller.js
 - app/javascript/controllers/admin_suite/clipboard_controller.js
 - app/javascript/controllers/admin_suite/code_editor_controller.js
+- app/javascript/controllers/admin_suite/dependent_searchable_select_controller.js
 - app/javascript/controllers/admin_suite/file_upload_controller.js
 - app/javascript/controllers/admin_suite/flash_controller.js
 - app/javascript/controllers/admin_suite/json_editor_controller.js
@@ -171,18 +173,6 @@ files:
 - app/views/layouts/admin_suite/application.html.erb
 - config/importmap.rb
 - config/routes.rb
-- docs/README.md
-- docs/actions.md
-- docs/configuration.md
-- docs/development.md
-- docs/docs_viewer.md
-- docs/fields.md
-- docs/installation.md
-- docs/portals.md
-- docs/releasing.md
-- docs/resources.md
-- docs/theming.md
-- docs/troubleshooting.md
 - lib/admin/base/action_executor.rb
 - lib/admin/base/action_handler.rb
 - lib/admin/base/filter_builder.rb
@@ -207,6 +197,7 @@ files:
 - lib/generators/admin_suite/scaffold/scaffold_generator.rb
 - lib/tasks/admin_suite_tailwind.rake
 - lib/tasks/admin_suite_test.rake
+- test/controllers/resources_controller_test.rb
 - test/dummy/Gemfile
 - test/dummy/README.md
 - test/dummy/Rakefile
@@ -251,9 +242,11 @@ files:
 - test/fixtures/docs/progress/PROGRESS_REPORT.md
 - test/integration/dashboard_test.rb
 - test/integration/docs_test.rb
+- test/integration/read_only_resource_test.rb
 - test/integration/theme_test.rb
 - test/lib/action_executor_test.rb
 - test/lib/markdown_renderer_test.rb
+- test/lib/resource_observability_extensions_test.rb
 - test/lib/theme_palette_test.rb
 - test/lib/zeitwerk_integration_test.rb
 - test/test_helper.rb

data/docs/README.md

@@ -1,26 +0,0 @@
-# AdminSuite Documentation
-
-AdminSuite is a mountable Rails engine that provides:
-
-- A **resource DSL** for CRUD + search/sort/filter + show/form configuration
-- A **portal system** (navigation + optional portal dashboards)
-- A built-in **docs viewer** (renders Markdown from your host app filesystem)
-- A small baseline **UI layer** (Tailwind optional)
-
-## Getting started
-
-- [Installation](installation.md)
-- [Configuration](configuration.md)
-- [Portals & dashboards](portals.md)
-- [Resources](resources.md)
-- [Fields](fields.md)
-- [Actions](actions.md)
-- [Theming & assets](theming.md)
-- [Docs viewer](docs_viewer.md)
-- [Troubleshooting](troubleshooting.md)
-
-## Contributing / maintainers
-
-- [Development](development.md)
-- [Releasing](releasing.md)
-

data/docs/actions.md

@@ -1,98 +0,0 @@
-# Actions
-
-AdminSuite supports three action “shapes” in the resource DSL:
-
-- `action` (member action on a single record)
-- `bulk_action` (runs across selected records)
-- `collection_action` (runs on a scope / collection)
-
-## Defining actions
-
-```ruby
-actions do
-  action :reindex, label: "Reindex", method: :post, confirm: "Reindex this record?"
-  bulk_action :archive, label: "Archive", confirm: "Archive selected records?"
-end
-```
-
-Supported action options:
-
-- `method:` HTTP method (default `:post`)
-- `label:` button label (default is humanized action name)
-- `icon:` lucide icon name (optional)
-- `color:` (optional)
-- `confirm:` string confirmation (optional)
-- `type:` reserved (default `:button`)
-- `if:` Proc condition (member actions only)
-- `unless:` Proc condition (member actions only)
-
-## How actions execute
-
-When you trigger an action, AdminSuite resolves behavior in this order:
-
-1. **Model method**: if the target responds to `action_name`, it calls that method.
-2. **Bang model method**: else if it responds to `action_name!`, it calls that.
-3. **Action handler class**: else it tries to find a handler class.
-
-### Handler class naming convention
-
-By default, AdminSuite looks for:
-
-```ruby
-Admin::Actions::<ResourceName><ActionName>Action
-```
-
-Example for `UserResource` + `:reset_password`:
-
-```ruby
-Admin::Actions::UserResetPasswordAction
-```
-
-Handlers should inherit from `Admin::Base::ActionHandler`:
-
-```ruby
-# app/admin/actions/user_reset_password_action.rb
-module Admin
-  module Actions
-    class UserResetPasswordAction < Admin::Base::ActionHandler
-      def call
-        # record is available as `record`, actor as `actor`, request params as `params`
-        record.send_reset_password_instructions!
-        success "Reset email sent."
-      rescue StandardError => e
-        failure "Failed to send reset: #{e.message}"
-      end
-    end
-  end
-end
-```
-
-## Overriding handler resolution (`config.resolve_action_handler`)
-
-If your app doesn’t want to follow the default naming convention, you can provide a resolver:
-
-```ruby
-AdminSuite.configure do |config|
-  config.resolve_action_handler = ->(resource_class, action_name) do
-    # return a Class or nil
-    if resource_class.name == "Admin::Resources::UserResource" && action_name.to_sym == :reset_password
-      Admin::Actions::UserResetPasswordAction
-    end
-  end
-end
-```
-
-## Auditing hook (`config.on_action_executed`)
-
-You can record or log all actions after they run:
-
-```ruby
-AdminSuite.configure do |config|
-  config.on_action_executed = ->(actor:, action_name:, resource_class:, subject:, params:, result:) do
-    Rails.logger.info(
-      "[admin_suite] actor=#{actor&.id} action=#{resource_class.name}##{action_name} success=#{result.success?}"
-    )
-  end
-end
-```
-