Implements iterator

Author: LBeghini

README.md

@@ -1,90 +1,26 @@
 # ☕ Java Design Patterns
 
-## About
+## Iterator
 
-This application is a simple Java Console Application that aims to implement design pattern examples to a Programmin Language Class. A set of design patterns will be developed
-each week, and they are divided in different [branches](https://github.com/LBeghini/Java-Design-Patterns/branches).  
+Iterator pattern is used to access sequentially a list of elements inside an object without having to know the object itself.
 
-The main branch is just a template for every other branch.
+For example, let's suppose we have a shopping basket and want to add items on it. The cashier just needs to know that there's an item to pass, independent of the quantity.
 
-Also, to make it easier to download the source code, [releases](https://github.com/LBeghini/Java-Design-Patterns/releases) are created related to the task of the week, giving a snapshot of the code for that specific implementation.
+So, the methot to checkout the shopping items would be like this:
 
-## Implemented design patterns
+```java
+    public static Float checkout(ShoppingBasket shoppingBasket) {
+        Float total = 0f;
 
-### Behavioural patterns
+        Screen.promptBanner();
 
-- [ ] Chain of responsability
-- [ ] Command
-- [ ] Iterator
-- [ ] Memento
-- [ ] Observer
-- [x] [State](https://github.com/LBeghini/Java-Design-Patterns/tree/3-state)
-- [ ] Strategy
-- [ ] Template method
-
-### Creational patterns
-
-- [ ] Abstract factory
-- [x] [Builder](https://github.com/LBeghini/Java-Design-Patterns/tree/1-builder)
-- [x] [Factory method](https://github.com/LBeghini/Java-Design-Patterns/tree/2-factory-method)
-- [x] [Prototype](https://github.com/LBeghini/Java-Design-Patterns/tree/2-prototype)
-- [x] [Singleton](https://github.com/LBeghini/Java-Design-Patterns/tree/1-singleton)
-
-### Structural patterns
-
-- [ ] Adapter
-- [ ] Bridge
-- [ ] Composite
-- [ ] Decorator
-- [ ] Facade
-- [ ] Flyweight
-- [ ] Mediator
-- [ ] Proxy
-
-## Technologies
-
-- Java
-- JUnit
-- Maven
-
-## Requirements 
-
-To run and edit the project, be sure to have installed in your computer the following softwares:
-- A code editor
-
-After that, you'll need to clone this repo:
-
-```bash
-git clone https://github.com/LBeghini/Java-Design-Patterns.git
-```
-
-## Change branch
-
-To change to a different branch, run the command:
-
-```bash
-git checkout name-of-the-branch
-```
-
-The branch names have the pattern:
-
-```bash
-{number-of-the-week}-{pattern-name}
-```
-
-> `number-of-the-week` corresponds to the week asked to be implemented certain pattern 
-
-## Testing
-
-This project has no aim to run any of the implemented classes, as the goal is the code itself. However, the classes will be tested to visualize the behaviour and implementation 
-of the patterns.  
-
-You can run the tests using the maven wrapper:
-
-```bash
-./mvnw test 
+        for (Item item : shoppingBasket) {
+            Screen.promptItem(item);
+            total += item.getPrice();
+        }
+        Screen.promptTotal(total);
+        return total;
+    }
 ```
 
-## :balance_scale: License
-
-[MIT License](https://github.com/LBeghini/Java-Design-Patterns/blob/main/LICENSE)
+Notice that we can iterate trought the items with the shopping basket only, without having a declaration of a list of these items.

src/main/java/com/language/programming/model/Cashier.java

@@ -0,0 +1,18 @@
+package com.language.programming.model;
+
+public class Cashier {
+
+    public static Float checkout(ShoppingBasket shoppingBasket) {
+        Float total = 0f;
+
+        Screen.promptBanner();
+
+        for (Item item : shoppingBasket) {
+            Screen.promptItem(item);
+            total += item.getPrice();
+        }
+        Screen.promptTotal(total);
+        return total;
+    }
+
+}

src/main/java/com/language/programming/model/Item.java

@@ -0,0 +1,57 @@
+package com.language.programming.model;
+
+public class Item {
+    private int code;
+    private String barcode;
+    private String name;
+    private Float price;
+    private String icon;
+
+    public Item(int code, String barcode, String name, Float price, String icon) {
+        this.code = code;
+        this.barcode = barcode;
+        this.name = name;
+        this.price = price;
+        this.icon = icon;
+    }
+
+    public int getCode() {
+        return code;
+    }
+
+    public void setCode(int code) {
+        this.code = code;
+    }
+
+    public String getBarcode() {
+        return barcode;
+    }
+
+    public void setBarcode(String barcode) {
+        this.barcode = barcode;
+    }
+
+    public String getName() {
+        return name;
+    }
+
+    public void setName(String name) {
+        this.name = name;
+    }
+
+    public Float getPrice() {
+        return price;
+    }
+
+    public void setPrice(Float price) {
+        this.price = price;
+    }
+
+    public String getIcon() {
+        return icon;
+    }
+
+    public void setIcon(String icon) {
+        this.icon = icon;
+    }
+}

src/main/java/com/language/programming/model/Screen.java

@@ -0,0 +1,19 @@
+package com.language.programming.model;
+
+public class Screen {
+
+    public static void promptItem(Item item) {
+        System.out.println(item.getBarcode() + "\ncode: " + item.getCode() + "\n" + item.getIcon() + " "
+                + item.getName() + "\n\t  $ " + item.getPrice().toString() + "\n-------------------\n");
+    }
+
+    public static void promptBanner() {
+        System.out.println("╔═╗┌─┐┌─┐┬ ┬┬┌─┐┬─┐\n" + "║  ├─┤└─┐├─┤│├┤ ├┬┘\n" + "╚═╝┴ ┴└─┘┴ ┴┴└─┘┴└─\n");
+    }
+
+    public static void promptTotal(Float total) {
+        System.out.println("\tTOTAL $" + total.toString());
+
+    }
+
+}

src/main/java/com/language/programming/model/ShoppingBasket.java

@@ -0,0 +1,21 @@
+package com.language.programming.model;
+
+import java.util.ArrayList;
+import java.util.Arrays;
+import java.util.Iterator;
+import java.util.List;
+
+public class ShoppingBasket implements Iterable<Item> {
+
+    private List<Item> items = new ArrayList<Item>();
+
+    public ShoppingBasket(Item... items) {
+        this.items = Arrays.asList(items);
+    }
+
+    @Override
+    public Iterator<Item> iterator() {
+        return items.iterator();
+    }
+
+}

src/test/java/com/language/programming/model/CashierTest.java

@@ -0,0 +1,20 @@
+package com.language.programming.model;
+
+import org.junit.jupiter.api.Test;
+
+import static org.junit.jupiter.api.Assertions.*;
+
+public class CashierTest {
+
+  @Test
+  public void shouldSumItemsPrices() {
+    ShoppingBasket shoppingBasket = new ShoppingBasket(
+        new Item(3810392, "│  │█ █│█ █│ ||||", "Chocolate Bar", 2.99f, "🍫"),
+        new Item(3039483, "████ |||| ██│|  █", "Red Apple", 0.99f, "🍎"),
+        new Item(9389348, "│█ █│█  ||||| ███", "Bread", 3.99f, "🍞"),
+        new Item(4893023, "||| ████    ██ ||", "Egg", 0.30f, "🥚"),
+        new Item(5920334, " █│█  ||||    ███", "Broccoli", 0.90f, "🥦"));
+
+    assertEquals(9.17f, Cashier.checkout(shoppingBasket));
+  }
+}