activeadmin-autocompletes 0.3.0

data/app/views/active_admin/autocompletes/_field.html.erb

@@ -0,0 +1,70 @@
+<%
+  object_name = local_assigns.fetch(:object_name)
+  field_name = local_assigns.fetch(:field_name)
+  field_id = "#{object_name}_#{field_name}".gsub(/[\[\]]+/, "_").gsub(/_+\z/, "")
+  list_id = "#{field_id}_options"
+  controller = local_assigns.fetch(:controller_name, "activeadmin-autocompletes--filter-autocomplete")
+  value_field = local_assigns.fetch(:value_field, false)
+  multiple = local_assigns.fetch(:multiple, false)
+  initial_value = local_assigns.fetch(:initial_value, nil)
+  initial_label = local_assigns.fetch(:initial_label, nil)
+  selected_items = Array(local_assigns.fetch(:selected_items, []))
+  display_value = value_field && !multiple ? initial_label.to_s : (multiple ? "" : initial_value.to_s)
+  placeholder = local_assigns.fetch(:placeholder, I18n.t("active_admin.autocompletes.filter_placeholder", default: "Type to search"))
+  label_text = local_assigns.fetch(:label_text, field_name.to_s.humanize)
+  search_url = local_assigns.fetch(:search_url)
+  page_size = local_assigns[:page_size]
+  params_payload = local_assigns.fetch(:params, {})
+  param_fields_payload = local_assigns.fetch(:param_fields, {})
+  field_param_name = multiple ? "#{object_name}[#{field_name}][]" : "#{object_name}[#{field_name}]"
+%>
+<div
+  data-controller="<%= controller %>"
+  data-<%= controller %>-url-value="<%= search_url %>"
+  data-<%= controller %>-multiple-value="<%= multiple %>"
+  <% if page_size.present? %>data-<%= controller %>-page-size-value="<%= page_size %>"<% end %>
+  <% if params_payload.present? %>data-<%= controller %>-params-value="<%= ERB::Util.html_escape(params_payload.to_json) %>"<% end %>
+  <% if param_fields_payload.present? %>data-<%= controller %>-param-fields-value="<%= ERB::Util.html_escape(param_fields_payload.to_json) %>"<% end %>
+  data-field-name="<%= field_param_name %>"
+  data-testid="filter-autocomplete-<%= field_name %>"
+  class="relative w-full"
+>
+  <% if multiple %>
+    <div data-<%= controller %>-target="chips" class="mb-2 flex flex-wrap gap-1"></div>
+    <% selected_items.each do |item| %>
+      <input
+        type="hidden"
+        name="<%= field_param_name %>"
+        value="<%= ERB::Util.html_escape(item.fetch(:value).to_s) %>"
+        data-label="<%= ERB::Util.html_escape(item.fetch(:label).to_s) %>"
+        data-<%= controller %>-target="selected" />
+    <% end %>
+  <% elsif value_field %>
+    <input
+      type="hidden"
+      name="<%= field_param_name %>"
+      value="<%= ERB::Util.html_escape(initial_value.to_s) %>"
+      data-<%= controller %>-target="value" />
+  <% end %>
+  <input
+    id="<%= field_id %>"
+    type="text"
+    <% unless value_field || multiple %>name="<%= field_param_name %>"<% end %>
+    value="<%= ERB::Util.html_escape(display_value) %>"
+    placeholder="<%= ERB::Util.html_escape(placeholder) %>"
+    autocomplete="off"
+    class="w-full"
+    role="combobox"
+    aria-label="<%= ERB::Util.html_escape(label_text.to_s) %>"
+    aria-autocomplete="list"
+    aria-controls="<%= list_id %>"
+    aria-expanded="false"
+    data-<%= controller %>-target="query"
+    data-action="input-><%= controller %>#search focus-><%= controller %>#open keydown-><%= controller %>#navigate" />
+  <ul
+    id="<%= list_id %>"
+    data-<%= controller %>-target="list"
+    data-action="scroll-><%= controller %>#loadMore"
+    class="hidden absolute z-20 mt-1 max-h-60 w-full overflow-auto rounded border border-gray-300 bg-white shadow-lg dark:border-gray-600 dark:bg-gray-900"
+    role="listbox"></ul>
+</div>

data/config/locales/en.yml

@@ -0,0 +1,4 @@
+en:
+  active_admin:
+    autocompletes:
+      filter_placeholder: Type to search

data/config/locales/fi.yml

@@ -0,0 +1,4 @@
+fi:
+  active_admin:
+    autocompletes:
+      filter_placeholder: Kirjoita hakeaksesi

data/config/locales/sv.yml

