Update address form and refactored

Added translations

Author: rahulsingh321

Gemfile

@@ -21,6 +21,7 @@ gem 'pg', '~> 1.0', require: false if dbs.match?(/all|postgres/)
 gem 'fast_sqlite', require: false if dbs.match?(/all|sqlite/)
 gem 'sqlite3', '>= 2.1', require: false if dbs.match?(/all|sqlite/)
 
+
 gem 'database_cleaner', '~> 2.0', require: false
 gem 'rspec-activemodel-mocks', '~> 1.1', require: false
 gem 'rspec-rails', '~> 6.0.3', require: false

api/lib/spree/api_configuration.rb

@@ -125,10 +125,10 @@ def promotion_attributes=(value)
     deprecate "promotion_attributes=" => promotion_attributes_deprecation_message, deprecator: Spree.deprecator
 
     preference :store_attributes, :array, default: [
-      :id, :name, :url, :meta_description, :meta_keywords, :seo_title,
-      :mail_from_address, :default_currency, :code, :default, :available_locales,
-      :bcc_email, :code, :legal_name, :tax_id, :contact_phone,
-      :contact_email, :vat_id, :description, :address
+      :id, :name, :legal_name, :url, :meta_description, :meta_keywords, :seo_title,
+      :mail_from_address, :default_currency, :code, :default,
+      :bcc_email, :contact_phone, :contact_email, :tax_id, :vat_id, :description,
+      :address1, :address2, :city, :postal_code, :country_id, :state_id, :state_name, :available_locales
     ]
 
     preference :store_credit_history_attributes, :array, default: [

api/spec/requests/spree/api/stores_spec.rb

@@ -38,13 +38,19 @@ module Spree::Api
             "code" => store.code,
             "default" => true,
             "available_locales" => ["en"],
-            "legal_name": nil,
-            "tax_id": nil,
-            "contact_phone": nil,
-            "contact_email": nil,
-            "vat_id": nil,
-            "description": nil,
-            "address": nil
+            "legal_name" => nil,
+            "contact_phone" => nil,
+            "contact_email" => nil,
+            "description" => nil,
+            "tax_id" => nil,
+            "vat_id" => nil,
+            "address1" => nil,
+            "address2" => nil,
+            "city" => nil,
+            "postal_code" => nil,
+            "country_id" => nil,
+            "state_id" => nil,
+            "state_name" => nil
           },
           {
             "id" => non_default_store.id,
@@ -59,13 +65,19 @@ module Spree::Api
             "code" => non_default_store.code,
             "default" => false,
             "available_locales" => ["en"],
-            "legal_name": nil,
-            "tax_id": nil,
-            "contact_phone": nil,
-            "contact_email": nil,
-            "vat_id": nil,
-            "description": nil,
-            "address": nil
+            "legal_name" => nil,
+            "contact_phone" => nil,
+            "contact_email" => nil,
+            "description" => nil,
+            "tax_id" => nil,
+            "vat_id" => nil,
+            "address1" => nil,
+            "address2" => nil,
+            "city" => nil,
+            "postal_code" => nil,
+            "country_id" => nil,
+            "state_id" => nil,
+            "state_name" => nil
           }
         ])
       end
@@ -86,12 +98,18 @@ module Spree::Api
           "default" => true,
           "available_locales" => ["en"],
           "legal_name" => nil,
-          "tax_id" => nil,
           "contact_phone" => nil,
           "contact_email" => nil,
-          "vat_id" => nil,
           "description" => nil,
-          "address" => nil
+          "tax_id" => nil,
+          "vat_id" => nil,
+          "address1" => nil,
+          "address2" => nil,
+          "city" => nil,
+          "postal_code" => nil,
+          "country_id" => nil,
+          "state_id" => nil,
+          "state_name" => nil
         )
       end
 

backend/app/views/spree/admin/stores/_form.html.erb

@@ -1,4 +1,4 @@
-<div class="row">
+<div class="row js-addresses-form">
   <div class="col-12 col-md-6">
     <%= f.field_container :name do %>
       <%= f.label :name, class: 'required' %>
