activeadmin-tom_select 4.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 101301522f68deaa4722807193d35b2e8e1e91b9f30e3ca555a1d08ca86681ba
+  data.tar.gz: 8ab0654e5ea3c8fdd6f180126b84b7e7477252cee7be34f5d10b49e2ed8aad5a
+SHA512:
+  metadata.gz: 4abe389636853e25410b3dfbdc56c38c536f5c97d92a141d374ca1e1e0e2426bf93fdd4c3764929b6a306ae9f8f87e02a7ae79b7c0cde83b11a748bf9bc06ff2
+  data.tar.gz: ef5c07fcfbb26a0921fd24070be3bec85d92f05d3752de56bfb64a2f3df7f7da76832bb4f16e9475350189b5b5ff9b4ea1a7c79e386c6f70b3b652300d22e2b7

data/.actrc

@@ -0,0 +1,20 @@
+# Act configuration for local GitHub Actions testing
+# This file configures act to work efficiently with caching
+
+# Use medium-sized runner image for better compatibility
+--platform ubuntu-latest=catthehacker/ubuntu:act-latest
+
+# Enable reuse of containers for faster subsequent runs
+--reuse
+
+# Use local .env file if it exists (for secrets during local testing)
+--env-file .env.local
+
+# Pull docker images if newer version exists
+--pull=false
+
+# Bind working directory for better performance with local files
+--bind
+
+# Use host network for faster downloads and to avoid network issues
+--network host

data/.claude/commands/fix-tests.md

