bullet_train-fields 1.3.1 → 1.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2c6f5ed54111d8605cb024f35e2d22ebbc8796dc0ee1ea889ad0e7e19e9bbeaa
-  data.tar.gz: a72c9b6c59084dba172f9d01752056eff99eae9b7c0f38eac296bc4a46f231b9
+  metadata.gz: 8d55793fe0b13a862e6df286add5f944e51ddac507d83e3771b35b839a123599
+  data.tar.gz: df7c6f3067c58ec7afeb9f673b2eab58bdcd53c8dbefd6d6da7a3fb44b1dbaa1
 SHA512:
-  metadata.gz: 14b0856a9c3a33999713ed94ac519e92849c01b97a63f503f7913b3158294049c0d5f3ddd6ec72f39d3fa3f2e691d19210779d86d6bbc02b16514a8a689df067
-  data.tar.gz: 4116f5e19cfc907ca0ee1f11637650fd8e3cb0be8a4f7c40102f34be46fb47efb2af9a07b49b79afd2c0ee1929f62e82a4db3bb28ad755b04630a2ccce3bc345
+  metadata.gz: b952ed07c8cc291358ce1195b8dbeb681b914c60eb359ef18a3ead154ee114538f7526e2a26eb1d05339534103a53e25b3e819a5fbd5c329068de6ad8a9e755f
+  data.tar.gz: 87aa8fa81f8bc2cbaf9dda4c590860d6ab7b3adfb570f2b0fcf34c7b61346f9d6bd275caf180ac970518de87c2f5c8f976ab979f13491883d1cc5e84ea9024c5

data/app/controllers/concerns/fields/date_and_time_support.rb

@@ -2,12 +2,22 @@ module Fields::DateAndTimeSupport
   extend ActiveSupport::Concern
 
   def assign_date_and_time(strong_params, attribute)
+    deprecator = ActiveSupport::Deprecation.new("2.0", "BulletTrain::Fields")
+    deprecator.deprecation_warning(
+      "assign_date_and_time",
+      "Please assign an ISO8601 datetime string as form field value instead and remove all assign_date_and_time assignments,
+      see https://ruby-doc.org/3.2.2/exts/date/DateTime.html"
+    )
     attribute = attribute.to_s
     time_zone_attribute = "#{attribute}_time_zone"
     if strong_params.dig(attribute).present?
-      time_zone = ActiveSupport::TimeZone.new(strong_params[time_zone_attribute] || current_team.time_zone)
-      strong_params.delete(time_zone_attribute)
-      strong_params[attribute] = time_zone.strptime(strong_params[attribute], t("global.formats.date_and_time"))
+      begin
+        strong_params[attribute] = DateTime.iso8601(strong_params[attribute])
+      rescue ArgumentError
+        time_zone = ActiveSupport::TimeZone.new(strong_params[time_zone_attribute] || current_team.time_zone)
+        strong_params.delete(time_zone_attribute)
+        strong_params[attribute] = time_zone.strptime(strong_params[attribute], t("global.formats.date_and_time"))
+      end
     end
   end
 end

data/app/controllers/concerns/fields/date_support.rb

@@ -2,11 +2,21 @@ module Fields::DateSupport
   extend ActiveSupport::Concern
 
   def assign_date(strong_params, attribute)
+    deprecator = ActiveSupport::Deprecation.new("2.0", "BulletTrain::Fields")
+    deprecator.deprecation_warning(
+      "assign_date",
+      "Please assign an ISO8601 date string as field value instead and remove all assign_date assignments,
+      see https://ruby-doc.org/3.2.2/exts/date/Date.html"
+    )
     attribute = attribute.to_s
     if strong_params.dig(attribute).present?
-      parsed_value = Chronic.parse(strong_params[attribute])
-      return nil unless parsed_value
-      strong_params[attribute] = parsed_value.to_date
+      begin
+        strong_params[attribute] = Date.iso8601(strong_params[attribute])
+      rescue ArgumentError
+        parsed_value = Chronic.parse(strong_params[attribute])
+        return nil unless parsed_value
+        strong_params[attribute] = parsed_value.to_date
+      end
     end
   end
 end

data/app/javascript/controllers/fields/date_controller.js

@@ -3,14 +3,18 @@ require("daterangepicker/daterangepicker.css");
 
 // requires jQuery, moment, might want to consider a vanilla JS alternative
 import 'daterangepicker';
