headmin 0.4.0 → 0.5.0

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

@@ -0,0 +1,61 @@
+module Headmin
+  module Filter
+    class BooleanView < ViewModel
+      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 value
+        # If the value is nil we want to display the first option (which is true)
+        @value.nil? ? @value = true : ""
+      end
+
+      def id
+        "#{name}_value"
+      end
+
+      def name
+        @name || attribute
+      end
+
+      def label
+        @label || I18n.t("attributes.#{attribute}", default: name.to_s)
+      end
+
+      def default_base_options
+        {
+          label: label,
+          name: attribute,
+          filter: Headmin::Filter::Boolean.new(name, @params),
+          display_values: [[I18n.t("headmin.filters.values.true"), true], [I18n.t("headmin.filters.values.false"), false]],
+          allowed_operators: Headmin::Filter::Boolean::OPERATORS
+        }
+      end
+
+      def default_input_options
+        {
+          label: false,
+          wrapper: false,
+          id: id,
+          collection: [[I18n.t("headmin.filters.values.true"), 1], [I18n.t("headmin.filters.values.false"), 0]],
+          selected: value ? 1 : 0,
+          data: {
+            action: "change->filter#updateHiddenValue",
+            filter_target: "value",
+            filter_row_target: "original"
+          }
+        }
+      end
+    end
+  end
+end

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

@@ -0,0 +1,25 @@
+module Headmin
+  module Filter
+    class ButtonView < ViewModel
+      def id
+        @id || SecureRandom.hex
+      end
+
+      def name
+        @name.to_sym
+      end
+
+      def label
+        @label || name.to_s.humanize
+      end
+
+      def display_values
+        @display_values || []
+      end
+
+      def filter
+        @filter || nil
+      end
+    end
+  end
+end

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

@@ -0,0 +1,16 @@
+module Headmin
+  module Filter
+    class ConditionalView < ViewModel
+      def selected
+        @selected ? "+#{@selected.to_s.upcase}+" : nil
+      end
+
+      def values
+        {
+          "+AND+": I18n.t("headmin.filters.filter.conditional.and"),
+          "+OR+": I18n.t("headmin.filters.filter.conditional.or")
+        }
+      end
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+module Headmin
+  module Filter
+    class Date < Headmin::Filter::Base
+      OPERATORS = %w[eq not_eq gt gteq lt lteq between not_between in not_in is_null is_not_null]
+
+      def cast_value(value)
+        value.present? ? value.to_date : ::Date.current
+      rescue
+        raise TypeError, "The value that was passed to this filter is not a date"
+      end
+
+      def display_value(value)
+        # This uses the default date format of headmin.
+        # Can be overwritten by setting default date format of the application.
+        I18n.l(value)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,52 @@
+module Headmin
+  module Filter
+    class DateView < ViewModel
+      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
+        @name || attribute
+      end
+
+      def label
+        @label || I18n.t("attributes.#{attribute}", default: name.to_s)
+      end
+
+      def default_base_options
+        {
+          label: label,
+          name: attribute,
+          filter: Headmin::Filter::Date.new(name, @params),
+          allowed_operators: Headmin::Filter::Date::OPERATORS - %w[in not_in between not_between]
+        }
+      end
+
+      def default_input_options
+        {
+          label: false,
+          wrapper: false,
+          id: id,
+          data: {action: "change->filter#updateHiddenValue",
+                 filter_target: "value",
+                 filter_row_target: "original"},
+          class: "form-control"
+        }
+      end
+    end
+  end
+end

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

@@ -0,0 +1,54 @@
+module Headmin
+  module Filter
+    class FlatpickrView < ViewModel
+      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
+        @name || attribute
+      end
+
+      def label
+        @label || I18n.t("attributes.#{attribute}", default: name.to_s)
+      end
+
+      def default_base_options
+        {
+          label: label,
+          name: attribute,
+          filter: Headmin::Filter::Date.new(name, @params),
+          allowed_operators: Headmin::Filter::Date::OPERATORS - %w[in not_in between not_between]
+        }
+      end
+
+      def default_input_options
+        {
+          label: false,
+          wrapper: false,
+          id: id,
+          data: {
+            action: "change->filter#updateHiddenValue",
+            filter_target: "value",
+            filter_row_target: "original"
+          },
+          class: "form-control"
+        }
+      end
+    end
+  end
+end

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

@@ -0,0 +1,6 @@
+module Headmin
+  module Filter
+    class MenuItemView < ViewModel
+    end
+  end
+end

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

@@ -0,0 +1,13 @@
+module Headmin
+  module Filter
+    class Money < Headmin::Filter::Number
+      def cast_value(value)
+        super(value) * 100
+      end
+
+      def attribute
+        "#{@attribute}_cents"
+      end
+    end
+  end
+end

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

