activeadmin-searchable_select 1.5.0 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eae3cd46ff6e641c50c4f6e02c7aa4ab8105a160740c07fd82efea3eb4af26e8
-  data.tar.gz: 37274666f643b0df81a37aa0dbbd197cc7b94f45ef804398496a1ecbb3f1094f
+  metadata.gz: 86f2b11107d464955292c9d5a51629757ff3fb213aafdeb9302b948f421796ee
+  data.tar.gz: 961efac5444a994afac0b8a13437bbd96ec8effedbbc6356b606a9d23bc80849
 SHA512:
-  metadata.gz: a0448e24dbb3c48ca7421eca976836d5be764e91db9e89a129e8c9b47dbb5dbbbdb94ac8937d049b5af35d6c68a17933bc6e3712719fd920b125e65d29147b88
-  data.tar.gz: 4c90fe918890f40de37d138ba3b82b12307bf5331772a0dd8a139afb1698a8cf3a95620a72372415437b103851ee4ae574807d11a888cd8b850a6d360a2af6e9
+  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/CHANGELOG.md

@@ -1,14 +1,14 @@
 # CHANGELOG
 
-### Version 1.5.0
+### Version 1.6.0
 
-2021-02-16
+2022-04-05
 
-[Compare changes](https://github.com/codevise/activeadmin-searchable_select/compare/1-4-stable...v1.5.0)
+[Compare changes](https://github.com/codevise/activeadmin-searchable_select/compare/1-5-stable...v1.6.0)
 
-- Allow adding additional payload to option items in AJAX response
-  ([#33](https://github.com/codevise/activeadmin-searchable_select/pull/33))
+- Add option to pass path params for nested resource fetching
+  ([#39](https://github.com/codevise/activeadmin-searchable_select/pull/39))
 
 See
-[1-4-stable branch](https://github.com/codevise/activeadmin-searchable_select/blob/1-4-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

@@ -242,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),
@@ -265,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/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,7 +49,7 @@ module ActiveAdmin
 
       def ajax_url
         return unless options[:ajax]
-        [ajax_resource.route_collection_path,
+        [ajax_resource.route_collection_path(path_params),
          '/',
          option_collection.collection_action_name,
          '?',
@@ -124,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.5.0'.freeze
+    VERSION = '1.6.0'.freeze
   end
 end

data/spec/features/end_to_end_spec.rb

@@ -94,6 +94,94 @@ RSpec.describe 'end to end', type: :feature, js: true do
     end
   end
 
+  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
+
+        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
+
+        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
+
   def expand_select_box
     find('.select2-container').click
   end

data/spec/internal/db/schema.rb

@@ -31,6 +31,26 @@ ActiveRecord::Schema.define do
     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

@@ -27,6 +27,22 @@ module Internal
   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.5.0
+  version: 1.6.0
 platform: ruby
 authors:
 - Codevise Solutions Ltd
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-02-16 00:00:00.000000000 Z
+date: 2022-04-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler