administrate_ransack 0.1.0 → 0.1.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: faad99daa51ceb91223e79770bc0df8aeb7adae21d76044b510cd7628a8fe323
-  data.tar.gz: 3b1e7a5f12bc54086a182a72715342c52c79e0bdeef77af03a79bf0f659aa590
+  metadata.gz: a2dde6b1bd570497e553c4e737f4b48654af8470dfbe733c6e35a3bb74991b6e
+  data.tar.gz: e8fcfe208ba7ebc128ccfee07f816da649aa7a8ac0ab35e180e06832af070391
 SHA512:
-  metadata.gz: bb14807a4275bdc1d62467bca4d30bc3ec9010df4af46516351ad3ec63b9cd863fce18a87dfac75d20d35a785561fea58a254457eadb645d69d9d0163878dd2c
-  data.tar.gz: e4f7f6c47e66712a9c574ff0394739189a402f33281612113129ec10af6166d85ef5a8d73b0922a5d47e99f245e18ddd961abdec48cb491e525fd4b44110b9d2
+  metadata.gz: 5581bf2209ae91bb8b9b43ffe96be8cecbceadb22d0b0db05755c20443fd6b17ddfcbf70f500442c94c6bf05f4ad31ef3bb9243e3336b9f642b7ac4de4a520b0
+  data.tar.gz: cf69dfe636379448c07b703fbf1435f47fdfeb234b15683414215d756132277d8c1b80e7832e8c16fea2fbd1d0ee0e6a904ccde85d43ddcc0409133e6b8da278

data/README.md

