activeadmin-searchable_select 1.3.0 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6a0f1ed4c7ca3f0b20a9a1844aa46ecf2693b5b91f447874cbfbc013d5a84e31
-  data.tar.gz: cdca70eae83da1caf578f39957b66fe30cec69a76c67f7f06d2a45bb3c680f7d
+  metadata.gz: 86f2b11107d464955292c9d5a51629757ff3fb213aafdeb9302b948f421796ee
+  data.tar.gz: 961efac5444a994afac0b8a13437bbd96ec8effedbbc6356b606a9d23bc80849
 SHA512:
-  metadata.gz: b509e473b24b32cad8c401f197413c7b01c7de196aaf0a2a4a735f7f6bd40d4ea76ed7733f9b00f87ecf23e6d3aba0bceee599f85c4e39fb1a17639b4234d94f
-  data.tar.gz: f224c6cc6fe60af0373b1d82c9d57a43282c3f327bf5c3c295d2b1d17ce5f9aace56aa0d4320405f40783a270fedaa8137496712091fc167712b9b1e1364a029
+  metadata.gz: 79b204c1f6af56e2d39c4ee658cfde5af5ca31733ed3d2eb657ab78a8de66511b9e7387dd5fa64a457768095c67858e64f3fd598058ef1458fceba0575880522
+  data.tar.gz: 9bcbd53a3504788a0c18ce8f701efefcc2f0495625eedf277a30c738c5083d4b3a4602fdd95c05ca904ad8b0034e551ea1706a46f077805c5b0146f0121ee2fc

data/.github/workflows/tests.yml

@@ -1,5 +1,9 @@
 name: tests
-on: [push, pull_request]
+on:
+  push:
+  pull_request:
+  schedule:
+    - cron: '45 2 * * *'
 
 jobs:
   rspec:
@@ -31,4 +35,4 @@ jobs:
           ruby-version: ${{ matrix.ruby-version }}
           bundler-cache: true
       - name: Run tests
-        run: bundle exec rspec
+        run: bundle exec rspec

data/.rubocop.yml

@@ -1,5 +1,7 @@
 AllCops:
   TargetRubyVersion: 2.3
+  Exclude:
+    - 'bin/**/*'
 
 # The default of 80 characters is a little to narrow.
 Metrics/LineLength:

data/CHANGELOG.md

@@ -1,20 +1,14 @@
 # CHANGELOG
 
-### Version 1.3.0
+### Version 1.6.0
 
-2021-02-03
+2022-04-05
 
