active_admin_auto_select 0.1.9 → 0.1.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: eb807c9098ae35252ffa0c72703a0c102a0a091c
-  data.tar.gz: 5423078c35c2e10a45f9ef6638c5a6756b4d0479
+  metadata.gz: f67a66ea734c425a23696088c318f40203046088
+  data.tar.gz: f54bc1ec07043c15a41b7808a9a8c5b2d8e5acdc
 SHA512:
-  metadata.gz: 3b97ef4ca1f7761563faa8b26b3e8ee44ad5aebba46bf569cc75da0c284bdb0274a681ef98e6d76c97b4b3fbcc266cc4b842fe0ba85eca84bc394460b5291428
-  data.tar.gz: ce1754441997f2589e1d3ab4ad2b486fa0834cc6b8fffe01408c35f590250906481d1e3566425f374f54416c83a6c9446b7c769c4fa3819d1b69252d7de2547f
+  metadata.gz: 80c8f878690641ae60a7ba90f635971a695eca263a9d66ce3b4e563b2f2f33c3a8cd9851aa4e0d1b582f23a45f0f2845c5c6eb7d73c1b758f6db05f23148eea5
+  data.tar.gz: c4950f69e39152d7a8346fbaf48cc27e016673122fcd967a55a9fb4e57b8a0106d11588fcc4cd7c2d746d41d7a34e4b34aa98be2afaed2b43b2e1a668b7db594

data/README.md

@@ -1,6 +1,8 @@
 # ActiveAdminAutoSelect
 
