headmin 0.2.2 → 0.2.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5b4489879289d2643f3045d91f28b3530f3c21e5a888246ceb36029106ea0692
-  data.tar.gz: 0e161c13ca9f3fd26f96401eefea905cd3858d0c3b3dfe86cd8ce4bda718d8f8
+  metadata.gz: 1ff0537188eb3c41240a97c8660f5c1cdd891615495eef10b1b86c66857170c9
+  data.tar.gz: 7add1ca43dd66063a4f1283f6817bbedf0ff9a666a04143a283929f92830da2a
 SHA512:
-  metadata.gz: 78d063e6e740edba6d1a849e1bacbff2a8750300848c20134b3e15bc5217b216e53a15be5d923de6671aecf768ce98c41cffa31bbd8939abd42e6a12ee877c7f
-  data.tar.gz: c515db4260d09f9a402d8b46d7d8b36acc10a3dbad433248a19716c5b3b59459ee965dfc8a862d8a35137b58aa4b8af734a6ef73a094b425a9f6ee81140a7261
+  metadata.gz: cd060f8b895ff9bd71f26c91bd152d2b3ed7eac3a59a09cf6afaf9473764a363ab81134f6aac656b84d698a17601bbd84a9d4e26143c6e8562c3be65ab4597af
+  data.tar.gz: 6192291a6b45d1341ef1ba85b97280e55c59a31550a112202bb304d4945024c9f151dfdd394542933c7a8bb4baae616b5c45c93b3fb9179deb924116d2af84cc

data/.nvmrc

