Class: Spree::AppConfiguration

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

Instance Attribute Summary collapse

Attributes inherited from Preferences::Configuration

#preference_store

Instance Method Summary collapse

Methods inherited from Preferences::Configuration

class_name_attribute, #configure, preference, #reset, #set, #use_legacy_db_preferences!, #use_static_preferences!

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

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.



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

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)



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

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)



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

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’)



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

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)



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

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)



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

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)



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

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)



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

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)



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

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)



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

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) 


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

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)



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

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)



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

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)



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

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)



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

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)



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

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



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

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



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

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) 


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

preference :billing_address_required, :boolean, default: false

#binary_inventory_cache ⇒ Boolean

Deprecated.

  • use inventory_cache_threshold instead

Only invalidate product caches when they change from in stock to out of stock. By default, caches are invalidated on any change of inventory quantity. Setting this to true should make operations on inventory faster. (default: false)

Returns:

  • (Boolean) 


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

preference :binary_inventory_cache, :boolean, default: false

#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



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

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.



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

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)



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

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)



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

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



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

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



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

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:



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

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



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

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



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

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)



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

preference :customer_returns_per_page, :integer, default: 15

#default_country_id ⇒ Integer?

Deprecated.

Use the default country ISO preference instead

Returns id of Country to be selected by default in dropdowns (default: nil).

Returns:

  • (Integer, nil) —

    id of Country to be selected by default in dropdowns (default: nil)



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

preference :default_country_id, :integer

#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”)



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

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

#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.



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

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

#disable_actionless_promotion_validation ⇒ Boolean

Returns Promotions should have actions associated before being considered active (default: true).

Returns:

  • (Boolean) —

    Promotions should have actions associated before being considered active (default: true)



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

preference :consider_actionless_promotion_active, :boolean, default: true

#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



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

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)



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

preference :guest_token_cookie_options, :hash, default: {}

#image_attachment_module ⇒ Module

Allows switching attachment library for Image

‘Spree::Image::PaperclipAttachment` is the default and provides the classic Paperclip 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



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

class_name_attribute :image_attachment_module, default: 'Spree::Image::PaperclipAttachment'

#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) 


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

preference :inventory_cache_threshold, :integer

#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”)



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

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

#legacy ⇒ Boolean

Returns use the legacy address’ state validation logic (default: true).

Returns:

  • (Boolean) —

    use the legacy address’ state validation logic (default: true)



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

preference :use_legacy_address_state_validator, :boolean, default: true

#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.



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

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).



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

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’)



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

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

#mails_from ⇒ String

Returns Email address used as From: field in transactional emails.

Returns:

  • (String) —

    Email address used as From: field in transactional emails.



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

preference :mails_from, :string, default: '[email protected]'

#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)



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

preference :max_level_in_taxons_menu, :integer, default: 1

#order_bill_address_used ⇒ Boolean

bill addresses on payment sources. (default: true)

Returns:

  • (Boolean) —

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



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

preference :order_bill_address_used, :boolean, default: true

#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



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

preference :order_capturing_time_window, :integer, default: 14

#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.



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

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.



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

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)



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

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



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

attr_writer :order_number_generator

#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)



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

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)`



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

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



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

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

#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)



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

preference :products_per_page, :integer, default: 12

#promotion_code_batch_mailer_class ⇒ ActionMailer::Base

Allows providing your own Mailer for promotion code batch mailer.

Returns:

  • (ActionMailer::Base) —

    an object that responds to “promotion_code_batch_finished”, and “promotion_code_batch_errored” (e.g. an ActionMailer with a “promotion_code_batch_finished” method) with the same signature as Spree::PromotionCodeBatchMailer.promotion_code_batch_finished.



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

class_name_attribute :promotion_code_batch_mailer_class, default: 'Spree::PromotionCodeBatchMailer'

#promotions_per_page ⇒ Integer

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

Returns:

  • (Integer) —

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



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

preference :promotions_per_page, :integer, default: 15

#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)



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

preference :properties_per_page, :integer, default: 15

#raise_with_invalid_currency ⇒ Boolean

Whether to raise an exception if trying to set a line item currency different from the order currency. When false a validation error is added to the instance instead.

Returns:

  • (Boolean) —

    (default: true)



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

preference :raise_with_invalid_currency, :boolean, default: true

#redirect_back_on_unauthorized ⇒ Boolean

Whether to try to redirect users back when they try to access unauthorized routes, before redirect them to /unauthorized.

Returns:

  • (Boolean) —

    (default: false)



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

preference :redirect_back_on_unauthorized, :boolean, default: false

#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.



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

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)



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

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)



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

preference :require_payment_to_ship, :boolean, default: true

#return_eligibility_number_of_days ⇒ Integer

Returns default: 365.

Returns:

  • (Integer) —

    default: 365



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

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



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

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

