mercadona 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 48672addf9ab3b766efbb3becdd57685902710787756a46a3328da7063b146ec
+  data.tar.gz: b0dd301ac7042f467e8e6db9c137080f4aec8f66f4cf808ece4c7333c88ccce7
+SHA512:
+  metadata.gz: 7ed023cacd19cb778fe26fdff556af8297f1a4805c34f53a5d245ecc82afd1e37fb95fc10179a498f3d61064744f25d8e6c7a33f70b3696f53b3b37f18d0e76d
+  data.tar.gz: 4fe01102cacdafb1683596daadbc2660a6892cdb1c89dd17067a3e2fd2ea7f4cb6a7fc267f2a8c105182a5cc8d03cbcf894832fa3c2a08a0cd419ff5d450eae6

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.7.0

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Vladislav Trotsenko
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'mercadona'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/mercadona/amount_formatter.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Mercadona
+  module AmountFormatter
+    def self.call(currency, amount)
+      ::Kernel.format("#{currency}%.2f", amount)
+    end
+  end
+end

data/lib/mercadona/checkout.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module Mercadona
+  class Checkout
+    DEFAULT_CURRENCY = '£'
+    INITIAL_AMOUNT = 0
+
+    def initialize(discount_rules, currency = Mercadona::Checkout::DEFAULT_CURRENCY)
+      @discount_rules = discount_rules
+      @currency = currency
+      @basket = []
+    end
+
+    def scan(order_item)
+      basket << order_item
+    end
+
+    def total
+      Mercadona::AmountFormatter.call(currency, calculate_amount / 100.0)
+    end
+
+    private
+
+    attr_reader :discount_rules, :currency, :basket
+
+    def discount_order_item?(order_item)
+      discount_rules.key?(order_item.product_code)
+    end
+
+    def amount_with_discount(order_item, quantity)
+      discount_rules[order_item.product_code].amount_with_discount(order_item, quantity)
+    end
+
+    def calculate_amount
+      # Because the technical brief does not specify the pricing method (whether per item or per specific weight),
+      # we will simplify our calculations by using the price per item as the reference point.
+      basket.tally.inject(Mercadona::Checkout::INITIAL_AMOUNT) do |amount, (order_item, quantity)|
+        next amount + amount_with_discount(order_item, quantity) if discount_order_item?(order_item)
+
+        amount + (order_item.price_in_fractional_currency * quantity)
+      end
+    end
+  end
+end

data/lib/mercadona/core.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Mercadona
+  ALLOWED_COMPARISON_OPERATORS = %w[== < > >= <=].freeze
+
+  require_relative '../mercadona/error/argument'
+  require_relative '../mercadona/error/runtime'
+  require_relative '../mercadona/entity/base'
+  require_relative '../mercadona/entity/discount_rule'
+  require_relative '../mercadona/entity/order_item'
+  require_relative '../mercadona/amount_formatter'
+  require_relative '../mercadona/discount/base'
+  require_relative '../mercadona/discount/bogo'
+  require_relative '../mercadona/discount/quantity'
+  require_relative '../mercadona/discount/bulk'
+  require_relative '../mercadona/checkout'
+  require_relative '../mercadona/version'
+end

data/lib/mercadona/discount/base.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Mercadona
+  module Discount
+    class Base
+      DISCOUNT_RULES_ATTRS = %i[condition quantity].freeze
+
+      def self.call(discount_rule, order_item, order_item_quantity)
+        new(discount_rule, order_item, order_item_quantity).call
+      end
+
+      def initialize(discount_rule, order_item, order_item_quantity)
+        @discount_rule = discount_rule
+        @order_item_price = order_item.price_in_fractional_currency
+        @order_item_quantity = order_item_quantity
+      end
+
+      def call
+        raise Mercadona::Error::Runtime, Mercadona::Error::Runtime::NOT_IMPLEMENTED
+      end
+
+      private
+
+      attr_reader :discount_rule, :order_item_price, :order_item_quantity
+
+      Mercadona::Discount::Base::DISCOUNT_RULES_ATTRS.each do |method_name|
+        define_method(method_name) { discount_rule.public_send(method_name) }
+      end
+
+      def discount_case?
+        order_item_quantity.public_send(condition, quantity)
+      end
+
+      def amount_without_discount
+        @amount_without_discount ||= order_item_price * order_item_quantity
+      end
+    end
+  end
+end

data/lib/mercadona/discount/bogo.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Mercadona
+  module Discount
+    class Bogo < Mercadona::Discount::Base
+      def call
+        return amount_without_discount unless discount_case?
+
+        amount_without_discount - order_item_price
+      end
+    end
+  end
+end

data/lib/mercadona/discount/bulk.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Mercadona
+  module Discount
+    class Bulk < Mercadona::Discount::Base
+      def call
+        return amount_without_discount unless discount_case?
+
+        amount_without_discount - (amount_without_discount * discount).round
+      end
+
+      private
+
+      def discount
+        @discount ||= discount_rule.discount.to_f
+      end
+    end
+  end
+end

data/lib/mercadona/discount/quantity.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Mercadona
+  module Discount
+    class Quantity < Mercadona::Discount::Base
+      def call
+        return amount_without_discount unless discount_case?
+
+        amount_without_discount - (discount * order_item_quantity)
+      end
+
+      private
+
+      def discount
+        @discount ||= (discount_rule.discount * 100).to_i
+      end
+    end
+  end
+end

data/lib/mercadona/entity/base.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Mercadona
+  module Entity
+    class Base < ::Struct; alias attributes members; end
+  end
+end

