Rename collapsed to start_collapsed, remove backward compat, drop animation

- Rename `collapsed:` option to `start_collapsed:` for clarity
- Remove deprecated `collapsed: true` backward compatibility (v3 breaking change)
- Raise ArgumentError with migration instructions for old option
- Remove CSS transitions on sidebar collapse/expand
- Update all specs and test app resources

Author: Fivell

app/assets/stylesheets/active_admin_sidebar.scss

@@ -52,15 +52,6 @@ body.active_admin {
 body.active_admin #active_admin_content.collapsible_sidebar {
   #sidebar {
     position: relative;
-    transition: width 0.25s ease, margin-left 0.25s ease;
-  }
-
-  #main_content_wrapper #main_content {
-    transition: margin 0.25s ease;
-  }
-
-  #main_content_wrapper {
-    transition: margin 0.25s ease;
   }
 
   .sidebar_toggle_btn {

lib/active_admin_sidebar/positions.rb

@@ -3,39 +3,40 @@ module Positions
     def left_sidebar!(options = {})
       @sidebar_options = { position: :left }
 
-      collapsible = options.fetch(:collapsible, false)
-      collapsed   = options.fetch(:collapsed, false)
-
-      # Backward compatibility: `collapsed: true` without `collapsible:` means collapsible (not start-collapsed)
-      if collapsed && !options.key?(:collapsible)
-        collapsible = true
-        collapsed = false
-        ActiveSupport::Deprecation.warn(
-          "left_sidebar!(collapsed: true) is deprecated. " \
-          "Use left_sidebar!(collapsible: true) instead, or " \
-          "left_sidebar!(collapsible: true, collapsed: true) to start collapsed."
-        )
-      end
+      validate_sidebar_options!(options)
+
+      collapsible     = options.fetch(:collapsible, false)
+      start_collapsed = options.fetch(:start_collapsed, false)
 
-      apply_collapsible_options(collapsible, collapsed) if collapsible
+      apply_collapsible_options(start_collapsed) if collapsible
     end
 
     def right_sidebar!(options = {})
       @sidebar_options = { position: :right }
 
-      collapsible = options.fetch(:collapsible, false)
-      collapsed   = options.fetch(:collapsed, false)
+      validate_sidebar_options!(options)
+
+      collapsible     = options.fetch(:collapsible, false)
+      start_collapsed = options.fetch(:start_collapsed, false)
 
-      apply_collapsible_options(collapsible, collapsed) if collapsible
+      apply_collapsible_options(start_collapsed) if collapsible
     end
 
     private
 
-    def apply_collapsible_options(collapsible, collapsed)
+    def validate_sidebar_options!(options)
+      if options.key?(:collapsed)
+        raise ArgumentError,
+          "The :collapsed option has been removed in v3. " \
+          "Use `collapsible: true, start_collapsed: true` instead."
+      end
+    end
+
+    def apply_collapsible_options(start_collapsed)
       session_key = :"collapsed_sidebar_#{controller_name}"
       handle_collapsed_sidebar_request(session_key)
       is_collapsed = if session[session_key].nil?
-                       collapsed
+                       start_collapsed
                      else
                        session[session_key]
                      end

spec/sidebars_spec.rb

@@ -54,9 +54,9 @@
 
   end
 
-  context 'left-sidebar with collapsible: true, collapsed: true (starts collapsed)' do
+  context 'left-sidebar with collapsible: true, start_collapsed: true' do
     before do
-      add_author_resource_with_collapsed
+      add_author_resource_with_start_collapsed
       add_post_resource
       visit '/admin/authors'
     end
@@ -79,16 +79,17 @@
     end
   end
 
-  context 'backward compatibility: left-sidebar with collapsed: true (old API)' do
-    before do
-      add_author_resource_with_old_api
-      add_post_resource
-      visit '/admin/authors'
+  context 'deprecated collapsed option raises error' do
+    it 'raises ArgumentError for left_sidebar!' do
+      obj = Object.new
+      obj.extend(ActiveAdminSidebar::Positions)
+      expect { obj.left_sidebar!(collapsed: true) }.to raise_error(ArgumentError, /removed in v3/)
     end
 
-    it 'still works as collapsible sidebar' do
-      expect(page).to have_css('#active_admin_content.collapsible_sidebar')
-      expect(page).to have_css('.sidebar_toggle_btn')
+    it 'raises ArgumentError for right_sidebar!' do
+      obj = Object.new
+      obj.extend(ActiveAdminSidebar::Positions)
+      expect { obj.right_sidebar!(collapsed: true) }.to raise_error(ArgumentError, /removed in v3/)
     end
   end
 
@@ -125,15 +126,15 @@
 
         page.find('.sidebar_toggle_btn').click
 
-        expect(page).to have_css('#sidebar .sidebar_section', visible: :visible)
         expect(page).not_to have_css('#active_admin_content.collapsed_sidebar')
+        expect(page).to have_css('#sidebar .sidebar_section', visible: :visible)
       end
     end
   end
 
-  context 'right-sidebar with collapsible: true, collapsed: true (starts collapsed)' do
+  context 'right-sidebar with collapsible: true, start_collapsed: true' do
     before do
-      add_author_resource_right_sidebar_collapsed
+      add_author_resource_right_sidebar_start_collapsed
       add_post_resource
       visit '/admin/authors'
     end
@@ -159,12 +160,12 @@
   context 'per-resource sidebar state isolation' do
     before do
       Post.create!(title: 'Test', body: 'Body', author: Author.first)
-      add_author_resource_with_collapsed
+      add_author_resource_with_start_collapsed
       add_post_resource_with_sidebar
     end
 
     it 'changing sidebar state on one resource does not affect another' do
-      # Authors starts collapsed (collapsible: true, collapsed: true)
+      # Authors starts collapsed (collapsible: true, start_collapsed: true)
       visit '/admin/authors'
       expect(page).to have_css('#active_admin_content.collapsed_sidebar')
 

spec/support/admin.rb

@@ -8,25 +8,12 @@ def add_author_resource(options = {}, &block)
 
 end
 
-def add_author_resource_with_collapsed(options = {}, &block)
+def add_author_resource_with_start_collapsed(options = {}, &block)
 
   ActiveAdmin.register Author do
     config.filters = true
     before_action do
-      left_sidebar!(collapsible: true, collapsed: true)
-    end
-  end
-
-  Rails.application.reload_routes!
-
-end
-
-def add_author_resource_with_old_api(options = {}, &block)
-
-  ActiveAdmin.register Author do
-    config.filters = true
-    before_action do
-      left_sidebar!(collapsed: true)
+      left_sidebar!(collapsible: true, start_collapsed: true)
     end
   end
 
@@ -47,12 +34,12 @@ def add_author_resource_right_sidebar(options = {}, &block)
 
 end
 
-def add_author_resource_right_sidebar_collapsed(options = {}, &block)
+def add_author_resource_right_sidebar_start_collapsed(options = {}, &block)
 
   ActiveAdmin.register Author do
     config.filters = true
     before_action do
-      right_sidebar!(collapsible: true, collapsed: true)
+      right_sidebar!(collapsible: true, start_collapsed: true)
     end
   end