@@ -1 +1 @@
-lts/*
+lts/gallium

data/Gemfile.lock

@@ -1,8 +1,8 @@
 PATH
   remote: .
   specs:
-    headmin (0.2.1)
-      closure_tree (~> 7.3)
+    headmin (0.2.5)
+      closure_tree
 
 GEM
   remote: https://rubygems.org/
@@ -23,7 +23,7 @@ GEM
       activerecord (>= 4.2.10)
       with_advisory_lock (>= 4.0.0)
     concurrent-ruby (1.1.9)
-    i18n (1.8.10)
+    i18n (1.8.11)
       concurrent-ruby (~> 1.0)
     minitest (5.14.4)
     parallel (1.20.1)

data/README.md

@@ -1,10 +1,8 @@
 # Headmin
 A complete library of commonly used components to build an admin interface in your Ruby on Rails project.
 
-## Interesting links
-- [Full documentation](docs/README.md)
-- [Rubygems](https://rubygems.org/gems/headmin)
-- [NPM](https://www.npmjs.com/package/headmin)
+[![Gem Version](https://badge.fury.io/rb/headmin.svg)](https://rubygems.org/gems/headmin)
+[![npm version](https://badge.fury.io/js/headmin.svg)](https://www.npmjs.com/package/headmin)
 
 ## Installation
 
@@ -47,6 +45,12 @@ Finally import Headmin in your stylesheet.
 @import '~headmin/src/scss/headmin.scss';
 ```
 
+### Integrations
+- [Blocks](docs/blocks.md)
+- [Fields](docs/fields.md)
+- [Blocks + Fields = Magic](docs/blocks-and-fields.md)
+- [Devise](docs/devise.md)
+
 ## Development
 For development purposes it's helpful to have both the test project and Headmin located in the same directory.
 
@@ -59,7 +63,7 @@ In package.json
 ```json
 {
   "dependencies": {
-    "bar": "link:../headmin"
+    "bar": "file:../headmin"
   }
 }
 ```
@@ -94,8 +98,14 @@ $ yarn build
 Update the version number of the gem
 
 ```shell
-$ gem bump -v {patch,minor,major,...} -p
-$ gem tag -p
+# First bundle if new runtime dependencies were added
+$ bundle
+$ git push
+
+# Update the version number and tag the release
+$ gem bump -v {patch,minor,major,...} --push --tag
+
+# Release to Rubygems
 $ gem release
 ```
 

data/app/helpers/headmin/admin_helper.rb

@@ -1,65 +1,9 @@
 module Headmin
   module AdminHelper
+    include Headmin::BootstrapHelper
     include Headmin::FilterHelper
+    include Headmin::FormHelper
     include Headmin::NotificationHelper
-
-    def current_model
-      controller_name.classify.constantize
-    end
-
-    def bootstrap_icon(icon, options = {})
-      data = options.has_key?(:data) ? options[:data] : nil
-      klass = options.has_key?(:class) ? options[:class] : nil
-      content_tag(:i, class: "bi bi-#{icon} #{klass}", data: data) {}
-    end
-
-    def current_url?(url)
-      uri = URI(url)
-      path = uri.path
-      query_string = uri.query
-      matches_path = request.path.include?(path)
-      matches_query = uri.query ? request.query_string.include?(query_string) : true
-      is_root = request.fullpath == url
-      if url == admin_root_path
-        is_root
-      else
-        matches_path && matches_query
-      end
-    end
-
-    def form_field_valid?(form, name)
-      !form.object.errors.has_key?(name)
-    end
-
-    def form_field_validation_id(form, name)
-      [form.object_name, name.to_s, 'validation'].join('_').parameterize.underscore
-    end
-
-    def form_field_validation_class(form, name)
-      return nil if request.get?
-      form.object.errors.has_key?(name) ? 'is-invalid' : 'is-valid'
-    end
-
-    def default_params
-      params.select { |key, value| is_default_param?(key) }
-    end
-
-    def add_default_param_key(key)
-      keys = default_param_keys || []
-      keys.push(key)
-      @default_param_keys = keys
-    end
-
-    def default_param_keys
-      @default_param_keys ||= [:page, :start, :length, :per_page]
-    end
-
-    def is_default_param?(key)
-      default_param_keys.include?(key.to_sym) || is_sort_param_key?(key)
-    end
-
-    def is_sort_param_key?(key)
-      key.to_s.include?('sort_')
-    end
+    include Headmin::RequestHelper
   end
 end

data/app/helpers/headmin/bootstrap_helper.rb

@@ -0,0 +1,9 @@
+module Headmin
+  module BootstrapHelper
+    def bootstrap_icon(icon, options = {})
+      data = options.has_key?(:data) ? options[:data] : nil
+      klass = options.has_key?(:class) ? options[:class] : nil
+      content_tag(:i, class: "bi bi-#{icon} #{klass}", data: data) {}
+    end
+  end
+end

data/app/helpers/headmin/filter_helper.rb

@@ -1,11 +1,15 @@
 module Headmin
   module FilterHelper
     def filter_param_exists?(name)
-      return false unless params.has_key?(name)
+      filter_param(name).present?
+    end
+
+    def filter_param(name)
+      return nil unless params.has_key?(name)
       if params[name].is_a?(Array)
-        params[name].reject { |c| c.empty? }.present?
+        params[name].reject { |c| c.empty? }
       else
-        params[name].present?
+        params[name]
       end
     end
   end

data/app/helpers/headmin/form_helper.rb

@@ -0,0 +1,36 @@
+module Headmin
+  module FormHelper
+    def form_field_valid?(form, name)
+      !form.object.errors.has_key?(name)
+    end
+
+    def form_field_validation_id(form, name)
+      [form.object_name, name.to_s, 'validation'].join('_').parameterize.underscore
+    end
+
+    def form_field_validation_class(form, name)
+      return nil if request.get?
+      form.object.errors.has_key?(name) ? 'is-invalid' : 'is-valid'
+    end
+
+    # Outputs currently present query parameters as hidden fields for a given form
+    #
+    # https://example.com/products?amount=1&type[]=food&type[]=beverage
+    #
+    # <%= form.hidden_input :amount, value: 1 %>
+    # <%= form.hidden_input :'type[]', value: 'food' %>
+    # <%= form.hidden_input :'type[]', value: 'beverage' %>
+    def query_parameter_fields(form)
+      test = request.query_parameters.map do |name, value|
+        if value.is_a?(Array)
+          value.map do |value_element|
+            form.hidden_field "#{name}[]", value: value_element
+          end.join
+        else
+          form.hidden_field name, value: value
+        end
+      end
+      test.join.html_safe
+    end
+  end
+end

data/app/helpers/headmin/request_helper.rb

@@ -0,0 +1,39 @@
+module Headmin
+  module RequestHelper
+    def current_url?(url)
+      uri = URI(url)
+      path = uri.path
+      query_string = uri.query
+      matches_path = request.path.include?(path)
+      matches_query = uri.query ? request.query_string.include?(query_string) : true
+      is_root = request.fullpath == url
+      if url == admin_root_path
+        is_root
+      else
+        matches_path && matches_query
+      end
+    end
+
+    def default_params
+      params.select { |key, value| is_default_param?(key) }
+    end
+
+    def add_default_param_key(key)
+      keys = default_param_keys || []
+      keys.push(key)
+      @default_param_keys = keys
+    end
+
+    def default_param_keys
+      @default_param_keys ||= [:page, :start, :length, :per_page]
+    end
+
+    def is_default_param?(key)
+      default_param_keys.include?(key.to_sym) || is_sort_param_key?(key)
+    end
+
+    def is_sort_param_key?(key)
+      key.to_s.include?('sort_')
+    end
+  end
+end

data/app/models/concerns/headmin/fieldable.rb

@@ -7,37 +7,67 @@ module Headmin
       accepts_nested_attributes_for :fields, allow_destroy: true
 
       def fields_hash
-        save_pair(fields.hash_tree)
+        fields.order(position: :asc).map do |field|
+          parse_hash_tree(field.hash_tree)
+        end.reduce({}, :merge)
+      end
+
+      def fields_hash=(hash)
+        parse_fields_hash(hash)
       end
 
       private
 
-      def save_pair(my_hash, array = false)
-        if array
-          my_hash.map { |key, value|
-            save_pair(value)
-          }
-        else
-          Hash[my_hash.map { |key, value|
-            if value.empty?
-              case key.field_type
-              when 'group'
-                [key.name, save_pair(key.hash_tree[key])]
-              when 'list'
-                [key.name, save_pair(key.hash_tree[key], true)]
-              else
-                [key.name, return_field_output(key)]
+      def parse_fields_hash(hash)
+        hash.map do |key, value|
+          case value
+          when Hash
+            fields.build(
+              name: key,
+              field_type: 'group',
+              fields: parse_fields_hash(value)
+            )
+          when Array
+            fields.build(
+              name: key,
+              field_type: 'list',
+              fields: value.map do |item|
+                fields.new(name: 'item', field_type: 'group', fields: parse_fields_hash(item))
               end
-            else
-              key.field_type == 'list' ? [key.name, save_pair(value, true)] : [key.name, save_pair(value)]
-            end
-          }]
+            )
+          when String
+            fields.build(
+              name: key,
+              field_type: 'text',
+              value: value
+            )
+          else
+            fields.build(
+              name: key,
+              field_type: 'file',
+              file: value
+            )
+          end
         end
       end
 
-      # returns what a field_type should return, e.g. its value, the file, the object ...
-      def return_field_output(key)
-        key.field_type == 'image' ? key.file : key.value
+      def parse_hash_tree(hash_tree)
+        Hash[hash_tree.map do |field, children|
+          case field.field_type.to_sym
+          when :group
+            children = children.any? ? children : field.hash_tree
+            [field.name, parse_hash_tree(children)]
+          when :list
+            children = children.any? ? children : field.hash_tree
+            [field.name, children.map { |child, grand_children| parse_hash_tree(grand_children) }]
+          when :image
+            [field.name, field.file]
+          when :file
+            [field.name, field.file]
+          else
+            [field.name, field.value]
+          end
+        end]
       end
     end
   end

data/app/services/block_service.rb

@@ -1,10 +1,7 @@
 class BlockService
   def self.block_names(path:)
     form_views(path: path).map do |view|
-      filename = File.basename(view, '.html.erb')
-
-      # Removes leading _ if exists
-      filename.sub!(/^_/, '')
+      view_name(view)
     end
   end
 
@@ -24,6 +21,13 @@ class BlockService
     views(form_view_paths(path))
   end
 
+  def self.view_name(view)
+    filename = File.basename(view, '.html.erb')
+
+    # Removes leading _ if exists
+    filename.sub(/^_/, '')
+  end
+
   private
 
   # Looks for a block view by its name.

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

@@ -18,7 +18,7 @@
 
 <% if blockable && blockable.respond_to?(:blocks) %>
   <% blockable.blocks.order(:position).each do |block| %>
-    <% view_path = BlockService.frontend_view(block.name, path: path).gsub('/_', '/') %>
+    <% view_path = BlockService.frontend_view(block.name, path: path).gsub('/_', '/').split('.').first %>
     <%= render view_path, block: block %>
   <% end %>
 <% end %>

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

@@ -11,7 +11,7 @@
   #   With custom URL
   #   <%= render "headmin/filters", url: admin_polls_path %#>
 
-  action = local_assigns.has_key?(:url) ? url : request.url
+  action = local_assigns.has_key?(:url) ? url : request.path
 %>
 
 <form action="<%= action %>" data-controller="filters" data-filters-target="form">

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

@@ -10,8 +10,11 @@
 %>
 
 <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 do %>
+    <%= collection.total_count %>
+  <% end %>
   <div class="ms-2 me-md-2 text-secondary">
-    <%= t('.items', count: collection.total_count) %>
+    <%= t('.items', count: content_for(:collection_total_count)) %>
   </div>
   <%= paginate collection, views_prefix: 'headmin/pagination' %>
 </div>

data/app/views/headmin/dropdown/_devise.html.erb

@@ -1,19 +1,29 @@
-<%#
-    headmin/dropdown/locale
-    accepts block: yes
-    parameters:
-      scope: (symbol) devise scope, i.e. ':users' => current_user
+<%
+  # headmin/dropdown/devise
+  #
+  # ==== Options
+  # * <tt>scope</tt> - (symbol) devise scope, i.e. ':users' => current_user
+  # * <tt>class</tt> - Custom class names to put on the dropdown
+  #
+  # ==== Examples
+  #   Basic version
+  #   <%= render "headmin/dropdown/devise"  %#>
+  #
+  #   Custom scope
+  #   <%= render "headmin/dropdown/devise", scope: :admins  %#>
+
+  class_names = local_assigns.has_key?(:class) ? local_assigns[:class] : ''
+  scope = local_assigns.has_key?(:scope) ? scope : :users
+  singular = scope.to_s.singularize.to_sym
+  user = send("current_#{singular}")
 %>
 
-<% scope = local_assigns.has_key?(:scope) ? scope : :users %>
-<% singular = scope.to_s.singularize.to_sym %>
-<% user = send("current_#{singular}") %>
 
-<%= render 'headmin/dropdown' do %>
+<%= render 'headmin/dropdown', class: class_names do %>
   <%= render 'headmin/dropdown/button' do %>
     <%= user.to_s %>
   <% end %>
-  <%= render 'headmin/dropdown/list' do %>
+  <%= render 'headmin/dropdown/list', class: 'dropdown-menu-end' do %>
     <%= render 'headmin/dropdown/item', name: t('.edit_profile'), url: polymorphic_path([:edit, singular, :registration]) %>
     <%= render 'headmin/dropdown/divider' %>
     <%= render 'headmin/dropdown/item', name: t('.log_out'), url: polymorphic_path([:destroy, singular, :session]), method: :delete %>

data/app/views/headmin/dropdown/_list.html.erb

@@ -1,11 +1,21 @@
-<%#
-    headmin/dropdown/list
-    accepts block: yes
-    parameters:
-      id: unique identifier for the dropdown
+<%
+  # headmin/dropdown/list
+  #
+  # ==== Options
+  # * <tt>id</tt> - unique identifier for the dropdown
+  # * <tt>class</tt> - Custom class names to put on the dropdown menu
+  #
+  # ==== Examples
+  #   Basic version
+  #   <%= render "headmin/dropdown/devise"  %#>
+  #
+  #   Custom scope
+  #   <%= render "headmin/dropdown/devise", scope: :admins  %#>
+
+  class_names = local_assigns.has_key?(:class) ? local_assigns[:class] : ''
+  id = local_assigns.has_key?(:id) ? id : 'dropdown-1'
 %>
-<% id = local_assigns.has_key?(:id) ? id : 'dropdown-1' %>
 
-<ul class="dropdown-menu" aria-labelledby="<%= id %>">
+<ul class="dropdown-menu <%= class_names %>" aria-labelledby="<%= id %>">
   <%= yield %>
 </ul>

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

@@ -36,8 +36,9 @@
 
 <%= content_for :filters_buttons do %>
   <% (params[name] || []).each_with_index do |param, index| %>
-    <% value = options.detect { |value, key, config| key == param } %>
-    <%= render 'headmin/filters/filter/button', name: name, label: label, value: value ? value.first : nil, id: "#{name}_#{index}" do %>
+    <% selected_option = options.detect { |value, key, config| (key.present? ? key : value) == param } %>
+    <% selected_value = selected_option.is_a?(Array) ? selected_option.first : selected_option %>
+    <%= render 'headmin/filters/filter/button', name: name, label: label, value: selected_value, id: "#{name}_#{index}" do %>
       <%= select_tag("#{name}[]", options_for_select(options, param), select_options) %>
     <% end %>
   <% end %>

data/app/views/headmin/filters/filter/_button.html.erb

@@ -12,7 +12,6 @@
 <% value = local_assigns.has_key?(:value) ? value : nil %>
 
 <div class="h-filter me-1 my-1" data-filter-name="<%= name %>">
-
   <button
     type="button"
     class="h-filter-button btn h-btn-outline-transparent"

data/app/views/headmin/forms/_blocks.html.erb

@@ -22,11 +22,18 @@
   templates = allowed_block_names.map { |name| BlockService.form_view(name, path: path) }
 %>
 
-<%= render 'headmin/forms/repeater', form: form, attribute: :blocks, templates: templates, label: false do |block| %>
-  <% view_path = BlockService.form_view(block.object.name, path: path).gsub('/_', '/') %>
-  <%= render view_path, form: block, name: block.object.name %>
+<%= render 'headmin/forms/repeater', form: form, attribute: :blocks, templates: templates, label: false do |block_form, template| %>
+  <% name = template ? BlockService.view_name(template) : block_form.object.name %>
 
+  <!-- Name input of the block -->
+  <%= block_form.hidden_field :name, value: name %>
+
+  <!-- Render block form fields -->
+  <% view_path = BlockService.form_view(name, path: path).gsub('/_', '/') %>
+  <%= render view_path, form: block_form %>
+
+  <!-- Label -->
   <span class="position-absolute top-0 end-0 badge bg-light text-dark">
-    <%= block.object.name.titleize %>
+    <%= name.titleize %>
   </span>
 <% end %>

data/app/views/headmin/forms/_date.html.erb

@@ -27,7 +27,7 @@
   required = local_assigns.has_key?(:required) ? required : false
   datepicker = local_assigns.has_key?(:datepicker) ? local_assigns[:datepicker] : false
 
-  class_names = "#{class_names} flatpicker" if datepicker
+  class_names = "#{class_names} flatpickr" if datepicker
 
   options = {
     'aria-describedby': form_field_validation_id(form, attribute),

data/app/views/headmin/forms/_label.html.erb

@@ -12,7 +12,7 @@
   #   <%= render 'headmin/forms/label', form: form, attribute: :image %#>
 
   class_names = local_assigns.has_key?(:class) ? local_assigns[:class] : false
-  name = local_assigns.has_key?(:name) && name ? name.to_s.humanize : attribute
+  custom_name = local_assigns.has_key?(:name) && name ? name.to_s.humanize : nil
   required = local_assigns.has_key?(:required) ? required : false
 
   options = {
@@ -21,4 +21,4 @@
   }
 %>
 
-<%= form.label name, options %>
+<%= form.label attribute, custom_name, options %>

data/app/views/headmin/forms/_repeater.html.erb

@@ -39,14 +39,14 @@
 
   template_names = templates.map { |template| File.basename(template, '.html.erb') }
   template_names = template_names.any? ? template_names : ['new']
-  multiple_templates = template_names.count > 1
   object_model = form.object.class
   association_model = object_model.reflect_on_association(attribute).class_name.constantize
-  with_positions = association_model.new.attributes.keys.include?('position')
+  association_object = association_model.new
+  with_positions = association_object.attributes.keys.include?('position')
   associations = form.object.send(attribute)
   associations = with_positions ? associations.order(:position) : associations
   repeater_id = form.object_id
-  pass_thru = multiple_templates ? nil : '[data-template-name="new"]'
+  pass_thru = template_names.count == 1 ? "[data-template-name=\"#{template_names.first}\"]" : nil
   show_label = label != false
 %>
 
@@ -115,15 +115,11 @@
 
     <!-- Templates -->
     <% template_names.each do |name| %>
-      <template data-repeater-target="template" data-template-name="<%= name %>">
-        <%= form.fields_for attribute, association_model.new, child_index: 'template_id' do |ff| %>
+      <template data-repeater-target="template" data-template-name="<%= name %>" data-template-id-regex="<%= association_object.object_id %>">
+        <%= form.fields_for attribute, association_object, child_index: association_object.object_id do |ff| %>
           <%= render 'headmin/forms/repeater/row', form: ff, pass_thru: pass_thru, repeater_id: repeater_id do %>
             <% template = templates.detect { |t| t.include?("/#{name}.") } %>
-            <% if template %>
-              <%= render(template.gsub('/_', '/'), form: ff) %>
-            <% else %>
-              <% yield(ff) %>
-            <% end %>
+            <% yield(ff, template&.gsub('/_', '/')) %>
           <% end %>
         <% end %>
       </template>