seshbot-packing 0.8.1 → 0.8.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3134dc89051dbe2bb688dc5608eee3ecc73847d141561f9a78376a414130039d
-  data.tar.gz: eb87d9d7d2f0a5ea8e3b972201101dd6eaeed1f207637e38a4c68a9e607c7f43
+  metadata.gz: c1693c794a4be401fe157bd5a6385e1375e37c738e8919a168cc881ec262f9ec
+  data.tar.gz: 44c25e149bc8dba14cc2cc49f309b5e3ba5901bf4a636f89787ec5e946e28502
 SHA512:
-  metadata.gz: 75385b37a1a5b0304483316012a6b626120861523701087ca5ea19ebbf0adf7a236d66783e7385206009989b4578f836bf44ddd2226914fafc5bd5a2da250a8a
-  data.tar.gz: 48d84bdb45a986d0cb166f2d073965f38c8aba4ebacf9456e8ed980a4e33b06ee60c33722c60c551c6863f316c4ac73663f0512e678769d166a2059ccd018970
+  metadata.gz: 59f4cb5bad8c401ef6dde61443937c3bbce68f37f659aef074175a067fd6ea91b346531bc1c809d7b2788a30969eb14c92d8f716fc382d56ac26560cec6c93fd
+  data.tar.gz: c9536fe10e717e4841e8521f5986e467cc0e2b029c3a7512cee255f61941f0d0a5041c6ff0a9a047c218691d9b47ef69b14da6df7227f304cc4eb015f0ba1afa

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    seshbot-packing (0.8.0)
+    seshbot-packing (0.8.6)
 
 GEM
   remote: https://rubygems.org/

data/lib/seshbot/packing.rb

@@ -1,3 +1,4 @@
 require "seshbot/packing/version"
 require "seshbot/packing/package"
 require "seshbot/packing/recipe"
+require "seshbot/packing/line_item"

data/lib/seshbot/packing/line_item.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Seshbot
+  module Packing
+    # :nodocs:
+    class LineItem
+      attr_accessor :sku, :quantity, :price
+
+      def initialize(sku, quantity, price=0)
+        raise 'SKU must be a string' if sku.class != String
+        raise 'Quantity must be an integer' if quantity.class != Integer
+
+        @sku = sku
+        @quantity = quantity
+        @price = price
+      end
+    end
+  end
+end

data/lib/seshbot/packing/package.rb

@@ -5,35 +5,46 @@ module Seshbot
   module Packing
     class Error < StandardError; end
     class << self
+      @@logger = nil
       def logger
-        Logger.new(STDERR)
+        if @@logger.nil?
+          @@logger = Logger.new(STDERR)
+          @@logger.level = 1
+        end
+        @@logger
       end
 
       def filter_by_sku(items, sku_fragment, inverse: false)
         items.select do |i|
-          matches = i['sku'].include?(sku_fragment)
+          matches = i.sku.include?(sku_fragment)
           inverse ? !matches : matches
         end
       end
 
       def substitute_sku(items, from, to)
-        items.each { |i| i['sku'].gsub!(from, to) }
-        items
+        items.map { |i| Seshbot::Packing::LineItem.new(i.sku.gsub(from, to), i.quantity) }
       end
 
       def count_product_types(items)
         result = Hash.new(0)
         # create a hash were the keys are sku_fragment, and the values are the summed quantities
         items.each do |item|
-          size = packaged_size(item["sku"])
-          result[size] += item["quantity"]
+          size = packaged_size(item.sku)
+          result[size] += item.quantity
         end
-        result
+        result.map { |k,v| Seshbot::Packing::LineItem.new("BUND-#{k}", v) }
       end
 
       def packaged_size(sku)
-        # Takes an sku and returns the size
-        result = sku[/[LUP]\d{2}|[BCM]\d{3}/]
+        size_regex = /-(K?[LUP]\d{2}|[BCM]\d{3})/
+        match = sku.match(size_regex)
+        raise "Cannot determine packaged size for SKU: #{sku}" if match.nil? || match.captures.empty?
+
+        # this is everything inside the (..) in the regex (everything except the leading '-')
+        result = match.captures[0]
+        # HACK! for legacy reasons, we don't consider K to be part of the size.
+        result.gsub!(/^K/, '')
+
         if result == "B502"
           result = "B306"
         end
@@ -45,20 +56,19 @@ module Seshbot
         result
       end
 
-      def bundle_items(items, fulfilled_at: nil)
+      def bundle_items(recipes, items, fulfilled_at: nil)
         logger.debug "***** BUNDLING"
         logger.debug "Bundling Items: #{items}. Fulfilled at: #{fulfilled_at || '(no fulfillment date)'}"
         if !fulfilled_at.nil? && fulfilled_at < DateTime.new(2020, 1, 14, 8, 0, 0, Time.new.zone)
-          return items.map { |item| { 'sku' => item.sku, 'quantity' => item.quantity, 'price' => item.price } }
+          return items
         end
 
         # get the cans first, and separate them out
         cans = filter_by_sku(items, '-C')
         unless cans.empty?
-          product_type_counts = count_product_types(cans)
-          product_type_counts = unpack(product_type_counts)
-          product_type_counts = pack(product_type_counts)
-          new_can_items = product_type_counts.map { |k, v| { 'sku' => "BUND-#{k}", 'quantity' => v, 'price' => 0 } }
+          bundle_items_by_type = count_product_types(cans)
+          bundle_items_by_type = unpack(recipes, bundle_items_by_type)
+          new_can_items = pack(recipes, bundle_items_by_type)
           # separate out all the C324s
           separated_c324s = filter_by_sku(new_can_items, '-C324')
           logger.debug "Cans: #{cans}"
@@ -76,16 +86,15 @@ module Seshbot
         logger.debug " - remaining items: #{remaining_items}"
 
         # substitute C's for B's
-        substitute_sku(remaining_items, '-C', '-B')
+        remaining_items = substitute_sku(remaining_items, '-C', '-B')
         logger.debug " - skus updated to: #{remaining_items}"
 
         # get a hash of {pack_6: 5, pack_12: 1}
-        product_type_counts = count_product_types(remaining_items)
+        bundle_items_by_type = count_product_types(remaining_items)
         # dismantle packages into individual units (e.g., {pack_6: 7})
-        product_type_counts = unpack(product_type_counts)
+        bundle_items_by_type = unpack(recipes, bundle_items_by_type)
         # repackage into the 'best' packaging we can figure out (e.g., {pack_12: 2})
-        product_type_counts = pack(product_type_counts)
-        new_remaining_items = product_type_counts.map { |k,v| { "sku" => "BUND-#{k}", "quantity" => v, "price" => 0} }
+        new_remaining_items = pack(recipes, bundle_items_by_type)
 
         separated_c324s ||= []
         merged_items = new_remaining_items + separated_c324s
@@ -95,45 +104,47 @@ module Seshbot
         merged_items
       end
 
+      def unpack(recipes, items)
 
-      def unpack(product_type_counts)
-        final_result = product_type_counts
+        final_result = items
 
-        while true
-          new_result = pack_single_step(final_result, unpacking: true)
-          break if new_result == final_result
+        loop do
+          new_result = pack_single_step(recipes, final_result, unpacking: true)
+          break if new_result.map { |li| [li.sku, li.quantity] }.sort == final_result.map { |li| [li.sku, li.quantity] }.sort
 
           final_result = new_result
         end
         final_result
       end
 
-      def pack_single_step(product_type_counts, unpacking:)
+      def pack_single_step(recipes, items, unpacking:)
         result = Hash.new(0)
-        product_type_counts.each do |sku_fragment, qty|
-          recipe = Recipe::find_best_recipe(sku_fragment, qty, unpacking: unpacking)
+        items.each do |item|
+          sku_size = packaged_size(item.sku)
+          recipe = Recipe::find_best_recipe(recipes, sku_size, item.quantity, unpacking: unpacking)
           if recipe.nil?
-            result[sku_fragment] += qty
+            result[sku_size] += item.quantity
             next
           end
 
-          recipe_quantities = Recipe::apply_recipe(recipe, qty)
+          recipe_quantities = Recipe::apply_recipe(recipe, item.quantity)
           result[recipe["input_fragment"]] += recipe_quantities[:input_quantity]
           result[recipe["output_fragment"]] += recipe_quantities[:output_quantity]
         end
         result.delete_if { |k,v| v == 0}
-        result
+        result.map { |k,v| Seshbot::Packing::LineItem.new("BUND-#{k}", v) }
       end
 
 
