box_packer 1.1.2 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: eba591c80a0ed22630cab9bb8ae6f6c4f61f8a4e
-  data.tar.gz: a078c724e6cb21db22d3d5937a635bf8bd5cee28
+  metadata.gz: cb419643a33b63ce8d279f9baafa0c2e4c010300
+  data.tar.gz: a5174fcc00bc4ccb58542182ac40a7aceef95f14
 SHA512:
-  metadata.gz: 4db6ea115a0c889b38f6308c3ac6904c22afeeffdce30e46c21de198da49ec81d6789bff75fb25b41632091f2e74840a6a497a1dd93d1d8fe37d7fc3da009f3b
-  data.tar.gz: 0c79d3e330a252443148c7e6b92ae3ac255afe1140a59f801b6bc225d19ac547dfc725f6c906bdd5996b77020e6003687d5709cf23776cfb4f60290a3df5831e
+  metadata.gz: fa82429a9a668dafdc268f9bc85d46261b9b9742a31099c87cb37870ce8cc6af3b8c358cc5babd5ebfd8e39549caa16344aef181737fdb33a1616b1696423cf4
+  data.tar.gz: 82af4730e2b2b13dc9868398a65b76f46561663ba0e158b606e8502aa3a4c569b9b42b7e22f83399420cbae3ad19368908c8fd0d01c4e3c036db594ed20e64f4

data/.gitignore

@@ -1,2 +1,15 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
 *.gem
-lib/box_packer/test.rb

data/.rubocop.yml

@@ -0,0 +1,4 @@
+Metrics/LineLength:
+  Max: 100
+Documentation:
+  Enabled: false

data/README.md

@@ -1,7 +1,7 @@
 BoxPacker
 =========
 
-A heuristic first-fit 3D bin packing algorithm with optional weight and bin limits. 
+A heuristic first-fit 3D bin packing algorithm with optional weight and bin limits.
 
 Installation
 ------------
@@ -24,44 +24,43 @@ Usage
 ``` ruby
 require 'box_packer'
 
-BoxPacker.container [3, 6, 7] do 
-	add_item [1,3,5]
-	add_item [4,3,5]
-	add_item [3,5,5]
-	pack! # returns 2
-
-	puts packed_successfully	         # true
-	puts packings.count	                 # 2
-	puts packings[0].include? items[1]   # false
-	puts packings[0][1].position         # (5,0,0)
-
-	puts self  	# |Container| 7x6x3
-				# |  Packing| Remaining Volume:36
-				# |     Item| 5x5x3 (0,0,0) Volume:75
-				# |     Item| 1x5x3 (5,0,0) Volume:15
-				# |  Packing| Remaining Volume:66
-				# |     Item| 5x4x3 (0,0,0) Volume:60
-	
+BoxPacker.container [3, 6, 7] do
+  add_item [1,3,5]
+  add_item [4,3,5]
+  add_item [3,5,5]
+  pack! # returns 2
+
+  puts packed_successfully           # true
+  puts packings.count                # 2
+  puts packings[0].include? items[1] # false
+  puts packings[0][1].position       # (5,0,0)
+
+  puts self # |Container| 7x6x3
+            # |  Packing| Remaining Volume:36
+            # |     Item| 5x5x3 (0,0,0) Volume:75
+            # |     Item| 1x5x3 (5,0,0) Volume:15
+            # |  Packing| Remaining Volume:66
+            # |     Item| 5x4x3 (0,0,0) Volume:60
 end
 ```
 
 With optional labels, weights, quantity and packings limit:
 
 ``` ruby
-BoxPacker.container [15, 20, 13], label: 'Parcel', weight_limit: 50, packings_limit: 3 do 
-	add_item [2, 3, 5], label: 'Shoes', weight: 47, quantity: 2
-	add_item [3, 3, 1], label: 'Watch', weight: 24
-	add_item [1, 1, 4], label: 'Bag',   weight:  7
-	pack! # returns 2
-
-	puts self  	# |Container| Parcel 20x15x13 Weight Limit:50 Packings Limit:3
-				# |  Packing| Remaining Volume:3870 Remaining Weight:3
-				# |     Item| Shoes 5x3x2 (0,0,0) Volume:30 Weight:47
-				# |  Packing| Remaining Volume:3870 Remaining Weight:3
-				# |     Item| Shoes 5x3x2 (0,0,0) Volume:30 Weight:47
-				# |  Packing| Remaining Volume:3887 Remaining Weight:19
-				# |     Item| Watch 3x3x1 (0,0,0) Volume:9 Weight:24
-				# |     Item| Bag 4x1x1 (3,0,0) Volume:4 Weight:7
+BoxPacker.container [15, 20, 13], label: 'Parcel', weight_limit: 50, packings_limit: 3 do
+  add_item [2, 3, 5], label: 'Shoes', weight: 47, quantity: 2
+  add_item [3, 3, 1], label: 'Watch', weight: 24
+  add_item [1, 1, 4], label: 'Bag',   weight:  7
+  pack! # returns 2
+
+  puts self # |Container| Parcel 20x15x13 Weight Limit:50 Packings Limit:3
+            # |  Packing| Remaining Volume:3870 Remaining Weight:3
+            # |     Item| Shoes 5x3x2 (0,0,0) Volume:30 Weight:47
+            # |  Packing| Remaining Volume:3870 Remaining Weight:3
+            # |     Item| Shoes 5x3x2 (0,0,0) Volume:30 Weight:47
+            # |  Packing| Remaining Volume:3887 Remaining Weight:19
+            # |     Item| Watch 3x3x1 (0,0,0) Volume:9 Weight:24
+            # |     Item| Bag 4x1x1 (3,0,0) Volume:4 Weight:7
 end
 ```
 
