headmin 0.4.2 → 0.5.0

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/datetime_range_view.rb

@@ -0,0 +1,25 @@
+module Headmin
+  module Form
+    class DatetimeRangeView < ViewModel
+      def start_options
+        default_start_options.deep_merge(@start || {})
+      end
+
+      def end_options
+        default_end_options.deep_merge(@end || {})
+      end
+
+      private
+
+      def default_start_options
+        keys = attributes - %i[start]
+        to_h.slice(*keys)
+      end
+
+      def default_end_options
+        keys = attributes - %i[end]
+        to_h.slice(*keys)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,45 @@
+module Headmin
+  module Form
+    class DatetimeView < ViewModel
+      include Headmin::Form::Hintable
+      include Headmin::Form::InputGroupable
+      include Headmin::Form::Labelable
+      include Headmin::Form::Listable
+      include Headmin::Form::Placeholderable
+      include Headmin::Form::Validatable
+      include Headmin::Form::Wrappable
+
+      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.deep_merge(options)
+      end
+
+      def input_group_options
+        default_input_group_options
+          .deep_merge(label_input_group_options)
+          .deep_merge(@input_group || {})
+      end
+
+      def wrapper_options
+        default_wrapper_options.deep_merge({
+          class: ["mb-3", ("form-floating" if float)]
+        }).deep_merge(@wrapper || {})
+      end
+
+      private
+
+      def default_input_options
+        {
+          aria: {describedby: validation_id},
+          class: [form_control_class, validation_class],
+          placeholder: placeholder
+        }
+      end
+
+      def form_control_class
+        plaintext ? "form-control-plaintext" : "form-control"
+      end
+    end
+  end
+end

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

@@ -43,10 +43,7 @@ module Headmin
 
       def wrapper_options
         default_wrapper_options.deep_merge({
-          class: ["mb-3", ("form-floating" if float)],
-          data: {
-            controller: "flatpickr date-range"
-          }
+          class: ["mb-3", ("form-floating" if float)]
         }).deep_merge(@wrapper || {})
       end
 
@@ -59,19 +56,11 @@ module Headmin
       end
 
       def default_start_options
-        {
-          data: {
-            'date-range-target': "startDateInput"
-          }
-        }
+        {}
       end
 
       def default_end_options
-        {
-          data: {
-            'date-range-target': "endDateInput"
-          }
-        }
+        {}
       end
 
       def default_input_options