-      def pack(product_type_counts)
-        final_result = product_type_counts
+      def pack(recipes, items)
+        final_result = items
 
         # keep trying to 'pack' until it stabilises (e.g., 6x6pack => 1x24pack+2x6pack => 1x24pack+1x12pack)
-        while true
-          new_result = pack_single_step(final_result, unpacking: false)
+        loop do
+          new_result = pack_single_step(recipes, final_result, unpacking: false)
           # no changes, break out
-          break if new_result == final_result
+          break if new_result.map { |li| [li.sku, li.quantity] }.sort == final_result.map { |li| [li.sku, li.quantity] }.sort
+
           final_result = new_result
         end
         final_result

data/lib/seshbot/packing/recipe.rb

@@ -2,61 +2,8 @@ module Seshbot
   module Packing
     module Recipe
       class << self
-        def get_recipes
-          {
-              "bottles_twenty_four_pack_4"=>{
-                  "input_fragment"=>"B306",
-                  "input_quantity"=>4,
-                  "output_fragment"=>"B324",
-                  "output_quantity"=>1
-              },
-              "bottles_twenty_four_pack_3"=>{
-                  "input_fragment"=>"B306",
-                  "input_quantity"=>3,
-                  "output_fragment"=>"B318",
-                  "output_quantity"=>1
-              },
-              "bottles_twelve_pack"=>{
-                  "input_fragment"=>"B306",
-                  "input_quantity"=>2,
-                  "output_fragment"=>"B312",
-                  "output_quantity"=>1
-              },
-              "bottles_six_pack"=>{
-                "input_fragment"=>"B301",
-                "input_quantity"=>6,
-                "output_fragment"=>"B306",
-                "output_quantity"=>1
-              },
-              "cans_twenty_four_pack_4"=>{
-                "input_fragment"=>"C306",
-                "input_quantity"=>4,
-                "output_fragment"=>"C324",
-                "output_quantity"=>1
-              },
-              "cans_twenty_four_pack_3"=>{
-                "input_fragment"=>"C306",
-                "input_quantity"=>3,
-                "output_fragment"=>"C318",
-                "output_quantity"=>1
-              },
-              "cans_twelve_pack"=>{
-                "input_fragment"=>"C306",
-                "input_quantity"=>2,
-                "output_fragment"=>"C312",
-                "output_quantity"=>1
-              },
-              "cans_six_pack"=>{
-                "input_fragment"=>"C301",
-                "input_quantity"=>6,
-                "output_fragment"=>"C306",
-                "output_quantity"=>1
-              }
-          }
-        end
-
-        def find_best_recipe(sku_fragment, qty, unpacking: false)
-          recipes = find_recipes(sku_fragment, qty, unpacking: unpacking)
+        def find_best_recipe(recipes_hash, sku_fragment, qty, unpacking: false)
+          recipes = find_recipes(recipes_hash, sku_fragment, qty, unpacking: unpacking)
           # we want the recipe that is 'best' (packaging into as few items as possible, or unpacaging into as many as possible)
           best_recipe_quantities = nil
           recipes.each do |name, recipe|
@@ -77,8 +24,7 @@ module Seshbot
           best_recipe_quantities[:recipe] if best_recipe_quantities
         end
 
-        def find_recipes(sku_fragment, qty, unpacking: false)
-          recipes = get_recipes
+        def find_recipes(recipes, sku_fragment, qty, unpacking: false)
           recipes = reverse_recipes(recipes) if unpacking
           recipes.select do |name, recipe|
             recipe["input_fragment"] == sku_fragment && qty >= recipe["input_quantity"]

data/lib/seshbot/packing/version.rb

@@ -1,5 +1,5 @@
 module Seshbot
   module Packing
-    VERSION = '0.8.1'
+    VERSION = '0.8.6'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: seshbot-packing
 version: !ruby/object:Gem::Version
-  version: 0.8.1
+  version: 0.8.6
 platform: ruby
 authors:
 - Shaun
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-01-13 00:00:00.000000000 Z
+date: 2021-03-31 00:00:00.000000000 Z
 dependencies: []
 description:
 email:
@@ -28,6 +28,7 @@ files:
 - bin/console
 - bin/setup
 - lib/seshbot/packing.rb
+- lib/seshbot/packing/line_item.rb
 - lib/seshbot/packing/package.rb
 - lib/seshbot/packing/recipe.rb
 - lib/seshbot/packing/version.rb