@@ -1,9 +1,9 @@
-# Administrate Ransack [![Gem Version](https://badge.fury.io/rb/administrate_ransack.svg)](https://badge.fury.io/rb/administrate_ransack)
+# 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)
 A plugin for [Administrate](https://github.com/thoughtbot/administrate) to use [Ransack](https://github.com/activerecord-hackery/ransack) for filtering resources.
 
 Features:
-- add Ransack method via module prepend in controller;
-- offer a filters bar based on the resource's attributes;
+- add Ransack search results using module prepend inside an Administrate controller;
+- offer a filters side bar based on the resource's attributes;
 - customize searchable attributes.
 
 ## Installation
@@ -14,23 +14,66 @@ prepend AdministrateRansack::Searchable
 ```
 - Add to your resource index view:
 ```erb
-<%= render('administrate_ransack/filters', attribute_types: page.attribute_types) %>
+<%= render('administrate_ransack/filters') %>
+```
+- 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`.
+
+Example:
+```rb
+class Post < ApplicationRecord
+  scope :admin_scope, -> { where(published: true) }
+
+  def admin_label
+    title.upcase
+  end
+end
+```
+
+## Notes
+- Administrate Search logic works independently from Ransack searches, I suggest to disable it eventually (ex. overriding `show_search_bar?` in the controller)
+- 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
+  # ...
+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>
+
+  <script>
+    // optionally change the flatpikr options:
+    window.flatpickr_filters_options = { dateFormat: "Y-m-d" };
+  </script>
 ```
 
 ## 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,
+<%
+attribute_types = {
   title: Administrate::Field::String,
+  author: Administrate::Field::BelongsTo,
   published: Administrate::Field::Boolean
-} %>
+}
+attribute_labels = {
+  author: 'Written by',
+  title: nil
+}
+%>
 <%= render(
   'administrate_ransack/filters',
-  attribute_types: attribute_types
+  attribute_types: attribute_types,
+  attribute_labels: attribute_labels
 ) %>
 ```
-- 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,12 +97,33 @@ 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)
+
+## 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:
+```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:
+```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:
+```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
 

data/Rakefile

@@ -1,7 +1,16 @@
 # frozen_string_literal: true
 
+require 'bundler/gem_tasks'
+
 begin
-  require 'bundler/setup'
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new(:spec) do |t|
+    # t.ruby_opts = %w[-w]
+    t.rspec_opts = ['--color', '--format documentation']
+  end
+
+  task default: :spec
 rescue LoadError
-  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+  puts '! LoadError: no RSpec available'
 end

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

@@ -1,3 +1,17 @@
+<% 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) } %>
 <%= search_form_for [:admin, @ransack_results], html: { 'data-administrate-ransack-filters': '1' } do |f| %>
   <div class="filters">
     <% attribute_types.each do |field, type| %>
@@ -10,32 +24,34 @@
           <% association = @ransack_results.klass.reflections[field.to_s] %>
           <% if association %>
             <% label = association.klass.method_defined?(:admin_label) ? :admin_label : :to_s %>
-            <%= f.label field %>
-            <%= f.collection_select "#{field}_id_eq", association.klass.all, :id, label, include_blank: true %>
+            <% collection = association.klass.send(association.klass.respond_to?(:admin_scope) ? :admin_scope : :all) %>
+            <%= f.label(attribute_labels.include?(field) ? attribute_labels[field] : field) %>
+            <%= 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.label(attribute_labels.include?(field) ? attribute_labels[field] : field) %>
+          <%= 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.label(attribute_labels.include?(field) ? attribute_labels[field] : field) %>
           <%= f.date_field "#{field}_gteq" %>
           <%= f.date_field "#{field}_lteq" %>
         <% when 'Administrate::Field::DateTime' %>
-          <%= f.label field %>
+          <%= f.label(attribute_labels.include?(field) ? attribute_labels[field] : field) %>
           <%= f.datetime_field "#{field}_gteq" %>
           <%= f.datetime_field "#{field}_lteq" %>
         <% when 'Administrate::Field::Email', 'Administrate::Field::String', 'Administrate::Field::Text' %>
-          <%= f.label field %>
+          <%= f.label(attribute_labels.include?(field) ? attribute_labels[field] : field) %>
           <%= f.search_field "#{field}_cont" %>
         <% when 'Administrate::Field::Number' %>
-          <%= f.label field %>
+          <%= f.label(attribute_labels.include?(field) ? attribute_labels[field] : field) %>
           <%= f.number_field "#{field}_eq" %>
         <% when 'Administrate::Field::HasMany' %>
           <% association = @ransack_results.klass.reflections[field.to_s] %>
           <% if association %>
             <% label = association.klass.method_defined?(:admin_label) ? :admin_label : :to_s %>
-            <%= f.label field %>
-            <%= f.collection_check_boxes "#{field}_id_in", association.klass.all, :id, label do |b| %>
+            <% collection = association.klass.send(association.klass.respond_to?(:admin_scope) ? :admin_scope : :all) %>
+            <%= f.label(attribute_labels.include?(field) ? attribute_labels[field] : field) %>
+            <%= f.collection_check_boxes "#{field}_id_in", collection, :id, label do |b| %>
               <%= b.label do %>
                 <%= b.check_box %>
                 <span><%= b.object.send(label) %></span>
@@ -43,12 +59,13 @@
             <% end %>
           <% end %>
         <% when 'Administrate::Field::Select' %>
-          <%= f.label field %>
+          <%= f.label(attribute_labels.include?(field) ? attribute_labels[field] : field) %>
           <%= f.select "#{field}_eq", type.options[:collection], include_blank: true %>
+        <% else %>
+          <!-- unsupported Field::HasOne -->
+          <!-- unsupported Field::Polymorphic -->
+          <!-- unsupported Field::Password -->
         <% end %>
-        <%# unsupported Field::HasOne %>
-        <%# unsupported Field::Polymorphic %>
-        <%# unsupported Field::Password %>
       </div>
     <% end %>
   </div>

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/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module AdministrateRansack
-  VERSION = '0.1.0'
+  VERSION = '0.1.10'
 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.10
 platform: ruby
 authors:
 - Mattia Roccoberton
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-09-20 00:00:00.000000000 Z
+date: 2021-04-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: administrate
@@ -16,28 +16,112 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.14.0
+        version: '0.14'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.14.0
+        version: '0.14'
 - !ruby/object:Gem::Dependency
   name: ransack
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.3.2
+        version: '2.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.3.2
+        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
@@ -52,6 +136,62 @@ dependencies:
     - - "~>"
       - !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
 email:
 - mat@blocknot.es