order_optimizer 0.1.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f0845a565bc344866e5e3d4725d28b890c9f3e4d57de36ee2789ee331f000168
-  data.tar.gz: b825661a3746a8b7bf574c3938efb2b412ac81163223a4836be013dda983100e
+  metadata.gz: 5868b03e4f28cfec6001c9e53e61ffba0907c6d626d4ee950596bf4b1f154075
+  data.tar.gz: 739453efda8bcfe9e015f91a47b0cf8945d0c9270fe8f18dc6241a71c5d35e63
 SHA512:
-  metadata.gz: 3103e356f667e9256ff3115d0381f05fa27906083232300c51833fcd5b15118fd4b4154542f07e781882a25a4de8f70b4604c8748c529f92a91d41af315391c4
-  data.tar.gz: 965406b44c6006b4ac863cc2dd3d8fc0872fd87a08bb4fadc45954cd81e6a724f7143975985c439a83a4a9a9d0630df54113a2e9e018cd16282ea420eff23315
+  metadata.gz: eebd782f5bc6971227292700da42edb7c30a3bca2d19573f65f901311b708aa91fd422ad1ca51a17798d28351e89a020eb1857b7ff7671892874f9e67fbe1429
+  data.tar.gz: d4f80534e745ed6723468c7bf7b49ce5fd5d45fb6db915b756601aa7b00894d10550baeb16bba5da96f4bc24c01e5638ab7ab79ac07ca6eb0bb6576aa4648663

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,4 +1,26 @@
 # OrderOptimizer Gem Changelog
 
+## 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

@@ -11,7 +11,7 @@ Imagine a product can be ordered in different pack sizes and each pack size has
 |      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). 
+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?
 
@@ -56,15 +56,85 @@ cheapest_order_for_947_units.total    # => 3_900.00
 cheapest_order_for_947_units.skus     # => { '1000-pack' => 1 }
 ```
 
+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 dicount prices a minimum quantity:
+
+```ruby
+order_optimizer = OrderOptimizer.new(
+  '1-pack' => { quantity: 1, price_per_unit: 9 },
+  '10-discount' => { quantity: 1, min_quantity: 10, price_per_unit: 8 },
+  '20-pack' => { quantity: 20, price_per_unit: 7 }
+)
+
+order_optimizer.cheapest_order(required_qty: 8).skus
+#=> { '1-pack' => 8 }
+
+order_optimizer.cheapest_order(required_qty: 9).skus
+#=> { '10-discount' => 10 }
+
+order_optimizer.cheapest_order(required_qty: 17).skus
+#=> { '10-discount' => 17 }
+
+order_optimizer.cheapest_order(required_qty: 18).skus
+#=> { '20-pack' => 1 }
+
+order_optimizer.cheapest_order(required_qty: 21).skus
+#=> { '20-pack' => 1, '1-pack' => 1 }
+
+order_optimizer.cheapest_order(required_qty: 29).skus
+#=> { '20-pack' => 1, '10-discount' => 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
 
@@ -72,4 +142,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,21 +10,57 @@ class OrderOptimizer
   end
 
   def cheapest_order(required_qty:)
-    possible_orders(required_qty: required_qty)
-      .min_by(&:total)
+    find_possible_orders(skus: @catalog.skus, required_qty: required_qty).min_by(&:total) ||
+      OrderOptimizer::Order.new(required_qty: required_qty)
   end
 
-  private
+  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
 
   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))
+    find_possible_orders(skus: @catalog.skus, required_qty: required_qty).sort_by(&:total)
+  end
+
+  private
+
+  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 = count_and_remainder_for_sku(order.missing_qty, sku)
+
+        orders << order.dup.add(sku, count: count) unless count.zero?
+        orders << order.dup.add(sku, count: count + 1) unless remainder.zero?
       end
+
+      count, remainder = count_and_remainder_for_sku(required_qty, sku)
+
+      unless count.zero?
+        orders << OrderOptimizer::Order.new(required_qty: required_qty).add(sku, count: count)
+      end
+
+      unless remainder.zero?
+        orders << OrderOptimizer::Order.new(required_qty: required_qty).add(sku, count: count + 1)
+      end
+    end
+
+    orders.select(&:complete?)
+  end
+
+  def count_and_remainder_for_sku(quantity, sku)
+    count, remainder = quantity.divmod(sku.quantity)
+
+    if 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]
+    else
+      [count, remainder]
     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,12 +1,21 @@
 class OrderOptimizer
   class Sku
-    attr_reader :id, :quantity, :price_per_unit, :price_per_sku
+    attr_reader :id, :quantity, :price_per_unit, :price_per_sku, :min_quantity
 
-    def initialize(id, quantity:, price_per_unit:)
+    def initialize(id, quantity:, price_per_sku: nil, price_per_unit: nil, min_quantity: nil)
       @id = id
-      @quantity = quantity
-      @price_per_unit = BigDecimal(price_per_unit, 2)
-      @price_per_sku = quantity * price_per_unit
+      @quantity = BigDecimal(quantity, 2)
+      @min_quantity = BigDecimal(min_quantity, 2) if min_quantity
+
+      unless price_per_unit || price_per_sku
+        raise ':price_per_sku or :price_per_unit must be set'
+      end
+
+      @price_per_unit = BigDecimal(price_per_unit, 2) if price_per_unit
+      @price_per_unit ||= BigDecimal(price_per_sku, 2) / quantity
+
+      @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.1.0"
+  VERSION = "0.4.1".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.1.0
+  version: 0.4.1
 platform: ruby
 authors:
 - crispymtn
 - Martin Spickermann
+- Maurice Vogel
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-12-13 00:00:00.000000000 Z
+date: 2021-02-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.3
 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