activeadmin-searchable_select 1.5.0 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eae3cd46ff6e641c50c4f6e02c7aa4ab8105a160740c07fd82efea3eb4af26e8
-  data.tar.gz: 37274666f643b0df81a37aa0dbbd197cc7b94f45ef804398496a1ecbb3f1094f
+  metadata.gz: afca3ffb2bd7868c51afc6e6793fc4b3080a1fdb0f92a248ccdbe264faa58597
+  data.tar.gz: defeafa115233119aacc2bde15424810bdd1fd05187c2c48536879586b96b00b
 SHA512:
-  metadata.gz: a0448e24dbb3c48ca7421eca976836d5be764e91db9e89a129e8c9b47dbb5dbbbdb94ac8937d049b5af35d6c68a17933bc6e3712719fd920b125e65d29147b88
-  data.tar.gz: 4c90fe918890f40de37d138ba3b82b12307bf5331772a0dd8a139afb1698a8cf3a95620a72372415437b103851ee4ae574807d11a888cd8b850a6d360a2af6e9
+  metadata.gz: 527c21ae72869785419007a81436186684d589e87abc4aeb64213a8fe46af2ca1701e98296f8d2a9c64c756a9331a625aac166994591a57d1c43c70cf277ccb0
+  data.tar.gz: 71f29f997879afec190f430697d57362dba21802e322b8045d20b247f3c1ef0df8ed8b88b0a84a4e43910dda1ef9221050e8843fac45133b3c9fd15defe028be

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,17 @@
 # CHANGELOG
 
-### Version 1.5.0
+### Version 1.7.0
 
-2021-02-16
+2023-05-03
 
-[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-6-stable...v1.7.0)
 
