Class: Spree::AppConfiguration

Inherits:
Preferences::Configuration show all
Includes:
Core::EnvironmentExtension
Defined in:
lib/spree/app_configuration.rb

Instance Attribute Summary collapse

Attributes inherited from Preferences::Configuration

#load_defaults_called, #loaded_defaults, #preference_store

Instance Method Summary collapse

Methods inherited from Preferences::Configuration

#check_load_defaults_called, class_name_attribute, #configure, inherited, #initialize, #load_defaults, preference, #reset, #set, #use_legacy_db_preferences!, #use_static_preferences!, versioned_preference

Methods included from Preferences::Preferable

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

Constructor Details

This class inherits a constructor from Spree::Preferences::Configuration

Instance Attribute Details

#add_payment_sources_to_wallet_class ⇒ Class

Allows providing your own class for adding payment sources to a user’s “wallet” after an order moves to the complete state.

Returns:

  • (Class) —

    a class with the same public interfaces as Spree::Wallet::AddPaymentSourcesToWallet.



459
 
# File 'lib/spree/app_configuration.rb', line 459

class_name_attribute :add_payment_sources_to_wallet_class, default: 'Spree::Wallet::AddPaymentSourcesToWallet'

#address_requires_phone ⇒ Boolean

Returns should phone number be required (default: true).

Returns:

  • (Boolean) —

    should phone number be required (default: true)



34
 
# File 'lib/spree/app_configuration.rb', line 34

preference :address_requires_phone, :boolean, default: true

#address_requires_state ⇒ Boolean

Returns should state/state_name be required (default: true).

Returns:

  • (Boolean) —

    should state/state_name be required (default: true)



38
 
# File 'lib/spree/app_configuration.rb', line 38

preference :address_requires_state, :boolean, default: true

#admin_interface_logo ⇒ String

Returns URL of logo used in admin (default: ‘logo/solidus.svg’).

Returns:

  • (String) —

    URL of logo used in admin (default: ‘logo/solidus.svg’)



42
 
# File 'lib/spree/app_configuration.rb', line 42

preference :admin_interface_logo, :string, default: 'logo/solidus.svg'

#admin_products_per_page ⇒ Integer

Returns Number of products to display in admin (default: 10).

Returns:

  • (Integer) —

    Number of products to display in admin (default: 10)



46
 
# File 'lib/spree/app_configuration.rb', line 46

preference :admin_products_per_page, :integer, default: 10

#admin_variants_per_page ⇒ Integer

Returns Number of variants to display in admin (default: 20).

Returns:

  • (Integer) —

    Number of variants to display in admin (default: 20)



50
 
# File 'lib/spree/app_configuration.rb', line 50

preference :admin_variants_per_page, :integer, default: 20

#admin_vat_country_iso ⇒ String?

Set this if you want to enter prices in the backend including value added tax.

Returns:

  • (String, nil) —

    Two-letter ISO code of that Country for which prices are entered in the backend (default: nil)



56
 
# File 'lib/spree/app_configuration.rb', line 56

preference :admin_vat_country_iso, :string, default: nil

#allow_checkout_on_gateway_error ⇒ Boolean

Returns Allow checkout to complete after a failed payment (default: false).

Returns:

  • (Boolean) —

    Allow checkout to complete after a failed payment (default: false)



60
 
# File 'lib/spree/app_configuration.rb', line 60

preference :allow_checkout_on_gateway_error, :boolean, default: false

#allow_guest_checkout ⇒ Boolean

Returns When false, customers must create an account to complete an order (default: true).

Returns:

  • (Boolean) —

    When false, customers must create an account to complete an order (default: true)



64
 
# File 'lib/spree/app_configuration.rb', line 64

preference :allow_guest_checkout, :boolean, default: true

#allow_return_item_amount_editing ⇒ Boolean

Returns Determines whether an admin is allowed to change a return item’s pre-calculated amount (default: false).

Returns:

  • (Boolean) —

    Determines whether an admin is allowed to change a return item’s pre-calculated amount (default: false)



72
 
# File 'lib/spree/app_configuration.rb', line 72

preference :allow_return_item_amount_editing, :boolean, default: false

#allowed_image_mime_types ⇒ Array