@@ -69,27 +68,27 @@ Alternative builder API:
 
 ``` ruby
 BoxPacker.builder do |b|
-	c1 = b.container [10,5,11]
-	c2 = b.container [17,23,14]
+  c1 = b.container [10,5,11]
+  c2 = b.container [17,23,14]
 
-	c1.items = [b.item([1,1,4]), b.item([4,6,7]), b.item([5,8,10])]
-	c2.items = c1.items
+  c1.items = [b.item([1,1,4]), b.item([4,6,7]), b.item([5,8,10])]
+  c2.items = c1.items
 
-	c1.pack! # 2
-	c2.pack! # 1
+  c1.pack! # 2
+  c2.pack! # 1
 
-	puts c1  # |Container| 11x10x5
-			 # |  Packing| Remaining Volume:146
-			 # |     Item| 10x8x5 (0,0,0) Volume:400
-			 # |     Item| 4x1x1 (0,8,0) Volume:4
-			 # |  Packing| Remaining Volume:382
-			 # |     Item| 7x6x4 (10,0,0) Volume:168
+  puts c1 # |Container| 11x10x5
+          # |  Packing| Remaining Volume:146
+          # |     Item| 10x8x5 (0,0,0) Volume:400
+          # |     Item| 4x1x1 (0,8,0) Volume:4
+          # |  Packing| Remaining Volume:382
+          # |     Item| 7x6x4 (10,0,0) Volume:168
 
-	puts c2  # |Container| 23x17x14
-			 # |  Packing| Remaining Volume:4902
-			 # |     Item| 10x8x5 (0,0,0) Volume:400
-			 # |     Item| 7x6x4 (10,0,0) Volume:168
-			 # |     Item| 4x1x1 (17,0,0) Volume:4
+  puts c2 # |Container| 23x17x14
+          # |  Packing| Remaining Volume:4902
+          # |     Item| 10x8x5 (0,0,0) Volume:400
+          # |     Item| 7x6x4 (10,0,0) Volume:168
+          # |     Item| 4x1x1 (17,0,0) Volume:4
 
 end
 ```
@@ -98,14 +97,14 @@ Export SVG
 ----------
 
 ``` ruby
-BoxPacker.container [3, 4, 2] do 
-	add_item [1,3,2], label: 'Bag', colour: 'red'
-	add_item [3,3,1], label: 'Hat', colour: 'blue'
-	add_item [1,2,2], label: 'Shoes', colour: 'green'
-	add_item [3,1,1], label: 'Slipper', colour: 'purple'
-	add_item [2,1,1], label: 'Dragon', colour: 'orange'
-	pack!
-	draw!('examples/example', scale_longest_side_to: 500, margin: 15)
+BoxPacker.container [3, 4, 2] do
+  add_item [1,3,2], label: 'Bag', colour: 'red'
+  add_item [3,3,1], label: 'Hat', colour: 'blue'
+  add_item [1,2,2], label: 'Shoes', colour: 'green'
+  add_item [3,1,1], label: 'Slipper', colour: 'purple'
+  add_item [2,1,1], label: 'Dragon', colour: 'orange'
+  pack!
+  draw!('examples/example', scale_longest_side_to: 500, margin: 15)
 end
 ```
 

data/Rakefile

@@ -1 +1 @@
-require "bundler/gem_tasks"
+require 'bundler/gem_tasks'

data/box_packer.gemspec

@@ -7,21 +7,18 @@ Gem::Specification.new do |spec|
   spec.version       = BoxPacker::VERSION
   spec.authors       = ['Max White']
   spec.email         = ['mushishi78@gmail.com']
