avo 2.3.0 → 2.3.1.pre.1

data/app/controllers/avo/base_controller.rb

@@ -5,6 +5,7 @@ module Avo
     before_action :set_resource_name
     before_action :set_resource
     before_action :hydrate_resource
+    before_action :set_applied_filters, only: :index
     before_action :set_model, only: [:show, :edit, :destroy, :update, :order]
     before_action :set_model_to_fill
     before_action :set_edit_title_and_breadcrumbs, only: [:edit, :update]
@@ -55,8 +56,8 @@ module Avo
         end
       end
 
-      # Apply filters
-      applied_filters.each do |filter_class, filter_value|
+      # Apply filters to the current query
+      filters_to_be_applied.each do |filter_class, filter_value|
         @query = filter_class.safe_constantize.new.apply_query request, @query, filter_value
       end
 
@@ -308,28 +309,32 @@ module Avo
         .select { |action| action.visible_in_view }
     end
 
-    def applied_filters
-      if params[:filters].present?
-        return JSON.parse(Base64.decode64(params[:filters]))
-      end
+    def set_applied_filters
+      @applied_filters = JSON.parse(Base64.decode64(params[:filters]))
+    rescue
+      @applied_filters = {}
+    end
 
+    # Get the default state of the filters and override with the user applied filters
+    def filters_to_be_applied
       filter_defaults = {}
 
       @resource.get_filters.each do |filter_class|
         filter = filter_class.new
 
-        if filter.default.present?
+        unless filter.default.nil?
           filter_defaults[filter_class.to_s] = filter.default
         end
       end
 
-      filter_defaults
+      filter_defaults.merge(@applied_filters)
     end
 
+    # Caching these so we know when the filters have changed so we reset the pagination
     def cache_applied_filters
       ::Avo::App.cache_store.delete applied_filters_cache_key if params[:filters].nil?
 
-      ::Avo::App.cache_store.write(applied_filters_cache_key, params[:filters], expires_in: 7.days)
+      ::Avo::App.cache_store.write(applied_filters_cache_key, params[:filters], expires_in: 1.day)
     end
 
     def reset_pagination_if_filters_changed

data/app/javascript/js/controllers/filter_controller.js

@@ -38,18 +38,22 @@ export default class extends Controller {
     const value = this.getFilterValue()
     const filterClass = this.getFilterClass()
 
+    // Get the `filters` param for all params
     let filters = this.uriParams()[this.uriParam('filters')]
 
+    // Decode the filters
     if (filters) {
       filters = JSON.parse(this.b64DecodeUnicode(filters))
     } else {
       filters = {}
     }
 
+    // Get the values for this particular filter
     filters[filterClass] = value
 
     const filtered = Object.keys(filters)
-      .filter((key) => filters[key] !== '')
+      // Filter out the filters without a value
+      .filter((key) => filters[key] !== null)
       .reduce((obj, key) => {
         obj[key] = filters[key]
 
@@ -58,10 +62,16 @@ export default class extends Controller {
 
     let encodedFilters
 
+    // Encode the filters and their values
     if (filtered && Object.keys(filtered).length > 0) {
       encodedFilters = this.b64EncodeUnicode(JSON.stringify(filtered))
     }
 
+    this.navigateToURLWithFilters(encodedFilters)
+  }
+
+  navigateToURLWithFilters(encodedFilters) {
+    // Create a new URI with them
     const url = new URI(this.urlRedirectTarget.href)
 
     const query = {

data/app/javascript/js/controllers/multiple_select_filter_controller.js

@@ -4,7 +4,9 @@ export default class extends BaseFilterController {
   static targets = ['selector']
 
   getFilterValue() {
-    return Array.from(this.selectorTarget.selectedOptions).map(({ value }) => value)
+    const filterValue = Array.from(this.selectorTarget.selectedOptions).map(({ value }) => value)
+
+    return filterValue.length === 0 ? null : filterValue
   }
 
   getFilterClass() {

data/app/javascript/js/controllers/select_filter_controller.js

@@ -4,7 +4,7 @@ export default class extends BaseFilterController {
   static targets = ['selector']
 
   getFilterValue() {
-    return this.selectorTarget.value
+    return this.selectorTarget.value === '' ? null : this.selectorTarget.value
   }
 
   getFilterClass() {

data/app/views/avo/base/_boolean_filter.html.erb

@@ -1,23 +1,10 @@
-<%
-  begin
-    decoded_filters_param = JSON.parse(Base64.decode64(params[:filters]))
-    set_value = decoded_filters_param[filter.class.to_s]
-  rescue => exception
-    if filter.default.present?
-      set_value = filter.default.stringify_keys
-    else
-      set_value = {}
-    end
-  end
-  set_value = {} if set_value.nil?
-%>
 <div data-controller="boolean-filter" data-filter-name="<%= filter.name %>">
   <%= filter_wrapper name: filter.name do %>
     <div class="flex items-center">
       <div class="space-y-2">
         <% filter.options.each do |value, label| %>
           <label class="flex items-center text-gray-700 text-sm">
-            <%= check_box_tag filter.id, value, set_value[value.to_s],
+            <%= check_box_tag filter.id, value, filter.selected_value(value.to_s, @applied_filters),
               class: 'mr-2 text-lg h-4 w-4',
               id: "avo_filters_#{filter.id.parameterize.underscore}",
               'data-filter-class': filter.class,

data/app/views/avo/base/_multiple_select_filter.html.erb

@@ -1,17 +1,6 @@
-<%
-  set_value = filter.default.present? ? filter.default.select { |key, value| value }.keys.map(&:to_sym) : {}
-
-  begin
-    decoded_filters_param = JSON.parse(Base64.decode64(params[:filters]))
-    if decoded_filters_param[filter.class.to_s].present?
-      set_value = decoded_filters_param[filter.class.to_s]
-    end
-  rescue
-  end
-%>
 <div data-controller="multiple-select-filter" data-filter-name="<%= filter.name %>">
   <%= filter_wrapper name: filter.name do %>
-    <%= select_tag filter.id, options_for_select(filter.options.invert, set_value),
+    <%= select_tag filter.id, options_for_select(filter.options.invert, filter.selected_value(@applied_filters)),
       class: input_classes('w-full mb-0'),
       multiple: true,
       id: "avo_filters_#{filter.id.parameterize.underscore}",
@@ -19,7 +8,7 @@
       'data-multiple-select-filter-target': 'selector'
     %>
     <div class="flex justify-end">
-      <%= a_button class: 'mt-4', color: :blue, size: :sm, data: { action: "multiple-select-filter#changeFilter" } do %>
+      <%= a_button class: 'mt-4', color: :blue, size: :xs, data: { action: "multiple-select-filter#changeFilter" } do %>
         Filter by <%=filter.name %>
       <% end %>
     </div>

data/app/views/avo/base/_select_filter.html.erb

@@ -1,14 +1,6 @@
-<%
-  begin
-    decoded_filters_param = JSON.parse(Base64.decode64(params[:filters]))
-    set_value = decoded_filters_param[filter.class.to_s]
-  rescue => exception
-    set_value = filter.default
-  end
-%>
 <div data-controller="select-filter" data-filter-name="<%= filter.name %>">
   <%= filter_wrapper name: filter.name do %>
-    <%= select_tag filter.id, options_for_select(filter.options.invert, set_value),
+    <%= select_tag filter.id, options_for_select(filter.options.invert, filter.applied_or_default_value(@applied_filters)),
       class: input_classes('w-full mb-0'),
       include_blank: '—',
       id: "avo_filters_#{filter.id.parameterize.underscore}",

data/app/views/avo/base/_text_filter.html.erb

@@ -1,14 +1,6 @@
-<%
-  begin
-    decoded_filters_param = JSON.parse(Base64.decode64(params[:filters]))
-    set_value = decoded_filters_param[filter.class.to_s]
-  rescue => exception
-    set_value = filter.default
-  end
-%>
 <div data-controller="text-filter" data-filter-name="<%= filter.name %>">
   <%= filter_wrapper name: filter.name do %>
-    <%= text_field_tag filter.id, set_value,
+    <%= text_field_tag filter.id, filter.applied_or_default_value(@applied_filters),
       class: input_classes('w-full mb-0'),
       id: "avo_filters_#{filter.id.parameterize.underscore}",
       'data-filter-class': filter.class.to_s,
@@ -16,7 +8,7 @@
       'data-action': 'keypress->text-filter#tryToSubmit'
     %>
     <div class="flex justify-end">
-      <%= a_button class: 'mt-4', color: :blue, data: { action: "text-filter#changeFilter" }, size: :sm do %>
+      <%= a_button class: 'mt-4', color: :blue, data: { action: "text-filter#changeFilter" }, size: :xs do %>
         <%= filter.button_label || "Filter by #{filter.name}" %>
       <% end %>
     </div>

data/lib/avo/filters/base_filter.rb

@@ -3,11 +3,11 @@ module Avo
     class BaseFilter
       class_attribute :name, default: "Filter"
       class_attribute :component, default: "boolean-filter"
-      class_attribute :default, default: ""
+      class_attribute :default, default: nil
       class_attribute :template, default: "avo/base/select_filter"
 
       def apply_query(request, query, value)
-        value.symbolize_keys! if value.is_a? Hash
+        value.stringify_keys! if value.is_a? Hash
 
         apply(request, query, value)
       end
@@ -15,6 +15,21 @@ module Avo
       def id
         self.class.name.underscore.tr("/", "_")
       end
+
+      # Get the applied value this filter.
+      # If it's not present return the default value.
+      def applied_or_default_value(applied_filters)
+        # Get the values for this particular filter
+        applied_value = applied_filters[self.class.to_s]
+
+        # Return that value if present
+        return applied_value unless applied_value.nil?
+
+        # Return that default
+        default
+      rescue
+        default
+      end
     end
   end
 end

data/lib/avo/filters/boolean_filter.rb

@@ -2,6 +2,18 @@ module Avo
   module Filters
     class BooleanFilter < BaseFilter
       self.template = "avo/base/boolean_filter"
+
+      def selected_value(item, applied_filters)
+        # See if there are any applied rules for this particular filter
+        if applied_filters[self.class.to_s].present?
+          # Symbolize the keys because they are returned from de-serialization (JSON and Base64)
+          applied_filters[self.class.to_s].stringify_keys.dig(item.to_s)
+        else
+          applied_or_default_value(applied_filters).stringify_keys.dig(item.to_s)
+        end
+      rescue
+        false
+      end
     end
   end
 end

data/lib/avo/filters/multiple_select_filter.rb

@@ -2,6 +2,21 @@ module Avo
   module Filters
     class MultipleSelectFilter < BaseFilter
       self.template = "avo/base/multiple_select_filter"
+
+      # The input expects an array of strings for the value
+      # Ex: ['admins', 'non_admins']
+      def selected_value(applied_filters)
+        # Get the values for this particular filter
+        applied_value = applied_filters[self.class.to_s]
+
+        # Return that value if present
+        return applied_value unless applied_value.nil?
+
+        # Return that default
+        return default unless default.nil?
+
+        []
+      end
     end
   end
 end

data/lib/avo/filters/text_filter.rb

@@ -4,6 +4,10 @@ module Avo
       class_attribute :button_label
 
       self.template = "avo/base/text_filter"
+
+      def selected_value(applied_filters)
+        applied_or_default_value
+      end
     end
   end
 end

data/lib/avo/version.rb

@@ -1,3 +1,3 @@
 module Avo
-  VERSION = "2.3.0"
+  VERSION = "2.3.1.pre.1"
 end