-This gem is a little widget which combines Select2, PostgeSQL and ActiveAdmin and helps you filter objects in ActiveAdmin with autocomplete of the selected fields.
+This gem is a nifty UI widget, which combines the Select2 library, PostgeSQL and ActiveAdmin,
+for helping you filter records in ActiveAdmin using auto-completion, based on certain database
+columns of your choice.
 
 ![Image of AutoSelect](http://i.imgur.com/lEJmaQC.png)
 ![Image of AutoSelect](http://i.imgur.com/6s0Xnco.png)
@@ -10,50 +12,89 @@ This gem is a little widget which combines Select2, PostgeSQL and ActiveAdmin an
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'admin_auto_select'
+gem 'active_admin_auto_select'
 ```
 
+Currently, [Select2 3.5](http://select2.github.io/select2/) is required. Select2 versions 4+
+are not compatible as the API contains [breaking changes](https://select2.org/upgrading/new-in-40).
+We are looking to remedy this as soon as possible.
+
 And then execute:
 
-    $ bundle
-    
-Add the following directive to your Javascript manifest file:
+```console
+> bundle
+```
+
+Add the following directives to your Javascript manifest file:
 
-``
+```javascript
+//= require select2
+//= require underscore
 //= require autoselect
-``
+```
 
-## Usage
+Or for Coffeescript flavor, add this:
+
+```coffeescript
+#= require select2
+#= require underscore
+#= require autoselect
+```
 
-After installing the gem, you have to add some lines into the model you want to auto_select. 
-For example, if you want to add the widget to the users id filter:
+Add the following directive to your Stylesheet manifest file:
 
-#### Call the method defined in the module in order to create the collection_action
+```scss
+@import "select2";
+```
+
+## Usage
+
+After installing the gem, you have to add some lines into the ActiveAdmin controller you want to auto_select. 
+For example, say you want to add the widget in order to filter to the users' `id` filter, by searching in their full names or emails:
 
-first_name, :last_name, :email are the fields which help you find the desired user
+### Call the `auto_select` method in order to create the collection_action
 
 ```ruby
- auto_select :first_name, :last_name, :email
+auto_select :first_name, :last_name, :email,
+  {
+    'users_with_properties' => ->{ User.joins(:properties).uniq }
+  }
 ```
 
-#### Then change the relevant filter in your model
+In the example above, `first_name`, `:last_name` and `:email` are the database columns that help you find the desired user.
+Anything that is typed into the autocomplete field will be lookup in the columns specified here. Last argument is a Hash of
+scopes that will make sense by reading through the next example.
 
-Notice: :id_eq is necessary.
-data-scope is the desired scope which will be used by the widget in order to fetch the similar users.
-data-url is also necessary and is the url generated by the action which is defined in the module.
+### Define the relevant `filter` in your controller
 
 ```ruby
-  filter :id_eq, label: "User", input_html: { data: { scope: 'user',
-                                                        url: 'users/autoselect',
-                                                placeholder: 'Select user'     } }
+filter :id_eq, label: 'User',
+  input_html: {
+    data: {
+      scope: 'users_with_properties',
+      url: 'users/autoselect',
+      placeholder: 'Select a user'
+    }
+  }
 ```
 
-#### Instantiate the js class in your active_admin js file with the generated filter input.
+#### Notice
 
-```
-newAutoSelect = new AutoSelect(input: $("#q_id_eq))
+- `:id_eq` (required) is the column being filtered `id` + the `_eq` suffix (Ransack style).
+- `data-scope` option is the desired scope that will be used by the widget in order to fetch the similar users.
+- `data-url` (required) is the url generated by the action, which is defined in the ActiveAdmin controller.
+
+### Instantiate the `AutoSelect` Javascript class in your active_admin's javascript file.
+
+```javascript
+$(document).ready ->
+  newAutoSelect = new AutoSelect(input: $('#q_id_eq'))
+  newAutoSelect.init()
 ```
 
+Where `#q_user_id_eq` use the generated input's `id` of the filter you added. For instance,
+if your filter's name in the ActiveAdmin controller is defined as `id_eq`, then the `id`
+attribute of the generated input will be `q_id_eq`.
 
 ## Contributing
 

data/active_admin_auto_select.gemspec

@@ -15,6 +15,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
   spec.add_development_dependency "bundler", "~> 1.10"
   spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_dependency "select2-rails"
+  spec.add_dependency "select2-rails", "3.5.2"
+  spec.add_dependency "underscore-rails"
   spec.add_dependency "pg"
 end

data/lib/active_admin_auto_select.rb

@@ -4,7 +4,12 @@ require 'active_admin_auto_select/rails'
 module AutoSelectable
   def auto_select(*fields)
     options = fields.extract_options!
-    create_collection_action(fields, options, @resource)
+
+    # The @resource instance variable seems unavailable in versions 
+    # later than 1.0.0.pre1 of the ActiveAdmin.
+    resource = @resource || self.config.resource_class_name.constantize
+    
+    create_collection_action(fields, options, resource)
   end
 
   def create_collection_action(fields, options, resource)
@@ -27,7 +32,11 @@ module AutoSelectable
            resources = effective_scope.call.
              where("#{resource.table_name}.id IN (?)", params[:ids]).
              select(select_fields)
-           resources = resources.first if resources.size == 1
+           if resources.size == 1
+             resources = resources.first
+           else
+             resources = resources.sort_by { |r| params[:ids].index(r.id.to_s) }
+           end
            render json: resources and return
         else
           concat_fields = fields.join(" || ' '::text || ")

data/lib/active_admin_auto_select/rails.rb

@@ -1,6 +1,8 @@
 module Autoselect
   module Rails
     class Engine < ::Rails::Engine
+      require 'select2-rails'
+      require 'underscore-rails'
     end
   end
 end

data/lib/active_admin_auto_select/version.rb

@@ -1,3 +1,3 @@
 module AdminAutoSelect
-  VERSION = "0.1.9"
+  VERSION = "0.1.10"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: active_admin_auto_select
 version: !ruby/object:Gem::Version
-  version: 0.1.9
+  version: 0.1.10
 platform: ruby
 authors:
 - spyrbri
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-19 00:00:00.000000000 Z
+date: 2017-09-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -40,6 +40,20 @@ dependencies:
         version: '10.0'
 - !ruby/object:Gem::Dependency
   name: select2-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.5.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.5.2
+- !ruby/object:Gem::Dependency
+  name: underscore-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -107,7 +121,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.5
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
 summary: This gem helps you select a row of a column in a model with autocomplete