@@ -81,7 +70,7 @@ module Headmin
           placeholder: placeholder,
           name: nil,
           data: {
-            "flatpickr-target": "input",
+            controller: "flatpickr date-range",
             action: "change->date-range#update",
             flatpickr: {
               mode: "range",

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

@@ -2,7 +2,7 @@ module Headmin
   module Form
     class FlatpickrView < ViewModel
       def options
-        keys = attributes - %i[data wrapper]
+        keys = attributes - %i[data]
         options = to_h.slice(*keys)
         default_options.deep_merge(options)
       end
@@ -11,27 +11,18 @@ module Headmin
 
       def default_options
         {
-          data: default_data.deep_merge(data || {}),
-          wrapper: default_wrapper_options.deep_merge(wrapper || {})
+          data: default_data.deep_merge(data || {})
         }
       end
 
       def default_data
         {
-          "flatpickr-target": "input",
+          controller: "flatpickr",
           flatpickr: {
             defaultDate: form.object&.send(attribute)&.strftime("%d/%m/%Y")
           }
         }
       end
-
-      def default_wrapper_options
-        {
-          data: {
-            controller: "flatpickr"
-          }
-        }
-      end
     end
   end
 end

data/app/models/view_model.rb

@@ -33,7 +33,7 @@ class ViewModel
   end
 
   def to_hash
-    attributes.map { |attribute| {attribute => value_for(attribute)} }.inject(:merge)
+    attributes.map { |attribute| {attribute => value_for(attribute)} }.inject(:merge) || {}
   end
 
   alias_method :to_h, :to_hash

data/app/views/examples/admin.html.erb

@@ -11,26 +11,26 @@
 </head>
 
 <body>
-<%= render 'headmin/layout/main' do %>
-  <%= render 'headmin/layout/sidebar', logo: inline_svg_tag('logo.svg') do %>
-    <%= render 'headmin/layout/sidebar/menu' do %>
-      <%= render 'headmin/layout/sidebar/menu/item', name: t('.dashboard'), link: admin_root_path, icon: 'speedometer' %>
+<%= render "headmin/layout/main" do %>
+  <%= render "headmin/layout/sidebar", logo: inline_svg_tag('logo.svg') do %>
+    <%= render "headmin/layout/sidebar/menu" do %>
+      <%= render "headmin/layout/sidebar/menu/item", name: t('.dashboard'), link: admin_root_path, icon: 'speedometer' %>
       <div class="d-block d-md-none">
-        <%= render 'headmin/layout/sidebar/menu/locale' do end %>
-        <%= render 'headmin/layout/sidebar/menu/account' do end %>
+        <%= render "headmin/layout/sidebar/menu/locale" do end %>
+        <%= render "headmin/layout/sidebar/menu/account" do end %>
       </div>
     <% end %>
   <% end %>
-  <%= render 'headmin/layout/body' do %>
-    <%= render 'headmin/layout/header' do %>
-      <%= render 'headmin/layout/header/locale' do end %>
-      <%= render 'headmin/layout/header/account' do end %>
+  <%= render "headmin/layout/body" do %>
+    <%= render "headmin/layout/header" do %>
+      <%= render "headmin/layout/header/locale" do end %>
+      <%= render "headmin/layout/header/account" do end %>
     <% end %>
-    <%= render 'headmin/layout/content' do %>
-      <%= render 'headmin/notifications' %>
+    <%= render "headmin/layout/content" do %>
+      <%= render "headmin/notifications" %>
       <%= yield %>
     <% end %>
-    <%= render 'headmin/layout/footer', class: 'text-secondary' do %>
+    <%= render "headmin/layout/footer", class: 'text-secondary' do %>
       <%= bootstrap_icon('question-circle') %>
       <a class="text-secondary" href="mailto:info@insiting.com" title="<%= t('.help') %>">
         <%= t('.help') %>

data/app/views/examples/auth.html.erb

@@ -10,7 +10,7 @@
 </head>
 <body class="bg-light w-100 vh-100">
 
-<%= render 'headmin/notifications' %>
+<%= render "headmin/notifications" %>
 
 <main class="d-flex justify-content-center align-items-center w-100 vh-100 p-3">
   <%= yield %>

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

@@ -14,16 +14,16 @@
   #   <%= render "headmin/filters", url: admin_polls_path %#>
 
   action = local_assigns.has_key?(:url) ? url : request.path
-
-  # Perform yield in order to capture content blocks
-  yield
 %>
 
-<form action="<%= action %>" data-controller="filters" data-filters-target="form">
+<%= form_with url: action, method: :get, data: {controller: "filters", filters_target: "form"} do |form| %>
+
+  <%# Perform yield in order to capture content blocks, pass form so we can use headmin form inputs %>
+  <%= yield(form) %>
 
   <!-- Default parameters (e.g. sorting, pagination) -->
   <% default_params.except('page').each do |name, value| %>
-    <%= hidden_field_tag(name.to_sym, value) %>
+    <%= form.hidden_field name.to_sym, value: value %>
   <% end %>
 
   <div class="d-flex flex-column flex-md-row align-content-start align-items-md-start">
@@ -69,8 +69,8 @@
 
   <!-- Filter templates -->
   <%= yield :filters_templates %>
-</form>
 
+<% end %>
 
 <%
   # Clears content blocks to make this view reusable

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

@@ -19,12 +19,12 @@
   #
   # === Examples
   #   Basic version
-  #   <%= render 'headmin/form', model: @product do |form| %#>
+  #   <%= render "headmin/form", model: @product do |form| %#>
   #     Form content
   #   <% end %#>
   #
   #   Specify URL to post to
-  #   <%= render 'headmin/form', model: @product, url: admin_products_path do |form| %#>
+  #   <%= render "headmin/form", model: @product, url: admin_products_path do |form| %#>
   #     Form content
   #   <% end %#>
 

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

@@ -3,7 +3,7 @@
   #
   # === Examples
   #   Basic version
-  #   <%= render 'headmin/index' do %#>
+  #   <%= render "headmin/index" do %#>
   #     Index content
   #   <% end %#>
 %>

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

@@ -11,7 +11,7 @@
 
 <div class="d-flex flex-row-reverse flex-md-row align-items-center justify-content-between justify-content-md-end my-1">
   <% content_for :collection_total_count, collection.total_count.to_s unless content_for?(:collection_total_count) %>
-  <div class="ms-2 me-md-2 text-secondary">
+  <div class="ms-2 me-md-2 text-secondary flex-grow-1 flex-shrink-0">
     <%= t('.items', count: content_for(:collection_total_count).to_i) %>
   </div>
   <%= paginate collection, views_prefix: 'headmin/pagination' %>

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

@@ -8,7 +8,7 @@
   #   To trigger this popup create an element with a data attribute like this
   #
   #   <button data-popup-id="popupId">open Popup</button>
-  #   <%= render 'headmin/popup', id: 'popupId' do %#>
+  #   <%= render "headmin/popup", id: 'popupId' do %#>
   #     popup Content
   #   <% end %#>
   #
@@ -16,7 +16,7 @@
   #   "data-popup-pass-thru" attribute.
   #
   #   <button data-popup-id="popupId" data-popup-pass-thru="#link">open Popup</button>
-  #   <%= render 'headmin/popup', id: 'popupId' do %#>
+  #   <%= render "headmin/popup", id: 'popupId' do %#>
   #     <a href="https://example.com" id="link">
   #   <% end %#>
   data = local_assigns.has_key?(:data) ? data : {}

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

@@ -5,7 +5,7 @@
   # * +sort_url</tt> - Url to post object ids to in the order of positions
   #
   # ==== Examples
-  #   <%= render 'headmin/table', sort_url: positions_admin_categories_path do %#>
+  #   <%= render "headmin/table", sort_url: positions_admin_categories_path do %#>
   #     table content here
   #   <% end %#>