headmin 0.5.4 → 0.5.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c163e16eb068c93256e3a73a0ac3b58f569cc72c36da590f084ecb13873b8866
-  data.tar.gz: 9297b7bfd0194980aa843c45e59f9180349bc17e571cfe8f9c75678738de7def
+  metadata.gz: 3445263c38deb23953f15bd095f0ab4d35acdba03e57863990afc270b3b0ec2d
+  data.tar.gz: 7ff3cbb8b497e7abfec49ee1222f3980b08779627179d788cd332794076c3ec7
 SHA512:
-  metadata.gz: b72bc6a71c864837e78619f8bfc7b0d455d4f57d108790f6d6619fbb3fe2acb882d2be87236b8a2d87204b55995fd4234c8617ee93be5a587b6eafa2616aaac4
-  data.tar.gz: 819ec0caa24dbfa82ac02dec7909d6c888550f87c71bf5eadae0b86b03a179c57b599c5a3af3b418e4435dfc569373a1b744ed5621380382bdf7cff4cb6d229d
+  metadata.gz: 6b6d3c45da2fc0d1e3d9d3f69daccfdb689eae2785cc46d19fdec80ffff497987193fcb251eb2576f95d2d7927179d2c0264fa0548c3363240193a0c51e7efcc
+  data.tar.gz: 1badf3f039045aaf9ddee10bcf1f2686bd3cd44f0e04db6f893c8e61c4cf8974b3464a427bcf6c66cbc7bfd03e2b502d48bd4edd8a4c26527484feefac74691b

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    headmin (0.5.3)
+    headmin (0.5.4)
       closure_tree (~> 7.4)
       inline_svg (~> 1.7)
       redcarpet (~> 3.5)

data/app/assets/stylesheets/headmin.css

@@ -1,7 +1,7 @@
 @charset "UTF-8";
 @import "https://cdn.jsdelivr.net/npm/bootstrap-icons@1.5.0/font/bootstrap-icons.css";
 
-/* sass-plugin-0:/opt/homebrew/var/www/headmin/src/scss/headmin.scss */
+/* sass-plugin-0:/usr/local/var/www/headmin/src/scss/headmin.scss */
 :root {
   --bs-blue: #0d6efd;
   --bs-indigo: #6610f2;

data/app/controllers/concerns/headmin/pagination.rb

@@ -2,7 +2,11 @@ module Headmin
   module Pagination
     def paginate(collection)
       @records_filtered = collection.count
-      collection.page(page).per(per_page)
+      if collection.is_a?(Array)
+        Kaminari.paginate_array(collection).page(page).per(per_page)
+      else
+        collection.page(page).per(per_page)
+      end
     end
 
     def page

data/app/models/headmin/filter/association_view.rb

@@ -1,6 +1,6 @@
 module Headmin
   module Filter
-    class AssociationView < ViewModel
+    class AssociationView < FilterView
       def base_options
         keys = %i[name label form]
         options = to_h.slice(*keys)

data/app/models/headmin/filter/base.rb

@@ -21,12 +21,13 @@ module Headmin
       }
 
       # Methods
-      def initialize(attribute, params)
-        @raw_value = params[attribute]
-        @attribute = attribute
+      def initialize(attribute, params, association: nil)
+        @attribute = association ? "#{association}_#{attribute}".to_sym : attribute
+        @raw_value = params[@attribute]
+        @association = association
         @instructions = []
 
-        if params.key?(attribute)
+        if params.key?(@attribute)
           parse(@raw_value)
         end
       end
@@ -61,7 +62,8 @@ module Headmin
           query = build_query(query, collection, instruction)
         end
 
-        collection.where(query)
+        collection = collection.joins(@association) if @association
+        collection.distinct.where(query)
       end
 
       def cast_value(value)
@@ -74,6 +76,30 @@ module Headmin
         value
       end
 
