administrate_ransack 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9e2ce06e06ce00cd336d5aad861c93657137a0c059a45bb3d1110c2a8c441ba6
-  data.tar.gz: eb5dae4623fb4c1c1270e785b423f2a82f619fe6d22bdd4a799be309d90b21dc
+  metadata.gz: 32afd347fc9d0dda302dca3c72f83a214a22f49394fbf987f45800ab1d549a90
+  data.tar.gz: 7c355e92c9b79610fa9bc8323e0f8231deb22b05ce1204446f5a72a61ff21749
 SHA512:
-  metadata.gz: 990b321779498d5f4a73cdf2846a16777767d4b860d69f913785528be4746f2dc50b5e77fcf4cbb8eaf8f439809d7e09678f9e8b14ebb4a7b55b7dae18f848d9
-  data.tar.gz: c2683c29c7b9d7bb02c71ec5c7349cd104431af0c0b7c31b8e90e8eb88772d107cd0390c709ce171c1d99d3ceeb1843f65566ac4c2d4f8896915783b96756b01
+  metadata.gz: 1e374f0de682af5cfbdfaf26274768016bfa4446d64e1ca47052a20339d81baa0cc62dc0b08542af0e52c0a0ef1987b080ee015e2ed09ad5d09fecb6815a4671
+  data.tar.gz: b42a18d64406cbf2e91594c5f7f740508cdc0fb3ed641e0216c551f2a7d2b1467154613dfc9be744faa8863e529b61194ccffe9b28794c5cac6acb07878d44b4

data/README.md

@@ -27,6 +27,24 @@ prepend AdministrateRansack::Searchable
 <%= render('administrate_ransack/filters') %>
 ```
 
+- Update your model (ex. Post) exposing the ransackable attributes and associations, skipping this step will raise an exception that explains in details:
+
+```rb
+class Post < ApplicationRecord
+  # ...
+
+  class << self
+    def ransackable_attributes(_auth_object = nil)
+      %w[title description]
+    end
+
+    def ransackable_associations(_auth_object = nil)
+      %w[author]
+    end
+  end
+end
+```
+
 - See the Usage section for extra options
 
 ## Usage
@@ -99,6 +117,21 @@ end
 
 ## Customizations
 
+- Ransack options can be customized defining a `ransack_options` method in the controller, example:
+
+```rb
+module Admin
+  class PostsController < Admin::ApplicationController
+    prepend AdministrateRansack::Searchable
+
+    def ransack_options
+      # raises an exception on unknown parameters
+      { ignore_unknown_conditions: false }
+    end
+  end
+end
+```
+
 - Sample call of the filters partial with different options provided:
 
 ```erb

data/lib/administrate_ransack/searchable.rb

@@ -5,7 +5,8 @@ require 'ransack'
 module AdministrateRansack
   module Searchable
     def scoped_resource
-      @ransack_results = super.ransack(params[:q])
+      options = respond_to?(:ransack_options) ? ransack_options : {}
+      @ransack_results = super.ransack(params[:q], **options)
       @ransack_results.result(distinct: true)
     end
 

data/lib/administrate_ransack/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module AdministrateRansack
-  VERSION = '0.5.0'
+  VERSION = '0.6.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: administrate_ransack
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Mattia Roccoberton
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-09-10 00:00:00.000000000 Z
+date: 2024-07-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: administrate
@@ -28,16 +28,22 @@ dependencies:
   name: ransack
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '2.3'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '2.3'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5'
 description: A plugin for Administrate to use Ransack for search filters
 email:
 - mat@blocknot.es