Defines which MIME types are allowed for images ‘%w(image/jpeg image/jpg image/png image/gif).freeze` is the default.

Returns:

  • (Array) 


528
 
# File 'lib/spree/app_configuration.rb', line 528

class_name_attribute :allowed_image_mime_types, default: %w(image/jpeg image/jpg image/png image/gif).freeze

#alternative_billing_phone ⇒ Boolean

Returns Request an extra phone number for bill address (default: false).

Returns:

  • (Boolean) —

    Request an extra phone number for bill address (default: false)



76
 
# File 'lib/spree/app_configuration.rb', line 76

preference :alternative_billing_phone, :boolean, default: false

#alternative_shipping_phone ⇒ Boolean

Returns Request an extra phone number for shipping address (default: false).

Returns:

  • (Boolean) —

    Request an extra phone number for shipping address (default: false)



80
 
# File 'lib/spree/app_configuration.rb', line 80

preference :alternative_shipping_phone, :boolean, default: false

#always_put_site_name_in_title ⇒ Boolean

Returns When true, site name is always appended to titles on the frontend (default: true).

Returns:

  • (Boolean) —

    When true, site name is always appended to titles on the frontend (default: true)



84
 
# File 'lib/spree/app_configuration.rb', line 84

preference :always_put_site_name_in_title, :boolean, default: true

#auto_capture ⇒ Boolean

Note:

Setting this to true is not recommended. Performing an authorize and later capture has far superior error handing. VISA and MasterCard also require that shipments are sent within a certain time of the card being charged.

Returns Automatically capture the credit card (as opposed to just authorize and capture later) (default: false).

Returns:

  • (Boolean) —

    Automatically capture the credit card (as opposed to just authorize and capture later) (default: false)



92
 
# File 'lib/spree/app_configuration.rb', line 92

preference :auto_capture, :boolean, default: false

#auto_capture_exchanges ⇒ Boolean

Returns Automatically capture the credit card (as opposed to just authorize and capture later) (default: false).

Returns:

  • (Boolean) —

    Automatically capture the credit card (as opposed to just authorize and capture later) (default: false)



96
 
# File 'lib/spree/app_configuration.rb', line 96

preference :auto_capture_exchanges, :boolean, default: false

#automatic_default_address ⇒ Boolean

The default value of true preserves existing backwards compatible feature of treating the most recently used address in checkout as the user’s default address. Setting to false means that the user should manage their own default via some custom UI that uses AddressBookController.

Returns:

  • (Boolean) —

    Whether use of an address in checkout marks it as user’s default



104
 
# File 'lib/spree/app_configuration.rb', line 104

preference :automatic_default_address, :boolean, default: true

#available_currencies ⇒ Array

Returns An array of available currencies from Money::Currency.all.

Returns:

  • (Array) —

    An array of available currencies from Money::Currency.all



315
 
# File 'lib/spree/app_configuration.rb', line 315

attr_writer :available_currencies

#billing_address_required ⇒ Boolean

Controls whether billing address is required or not in the checkout process by default, can be overridden at order level. (default: false)

Returns:

  • (Boolean) 


111
 
# File 'lib/spree/app_configuration.rb', line 111

preference :billing_address_required, :boolean, default: false

#brand_selector_class ⇒ Class

Allows finding brand for product.

Returns:

  • (Class) —

    a class with the same public interfaces as Spree::TaxonBrandSelector.



565
 
# File 'lib/spree/app_configuration.rb', line 565

class_name_attribute :brand_selector_class, default: 'Spree::TaxonBrandSelector'

#can_restrict_stock_management ⇒ Boolean

Returns Indicates if stock management can be restricted by location.

Returns:

  • (Boolean) —

    Indicates if stock management can be restricted by location



115
 
# File 'lib/spree/app_configuration.rb', line 115

preference :can_restrict_stock_management, :boolean, default: false

#carton_shipped_email_class ⇒ ActionMailer::Base

Allows providing your own Mailer for shipped cartons.

Returns:

  • (ActionMailer::Base) —

    an object that responds to “shipped_email” (e.g. an ActionMailer with a “shipped_email” method) with the same signature as Spree::CartonMailer.shipped_email.



403
 
# File 'lib/spree/app_configuration.rb', line 403

class_name_attribute :carton_shipped_email_class, default: 'Spree::CartonMailer'

#checkout_zone ⇒ String

Returns Name of a Zone, which limits available countries to those included in that zone. (default: nil).

Returns:

  • (String) —

    Name of a Zone, which limits available countries to those included in that zone. (default: nil)



119
 
# File 'lib/spree/app_configuration.rb', line 119

preference :checkout_zone, :string, default: nil

#company ⇒ Boolean

Returns Request company field for billing and shipping addresses. (default: false).

Returns:

  • (Boolean) —

    Request company field for billing and shipping addresses. (default: false)



123
 
# File 'lib/spree/app_configuration.rb', line 123

preference :company, :boolean, default: false

#completable_order_created_cutoff ⇒ Integer

Returns the number of days to look back for updated orders which get returned to the user as last completed.

Returns:

  • (Integer) —

    the number of days to look back for updated orders which get returned to the user as last completed



127
 
# File 'lib/spree/app_configuration.rb', line 127

preference :completable_order_created_cutoff_days, :integer, default: nil

#countries_that_use_nested_subregions ⇒ Array

of the default subregions that come with Carmen. Will be used on store creation to ensure the correct states are generated, and when running the states regenerate rake task. (default: [‘IT’])

Returns:

  • (Array) —

    An array of countries that use nested subregions, instead



272
 
# File 'lib/spree/app_configuration.rb', line 272

preference :countries_that_use_nested_subregions, :array, default: ['IT']

#credit_to_new_allocation ⇒ Boolean

Returns Creates a new allocation anytime StoreCredit#credit is called.

Returns:



135
 
# File 'lib/spree/app_configuration.rb', line 135

preference :credit_to_new_allocation, :boolean, default: false

#currency ⇒ String

Currency to use by default when not defined on the site (default: “USD”)

Returns:

  • (String) —

    ISO 4217 Three letter currency code



140
 
# File 'lib/spree/app_configuration.rb', line 140

preference :currency, :string, default: "USD"

#current_store_selector_class ⇒ Class

Allows providing your own class for choosing which store to use.

Returns:

  • (Class) —

    a class with the same public interfaces as Spree::CurrentStoreSelector



489
 
# File 'lib/spree/app_configuration.rb', line 489

class_name_attribute :current_store_selector_class, default: 'Spree::StoreSelector::ByServerName'

#customer_returns_per_page ⇒ Integer

Returns Customer returns to show per-page in the admin (default: 15).

Returns:

  • (Integer) —

    Customer returns to show per-page in the admin (default: 15)



144
 
# File 'lib/spree/app_configuration.rb', line 144

preference :customer_returns_per_page, :integer, default: 15

#default_country_iso ⇒ String

Default customer country ISO code

Returns:

  • (String) —

    Two-letter ISO code of a Country to assumed as the country of an unidentified customer (default: “US”)



149
 
# File 'lib/spree/app_configuration.rb', line 149

preference :default_country_iso, :string, default: 'US'

#default_email_regexp ⇒ Regexp

Returns Regex to be used in email validations, for example in Spree::EmailValidator.

Returns:

  • (Regexp) —

    Regex to be used in email validations, for example in Spree::EmailValidator



153
 
# File 'lib/spree/app_configuration.rb', line 153

preference :default_email_regexp, :regexp, default: URI::MailTo::EMAIL_REGEXP

#default_payment_builder_class ⇒ Class

Allows providing your own class for adding default payments to a user’s order from their “wallet”.

Returns:

  • (Class) —

    a class with the same public interfaces as Spree::Wallet::DefaultPaymentBuilder.



418
 
# File 'lib/spree/app_configuration.rb', line 418

class_name_attribute :default_payment_builder_class, default: 'Spree::Wallet::DefaultPaymentBuilder'

#generate_api_key_for_all_roles ⇒ Boolean

at role_user creation for all roles. (default: false)

Returns:

  • (Boolean) —

    Allow generating api key automatically for user



158
 
# File 'lib/spree/app_configuration.rb', line 158

preference :generate_api_key_for_all_roles, :boolean, default: false

#guest_token_cookie_options ⇒ Hash

Returns Add additional guest_token cookie options here (ie. domain or path).

Returns:

  • (Hash) —

    Add additional guest_token cookie options here (ie. domain or path)



68
 
# File 'lib/spree/app_configuration.rb', line 68

preference :guest_token_cookie_options, :hash, default: {}

#image_attachment_module ⇒ Module

Allows switching attachment library for Image

‘Spree::Image::ActiveStorageAttachment` is the default and provides the Active Storage implementation.