+      def build_query(query, collection, instruction)
+        query_operator = convert_to_query_operator(instruction[:operator])
+        query_value = convert_to_query_value(instruction[:value], instruction[:operator])
+
+        query_operator, query_value = process_null_operators(query_operator, query_value)
+
+        model = collection.is_a?(Class) ? collection : collection.model
+
+        if @association
+          # Association attributes are passed through as {association}_{attribute}, so we need to transform this into {attribute}
+          new_attribute = attribute.to_s.gsub("#{@association}_", "").to_sym
+          new_model = model.reflect_on_association(@association)
+
+          # In case the association cannot be found, raise a well defined error
+          raise UnknownAssociation if new_model.nil?
+
+          new_query = new_model.klass.arel_table[new_attribute].send(query_operator, query_value)
+        else
+          new_query = model.arel_table[attribute].send(query_operator, query_value)
+        end
+
+        query ? query.send(instruction[:conditional], new_query) : new_query
+      end
+
       private
 
       def parse(string)
@@ -139,18 +165,6 @@ module Headmin
         process_value(string, operator)
       end
 
-      def build_query(query, collection, instruction)
-        query_operator = convert_to_query_operator(instruction[:operator])
-        query_value = convert_to_query_value(instruction[:value], instruction[:operator])
-
-        query_operator, query_value = process_null_operators(query_operator, query_value)
-
-        model = collection.is_a?(Class) ? collection : collection.model
-        new_query = model.arel_table[attribute].send(query_operator, query_value)
-
-        query ? query.send(instruction[:conditional], new_query) : new_query
-      end
-
       def process_null_operators(operator, value)
         # In case of null operators (is_null and is_not_null), we have to intercept the operator and value values
         # and transform them to the correct operator (eq or not_eq) and value (nil)
@@ -237,5 +251,8 @@ module Headmin
 
     class NotImplementedMethodError < StandardError
     end
+
+    class UnknownAssociation < StandardError
+    end
   end
 end

data/app/models/headmin/filter/boolean_view.rb

@@ -1,6 +1,6 @@
 module Headmin
   module Filter
-    class BooleanView < ViewModel
+    class BooleanView < FilterView
       def base_options
         keys = %i[name label form]
         options = to_h.slice(*keys)
@@ -28,10 +28,6 @@ module Headmin
         @name || attribute
       end
 
