bullet_train-fields 1.3.21 → 1.3.22

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b7a0d3f08265c7e50f763434c57c88f284be710d7d63ce0cc8fbaff886311db9
-  data.tar.gz: b035e5ff82398aa88f30b757516b6c03ac31d01256b88c24c938dec2638c0ffb
+  metadata.gz: c547b13d9d1ff85a1cf3eea7e65f028285a26b65c8df77cddd30244fffd4934d
+  data.tar.gz: 5070d18444d36f773334b04460e506c5196f8d30f9832a782f6b3221368b0c35
 SHA512:
-  metadata.gz: 85e68bcc552bd519e3f6b0d6792109a3e3d2602b943aa29e0806f4b6ef777a6eb371fae067e9e8d8f0feff2cf1cf67353dcf34751900aa6d9965d493f838b862
-  data.tar.gz: a539896e8d1deabf39906b9e385521975a4816a6a4b3afbbdc058489c4ebf0793a2074f5e4a56ab5e94e3f37d400cccd8324ee25e0c2c6c80b15ab74771cc676
+  metadata.gz: 3fbe6e3df3014fe0ae7e5d61ae88643d7c5d7ea4c819f4617b1fb1ee4e735b0b9c38ce111eacff30b14414eb8dd5ca2f4f562929571f9ad8aadaf31e43b7507d
+  data.tar.gz: d4edcea75f716cab08849f03414381c6a29b03a5350df76bf5af4717fc0a01862f0cd6b7278e39e9850f7990dfdf44d28ba85a249d7018b0956d6439c03e285c

data/app/helpers/fields/address_field_helper.rb

@@ -0,0 +1,127 @@
+module Fields::AddressFieldHelper
+  def populate_country_options
+    ([Addresses::Country.find_by(name: "United States"), Addresses::Country.find_by(name: "Canada")] + Addresses::Country.all).map { |country| [country.name, country.id] }.uniq
+  end
+
+  def populate_region_options(address_form)
+    return [] if address_form.object.country_id.nil?
+    Addresses::Region.where(country_id: address_form.object.country_id).map { |region| [region.name, region.id] }
+  end
+
+  def admin_division_label_for(address_form)
+    # using country_id because it's fastest, even if this case statement is hard to read
+    admin_divisions_key = case address_form.object.country_id
+    when 233, 31, 142, 239, 101
+      :states
+    when 39
+      :provinces_territories
+    when 109
+      :prefectures
+    when 107, 45, 116, 182, 207, 219, 230, 156, 204
+      :provinces
+    when 14
+      :states_territories
+    when 59
+      :regions
+    when 82, 15
+      :federal_states
+    when 75
+      :departments
+    when 105
+      :counties
+    when 214
+      :cantons
+    else
+      :default
+    end
+    path = [:addresses, :fields, :admin_divisions, admin_divisions_key]
+    t(path.compact.join("."))
+  end
+
+  def postal_code_label_for(address_form)
+    key = if address_form.object.country_id == 233
+      :zip_code
+    else
+      :postal_code
+    end
+    path = [:addresses, :fields, key, :label]
+    t(path.compact.join("."))
+  end
+
+  def address_formatted(address, one_line: false)
+    return "" if address.all_blank?
+
+    formatted = [
+      address.address_one,
+      address.address_two,
+      address_city_line_formatted(address),
+      address.country&.name&.upcase
+    ].reject(&:blank?)
+
+    if one_line
+      formatted.join(", ") # simplistic
+    else
+      simple_format(formatted.join("\n"))
+    end
+  end
+
+  def address_city_line_formatted(address)
+    country_iso2 = address.country&.iso2 # can be nil or empty
+    city = address.city
+    region = address.region&.name
+    postal_code = address.postal_code
+
+    # adapted from https://github.com/cainlevy/snail/blob/master/lib/snail.rb
+    # using iso2 property here because it's a port of what's used in snail gem
+    # will be cleaned up below if parts missing
+    formatted = case country_iso2
+    when "CN", "IN"
+      "#{city}, #{region}  #{postal_code}"
+    when "BR"
+      "#{postal_code} #{city}#{"-" unless city.nil? || city.empty? || region.nil? || region.empty?}#{region}"
+    when "MX", "SK"
+      "#{postal_code} #{city}, #{region}"
+    when "IT"
+      "#{postal_code} #{city} #{region}"
+    when "BY"
+      "#{postal_code} #{city}#{"-" unless city.nil? || city.empty? || region.nil? || region.empty?}#{region}"
+    when "US", "CA", "AU", nil, ""
+      "#{city} #{region}  #{postal_code}"
+    when "IL", "DK", "FI", "FR", "DE", "GR", "NO", "ES", "SE", "TR", "CY", "PT", "MK", "BA"
+      "#{postal_code} #{city}"
+    when "KW", "SY", "OM", "EE", "LU", "BE", "IS", "CH", "AT", "MD", "ME", "RS", "BG", "GE", "PL", "AM", "HR", "RO", "AZ"
+      "#{postal_code} #{city}"
+    when "NL"
+      "#{postal_code}  #{city}"
+    when "IE"
+      "#{city}, #{region}\n#{postal_code}"
+    when "GB", "RU", "UA", "JO", "LB", "IR", "SA", "NZ"
+      "#{city}  #{postal_code}" # Locally these may be on separate lines. The USPS prefers the city line above the country line, though.
+    when "EC"
+      "#{postal_code} #{city}"
+    when "HK", "IQ", "YE", "QA", "AL"
+      city.to_s
+    when "AE"
+      "#{postal_code}\n#{city}"
+    when "JP"
+      "#{city}, #{region}\n#{postal_code}"
+    when "EG", "ZA", "IM", "KZ", "HU"
+      "#{city}\n#{postal_code}"
+    when "LV"
+      "#{city}, LV-#{postal_code}".gsub(/LV-\s*$/, "") # undo if no postal code
+    when "LT"
+      "LT-#{postal_code} #{city}".gsub(/^LT-\s*/, "") # undo if no postal code
+    when "SI"
+      "SI-#{postal_code} #{city}".gsub(/^SI-\s*/, "") # undo if no postal code
+    when "CZ"
+      "#{postal_code} #{region}\n#{city}"
+    else
+      "#{city} #{region}  #{postal_code}"
+    end
+
+    # clean up separators when missing pieces
+    formatted.strip      # remove extra spaces and newlines before and after
+      .gsub(/^,\s*/, "") # remove extra comma from start
+      .gsub(/\s*,$/, "") # remove extra comma from end
+  end
+end