Enumerable of images adhering to the present_image_class interface

Returns:

  • (Module) —

    a module that can be included into Spree::Image to allow attachments



520
 
# File 'lib/spree/app_configuration.rb', line 520

class_name_attribute :image_attachment_module, default: "Spree::Image::ActiveStorageAttachment"

#inventory_cache_threshold ⇒ Integer

Only invalidate product caches when the count on hand for a stock item falls below or rises about the inventory_cache_threshold. When undefined, the product caches will be invalidated anytime the count on hand is changed.

Returns:

  • (Integer) 


165
 
# File 'lib/spree/app_configuration.rb', line 165

preference :inventory_cache_threshold, :integer

#item_total_class ⇒ Class

Allows providing your own class for recalculating totals on an item.

Returns:

  • (Class) —

    a class with the same public interfaces as Spree::ItemTotal



466
 
# File 'lib/spree/app_configuration.rb', line 466

class_name_attribute :item_total_class, default: 'Spree::ItemTotal'

#layout ⇒ String

Returns template to use for layout on the frontend (default: “spree/layouts/spree_application”).

Returns:

  • (String) —

    template to use for layout on the frontend (default: “spree/layouts/spree_application”)



169
 
# File 'lib/spree/app_configuration.rb', line 169

preference :layout, :string, default: 'spree/layouts/spree_application'

