vending_machine 0.1.6

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ebf3a4903d76e77dcd088bb50901d2825b2d929d8d7122becf02a7b8deb0046a
+  data.tar.gz: 3e0783031e9948ffd099f369a4bcff468c49a7d12cc7da4d1a239a2c9ee1a03d
+SHA512:
+  metadata.gz: 15cd46d98aec5c7984ada2c49f69e6495e1ec973dbd87228d077ddf64d575f5a4d94d6d50796b3ea42a613d03f3d90619e039717403e2cb35b8f6f60deba5791
+  data.tar.gz: 0a49e14a162353a7fc72ea3dcfe6d6b8e98eadbee87ffa2b98eb3a54036ea6e6bcb2cf2e6e21b58a89ad28baafd9b7ebf26df612a51cd5cb61bee7d7f24d674a

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.gem

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/.ruby-version

@@ -0,0 +1 @@
+2.5.1

data/.travis.yml

@@ -0,0 +1,9 @@
+language: ruby
+cache: bundler
+sudo: false
+before_install:
+  - gem install bundler
+  - gem update --system
+  - gem --version
+rvm:
+  - 2.5.1

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+ruby "2.5.1"
+
+gem "rspec"
+gem "rake"
+gem "pry"

data/Gemfile.lock

@@ -0,0 +1,37 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.1.2)
+    diff-lcs (1.3)
+    method_source (0.9.0)
+    pry (0.11.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rake (12.3.1)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  pry
+  rake
+  rspec
+
+RUBY VERSION
+   ruby 2.5.1p57
+
+BUNDLED WITH
+   1.16.3

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Jonathan O'Mahony
+
+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/README.md

@@ -0,0 +1,120 @@
+# Vending Machine [![Build Status](https://travis-ci.org/jonnyom/vending_machine.svg?branch=master)](https://travis-ci.org/jonnyom/vending_machine)
+This is a Ruby gem which emulates a vending machine.
+
+Provided with the name of a product and an array of coins (in string values), 
+the machine will either return the correct product, 
+or inform you of the relevant error.
+
+### Installing the machine
+```
+gem install vending_machine
+```
+
+### The machine
+The machine itself contains a hash of products, and its available change,
+in denominations of €2 to 1c inclusive.
+
+For example
+```ruby
+change = {
+             "1c" => 100,
+             "2c" => 100,
+             "5c" => 100,
+             "10c" => 100,
+             "20c" => 100,
+             "50c" => 100,
+             "€1" => 100,
+             "€2" => 100
+           }
+snickers = Product.new(name: "Snickers", price: "€2")
+mars_bar = Product.new(name: "Mars Bar", price: "€1")
+products = {
+             "Snickers" => {
+                product: snickers,
+                available: 10
+             },
+             "mars bar" => {
+                product: mars_bar,
+                available: 5
+               }
+             }
+machine = Machine.new(products: products, available_change: change)
+
+machine.select_product(product: "Mars Bar", coins: ["20c", "50c", "10c", "20c"])
+=> {:product=>"Mars Bar", :change=>["0"]}
+```
+
+If not enough money is given, the machine raises a MoreMoneyError and exits
+
+```ruby
+machine.select_product(product: "Snickers", coins: ["20c", "50c", "10c", "20c"])
+MoreMoneyError: MoreMoneyError
+```
+
+The machine can be refilled with both products and change
+```ruby
+machine = Machine.new(products: [Product.new(name: "snickers", price: "€2")], available_change: available_change)
+=> #<Machine:0x00007fb3ac086440 @available_change={1=>100, 2=>100, 5=>100, 10=>100, 20=>100, 50=>100, 100=>100, 200=>100}, @products=[#<Product:0x00007fb3ac0864e0 @name="snickers", @price="€2">]>
+cash_refill = { "1c" => 100 }
+machine.refill_cash(cash_refill)
+=> {1=>100}
+machine.available_change
+=> {1=>200, 2=>100, 5=>100, 10=>100, 20=>100, 50=>100, 100=>100, 200=>100}
+
+milky_bar = Product.new(name: "milky bar", price: "60c")
+=> #<Product:0x00007fb81297fc30 @name="milky bar", @price="60c">
+snickers = Product.new(name: "Snickers", price: "€2")
+=> #<Product:0x00007fb8121e76a8 @name="Snickers", @price="€2">
+machine.refill_products([{ product: milky_bar, available: 10 }, { product: snickers, available: 15 }])
+=> [{:product=>#<Product:0x00007fb81297fc30 @name="milky bar", @price="60c">, :available=>10}, {:product=>#<Product:0x00007fb8121e76a8 @name="Snickers", @price="€2">, :available=>15}]
+machine.products
+=> {"Snickers"=>{:product=>#<Product:0x00007fb8121a54b0 @name="Snickers", @price="€2">, :available=>25},
+ "Mars Bar"=>{:product=>#<Product:0x00007fb8121a53e8 @name="Mars Bar", @price="€1">, :available=>5},
+ "milky bar"=>{:product=>#<Product:0x00007fb81297fc30 @name="milky bar", @price="60c">, :available=>20}}
+```
+
+### How does it find the correct change
+The algorithm behind finding the correct change is a simple greedy algorithm which 
+constantly asks for the largest coin denomination that can be returned without
+the change going below 0.
+
+For example
+```ruby
+available_coins = [1, 3, 4], change = 2
+2 - 4 = -2: less than 0, moving on
+2 - 3 = -1: less than 0, moving on
+2 - 1 = 1: greater than 0, adding 1 to change array and checking if 1 still works with new change of 1
+1 - 1 = 0: greater than 0, adding 1 to change array and checking if 1 still works with new change of 0
+0 - 1 = -1: less than 0, moving on and breaking out as we have come to the end of the array
+```
+
+If the exact change for a product's price is given and no change needs to be calculated,
+the machine simply returns the product and 0 change.
+
+```ruby
+machine.select_product(product: "Snickers", coins: ["€2"])
+=> {:product=>"Snickers", :change=>["0"]}
+```
+
+### Running the machine locally
+Simply run `gem install vending_machine`.
+
+Then call a CLI of your choice (for example `pry` or `irb`)
+
+Requiring the installed gem will then let you interact with it. 
+
+This machine comes preloaded with some change and products for testing.
+
+
+```
+~/vending_machine ❯❯❯ pry                                                                                                                                                                                                    
+[1] pry(main)> require "vending_machine"
+=> true
+[2] pry(main)> machine = Machine.new(products: products, available_change: change)
+=> #<Machine:0x00007f8867a59280
+ @available_change={1=>100, 2=>100, 5=>100, 10=>100, 20=>100, 50=>100, 100=>100, 200=>100},
+ @products={"Snickers"=>{:product=>#<Product:0x00007f8867a59460 @name="Snickers", @price="€2">, :available=>10}, "Mars Bar"=>{:product=>#<Product:0x00007f8867a59398 @name="Mars Bar", @price="€1">, :available=>5}}>
+```
+
+### Tests
+To run the tests simply `cd` into the root of the directory and run `rake`

data/Rakefile

@@ -0,0 +1,6 @@
+require 'rake'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default  => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "vending_machine"
+
+# 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 "pry"
+Pry.start

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/errors/invalid_coin_error.rb

@@ -0,0 +1,2 @@
+class InvalidCoinError < StandardError
+end

data/lib/errors/more_money_error.rb

@@ -0,0 +1,2 @@
+class MoreMoneyError < StandardError
+end

data/lib/errors/no_money_error.rb

@@ -0,0 +1,2 @@
+class NoMoneyError < StandardError
+end

data/lib/errors/out_of_money_error.rb

@@ -0,0 +1,2 @@
+class OutOfMoneyError < StandardError
+end

data/lib/errors/out_of_selected_product_error.rb

@@ -0,0 +1,2 @@
+class OutOfSelectedProductError < StandardError
+end

data/lib/machine/cash.rb

@@ -0,0 +1,51 @@
+class Cash
+
+  class << self
+    def cash_values(coins)
+      coins.map { |coin| coin_map[coin] }
+    end
+
+    def string_values(coins)
+      coins.map { |coin| to_string[coin] }
+    end
+
+    def cash_value(coin)
+      coin_map[coin]
+    end
+
+    def string_value(coin)
+      to_string[coin]
+    end
+
+    def valid_coins
+      coin_map.keys
+    end
+
+    private def coin_map
+      {
+        "1c" => 1,
+        "2c" => 2,
+        "5c" => 5,
+        "10c" => 10,
+        "20c" => 20,
+        "50c" => 50,
+        "€1" => 100,
+        "€2" => 200
+      }
+    end
+
+    private def to_string
+      {
+        1 => "1c",
+        2 => "2c",
+        5 => "5c",
+        10 => "10c",
+        20 => "20c",
+        50 => "50c",
+        100 => "€1",
+        200 => "€2"
+      }
+    end
+  end
+
+end

data/lib/machine/machine.rb

@@ -0,0 +1,133 @@
+# frozen_string_literal: true
+
+require_relative "./cash"
+require_relative "./product"
+require_relative "../errors/invalid_coin_error"
+require_relative "../errors/more_money_error"
+require_relative "../errors/no_money_error"
+require_relative "../errors/out_of_money_error"
+require_relative "../errors/out_of_selected_product_error"
+
+class Machine
+  attr_accessor :products, :available_change
+
+  def initialize(products:, available_change:)
+    @products = products
+    @available_change = transform_keys_to_cash(available_change)
+  end
+
+  def select_product(product:, coins:)
+    raise ArgumentError unless coins.is_a? Array
+    raise NoMoneyError if coins.empty?
+    product = products[product]
+    raise OutOfSelectedProductError if product.nil? || product[:available].zero?
+    find_product(product: product[:product], cash_values: Cash.cash_values(coins))
+  end
+
+  def refill_products(products)
+    reload_products(product_refills: products)
+  end
+
+  def refill_cash(cash)
+    reload_cash(cash_refills: cash)
+  end
+
+  private def find_product(product:, cash_values:)
+    product_price = product.cash_value
+    if correct_change_given?(product_price: product_price, coins: cash_values)
+      available_change[product_price] += 1
+      decrement_available_products(product)
+      return product_and_change(product)
+    end
+    raise OutOfMoneyError if remaining_change.empty?
+    change = change(product_price: product_price, coins: cash_values)
+    coins = calculate_coin_denominations(change: change)
+    decrement_available_products(product)
+    product_and_change(product, Cash.string_values(coins))
+  end
+
+  private def product_and_change(product, change = nil)
+    {
+      product: product.name,
+      change: change.nil? ? ["0"] : change
+    }
+  end
+
+  private def correct_change_given?(product_price:, coins: [])
+    raise ArgumentError unless coins.is_a? Array
+    return true if exact_change?(coins: coins) && (product_price - coins.first).zero?
+    change = change(product_price: product_price, coins: coins)
+    change <= 0
+  end
+
+  private def change(product_price:, coins:)
+    @change ||= calculate_change(product_price: product_price, coins: coins)
+  end
+
+  private def calculate_change(product_price:, coins:)
+    sorted_coins = coins.sort.reverse!
+    sorted_coins.each do |coin|
+      product_price -= coin
+    end
+    raise MoreMoneyError if product_price.positive?
+    product_price.abs
+  end
+
+  private def calculate_coin_denominations(change:)
+    available_coins = remaining_change.keys.sort.reverse!
+    change_array = []
+    available_coins.each do |coin|
+      next if (change - coin).negative?
+      until (change - coin).negative?
+        change -= coin
+        change_array << coin
+      end
+    end
+    decrement_available_change(change_array)
+    change_array
+  end
+
+  private def reload_products(product_refills:)
+    raise ArgumentError unless product_refills.is_a? Array
+    raise ArgumentError unless product_refills.all? { |product_refill| product_refill[:product].is_a? Product }
+    raise ArgumentError if product_refills.empty?
+    product_refills.each do |product_refill|
+      product_name = product_refill[:product].name
+      if products[product_name].nil?
+        products[product_name] = product_refill
+      else
+        products[product_name][:available] += product_refill[:available]
+      end
+    end
+  end
+
+  private def reload_cash(cash_refills:)
+    raise ArgumentError if cash_refills.empty?
+    raise InvalidCoinError unless (cash_refills.keys - Cash.valid_coins).empty?
+    cash_value_refills = transform_keys_to_cash(cash_refills)
+    cash_value_refills.each do |coin, amount|
+      next if amount.negative?
+      available_change[coin] += amount
+    end
+  end
+
+  private def exact_change?(coins:)
+    coins.length == 1
+  end
+
+  private def remaining_change
+    available_change.select { |coin, remaining| remaining.positive? }
+  end
+
+  private def transform_keys_to_cash(coins)
+    coins.transform_keys! { |coin| Cash.cash_value(coin) }
+  end
+
+  private def decrement_available_change(change_array)
+    change_array.each { |change| available_change[change] -= 1 }
+  end
+
+  private def decrement_available_products(product)
+    products[product.name][:available] -= 1
+  end
+end

data/lib/machine/product.rb

@@ -0,0 +1,14 @@
+require_relative "./cash"
+
+class Product
+  attr_reader :name, :price
+
+  def initialize(name:, price:)
+    @name = name
+    @price = price
+  end
+
+  def cash_value
+    Cash.cash_value(price)
+  end
+end

data/lib/vending_machine/version.rb

@@ -0,0 +1,3 @@
+module VendingMachine
+  VERSION = "0.1.6"
+end

data/lib/vending_machine.rb

@@ -0,0 +1,33 @@
+require "machine/product"
+require "machine/machine"
+
+def products
+  snickers = Product.new(name: "Snickers", price: "€2")
+  mars_bar = Product.new(name: "Mars Bar", price: "€1")
+  {
+    "Snickers" => {
+      product: snickers,
+      available: 10
+    },
+    "Mars Bar" => {
+      product: mars_bar,
+      available: 5
+    }
+  }
+end
+
+def change
+  {
+    "1c" => 100,
+    "2c" => 100,
+    "5c" => 100,
+    "10c" => 100,
+    "20c" => 100,
+    "50c" => 100,
+    "€1" => 100,
+    "€2" => 100
+  }
+end
+
+module VendingMachine
+end

data/vending_machine.gemspec

@@ -0,0 +1,29 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "vending_machine/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "vending_machine"
+  spec.version       = VendingMachine::VERSION
+  spec.authors       = ["Jonathan O'Mahony"]
+  spec.email         = ["jonathanomahony@gmail.com"]
+
+  spec.summary       = %q{Simple Vending Machine}
+  spec.description   = %q{A simple vending machine in Ruby}
+  spec.license       = "MIT"
+
+  spec.add_development_dependency "rspec", '~> 0'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification
+name: vending_machine
+version: !ruby/object:Gem::Version
+  version: 0.1.6
+platform: ruby
+authors:
+- Jonathan O'Mahony
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-10-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: A simple vending machine in Ruby
+email:
+- jonathanomahony@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/errors/invalid_coin_error.rb
+- lib/errors/more_money_error.rb
+- lib/errors/no_money_error.rb
+- lib/errors/out_of_money_error.rb
+- lib/errors/out_of_selected_product_error.rb
+- lib/machine/cash.rb
+- lib/machine/machine.rb
+- lib/machine/product.rb
+- lib/vending_machine.rb
+- lib/vending_machine/version.rb
+- vending_machine.gemspec
+homepage: 
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.7
+signing_key: 
+specification_version: 4
+summary: Simple Vending Machine
+test_files: []