data/app/helpers/refresh_fields_helper.rb

@@ -0,0 +1,30 @@
+module RefreshFieldsHelper
+  def accept_query_string_override_for(form, method)
+    field_name = form.field_name(method)
+
+    new_value = new_value_from_query_string(field_name)
+    return if new_value.nil?
+
+    form.object[method] = new_value
+  end
+
+  private
+
+  def new_value_from_query_string(field_name)
+    params.dig(*params_dig_path_for_field_name(field_name))
+  end
+
+  def params_dig_path_for_field_name(field_name)
+    dig_path = []
+
+    nested_keys = Rack::Utils.parse_nested_query(field_name)
+
+    while !nested_keys.nil? && nested_keys.keys.size
+      key = nested_keys.keys.first
+      dig_path << key.to_sym
+      nested_keys = nested_keys[key]
+    end
+
+    dig_path
+  end
+end

data/app/javascript/controllers/dependable_controller.js

@@ -0,0 +1,24 @@
+import { Controller } from "@hotwired/stimulus"
+
+export default class extends Controller {
+  static values = {
+    dependentsSelector: String
+  }
+
+  updateDependents(event) {
+    if (!this.hasDependents) { return false }
+    
+    this.dependents.forEach((dependent) => {
+      dependent.dispatchEvent(new CustomEvent(`${this.identifier}:updated`, { detail: { event: event }, bubbles: true, cancelable: false }))
+    })
+  }
+  
+  get hasDependents() {
+    return (this.dependents.length > 0)
+  }
+  
+  get dependents() {
+    if (!this.dependentsSelectorValue) { return [] }
+    return document.querySelectorAll(this.dependentsSelectorValue)
+  }
+}

data/app/javascript/controllers/index.js

@@ -11,6 +11,8 @@ import FileItemController from './fields/file_item_controller'
 import PasswordController from './fields/password_controller'
 import PhoneController from './fields/phone_controller'
 import SuperSelectController from './fields/super_select_controller'
+import DependableController from './dependable_controller'
+import RefreshFieldsController from './refresh_fields_controller'
 
 export const controllerDefinitions = [
   [FieldController, 'fields/field_controller.js'],
@@ -24,6 +26,8 @@ export const controllerDefinitions = [
   [PasswordController, 'fields/password_controller.js'],
   [PhoneController, 'fields/phone_controller.js'],
   [SuperSelectController, 'fields/super_select_controller.js'],
+  [DependableController, 'dependable_controller.js'],
+  [RefreshFieldsController, 'refresh_fields_controller.js'],
 ].map(function(d) {
   const key = d[1]
   const controller = d[0]
@@ -45,4 +49,6 @@ export {
   PasswordController,
   PhoneController,
   SuperSelectController,
+  DependableController,
+  RefreshFieldsController,
 }

data/app/javascript/controllers/refresh_fields_controller.js

@@ -0,0 +1,68 @@
+import { Controller } from "@hotwired/stimulus"
+
+export default class extends Controller {
+  static targets = [ "field" ]
+  static values = {
+    valuesStore: { type: Object, default: {} },
+    loading: { type: Boolean, default: false }
+  }
+  static classes = [ "loading" ]
+  
+  updateFrameFromDependentField(event) {
+    const field = event?.detail?.event?.detail?.event?.target || // super select nests its original jQuery event, contains <select> target
+                  event?.detail?.event?.target || // dependable_controller will include the original event in detail
+                  event?.target // maybe it was fired straight from the field
+    
+    if (!field) { return }
+    
+    this.storeFieldValues()
+    
+    this.loadingValue = true
+    this.disableFieldInputWhileRefreshing()
+    
+    const frame = this.element
+    frame.src = this.constructNewUrlUpdatingField(field.name, field.value)
+  }
+  
+  finishFrameUpdate(event) {
+    if (event.target !== this.element) { return }
+    
+    this.restoreFieldValues()
+    this.loadingValue = false
+  }
+  
+  constructNewUrlUpdatingField(fieldName, fieldValue) {
+    const url = new URL(window.location.href)
+    url.searchParams.set(fieldName, fieldValue)
+    
+    return url.href
+  }
+  
+  disableFieldInputWhileRefreshing() {
+    this.fieldTargets.forEach(field => field.disabled = true )
+  }
+  
+  loadingValueChanged() {
+    if (!this.hasLoadingClass) { return }
+    this.element.classList.toggle(...this.loadingClasses, this.loadingValue)
+  }
+  
+  storeFieldValues() {
+    this.fieldTargets.forEach(field => {
+      let storeUpdate = {}
+      storeUpdate[field.name] = field.value
+      this.valuesStoreValue = Object.assign(this.valuesStoreValue, storeUpdate)
+    })
+  }
+  
+  restoreFieldValues() {
+    this.fieldTargets.forEach(field => {
+      const storedValue = this.valuesStoreValue[field.name]
+      if (storedValue === undefined) { return }
+      field.value = storedValue
+      field.dispatchEvent(new Event('change')) // ensures cascading effects, including super-select validating against valid options
+    })
+    
+    this.valuesStoreValue = {}
+  }
+}

data/lib/bullet_train/fields/version.rb

@@ -1,5 +1,5 @@
 module BulletTrain
   module Fields
-    VERSION = "1.3.21"
+    VERSION = "1.3.22"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bullet_train-fields
 version: !ruby/object:Gem::Version
-  version: 1.3.21
+  version: 1.3.22
 platform: ruby
 authors:
 - Andrew Culver
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-08-31 00:00:00.000000000 Z
+date: 2023-09-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: standard
@@ -99,11 +99,14 @@ files:
 - app/controllers/concerns/fields/date_support.rb
 - app/controllers/concerns/fields/options_support.rb
 - app/controllers/concerns/fields/super_select_support.rb
+- app/helpers/fields/address_field_helper.rb
 - app/helpers/fields/cloudinary_image_helper.rb
 - app/helpers/fields/html_editor_helper.rb
 - app/helpers/fields/phone_field_helper.rb
 - app/helpers/fields/trix_editor_helper.rb
 - app/helpers/fields_helper.rb
+- app/helpers/refresh_fields_helper.rb
+- app/javascript/controllers/dependable_controller.js
 - app/javascript/controllers/fields/button_toggle_controller.js
 - app/javascript/controllers/fields/cloudinary_image_controller.js
 - app/javascript/controllers/fields/color_picker_controller.js
@@ -116,6 +119,7 @@ files:
 - app/javascript/controllers/fields/phone_controller.js
 - app/javascript/controllers/fields/super_select_controller.js
 - app/javascript/controllers/index.js
+- app/javascript/controllers/refresh_fields_controller.js
 - app/javascript/index.js
 - app/javascript/trix_editor.js
 - config/routes.rb