@@ -37,18 +37,18 @@
       <%= f.error_message_on :legal_name %>
     <% end %>
 
-    <%= f.field_container :tax_id do %>
-      <%= f.label :tax_id %>
-      <%= f.text_field :tax_id, class: 'fullwidth' %>
-      <%= f.error_message_on :tax_id %>
-    <% end %>
-
     <%= f.field_container :contact_phone do %>
       <%= f.label :contact_phone %>
       <%= f.phone_field :contact_phone, class: 'fullwidth' %>
       <%= f.error_message_on :contact_phone %>
     <% end %>
 
+    <%= f.field_container :tax_id do %>
+      <%= f.label :tax_id %>
+      <%= f.text_field :tax_id, class: 'fullwidth' %>
+      <%= f.error_message_on :tax_id %>
+    <% end %>
+
     <%= f.field_container :vat_id do %>
       <%= f.label :vat_id %>
       <%= f.text_field :vat_id, class: 'fullwidth' %>
@@ -116,39 +116,53 @@
 
     <%= f.field_container :description do %>
       <%= f.label :description %>
-      <%= f.text_area :description, class: 'fullwidth', style: 'height: 130px;' %>
+      <%= f.text_area :description, class: 'fullwidth', rows: 6 %>
       <%= f.error_message_on :description %>
     <% end %>
   </div>
 
   <div class="col-12">
-    <%= f.label :address, "Address" %>
+    <%= f.label :address %>
     <div class="row border mx-1 py-3 border-secondary rounded">
       <div class="col-md-6 mb-3">
-        <%= f.label :streetAddress, "Street Address", class: "form-label" %>
-        <%= text_field_tag 'store[address][streetAddress]', f.object.address&.dig('streetAddress'), class: 'form-control', placeholder: "Street Address" %>
+        <%= f.field_container :address1 do %>
+          <%= f.label :address1 %>
+          <%= f.text_field :address1, class: 'fullwidth' %>
+        <% end %>
       </div>
-
       <div class="col-md-6 mb-3">
-        <%= f.label :addressLocality, "City", class: "form-label" %>
-        <%= text_field_tag 'store[address][addressLocality]', f.object.address&.dig('addressLocality'), class: 'form-control', placeholder: "City" %>
+        <%= f.field_container :address2 do %>
+          <%= f.label :address2 %>
+          <%= f.text_field :address2, class: 'fullwidth' %>
+        <% end %>
       </div>
-
       <div class="col-md-6 mb-3">
-        <%= f.label :addressRegion, "Region", class: "form-label" %>
-        <%= text_field_tag 'store[address][addressRegion]', f.object.address&.dig('addressRegion'), class: 'form-control', placeholder: "Region" %>
+        <%= f.field_container :city do %>
+          <%= f.label :city %>
+          <%= f.text_field :city, class: 'fullwidth' %>
+        <% end %>
       </div>
-
-      <div class="mb-3 col-md-6">
-        <%= f.label :addressCountry, "Country", class: "form-label" %>
-        <%= select_tag 'store[address][addressCountry]',
-              options_from_collection_for_select(available_countries(restrict_to_zone: nil), :id, :name, f.object.address&.dig('addressCountry')),
-              class: 'form-control', placeholder: "Country" %>
+      <div class="col-md-6 mb-3">
+        <%= f.field_container :postal_code do %>
+          <%= f.label :postal_code %>
+          <%= f.text_field :postal_code, class: 'fullwidth' %>
+        <% end %>
+      </div>
+      <div class="col-md-6 mb-3">
+        <%= f.field_container :country_id do %>
+          <%= f.label :country_id %>
+          <span id="country"><%= f.collection_select :country_id, available_countries(restrict_to_zone: nil), :id, :name, { include_blank: true }, { class: 'custom-select js-country_id fullwidth' } %></span>
+        <% end %>
       </div>
-
       <div class="col-md-6 mb-3">
