Merge branch 'codevise:master' into master

Author: alexgreat70

.github/workflows/tests.yml

@@ -0,0 +1,42 @@
+name: tests
+on:
+  push:
+  pull_request:
+  schedule:
+    - cron: '45 2 * * *'
+
+jobs:
+  rspec:
+    runs-on: ubuntu-latest
+
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby-version:
+          - '2.6'
+          - '2.7'
+        gemfile:
+          - gemfiles/rails_5.1_active_admin_1.x.gemfile
+          - gemfiles/rails_5.x_active_admin_1.x.gemfile
+          - gemfiles/rails_5.x_active_admin_2.x.gemfile
+          - gemfiles/rails_6.x_active_admin_2.x.gemfile
+        include:
+          - ruby-version: '3.0'
+            gemfile: gemfiles/rails_6.x_active_admin_2.x.gemfile
+          - ruby-version: '3.0'
+            gemfile: gemfiles/rails_6.x_active_admin_3.x.gemfile
+          - ruby-version: '3.0'
+            gemfile: gemfiles/rails_7.x_active_admin_3.x.gemfile
+
+    env:
+      BUNDLE_GEMFILE: ${{ matrix.gemfile }}
+
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+          bundler-cache: true
+      - name: Run tests
+        run: bundle exec rspec

.gitignore

@@ -6,4 +6,8 @@ Gemfile.lock
 /pkg/*
 /spec/internal/tmp
 /spec/internal/db/*.sqlite
-/spec/examples.txt
+/spec/internal/db/*.sqlite-shm
+/spec/internal/db/*.sqlite-wal
+/spec/examples.txt
+/src
+/node_modules

.rubocop.yml

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

.travis.yml

@@ -1,10 +1,3 @@
-appraise 'rails-4.2-active-admin-1.0.0.pre4' do
-  gem 'rails', '~> 4.2'
-  gem 'activeadmin', '1.0.0.pre4'
-  gem 'jquery-ui-rails', '~> 5.0'
-  gem 'sqlite3', '~> 1.3.6'
-end
-
 appraise 'rails-5.1-active-admin-1.x' do
   gem 'rails', '~> 5.1.0'
   gem 'activeadmin', '~> 1.0'
@@ -18,4 +11,19 @@ end
 appraise 'rails-5.x-active-admin-2.x' do
   gem 'rails', '~> 5.2'
   gem 'activeadmin', '~> 2.0'
-end
+end
+
+appraise 'rails-6.x-active-admin-2.x' do
+  gem 'rails', '~> 6.1'
+  gem 'activeadmin', '~> 2.0'
+end
+
+appraise 'rails-6.x-active-admin-3.x' do
+  gem 'rails', '~> 6.1'
+  gem 'activeadmin', '~> 3.0'
+end
+
+appraise 'rails-7.x-active-admin-3.x' do
+  gem 'rails', '~> 7.1'
+  gem 'activeadmin', '~> 3.0'
+end

Appraisals

@@ -2,10 +2,10 @@
 
 ### Unreleased Changes
 
-[Compare changes](https://github.com/codevise/activeadmin-searchable_select/compare/1-2-stable...master)
+[Compare changes](https://github.com/codevise/activeadmin-searchable_select/compare/1-8-stable...master)
 
 None so far.
 
 See
-[1-2-stable branch](https://github.com/codevise/activeadmin-searchable_select/blob/1-2-stable/CHANGELOG.md)
+[1-8-stable branch](https://github.com/codevise/activeadmin-searchable_select/blob/1-8-stable/CHANGELOG.md)
 for previous changes.

CHANGELOG.md

@@ -1,7 +1,9 @@
 # ActiveAdmin Searchable Select
 
 [![Gem Version](https://badge.fury.io/rb/activeadmin-searchable_select.svg)](http://badge.fury.io/rb/activeadmin-searchable_select)
-[![Build Status](https://travis-ci.org/codevise/activeadmin-searchable_select.svg?branch=master)](https://travis-ci.org/codevise/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/actions/workflows/tests.yml/badge.svg)](https://github.com/codevise/activeadmin-searchable_select/actions)
 
 Searchable select boxes (via [Select2](https://select2.org/)) for
 ActiveAdmin forms and filters. Extends the ActiveAdmin resource DSL to
@@ -12,9 +14,10 @@ allow defining JSON endpoints to fetch options from asynchronously.
 Add `activeadmin-searchable_select` to your Gemfile:
 
 ```ruby
-   gem 'activeadmin-searchable_select
+   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
@@ -193,6 +229,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 +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),
@@ -238,12 +354,35 @@ 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
 
 ```
 
+### Passing 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.
+For example you can tell Select2 how long to wait after a user
+has stopped typing before sending the request:
+
+```ruby
+   ...
+   f.input(:category,
+           as: :searchable_select,
+           ajax: true,
+           input_html: {
+             data: {
+               'ajax--delay' => 500
+             }
+           })
+   ...
+```
+
+
 ## Development
 
 To run the tests install bundled gems and invoke RSpec:

README.md

@@ -14,22 +14,28 @@ Gem::Specification.new do |spec|
   spec.files         = `git ls-files -z`.split("\x0")
   spec.require_paths = ['lib']
 
-  spec.required_ruby_version = '~> 2.1'
+  spec.required_ruby_version = ['>= 2.1', '< 4']
 
-  spec.add_development_dependency 'bundler', '~> 1.5'
+  spec.add_development_dependency 'bundler', ['>= 1.5', '< 3']
   spec.add_development_dependency 'rake'
   spec.add_development_dependency 'appraisal', '~> 2.2'
   spec.add_development_dependency 'rspec-rails', '~> 3.6'
   spec.add_development_dependency 'combustion', '~> 1.0'
-  spec.add_development_dependency 'database_cleaner', '~> 1.6'
+  spec.add_development_dependency 'database_cleaner-active_record', '~> 2.1'
   spec.add_development_dependency 'sqlite3', '~> 1.3'
-  spec.add_development_dependency 'capybara', '~> 2.15'
-  spec.add_development_dependency 'poltergeist', '~> 1.15'
+
+  spec.add_development_dependency 'capybara', '~> 3.9'
+  spec.add_development_dependency 'puma', '~> 5.0'
+  spec.add_development_dependency 'selenium-webdriver', '~> 4.1'
+  spec.add_development_dependency 'webdrivers', '= 5.3.0'
+
+  spec.add_development_dependency 'coffee-rails'
+  spec.add_development_dependency 'rails'
   spec.add_development_dependency 'rubocop', '~> 0.42.0'
   spec.add_development_dependency 'semmy', '~> 1.0'
-  spec.add_development_dependency 'rails'
+  spec.add_development_dependency 'sprockets', '~> 3.7'
 
-  spec.add_runtime_dependency 'activeadmin', ['>= 1.x', '< 3']
+  spec.add_runtime_dependency 'activeadmin', ['>= 1.x', '< 4']
   spec.add_runtime_dependency 'jquery-rails', ['>= 3.0', '< 5']
   spec.add_runtime_dependency 'select2-rails', '~> 4.0'
 end

activeadmin-searchable_select.gemspec

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