#log_entry_allow_aliases ⇒ Boolean

Returns Whether YAML aliases are allowed when loading serialized data in LogEntry. It defaults to true. Depending on the source of your data, you may consider disabling it to prevent entity expansion attacks.

Returns:

  • (Boolean) —

    Whether YAML aliases are allowed when loading serialized data in LogEntry. It defaults to true. Depending on the source of your data, you may consider disabling it to prevent entity expansion attacks.



196
 
# File 'lib/spree/app_configuration.rb', line 196

preference :log_entry_allow_aliases, :boolean, default: true

#log_entry_permitted_classes ⇒ Array<String>

Returns An array of extra classes that are allowed to be loaded from a serialized YAML as details in LogEntry (defaults to a non-frozen empty array, so that extensions can add their own classes).

Examples:

config.log_entry_permitted_classes = ['Date']

Returns:

  • (Array<String>) —

    An array of extra classes that are allowed to be loaded from a serialized YAML as details in LogEntry (defaults to a non-frozen empty array, so that extensions can add their own classes).



189
 
# File 'lib/spree/app_configuration.rb', line 189

preference :log_entry_permitted_classes, :array, default: []

#logo ⇒ String

Returns URL of logo used on frontend (default: ‘logo/solidus.svg’).

Returns:

  • (String) —

    URL of logo used on frontend (default: ‘logo/solidus.svg’)



180
 
# File 'lib/spree/app_configuration.rb', line 180

preference :logo, :string, default: 'logo/solidus.svg'

#max_level_in_taxons_menu ⇒ Integer

Returns maximum nesting level in taxons menu (default: 1).

Returns:

  • (Integer) —

    maximum nesting level in taxons menu (default: 1)



200
 
# File 'lib/spree/app_configuration.rb', line 200

preference :max_level_in_taxons_menu, :integer, default: 1

#meta_data_max_key_length ⇒ Integer

Returns Maximum length that key can have in customer and admin metadata column (default: 16).

Returns:

  • (Integer) —

    Maximum length that key can have in customer and admin metadata column (default: 16)



234
 
# File 'lib/spree/app_configuration.rb', line 234

preference :meta_data_max_key_length, :integer, default: 16

#meta_data_max_keys ⇒ Integer

Returns Maximum keys that can be allocated in customer and admin metadata column (default: 6).

Returns:

  • (Integer) —

    Maximum keys that can be allocated in customer and admin metadata column (default: 6)



230
 
# File 'lib/spree/app_configuration.rb', line 230

preference :meta_data_max_keys, :integer, default: 6

#meta_data_max_value_length ⇒ Integer

Returns Maximum length that value can have in customer and admin metadata column (default: 256).

Returns:

  • (Integer) —

    Maximum length that value can have in customer and admin metadata column (default: 256)



238
 
# File 'lib/spree/app_configuration.rb', line 238

preference :meta_data_max_value_length, :integer, default: 256

#meta_data_validation_enabled ⇒ Boolean

When this is set to true, the following preferences will be used to validate the metadata:

  • The maximum number of keys that can be added to the metadata columns (meta_data_max_keys).

  • The maximum length of each key in the metadata columns (meta_data_max_key_length).

  • The maximum length of each value in the metadata columns (meta_data_max_value_length).

(default: false)

Returns:

  • (Boolean) —

    Indicates whether validation for customer and admin metadata columns is enabled.



226
 
# File 'lib/spree/app_configuration.rb', line 226

preference :meta_data_validation_enabled, :boolean, default: false

#migration_path ⇒ Pathname

Configures the absolute path that contains the Solidus engine migrations. This will be checked at app boot to confirm that all Solidus migrations are installed.

Returns:

  • (Pathname) —

    the configured path. (default: ‘Rails.root.join(’db’, ‘migrate’)‘)



612
 
# File 'lib/spree/app_configuration.rb', line 612

attr_writer :migration_path

#order_bill_address_used ⇒ Boolean

bill addresses on payment sources. (default: true)

Returns:

  • (Boolean) —

    Use the order’s bill address, as opposed to storing



205
 
# File 'lib/spree/app_configuration.rb', line 205

preference :order_bill_address_used, :boolean, default: true

#order_cancellations_class ⇒ Class

Allows providing your own class for managing the inventory units of a completed order.

Returns:

  • (Class) —

    a class with the same public interfaces as Spree::OrderCancellations.



440
 
# File 'lib/spree/app_configuration.rb', line 440

