headmin 0.2.0 → 0.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 93f5cab4fe5c5f5d8a93268a168390a6857bd3b47521e1344d26b6f75342f20c
-  data.tar.gz: cedf8e3baaac368cefac19657aadd879c48fcb7035850c0b867cd60a2487a281
+  metadata.gz: ade465655c1e8e80dd864856e0f0cb26ab1f731bfd518b3ad976bbb317420aa1
+  data.tar.gz: 2dc85e50e4840a186b996ec165f296dd8b234292172f58e1be74cf378adf7f3f
 SHA512:
-  metadata.gz: 4d03d8950dd996f4aea3c6047ed6fdc9ec8fd3d4160043b70d80e0a50f78aee1cec18ef3b1bcbc3cbb80dee0d1756bb9b4e2c84ddc43172d6d4ea4c1eb743162
-  data.tar.gz: 4d7eb98ffae8e16f4094c0862705a66f471e953736c3fa3728549208d05d384a97b84ebbc650d4463b3df5b01e80f91b6cff161bbb7e6da59808de282765c2e5
+  metadata.gz: bfa03386ea283e4d45180d69d04c226459ce494ed6a004215d1b4ba028dd5e1eb4c87e6027016743deab25baa103a239ed2933b0786dbdb0af727a1d16e90de2
+  data.tar.gz: a86486191d491de2585fe647644812f6c2e813473821d89bea6be44c0a7d71b42cdc0293d2117094946ba5bbd4415dea85e7cd5dc3c7249a72d68b2e8a15a9bd

data/.nvmrc

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

data/Gemfile

@@ -8,5 +8,4 @@ gemspec
 gem "rake", "~> 13.0"
 
 gem "minitest", "~> 5.0"
-gem 'closure_tree', "~> 7.3"
 gem "rubocop", "~> 1.7"

data/Gemfile.lock

@@ -1,24 +1,25 @@
 PATH
   remote: .
   specs:
-    headmin (0.2.0)
+    headmin (0.2.3)
+      closure_tree
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activemodel (6.1.4)
-      activesupport (= 6.1.4)
-    activerecord (6.1.4)
-      activemodel (= 6.1.4)
-      activesupport (= 6.1.4)
-    activesupport (6.1.4)
+    activemodel (6.1.4.1)
+      activesupport (= 6.1.4.1)
+    activerecord (6.1.4.1)
+      activemodel (= 6.1.4.1)
+      activesupport (= 6.1.4.1)
+    activesupport (6.1.4.1)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
       tzinfo (~> 2.0)
       zeitwerk (~> 2.3)
     ast (2.4.2)
-    closure_tree (7.3.0)
+    closure_tree (7.4.0)
       activerecord (>= 4.2.10)
       with_advisory_lock (>= 4.0.0)
     concurrent-ruby (1.1.9)
@@ -49,13 +50,12 @@ GEM
     unicode-display_width (2.0.0)
     with_advisory_lock (4.6.0)
       activerecord (>= 4.2)
-    zeitwerk (2.4.2)
+    zeitwerk (2.5.1)
 
 PLATFORMS
   x86_64-darwin-19
 
 DEPENDENCIES
-  closure_tree (~> 7.3)
   headmin!
   minitest (~> 5.0)
   rake (~> 13.0)

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,21 +98,21 @@ $ 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
 ```
 
-Use the generated version number for the node module as well
+Update the node module
 ```
