headmin 0.4.1 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 503fa2fc7ec041e2a3baca7937f969f7cc8061da02fcb698924f43f3ccc384f9
-  data.tar.gz: 88ad583e50e5d72b8f08c6212bdee24ce1f504d4776bcf0ff6c21faadb37db6e
+  metadata.gz: 8a80387ee0e1dfc309d65f5e5eb450260dc84fda671904c3886eb50d2087c3eb
+  data.tar.gz: 98282252c395347dbb1c2490247c323649b4d282d1bc0d7a6bad32c51ec7ebfc
 SHA512:
-  metadata.gz: 6bc9c3497c44c255eca104e024d672fa37041029c0da730ee257078f42a72b2d299b427c636b52ee6d0a370c41576d16af83b2ec55db4ad90418f104dbe406e9
-  data.tar.gz: ccecbb9860f879f0bd398954e67f546671e090a230a5f812bff8c59dd268e62755147ee4d14b3eafd7a59f182c39ee012f70e234ea14b47e58a63ef60dea71c7
+  metadata.gz: 3c7271cbff3e46599c77506c07bdd0d0fc0d132bf7230202913a394b4b285f599c37866f52d28ff5d79b19ea59c754db7f25fab68bba71795e87d7d42139285a
+  data.tar.gz: 9900e4731b52d46486ea772433696774856b974d7bd2dc758628ce964c5d990296910c1a59a04990f5e509a5a1e341f3d9848d2043ad2ee2c14029c8096feae9

data/CHANGELOG.md

@@ -1,6 +1,20 @@
 # Headmin Changelog
 
-## HEAD
+## 0.5
+- FEATURE: Filters now have support for operators and conditionals 
+- BREAK: `headmin/filters` now return a form object that is required for each individual form
+- DEPRECATED: `Headmin::Searchable` is replaced with `Headmin::Filterable`. 
+  - A `filter(params, types)` method is available and accepts an optional types argument.
+  - The `search()` method is now deprecated and no longer required
+
+## 0.4.2
+- FEATURE: New field type "files" to allow simple gallery creation
+- FIX: Fields hash with duplicate keys no longer mix up
+- BREAK: Image field is now deprecated. Use the file field instead
+- BREAK: Field uses "has_many_attached :files" instead of "has_one_attache :file" now. Rename "file" to "files" in `active_storage_attachments`
+- BREAK: You need to set a File object in the fields_hash, instead of creating an intermediate Blob instance
+
+## 0.4
 - FEATURE: Introduction of a `ViewModel` class to clean up the component views. This allows for a cleaner abstraction and better testing.
 - FEATURE: New `wysiwyg` component which currently defaults to Redactor X. Redactor X will be swapped with a free open source version in the 1.0 release.
 - FEATURE: `headmin/forms/redactorx` now accepts `hybrid: true` to hide the controls
@@ -15,7 +29,7 @@
 - BREAK: `headmin/forms/actions` and all of its child components have been removed
 - BREAK: `$font-weight-medium` has been removed from headmin overrides variables. We don't want to introduce new variable names that look like they are part of Bootstrap.
 - BREAK: `headmin/forms/date_range` has a different way of setting attribute specific values. We now have a `:start` and `:end` attribute that accept all possible input options for their respective inputs. Both have a required `:attribute` parameter now.