-[Compare changes](https://github.com/codevise/activeadmin-searchable_select/compare/1-2-stable...v1.3.0)
+[Compare changes](https://github.com/codevise/activeadmin-searchable_select/compare/1-5-stable...v1.6.0)
 
-- Add support for Ruby 3
-  ([#26](https://github.com/codevise/activeadmin-searchable_select/pull/26))
-- Add a small description of how to pass options to Select2
-  ([#27](https://github.com/codevise/activeadmin-searchable_select/pull/27))
-- Update CI Setup
-  ([#25](https://github.com/codevise/activeadmin-searchable_select/pull/25))
-- Allow Bundler 2 in development dependencies
-  ([#18](https://github.com/codevise/activeadmin-searchable_select/pull/18))
+- Add option to pass path params for nested resource fetching
+  ([#39](https://github.com/codevise/activeadmin-searchable_select/pull/39))
 
 See
-[1-2-stable branch](https://github.com/codevise/activeadmin-searchable_select/blob/1-2-stable/CHANGELOG.md)
+[1-5-stable branch](https://github.com/codevise/activeadmin-searchable_select/blob/1-5-stable/CHANGELOG.md)
 for previous changes.

data/README.md

@@ -193,6 +193,25 @@ build your query in a way that it can query multiple attributes at once.
 
 In this example, the `all` scope will query `email OR username`.
 
+You can add the additional payload as dsl option:
+
+```ruby
+   ActiveAdmin.register Category do
+     searchable_select_options(scope: Category.all,
+                               text_attribute: :name,
+                               additional_payload: ->(record) { { foo: record.bar } } )
+   end
+```
+
+response example which uses additional_payload:
+
+```json
+{
+  "results": [{ "id": "1", "text": "Bicycles", "foo": "Bar" }],
+  "pagination": { "more": "false" }
+}
+```
+
 #### Passing Parameters
 
 You can pass additional parameters to the options endpoint:
@@ -223,6 +242,67 @@ argument:
    end
 ```
 
+#### Path options for nested resources
+
+Example for the following setup:
+
+```ruby
+# Models
+class OptionType < ActiveRecord::Base; end
+
+class OptionValue < ActiveRecord::Base
+  belongs_to :option_type
+end
+
+class Product < ActiveRecord::Base
+  belongs_to :option_type
+  has_many :variants
+end
+
+class Variant < ActiveRecord::Base
+  belongs_to :product
+  belongs_to :option_value
+end
+
+# ActiveAdmin
+ActiveAdmin.register(OptionType)
+
+ActiveAdmin.register(Product)
+
+ActiveAdmin.register(OptionValue) do
+  belongs_to :option_type
+  searchable_select_options(scope: lambda do |params|
+                                     OptionValue.where(
+                                       option_type_id: params[:option_type_id]
+                                     )
+                                   end,
+                            text_attribute: :value)
+end
+```
+
+It is possible to pass path parameters for correctly generating URLs for nested resources fetching via `path_params`
+
+```ruby
+ActiveAdmin.register(Variant) do
+  belongs_to :product
+
+  form do |f|
+    ...
+    f.input(:option_value,
+            as: :searchable_select,
+            ajax: {
+              resource: OptionValue,
+              path_params: {
+                option_type_id: f.object.product.option_type_id
+              }
+            })
+    ...
+  end
+end
+```
+
+This will generate the path for fetching as `all_options_admin_option_type_option_values(option_type_id: f.object.product.option_type_id)` (e.g. `/admin/option_types/2/option_values/all_options`)
+
 #### Inlining Ajax Options in Feature Tests
 
 When writing UI driven feature specs (i.e. with Capybara),
@@ -238,7 +318,7 @@ for feature specs:
 ```ruby
   RSpec.configure do |config|
     config.before(:each) do |example|
-      ActiveAdmin::Select2.inline_ajax_options = (example.metadata[:type] == :feature)
+      ActiveAdmin::SearchableSelect.inline_ajax_options = (example.metadata[:type] == :feature)
     end
   end
 
@@ -246,7 +326,7 @@ for feature specs:
 
 ### Passing options to Select2
 
-It is possible to pass and define configuration options to Select2 
+It is possible to pass and define configuration options to Select2
 via `data-attributes` using nested (subkey) options.
 
 Attributes need to be added to the `input_html` option in the form input.

data/lib/activeadmin/searchable_select/option_collection.rb

@@ -8,6 +8,7 @@ module ActiveAdmin
         @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)
@@ -38,7 +39,7 @@ module ActiveAdmin
           {
             id: record.id,
             text: display_text(record)
-          }
+          }.merge(hash_of_additional_payload(record) || {})
         end
 
         { results: results, pagination: { more: more } }
@@ -98,6 +99,21 @@ module ActiveAdmin
           ->(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

@@ -26,6 +26,23 @@ module ActiveAdmin
       #
       # @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

data/lib/activeadmin/searchable_select/select_input_extension.rb

@@ -20,6 +20,10 @@ module ActiveAdmin
     # - `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
@@ -45,9 +49,11 @@ module ActiveAdmin
 
       def ajax_url
         return unless options[:ajax]
-        template.polymorphic_path([template.active_admin_namespace.route_prefix, ajax_resource_class],
-                                  action: option_collection.collection_action_name,
-                                  **ajax_params)
+        [ajax_resource.route_collection_path(path_params),
+         '/',
+         option_collection.collection_action_name,
+         '?',
+         ajax_params.to_query].join
       end
 
       def all_options_collection
@@ -122,6 +128,10 @@ module ActiveAdmin
         ajax_options.fetch(:params, {})
       end
 
+      def path_params
+        ajax_options.fetch(:path_params, {})
+      end
+
       def ajax_options
         options[:ajax] == true ? {} : options[:ajax]
       end

data/lib/activeadmin/searchable_select/version.rb

@@ -1,5 +1,5 @@
 module ActiveAdmin
   module SearchableSelect
-    VERSION = '1.3.0'.freeze
+    VERSION = '1.6.0'.freeze
   end
 end

data/spec/features/end_to_end_spec.rb

@@ -5,60 +5,180 @@ require 'support/capybara'
 require 'support/active_admin_helpers'
 
 RSpec.describe 'end to end', type: :feature, js: true do
-  before(:each) do
-    ActiveAdminHelpers.setup do
-      ActiveAdmin.register(Category) do
-        searchable_select_options(scope: Category, text_attribute: :name)
-      end
+  context 'class name without namespaces' do
+    before(:each) do
+      ActiveAdminHelpers.setup do
+        ActiveAdmin.register(Category) do
+          searchable_select_options(scope: Category, text_attribute: :name)
+        end
 
-      ActiveAdmin.register(Post) do
-        filter(:category, as: :searchable_select, ajax: true)
+        ActiveAdmin.register(Post) do
+          filter(:category, as: :searchable_select, ajax: true)
 
-        form do |f|
-          f.input(:category, as: :searchable_select, ajax: true)
+          form do |f|
+            f.input(:category, as: :searchable_select, ajax: true)
+          end
         end
+
+        ActiveAdmin.setup {}
       end
+    end
+
+    describe 'index page with searchable select filter' do
+      it 'loads filter input options' do
+        Category.create(name: 'Music')
+        Category.create(name: 'Travel')
+
+        visit '/admin/posts'
+
+        expand_select_box
+        wait_for_ajax
+
+        expect(select_box_items).to eq(%w(Music Travel))
+      end
+
+      it 'allows filtering options by term' do
+        Category.create(name: 'Music')
+        Category.create(name: 'Travel')
+
+        visit '/admin/posts'
 
-      ActiveAdmin.setup {}
+        expand_select_box
+        enter_search_term('T')
+        wait_for_ajax
+
+        expect(select_box_items).to eq(%w(Travel))
+      end
+
+      it 'loads more items when scrolling down' do
+        15.times { |i| Category.create(name: "Category #{i}") }
+        visit '/admin/posts'
+
+        expand_select_box
+        wait_for_ajax
+        scroll_select_box_list
+        wait_for_ajax
+
+        expect(select_box_items.size).to eq(15)
+      end
     end
   end
 
-  describe 'index page with searchable select filter' do
-    it 'loads filter input options' do
-      Category.create(name: 'Music')
-      Category.create(name: 'Travel')
-
-      visit '/admin/posts'
+  context 'class name with namespace' do
+    before(:each) do
+      ActiveAdminHelpers.setup do
+        ActiveAdmin.register RGB::Color, as: 'color' do
+          searchable_select_options scope: RGB::Color, text_attribute: :code
+        end
 
-      expand_select_box
-      wait_for_ajax
+        ActiveAdmin.register Internal::TagName, as: 'Tag Name' do
+          filter :color, as: :searchable_select, ajax: { resource: RGB::Color }
+        end
 
-      expect(select_box_items).to eq(%w(Music Travel))
+        ActiveAdmin.setup {}
+      end
     end
 
-    it 'allows filtering options by term' do
-      Category.create(name: 'Music')
-      Category.create(name: 'Travel')
+    describe 'index page with searchable select filter' do
+      it 'loads filter input options' do
+        RGB::Color.create(code: '#eac112', description: 'Orange')
+        RGB::Color.create(code: '#19bf25', description: 'Green')
 
-      visit '/admin/posts'
+        visit '/admin/tag_names'
 
-      expand_select_box
-      enter_search_term('T')
-      wait_for_ajax
+        expand_select_box
+        wait_for_ajax
 
-      expect(select_box_items).to eq(%w(Travel))
+        expect(select_box_items).to eq(%w(#eac112 #19bf25))
+      end
     end
+  end
 
-    it 'loads more items when scrolling down' do
-      15.times { |i| Category.create(name: "Category #{i}") }
-      visit '/admin/posts'
+  context 'class with nested belongs_to association' do
+    before(:all) do
+      ActiveAdminHelpers.setup do
+        ActiveAdmin.register(OptionType)
+
+        ActiveAdmin.register(Product)
+
+        ActiveAdmin.register(OptionValue) do
+          belongs_to :option_type
+          searchable_select_options(scope: lambda do |params|
+                                             OptionValue.where(
+                                               option_type_id: params[:option_type_id]
+                                             )
+                                           end,
+                                    text_attribute: :value)
+        end
 
-      expand_select_box
-      wait_for_ajax
-      scroll_select_box_list
-      wait_for_ajax
+        ActiveAdmin.register(Variant) do
+          belongs_to :product
+
+          form do |f|
+            input :price
+            input(:option_value,
+                  as: :searchable_select,
+                  ajax: {
+                    resource: OptionValue,
+                    path_params: {
+                      option_type_id: f.object.product.option_type_id
+                    }
+                  })
+          end
+        end
 
-      expect(select_box_items.size).to eq(15)
+        ActiveAdmin.setup {}
+      end
+    end
+
+    describe 'new page with searchable select filter' do
+      it 'loads filter input options' do
+        option_type = OptionType.create(name: 'Color')
+        ot = OptionType.create(name: 'Size')
+        OptionValue.create(value: 'Black', option_type: option_type)
+        OptionValue.create(value: 'Orange', option_type: option_type)
+        OptionValue.create(value: 'M', option_type: ot)
+        product = Product.create(name: 'Cap', option_type: option_type)
+
+        visit "/admin/products/#{product.id}/variants/new"
+
+        expand_select_box
+        wait_for_ajax
+
+        expect(select_box_items).to eq(%w(Black Orange))
+      end
+
+      it 'allows filtering options by term' do
+        option_type = OptionType.create(name: 'Color')
+        ot = OptionType.create(name: 'Size')
+        OptionValue.create(value: 'Black', option_type: option_type)
+        OptionValue.create(value: 'Orange', option_type: option_type)
+        OptionValue.create(value: 'M', option_type: ot)
+        product = Product.create(name: 'Cap', option_type: option_type)
+
+        visit "/admin/products/#{product.id}/variants/new"
+
+        expand_select_box
+        enter_search_term('O')
+        wait_for_ajax
+
+        expect(select_box_items).to eq(%w(Orange))
+      end
+
+      it 'loads more items when scrolling down' do
+        option_type = OptionType.create(name: 'Color')
+        15.times { |i| OptionValue.create(value: "Black #{i}", option_type: option_type) }
+        product = Product.create(name: 'Cap', option_type: option_type)
+
+        visit "/admin/products/#{product.id}/variants/new"
+
+        expand_select_box
+        wait_for_ajax
+        scroll_select_box_list
+        wait_for_ajax
+
+        expect(select_box_items.size).to eq(15)
+      end
     end
   end
 

data/spec/features/options_dsl_spec.rb

@@ -140,6 +140,60 @@ RSpec.describe 'searchable_select_options dsl', type: :request do
     end
   end
 
+  describe 'with additional_payload' do
+    context 'as lambda' do
+      before(:each) do
+        ActiveAdminHelpers.setup do
+          ActiveAdmin.register(Post) do
+            searchable_select_options(
+              scope: Post,
+              text_attribute: :title,
+              additional_payload: lambda do |record|
+                { published: record.published }
+              end
+            )
+          end
+        end
+      end
+      let!(:post) { Post.create!(title: 'A post', published: false) }
+
+      subject { get '/admin/posts/all_options' }
+
+      it 'returns options with our additional attribute' do
+        subject
+        expect(json_response).to match(
+          results: [{ text: 'A post', id: post.id, published: false }],
+          pagination: { more: false }
+        )
+      end
+    end
+
+    context 'as Proc' do
+      before(:each) do
+        ActiveAdminHelpers.setup do
+          ActiveAdmin.register(Post) do
+            searchable_select_options(
+              scope: Post,
+              text_attribute: :title,
+              additional_payload: proc { |record| { published: record.published } }
+            )
+          end
+        end
+      end
+      let!(:post) { Post.create!(title: 'A post', published: false) }
+
+      subject { get '/admin/posts/all_options' }
+
+      it 'returns options with our additional attribute' do
+        subject
+        expect(json_response).to match(
+          results: [{ text: 'A post', id: post.id, published: false }],
+          pagination: { more: false }
+        )
+      end
+    end
+  end
+
   it 'allows passing lambda as scope' do
     ActiveAdminHelpers.setup do
       ActiveAdmin.register(Post) do

data/spec/internal/db/schema.rb

@@ -20,6 +20,37 @@ ActiveRecord::Schema.define do
     t.boolean :published
   end
 
+  create_table(:rgb_colors, force: true) do |t|
+    t.string :code
+    t.text :description
+  end
+
+  create_table(:internal_tag_names, force: true) do |t|
+    t.string :name
+    t.text :description
+    t.integer :color_id
+  end
+
+  create_table(:option_types, force: true) do |t|
+    t.string :name
+  end
+
+  create_table(:option_values, force: true) do |t|
+    t.string :value
+    t.belongs_to :option_type
+  end
+
+  create_table(:products, force: true) do |t|
+    t.string :name
+    t.belongs_to :option_type
+  end
+
+  create_table(:variants, force: true) do |t|
+    t.integer :price
+    t.belongs_to :product
+    t.belongs_to :option_value
+  end
+
   create_table(:users, force: true) do |t|
     t.string :name
   end

data/spec/support/active_admin_helpers.rb

@@ -1,9 +1,13 @@
 module ActiveAdminHelpers
   module_function
 
+  def reload_routes!
+    Rails.application.reload_routes!
+  end
+
   def setup
     ActiveAdmin.application = nil
     yield
-    Rails.application.reload_routes!
+    reload_routes!
   end
 end

data/spec/support/models.rb

@@ -13,6 +13,36 @@ class Post < ActiveRecord::Base
   scope(:published, -> { where(published: true) })
 end
 
+module RGB
+  class Color < ActiveRecord::Base
+    self.table_name = :rgb_colors
+    has_many :tags, class_name: 'Internal::TagName'
+  end
+end
+
+module Internal
+  class TagName < ActiveRecord::Base
+    self.table_name = :internal_tag_names
+    belongs_to :color, class_name: 'RGB::Color', foreign_key: :color_id
+  end
+end
+
+class OptionType < ActiveRecord::Base; end
+
+class OptionValue < ActiveRecord::Base
+  belongs_to :option_type
+end
+
+class Product < ActiveRecord::Base
+  belongs_to :option_type
+  has_many :variants
+end
+
+class Variant < ActiveRecord::Base
+  belongs_to :product
+  belongs_to :option_value
+end
+
 RSpec.configure do |config|
   config.after do
     DatabaseCleaner.strategy = :truncation

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: activeadmin-searchable_select
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.6.0
 platform: ruby
 authors:
 - Codevise Solutions Ltd
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-02-03 00:00:00.000000000 Z
+date: 2022-04-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -375,7 +375,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
+rubygems_version: 3.0.8
 signing_key: 
 specification_version: 4
 summary: Use searchable selects based on Select2 in Active Admin forms and filters.