Class: AddressesController

Inherits:
CrmController show all
Includes:
Controllers::Destroyable, CrmFormHelper
Defined in:
app/controllers/addresses_controller.rb

Overview

Controller for managing addresses.

Constant Summary

Constants included from Controllers::ReferenceFindable

Controllers::ReferenceFindable::ID_EMBEDDED_PATTERNS

Constants included from Controllers::AnalyticsEvents

Controllers::AnalyticsEvents::MAX_QUEUED_EVENTS, Controllers::AnalyticsEvents::SESSION_KEY

Constants included from Controllers::ErrorRendering

Controllers::ErrorRendering::NON_CONTENT_PATH_PREFIXES

Instance Method Summary collapse

Methods included from CrmFormHelper

#blocking_submit_button, #boolean_select, #datalist, #edit_button, #form_style_attribute_display, #opportunity_local_sales_rep_input, #sales_support_rep_input, #submit_cancel, #technical_rep_input, #technical_rep_sec_input, #yes_no_blank_boolean_collection_for_select, #yes_no_boolean_collection_for_select

Methods included from Controllers::Destroyable

#perform_destroy

Methods inherited from CrmController

#access_denied, #context_id, #context_object, #crm_home_path, #current_ability, #default_url_options, #download_temp, #get_tempfile_path_for_download, #init_status_job_collector, #initialize_crm_lazy_chunks, #persist_enqueued_status_jobs, #record_not_found, #redirect_to_job_or_fallback, #render_edit_action, #set_context, #set_download_path, #stash_file_for_temp_download, #sync_admin_presence_cookie, #touch_employee_last_seen

Methods inherited from ApplicationController

#account_impersonated?, #add_to_flash, #after_sign_in_path_for, #bypass_forgery_protection?, #chat_enabled?, #cloudflare_cleared?, #default_catalog, #default_url_options, #enable_turbo_frames, #find_publication, #fix_invalid_accept_header, #init_js_utils, #is_globals_call?, #layout_by_resource, #locale_store, #redirect_to, #require_employee_for_crm, #set_base_host, #set_real_ip, #set_report_errors_for, #should_render_layout?, #skip_layout_for_turbo_frame?, #stamp_impersonation_context, #tab_frame_breakout_request?, #warmlyyours_canada_ip?, #warmlyyours_ip?, #y

Methods included from Controllers::ReturnPathHandling

#check_for_return_path, #redirect_to_return_path_or_default

Methods included from Controllers::AnalyticsEvents

#consume_queued_analytics_events, #registration_lead_type, #track_event

Methods included from Controllers::DeviceDetection

#device_detector, #is_ie?

Methods included from Controllers::SubdomainDetection

#is_crm_request?, #is_www_request?, #json_request?

Methods included from Controllers::TurboSafeRedirect

#redirect_to

Methods included from Controllers::TrackingDetection

#bot_request?, #gdpr_country?, #gdpr_country_data, #prevent_bots, #set_tracking_cookie, #track_visitor?

Methods included from Controllers::AcceleratedFileSending

#send_file_accelerated, #send_upload_accelerated

Methods included from Controllers::ErrorRendering

#excp_string, #mail_to_for_error_reporting, #render_400, #render_404, #render_406, #render_410, #render_500, #render_invalid_authenticity_token, #render_ip_spoof_error, #render_unpermitted_parameters, #safe_referer_or_fallback

Methods included from Controllers::TurnstileVerification

#load_turnstile_script_tag, #turnstile_lazy_widget, #turnstile_script_tag, #turnstile_widget, #validate_turnstile!

Methods included from Controllers::CloudflareCaching

edge_cached, #edge_cached_action?, #reset_cloudflare_cache, #set_cloudflare_cache, #skip_edge_cache!, #skip_session

Methods included from Controllers::Webpackable

#preload_webpack_fonts, #webpack_css_include, #webpack_css_url, #webpack_js_include, #wpd_is_running?

Methods included from Controllers::Localizable