@@ -0,0 +1,203 @@
+# Fix Tests - ActiveAdmin Searchable Select
+
+## Overview
+This guide provides instructions for debugging and fixing failing tests in the ActiveAdmin Searchable Select gem, particularly issues related to Select2 initialization and DOM element selection.
+
+## Common Test Failures
+
+### 1. Select2 Container Not Found
+**Error:** `Unable to find css ".select2-container"`
+
+**Root Causes:**
+- JavaScript dependencies (jQuery, Select2) not loaded in test environment
+- ActiveAdmin 4 expects `importmap-rails` but test environment uses no-op shims
+
+**Solution:**
+Check `/spec/internal/config/initializers/active_admin.rb` and ensure JavaScript dependencies are properly loaded:
+
+```ruby
+# Replace no-op javascript_importmap_tags with working implementation
+config.register_javascript do
+  raw <<~HTML
+    <link href="https://cdn.jsdelivr.net/npm/select2@4.1.0-rc.0/dist/css/select2.min.css" rel="stylesheet" />
+    <script src="https://code.jquery.com/jquery-3.7.1.min.js"></script>
+    <script src="https://cdn.jsdelivr.net/npm/select2@4.1.0-rc.0/dist/js/select2.min.js"></script>
+    <script type="text/javascript">
+      #{File.read(Rails.root.join('../../app/assets/javascripts/active_admin/searchable_select/init.js'))}
+    </script>
+  HTML
+end
+```
+
+### 2. Filter Form Selector Changes
+**Error:** `Unable to find css ".filter_form"`
+
+**Root Cause:** ActiveAdmin 4 changed the filter form class from `.filter_form` to `.filters-form` (with an 's')
+
+**Solution:** Update selectors in tests:
+```ruby
+# Old (incorrect)
+within '.filter_form' do
+  find('.select2-container').click
+end
+
+# New (correct)
+within '.filters-form' do
+  find('.select2-container').click
+end
+```
+
+## Debugging Workflow
+
+### Step 1: Add HTML Debug Output
+When a test fails due to missing elements, add debug output to see the actual page structure:
+
+```ruby
+it 'your test' do
+  visit '/admin/posts'
+  
+  # Debug: output page HTML
+  puts "\n=== DEBUG: Page HTML ==="
+  puts page.html
+  puts "=== END DEBUG ===\n"
+  
+  # Debug: check for specific elements
+  puts "Select2 containers found: #{page.all('.select2-container').count}"
+  puts "Searchable select inputs: #{page.all('.searchable-select-input').count}"
+  
+  # Your test code here
+end
+```
+
+### Step 2: Check JavaScript Loading
+Add JavaScript debugging to verify dependencies are loaded:
+
+```ruby
+it 'checks JavaScript dependencies' do
+  visit '/admin/posts'
+  
+  # Check if jQuery is loaded
+  jquery_loaded = page.evaluate_script('typeof jQuery !== "undefined"')
+  puts "jQuery loaded: #{jquery_loaded}"
+  
+  # Check jQuery version
+  if jquery_loaded
+    jquery_version = page.evaluate_script('jQuery.fn.jquery')
+    puts "jQuery version: #{jquery_version}"
+  end
+  
+  # Check if Select2 is loaded
+  select2_loaded = page.evaluate_script('typeof jQuery !== "undefined" && jQuery.fn.select2 !== undefined')
+  puts "Select2 loaded: #{select2_loaded}"
+end
+```
+
+### Step 3: Capture Console Errors
+For JavaScript-capable drivers, capture console errors:
+
+```ruby
+# Add to test setup
+page.driver.browser.manage.logs.get(:browser).each do |log|
+  puts "Console #{log.level}: #{log.message}"
+end
+```
+
+### Step 4: Wait for Dynamic Elements
+Ensure elements have time to initialize:
+
+```ruby
+# Use Capybara's wait functionality
+expect(page).to have_css('.select2-container', wait: 5)
+
+# Or wait for specific conditions
+Capybara.using_wait_time(5) do
+  find('.select2-container').click
+end
+```
+
+## Project-Specific Considerations
+
+### 1. Test Environment Setup
+The test suite uses Combustion to create a minimal Rails app in `spec/internal/`. Key files:
+- `spec/internal/config/initializers/active_admin.rb` - ActiveAdmin configuration
+- `spec/internal/app/admin/` - Test admin resources
+- `spec/internal/app/models/` - Test models
+
+### 2. ActiveAdmin Version Compatibility
+This gem supports multiple ActiveAdmin versions through Appraisal. Test against specific versions:
+```bash
+# Install appraisals
+appraisal install
+
+# Run tests against specific version
+appraisal activeadmin-4 rspec
+```
+
+### 3. JavaScript Asset Loading
+The gem's JavaScript is in `app/assets/javascripts/active_admin/searchable_select/`. In tests, ensure these files are loaded either:
+- Via CDN (for simplicity in tests)
+- Via Rails asset pipeline (for integration testing)
+- Inline in the test initializer (current approach)
+
+### 4. Inline AJAX Options Mode
+For testing without real AJAX calls, enable inline mode:
+```ruby
+ActiveAdmin::SearchableSelect.inline_ajax_options = true
+```
+This renders all options statically in the HTML.
+
+## Running Tests
+
+```bash
+# Run all tests
+bundle exec rspec
+
+# Run specific test file
+bundle exec rspec spec/features/end_to_end_spec.rb
+
+# Run specific test by line number
+bundle exec rspec spec/features/production_build_spec.rb:56
+
+# Run with documentation format for clarity
+bundle exec rspec --format documentation
+
+# Run tests matching a pattern
+bundle exec rspec -e "searchable select"
+```
+
+## Common Fixes Checklist
+
+1. ✅ Verify jQuery is loaded (version 3.x recommended)
+2. ✅ Verify Select2 is loaded (version 4.1.0-rc.0)
+3. ✅ Check CSS selectors match current ActiveAdmin version
+4. ✅ Ensure test database has seed data if needed
+5. ✅ Check for JavaScript console errors
+6. ✅ Verify AJAX endpoints are defined (`searchable_select_options` in resource)
+7. ✅ Wait for dynamic elements to initialize
+8. ✅ Use correct Capybara driver for JavaScript tests (`:selenium_chrome_headless`)
+
+## Troubleshooting Tips
+
+1. **"Warning: method `all_options` already defined"** - Normal warning, can be ignored
+2. **Flaky tests** - Add explicit waits or use `have_css` with wait parameter
+3. **Different behavior in CI** - Check for timing issues, add debug output
+4. **Select2 not initializing** - Verify document ready events are firing correctly
+
+## Quick Debug Template
+
+Add this to any failing test for comprehensive debugging:
+
+```ruby
+# Debug template
+puts "\n=== DEBUG START ==="
+puts "Current URL: #{current_url}"
+puts "Page title: #{page.title}"
+puts "Select2 containers: #{page.all('.select2-container').count}"
+puts "Searchable inputs: #{page.all('.searchable-select-input').count}"
+puts "jQuery loaded: #{page.evaluate_script('typeof jQuery !== "undefined"')}"
+puts "Select2 loaded: #{page.evaluate_script('typeof jQuery !== "undefined" && jQuery.fn.select2 !== undefined')}"
+save_screenshot('debug_screenshot.png') if respond_to?(:save_screenshot)
+puts "=== DEBUG END ===\n"
+```
+
+This guide should help quickly diagnose and fix test failures related to the searchable select functionality.

