seshbot-packing 0.5.0 → 0.8.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fcd108047bea2fe4b890f489dfae607149553eda6580377307ba0da508b09106
-  data.tar.gz: fa66fc1bf3d90177921fd3abb9916140bffe80d83a3ebcd991e4ea7c6090bf26
+  metadata.gz: b5c704b0aaa991e8fe3cc828791fa04b78b5cb742da74985e7d8fb4a151d6bb7
+  data.tar.gz: 704326012b06c7cb027004351e54f9123aceede796cf11da63bccaf793df68b6
 SHA512:
-  metadata.gz: 489a49b0e178294f885d70301b339292a85de575044a6c4a1473a25793cf851f288b95a50530c26fb6fadfc5b94639f4eaec35c218aa659be37a064942597b16
-  data.tar.gz: 6e2bd8737ef03133ae76ae6811f6ddc96efe5e72ff8db287471a0be89f8c631587335f8032a69196498bf4d449548b628d98d24adecde619845a7b2dc58c4266
+  metadata.gz: 0a9c6f27dceded9253e7e0ba1297ff4bb331d5b2b695e5261bb3255609c003ea438313d691e8fade12cb4752d021b1c1256214a7aa5ec39c81f3400c4afd2518
+  data.tar.gz: c18687b3b45ac45f5894e0b1ddc394d2931e698c68cc6c3c860cfeb4b8b4611ad7dc812b190ddf033f9828723207b29055f6229da8df974eb8170f933821f22a

data/.gitignore

@@ -1,4 +1,5 @@
 .byebug_history
+.ruby-version
 /.bundle/
 /.yardoc
 /_yardoc/

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## Version 0.8.0
+
+* -C324 are calculated and separated from bundling

data/Gemfile.lock

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

data/README.md