#cloudflare_country_locale, #determine_request_locale, #geocoder_locale, #guest_user_locale_check, #locale_optional_www_auth_path?, #param_locale, #set_locale, #set_request_locale, #skip_localization?, #warmlyyours_ip_locale

Methods included from Controllers::Authenticable

#access_denied, #authenticate_account, #authenticate_account!, #authenticate_account_from_login_token!, #check_is_a_manager, #check_is_a_sales_manager, #check_is_an_admin, #check_is_an_employee, #check_party, #clear_mismatched_guest_user, #create_guest_user, #credentials?, #current_or_guest_user, #current_or_guest_user_id_read_only, #current_user, #devise_mapping, #fully_logged_in?, #generate_bot_id, #guest_user, #identifiable?, #init_current_user, #initialize_guest, #load_context_user, #logging_in, #resource, #resource_name, #restrict_access_for_non_employees, #scrubbed_request_path, #user_object, #warn_on_session_guest_id_leak

Methods included from UrlsHelper

#catalog_breadcrumb_links, #catalog_link, #catalog_link_for_product_line, #catalog_link_for_sku, #cms_link, #delocalized_path, #path_to_sales_product_sku, #path_to_sales_product_sku_for_product_line, #path_to_sales_product_sku_for_product_line_slug, #product_line_from_catalog_link, #protocol_neutral_url, #sanitize_external_url, #valid_external_url?

Instance Method Details

#city_lookup ⇒ Object

Look up cities by name.



140
141
142
143
144
145
146
147
148
 
# File 'app/controllers/addresses_controller.rb', line 140

def city_lookup
  q = params[:q]
  page = params[:page] || 1
  per_page = params[:per_page] || 10
  @pagy, @results = pagy(City.where('city_name ILIKE ?', "#{q}%").select('DISTINCT city_name'), page: page, limit: per_page)
  total_entries = @pagy.count
  results_array = @results.map { |e| { id: e.city_name, text: e.city_name } }
  render json: { results: results_array, total: total_entries }
end

#create ⇒ Object

Create a new address.



70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'app/controllers/addresses_controller.rb', line 70

def create
  result = Address::Creator.new.process(params[:address], context_object)
  if result.saved?
    add_to_flash(result.autocorrect_message, :warning) if result.autocorrect_message.present?
    if result.address.party&.addresses&.one? && result.address.country_iso3 != result.address.party&.catalog&.country_iso3 # deal with suppliers here too
      redirect_to edit_catalog_customer_path(result.address.party, error: "Customer's first address country does not match catalog country, please update the catalog!",
                                                                   return_path: @return_path || polymorphic_url([result.address.party, :addresses]))
    else
      redirect_to_return_path_or_default(party_addresses_url(result.address) || root_path)
    end
  else
    @address = result.address
    render :new, status: :unprocessable_content
  end
end

#destroy ⇒ Object

Delete an address.



106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
 
# File 'app/controllers/addresses_controller.rb', line 106

def destroy
  @address.party
  if @address.ok_to_delete?
    @address.destroy
    flash[:info] = 'Address deleted'
  else
    flash[:error] = self.class.helpers.raw("Address cannot be deleted because it is referenced by : #{render_to_string(partial: 'dependents')}")
  end
  return_link_default = begin
    polymorphic_url([@address.party, :addresses])
  rescue StandardError
    nil
  end
  return_link_default ||= root_path
  redirect_to_return_path_or_default return_link_default
end

#disassociate_party ⇒ Object

Disassociate an address from its party.



124
125
126
127
128
129
130
131
132
133
134
135
136
137
 
# File 'app/controllers/addresses_controller.rb', line 124

def disassociate_party
  previous_party = @address.party
  result = @address.update(party_id: nil)
  if result
    flash[:info] = 'Address was archived'
  else
    flash[:error] = "Address could not be archived, #{@address.errors_to_s}"
  end
  if previous_party.nil?
    redirect_to_return_path_or_default employee_dashboard_path(@context_user)
  else
    redirect_to_return_path_or_default polymorphic_url([previous_party, :addresses])
  end
end

#edit ⇒ Object

Display address for editing.



61
62
63
64
65
66
67
 
# File 'app/controllers/addresses_controller.rb', line 61

def edit
  @address_form_path = @address
  check_freight_fields
  return unless @address.editing_locked?

  add_to_flash('Address is linked to at least one locked order and can only be partially modified. Managers can edit these, but please be careful and aware that a locked order may be affected by your changes!', :error, now: true)
end

#edit_service_area ⇒ Object

Display service area editing form.



87
88
89
 
# File 'app/controllers/addresses_controller.rb', line 87

def edit_service_area
  @address_form_path = @address
end

#index ⇒ Object

List all addresses for the context object.



11
12
13
14
15
16
17
18
19
 
# File 'app/controllers/addresses_controller.rb', line 11

def index
  @addresses = []
  @addresses << context_object.billing_address if context_object.respond_to?(:billing_address)
  @addresses += context_object.addresses
  @addresses = @addresses.uniq.compact
  @address = @context_object.addresses.new
  @address_form_path = [@context_object, @address]
  render layout: should_render_layout?
end

#new ⇒ Object

Initialize a new address form.



36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
 
# File 'app/controllers/addresses_controller.rb', line 36

def new
  if context_object.nil?
    @address = Address.new(params[:address] || { address_type: 'residential' }) # start off as residential
  else
    @address = context_object.addresses.new(params[:address] || { address_type: 'residential' }) # start off as residential
    @address.country_iso3 ||= begin
      context_object.store.country_iso3
    rescue StandardError
      nil?
    end
    if params[:address].blank?
      first_address = (@contact.try(:first_address) or @customer.try(:first_address))
      unless first_address.nil?
        @address.country_iso3 = first_address.country_iso3
        @address.state_code = first_address.state_code
        @address.zip = first_address.zip
        @address.city = first_address.city
      end
      @address.is_residential = false if @address.party&.customer&.is_organization?
    end
  end
  @hide_new_address_form = false
end

#postal_code_lookup ⇒ Object

Look up postal codes.



151
152
153
154
155
156
157
158
159
160
161
162
163
164
 
# File 'app/controllers/addresses_controller.rb', line 151

def postal_code_lookup
  q = params[:q]
  params[:page] ||= 1
  params[:per_page] ||= 10
  @results = PostalCode.joins(:cities).where('postal_codes.code ILIKE ?', "#{q}%").select("DISTINCT postal_codes.code as code, (cities.city_name || ', ' || postal_codes.state_code || ' ' || postal_codes.code) as locality")
  hsh_result = TomSelect.format_json_results(self, @results, params[:page], params[:per_page], :code, :locality)

  if params[:canadian_partial_allowed] && q =~ /^([a-z]\d[a-z])/i # Canadian postal code can be first 3 letters too
    val = q.first(3).upcase
    hsh_result[:results] ||= []
    hsh_result[:results].insert(0, { id: val, text: "#{val}*" })
  end
  render json: hsh_result
end

#show ⇒ Object

Redirect to edit action.

Shallow routes register GET /addresses/:id and nested routes register GET …/addresses/:id
but CRM flows always use #edit. Redirect so links and prefetch never hit ActionNotFound.



25
26
27
28
29
30
31
32
33
 
# File 'app/controllers/addresses_controller.rb', line 25

def show
  redirect_to(
    if params[:supplier_id].present?
      edit_supplier_address_path(params[:supplier_id], @address, request.query_parameters)
    else
      edit_address_path(@address, request.query_parameters)
    end
  )
end

#update ⇒ Object

Update an address.



92
93
94
95
96
97
98
99
100
101
102
103
 
# File 'app/controllers/addresses_controller.rb', line 92

def update
  result = Address::Updater.new.process(params[:id], params[:address])
  if result.saved?
    add_to_flash(result.autocorrect_message, :warning) if result.autocorrect_message.present?
    return_path = @return_path || party_addresses_url(result.address) || root_path
    redirect_to return_path
  else
    @address = result.address
    check_freight_fields
    render :edit, status: :unprocessable_content
  end
end