unit4-checkout 0.1.2 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 86c9a4b5ced5591d1e29fab651f213c6b2650bb4704e11635161b3af16076442
-  data.tar.gz: 015c9dcccbc32478e8ac41875d506588c1319835a57764e985d1cb4140396bcc
+  metadata.gz: 3539766a2698101358c85167d1f34d563461cdc23b24098439e1948c2e815fba
+  data.tar.gz: 40bc469e6c776039f1d2d424b73d9904e08546181af2f95a117fbd9b4e39d553
 SHA512:
-  metadata.gz: 9918c0698cae46a2e02bf767b000a4da06173a023f72b8bae9d4694d09e6b3a92e0a2b1fbceaab4438635253a2bc3a5f9e198f1c6d4079ef8dc9567c174f1aea
-  data.tar.gz: e511b5b0a2ddf526f51ee5adbbece0c8ba91642203a18ba806100f8c4348e76f6c5218fbb21c31ba2dce68703723b7bd94da078d2fbfdb7adcb8182609bca0c0
+  metadata.gz: 7abf3c6c31eeaff5105c9f966d8751e14e94aeb585c31a7a6c3e42321797429ce6ae1e6a7fcd083e30801df9b4795144be22967bb5d759c81ca94af447ce146d
+  data.tar.gz: d5c3abb4a0ce0c7599fc5193d44d73560b7de229b1bdb8c9a1607ee71ab2dd569a860292487a9b05fac605082f950a0e6d001fc20a9e119940b03490c6e4a073

data/Gemfile

@@ -14,5 +14,3 @@ gem "rubocop", "~> 1.21"
 gem "activerecord"
 
 gem "erb"
-
-# gem "sqlite3"

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    unit4-checkout (0.1.0)
+    unit4-checkout (0.2.0)
 
 GEM
   remote: https://rubygems.org/

data/lib/unit4/checkout/checkout.rb

@@ -1,20 +1,24 @@
 # frozen_string_literal: true
 
-require "active_record"
-require "erb"
-
 class Checkout
-  attr_reader :promotional_rules, :total, :basket, :price_discount_applied_flag
+  attr_reader :total
 
-  # {product_discounts: {001: {count:2, price: 3.25}, 004: {count:2, price: 3.25}}, total_price_discount: $50}
-  def initialize(promotional_rules)
-    # maybe raise another error if keys aren't ids or total price, possibly total_item_count
-    raise TypeError, "expected a Hash, got #{promotional_rules.class.name}" unless promotional_rules.is_a? Hash
+  def initialize(promotional_rules = {})
+    raise PromotionalRulesTypeError, promotional_rules.class.name unless promotional_rules.is_a? Hash
+    raise PromotionalRulesForbiddenKeys unless correct_keys?(promotional_rules)
 
     @promotional_rules = promotional_rules
     @total = 0
     @basket = Basket.new
-    establish_connection
+    create_db_connection
+  end
+
+  def correct_keys?(promotional_rules)
+    (promotional_rules.keys - %i[product_discounts total_price_discount]).empty?
+  end
+
+  def create_db_connection
+    Connection.new
   end
 
   # maybe facilitate scanning multiple items at once
@@ -23,46 +27,78 @@ class Checkout
     # check for item id
     add_to_basket(item)
     calculate_total(item)
-    puts "#{item.capitalize} has been added to the basket successfully!"
+    puts "Item with ID '#{item}' has been added to the basket successfully!"
   end
 
   def calculate_total(item)
-    item_price = find_item_price(item)
-    new_discount_available?(item) ? apply_discounts : @total += item_price
-    @total
+    item_price = item_price(item)
+    if @total_price_discount_applied_flag
+      item_discounted?(item) ? apply_item_and_total_discount(item, item_price) : apply_total_discount_on_item(item_price)
+    else
+      item_discounted?(item) ? apply_item_discount(item, item_price) : @total += item_price
+      apply_total_discount if total_price_discounted?
+    end
+    @total = @total.round(2)
+  end
+
+  def item_price(item)
+    # TODO: facilitate DB name different from products, i.e. ask gem user for db name???
+    PriceQuery.new(item).find_price
+  end
+
+  def apply_item_and_total_discount(item, item_price)
+    item_prom_rules = @promotional_rules[:product_discounts][item]
+    item_basket_count = @basket.items[item]
+    total_discount = (1 - @promotional_rules[:total_price_discount][:percent] / 100.00)
+    @total += item_and_total(item_basket_count, item_prom_rules, total_discount, item_price)
   end
 
-  def find_item_price(item)
-    query = "SELECT * FROM 'users' WHERE 'users'.'id' = ?"
-    sanitized_query = ActiveRecord::Base.sanitize_sql_array([query, item])
-    execute_statement(sanitized_query)
-    ActiveRecord::Base.connection.exec_query(sanitized_query)
+  def item_and_total(item_basket_count, item_prom_rules, total_discount, item_price)
+    if item_basket_count == item_prom_rules[:count]
+      (item_basket_count * item_prom_rules[:price] - (item_basket_count - 1) * item_price) * total_discount
+    else
+      item_basket_count * item_prom_rules[:price] * total_discount
+    end
   end
 
-  def apply_discounts; end
+  def apply_total_discount_on_item(item_price)
+    @total += item_price * (1 - @promotional_rules[:total_price_discount][:percent] / 100.00)
+  end
 
-  def new_discount_available?(item); end
+  def item_discounted?(item)
+    return false unless item_in_discounts?(item)
 
