administrate_ransack 0.1.10 → 0.1.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a2dde6b1bd570497e553c4e737f4b48654af8470dfbe733c6e35a3bb74991b6e
-  data.tar.gz: e8fcfe208ba7ebc128ccfee07f816da649aa7a8ac0ab35e180e06832af070391
+  metadata.gz: 1be017567c90bc3b625f7db95063c8f79ec3176191d0ac8c97b2a720574d32da
+  data.tar.gz: c8ca5c07a2ce1e560d394736173db107a9b8a1177854bac626eb6c296e901f95
 SHA512:
-  metadata.gz: 5581bf2209ae91bb8b9b43ffe96be8cecbceadb22d0b0db05755c20443fd6b17ddfcbf70f500442c94c6bf05f4ad31ef3bb9243e3336b9f642b7ac4de4a520b0
-  data.tar.gz: cf69dfe636379448c07b703fbf1435f47fdfeb234b15683414215d756132277d8c1b80e7832e8c16fea2fbd1d0ee0e6a904ccde85d43ddcc0409133e6b8da278
+  metadata.gz: 97465a3a36becda93904588d3505376b76481d35cb5f710788568f578a476c43c7dc2ff49a7f7d3b733e1f42c6988c5182a69bd1eb0660f193b013a6d1b9dbc9
+  data.tar.gz: dc13be2b62e76b562169e1646b627d7d2c5e410b3625c37aa1982470ed33d052e382098de2fbca904207caf69a94ed144c4e7d2c7bfcf4605c9e57b0ee11d08b

data/README.md

@@ -19,9 +19,12 @@ prepend AdministrateRansack::Searchable
 - See the Customizations section to change the attributes list
 
 ## Usage
-For associations (has many/belongs to) the label used can be customized adding an `admin_label` method to the target model which returns a string while the collection can by filtered with `admin_scope`.
+- The filters partial accepts some optional parameters:
+  + `attribute_labels`: hash used to override the field labels, ex. `{ title: "The title" }`
+  + `attribute_types`: hash used to specify the filter fields, ex. `{ title: Administrate::Field::String }`
+  + `search_path`: the path to use for searching (form URL)
+- For associations (has many/belongs to) the label used can be customized adding an `admin_label` method to the target model which returns a string while the collection can by filtered with `admin_scope`. Example:
 
-Example:
 ```rb
 class Post < ApplicationRecord
   scope :admin_scope, -> { where(published: true) }
@@ -54,9 +57,10 @@ end
 ```
 
 ## Customizations
-- Allow only some fields for the filters in the index view:
+- Sample with different options provided:
 ```erb
 <%
+# In alternative prepare an hash in the dashboard like RANSACK_TYPES = {}
 attribute_types = {
   title: Administrate::Field::String,
   author: Administrate::Field::BelongsTo,
@@ -70,9 +74,14 @@ attribute_labels = {
 <%= render(
   'administrate_ransack/filters',
   attribute_types: attribute_types,
-  attribute_labels: attribute_labels
+  attribute_labels: attribute_labels,
+  search_path: admin_root_path
 ) %>
 ```
+- An alternative is to prepare some hashes constants in the dashboard (ex. `RANSACK_TYPES`) and then:
+```erb
+<%= render('administrate_ransack/filters', attribute_types: @dashboard.class::RANSACK_TYPES) %>
+```
 - Optional basic style to setup the filters as a sidebar:
 ```css
 .main-content__body {

data/app/views/administrate_ransack/_filters.html.erb

@@ -10,9 +10,18 @@
   </script>
 <% end %>
 
-<% attribute_labels ||= {} %>
-<% attribute_types ||= @dashboard.attribute_types.select { |key, _value| @dashboard.collection_attributes.include?(key) } %>
-<%= search_form_for [:admin, @ransack_results], html: { 'data-administrate-ransack-filters': '1' } do |f| %>
+<%
+  attribute_labels ||= {}
+  attribute_types ||= @dashboard.attribute_types.select { |key, _value| @dashboard.collection_attributes.include?(key) }
+  form_options = { html: { 'data-administrate-ransack-filters': '1' } }
+  if local_assigns.has_key?(:search_path)
+    form_path = @ransack_results
+    form_options[:url] = search_path
+  else
+    form_path = [:admin, @ransack_results]
+  end
+%>
+<%= search_form_for form_path, form_options do |f| %>
   <div class="filters">
     <% attribute_types.each do |field, type| %>
       <% next if field == :id %>

data/lib/administrate_ransack/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: administrate_ransack
 version: !ruby/object:Gem::Version
-  version: 0.1.10
+  version: 0.1.12
 platform: ruby
 authors:
 - Mattia Roccoberton
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-04-17 00:00:00.000000000 Z
+date: 2021-04-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: administrate
@@ -227,7 +227,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.4
 signing_key:
 specification_version: 4
 summary: Administrate Ransack plugin