-      def label
-        @label || I18n.t("attributes.#{attribute}", default: name.to_s)
-      end
-
       def default_base_options
         {
           label: label,

data/app/models/headmin/filter/date_view.rb

@@ -1,6 +1,6 @@
 module Headmin
   module Filter
-    class DateView < ViewModel
+    class DateView < FilterView
       def base_options
         keys = %i[name label form]
         options = to_h.slice(*keys)
@@ -23,10 +23,6 @@ module Headmin
         @name || attribute
       end
 
-      def label
-        @label || I18n.t("attributes.#{attribute}", default: name.to_s)
-      end
-
       def default_base_options
         {
           label: label,

data/app/models/headmin/filter/field.rb

@@ -0,0 +1,55 @@
+module Headmin
+  module Filter
+    class Field < Headmin::Filter::Base
+      OPERATORS = %w[eq not_eq matches does_not_match]
+
+      def initialize(attribute, params, association: nil)
+        @attribute = association ? "#{association}_#{attribute}".to_sym : attribute
+        @attribute = "field_#{attribute}".to_sym
+        @raw_value = params[@attribute]
+        @association = association
+        @instructions = []
+
+        if params.key?(@attribute)
+          parse(@raw_value)
+        end
+      end
+
+      def cast_value(value)
+        value
+      end
+
+      def display_value(value)
+        value.downcase
+      end
+
+      def query(collection)
+        return collection unless @instructions.any?
+
+        query = nil
+
+        @instructions.each do |instruction|
+          query = build_query(query, collection, instruction)
+        end
+
+        collection = collection.joins(:fields)
+        collection.where(query)
+      end
+
+      def build_query(query, collection, instruction)
+        query_operator = convert_to_query_operator(instruction[:operator])
+        query_value = convert_to_query_value(instruction[:value], instruction[:operator])
+
+        query_operator, query_value = process_null_operators(query_operator, query_value)
+
+        model = collection.is_a?(Class) ? collection : collection.model
+
+        new_attribute = attribute.to_s.gsub("field_", "").to_sym
+        fields_model = model.reflect_on_association(:fields).klass
+        new_query = fields_model.arel_table[:name].matches(new_attribute).and(fields_model.arel_table[:value].send(query_operator, query_value))
+
+        query ? query.send(instruction[:conditional], new_query) : new_query
+      end
+    end
+  end
+end

data/app/models/headmin/filter/field_view.rb

@@ -0,0 +1,50 @@
+module Headmin
+  module Filter
+    class FieldView < FilterView
+      def base_options
+        keys = %i[name label form]
+        options = to_h.slice(*keys)
+        default_base_options.merge(options)
+      end
+
+      def input_options
+        keys = %i[form]
+        options = to_h.slice(*keys)
+        default_input_options.merge(options)
+      end
+
+      private
+
+      def id
+        "#{name}_value"
+      end
+
+      def name
+        "field_#{@name}".to_sym || attribute
+      end
+
+      def default_base_options
+        {
+          label: label,
+          name: "field_#{attribute}".to_sym,
+          filter: Headmin::Filter::Field.new("field_#{attribute}".to_sym, @params),
+          allowed_operators: Headmin::Filter::Field::OPERATORS - %w[in not_in]
+        }
+      end
+
+      def default_input_options
+        {
+          label: false,
+          wrapper: false,
+          id: id,
+          name: nil,
+          data: {
+            action: "change->filter#updateHiddenValue",
+            filter_target: "value",
+            filter_row_target: "original"
+          }
+        }
+      end
+    end
+  end
+end

data/app/models/headmin/filter/filter_view.rb

@@ -0,0 +1,25 @@
+module Headmin
+  module Filter
+    class FilterView < ViewModel
+      def attribute
+        @association ? "#{@association}_#{@attribute}".to_sym : @attribute
+      end
+
+      def label
+        @label || I18n.t("attributes.#{attribute}", default: @association ? "#{association_model.model_name.human(count: 1)} - #{association_model.human_attribute_name(@attribute)}" : name.to_s)
+      end
+
+      def reflection
+        if @association
+          form.object.class.reflect_on_association(@association)
+        end
+      end
+
+      def association_model
+        if @association
+          reflection.klass
+        end
+      end
+    end
+  end
+end

data/app/models/headmin/filter/number_view.rb

@@ -1,6 +1,6 @@
 module Headmin
   module Filter
-    class NumberView < ViewModel
+    class NumberView < FilterView
       def base_options
         keys = %i[name label form]
         options = to_h.slice(*keys)
@@ -23,10 +23,6 @@ module Headmin
         @name || attribute
       end
 
-      def label
-        @label || I18n.t("attributes.#{attribute}", default: name.to_s)
-      end
-
       def default_base_options
         {
           label: label,

data/app/models/headmin/filter/options_view.rb

@@ -1,6 +1,6 @@
 module Headmin
   module Filter
-    class OptionsView < ViewModel
+    class OptionsView < FilterView
       def base_options
         keys = %i[name label form]
         options = to_h.slice(*keys)
@@ -27,10 +27,6 @@ module Headmin
         @name || attribute
       end
 
-      def label
-        @label || I18n.t("attributes.#{attribute}", default: name.to_s)
-      end
-
       def default_base_options
         {
           label: label,

data/app/models/headmin/filter/text_view.rb

@@ -1,6 +1,6 @@
 module Headmin
   module Filter
-    class TextView < ViewModel
+    class TextView < FilterView
       def base_options
         keys = %i[name label form]
         options = to_h.slice(*keys)
@@ -23,10 +23,6 @@ module Headmin
         @name || attribute
       end
 
-      def label
-        @label || I18n.t("attributes.#{attribute}", default: name.to_s)
-      end
-
       def default_base_options
         {
           label: label,

data/app/models/headmin/filters.rb

@@ -13,15 +13,30 @@ module Headmin
       @param_types = param_types
     end
 
-    def parse(attribute, type)
+    def parse(attribute, type, association: nil)
       class_name = "Headmin::Filter::#{type.to_s.classify}".constantize
-      class_name.new(attribute, @params)
+      class_name.new(attribute, @params, association: association)
     end
 
     def query(collection)
       @param_types.each do |attribute, type|
-        filter = parse(attribute, type)
-        collection = filter.query(collection)
+        if type.is_a? Hash
+          # We are given attribute filters of an association
+          association = attribute
+
+          # By default, we offer a filter of type association
+          association_filter = Headmin::Filter::Association.new(attribute, @params, association: nil)
+          collection = association_filter.query(collection)
+
+          # Query all the passed attribute filters for this association
+          type.each do |new_attribute, new_type|
+            filter = parse(new_attribute, new_type, association: association)
+            collection = filter.query(collection)
+          end
+        else
+          filter = parse(attribute, type)
+          collection = filter.query(collection)
+        end
       end
       collection
     end

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

@@ -16,7 +16,7 @@
   action = local_assigns.has_key?(:url) ? url : request.path
 
   begin
-    model = controller_name.singularize.capitalize.constantize
+    model = controller_name.classify.constantize
   rescue
     raise "Cannot find class!"
   end

data/app/views/headmin/filters/_field.html.erb

@@ -0,0 +1,23 @@
+<%
+  # headmin/filters/field
+  #
+  # ==== Required parameters
+  # * +form+ - Form object
+  # * +attribute+ - Name of the attribute to be filtered
+  #
+  # ==== Optional parameters
+  # * +label+ - Display label
+  # * +name+ - Name of the filter parameter
+  #
+  # ==== Examples
+  #   Basic version
+  #   <%= render "headmin/filters", url: admin_orders_path do |form| %#>
+  #     <%= render "headmin/filters/field", form: form, attribute: :title %#>
+  #   <% end  %#>
+
+  text = Headmin::Filter::FieldView.new(local_assigns.merge(params: params))
+%>
+
+<%= render "headmin/filters/base", text.base_options do |value| %>
+  <%= render "headmin/forms/text", text.input_options.merge({value: value}) %>
+<% end %>

data/lib/headmin/version.rb

@@ -1,3 +1,3 @@
 module Headmin
-  VERSION = "0.5.4"
+  VERSION = "0.5.5"
 end

data/package.json

@@ -1,6 +1,6 @@
 {
   "name": "headmin",
-  "version": "0.5.3",
+  "version": "0.5.4",
   "description": "Admin component library",
   "module": "app/assets/javascripts/headmin.js",
   "main": "app/assets/javascripts/headmin.js",

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: headmin
 version: !ruby/object:Gem::Version
-  version: 0.5.4
+  version: 0.5.5
 platform: ruby
 authors:
 - Jef Vlamings
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-08-22 00:00:00.000000000 Z
+date: 2022-09-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: closure_tree
@@ -268,6 +268,9 @@ files:
 - app/models/headmin/filter/conditional_view.rb
 - app/models/headmin/filter/date.rb
 - app/models/headmin/filter/date_view.rb
+- app/models/headmin/filter/field.rb
+- app/models/headmin/filter/field_view.rb
+- app/models/headmin/filter/filter_view.rb
 - app/models/headmin/filter/flatpickr_view.rb
 - app/models/headmin/filter/menu_item_view.rb
 - app/models/headmin/filter/money.rb
@@ -336,6 +339,7 @@ files:
 - app/views/headmin/filters/_base.html.erb
 - app/views/headmin/filters/_boolean.html.erb
 - app/views/headmin/filters/_date.html.erb
+- app/views/headmin/filters/_field.html.erb
 - app/views/headmin/filters/_flatpickr.html.erb
 - app/views/headmin/filters/_number.html.erb
 - app/views/headmin/filters/_options.html.erb