tetromino 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f213c2b8801c9305548c310584cc79c250cb01db
+  data.tar.gz: 8a26aa1a26d3fe24cd4af2855337e208617d6824
+SHA512:
+  metadata.gz: f72956ce3244720a88cf4be9e921a34204534dd1a83bfba8e9bee685d7cda22fd310d3ce096c4b0dd2e53b203c0f001fedd75bdc2384b325fc67d25001b47314
+  data.tar.gz: d76fa657f1e0cc53670d20c681744f6bb2360d1ad3b411739feed4270470570790170611fba21470e11973666040a7ddfb85e602cbf37ad59629aabbb77afb91

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.2.7
+before_install: gem install bundler -v 1.16.2

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in tetromino.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,49 @@
+PATH
+  remote: .
+  specs:
+    tetromino (0.1.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.1.2)
+    diff-lcs (1.3)
+    docile (1.3.1)
+    json (2.1.0)
+    method_source (0.9.0)
+    pry (0.11.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rake (10.5.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+    simplecov (0.16.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  pry (~> 0.11.0)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  simplecov (~> 0.16.1)
+  tetromino!
+
+BUNDLED WITH
+   1.16.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 deliver.ee
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,200 @@
+[![Gem Version](https://badge.fury.io/rb/tetromino.svg)](https://badge.fury.io/rb/tetromino)
+
+# Tetromino
+
+## Introduction
+
+First fit heuristic algorithm for 4D bin packing problem solver (4dbpp).
+An implementation of the "4D" bin packing problem i.e. given a list of items,
+how many boxes do you need to fit them all in taking into account physical
+dimensions and weights.
+
+This project is a complete rewrite of [box_packer](https://github.com/mushishi78/box_packer)
+
+It also provide 2 additional "real life" features:
+* Coerce items that can't be stacked.
+* Coerce items that are not invertible.
+
+...Especially if you need to pack (big) fragile items.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'tetromino'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install tetromino
+
+## Usage
+
+```ruby
+tetromino = Tetromino.packer(dimensions: [40, 30, 20]) # Define the size of your box
+tetromino.add_item!(dimensions: [40, 30, 10]) # Fill it up with item
+tetromino.add_item!(dimensions: [10, 40, 30]) # ...Moarrr item!
+tetromino.pack! # Pack your stuff
+tetromino.packed_successfully? # => true
+```
+### Dimensions
+
+Dimensions **should always** be declared in the following order:
+`[depth, width, height]`
+
+### Detailed results
+
+You can also get the results of the algorithm.
+
+```ruby
+results = tetromino.results
+=> [#<struct Tetromino::Packing
+    placements=
+    [
+      #<struct Tetromino::Placement
+        dimensions=[40, 30, 10],
+        position=[0, 0, 0],
+        weight=0>,
+      #<struct Tetromino::Placement
+        dimensions=[40, 30, 10],
+        position=[0, 0, 10],
+        weight=0>
+    ],
+    weight=0.0,
+    spaces=
+    [
+      #<struct Tetromino::Space
+        dimensions=[0, 30, 20],
+        position=[40, 0, 0]>,
+      #<struct Tetromino::Space
+        dimensions=[40, 0, 20],
+        position=[0, 30, 0]>,
+      #<struct Tetromino::Space
+        dimensions=[0, 30, 10],
+        position=[40, 0, 10]>,
+      #<struct Tetromino::Space
+        dimensions=[40, 0, 10],
+        position=[0, 30, 10]>,
+      #<struct Tetromino::Space
+        dimensions=[40, 30, 0],
+        position=[0, 0, 20]>
+    ]>
+  ]
+```
+
+### Placements
+
+Placements represent how your items have been organized into your box(es) (dimensions & positions).
+
+```ruby
+results.placements
+```
+
+### Spaces
+
+These are the empty spaces remaining in your box(es).
+
+```ruby
+results.spaces
+```
+
+### Weight
+
+This is the total weight of the packed items.
+
+```ruby
+results.weight
+```
+
+## Advanced usages
+
+### Weight coercion
+
+You can define a weight limit constraint on your box(es).
+
+```ruby
+begin
+tetromino = Tetromino.packer(dimensions: [40, 30, 20], max_weight: 4)
+tetromino.add_item!(dimensions: [40, 15, 20], weight: 2)
+tetromino.add_item!(dimensions: [40, 15, 20], weight: 3)
+tetromino.pack!
+tetromino.packed_successfully? # => false
+rescue Tetromino::Exceptions::Error => error
+  puts error.message # => Maximum boxes quantity exceeded
+end
+```
+
+### Multiple boxes
+
+You can try to pack your items in multiple boxes.
+
+```ruby
+tetromino = Tetromino.packer(dimensions: [40, 30, 20], boxes_limit: 2)
+tetromino.add_item!(dimensions: [40, 30, 20])
+tetromino.add_item!(dimensions: [30, 20, 40])
+tetromino.pack!
+tetromino.packed_successfully? # => true
+```
+
+### Not stackable items
+
+You can define if your items can't be stacked.
+
+```ruby
+begin
+  tetromino = Tetromino.packer(dimensions: [40, 30, 20])
+  tetromino.add_item!(dimensions: [40, 30, 10], stackable: false)
+  tetromino.add_item!(dimensions: [40, 30, 10], stackable: false)
+  tetromino.pack!
+  tetromino.packed_successfully? # => false
+rescue Tetromino::Exceptions::Error => error
+  puts error.message # => Maximum boxes quantity exceeded
+end
+```
+
+### Not invertible items
+
+You can define if your items can't be leaned.
+(impossible to permute height with depth or width)
+
+```ruby
+begin
+  tetromino = Tetromino.packer(dimensions: [40, 30, 20])
+  tetromino.add_item!(dimensions: [40, 30, 10], invertible: false)
+  tetromino.add_item!(dimensions: [40, 10, 30], invertible: false)
+  tetromino.pack!
+  tetromino.packed_successfully? # => false
+rescue Tetromino::Exceptions::Error => error
+  puts error.message # => Maximum boxes quantity exceeded
+end
+```
+
+### Parameters combinations
+
+You can combine all the parameters at once:
+
+```ruby
+tetromino = Tetromino.packer(dimensions: [40, 30, 20], boxes_limit: 2, max_weight: 5)
+tetromino.add_item!(dimensions: [40, 30, 10], invertible: false, stackable: false, weight: 2)
+tetromino.add_item!(dimensions: [30, 40, 10], invertible: false, stackable: false, weight: 3)
+tetromino.pack!
+tetromino.packed_successfully? # => true
+```
+
+## Errors handling
+
+Tetromino will always raise an error if it is unable to pack your items with
+the given constraints.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/deliver-ee/tetromino.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "tetromino"
+
+# 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.
+
+require "pry"
+Pry.start
+

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/tetromino.rb

@@ -0,0 +1,19 @@
+require "tetromino/args"
+require "tetromino/box"
+require "tetromino/exceptions"
+require "tetromino/item"
+require "tetromino/packer"
+require "tetromino/packing"
+require "tetromino/placement"
+require "tetromino/space"
+require "tetromino/version"
+
+module Tetromino
+  extend Forwardable
+  def_delegator :@box, :add_item, :pack!
+
+  def self.packer(dimensions: [0, 0, 0],  max_weight: nil, boxes_limit: 1)
+    box = Tetromino::Box.new(dimensions, max_weight)
+    Tetromino::Packer.new(box, boxes_limit)
+  end
+end

data/lib/tetromino/args.rb

@@ -0,0 +1,8 @@
+module Tetromino
+  BOX_ARGS = %i[dimensions max_weight].freeze
+  ITEM_ARGS = %i[dimensions weight stackable invertible packed].freeze
+  PACKER_ARGS = %i[box boxes_limit].freeze
+  PACKING_ARGS = %i[placements weight spaces].freeze
+  PLACEMENT_ARGS = %i[dimensions position weight].freeze
+  SPACE_ARGS = %i[dimensions position].freeze
+end

data/lib/tetromino/box.rb

@@ -0,0 +1,29 @@
+Tetromino::Box = Struct.new(*Tetromino::BOX_ARGS) do
+  attr_reader :items
+
+  def depth
+    dimensions[0]
+  end
+
+  def width
+    dimensions[1]
+  end
+
+  def height
+    dimensions[2]
+  end
+
+  def volume
+    dimensions.inject(:*)
+  end
+
+  def has_weight_limit?
+    not max_weight.nil?
+  end
+
+  def append!(item:)
+    @items = [] if @items.nil?
+    @items << item if item.is_a?(Tetromino::Item)
+    item
+  end
+end

data/lib/tetromino/exceptions.rb

@@ -0,0 +1,23 @@
+module Tetromino
+  module Exceptions
+    class Error < StandardError; end
+
+    class TooHeavyItem < Error
+      def message
+       'Item is too big to fit in the box'
+      end
+    end
+
+    class CannotFitInBoxes < Error
+      def message
+       'Maximum boxes quantity exceeded'
+      end
+    end
+
+    class NothingToPack < Error
+      def message
+       'There are no items to pack'
+      end
+    end
+  end
+end

data/lib/tetromino/item.rb

@@ -0,0 +1,50 @@
+Tetromino::Item = Struct.new(*Tetromino::ITEM_ARGS) do
+  include Comparable
+
+  def depth
+    dimensions[0]
+  end
+
+  def width
+    dimensions[1]
+  end
+
+  def height
+    dimensions[2]
+  end
+
+  def volume
+    dimensions.inject(:*)
+  end
+
+  def <=> (other)
+    other.volume <=> self.volume
+  end
+
+  def place(space:)
+    permutations = []
+    permutations << [depth, width, height]
+    permutations << [width, depth, height]
+
+    if invertible
+      permutations << [depth, height, width]
+      permutations << [width, height, depth]
+      permutations << [height, width, depth]
+      permutations << [height, depth, width]
+    end
+
+    permutations.each do |perm|
+      next unless perm[0] <= space.dimensions[0] &&
+                  perm[1] <= space.dimensions[1] &&
+                  perm[2] <= space.dimensions[2]
+
+      # Consider that all remaining space above is filled
+      perm[2] = space.dimensions[2] unless stackable
+
+      return Tetromino::Placement.new(perm, space.position, weight)
+    end
+
+    return nil
+  end
+end
+

data/lib/tetromino/packer.rb

@@ -0,0 +1,63 @@
+Tetromino::Packer = Struct.new(*Tetromino::PACKER_ARGS) do
+  attr_reader :results
+
+  def add_item!(dimensions: [], weight: 0, stackable: true, invertible: true)
+    item = Tetromino::Item.new(dimensions, weight, stackable, invertible, false)
+    self.box.append!(item: item)
+  end
+
+  def items
+    box.items
+  end
+
+  def pack!
+    raise Tetromino::Exceptions::NothingToPack if items.nil? || items.empty?
+    @results = []
+
+    items.sort!.each do |item|
+      if box.has_weight_limit? && (item.weight.to_f > box.max_weight.to_f)
+        raise Tetromino::Exceptions::TooHeavyItem
+      end
+
+      @results.each do |packing|
+        next if box.has_weight_limit? && \
+                (packing.weight.to_f + item.weight.to_f > box.max_weight.to_f)
+
+        packing.spaces.each do |space|
+          next unless placement = item.place(space: space)
+
+          packing.placements += [placement]
+          packing.weight += item.weight.to_f
+          packing.spaces -= [space]
+          packing.spaces += space.break_up(placement: placement)
+          item.packed = true
+          break
+        end
+
+        break if item.packed
+      end
+      next if item.packed
+
+      space = Tetromino::Space.new(box.dimensions, [0, 0, 0])
+
+      placement = item.place(space: space)
+      item.packed = true unless placement.nil?
+
+      packing = Tetromino::Packing.new(
+        [placement],
+        item.weight.to_f,
+        space.break_up(placement: placement)
+      )
+
+      @results += [packing]
+    end
+
+    raise Tetromino::Exceptions::CannotFitInBoxes unless packed_successfully?
+
+    @results
+  end
+
+  def packed_successfully?
+    items.all?(&:packed) && (results.count <= boxes_limit)
+  end
+end

data/lib/tetromino/packing.rb

@@ -0,0 +1 @@
+Tetromino::Packing = Struct.new(*Tetromino::PACKING_ARGS)

data/lib/tetromino/placement.rb

@@ -0,0 +1 @@
+Tetromino::Placement = Struct.new(*Tetromino::PLACEMENT_ARGS)

data/lib/tetromino/space.rb

@@ -0,0 +1,43 @@
+Tetromino::Space = Struct.new(*Tetromino::SPACE_ARGS) do
+  def break_up(placement:)
+    return [] if placement.nil?
+    [
+      Tetromino::Space.new(
+        [
+          dimensions[0] - placement.dimensions[0],
+          dimensions[1],
+          dimensions[2]
+        ],
+        [
+          position[0] + placement.dimensions[0],
+          position[1],
+          position[2]
+        ]
+      ),
+      Tetromino::Space.new(
+        [
+          placement.dimensions[0],
+          dimensions[1] - placement.dimensions[1],
+          dimensions[2]
+        ],
+        [
+          position[0],
+          position[1] + placement.dimensions[1],
+          position[2]
+        ]
+      ),
+      Tetromino::Space.new(
+        [
+          placement.dimensions[0],
+          placement.dimensions[1],
+          dimensions[2] - placement.dimensions[2]
+        ],
+        [
+          position[0],
+          position[1],
+          position[2] + placement.dimensions[2]
+        ]
+      )
+    ]
+  end
+end

data/lib/tetromino/version.rb

@@ -0,0 +1,3 @@
+module Tetromino
+  VERSION = "0.1.1"
+end

data/tetromino.gemspec

@@ -0,0 +1,41 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "tetromino/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "tetromino"
+  spec.version       = Tetromino::VERSION
+  spec.authors       = ["deliver.ee"]
+  spec.email         = ["1337@deliver.ee"]
+
+  spec.summary       = %q{
+                        First fit heuristic algorithm for 4D
+                        bin packing problem solver (4dbpp)
+                      }
+  spec.description   = %q{
+                        An implementation of the "4D" bin packing
+                        problem i.e. given a list of items, how many boxes
+                        do you need to fit them all in taking into account
+                        physical dimensions and weights.
+                        It also allow to declare items that are not stackables
+                        nor invertibles (ie. you need to pack fragile items).
+                      }
+  spec.homepage      = "https://github.com/deliver-ee/tetromino"
+  spec.license       = "MIT"
+
+  # 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"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "pry", "~> 0.11.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "simplecov", "~> 0.16.1"
+end

metadata

@@ -0,0 +1,140 @@
+--- !ruby/object:Gem::Specification
+name: tetromino
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- deliver.ee
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-06-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.11.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.11.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.16.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.16.1
+description: "\n                        An implementation of the \"4D\" bin packing\n
+  \                       problem i.e. given a list of items, how many boxes\n                        do
+  you need to fit them all in taking into account\n                        physical
+  dimensions and weights.\n                        It also allow to declare items
+  that are not stackables\n                        nor invertibles (ie. you need to
+  pack fragile items).\n                      "
+email:
+- 1337@deliver.ee
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/tetromino.rb
+- lib/tetromino/args.rb
+- lib/tetromino/box.rb
+- lib/tetromino/exceptions.rb
+- lib/tetromino/item.rb
+- lib/tetromino/packer.rb
+- lib/tetromino/packing.rb
+- lib/tetromino/placement.rb
+- lib/tetromino/space.rb
+- lib/tetromino/version.rb
+- tetromino.gemspec
+homepage: https://github.com/deliver-ee/tetromino
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.13
+signing_key: 
+specification_version: 4
+summary: First fit heuristic algorithm for 4D bin packing problem solver (4dbpp)
+test_files: []