@@ -0,0 +1,4 @@
+sv:
+  active_admin:
+    autocompletes:
+      filter_placeholder: Skriv för att söka

data/config/polyrun_coverage.yml

@@ -0,0 +1,8 @@
+track_under:
+  - lib
+  - app
+minimum_line_percent: 100
+report_formats:
+  - html
+  - cobertura
+  - console

data/lib/activeadmin/autocompletes/engine.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module ActiveAdmin
+  module Autocompletes
+    class Engine < ::Rails::Engine
+      engine_name "activeadmin_autocompletes"
+
+      initializer "activeadmin_autocompletes.load" do
+        require "activeadmin/autocompletes/filter_autocomplete"
+        require "activeadmin/autocompletes/input_support"
+        require "activeadmin/inputs/filters/autocomplete_input"
+        require "activeadmin/inputs/autocomplete_input"
+      end
+
+      initializer "activeadmin_autocompletes.assets" do |app|
+        assets_path = root.join("app/assets")
+        if app.config.respond_to?(:importmap)
+          app.config.importmap.cache_sweepers << assets_path.join("controllers")
+        end
+      end
+
+      initializer "activeadmin_autocompletes.importmap", after: "active_admin.importmap" do
+        next unless defined?(ActiveAdmin) && ActiveAdmin.respond_to?(:importmap) && ActiveAdmin.importmap
+
+        ActiveAdmin.importmap.draw do
+          pin "controllers/activeadmin_autocompletes/filter_autocomplete_controller",
+            to: "activeadmin_autocompletes/filter_autocomplete_controller.js"
+        end
+      end
+
+      initializer "activeadmin_autocompletes.i18n" do
+        I18n.load_path += Dir[root.join("config/locales/*.yml")]
+      end
+
+      initializer "activeadmin_autocompletes.view_paths", after: :add_view_paths do
+        views_path = root.join("app/views").to_s
+        ActiveSupport.on_load(:action_controller) do
+          prepend_view_path(views_path)
+        end
+      end
+    end
+  end
+end

data/lib/activeadmin/autocompletes/filter_autocomplete.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module ActiveAdmin
+  module Autocompletes
+    module FilterAutocomplete
+      DEFAULT_LIMIT = 20
+      MAX_LIMIT = 50
+      MAX_QUERY_CHARS = 200
+
+      def self.clamp_limit(raw)
+        raw.to_i.clamp(1, MAX_LIMIT)
+      end
+
+      def self.clamp_query(raw)
+        query = raw.to_s.strip
+        query = query.byteslice(0, MAX_QUERY_CHARS) if query.bytesize > MAX_QUERY_CHARS
+        query.empty? ? nil : query
+      end
+
+      def filter_autocomplete(attribute, action: nil, &block)
+        raise ArgumentError, "filter_autocomplete requires a block" unless block
+
+        action_name = (action || :"#{attribute}_options").to_sym
+
+        collection_action action_name, method: :get do
+          authorize! :index, config.resource_class
+
+          limit = ActiveAdmin::Autocompletes::FilterAutocomplete.clamp_limit(
+            params.fetch(:limit, ActiveAdmin::Autocompletes::FilterAutocomplete::DEFAULT_LIMIT)
+          )
+          offset = [params.fetch(:offset, 0).to_i, 0].max
+          query = ActiveAdmin::Autocompletes::FilterAutocomplete.clamp_query(params[:q])
+
+          items = instance_exec(query:, limit:, offset:, &block)
+          render json: Array(items)
+        end
+      end
+    end
+  end
+end

data/lib/activeadmin/autocompletes/input_support.rb

