administrate_ransack 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4d5b6b6df33ceb539a8c0abfead4d35fc568deec8019fbe4357fa4e7c49a7ec4
-  data.tar.gz: cd1434bf426ffe46b9ee4d8ec34c92aa6c12b2f973dcf1088e81d63568af1240
+  metadata.gz: 07d7f30c351a3488f7eb7f2ba5c21ed52d1a935fc895070026af20209883d48f
+  data.tar.gz: 07b89a2beba6bdf5d6c59f17c100c70c7a90d73f85b3260715ba4b1641d566b4
 SHA512:
-  metadata.gz: c04a5d614096bd32d044440a55f6f76738525f5ffa88b020d6745cf89328242823154b6d77e356c981b7f9ce7093d55711a77eac72bc42a6a6bc3f844d2d47e3
-  data.tar.gz: 8de7bda5e911657aeb149c251038078164a4632b8dc2163a4ac08736770bb50b63a5ce1f9f8b37d6f6d60e0ce94000375b0a7baec487a414ae02a9662c2551f2
+  metadata.gz: c87a21c626b2553f8659740e785c5a7f893b35d021dc483d70d75ada047b729f8a04fcafaf95236f8dae55f25f61fc95a558580ae89bd68d68f520892ff303ee
+  data.tar.gz: a7040f799122eb75d22e1af2d24c86a84c51c5da6001219cf8ba67fa861b59f2a772fae3a13cfeb9cbaa4e1d3517c754e241723993bc5603ee68f23f409ec74c

data/README.md

