rs-activeadmin-searchable_select 4.0.5

data/lib/activeadmin/searchable_select/select_input_extension.rb

@@ -0,0 +1,159 @@
+module ActiveAdmin
+  module SearchableSelect
+    # Mixin for searchable select inputs.
+    #
+    # Supports the same options as inputs of type `:select`.
+    #
+    # Adds support for an `ajax` option to fetch options data from a
+    # JSON endpoint. Pass either `true` to use defaults or a hash
+    # containing some of the following options:
+    #
+    # - `resource`: ActiveRecord model class of ActiveAdmin resource
+    #    which provides the collection action to fetch options
+    #    from. By default the resource is auto detected via the name
+    #    of the input attribute.
+    #
+    # - `collection_name`: Name passed to the
+    #   `searchable_select_options` method that defines the collection
+    #   action to fetch options from.
+    #
+    # - `params`: Hash of query parameters that shall be passed to the
+    #   options endpoint.
+    #
+    # - `path_params`: Hash of parameters, which would be passed to the
+    #   dynamic collection path generation for the resource.
+    #   e.g `admin_articles_path(path_params)`
+    #
+    # If the `ajax` option is present, the `collection` option is
+    # ignored.
+    module SelectInputExtension
+      # @api private
+      def to_html
+        super
+      rescue RuntimeError => e
+        # In development/test, display the error message
+        raise e unless Rails.env.development? || Rails.env.test?
+
+        template.content_tag(:div, e.message, class: 'searchable-select-error')
+      end
+
+      # @api private
+      def input_html_options
+        super.tap do |options|
+          options[:class] = [options[:class], 'searchable-select-input'].compact.join(' ')
+          options['data-ajax-url'] = ajax_url if ajax? && !SearchableSelect.inline_ajax_options
+        end
+      end
+
+      # @api private
+      def collection_from_options
+        return super unless options[:ajax]
+
+        if SearchableSelect.inline_ajax_options
+          all_options_collection
+        else
+          selected_value_collection
+        end
+      end
+
+      private
+
+      def ajax?
+        options[:ajax].present?
+      end
+
+      def ajax_url
+        return unless options[:ajax]
+
+        [ajax_resource.route_collection_path(path_params),
+         '/',
+         option_collection.collection_action_name,
+         '?',
+         ajax_params.to_query].join
+      end
+
+      def all_options_collection
+        option_collection_scope.all.map do |record|
+          option_for_record(record)
+        end
+      end
+
+      def selected_value_collection
+        selected_records.collect { |s| option_for_record(s) }
+      end
+
+      def option_for_record(record)
+        [option_collection.display_text(record), record.id]
+      end
+
+      def selected_records
+        @selected_records ||=
+          if selected_values
+            option_collection_scope.where(id: selected_values)
+          else
+            []
+          end
+      end
+
+      def selected_values
+        @object&.send(input_name)
+      end
+
+      def option_collection_scope
+        option_collection.scope(template, path_params.merge(ajax_params))
+      end
+
+      def option_collection
+        ajax_resource
+          .searchable_select_option_collections
+          .fetch(ajax_option_collection_name) do
+          raise("No option collection named '#{ajax_option_collection_name}' " \
+                "defined in '#{ajax_resource_class.name}' admin.")
+        end
+      end
+
+      def ajax_resource
+        @ajax_resource ||=
+          template.active_admin_namespace.resource_for(ajax_resource_class) ||
+          raise("No admin found for '#{ajax_resource_class.name}' to fetch " \
+                'options for searchable select input from.')
+      end
+
+      def ajax_resource_class
+        ajax_options.fetch(:resource) do
+          raise_cannot_auto_detect_resource unless reflection
+          reflection.klass
+        end
+      end
+
+      def raise_cannot_auto_detect_resource
+        raise('Cannot auto detect resource to fetch options for searchable select input from. ' \
+              "Explicitly pass class of an ActiveAdmin resource:\n\n  " \
+              "f.input(:custom_category,\n          " \
+              "type: :searchable_select,\n          " \
+              "ajax: {\n            " \
+              "resource: Category\n          " \
+              "})\n")
+      end
+
+      def ajax_option_collection_name
+        ajax_options.fetch(:collection_name, :all)
+      end
+
+      def ajax_params
+        ajax_options.fetch(:params, {})
+      end
+
+      def path_params
+        ajax_options.fetch(:path_params, {})
+      end
+
+      def ajax_options
+        # ActiveAdmin 4 may transform ajax hash to boolean
+        return {} if options[:ajax] == true || options[:ajax].nil?
+
+        options[:ajax]
+      end
+    end
+  end
+end