-  def execute_statement(sql)
-    results = ActiveRecord::Base.connection.exec_query(sql)
-    results if results.present?
+    @basket.items[item] >= @promotional_rules[:product_discounts][item][:count]
   end
 
-  def establish_connection
-    db_config = setup_db_config
-    ActiveRecord::Base.establish_connection(adapter: db_config["adapter"], database: db_config["database"])
+  def item_in_discounts?(item)
+    @promotional_rules[:product_discounts] && @promotional_rules[:product_discounts][item]
   end
 
-  def setup_db_config
-    if defined? Rails && defined? Rails.env
-      Rails.application.config.database_configuration[Rails.env]
-    else
-      # TODO: use current database instead of development
-      YAML.safe_load(ERB.new(File.read("./config/database.yml")).result, aliases: true)["development"]
-    end
+  def apply_item_discount(item, item_price)
+    item_prom_rules = @promotional_rules[:product_discounts][item]
+    item_basket_count = @basket.items[item]
+    @total += if item_basket_count == item_prom_rules[:count]
+                item_basket_count * item_prom_rules[:price] - (item_basket_count - 1) * item_price
+              else
+                item_prom_rules[:price]
+              end
   end
 
-  # maybe add remove item function
+  def total_price_discounted?
+    return false unless total_price_in_discounts?
+
+    @total >= @promotional_rules[:total_price_discount][:price]
+  end
+
+  def total_price_in_discounts?
+    @promotional_rules[:total_price_discount] && @promotional_rules[:total_price_discount][:price]
+  end
+
+  def apply_total_discount
+    @total *= (1 - @promotional_rules[:total_price_discount][:percent] / 100.00)
+    @total_price_discount_applied_flag = true
+  end
 
   def add_to_basket(item)
     @basket.items[item] ? @basket.items[item] += 1 : @basket.items[item] = 1

data/lib/unit4/checkout/connection.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require "active_record"
+require "erb"
+
+class Connection
+  def initialize
+    db_config = setup_db_config
+    ActiveRecord::Base.establish_connection(adapter: db_config["adapter"], database: db_config["database"])
+  end
+
+  def setup_db_config
+    defined?(Rails) && defined?(Rails.env) ? rails_db_config : non_rails_db_config
+  end
+
+  def rails_db_config
+    Rails.application.config.database_configuration[Rails.env]
+  end
+
+  def non_rails_db_config
+    # TODO: use current database instead of development
+    YAML.safe_load(ERB.new(File.read("./config/database.yml")).result, aliases: true)["development"]
+  end
+end

data/lib/unit4/checkout/exceptions.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+class PromotionalRulesTypeError < TypeError
+  def initialize(class_name, msg = "expected a Hash, got ", exception_type = "custom")
+    msg += class_name
+    @exception_type = exception_type
+    super(msg)
+  end
+end
+
+class PromotionalRulesForbiddenKeys < TypeError
+  def initialize(msg = "expected Hash with optional keys 'product_discounts' and 'total_price_discount", exception_type = "custom")
+    @exception_type = exception_type
+    super(msg)
+  end
+end

data/lib/unit4/checkout/price_query.rb

@@ -0,0 +1,16 @@
+class PriceQuery
+
+  def initialize(item)
+    @sanitized_query = prepare_sql_statement(item)
+  end
+
+  def prepare_sql_statement(item)
+    # TODO: keep seen items in cache or variable  !!!!!!!!!
+    ActiveRecord::Base.sanitize_sql_array(["SELECT 'products'.'price' FROM 'products' WHERE 'products'.'id' = ?", item])
+  end
+
+  def find_price
+    results = ActiveRecord::Base.connection.exec_query(@sanitized_query)
+    results.rows.first.first if results.present?
+  end
+end

data/lib/unit4/checkout/version.rb

@@ -2,6 +2,6 @@
 
 module Unit4
   module Checkout
-    VERSION = "0.1.2"
+    VERSION = "0.2.1"
   end
 end

data/lib/unit4/checkout.rb

@@ -3,6 +3,9 @@
 require_relative "checkout/version"
 require_relative "checkout/checkout"
 require_relative "checkout/basket"
+require_relative "checkout/connection"
+require_relative "checkout/price_query"
+require_relative "checkout/exceptions"
 
 module Unit4
   module Checkout

metadata

@@ -1,16 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: unit4-checkout
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.1
 platform: ruby
 authors:
 - Boyan Georgiev
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-07-21 00:00:00.000000000 Z
+date: 2022-07-22 00:00:00.000000000 Z
 dependencies: []
-description: Initial commit
+description: A Ruby gem that helps the user implement a checkout system by supplying
+  only the promotional rules
 email:
 - bbgeorgiev96@gmail.com
 executables: []
@@ -26,10 +27,14 @@ files:
 - lib/unit4/checkout.rb
 - lib/unit4/checkout/basket.rb
 - lib/unit4/checkout/checkout.rb
+- lib/unit4/checkout/connection.rb
+- lib/unit4/checkout/exceptions.rb
+- lib/unit4/checkout/price_query.rb
 - lib/unit4/checkout/version.rb
 - sig/unit4/checkout.rbs
 homepage: https://github.com/BoyanGeorgiev96/unit4-checkout
-licenses: []
+licenses:
+- MIT
 metadata:
   allowed_push_host: https://rubygems.org/
   homepage_uri: https://github.com/BoyanGeorgiev96/unit4-checkout
@@ -52,5 +57,5 @@ requirements: []
 rubygems_version: 3.3.3
 signing_key:
 specification_version: 4
-summary: Initial commit
+summary: Checkout gem for Unit4 technical task
 test_files: []