@@ -1,12 +1,14 @@
-# Administrate Ransack [![Gem Version](https://badge.fury.io/rb/administrate_ransack.svg)](https://badge.fury.io/rb/administrate_ransack) [![CircleCI](https://circleci.com/gh/blocknotes/administrate_ransack.svg?style=svg)](https://circleci.com/gh/blocknotes/administrate_ransack)
+# 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)
+
 A plugin for [Administrate](https://github.com/thoughtbot/administrate) to use [Ransack](https://github.com/activerecord-hackery/ransack) for filtering resources.
 
 Features:
 - add Ransack search results using module prepend inside an Administrate controller;
-- offer a filters side bar based on the resource's attributes;
+- offer a filters partial based on the resource's attributes;
 - customize searchable attributes.
 
 ## Installation
+
 - After installing Administrate, add to *Gemfile*: `gem 'administrate_ransack'` (and execute `bundle`)
 - Edit your admin resource controller adding inside the class body:
 ```rb
@@ -19,13 +21,15 @@ prepend AdministrateRansack::Searchable
 - See the Usage section for extra options
 
 ## Usage
+
 - 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:
+- 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
+# Sample post model
 class Post < ApplicationRecord
   scope :admin_scope, -> { where(published: true) }
 
@@ -35,8 +39,33 @@ class Post < ApplicationRecord
 end
 ```
 
+- To use scopes in filters it's needed to update also the `ransackable_scopes` in the model, example:
+
+```rb
+# Sample post model
+class Post < ApplicationRecord
+  scope :recents, ->(dt = 1.month.ago) { where('dt > ?', dt).order(dt: :desc) }
+  scope :by_category, ->(category) { where(category: category) }
+
+  class << self
+    def ransackable_scopes(_auth_object = nil)
+      %i[by_category recents]
+    end
+  end
+end
+```
+
+```erb
+<!-- Sample index view -->
+<%= render(
+  'administrate_ransack/filters',
+  attribute_types: { recents: Administrate::Field::DateTime, by_category: Administrate::Field::String }
+) %>
+```
+
 ## Notes
-- Administrate Search logic works independently from Ransack searches, I suggest to disable it eventually (ex. overriding `show_search_bar?` in the controller)
+
+- Administrate Search logic works independently from Ransack searches, I suggest to disable it eventually (ex. overriding `show_search_bar?` in the controller or removing the bar from the view)
 - 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**:
@@ -51,7 +80,8 @@ end
 ```
 
 ## Customizations
-- Sample with different options provided:
+
+- Sample call of the filters partial with different options provided:
 ```erb
 <%
 # In alternative prepare an hash in the dashboard like RANSACK_TYPES = {}
@@ -72,11 +102,11 @@ attribute_labels = {
   search_path: admin_root_path
 ) %>
 ```
-- An alternative is to prepare some hashes constants in the dashboard (ex. `RANSACK_TYPES`) and then:
+- 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) %>
 ```
-- Optional basic style to setup the filters as a sidebar:
+- Some basic style to setup the filters as a sidebar (see the screenshot below):
 ```css
 .main-content__body {
   display: inline-block;
@@ -104,31 +134,35 @@ Screenshot:
 ![screenshot](screenshot.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, ex:
+
+- 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
   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, example to search in a `jsonb` field adding to a Post model:
+- 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
   ransacker :keywords do
     Arel.sql("posts.metadata ->> 'keywords'")
   end
 ```
-- With this component you can easily link another resource applying some filters, example to add in a tag show page the link to the related posts:
+- 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") %>
 ```
 
 ## 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.
 
 Or consider offering me a coffee, it's a small thing but it is greatly appreciated: [about me](https://www.blocknot.es/about-me).
 
 ## Contributors
+
 - [Mattia Roccoberton](https://blocknot.es/): author
 
 ## License
+
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

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

@@ -30,29 +30,30 @@
       <% next if field == :id %>
 
       <% 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 = @ransack_results.klass.reflections[field.to_s] %>
-          <%= render 'administrate_ransack/components/field_belongs_to', form: f, field: field, label: label, association: association %>
+          <% 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, field: field, label: label %>
+          <%= 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, field: field, label: label %>
+          <%= 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, field: field, label: label %>
+          <%= 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, field: field, label: label %>
+          <%= 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, field: field, label: label %>
+          <%= render 'administrate_ransack/components/field_number', form: f, model: model, field: field, label: label %>
         <% when 'Administrate::Field::HasMany' %>
-          <% association = @ransack_results.klass.reflections[field.to_s] %>
-          <%= render 'administrate_ransack/components/field_has_many', form: f, field: field, label: label, association: association %>
+          <% 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, field: field, label: label, type: type %>
+          <%= 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, field: field, label: label, type: type %>
+          <%= render 'administrate_ransack/components/field_other', form: f, model: model, field: field, label: label, type: type %>
         <% end %>
       </div>
     <% end %>

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

@@ -1,6 +1,7 @@
 <% 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.collection_select "#{field}_id_eq", collection, :id, desc, include_blank: true %>
+  <%= form.collection_select(field_key, collection, :id, desc, include_blank: true) %>
 <% end %>

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

@@ -1,3 +1,4 @@
+<% 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.select "#{field}_eq", values, include_blank: true %>
+<%= form.select(field_key, values, include_blank: true) %>

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

@@ -1,3 +1,7 @@
 <%= form.label(label) %>
-<%= form.date_field "#{field}_gteq" %>
-<%= form.date_field "#{field}_lteq" %>
+<% if model.ransackable_scopes.include?(field) %>
+  <%= form.date_field(field) %>
+<% else %>
+  <%= form.date_field("#{field}_gteq") %>
+  <%= form.date_field("#{field}_lteq") %>
+<% end %>

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

@@ -1,3 +1,7 @@
 <%= form.label(label) %>
-<%= form.datetime_field "#{field}_gteq" %>
-<%= form.datetime_field "#{field}_lteq" %>
+<% if model.ransackable_scopes.include?(field) %>
+  <%= form.datetime_field(field) %>
+<% else %>
+  <%= form.datetime_field("#{field}_gteq") %>
+  <%= form.datetime_field("#{field}_lteq") %>
+<% end %>

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

@@ -1,8 +1,9 @@
 <% 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}_id_in", collection, :id, desc do |b| %>
+  <%= form.collection_check_boxes(field_key, collection, :id, desc) do |b| %>
     <%= b.label do %>
       <%= b.check_box %>
       <span><%= b.object.send(desc) %></span>

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

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

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

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

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

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

data/lib/administrate_ransack/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: administrate_ransack
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Mattia Roccoberton
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-05-01 00:00:00.000000000 Z
+date: 2021-05-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: administrate
@@ -38,161 +38,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.3'
-- !ruby/object:Gem::Dependency
-  name: activestorage
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '6.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '6.0'
-- !ruby/object:Gem::Dependency
-  name: capybara
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.33'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.33'
-- !ruby/object:Gem::Dependency
-  name: pry
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.13'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.13'
-- !ruby/object:Gem::Dependency
-  name: puma
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4.3'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4.3'
-- !ruby/object:Gem::Dependency
-  name: rspec_junit_formatter
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.4'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.4'
-- !ruby/object:Gem::Dependency
-  name: rspec-rails
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4.0'
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.90'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.90'
-- !ruby/object:Gem::Dependency
-  name: sassc
-  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'
-- !ruby/object:Gem::Dependency
-  name: selenium-webdriver
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.142'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.142'
-- !ruby/object:Gem::Dependency
-  name: sprockets-rails
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.2'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.2'
-- !ruby/object:Gem::Dependency
-  name: sqlite3
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.4'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.4'
-description: A plugin for Administrate to use Ransack for filtering resources
+description: A plugin for Administrate to use Ransack for search filters
 email:
 - mat@blocknot.es
 executables: []
@@ -237,7 +83,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