Skip to content

Simple sequence of requirements, leading to a (hopefully) simple code implementation

Notifications You must be signed in to change notification settings

Cobrijani/price-calculator-kata

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

49 Commits
 
 
 
 
 
 

Repository files navigation

Price Calculator Kata

Invitation

You are invited to implement imaginary customer’s requirements listed below, using programming language of choice and applying any coding practices you wish.

I have been using this example since 2016 in trainings and lectures. Many developers have already passed through the drill of implementing these same requirements. Requirements listed below have been selected carefully after observing typical mistakes made by novice developers, but very often by seasoned ones, too.

Take your time to examine the requirements and select your development strategy. Play with the code as long as you feel excitement. There is no reward after completing this challennge.

If you decide to participate, you may fork this repo and develop your own solution based on the requirements. Don't be afraid to experiment and exchange thoughts with other developers.

Rules of Conduct

1. You are free to choose programming language and programming method - This challenge is not a competition. There are no better or worse solutions per se. The goal is to evaluate expressiveness of languages and usefulness of programming paradigms. All languages and paradigms are equally welcome.

2. Requirements should be implemented in order - The sequence of requirements is simulating the evolution of customer's expectations over a prolonged period of time, as customer occasionally gets “bright ideas” and hands them over to developers. Implementing requirements all at once or out of order would look like real time was flowing back and forth.

3. Application must remain operational at all times - After implementing each requirement, the application must be correct and fully operational. The newly implemented requirement, as well as all previous requirements must work. If, however, there are bugs or omissions, don’t despair – just apply a fix when you find them and carry on. That is what you would do in a day-to-day development anyway.

4. Mark each task with the requirement label - Include requirement label into each commit message, so that the evolution of the product can be observed later. Each requirement begins with a label in capital letters.

5. Pretend you don’t know the requirements in advance - Even though you can read all the requirements right away, try thinking of those beyond the one you’re currently solving as yet unknown. Don’t overengineer current solution because you have anticipated a future requirement.

Customer’s Requirements

1. TAX
There is a product, defined by: Name (string), UPC (can be a plain number) and a price.
Company is only doing business in US dollars. Money is calculated at two decimals precision (e.g. $12.34).
There is a flat-rate tax (currently 20%) added to all products’ prices. Tax is mandatory and equal for all products.
Customer wants to be able to specify tax percentage.
Write code which displays base price and price with tax for a product.

Definition of done:
Sample product: Book with name = “The Little Prince”, UPC=12345, price=$20.25.

Product price reported as $20.25 before tax and $24.30 after 20% tax.
Product price reported as $20.25 before tax and $24.50 after 21% tax.

2. DISCOUNT
Customer chooses to apply a relative discount to all products.
Discount is specified as a percentage relative to price. Tax is always applied to a price before it was deduced, i.e. discount doesn’t reduce tax amount (see example below).
Customer requires discount percentage to be configurable.
Enhance code so that it can apply discount and tax to the product’s price.

Definition of done:
Sample product: Book with name = “The Little Prince”, UPC=12345, price=$20.25.

Tax=20%, discount=15%
Tax amount = $4.05; Discount amount = $3.04
Price before = $20.25, price after = $21.26

3. REPORT
When a discount is applied, print out (or display by any convenient means) a message which reports the discounted amount.

Definition of done:
Sample product: Title = “The Little Prince”, UPC=12345, price=$20.25.

Case #1:
Tax = 20%, discount = 15%
Program prints price $21.26
Program displays $3.04 amount which was deduced

Case #2:
Tax = 20%, no discount
Program prints price $24.30
Program doesn’t show any discounted amount.

4. SELECTIVE
There is a special discount assigned to a product with specified (configurable) UPC.
This discount only applies to a product with UPC value equal to the value defined by the discount.
If both universal and UPC-based discounts are applicable, they both apply to original product price and then sum up.
When two discounts are applied, only the total discounted amount is printed (requirement REPORT-DISCOUNT).

Definition of done:
Sample product: Title = “The Little Prince”, UPC=12345, price=$20.25.

