administrate_ransack 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 07d7f30c351a3488f7eb7f2ba5c21ed52d1a935fc895070026af20209883d48f
-  data.tar.gz: 07b89a2beba6bdf5d6c59f17c100c70c7a90d73f85b3260715ba4b1641d566b4
+  metadata.gz: 8a221cd6e8ff63813b5fbdb9ef6c2a137e1e1953a3ecafcd2db0034e9f958f35
+  data.tar.gz: 5c36e74bb7c07df45d0dd31184e1c5afb1974fd29c79b0a718f123e60152f1f6
 SHA512:
-  metadata.gz: c87a21c626b2553f8659740e785c5a7f893b35d021dc483d70d75ada047b729f8a04fcafaf95236f8dae55f25f61fc95a558580ae89bd68d68f520892ff303ee
-  data.tar.gz: a7040f799122eb75d22e1af2d24c86a84c51c5da6001219cf8ba67fa861b59f2a772fae3a13cfeb9cbaa4e1d3517c754e241723993bc5603ee68f23f409ec74c
+  metadata.gz: f1dacc6dce1f49a453fe9cf9819688e54a09ad5fd9a61429ab6674a869a18d4f9e45910dd0547a6733db5e52b215fde3ac7f1f959acba2bc445498d9a7b34a36
+  data.tar.gz: 1802141cbf17b9b0a3b7b4c03c218549a7a1cadb24b6dc3edd27f2f9cce6a24835fd6892a30ae57a2b38561a800be72c941c106939a8f90ac0a307c51ce22fd2

data/README.md

