rs-activeadmin-searchable_select 4.0.5

data/gemfiles/rails_8.x_active_admin_4.x.gemfile.lock

@@ -0,0 +1,366 @@
+PATH
+  remote: ..
+  specs:
+    rs-activeadmin-searchable_select (4.0.5)
+      activeadmin (~> 4.0.0.beta)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actioncable (8.0.2.1)
+      actionpack (= 8.0.2.1)
+      activesupport (= 8.0.2.1)
+      nio4r (~> 2.0)
+      websocket-driver (>= 0.6.1)
+      zeitwerk (~> 2.6)
+    actionmailbox (8.0.2.1)
+      actionpack (= 8.0.2.1)
+      activejob (= 8.0.2.1)
+      activerecord (= 8.0.2.1)
+      activestorage (= 8.0.2.1)
+      activesupport (= 8.0.2.1)
+      mail (>= 2.8.0)
+    actionmailer (8.0.2.1)
+      actionpack (= 8.0.2.1)
+      actionview (= 8.0.2.1)
+      activejob (= 8.0.2.1)
+      activesupport (= 8.0.2.1)
+      mail (>= 2.8.0)
+      rails-dom-testing (~> 2.2)
+    actionpack (8.0.2.1)
+      actionview (= 8.0.2.1)
+      activesupport (= 8.0.2.1)
+      nokogiri (>= 1.8.5)
+      rack (>= 2.2.4)
+      rack-session (>= 1.0.1)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.2)
+      rails-html-sanitizer (~> 1.6)
+      useragent (~> 0.16)
+    actiontext (8.0.2.1)
+      actionpack (= 8.0.2.1)
+      activerecord (= 8.0.2.1)
+      activestorage (= 8.0.2.1)
+      activesupport (= 8.0.2.1)
+      globalid (>= 0.6.0)
+      nokogiri (>= 1.8.5)
+    actionview (8.0.2.1)
+      activesupport (= 8.0.2.1)
+      builder (~> 3.1)
+      erubi (~> 1.11)
+      rails-dom-testing (~> 2.2)
+      rails-html-sanitizer (~> 1.6)
+    activeadmin (4.0.0.beta16)
+      arbre (~> 2.0)
+      csv
+      formtastic (>= 5.0)
+      formtastic_i18n (>= 0.7)
+      inherited_resources (~> 2.0)
+      kaminari (>= 1.2.1)
+      railties (>= 7.0)
+      ransack (>= 4.0)
+    activejob (8.0.2.1)
+      activesupport (= 8.0.2.1)
+      globalid (>= 0.3.6)
+    activemodel (8.0.2.1)
+      activesupport (= 8.0.2.1)
+    activerecord (8.0.2.1)
+      activemodel (= 8.0.2.1)
+      activesupport (= 8.0.2.1)
+      timeout (>= 0.4.0)
+    activestorage (8.0.2.1)
+      actionpack (= 8.0.2.1)
+      activejob (= 8.0.2.1)
+      activerecord (= 8.0.2.1)
+      activesupport (= 8.0.2.1)
+      marcel (~> 1.0)
+    activesupport (8.0.2.1)
+      base64
+      benchmark (>= 0.3)
+      bigdecimal
+      concurrent-ruby (~> 1.0, >= 1.3.1)
+      connection_pool (>= 2.2.5)
+      drb
+      i18n (>= 1.6, < 2)
+      logger (>= 1.4.2)
+      minitest (>= 5.1)
+      securerandom (>= 0.3)
+      tzinfo (~> 2.0, >= 2.0.5)
+      uri (>= 0.13.1)
+    addressable (2.8.7)
+      public_suffix (>= 2.0.2, < 7.0)
+    appraisal (2.5.0)
+      bundler
+      rake
+      thor (>= 0.14.0)
+    arbre (2.2.0)
+      activesupport (>= 7.0)
+    ast (2.4.3)
+    base64 (0.3.0)
+    benchmark (0.4.1)
+    bigdecimal (3.2.3)
+    builder (3.3.0)
+    capybara (3.40.0)
+      addressable
+      matrix
+      mini_mime (>= 0.1.3)
+      nokogiri (~> 1.11)
+      rack (>= 1.6.0)
+      rack-test (>= 0.6.3)
+      regexp_parser (>= 1.5, < 3.0)
+      xpath (~> 3.2)
+    capybara-playwright-driver (0.5.7)
+      addressable
+      capybara
+      playwright-ruby-client (>= 1.16.0)
+    combustion (1.5.0)
+      activesupport (>= 3.0.0)
+      railties (>= 3.0.0)
+      thor (>= 0.14.6)
+    concurrent-ruby (1.3.5)
+    connection_pool (2.5.4)
+    crass (1.0.6)
+    csv (3.3.5)
+    database_cleaner-active_record (2.2.2)
+      activerecord (>= 5.a)
+      database_cleaner-core (~> 2.0)
+    database_cleaner-core (2.0.1)
+    date (3.4.1)
+    diff-lcs (1.6.2)
+    docile (1.4.1)
+    drb (2.2.3)
+    erb (5.0.2)
+    erubi (1.13.1)
+    formtastic (5.0.0)
+      actionpack (>= 6.0.0)
+    formtastic_i18n (0.7.0)
+    git (1.19.1)
+      addressable (~> 2.8)
+      rchardet (~> 1.8)
+    globalid (1.2.1)
+      activesupport (>= 6.1)
+    has_scope (0.8.2)
+      actionpack (>= 5.2)
+      activesupport (>= 5.2)
+    i18n (1.14.7)
+      concurrent-ruby (~> 1.0)
+    inherited_resources (2.1.0)
+      actionpack (>= 7.0)
+      has_scope (>= 0.6)
+      railties (>= 7.0)
+      responders (>= 2)
+    io-console (0.8.1)
+    irb (1.15.2)
+      pp (>= 0.6.0)
+      rdoc (>= 4.0.0)
+      reline (>= 0.4.2)
+    json (2.13.2)
+    kaminari (1.2.2)
+      activesupport (>= 4.1.0)
+      kaminari-actionview (= 1.2.2)
+      kaminari-activerecord (= 1.2.2)
+      kaminari-core (= 1.2.2)
+    kaminari-actionview (1.2.2)
+      actionview
+      kaminari-core (= 1.2.2)
+    kaminari-activerecord (1.2.2)
+      activerecord
+      kaminari-core (= 1.2.2)
+    kaminari-core (1.2.2)
+    logger (1.7.0)
+    loofah (2.24.1)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.12.0)
+    mail (2.8.1)
+      mini_mime (>= 0.1.1)
+      net-imap
+      net-pop
+      net-smtp
+    marcel (1.0.4)
+    matrix (0.4.3)
+    mime-types (3.7.0)
+      logger
+      mime-types-data (~> 3.2025, >= 3.2025.0507)
+    mime-types-data (3.2025.0902)
+    mini_mime (1.1.5)
+    minitest (5.25.5)
+    net-imap (0.5.10)
+      date
+      net-protocol
+    net-pop (0.1.2)
+      net-protocol
+    net-protocol (0.2.2)
+      timeout
+    net-smtp (0.5.1)
+      net-protocol
+    nio4r (2.7.4)
+    nokogiri (1.18.9-x86_64-linux-gnu)
+      racc (~> 1.4)
+    parallel (1.27.0)
+    parser (3.3.9.0)
+      ast (~> 2.4.1)
+      racc
+    playwright-ruby-client (1.55.0)
+      concurrent-ruby (>= 1.1.6)
+      mime-types (>= 3.0)
+    pp (0.6.2)
+      prettyprint
+    prettyprint (0.2.0)
+    prism (1.4.0)
+    propshaft (1.2.1)
+      actionpack (>= 7.0.0)
+      activesupport (>= 7.0.0)
+      rack
+    psych (5.2.6)
+      date
+      stringio
+    public_suffix (6.0.2)
+    puma (6.6.1)
+      nio4r (~> 2.0)
+    racc (1.8.1)
+    rack (3.2.1)
+    rack-session (2.1.1)
+      base64 (>= 0.1.0)
+      rack (>= 3.0.0)
+    rack-test (2.2.0)
+      rack (>= 1.3)
+    rackup (2.2.1)
+      rack (>= 3)
+    rails (8.0.2.1)
+      actioncable (= 8.0.2.1)
+      actionmailbox (= 8.0.2.1)
+      actionmailer (= 8.0.2.1)
+      actionpack (= 8.0.2.1)
+      actiontext (= 8.0.2.1)
+      actionview (= 8.0.2.1)
+      activejob (= 8.0.2.1)
+      activemodel (= 8.0.2.1)
+      activerecord (= 8.0.2.1)
+      activestorage (= 8.0.2.1)
+      activesupport (= 8.0.2.1)
+      bundler (>= 1.15.0)
+      railties (= 8.0.2.1)
+    rails-dom-testing (2.3.0)
+      activesupport (>= 5.0.0)
+      minitest
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.6.2)
+      loofah (~> 2.21)
+      nokogiri (>= 1.15.7, != 1.16.7, != 1.16.6, != 1.16.5, != 1.16.4, != 1.16.3, != 1.16.2, != 1.16.1, != 1.16.0.rc1, != 1.16.0)
+    railties (8.0.2.1)
+      actionpack (= 8.0.2.1)
+      activesupport (= 8.0.2.1)
+      irb (~> 1.13)
+      rackup (>= 1.0.0)
+      rake (>= 12.2)
+      thor (~> 1.0, >= 1.2.2)
+      zeitwerk (~> 2.6)
+    rainbow (2.2.2)
+      rake
+    rake (13.3.0)
+    ransack (4.3.0)
+      activerecord (>= 6.1.5)
+      activesupport (>= 6.1.5)
+      i18n
+    rchardet (1.9.0)
+    rdoc (6.14.2)
+      erb
+      psych (>= 4.0.0)
+    regexp_parser (2.11.2)
+    reline (0.6.2)
+      io-console (~> 0.5)
+    responders (3.1.1)
+      actionpack (>= 5.2)
+      railties (>= 5.2)
+    rexml (3.4.2)
+    rspec-core (3.13.5)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.5)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.5)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-rails (6.1.5)
+      actionpack (>= 6.1)
+      activesupport (>= 6.1)
+      railties (>= 6.1)
+      rspec-core (~> 3.13)
+      rspec-expectations (~> 3.13)
+      rspec-mocks (~> 3.13)
+      rspec-support (~> 3.13)
+    rspec-support (3.13.5)
+    rspec_junit_formatter (0.6.0)
+      rspec-core (>= 2, < 4, != 2.12.0)
+    rubocop (1.50.2)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.2.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.28.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.46.0)
+      parser (>= 3.3.7.2)
+      prism (~> 1.4)
+    ruby-progressbar (1.13.0)
+    securerandom (0.4.1)
+    semmy (1.2.0)
+      git (~> 1.3)
+      rainbow (~> 2.1)
+      unindent (~> 1.0)
+    simplecov (0.22.0)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-cobertura (3.1.0)
+      rexml
+      simplecov (~> 0.19)
+    simplecov-html (0.13.2)
+    simplecov_json_formatter (0.1.4)
+    sqlite3 (2.7.3-x86_64-linux-gnu)
+    stringio (3.1.7)
+    thor (1.4.0)
+    timeout (0.4.3)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.6.0)
+    unindent (1.0)
+    uri (1.0.3)
+    useragent (0.16.11)
+    websocket-driver (0.8.0)
+      base64
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.5)
+    xpath (3.2.0)
+      nokogiri (~> 1.8)
+    zeitwerk (2.7.3)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  activeadmin (= 4.0.0.beta16)
+  appraisal (~> 2.2)
+  bundler (>= 1.5, < 3)
+  capybara (~> 3.39)
+  capybara-playwright-driver (~> 0.5)
+  combustion (~> 1.5)
+  database_cleaner-active_record (~> 2.1)
+  propshaft
+  puma (~> 6.0)
+  rails (~> 8.0)
+  rake
+  rs-activeadmin-searchable_select!
+  rspec-rails (~> 6.0)
+  rspec_junit_formatter
+  rubocop (~> 1.50.0)
+  semmy (~> 1.0)
+  simplecov
+  simplecov-cobertura
+  sqlite3 (~> 2.1)
+
+BUNDLED WITH
+   2.4.10