-// In package.json
-
-{
-  "name": "headmin",
-  "version": "{new version number here}",
-  ...
-}
-
+# Manually update the version number in package.json
+$ npm publish
 ```
 
 ## Deployment

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

@@ -7,37 +7,65 @@ module Headmin
       accepts_nested_attributes_for :fields, allow_destroy: true
 
       def fields_hash
-        save_pair(fields.hash_tree)
+        parse_hash_tree(fields.hash_tree)
+      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/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/_repeater.html.erb

@@ -39,14 +39,13 @@
 
   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')
   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
 %>
 

data/dist/js/headmin.js

@@ -1505,7 +1505,7 @@ eval("__webpack_require__.r(__webpack_exports__);\n/* harmony export (binding) *
 /***/ (function(module, __webpack_exports__, __webpack_require__) {
 
 "use strict";
-eval("__webpack_require__.r(__webpack_exports__);\n/* harmony export (binding) */ __webpack_require__.d(__webpack_exports__, \"default\", function() { return _default; });\n/* harmony import */ var stimulus__WEBPACK_IMPORTED_MODULE_0__ = __webpack_require__(/*! stimulus */ \"./node_modules/stimulus/index.js\");\n/* harmony import */ var sortablejs__WEBPACK_IMPORTED_MODULE_1__ = __webpack_require__(/*! sortablejs */ \"./node_modules/sortablejs/modular/sortable.esm.js\");\nfunction _typeof(obj) { \"@babel/helpers - typeof\"; if (typeof Symbol === \"function\" && typeof Symbol.iterator === \"symbol\") { _typeof = function _typeof(obj) { return typeof obj; }; } else { _typeof = function _typeof(obj) { return obj && typeof Symbol === \"function\" && obj.constructor === Symbol && obj !== Symbol.prototype ? \"symbol\" : typeof obj; }; } return _typeof(obj); }\n\nfunction _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError(\"Cannot call a class as a function\"); } }\n\nfunction _defineProperties(target, props) { for (var i = 0; i < props.length; i++) { var descriptor = props[i]; descriptor.enumerable = descriptor.enumerable || false; descriptor.configurable = true; if (\"value\" in descriptor) descriptor.writable = true; Object.defineProperty(target, descriptor.key, descriptor); } }\n\nfunction _createClass(Constructor, protoProps, staticProps) { if (protoProps) _defineProperties(Constructor.prototype, protoProps); if (staticProps) _defineProperties(Constructor, staticProps); return Constructor; }\n\nfunction _inherits(subClass, superClass) { if (typeof superClass !== \"function\" && superClass !== null) { throw new TypeError(\"Super expression must either be null or a function\"); } subClass.prototype = Object.create(superClass && superClass.prototype, { constructor: { value: subClass, writable: true, configurable: true } }); if (superClass) _setPrototypeOf(subClass, superClass); }\n\nfunction _setPrototypeOf(o, p) { _setPrototypeOf = Object.setPrototypeOf || function _setPrototypeOf(o, p) { o.__proto__ = p; return o; }; return _setPrototypeOf(o, p); }\n\nfunction _createSuper(Derived) { var hasNativeReflectConstruct = _isNativeReflectConstruct(); return function _createSuperInternal() { var Super = _getPrototypeOf(Derived), result; if (hasNativeReflectConstruct) { var NewTarget = _getPrototypeOf(this).constructor; result = Reflect.construct(Super, arguments, NewTarget); } else { result = Super.apply(this, arguments); } return _possibleConstructorReturn(this, result); }; }\n\nfunction _possibleConstructorReturn(self, call) { if (call && (_typeof(call) === \"object\" || typeof call === \"function\")) { return call; } return _assertThisInitialized(self); }\n\nfunction _assertThisInitialized(self) { if (self === void 0) { throw new ReferenceError(\"this hasn't been initialised - super() hasn't been called\"); } return self; }\n\nfunction _isNativeReflectConstruct() { if (typeof Reflect === \"undefined\" || !Reflect.construct) return false; if (Reflect.construct.sham) return false; if (typeof Proxy === \"function\") return true; try { Boolean.prototype.valueOf.call(Reflect.construct(Boolean, [], function () {})); return true; } catch (e) { return false; } }\n\nfunction _getPrototypeOf(o) { _getPrototypeOf = Object.setPrototypeOf ? Object.getPrototypeOf : function _getPrototypeOf(o) { return o.__proto__ || Object.getPrototypeOf(o); }; return _getPrototypeOf(o); }\n\n\n\n\nvar _default = /*#__PURE__*/function (_Controller) {\n  _inherits(_default, _Controller);\n\n  var _super = _createSuper(_default);\n\n  function _default() {\n    _classCallCheck(this, _default);\n\n    return _super.apply(this, arguments);\n  }\n\n  _createClass(_default, [{\n    key: \"connect\",\n    value: function connect() {\n      var _this = this;\n\n      new sortablejs__WEBPACK_IMPORTED_MODULE_1__[\"default\"](this.listTarget, {\n        animation: 150,\n        ghostClass: 'list-group-item-dark',\n        draggable: '.repeater-row',\n        handle: '.repeater-row-handle',\n        onEnd: function onEnd() {\n          _this.resetIndices();\n\n          _this.resetPositions();\n        }\n      });\n      this.toggleEmpty();\n    }\n  }, {\n    key: \"resetButtonIndices\",\n    value: function resetButtonIndices(event) {\n      var row = event.target.closest('.repeater-row');\n      var index = this.containsRow(row) ? row.dataset.rowIndex : '';\n      this.updatePopupButtonIndices(index);\n    }\n  }, {\n    key: \"containsRow\",\n    value: function containsRow(row) {\n      return this.rowTargets.includes(row);\n    }\n  }, {\n    key: \"updatePopupButtonIndices\",\n    value: function updatePopupButtonIndices(index) {\n      console.log(index);\n      var popup = document.querySelector(\"[data-popup-target=\\\"popup\\\"][data-popup-id=\\\"repeater-buttons-\".concat(this.idValue, \"\\\"]\"));\n      var buttons = popup.querySelectorAll('a');\n      buttons.forEach(function (button) {\n        button.dataset.rowIndex = index;\n      });\n    }\n  }, {\n    key: \"addRow\",\n    value: function addRow(event) {\n      event.preventDefault();\n      var button = event.target;\n      var templateName = button.dataset.templateName;\n      var rowIndex = button.dataset.rowIndex; // Prepare html from template\n\n      var html = this.getTemplateHTML(templateName);\n      html = this.replaceIdsWithTimestamps(html); // Fallback to last row if no index is set\n\n      if (rowIndex) {\n        // Insert new row after defined row\n        var row = this.rowTargets[rowIndex];\n        row.insertAdjacentHTML('afterend', html);\n      } else {\n        // Insert before footer\n        this.footerTarget.insertAdjacentHTML('beforebegin', html);\n      } // Dispatch an event\n\n\n      document.dispatchEvent(new CustomEvent('headmin:reinit', {\n        bubbles: true\n      }));\n      this.resetIndices();\n      this.resetPositions();\n      this.toggleEmpty();\n    }\n  }, {\n    key: \"removeRow\",\n    value: function removeRow(event) {\n      event.preventDefault();\n      var row = event.target.closest(\".repeater-row\");\n\n      if (row.dataset.newRecord === \"true\") {\n        // New records are simply removed from the page\n        row.remove();\n      } else {\n        // Existing records are hidden and flagged for deletion\n        row.querySelector(\"input[name*='_destroy']\").value = 1;\n        row.style.display = 'none';\n      }\n\n      this.resetIndices();\n      this.resetPositions();\n      this.toggleEmpty();\n    }\n  }, {\n    key: \"getTemplateHTML\",\n    value: function getTemplateHTML(name) {\n      var template = this.templateTargets.filter(function (template) {\n        return template.dataset.templateName === name;\n      })[0];\n      return template.innerHTML;\n    }\n  }, {\n    key: \"replaceIdsWithTimestamps\",\n    value: function replaceIdsWithTimestamps(html) {\n      var regex = new RegExp('template_id', \"g\");\n      return html.replace(regex, new Date().getTime());\n    }\n  }, {\n    key: \"visibleRowsCount\",\n    value: function visibleRowsCount() {\n      return this.visibleRows().length;\n    }\n  }, {\n    key: \"visibleRows\",\n    value: function visibleRows() {\n      var rows = this.rowTargets;\n      return rows.filter(function (row) {\n        return row.querySelector(\"input[name*='_destroy']\").value !== '1';\n      });\n    }\n  }, {\n    key: \"toggleEmpty\",\n    value: function toggleEmpty() {\n      if (this.visibleRowsCount() > 0) {\n        this.emptyTarget.classList.add('invisible');\n      } else {\n        this.emptyTarget.classList.remove('invisible');\n      }\n    }\n  }, {\n    key: \"resetPositions\",\n    value: function resetPositions() {\n      this.visibleRows().forEach(function (row, index) {\n        var positionInput = row.querySelector(\"input[name*='position']\");\n\n        if (positionInput) {\n          positionInput.value = index;\n        }\n      });\n    }\n  }, {\n    key: \"resetIndices\",\n    value: function resetIndices() {\n      this.visibleRows().forEach(function (row, index) {\n        row.dataset.rowIndex = index;\n      });\n    }\n  }], [{\n    key: \"values\",\n    get: function get() {\n      return {\n        id: String\n      };\n    }\n  }, {\n    key: \"targets\",\n    get: function get() {\n      return [\"repeater\", \"footer\", \"template\", \"row\", \"list\", \"empty\", \"addButton\"];\n    }\n  }]);\n\n  return _default;\n}(stimulus__WEBPACK_IMPORTED_MODULE_0__[\"Controller\"]);\n\n\n\n//# sourceURL=webpack:///./src/js/headmin/controllers/repeater_controller.js?");
+eval("__webpack_require__.r(__webpack_exports__);\n/* harmony export (binding) */ __webpack_require__.d(__webpack_exports__, \"default\", function() { return _default; });\n/* harmony import */ var stimulus__WEBPACK_IMPORTED_MODULE_0__ = __webpack_require__(/*! stimulus */ \"./node_modules/stimulus/index.js\");\n/* harmony import */ var sortablejs__WEBPACK_IMPORTED_MODULE_1__ = __webpack_require__(/*! sortablejs */ \"./node_modules/sortablejs/modular/sortable.esm.js\");\nfunction _typeof(obj) { \"@babel/helpers - typeof\"; if (typeof Symbol === \"function\" && typeof Symbol.iterator === \"symbol\") { _typeof = function _typeof(obj) { return typeof obj; }; } else { _typeof = function _typeof(obj) { return obj && typeof Symbol === \"function\" && obj.constructor === Symbol && obj !== Symbol.prototype ? \"symbol\" : typeof obj; }; } return _typeof(obj); }\n\nfunction _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError(\"Cannot call a class as a function\"); } }\n\nfunction _defineProperties(target, props) { for (var i = 0; i < props.length; i++) { var descriptor = props[i]; descriptor.enumerable = descriptor.enumerable || false; descriptor.configurable = true; if (\"value\" in descriptor) descriptor.writable = true; Object.defineProperty(target, descriptor.key, descriptor); } }\n\nfunction _createClass(Constructor, protoProps, staticProps) { if (protoProps) _defineProperties(Constructor.prototype, protoProps); if (staticProps) _defineProperties(Constructor, staticProps); return Constructor; }\n\nfunction _inherits(subClass, superClass) { if (typeof superClass !== \"function\" && superClass !== null) { throw new TypeError(\"Super expression must either be null or a function\"); } subClass.prototype = Object.create(superClass && superClass.prototype, { constructor: { value: subClass, writable: true, configurable: true } }); if (superClass) _setPrototypeOf(subClass, superClass); }\n\nfunction _setPrototypeOf(o, p) { _setPrototypeOf = Object.setPrototypeOf || function _setPrototypeOf(o, p) { o.__proto__ = p; return o; }; return _setPrototypeOf(o, p); }\n\nfunction _createSuper(Derived) { var hasNativeReflectConstruct = _isNativeReflectConstruct(); return function _createSuperInternal() { var Super = _getPrototypeOf(Derived), result; if (hasNativeReflectConstruct) { var NewTarget = _getPrototypeOf(this).constructor; result = Reflect.construct(Super, arguments, NewTarget); } else { result = Super.apply(this, arguments); } return _possibleConstructorReturn(this, result); }; }\n\nfunction _possibleConstructorReturn(self, call) { if (call && (_typeof(call) === \"object\" || typeof call === \"function\")) { return call; } return _assertThisInitialized(self); }\n\nfunction _assertThisInitialized(self) { if (self === void 0) { throw new ReferenceError(\"this hasn't been initialised - super() hasn't been called\"); } return self; }\n\nfunction _isNativeReflectConstruct() { if (typeof Reflect === \"undefined\" || !Reflect.construct) return false; if (Reflect.construct.sham) return false; if (typeof Proxy === \"function\") return true; try { Boolean.prototype.valueOf.call(Reflect.construct(Boolean, [], function () {})); return true; } catch (e) { return false; } }\n\nfunction _getPrototypeOf(o) { _getPrototypeOf = Object.setPrototypeOf ? Object.getPrototypeOf : function _getPrototypeOf(o) { return o.__proto__ || Object.getPrototypeOf(o); }; return _getPrototypeOf(o); }\n\n\n\n\nvar _default = /*#__PURE__*/function (_Controller) {\n  _inherits(_default, _Controller);\n\n  var _super = _createSuper(_default);\n\n  function _default() {\n    _classCallCheck(this, _default);\n\n    return _super.apply(this, arguments);\n  }\n\n  _createClass(_default, [{\n    key: \"connect\",\n    value: function connect() {\n      var _this = this;\n\n      new sortablejs__WEBPACK_IMPORTED_MODULE_1__[\"default\"](this.listTarget, {\n        animation: 150,\n        ghostClass: 'list-group-item-dark',\n        draggable: '.repeater-row',\n        handle: '.repeater-row-handle',\n        onEnd: function onEnd() {\n          _this.resetIndices();\n\n          _this.resetPositions();\n        }\n      });\n      this.toggleEmpty();\n    }\n  }, {\n    key: \"resetButtonIndices\",\n    value: function resetButtonIndices(event) {\n      var row = event.target.closest('.repeater-row');\n      var index = this.containsRow(row) ? row.dataset.rowIndex : '';\n      this.updatePopupButtonIndices(index);\n    }\n  }, {\n    key: \"containsRow\",\n    value: function containsRow(row) {\n      return this.rowTargets.includes(row);\n    }\n  }, {\n    key: \"updatePopupButtonIndices\",\n    value: function updatePopupButtonIndices(index) {\n      var popup = document.querySelector(\"[data-popup-target=\\\"popup\\\"][data-popup-id=\\\"repeater-buttons-\".concat(this.idValue, \"\\\"]\"));\n      var buttons = popup.querySelectorAll('a');\n      buttons.forEach(function (button) {\n        button.dataset.rowIndex = index;\n      });\n    }\n  }, {\n    key: \"addRow\",\n    value: function addRow(event) {\n      event.preventDefault();\n      var button = event.target;\n      var templateName = button.dataset.templateName;\n      var rowIndex = button.dataset.rowIndex; // Prepare html from template\n\n      var html = this.getTemplateHTML(templateName);\n      html = this.replaceIdsWithTimestamps(html); // Fallback to last row if no index is set\n\n      if (rowIndex) {\n        // Insert new row after defined row\n        var row = this.rowTargets[rowIndex];\n        row.insertAdjacentHTML('afterend', html);\n      } else {\n        // Insert before footer\n        this.footerTarget.insertAdjacentHTML('beforebegin', html);\n      } // Dispatch an event\n\n\n      document.dispatchEvent(new CustomEvent('headmin:reinit', {\n        bubbles: true\n      }));\n      this.resetIndices();\n      this.resetPositions();\n      this.toggleEmpty();\n    }\n  }, {\n    key: \"removeRow\",\n    value: function removeRow(event) {\n      event.preventDefault();\n      var row = event.target.closest(\".repeater-row\");\n\n      if (row.dataset.newRecord === \"true\") {\n        // New records are simply removed from the page\n        row.remove();\n      } else {\n        // Existing records are hidden and flagged for deletion\n        row.querySelector(\"input[name*='_destroy']\").value = 1;\n        row.style.display = 'none';\n      }\n\n      this.resetIndices();\n      this.resetPositions();\n      this.toggleEmpty();\n    }\n  }, {\n    key: \"getTemplateHTML\",\n    value: function getTemplateHTML(name) {\n      var template = this.templateTargets.filter(function (template) {\n        return template.dataset.templateName === name;\n      })[0];\n      return template.innerHTML;\n    }\n  }, {\n    key: \"replaceIdsWithTimestamps\",\n    value: function replaceIdsWithTimestamps(html) {\n      var regex = new RegExp('template_id', \"g\");\n      return html.replace(regex, new Date().getTime());\n    }\n  }, {\n    key: \"visibleRowsCount\",\n    value: function visibleRowsCount() {\n      return this.visibleRows().length;\n    }\n  }, {\n    key: \"visibleRows\",\n    value: function visibleRows() {\n      var rows = this.rowTargets;\n      return rows.filter(function (row) {\n        return row.querySelector(\"input[name*='_destroy']\").value !== '1';\n      });\n    }\n  }, {\n    key: \"toggleEmpty\",\n    value: function toggleEmpty() {\n      if (this.visibleRowsCount() > 0) {\n        this.emptyTarget.classList.add('invisible');\n      } else {\n        this.emptyTarget.classList.remove('invisible');\n      }\n    }\n  }, {\n    key: \"resetPositions\",\n    value: function resetPositions() {\n      this.visibleRows().forEach(function (row, index) {\n        var positionInput = row.querySelector(\"input[name*='position']\");\n\n        if (positionInput) {\n          positionInput.value = index;\n        }\n      });\n    }\n  }, {\n    key: \"resetIndices\",\n    value: function resetIndices() {\n      this.visibleRows().forEach(function (row, index) {\n        row.dataset.rowIndex = index;\n      });\n    }\n  }], [{\n    key: \"values\",\n    get: function get() {\n      return {\n        id: String\n      };\n    }\n  }, {\n    key: \"targets\",\n    get: function get() {\n      return [\"repeater\", \"footer\", \"template\", \"row\", \"list\", \"empty\", \"addButton\"];\n    }\n  }]);\n\n  return _default;\n}(stimulus__WEBPACK_IMPORTED_MODULE_0__[\"Controller\"]);\n\n\n\n//# sourceURL=webpack:///./src/js/headmin/controllers/repeater_controller.js?");
 
 /***/ }),
 

data/docs/blocks-and-fields.md

@@ -0,0 +1,54 @@
+# Blocks + fields = Magic
+
+## Installation
+Run the following generators to generate the migration files.
+```
+rails generate headmin:blocks
+rails generate headmin:fields
+rails db:migrate
+```
+
+## Getting Started
+### Setup model
+
+Setup a block model by including `Headmin::Fieldable`
+
+```ruby
+class Block < ApplicationRecord
+  include Headmin::Block
+  include Headmin::Fieldable
+end
+```
+
+### Setup forms
+
+```erb
+# app/views/admin/blocks/_contact.html.erb
+<%= form.hidden_field :name, value: :contact %>
+
+<!-- Title -->
+<%= render 'headmin/forms/fields/text', form: form, name: :title do |field, attribute, label| %>
+  <%= render 'headmin/forms/text', form: field, attribute: attribute, label: label %>
+<% end %>
+
+<!-- People list -->
+<%= render 'headmin/forms/fields/list', form: form, name: :people do |item| %>
+  <%= render 'headmin/forms/fields/text', form: item, name: :name do |field, attribute, label| %>
+    <%= render 'headmin/forms/text', form: field, attribute: attribute, label: label %>
+  <% end %>
+<% end %>
+```
+
+### Usage in website
+
+```erb
+# app/views/website/blocks/_contact.html.erb
+<% fields = block.fields_hash %>
+
+<h1><%= fields["title"] %></h1>
+<ul>
+  <% fields["people"].each do |person| %>
+    <li><%= person["name"] %></h2></li>
+  <% end %>
+</ul>
+```

data/docs/blocks.md

@@ -38,7 +38,7 @@ Make sure to include a hidden field to store the name of the block.
 ...
 ```
 