Case #1:
Tax = 20%, universal discount = 15%, UPC-discount = 7% for UPC=12345
Tax amount = $20.25 * 20% = $4.05, discount = $20.25 * 15% = $3.04, UPC discount = $1.42
Program prints price $19.84
Program reports total discount amount $4.46

Case #2:
Tax = 21%, universal discount = 15%, UPC-discount = 7 for UPC = 789
Tax amount = $20.25 * 21% = $4.25, discount = $20.25 * 15% = $3.04
Program prints price $21.46
Program reports discount amount $3.04

5. PRECEDENCE
By this point, tax had precedence over any discounts. That means that tax was always applied to full price of the product, not to the discounted price.
Customer is happy to announce that some discounts can legally be applied before tax. That has the consequence that the tax amount would be lower.
Extend the solution so that discounts can either be applied before tax calculation, or after tax calculation.

Definition of done:
Sample product: Title = “The Little Prince”, UPC=12345, price=$20.25.
Tax = 20%, universal discount (after tax) = 15%, UPC-discount (before tax) = 7% for UPC=12345

UPC discount amount = $1.42, remaining price = $20.25 - $1.42 = $18.83
Tax amount = $18.83 * 20% = $3.77, universal discount = $18.83 * 15% = $2.82
Final price = $20.25 - $1.42 + $3.77 - $2.82 = $19.78

Program prints price $19.78
Program reports total discount amount $4.24

6. EXPENSES
Customer wants to introduce packaging and transport costs, administrative costs, etc., which are neither subject to tax, nor to discounts.
There can be more than one cost added, each defined by a description and an amount. Amount can either be a percentage of price or an absolute value.
Program should separately report product price, tax, discounts, each cost and total.

Definition of done:
Sample product: Title = “The Little Prince”, UPC=12345, price=$20.25.

Case #1:
Tax = 21%, discount = 15%, UPC discount = 7% for UPC=12345
Packaging cost = 1% of price
Transport cost = $2.2
Tax amount = $20.25 * 21% = $4.25, discounts = $20.25 * 15% + $20.25 * 7% = $3.04 + $1.42 = $4.46
Packaging = $20.25 * 1% = $0.20, transport = $2.2

Program prints:
Cost = $20.25
Tax = $4.25
Discounts = $4.46
Packaging = $0.20
Transport = $2.2
TOTAL = $22.44
Program separately reports $4.46 total discount

Case #2:
Tax 21%, no discounts and no additional costs.

Program prints:
Cost = $20.25
Tax = $4.25
TOTAL = $24.5
Program reports no discounts

7. COMBINING
Customer is not satisfied with the way in which discounts are combined (simple sum).
New request is to allow the customer to select between two methods of combining discounts: (1) additive - discounts are all calculated from the original price and summed up, or (2) multiplicative - each discount is calculated from the price after applying the previous one.

Definition of done:
Sample product: Title = “The Little Prince”, UPC=12345, price=$20.25.

Case #1:
Tax = 21%, discount = 15%, UPC discount = 7% for UPC=12345, additive discounts
Packaging cost = 1% of price
Transport cost = $2.2
Tax amount = $20.25 * 21% = $4.25, discounts = $20.25 * 15% + $20.25 * 7% = $3.04 + $1.42 = $4.46
Packaging = $20.25 * 1% = $0.20, transport = $2.2

Program prints:
Cost = $20.25
Tax = $4.25
Discounts = $4.46
Packaging = $0.20
Transport = $2.2
TOTAL = $22.44
Program separately reports $4.46 total discount

Case #2:
Tax = 21%, discount = 15%, UPC discount = 7% for UPC=12345, multiplicative discounts
Packaging cost = 1% of price
Transport cost = $2.2
Tax amount = $20.25 * 21% = $4.25, discount #1 = $20.25 * 15% = $3.04; discount #2 = ($20.25 - $3.04) * 7% = $1.20
Packaging = $20.25 * 1% = $0.20, transport = $2.2

