bakool 0.1.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e5009031cd942deffbc62f4c505271d2da9fabf81779928e5f9210a280c4439d
-  data.tar.gz: 6dfde5cdd258e3349488aeaee4312f0308072cbaf58b7f30c8358636b2ae9244
+  metadata.gz: 9f6b718a875f6d825342d460912a7c58d03263727f6e333b7d1b235906d1c1e9
+  data.tar.gz: 287a1c88f79cfd3408603a60a74de5a4b33374ad1f7f295419c3ca6620416271
 SHA512:
-  metadata.gz: 6ad281d985e7ff08ca30a5f48878c5604df6eb62822f3f2a4d539d30ec34815117b881c2de08ce96cabb2e88547e3815418d68c10771b0e8473fbc662d670890
-  data.tar.gz: 66e506ce07373e4d5d3b122e6349972d7c62e8f5fb68f09457f3371f550f9e10baffb62cb7929fc86563bbac6d00374dff7c4e18abda3bb1677989c41bdb7b37
+  metadata.gz: ec15dabe54e1dfffba8f6b57cd79ea392dbcbd97218e55388b4fee67ef05597302e9ceecff8f3114f054b0bd040d8ae48b3f0265dc3bae5522b6d71fda72b9cb
+  data.tar.gz: a503865557c9e83744cba6f209d8bfc21285b6caf3843e88da58fe58a234e56a3ecd9427e2db65543b28a60f0b4d2c2319fda615e000727cda4ece1d3eb7b113

data/README.md

@@ -88,6 +88,114 @@ The gem comes with a default catalogue containing:
 | G01  | Green Widget | $24.95 |
 | B01  | Blue Widget | $7.95 |
 