-### Render blocks in frontend
+### Usage in frontend
 
 ```erb
 # app/views/website/pages/show.html.erb
@@ -53,49 +53,3 @@ For each block in the admin, you'll need to create a corresponding template in y
 # app/views/website/blocks/_contact.html.erb
 <%= block.name %>
 ```
-
-## Blocks + fields = Magic
-
-### Add fields to blocks
-
-Setup a block model by including `Headmin::Fieldable`
-
-```ruby
-class Block < ApplicationRecord
-  include Headmin::Block
-  include Headmin::Fieldable
-end
-```
-
-### Use fields in admin blocks
-
-```erb
-# app/views/admin/blocks/_contact.html.erb
-<%= form.hidden_field :name, value: :contact %>
-
-<!-- Title -->
-<%= render 'headmin/forms/fields/text', form: form, name: :title do |field, attribute, label| %>
-  <%= render 'headmin/forms/text', form: field, attribute: attribute, label: label %>
-<% end %>
-
-<!-- People list -->
-<%= render 'headmin/forms/fields/list', form: form, name: :people do |item| %>
-  <%= render 'headmin/forms/fields/text', form: item, name: :name do |field, attribute, label| %>
-    <%= render 'headmin/forms/text', form: field, attribute: attribute, label: label %>
-  <% end %>
-<% end %>
-```
-
-### Render blocks in your frontend
-
-```erb
-# app/views/website/blocks/_contact.html.erb
-<% fields = block.fields_hash %>
-
-<h1><%= fields["title"] %></h1>
-<ul>
-  <% fields["people"].each do |person| %>
-    <li><%= person["name"] %></h2></li>
-  <% end %>
-</ul>
-```

