administrate_filterable 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 655e44dca6e45d18592d84ccc20dbc79f47da6f79e5c7995c32cc2553f8d1a29
+  data.tar.gz: 05d8c8e708c9d6a08a1a917938f5c26b67e49872374b08206e4167de82b17721
+SHA512:
+  metadata.gz: d4c07a5076e76713970cdacad3fa7b90a56cefe00a4aa4fa385f20389642c39e284ea72a9528d6f9111b422f45ad197517269d5c4c6ceb6f574c811914ea9a6b
+  data.tar.gz: 6f2a3adc9344bb6014f9a61b1048f012a87d60418d363df6e9f40a9caa2df2d67fa95f574d6d4af641ecc271fcd762942b18a37075ef8b9c59fccca29e94afe5

data/.github/workflows/main.yml

@@ -0,0 +1,20 @@
+---
+name: CI
+on: [push,pull_request]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    steps:
+      - run: ls /opt/hostedtoolcache/Ruby
+      - uses: actions/checkout@v2
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@master
+        with:
+          ruby-version: 3.2.2
+
+      - name: Install dependencies
+        run: bundle install
+      - name: Run tests
+        run: bundle exec rspec

data/.gitignore

@@ -0,0 +1,20 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+
+# Ignore the default SQLite database.
+spec/dummy/db/*.sqlite3
+spec/dummy/db/*.sqlite3-journal
+
+# Ignore all logfiles and tempfiles.
+spec/dummy/log/*
+spec/dummy/tmp/*

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/CHANGELOG

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

data/Gemfile

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+eval_gemfile File.join(File.dirname(__FILE__), "spec/dummy/Gemfile")

data/Gemfile.lock

@@ -0,0 +1,238 @@
+PATH
+  remote: .
+  specs:
+    administrate_filterable (0.0.2)
+      actionview (>= 5.2.2.1)
+      administrate (>= 0.17.0)
+      rails (>= 4.2)
+      railties (>= 5.2.2.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actioncable (7.0.4.3)
+      actionpack (= 7.0.4.3)
+      activesupport (= 7.0.4.3)
+      nio4r (~> 2.0)
+      websocket-driver (>= 0.6.1)
+    actionmailbox (7.0.4.3)
+      actionpack (= 7.0.4.3)
+      activejob (= 7.0.4.3)
+      activerecord (= 7.0.4.3)
+      activestorage (= 7.0.4.3)
+      activesupport (= 7.0.4.3)
+      mail (>= 2.7.1)
+      net-imap
+      net-pop
+      net-smtp
+    actionmailer (7.0.4.3)
+      actionpack (= 7.0.4.3)
+      actionview (= 7.0.4.3)
+      activejob (= 7.0.4.3)
+      activesupport (= 7.0.4.3)
+      mail (~> 2.5, >= 2.5.4)
+      net-imap
+      net-pop
+      net-smtp
+      rails-dom-testing (~> 2.0)
+    actionpack (7.0.4.3)
+      actionview (= 7.0.4.3)
+      activesupport (= 7.0.4.3)
+      rack (~> 2.0, >= 2.2.0)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.2.0)
+    actiontext (7.0.4.3)
+      actionpack (= 7.0.4.3)
+      activerecord (= 7.0.4.3)
+      activestorage (= 7.0.4.3)
+      activesupport (= 7.0.4.3)
+      globalid (>= 0.6.0)
+      nokogiri (>= 1.8.5)
+    actionview (7.0.4.3)
+      activesupport (= 7.0.4.3)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.1, >= 1.2.0)
+    activejob (7.0.4.3)
+      activesupport (= 7.0.4.3)
+      globalid (>= 0.3.6)
+    activemodel (7.0.4.3)
+      activesupport (= 7.0.4.3)
+    activerecord (7.0.4.3)
+      activemodel (= 7.0.4.3)
+      activesupport (= 7.0.4.3)
+    activestorage (7.0.4.3)
+      actionpack (= 7.0.4.3)
+      activejob (= 7.0.4.3)
+      activerecord (= 7.0.4.3)
+      activesupport (= 7.0.4.3)
+      marcel (~> 1.0)
+      mini_mime (>= 1.1.0)
+    activesupport (7.0.4.3)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+    administrate (0.17.0)
+      actionpack (>= 5.0)
+      actionview (>= 5.0)
+      activerecord (>= 5.0)
+      datetime_picker_rails (~> 0.0.7)
+      jquery-rails (>= 4.0)
+      kaminari (>= 1.0)
+      momentjs-rails (~> 2.8)
+      sassc-rails (~> 2.1)
+      selectize-rails (~> 0.6)
+    builder (3.2.4)
+    byebug (11.1.3)
+    concurrent-ruby (1.1.10)
+    crass (1.0.6)
+    date (3.3.4)
+    datetime_picker_rails (0.0.7)
+      momentjs-rails (>= 2.8.1)
+    diff-lcs (1.5.0)
+    erubi (1.10.0)
+    ffi (1.15.5)
+    globalid (1.2.1)
+      activesupport (>= 6.1)
+    i18n (1.10.0)
+      concurrent-ruby (~> 1.0)
+    jquery-rails (4.4.0)
+      rails-dom-testing (>= 1, < 3)
+      railties (>= 4.2.0)
+      thor (>= 0.14, < 2.0)
+    kaminari (1.2.2)
+      activesupport (>= 4.1.0)
+      kaminari-actionview (= 1.2.2)
+      kaminari-activerecord (= 1.2.2)
+      kaminari-core (= 1.2.2)
+    kaminari-actionview (1.2.2)
+      actionview
+      kaminari-core (= 1.2.2)
+    kaminari-activerecord (1.2.2)
+      activerecord
+      kaminari-core (= 1.2.2)
+    kaminari-core (1.2.2)
+    loofah (2.18.0)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    mail (2.8.1)
+      mini_mime (>= 0.1.1)
+      net-imap
+      net-pop
+      net-smtp
+    marcel (1.0.2)
+    method_source (1.0.0)
+    mini_mime (1.1.5)
+    mini_portile2 (2.8.0)
+    minitest (5.15.0)
+    momentjs-rails (2.29.1.1)
+      railties (>= 3.1)
+    net-imap (0.4.4)
+      date
+      net-protocol
+    net-pop (0.1.2)
+      net-protocol
+    net-protocol (0.2.2)
+      timeout
+    net-smtp (0.4.0)
+      net-protocol
+    nio4r (2.5.9)
+    nokogiri (1.13.6)
+      mini_portile2 (~> 2.8.0)
+      racc (~> 1.4)
+    racc (1.6.0)
+    rack (2.2.3)
+    rack-test (1.1.0)
+      rack (>= 1.0, < 3)
+    rails (7.0.4.3)
+      actioncable (= 7.0.4.3)
+      actionmailbox (= 7.0.4.3)
+      actionmailer (= 7.0.4.3)
+      actionpack (= 7.0.4.3)
+      actiontext (= 7.0.4.3)
+      actionview (= 7.0.4.3)
+      activejob (= 7.0.4.3)
+      activemodel (= 7.0.4.3)
+      activerecord (= 7.0.4.3)
+      activestorage (= 7.0.4.3)
+      activesupport (= 7.0.4.3)
+      bundler (>= 1.15.0)
+      railties (= 7.0.4.3)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.4.2)
+      loofah (~> 2.3)
+    railties (7.0.4.3)
+      actionpack (= 7.0.4.3)
+      activesupport (= 7.0.4.3)
+      method_source
+      rake (>= 12.2)
+      thor (~> 1.0)
+      zeitwerk (~> 2.5)
+    rake (13.0.6)
+    rb-readline (0.5.5)
+    rspec-core (3.9.3)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.4)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-rails (3.9.1)
+      actionpack (>= 3.0)
+      activesupport (>= 3.0)
+      railties (>= 3.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.4)
+    sassc (2.4.0)
+      ffi (~> 1.9)
+    sassc-rails (2.1.2)
+      railties (>= 4.0.0)
+      sassc (>= 2.0)
+      sprockets (> 3.0)
+      sprockets-rails
+      tilt
+    selectize-rails (0.12.6)
+    sprockets (4.0.3)
+      concurrent-ruby (~> 1.0)
+      rack (> 1, < 3)
+    sprockets-rails (3.4.2)
+      actionpack (>= 5.2)
+      activesupport (>= 5.2)
+      sprockets (>= 3.0.0)
+    sqlite3 (1.4.2)
+    thor (1.2.1)
+    tilt (2.0.10)
+    timeout (0.4.1)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+    websocket-driver (0.7.6)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.5)
+    zeitwerk (2.6.12)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  administrate (~> 0.17.0)
+  administrate_filterable!
+  byebug
+  rails (~> 7.0.0)
+  rb-readline
+  rspec-rails (~> 3.8)
+  sqlite3
+
+RUBY VERSION
+   ruby 3.2.2p53
+
+BUNDLED WITH
+   2.4.22

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Irvan Fauziansyah
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,120 @@
+# Administrate Custom Filter
+
+![Gem](https://img.shields.io/gem/v/administrate_filterable.svg)
+![CI](https://github.com/IrvanFza/administrate_filterable/workflows/CI/badge.svg)
+
+An [Administrate](https://github.com/thoughtbot/administrate/) plugin to add custom filter in your index page. Highly inspired by [ActiveAdmin](https://github.com/activeadmin/activeadmin)'s filter.
+
+## Why you need this?
+
+Let's agree that the Administrate's team has done a great job with the default search or filter functionality. It's simple and easy to use. It supports multiple search fields, cross relation search, and it's easy to customize (like enable/disable the search, defining custom search fields, etc).
+
+But there are some drawbacks that I found:
+1. Since it uses single search box, the search process behind it is quite heavy. It will search all the attributes of the model, and it will be slower if you have a lot of data.
+2. Again, because it search all the attributes, it will be hard to search for a specific attribute. For example, if you have `registration_status` and `employment_status`, and you want to search for "active" registration status only, you will get all the "active" records, including the employment status.
+3. It's not user friendly when it comes to defined search list (e.g. dropdown list). The user will have to type the value manually, and it's not good for the user experience.
+
+Please share your thoughts if you have any other reasons.
+
+## Requirements
+
+- Ruby on Rails version >= 5.0
+- Administrate version >= 0.2.2
+
+## Installation
+
+Add `administrate_filterable` to your Gemfile:
+
+```ruby
+gem 'administrate_filterable'
+```
+
+And then execute:
+```
+$ bundle install
+```
+
+Or, simply just run:
+```
+$ bundle add administrate_filterable
+```
+
+## Usage
+
+For each resource you want to add custom filter, add the following line to the their respective Administrate controller.
+```ruby
+include AdministrateFilterable::Filterer
+```
+
+Example:
+```ruby
+class UsersController < Administrate::ApplicationController
+  include AdministrateFilterable::Filterer
+
+  # ...
+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.
+
+Example (`app/dashboards/user_dashboard.rb`):
+```ruby
+class UserDashboard < Administrate::BaseDashboard
+  # ..
+  FILTER_ATTRIBUTES = [
+    :first_name,
+    :last_name,
+    :email,
+    :created_at
+  ].freeze
+  # ..
+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 ...
+
+  <%= render('index_filter', page: page) %>
+</header>
+```
+
+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 ...
+
+//= link administrate_filterable/application.css
+//= link administrate_filterable/application.js
+```
+
+## 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):
+- [ ] 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
+- [ ] Figure out a better way to implement the filter functionality (currently I override the `scoped_resource` method)
+- [ ] Figure out a better way to pass the filter attributes to the form (currently I use instance variable in the overridden `scoped_resource` method)
+- [ ] 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
+
+1. Contribution are welcome (codes, suggestions, and bugs)
+2. Please test your code: `bundle exec rspec`
+3. Please document your code
+
+## License
+
+[MIT License](https://github.com/IrvanFza/administrate_filterable/blob/master/LICENSE)
+
+## 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.

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/administrate_filterable.gemspec

@@ -0,0 +1,40 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "administrate_filterable/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "administrate_filterable"
+  spec.version       = AdministrateFilterable::VERSION
+  spec.authors       = ["Irvan Fauziansyah"]
+  spec.email         = ["ervhan@gmail.com"]
+  spec.homepage      = 'https://github.com/IrvanFza/administrate_filterable'
+  spec.summary       = "Administrate Custom Filter"
+  spec.description   = "Simple plugin to add custom filter functionality to your Administrate index page."
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  # if spec.respond_to?(:metadata)
+  #   spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+  # else
+  #   raise "RubyGems 2.0 or newer is required to protect against " \
+  #     "public gem pushes."
+  # end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "byebug", "~> 10.0"
+  spec.add_dependency 'administrate','>= 0.17.0'
+  spec.add_dependency 'rails', '>= 4.2'
+  spec.add_dependency 'actionview', '>= 5.2.2.1'
+  spec.add_dependency 'railties', '>= 5.2.2.1'
+end

data/app/assets/javascripts/administrate_filterable/application.js

@@ -0,0 +1,107 @@
+const navTrigger = document.getElementsByClassName('administrate-filterable__toggle-button')[0];
+const body = document.getElementsByTagName('body')[0];
+
+navTrigger.addEventListener('click', toggleNavigation);
+
+function toggleNavigation(event) {
+  event.preventDefault();
+  body.classList.toggle('administrate-filterable__open');
+}
+
+const applyFilterButton = document.getElementsByClassName('administrate-filterable__apply-filter')[0];
+const form = document.getElementsByClassName('administrate-filterable__form')[0];
+
+applyFilterButton.addEventListener('click', function(event) {
+  // Prevent form submission
+  event.preventDefault();
+
+  // Instantiate a new FormData object
+  let formData = new FormData(form);
+
+  // Create URLSearchParams from FormData
+  let formDataParams = new URLSearchParams([...formData.entries()]);
+
+  // get existing query params
+  let existingParams = new URLSearchParams(window.location.search);
+
+  // Get keys of existingParams
+  let keys = [...existingParams.keys()];
+
+  // delete keys from existingParams which don't exist in formDataParams
+  keys.forEach((key) => {
+    if (!formDataParams.has(key)) {
+      existingParams.delete(key);
+    }
+  });
+
+  // append or replace new formDataParams
+  formDataParams.forEach((value, key) => {
+    if (value.trim() !== '') {
+      existingParams.set(key, value);
+    } else {
+      existingParams.delete(key);
+    }
+  });
+
+  // Create query params string from existingParams
+  let queryParamsString = '?' + existingParams.toString();
+
+  // Get the URL without query params
+  const currentUrl = window.location.href.split('?')[0];
+
+  // Construct new URL with updated parameters
+  const newUrl = currentUrl + queryParamsString;
+
+  // Redirect to current url with new query params
+  window.location.href = newUrl;
+});
+
+window.onload = function() {
+  // Get form fields
+  const form = document.getElementsByClassName('administrate-filterable__form')[0];
+  let formData = new FormData(form);
+
+  // Extract query params from URL
+  const queryParams = new URLSearchParams(window.location.search);
+
+  // Loop through the query parameters and set form field values
+  for (let pair of queryParams.entries()) {
+    const formFields = document.getElementsByName(pair[0]);
+    const fieldValue = decodeURIComponent(pair[1]);
+    for(let field of formFields) {
+      if(field.type === "checkbox" || field.type === "radio") {
+        field.checked = field.value === fieldValue;
+      } else if(field.tagName === 'SELECT') {
+        // Check for Selectize
+        if (field.className.indexOf('selectized') != -1) {
+          // Field uses Selectize
+          field.selectize.setValue(fieldValue, true);
+        } else {
+          // Regular SELECT Field
+          for(let option of field.options) {
+            if(option.value === fieldValue) {
+              option.selected = true;
+              break;
+            }
+          }
+        }
+      } else {
+        field.value = fieldValue;
+      }
+    }
+  }
+}
+
+const clearFilterButton = document.getElementsByClassName('administrate-filterable__clear-filter')[0];
+// Clear all query params on clear filter click
+clearFilterButton.addEventListener('click', function(event) {
+  // Prevent form submission
+  event.preventDefault();
+  window.location = removeQueryParams(window.location.href);
+});
+
+function removeQueryParams(url) {
+  let parsedUrl = new URL(url);
+
+  return parsedUrl.origin + parsedUrl.pathname;
+}

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

@@ -0,0 +1,92 @@
+.administrate-filterable__toggle-button {
+  position: fixed;
+  z-index: 4;
+  top: 38px;
+  right: 10px;
+}
+
+.administrate-filterable__overlay {
+  position: fixed;
+  z-index: 2;
+  top: 0;
+  left: 0;
+  width: 100%;
+  height: 100%;
+  background: #1C1D21;
+  opacity: 0;
+  visibility: hidden;
+  transition: opacity .5s, visibility .5s;
+}
+
+.administrate-filterable__open .administrate-filterable__overlay {
+  opacity: .6;
+  visibility: visible;
+}
+
+.administrate-filterable__container {
+  position: fixed;
+  z-index: 3;
+  top: 0;
+  right: 0;
+  height: 100%;
+  width: 90%;
+  max-width: 460px;
+  padding: 2em 3.5em;
+  background: #F3F3F3;
+  overflow: auto;
+  transform: translateZ(0);
+  transform: translateX(100%);
+  transition: transform .5s cubic-bezier(.07,.23,.34,1);
+}
+
+.administrate-filterable__open .administrate-filterable__container {
+  transform: translateX(0);
+}
+
+.administrate-filterable__container h2 {
+  font-size: 15px;
+  font-weight: bold;
+  text-transform: uppercase;
+  color: #AAAAAA;
+  margin: 1.5em 0;
+}
+
+@keyframes slide-in {
+  0% {
+      opacity: 0;
+      transform: translateX(80px);
+  }
+
+  100% {
+      opacity: 1;
+      transform: translateX(0);
+  }
+}
+
+.administrate-filterable__form .field-unit {
+  display: block;
+}
+
+.administrate-filterable__form .field-unit__label {
+  width: 100%;
+  margin-left: 0;
+  text-align: left;
+  margin-bottom: 5px;
+}
+
+.administrate-filterable__form .field-unit__field {
+  margin-left: 0;
+}
+
+.administrate-filterable__form .form-actions {
+  margin-left: 0;
+  text-align: center;
+}
+
+.administrate-filterable__form .administrate-filterable__clear-filter {
+  background: #888888;
+}
+
+.administrate-filterable__form .administrate-filterable__clear-filter:hover {
+  background: #666666;
+}

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

@@ -0,0 +1,32 @@
+<% if @administrate_filterable_attributes.present? %>
+  <% resource_title = display_resource_name(page.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 %>">
+    <svg style="width: 44px; height: 44px;" width="800px" height="800px" viewBox="0 0 24 24" fill="none" xmlns="http://www.w3.org/2000/svg">
+      <path d="M21 6H19M21 12H16M21 18H16M7 20V13.5612C7 13.3532 7 13.2492 6.97958 13.1497C6.96147 13.0615 6.93151 12.9761 6.89052 12.8958C6.84431 12.8054 6.77934 12.7242 6.64939 12.5617L3.35061 8.43826C3.22066 8.27583 3.15569 8.19461 3.10948 8.10417C3.06849 8.02393 3.03853 7.93852 3.02042 7.85026C3 7.75078 3 7.64677 3 7.43875V5.6C3 5.03995 3 4.75992 3.10899 4.54601C3.20487 4.35785 3.35785 4.20487 3.54601 4.10899C3.75992 4 4.03995 4 4.6 4H13.4C13.9601 4 14.2401 4 14.454 4.10899C14.6422 4.20487 14.7951 4.35785 14.891 4.54601C15 4.75992 15 5.03995 15 5.6V7.43875C15 7.64677 15 7.75078 14.9796 7.85026C14.9615 7.93852 14.9315 8.02393 14.8905 8.10417C14.8443 8.19461 14.7793 8.27583 14.6494 8.43826L11.3506 12.5617C11.2207 12.7242 11.1557 12.8054 11.1095 12.8958C11.0685 12.9761 11.0385 13.0615 11.0204 13.1497C11 13.2492 11 13.3532 11 13.5612V17L7 20Z" stroke="#000000" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"/>
+    </svg>
+  </a>
+
+  <div class="administrate-filterable__container" id="administrate-filterable">
+    <header>
+      <h2>Filter <%= resource_title %></h2>
+    </header>
+
+    <%= form_with(model: [:admin, @administrate_filterable_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">
+          <%= render_field attribute, f: f %>
+        </div>
+      <% end -%>
+
+      <div class="form-actions">
+        <%= f.button 'Clear Filter', class: 'administrate-filterable__clear-filter' %>
+        <%= f.submit 'Apply Filter', class: 'administrate-filterable__apply-filter' %>
+      </div>
+    <% end %>
+  </div>
+
+  <div class="administrate-filterable__overlay"></div>
+<% end %>

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

@@ -0,0 +1,19 @@
+<% 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>

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "administrate_filterable"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/administrate_filterable/filterer.rb

@@ -0,0 +1,39 @@
+module AdministrateFilterable
+  module Filterer
+    extend ActiveSupport::Concern
+
+    included do
+      filterable
+    end
+
+    class_methods do
+      def filterable
+        # TODO: Figure out a better way to implement the filter functionality
+        # This is a hack to implement the filter functionality by overriding the scoped_resource method
+        # 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
+          # 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)
+
+          data = resource_class.all
+
+          filter_params = params[resource_name]
+          return data if filter_params.blank?
+
+          filter_params.each do |key, value|
+            next unless data.column_names.include?(key.to_s) && value.present?
+
+            # TODO: Add support for relational filter (e.g. filter by `belongs_to` association, etc)
+            sanitized_query = ActiveRecord::Base.send(:sanitize_sql_array, ["#{key} LIKE ?", "%#{value}%"])
+            data = data.where(sanitized_query)
+          end
+
+          data
+        end
+      end
+    end
+  end
+end

data/lib/administrate_filterable/filterer_service.rb

@@ -0,0 +1,30 @@
+require 'csv'
+
+module AdministrateFilterable
+  class FiltererService
+    def self.filter_attributes(dashboard, resource)
+      new(dashboard, resource).filter_attributes
+    end
+
+    def initialize(dashboard, resource)
+      @dashboard = dashboard
+      @resource = resource
+    end
+
+    def filter_attributes
+      form = Administrate::Page::Form.new(@dashboard, @resource)
+
+      attributes.map do |attribute|
+        form.send :attribute_field, @dashboard, @resource, attribute, :form
+      end
+    end
+
+    private
+
+    def attributes
+      return @dashboard.class::FILTER_ATTRIBUTES if @dashboard.class.const_defined?("FILTER_ATTRIBUTES")
+
+      @dashboard.class::COLLECTION_ATTRIBUTES
+    end
+  end
+end

data/lib/administrate_filterable/version.rb

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

data/lib/administrate_filterable.rb

@@ -0,0 +1,11 @@
+require "administrate_filterable/version"
+require "administrate_filterable/filterer_service"
+require "administrate_filterable/filterer"
+require "administrate/engine"
+
+module AdministrateFilterable
+  class Engine < ::Rails::Engine
+    Administrate::Engine.add_javascript "administrate_filterable/application"
+    Administrate::Engine.add_stylesheet "administrate_filterable/application"
+  end
+end

metadata

@@ -0,0 +1,176 @@
+--- !ruby/object:Gem::Specification
+name: administrate_filterable
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Irvan Fauziansyah
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-11-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: administrate
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.17.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.17.0
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: actionview
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.2.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.2.2.1
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.2.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.2.2.1
+description: Simple plugin to add custom filter functionality to your Administrate
+  index page.
+email:
+- ervhan@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/main.yml"
+- ".gitignore"
+- ".rspec"
+- CHANGELOG
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- administrate_filterable.gemspec
+- 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
+- bin/console
+- bin/setup
+- lib/administrate_filterable.rb
+- lib/administrate_filterable/filterer.rb
+- lib/administrate_filterable/filterer_service.rb
+- lib/administrate_filterable/version.rb
+homepage: https://github.com/IrvanFza/administrate_filterable
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.22
+signing_key:
+specification_version: 4
+summary: Administrate Custom Filter
+test_files: []