data/.github/workflows/ci.yml

@@ -0,0 +1,174 @@
+name: CI
+
+on:
+  push:
+    branches: [master, main]
+  pull_request:
+    branches: [master, main]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    timeout-minutes: 15
+    
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: ['3.3', '3.4']
+        gemfile:
+          - rails_7.x_active_admin_4.x
+          - rails_8.x_active_admin_4.x
+
+    env:
+      BUNDLE_GEMFILE: ${{ github.workspace }}/gemfiles/${{ matrix.gemfile }}.gemfile
+      RAILS_ENV: test
+      PLAYWRIGHT_BROWSERS_PATH: ${{ github.workspace }}/ms-playwright
+
+    steps:
+      - uses: actions/checkout@v5
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+
+      # Cache APT packages for Playwright dependencies
+      - name: Cache APT packages
+        uses: awalsh128/cache-apt-pkgs-action@v1.5.3
+        with:
+          packages: libnss3 libnspr4 libatk1.0-0 libatk-bridge2.0-0 libcups2 libdrm2 libdbus-1-3 libatspi2.0-0 libx11-6 libxcomposite1 libxdamage1 libxext6 libxfixes3 libxrandr2 libgbm1 libxcb1 libxkbcommon0 libpango-1.0-0 libcairo2 libasound2
+          version: 1.0
+          execute_install_scripts: true
+
+      # Get Playwright version for cache key
+      - name: Get Playwright version
+        id: playwright-version
+        run: |
+          PLAYWRIGHT_VERSION=$(npm ls @playwright/test 2>/dev/null | grep @playwright/test | sed 's/.*@//' | head -1)
+          if [ -z "$PLAYWRIGHT_VERSION" ]; then
+            PLAYWRIGHT_VERSION=$(npx playwright --version | sed 's/Version //')
+          fi
+          echo "version=$PLAYWRIGHT_VERSION" >> $GITHUB_OUTPUT
+
+      # Cache Playwright browsers
+      - name: Cache Playwright browsers
+        id: playwright-cache
+        uses: actions/cache@v4
+        with:
+          path: ${{ github.workspace }}/ms-playwright
+          key: ${{ runner.os }}-playwright-${{ steps.playwright-version.outputs.version }}-${{ hashFiles('**/package-lock.json', '**/yarn.lock', '**/pnpm-lock.yaml') }}
+          restore-keys: |
+            ${{ runner.os }}-playwright-${{ steps.playwright-version.outputs.version }}-
+            ${{ runner.os }}-playwright-
+
+      - name: Install npm dependencies
+        run: |
+          cd npm-package
+          npm install
+
+      - name: Build and install npm package
+        run: |
+          # Build the npm package
+          cd npm-package
+          npm pack
+
+          # Extract it to a temporary location
+          mkdir -p /tmp/npm-package
+          tar -xzf *.tgz -C /tmp/npm-package
+
+          # Update spec/internal to use the extracted package
+          cd ../spec/internal
+          # Remove any existing symlink/folder
+          rm -rf package
+          rm -rf node_modules/@rocket-sensei/activeadmin-tom_select
+          npm install
+
+          # Install from the extracted package
+          npm install /tmp/npm-package/package
+
+          # Build assets (JS and CSS)
+          echo "Building JavaScript assets..."
+          npm run build:js
+
+          echo "Building CSS assets with Tailwind..."
+          bundle exec rake active_admin:build
+
+          # Verify assets were built
+          echo "Checking built assets..."
+          ls -la app/assets/builds/
+
+      - name: Install Playwright browsers
+        if: steps.playwright-cache.outputs.cache-hit != 'true'
+        run: |
+          cd npm-package
+          npx playwright install chromium
+
+      - name: Setup test database
+        run: |
+          # The database tasks may not be available, skip for now
+          echo "Database setup will be handled by test suite"
+
+      - name: Run tests with coverage
+        run: |
+          bundle exec rspec --format progress --format RspecJunitFormatter --out rspec-results.xml
+        continue-on-error: true
+
+      - name: Upload coverage to Codecov
+        if: matrix.ruby == '3.4' && matrix.gemfile == 'rails_7.x_active_admin_4.x'
+        uses: codecov/codecov-action@v5
+        with:
+          file: ./coverage/coverage.json
+          fail_ci_if_error: false
+          token: ${{ secrets.CODECOV_TOKEN }}
+      
+      - name: SonarQube Scan
+        if: matrix.ruby == '3.4' && matrix.gemfile == 'rails_7.x_active_admin_4.x' && github.event_name != 'pull_request'
+        uses: sonarsource/sonarqube-scan-action@v3
+        env:
+          SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
+          SONAR_HOST_URL: ${{ secrets.SONAR_HOST_URL || 'https://sonarcloud.io' }}
+        with:
+          args: >
+            -Dsonar.projectKey=rs-pro_activeadmin-tom_select
+            -Dsonar.ruby.coverage.reportPaths=coverage/coverage.json
+            -Dsonar.ruby.rspec.reportPaths=rspec-results.xml
+        continue-on-error: true
+
+  lint:
+    runs-on: ubuntu-latest
+    
+    steps:
+      - uses: actions/checkout@v5
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: '3.4'
+          bundler-cache: true
+
+      - name: Run RuboCop
+        run: bundle exec rubocop --force-exclusion
+
+  build-npm:
+    runs-on: ubuntu-latest
+    
+    steps:
+      - uses: actions/checkout@v5
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: '22'
+          cache: 'npm'
+          cache-dependency-path: npm-package/package-lock.json
+
+      - name: Install dependencies
+        run: |
+          cd npm-package
+          npm ci
+
+      - name: Check package
+        run: |
+          cd npm-package
+          npm pack --dry-run