-
+- BREAK: filter concern (controllers) has been renamed to filterable
 ```erb
 # Old
 <%= render "headmin/forms/date_range", form: form, start_attribute: :start_date, end_attribute: :end_date %>

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    headmin (0.4.0)
+    headmin (0.5.1)
       closure_tree (~> 7.4)
       inline_svg (~> 1.7)
       redcarpet (~> 3.5)
@@ -10,67 +10,67 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    actioncable (7.0.1)
-      actionpack (= 7.0.1)
-      activesupport (= 7.0.1)
+    actioncable (7.0.2.4)
+      actionpack (= 7.0.2.4)
+      activesupport (= 7.0.2.4)
       nio4r (~> 2.0)
       websocket-driver (>= 0.6.1)
-    actionmailbox (7.0.1)
-      actionpack (= 7.0.1)
-      activejob (= 7.0.1)
-      activerecord (= 7.0.1)
-      activestorage (= 7.0.1)
-      activesupport (= 7.0.1)
+    actionmailbox (7.0.2.4)
+      actionpack (= 7.0.2.4)
+      activejob (= 7.0.2.4)
+      activerecord (= 7.0.2.4)
+      activestorage (= 7.0.2.4)
+      activesupport (= 7.0.2.4)
       mail (>= 2.7.1)
       net-imap
       net-pop
       net-smtp
-    actionmailer (7.0.1)
-      actionpack (= 7.0.1)
-      actionview (= 7.0.1)
-      activejob (= 7.0.1)
-      activesupport (= 7.0.1)
+    actionmailer (7.0.2.4)
+      actionpack (= 7.0.2.4)
+      actionview (= 7.0.2.4)
+      activejob (= 7.0.2.4)
+      activesupport (= 7.0.2.4)
       mail (~> 2.5, >= 2.5.4)
       net-imap
       net-pop
       net-smtp
       rails-dom-testing (~> 2.0)
-    actionpack (7.0.1)
-      actionview (= 7.0.1)
-      activesupport (= 7.0.1)
+    actionpack (7.0.2.4)
+      actionview (= 7.0.2.4)
+      activesupport (= 7.0.2.4)
       rack (~> 2.0, >= 2.2.0)
       rack-test (>= 0.6.3)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.0, >= 1.2.0)
-    actiontext (7.0.1)
-      actionpack (= 7.0.1)
-      activerecord (= 7.0.1)
-      activestorage (= 7.0.1)
-      activesupport (= 7.0.1)
+    actiontext (7.0.2.4)
+      actionpack (= 7.0.2.4)
+      activerecord (= 7.0.2.4)
+      activestorage (= 7.0.2.4)
+      activesupport (= 7.0.2.4)
       globalid (>= 0.6.0)
       nokogiri (>= 1.8.5)
-    actionview (7.0.1)
-      activesupport (= 7.0.1)
+    actionview (7.0.2.4)
+      activesupport (= 7.0.2.4)
       builder (~> 3.1)
       erubi (~> 1.4)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.1, >= 1.2.0)
-    activejob (7.0.1)
-      activesupport (= 7.0.1)
+    activejob (7.0.2.4)
+      activesupport (= 7.0.2.4)
       globalid (>= 0.3.6)
-    activemodel (7.0.1)
-      activesupport (= 7.0.1)
-    activerecord (7.0.1)
-      activemodel (= 7.0.1)
-      activesupport (= 7.0.1)
-    activestorage (7.0.1)
-      actionpack (= 7.0.1)
-      activejob (= 7.0.1)
-      activerecord (= 7.0.1)
-      activesupport (= 7.0.1)
+    activemodel (7.0.2.4)
+      activesupport (= 7.0.2.4)
+    activerecord (7.0.2.4)
+      activemodel (= 7.0.2.4)
+      activesupport (= 7.0.2.4)
+    activestorage (7.0.2.4)
+      actionpack (= 7.0.2.4)
+      activejob (= 7.0.2.4)
+      activerecord (= 7.0.2.4)
+      activesupport (= 7.0.2.4)
       marcel (~> 1.0)
       mini_mime (>= 1.1.0)
-    activesupport (7.0.1)
+    activesupport (7.0.2.4)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
@@ -91,25 +91,24 @@ GEM
     closure_tree (7.4.0)
       activerecord (>= 4.2.10)
       with_advisory_lock (>= 4.0.0)
-    concurrent-ruby (1.1.9)
+    concurrent-ruby (1.1.10)
     crass (1.0.6)
-    debug (1.4.0)
+    debug (1.5.0)
       irb (>= 1.3.6)
       reline (>= 0.2.7)
     digest (3.1.0)
     erubi (1.10.0)
     globalid (1.0.0)
       activesupport (>= 5.0)
-    i18n (1.9.1)
+    i18n (1.10.0)
       concurrent-ruby (~> 1.0)
     inline_svg (1.8.0)
       activesupport (>= 3.0)
       nokogiri (>= 1.6)
     io-console (0.5.11)
-    io-wait (0.2.1)
     irb (1.4.1)
       reline (>= 0.3.0)
-    loofah (2.13.0)
+    loofah (2.16.0)
       crass (~> 1.0.2)
       nokogiri (>= 1.5.9)
     mail (2.7.1)
@@ -118,7 +117,7 @@ GEM
     matrix (0.4.2)
     method_source (1.0.0)
     mini_mime (1.1.2)
-    minitest (5.14.4)
+    minitest (5.15.0)
     minitest-spec-rails (6.1.0)
       minitest (>= 5.0)
       railties (>= 4.1)
@@ -130,78 +129,77 @@ GEM
       digest
       net-protocol
       timeout
-    net-protocol (0.1.2)
-      io-wait
+    net-protocol (0.1.3)
       timeout
     net-smtp (0.3.1)
       digest
       net-protocol
       timeout
     nio4r (2.5.8)
-    nokogiri (1.13.1-arm64-darwin)
+    nokogiri (1.13.4-arm64-darwin)
       racc (~> 1.4)
-    nokogiri (1.13.1-x86_64-darwin)
+    nokogiri (1.13.4-x86_64-darwin)
       racc (~> 1.4)
-    nokogiri (1.13.1-x86_64-linux)
+    nokogiri (1.13.4-x86_64-linux)
       racc (~> 1.4)
-    parallel (1.21.0)
-    parser (3.1.0.0)
+    parallel (1.22.1)
+    parser (3.1.2.0)
       ast (~> 2.4.1)
-    public_suffix (4.0.6)
+    public_suffix (4.0.7)
     racc (1.6.0)
     rack (2.2.3)
     rack-test (1.1.0)
       rack (>= 1.0, < 3)
-    rails (7.0.1)
-      actioncable (= 7.0.1)
-      actionmailbox (= 7.0.1)
-      actionmailer (= 7.0.1)
-      actionpack (= 7.0.1)
-      actiontext (= 7.0.1)
-      actionview (= 7.0.1)
-      activejob (= 7.0.1)
-      activemodel (= 7.0.1)
-      activerecord (= 7.0.1)
-      activestorage (= 7.0.1)
-      activesupport (= 7.0.1)
+    rails (7.0.2.4)
+      actioncable (= 7.0.2.4)
+      actionmailbox (= 7.0.2.4)
+      actionmailer (= 7.0.2.4)
+      actionpack (= 7.0.2.4)
+      actiontext (= 7.0.2.4)
+      actionview (= 7.0.2.4)
+      activejob (= 7.0.2.4)
+      activemodel (= 7.0.2.4)
+      activerecord (= 7.0.2.4)
+      activestorage (= 7.0.2.4)
+      activesupport (= 7.0.2.4)
       bundler (>= 1.15.0)
-      railties (= 7.0.1)
+      railties (= 7.0.2.4)
     rails-dom-testing (2.0.3)
       activesupport (>= 4.2.0)
       nokogiri (>= 1.6)
     rails-html-sanitizer (1.4.2)
       loofah (~> 2.3)
-    railties (7.0.1)
-      actionpack (= 7.0.1)
-      activesupport (= 7.0.1)
+    railties (7.0.2.4)
+      actionpack (= 7.0.2.4)
+      activesupport (= 7.0.2.4)
       method_source
       rake (>= 12.2)
       thor (~> 1.0)
       zeitwerk (~> 2.5)
     rainbow (3.1.1)
-    rake (13.0.3)
+    rake (13.0.6)
     redcarpet (3.5.1)
-    regexp_parser (2.2.0)
+    regexp_parser (2.3.1)
     reline (0.3.1)
       io-console (~> 0.5)
     rexml (3.2.5)
     rouge (3.28.0)
-    rubocop (1.25.0)
+    rubocop (1.28.2)
       parallel (~> 1.10)
       parser (>= 3.1.0.0)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml
-      rubocop-ast (>= 1.15.1, < 2.0)
+      rubocop-ast (>= 1.17.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.15.1)
-      parser (>= 3.0.1.1)
-    rubocop-performance (1.13.2)
+    rubocop-ast (1.17.0)
+      parser (>= 3.1.1.0)
+    rubocop-performance (1.13.3)
       rubocop (>= 1.7.0, < 2.0)
       rubocop-ast (>= 0.4.0)
     ruby-progressbar (1.11.0)
-    sprockets (4.0.2)
+    sprockets (4.0.3)
       concurrent-ruby (~> 1.0)
       rack (> 1, < 3)
     sprockets-rails (3.4.2)
@@ -209,9 +207,9 @@ GEM
       activesupport (>= 5.2)
       sprockets (>= 3.0.0)
     sqlite3 (1.4.2)
-    standard (1.7.0)
-      rubocop (= 1.25.0)
-      rubocop-performance (= 1.13.2)
+    standard (1.11.0)
+      rubocop (= 1.28.2)
+      rubocop-performance (= 1.13.3)
     strscan (3.0.1)
     thor (1.2.1)
     timeout (0.2.0)

data/app/assets/javascripts/headmin/controllers/date_range_controller.js

@@ -1,10 +1,6 @@
 import { Controller } from '@hotwired/stimulus'
 
 export default class extends Controller {
-  static get targets () {
-    return ['dateInput', 'startDateInput', 'endDateInput']
-  }
-
   update (event) {
     const flatpickr = event.target._flatpickr
     const startDate = flatpickr.selectedDates[0]
@@ -15,11 +11,21 @@ export default class extends Controller {
   }
 
   setStartDateInputValue (value) {
-    this.startDateInputTarget.value = value
+    const startDateInput = this.startDateInput()
+    startDateInput.value = value
   }
 
   setEndDateInputValue (value) {
-    this.endDateInputTarget.value = value
+    const endDateInput = this.endDateInput()
+    endDateInput.value = value
+  }
+
+  startDateInput () {
+    return this.element.nextElementSibling
+  }
+
+  endDateInput () {
+    return this.startDateInput().nextElementSibling
   }
 
   formatDate (date) {

data/app/assets/javascripts/headmin/controllers/filter_controller.js

@@ -2,7 +2,13 @@ import { Controller } from '@hotwired/stimulus'
 
 export default class extends Controller {
   static get targets () {
-    return ['button', 'popup']
+    return ['button', 'popup', 'conditional', 'operator', 'value', 'hidden', 'wrapper', 'template', 'row']
+  }
+
+  static get values () {
+    return {
+      name: String
+    }
   }
 
   // Attaches controller logic to the element itself
@@ -10,16 +16,7 @@ export default class extends Controller {
   connect () {
     this.element.controller = this
 
-    // Clicked outside popup
-    document.addEventListener('click', (event) => {
-      this.handleOutsideClick(event)
-    })
-  }
-
-  handleOutsideClick (event) {
-    if (!this.isClickedInside(event)) {
-      this.close()
-    }
+    this.updateHiddenValue()
   }
 
   toggle (event) {
@@ -41,6 +38,38 @@ export default class extends Controller {
     this.popupTarget.classList.add('closed')
   }
 
+  add (event) {
+    event.preventDefault()
+    const html = this.getTemplateHTML()
+    this.wrapperTarget.insertAdjacentHTML('beforeend', html)
+  }
+
+  remove (event) {
+    event.preventDefault()
+    const inputGroup = event.currentTarget.closest('[data-filter-target="row"]')
+    // Check if there is a previous element (the conditional select). If no element (first inputGroup), take the next element.
+    const conditional = inputGroup.previousElementSibling != null ? inputGroup.previousElementSibling : inputGroup.nextElementSibling
+
+    inputGroup.remove()
+    // If there is only one inputGroup, the conditional is null, so do not attempt to remove it
+    if (conditional != null) conditional.remove()
+
+    // After we remove the UI, run update to also remove filter from the hidden input
+    this.updateHiddenValue()
+
+    // Check if there are still inputs left, else remove filter
+    if (this.valueTargets.length === 0) {
+      this.removeFilter()
+    }
+  }
+
+  removeFilter () {
+    const form = this.buttonTarget.closest('form')
+    this.buttonTarget.remove()
+    this.popupTarget.remove()
+    form.submit()
+  }
+
   isClickedInside (event) {
     if (!event) {
       return false
@@ -50,4 +79,25 @@ export default class extends Controller {
     const inAddButton = event.target.dataset.action === 'click->filters#add'
     return (inPopup || inButton || inAddButton)
   }
+
+  updateHiddenValue () {
+    this.hiddenTarget.value = this.buildInstructionString()
+  }
+
+  buildInstructionString () {
+    let string = ''
+    for (const row of this.rowTargets) {
+      const conditional = row.previousElementSibling ? row.previousElementSibling.querySelector('[data-filter-target="conditional"]').value : null
+      const operator = row.querySelector('[data-filter-target="operator"]').value
+      const value = row.querySelector('[data-filter-target="value"]').value
+      string += `${conditional || ''}${operator}:${value}`
+    }
+
+    return string
+  }
+
+  getTemplateHTML () {
+    const template = this.templateTarget
+    return template.innerHTML
+  }
 }

data/app/assets/javascripts/headmin/controllers/filter_row_controller.js

@@ -0,0 +1,50 @@
+import { Controller } from '@hotwired/stimulus'
+
+export default class extends Controller {
+  static get targets () {
+    return ['original', 'operator', 'null']
+  }
+
+  connect () {
+    this.operatorTarget.addEventListener('change', () => this.handleOperatorChange())
+    this.handleOperatorChange()
+  }
+
+  handleOperatorChange () {
+    if (this.operatorTarget.value === 'is_null' || this.operatorTarget.value === 'is_not_null') {
+      this.toggleNullInput()
+    } else {
+      this.toggleOriginalInput()
+    }
+  }
+
+  toggleNullInput () {
+    this.hideOriginal()
+    this.showNull()
+  }
+
+  toggleOriginalInput () {
+    this.showOriginal()
+    this.hideNull()
+  }
+
+  hideOriginal () {
+    this.originalTarget.style.display = 'none'
+    this.originalTarget.setAttribute('data-filter-target', 'value_original')
+  }
+
+  showOriginal () {
+    this.originalTarget.style.display = 'block'
+    this.originalTarget.setAttribute('data-filter-target', 'value')
+  }
+
+  hideNull () {
+    this.nullTarget.style.display = 'none'
+    this.nullTarget.setAttribute('data-filter-target', 'value_null')
+  }
+
+  showNull () {
+    this.nullTarget.style.display = 'block'
+    this.nullTarget.setAttribute('data-filter-target', 'value')
+  }
+}

data/app/assets/javascripts/headmin/controllers/flatpickr_controller.js

@@ -4,17 +4,13 @@ import { Dutch } from 'flatpickr/dist/esm/l10n/nl.js'
 import I18n from '../config/i18n'
 
 export default class extends Controller {
-  static get targets () {
-    return ['input']
-  }
-
   connect () {
     const options = { ...this.defaultOptions(), ...this.options() }
-    flatpickr(this.inputTarget, options)
+    flatpickr(this.element, options)
   }
 
   options () {
-    return JSON.parse(this.inputTarget.getAttribute('data-flatpickr'))
+    return JSON.parse(this.element.getAttribute('data-flatpickr'))
   }
 
   defaultOptions () {

data/app/assets/javascripts/headmin/controllers/popup_controller.js

@@ -19,6 +19,9 @@ export default class extends Controller {
   }
 
   handleOutsideClick (event) {
+    const itemRemoved = !document.body.contains(event.target) // Ignore items that were removed from DOM (else this triggers a close)
+    if (itemRemoved) return
+
     const inPopup = event.target.closest('[data-popup-target="popup"]') !== null
     const inButton = event.target.closest('[data-popup-target="button"]') !== null
     const openPopup = document.querySelector('[data-popup-target="popup"]:not(.closed)')
@@ -53,7 +56,6 @@ export default class extends Controller {
   close (event) {
     const button = event.target.closest('[data-popup-target="button"]')
     const popup = this.popupById(button.dataset.popupId)
-
     this.closePopup(popup)
   }
 

data/app/assets/javascripts/headmin/controllers/table_actions_controller.js

@@ -2,12 +2,12 @@ import { Controller } from '@hotwired/stimulus'
 
 export default class extends Controller {
   static get targets () {
-    return ['wrapper', 'form', 'select', 'method', 'button', 'idInputTemplate', 'id', 'counter']
+    return ['wrapper', 'form', 'select', 'method', 'button', 'idInput', 'counter']
   }
 
   connect () {
     this.wrapperTarget.addEventListener('idSelectionChanged', (event) => {
-      this.updateIdFields(event.detail.ids)
+      this.updateIdInput(event.detail.ids)
       this.updateCounter(event.detail.count)
       this.toggleCounter(event.detail.count)
     })
@@ -21,17 +21,24 @@ export default class extends Controller {
     this.enableButton()
   }
 
-  updateIdFields (ids) {
-    this.removeIds()
-    if (ids instanceof Array) {
-      ids.forEach((id) => {
-        this.addId(id)
-      })
+  updateIdInput (ids) {
+    if (ids == null) {
+      this.disableIdInput()
+      this.idInputTarget.value = ''
     } else {
-      this.addId('')
+      this.enableIdInput()
+      this.idInputTarget.value = `in:${ids.join(',')}`
     }
   }
 
+  disableIdInput () {
+    this.idInputTarget.removeAttribute('name')
+  }
+
+  enableIdInput () {
+    this.idInputTarget.setAttribute('name', 'id')
+  }
+
   updateCounter (count) {
     let htmlString = ''
     switch (count) {
@@ -94,16 +101,4 @@ export default class extends Controller {
   enableButton () {
     this.buttonTarget.removeAttribute('disabled')
   }
-
-  addId (id) {
-    const template = this.idInputTemplateTarget
-    const input = template.innerHTML.replace(/ID/g, id)
-    this.formTarget.insertAdjacentHTML('afterbegin', input)
-  }
-
-  removeIds () {
-    this.idTargets.forEach((input) => {
-      this.formTarget.removeChild(input)
-    })
-  }
 }

data/app/assets/javascripts/headmin/index.js

@@ -6,6 +6,7 @@ import DateRangeController from './controllers/date_range_controller'
 import DropzoneController from './controllers/dropzone_controller'
 import FilePreviewController from './controllers/file_preview_controller'
 import FilterController from './controllers/filter_controller'
+import FilterRowController from './controllers/filter_row_controller'
 import FiltersController from './controllers/filters_controller'
 import FlatpickrController from './controllers/flatpickr_controller'
 import HelloController from './controllers/hello_controller'
@@ -26,6 +27,7 @@ export class Headmin {
     Stimulus.register('dropzone', DropzoneController)
     Stimulus.register('file-preview', FilePreviewController)
     Stimulus.register('filter', FilterController)
+    Stimulus.register('filter-row', FilterRowController)
     Stimulus.register('filters', FiltersController)
     Stimulus.register('flatpickr', FlatpickrController)
     Stimulus.register('hello', HelloController)