data/lefthook.yml

@@ -0,0 +1,17 @@
+# Lefthook configuration
+# https://github.com/evilmartians/lefthook
+
+pre-commit:
+  parallel: true
+  commands:
+    rubocop:
+      tags: style ruby
+      glob: "*.{rb,rake}"
+      run: bundle exec rubocop --force-exclusion {staged_files}
+    
+pre-push:
+  parallel: true
+  commands:
+    rspec:
+      tags: test ruby
+      run: bundle exec rspec --format progress

data/lib/activeadmin/inputs/filters/searchable_select_input.rb

@@ -0,0 +1,13 @@
+module ActiveAdmin
+  module Inputs
+    module Filters
+      # Searchable select input type for ActiveAdmin filters.
+      #
+      # @see ActiveAdmin::SearchableSelect::SelectInputExtension
+      #   SelectInputExtension for list of available options.
+      class SearchableSelectInput < SelectInput
+        include ActiveAdmin::SearchableSelect::SelectInputExtension
+      end
+    end
+  end
+end

data/lib/activeadmin/inputs/searchable_select_input.rb

@@ -0,0 +1,11 @@
+module ActiveAdmin
+  module Inputs
+    # Searchable select input type for ActiveAdmin filters.
+    #
+    # @see ActiveAdmin::SearchableSelect::SelectInputExtension
+    #   SelectInputExtension for list of available options.
+    class SearchableSelectInput < Formtastic::Inputs::SelectInput
+      include ActiveAdmin::SearchableSelect::SelectInputExtension
+    end
+  end
+end