-        <%= f.label :postalCode, "Postal Code", class: "form-label" %>
-        <%= text_field_tag 'store[address][postalCode]', f.object.address&.dig('postalCode'), class: 'form-control', placeholder: "Postal Code" %>
+        <%= f.field_container :state do %>
+          <% country = f.object.country %>
+          <%= f.label :state_id %>
+          <span id="state" class="region">
+            <%= f.text_field :state_name, style: "display: none", class: 'fullwidth state_name js-state_name' %>
+            <%= f.collection_select :state_id, country ? country.states.sort : [], :id, :name, { include_blank: true }, {class: 'custom-select fullwidth js-state_id', style: "display: none" } %>
+          </span>
+        <% end %>
       </div>
     </div>
   </div>

core/app/models/spree/store.rb

@@ -15,6 +15,9 @@ class Store < Spree::Base
     has_many :store_shipping_methods, inverse_of: :store
     has_many :shipping_methods, through: :store_shipping_methods
 
+    belongs_to :state, class_name: 'Spree::State', optional: true
+    belongs_to :country, class_name: 'Spree::Country', optional: true
+
     has_many :orders, class_name: "Spree::Order"
 
     validates :code, presence: true, uniqueness: { allow_blank: true, case_sensitive: true }

core/config/locales/en.yml

@@ -350,18 +350,31 @@ en:
         quantity: Quantity
         variant: Variant
       spree/store:
+        address: Address
+        address1: Street Address
+        address2: Street Address (cont'd)
         available_locales: Locales Available in the Storefront
         bcc_email: BCC Email
         cart_tax_country_iso: Tax Country for Empty Carts
+        city: City
         code: Slug
+        contact_email: Contact Email
+        contact_phone: Contact Phone
+        country_id: Country
         default: Default
         default_currency: Default Currency
+        description: Store Description
+        legal_name: Legal Name
         mail_from_address: Mail From Address
         meta_description: Meta Description
         meta_keywords: Meta Keywords
         name: Site Name
+        postal_code: Postal Code
         seo_title: Seo Title
+        state_id: State
+        tax_id: Tax ID
         url: Site URL
+        vat_id: VAT ID
       spree/store_credit:
         amount: Amount
         amount_authorized: Amount Authorized

core/db/migrate/20250202173007_add_store_attributes_to_spree_stores.rb

@@ -1,11 +1,17 @@
 class AddStoreAttributesToSpreeStores < ActiveRecord::Migration[7.2]
   def change
     add_column :spree_stores, :legal_name, :string
-    add_column :spree_stores, :tax_id, :string
-    add_column :spree_stores, :address, :jsonb
     add_column :spree_stores, :contact_phone, :string
     add_column :spree_stores, :contact_email, :string
-    add_column :spree_stores, :vat_id, :string
     add_column :spree_stores, :description, :text
+    add_column :spree_stores, :vat_id, :string
+    add_column :spree_stores, :tax_id, :string
+    add_column :spree_stores, :address1, :string
+    add_column :spree_stores, :address2, :string
+    add_column :spree_stores, :city, :string
+    add_column :spree_stores, :postal_code, :string
+    add_column :spree_stores, :state_name, :string
+    add_reference :spree_stores, :country, foreign_key: { to_table: :spree_countries }, index: true
+    add_reference :spree_stores, :state, foreign_key: { to_table: :spree_states }, index: true
   end
 end

core/lib/spree/permitted_attributes.rb

@@ -110,11 +110,12 @@ module PermittedAttributes
       :quantity, :stock_item, :stock_item_id, :originator, :action
     ]
 
-    @@store_attributes = [:name, :url, :seo_title, :meta_keywords,
+    @@store_attributes = [:name, :legal_name, :url, :seo_title, :meta_keywords,
                           :meta_description, :default_currency,
                           :mail_from_address, :cart_tax_country_iso,
-                          :bcc_email, :code, :legal_name, :tax_id, :contact_phone,
-                          :contact_email, :vat_id, :description, address: {}]
+                          :bcc_email, :contact_email, :contact_phone, :code,
+                          :tax_id, :vat_id, :description, :address1, :address2,
+                          :city, :postal_code, :country_id, :state_id, :state_name]
 
     @@taxonomy_attributes = [:name]