administrate_ransack 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: faad99daa51ceb91223e79770bc0df8aeb7adae21d76044b510cd7628a8fe323
-  data.tar.gz: 3b1e7a5f12bc54086a182a72715342c52c79e0bdeef77af03a79bf0f659aa590
+  metadata.gz: 88c77d51c97628de19019594f60a310000340c079d4adaf442005c1037da1748
+  data.tar.gz: 41055594ee72a4e78c2d201ff04d758839238c122d917362382a8842b860b2a2
 SHA512:
-  metadata.gz: bb14807a4275bdc1d62467bca4d30bc3ec9010df4af46516351ad3ec63b9cd863fce18a87dfac75d20d35a785561fea58a254457eadb645d69d9d0163878dd2c
-  data.tar.gz: e4f7f6c47e66712a9c574ff0394739189a402f33281612113129ec10af6166d85ef5a8d73b0922a5d47e99f245e18ddd961abdec48cb491e525fd4b44110b9d2
+  metadata.gz: cc773c880ca05607c1af0d11bf15b5bd9a1e6c7bf5a90060f7e49977cdb5f099d379f1617e9b91079c98321847e404c8e3e5cad94d2156ac986a425b95eaf4d4
+  data.tar.gz: 253988df0bb9cb37804da6486b22867dfba2660a8065f38e13a353b549a9c655b300296e38651c1b293cace9bfd6685ed7c6e81f99d1b669b110b3591fb9cdb2

data/README.md

@@ -17,8 +17,30 @@ prepend AdministrateRansack::Searchable
 <%= render('administrate_ransack/filters', attribute_types: page.attribute_types) %>
 ```
 
+## 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`.
+
+Example:
+```rb
+class Post < ApplicationRecord
+  scope :admin_scope, -> { where(published: true) }
+
+  def admin_label
+    title.upcase
+  end
+end
+```
+
+## Notes
+- Administrate Search input works independently from Ransack searches, I suggest to disable it eventually
+- Ordering by clicking on the headers of the table preserving the Ransack searches requires a change to the headers links, replacing the th links of *_collection* partial with:
+```rb
+sort_link(@ransack_results, attr_name) do
+# ...
+```
+
 ## Customizations
-- Setup the fields for the filters in the index view:
+- Allow only some fields for the filters in the index view:
 ```erb
 <% attribute_types = {
   author: Administrate::Field::BelongsTo,
@@ -30,7 +52,7 @@ prepend AdministrateRansack::Searchable
   attribute_types: attribute_types
 ) %>
 ```
-- Optionally setup the layout for filters as a sidebar:
+- Optional basic style to setup the filters as a sidebar:
 ```css
 .main-content__body {
   display: inline-block;
@@ -54,8 +76,8 @@ prepend AdministrateRansack::Searchable
 }
 ```
 
-## Notes
-- 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
+Screenshot:
+![screenshot](screenshot.png)
 
 ## Do you like it? Star it!
 If you use this component just star it. A developer is more motivated to improve a project when there is some interest.

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

@@ -10,12 +10,13 @@
           <% association = @ransack_results.klass.reflections[field.to_s] %>
           <% if association %>
             <% label = association.klass.method_defined?(:admin_label) ? :admin_label : :to_s %>
+            <% collection = association.klass.send(association.klass.respond_to?(:admin_scope) ? :admin_scope : :all) %>
             <%= f.label field %>
-            <%= f.collection_select "#{field}_id_eq", association.klass.all, :id, label, include_blank: true %>
+            <%= f.collection_select "#{field}_id_eq", collection, :id, label, include_blank: true %>
           <% end %>
         <% when 'Administrate::Field::Boolean' %>
           <%= f.label field %>
-          <%= f.select "#{field}_eq", [['no', false], ['yes', true]], include_blank: true %>
+          <%= f.select "#{field}_eq", [[t('administrate_ransack.filters.no'), false], [t('administrate_ransack.filters.yes'), true]], include_blank: true %>
         <% when 'Administrate::Field::Date' %>
           <%= f.label field %>
           <%= f.date_field "#{field}_gteq" %>
@@ -34,8 +35,9 @@
           <% association = @ransack_results.klass.reflections[field.to_s] %>
           <% if association %>
             <% label = association.klass.method_defined?(:admin_label) ? :admin_label : :to_s %>
+            <% collection = association.klass.send(association.klass.respond_to?(:admin_scope) ? :admin_scope : :all) %>
             <%= f.label field %>
-            <%= f.collection_check_boxes "#{field}_id_in", association.klass.all, :id, label do |b| %>
+            <%= f.collection_check_boxes "#{field}_id_in", collection, :id, label do |b| %>
               <%= b.label do %>
                 <%= b.check_box %>
                 <span><%= b.object.send(label) %></span>

data/config/locales/en.yml

@@ -1,4 +1,6 @@
 en:
   administrate_ransack:
     filters:
-      clear_filters: Clear filters
+      'clear_filters': Clear filters
+      'no': 'No'
+      'yes': 'Yes'

data/lib/administrate_ransack/searchable.rb

@@ -4,6 +4,11 @@ require 'ransack'
 
 module AdministrateRansack
   module Searchable
+    def index
+      @dashboard = dashboard
+      super
+    end
+
     def scoped_resource
       @ransack_results = super.ransack(params[:q])
       @ransack_results.result(distinct: true)

data/lib/administrate_ransack/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: administrate_ransack
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors:
 - Mattia Roccoberton
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-09-20 00:00:00.000000000 Z
+date: 2020-10-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: administrate