data/lib/activeadmin/searchable_select/version.rb

@@ -0,0 +1,5 @@
+module ActiveAdmin
+  module SearchableSelect
+    VERSION = '4.0.5'.freeze
+  end
+end

data/lib/activeadmin/searchable_select.rb

@@ -0,0 +1,20 @@
+require 'activeadmin/searchable_select/engine'
+require 'activeadmin/searchable_select/option_collection'
+require 'activeadmin/searchable_select/resource_extension'
+require 'activeadmin/searchable_select/resource_dsl_extension'
+require 'activeadmin/searchable_select/select_input_extension'
+require 'activeadmin/searchable_select/version'
+
+ActiveAdmin::Resource.include ActiveAdmin::SearchableSelect::ResourceExtension
+ActiveAdmin::ResourceDSL.include ActiveAdmin::SearchableSelect::ResourceDSLExtension
+
+module ActiveAdmin
+  # Global settings for searchable selects
+  module SearchableSelect
+    # Statically render all options into searchable selects with
+    # `ajax` option set to true. This can be used to ease ui driven
+    # integration testing.
+    mattr_accessor :inline_ajax_options
+    self.inline_ajax_options = false
+  end
+end

data/lib/activeadmin-searchable_select.rb

@@ -0,0 +1,4 @@
+require 'activeadmin/searchable_select'
+
+require 'activeadmin/inputs/filters/searchable_select_input'
+require 'activeadmin/inputs/searchable_select_input'

data/lib/generators/active_admin/searchable_select/install/install_generator.rb