class_name_attribute :order_cancellations_class, default: 'Spree::OrderCancellations'

#order_capturing_time_window ⇒ Integer

Returns the number of days to look back for fully-shipped/cancelled orders in order to charge for them.

Returns:

  • (Integer) —

    the number of days to look back for fully-shipped/cancelled orders in order to charge for them



209
 
# File 'lib/spree/app_configuration.rb', line 209

preference :order_capturing_time_window, :integer, default: 14

#order_contents_class ⇒ Class

Allows providing your own class for managing the contents of an order.

Returns:

  • (Class) —

    a class with the same public interfaces as Spree::OrderContents.



425
 
# File 'lib/spree/app_configuration.rb', line 425

class_name_attribute :order_contents_class, default: 'Spree::SimpleOrderContents'

#order_mailer_class ⇒ ActionMailer::Base

Allows providing your own Mailer for order mailer.

Returns:

  • (ActionMailer::Base) —

    an object that responds to “confirm_email”, “cancel_email” and “inventory_cancellation_email” (e.g. an ActionMailer with a “confirm_email” method) with the same signature as Spree::OrderMailer.confirm_email.



372
 
# File 'lib/spree/app_configuration.rb', line 372

class_name_attribute :order_mailer_class, default: 'Spree::OrderMailer'

#order_merger_class ⇒ Class

Allows providing your own class for merging two orders.

Returns:

  • (Class) —

    a class with the same public interfaces as Spree::OrderMerger.



410
 
# File 'lib/spree/app_configuration.rb', line 410

class_name_attribute :order_merger_class, default: 'Spree::OrderMerger'

#order_mutex_max_age ⇒ Integer

Returns Max age of OrderMutex in seconds (default: 2 minutes).

Returns:

  • (Integer) —

    Max age of OrderMutex in seconds (default: 2 minutes)



213
 
# File 'lib/spree/app_configuration.rb', line 213

preference :order_mutex_max_age, :integer, default: 120

#order_number_generator ⇒ Class

Allows providing your own class instance for generating order numbers.

Returns:

  • (Class) —

    a class instance with the same public interfaces as Spree::Order::NumberGenerator



623
 
# File 'lib/spree/app_configuration.rb', line 623

attr_writer :order_number_generator

#order_recalculator_class ⇒ Class

Allows providing a different order recalculator.

Returns:

  • (Class) —

    an object that conforms to the API of the standard order recalculator class Spree::OrderUpdater.

See Also:



387
 
# File 'lib/spree/app_configuration.rb', line 387

class_name_attribute :order_recalculator_class, default: 'Spree::OrderUpdater'

#order_shipping_class ⇒ Class

Allows providing your own class for shipping an order.

Returns:

  • (Class) —

    a class with the same public interfaces as Spree::OrderShipping.



432
 
# File 'lib/spree/app_configuration.rb', line 432

class_name_attribute :order_shipping_class, default: 'Spree::OrderShipping'

#order_update_attributes_class ⇒ Class

Allows providing your own order update attributes class for checkout.

Returns:

  • (Class) —

    a class that responds to “call” with the same signature as Spree::OrderUpdateAttributes.



379
 
# File 'lib/spree/app_configuration.rb', line 379

class_name_attribute :order_update_attributes_class, default: 'Spree::OrderUpdateAttributes'

#orders_per_page ⇒ Integer

Returns Orders to show per-page in the admin (default: 15).

Returns:

  • (Integer) —

    Orders to show per-page in the admin (default: 15)



217
 
# File 'lib/spree/app_configuration.rb', line 217

preference :orders_per_page, :integer, default: 15

#payment_canceller ⇒ Class

Allows providing your own class for canceling payments.

Returns:

  • (Class) —

    a class instance that responds to ‘cancel!(payment)`



446
 
# File 'lib/spree/app_configuration.rb', line 446

attr_writer :payment_canceller

#product_gallery_class ⇒ Class

Allows providing your own class for image galleries on Products

Enumerable of images adhering to the present_image_class interface

Returns:

  • (Class) —

    a class that implements an ‘images` method and returns an



510
 
# File 'lib/spree/app_configuration.rb', line 510

class_name_attribute :product_gallery_class, default: 'Spree::Gallery::ProductGallery'

#product_image_style_default ⇒ Symbol

Defines which style to default to when style is not provided :product is the default.

Returns:

  • (Symbol) 


536
 
# File 'lib/spree/app_configuration.rb', line 536

class_name_attribute :product_image_style_default, default: :product

#product_image_styles ⇒ Hash

Defines image styles/sizes hash for styles ‘{ mini: ’48x48>‘,

small: '400x400>',
product: '680x680>',
large: '1200x1200>' } is the default.

Returns:

  • (Hash) 


