activeadmin-hotwire_combobox_filters 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 50fd003a869037e3a173d2457fbf2b294166da458de471339cde16716fe4f64f
+  data.tar.gz: ea45045933bec40c20703a35c89040559a03b4aa79dde3865a1e549c9939dd70
+SHA512:
+  metadata.gz: ad30fc1e85226f1bc6f0fefa0199c13945122c23e32441430940a138ef355b3684f7e2d096c8b1a5229cf60a76b645723cf902f5457692d1a4826dc5319289d1
+  data.tar.gz: 3eb7bf504703e5341b92fae5fc96be479f174a7b3ad2f2850b70d52503c9072db49700aa66a3321e9bea5920eb9f3488589cf71d9edd9a9b2572158f484c1c8e

data/README.md

@@ -0,0 +1,18 @@
+# ActiveAdmin Hotwire Combobox Filters
+
+This gem adds a hotwire combobox to ActiveAdmin sidebar filters for related resources (`belongs_to`, `has_many`, etc.).
+
+# Installation
+
+```
+gem "activeadmin-hotwire_combobox_filters"
+```
+
+# Usage
+
+The gem automatically replaces the default ActiveAdmin filters with hotwire_combobox filters after being required.
+
+# Thanks and credits
+
+Thanks to @josefarias for the awesome [hotwire_combobox](https://github.com/josefarias/hotwire_combobox) gem.
+Thanks to all the team at [ActiveAdmin](https://github.com/activeadmin/activeadmin) for the awesome gem.

data/app/views/activeadmin_hotwire_combobox_filters/_combobox_styles.html.erb

@@ -0,0 +1,23 @@
+<%= combobox_style_tag %>
+<style>
+  [role='combobox'] {
+    background-color: inherit;
+  }
+  .dark:root {
+    --tw-border-opacity: 1;
+    --hw-border-color: rgb(75 85 99 / var(--tw-border-opacity));
+    --hw-active-bg-color: rgb(31 41 55/var(--tw-border-opacity));
+    --tw-bg-opacity: 1;
+    --hw-component-bg-color: rgb(55 65 81 / var(--tw-bg-opacity));
+    --hw-option-bg-color: rgb(55 65 81 / var(--tw-bg-opacity));
+
+    /* --hw-group-color: #57595C;
+    --hw-group-bg-color: #FFFFFF;
+    --hw-invalid-color: #EF4444;
+    --hw-dialog-label-color: #1D1D1D;
+    --hw-focus-color: #2563EB; */
+
+    /* --hw-handle-image: url("data:image/svg+xml;charset=utf-8,%3Csvg xmlns='http://www.w3.org/2000/svg' fill='none' viewBox='0 0 20 20'%3E%3Cpath stroke='%236b7280' stroke-linecap='round' stroke-linejoin='round' stroke-width='1.5' d='m6 8 4 4 4-4'/%3E%3C/svg%3E");
+    --hw-handle-image--queried: url("data:image/svg+xml;charset=utf-8,%3Csvg xmlns='http://www.w3.org/2000/svg' fill='none' viewBox='0 0 24 24'%3E%3Cpath stroke='%236b7280' stroke-linecap='round' stroke-linejoin='round' stroke-width='2' d='M6 18 18 6M6 6l12 12'/%3E%3C/svg%3E"); */
+  }
+</style>

data/app/views/activeadmin_hotwire_combobox_filters/combobox_search.turbo_stream.erb

@@ -0,0 +1 @@
+<%= async_combobox_options(combobox_results, next_page:) %>

data/lib/activeadmin-hotwire_combobox_filters.rb

@@ -0,0 +1,23 @@
+# rubocop:disable Naming/FileName
+# rubocop:enable Naming/FileName
+require "active_admin"
+require "hotwire_combobox"
+
+module ActiveAdminHotwireComboboxFilters
+  class Engine < ::Rails::Engine
+    config.to_prepare do
+      require "activeadmin_hotwire_combobox_filters/dsl"
+      ActiveAdmin::ResourceDSL.include(ActiveAdminHotwireComboboxFilters::DSL)
+
+      require "activeadmin_hotwire_combobox_filters/resource_extension"
+      ActiveAdmin::Resource.include(ActiveAdminHotwireComboboxFilters::ResourceExtension)
+
+      require "activeadmin_hotwire_combobox_filters/fieldset_override"
+      HotwireCombobox::Component::Markup::Fieldset.prepend(ActiveAdminHotwireComboboxFilters::FieldsetOverride)
+    end
+  end
+end
+
+require "activeadmin_hotwire_combobox_filters/inputs/filters_select_input"
+require "activeadmin_hotwire_combobox_filters/inputs/hotwire_combobox_input"
+require "activeadmin_hotwire_combobox_filters/form_builder_extension"

data/lib/activeadmin_hotwire_combobox_filters/dsl.rb

@@ -0,0 +1,43 @@
+module ActiveAdminHotwireComboboxFilters
+  module DSL
+    DISPLAY_NAME_METHODS = %w[display_name full_name name username login title email to_s].freeze
+
+    def run_registration_block(&block) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
+      resource_class = config.resource_class
+      unless resource_class.respond_to?(:to_combobox_display)
+        resource_class.class_eval do
+          define_method :to_combobox_display do
+            method = DISPLAY_NAME_METHODS.find { |m| self.respond_to?(m) }
+            self.public_send(method) if method.present?
+          end
+        end
+      end
+
+      new_block = proc do
+        collection_action :combobox_search, method: :get do
+          method = (resource_class.attribute_aliases.keys & DISPLAY_NAME_METHODS).first
+          method = if resource_class.column_names.include?(resource_class.attribute_aliases[method])
+                     resource_class.attribute_aliases[method]
+                   else
+                     (DISPLAY_NAME_METHODS & resource_class.column_names).first
+                   end
+          if method.blank?
+            raise NoMethodError,
+                  "No display method found for #{resource_class.name}. Methods searched: #{DISPLAY_NAME_METHODS.join(', ')}"
+          end
+
+          @records = Pundit.policy_scope!(current_user, resource_class).ransack("#{method}_cont" => params[:q]).result
+                           .page(params[:page]).per(Kaminari.config.default_per_page)
+
+          @combobox_results = @records.pluck(method, :id)
+          @next_page = @records.next_page
+          render "activeadmin_hotwire_combobox_filters/combobox_search",
+                 locals: { combobox_results: @combobox_results, next_page: @next_page }
+        end
+
+        instance_exec(&block) if block
+      end
+      instance_exec(&new_block)
+    end
+  end
+end

data/lib/activeadmin_hotwire_combobox_filters/fieldset_override.rb

@@ -0,0 +1,21 @@
+module ActiveAdminHotwireComboboxFilters
+  module FieldsetOverride
+    private
+
+      def prefilled_display # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
+        return if multiselect? || !hidden_field_value
+
+        if async_src && associated_object
+          associated_object.to_combobox_display
+        elsif async_src && form_object&.respond_to?(name) # rubocop:disable Lint/RedundantSafeNavigation
+          form_object.public_send name
+        # special case for filtering Ransack::Search object
+        elsif async_src && !form_object&.public_send(name).nil?
+          options&.find { |option| option.value == value }&.autocompletable_as || hidden_field_value
+        # end special case
+        else
+          options.find_by_value(hidden_field_value)&.autocompletable_as || hidden_field_value # rubocop:disable Rails/DynamicFindBy
+        end
+      end
+  end
+end

data/lib/activeadmin_hotwire_combobox_filters/form_builder_extension.rb

@@ -0,0 +1,12 @@
+module ActiveAdmin
+  class FormBuilder < ::Formtastic::FormBuilder
+    def input(method, options = {})
+      options[:as] ||= :hotwire_combobox if association?(method)
+      super
+    end
+
+    private
+
+      def association?(method) = reflection_for(method) # &.macro == :belongs_to
+  end
+end

data/lib/activeadmin_hotwire_combobox_filters/inputs/filters_select_input.rb

@@ -0,0 +1,17 @@
+ActiveAdmin::Inputs::Filters::SelectInput.class_eval do
+  def select_html # rubocop:disable Metrics/AbcSize
+    current_value = object.public_send(input_name)
+
+    options = []
+    if current_value.present?
+      value_record = Pundit.policy_scope!(Current.user, reflection.klass).find_by(id: current_value)
+      options = HotwireCombobox::Listbox::Item.collection_for(
+        template, [value_record], render_in: {}, include_blank: nil, display: :to_combobox_display
+      )
+    end
+
+    path = template.public_send(:"combobox_search_admin_#{reflection.klass.name.underscore.pluralize}_path")
+
+    builder.combobox(input_name, path, value: current_value, options:)
+  end
+end

data/lib/activeadmin_hotwire_combobox_filters/inputs/hotwire_combobox_input.rb

@@ -0,0 +1,12 @@
+module ActiveAdmin
+  module Inputs
+    class HotwireComboboxInput < Formtastic::Inputs::SelectInput
+      def select_html
+        path = template.public_send(:"combobox_search_admin_#{reflection.klass.name.underscore.pluralize}_path")
+
+        template.render(partial: "activeadmin_hotwire_combobox_filters/combobox_styles") <<
+          builder.combobox(input_name, path)
+      end
+    end
+  end
+end

data/lib/activeadmin_hotwire_combobox_filters/resource_extension.rb

@@ -0,0 +1,12 @@
+module ActiveAdminHotwireComboboxFilters
+  module ResourceExtension
+    def filters_sidebar_section
+      ActiveAdmin::SidebarSection.new :filters, only: :index, if: -> { active_admin_config.filters.any? } do
+        render partial: "activeadmin_hotwire_combobox_filters/combobox_styles"
+
+        h3 I18n.t("active_admin.sidebars.filters", default: "Filters"), class: "filters-form-title"
+        active_admin_filters_form_for assigns[:search], **active_admin_config.filters
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification
+name: activeadmin-hotwire_combobox_filters
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Viktor Fonic
+bindir: bin
+cert_chain: []
+date: 2025-01-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activeadmin
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.0.0.beta7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.0.0.beta7
+- !ruby/object:Gem::Dependency
+  name: hotwire_combobox
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+description: Adds Hotwire-powered combobox filters to ActiveAdmin
+email:
+- activeadmin-hotwire_combobox_filters@ada-dev.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- app/views/activeadmin_hotwire_combobox_filters/_combobox_styles.html.erb
+- app/views/activeadmin_hotwire_combobox_filters/combobox_search.turbo_stream.erb
+- lib/activeadmin-hotwire_combobox_filters.rb
+- lib/activeadmin_hotwire_combobox_filters/dsl.rb
+- lib/activeadmin_hotwire_combobox_filters/fieldset_override.rb
+- lib/activeadmin_hotwire_combobox_filters/form_builder_extension.rb
+- lib/activeadmin_hotwire_combobox_filters/inputs/filters_select_input.rb
+- lib/activeadmin_hotwire_combobox_filters/inputs/hotwire_combobox_input.rb
+- lib/activeadmin_hotwire_combobox_filters/resource_extension.rb
+homepage: https://github.com/vfonic/activeadmin-hotwire_combobox_filters
+licenses:
+- MIT
+metadata:
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.2
+specification_version: 4
+summary: Hotwire Combobox filters for ActiveAdmin
+test_files: []