data/.github/workflows/npm-publish.yml

@@ -0,0 +1,50 @@
+name: Publish to NPM
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  publish-npm:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      id-token: write
+    
+    steps:
+      - uses: actions/checkout@v5
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: '22'
+          registry-url: 'https://registry.npmjs.org'
+
+      - name: Verify package files
+        run: |
+          cd npm-package
+          echo "Package files to be published:"
+          npm pack --dry-run
+          echo ""
+          echo "Package name: $(npm pkg get name | tr -d '"')"
+          echo "Package version: $(npm pkg get version | tr -d '"')"
+
+      - name: Publish to NPM
+        run: |
+          cd npm-package
+          npm publish --access public
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+
+      - name: Add publish summary
+        run: |
+          echo "### NPM Package Published! 🎉" >> $GITHUB_STEP_SUMMARY
+          echo "" >> $GITHUB_STEP_SUMMARY
+          echo "Package: \`@rocket-sensei/activeadmin-tom_select@$(cd npm-package && npm pkg get version | tr -d '"')\`" >> $GITHUB_STEP_SUMMARY
+          echo "" >> $GITHUB_STEP_SUMMARY
+          echo "Install with:" >> $GITHUB_STEP_SUMMARY
+          echo "\`\`\`bash" >> $GITHUB_STEP_SUMMARY
+          echo "npm install @rocket-sensei/activeadmin-tom_select" >> $GITHUB_STEP_SUMMARY
+          echo "\`\`\`" >> $GITHUB_STEP_SUMMARY
+          echo "" >> $GITHUB_STEP_SUMMARY
+          echo "View on NPM: https://www.npmjs.com/package/@rocket-sensei/activeadmin-tom_select" >> $GITHUB_STEP_SUMMARY