#run_order_validations_on_order_updater ⇒ Boolean

Returns Whether to run validation when updating an order with the OrderUpdater.

Returns:

  • (Boolean) —

    Whether to run validation when updating an order with the OrderUpdater



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

preference :run_order_validations_on_order_updater, :boolean, default: false

#send_core_emails ⇒ Boolean

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

Returns:

  • (Boolean) —

    Whether to send transactional emails (default: true)



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

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)



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

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



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

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)



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

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)



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

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)



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

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)



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

preference :show_variant_full_price, :boolean, default: false

#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



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

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



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

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)



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

preference :tax_using_ship_address, :boolean, default: true

#taxon_attachment_module ⇒ Module

Allows switching attachment library for Taxon

‘Spree::Taxon::PaperclipAttachment` is the default and provides the classic Paperclip 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



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

class_name_attribute :taxon_attachment_module, default: 'Spree::Taxon::PaperclipAttachment'

#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



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

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)



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

preference :track_inventory_levels, :boolean, default: true

#use_combined_first_and_last_name_in_address ⇒ Boolean

API responses. (default: false)

Returns:

  • (Boolean) —

    Use Spree::Address combined first and last name in HTML views and



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

preference :use_combined_first_and_last_name_in_address, :boolean, default: false

#use_custom_cancancan_actions ⇒ Boolean

Returns Allow to use legacy Solidus custom CanCanCan action aliases (default: true).

Returns:

  • (Boolean) —

    Allow to use legacy Solidus custom CanCanCan action aliases (default: true)



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

preference :use_custom_cancancan_actions, :boolean, default: true

#use_legacy_order_state_machine ⇒ Boolean

(default: false)

Returns:

  • (Boolean) —

    Uses the legacy order state machine from Spree::Order::Checkout



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

preference :use_legacy_order_state_machine, :boolean, default: true

#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



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

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:



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

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:



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

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:



663
664
665
666
667
 
# File 'lib/spree/app_configuration.rb', line 663

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:



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

def default_pricing_options
  pricing_options_class.new
end

#environment ⇒ Object 



581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
 
# File 'lib/spree/app_configuration.rb', line 581

def environment
  @environment ||= Spree::Core::Environment.new(self).tap do |env|
    env.calculators.promotion_actions_create_adjustments = %w[
      Spree::Calculator::FlatPercentItemTotal
      Spree::Calculator::FlatRate
      Spree::Calculator::FlexiRate
      Spree::Calculator::TieredPercent
      Spree::Calculator::TieredFlatRate
    ]

    env.calculators.promotion_actions_create_item_adjustments = %w[
      Spree::Calculator::DistributedAmount
      Spree::Calculator::FlatRate
      Spree::Calculator::FlexiRate
      Spree::Calculator::PercentOnLineItem
      Spree::Calculator::TieredPercent
    ]

    env.calculators.promotion_actions_create_quantity_adjustments = %w[
      Spree::Calculator::PercentOnLineItem
      Spree::Calculator::FlatRate
    ]

    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
    ]

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

    env.promotions.rules = %w[
      Spree::Promotion::Rules::ItemTotal
      Spree::Promotion::Rules::Product
      Spree::Promotion::Rules::User
      Spree::Promotion::Rules::FirstOrder
      Spree::Promotion::Rules::UserLoggedIn
      Spree::Promotion::Rules::OneUsePerUser
      Spree::Promotion::Rules::Taxon
      Spree::Promotion::Rules::NthOrder
      Spree::Promotion::Rules::OptionValue
      Spree::Promotion::Rules::FirstRepeatPurchaseSince
      Spree::Promotion::Rules::UserRole
      Spree::Promotion::Rules::Store
    ]

    env.promotions.actions = %w[
      Spree::Promotion::Actions::CreateAdjustment
      Spree::Promotion::Actions::CreateItemAdjustments
      Spree::Promotion::Actions::CreateQuantityAdjustments
      Spree::Promotion::Actions::FreeShipping
    ]

    env.promotions.shipping_actions = %w[
      Spree::Promotion::Actions::FreeShipping
    ]

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

#events ⇒ Object 



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

def events
  @events_configuration ||= Spree::Event::Configuration.new
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



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

delegate :pricing_options_class, to: :variant_price_selector_class

#roles ⇒ Object 



564
565
566
567
568
569
 
# File 'lib/spree/app_configuration.rb', line 564

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 



552
553
554
 
# File 'lib/spree/app_configuration.rb', line 552

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

#static_model_preferences ⇒ Object 



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

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

#stock ⇒ Object 



560
561
562
 
# File 'lib/spree/app_configuration.rb', line 560

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

#user_last_url_storer_rules ⇒ Object 



575
576
577
578
579
 
# File 'lib/spree/app_configuration.rb', line 575

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