binpack 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in binpack.gemspec
+gemspec

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/Readme.md

@@ -0,0 +1,61 @@
+# Introduction
+This is a gem adapted from a solution for 2-dimensional bin packing by Ilmari Heikkinen. From the post:
+
+> It's a greedy heuristic algorithm that tries to fit each box into the trunk, largest first.
+> If no box fits, a new trunk is created.
+> I'm representing trunks as 2D tables of squares (with one unit of hidden padding around), then fill it starting from top left.
+> The fitterfirst finds a row with enough empty space to fit the box and then checks if the next box-height rows also contain the space.
+> If they do, the box is drawn to the rows.
+> Printing is easy because the trunk already is in printable format.
+
+## Usage
+    # Create an array of random items
+    items = []
+    12.times do |i|
+      items << Binpack::Item.new("Associated object #{i+1}", (rand(10)+2)/2.0, (rand(10)+2)/2.0)
+    end
+
+    # Pack the array of items into a bin where the default bin size is 16x10 with a padding of 1
+    bins = Binpack::Bin.pack(items, [], Binpack::Bin.new(16, 10, 1))
+
+  
+Visual output example:
+
+    puts bins.join("\n\n")
+
+    22222_0000_11_cc
+    22222_0000_11_cc
+    22222_0000_11_cc
+    ___________11_cc
+    99_888_aaa____cc
+    99_888__________
+    99_____b_aaa____
+    99_0_7_b________
+    99_0_7_b_0______
+    ___0_7___0______
+    
+Array of items, their locations locations, and whether or not they had to be rotated 90º
+
+    puts bins[0].items.inspect
+    
+    [
+      [#<Binpack::Item:0x007f84bb14c5c0 @obj="Associated object 12", @width=5.0, @height=3.0, @rotated=false>, 1, 1],
+      [#<Binpack::Item:0x007f84bb031438 @obj="Associated object 1", @width=4.5, @height=3.0, @rotated=false>, 7, 1],
+      [#<Binpack::Item:0x007f84bb14c6b0 @obj="Associated object 11", @width=2.5, @height=4.5, @rotated=false>, 12, 1],
+      [#<Binpack::Item:0x007f84bb031000 @obj="Associated object 3", @width=2.0, @height=5.0, @rotated=false>, 15, 1],
+      [#<Binpack::Item:0x007f84bb030dd0 @obj="Associated object 4", @width=2.0, @height=5.0, @rotated=false>, 1, 5],
+      [#<Binpack::Item:0x007f84bb14c890 @obj="Associated object 9", @width=3.5, @height=2.5, @rotated=false>, 4, 5],
+      [#<Binpack::Item:0x007f84bb14c980 @obj="Associated object 8", @width=3.5, @height=1.5, @rotated=false>, 8, 5],
+      [#<Binpack::Item:0x007f84bb030b00 @obj="Associated object 5", @width=1.5, @height=3.0, @rotated=false>, 4, 8],
+      [#<Binpack::Item:0x007f84bb0311e0 @obj="Associated object 2", @width=1.0, @height=4.0, @rotated=false>, 6, 8],
+      [#<Binpack::Item:0x007f84bb14c7a0 @obj="Associated object 10", @width=1.0, @height=3.5, @rotated=false>, 8, 7],
+      [#<Binpack::Item:0x007f84bb14cb60 @obj="Associated object 6", @width=3.5, @height=1.0, @rotated=false>, 10, 7],
+      [#<Binpack::Item:0x007f84bb02a070 @obj="Associated object 7", @width=1.0, @height=2.5, @rotated=true>, 10, 9]
+    ]
+    
+## Notes
+
+1. The packing assumes a border of @padding. If you wish to put images on an 11"x17"
+piece of paper with a 1" border, you will need to make the bin 16x10 with a padding of 1.
+2. When layout out your objects, be sure to note whether or not the item had to be rotated to fit.
+3. The algorithm uses string matching to determine placement so if higher precision than integral is required, you'll need to use a multiplier on everything.

data/binpack.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "binpack/version"
+
+Gem::Specification.new do |s|
+  s.name        = "binpack"
+  s.version     = Binpack::VERSION
+  s.authors     = ["Kelley Reynolds"]
+  s.email       = ["kelley.reynolds@rubyscale.com"]
+  s.homepage    = ""
+  s.summary     = %q{2 dimensional bin packing library}
+  s.description = %q{2 dimensional bin packing library adapted from a RubyQuiz solution by Ilmari Heikkinen}
+
+  s.rubyforge_project = "binpack"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/lib/binpack.rb

@@ -0,0 +1,77 @@
+#require "binpack/version"
+
+module Binpack
+  class Item
+    attr_reader :width, :height, :rotated, :obj
+
+    def initialize(obj, width, height, rotated=false)
+      @obj, @width, @height, @rotated = obj, width, height, rotated
+    end
+
+    def rotate
+      self.class.new(@obj, @height, @width, !@rotated)
+    end
+  end
+
+  class Bin
+    attr_reader :width, :height, :padding, :items
+
+    def initialize(width, height, padding=1)
+      @width, @height, @padding = width, height, padding.to_i
+      @items = []
+      @rows = (@padding..@height + (@padding * 2)).map{ "_"*(@width + (@padding * 2)) }
+    end
+
+    def add(item)
+      try_adding(item) or try_adding(item.rotate)
+    end
+    alias_method "<<".to_sym, :add
+    
+    def try_adding(item)
+      itemrow = "_" * (item.width + (@padding * 2))
+      @rows.each_with_index {|r,i|
+        break if i > @rows.size - (item.width + @padding * 2)
+        next unless r.include?(itemrow)
+        idxs = @rows[i + @padding, item.height + @padding].map { |s| s.index(itemrow) }
+        next unless idxs.all?
+        idx = idxs.max
+        next unless @rows[i, item.height + (@padding*2)].all? { |s| s[idx,itemrow.size] == itemrow }
+        g = rand(16).to_s(16)
+        @rows[i + @padding, item.height].each{ |s|
+          s[idx + @padding, item.width] = "#{g}" * item.width
+        }
+        @items.push([item, idx + @padding, i + @padding])
+        return item
+      }
+      nil
+    end
+
+    def empty?
+      @items.empty?
+    end
+
+    def to_s
+      @rows[@padding..(-1 - @padding)].map{ |r| r[@padding..(-1 - @padding)] }.join("\n")
+    end
+
+    def self.pack(items, bins=[], default_bin=nil)
+      default_bin ||= self.new(16, 10)
+      raise "Expected an array" if !bins.kind_of?(Array)
+
+      items = items.sort_by { |item| item.width*item.height }.reverse
+      bins << self.new(default_bin.width, default_bin.height, default_bin.padding) if bins.empty?
+      until items.empty?
+        fitting = items.find { |item| bins.last.add item }
+        if fitting
+          items.delete_at(items.index(fitting))
+        elsif bins.last.empty?
+          raise "Can't fit #{items.inspect} into the bins"
+        else
+          bins << self.new(default_bin.width, default_bin.height, default_bin.padding) unless items.empty?
+        end
+      end
+
+      bins
+    end
+  end
+end

data/lib/binpack/version.rb

@@ -0,0 +1,3 @@
+module Binpack
+  VERSION = "0.0.1"
+end

metadata

@@ -0,0 +1,53 @@
+--- !ruby/object:Gem::Specification
+name: binpack
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Kelley Reynolds
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-04-24 00:00:00.000000000 Z
+dependencies: []
+description: 2 dimensional bin packing library adapted from a RubyQuiz solution by
+  Ilmari Heikkinen
+email:
+- kelley.reynolds@rubyscale.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Rakefile
+- Readme.md
+- binpack.gemspec
+- lib/binpack.rb
+- lib/binpack/version.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: binpack
+rubygems_version: 1.8.15
+signing_key: 
+specification_version: 3
+summary: 2 dimensional bin packing library
+test_files: []