order_optimizer 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f0845a565bc344866e5e3d4725d28b890c9f3e4d57de36ee2789ee331f000168
+  data.tar.gz: b825661a3746a8b7bf574c3938efb2b412ac81163223a4836be013dda983100e
+SHA512:
+  metadata.gz: 3103e356f667e9256ff3115d0381f05fa27906083232300c51833fcd5b15118fd4b4154542f07e781882a25a4de8f70b4604c8748c529f92a91d41af315391c4
+  data.tar.gz: 965406b44c6006b4ac863cc2dd3d8fc0872fd87a08bb4fadc45954cd81e6a724f7143975985c439a83a4a9a9d0630df54113a2e9e018cd16282ea420eff23315

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.5
+before_install: gem install bundler -v 2.0.2

data/CHANGELOG.md

@@ -0,0 +1,4 @@
+# OrderOptimizer Gem Changelog
+
+
+## 0.1.0 First release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at op@crispymtn.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in order_optimizer.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,22 @@
+PATH
+  remote: .
+  specs:
+    order_optimizer (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    minitest (5.13.0)
+    rake (13.0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler
+  minitest
+  order_optimizer!
+  rake
+
+BUNDLED WITH
+   2.0.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Crispy Mountain GmbH
+
+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,75 @@
+# OrderOptimizer
+
+The `OrderOptimizer` gem helps to optimize orders when the goods are offered in different pack sizes and in different discount levels.
+
+Imagine a product can be ordered in different pack sizes and each pack size has a different price per unit. For example like this:
+
+| Pack size | Price per Unit |
+|-----------|----------------|
+|    1000   |      3.90      |
+|     100   |      4.00      |
+|      10   |      6.00      |
+|       1   |      9.00      |
+
+In this example, it is quite obvious that it is cheaper buying one 10-pack instead of nine 1-packs when you need 9 units (because the 10-pack costs 60.00 but nine 1-packs would cost 81.00). 
+
+But what would be the cheapest combination when you need 946 units? Or 947?
+
+The `OrderOptimizer` answers this kind of question in a performant way.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'order_optimizer'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install order_optimizer
+
+## Usage
+
+```ruby
+# Initialize the optimizer with a catalog
+order_optimizer = OrderOptimizer.new(
+  '1-pack' => { quantity: 1, price_per_unit: 9 },
+  '10-pack' => { quantity: 10, price_per_unit: 6 },
+  '100-pack' => { quantity: 100, price_per_unit: 4 },
+  '1000-pack' => { quantity: 1000, price_per_unit: 3.9 }
+)
+
+# Pick the cheapers possible order for the required quantity
+cheapest_order_for_946_units = order_optimizer.cheapest_order(required_qty: 946)
+cheapest_order_for_946_units.quantity # =>  946
+cheapest_order_for_946_units.total    # => 3894.00
+cheapest_order_for_946_units.skus     # => { '100-pack' => 9, '10-pack' => 4, '1-pack' => 6 }
+
+cheapest_order_for_947_units = order_optimizer.cheapest_order(required_qty: 947)
+cheapest_order_for_947_units.quantity # => 1_000
+cheapest_order_for_947_units.total    # => 3_900.00
+cheapest_order_for_947_units.skus     # => { '1000-pack' => 1 }
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/crispymtn/order_optimizer. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the OrderOptimizer project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/crispymtn/order_optimizer/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "order_optimizer"
+
+# 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/order_optimizer/catalog.rb

@@ -0,0 +1,13 @@
+require 'order_optimizer/sku'
+
+class OrderOptimizer
+  class Catalog
+    def initialize(skus)
+      @skus = skus.map { |id, values| Sku.new(id, **values) }.sort_by(&:price_per_unit)
+    end
+
+    def skus
+      @skus.dup
+    end
+  end
+end

data/lib/order_optimizer/order.rb

@@ -0,0 +1,18 @@
+class OrderOptimizer
+  class Order
+    attr_reader :quantity, :total, :skus
+
+    def initialize
+      @quantity = 0
+      @total    = 0
+      @skus     = {}
+    end
+
+    def add(sku, count: 1)
+      @quantity += count * sku.quantity
+      @total    += count * sku.price_per_sku
+      @skus     = skus.merge(sku.id => count) { |identifier, current, plus| current + plus }
+      self
+    end
+  end
+end

data/lib/order_optimizer/sku.rb

@@ -0,0 +1,12 @@
+class OrderOptimizer
+  class Sku
+    attr_reader :id, :quantity, :price_per_unit, :price_per_sku
+
+    def initialize(id, quantity:, price_per_unit:)
+      @id = id
+      @quantity = quantity
+      @price_per_unit = BigDecimal(price_per_unit, 2)
+      @price_per_sku = quantity * price_per_unit
+    end
+  end
+end

data/lib/order_optimizer/version.rb

@@ -0,0 +1,3 @@
+class OrderOptimizer
+  VERSION = "0.1.0"
+end

data/lib/order_optimizer.rb

@@ -0,0 +1,30 @@
+require 'bigdecimal'
+
+require "order_optimizer/catalog"
+require "order_optimizer/order"
+require "order_optimizer/version"
+
+class OrderOptimizer
+  def initialize(skus)
+    @catalog = OrderOptimizer::Catalog.new(skus)
+  end
+
+  def cheapest_order(required_qty:)
+    possible_orders(required_qty: required_qty)
+      .min_by(&:total)
+  end
+
+  private
+
+  def possible_orders(required_qty:)
+    [].tap do |orders|
+      skus  = @catalog.skus
+      order = OrderOptimizer::Order.new
+      while sku = skus.shift
+        count, remainder = (required_qty - order.quantity).divmod(sku.quantity)
+        order.add(sku, count: count) unless count.zero?
+        orders << (remainder.zero? ? order.dup : order.dup.add(sku))
+      end
+    end
+  end
+end

data/order_optimizer.gemspec

@@ -0,0 +1,30 @@
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "order_optimizer/version"
+
+Gem::Specification.new do |spec|
+  spec.name     = "order_optimizer"
+  spec.version  = OrderOptimizer::VERSION
+
+  spec.authors  = ["crispymtn", "Martin Spickermann"]
+  spec.email    = ["op@crispymtn.com", "spickermann@gmail.com"]
+  spec.homepage = "https://github.com/crispymtn/order_optimizer"
+  spec.license  = "MIT"
+  spec.summary  = "Helps to optimize orders if the goods are offered in different pack sizes and in different discount levels."
+
+
+  spec.metadata["changelog_uri"] = "https://github.com/crispymtn/order_optimizer/blob/master/CHANGELOG.md"
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+
+  # 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.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "minitest"
+  spec.add_development_dependency "rake"
+end

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification
+name: order_optimizer
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- crispymtn
+- Martin Spickermann
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-12-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: minitest
+  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: rake
+  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'
+description: 
+email:
+- op@crispymtn.com
+- spickermann@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/order_optimizer.rb
+- lib/order_optimizer/catalog.rb
+- lib/order_optimizer/order.rb
+- lib/order_optimizer/sku.rb
+- lib/order_optimizer/version.rb
+- order_optimizer.gemspec
+homepage: https://github.com/crispymtn/order_optimizer
+licenses:
+- MIT
+metadata:
+  changelog_uri: https://github.com/crispymtn/order_optimizer/blob/master/CHANGELOG.md
+  homepage_uri: https://github.com/crispymtn/order_optimizer
+  source_code_uri: https://github.com/crispymtn/order_optimizer
+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: []
+rubygems_version: 3.0.6
+signing_key: 
+specification_version: 4
+summary: Helps to optimize orders if the goods are offered in different pack sizes
+  and in different discount levels.
+test_files: []