activeadmin-searchable_select 1.4.0 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fe0935611dac081858397d808fa99c65a72944153ce323c8b10f3afb96657a83
-  data.tar.gz: e5c1faa951288612248a1f87f4ed1961f7f45861b7ac1946a404c5f15030f656
+  metadata.gz: eae3cd46ff6e641c50c4f6e02c7aa4ab8105a160740c07fd82efea3eb4af26e8
+  data.tar.gz: 37274666f643b0df81a37aa0dbbd197cc7b94f45ef804398496a1ecbb3f1094f
 SHA512:
-  metadata.gz: '097917cab8c292dcf3cdab69661ff59f6a0377698514b6f7323b28a3a70bc2c3f66c41b64a7e26ae47f981559f791d6ae35df96ec1a736f214fcd7753cd25693'
-  data.tar.gz: 10592311d0cf0ad805abaf218ce97a9af4ff8a8350b861571465e01106815d6b3eaddd9641f2256e5323e5a05a6ed7cd0759a6531cdfe5af2cf858e69affedf2
+  metadata.gz: a0448e24dbb3c48ca7421eca976836d5be764e91db9e89a129e8c9b47dbb5dbbbdb94ac8937d049b5af35d6c68a17933bc6e3712719fd920b125e65d29147b88
+  data.tar.gz: 4c90fe918890f40de37d138ba3b82b12307bf5331772a0dd8a139afb1698a8cf3a95620a72372415437b103851ee4ae574807d11a888cd8b850a6d360a2af6e9

data/CHANGELOG.md

@@ -1,16 +1,14 @@
 # CHANGELOG
 
-### Version 1.4.0
+### Version 1.5.0
 
-2021-02-04
+2021-02-16
 
-[Compare changes](https://github.com/codevise/activeadmin-searchable_select/compare/1-3-stable...v1.4.0)
+[Compare changes](https://github.com/codevise/activeadmin-searchable_select/compare/1-4-stable...v1.5.0)
 
-- Support admin resources for namespaced models.
-  ([#30](https://github.com/codevise/activeadmin-searchable_select/pull/30))
-- Improve README.md
-  ([#28](https://github.com/codevise/activeadmin-searchable_select/pull/28))
+- Allow adding additional payload to option items in AJAX response
+  ([#33](https://github.com/codevise/activeadmin-searchable_select/pull/33))
 
 See
-[1-3-stable branch](https://github.com/codevise/activeadmin-searchable_select/blob/1-3-stable/CHANGELOG.md)
+[1-4-stable branch](https://github.com/codevise/activeadmin-searchable_select/blob/1-4-stable/CHANGELOG.md)
 for previous changes.

data/README.md

@@ -193,6 +193,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:

data/lib/activeadmin/searchable_select/option_collection.rb

@@ -8,6 +8,7 @@ module ActiveAdmin
         @display_text = extract_display_text_option(options)
         @filter = extract_filter_option(options)
         @per_page = options.fetch(:per_page, 10)
+        @additional_payload = options.fetch(:additional_payload, {})
       end
 
       def scope(template, params)
@@ -38,7 +39,7 @@ module ActiveAdmin
           {
             id: record.id,
             text: display_text(record)
-          }
+          }.merge(hash_of_additional_payload(record) || {})
         end
 
         { results: results, pagination: { more: more } }
@@ -98,6 +99,21 @@ module ActiveAdmin
           ->(term, scope) { scope.ransack("#{text_attribute}_cont" => term).result }
         end
       end
+
+      def build_additional_payload(record)
+        case @additional_payload
+        when Proc
+          @additional_payload.call(record).to_h
+        else
+          {}
+        end
+      end
+
+      def hash_of_additional_payload(record)
+        return nil if @additional_payload.nil? && @additional_payload.empty?
+
+        build_additional_payload(record)
+      end
     end
   end
 end

data/lib/activeadmin/searchable_select/resource_dsl_extension.rb

@@ -26,6 +26,23 @@ module ActiveAdmin
       #
       # @param name [Symbol] Optional collection name if helper is
       #   used multiple times within one resource.
+      #
+      # @param additional_payload [Proc]
+      #   Adds additional attributes to the results array
+      # @example
+      #
+      #   ActiveAdmin.register Tag do
+      #     searchable_select_options(
+      #       scope: Color,
+      #       text_attributes: :title,
+      #       additional_payload: lambda { |record| { color: record.color } }
+      #     )
+      #   end
+      # @json
+      # {
+      #   "results": [{ "id": "1", "text": "Red", "color": "#FFF" }],
+      #   "pagination": { "more": "false" }
+      # }
       def searchable_select_options(name: :all, **options)
         option_collection = OptionCollection.new(name, options)
         config.searchable_select_option_collections[name] = option_collection

data/lib/activeadmin/searchable_select/version.rb

@@ -1,5 +1,5 @@
 module ActiveAdmin
   module SearchableSelect
-    VERSION = '1.4.0'.freeze
+    VERSION = '1.5.0'.freeze
   end
 end

data/spec/features/options_dsl_spec.rb

@@ -140,6 +140,60 @@ RSpec.describe 'searchable_select_options dsl', type: :request do
     end
   end
 
+  describe 'with additional_payload' do
+    context 'as lambda' do
+      before(:each) do
+        ActiveAdminHelpers.setup do
+          ActiveAdmin.register(Post) do
+            searchable_select_options(
+              scope: Post,
+              text_attribute: :title,
+              additional_payload: lambda do |record|
+                { published: record.published }
+              end
+            )
+          end
+        end
+      end
+      let!(:post) { Post.create!(title: 'A post', published: false) }
+
+      subject { get '/admin/posts/all_options' }
+
+      it 'returns options with our additional attribute' do
+        subject
+        expect(json_response).to match(
+          results: [{ text: 'A post', id: post.id, published: false }],
+          pagination: { more: false }
+        )
+      end
+    end
+
+    context 'as Proc' do
+      before(:each) do
+        ActiveAdminHelpers.setup do
+          ActiveAdmin.register(Post) do
+            searchable_select_options(
+              scope: Post,
+              text_attribute: :title,
+              additional_payload: proc { |record| { published: record.published } }
+            )
+          end
+        end
+      end
+      let!(:post) { Post.create!(title: 'A post', published: false) }
+
+      subject { get '/admin/posts/all_options' }
+
+      it 'returns options with our additional attribute' do
+        subject
+        expect(json_response).to match(
+          results: [{ text: 'A post', id: post.id, published: false }],
+          pagination: { more: false }
+        )
+      end
+    end
+  end
+
   it 'allows passing lambda as scope' do
     ActiveAdminHelpers.setup do
       ActiveAdmin.register(Post) do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: activeadmin-searchable_select
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.5.0
 platform: ruby
 authors:
 - Codevise Solutions Ltd
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-02-04 00:00:00.000000000 Z
+date: 2021-02-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler