Class: Spree::ShippingMethod

Inherits:
Base
  • Object
show all
Includes:
CalculatedAdjustments
Defined in:
app/models/spree/shipping_method.rb

Overview

Represents a means of having a shipment delivered, such as FedEx or UPS.

Constant Summary

DISPLAY =
ActiveSupport::Deprecation::DeprecatedObjectProxy.new(
  [:both, :front_end, :back_end],
  "Spree::ShippingMethod::DISPLAY is deprecated",
  Spree::Deprecation
)

Class Method Summary (collapse)

Instance Method Summary (collapse)

Methods included from CalculatedAdjustments

#calculator_type, #calculator_type=

Methods inherited from Base

display_includes, #initialize_preference_defaults, page, preference

Methods included from Preferences::Preferable

#default_preferences, #defined_preferences, #get_preference, #has_preference!, #has_preference?, #preference_default, #preference_type, #set_preference

Class Method Details

+ (ActiveRecord::Relation) available_for_address(address)

Returns shipping methods which are associated with zones matching the provided address

Parameters:

Returns:

  • (ActiveRecord::Relation)

    shipping methods which are associated with zones matching the provided address



70
71
72
# File 'app/models/spree/shipping_method.rb', line 70

def self.available_for_address(address)
  joins(:zones).merge(Zone.for_address(address))
end

+ (ActiveRecord::Relation) available_in_stock_location(stock_location)

Returns shipping methods which are available with the stock location or are marked available_to_all

Parameters:

Returns:

  • (ActiveRecord::Relation)

    shipping methods which are available with the stock location or are marked available_to_all



48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
# File 'app/models/spree/shipping_method.rb', line 48

def self.available_in_stock_location(stock_location)
  smsl_table = Spree::ShippingMethodStockLocation.arel_table

  # We are searching for either a matching entry in the stock location join
  # table or available_to_all being true.
  # We need to use an outer join otherwise a shipping method with no
  # associated stock locations will be filtered out of the results. In
  # rails 5 this will be easy using .left_join and .or, but for now we must
  # use arel to achieve this.
  arel_join =
    arel_table.join(smsl_table, Arel::Nodes::OuterJoin).
    on(arel_table[:id].eq(smsl_table[:shipping_method_id])).
    join_sources
  arel_condition =
    arel_table[:available_to_all].eq(true).or(smsl_table[:stock_location_id].eq(stock_location.id))

  joins(arel_join).where(arel_condition).distinct
end

+ (ActiveRecord::Relation) with_all_shipping_category_ids(shipping_category_ids)

Returns shipping methods which are associated with all of the provided shipping categories

Parameters:

  • shipping_category_ids (Array<Integer>)

    ids of desired shipping categories

Returns:

  • (ActiveRecord::Relation)

    shipping methods which are associated with all of the provided shipping categories



33
34
35
36
37
38
39
40
41
42
43
# File 'app/models/spree/shipping_method.rb', line 33

def self.with_all_shipping_category_ids(shipping_category_ids)
  # Some extra care is needed with the having clause to ensure we are
  # counting distinct records of the join table. Otherwise a join could
  # cause this to return incorrect results.
  join_table = Spree::ShippingMethodCategory.arel_table
  having = join_table[:id].count(true).eq(shipping_category_ids.count)
  joins(:shipping_method_categories).
    where(spree_shipping_method_categories: { shipping_category_id: shipping_category_ids }).
    group('spree_shipping_methods.id').
    having(having)
end

Instance Method Details

- (Object) build_tracking_url(tracking)



81
82
83
84
# File 'app/models/spree/shipping_method.rb', line 81

def build_tracking_url(tracking)
  return if tracking.blank? || tracking_url.blank?
  tracking_url.gsub(/:tracking/, ERB::Util.url_encode(tracking)) # :url_encode exists in 1.8.7 through 2.1.0
end

- (Object) display_on



86
87
88
89
90
91
92
# File 'app/models/spree/shipping_method.rb', line 86

def display_on
  if available_to_users?
    "both"
  else
    "back_end"
  end
end

- (Object) display_on=(value)



95
96
97
# File 'app/models/spree/shipping_method.rb', line 95

def display_on=(value)
  self.available_to_users = (value != "back_end")
end

- (Boolean) frontend?

Some shipping methods are only meant to be set via backend

Returns:

  • (Boolean)


101
102
103
# File 'app/models/spree/shipping_method.rb', line 101

def frontend?
  available_to_users?
end

- (Boolean) include?(address)

Returns:

  • (Boolean)


74
75
76
77
78
79
# File 'app/models/spree/shipping_method.rb', line 74

def include?(address)
  return false unless address
  zones.any? do |zone|
    zone.include?(address)
  end
end