data/lib/mercadona/entity/discount_rule.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Mercadona
+  module Entity
+    DiscountRule = Mercadona::Entity::Base.new(:type, :condition, :quantity, :discount, keyword_init: true) do
+      def initialize(type:, condition:, **args)
+        validate_sensitive_args(type, condition)
+        super
+      end
+
+      def amount_with_discount(order_item, order_item_quantity)
+        type.call(self, order_item, order_item_quantity)
+      end
+
+      private
+
+      def discount_class_valid?(discount_class)
+        discount_class.respond_to?(:call)
+      end
+
+      def comparison_operator_valid?(comparison_operator)
+        Mercadona::ALLOWED_COMPARISON_OPERATORS.include?(comparison_operator)
+      end
+
+      def validate_sensitive_args(discount_class, comparison_operator)
+        raise Mercadona::Error::Argument, Mercadona::Error::Argument::DISCOUNT_CLASS unless discount_class_valid?(discount_class)
+        raise Mercadona::Error::Argument, Mercadona::Error::Argument::COMPARISON_OPERATOR unless comparison_operator_valid?(comparison_operator)
+      end
+    end
+  end
+end

data/lib/mercadona/entity/order_item.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Mercadona
+  module Entity
+    OrderItem = Mercadona::Entity::Base.new(:product_code, :name, :price, keyword_init: true) do
+      # Understanding Ruby's floating-point precision issues for money calculations,
+      # let's use whole numbers instead of floats.
+      def price_in_fractional_currency
+        (price.to_f * 100).to_i
+      end
+    end
+  end
+end

data/lib/mercadona/error/argument.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Mercadona
+  module Error
+    class Argument < ::ArgumentError
+      DISCOUNT_CLASS = 'type: must have a :call method'
+      COMPARISON_OPERATOR = "condition: must be one of #{Mercadona::ALLOWED_COMPARISON_OPERATORS.join(', ')}"
+    end
+  end
+end

data/lib/mercadona/error/runtime.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Mercadona
+  module Error
+    class Runtime < ::RuntimeError
+      NOT_IMPLEMENTED = 'call method must be implemented'
+    end
+  end
+end

data/lib/mercadona/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Mercadona
+  VERSION = '0.1.0'
+end

data/lib/mercadona.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require_relative 'mercadona/core'

data/mercadona.gemspec

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require_relative 'lib/mercadona/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'mercadona'
+  spec.version = Mercadona::VERSION
+  spec.authors = ['Vladislav Trotsenko']
+  spec.email = ['admin@bestweb.com.ua']
+
+  spec.summary = %(Simple retail shop interface)
+  spec.description = %(Simple retail shop interface.)
+
+  spec.homepage = 'https://github.com/bestwebua/mercadona'
+  spec.license = 'MIT'
+
+  spec.metadata = {
+    'homepage_uri' => 'https://github.com/bestwebua/mercadona',
+    'changelog_uri' => 'https://github.com/bestwebua/mercadona/blob/master/CHANGELOG.md',
+    'source_code_uri' => 'https://github.com/bestwebua/mercadona',
+    'documentation_uri' => 'https://github.com/bestwebua/mercadona/blob/master/README.md',
+    'bug_tracker_uri' => 'https://github.com/bestwebua/mercadona/issues'
+  }
+
+  spec.required_ruby_version = '>= 2.7.0'
+  spec.files = `git ls-files -z`.split("\x0").select { |f| f.match(%r{^(bin|lib)/|.ruby-version|mercadona.gemspec|LICENSE}) }
+  spec.require_paths = %w[lib]
+
+  spec.add_development_dependency 'factory_bot', '~> 6.4', '>= 6.4.4'
+  spec.add_development_dependency 'rake', '~> 13.2', '>= 13.2.1'
+  spec.add_development_dependency 'rspec', '~> 3.13'
+end

metadata

@@ -0,0 +1,121 @@
+--- !ruby/object:Gem::Specification
+name: mercadona
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Vladislav Trotsenko
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2024-07-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: factory_bot
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.4.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.4.4
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 13.2.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 13.2.1
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.13'
+description: Simple retail shop interface.
+email:
+- admin@bestweb.com.ua
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".ruby-version"
+- LICENSE.txt
+- bin/console
+- bin/setup
+- lib/mercadona.rb
+- lib/mercadona/amount_formatter.rb
+- lib/mercadona/checkout.rb
+- lib/mercadona/core.rb
+- lib/mercadona/discount/base.rb
+- lib/mercadona/discount/bogo.rb
+- lib/mercadona/discount/bulk.rb
+- lib/mercadona/discount/quantity.rb
+- lib/mercadona/entity/base.rb
+- lib/mercadona/entity/discount_rule.rb
+- lib/mercadona/entity/order_item.rb
+- lib/mercadona/error/argument.rb
+- lib/mercadona/error/runtime.rb
+- lib/mercadona/version.rb
+- mercadona.gemspec
+homepage: https://github.com/bestwebua/mercadona
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/bestwebua/mercadona
+  changelog_uri: https://github.com/bestwebua/mercadona/blob/master/CHANGELOG.md
+  source_code_uri: https://github.com/bestwebua/mercadona
+  documentation_uri: https://github.com/bestwebua/mercadona/blob/master/README.md
+  bug_tracker_uri: https://github.com/bestwebua/mercadona/issues
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.10
+signing_key: 
+specification_version: 4
+summary: Simple retail shop interface
+test_files: []