order_optimizer 0.2.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d3dec3fd3cab38f6a56c1fa13e3ee398e4b196c1c992cdf6f4c7e87c2c19e2f1
-  data.tar.gz: 9cd52e4ae25d980de2b8b4ba1988bbe42dac0dd686d0d1c7f23584c7889cb3e8
+  metadata.gz: 21b6b1f9358d26572d0f3fe4d2a237c2da2a217bbb5f2d241d7a98683a9a43e1
+  data.tar.gz: 29987d3e12a263c8f18acdcf6c1972dcfa91204ece002e1a778ccc72a38a2843
 SHA512:
-  metadata.gz: 958f1f99429e00465cdc9a562dff1717da0b145827430704766756626444559e25f1f0b615c7f19cb274bc1783e33fb2eb3ca34b8e4d114e08af5f01f75c05f2
-  data.tar.gz: 0cfb7dc00f8eacff31bff96cfedee003427e9e9e4677f8a382f7aa28e0148de5ca902ca576697aeba54c3b28a19a3302f451fb0944dc96464908742a9328287f
+  metadata.gz: 32b08adac0ba68f5133e60506b72a2f969d2e5617fd02ab16e922a05088e0afb81294041d6cbf6762dc70e8877a522733dc6160bb5583a30f744d67668efbee7
+  data.tar.gz: e8808b19221863663091640750d3765fccbf9dea0a4191f8cb9b1d13c46f49a3fa47f7ba8f906efaaa7bf5f3a6f7f13873ccdf19a59fcd32e81025b409676300

data/.circleci/config.yml

@@ -0,0 +1,63 @@
+version: 2.1
+jobs:
+  test:
+    docker:
+      - image: circleci/ruby:3.0
+
+    working_directory: ~/repo
+
+    steps:
+      - checkout
+
+      - restore_cache:
+          keys:
+            - v1-dependencies-{{ checksum "order_optimizer.gemspec" }}
+            # fallback to using the latest cache if no exact match is found
+            - v1-dependencies-
+
+      - run:
+          name: install dependencies
+          command: bundle install --jobs=4 --retry=3 --path vendor/bundle
+
+      - save_cache:
+          paths:
+            - ./vendor/bundle
+          key: v1-dependencies-{{ checksum "order_optimizer.gemspec" }}
+
+      - run:
+          name: run tests
+          command: bundle exec rake
+
+  publish:
+    docker:
+      - image: circleci/ruby:3.0
+    working_directory: ~/repo
+    steps:
+      - checkout
+      - run:
+          name: Build package
+          command: gem build order_optimizer.gemspec
+      - run:
+          name: Push package
+          command: |
+            VERSION=$(ruby -r "./lib/order_optimizer/version.rb" -e "print OrderOptimizer::VERSION")
+            gem push order_optimizer-${VERSION}.gem
+
+workflows:
+  default:
+    jobs:
+      - test:
+          filters:
+            tags:
+              only: /.*/
+            branches:
+              only: /.*/
+      - publish:
+          context:
+            - rubygems-push
+          requires: [test]
+          filters:
+            tags:
+              only: /^v.*/
+            branches:
+              ignore: /.*/

data/.gitignore

@@ -6,3 +6,4 @@
 /pkg/
 /spec/reports/
 /tmp/
+Gemfile.lock

data/CHANGELOG.md

@@ -1,7 +1,29 @@
 # OrderOptimizer Gem Changelog
 