-- Allow adding additional payload to option items in AJAX response
-  ([#33](https://github.com/codevise/activeadmin-searchable_select/pull/33))
+- Fix pre-selected item when using belongs_to
+  ([#43](https://github.com/codevise/activeadmin-searchable_select/pull/43),
+   [#44](https://github.com/codevise/activeadmin-searchable_select/pull/44))
+- Improvement the examples in Readme for import npm assets
+  ([#41](https://github.com/codevise/activeadmin-searchable_select/pull/41))
 
 See
-[1-4-stable branch](https://github.com/codevise/activeadmin-searchable_select/blob/1-4-stable/CHANGELOG.md)
+[1-6-stable branch](https://github.com/codevise/activeadmin-searchable_select/blob/1-6-stable/CHANGELOG.md)
 for previous changes.

data/README.md

@@ -1,6 +1,8 @@
 # ActiveAdmin Searchable Select
 
 [![Gem Version](https://badge.fury.io/rb/activeadmin-searchable_select.svg)](http://badge.fury.io/rb/activeadmin-searchable_select)
+[![NPM Version](https://badge.fury.io/js/@codevise%2Factiveadmin-searchable_select.svg)](https://badge.fury.io/js/@codevise%2Factiveadmin-searchable_select)
+[![npm](https://img.shields.io/npm/dm/@codevise/activeadmin-searchable_select)](https://www.npmjs.com/package/@codevise/activeadmin-searchable_select)
 [![Build Status](https://github.com/codevise/activeadmin-searchable_select.svg?branch=master)](https://github.com/codevise/activeadmin-searchable_select/actions)
 
 Searchable select boxes (via [Select2](https://select2.org/)) for
@@ -15,6 +17,7 @@ Add `activeadmin-searchable_select` to your Gemfile:
    gem 'activeadmin-searchable_select'
 ```
 
+##### Using assets via Sprockets
 Import stylesheets and require javascripts:
 
 ```scss
@@ -27,6 +30,39 @@ Import stylesheets and require javascripts:
 //= require active_admin/searchable_select
 ```
 
+##### Using assets via Webpacker (or any other assets bundler) as a NPM module (Yarn package)
+
+Execute:
+
+    $ npm i @codevise/activeadmin-searchable_select
+
+Or
+
+    $ yarn add @codevise/activeadmin-searchable_select
+
+Or add manually to `package.json`:
+
+```json
+"dependencies": {
+  "@codevise/activeadmin-searchable_select": "1.6.0"
+}
+```
+and execute:
+
+    $ yarn
+
+Add the following line into `app/javascript/active_admin.js`:
+
+```javascript
+import '@codevise/activeadmin-searchable_select';
+```
+
+Add the following line into `app/javascript/stylesheets/active_admin.scss`:
+
+```css
+@import '@codevise/activeadmin-searchable_select';
+```
+
 ## Usage
 
 ### Making Select Boxes Searchable
@@ -242,6 +278,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 +362,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/app/assets/javascripts/active_admin/searchable_select_pack.js

@@ -0,0 +1,2 @@
+import 'select2';
+import './searchable_select/init';

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,
          '?',
@@ -80,7 +84,7 @@ module ActiveAdmin
       end
 
       def option_collection_scope
-        option_collection.scope(template, ajax_params)
+        option_collection.scope(template, path_params.merge(ajax_params))
       end
 
       def option_collection
@@ -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.7.0'.freeze
   end
 end

data/package.json

@@ -0,0 +1,38 @@
+{
+  "name": "@codevise/activeadmin-searchable_select",
+  "version": "1.7.0",
+  "description": "Use searchable selects based on Select2 in Active Admin forms and filters.",
+  "main": "src/searchable_select.js",
+  "style": "src/searchable_select.scss",
+  "repository": "git@github.com:codevise/activeadmin-searchable_select.git",
+  "author": "Codevise Solutions Ltd <info@codevise.de>",
+  "license": "MIT",
+  "private": false,
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/codevise/activeadmin-searchable_select.git"
+  },
+  "bugs": {
+    "url": "https://github.com/codevise/activeadmin-searchable_select/issues"
+  },
+  "homepage": "https://github.com/codevise/activeadmin-searchable_select#readme",
+  "keywords": [
+    "select2",
+    "active",
+    "admin",
+    "searchable",
+    "select"
+  ],
+  "dependencies": {
+    "jquery": ">= 3.0, < 5",
+    "select2": "~> 4.0"
+  },
+  "files": [
+    "src/**/*"
+  ],
+  "scripts": {
+    "prepare_javascripts_src": "rm -rf src && cp -R app/assets/javascripts/active_admin/ src && mv src/searchable_select_pack.js src/searchable_select.js",
+    "prepare_stylesheets_src": "cp -R app/assets/stylesheets/active_admin/* src",
+    "prepublishOnly": "npm run prepare_javascripts_src && npm run prepare_stylesheets_src"
+  }
+}

data/spec/features/end_to_end_spec.rb

@@ -94,6 +94,110 @@ 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
+
+    describe 'edit page with searchable select filter' do
+      it 'preselects item' do
+        option_type = OptionType.create(name: 'Color')
+        ot = OptionType.create(name: 'Size')
+        option_value = 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)
+        variant = Variant.create(product: product, option_value: option_value)
+
+        visit "/admin/products/#{product.id}/variants/#{variant.id}/edit"
+
+        expect(select_box_selected_item_text).to eq('Black')
+      end
+    end
+  end
+
   def expand_select_box
     find('.select2-container').click
   end
@@ -110,6 +214,10 @@ RSpec.describe 'end to end', type: :feature, js: true do
     all('.select2-dropdown li').map(&:text)
   end
 
+  def select_box_selected_item_text
+    find('.select2-selection').text
+  end
+
   def wait_for_ajax
     Timeout.timeout(Capybara.default_max_wait_time) do
       sleep 0.1

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.7.0
 platform: ruby
 authors:
 - Codevise Solutions Ltd
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-02-16 00:00:00.000000000 Z
+date: 2023-05-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -314,6 +314,7 @@ files:
 - activeadmin-searchable_select.gemspec
 - app/assets/javascripts/active_admin/searchable_select.js
 - app/assets/javascripts/active_admin/searchable_select/init.js
+- app/assets/javascripts/active_admin/searchable_select_pack.js
 - app/assets/stylesheets/active_admin/searchable_select.scss
 - bin/rspec
 - gemfiles/rails_5.1_active_admin_1.x.gemfile
@@ -330,6 +331,7 @@ files:
 - lib/activeadmin/searchable_select/resource_extension.rb
 - lib/activeadmin/searchable_select/select_input_extension.rb
 - lib/activeadmin/searchable_select/version.rb
+- package.json
 - spec/features/ajax_params_spec.rb
 - spec/features/end_to_end_spec.rb
 - spec/features/filter_input_spec.rb
@@ -375,7 +377,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.8
+rubygems_version: 3.2.3
 signing_key: 
 specification_version: 4
 summary: Use searchable selects based on Select2 in Active Admin forms and filters.