Skip to content

armgit / spree

Public Imported from GitHub
0

Open Source Platform for DTC, B2B Commerce, Marketplaces & Omnichannel. REST APIs, TypeScript SDKs, and production-ready Next.js storefront. Self-host it. Own your data. No vendor lock-in. Zero platform fees.

Open source more address features (including quick checkout), add job for geocoding addresses

Łukasz Adamczyk12f8f03856fb
diff --git a/core/app/jobs/spree/addresses/geocode_address_job.rb b/core/app/jobs/spree/addresses/geocode_address_job.rb
new file mode 100644
index 0000000000..740dc6dee5
--- /dev/null
+++ b/core/app/jobs/spree/addresses/geocode_address_job.rb
@@ -0,0 +1,29 @@
+module Spree
+ module Addresses
+ class GeocodeAddressError < StandardError; end
+
+ class GeocodeAddressJob < BaseJob
+ queue_as Spree.queues.addresses
+
+ def perform(address_id)
+ address = Spree::Address.find(address_id)
+
+ coordinates = Geocoder.coordinates(
+ address.geocoder_address,
+ country: address.country_iso3
+ )
+
+ if coordinates.present?
+ address.update_columns(latitude: coordinates[0], longitude: coordinates[1], updated_at: Time.current)
+ else
+ # Unfortunately there is no way to get the error message from Geocoder,
+ # but the request is fully displayed in the server logs
+ Spree::ErrorHandler.call(
+ exception: GeocodeAddressError.new("Cannot geocode address #{address.id}"),
+ opts: { report_context: { address_id: address_id } }
+ )
+ end
+ end
+ end
+ end
+end
diff --git a/core/app/models/spree/address.rb b/core/app/models/spree/address.rb
index 8a0a5474aa..504c55efa9 100644
--- a/core/app/models/spree/address.rb
+++ b/core/app/models/spree/address.rb
@@ -34,6 +34,7 @@ module Spree
# those attributes depending of the logic of their applications
ADDRESS_FIELDS = %w(firstname lastname company address1 address2 city state zipcode country phone)
EXCLUDED_KEYS_FOR_COMPARISON = %w(id updated_at created_at deleted_at label user_id public_metadata private_metadata)
+ FIELDS_TO_NORMALIZE = %w(firstname lastname phone company address1 address2 city zipcode)
scope :not_deleted, -> { where(deleted_at: nil) }
@@ -41,13 +42,22 @@ module Spree
joins(:state).merge(Spree::State.where(name: state_name).or(Spree::State.where(abbr: state_name)))
}
+ scope :not_quick_checkout, -> { where(quick_checkout: false) }
+
belongs_to :country, class_name: 'Spree::Country'
belongs_to :state, class_name: 'Spree::State', optional: true
belongs_to :user, class_name: Spree.user_class.name, optional: true, touch: true
has_many :shipments, inverse_of: :address
+ after_initialize :set_default_values, if: -> { new_record? && user.present? }
+
before_validation :clear_invalid_state_entities, if: -> { country.present? }, on: :update
+ before_validation :remove_emoji_and_normalize
+
+ after_create :set_user_attributes, if: -> { user.present? }
+
+ after_commit :async_geocode
with_options presence: true do
validates :firstname, :lastname, if: :require_name?
@@ -153,15 +163,19 @@ module Spree
end
def require_zipcode?
- country ? country.zipcode_required? : true
+ !quick_checkout && (country ? country.zipcode_required? : true)
end
def require_name?
- true
+ !quick_checkout
+ end
+
+ def require_company?
+ false
end
def require_street?
- true
+ !quick_checkout
end
def show_company_address_field?
@@ -192,8 +206,26 @@ module Spree
end
end
+ def async_geocode
+ Spree::Addresses::GeocodeAddressJob.perform_later(id) if should_geocode?
+ end
+
+ def geocoder_address
+ @geocoder_address ||= [street, city, state_text, country.to_s].compact.map(&:strip).join(', ')
+ end
+
private
+ def should_geocode?
+ saved_changes.key?(:address1) || saved_changes.key?(:city) || saved_changes.key?(:state_id) || saved_changes.key?(:country_id)
+ end
+
+ def set_default_values
+ self.firstname ||= user.first_name
+ self.lastname ||= user.last_name
+ self.phone ||= user.phone
+ end
+
def clear_state
self.state = nil
end
@@ -210,6 +242,26 @@ module Spree
end
end
+ def remove_emoji_and_normalize
+ attributes_to_normalize = attributes.slice(*FIELDS_TO_NORMALIZE)
+ normalized_attributes = attributes_to_normalize.compact_blank.deep_transform_values do |value|
+ NormalizeString.remove_emoji_and_normalize(value.to_s).strip
+ end
+
+ normalized_attributes.transform_keys! { |key| key.gsub('original_', '') } if defined?(Spree::Security::Addresses)
+
+ assign_attributes(normalized_attributes)
+ end
+
+ def set_user_attributes
+ if user.name.blank?
+ user.first_name = firstname
+ user.last_name = lastname
+ end
+
+ user.save! if user.changed?
+ end
+
def state_validate
# Skip state validation without country (also required)
# or when disabled by preference
@@ -269,7 +321,7 @@ module Spree
end
def assign_new_default_address_to_user_scope
- user.addresses.reorder(created_at: :desc)
+ user.addresses.not_quick_checkout.reorder(created_at: :desc)
end
end
end
diff --git a/core/lib/normalize_string.rb b/core/lib/normalize_string.rb
new file mode 100644
index 0000000000..23bf6ae26d
--- /dev/null
+++ b/core/lib/normalize_string.rb
@@ -0,0 +1,18 @@
+require 'any_ascii'
+
+module NormalizeString
+ def self.normalize(string)
+ return unless string.present?
+
+ AnyAscii.transliterate(string)
+ end
+
+ def self.remove_emoji_and_normalize(string, keep_emoji_when_empty: false)
+ return unless string.present?
+
+ result = AnyAscii.transliterate(string.gsub(/\p{So}/, ''))
+ return result if result.present? || !keep_emoji_when_empty
+
+ normalize(string)
+ end
+end
diff --git a/core/lib/spree/core.rb b/core/lib/spree/core.rb
index f023bc5c71..511884afcf 100644
--- a/core/lib/spree/core.rb
+++ b/core/lib/spree/core.rb
@@ -100,7 +100,8 @@ module Spree
stock_location_stock_items: :default,
coupon_codes: :default,
webhooks: :default,
- themes: :default
+ themes: :default,
+ addresses: :addresses
)
end
diff --git a/core/lib/spree/core/configuration.rb b/core/lib/spree/core/configuration.rb
index ffe5461778..cb2748b27f 100644
--- a/core/lib/spree/core/configuration.rb
+++ b/core/lib/spree/core/configuration.rb
@@ -25,7 +25,7 @@ module Spree
class Configuration < Preferences::RuntimeConfiguration
# Alphabetized to more easily lookup particular preferences
preference :address_requires_state, :boolean, default: true, deprecated: true # should state/state_name be required
- preference :address_requires_phone, :boolean, default: true # Determines whether we require phone in address
+ preference :address_requires_phone, :boolean, default: false # Determines whether we require phone in address
preference :allow_checkout_on_gateway_error, :boolean, default: false
preference :allow_empty_price_amount, :boolean, default: false
preference :allow_guest_checkout, :boolean, default: true # this is only used in the rails frontend, and is not implemented in API
diff --git a/core/lib/spree_core.rb b/core/lib/spree_core.rb
index 370fdf4bad..81fde8f250 100644
--- a/core/lib/spree_core.rb
+++ b/core/lib/spree_core.rb
@@ -1,4 +1,5 @@
require 'friendly_id/paranoia'
require 'mobility/plugins/store_based_fallbacks'
+require 'normalize_string'
require 'spree/core'
diff --git a/core/spree_core.gemspec b/core/spree_core.gemspec
index 1e4c1d498f..ee4f70666c 100644
--- a/core/spree_core.gemspec
+++ b/core/spree_core.gemspec
@@ -60,4 +60,5 @@ Gem::Specification.new do |s|
s.add_dependency 'request_store', '~> 1.7'
s.add_dependency 'wannabe_bool'
s.add_dependency 'geared_pagination'
+ s.add_dependency 'any_ascii', '~> 0.3.2'
end