data/.gitignore

@@ -0,0 +1,35 @@
+*.gem
+.bundle
+.ruby-version
+.ruby-gemset
+/pkg/*
+/spec/internal/tmp
+/spec/internal/db/*.sqlite
+/spec/internal/db/*.sqlite-shm
+/spec/internal/db/*.sqlite-wal
+/spec/examples.txt
+/node_modules
+/npm-package/node_modules
+/vendor/bundle
+.cache
+/.cache
+
+# Generated/built files only
+/spec/internal/node_modules/
+/spec/internal/app/assets/builds/
+/spec/internal/public/select2/
+/spec/internal/public/assets/
+/spec/internal/public/assets-test/
+/spec/internal/storage/*
+/spec/internal/log/*
+/public/assets/
+/public/assets-test/
+
+# Debug and temporary files
+/debug_*.rb
+/spec/debug_*.rb
+/*.tgz
+
+# Code coverage reports
+/coverage/
+*.lcov

data/.npmignore

@@ -0,0 +1,58 @@
+# Ruby/Rails files
+*.gemspec
+Gemfile
+Gemfile.lock
+Rakefile
+Appraisals
+.rubocop.yml
+.rubocop.todo.yml
+.ruby-version
+.ruby-gemset
+.rspec
+
+# Ruby source code (not needed for npm package)
+/lib/
+/app/assets/stylesheets/
+
+# Test files
+/spec/
+/test/
+/gemfiles/
+
+# Documentation
+*.md
+LICENSE
+CHANGELOG*
+
+# Development files
+.gitignore
+.actrc
+
+# CI/CD
+.github/
+.travis.yml
+
+# Build artifacts
+/pkg/
+/tmp/
+/log/
+*.gem
+
+# Bundler
+/.bundle/
+/vendor/bundle/
+/vendor/cache/
+
+# Node modules (shouldn't be in package)
+/node_modules/
+
+# Editor files
+.idea/
+.vscode/
+*.swp
+*.swo
+*~
+.DS_Store
+
+# Keep only the built JavaScript and CSS files
+!src/

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,75 @@
+inherit_mode:
+  merge:
+    - Exclude
+
+AllCops:
+  TargetRubyVersion: 3.0
+  NewCops: enable
+  SuggestExtensions: false
+  Exclude:
+    - 'bin/**/*'
+    - 'vendor/**/*'
+    - 'gemfiles/vendor/**/*'
+    - '**/vendor/**/*'
+    - 'spec/internal/bin/**/*'
+    - 'spec/internal/Gemfile'
+    - 'gemfiles/**/*.gemfile'
+    - 'gemfiles/**/*.gemfile.lock'
+
+# The default of 80 characters is a little to narrow.
+Layout/LineLength:
+  Max: 100
+
+# Do not warn about missing magic comment
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+# Disable block length checks for spec files
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*'
+    - 'spec/internal/db/schema.rb'
+    - '*.gemspec'
+
+# Allow empty blocks in specs (for ActiveAdmin.setup {})
+Lint/EmptyBlock:
+  Exclude:
+    - 'spec/**/*'
+
+# Naming exception for gem main file
+Naming/FileName:
+  Exclude:
+    - 'lib/activeadmin-tom_select.rb'
+
+# Allow development dependencies in gemspec
+Gemspec/DevelopmentDependencies:
+  Enabled: false
+
+# Allow Ruby version mismatch (we support multiple versions)
+Gemspec/RequiredRubyVersion:
+  Enabled: false
+
+# Allow longer classes for generators
+Metrics/ClassLength:
+  Exclude:
+    - 'lib/generators/**/*'
+
+# Allow longer methods for generators
+Metrics/MethodLength:
+  Exclude:
+    - 'lib/generators/**/*'
+
+# Allow slightly longer modules for input extensions
+Metrics/ModuleLength:
+  Max: 110
+
+# Allow complex methods for generators
+Metrics/AbcSize:
+  Exclude:
+    - 'lib/generators/**/*'
+
+# Documentation not required for generators and test support files
+Style/Documentation:
+  Exclude:
+    - 'lib/generators/**/*'
+    - 'spec/**/*'

