administrate_filterable 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 655e44dca6e45d18592d84ccc20dbc79f47da6f79e5c7995c32cc2553f8d1a29
-  data.tar.gz: 05d8c8e708c9d6a08a1a917938f5c26b67e49872374b08206e4167de82b17721
+  metadata.gz: b3e6008fb9def58abce9a1281766aebb0e55ac7e2dece88377ba09d41f4ec902
+  data.tar.gz: 78b59b43ed159b5c5c184434aedd6eb10258fd7a483a5b7c379152be2a1b19b9
 SHA512:
-  metadata.gz: d4c07a5076e76713970cdacad3fa7b90a56cefe00a4aa4fa385f20389642c39e284ea72a9528d6f9111b422f45ad197517269d5c4c6ceb6f574c811914ea9a6b
-  data.tar.gz: 6f2a3adc9344bb6014f9a61b1048f012a87d60418d363df6e9f40a9caa2df2d67fa95f574d6d4af641ecc271fcd762942b18a37075ef8b9c59fccca29e94afe5
+  metadata.gz: f865057d44efb6b5660b097be590d1c5bfba7df1e6caed4df2b53c6cd1bf526dd43e63980d6640c934d0bf15e61fedaadd2ea49bc5eba8e5a1ecc3048d4ca423
+  data.tar.gz: 3a62607e5eb4513a443160b2ec244ef468e9b35617f8f7c7c1a39f98af49aa0e1597f852b8a52b42080b219a24d090917ead63f2b2b6719dd8fbc4f985ce0346

data/.gitignore

@@ -10,6 +10,8 @@
 # rspec failure tracking
 .rspec_status
 
