activeadmin-searchable_select 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e45366aab36050f1bacd26cf7c7e083f73366337
+  data.tar.gz: 41b977d5f33c903293d2cccccfcabf2de910c71a
+SHA512:
+  metadata.gz: 48d3f353accca041a2bc5d533cc8574d6f895f7b04fca7354b5d10e6fc73c3ae276b555ed031ea8226bcfc0a68f70c49657f737df9c51fb0f6f316700d34c2a4
+  data.tar.gz: 1114951d8895a4a25a1e56162d099c9fc60592241ec79b9ee8c573fed3db93e427b3137f41d555c3a658eef3f0df6cecf2a3f4034e8102a8a4280cfa97336a8e

data/.gitignore

@@ -0,0 +1,9 @@
+.bundle
+.ruby-version
+.ruby-gemset
+Gemfile.lock
+/gemfiles/*.lock
+/pkg/*
+/spec/internal/tmp
+/spec/internal/db/*.sqlite
+/spec/examples.txt

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,10 @@
+AllCops:
+  TargetRubyVersion: 2.3
+
+# The default of 80 characters is a little to narrow.
+Metrics/LineLength:
+  Max: 100
+
+# Do not warn about missing magic comment
+Style/FrozenStringLiteralComment:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,16 @@
+language: ruby
+rvm:
+  - 2.3.4
+
+# Use container based travis infrastructure which allows caching
+# features for open source projects.
+sudo: false
+cache:
+  bundler: true
+
+gemfile:
+  - gemfiles/rails_4.2_active_admin_1.0.0.pre4.gemfile
+  - gemfiles/rails_5.1_active_admin_1.0.gemfile
+  - gemfiles/rails_5.1_active_admin_1.1.gemfile
+
+script: bundle exec rspec

data/.yardopts

@@ -0,0 +1,2 @@
+--no-private
+--markup markdown

data/Appraisals

@@ -0,0 +1,15 @@
+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'
+end
+
+appraise 'rails-5.1-active-admin-1.0' do
+  gem 'rails', '~> 5.1'
+  gem 'activeadmin', '~> 1.0'
+end
+
+appraise 'rails-5.1-active-admin-1.1' do
+  gem 'rails', '~> 5.1'
+  gem 'activeadmin', '~> 1.1'
+end

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+# CHANGELOG
+
+### Version 1.0.0
+
+2017-10-23
+
+- Initial release.

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,25 @@
+
+Copyright for portions of `codevise/activeadmin-searchable_select`
+held by Mark Fariburn, Praxitar Ltd, 2014 as part of
+`mfairburn/activeadmin-select2` which this project is based on. All
+other copyright for `codevise/activeadmin-searchable_select` held by
+Codevise Solutions Ltd, 2017.
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,247 @@
+# 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)
+
+Searchable select boxes (via [Select2](https://select2.org/)) for
+ActiveAdmin forms and filters. Extends the ActiveAdmin resource DSL to
+allow defining JSON endpoints to fetch options from asynchronously.
+
+## Installation
+
+Add `activeadmin-searchable_select` to your Gemfile:
+
+```ruby
+   gem 'activeadmin-searchable_select
+```
+
+Import stylesheets and require javascripts:
+
+```scss
+// active_admin.css.scss
+@import "active_admin/searchable_select";
+```
+
+```coffee
+# active_admin.js.coffee
+#= require active_admin/searchable_select
+```
+
+## Usage
+
+### Making Select Boxes Searchable
+
+To add search functionality to a select box, use the
+`:searchable_select` input type:
+
+```ruby
+   ActiveAdmin.register Product do
+     form do |f|
+       f.input(:category, as: :searchable_select)
+     end
+   end
+```
+
+This also works for filters:
+
+```ruby
+   ActiveAdmin.register Product do
+     filter(:category, as: :searchable_select)
+   end
+```
+
+### Fetching Options via Ajax
+
+For large collections, rendering the whole set of options can be to
+expensive. Use the `ajax` option to fetch a set of matching options
+once the user begins to type:
+
+```ruby
+
+   ActiveAdmin.register Product do
+     filter(:category,
+            as: :searchable_select,
+            ajax: true)
+   end
+```
+
+If the input attribute corresponds to an ActiveAdmin resource, it is
+expected to provide the JSON endpoint that provides the options. Use
+the `searchable_select_options` method to define the required
+collection action:
+
+```ruby
+   ActiveAdmin.register Category do
+     searchable_select_options(scope: Category.all,
+                               text_attribute: :name)
+   end
+```
+
+By default, `scope` needs to be a Ransack enabled ActiveRecord
+collection proxy determining which options are available. The
+attribute given by `text_attribute` will be used to get a display name
+for each record. Via Ransack, it is also used to filter by search
+term. Limiting result set size is handled automatically.
+
+You can customize the display text:
+
+```ruby
+   ActiveAdmin.register Category do
+     searchable_select_options(scope: Category.all,
+                               text_attribute: :name,
+                               display_text: ->(record) { "Category: #{record.name}" } )
+   end
+```
+
+Note that `text_attribute` is still required to perform filtering via
+Ransack. You can pass the `filter` option, to specify your own
+filtering strategy:
+
+```ruby
+   ActiveAdmin.register Category do
+     searchable_select_options(scope: Category.all,
+                               text_attribute: :name,
+                               filter: lambda |term, scope|
+                                 scope.ransack(name_cont_all: term.split(' ')).result
+                               end)
+   end
+```
+
+`scope` can also be a lambda which is evaluated in the context of the
+collection action defined by the helper:
+
+```ruby
+   ActiveAdmin.register Category do
+     searchable_select_options(scope: -> { Category.allowed_for(current_user) },
+                               text_attribute: :name)
+   end
+```
+
+If the input attribute is set on the form's object, ajax based
+searchable selects will automatically render a single option to ensure
+the selected item is displayed correctly even before options have been
+loaded asynchronously.
+
+#### Specifying the Options Endpoint Resource
+
+If the resource that provides the options endpoint cannot be guessed
+based on the input attribute name, you can pass an object with a
+`resource` key as `ajax` option:
+
+```ruby
+   ActiveAdmin.register Product do
+     form do |f|
+       f.input(:additional_category,
+               as: :searchable_select,
+               ajax: { resource: Category })
+     end
+   end
+```
+
+#### Mutlple Options Endpoints per Resource
+
+A single ActiveAdmin resource can define multiple options endpoints:
+
+```ruby
+   ActiveAdmin.register Category do
+     searchable_select_options(name: :favorites,
+                               scope: Category.favorites,
+                               text_attribute: :name)
+
+     searchable_select_options(name: :recent,
+                               scope: Category.recent,
+                               text_attribute: :name)
+   end
+```
+
+To specify which collection to use, pass an object with a
+`collection_name` key as `ajax` option:
+
+```ruby
+   ActiveAdmin.register Product do
+     form do |f|
+        f.input(:category,
+                as: :searchable_select,
+                ajax: { collection_name: :favorites })
+     end
+   end
+```
+
+#### Passing Parameters
+
+You can pass additional parameters to the options endpoint:
+
+```ruby
+   ActiveAdmin.register Product do
+     form do |f|
+        f.input(:category,
+                as: :searchable_select,
+                ajax: {
+                  params: {
+                    some: 'value'
+                  }
+                })
+     end
+   end
+```
+
+The lambda passed as `scope` can receive those parameters as first
+argument:
+
+```ruby
+   ActiveAdmin.register Category do
+     searchable_select_options(scope: lambda do |params|
+                                 Category.find_all_by_some(params[:some])
+                               end,
+                               text_attribute: :name)
+   end
+```
+
+#### Inlining Ajax Options in Feature Tests
+
+When writing UI driven feature specs (i.e. with Capybara),
+asynchronous loading of select options can increase test
+complexity. `activeadmin-searchable_select` provides an option to
+render all available options just like a normal select input while
+still exercsing the same code paths including `scope` and
+`text_attribute` handling.
+
+For example with RSpec/Capybara, simply set `inline_ajax_options` true
+for feature specs:
+
+```ruby
+  RSpec.configure do |config|
+    config.before(:each) do |example|
+      ActiveAdmin::Select2.inline_ajax_options = (example.metadata[:type] == :feature)
+    end
+  end
+
+```
+
+## Development
+
+To run the tests install bundled gems and invoke RSpec:
+
+```
+$ bundle
+$ bundle exec rspec
+```
+
+The test suite can be run against different versions of Rails and
+Active Admin (see `Appraisals` file):
+
+```
+$ appraisal install
+$ appraisal rspec
+```
+
+Please make sure changes conform with the styleguide:
+
+```
+$ bundle exec rubocop
+```
+
+## Acknowledgements
+
+Based on
+[mfairburn/activeadmin-select2](https://github.com/mfairburn/activeadmin-select2).

data/Rakefile

@@ -0,0 +1,6 @@
+# encoding: utf-8
+
+require 'bundler/gem_tasks'
+
+require 'semmy'
+Semmy::Tasks.install

data/activeadmin-searchable_select.gemspec

@@ -0,0 +1,37 @@
+# -*- encoding: utf-8 -*-
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'activeadmin/searchable_select/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'activeadmin-searchable_select'
+  spec.version       = ActiveAdmin::SearchableSelect::VERSION
+  spec.summary       = 'Use searchable selects based on Select2 in Active Admin forms and filters.'
+  spec.license       = 'MIT'
+  spec.authors       = ['Codevise Solutions Ltd']
+  spec.email         = 'info@codevise.de'
+  spec.homepage      = 'https://github.com/codevise/activeadmin-searchable_select'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.require_paths = ['lib']
+
+  spec.required_ruby_version = '~> 2.1'
+
+  spec.add_development_dependency 'bundler', '~> 1.5'
+  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', '~> 0.7.0'
+  spec.add_development_dependency 'database_cleaner', '~> 1.6'
+  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 'rubocop', '~> 0.42.0'
+  spec.add_development_dependency 'semmy', '~> 1.0'
+  spec.add_development_dependency 'rails'
+
+  spec.add_runtime_dependency 'activeadmin', '~> 1.x'
+  spec.add_runtime_dependency 'jquery-rails', ['>= 3.0', '< 5']
+  spec.add_runtime_dependency 'select2-rails', '~> 4.0'
+end

data/app/assets/javascripts/active_admin/searchable_select.js.coffee

@@ -0,0 +1,3 @@
+#= require select2
+
+#= require_tree ./searchable_select

data/app/assets/javascripts/active_admin/searchable_select/init.js.coffee

@@ -0,0 +1,29 @@
+'use strict';
+
+initSearchableSelects = (inputs, extra = {}) ->
+  inputs.each ->
+    item = $(this)
+    # reading from data allows <input data-searchable_select='{"tags": ['some']}'>
+    # to be passed to select2
+    options = $.extend(extra, item.data('searchableSelect'))
+    url = item.data('ajaxUrl');
+
+    if url
+      $.extend(
+        options,
+        ajax: {
+          url: url,
+          dataType: 'json'
+        }
+      )
+
+    item.select2(options)
+
+$(document).on 'has_many_add:after', '.has_many_container', (e, fieldset) ->
+  initSearchableSelects(fieldset.find('.searchable-select-input'))
+
+$(document).on 'page:load turbolinks:load', ->
+  initSearchableSelects($(".searchable-select-input"), placeholder: "")
+  return
+
+$(-> initSearchableSelects($(".searchable-select-input")))

data/app/assets/stylesheets/active_admin/searchable_select.scss

@@ -0,0 +1,5 @@
+@import "select2";
+
+.searchable_select.input .select2-container {
+  min-width: 30%;
+}