@@ -0,0 +1,27 @@
+module Headmin
+  module Filter
+    class Number < Headmin::Filter::Base
+      OPERATORS = %w[eq not_eq gt gteq lt lteq between not_between in not_in is_null is_not_null]
+
+      def cast_value(value)
+        is_i?(value) ? value.to_i : 0
+      end
+
+      def to_s
+        string
+      end
+
+      private
+
+      def is_i?(value)
+        # Regex: this selects signed digits (\d) only, it is then checked to the value, e.g.:
+        # is_i?("3") = true
+        # is_i?("-3") = true
+        # is_i?("3a") = false
+        # is_i?("3.2") = false
+
+        /\A[-+]?\d+\z/.match(value)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,54 @@
+module Headmin
+  module Filter
+    class NumberView < ViewModel
+      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
+        @name || attribute
+      end
+
+      def label
+        @label || I18n.t("attributes.#{attribute}", default: name.to_s)
+      end
+
+      def default_base_options
+        {
+          label: label,
+          name: attribute,
+          filter: Headmin::Filter::Number.new(name, @params),
+          allowed_operators: Headmin::Filter::Number::OPERATORS - %w[in not_in between not_between]
+        }
+      end
+
+      def default_input_options
+        {
+          label: false,
+          wrapper: false,
+          id: id,
+          data: {
+            action: "change->filter#updateHiddenValue",
+            filter_target: "value",
+            filter_row_target: "original"
+          },
+          class: "form-control"
+        }
+      end
+    end
+  end
+end

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

@@ -0,0 +1,30 @@
+module Headmin
+  module Filter
+    class OperatorView < ViewModel
+      def allowed_operators
+        @allowed_operators || []
+      end
+
+      def selected
+        @selected || nil
+      end
+
+      def operator_symbol
+        {
+          eq: "&equals; #{I18n.t("headmin.filters.operators.eq")}",
+          not_eq: "&ne; #{I18n.t("headmin.filters.operators.not_eq")}",
+          gt: "&gt; #{I18n.t("headmin.filters.operators.gt")}",
+          gteq: "&ge; #{I18n.t("headmin.filters.operators.gteq")}",
+          lt: "&lt; #{I18n.t("headmin.filters.operators.lt")}",
+          lteq: "&le; #{I18n.t("headmin.filters.operators.lteq")}",
+          starts_with: "&sqsub; #{I18n.t("headmin.filters.operators.starts_with")}",
+          ends_with: "&sqsup; #{I18n.t("headmin.filters.operators.ends_with")}",
+          matches: "&approx; #{I18n.t("headmin.filters.operators.matches")}",
+          does_not_match: "&napprox; #{I18n.t("headmin.filters.operators.does_not_match")}",
+          is_null: "&#9675; #{I18n.t("headmin.filters.operators.is_null")}",
+          is_not_null: "&#9679; #{I18n.t("headmin.filters.operators.is_not_null")}"
+        }
+      end
+    end
+  end
+end

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

@@ -0,0 +1,61 @@
+module Headmin
+  module Filter
+    class OptionsView < ViewModel
+      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
+
+      def collection
+        @collection || []
+      end
+
+      private
+
+      def id
+        "#{name}_value"
+      end
+
+      def name
+        @name || attribute
+      end
+
+      def label
+        @label || I18n.t("attributes.#{attribute}", default: name.to_s)
+      end
+
+      def default_base_options
+        {
+          label: label,
+          name: attribute,
+          display_values: collection,
+          filter: Headmin::Filter::Text.new(name, @params),
+          allowed_operators: Headmin::Filter::Text::OPERATORS - %w[starts_with ends_with in not_in]
+        }
+      end
+
+      def default_input_options
+        {
+          label: false,
+          wrapper: false,
+          id: id,
+          data: {
+            action: "change->filter#updateHiddenValue",
+            filter_target: "value",
+            filter_row_target: "original"
+          },
+          collection: collection,
+          selected: selected,
+          class: "form-select"
+        }
+      end
+    end
+  end
+end

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

@@ -0,0 +1,13 @@
+module Headmin
+  module Filter
+    class RowView < ViewModel
+      def operator
+        @operator || nil
+      end
+
+      def value
+        @value || nil
+      end
+    end
+  end
+end

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

@@ -0,0 +1,18 @@
+module Headmin
+  module Filter
+    class Search < Headmin::Filter::Base
+      def query(collection)
+        return collection unless @instructions.any?
+        collection.search(raw_value)
+      end
+
+      def cast_value(value)
+        value
+      end
+
+      def display_value(value)
+        value.downcase
+      end
+    end
+  end
+end

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