data/docs/devise.md

@@ -1,3 +1,41 @@
-# Authentication
+# Devise
+Headmin comes with some default views for all devise related pages. 
+To make use of them, follow the guidelines below.
 
-TODO: rewrite
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'devise'
+```
+
+Run the install generator
+```sh
+$ rails generate devise:install
+```
+
+Create a devise model
+```sh
+$ rails generate devise User
+$ rails db:migrate
+```
+
+Generate the default auth views
+```sh
+$ rails generate headmin:devise
+```
+
+## Getting Started
+
+### Change routes
+Change the default `devise_for` routes with the code below
+
+```ruby
+devise_for :users, controllers: {
+  sessions: 'auth/sessions',
+  registrations: 'auth/registrations',
+  passwords: 'auth/passwords',
+  unlocks: 'auth/unlocks',
+  confirmations: 'auth/confirmations'
+}
+```

data/docs/fields.md

@@ -1,10 +1,12 @@
-# Fields 
+# Fields
 
 ## Installation
+
 Run the following generators to generate the migration files.
-```
-rails generate headmin:fields
-rails db:migrate
+
+```sh
+$ rails generate headmin:fields
+$ rails db:migrate
 ```
 
 ## Getting Started
@@ -12,6 +14,7 @@ rails db:migrate
 ### Setup model
 
 ```ruby
+
 class Settings < ApplicationRecord
   include Headmin::Fieldable
 end
@@ -19,7 +22,7 @@ end
 
 ### Setup forms
 
-```erb
+```html
 # app/views/admin/settings/_form.html.erb
 
 <!-- Company name -->
@@ -36,22 +39,41 @@ end
 ```
 
 #### Type of fields