547
548
549
550
 
# File 'lib/spree/app_configuration.rb', line 547

class_name_attribute :product_image_styles, default: { mini: '48x48>',
small: '400x400>',
product: '680x680>',
large: '1200x1200>' }

#products_per_page ⇒ Integer

Returns Products to show per-page in the frontend (default: 12).

Returns:

  • (Integer) —

    Products to show per-page in the frontend (default: 12)



246
 
# File 'lib/spree/app_configuration.rb', line 246

preference :products_per_page, :integer, default: 12

#promotions ⇒ Spree::Core::NullPromotionConfiguration

Allows providing your own promotion configuration instance

Returns:



644
 
# File 'lib/spree/app_configuration.rb', line 644

attr_writer :promotions

#properties_per_page ⇒ Integer

Returns Properties to show per-page in the admin (default: 15).

Returns:

  • (Integer) —

    Properties to show per-page in the admin (default: 15)



242
 
# File 'lib/spree/app_configuration.rb', line 242

preference :properties_per_page, :integer, default: 15

#reimbursement_mailer_class ⇒ ActionMailer::Base

Allows providing your own Mailer for reimbursement mailer.

Returns:

  • (ActionMailer::Base) —

    an object that responds to “reimbursement_email” (e.g. an ActionMailer with a “reimbursement_email” method) with the same signature as Spree::ReimbursementMailer.reimbursement_email.



395
 
# File 'lib/spree/app_configuration.rb', line 395

class_name_attribute :reimbursement_mailer_class, default: 'Spree::ReimbursementMailer'

#require_master_price ⇒ Boolean

Returns Require a price on the master variant of a product (default: true).

Returns:

  • (Boolean) —

    Require a price on the master variant of a product (default: true)



250
 
# File 'lib/spree/app_configuration.rb', line 250

preference :require_master_price, :boolean, default: true

#require_payment_to_ship ⇒ Boolean

Returns Allows shipments to be ready to ship regardless of the order being paid if false (default: true).

Returns:

  • (Boolean) —

    Allows shipments to be ready to ship regardless of the order being paid if false (default: true)



254
 
# File 'lib/spree/app_configuration.rb', line 254

preference :require_payment_to_ship, :boolean, default: true

#return_eligibility_number_of_days ⇒ Integer

Returns default: 365.

Returns:

  • (Integer) —

    default: 365



258
 
# File 'lib/spree/app_configuration.rb', line 258

preference :return_eligibility_number_of_days, :integer, default: 365

#roles_for_auto_api_key ⇒ Array

at role_user creation is desired when user has one of these roles. (default: [‘admin’])

Returns:

  • (Array) —

    An array of roles where generating an api key for a user



264
 
# File 'lib/spree/app_configuration.rb', line 264

preference :roles_for_auto_api_key, :array, default: ['admin']

#send_core_emails ⇒ Boolean

Returns Whether to send transactional emails (default: true).

Returns:

  • (Boolean) —

    Whether to send transactional emails (default: true)



276
 
# File 'lib/spree/app_configuration.rb', line 276

preference :send_core_emails, :boolean, default: true

#shipping_instructions ⇒ Boolean

Returns Request instructions/info for shipping (default: false).

Returns:

  • (Boolean) —

    Request instructions/info for shipping (default: false)



280
 
# File 'lib/spree/app_configuration.rb', line 280

preference :shipping_instructions, :boolean, default: false

#shipping_rate_tax_calculator_class ⇒ Class

Allows providing your own class for calculating taxes on a shipping rate.

Returns:

  • (Class) —

    a class with the same public interfaces as Spree::TaxCalculator::ShippingRate



363
 
# File 'lib/spree/app_configuration.rb', line 363

class_name_attribute :shipping_rate_tax_calculator_class, default: 'Spree::TaxCalculator::ShippingRate'

#show_only_complete_orders_by_default ⇒ Boolean

Returns Only show completed orders by default in the admin (default: true).

Returns:

  • (Boolean) —

    Only show completed orders by default in the admin (default: true)



284
 
# File 'lib/spree/app_configuration.rb', line 284

preference :show_only_complete_orders_by_default, :boolean, default: true

#show_products_without_price ⇒ Boolean

Returns Whether products without a price are visible in the frontend (default: false).

Returns:

  • (Boolean) —

    Whether products without a price are visible in the frontend (default: false)



292
 
# File 'lib/spree/app_configuration.rb', line 292

preference :show_products_without_price, :boolean, default: false

#show_raw_product_description ⇒ Boolean

Returns Don’t escape HTML of product descriptions. (default: false).

Returns:

  • (Boolean) —

    Don’t escape HTML of product descriptions. (default: false)



296
 