+# Ignore byebug command history file.
+.byebug_history
 
 # Ignore the default SQLite database.
 spec/dummy/db/*.sqlite3
@@ -18,3 +20,6 @@ spec/dummy/db/*.sqlite3-journal
 # Ignore all logfiles and tempfiles.
 spec/dummy/log/*
 spec/dummy/tmp/*
+
+# Ignore gem build artifacts
+*.gem

data/CHANGELOG.md

@@ -0,0 +1,11 @@
+# CHANGELOG
+
+## 0.0.3
+* Move `_index_filter.html.erb` render location to `_search.html.erb`
+
+## 0.0.2
+* Refactor filterer resource to use new_resource instead of resource_name
+
+## 0.0.1
+
+* Initial release with basic filter functionality

data/README.md

@@ -41,7 +41,8 @@ $ bundle add administrate_filterable
 
 ## Usage
 
-For each resource you want to add custom filter, add the following line to the their respective Administrate controller.
+### Enable the filter
+For each resource you want to add custom filter, add the following line to their respective Administrate controller.
 ```ruby
 include AdministrateFilterable::Filterer
 ```
@@ -55,7 +56,8 @@ class UsersController < Administrate::ApplicationController
 end
 ```
 
-By default all the attributes from COLLECTION_ATTRIBUTES will be rendered as the filter fields. You can override this by adding FILTER_ATTRIBUTES to your Administrate's dashboard file.
+### Customizing the filter fields
+By default all the attributes from `COLLECTION_ATTRIBUTES` will be rendered as the filter fields. You can override this by adding `FILTER_ATTRIBUTES` to your Administrate's dashboard file.
 
 Example (`app/dashboards/user_dashboard.rb`):
 ```ruby
@@ -71,21 +73,12 @@ class UserDashboard < Administrate::BaseDashboard
 end
 ```
 
-By default this gem will add a filter button to the partial `views/admin/application/_index_header.html.erb`. But if you have your own Administrate index views or override that partial in your application you can add the button manually by adding the following line:
-```erb
-<%= render('index_filter', page: page) %>
-```
-
-Example (`app/views/admin/users/_index_header.html.erb`):
-```erb
-... other code here ...
-<header class="main-content__header">
-  ... other code here ...
+### Customizing the filter template
+It is possible to customize the filter template (e.g. changing the filter button icon, etc). You can do this by overriding the default template in your application, just create a new file called `_index_filter.html.erb` in your desired resource folder.
 
-  <%= render('index_filter', page: page) %>
-</header>
-```
+For example, if you want to override the filter template for `users` resource, you need to create the file in `app/views/admin/users/_index_filter.html.erb`. Then just copy and paste the content from the default template [here](app/views/admin/application/_index_filter.html.erb) and modify it to suit your needs.
 
+### Asset Pipeline
 If you use assets pipeline, you need to include this gem's assets to your `app/assets/config/manifest.js` file:
 ```javascript
 // ... other code here ...
@@ -94,8 +87,34 @@ If you use assets pipeline, you need to include this gem's assets to your `app/a
 //= link administrate_filterable/application.js
 ```
 
+Run `rails assets:precompile` if the assets are not loaded.
+
+
+## Troubleshooting
+### Overridden default search template
+By default this gem will add a filter button to `views/admin/application/_search.html.erb` partial. But if you have override that partial in your application you can add the button manually by adding the following line:
+```erb
+<%= render 'index_filter' %>
+```
+
+Example (`app/views/admin/users/_search.html.erb`):
+```erb
+<form class="search" role="search">
+  ... other code here ...
+</form>
+
+<%= render 'index_filter' %>
+```
+
+### Filter button not showing
+Since I use the `_search.html.erb` partial to add the filter button, it may not be showing if you turn all the searchable attributes to false in the model dashboard. So make sure you have at least one searchable attribute to make the filter button show up.
+
+The reason why I use the partial is because:
+1. It is rarely overridden by the user, so you won't have to add the button manually in most cases.
+2. Previously, I use `_index_header.html.erb` partial, but it conflicts with the export button from [administrate_exportable](https://github.com/SourceLabsLLC/administrate_exportable). Using both gems results in one button missing, due to the partial override.
+
 ## To Do
-There are still a lot of things to do to make this gem better. Here are some of them (sorted highest priority first):
+There are still a lot of things to do to make this gem better. Here are some of them (sorted by highest priority first):
 - [ ] Add support for relational filter (e.g. filter by `belongs_to` association, etc)
 - [ ] Add support to customize the dropdown list (e.g. add `prompt` option, add `include_blank` option, etc)
 - [ ] Exclude checkbox, radio, or select value from the filter params if no action is performed on them
@@ -104,11 +123,13 @@ There are still a lot of things to do to make this gem better. Here are some of
 - [ ] Add capability to customize the filter behavior (e.g. search by exact match, search by partial match, etc just like in the ActiveAdmin filter)
 - [ ] Improve the toggle button user experience (e.g. add open/close animation, add dynamic open/close title, etc)
 
-## Contributing
+If you have any idea or suggestion, please let me know by creating an issue or pull request.
 
-1. Contribution are welcome (codes, suggestions, and bugs)
+## Contributing
+You can help me to improve this gem by contributing to this project. Any help is highly appreciated.
+1. Fork this repo and create a pull request
 2. Please test your code: `bundle exec rspec`
-3. Please document your code
+3. Please document your code if needed
 
 ## License
 
@@ -116,5 +137,5 @@ There are still a lot of things to do to make this gem better. Here are some of
 
 ## Credits
 Huge thanks for the following resources that help me a lot in creating this gem:
-- [administrate_filterable](https://github.com/SourceLabsLLC/administrate_exportable): Basically I just copy the code from this gem and modify it to suit my needs, highly recommended if you need to export your data from Administrate.
-- [Off-Canvas Menu](https://web.archive.org/web/20210304195120/https://codepen.io/11bits/pen/jryEGW): I found this CodePen from Google Images when I was looking for a way to create an off-canvas menu. I modified it a little bit to suit my needs. But it seems the codepen is no longer available, so I put the archived version here. If any of you know the original author, please let me know so I can give the proper credit.
+- [administrate_exportable](https://github.com/SourceLabsLLC/administrate_exportable): Basically I just copy the code from this gem and modify it to suit my needs, highly recommended if you need to export your data from Administrate.
+- [Off-Canvas Menu](https://web.archive.org/web/20210304195120/https://codepen.io/11bits/pen/jryEGW): I found this code from Google Images when I was looking for a way to create an off-canvas filter component. I modified it a little bit to suit my needs. But it seems the CodePen is no longer available, so I put the archived version here. If any of you know the original author, please let me know so I can give the proper credit.

data/app/assets/stylesheets/administrate_filterable/application.css

@@ -2,7 +2,7 @@
   position: fixed;
   z-index: 4;
   top: 38px;
-  right: 10px;
+  right: 0;
 }
 
 .administrate-filterable__overlay {

data/app/views/admin/application/_index_filter.html.erb

@@ -1,5 +1,5 @@
 <% if @administrate_filterable_attributes.present? %>
-  <% resource_title = display_resource_name(page.resource_name) %>
+  <% resource_title = display_resource_name(resource_name) %>
 
   <% # TODO: Improve the toggle button user experience (e.g. add open/close animation, add dynamic open/close title, etc) %>
   <a href="#administrate-filterable" class="administrate-filterable__toggle-button" title="Filter <%= resource_title %>">
@@ -13,7 +13,7 @@
       <h2>Filter <%= resource_title %></h2>
     </header>
 
-    <%= form_with(model: [:admin, @administrate_filterable_resource], method: :get, html: { class: "form administrate-filterable__form" }) do |f| %>
+    <%= form_with(model: [:admin, new_resource], method: :get, html: { class: "form administrate-filterable__form" }) do |f| %>
       <% @administrate_filterable_attributes.each do |attribute| -%>
         <% # TODO: Add capability to customize the filter behavior (e.g. search by exact match, search by partial match, etc just like in the ActiveAdmin filter) %>
         <div class="field-unit field-unit--<%= attribute.html_class %> administrate-filterable__field">

data/app/views/admin/application/_search.html.erb

@@ -0,0 +1,27 @@
+<form class="search" role="search">
+  <label class="search__label" for="search">
+    <svg class="search__eyeglass-icon" role="img">
+      <title>
+        <%= t("administrate.search.label", resource: resource_name) %>
+      </title>
+      <use xlink:href="#icon-eyeglass" />
+    </svg>
+  </label>
+
+  <input class="search__input"
+         id="search"
+         type="search"
+         name="search"
+         placeholder="<%= t("administrate.search.label",
+                            resource: resource_name) %>"
+         value="<%= search_term %>">
+
+  <%= link_to clear_search_params, class: "search__clear-link" do %>
+    <svg class="search__clear-icon" role="img">
+      <title><%= t("administrate.search.clear") %></title>
+      <use xlink:href="#icon-cancel" />
+    </svg>
+  <% end %>
+</form>
+
+<%= render 'index_filter' %>

data/lib/administrate_filterable/filterer.rb

@@ -13,10 +13,9 @@ module AdministrateFilterable
         # It would be better to implement this as a separate controller action, but I don't have time to explore that right now
         define_method(:scoped_resource) do
           # TODO: Figure out a better way to pass the filter data to the form
-          # This is a hack to get the filter resource and attributes to show up in the form, but it's not ideal
+          # This is a hack to get the filter attributes to show up in the form, but it's not ideal
           # So I tried to make the variable name as unique as possible to avoid collisions
-          @administrate_filterable_resource = resource_name.to_s.titleize.constantize.new
-          @administrate_filterable_attributes = FiltererService.filter_attributes(dashboard, @administrate_filterable_resource)
+          @administrate_filterable_attributes = FiltererService.filter_attributes(dashboard, new_resource)
 
           data = resource_class.all
 

data/lib/administrate_filterable/version.rb

@@ -1,3 +1,3 @@
 module AdministrateFilterable
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: administrate_filterable
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Irvan Fauziansyah
@@ -133,7 +133,7 @@ files:
 - ".github/workflows/main.yml"
 - ".gitignore"
 - ".rspec"
-- CHANGELOG
+- CHANGELOG.md
 - Gemfile
 - Gemfile.lock
 - LICENSE
@@ -143,7 +143,7 @@ files:
 - app/assets/javascripts/administrate_filterable/application.js
 - app/assets/stylesheets/administrate_filterable/application.css
 - app/views/admin/application/_index_filter.html.erb
-- app/views/admin/application/_index_header.html.erb
+- app/views/admin/application/_search.html.erb
 - bin/console
 - bin/setup
 - lib/administrate_filterable.rb

data/CHANGELOG

@@ -1,5 +0,0 @@
-# CHANGELOG
-
-## 0.0.1
-
-* Initial release with basic filter functionality

data/app/views/admin/application/_index_header.html.erb

@@ -1,19 +0,0 @@
-<% content_for(:title) do %>
-  <%= display_resource_name(page.resource_name) %>
-<% end %>
-
-<header class="main-content__header">
-  <h1 class="main-content__page-title" id="page-title">
-    <%= content_for(:title) %>
-  </h1>
-
-  <% if show_search_bar %>
-    <%= render(
-      "search",
-      search_term: search_term,
-      resource_name: display_resource_name(page.resource_name)
-    ) %>
-  <% end %>
-
-  <%= render('index_filter', page: page) %>
-</header>