Shopping Cart
Project description
Shopping cart for plone.
Base package Installation
Depend your instance to bda.plone.cart and install it as addon in plone control panel.
Provide contracts
This package provides components needed to render a shopping cart. It expects several contracts defined in:
bda.plone.cart.interfaces.ICartDataProvider
bda.plone.cart.interfaces.ICartItemDataProvider
bda.plone.cart.interfaces.ICartItemStock
bda.plone.cart.interfaces.ICartItemPreviewImage
bda.plone.cart.interfaces.ICartItemAvailability
bda.plone.cart.interfaces.ICartItemState
bda.plone.cart.interfaces.ICartDiscount
bda.plone.cart.interfaces.ICartItemDiscount
Please take a look at the corresponding interfaces for contract details. Further some abstract base implementations are available in bda.plone.cart.__init__ which can be used as base class for concrete implementations.
Cart Visibility
The cart can be rendered as a portlet or inside a viewlet in the portal header. It’s not possible to render the cart twice in one page. Thus, the viewlet gets skipped automatically if a cart portlet assignment is found. Also, if cart summary, checkout, order confirmation or portal factory is rendered, regular cart rendering gets skipped.
Its possible to define custom patterns which are checked against recent browser URL defining whether to skip cart rendering. This is useful for custom payment implementations and similar:
from bda.plone.cart.browser.portlet import SKIP_RENDER_CART_PATTERNS
SKIP_RENDER_CART_PATTERNS.append('@@my_payment')A ready-to-use implementation
Concrete implementations of the expected contracts already exists in bda.plone.shop for Archetypes and Dexterity. Please refer to https://github.com/bluedynamics/bda.plone.shop for more details.
Markup
Take a look at bda.plone.cart.browser:tile.pt how HTML markup for adding items to cart might look like.
Basically a shop item consists of a container DOM element, containing an element with CSS class cart_item_uid, where the item UID is taken from:
<span class="cart_item_uid" style="display: none;">12345678</span>a text input field with CSS class cart_item_count which is read for item count:
<input type="text" size="2" value="1" class="cart_item_count" />a quantity unit:
<span class="cart_item_quantity_unit">Quantity</span>If quantity unit can be be float, add quantity_unit_float CSS class:
<input type="text" size="2" value="1"
class="cart_item_count quantity_unit_float" />the “add to Cart” action:
<a href="" class="add_cart_item">add to cart</a>and the “update cart” action:
<a href="" class="update_cart_item">update cart</a>Optionally, If cart viewlet is used, a status message can be displayed when adding or updating cart items. This is useful if user should get clearly informed if cart data has changed. To display status messages, add CSS class show_status_message to “add to cart” and “update cart” actions:
<a href="" class="update_cart_item show_status_message">update cart</a>and optionally an element defining a comment or an input for entering a comment:
<input type="text" size="16" value="" class="cart_item_comment" />If comment should be required, add CSS class required to comment input. If comment is empty, an error message gets shown to the user when trying to add or update a cart item:
<input type="text" size="16" value="" class="cart_item_comment required" />Create translations
$ cd src/bda/plone/cart/ $ ./i18n.sh
Develop CSS Styles
CSS Styles are written in Sass and compiled via npm:
$ npm install $ npm run build # to build the resources or $ npm run watch # to watch changes during development
Contributors
Robert Niederreiter (Autor)
Sven Plage
Peter Holzer
Harald Friessnegger
Peter Mathis
Espen Moe-Nilssen
Johannes Raggam
Jure Cerjak
Icons by famfamfam
Changelog
2.0b1 (2024-04-17)
rewrite LESS resources to SASS and remove grunt in favor of npm/sass [petschki]
Use bs popover markup to display cart status message. [rnix]
Remove decimal_converter and rely on plone.restapi>=6.13.7 [agitator]
Mark cart item in summary and portlet if comment is enabled or not. [jensens]
Fix broken remove from cart in summary. [jensens]
Handle count number localized. [jensens]
No longer support for z3c.autoinclude. [jensens]
More CSS classes on cart [jensens]
Fix problem, when cart item value is removed while typing item was removed from cart. [jensens]
Fix problem, when in listing the to be added number changes was immediately is added to the cart. [jensens]
Moved shipping code over to here. [jensens]
Refactored lots of code out of init into more semantic modules. [jensens]
Added RESTAPI [jensens]
Code style black. [jensens]
Python 2/3 compatibility [agitator]
Update version and classifiers - 2.x targets Plone 5.1/5.2 without Archetypes [agitator]
Italian translations [ale-rt]
switch to Plone 6 icon resolver [petschki]
1.0a1 (unreleased)
Keep cart item cound focus after auto update. [rnix]
Auto update cart if item count changes. [rnix]
Replace unittest2 with untittest. [llisa123]
Introduce bda.plone.cart.browser.portlet.SKIP_RENDER_CART_PATTERNS which can be used to define patterns which are checked against actual browser URL defining whether to skip cart rendering. [rnix]
In cart.js, make code blocks dealing with add and update after click event available for third party code. A move of the two anonymous functions in its own named functions, named update_cart_item and add_cart_item taking the node as parameter there were called on. [jensens]
In cart.js, allow also a select for count. [jensens. agitator]
Add support for displaying cart item discount in cart. [rnix]
Add get_item_shipping and cart_item_free_shipping utilities. [rnix]
Fix typo. Rename remaining card_item_tempate to cart_item_tempate. This already has been changed for summary and overview (in bda.plone.checkout) but was missing in cart.js and tile.pt fixes #31. Make sure to fix this in all your cart related custom templates! [rnix]
More precise selectors for cart item template, cart summary discount and cart summary shipping in cart.js. [rnix]
Use code for safe uid also for get_object_by_uid and use plone.api. [jensens]
fixed selector typo #cart_viewlet_summery with #cart_viewlet_summary [agitator]
Pass comment in JS from add/update cart to server side validation. [jensens]
use MwSt. instead of Ust. in german [agitator]
added data-context-url for sane cartData and validate_cart_item calls on Plone 5 [agitator]
Plone 5 update [agitator]
extractitems now returns a namedtuple with attributes uid, count and comment [jensens]
0.10.dev2
Resolve JSHint errors and warnings. [thet]
Fix cart item not removable, if comment is required. Fixes #17, fixes #12. [thet]
Remove portlet’s cartWrapper div node. It’s not used at all and only introduces non-standard portlet HTML markup. [thet]
By default, cart viewlet is hidden and gets displayed as soon as cart items are fetched. [rnix]
Consider hide cart if empty setting on cart viewlet. [rnix]
Hide unset preview images for cart item. [rnix]
Cart can display status message if cart data gets modified. [rnix]
Cart might be rendered as viewlet in portal header instead of as portlet. [rnix]
Do not expect IShippingItem to be implemented. See also https://github.com/bluedynamics/bda.plone.shop/issues/31 [jensens]
No caching/merging of cart.translations.js [agitator]
0.9
Quote/Unqote special characters in cart cookie only for cart item comment. Thus we can have any characters in comment. “Invalid comment characters” validation and error message no longer necessary. [rnix]
0.8
Use decodeURIComponent instead of deprectaed unescape in cart.js. [rnix]
Catch ValueError if given uid value is no valid uuid.UUID string in get_catalog_brain. [rnix]
Let get_catalog_brain and thus get_object_by_uid handle uuid.UUID objects, hex strings like ‘8de81513431752d5f32c680db93dda0c’ and UUID object representation strings like ‘8de81513-4317-52d5-f32c-680db93dda0c’. [thet]
Encode umlaut characters in cart item comment. [rnix]
0.7
Add comment label in cart summary template. [rnix]
0.6
Hide discount and shipping info in cart via JS if data changed respective. [rnix]
Remove include_shipping_costs property from CartView. [rnix]
Always deliver shipping markup for cart, control with JS whether shipping costs are displayed. [rnix]
Move bda.plone.cart.browser.CURRENCY_LITERALS to bda.plone.cart.CURRENCY_LITERALS. [rnix]
Add ICartDataProvider.max_artice_count attribute and implement in CartDataProviderBase. [rnix]
Add bda.plone.cart.cart_item_shippable utility. [rnix]
Implement ICartDataProvider.include_shipping_costs on CartDataProviderBase using bda.plone.shipping.interfaces.IShippingItem.shipping flag for calculation. [rnix]
Add ICartDataProvider.total attribute and implement in CartDataProviderBase. [rnix]
Use readcookie instead of expecting items request parameter in CartDataProviderBase.data. [rnix]
Do not pass recent cart items parameter to @@cartData view, contained value is included as cart cookie anyways. [rnix]
Adopt shipping handling to bda.plone.shipping >= 0.4. [rnix]
CartDataProviderBase no longer provides default values for currency, cart_url, show_to_cart, show_checkout and show_currency. [rnix]
Add browser view rendering a JS snippet for Cart JS translations. Cart translations are now handled via message catalogs. [rnix]
Fix validation of comment characters in cart JS. [rnix]
0.5
Add a title property to the ICartItemDataProvider accessor interface to allow customizations of the cart item title. This can be used to give more context on the cart item, e.g. for a buyable within another content item. [thet]
0.4
Cart validation considers update flag on error. [rnix]
Introduce remove_item_from_cart utility function. [rnix]
validate_set of CartDataProviderBase raises NotImplementedError. [rnix]
Hanlde article_limit_reached message on server side. [rnix]
Extend bda.plone.cart.interfaces.ICartItemDataProvider by cart_count_limit. [rnix]
Fix and refactor max article count for cart. [rnix]
Add hide_cart_if_empty property to bda.plone.cart.interfaces.ICartDataProvider, integrate in bda.plone.cart.CartDataProviderBase and consider in Cart JS. [rnix]
Add display property to bda.plone.cart.interfaces.ICartItemStock and and expose it via bda.plone.cart.CartItemAvailabilityBase [rnix]
Add bda.plone.cart.CartItemDataProviderBase class. [rnix]
Extend bda.plone.cart.interfaces.ICartItemDataProvider by discount_enabled and discount_net. [rnix]
Introduce bda.plone.cart.interfaces.ICartDiscount. [rnix]
Introduce bda.plone.cart.interfaces.ICartItemDiscount. [rnix]
Fix BrowserLayer order precedence. [thet]
0.3
Add get_item_delivery helper function for looking up IItemDelivery adapter. [rnix]
0.2
Introduce bda.plone.cart.interfaces.ICartItemState. [rnix]
Introduce bda.plone.cart.interfaces.ICartItemAvailability. [rnix]
Introduce bda.plone.cart.interfaces.ICartItemStock. [rnix]
Allow the cart portlet in the left column too. [fRiSi]
Add adapter for cart item preview images [petschki]
0.1
initial work [rnix]
License
Copyright (c) 2012-2019, BlueDynamics Alliance, Austria All rights reserved.
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
Neither the name of the BlueDynamics Alliance nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY BlueDynamics Alliance AS IS AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL BlueDynamics Alliance BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file bda.plone.cart-2.0b1.tar.gz.
File metadata
- Download URL: bda.plone.cart-2.0b1.tar.gz
- Upload date:
- Size: 69.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.0.0 CPython/3.9.2
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 30f9ed514e0ad4649eb3262370a3a724250fac656508dabe768dc0a733105ab0 |
|
| MD5 | 27addea5a8224642b50134d071b15d97 |
|
| BLAKE2b-256 | a801a5f6b1f8b880b6d49c60bfdfb87ca2f580365ee24b56406c0e7e986db38f |
File details
Details for the file bda.plone.cart-2.0b1-py3-none-any.whl.
File metadata
- Download URL: bda.plone.cart-2.0b1-py3-none-any.whl
- Upload date:
- Size: 85.4 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.0.0 CPython/3.9.2
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 638b18734b701649754303839f6f66120cbf45272a1958f35791cf3c72b22ff6 |
|
| MD5 | 18561924d24ec679dac723b8e20d87f4 |
|
| BLAKE2b-256 | ee05d44a8f56a8ffd314c0ac054a5c1b0e10af6d7a0a3f5fc6e17a393e07e0ad |