-  spec.description   = 'A Heuristic First-Fit 3D Bin Packing Algorithm with Weight Limit'
-  spec.summary       = 'A Heuristic First-Fit 3D Bin Packing Algorithm with Weight Limit'
-  spec.homepage      = ''
+  spec.summary       = 'Heuristic first-fit 3D bin-packing algorithm' \
+                       'with optional weight and bin limits.'
+  spec.homepage      = 'https://github.com/mushishi78/box_packer'
   spec.license       = 'MIT'
 
-  spec.files         = `git ls-files`.split($/)
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(/^bin/) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(/^(test|spec|features)/)
   spec.require_paths = ['lib']
 
-  spec.add_development_dependency 'bundler', '~> 1.3'
-  spec.add_development_dependency 'rake'
-  spec.add_development_dependency 'rspec'
-
-  spec.add_dependency 'attr_extras', '~> 3.1.0' 
-  spec.add_dependency 'rasem', '~> 0.6.0'
+  spec.add_development_dependency 'rspec', '~> 3.1'
 
+  spec.add_dependency 'attire', '~> 0'
+  spec.add_dependency 'rasem', '~> 0.6'
 end

data/lib/box_packer.rb

@@ -1,3 +1,13 @@
-require_relative 'box_packer/version'
-require_relative 'box_packer/builder'
-require_relative 'box_packer/container'
+require 'attire'
+require 'forwardable'
+
+require 'box_packer/position'
+require 'box_packer/dimensions'
+require 'box_packer/box'
+require 'box_packer/item'
+require 'box_packer/packer'
+require 'box_packer/packing'
+require 'box_packer/svg_exporter'
+require 'box_packer/container'
+require 'box_packer/builder'
+require 'box_packer/version'

data/lib/box_packer/box.rb

@@ -1,40 +1,30 @@
-require 'attr_extras'
-require 'forwardable'
-require_relative 'position'
-require_relative 'dimensions'
-
 module BoxPacker
-	class Box
-		extend Forwardable
-		attr_initialize :dimensions, [:position]
-		def_delegators :dimensions, :volume, :each_rotation, :width, :height, :depth
-		attr_accessor :dimensions, :position
-
-		def position
-			@position ||= Position[0, 0, 0]
-		end
-
-		def orient!
-			@dimensions = Dimensions[*dimensions.to_a.sort!.reverse!]
-		end
-
-		def >=(other_box)
-			dimensions >= other_box.dimensions
-		end
-
-		def sub_boxes(item)	
-			sub_boxes = sub_boxes_args(item).select{ |(d, p)| d.volume > 0 }
-			sub_boxes.map!{ |args| Box.new(*args) }
-			sub_boxes.sort_by!(&:volume).reverse!
-		end
-
-	private
-
-		def sub_boxes_args(item)
-			[[      width +      height + depth - item.width,  position: position + item.width  ],
-			 [ item.width +      height + depth - item.height, position: position + item.height ],
-			 [ item.width + item.height + depth - item.depth,  position: position + item.depth  ]]
-		end
-
-	end
-end
+  class Box
+    extend Forwardable
+    attr_init :dimensions, position: Position[0, 0, 0]
+    def_delegators :dimensions, :volume, :each_rotation, :width, :height, :depth
+    attr_accessor :dimensions, :position
+
+    def orient!
+      @dimensions = Dimensions[*dimensions.to_a.sort!.reverse!]
+    end
+
+    def >=(other)
+      dimensions >= other.dimensions
+    end
+
+    def sub_boxes(item)
+      sub_boxes = sub_boxes_args(item).select { |(d, _)| d.volume > 0 }
+      sub_boxes.map! { |args| Box.new(*args) }
+      sub_boxes.sort_by!(&:volume).reverse!
+    end
+
+    private
+
+    def sub_boxes_args(item)
+      [[width +      height + depth - item.width,  position: position + item.width],
+       [item.width +      height + depth - item.height, position: position + item.height],
+       [item.width + item.height + depth - item.depth,  position: position + item.depth]]
+    end
+  end
+end

data/lib/box_packer/builder.rb

@@ -1,22 +1,15 @@
-require_relative 'container'
-require_relative 'item'
-
 module BoxPacker
-
-	def self.builder(&b)
-		b.call(Builder.new) if block_given?
-	end
-
-	class Builder
-
-		def container(*args, &b)
-			Container.new(*args, &b)
-		end
-
-		def item(*args)
-			Item.new(*args)
-		end
-
-	end
-	
-end
+  def self.builder(&b)
+    b.call(Builder.new) if block_given?
+  end
+
+  class Builder
+    def container(*args, &b)
+      Container.new(*args, &b)
+    end
+
+    def item(*args)
+      Item.new(*args)
+    end
+  end
+end

data/lib/box_packer/container.rb

@@ -1,108 +1,95 @@
-require_relative 'box'
-require_relative 'packing'
-require_relative 'dimensions'
-require_relative 'item'
-require_relative 'packer'
-require_relative 'svg_exporter'
-
 module BoxPacker