@@ -0,0 +1,113 @@
+# frozen_string_literal: true
+
+require "active_support/core_ext/object/blank"
+
+module ActiveAdmin
+  module Autocompletes
+    module InputSupport
+      CONTROLLER = "activeadmin-autocompletes--filter-autocomplete"
+      PARTIAL = "active_admin/autocompletes/field"
+
+      private
+
+      def autocomplete_search_url
+        url = options[:url]
+        url = template.instance_exec(&url) if url.respond_to?(:call)
+        url.to_s
+      end
+
+      def autocomplete_placeholder
+        options[:placeholder].presence || I18n.t(
+          "active_admin.autocompletes.filter_placeholder",
+          default: "Type to search"
+        )
+      end
+
+      def value_field?
+        options[:value_field].present?
+      end
+
+      def multiple?
+        options[:multiple].present?
+      end
+
+      def page_size_value
+        raw = options[:page_size]
+        return if raw.blank?
+
+        FilterAutocomplete.clamp_limit(raw)
+      end
+
+      def static_params
+        raw = options[:params]
+        return {} if raw.blank?
+
+        hash = raw.respond_to?(:call) ? template.instance_exec(&raw) : raw
+        stringify_option_hash(hash, keep_nil: true)
+      end
+
+      def param_fields
+        raw = options[:param_fields]
+        return {} if raw.blank?
+
+        stringify_option_hash(raw, keep_nil: false)
+      end
+
+      def selected_items_for(current_value)
+        return [] unless multiple?
+
+        labels = options[:initial_labels]
+        Array(current_value).filter_map do |value|
+          next if value.blank?
+
+          {value: value, label: label_for_value(value, labels)}
+        end
+      end
+
+      def stringify_option_hash(raw, keep_nil:)
+        out = {}
+        raw.to_h.each do |key, value|
+          out[key.to_s] = keep_nil ? value&.to_s : value.to_s
+        end
+        out
+      end
+
+      def initial_label_for(current_value)
+        label = options[:initial_label]
+        return "" if current_value.blank? && label.blank?
+
+        label_for_value(current_value, label)
+      end
+
+      def label_for_value(value, labels)
+        resolved = if labels.respond_to?(:call)
+          template.instance_exec(value, &labels)
+        elsif labels.is_a?(Hash)
+          labels[value] || labels[value.to_s]
+        else
+          labels
+        end
+        resolved.to_s.presence || value.to_s
+      end
+
+      def autocomplete_locals(object_name:, field_name:, current_value:)
+        {
+          object_name: object_name,
+          field_name: field_name,
+          search_url: autocomplete_search_url,
+          placeholder: autocomplete_placeholder,
+          initial_value: current_value,
+          initial_label: initial_label_for(current_value),
+          selected_items: selected_items_for(current_value),
+          label_text: label_from_options,
+          controller_name: CONTROLLER,
+          value_field: value_field?,
+          multiple: multiple?,
+          page_size: page_size_value,
+          params: static_params,
+          param_fields: param_fields
+        }
+      end
+    end
+  end
+end

data/lib/activeadmin/autocompletes/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module ActiveAdmin
+  module Autocompletes
+    VERSION = "0.3.0"
+  end
+end

data/lib/activeadmin/autocompletes.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require "activeadmin/autocompletes/version"
+require "activeadmin/autocompletes/engine"
+
+module ActiveAdmin
+  module Autocompletes
+  end
+end

data/lib/activeadmin/inputs/autocomplete_input.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require "activeadmin/autocompletes/input_support"
+
+module ActiveAdmin
+  module Inputs
+    class AutocompleteInput < ::Formtastic::Inputs::StringInput
+      include ActiveAdmin::Autocompletes::InputSupport
+
+      def to_html
+        input_wrapping do
+          label_html << template.render(
+            PARTIAL,
+            **autocomplete_locals(
+              object_name: builder.object_name,
+              field_name: method,
+              current_value: current_value
+            )
+          )
+        end
+      end
+
+      private
+
+      def current_value
+        return options[:selected] if options.key?(:selected)
+
+        object.public_send(method) if object.respond_to?(method)
+      rescue NoMethodError
+        nil
+      end
+    end
+  end
+end

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

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require "activeadmin/autocompletes/input_support"
+
+module ActiveAdmin
+  module Inputs
+    module Filters
+      class AutocompleteInput < ::Formtastic::Inputs::StringInput
+        include Base
+        include ActiveAdmin::Autocompletes::InputSupport
+
+        def to_html
+          input_wrapping do
+            label_html << template.render(
+              PARTIAL,
+              **autocomplete_locals(
+                object_name: builder.object_name,
+                field_name: input_name,
+                current_value: current_value
+              )
+            )
+          end
+        end
+
+        def input_name
+          method
+        end
+
+        private
+
+        def current_value
+          @object.public_send(method).presence if @object.respond_to?(method)
+        rescue NoMethodError
+          nil
+        end
+      end
+    end
+  end
+end

data/lib/activeadmin-autocompletes.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require "activeadmin/autocompletes"

data/sig/activeadmin/autocompletes.rbs

@@ -0,0 +1,16 @@
+module ActiveAdmin
+  module Autocompletes
+    VERSION: String
+
+    module FilterAutocomplete
+      DEFAULT_LIMIT: Integer
+      MAX_LIMIT: Integer
+      MAX_QUERY_CHARS: Integer
+
+      def self.clamp_limit: (untyped raw) -> Integer
+      def self.clamp_query: (untyped raw) -> String?
+
+      def filter_autocomplete: (untyped attribute, ?action: untyped?) { (query: String?, limit: Integer, offset: Integer) -> untyped } -> void
+    end
+  end
+end