@@ -1,9 +1,5 @@
 # Seshbot::Packing
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/seshbot/packing`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
-
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -20,9 +16,43 @@ Or install it yourself as:
 
     $ gem install seshbot-packing
 
-## Usage
+## Methods
+
+```ruby
+# Bundle Items
+## this is the main method, it calls most other methods to get its result
+items = [{ 'sku' => 'B-B306', 'quantity' => 2, 'price' => 1 }]
+Seshbot::Packing.bundle_items(items)
+#=> [{ 'sku' => 'BUND-B312', 'quantity' => 1, 'price' => 0 }]
+
+# Count Product Types
+## groups together everythign after the `-` and counts them
+items = [{"sku" => "A-B306", "quantity" => 2}, {"sku" => "B-B306", "quantity" => 1}]
+Seshbot::Packing.count_product_types(items)
+#=> {"B306"=>3}
+
+# Separate SKU
+## returns the hashes where the sku value matches the given string
+items = [{ 'sku' => 'A-C306', 'quantity' => 4, 'price' => 1 },
+         { 'sku' => 'A-B306', 'quantity' => 4, 'price' => 1 }]
+Seshbot::Packing.filter_by_sku(items, '-C')
+#=> [{ 'sku' => 'A-C306', 'quantity' => 4, 'price' => 1 }]
+## also takes a named argument
+Seshbot::Packing.filter_by_sku(items, '-C', inverse: true)
+#=> [{ 'sku' => 'A-B306', 'quantity' => 4, 'price' => 1 }]
+
+# Substitute SKU
+## replaces an sku in a hash
+Seshbot::Packing.substitute_sku(items, '-B', '-C')
+#=> items = [{"sku" => "A-C306", "quantity" => 2}, {"sku" => "B-C306", "quantity" => 1}]
+```
+
 
-TODO: Write usage instructions here
+## C324s
+As of v0.8.0, C324s will be treated differently. If there are any C324s that can exist, they will stay as C324s, and not converted to bottles.
+eg.
+In:  1x C312, 1x C312, 1x C306, 1x B306
+Out: 1x C324, 1x B312
 
 ## Development
 

data/lib/seshbot/packing/package.rb

@@ -1,13 +1,30 @@
-require "date"
+require 'logger'
+require 'date'
+
 module Seshbot
   module Packing
     class Error < StandardError; end
-
     class << self
+      def logger
+        Logger.new(STDERR)
+      end
+
+      def filter_by_sku(items, sku_fragment, inverse: false)
+        items.select do |i|
+          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
+      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| 
+        items.each do |item|
           size = packaged_size(item["sku"])
           result[size] += item["quantity"]
         end
@@ -15,36 +32,74 @@ module Seshbot
       end
 
       def packaged_size(sku)
-        # Takes an sku and returns the size
-        result = sku[/(L\d{2}|U\d{2}|B\d{3}|C\d{3}|M\d{3}|P\d{2})/]
+        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
         if result == "B504"
           result = "B312"
         end
-        result.gsub!(/^C/, 'B')
+        raise "Cannot determine packaged size for SKU: #{sku}" if result.nil?
+
         result
       end
 
       def bundle_items(items, fulfilled_at: nil)
-        if fulfilled_at
-          bundling_start_date =  DateTime.new(2020, 1, 14, 8, 0, 0, Time.new.zone)
-          result = items.map { |item| { "sku" => item.sku, "quantity" => item.quantity, "price" => item.price } }
-          return result if fulfilled_at < bundling_start_date # TODO remove bundling start date method
+        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 } }
         end
 
-        # get a hash of {pack_6: 5, pack_12: 1}
-        product_type_counts = count_product_types(items)
+        # 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 } }
+          # separate out all the C324s
+          separated_c324s = filter_by_sku(new_can_items, '-C324')
+          logger.debug "Cans: #{cans}"
+          logger.debug " - Removed C324s: #{separated_c324s}"
+
+          remaining_cans = filter_by_sku(new_can_items, '-C324', inverse: true)
+          logger.debug " - Remaining skus: #{remaining_cans}"
+        end
 
+        # merge the remaining with the original leftover
+        non_cans = filter_by_sku(items, '-C', inverse: true)
+        remaining_cans ||= []
+        remaining_items = non_cans + remaining_cans
+        logger.debug "Substituting:"
+        logger.debug " - remaining items: #{remaining_items}"
+
+        # substitute C's for B's
+        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)
         # dismantle packages into individual units (e.g., {pack_6: 7})
         product_type_counts = unpack(product_type_counts)
-
         # 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_line_items = product_type_counts.map { |k,v| { "sku" => "BUND-#{k}", "quantity" => v, "price" => 0} }
-        new_line_items
+        separated_c324s ||= []
+        merged_items = new_remaining_items + separated_c324s
+        logger.debug "Bundled result:"
+        logger.debug " - IN: #{items}"
+        logger.debug " - OUT: #{merged_items}"
+        merged_items
       end
 
 
@@ -54,6 +109,7 @@ module Seshbot
         while true
           new_result = pack_single_step(final_result, unpacking: true)
           break if new_result == final_result
+
           final_result = new_result
         end
         final_result

data/lib/seshbot/packing/version.rb

@@ -1,5 +1,5 @@
 module Seshbot
   module Packing
-    VERSION = "0.5.0"
+    VERSION = '0.8.3'
   end
 end

data/seshbot-packing.gemspec

@@ -1,20 +1,20 @@
 require_relative 'lib/seshbot/packing/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "seshbot-packing"
+  spec.name          = 'seshbot-packing'
   spec.version       = Seshbot::Packing::VERSION
-  spec.authors       = ["Shaun"]
-  spec.email         = ["shaun@brewkeeper.com.au"]
-
+  spec.authors       = ['Shaun']
+  spec.email         = ['shaun@brewkeeper.com.au']
+  spec.license       = 'MIT'
   spec.summary       = %q{Receives, calculates, returns skus with new quantities}
-  spec.homepage      = "https://gitlab.com/brewkeeper/seshbot-packing"
+  spec.homepage      = 'https://gitlab.com/brewkeeper/seshbot-packing'
   spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
 
   # spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
 
   spec.metadata["homepage_uri"] = spec.homepage
   spec.metadata["source_code_uri"] = "https://gitlab.com/brewkeeper/seshbot-packing"
-  spec.metadata["changelog_uri"] = "https://gitlab.com/brewkeeper/seshbot-packing/~blob/master/CHANGELOG.md"
+  spec.metadata["changelog_uri"] = "https://gitlab.com/brewkeeper/seshbot-packing/-/blob/master/CHANGELOG.md"
 
   # 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.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: seshbot-packing
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.8.3
 platform: ruby
 authors:
 - Shaun
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-11-16 00:00:00.000000000 Z
+date: 2021-03-16 00:00:00.000000000 Z
 dependencies: []
 description:
 email:
@@ -19,6 +19,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".travis.yml"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - Gemfile.lock
@@ -32,11 +33,12 @@ files:
 - lib/seshbot/packing/version.rb
 - seshbot-packing.gemspec
 homepage: https://gitlab.com/brewkeeper/seshbot-packing
-licenses: []
+licenses:
+- MIT
 metadata:
   homepage_uri: https://gitlab.com/brewkeeper/seshbot-packing
   source_code_uri: https://gitlab.com/brewkeeper/seshbot-packing
-  changelog_uri: https://gitlab.com/brewkeeper/seshbot-packing/~blob/master/CHANGELOG.md
+  changelog_uri: https://gitlab.com/brewkeeper/seshbot-packing/-/blob/master/CHANGELOG.md
 post_install_message:
 rdoc_options: []
 require_paths: