Adjustments Refactoring

A talk that goes into the reasons why we refactored Spree's adjustments system.

Transcript

7. Adjusting Adjustments Ryan Bigg
8. Orders
10. 1. Retain order-wide adjustments "We screwed up. Have $20 off your whole order."
11. 2. Discounts + Credits "Use 10off to get 10% off this weekend!" "We screwed up. Have $20 off your whole order."
12. 3. Discounts for specific customers 15% off for .edu customers! 5% off for members!
13. 4. Shipping taxation Shipping as a service.
14. 5. Refund specific items $3.63 GST included 10% GST "How much tax did this item incur?"
15. 6. Freeze order adjustments
16. 7. Refund VAT outside of EU
17. 8. Allow multiple discounts per order "Can I combine a free shipping promotion and a 10% off promotion?" "You can't!"
18. 9. Robust test suite ........................................... ........................................... ........................................... ........................................... ........................................... ........................................... ...........................................
19. Events and Notifications
20. fire_event('spree.cart.add')
21. 1.Find all Spree::Activator instances with that event name
 2. Activate them
22. #4270
23. Events and Notifications
24. A. Avoid excessive calculations B. Avoid multiple adjustments per line item C. Not overly complicate things Ground Rules
25. A. Avoid excessive calculations B. Avoid multiple adjustments per line item C. Not overly complicate things Ground Rules
26. 86,082 lines
27. A. Avoid excessive calculations B. Avoid multiple adjustments per line item C. Not overly complicate things Ground Rules
28. A. Avoid excessive calculations B. Avoid multiple adjustments per line item Ground Rules
29. http://www.ohloh.net/p/magento
32. Sales Tax (it's complicated)
33. Sales Tax (it's super complicated)
34. New York Sales Tax = ?????
35. "Clothing and footwear under $110 are exempt from New York City and NY State Sales Tax. ! Purchases above $110 are subject to a 4.5% NYC Sales Tax and a 4% NY State Sales Tax." http://www.nyc.gov/html/dof/html/business/nys_sales_tax.shtml
36. New York Sales Tax = 0%
37. http://www.irishtimes.com/blogs/generationemigration/files/2011/11/australian_flag_3.jpg 10% Goods and Services Tax
38. $3.63 GST included 10% GST
39. vatlive.com
40. $6.66 VAT included 20% VAT
41. $6.38 VAT included 19% VAT
43. http://en.wikipedia.org/wiki/Sales_taxes_in_the_United_States
44. taxcloud.net
46. $0 - $4.68 extra 0 - 11.725% Sales Tax
47. "united" states
48. OR
49. Tax Categories Zones Rates
50. Clothing Australia 10%
51. Food NY 8.875%
52. Old Adjustments
53. Old Adjustments * Source - Thing doing the adjustment * Originator - Maybe same as source, maybe not * Adjustable - Thing being adjusted * Amount - Self-explanatory
54. Tax Adjustment * Source = Order * Originator = TaxRate * Adjustable = Order
55. Order Tax Rate create_tax_charge
56. 1. tax included in price (i.e. GST) 2. default tax zone is the same as the order's zone IF THEN Purchases in same country as store (price inc.) Adjustment Line Item Line Item Line Item Adjustment Adjustment 1. Apply adjustments to every single line item
57. Spree < 2.2 - 10% GST $1.82 tax incl.
58. $1.82 tax incl. $1.82 tax incl. Spree < 2.2 - 10% GST
59. 1. tax included in price (i.e. VAT) 2. default tax zone is NOT the order's zone IF THEN 1. apply one big negative adjustment to the entire order (a refund) Purchases outside of the country (price inc.) Adjustment Order
60. Spree < 2.2 - 10% VAT $1.82 tax refund
61. Spree < 2.2 - 10% VAT $1.82 tax refund $1.82 tax refund 1 whole-order adjustment for $3.64
62. 1. tax is NOT included in price (i.e. sales tax) THEN 1. apply one big adjustment to the whole order Purchases in country (price excl.) Order Adjustment
63. Spree < 2.2 - 7% Sales Tax (NY) + $1.39 tax
64. Spree < 2.2 - 7% Sales Tax (NY) + $1.39 tax + $1.39 tax
65. Spree < 2.2 - 7% Sales Tax (NY) 1 whole-order adjustment for $2.78 + $1.39 tax + $1.39 tax
66. Adjustment Line Item Line Item Line Item Adjustment Adjustment Adjustment Order Order Adjustment Spree < 2.2
67. Adjustment Line Item Line Item Line Item Adjustment Adjustment Adjustment Order Order Adjustment Spree < 2.2
68. New Adjustments
69. Adjustment Line Item Line Item Line Item Adjustment Adjustment Adjustment Adjustment Adjustment Line Item Line Item Line Item Spree 2.2+ +
70. 5. Refund specific items $3.63 GST included 10% GST "How much tax did this item incur?"
71. line_item.tax_total shipment.tax_total order.tax_total
72. Included
 vs. Additional
73. line_item.included_tax_total shipment.included_tax_total order.included_tax_total line_item.additional_tax_total shipment.additional_tax_total order.additional_tax_total
74. Spree 2.2+ - 10% GST $3.63 tax incl. $1.82 tax incl. 2 $39.98 $59.97 $59.97 1 adjustment for $3.63, 1 adjustment for $1.82
75. Spree 2.2+ - 7% Sales Tax 1 adjustment per line item for $1.39 + $1.39 tax + $1.39 tax
76. Spree 2.1+ Adjustments * Source * Originator * Adjustable * Amount * Included? - Counts towards final total
77. * Source * Originator * Adjustable * Amount * Included? - Counts towards final total Spree 2.2+ Adjustments
78. Shipment Adjustments
79. Shipment Adjustment * Source = Shipment * Originator = ShippingMethod * Adjustable = Order Spree 2.1
80. "Why does the cost of a shipment need to be an adjustment?"
81. shipment.cost = 10
82. Shipment Taxation
83. Shipping methods now have a tax category tax category + zone = rate(?)
84. Order create_tax_charge Tax Rate Line items Order create_tax_charge Tax Rate Shipments Spree 2.2. Taxation
85. Shipment Adjustment * Source = Shipment * Originator = ShippingMethod * Adjustable = Order Spree 2.1 Shipment Adjustment * Source = TaxRate * Adjustable = Shipment Spree 2.2
86. Tax Adjustment * Source = TaxRate * Adjustable = LineItem OR * Adjustable = Shipment
87. Promotion Adjustments
88. Order Promotions * Source = Order * Originator = PromotionAction * Adjustable = Order
89. Spree < 2.2 - 10% off promotion $2 off
90. $2 off $2 off Spree < 2.2 - 10% off promotion 1 Order Adjustment for -$4
91. $2 off $2 off Spree 2.2+ - 10% off promotion 1 adjustment per line item for -$2
92. Promotion Handlers
93. Promotion Handlers Order Promotion Cart, Coupon, Free Shipping, or Page Promotion::Handler New in Spree 2.2!
94. Promotion Handlers Cart 1. Find all non-code or path promotions 2. Check if they're eligible for that line item or order 3. Activate
95. Promotion Handlers Coupon 1. Find promotion matching coupon code 2. Validate promotion usage limit & eligiblity 3. Attempt application of promotion to order 4. Report on success of application
96. Promotion Handlers Free Shipping 1. Find all 'Free Shipping' promotion actions 2. Check eligibility for order 3. Activate
97. Promotion Handlers Page 1. Find promotion for specified path 2. Check eligibility for order 3. Activate
98. Picking a winner
99. 10% off! adjustment LineItem $10 off! adjustment
100. $1 LineItem! @ $10 $10
101. $15 LineItem! @ $150 $10
102. #4270 Complex promotion rules
103. In summary…
104. "Can I combine a free shipping promotion and a 10% off promotion? " "You can!" ORDER SUMMARY Item Total: $1,599.00 Sales Tax $80.45 - Free Shipping Promotion (10% off) Order Total: $1,511.51 -$167.95
105. PromotionAction::CreateAdjustment Commandment #1: Order Wide Adjustments
106. Commandment #2: Discounts + Credits Yes Not yet
107. Commandment #3: Group discounts Soon.
108. Commandment #4: Shipping taxation Yes.
109. Commandment #5: Refunding of items Soon.
110. Commandment #6: Adjustment freezing It's always been that way.
111. Commandment #7: VAT Refunding Of course! Adjustment Adjustment Adjustment Line Item Line Item Line Item
112. Commandment #8: Multiple discounts per order One promotion adjustment. One credit adjustment. One taxation adjustment.
113. Commandment #9: Robust test suite. Definitely.
114. Commandment A: Avoid excessive calculations. Calculations at an all time low.
115. Commandment B: Avoid multiple adjustments per item. Oops. One promotion adjustment. One credit adjustment. One taxation adjustment.
116. Commandment i: Line item adjustments. One promotion adjustment. One credit adjustment. One taxation adjustment.
117. Commandment ii: Some form of inheritance. Inheritance free zone.
118. Commandment iii: Take advantage of calculators and rules Done.
119. Commandment iv: Events should be scrapped. Gone.
120. Commandment v: Notifications should be scrapped. Gone. Replaced with Handlers. Gone.
121. We now have an adjustments system which is: SIMPLE
122. We now have an adjustments system which is: CONSISTENT Adjustment LineItem Shipment Adjustment
123. We now have an adjustments system which is: FLEXIBLE