Program prints:
Cost = $20.25
Tax = $4.25
Discounts = $4.24
Packaging = $0.20
Transport = $2.2
TOTAL = $22.65
Program separately reports $4.24 total discount

8. CAP
Customer is not satisfied with total discounted amount and wants to put a cap on it.
Cap is either a percentage of original price or an absolute amount. Either way, the discounted amount must not be larger than indicated by the cap.

Definition of done:
Sample product: Title = “The Little Prince”, UPC=12345, price=$20.25.

Case #1:
Tax = 21%, discount = 15%, UPC discount = 7% for UPC=12345, additive discounts, cap = 20%
Tax amount = $20.25 * 21% = $4.25, discounts = $20.25 * 15% + $20.25 * 7% = $3.04 + $1.42 = $4.46, cap = $20.25 * 20% = $4.05

Program prints:
Cost = $20.25
Tax = $4.25
Discounts = $4.05
TOTAL = $20.45
Program separately reports $4.05 total discount

Case #2:
Tax = 21%, discount = 15%, UPC discount = 7% for UPC=12345, additive discounts, cap = $4
Tax amount = $20.25 * 21% = $4.25, discounts = $20.25 * 15% + $20.25 * 7% = $3.04 + $1.42 = $4.46, cap = $4

Program prints:
Cost = $20.25
Tax = $4.25
Discounts = $4.00
TOTAL = $20.50
Program separately reports $4.00 total discount

Case #3:
Tax = 21%, discount = 15%, UPC discount = 7% for UPC=12345, additive discounts, cap = 30%
Tax amount = $20.25 * 21% = $4.25, discounts = $20.25 * 15% + $20.25 * 7% = $3.04 + $1.42 = $4.46, cap = $20.25 * 30% = $6.08

Program prints:
Cost = $20.25
Tax = $4.25
Discounts = $4.46
TOTAL = $20.04
Program separately reports $4.46 total discount

9. CURRENCY
Customer is happy to announce expansion to other markets.
New request is to support currencies other than US dollar.
Currencies should be indicated using ISO-3 codes (e.g. USD, GBP, JPY, etc.).

Definition of done:

Case #1:
Sample product: Title = “The Little Prince”, UPC=12345, price=20.25 USD.
Tax = 20%, no discounts

Program prints:
Cost = 20.25 USD
Tax = 4.25 USD
TOTAL = 24.50 USD
Program reports no discount

Case #2:
Sample product: Title = “The Little Prince”, UPC=12345, price=17.76 GBP.
Tax = 20%, no discounts

Program prints:
Cost = 17.76 GBP
Tax = 3.55 GBP
TOTAL = 21.31 GBP
Program reports no discount

10. PRECISION
New request comes from the accounting department. All money-related calculations must be performed with four decimal digits precision and then rounded to two decimal digits before becoming final.
This means, for example, that all discounts, taxes and expenses must be calculated and combined with higher precision and then each final line rounded to lower precision (see example below).

Definition of done:
Sample product: Title = “The Little Prince”, UPC=12345, price=20.25 USD.
Tax = 21%, universal discount = 15%, UPC discount = 7% for UPC=12345, discounts are multiplicative and after tax
Transport cost = 3% of base price

Tax amount = 20.25 USD * 21% = 4.2525 USD
Universal discount = 20.25 USD * 15% = 3.0375 USD
UPC discount = (20.25 USD – 3.0375 USD) * 7% = 1.2049 USD
Total discount = 3.0375 USD + 1.2049 USD = 4.2424 USD
Transport cost = 20.25 USD * 3% = 0.6075 USD

Program prints:
Cost = 20.25 USD
Tax = 4.25 USD
Discounts = 4.24 USD
Transport = 0.61 USD
TOTAL = 20.81 USD Program separately reports discount 4.24 USD

11. CONFIGURATOR (bonus level)
Customer wants to be able to configure all elements of the price calculator: tax, discounts, combination method, cap, expenses.
You are free to choose the configuration method – plain text file, XML file, JSON file, database, etc.

About

Simple sequence of requirements, leading to a (hopefully) simple code implementation

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Clojure 97.0%
  • Haskell 3.0%