Module: Spree
- Defined in:
- app/models/spree/image.rb,
lib/spree/core.rb,
lib/spree/i18n.rb,
lib/spree/money.rb,
lib/spree/events.rb,
lib/spree/webhooks.rb,
lib/spree/analytics.rb,
lib/spree/migrations.rb,
app/models/spree/role.rb,
app/models/spree/zone.rb,
lib/spree/core/engine.rb,
lib/spree/core/routes.rb,
app/models/spree/asset.rb,
app/models/spree/event.rb,
app/models/spree/order.rb,
app/models/spree/price.rb,
app/models/spree/state.rb,
app/models/spree/store.rb,
app/models/spree/taxon.rb,
lib/spree/core/version.rb,
app/jobs/spree/base_job.rb,
app/models/spree/export.rb,
app/models/spree/import.rb,
app/models/spree/market.rb,
app/models/spree/policy.rb,
app/models/spree/refund.rb,
app/models/spree/report.rb,
lib/spree/core/partials.rb,
app/models/spree/ability.rb,
app/models/spree/address.rb,
app/models/spree/api_key.rb,
app/models/spree/country.rb,
app/models/spree/current.rb,
app/models/spree/digital.rb,
app/models/spree/gateway.rb,
app/models/spree/payment.rb,
app/models/spree/product.rb,
app/models/spree/variant.rb,
lib/spree/service_module.rb,
app/models/spree/category.rb,
app/models/spree/exchange.rb,
app/models/spree/shipment.rb,
app/models/spree/tax_rate.rb,
app/models/spree/taxonomy.rb,
app/models/spree/wishlist.rb,
lib/spree/core/components.rb,
lib/spree/events/registry.rb,
app/models/spree/data_feed.rb,
app/models/spree/gift_card.rb,
app/models/spree/line_item.rb,
app/models/spree/log_entry.rb,
app/models/spree/metafield.rb,
app/models/spree/promotion.rb,
app/models/spree/prototype.rb,
app/models/spree/role_user.rb,
lib/spree/localized_number.rb,
app/models/spree/adjustment.rb,
app/models/spree/calculator.rb,
app/models/spree/import_row.rb,
app/models/spree/invitation.rb,
app/models/spree/price_list.rb,
app/models/spree/price_rule.rb,
app/models/spree/stock_item.rb,
app/models/spree/subscriber.rb,
app/models/spree/taxon_rule.rb,
lib/spree/core/dependencies.rb,
app/models/spree/coupon_code.rb,
app/models/spree/credit_card.rb,
app/models/spree/integration.rb,
app/models/spree/legacy_user.rb,
app/models/spree/option_type.rb,
app/models/spree/return_item.rb,
app/models/spree/wished_item.rb,
app/models/spree/zone_member.rb,
app/services/spree/seeds/all.rb,
lib/spree/core/configuration.rb,
app/finders/spree/base_finder.rb,
app/finders/spree/taxons/find.rb,
app/helpers/spree/base_helper.rb,
app/mailers/spree/base_mailer.rb,
app/models/spree/digital_link.rb,
app/models/spree/option_value.rb,
app/models/spree/order_merger.rb,
app/models/spree/state_change.rb,
app/models/spree/stock/packer.rb,
app/models/spree/store_credit.rb,
app/models/spree/tax_category.rb,
app/services/spree/cart/empty.rb,
app/sorters/spree/base_sorter.rb,
app/sorters/spree/orders/sort.rb,
app/models/spree/checkout/step.rb,
app/models/spree/gateway/bogus.rb,
app/models/spree/import_schema.rb,
app/models/spree/order/digital.rb,
app/models/spree/order_updater.rb,
app/models/spree/price_history.rb,
app/models/spree/product/slugs.rb,
app/models/spree/refresh_token.rb,
app/models/spree/refund_reason.rb,
app/models/spree/reimbursement.rb,
app/models/spree/shipping_rate.rb,
app/models/spree/stock/package.rb,
app/models/spree/store_product.rb,
app/models/spree/user_identity.rb,
app/services/spree/cart/create.rb,
app/services/spree/cart/update.rb,
app/services/spree/seeds/roles.rb,
app/services/spree/seeds/zones.rb,
lib/spree/core/pricing/context.rb,
lib/spree/core/token_generator.rb,
lib/spree/events/adapters/base.rb,
lib/spree/permitted_attributes.rb,
lib/spree/testing_support/i18n.rb,
app/finders/spree/products/find.rb,
app/finders/spree/variants/find.rb,
app/helpers/spree/images_helper.rb,
app/helpers/spree/locale_helper.rb,
app/mailers/spree/export_mailer.rb,
app/mailers/spree/report_mailer.rb,
app/models/spree/allowed_origin.rb,
app/models/spree/classification.rb,
app/models/spree/customer_group.rb,
app/models/spree/exports/orders.rb,
app/models/spree/import_mapping.rb,
app/models/spree/inventory_unit.rb,
app/models/spree/market_country.rb,
app/models/spree/order/checkout.rb,
app/models/spree/order/payments.rb,
app/models/spree/order/webhooks.rb,
app/models/spree/order_contents.rb,
app/models/spree/payment_method.rb,
app/models/spree/payment_source.rb,
app/models/spree/promotion_rule.rb,
app/models/spree/stock/adjuster.rb,
app/models/spree/stock_location.rb,
app/models/spree/stock_movement.rb,
app/models/spree/stock_transfer.rb,
app/services/spree/cart/destroy.rb,
app/services/spree/carts/create.rb,
app/services/spree/carts/update.rb,
app/services/spree/seeds/states.rb,
app/services/spree/seeds/stores.rb,
app/sorters/spree/products/sort.rb,
lib/spree/core/number_generator.rb,
lib/spree/core/pricing/resolver.rb,
app/finders/spree/addresses/find.rb,
app/finders/spree/countries/find.rb,
app/mailers/spree/webhook_mailer.rb,
app/models/spree/customer_return.rb,
app/models/spree/gift_card_batch.rb,
app/models/spree/metafields/json.rb,
app/models/spree/order/gift_card.rb,
app/models/spree/order_inventory.rb,
app/models/spree/order_promotion.rb,
app/models/spree/payment_session.rb,
app/models/spree/prototype_taxon.rb,
app/models/spree/shipping_method.rb,
app/models/spree/stock/estimator.rb,
app/models/spree/store_promotion.rb,
app/models/spree/taxon_rules/tag.rb,
app/services/spree/cart/add_item.rb,
app/services/spree/checkout/next.rb,
app/services/spree/orders/cancel.rb,
app/services/spree/tags/bulk_add.rb,
lib/spree/testing_support/kernel.rb,
lib/spree/translation_migrations.rb,
app/helpers/spree/currency_helper.rb,
app/helpers/spree/products_helper.rb,
app/helpers/spree/shipment_helper.rb,
app/jobs/spree/variants/touch_job.rb,
app/models/spree/data_feed/google.rb,
app/models/spree/exports/products.rb,
app/models/spree/gateway_customer.rb,
app/models/spree/imports/products.rb,
app/models/spree/payment/webhooks.rb,
app/models/spree/payment_response.rb,
app/models/spree/product/webhooks.rb,
app/models/spree/promotion_action.rb,
app/models/spree/report_line_item.rb,
app/models/spree/shipment_handler.rb,
app/models/spree/stock/quantifier.rb,
app/models/spree/taxon_rules/sale.rb,
app/models/spree/variant/webhooks.rb,
app/models/spree/webhook_delivery.rb,
app/models/spree/webhook_endpoint.rb,
app/services/spree/account/create.rb,
app/services/spree/account/update.rb,
app/services/spree/cart/associate.rb,
app/services/spree/carts/complete.rb,
app/services/spree/generate_token.rb,
app/services/spree/orders/approve.rb,
app/services/spree/seeds/api_keys.rb,
lib/spree/database_type_utilities.rb,
app/helpers/spree/addresses_helper.rb,
app/models/concerns/spree/metadata.rb,
app/models/spree/checkout/registry.rb,
app/models/spree/exports/customers.rb,
app/models/spree/imports/customers.rb,
app/models/spree/invitations/store.rb,
app/models/spree/legacy_admin_user.rb,
app/models/spree/metafields/number.rb,
app/models/spree/shipment/webhooks.rb,
app/models/spree/shipping_category.rb,
app/models/spree/stock/coordinator.rb,
app/models/spree/stock/prioritizer.rb,
app/models/spree/store_credit_type.rb,
app/services/spree/checkout/update.rb,
app/services/spree/payments/create.rb,
app/services/spree/seeds/countries.rb,
app/validators/spree/url_validator.rb,
lib/spree/core/dependencies_helper.rb,
app/finders/spree/credit_cards/find.rb,
app/jobs/spree/exports/generate_job.rb,
app/jobs/spree/reports/generate_job.rb,
app/mailers/spree/invitation_mailer.rb,
app/models/spree/exports/gift_cards.rb,
app/models/spree/fulfilment_changer.rb,
app/models/spree/metafields/boolean.rb,
app/models/spree/order/address_book.rb,
app/models/spree/order/store_credit.rb,
app/models/spree/payment/processing.rb,
app/models/spree/promotion_category.rb,
app/models/spree/reimbursement_type.rb,
app/models/spree/returns_calculator.rb,
app/models/spree/stock/content_item.rb,
app/models/spree/store_credit_event.rb,
app/services/spree/addresses/create.rb,
app/services/spree/addresses/helper.rb,
app/services/spree/addresses/update.rb,
app/services/spree/cart/recalculate.rb,
app/services/spree/cart/remove_item.rb,
app/services/spree/checkout/advance.rb,
app/services/spree/gift_cards/apply.rb,
app/services/spree/seeds/admin_user.rb,
app/services/spree/shipments/create.rb,
app/services/spree/shipments/helper.rb,
app/services/spree/shipments/update.rb,
app/services/spree/tags/bulk_remove.rb,
app/jobs/spree/events/subscriber_job.rb,
app/models/concerns/spree/display_on.rb,
app/models/concerns/spree/metafields.rb,
app/models/concerns/spree/named_type.rb,
app/models/concerns/spree/searchable.rb,
app/models/concerns/spree/user_roles.rb,
app/models/spree/customer_group_user.rb,
app/models/spree/product_option_type.rb,
app/models/spree/promotion_rule_user.rb,
app/models/spree/reports/sales_total.rb,
app/models/spree/shipping_calculator.rb,
app/models/spree/stock/splitter/base.rb,
app/models/spree/stock_item/webhooks.rb,
app/paginators/spree/shared/paginate.rb,
app/services/spree/cart/set_quantity.rb,
app/services/spree/checkout/complete.rb,
app/services/spree/gift_cards/redeem.rb,
app/services/spree/gift_cards/remove.rb,
app/services/spree/line_items/create.rb,
app/services/spree/line_items/helper.rb,
app/services/spree/line_items/update.rb,
app/services/spree/newsletter/verify.rb,
app/services/spree/themes/duplicator.rb,
lib/spree/core/ransack_configuration.rb,
app/finders/spree/orders/find_current.rb,
app/finders/spree/stores/find_default.rb,
app/helpers/spree/integrations_helper.rb,
app/models/concerns/spree/prefixed_id.rb,
app/models/concerns/spree/publishable.rb,
app/models/concerns/spree/unique_name.rb,
app/models/spree/calculator/flat_rate.rb,
app/models/spree/checkout/requirement.rb,
app/models/spree/exports/coupon_codes.rb,
app/models/spree/metafield_definition.rb,
app/models/spree/metafields/long_text.rb,
app/models/spree/metafields/rich_text.rb,
app/models/spree/option_value_variant.rb,
app/models/spree/payment_method/check.rb,
app/models/spree/permission_sets/base.rb,
app/models/spree/promotion/rules/user.rb,
app/models/spree/promotion_rule_taxon.rb,
app/models/spree/reimbursement/credit.rb,
app/models/spree/return_authorization.rb,
app/models/spree/search_provider/base.rb,
app/models/spree/shipping_method_zone.rb,
app/models/spree/stock/differentiator.rb,
app/models/spree/store_payment_method.rb,
app/services/spree/carts/upsert_items.rb,
app/services/spree/compare_line_items.rb,
app/services/spree/line_items/destroy.rb,
app/services/spree/sample_data/loader.rb,
app/services/spree/shipments/add_item.rb,
lib/spree/testing_support/preferences.rb,
lib/spree/testing_support/url_helpers.rb,
app/finders/spree/orders/find_complete.rb,
app/finders/spree/orders/finder_helper.rb,
app/jobs/spree/imports/create_rows_job.rb,
app/models/concerns/spree/stores/setup.rb,
app/models/concerns/spree/user_address.rb,
app/models/concerns/spree/user_methods.rb,
app/models/spree/calculator/flexi_rate.rb,
app/models/spree/calculator/price_sack.rb,
app/models/spree/checkout/requirements.rb,
app/models/spree/metafields/short_text.rb,
app/models/spree/newsletter_subscriber.rb,
app/models/spree/option_type_prototype.rb,
app/models/spree/payment/custom_events.rb,
app/models/spree/payment_capture_event.rb,
app/models/spree/payment_setup_session.rb,
app/models/spree/price_rules/user_rule.rb,
app/models/spree/price_rules/zone_rule.rb,
app/models/spree/promotion/rules/taxon.rb,
app/models/spree/stock/splitter/weight.rb,
app/models/spree/store_credit_category.rb,
app/presenters/spree/variant_presenter.rb,
app/services/spree/country_to_timezone.rb,
app/services/spree/products/duplicator.rb,
app/services/spree/taxons/add_products.rb,
app/sorters/spree/classifications/sort.rb,
lib/spree/core/controller_helpers/auth.rb,
app/jobs/spree/images/save_from_url_job.rb,
app/jobs/spree/imports/process_rows_job.rb,
app/models/concerns/spree/default_price.rb,
app/models/concerns/spree/display_money.rb,
app/models/concerns/spree/image_methods.rb,
app/models/concerns/spree/memoized_data.rb,
app/models/spree/calculator/default_tax.rb,
app/models/spree/order/currency_updater.rb,
app/models/spree/payment_sessions/bogus.rb,
app/models/spree/product_promotion_rule.rb,
app/models/spree/promotion_handler/cart.rb,
app/models/spree/promotion_handler/page.rb,
app/models/spree/shipment/custom_events.rb,
app/models/spree/stock/splitter/digital.rb,
app/services/spree/cart/change_currency.rb,
app/services/spree/credit_cards/destroy.rb,
app/services/spree/newsletter/subscribe.rb,
app/services/spree/seeds/tax_categories.rb,
app/subscribers/spree/export_subscriber.rb,
app/subscribers/spree/report_subscriber.rb,
lib/spree/core/controller_helpers/order.rb,
lib/spree/core/controller_helpers/store.rb,
lib/spree/core/controller_helpers/turbo.rb,
lib/spree/core/permission_configuration.rb,
lib/spree/testing_support/image_helpers.rb,
app/jobs/spree/products/touch_taxons_job.rb,
app/jobs/spree/search_provider/index_job.rb,
app/models/concerns/spree/product_scopes.rb,
app/models/concerns/spree/stores/markets.rb,
app/models/concerns/spree/user_reporting.rb,
app/models/spree/adjustable/adjuster/tax.rb,
app/models/spree/import_schemas/products.rb,
app/models/spree/payment/gateway_options.rb,
app/models/spree/price_rules/market_rule.rb,
app/models/spree/price_rules/volume_rule.rb,
app/models/spree/promotion/rules/country.rb,
app/models/spree/promotion/rules/product.rb,
app/models/spree/reimbursement_performer.rb,
app/models/spree/stock_movement/webhooks.rb,
app/services/spree/cart/remove_line_item.rb,
app/services/spree/seeds/allowed_origins.rb,
app/services/spree/seeds/payment_methods.rb,
app/services/spree/seeds/stock_locations.rb,
app/services/spree/shipments/remove_item.rb,
lib/spree/core/controller_helpers/common.rb,
lib/spree/core/controller_helpers/locale.rb,
lib/spree/testing_support/locale_helpers.rb,
app/finders/spree/variants/visible_finder.rb,
app/jobs/spree/search_provider/remove_job.rb,
app/models/concerns/spree/number_as_param.rb,
app/models/concerns/spree/user_management.rb,
app/models/spree/adjustable/adjuster/base.rb,
app/models/spree/import_schemas/customers.rb,
app/models/spree/payment_connection_error.rb,
app/models/spree/promotion/rules/currency.rb,
app/models/spree/promotion_handler/coupon.rb,
app/models/spree/search_provider/database.rb,
app/models/spree/shipping_method_category.rb,
app/models/spree/taxon_rules/available_on.rb,
app/services/spree/seeds/digital_delivery.rb,
app/services/spree/shipments/change_state.rb,
app/services/spree/taxons/remove_products.rb,
app/jobs/spree/payments/handle_webhook_job.rb,
app/models/concerns/spree/search_indexable.rb,
app/models/spree/calculator/tiered_percent.rb,
app/models/spree/reimbursement_type/credit.rb,
app/presenters/spree/csv/metafields_helper.rb,
app/services/spree/payments/handle_webhook.rb,
app/subscribers/spree/event_log_subscriber.rb,
lib/generators/spree/dummy/dummy_generator.rb,
lib/generators/spree/model/model_generator.rb,
lib/spree/core/controller_helpers/currency.rb,
app/jobs/spree/gift_cards/bulk_generate_job.rb,
app/jobs/spree/products/refresh_metrics_job.rb,
app/models/concerns/spree/adjustment_source.rb,
app/models/concerns/spree/number_identifier.rb,
app/models/spree/permission_sets/super_user.rb,
app/models/spree/promotion/rules/item_total.rb,
app/models/spree/promotion_action_line_item.rb,
app/models/spree/stock/splitter/backordered.rb,
app/presenters/spree/csv/customer_presenter.rb,
app/services/spree/account/addresses/create.rb,
app/services/spree/account/addresses/update.rb,
app/finders/spree/line_items/find_by_variant.rb,
app/jobs/spree/addresses/geocode_address_job.rb,
app/jobs/spree/variants/remove_line_item_job.rb,
app/models/concerns/spree/admin_user_methods.rb,
app/models/concerns/spree/has_image_alt_text.rb,
app/models/spree/calculator/tiered_flat_rate.rb,
app/models/spree/payment_method/store_credit.rb,
app/models/spree/promotion/rules/first_order.rb,
app/models/spree/return_authorization_reason.rb,
app/models/spree/search_provider/meilisearch.rb,
app/presenters/spree/csv/gift_card_presenter.rb,
app/presenters/spree/filters/price_presenter.rb,
app/services/spree/checkout/add_store_credit.rb,
app/services/spree/sample_data/import_runner.rb,
app/services/spree/seeds/returns_environment.rb,
app/services/spree/seeds/shipping_categories.rb,
app/finders/concerns/spree/product_filterable.rb,
app/jobs/spree/coupon_codes/bulk_generate_job.rb,
app/jobs/spree/products/auto_match_taxons_job.rb,
app/models/concerns/spree/user_payment_source.rb,
app/models/spree/asset/support/active_storage.rb,
app/models/spree/base_analytics_event_handler.rb,
app/models/spree/calculator/shipping/per_item.rb,
app/models/spree/exports/product_translations.rb,
app/models/spree/imports/product_translations.rb,
app/models/spree/permission_sets/user_display.rb,
app/models/spree/promotion/rules/option_value.rb,
app/models/spree/reimbursement_tax_calculator.rb,
app/models/spree/reports/products_performance.rb,
app/models/spree/stock/availability_validator.rb,
app/models/spree/stock/inventory_unit_builder.rb,
app/models/spree/stock_movement/custom_events.rb,
app/services/spree/classifications/reposition.rb,
app/services/spree/coupon_codes/bulk_generate.rb,
app/services/spree/orders/create_user_account.rb,
app/services/spree/products/auto_match_taxons.rb,
app/services/spree/taxons/regenerate_products.rb,
app/services/spree/variants/remove_line_items.rb,
lib/spree/testing_support/controller_requests.rb,
app/finders/spree/option_values/find_available.rb,
app/finders/spree/variants/option_types_finder.rb,
app/models/concerns/spree/integrations_concern.rb,
app/models/concerns/spree/parameterizable_name.rb,
app/models/spree/adjustable/adjuster/promotion.rb,
app/models/spree/calculator/shipping/flat_rate.rb,
app/models/spree/checkout/default_requirements.rb,
app/models/spree/permission_sets/order_display.rb,
app/models/spree/permission_sets/stock_display.rb,
app/models/spree/report_line_items/sales_total.rb,
app/models/spree/search_provider/search_result.rb,
app/presenters/spree/csv/coupon_code_presenter.rb,
app/presenters/spree/data_feeds/base_presenter.rb,
app/presenters/spree/filters/options_presenter.rb,
app/presenters/spree/product_summary_presenter.rb,
app/services/spree/checkout/get_shipping_rates.rb,
app/services/spree/imports/row_processors/base.rb,
app/validators/spree/addresses/phone_validator.rb,
app/models/concerns/spree/single_store_resource.rb,
app/models/concerns/spree/store_scoped_resource.rb,
app/models/concerns/spree/translatable_resource.rb,
app/models/concerns/spree/vat_price_calculation.rb,
app/models/spree/adjustable/adjustments_updater.rb,
app/models/spree/calculator/shipping/flexi_rate.rb,
app/models/spree/calculator/shipping/price_sack.rb,
app/models/spree/exports/newsletter_subscribers.rb,
app/models/spree/promotion/rules/customer_group.rb,
app/models/spree/promotion/rules/user_logged_in.rb,
app/presenters/spree/variants/options_presenter.rb,
app/services/spree/cart/estimate_shipping_rates.rb,
app/services/spree/checkout/remove_store_credit.rb,
app/services/spree/wallet/create_payment_source.rb,
lib/spree/testing_support/authorization_helpers.rb,
app/models/concerns/spree/calculated_adjustments.rb,
app/models/concerns/spree/payment_source_concern.rb,
app/models/spree/calculator/percent_on_line_item.rb,
app/models/spree/permission_sets/product_display.rb,
app/models/spree/permission_sets/role_management.rb,
app/models/spree/permission_sets/user_management.rb,
app/models/spree/price_rules/customer_group_rule.rb,
app/models/spree/promotion/actions/free_shipping.rb,
app/models/spree/promotion_handler/free_shipping.rb,
app/presenters/spree/data_feeds/google_presenter.rb,
app/services/spree/seeds/store_credit_categories.rb,
app/services/spree/tracking_numbers/base_service.rb,
app/subscribers/spree/product_metrics_subscriber.rb,
lib/spree/core/preferences/runtime_configuration.rb,
app/models/spree/adjustable/promotion_accumulator.rb,
app/models/spree/permission_sets/default_customer.rb,
app/models/spree/permission_sets/order_management.rb,
app/models/spree/permission_sets/stock_management.rb,
app/models/spree/promotion/rules/one_use_per_user.rb,
app/models/spree/stock/splitter/shipping_category.rb,
app/services/spree/cart/remove_out_of_stock_items.rb,
app/subscribers/spree/invitation_email_subscriber.rb,
app/models/spree/permission_sets/dashboard_display.rb,
app/presenters/spree/csv/order_line_item_presenter.rb,
app/presenters/spree/csv/product_variant_presenter.rb,
app/presenters/spree/filters/price_range_presenter.rb,
app/services/spree/checkout/select_shipping_method.rb,
app/services/spree/imports/row_processors/customer.rb,
app/models/spree/calculator/flat_percent_item_total.rb,
app/models/spree/image/configuration/active_storage.rb,
app/models/spree/permission_sets/product_management.rb,
lib/spree/core/controller_helpers/strong_parameters.rb,
app/models/concerns/spree/translatable_resource_slug.rb,
app/models/spree/import_schemas/product_translations.rb,
app/models/spree/promotion/actions/create_adjustment.rb,
app/models/spree/promotion/actions/create_line_items.rb,
app/presenters/spree/variants/option_types_presenter.rb,
app/services/spree/coupon_codes/coupon_codes_handler.rb,
app/services/spree/orders/update_contact_information.rb,
app/services/spree/seeds/default_reimbursement_types.rb,
app/jobs/spree/stock_locations/stock_items/create_job.rb,
app/models/spree/calculator/shipping/digital_delivery.rb,
app/models/spree/gateway/custom_payment_source_method.rb,
app/models/spree/permission_sets/promotion_management.rb,
app/services/spree/products/prepare_nested_attributes.rb,
app/services/spree/stock_locations/stock_items/create.rb,
app/models/concerns/spree/translatable_resource_scopes.rb,
app/presenters/spree/csv/product_translation_presenter.rb,
app/presenters/spree/search_provider/product_presenter.rb,
app/services/spree/stores/settings_defaults_by_country.rb,
lib/generators/spree/dummy_model/dummy_model_generator.rb,
lib/spree/events/adapters/active_support_notifications.rb,
app/models/spree/promotion_handler/promotion_duplicator.rb,
app/models/spree/report_line_items/products_performance.rb,
app/models/spree/authentication/strategies/base_strategy.rb,
app/models/spree/reimbursement/reimbursement_type_engine.rb,
app/presenters/spree/csv/newsletter_subscriber_presenter.rb,
app/services/spree/locales/set_fallback_locale_for_store.rb,
app/jobs/spree/variants/remove_from_incomplete_orders_job.rb,
app/models/spree/calculator/returns/default_refund_amount.rb,
app/models/spree/permission_sets/configuration_management.rb,
app/models/spree/reimbursement_type/reimbursement_helpers.rb,
app/services/spree/imports/row_processors/product_variant.rb,
lib/generators/spree/authentication/dummy/dummy_generator.rb,
app/models/spree/promotion/actions/create_item_adjustments.rb,
app/models/spree/return_item/eligibility_validator/default.rb,
app/models/spree/reimbursement/reimbursement_type_validator.rb,
lib/generators/spree/authentication/custom/custom_generator.rb,
lib/generators/spree/authentication/devise/devise_generator.rb,
app/models/spree/calculator/shipping/flat_percent_item_total.rb,
app/presenters/spree/filters/quantified_price_range_presenter.rb,
app/services/spree/imports/row_processors/product_translation.rb,
lib/generators/spree/model_decorator/model_decorator_generator.rb,
app/models/spree/return_item/eligibility_validator/rma_required.rb,
app/models/spree/return_item/eligibility_validator/base_validator.rb,
app/models/spree/authentication/strategies/email_password_strategy.rb,
app/models/spree/return_item/eligibility_validator/order_completed.rb,
app/models/spree/return_item/eligibility_validator/inventory_shipped.rb,
app/models/spree/return_item/eligibility_validator/no_reimbursements.rb,
app/models/spree/return_item/eligibility_validator/time_since_purchase.rb,
app/models/spree/return_item/exchange_variant_eligibility/same_product.rb,
app/models/spree/return_item/exchange_variant_eligibility/same_option_value.rb
Overview
Permission set for managing store configuration and settings.
This permission set provides access to manage store settings, payment methods, shipping methods, and other configuration.
Defined Under Namespace
Modules: Account, Addresses, AddressesHelper, Adjustable, AdjustmentSource, AdminUserMethods, Analytics, Authentication, BaseHelper, CSV, CalculatedAdjustments, Cart, Carts, Checkout, Classifications, Core, Countries, CouponCodes, CreditCards, CurrencyHelper, DataFeeds, DatabaseTypeUtilities, DefaultPrice, DependenciesHelper, DisplayMoney, DisplayOn, DummyGeneratorHelper, Events, Exports, Filters, GiftCards, HasImageAltText, ImageMethods, Images, ImagesHelper, ImportSchemas, Imports, IntegrationsConcern, IntegrationsHelper, Invitations, LineItems, LocaleHelper, Locales, MemoizedData, Metadata, Metafields, NamedType, Newsletter, NumberAsParam, NumberIdentifier, OptionValues, Orders, ParameterizableName, PaymentSourceConcern, Payments, PermissionSets, PermittedAttributes, Preferences, PrefixedId, PriceRules, Pricing, ProductFilterable, ProductScopes, Products, ProductsHelper, PromotionHandler, Publishable, RansackableAttributes, ReportLineItems, Reports, SampleData, SearchIndexable, SearchProvider, Searchable, Seeds, ServiceModule, Shared, ShipmentHelper, Shipments, SingleStoreResource, Stock, StockLocations, StoreScopedResource, Stores, Tags, TaxonRules, Taxons, TestingSupport, Themes, TrackingNumbers, TranslatableResource, TranslatableResourceScopes, TranslatableResourceSlug, UniqueName, UserAddress, UserManagement, UserMethods, UserPaymentSource, UserReporting, UserRoles, Variants, VatPriceCalculation, Wallet, Webhooks
Classes: Ability, Address, Adjustment, AllowedOrigin, AnalyticsConfig, ApiKey, Asset, Base, BaseAnalyticsEventHandler, BaseController, BaseFinder, BaseJob, BaseMailer, BaseSorter, Calculator, Category, Classification, CompareLineItems, Country, CountryToTimezone, CouponCode, CreditCard, Current, CustomerGroup, CustomerGroupUser, CustomerReturn, DataFeed, DependencyError, Digital, DigitalLink, DummyGenerator, DummyModelGenerator, Event, EventLogSubscriber, Exchange, Export, ExportMailer, ExportSubscriber, FulfilmentChanger, Gateway, GatewayCustomer, GenerateToken, GiftCard, GiftCardBatch, Image, Import, ImportMapping, ImportRow, ImportSchema, Integration, InventoryUnit, Invitation, InvitationEmailSubscriber, InvitationMailer, LegacyAdminUser, LegacyUser, LineItem, LocalizedNumber, LogEntry, Market, MarketCountry, Metafield, MetafieldDefinition, Migrations, ModelDecoratorGenerator, ModelGenerator, Money, NewsletterSubscriber, OptionType, OptionTypePrototype, OptionValue, OptionValueVariant, Order, OrderContents, OrderInventory, OrderMerger, OrderPromotion, OrderUpdater, Payment, PaymentCaptureEvent, PaymentConnectionError, PaymentMethod, PaymentResponse, PaymentSession, PaymentSetupSession, PaymentSource, PermissionConfiguration, Policy, Preference, Price, PriceHistory, PriceList, PriceRule, Product, ProductMetricsSubscriber, ProductOptionType, ProductPromotionRule, ProductSummaryPresenter, Promotion, PromotionAction, PromotionActionLineItem, PromotionCategory, PromotionRule, PromotionRuleTaxon, PromotionRuleUser, Prototype, PrototypeTaxon, RansackConfiguration, RefreshToken, Refund, RefundReason, Reimbursement, ReimbursementPerformer, ReimbursementTaxCalculator, ReimbursementType, Report, ReportLineItem, ReportMailer, ReportSubscriber, ReturnAuthorization, ReturnAuthorizationReason, ReturnItem, ReturnsCalculator, Role, RoleUser, Shipment, ShipmentHandler, ShippingCalculator, ShippingCategory, ShippingMethod, ShippingMethodCategory, ShippingMethodZone, ShippingRate, State, StateChange, StockItem, StockLocation, StockMovement, StockTransfer, Store, StoreCredit, StoreCreditCategory, StoreCreditEvent, StoreCreditType, StorePaymentMethod, StoreProduct, StorePromotion, Subscriber, TaxCategory, TaxRate, Taxon, TaxonRule, Taxonomy, TranslationHelperWrapper, TranslationMigrations, UrlValidator, UserIdentity, Variant, VariantPresenter, WebhookDelivery, WebhookEndpoint, WebhookMailer, WishedItem, Wishlist, Zone, ZoneMember
Constant Summary
collapse
- VERSION =
'5.4.1'.freeze
- MultiSearchable =
Backward compatibility alias — remove in Spree 6.0
Searchable
Class Attribute Summary collapse
Class Method Summary
collapse
Class Attribute Details
.missing_translation_messages ⇒ Object
Returns the value of attribute missing_translation_messages.
12
13
14
|
# File 'lib/spree/testing_support/i18n.rb', line 12
def missing_translation_messages
@missing_translation_messages
end
|
.unused_translation_messages ⇒ Object
Returns the value of attribute unused_translation_messages.
12
13
14
|
# File 'lib/spree/testing_support/i18n.rb', line 12
def unused_translation_messages
@unused_translation_messages
end
|
.unused_translations ⇒ Object
Returns the value of attribute unused_translations.
12
13
14
|
# File 'lib/spree/testing_support/i18n.rb', line 12
def unused_translations
@unused_translations
end
|
.used_translations ⇒ Object
Returns the value of attribute used_translations.
12
13
14
|
# File 'lib/spree/testing_support/i18n.rb', line 12
def used_translations
@used_translations
end
|
Class Method Details
.adjusters ⇒ Object
228
229
230
|
# File 'lib/spree/core.rb', line 228
def self.adjusters
Rails.application.config.spree.adjusters
end
|
.adjusters=(value) ⇒ Object
232
233
234
|
# File 'lib/spree/core.rb', line 232
def self.adjusters=(value)
Rails.application.config.spree.adjusters = value
end
|
.admin_user_class(constantize: true) ⇒ Object
64
65
66
67
68
69
70
|
# File 'lib/spree/core.rb', line 64
def self.admin_user_class(constantize: true)
if @@admin_user_class.is_a?(Class)
raise 'Spree.admin_user_class MUST be a String or Symbol object, not a Class object.'
elsif @@admin_user_class.is_a?(String) || @@admin_user_class.is_a?(Symbol)
constantize ? @@admin_user_class.to_s.constantize : @@admin_user_class.to_s
end
end
|
.always_use_translations? ⇒ Boolean
162
163
164
|
# File 'lib/spree/core.rb', line 162
def self.always_use_translations?
Spree::Config.always_use_translations
end
|
.analytics ⇒ Object
341
342
343
|
# File 'lib/spree/core.rb', line 341
def self.analytics
@analytics ||= AnalyticsConfig.new
end
|
.available_locales ⇒ Object
19
20
21
22
23
24
25
26
|
# File 'lib/spree/i18n.rb', line 19
def available_locales
locales = defined?(SpreeI18n) ? SpreeI18n::Locale.all.map(&:to_sym) : []
locales << :en
locales << I18n.locale
locales << Rails.application.config.i18n.default_locale
locales.uniq.compact
end
|
.base_class(constantize: true) ⇒ Object
47
48
49
50
51
52
53
54
|
# File 'lib/spree/core.rb', line 47
def self.base_class(constantize: true)
@@base_class ||= 'Spree::Base'
if @@base_class.is_a?(Class)
raise 'Spree.base_class MUST be a String or Symbol object, not a Class object.'
elsif @@base_class.is_a?(String) || @@base_class.is_a?(Symbol)
constantize ? @@base_class.to_s.constantize : @@base_class.to_s
end
end
|
.calculators ⇒ Object
Environment accessors for easier configuration access Instead of Rails.application.config.spree.payment_methods you can use Spree.payment_methods
204
205
206
|
# File 'lib/spree/core.rb', line 204
def self.calculators
Rails.application.config.spree.calculators
end
|
.calculators=(value) ⇒ Object
208
209
210
|
# File 'lib/spree/core.rb', line 208
def self.calculators=(value)
Rails.application.config.spree.calculators = value
end
|
.check_missing_translations ⇒ Object
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
|
# File 'lib/spree/testing_support/i18n.rb', line 28
def self.check_missing_translations
self.missing_translation_messages = []
self.used_translations ||= []
used_translations.map { |a| a.split('.') }.each do |translation_keys|
root = translations
processed_keys = []
translation_keys.each do |key|
root = root.fetch(key.to_sym)
processed_keys << key.to_sym
rescue KeyError
error = "#{(processed_keys << key).join('.')} (#{I18n.locale})"
unless Spree.missing_translation_messages.include?(error)
Spree.missing_translation_messages << error
end
end
end
end
|
.check_unused_translations ⇒ Object
46
47
48
49
50
51
52
53
54
55
|
# File 'lib/spree/testing_support/i18n.rb', line 46
def self.check_unused_translations
self.used_translations ||= []
self.unused_translation_messages = []
self.unused_translations = []
load_translations(translations)
translation_diff = unused_translations - used_translations
translation_diff.each do |translation|
Spree.unused_translation_messages << "#{translation} (#{I18n.locale})"
end
end
|
.config ⇒ Object
Used to configure Spree.
Example:
Spree.config do |config|
config.track_inventory_levels = false
end
This method is defined within the core gem on purpose. Some people may only wish to use the Core part of Spree.
180
181
182
183
184
|
# File 'lib/spree/core.rb', line 180
def self.config
Rails.application.config.after_initialize do
yield(Spree::Config)
end
end
|
.data_feed_types ⇒ Object
260
261
262
|
# File 'lib/spree/core.rb', line 260
def self.data_feed_types
Rails.application.config.spree.data_feed_types
end
|
.data_feed_types=(value) ⇒ Object
264
265
266
|
# File 'lib/spree/core.rb', line 264
def self.data_feed_types=(value)
Rails.application.config.spree.data_feed_types = value
end
|
.dependencies {|Spree::Dependencies| ... } ⇒ Object
Used to set dependencies for Spree.
Example:
Spree.dependencies do |dependency|
dependency.cart_add_item_service = MyCustomAddToCart
end
This method is defined within the core gem on purpose. Some people may only wish to use the Core part of Spree.
196
197
198
|
# File 'lib/spree/core.rb', line 196
def self.dependencies
yield(Spree::Dependencies)
end
|
.events_adapter_class(constantize: true) ⇒ Class, String
Returns the events adapter class used for publishing and subscribing to events.
148
149
150
151
152
153
154
155
156
|
# File 'lib/spree/core.rb', line 148
def self.events_adapter_class(constantize: true)
@@events_adapter_class ||= 'Spree::Events::Adapters::ActiveSupportNotifications'
if @@events_adapter_class.is_a?(Class)
raise 'Spree.events_adapter_class MUST be a String or Symbol object, not a Class object.'
elsif @@events_adapter_class.is_a?(String) || @@events_adapter_class.is_a?(Symbol)
constantize ? @@events_adapter_class.to_s.constantize : @@events_adapter_class.to_s
end
end
|
.export_types ⇒ Object
268
269
270
|
# File 'lib/spree/core.rb', line 268
def self.export_types
Rails.application.config.spree.export_types
end
|
.export_types=(value) ⇒ Object
272
273
274
|
# File 'lib/spree/core.rb', line 272
def self.export_types=(value)
Rails.application.config.spree.export_types = value
end
|
.google_places_api_key ⇒ Object
158
159
160
|
# File 'lib/spree/core.rb', line 158
def self.google_places_api_key
@@google_places_api_key
end
|
.import_types ⇒ Object
276
277
278
|
# File 'lib/spree/core.rb', line 276
def self.import_types
Rails.application.config.spree.import_types
end
|
.import_types=(value) ⇒ Object
280
281
282
|
# File 'lib/spree/core.rb', line 280
def self.import_types=(value)
Rails.application.config.spree.import_types = value
end
|
.integrations ⇒ Object
312
313
314
|
# File 'lib/spree/core.rb', line 312
def self.integrations
Rails.application.config.spree.integrations
end
|
.integrations=(value) ⇒ Object
316
317
318
|
# File 'lib/spree/core.rb', line 316
def self.integrations=(value)
Rails.application.config.spree.integrations = value
end
|
.line_item_comparison_hooks ⇒ Object
252
253
254
|
# File 'lib/spree/core.rb', line 252
def self.line_item_comparison_hooks
Rails.application.config.spree.line_item_comparison_hooks
end
|
.line_item_comparison_hooks=(value) ⇒ Object
256
257
258
|
# File 'lib/spree/core.rb', line 256
def self.line_item_comparison_hooks=(value)
Rails.application.config.spree.line_item_comparison_hooks = value
end
|
.load_translations(hash, root = []) ⇒ Object
59
60
61
62
63
64
65
66
67
68
|
# File 'lib/spree/testing_support/i18n.rb', line 59
def self.load_translations(hash, root = [])
hash.each do |k, v|
if v.is_a?(Hash)
load_translations(v, root.dup << k)
else
key = (root + [k]).join('.')
unused_translations << key
end
end
end
|
308
309
310
|
# File 'lib/spree/core.rb', line 308
def self.metafields
Rails.application.config.spree.metafields
end
|
.method_missing(method_name, *args, &block) ⇒ Object
Dynamic methods for core dependencies
401
402
403
404
405
406
407
408
409
410
411
412
|
# File 'lib/spree/core.rb', line 401
def method_missing(method_name, *args, &block)
base_name = method_name.to_s.chomp('=').to_sym
return super unless core_dependency?(base_name)
if method_name.to_s.end_with?('=')
Spree::Dependencies.send(method_name, args.first)
else
Spree::Dependencies.send("#{method_name}_class")
end
end
|
.normal_t ⇒ Object
Add spree namespace and delegate to Rails TranslationHelper for some nice extra functionality. e.g return reasonable strings for missing translations
14
15
16
17
18
|
# File 'lib/spree/testing_support/i18n.rb', line 14
def translate(key, options = {})
options[:scope] = [*options[:scope]].unshift(:spree).uniq
TranslationHelperWrapper.new.translate(key, **options)
end
|
.payment_methods ⇒ Object
220
221
222
|
# File 'lib/spree/core.rb', line 220
def self.payment_methods
Rails.application.config.spree.payment_methods
end
|
.payment_methods=(value) ⇒ Object
224
225
226
|
# File 'lib/spree/core.rb', line 224
def self.payment_methods=(value)
Rails.application.config.spree.payment_methods = value
end
|
Permission configuration accessor for managing role-to-permission-set mappings.
.pricing ⇒ Object
333
334
335
|
# File 'lib/spree/core.rb', line 333
def self.pricing
Rails.application.config.spree.pricing
end
|
.pricing=(value) ⇒ Object
337
338
339
|
# File 'lib/spree/core.rb', line 337
def self.pricing=(value)
Rails.application.config.spree.pricing = value
end
|
.private_storage_service_name ⇒ Object
72
73
74
75
76
77
78
79
80
|
# File 'lib/spree/core.rb', line 72
def self.private_storage_service_name
if @@private_storage_service_name
if @@private_storage_service_name.is_a?(String) || @@private_storage_service_name.is_a?(Symbol)
@@private_storage_service_name.to_sym
end
else
Rails.application.config.active_storage.service
end
end
|
244
245
246
|
# File 'lib/spree/core.rb', line 244
def self.promotions
Rails.application.config.spree.promotions
end
|
248
249
250
|
# File 'lib/spree/core.rb', line 248
def self.promotions=(value)
Rails.application.config.spree.promotions = value
end
|
.public_storage_service_name ⇒ Object
82
83
84
85
86
87
88
89
90
|
# File 'lib/spree/core.rb', line 82
def self.public_storage_service_name
if @@public_storage_service_name
if @@public_storage_service_name.is_a?(String) || @@public_storage_service_name.is_a?(Symbol)
@@public_storage_service_name.to_sym
end
else
Rails.application.config.active_storage.service
end
end
|
.queues ⇒ Object
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
|
# File 'lib/spree/core.rb', line 96
def self.queues
@@queues ||= OpenStruct.new(
default: :default,
events: :default,
exports: :default,
images: :default,
imports: :default,
products: :default,
reports: :default,
variants: :default,
taxons: :default,
stock_location_stock_items: :default,
coupon_codes: :default,
themes: :default,
addresses: :default,
gift_cards: :default,
webhooks: :default,
payment_webhooks: :default,
api_keys: :default,
search: :default
)
end
|
Ransack configuration accessor for managing custom ransackable attributes, associations, and scopes across Spree models.
.reports ⇒ Object
292
293
294
|
# File 'lib/spree/core.rb', line 292
def self.reports
Rails.application.config.spree.reports
end
|
.reports=(value) ⇒ Object
296
297
298
|
# File 'lib/spree/core.rb', line 296
def self.reports=(value)
Rails.application.config.spree.reports = value
end
|
.respond_to_missing?(method_name, include_private = false) ⇒ Boolean
414
415
416
417
|
# File 'lib/spree/core.rb', line 414
def respond_to_missing?(method_name, include_private = false)
base_name = method_name.to_s.chomp('=').to_sym
core_dependency?(base_name) || super
end
|
.root_domain ⇒ Object
92
93
94
|
# File 'lib/spree/core.rb', line 92
def self.root_domain
@@root_domain
end
|
.search_provider ⇒ Object
Search provider class name. Controls product search, filtering, and faceted navigation.
Spree.search_provider = 'Spree::SearchProvider::Meilisearch'
133
134
135
|
# File 'lib/spree/core.rb', line 133
def self.search_provider
@@search_provider ||= 'Spree::SearchProvider::Database'
end
|
.search_provider=(value) ⇒ Object
137
138
139
|
# File 'lib/spree/core.rb', line 137
def self.search_provider=(value)
@@search_provider = value.to_s
end
|
.searcher_class(constantize: true) ⇒ Object
125
126
127
|
# File 'lib/spree/core.rb', line 125
def self.searcher_class(constantize: true)
@@searcher_class
end
|
.searcher_class=(value) ⇒ Object
Deprecated.
Spree.searcher_class is deprecated and will be removed in Spree 5.5. Use Spree.search_provider instead.
120
121
122
123
|
# File 'lib/spree/core.rb', line 120
def self.searcher_class=(value)
Spree::Deprecation.warn('Spree.searcher_class is deprecated and will be removed in Spree 5.5. Use Spree.search_provider instead.')
@@searcher_class = value
end
|
.stock_splitters ⇒ Object
236
237
238
|
# File 'lib/spree/core.rb', line 236
def self.stock_splitters
Rails.application.config.spree.stock_splitters
end
|
.stock_splitters=(value) ⇒ Object
240
241
242
|
# File 'lib/spree/core.rb', line 240
def self.stock_splitters=(value)
Rails.application.config.spree.stock_splitters = value
end
|
.subscribers ⇒ Object
Event subscribers that handle lifecycle and custom events
325
326
327
|
# File 'lib/spree/core.rb', line 325
def self.subscribers
Rails.application.config.spree.subscribers
end
|
.subscribers=(value) ⇒ Object
329
330
331
|
# File 'lib/spree/core.rb', line 329
def self.subscribers=(value)
Rails.application.config.spree.subscribers = value
end
|
.taxon_rules ⇒ Object
284
285
286
|
# File 'lib/spree/core.rb', line 284
def self.taxon_rules
Rails.application.config.spree.taxon_rules
end
|
.taxon_rules=(value) ⇒ Object
288
289
290
|
# File 'lib/spree/core.rb', line 288
def self.taxon_rules=(value)
Rails.application.config.spree.taxon_rules = value
end
|
.translatable_resources ⇒ Object
300
301
302
|
# File 'lib/spree/core.rb', line 300
def self.translatable_resources
Rails.application.config.spree.translatable_resources
end
|
.translatable_resources=(value) ⇒ Object
304
305
306
|
# File 'lib/spree/core.rb', line 304
def self.translatable_resources=(value)
Rails.application.config.spree.translatable_resources = value
end
|
.translate(key, options = {}) ⇒ Object
Also known as:
t
Add spree namespace and delegate to Rails TranslationHelper for some nice extra functionality. e.g return reasonable strings for missing translations
13
14
15
16
17
|
# File 'lib/spree/i18n.rb', line 13
def translate(key, options = {})
options[:scope] = [*options[:scope]].unshift(:spree).uniq
TranslationHelperWrapper.new.translate(key, **options)
end
|
.translations ⇒ Object
70
71
72
|
# File 'lib/spree/testing_support/i18n.rb', line 70
def self.translations
@translations ||= I18n.backend.send(:translations)[I18n.locale][:spree]
end
|
.use_translations? ⇒ Boolean
166
167
168
|
# File 'lib/spree/core.rb', line 166
def self.use_translations?
Spree::Config.always_use_translations || I18n.default_locale != I18n.locale
end
|
.user_class(constantize: true) ⇒ Object
56
57
58
59
60
61
62
|
# File 'lib/spree/core.rb', line 56
def self.user_class(constantize: true)
if @@user_class.is_a?(Class)
raise 'Spree.user_class MUST be a String or Symbol object, not a Class object.'
elsif @@user_class.is_a?(String) || @@user_class.is_a?(Symbol)
constantize ? @@user_class.to_s.constantize : @@user_class.to_s
end
end
|
.validators ⇒ Object
212
213
214
|
# File 'lib/spree/core.rb', line 212
def self.validators
Rails.application.config.spree.validators
end
|
.validators=(value) ⇒ Object
216
217
218
|
# File 'lib/spree/core.rb', line 216
def self.validators=(value)
Rails.application.config.spree.validators = value
end
|
.version ⇒ Object
4
5
6
|
# File 'lib/spree/core/version.rb', line 4
def self.version
VERSION
end
|