+import moment from 'moment-timezone'
 
 export default class extends Controller {
-  static targets = [ "field", "clearButton", "currentTimeZoneWrapper", "timeZoneButtons", "timeZoneSelectWrapper", "timeZoneField" ]
+  static targets = [ "field", "displayField", "clearButton", "currentTimeZoneWrapper", "timeZoneButtons", "timeZoneSelectWrapper", "timeZoneField", "timeZoneSelect" ]
   static values = {
     includeTime: Boolean,
     defaultTimeZones: Array,
-    cancelButtonLabel: { type: String, default: "Cancel" },
-    applyButtonLabel: { type: String, default: "Apply" }
+    dateFormat: String,
+    timeFormat: String,
+    currentTimeZone: String,
+    isAmPm: Boolean,
+    pickerLocale: { type: Object, default: {} }
   }
 
   connect() {
@@ -26,13 +30,33 @@ export default class extends Controller {
     event.preventDefault()
 
     $(this.fieldTarget).val('')
+    $(this.displayFieldTarget).val('')
+  }
+
+  currentTimeZone(){
+    return (
+      ( this.hasTimeZoneSelectWrapperTarget && $(this.timeZoneSelectWrapperTarget).is(":visible") && this.timeZoneSelectTarget.value ) ||
+      ( this.hasTimeZoneFieldTarget && this.timeZoneFieldTarget.value ) ||
+        this.currentTimeZoneValue
+    )
   }
 
   applyDateToField(event, picker) {
-    const format = this.includeTimeValue ? 'MM/DD/YYYY h:mm A' : 'MM/DD/YYYY'
-    $(this.fieldTarget).val(picker.startDate.format(format))
+    const format = this.includeTimeValue ? this.timeFormatValue : this.dateFormatValue
+    const newTimeZone = this.currentTimeZone()
+    const momentVal = (
+      picker ?
+      moment(picker.startDate.toISOString()).tz(newTimeZone, true) :
+      moment.tz(moment(this.fieldTarget.value, "YYYY-MM-DDTHH:mm").format("YYYY-MM-DDTHH:mm"), newTimeZone) 
+    )
+    const displayVal = momentVal.format(format)
+    const dataVal = this.includeTimeValue ? momentVal.toISOString(true) : momentVal.format('YYYY-MM-DD')
+    $(this.displayFieldTarget).val(displayVal)
+    $(this.fieldTarget).val(dataVal)
     // bubble up a change event when the input is updated for other listeners
-    this.fieldTarget.dispatchEvent(new CustomEvent('change', { detail: { picker: picker }}))
+    if(picker){
+      this.displayFieldTarget.dispatchEvent(new CustomEvent('change', { detail: { picker: picker }}))
+    }
   }
 
   showTimeZoneButtons(event) {
@@ -43,15 +67,18 @@ export default class extends Controller {
     $(this.timeZoneButtonsTarget).toggleClass('hidden')
   }
 
+  // triggered on other click from the timezone buttons
   showTimeZoneSelectWrapper(event) {
     // don't follow the anchor
     event.preventDefault()
 
     $(this.timeZoneButtonsTarget).toggleClass('hidden')
-
     if (this.hasTimeZoneSelectWrapperTarget) {
       $(this.timeZoneSelectWrapperTarget).toggleClass('hidden')
     }
+    if(!["", null].includes(this.fieldTarget.value)){
+      $(this.displayFieldTarget).trigger("apply.daterangepicker");
+    }
   }
 
   resetTimeZoneUI(e) {
@@ -65,39 +92,70 @@ export default class extends Controller {
     }
   }
 
+  // triggered on selecting a new timezone using the buttons
   setTimeZone(event) {
     // don't follow the anchor
     event.preventDefault()
-
     const currentTimeZoneEl = this.currentTimeZoneWrapperTarget.querySelector('a')
-    const {value} = event.target.dataset
-
-    $(this.timeZoneFieldTarget).val(value)
-    $(currentTimeZoneEl).text(value)
-
+    $(this.timeZoneFieldTarget).val(event.target.dataset.value)
+    $(currentTimeZoneEl).text(event.target.dataset.label)
     $('.time-zone-button').removeClass('button').addClass('button-alternative')
     $(event.target).removeClass('button-alternative').addClass('button')
+    this.resetTimeZoneUI()
+    if(!["", null].includes(this.fieldTarget.value)){
+      $(this.displayFieldTarget).trigger("apply.daterangepicker");
+    }
+  }
+
+  // triggered on selecting a new timezone from the timezone picker
+  selectTimeZoneChange(event) {
+    if(!["", null].includes(this.fieldTarget.value)){
+      $(this.displayFieldTarget).trigger("apply.daterangepicker");
+    }
+  }
 
+  // triggered on cancel click from the timezone picker
+  cancelSelect(event) {
+    event.preventDefault()
     this.resetTimeZoneUI()
+    if(!["", null].includes(this.fieldTarget.value)){
+      $(this.displayFieldTarget).trigger("apply.daterangepicker")
+    }
+  }
+
+  displayFieldChange(event) {
+    const newTimeZone = this.currentTimeZone()
+    const format = this.includeTimeValue ? this.timeFormatValue : this.dateFormatValue
+    const momentParsed = moment(this.displayFieldTarget.value, format, false)
+    if(momentParsed.isValid()){
+      const momentVal = moment.tz(momentParsed.format("YYYY-MM-DDTHH:mm"), newTimeZone)
+      const dataVal = this.includeTimeValue ? momentVal.toISOString(true) : momentVal.format('YYYY-MM-DD')
+      $(this.fieldTarget).val(dataVal)
+    } else {
+      // nullify field value when the display format is wrong
+      $(this.fieldTarget).val("")
+    }
   }
 
   initPluginInstance() {
-    $(this.fieldTarget).daterangepicker({
+    const localeValues = this.pickerLocaleValue
+    const isAmPm = this.isAmPmValue
+    localeValues['format'] = this.includeTimeValue ? this.timeFormatValue : this.dateFormatValue
+
+    $(this.displayFieldTarget).daterangepicker({
       singleDatePicker: true,
       timePicker: this.includeTimeValue,
       timePickerIncrement: 5,
       autoUpdateInput: false,
-      locale: {
-        cancelLabel: this.cancelButtonLabelValue,
-        applyLabel: this.applyButtonLabelValue,
-        format: this.includeTimeValue ? 'MM/DD/YYYY h:mm A' : 'MM/DD/YYYY'
-      }
+      locale: localeValues,
+      timePicker24Hour: !isAmPm,
     })
 
-    $(this.fieldTarget).on('apply.daterangepicker', this.applyDateToField.bind(this))
-    $(this.fieldTarget).on('cancel.daterangepicker', this.clearDate.bind(this))
+    $(this.displayFieldTarget).on('apply.daterangepicker', this.applyDateToField.bind(this))
+    $(this.displayFieldTarget).on('cancel.daterangepicker', this.clearDate.bind(this))
+    $(this.displayFieldTarget).on('input', this,this.displayFieldChange.bind(this));
 
-    this.pluginMainEl = this.fieldTarget
+    this.pluginMainEl = this.displayFieldTarget
     this.plugin = $(this.pluginMainEl).data('daterangepicker') // weird
 
     // Init time zone select
@@ -113,7 +171,6 @@ export default class extends Controller {
       $(this.timeZoneSelect).on('change.select2', function(event) {
         const currentTimeZoneEl = self.currentTimeZoneWrapperTarget.querySelector('a')
         const {value} = event.target
-
         $(self.timeZoneFieldTarget).val(value)
         $(currentTimeZoneEl).text(value)
 
@@ -126,7 +183,6 @@ export default class extends Controller {
         } else {
           // deselect any selected button
           $('.time-zone-button').removeClass('button').addClass('button-alternative')
-
           selectedOptionTimeZoneButton.text(value)
           selectedOptionTimeZoneButton.attr('data-value', value).removeAttr('hidden')
           selectedOptionTimeZoneButton.removeClass(['hidden', 'button-alternative']).addClass('button')
@@ -139,10 +195,8 @@ export default class extends Controller {
 
   teardownPluginInstance() {
     if (this.plugin === undefined) { return }
-
     $(this.pluginMainEl).off('apply.daterangepicker')
     $(this.pluginMainEl).off('cancel.daterangepicker')
-
     // revert to original markup, remove any event listeners
     this.plugin.remove()
 

data/lib/bullet_train/fields/version.rb

@@ -1,5 +1,5 @@
 module BulletTrain
   module Fields
-    VERSION = "1.3.1"
+    VERSION = "1.3.3"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bullet_train-fields
 version: !ruby/object:Gem::Version
-  version: 1.3.1
+  version: 1.3.3
 platform: ruby
 authors:
 - Andrew Culver
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-08-16 00:00:00.000000000 Z
+date: 2023-08-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: standard