# File 'lib/spree/app_configuration.rb', line 296

preference :show_raw_product_description, :boolean, default: false

#show_variant_full_price ⇒ Boolean

Returns Displays variant full price or difference with product price. (default: false).

Returns:

  • (Boolean) —

    Displays variant full price or difference with product price. (default: false)



288
 
# File 'lib/spree/app_configuration.rb', line 288

preference :show_variant_full_price, :boolean, default: false

#store_credit_prioritizer_class ⇒ Class

Allows providing your own class for prioritizing store credit application to an order.

Returns:

  • (Class) —

    a class with the same public interfaces as Spree::StoreCreditPrioritizer.



558
 
# File 'lib/spree/app_configuration.rb', line 558

class_name_attribute :store_credit_prioritizer_class, default: 'Spree::StoreCreditPrioritizer'

#tax_adjuster_class ⇒ Class

Allows providing your own class for calculating taxes on an order.

This extension point is under development and may change in a future minor release.

Returns:

  • (Class) —

    a class with the same public interfaces as Spree::Tax::OrderAdjuster



475
 
# File 'lib/spree/app_configuration.rb', line 475

class_name_attribute :tax_adjuster_class, default: 'Spree::Tax::OrderAdjuster'

#tax_calculator_class ⇒ Class

Allows providing your own class for calculating taxes on an order.

Returns:

  • (Class) —

    a class with the same public interfaces as Spree::TaxCalculator::Default



482
 
# File 'lib/spree/app_configuration.rb', line 482

class_name_attribute :tax_calculator_class, default: 'Spree::TaxCalculator::Default'

#tax_using_ship_address ⇒ Boolean

Returns Use the shipping address rather than the billing address to determine tax (default: true).

Returns:

  • (Boolean) —

    Use the shipping address rather than the billing address to determine tax (default: true)



300
 
# File 'lib/spree/app_configuration.rb', line 300

preference :tax_using_ship_address, :boolean, default: true

#taxon_attachment_module ⇒ Module

Allows switching attachment library for Taxon

‘Spree::Taxon::ActiveStorageAttachment` is the default and provides the Active Storage implementation.

Enumerable of taxons adhering to the present_taxon_class interface

Returns:

  • (Module) —

    a module that can be included into Spree::Taxon to allow attachments



594
 
# File 'lib/spree/app_configuration.rb', line 594

class_name_attribute :taxon_attachment_module, default: "Spree::Taxon::ActiveStorageAttachment"

#taxon_image_style_default ⇒ Symbol

Defines which style to default to when style is not provided :mini is the default.

Returns:

  • (Symbol) 


573
 
# File 'lib/spree/app_configuration.rb', line 573

class_name_attribute :taxon_image_style_default, default: :mini

#taxon_styles ⇒ Hash

Defines taxon styles/sizes hash for styles ‘{ mini: ’48x48>‘,

small: '400x400>',
product: '680x680>',
large: '1200x1200>' } is the default.

Returns:

  • (Hash) 


584
 
# File 'lib/spree/app_configuration.rb', line 584

class_name_attribute :taxon_image_styles, default: { mini: '32x32>', normal: '128x128>' }

#taxon_url_parametizer_class ⇒ Class

Allows providing your own class for creating urls on taxons

returns a String

Returns:

  • (Class) —

    a class that provides a ‘#parameterize` method that



496
 
# File 'lib/spree/app_configuration.rb', line 496

class_name_attribute :taxon_url_parametizer_class, default: 'ActiveSupport::Inflector'

#track_inventory_levels ⇒ Object

Determines whether to track on_hand values for variants / products. If you do not track inventory, or have effectively unlimited inventory for all products you can turn this on.

Returns:

  • Track on_hand values for variants / products. (default: true)



307
 
# File 'lib/spree/app_configuration.rb', line 307

preference :track_inventory_levels, :boolean, default: true

#unauthorized_redirect_handler_class ⇒ Class

Allows changing the default behavior for redirects when a user is not authorized

Returns:

  • (Class) —

    a class with the same public interfaces as Spree::UnauthorizedRedirectHandler.



601
 
# File 'lib/spree/app_configuration.rb', line 601

class_name_attribute :unauthorized_redirect_handler_class, default: "Spree::UnauthorizedRedirectHandler"

#variant_gallery_class ⇒ Class

Allows providing your own class for image galleries on Variants

Enumerable of images adhering to the present_image_class interface