+### Custom Catalogues
+
+You can create your own custom catalogue with your own products. This is useful when you want to use different products or pricing than the default catalogue.
+
+#### Creating a Custom Catalogue
+
+```ruby
+# Create a new empty catalogue
+catalogue = Bakool::Catalogue.new
+
+# Add products to your catalogue
+catalogue.add_product(Bakool::Product.new("Laptop", "LAP01", 999.99))
+catalogue.add_product(Bakool::Product.new("Mouse", "MOU01", 25.50))
+catalogue.add_product(Bakool::Product.new("Keyboard", "KEY01", 75.00))
+catalogue.add_product(Bakool::Product.new("Monitor", "MON01", 299.99))
+
+# Create a basket with your custom catalogue
+basket = Bakool::Basket.new(catalogue: catalogue)
+
+# Add products using your custom codes
+basket.add("LAP01")  # Laptop
+basket.add("MOU01")  # Mouse
+basket.add("KEY01")  # Keyboard
+
+# Calculate total
+total = basket.total
+puts "Total: $#{total}"
+```
+
+#### Complete Custom Catalogue Example
+
+```ruby
+# Create a custom catalogue for an electronics store
+electronics_catalogue = Bakool::Catalogue.new
+
+# Add electronics products
+electronics_catalogue.add_product(Bakool::Product.new("iPhone 15", "IPH15", 799.99))
+electronics_catalogue.add_product(Bakool::Product.new("AirPods Pro", "AIRPODS", 249.99))
+electronics_catalogue.add_product(Bakool::Product.new("MacBook Air", "MBA", 1199.99))
+electronics_catalogue.add_product(Bakool::Product.new("iPad Air", "IPAD", 599.99))
+
+# Create custom delivery charge rule for electronics
+electronics_delivery = Bakool::DeliveryChargeRule.new(lambda do |order_total|
+  if order_total < 10000 then 995      # $9.95 for orders under $100
+  elsif order_total < 50000 then 495   # $4.95 for orders under $500
+  else 0                              # Free delivery for orders $500+
+  end
+end)
+
+# Create custom discount for AirPods (buy one get one 25% off)
+class AirPodsDiscount < Bakool::Discount
+  def calculate(basket)
+    airpods = basket.items.filter { |item| item.code == "AIRPODS" }
+    if airpods.count >= 2
+      # Apply 25% discount to every second AirPod
+      (airpods.count / 2) * (airpods.first.price_in_cents * 0.25)
+    else
+      0
+    end
+  end
+end
+
+# Create basket with custom catalogue, delivery, and discount
+basket = Bakool::Basket.new(
+  catalogue: electronics_catalogue,
+  delivery_charge_rule: electronics_delivery,
+  discount: AirPodsDiscount.new
+)
+
+# Add items
+basket.add("IPH15")   # iPhone 15
+basket.add("AIRPODS") # AirPods Pro
+basket.add("AIRPODS") # Second AirPods Pro (25% off)
+basket.add("MBA")     # MacBook Air
+
+# Calculate total
+total = basket.total
+puts "Total: $#{total}"
+```
+
+#### Catalogue API Reference
+
+##### `Bakool::Catalogue.new`
+
+Creates a new empty catalogue.
+
+```ruby
+catalogue = Bakool::Catalogue.new
+```
+
+##### `catalogue.add_product(product)`
+
+Adds a product to the catalogue.
+
+- `product` (Bakool::Product): Product object to add
+
+```ruby
+catalogue.add_product(Bakool::Product.new("Product Name", "CODE", 29.99))
+```
+
+##### `Bakool::Catalogue.default_catalogue`
+
+Returns a catalogue with the default products (Red Widget, Green Widget, Blue Widget).
+
+```ruby
+default_catalogue = Bakool::Catalogue.default_catalogue
+```
+
 ### Custom Delivery Charges
 
 ```ruby
@@ -225,16 +333,28 @@ Manages the product inventory.
 
 Creates a new empty catalogue.
 
+```ruby
+catalogue = Bakool::Catalogue.new
+```
+
 #### `catalogue.add_product(product)`
 
 Adds a product to the catalogue.
 
 - `product` (Bakool::Product): Product object to add
 
+```ruby
+catalogue.add_product(Bakool::Product.new("Product Name", "CODE", 29.99))
+```
+
 #### `Bakool::Catalogue.default_catalogue`
 
 Returns a catalogue with default products (Red Widget, Green Widget, Blue Widget).
 
+```ruby
+default_catalogue = Bakool::Catalogue.default_catalogue
+```
+
 ### DeliveryChargeRule
 
 Handles delivery charge calculations.

data/lib/bakool/basket.rb

@@ -2,6 +2,19 @@
 
 # A shopping basket that can hold products and calculate totals with discounts and delivery charges
 module Bakool
+  # Represents a shopping basket that can hold products and calculate totals
+  # with discounts and delivery charges applied.
+  #
+  # @example
+  #   basket = Bakool::Basket.new
+  #   basket.add("R01")
+  #   basket.add("G01")
+  #   total = basket.total
+  #
+  # @attr_reader catalogue [Bakool::Catalogue] The product catalogue
+  # @attr_reader items [Array<Bakool::Product>] The items in the basket
+  # @attr_reader delivery_charge_rule [Bakool::DeliveryChargeRule] The delivery charge calculation rule
+  # @attr_reader discount [Bakool::Discount] The discount strategy to apply
   class Basket
     attr_accessor :catalogue, :items, :delivery_charge_rule, :discount_rule, :discount
 

data/lib/bakool/catalogue.rb

@@ -2,6 +2,15 @@
 
 # A catalogue that holds a collection of products
 module Bakool
+  # Represents a catalogue that holds a collection of products.
+  # Provides methods to add products and retrieve the default catalogue.
+  #
+  # @example
+  #   catalogue = Bakool::Catalogue.new
+  #   catalogue.add_product(Bakool::Product.new("Widget", "W01", 10.00))
+  #   default_catalogue = Bakool::Catalogue.default_catalogue
+  #
+  # @attr_reader products [Array<Bakool::Product>] The products in the catalogue
   class Catalogue
     attr_accessor :products
 

data/lib/bakool/delivery_charge_rule.rb

@@ -2,6 +2,17 @@
 
 # A rule that calculates delivery charges based on order total
 module Bakool
+  # Represents a rule that calculates delivery charges based on order total.
+  # Can be customized with a custom calculation function or use the default logic.
+  #
+  # @example
+  #   rule = Bakool::DeliveryChargeRule.new
+  #   charge = rule.calculate(5000) # 495 cents for orders over 0
+  #
+  # @example Custom rule
+  #   custom_rule = Bakool::DeliveryChargeRule.new(->(total) { total > 5000 ? 0 : 1000 })
+  #
+  # @attr_reader func [Proc] The function that calculates delivery charges
   class DeliveryChargeRule
     attr_accessor :func
 

data/lib/bakool/discount_strategies/default_discount.rb

@@ -4,6 +4,14 @@ require_relative "discount"
 
 # Default discount strategy that applies no discount
 module Bakool
+  # Default discount strategy that applies no discount to the basket.
+  # This is the fallback discount strategy when no other discounts are applicable.
+  #
+  # @example
+  #   discount = Bakool::DefaultDiscount.new
+  #   amount = discount.calculate(basket) # Always returns 0
+  #
+  # @see Bakool::Discount
   class DefaultDiscount < Discount
     def calculate(_basket)
       0

data/lib/bakool/discount_strategies/discount.rb

@@ -2,6 +2,18 @@
 
 # Abstract base class for discount strategies
 module Bakool
+  # Abstract base class for discount strategies.
+  # Subclasses must implement the #calculate method to provide specific discount logic.
+  #
+  # @example
+  #   class MyDiscount < Bakool::Discount
+  #     def calculate(basket)
+  #       # Custom discount logic here
+  #       1000 # Return discount amount in cents
+  #     end
+  #   end
+  #
+  # @abstract Subclasses must implement {#calculate}
   class Discount
     def calculate(basket)
       raise NotImplementedError, "Subclasses must implement this method"

data/lib/bakool/discount_strategies/fifty_percent_off_2nd_same_item_discount.rb

@@ -2,6 +2,14 @@
 
 # Discount strategy that applies 50% off the second item of the same type
 module Bakool
+  # Discount strategy that applies 50% off the second item of the same type.
+  # This discount is applied when there are 2 or more items with the same product code.
+  #
+  # @example
+  #   discount = Bakool::FiftyPercentOff2ndSameItemDiscount.new("R01")
+  #   amount = discount.calculate(basket) # Returns discount amount in cents
+  #
+  # @see Bakool::Discount
   class FiftyPercentOff2ndSameItemDiscount < Discount
     def initialize(item_code)
       super()

data/lib/bakool/product.rb

@@ -2,6 +2,16 @@
 
 # A product that can be added to a shopping basket
 module Bakool
+  # Represents a product that can be added to a shopping basket.
+  # Each product has a name, code, and price.
+  #
+  # @example
+  #   product = Bakool::Product.new("Red Widget", "R01", 32.95)
+  #   price_in_cents = product.price_in_cents # 3295
+  #
+  # @attr_reader name [String] The product name
+  # @attr_reader code [String] The product code
+  # @attr_reader price [Numeric] The product price in dollars
   class Product
     attr_accessor :name, :code, :price
 

data/lib/bakool/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Bakool
-  VERSION = "0.1.0"
+  VERSION = "0.2.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bakool
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Fadhil Luqman