data/lib/activeadmin/searchable_select/engine.rb

@@ -0,0 +1,17 @@
+require 'active_admin'
+
+module ActiveAdmin
+  module SearchableSelect
+    # @api private
+    class Engine < ::Rails::Engine
+      engine_name 'activeadmin_searchable_select'
+
+      initializer 'activeadmin_searchable_select.setup' do
+        ActiveSupport.on_load(:active_admin) do
+          require 'activeadmin/inputs/searchable_select_input'
+          require 'activeadmin/inputs/filters/searchable_select_input'
+        end
+      end
+    end
+  end
+end

data/lib/activeadmin/searchable_select/option_collection.rb

@@ -0,0 +1,119 @@
+module ActiveAdmin
+  module SearchableSelect
+    # @api private
+    class OptionCollection
+      def initialize(name, options)
+        @name = name
+        @scope = extract_scope_option(options)
+        @display_text = extract_display_text_option(options)
+        @filter = extract_filter_option(options)
+        @per_page = options.fetch(:per_page, 10)
+        @additional_payload = options.fetch(:additional_payload, {})
+      end
+
+      def scope(template, params)
+        case @scope
+        when Proc
+          if @scope.arity.zero?
+            template.instance_exec(&@scope)
+          else
+            template.instance_exec(params, &@scope)
+          end
+        else
+          @scope
+        end
+      end
+
+      def display_text(record)
+        @display_text.call(record)
+      end
+
+      def collection_action_name
+        "#{@name}_options"
+      end
+
+      def as_json(template, params)
+        records, more = fetch_records(template, params)
+
+        results = records.map do |record|
+          {
+            id: record.id,
+            text: display_text(record)
+          }.merge(hash_of_additional_payload(record) || {})
+        end
+
+        { results: results, pagination: { more: more } }
+      end
+
+      private
+
+      attr_reader :per_page
+
+      def fetch_records(template, params)
+        paginate(filter(scope(template, params), params[:term]),
+                 params[:page])
+      end
+
+      def filter(scope, term)
+        term ? @filter.call(term, scope) : scope
+      end
+
+      def paginate(scope, page_index)
+        page_index = page_index.to_i
+
+        records = scope.limit(per_page + 1).offset(page_index * per_page).to_a
+
+        [
+          records.slice(0, per_page),
+          records.size > per_page
+        ]
+      end
+
+      def extract_scope_option(options)
+        options.fetch(:scope) do
+          raise('Missing option: scope. ' \
+                'Pass the collection of items to render options for.')
+        end
+      end
+
+      def extract_display_text_option(options)
+        options.fetch(:display_text) do
+          text_attribute = options.fetch(:text_attribute) do
+            raise('Missing option: display_text or text_attribute. ' \
+                  'Either pass a proc to determine the display text for a record ' \
+                  'or set the text_attribute option.')
+          end
+
+          ->(record) { record.send(text_attribute) }
+        end
+      end
+
+      def extract_filter_option(options)
+        options.fetch(:filter) do
+          text_attribute = options.fetch(:text_attribute) do
+            raise('Missing option: filter or text_attribute. ' \
+                  'Either pass a proc which filters the scope according to a given ' \
+                  'or set the text_attribute option to apply a default Ransack filter.')
+          end
+
+          ->(term, scope) { scope.ransack("#{text_attribute}_cont" => term).result }
+        end
+      end
+
+      def build_additional_payload(record)
+        case @additional_payload
+        when Proc
+          @additional_payload.call(record).to_h
+        else
+          {}
+        end
+      end
+
+      def hash_of_additional_payload(record)
+        return nil if @additional_payload.nil? && @additional_payload.empty?
+
+        build_additional_payload(record)
+      end
+    end
+  end
+end

