Major/New Features
3.7 release is our last 3.x line release bridging the gap between 3.x and Spree 4.0. This is a big release packed with several amazing features and a huge number of bug fixes (over 700 commits by 17 contributors!). Upgrading to 3.7 guarantees a smooth and easy migration to Spree 4.0 (April 2019 with Rails 6.0 support).
Spree 3.7 requires Rails 5.2.2 and Ruby 2.3.3 (or higher).
Storefront API v2
We've worked hard over the last few months to deliver a completely new, easy to work with and lightweight REST API for building amazing customer interfaces with modern JavaScript libraries (React, Vue, Angular) and for native mobile apps. New Storefront API v2 is fast, easy to use and extend. It's also well documented in OpenAPI 3.0 (Swagger) format which you can import into Postman app.
New API is based on JSON API spec and uses blazing fast Netflix fast_json_api serializer library. Authentication is based on Oauth using doorkeeper library. Besides that there are no additional dependencies making it lightweight and future-proof.
Storefront API v2 consists of:
- Cart endpoints (Create Cart, Add Item, Set Quantity, Remove Item, Empty Cart)
- Checkout endpoints (Update Checkout, Advance Checkout, Complete Checkout, Add/Remove Store Credit, Get Shiping Rates, Get Payment Methods)
- Products Catalog
- Taxons Catalog
- Account endpoints (Account Information, Credit Cards, placed Orders)
- Order Status
- Countries
- Authentication
All of the endpoints support JSON API's Sparse Fieldsets to fix usual Over-Fetching issues and Related Resources to reduce the number of API queries you need to perform.
Service Oriented Architecture
While building the API v2 we've also refactored a huge portion of Spree internals by introducing modular Service Oriented Architecture to the codebase.
We're in the process of moving domain-specific code from models to Service Objects
with a well-defined scope and predictable return values. All service objects include Service Module which unifies how those classes handle arguments and what they return.
Also, we're moving away from ransack library by introducing Finders
and Sorters
classes for simpler fetching resources and collections.
This makes Spree codebase easier to read and learn. It also makes any customizations way easier. At the same time, public APIs won't change a lot as providing backward compatibility is one of our top priorities.
Dependencies system
We're introducing a new painless way of customizing Spree without the need of decorators. With Dependencies you can easily replace parts of Spree internals with your custom classes. You can replace Services, Abilities and Serializers. More will come in the future. We hope using Dependencies will remove the need for creating decorators at all!
Removing Coffee Script
CoffeeScript a few years back ago was a really great JavaScript enhancement. Nowadays with ES6 and TypeScript around it became obsolete. That's why we've converted all of the CoffeeScript assets in Spree and extensions to plain JavaScript and removed CoffeeScript dependency.
Improved MySQL support
A lot of merchants were using Spree with MySQL for years now, but development of the platform was mainly focused on PostgreSQL support. We've changed that and all of our CI builds are tested and verified against both PostgreSQL and MySQL. We've also fixed all MySQL-related bugs.
Installation
Add Spree gems to Gemfile
gem 'spree', '~> 3.7.0'
gem 'spree_auth_devise', '~> 3.5'
gem 'spree_gateway', '~> 3.4'
Run bundle install
Use the install generators to set up Spree
rails g spree:install --user_class=Spree::User
rails g spree:auth:install
rails g spree_gateway:install
Upgrade
Spree 3.6 to 3.7 upgrade guide
Noteworthy changes
Please review each of the noteworthy changes to ensure your customizations or extensions are not affected. If you are affected by a change, and have any suggestions please submit a PR to help the next person!
-
Dropped support for Ruby 2.2
-
Support multiple currencies for
Store Credits
management in Admin Panel -
Added information if Product is backorderable on Product page
-
Improved OmniChannel support in the Admin Panel
-
Improved error handling for XHR requests in the Admin Panel
-
Improved Admin Panel Variant autocomplete
-
Order
is now associated withStore
, the presence ofStore
is required for validation -
Order
now has to havecurrency
value set -
Made
CreditCard
deleted softly by default -
Payment
source
needs to be present (validation can be turned off viasource_required?
inPaymentMethod
) -
Added
StockLocation#name
unique validation -
Added
FulfilmentChanger
class -
Extended
OrderPromotion
model -
Added
ShippingRate#final_price
method -
Added
Shipment#free?
method -
Added
Product#default_variant
andProduct#default_variant_id
methods -
Delegated
iso
andiso_name
inAddress
model toCountry
-
Replaced
jquery.cookie
withjs.cookie
-
Fixed deprecation warning:
BigDecimal.new() is deprecated
-
Fixed displaying currency in
Admin Panel
->Return Authorizations
-
Fixed all deprecations of Ruby Money 6.13+
-
Fallback to
Order#currency
if there's no currency set forAdjustment
-
Renamed
Order#guest_token
toOrder#token
-
Renamed
Admin::GeneralSettingsHelper
toAdmin::CurrencyHelper
-
Renamed
TaxonIcon
toTaxonImage
-
Deprecated
OrderContents
and replaced with severalCart
services (eg.Cart::AddItem
) -
Deprecated
Order#add_store_credit_payments
in favor ofCheckout::AddStoreCredit
service -
Deprecated
Order#remove_store_credit_payments
in favor ofCheckout::RemoveStoreCredit
service -
Deprecated
OrdersController#populate
andOrdersController#populate_redirect
-
Deprecated
Address#same_as?
in favor ofAddress#==
-
Deprecated
Order#add register_line_item_comparison_hook
(please useRails.application.config.spree.line_item_comparison_hooks << hook
instead) -
Deprecated
ControllerHelpers::RespondWith
-
Deprecated
BaseHelper#variant_options
-
Deprecated
Address#iso_name
, please useAddress#country_iso_name
-
Removed previously deprecated
Spree::Core::EnvironmentExtension
-
Removed previously deprecated
ControllerHelpers::Common#render_404
-
Removed previously deprecated
EmailValidator
-
Removed previously deprecated
NavigationHelper#icon
-
Removed previously deprecated
FrontendHelper#breadcrums
-
Removed
Product#distinct_by_product_ids
-
Bumped
highline
dependency to2.0.x
-
Bumped
paperclip
dependency to6.1.x
-
Bumped
bootstrap-sass
to3.4.x
Full Changelog
You can view the full changes using Github Compare.