seshbot-packing 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: fb6f487a85ab3bea24e16e9d12c02ae511a58e5e79b2cf76e647cc0c064e8db0
+  data.tar.gz: 347038a58ec75af02cd61551cc05210257f49fee6ef2841c359a01cdc388ccc7
+SHA512:
+  metadata.gz: 62b68bf0c4ec15a201d60a33d0528bef7d7357178be258743eb6e1fe0f026c2bf03800ddd4310ca9b9dcad2bc7cd52b999bbfe4c00b02012a95f5df3c014c7d0
+  data.tar.gz: 372ff6ce363c20a1d82aea75c0bfd460acdd04b67c2d37967f4a51468b72bad2b8e585bd512a594537688e60ccbbef5a2f3a2c057998ac166689dcc78f4ab758

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.5
+before_install: gem install bundler -v 2.1.4

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 storkyd@gmail.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 [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in seshbot-packaging.gemspec
+gemspec
+gem "rake", "~> 12.0"
+gem "minitest", "~> 5.0"

data/Gemfile.lock

@@ -0,0 +1,21 @@
+PATH
+  remote: .
+  specs:
+    seshbot-packing (0.2.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    minitest (5.14.2)
+    rake (12.3.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  minitest (~> 5.0)
+  rake (~> 12.0)
+  seshbot-packing!
+
+BUNDLED WITH
+   2.1.4

data/README.md

@@ -0,0 +1,40 @@
+# 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:
+
+```ruby
+gem 'seshbot-packing'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install seshbot-packing
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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/[USERNAME]/seshbot-packing. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/seshbot-packing/blob/master/CODE_OF_CONDUCT.md).
+
+
+## Code of Conduct
+
+Everyone interacting in the Seshbot::Packing project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/seshbot-packing/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 "seshbot/packing"
+
+# 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/seshbot/packing.rb

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

data/lib/seshbot/packing/package.rb

@@ -0,0 +1,94 @@
+require "date"
+module Seshbot
+  module Packing
+    class Error < StandardError; end
+
+    class << self
+      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"]
+        end
+        result
+      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})/]
+        if result == "B502"
+          result = "B306"
+        end
+        if result == "B504"
+          result = "B312"
+        end
+        result.gsub!(/^C/, 'B')
+        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
+        end
+
+        product_type_prices = Hash.new(0)
+        items.each do |item|
+          size = packaged_size(item["sku"])
+          product_type_prices[size] += item["price"]
+        end
+
+        # get a hash of {pack_6: 5, pack_12: 1}
+        product_type_counts = count_product_types(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_line_items = product_type_counts.map { |k,v| { "sku" => "BUND-#{k}", "quantity" => v, "price" => 0} }
+        new_line_items
+      end
+
+
+      def unpack(product_type_counts)
+        result = pack_single_step(product_type_counts, unpacking: true)
+        result
+      end
+
+      def pack_single_step(product_type_counts, unpacking:)
+        result = Hash.new(0)
+        product_type_counts.each do |sku_fragment, qty|
+          recipe = Recipe::find_best_recipe(sku_fragment, qty, unpacking: unpacking)
+          if recipe.nil?
+            result[sku_fragment] += qty
+            next
+          end
+
+          recipe_quantities = Recipe::apply_recipe(recipe, qty)
+          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
+      end
+
+
+      def pack(product_type_counts)
+        final_result = product_type_counts
+
+        # 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)
+          # no changes, break out
+          break if new_result == final_result
+          final_result = new_result
+        end
+        final_result
+      end
+    end
+  end
+end

data/lib/seshbot/packing/recipe.rb

@@ -0,0 +1,102 @@
+module Seshbot
+  module Packing
+    module Recipe
+      class << self
+        def get_recipes
+          {
+              "twenty_four_pack_4"=>{
+                  "input_fragment"=>"B306",
+                  "input_quantity"=>4,
+                  "output_fragment"=>"B324",
+                  "output_quantity"=>1
+              },
+              "twenty_four_pack_3"=>{
+                  "input_fragment"=>"B306",
+                  "input_quantity"=>3,
+                  "output_fragment"=>"B318",
+                  "output_quantity"=>1
+              },
+              "twelve_pack"=>{
+                  "input_fragment"=>"B306",
+                  "input_quantity"=>2,
+                  "output_fragment"=>"B312",
+                  "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
+              }
+          }
+        end
+
+        def find_best_recipe(sku_fragment, qty, unpacking: false)
+          recipes = find_recipes(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|
+            recipe_quantities = apply_recipe(recipe, qty)
+
+            # if there was no 'best' until now, just set it (makes the next step a bit simpler)
+            best_recipe_quantities ||= recipe_quantities
+
+            # is this recipe the 'best'? (if packaging, best is the one that creates fewest quantity)
+            is_best = unpacking ?
+                        recipe_quantities[:output_quantity] > best_recipe_quantities[:output_quantity] :
+                        recipe_quantities[:output_quantity] < best_recipe_quantities[:output_quantity]
+
+            if is_best
+              best_recipe_quantities = recipe_quantities
+            end
+          end
+          best_recipe_quantities[:recipe] if best_recipe_quantities
+        end
+
+        def find_recipes(sku_fragment, qty, unpacking: false)
+          recipes = get_recipes
+          recipes = reverse_recipes(recipes) if unpacking
+          recipes.select do |name, recipe|
+            recipe["input_fragment"] == sku_fragment && qty >= recipe["input_quantity"]
+          end
+          # recipes.select { |name, recipe| recipe[:input_fragment] == sku_fragment && qty >= recipe[:input_quantity] }
+        end
+
+        def reverse_recipes(recipes)
+          results = recipes.map do |recipe_name, recipe_details|
+            new_recipe_details = {
+              "input_fragment" => recipe_details["output_fragment"],
+              "input_quantity" => recipe_details["output_quantity"],
+              "output_fragment" => recipe_details["input_fragment"],
+              "output_quantity" => recipe_details["input_quantity"]
+            }
+            [recipe_name, new_recipe_details]
+          end
+          results.to_h
+        end
+
+        def apply_recipe(recipe, input_quantity)
+          multiplier, remainder = input_quantity.divmod(recipe["input_quantity"])
+          {
+            recipe: recipe,
+            input_quantity: remainder,
+            output_quantity: multiplier * recipe["output_quantity"]
+          }
+        end
+
+      end
+    end
+  end
+end

data/lib/seshbot/packing/version.rb

@@ -0,0 +1,5 @@
+module Seshbot
+  module Packing
+    VERSION = "0.2.0"
+  end
+end

data/seshbot-packing.gemspec

@@ -0,0 +1,27 @@
+require_relative 'lib/seshbot/packing/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "seshbot-packing"
+  spec.version       = Seshbot::Packing::VERSION
+  spec.authors       = ["Shaun"]
+  spec.email         = ["shaun@brewkeeper.com.au"]
+
+  spec.summary       = %q{Receives, calculates, returns skus with new quantities}
+  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"
+
+  # 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.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+end

metadata

@@ -0,0 +1,59 @@
+--- !ruby/object:Gem::Specification
+name: seshbot-packing
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Shaun
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2020-11-15 00:00:00.000000000 Z
+dependencies: []
+description:
+email:
+- shaun@brewkeeper.com.au
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/seshbot/packing.rb
+- lib/seshbot/packing/package.rb
+- lib/seshbot/packing/recipe.rb
+- lib/seshbot/packing/version.rb
+- seshbot-packing.gemspec
+homepage: https://gitlab.com/brewkeeper/seshbot-packing
+licenses: []
+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
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key:
+specification_version: 4
+summary: Receives, calculates, returns skus with new quantities
+test_files: []