@@ -0,0 +1,217 @@
+require 'rails/generators'
+
+module ActiveAdmin
+  module SearchableSelect
+    module Generators
+      class InstallGenerator < Rails::Generators::Base
+        source_root File.expand_path('templates', __dir__)
+
+        desc 'Installs ActiveAdmin Searchable Select for ActiveAdmin 4.x'
+
+        class_option :bundler,
+                     type: :string,
+                     default: 'esbuild',
+                     desc: 'JavaScript bundler to use (esbuild, importmap, webpack)',
+                     enum: %w[esbuild importmap webpack]
+
+        def install_npm_package
+          return unless options[:bundler] != 'importmap'
+
+          say 'Installing @codevise/activeadmin-searchable_select npm package...', :green
+          run 'npm install @codevise/activeadmin-searchable_select jquery select2'
+        end
+
+        def setup_javascript
+          case options[:bundler]
+          when 'esbuild'
+            setup_esbuild
+          when 'importmap'
+            setup_importmap
+          when 'webpack'
+            setup_webpack
+          end
+        end
+
+        def setup_stylesheets
+          if File.exist?('app/assets/stylesheets/active_admin.css')
+            say 'Adding Select2 styles to active_admin.css...', :green
+            prepend_to_file 'app/assets/stylesheets/active_admin.css' do
+              <<~CSS
+                @import url('https://cdn.jsdelivr.net/npm/select2@4.1.0-rc.0/dist/css/select2.min.css');
+
+              CSS
+            end
+          elsif File.exist?('app/assets/stylesheets/active_admin.scss')
+            say 'Adding Select2 styles to active_admin.scss...', :green
+            prepend_to_file 'app/assets/stylesheets/active_admin.scss' do
+              <<~SCSS
+                @import url('https://cdn.jsdelivr.net/npm/select2@4.1.0-rc.0/dist/css/select2.min.css');
+
+              SCSS
+            end
+          else
+            say 'Please manually add Select2 styles to your ActiveAdmin stylesheet', :yellow
+          end
+        end
+
+        def show_post_install_message
+          say "\n✅ ActiveAdmin Searchable Select has been installed!", :green
+
+          case options[:bundler]
+          when 'esbuild'
+            say "\nMake sure to rebuild your JavaScript:", :yellow
+            say '  npm run build', :cyan
+            say "\nFor development with watch mode:", :yellow
+            say '  npm run build -- --watch', :cyan
+          when 'importmap'
+            say "\nRestart your Rails server to load the new pins.", :yellow
+          when 'webpack'
+            say "\nRecompile your webpack bundles:", :yellow
+            say '  bin/webpack', :cyan
+          end
+
+          say "\n📚 Usage example:", :green
+          say <<~RUBY
+
+            # In your ActiveAdmin resource:
+            ActiveAdmin.register User do
+              searchable_select_options(
+                scope: User.all,
+                text_attribute: :name
+              )
+            end
+
+            ActiveAdmin.register Post do
+              form do |f|
+                f.inputs do
+                  f.input :user, as: :searchable_select, ajax: true
+                end
+                f.actions
+              end
+            end
+          RUBY
+        end
+
+        PACKAGE_JSON_FILE = 'package.json'.freeze
+
+        private
+
+        def setup_esbuild
+          say 'Setting up for esbuild...', :green
+
+          # Check if app/javascript/active_admin.js exists
+          js_file = 'app/javascript/active_admin.js'
+
+          if File.exist?(js_file)
+            say "Adding searchable_select to #{js_file}...", :green
+            append_to_file js_file do
+              <<~JS
+
+                // ActiveAdmin Searchable Select
+                import '@codevise/activeadmin-searchable_select';
+              JS
+            end
+          else
+            say "Creating #{js_file}...", :green
+            create_file js_file do
+              <<~JS
+                import "@activeadmin/activeadmin";
+
+                // ActiveAdmin Searchable Select#{'  '}
+                import $ from 'jquery';
+                import select2 from 'select2';
+
+                // Critical: Initialize select2 on jQuery for production builds
+                select2($);
+
+                // Ensure jQuery is globally available
+                window.$ = window.jQuery = $;
+
+                // Import the searchable select functionality
+                import '@codevise/activeadmin-searchable_select';
+              JS
+            end
+          end
+
+          # Update package.json scripts if needed
+          return unless File.exist?(PACKAGE_JSON_FILE)
+
+          package_json = JSON.parse(File.read(PACKAGE_JSON_FILE))
+
+          return if package_json['scripts'] && package_json['scripts']['build']
+
+          say 'Adding build script to package.json...', :green
+          package_json['scripts'] ||= {}
+          package_json['scripts']['build'] =
+            'esbuild app/javascript/*.* --bundle --sourcemap --format=esm ' \
+            '--outdir=app/assets/builds --public-path=/assets'
+
+          File.write(PACKAGE_JSON_FILE, JSON.pretty_generate(package_json))
+        end
+
+        def setup_importmap
+          say 'Setting up for importmap...', :green
+
+          # Add pins to importmap.rb
+          if File.exist?('config/importmap.rb')
+            say 'Adding pins to config/importmap.rb...', :green
+            append_to_file 'config/importmap.rb' do
+              <<~RUBY
+
+                # ActiveAdmin Searchable Select
+                pin "jquery", to: "https://cdn.jsdelivr.net/npm/jquery@3.7.1/dist/jquery.min.js"
+                pin "select2", to: "https://cdn.jsdelivr.net/npm/select2@4.1.0-rc.0/dist/js/select2.min.js"
+                pin "activeadmin-searchable_select", to: "activeadmin-searchable_select.js"
+              RUBY
+            end
+          end
+
+          # Copy the vendor JavaScript file
+          say 'Copying vendor JavaScript file...', :green
+          copy_file '../../../../vendor/assets/javascripts/activeadmin-searchable_select.js',
+                    'app/assets/javascripts/activeadmin-searchable_select.js'
+
+          # Update application.js
+          js_file = 'app/javascript/application.js'
+          return unless File.exist?(js_file)
+
+          say "Adding imports to #{js_file}...", :green
+          append_to_file js_file do
+            <<~JS
+
+              // ActiveAdmin Searchable Select
+              import "jquery"
+              import "select2"
+              import "activeadmin-searchable_select"
+            JS
+          end
+        end
+
+        def setup_webpack
+          say 'Setting up for webpack...', :green
+
+          js_file = 'app/javascript/packs/active_admin.js'
+
+          if File.exist?(js_file)
+            say "Adding searchable_select to #{js_file}...", :green
+            append_to_file js_file do
+              <<~JS
+
+                // ActiveAdmin Searchable Select
+                import $ from 'jquery';
+                import select2 from 'select2';
+                select2($);
+                window.$ = window.jQuery = $;
+
+                import '@codevise/activeadmin-searchable_select';
+              JS
+            end
+          else
+            say 'Please manually add the searchable_select import ' \
+                'to your ActiveAdmin JavaScript pack', :yellow
+          end
+        end
+      end
+    end
+  end
+end

data/package-lock.json

@@ -0,0 +1,18 @@
+{
+  "name": "@codevise/activeadmin-searchable_select",
+  "version": "4.0.2",
+  "lockfileVersion": 1,
+  "requires": true,
+  "dependencies": {
+    "jquery": {
+      "version": "3.7.0",
+      "resolved": "https://registry.npmjs.org/jquery/-/jquery-3.7.0.tgz",
+      "integrity": "sha512-umpJ0/k8X0MvD1ds0P9SfowREz2LenHsQaxSohMZ5OMNEU2r0tf8pdeEFTHMFxWVxKNyU9rTtK3CWzUCTKJUeQ=="
+    },
+    "select2": {
+      "version": "4.0.13",
+      "resolved": "https://registry.npmjs.org/select2/-/select2-4.0.13.tgz",
+      "integrity": "sha512-1JeB87s6oN/TDxQQYCvS5EFoQyvV6eYMZZ0AeA4tdFDYWN3BAGZ8npr17UBFddU0lgAt3H0yjX3X6/ekOj1yjw=="
+    }
+  }
+}

data/package.json

@@ -0,0 +1,45 @@
+{
+  "name": "@rocket-sensei/activeadmin-searchable_select",
+  "version": "4.0.5",
+  "description": "Use searchable selects based on Select2 in Active Admin forms and filters.",
+  "main": "src/index.js",
+  "module": "src/index.js",
+  "style": "src/searchable_select.scss",
+  "exports": {
+    ".": {
+      "import": "./src/index.js",
+      "require": "./src/index.js",
+      "default": "./src/index.js"
+    },
+    "./css": "./src/searchable_select.css",
+    "./style": "./src/searchable_select.css",
+    "./scss": "./src/searchable_select.scss"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/glebtv/activeadmin-searchable_select.git"
+  },
+  "author": "Codevise Solutions Ltd <info@codevise.de>",
+  "license": "MIT",
+  "private": false,
+  "bugs": {
+    "url": "https://github.com/glebtv/activeadmin-searchable_select/issues"
+  },
+  "homepage": "https://github.com/glebtv/activeadmin-searchable_select#readme",
+  "keywords": [
+    "select2",
+    "active",
+    "admin",
+    "searchable",
+    "select",
+    "activeadmin",
+    "rails"
+  ],
+  "peerDependencies": {
+    "jquery": ">= 3.0, < 5",
+    "select2": "^4.0.0 || ^4.1.0-rc.0"
+  },
+  "files": [
+    "src/**/*"
+  ]
+}

data/rs-activeadmin-searchable_select.gemspec

@@ -0,0 +1,38 @@
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'activeadmin/searchable_select/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'rs-activeadmin-searchable_select'
+  spec.version       = ActiveAdmin::SearchableSelect::VERSION
+  spec.summary       = 'Use searchable selects based on Select2 in Active Admin forms and filters.'
+  spec.license       = 'MIT'
+  spec.authors       = ['Rocket Sensei']
+  spec.email         = 'glebtv@gmail.com'
+  spec.homepage      = 'https://github.com/glebtv/activeadmin-searchable_select'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.require_paths = ['lib']
+
+  spec.required_ruby_version = ['>= 2.1', '< 4']
+
+  spec.add_development_dependency 'appraisal', '~> 2.2'
+  spec.add_development_dependency 'bundler', ['>= 1.5', '< 3']
+  spec.add_development_dependency 'combustion', '~> 1.5'
+  spec.add_development_dependency 'database_cleaner-active_record', '~> 2.1'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec-rails', '~> 6.0'
+  spec.add_development_dependency 'sqlite3', '~> 2.1'
+
+  spec.add_development_dependency 'capybara', '~> 3.39'
+  spec.add_development_dependency 'capybara-playwright-driver', '~> 0.5'
+  spec.add_development_dependency 'puma', '~> 6.0'
+
+  spec.add_development_dependency 'propshaft'
+  spec.add_development_dependency 'rails'
+  spec.add_development_dependency 'rubocop', '~> 1.50.0'
+  spec.add_development_dependency 'semmy', '~> 1.0'
+
+  spec.add_dependency 'activeadmin', '~> 4.0.0.beta'
+  spec.metadata['rubygems_mfa_required'] = 'true'
+end

data/sonar-project.properties

@@ -0,0 +1,25 @@
+# SonarQube project configuration
+sonar.projectKey=glebtv_activeadmin-searchable_select
+sonar.projectName=activeadmin-searchable_select
+sonar.projectVersion=0.5.0
+
+# Source code directories
+sonar.sources=lib,app
+sonar.tests=spec
+
+# Language
+sonar.language=ruby
+
+# Encoding
+sonar.sourceEncoding=UTF-8
+
+# Ruby specific settings
+sonar.ruby.file.suffixes=.rb,.rake
+sonar.ruby.coverage.reportPaths=coverage/coverage.xml
+
+# Exclusions
+sonar.exclusions=spec/**/*,vendor/**/*,coverage/**/*,tmp/**/*,*.gemspec,gemfiles/**/*,Appraisals
+sonar.test.exclusions=spec/internal/app/assets/builds/**/*,spec/internal/public/**/*,spec/internal/node_modules/**/*
+
+# Coverage exclusions (files that don't need coverage)
+sonar.coverage.exclusions=spec/**/*,vendor/**/*,spec/internal/**/*,**/*_spec.rb

data/spec/features/ajax_params_spec.rb

@@ -0,0 +1,31 @@
+require 'rails_helper'
+
+require 'support/models'
+require 'support/capybara'
+
+RSpec.describe 'ajax params', type: :request do
+  # Using static TestAjaxParamsPost and TestAjaxParamsCategory admins
+
+  it 'passes parameters when rendering selected item' do
+    user = User.create
+    category = Category.create(name: 'Travel', created_by: user)
+    post = Post.create(category: category)
+
+    ApplicationController.current_user = user
+    get "/admin/test_ajax_params_posts/#{post.id}/edit"
+
+    expect(response.body).to have_selector('.searchable-select-input option[selected]',
+                                           text: 'Travel')
+  end
+
+  it 'includes parameters in ajax url' do
+    user = User.create
+
+    ApplicationController.current_user = user
+    get '/admin/test_ajax_params_posts/new'
+
+    url_matcher = "?created_by=#{user.id}"
+    expect(response.body).to have_selector('.searchable-select-input' \
+                                           "[data-ajax-url*='#{url_matcher}']")
+  end
+end