data/lib/activeadmin/searchable_select/resource_dsl_extension.rb

@@ -0,0 +1,56 @@
+module ActiveAdmin
+  module SearchableSelect
+    # Mixin for ActiveAdmin resource DSL
+    module ResourceDSLExtension
+      # Define a collection action to serve options JSON data for
+      # searchable selects.
+      #
+      # @param scope [ActiveRecord::Relation, Proc] Either a
+      #   collection of records to create options for or a proc
+      #   returning such a collection. Procs are evaluated in the
+      #   context of the collection action defined by this
+      #   method. Procs can optionally take a single `params` argument
+      #   containing data defined under the `params` key of the
+      #   input's `ajax` option. Required.
+      #
+      # @param text_attribute [Symbol] Name of attribute to use as
+      #   display name and to filter by search term.
+      #
+      # @param display_text [Proc] Takes the record as
+      #   parameter. Required if `text_attribute` is not present.
+      #
+      # @param filter [Proc] Takes the search term and an Active
+      #   Record scope as parameters and needs to return a scope of
+      #   filtered records. Required if `text_attribute` is not
+      #   present.
+      #
+      # @param name [Symbol] Optional collection name if helper is
+      #   used multiple times within one resource.
+      #
+      # @param additional_payload [Proc]
+      #   Adds additional attributes to the results array
+      # @example
+      #
+      #   ActiveAdmin.register Tag do
+      #     searchable_select_options(
+      #       scope: Color,
+      #       text_attributes: :title,
+      #       additional_payload: lambda { |record| { color: record.color } }
+      #     )
+      #   end
+      # @json
+      # {
+      #   "results": [{ "id": "1", "text": "Red", "color": "#FFF" }],
+      #   "pagination": { "more": "false" }
+      # }
+      def searchable_select_options(name: :all, **options)
+        option_collection = OptionCollection.new(name, options)
+        config.searchable_select_option_collections[name] = option_collection
+
+        collection_action(option_collection.collection_action_name) do
+          render(json: option_collection.as_json(self, params))
+        end
+      end
+    end
+  end
+end

data/lib/activeadmin/searchable_select/resource_extension.rb

@@ -0,0 +1,10 @@
+module ActiveAdmin
+  module SearchableSelect
+    # @api private
+    module ResourceExtension
+      def searchable_select_option_collections
+        @searchable_select_option_collections ||= {}
+      end
+    end
+  end
+end