@@ -1,4 +1,9 @@
-# Administrate Ransack [![Gem Version](https://badge.fury.io/rb/administrate_ransack.svg)](https://badge.fury.io/rb/administrate_ransack) [![Specs](https://github.com/blocknotes/administrate_ransack/actions/workflows/specs.yml/badge.svg)](https://github.com/blocknotes/administrate_ransack/actions/workflows/specs.yml)
+# Administrate Ransack
+[![gem version](https://badge.fury.io/rb/administrate_ransack.svg)](https://badge.fury.io/rb/administrate_ransack)
+[![gem downloads](https://badgen.net/rubygems/dt/administrate_ransack)](https://rubygems.org/gems/administrate_ransack)
+[![linters](https://github.com/blocknotes/administrate_ransack/actions/workflows/linters.yml/badge.svg)](https://github.com/blocknotes/administrate_ransack/actions/workflows/linters.yml)
+[![specs](https://github.com/blocknotes/administrate_ransack/actions/workflows/specs.yml/badge.svg)](https://github.com/blocknotes/administrate_ransack/actions/workflows/specs.yml)
+[![specs Rails7](https://github.com/blocknotes/administrate_ransack/actions/workflows/specs2.yml/badge.svg)](https://github.com/blocknotes/administrate_ransack/actions/workflows/specs2.yml)
 
 A plugin for [Administrate](https://github.com/thoughtbot/administrate) to use [Ransack](https://github.com/activerecord-hackery/ransack) for filtering resources.
 
@@ -11,13 +16,17 @@ Features:
 
 - After installing Administrate, add to *Gemfile*: `gem 'administrate_ransack'` (and execute `bundle`)
 - Edit your admin resource controller adding inside the class body:
+
 ```rb
 prepend AdministrateRansack::Searchable
 ```
-- Add to your resource index view:
+
+- Add to your resource index view (ex. to generate the index for a Post model: `bin/rails generate administrate:views:index Post`):
+
 ```erb
 <%= render('administrate_ransack/filters') %>
 ```
+
 - See the Usage section for extra options
 
 ## Usage
@@ -26,6 +35,7 @@ prepend AdministrateRansack::Searchable
   + `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)
+  + `namespace`: the namespace used by Administrate, ex. `:supervisor`
 - 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
@@ -39,6 +49,13 @@ class Post < ApplicationRecord
 end
 ```
 
+- For _has_many_ associations it is possible to use Selectize in place of the checkboxes using:
+
+```erb
+<!-- Set options for an association named: tags -->
+<%= render('administrate_ransack/filters', options: { tags: 'select' } ) %>
+```
+
 - To use scopes in filters it's needed to update also the `ransackable_scopes` in the model, example:
 
 ```rb
@@ -69,6 +86,7 @@ end
 - Date/time filters use Rails `datetime_field` method which produces a `datetime-local` input field, at the moment this type of element is not broadly supported, a workaround is to include [flatpickr](https://github.com/flatpickr/flatpickr) datetime library.
   + This gem checks if `flatpickr` function is available in the global scope and applies it to the `datetime-local` filter inputs;
   + you can include the library using your application assets or via CDN, ex. adding to **app/views/layouts/admin/application.html.erb**:
+
 ```html
   <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/flatpickr@4.5.7/dist/flatpickr.min.css">
   <script src="https://cdn.jsdelivr.net/npm/flatpickr@4.5.7/dist/flatpickr.min.js"></script>
@@ -82,6 +100,7 @@ end
 ## Customizations
 
 - Sample call of the filters partial with different options provided:
+
 ```erb
 <%
 # In alternative prepare an hash in the dashboard like RANSACK_TYPES = {}
@@ -102,11 +121,17 @@ attribute_labels = {
   search_path: admin_root_path
 ) %>
 ```
+
 - Another option is to prepare some hashes constants in the dashboard (ex. `RANSACK_TYPES`):
+
 ```erb
 <%= render('administrate_ransack/filters', attribute_types: @dashboard.class::RANSACK_TYPES) %>
 ```
+
+## Sample styles
+
 - Some basic style to setup the filters as a sidebar (see the screenshot below):
+
 ```css
 .main-content__body {
   display: inline-block;
@@ -131,24 +156,60 @@ attribute_labels = {
 ```
 
 Screenshot:
-![screenshot](screenshot.png)
+![screenshot](extra/screenshot.png)
+
+- Alternative styles for an horizontal search bar:
+
+```css
+[data-administrate-ransack-filters] {
+  border: 1px solid #ddd;
+  padding: 10px;
+  text-align: center;
+}
+
+[data-administrate-ransack-filters] .filters {
+  display: inline-block;
+}
+
+[data-administrate-ransack-filters] .filter, [data-administrate-ransack-filters] .filter > label {
+  display: inline-block;
+}
+
+[data-administrate-ransack-filters] .filter > input {
+  display: inline-block;
+  width: auto;
+}
+
+[data-administrate-ransack-filters] .filters-buttons {
+  display: inline-block;
+  margin-left: 20px;
+}
+```
+
+Screenshot:
+![screenshot2](extra/screenshot2.png)
 
 ## Extra notes
 
 - If you need to define custom search logics you can skip prepending the module (`AdministrateRansack::Searchable`) and create your own search query in a controller (but you need to assign the Ransack search object to `@ransack_results` for the filters partial), for example:
-```ruby
+
+```rb
   def scoped_resource
     @ransack_results = super.ransack(params[:q])
     @ransack_results.result(distinct: true)
   end
 ```
+
 - Sometimes it's easier to create a new Ransack field than overriding the search logic (there are a lot of good examples in the [Ransack Wiki](https://github.com/activerecord-hackery/ransack/wiki/Using-Ransackers)), example to search in a `jsonb` field adding to a Post model:
-```ruby
+
+```rb
   ransacker :keywords do
     Arel.sql("posts.metadata ->> 'keywords'")
   end
 ```
+
 - With Administrate Ransack you can easily create links to other resources applying some filters, example to add in a tag show page the link to the related posts:
+
 ```erb
   <%= link_to("Tag's posts", admin_posts_path('q[tags_id_in][]': page.resource.id), class: "button") %>
 ```
@@ -162,6 +223,7 @@ Or consider offering me a coffee, it's a small thing but it is greatly appreciat
 ## Contributors
 
 - [Mattia Roccoberton](https://blocknot.es/): author
+- The good guys that opened issues and pull requests from time to time
 
 ## License
 

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

@@ -1,29 +1,21 @@
-<% content_for :javascript do %>
-  <script>
-    document.addEventListener('DOMContentLoaded', (_event) => {
-      if(typeof window.flatpickr === 'function') {
-        var options = window.flatpickr_filters_options;
-        if(typeof options !== 'object') options = { enableTime: true };
-        window.flatpickr('.filter [type="datetime-local"]', options);
-      }
-    });
-  </script>
-<% end %>
-
 <%
   attribute_labels ||= {}
   attribute_types ||= @dashboard.attribute_types.select { |key, _value| @dashboard.collection_attributes.include?(key) }
+  options ||= {}
   form_options = { html: { 'data-administrate-ransack-filters': '1' } }
+  namespace = local_assigns[:namespace] || :admin
   if local_assigns.has_key?(:search_path)
     form_path = @ransack_results
     form_options[:url] = search_path
     clear_filters_path = search_path
   else
-    form_path = [:admin, @ransack_results]
-    clear_filters_path = url_for(url_for([:admin, @ransack_results.klass]))
+    form_path = [namespace, @ransack_results]
+    clear_filters_path = url_for(url_for([namespace, @ransack_results.klass]))
   end
 %>
 
+<% render 'administrate_ransack/javascript' %>
+
 <%= search_form_for form_path, form_options do |f| %>
   <div class="filters">
     <% attribute_types.each do |field, type| %>
@@ -32,29 +24,10 @@
       <% label = attribute_labels.include?(field) ? attribute_labels[field] : field %>
       <% model = @ransack_results.klass %>
       <% input_type = type.is_a?(Administrate::Field::Deferred) ? type.deferred_class.to_s : type.to_s %>
-      <div class="filter <%= input_type.parameterize %>">
-        <% case input_type %>
-        <% when 'Administrate::Field::BelongsTo' %>
-          <% association = model.reflections[field.to_s] %>
-          <%= render 'administrate_ransack/components/field_belongs_to', form: f, model: model, field: field, label: label, association: association %>
-        <% when 'Administrate::Field::Boolean' %>
-          <%= render 'administrate_ransack/components/field_boolean', form: f, model: model, field: field, label: label %>
-        <% when 'Administrate::Field::Date' %>
-          <%= render 'administrate_ransack/components/field_date', form: f, model: model, field: field, label: label %>
-        <% when 'Administrate::Field::DateTime' %>
-          <%= render 'administrate_ransack/components/field_datetime', form: f, model: model, field: field, label: label %>
-        <% when 'Administrate::Field::Email', 'Administrate::Field::String', 'Administrate::Field::Text' %>
-          <%= render 'administrate_ransack/components/field_string', form: f, model: model, field: field, label: label %>
-        <% when 'Administrate::Field::Number' %>
-          <%= render 'administrate_ransack/components/field_number', form: f, model: model, field: field, label: label %>
-        <% when 'Administrate::Field::HasMany' %>
-          <% association = model.reflections[field.to_s] %>
-          <%= render 'administrate_ransack/components/field_has_many', form: f, model: model, field: field, label: label, association: association %>
-        <% when 'Administrate::Field::Select' %>
-          <%= render 'administrate_ransack/components/field_select', form: f, model: model, field: field, label: label, type: type %>
-        <% else %>
-          <%= render 'administrate_ransack/components/field_other', form: f, model: model, field: field, label: label, type: type %>
-        <% end %>
+      <% component = AdministrateRansack::FILTERS[input_type] || 'field_other' %>
+
+      <div class="filter filter-<%= field.to_s.parameterize %> <%= input_type.parameterize %>">
+        <%= render "administrate_ransack/components/#{component}", form: f, model: model, field: field, label: label, type: type, options: options[field] %>
       </div>
     <% end %>
   </div>

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

@@ -0,0 +1,17 @@
+<% content_for :javascript do %>
+  <script>
+    document.addEventListener('DOMContentLoaded', (_event) => {
+      // flatpickr setup
+      if(typeof window.flatpickr === 'function') {
+        var options = window.flatpickr_filters_options;
+        if(typeof options !== 'object') options = { enableTime: true };
+        window.flatpickr('.filter [type="datetime-local"]', options);
+      }
+
+      // selectize setup
+      $(function () {
+        $('.filters select').selectize();
+      });
+    });
+  </script>
+<% end %>

data/app/views/administrate_ransack/components/_field_belongs_to.html.erb

@@ -1,7 +1,9 @@
+<% association = model.reflections[field.to_s] %>
 <% if association %>
   <% field_key = model.ransackable_scopes.include?(field) ? field : "#{field}_id_eq" %>
   <% desc = association.klass.method_defined?(:admin_label) ? :admin_label : :to_s %>
   <% collection = association.klass.send(association.klass.respond_to?(:admin_scope) ? :admin_scope : :all) %>
-  <%= form.label(label) %>
+
+  <%= form.label(label, class: 'filter-label') %>
   <%= form.collection_select(field_key, collection, :id, desc, include_blank: true) %>
 <% end %>

data/app/views/administrate_ransack/components/_field_boolean.html.erb

@@ -1,4 +1,5 @@
 <% field_key = model.ransackable_scopes.include?(field) ? field : "#{field}_eq" %>
 <% values = [[t('administrate_ransack.filters.no'), false], [t('administrate_ransack.filters.yes'), true]] %>
-<%= form.label(label) %>
+
+<%= form.label(label, class: 'filter-label') %>
 <%= form.select(field_key, values, include_blank: true) %>

data/app/views/administrate_ransack/components/_field_date.html.erb

@@ -1,6 +1,6 @@
-<%= form.label(label) %>
+<%= form.label(label, class: 'filter-label') %>
 <% if model.ransackable_scopes.include?(field) %>
-  <%= form.date_field(field) %>
+  <%= form.date_field(field, value: form.object.send(field)) %>
 <% else %>
   <%= form.date_field("#{field}_gteq") %>
   <%= form.date_field("#{field}_lteq") %>

data/app/views/administrate_ransack/components/_field_datetime.html.erb

@@ -1,6 +1,6 @@
-<%= form.label(label) %>
+<%= form.label(label, class: 'filter-label') %>
 <% if model.ransackable_scopes.include?(field) %>
-  <%= form.datetime_field(field) %>
+  <%= form.datetime_field(field, value: form.object.send(field)) %>
 <% else %>
   <%= form.datetime_field("#{field}_gteq") %>
   <%= form.datetime_field("#{field}_lteq") %>

data/app/views/administrate_ransack/components/_field_has_many.html.erb

@@ -1,12 +1,20 @@
+<% association = model.reflections[field.to_s] %>
 <% if association %>
   <% field_key = model.ransackable_scopes.include?(field) ? field : "#{field}_id_in" %>
   <% desc = association.klass.method_defined?(:admin_label) ? :admin_label : :to_s %>
   <% collection = association.klass.send(association.klass.respond_to?(:admin_scope) ? :admin_scope : :all) %>
-  <%= form.label(label) %>
-  <%= form.collection_check_boxes(field_key, collection, :id, desc) do |b| %>
-    <%= b.label do %>
-      <%= b.check_box %>
-      <span><%= b.object.send(desc) %></span>
+
+  <%= form.label(label, class: 'filter-label') %>
+  <% if options&.include? 'select' %>
+    <%= form.select(field_key, nil, {}, multiple: true) do %>
+      <%= options_from_collection_for_select(collection, :id, desc) %>
+    <% end %>
+  <% else %>
+    <%= form.collection_check_boxes(field_key, collection, :id, desc) do |b| %>
+      <%= b.label do %>
+        <%= b.check_box %>
+        <span><%= b.object.send(desc) %></span>
+      <% end %>
     <% end %>
   <% end %>
 <% end %>

data/app/views/administrate_ransack/components/_field_number.html.erb

@@ -1,3 +1,4 @@
 <% field_key = model.ransackable_scopes.include?(field) ? field : "#{field}_eq" %>
-<%= form.label(label) %>
+
+<%= form.label(label, class: 'filter-label') %>
 <%= form.number_field(field_key) %>

data/app/views/administrate_ransack/components/_field_other.html.erb

@@ -1,6 +1,6 @@
-<%= form.label(label) %>
+<%= form.label(label, class: 'filter-label') %>
 <%= form.search_field(field) %>
 
-<!-- unsupported Field::HasOne -->
-<!-- unsupported Field::Polymorphic -->
-<!-- unsupported Field::Password -->
+<%# unsupported Field::HasOne %>
+<%# unsupported Field::Polymorphic %>
+<%# unsupported Field::Password %>

data/app/views/administrate_ransack/components/_field_select.html.erb

@@ -1,3 +1,4 @@
 <% field_key = model.ransackable_scopes.include?(field) ? field : "#{field}_eq" %>
-<%= form.label(label) %>
+
+<%= form.label(label, class: 'filter-label') %>
 <%= form.select(field_key, type.options[:collection] || [], include_blank: true) %>

data/app/views/administrate_ransack/components/_field_string.html.erb

@@ -1,3 +1,4 @@
 <% field_key = model.ransackable_scopes.include?(field) ? field : "#{field}_cont" %>
-<%= form.label(label) %>
+
+<%= form.label(label, class: 'filter-label') %>
 <%= form.search_field(field_key) %>

data/lib/administrate_ransack/filters.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module AdministrateRansack
+  FILTERS = {
+    'Administrate::Field::BelongsTo' => 'field_belongs_to',
+    'Administrate::Field::Boolean' => 'field_boolean',
+    'Administrate::Field::Date' => 'field_date',
+    'Administrate::Field::DateTime' => 'field_date',
+    'Administrate::Field::Email' => 'field_string',
+    'Administrate::Field::HasMany' => 'field_has_many',
+    'Administrate::Field::Number' => 'field_number',
+    'Administrate::Field::Select' => 'field_select',
+    'Administrate::Field::String' => 'field_string',
+    'Administrate::Field::Text' => 'field_string'
+  }.freeze
+end

data/lib/administrate_ransack/version.rb

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

data/lib/administrate_ransack.rb

@@ -1,7 +1,9 @@
 # frozen_string_literal: true
 
 require 'administrate_ransack/engine'
+require 'administrate_ransack/filters'
 require 'administrate_ransack/searchable'
+require 'administrate_ransack/version'
 
 module AdministrateRansack
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: administrate_ransack
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Mattia Roccoberton
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-05-19 00:00:00.000000000 Z
+date: 2022-04-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: administrate
@@ -38,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.3'
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
 description: A plugin for Administrate to use Ransack for search filters
 email:
 - mat@blocknot.es
@@ -49,6 +63,7 @@ files:
 - README.md
 - Rakefile
 - app/views/administrate_ransack/_filters.html.erb
+- app/views/administrate_ransack/_javascript.html.erb
 - app/views/administrate_ransack/components/_field_belongs_to.html.erb
 - app/views/administrate_ransack/components/_field_boolean.html.erb
 - app/views/administrate_ransack/components/_field_date.html.erb
@@ -62,12 +77,16 @@ files:
 - config/locales/en.yml
 - lib/administrate_ransack.rb
 - lib/administrate_ransack/engine.rb
+- lib/administrate_ransack/filters.rb
 - lib/administrate_ransack/searchable.rb
 - lib/administrate_ransack/version.rb
 homepage: https://github.com/blocknotes/administrate_ransack
 licenses:
 - MIT
-metadata: {}
+metadata:
+  homepage_uri: https://github.com/blocknotes/administrate_ransack
+  source_code_uri: https://github.com/blocknotes/administrate_ransack
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -83,7 +102,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.1.6
 signing_key:
 specification_version: 4
 summary: Administrate Ransack plugin