@@ -0,0 +1,31 @@
+module Headmin
+  module Filter
+    class SearchView < ViewModel
+      def input_options
+        keys = attributes - %i[params]
+        options = to_h.slice(*keys)
+        options = default_input_options.merge(options)
+        options.merge(label: false)
+      end
+
+      private
+
+      def default_input_options
+        {
+          name: name,
+          value: params[name],
+          wrapper: false,
+          placeholder: placeholder
+        }
+      end
+
+      def name
+        @name || attribute || :search
+      end
+
+      def placeholder
+        @placeholder || I18n.t("headmin.filters.search.placeholder", resource: label)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,25 @@
+module Headmin
+  module Filter
+    class Text < Headmin::Filter::Base
+      OPERATORS = %w[eq not_eq in not_in matches does_not_match starts_with ends_with is_null is_not_null starts_with ends_with]
+
+      def cast_value(value)
+        value
+      end
+
+      def display_value(value)
+        value.downcase
+      end
+
+      private
+
+      def convert_to_ends(value)
+        "%#{value}"
+      end
+
+      def convert_to_starts(value)
+        "#{value}%"
+      end
+    end
+  end
+end

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

@@ -0,0 +1,53 @@
+module Headmin
+  module Filter
+    class TextView < ViewModel
+      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
+        @name || attribute
+      end
+
+      def label
+        @label || I18n.t("attributes.#{attribute}", default: name.to_s)
+      end
+
+      def default_base_options
+        {
+          label: label,
+          name: attribute,
+          filter: Headmin::Filter::Text.new(name, @params),
+          allowed_operators: Headmin::Filter::Text::OPERATORS - %w[in not_in]
+        }
+      end
+
+      def default_input_options
+        {
+          label: false,
+          wrapper: false,
+          id: id,
+          data: {
+            action: "change->filter#updateHiddenValue",
+            filter_target: "value",
+            filter_row_target: "original"
+          }
+        }
+      end
+    end
+  end
+end

data/app/models/headmin/filters.rb

@@ -0,0 +1,29 @@
+module Headmin
+  class Filters
+    # Example:
+    #
+    # @orders = Headmin::Filters.new(params, {
+    #   status: :text,
+    #   price: :number,
+    #   in_stock: :boolean
+    # }).query(Order)
+
+    def initialize(params, param_types)
+      @params = params
+      @param_types = param_types
+    end
+
+    def parse(attribute, type)
+      class_name = "Headmin::Filter::#{type.to_s.classify}".constantize
+      class_name.new(attribute, @params)
+    end
+
+    def query(collection)
+      @param_types.each do |attribute, type|
+        filter = parse(attribute, type)
+        collection = filter.query(collection)
+      end
+      collection
+    end
+  end
+end

data/app/models/headmin/form/blocks_view.rb

@@ -4,7 +4,7 @@ module Headmin
       def repeater_options
         keys = %i[form attribute names label]
         options = to_h.slice(*keys)
-        default_repeater_options.merge(options)
+        default_repeater_options.deep_merge(options)
       end
 
       def paths

data/app/models/headmin/form/checkbox_view.rb

@@ -17,7 +17,7 @@ module Headmin
       def input_options
         keys = attributes - %i[attribute form label validate wrapper checked_value unchecked_value]
         options = to_h.slice(*keys)
-        default_input_options.merge(options)
+        default_input_options.deep_merge(options)
       end
 
       def label_options
@@ -31,11 +31,11 @@ module Headmin
       end
 
       def wrapper_options
-        default_wrapper_options.merge(
+        default_wrapper_options.deep_merge(
           {
             class: %w[form-check mb-3]
           }
-        ).merge(@wrapper || {})
+        ).deep_merge(@wrapper || {})
       end
 
       private

data/app/models/headmin/form/date_range_view.rb

@@ -2,11 +2,11 @@ module Headmin
   module Form
     class DateRangeView < ViewModel
       def start_options
-        default_start_options.merge(@start || {})
+        default_start_options.deep_merge(@start || {})
       end
 
       def end_options
-        default_end_options.merge(@end || {})
+        default_end_options.deep_merge(@end || {})
       end
 
       private

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

@@ -12,19 +12,19 @@ module Headmin
       def input_options
         keys = attributes - %i[append attribute float form input_group input_group label prepend validate wrapper]
         options = to_h.slice(*keys)
-        default_input_options.merge(options)
+        default_input_options.deep_merge(options)
       end
 
       def input_group_options
         default_input_group_options
-          .merge(label_input_group_options)
-          .merge(@input_group || {})
+          .deep_merge(label_input_group_options)
+          .deep_merge(@input_group || {})
       end
 
       def wrapper_options
-        default_wrapper_options.merge({
+        default_wrapper_options.deep_merge({
           class: ["mb-3", ("form-floating" if float)]
-        }).merge(@wrapper || {})
+        }).deep_merge(@wrapper || {})
       end
 
       private