data/.yardopts

@@ -0,0 +1,2 @@
+--no-private
+--markup markdown

data/AGENTS.md

@@ -0,0 +1,39 @@
+# Repository Guidelines
+
+## Project Structure & Module Organization
+- `lib/`: Ruby engine, extensions, and DSL under `ActiveAdmin::SearchableSelect`.
+- `app/assets/`: Legacy Sprockets JS/CSS entry points for ActiveAdmin.
+- `src/`: ESM sources for the npm package (`searchable_select.js/.scss`).
+- `vendor/assets/javascripts/`: Importmap-friendly JS build.
+- `spec/`: RSpec suite with Combustion Rails app under `spec/internal`; feature specs in `spec/features/**`.
+- `docs/`: Setup and integration guides.
+
+## Build, Test, and Development Commands
+- `bundle && bundle exec rspec`: Install gems and run the test suite.
+- `appraisal install && appraisal rspec`: Run the Rails/ActiveAdmin matrix (see `Appraisals`).
+- `bundle exec rubocop --force-exclusion`: Lint Ruby code per `.rubocop.yml`.
+- `npm ci && npm run prepublishOnly`: Build npm artifacts from `app/assets` into `src/`.
+- `npx playwright install chromium`: One-time browser install for JS feature specs.
+- `rake build` / `rake release`: Build/release the gem via Bundler tasks.
+- Example (headed browser): `HEADLESS=false bundle exec rspec`.
+
+## Coding Style & Naming Conventions
+- Ruby: 2-space indent, TargetRuby 3.0, max line length 100; follow RuboCop rules.
+- Names: Ruby files in `lib/activeadmin/searchable_select/` use snake_case; modules under `ActiveAdmin::SearchableSelect`.
+- JS: ESM modules in `src/`; keep imports explicit. Avoid global jQuery except for ActiveAdmin integration.
+
+## Testing Guidelines
+- Framework: RSpec. Feature/system specs use Capybara with Playwright; unit/integration via Combustion.
+- Layout: Place UI/Select2 specs under `spec/features/**` and tag `type: :feature, js: true`.
+- Run: `bundle exec rspec` locally; use `appraisal rspec` to validate matrices before PRs.
+- Browser: Install once with `npx playwright install chromium`. Use `HEADLESS=false` to visualize.
+
+## Commit & Pull Request Guidelines
+- Commits: Imperative, concise messages (e.g., "Fix Select2 init on esbuild"). Group related changes.
+- PRs: Provide clear description, rationale, linked issues; add screenshots/GIFs for UI changes. Update `README.md`/`docs/` and `CHANGELOG.md` for behavior changes.
+- Quality gate: Ensure `rspec` and `rubocop` pass; for npm-facing changes, run `npm run prepublishOnly` to verify `src/` packaging.
+
+## JS Integration Notes
+- Bundlers (esbuild/webpack): `import 'jquery'` and `import 'select2'`, then call `select2($)` and ensure `window.$ = window.jQuery = $` before importing this package.
+- Importmap: Use `vendor/assets/javascripts/activeadmin-searchable_select.js`.
+

data/Appraisals

@@ -0,0 +1,9 @@
+appraise 'rails-7.x-active-admin-4.x' do
+  gem 'rails', '~> 7.1'
+  gem 'activeadmin', '4.0.0.beta16'
+end
+
+appraise 'rails-8.x-active-admin-4.x' do
+  gem 'rails', '~> 8.0'
+  gem 'activeadmin', '4.0.0.beta16'
+end