-
-	def self.container(*args, &b)
-		Container.new(*args, &b)
-	end
-
-	class Container < Box
-		attr_accessor :label, :weight_limit, :packings_limit
-		attr_reader :items, :packing, :packings, :packed_successfully
-
-		def initialize(dimensions, opts={}, &b)
-			super(Dimensions[*dimensions])
-			@label = opts[:label]
-			@weight_limit = opts[:weight_limit]
-			@packings_limit = opts[:packings_limit]
-			@items = opts[:items] || []
-			orient!
-      		self.instance_exec(&b) if block_given?
-		end
-
-		def add_item(dimensions, opts={})
-			quantity = opts.delete(:quantity) || 1
-			quantity.times do
-				items << Item.new(dimensions, opts)
-			end
-		end
-
-		def <<(item)
-			items << item.dup
-		end
-
-		def items=(new_items)
-			@items = new_items.map(&:dup)
-		end
-
-		def pack!
-			prepare_to_pack!
-			return unless packable?
-			if @packed_successfully = Packer.pack(self)
-				packings.count
-			else
-				@packings = []
-				false
-			end
-		end
-
-		def new_packing!
-			@packing = Packing.new(volume, weight_limit)
-			@packings << @packing
-		end
-
-		def to_s
-			s = "\n|Container|"
-			s << " #{label}" if label
-			s << " #{dimensions}"
-			s << " Weight Limit:#{weight_limit}" if weight_limit
-			s << " Packings Limit:#{packings_limit}" if packings_limit
-			s << "\n"
-			if packed_successfully
-				s << packings.map(&:to_s).join
-			else
-				s << "|         | Did Not Pack!"
-			end
-		end
-
-		def draw!(filename, opts={})
-			exporter = SVGExporter.new(self, opts)
-			exporter.draw
-			exporter.save(filename)
-		end
-
-	private
-
-		def packable?
-			return false if items.empty?
-			total_weight = 0
-
-			items.each do |item|
-				if weight_limit && item.weight 
-					return false if item.weight > weight_limit 
-					total_weight += item.weight
-				end
-
-				return false unless self >= item
-			end
-
-			if weight_limit && packings_limit
-				return total_weight <= weight_limit * packings_limit 
-			end
-
-			true
-		end
-
-		def prepare_to_pack!
-			items.each(&:orient!)
-			@packings = []
-			@packed_successfully = false
-		end
-
-	end
-end
+  def self.container(*args, &b)
+    Container.new(*args, &b)
+  end
+
+  class Container < Box
+    attr_accessor :label, :weight_limit, :packings_limit
+    attr_reader :items, :packing, :packings, :packed_successfully
+
+    def initialize(dimensions, opts = {}, &b)
+      super(Dimensions[*dimensions])
+      @label = opts[:label]
+      @weight_limit = opts[:weight_limit]
+      @packings_limit = opts[:packings_limit]
+      @items = opts[:items] || []
+      orient!
+      instance_exec(&b) if b
+    end
+
+    def add_item(dimensions, opts = {})
+      quantity = opts.delete(:quantity) || 1
+      quantity.times do
+        items << Item.new(dimensions, opts)
+      end
+    end
+
+    def <<(item)
+      items << item.dup
+    end
+
+    def items=(new_items)
+      @items = new_items.map(&:dup)
+    end
+
+    def pack!
+      prepare_to_pack!
+      return unless packable?
+      if @packed_successfully = Packer.pack(self)
+        packings.count
+      else
+        @packings = []
+        false
+      end
+    end
+
+    def new_packing!
+      @packing = Packing.new(volume, weight_limit)
+      @packings << @packing
+    end
+
+    def to_s
+      s = "\n|Container|"
+      s << " #{label}" if label
+      s << " #{dimensions}"
+      s << " Weight Limit:#{weight_limit}" if weight_limit
+      s << " Packings Limit:#{packings_limit}" if packings_limit
+      s << "\n"
+      s << packed_successfully ? packings.map(&:to_s).join : '|         | Did Not Pack!'
+    end
+
+    def draw!(filename, opts = {})
+      exporter = SVGExporter.new(self, opts)
+      exporter.draw
+      exporter.save(filename)
+    end
+
+    private
+
+    def packable?
+      return false if items.empty?
+      total_weight = 0
+
+      items.each do |item|
+        if weight_limit && item.weight
+          return false if item.weight > weight_limit
+          total_weight += item.weight
+        end
+
+        return false unless self >= item
+      end
+
+      if weight_limit && packings_limit
+        return total_weight <= weight_limit * packings_limit
+      end
+
+      true
+    end
+
+    def prepare_to_pack!
+      items.each(&:orient!)
+      @packings = []
+      @packed_successfully = false
+    end
+  end
+end