+## 0.5.0 (2021-04-15)
+- Add `maximum_quantity` for SKUs
+
+## 0.4.1 (2021-02-15)
+
+- Fix issue with floating point conversion [#3]
+
+## 0.4.0 (2020-12-11)
+
+- Add `possible_orders` method to find all possible orders
+- Fix issues with zero remainders on calculations
+
+## 0.3.0 (2020-11-23)
+
+- Add `cheapest_exact_order` method to optimize an order with an exact amount
+
+## 0.2.1 (2019-12-18)
+
+- Improve result for mixed catalogs with discounts and multiple pack sizes
+
 ## 0.2.0 (2019-12-16)
 
 - Add support for discounts when ordering a minimum quantity
 
 ## 0.1.0 First release
+
+[#3]: https://github.com/zaikio/order_optimizer/pull/3

data/README.md

@@ -56,7 +56,23 @@ cheapest_order_for_947_units.total    # => 3_900.00
 cheapest_order_for_947_units.skus     # => { '1000-pack' => 1 }
 ```
 
-It is possible to define dicount prices a minimum quantity:
+You can also optimize your order for exact order amounts
+
+```ruby
+# Initialize the optimize with a catalog
+order_optimizer = OrderOptimizer.new(
+  '1-pack' => { quantity: 1, price_per_unit: 9 },
+  '10-pack' => { quantity: 10, price_per_unit: 5 },
+)
+
+# Pick the cheapest order that includes the exact required quantity
+cheapest_exact_order_for_58_units = order_optimizer.cheapest_exact_order(required_qty: 56)
+cheapest_exact_order_for_58_units.quantity # => 58
+cheapest_exact_order_for_58_units.total # => 322
+cheapest_exact_order_for_58_units.skus # => { '10-pack' => 5, '1-pack' => 8 }
+```
+
+It is possible to define discount prices with a minimum quantity:
 
 ```ruby
 order_optimizer = OrderOptimizer.new(
@@ -84,15 +100,52 @@ order_optimizer.cheapest_order(required_qty: 29).skus
 #=> { '20-pack' => 1, '10-discount' => 10 }
 ```
 
+It is also possible to define discount prices with a maximum quantity:
+```ruby
+order_optimizer = OrderOptimizer.new(
+  '1-pack' => { quantity: 1, price_per_unit: 9 },
+  '10-pack' => { quantity: 10, price_per_unit: 8, max_quantity: 20 },
+)
+
+order_optimizer.cheapest_order(required_qty: 30).skus
+#=> { '10-pack' => 2, '1-pack' => 10 }
+```
+
+If you're just interested in all possible order combinations:
+
+```ruby
+# Initialize the optimize with a catalog
+order_optimizer = OrderOptimizer.new(
+  '1-pack' => { quantity: 1, price_per_unit: 9 },
+  '10-pack' => { quantity: 10, price_per_unit: 5 },
+)
+
+order_optimizer.possible_orders(required_qty: 11).size
+#=> 3
+order_optimizer.possible_orders(required_qty: 10).map(&:skus)
+#=> [{"10-pack"=>1, "1-pack"=>1}, {"1-pack"=>11}, {"10-pack"=>2}]
+```
+
 ## 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.
+Bug reports and pull requests are welcome on GitHub at
+https://github.com/zaikio/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.
+
+- Make your changes and submit a pull request for them
+- Make sure to update `CHANGELOG.md`
+
+To release a new version of the gem:
+- Update the version in `lib/order_optimizer/version.rb`
+- Update `CHANGELOG.md` to include the new version and its release date
+- Commit and push your changes
+- Create a [new release on GitHub](https://github.com/zaikio/order_optimizer/releases/new)
+- CircleCI will build the Gem package and push it Rubygems for you
 
 ## License
 
@@ -100,4 +153,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## 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).
+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/zaikio/order_optimizer/blob/master/CODE_OF_CONDUCT.md).

data/lib/order_optimizer.rb

@@ -1,8 +1,8 @@
 require 'bigdecimal'
 
-require "order_optimizer/catalog"
-require "order_optimizer/order"
-require "order_optimizer/version"
+require 'order_optimizer/catalog'
+require 'order_optimizer/order'
+require 'order_optimizer/version'
 
 class OrderOptimizer
   def initialize(skus)
@@ -10,39 +10,63 @@ class OrderOptimizer
   end
 
   def cheapest_order(required_qty:)
-    orders =
-      possible_orders(skus: @catalog.skus_without_min_quantities, required_qty: required_qty) +
-      possible_orders(skus: @catalog.skus_with_min_quantities, required_qty: required_qty) +
-      possible_orders(skus: @catalog.skus, required_qty: required_qty)
+    find_possible_orders(skus: @catalog.skus, required_qty: required_qty).min_by(&:total) ||
+      OrderOptimizer::Order.new(required_qty: required_qty)
+  end
+
+  def cheapest_exact_order(required_qty:)
+    find_possible_orders(skus: @catalog.skus, required_qty: required_qty).select(&:exact?).min_by(&:total) ||
+      OrderOptimizer::Order.new(required_qty: required_qty)
+  end
 
-    orders.min_by(&:total) || OrderOptimizer::Order.new
+  def possible_orders(required_qty:)
+    find_possible_orders(skus: @catalog.skus, required_qty: required_qty).sort_by(&:total)
   end
 
   private
 
-  def possible_orders(required_qty:, skus:)
-    [].tap do |orders|
-      order = OrderOptimizer::Order.new
+  def find_possible_orders(required_qty:, skus:)
+    return [] if required_qty < 1 || skus.empty?
+
+    orders = []
+
+    skus.each do |sku|
+      orders.reject(&:complete?).each do |order|
+        count, remainder, skip_increase = count_and_remainder_for_sku(order.missing_qty, sku)
 
-      while required_qty.positive? && (sku = skus.shift)
-        count, remainder = (required_qty - order.quantity).divmod(sku.quantity)
-        count, remainder = adjustment_for_skus_with_min_quantity(sku, count, remainder)
+        orders << order.dup.add(sku, count: count) unless count.zero?
+        orders << order.dup.add(sku, count: count + 1) unless remainder.zero? || skip_increase
+      end
 
-        order.add(sku, count: count) unless count.zero?
+      count, remainder, skip_increase = count_and_remainder_for_sku(required_qty, sku)
 
-        orders << (remainder.positive? ? order.dup.add(sku) : order.dup)
+      unless count.zero?
+        orders << OrderOptimizer::Order.new(required_qty: required_qty).add(sku, count: count)
+      end
 
-        order = OrderOptimizer::Order.new if sku.min_quantity
+      unless remainder.zero? || skip_increase
+        orders << OrderOptimizer::Order.new(required_qty: required_qty).add(sku, count: count + 1)
       end
     end
+
+    orders.select(&:complete?)
   end
 
-  def adjustment_for_skus_with_min_quantity(sku, count, remainder)
-    units = count * sku.quantity
+  def count_and_remainder_for_sku(quantity, sku)
+    count, remainder = quantity.divmod(sku.quantity)
 
-    return count, remainder if sku.min_quantity.nil? || units >= sku.min_quantity
+    if sku.max_quantity && count * sku.quantity > sku.max_quantity
+      new_count = (sku.max_quantity / sku.quantity).ceil
+      remainder = (count - new_count) * sku.quantity
 
-    delta = ((sku.min_quantity - units).to_f / sku.quantity).ceil
-    [count + delta, remainder - (delta * sku.quantity)]
+      [new_count, [remainder, 0].max, true]
+    elsif sku.min_quantity && count * sku.quantity < sku.min_quantity
+      new_count = (sku.min_quantity / sku.quantity).ceil
+      remainder -= (new_count - count) * sku.quantity
+
+      [new_count, [remainder, 0].max, false]
+    else
+      [count, remainder, false]
+    end
   end
 end

data/lib/order_optimizer/catalog.rb

@@ -9,13 +9,5 @@ class OrderOptimizer
     def skus
       @skus.dup
     end
-
-    def skus_without_min_quantities
-      @skus.reject(&:min_quantity)
-    end
-
-    def skus_with_min_quantities
-      @skus.select(&:min_quantity)
-    end
   end
 end

data/lib/order_optimizer/order.rb

@@ -2,17 +2,30 @@ class OrderOptimizer
   class Order
     attr_reader :quantity, :total, :skus
 
-    def initialize
-      @quantity = 0
-      @total    = 0
-      @skus     = {}
+    def initialize(required_qty:)
+      @quantity     = 0
+      @required_qty = required_qty
+      @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 }
+      @skus = skus.merge(sku.id => count) { |_identifier, current, plus| current + plus }
       self
     end
+
+    def missing_qty
+      [@required_qty - quantity, 0].max
+    end
+
+    def complete?
+      missing_qty.zero?
+    end
+
+    def exact?
+      @required_qty == quantity
+    end
   end
 end

data/lib/order_optimizer/sku.rb

@@ -1,25 +1,24 @@
 class OrderOptimizer
   class Sku
-    attr_reader :id, :quantity, :price_per_unit, :price_per_sku, :min_quantity
+    attr_reader :id, :quantity, :price_per_unit, :price_per_sku, :min_quantity, :max_quantity
 
-    def initialize(id, quantity:, price_per_unit:, min_quantity: nil)
+    def initialize(id, quantity:, price_per_sku: nil, price_per_unit: nil, min_quantity: nil, max_quantity: nil)
       @id = id
-      @quantity = quantity
-      @price_per_unit = BigDecimal(price_per_unit, 2)
-      @price_per_sku = quantity * price_per_unit
-      @min_quantity = min_quantity
-    end
+      @quantity = BigDecimal(quantity, 2)
+      @min_quantity = BigDecimal(min_quantity, 2) if min_quantity
+      @max_quantity = BigDecimal(max_quantity, 2) if max_quantity
+
+      if min_quantity && max_quantity && (min_quantity > max_quantity)
+        raise ArgumentError, "min_quantity can't be larger than max_quantity"
+      end
 
-    private
+      raise ArgumentError, ':price_per_sku or :price_per_unit must be set' unless price_per_unit || price_per_sku
 
-    def set_min_quantity(min_qty)
-      return unless min_qty
+      @price_per_unit = BigDecimal(price_per_unit, 2) if price_per_unit
+      @price_per_unit ||= BigDecimal(price_per_sku, 2) / quantity
 
-      if min_quantity.modulo(quantity).zero?
-        @min_quantity = min_qty
-      else
-        raise ':min_quantity must be a multiple of :quantity'
-      end
+      @price_per_sku = BigDecimal(price_per_sku,  2) if price_per_sku
+      @price_per_sku ||= quantity * price_per_unit
     end
   end
 end

data/lib/order_optimizer/version.rb

@@ -1,3 +1,3 @@
 class OrderOptimizer
-  VERSION = "0.2.0"
+  VERSION = "0.5.0".freeze
 end

data/order_optimizer.gemspec

@@ -6,14 +6,14 @@ 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.authors  = ["crispymtn", "Martin Spickermann", "Maurice Vogel"]
+  spec.email    = ["op@zaikio.com", "spickermann@gmail.com"]
+  spec.homepage = "https://github.com/zaikio/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["changelog_uri"] = "https://github.com/zaikio/order_optimizer/blob/master/CHANGELOG.md"
   spec.metadata["homepage_uri"] = spec.homepage
   spec.metadata["source_code_uri"] = spec.homepage
 

metadata

@@ -1,15 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: order_optimizer
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.5.0
 platform: ruby
 authors:
 - crispymtn
 - Martin Spickermann
+- Maurice Vogel
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-12-16 00:00:00.000000000 Z
+date: 2021-04-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -55,18 +56,18 @@ dependencies:
         version: '0'
 description: 
 email:
-- op@crispymtn.com
+- op@zaikio.com
 - spickermann@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".circleci/config.yml"
 - ".gitignore"
 - ".travis.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -78,13 +79,13 @@ files:
 - lib/order_optimizer/sku.rb
 - lib/order_optimizer/version.rb
 - order_optimizer.gemspec
-homepage: https://github.com/crispymtn/order_optimizer
+homepage: https://github.com/zaikio/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
+  changelog_uri: https://github.com/zaikio/order_optimizer/blob/master/CHANGELOG.md
+  homepage_uri: https://github.com/zaikio/order_optimizer
+  source_code_uri: https://github.com/zaikio/order_optimizer
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -100,7 +101,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
+rubygems_version: 3.2.15
 signing_key: 
 specification_version: 4
 summary: Helps to optimize orders if the goods are offered in different pack sizes

data/Gemfile.lock

@@ -1,22 +0,0 @@
-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