Returns:

  • (Class) —

    a class that implements an ‘images` method and returns an



503
 
# File 'lib/spree/app_configuration.rb', line 503

class_name_attribute :variant_gallery_class, default: 'Spree::Gallery::VariantGallery'

#variant_price_selector_class ⇒ Class

Allows implementing custom pricing for variants

Returns:

  • (Class) —

    an object that conforms to the API of the standard variant price selector class Spree::Variant::PriceSelector.

See Also:



328
 
# File 'lib/spree/app_configuration.rb', line 328

class_name_attribute :variant_price_selector_class, default: 'Spree::Variant::PriceSelector'

#variant_vat_prices_generator_class ⇒ Class

Allows implementing custom vat prices generation

Returns:

  • (Class) —

    an object that conforms to the API of the standard variant vat prices generator class Spree::Variant::VatPriceGenerator.

See Also:



350
 
# File 'lib/spree/app_configuration.rb', line 350

class_name_attribute :variant_vat_prices_generator_class, default: 'Spree::Variant::VatPriceGenerator'

Instance Method Details

#admin_vat_location ⇒ Spree::Tax::TaxLocation

Default admin VAT location

An object that responds to :state_id and :country_id so it can double as a Spree::Address in Spree::Zone.for_address. Takes the ‘admin_vat_country_iso` as input.

Returns:

See Also:



737
738
739
740
741
 
# File 'lib/spree/app_configuration.rb', line 737

def admin_vat_location
  @default_tax_location ||= Spree::Tax::TaxLocation.new(
    country: Spree::Country.find_by(iso: admin_vat_country_iso)
  )
end

#default_pricing_options ⇒ variant_price_selector_class

Shortcut for the default pricing options

Returns:



338
339
340
 
# File 'lib/spree/app_configuration.rb', line 338

def default_pricing_options
  pricing_options_class.new
end

#environment ⇒ Object 



701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
 
# File 'lib/spree/app_configuration.rb', line 701

def environment
  @environment ||= Spree::Core::Environment.new(self).tap do |env|
    env.calculators.shipping_methods = %w[
      Spree::Calculator::Shipping::FlatPercentItemTotal
      Spree::Calculator::Shipping::FlatRate
      Spree::Calculator::Shipping::FlexiRate
      Spree::Calculator::Shipping::PerItem
      Spree::Calculator::Shipping::PriceSack
    ]

    env.calculators.tax_rates = %w[
      Spree::Calculator::DefaultTax
      Spree::Calculator::FlatFee
    ]

    env.payment_methods = %w[
      Spree::PaymentMethod::BogusCreditCard
      Spree::PaymentMethod::SimpleBogusCreditCard
      Spree::PaymentMethod::StoreCredit
      Spree::PaymentMethod::Check
    ]

    env.stock_splitters = %w[
      Spree::Stock::Splitter::ShippingCategory
      Spree::Stock::Splitter::Backordered
    ]
  end
end

#pricing_options_class ⇒ Class

Shortcut for getting the variant price selector’s pricing options class

Returns:

  • (Class) —

    The pricing options class to be used



333
 
# File 'lib/spree/app_configuration.rb', line 333

delegate :pricing_options_class, to: :variant_price_selector_class

#promotion_adjuster_class ⇒ Object 



658
659
660
 
# File 'lib/spree/app_configuration.rb', line 658

def promotion_adjuster_class
  promotions.order_adjuster_class
end

#promotion_adjuster_class=(klass) ⇒ Object 



662
663
664
 
# File 'lib/spree/app_configuration.rb', line 662

def promotion_adjuster_class=(klass)
  promotions.order_adjuster_class = klass
end

#roles ⇒ Object 



688
689
690
691
692
693
 
# File 'lib/spree/app_configuration.rb', line 688

def roles
  @roles ||= Spree::RoleConfiguration.new.tap do |roles|
    roles.assign_permissions :default, ['Spree::PermissionSets::DefaultCustomer']
    roles.assign_permissions :admin, ['Spree::PermissionSets::SuperUser']
  end
end

#state_machines ⇒ Object 



628
629
630
 
# File 'lib/spree/app_configuration.rb', line 628

def state_machines
  @state_machines ||= Spree::Core::StateMachines.new
end

#static_model_preferences ⇒ Object 



632
633
634
 
# File 'lib/spree/app_configuration.rb', line 632

def static_model_preferences
  @static_model_preferences ||= Spree::Preferences::StaticModelPreferences.new
end

#stock ⇒ Object 



636
637
638
 
# File 'lib/spree/app_configuration.rb', line 636

def stock
  @stock_configuration ||= Spree::Core::StockConfiguration.new
end

#user_last_url_storer_rules ⇒ Object 



695
696
697
698
699
 
# File 'lib/spree/app_configuration.rb', line 695

def user_last_url_storer_rules
  @user_last_url_storer_rules ||= ::Spree::Core::ClassConstantizer::Set.new.tap do |set|
    set << 'Spree::UserLastUrlStorer::Rules::AuthenticationRule'
  end
end