+
 - Text: `headmin/forms/fields/text`
 - File: `headmin/forms/fields/file`
 - Image: `headmin/forms/fields/image`
 - List: `headmin/forms/fields/list`
 - Group: `headmin/forms/fields/group`
 
-### Render fields in frontend 
+### Seed database
+
+Use the `fields_hash` setter method to set the data, the way you want to retrieve it.
 
-```erb
+```ruby
+# In db/seeds.rb
+Setting.create!(
+  name: 'Website settings',
+  fields_hash: {
+    company_name: 'Insiting BV',
+    people: [
+      { name: 'Jef Vlamings' },
+      { name: 'Gert-Jan Peeters' }
+    ]
+  }
+)
+```
+
+### Usage in frontend
+
+```html
 # app/views/website/settings/show.html.erb
 <% fields = @setting.fields_hash %>
 
 <h1><%= fields["company_name"] %></h1>
 <ul>
-  <% fields["people"].each do |person| %>
+    <% fields["people"].each do |person| %>
     <li><%= person["name"] %></h2></li>
-  <% end %>
+    <% end %>
 </ul>
 ```

data/headmin.gemspec

@@ -29,6 +29,7 @@ Gem::Specification.new do |spec|
 
   # Uncomment to register a new dependency of your gem
   # spec.add_dependency "example-gem", "~> 1.0"
+  spec.add_runtime_dependency 'closure_tree'
 
   # For more information and examples about making a new gem, checkout our
   # guide at: https://bundler.io/guides/creating_gem.html

data/lib/generators/headmin/devise_generator.rb

@@ -0,0 +1,12 @@
+module Headmin
+  class DeviseGenerator < Rails::Generators::Base
+    include Rails::Generators::Migration
+
+    source_root File.expand_path('../../templates', __FILE__)
+
+    def blocks
+      directory 'views/auth', 'app/views/auth'
+      copy_file 'views/layouts/auth.html.erb', 'app/layouts/auth.html.erb'
+    end
+  end
+end

data/lib/generators/headmin/fields_generator.rb

@@ -7,6 +7,7 @@ module Headmin
     def blocks
       template 'models/field.rb', 'app/models/field.rb'
       migration_template 'migrations/create_fields.rb', 'db/migrate/create_fields.rb'
+      migration_template 'migrations/create_field_hierarchies.rb', 'db/migrate/create_field_hierarchies.rb'
     end
 
     private

data/lib/generators/templates/migrations/create_field_hierarchies.rb

@@ -0,0 +1,16 @@
+class CreateFieldHierarchies < ActiveRecord::Migration[6.1]
+  def change
+    create_table :field_hierarchies, id: false do |t|
+      t.integer :ancestor_id, null: false
+      t.integer :descendant_id, null: false
+      t.integer :generations, null: false
+    end
+
+    add_index :field_hierarchies, [:ancestor_id, :descendant_id, :generations],
+      unique: true,
+      name: "field_anc_desc_idx"
+
+    add_index :field_hierarchies, [:descendant_id],
+      name: "field_desc_idx"
+  end
+end

data/lib/generators/templates/views/auth/confirmations/new.html.erb

@@ -0,0 +1 @@
+<%= render "headmin/views/devise/confirmations/new" %>

data/lib/generators/templates/views/auth/mailer/confirmation_instructions.html.erb

@@ -0,0 +1 @@
+<%= render "headmin/views/devise/mailer/confirmation_instructions" %>

data/lib/generators/templates/views/auth/mailer/email_changed.html.erb

@@ -0,0 +1 @@
+<%= render "headmin/views/devise/mailer/email_changed" %>

data/lib/generators/templates/views/auth/mailer/password_change.html.erb

@@ -0,0 +1 @@
+<%= render "headmin/views/devise/mailer/password_change" %>

data/lib/generators/templates/views/auth/mailer/reset_password_instructions.html.erb

@@ -0,0 +1 @@
+<%= render "headmin/views/devise/mailer/reset_password_instructions" %>

data/lib/generators/templates/views/auth/mailer/unlock_instructions.html.erb

@@ -0,0 +1 @@
+<%= render "headmin/views/devise/mailer/unlock_instructions" %>

data/lib/generators/templates/views/auth/passwords/edit.html.erb

@@ -0,0 +1 @@
+<%= render "headmin/views/devise/passwords/edit" %>

data/lib/generators/templates/views/auth/passwords/new.html.erb

@@ -0,0 +1 @@
+<%= render "headmin/views/devise/passwords/new" %>

data/lib/generators/templates/views/auth/registrations/edit.html.erb

@@ -0,0 +1 @@
+<%= render "headmin/views/devise/registrations/edit" %>

data/lib/generators/templates/views/auth/registrations/new.html.erb

@@ -0,0 +1 @@
+<%= render "headmin/views/devise/registrations/new" %>

data/lib/generators/templates/views/auth/sessions/new.html.erb

@@ -0,0 +1 @@
+<%= render "headmin/views/devise/sessions/new" %>

data/lib/generators/templates/views/auth/unlocks/new.html.erb

@@ -0,0 +1 @@
+<%= render "headmin/views/devise/unlocks/new" %>