hola_shopping_cart 0.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 519019c411f966ece64787aca2326ccc50fedea00d6fb581035d1ea50e3b95ad
+  data.tar.gz: daedaf24f05f04c2d3c2ab2eb5f315a7d7d1c33971fe7d4e9fe9e0b580ec0c4b
+SHA512:
+  metadata.gz: e0d042982394c72a4b702a261d3616c8af16bbd266f09ec3cc4b7896bea2bda1d164c4a23eab41a5e65583a2c4f7fe741cc49ea1670343bb7c37d9e35c151a4e
+  data.tar.gz: 2447418bbba5340df270c318ba10146ef6345393d08928f529ee2902482d12972ef46738f7ef3577067e1a48970134666b2564d1ed11166bf81c9a38ee8e1b28

data/README.md

@@ -0,0 +1,111 @@
+# Hola Shopping Cart 🛍️
+
+## Challenge
+> *Build an app that supports adding products to a shopping cart and displaying a total price.*
+> | *Product code* | *Name*         | *Price*   |
+> | -------------- | -------------- | --------- |
+> | *GR1*          | *Green Tea*    | *3.11 €*  |
+> | *SR1*          | *Strawberries* | *5.00 €*  |
+> | *CF1*          | *Coffee*       | *11.23 €* |
+> ### *Special conditions*
+> * *Green Tea has buy-one-get-one-free offer*
+>
+> * *Strawberries price changes to 4.50€ if you buy 3 or more*
+>
+> * *Coffee price drops to 2/3 of the original price if you buy 3 or more*
+>
+> *Shopping cart can accept items in any order and be flexible regarding pricing rules.*
+> ### *Test data*
+>| *Basket*                  | *Total price expected* |
+>| ------------------------- | ---------------------- |
+>| *GR1, GR1*                | *3.11€*                |
+>| *SR1, SR1, GR1, SR1*      | *16.61€*               |
+>| *GR1, CF1, SR1, CF1, CF1* | *30.57€*               |
+
+
+## Solution
+
+### Hola Shopping Cart 🛍️
+
+*Are you tired of shopping on over-designed webshops? Hola Shopping Cart is a simple, eyes-friendly CLI application to browse products and fill the shopping cart. Don't leave your favorite terminal to go shopping.*
+
+![Demo](docs/demo.gif)
+
+
+## Installation
+
+*Requirements: Ruby >= 3.0.0 installed*
+
+Available as a gem through [RubyGems](https://rubygems.org/gems/hola_shopping_cart), install it:
+
+```
+$ gem install hola_shopping_cart
+```
+
+## Usage
+In order to start shopping, run the command:
+
+```
+$ hola
+```
+Use your keyboard's Up/Down arrow keys to navigate the product list. Press Enter to select a product. Select a quantity by inserting a number. When you want to finish shopping, press `n` to see the shopping cart.
+
+## Arhitecture
+Three primary actions happen in the life cycle of the app:
+* User input capture
+* Processing items in a cart
+* Rendering a cart to display it
+
+![AppLifeCycle](docs/app-life-cycle.png)
+
+### User input
+The underlying library [TTY::Prompt](https://github.com/piotrmurach/tty-prompt) is used to ease up gathering user input from the command line. The library has a number of handy prompt types; one of them is `select`, which is used to show a list of available products and make a selection. The command line immediately displays a user selection for a great user experience. After that, it's up to the processing action to take over.
+
+### Processing
+Processing action is responsible for fetching necessary data, processing the product offers, and answering with `Cart::Item`. The item is then stored in the `Cart`, and processing is complete. The processing is done intentionally before adding an item to the cart to avoid big performance spikes at the end when the cart is rendered. That brings additional benefits. For example, if the product price or offer changes in the middle of the user's shopping, the total price will respect the price shown when the product is added to the cart.
+
+Sequence diagram of processing an item:
+![AddToCart](docs/add-to-cart-seq-diagram.png)
+
+### Cart render
+The [TTY::Table](https://github.com/piotrmurach/tty-table) table formatting component is used to perform rendering. The table is rendered with an ASCII-type border.
+```
++------------+------+--------+--------+------------------------+
+|Item        |Price |Quantity|Subtotal|Offer                   |
++------------+------+--------+--------+------------------------+
+|Green Tea   |3.11€ |1       |3.11€   |                        |
+|Strawberries|5.00€ |1       |5.00€   |                        |
+|Coffee      |11.23€|3       |22.46€  |Two-Thirds Bulk Discount|
++------------+------+--------+--------+------------------------+
+|Total       |      |        |30.57€  |                        |
++------------+------+--------+--------+------------------------+
+```
+
+### Flexibility
+The architecture is designed to be flexible as much as possible when comes to adding new special offers or modifying existing ones.
+
+To add a new special offer, you must create a new file inside `hola/offers`. The example below shows adding a price reduction of 20%.
+```ruby
+module Hola
+  class Offer
+    class NewSpecialDiscount < Offer
+      def price
+        super * 0.8
+      end
+    end
+  end
+end
+```
+The last step is to add a newly created special offer to a product.
+```ruby
+product.apply_offer("NewSpecialDiscount")
+```
+
+## Tests
+```
+rspec ./spec
+.............................................................................................
+
+Finished in 0.0316 seconds (files took 0.15474 seconds to load)
+93 examples, 0 failures
+```

data/bin/hola

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require "hola"
+
+Hola::CLI.start

data/lib/hola/app.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require "tty-prompt"
+require "hola/product/selector"
+require "hola/cart/renderer"
+require "hola/cart"
+
+# This class facilitates user flow experience.
+# It allows user to select products and prints the cart.
+module Hola
+  class App
+    def initialize(prompt = TTY::Prompt.new)
+      @prompt = prompt
+    end
+
+    def run
+      prompt.say("Hola. It's shopping time 🛍️")
+
+      loop do
+        selection = Product::Selector.new(prompt).perform
+        cart.add(
+          product_id: selection[:product_id],
+          quantity: selection[:quantity]
+        )
+
+        break unless prompt.yes?("Would you like to add more items?")
+      end
+
+      prompt.say(Cart::Renderer.new(cart).perform)
+    end
+
+    private
+
+    attr_reader :prompt
+
+    def cart
+      @cart ||= Cart.new
+    end
+  end
+end

data/lib/hola/cart/item/processor.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+require "hola/cart/item"
+require "hola/offer"
+Dir.glob(File.expand_path("../../offer/*.rb", __dir__), &method(:require))
+
+# The item processor is responsible for processing the item before
+# it's added to a cart. It applies the product's offer
+# and responds with a cart item value object.
+module Hola
+  class Cart
+    class Item
+      class Processor
+        attr_reader :product_id, :quantity
+
+        def initialize(product_id:, quantity:)
+          @product_id = product_id
+          @quantity = quantity
+        end
+
+        def perform
+          Cart::Item.new(
+            product: product,
+            quantity: quantity,
+            subtotal: offer.subtotal,
+            offer: (offer.name if offer.applied?)
+          )
+        end
+
+        private
+
+        def product
+          @product ||= Product.find(product_id)
+        end
+
+        def offer
+          @offer ||= begin
+            klass = product.offer? ? product.offer : "NoOffer"
+            Object.const_get("Hola::Offer::#{klass}").new(
+              product: product,
+              quantity: quantity
+            )
+          end
+        rescue NameError
+          raise ArgumentError.new("Offer not found")
+        end
+      end
+    end
+  end
+end

data/lib/hola/cart/item.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+# Value object for Item in a Cart.
+# It only knows how to display the values.
+module Hola
+  class Cart
+    class Item
+      attr_reader :product, :quantity, :subtotal, :offer
+
+      def initialize(product: nil, quantity: 0, subtotal: 0, offer: "")
+        @product = product
+        @quantity = quantity
+        @subtotal = subtotal
+        @offer = offer
+      end
+
+      def output
+        [
+          product.name,
+          Utils::Money.to_currency(product.price),
+          quantity,
+          Utils::Money.to_currency(subtotal),
+          offer
+        ]
+      end
+    end
+  end
+end

data/lib/hola/cart/renderer.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require "tty-table"
+require "hola/product"
+
+# Renders cart in table format
+module Hola
+  class Cart
+    class Renderer
+      def initialize(cart)
+        @cart = cart
+      end
+
+      def perform
+        table.render(:ascii)
+      end
+
+      private
+
+      attr_reader :cart
+
+      def table
+        @table ||= TTY::Table.new(
+          header: %w[Item Price Quantity Subtotal Offer],
+          rows: [
+            :separator,
+            *cart.output,
+            :separator,
+            ["Total", "", "", Utils::Money.to_currency(cart.total), ""]
+          ]
+        )
+      end
+    end
+  end
+end

data/lib/hola/cart.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require "hola/cart/item/processor"
+require "hola/cart/item"
+require "hola/product"
+
+# The cart is responsible for holding list of items
+module Hola
+  class Cart
+    attr_reader :items
+
+    def initialize
+      @items = Hash.new { Cart::Item.new }
+    end
+
+    def add(product_id:, quantity:)
+      items[product_id] = Cart::Item::Processor.new(
+        product_id: product_id,
+        quantity: items[product_id].quantity + quantity
+      ).perform
+    end
+
+    def total
+      items.sum { |_k, item| item.subtotal }
+    end
+
+    def output
+      items.map { |_k, item| item.output }
+    end
+  end
+end

data/lib/hola/errors.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Hola
+  class Error < StandardError; end
+end

data/lib/hola/offer/get_one_free.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Hola
+  class Offer
+    class GetOneFree < Offer
+      def name
+        "Get One Free"
+      end
+
+      def quantity
+        @_quantity ||= super - quantity_reduction
+      end
+
+      def applied?
+        eligible?
+      end
+
+      private
+
+      def quantity_reduction
+        eligible? ? 1 : 0
+      end
+
+      def eligible?
+        @quantity > 1
+      end
+    end
+  end
+end

data/lib/hola/offer/no_offer.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+# When no offer assigned to a product this is should be the class
+# for computing subtotal
+module Hola
+  class Offer
+    class NoOffer < Offer
+    end
+  end
+end

data/lib/hola/offer/strawberry_bulk_discount.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require "bigdecimal"
+
+module Hola
+  class Offer
+    class StrawberryBulkDiscount < Offer
+      DISCOUNTED_PRICE = BigDecimal("4.5")
+
+      def name
+        "Strawberry Bulk Discount"
+      end
+
+      def price
+        eligible? ? DISCOUNTED_PRICE : super
+      end
+
+      def applied?
+        eligible?
+      end
+
+      private
+
+      def eligible?
+        quantity >= 3
+      end
+    end
+  end
+end

data/lib/hola/offer/two_thirds_bulk_discount.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require "bigdecimal"
+
+module Hola
+  class Offer
+    class TwoThirdsBulkDiscount < Offer
+      def name
+        "Two-Thirds Bulk Discount"
+      end
+
+      def price
+        super * discount
+      end
+
+      def applied?
+        eligible?
+      end
+
+      private
+
+      def discount
+        return BigDecimal(1) unless eligible?
+
+        BigDecimal(2) / BigDecimal(3)
+      end
+
+      def eligible?
+        quantity >= 3
+      end
+    end
+  end
+end

data/lib/hola/offer.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+# A parent class that all offers should inherit from
+module Hola
+  class Offer
+    attr_reader :quantity
+
+    def initialize(product:, quantity:)
+      @product = product
+      @quantity = quantity
+    end
+
+    def name
+      ""
+    end
+
+    def price
+      @price ||= product.price
+    end
+
+    def applied?
+      false
+    end
+
+    def subtotal
+      price * quantity
+    end
+
+    private
+
+    attr_reader :product
+  end
+end

data/lib/hola/product/inventory.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require "singleton"
+require "hola/product"
+
+# The inventory stores products.
+# The Hola shop has only 3 products in stock.
+# This class can be extended to support bulk import of products from files
+# provided via the command line or
+# get completely replaced by the database in the future.
+module Hola
+  class Product
+    class Inventory
+      include Singleton
+      attr_reader :products
+
+      def initialize
+        @products = [
+          Product.new(name: "Green Tea", price: 3.11, offer: "GetOneFree"),
+          Product.new(name: "Strawberries", price: 5.0, offer: "StrawberryBulkDiscount"),
+          Product.new(name: "Coffee", price: 11.23, offer: "TwoThirdsBulkDiscount")
+        ]
+      end
+
+      def find_product(id)
+        products.find { |p| p.id == id }
+      end
+    end
+  end
+end

data/lib/hola/product/selector.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require "tty-prompt"
+require "hola/product"
+
+# This class provides an interface for a user to select a product
+module Hola
+  class Product
+    class Selector
+      def initialize(prompt)
+        @prompt = prompt
+      end
+
+      def perform
+        {
+          product_id: select_product,
+          quantity: select_quantity
+        }
+      end
+
+      private
+
+      attr_reader :prompt
+
+      def product_options
+        @product_options ||= Product.list.map(&:to_option)
+      end
+
+      def select_product
+        prompt.select("Choose a product", product_options)
+      end
+
+      def select_quantity
+        prompt.ask(
+          "Select quantity (stock: 100)? ",
+          convert: :int
+        ) do |q|
+          q.in("1-100")
+          q.messages[:range?] = "out of expected range"
+          q.messages[:convert?] = "not a number"
+        end
+      end
+    end
+  end
+end

data/lib/hola/product.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+require "hola/product/inventory"
+require "hola/utils/money"
+require "securerandom"
+
+module Hola
+  class Product
+    class << self
+      def list
+        Inventory.instance.products
+      end
+
+      def find(id)
+        Inventory.instance.find_product(id)
+      end
+
+      def currency
+        "€"
+      end
+    end
+
+    attr_reader :id, :name, :price, :offer
+
+    def initialize(name:, price:, offer: "")
+      @id = SecureRandom.uuid
+      @name = name
+      @price = Utils::Money.parse(price)
+      @offer = offer
+    end
+
+    def offer?
+      !offer.empty?
+    end
+
+    def to_option
+      {name: title, value: id}
+    end
+
+    def apply_offer(name)
+      self.offer = name
+    end
+
+    private
+
+    attr_writer :offer
+
+    def title
+      "#{name} (#{Utils::Money.to_currency(price)})"
+    end
+  end
+end

data/lib/hola/utils/money.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require "bigdecimal"
+require "hola/errors"
+
+module Hola
+  module Utils
+    class Money
+      class << self
+        def parse(...)
+          new(...).parse
+        end
+
+        def to_currency(...)
+          new(...).to_currency
+        end
+      end
+
+      def initialize(value)
+        @value = value
+      end
+
+      def parse
+        BigDecimal((value || 0).to_s.strip)
+      rescue ArgumentError, TypeError => err
+        raise Error.new(err.message)
+      end
+
+      def to_currency
+        "#{format("%.2f", value)}#{Product.currency}"
+      end
+
+      private
+
+      attr_reader :value
+    end
+  end
+end

data/lib/hola.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require "hola/app"
+
+module Hola
+  class CLI
+    class << self
+      def start
+        App.new.run
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,137 @@
+--- !ruby/object:Gem::Specification
+name: hola_shopping_cart
+version: !ruby/object:Gem::Version
+  version: '0.4'
+platform: ruby
+authors:
+- Luka Domitrovic
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-02-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: tty-prompt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.23.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.23.1
+- !ruby/object:Gem::Dependency
+  name: tty-table
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.12.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.12.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: rspec-uuid
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.60.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.60.2
+description: "  Are you tired of shopping on over-designed webshops?  \n  Hola Shopping
+  Cart is a simple, eyes-friendly CLI application to browse \n  products and fill
+  the shopping cart. \n  Don't leave your favorite terminal to go shopping. \n  It's
+  an example app for a technical assignment ;)\n"
+email:
+- luka@domitrovic.si
+executables:
+- hola
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- bin/hola
+- lib/hola.rb
+- lib/hola/app.rb
+- lib/hola/cart.rb
+- lib/hola/cart/item.rb
+- lib/hola/cart/item/processor.rb
+- lib/hola/cart/renderer.rb
+- lib/hola/errors.rb
+- lib/hola/offer.rb
+- lib/hola/offer/get_one_free.rb
+- lib/hola/offer/no_offer.rb
+- lib/hola/offer/strawberry_bulk_discount.rb
+- lib/hola/offer/two_thirds_bulk_discount.rb
+- lib/hola/product.rb
+- lib/hola/product/inventory.rb
+- lib/hola/product/selector.rb
+- lib/hola/utils/money.rb
+homepage: https://rubygems.org/gems/hola_shopping_cart
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://rubygems.org/gems/hola_shopping_cart
+  source_code_uri: https://github.com/luxxi/hola_shopping_cart
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: '3.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.3
+signing_key:
+specification_version: 4
+summary: Hola Shopping Cart CLI app
+test_files: []