column_pack 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d3392aff0cd883b18b176bc81e864c6eb575dcb7
+  data.tar.gz: 4973088e62dac89bc4f9096cec5e76431254af0e
+SHA512:
+  metadata.gz: 39fab94e8b81156dbe61ef7a7fd0f09c14f1445f0b234c07e9c2c3555af5d147342bac049fbabd5943c47349037df1b7a32286ab6e1f49184242141d2c599c94
+  data.tar.gz: be2914d3adc9180b9fe12dc9f3e90fe7d8fc4ebe2ee08344ff88fa8844acae0150457fa81cedbe6f2dcd3b598eca8c4e72adede90ac86cff98170fbf9f1aef68

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2014 YOURNAME
+
+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/Rakefile

@@ -0,0 +1,32 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'ColumnPack'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/lib/column_pack.rb

@@ -0,0 +1,9 @@
+require 'column_pack/railtie' if defined? Rails
+
+module ColumnPack
+  module Rails
+    class Engine < ::Rails::Engine
+      # Get rails to add app, lib, vendor to load path
+    end
+  end
+end

data/lib/column_pack/bin_packer.rb

@@ -0,0 +1,104 @@
+module ColumnPack
+
+  # Arranges elements into bins using a simple one dimensional bin packing algorithm.
+  class BinPacker
+
+    # Uses a fixed number of bins (total_bins).
+    #
+    # Options:
+    # :algorithm        specify a different bin packing algorithm (default :best_fit_decreasing)
+    #                   available algorithms are :best_fit_decreasing, :best_fit_increasing
+    #
+    # :shuffle_in_col   after packing columns, shuffle the elements in each column (defaults to true)
+    #
+    def initialize(total_bins, options = {})
+      raise ArgumentError.new("Must choose a number of bins greater than zero") if total_bins <= 0
+
+      @total_bins = total_bins
+      @algorithm  = options[:algorithm] || :best_fit_decreasing
+
+      if options.has_key? :shuffle_in_col
+        @shuffle_in_col = options[:shuffle_in_col]
+      else
+        @shuffle_in_col = true
+      end
+
+      @elements       = []
+      @needs_packing  = true
+    end
+
+    # Adds element to be packed.
+    def add(size, content)
+      raise ArgumentError.new("Bin size must be greater than zero") if size <= 0
+
+      @elements << {:size => size.to_i, :content => content}
+      @needs_packing = true
+    end
+
+    # Returns a packed multi-dimensional array of elements.
+    def bins
+      pack_all if @needs_packing
+      @bins
+    end
+
+    # Total empty space left over by uneven packing.
+    def empty_space
+      pack_all if @needs_packing
+      max = @sizes.each.max
+      space = 0
+      @sizes.each { |size| space += max - size }
+      return space
+    end
+
+    private
+    def pack_all
+      @bins   = Array.new(@total_bins) {Array.new}
+      @sizes  = Array.new(@total_bins, 0)
+
+      self.send(@algorithm)
+      tall_to_middle
+      shuffle_within_cols if @shuffle_in_col
+
+      @needs_packing = false
+    end
+
+    def best_fit_decreasing
+      @elements.sort_by! { |e| e[:size] }
+      @elements.reverse!
+      best_fit
+    end
+
+    def best_fit_increasing
+      @elements.sort_by! { |e| e[:size] }
+      best_fit
+    end
+
+    def best_fit
+      @elements.each do |element|
+        size, col = @sizes.each_with_index.min
+        pack(col, element)
+      end
+    end
+
+    def shuffle_within_cols
+      @bins.each { |bin| bin.shuffle! }
+    end
+
+    # moves the tallest bin to the middle
+    def tall_to_middle
+      if (@total_bins > 1) && ((@total_bins % 2) != 0)
+        size, max_col = @sizes.each_with_index.max
+        mid_col = @total_bins / 2
+
+        temp = @bins[mid_col].clone
+        @bins[mid_col] = @bins[max_col]
+        @bins[max_col] = temp
+      end
+    end
+
+    def pack(col, element)
+      @bins[col] << element[:content]
+      @sizes[col] += element[:size].to_i
+    end
+  end
+end

data/lib/column_pack/column_packer.rb

@@ -0,0 +1,54 @@
+module ColumnPack
+  # Arranges HTML elements into a fixed number of columns.
+  class ColumnPacker
+    include ActionView::Context
+    include ActionView::Helpers::TagHelper
+    include ActionView::Helpers::TextHelper
+
+    # Uses a fixed number of columns (total_columns).
+    #
+    # Options:
+    # :algorithm        specify a different bin packing algorithm (default :best_fit_decreasing)
+    #                   available algorithms are :best_fit_decreasing, :best_fit_increasing
+    #
+    # :shuffle_in_col   after packing columns, shuffle the elements in each column (defaults to true)
+    #
+    def initialize(total_columns, options = {})
+      @bin_packer = BinPacker.new(total_columns, options)
+    end
+
+    def add(height, content)
+      @bin_packer.add(height.to_i, content)
+    end
+
+    # Renders all elements into columns.
+    def render
+      wrap(@bin_packer.bins).html_safe
+    end
+
+    private
+    def wrap(bins)
+      content_tag :div, :class => "column-pack-wrap" do
+        capture do
+          bins.each do |bin|
+            concat column(bin)
+          end
+        end
+      end
+    end
+
+    def column(bin)
+      content_tag :div, :class => "column-pack-col" do
+        capture do
+          bin.each do |element|
+            concat element(element)
+          end
+        end
+      end
+    end
+
+    def element(element)
+      content_tag :div, element.html_safe, :class => "column-pack-element"
+    end
+  end
+end

data/lib/column_pack/railtie.rb

@@ -0,0 +1,11 @@
+require 'column_pack/view_helpers'
+require 'column_pack/bin_packer'
+require 'column_pack/column_packer'
+
+module ColumnPack
+  class Railtie < Rails::Railtie
+    initializer "column_pack.view_helpers" do |app|
+      ActionView::Base.send :include, ViewHelpers
+    end
+  end
+end

data/lib/column_pack/version.rb

@@ -0,0 +1,3 @@
+module ColumnPack
+  VERSION = "1.0.0"
+end

data/lib/column_pack/view_helpers.rb

@@ -0,0 +1,51 @@
+module ColumnPack
+  module ViewHelpers
+
+    # Packs content into columns.
+    #
+    # pack_in_columns expect a block to be passed:
+    #
+    #   pack_in_columns(3) do
+    #     pack_element(100) do
+    #       "A"
+    #     end
+    #  end
+    #
+    # Options:
+    # :algorithm        specify a different bin packing algorithm (default :best_fit_decreasing)
+    #                   available algorithms are :best_fit_decreasing, :best_fit_increasing
+    #
+    # :shuffle_in_col   after packing columns, shuffle the elements in each column (defaults to true)
+    #
+    def pack_in_columns(total_columns, options = {})
+      @column_packer = ColumnPacker.new(total_columns, options)
+
+      yield
+
+      @column_packer.render
+    end
+
+    # Packs a single element with a given height into a column.
+    #
+    # pack_element should be called withing pack_in_columns's block:
+    #
+    #   pack_in_columns(3) do
+    #     pack_element(100) do
+    #       "A"
+    #     end
+    #  end
+    #
+    # Accepts parameter strings or block content (ERB, strings, etc).
+    #
+    def pack_element(height, content = nil, &block)
+      return if @column_packer.nil?
+
+      if block_given?
+        @column_packer.add(height.to_i, capture(&block))
+      else
+        @column_packer.add(height.to_i, content)
+      end
+    end
+
+  end
+end

data/lib/tasks/column_pack_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :column_pack do
+#   # Task goes here
+# end

data/test/bin_packer_test.rb

@@ -0,0 +1,139 @@
+require 'test_helper'
+
+class BinPackerTest < ActiveSupport::TestCase
+  include ColumnPack
+
+  test "initilizes with three columns" do
+    bp = BinPacker.new(3)
+    assert_equal BinPacker, bp.class
+    assert_equal Array, bp.bins.class
+  end
+
+  test "can't init with a non-positive number of cols" do
+    assert_raises ArgumentError do
+      bp = BinPacker.new(0)
+    end
+
+    assert_raises ArgumentError do
+      bp = BinPacker.new(-100)
+    end
+  end
+
+  test "adds element" do
+    bp = BinPacker.new(1)
+    assert bp.add(400, 'A')
+    assert_equal 'A', bp.bins[0][0]
+  end
+
+  test "height must be greater than zero" do
+    bp = BinPacker.new(3)
+    assert_raises ArgumentError do
+      bp.add(0, 'A')
+    end
+
+    assert_raises ArgumentError do
+      bp.add(-1, 'A')
+    end
+  end
+
+  test "adds two elements" do
+    bp = BinPacker.new(2, {:algorithm => :best_fit_decreasing})
+    assert bp.add(400, 'A')
+    assert bp.add(500, 'B')
+
+    assert_equal 'A', bp.bins[1][0]
+    assert_equal 'B', bp.bins[0][0]
+  end
+
+  test "add six elements" do
+    bp = BinPacker.new(3)
+    bp.add(600, 'F')
+    bp.add(300, 'C')
+    bp.add(500, 'E')
+    bp.add(400, 'D')
+    bp.add(200, 'B')
+    bp.add(100, 'A')
+    assert_equal 3, bp.bins.length
+
+    assert_equal Array, bp.bins[0].class
+    assert_operator 1, :<, bp.bins[0].length
+
+    assert_equal Array, bp.bins[1].class
+    assert_operator 1, :<, bp.bins[1].length
+
+    assert_equal Array, bp.bins[2].class
+    assert_operator 1, :<, bp.bins[2].length
+  end
+
+  test "can iterate bins" do
+    bp = BinPacker.new(3)
+    bp.add(600, 'F')
+    bp.add(300, 'C')
+    bp.add(500, 'E')
+    bp.add(400, 'D')
+    bp.add(200, 'B')
+    bp.add(100, 'A')
+
+    assert_equal Array, bp.bins.class
+
+    bp.bins.each do |bin|
+      bin.each do |element|
+        assert_includes ['A', 'B', 'C', 'D', 'E', 'F'], element.to_s
+      end
+    end
+  end
+
+  test "empty space" do
+    bp = BinPacker.new(3)
+    bp.add(200, 'A')
+    bp.add(900, 'B')
+    assert_equal 1600, bp.empty_space
+  end
+
+  test "test different packing algorithms" do
+    bp = BinPacker.new(3, {:algorithm => :best_fit_decreasing})
+    bp.add(100, 'A')
+    bp.add(900, 'B')
+  end
+
+  test "can turn off shuffling" do
+    bp = BinPacker.new(1, {:algorithm => :best_fit_decreasing, :shuffle_in_col => false})
+    bp.add(900, 'A')
+    bp.add(800, 'B')
+    bp.add(700, 'C')
+    bp.add(600, 'D')
+    bp.add(500, 'E')
+    bp.add(400, 'F')
+
+    assert_equal 'A', bp.bins[0][0]
+    assert_equal 'B', bp.bins[0][1]
+    assert_equal 'C', bp.bins[0][2]
+    assert_equal 'D', bp.bins[0][3]
+    assert_equal 'E', bp.bins[0][4]
+    assert_equal 'F', bp.bins[0][5]
+  end
+
+  test "big data set" do
+    (2..10).each do |num_bins|
+      assert bp = BinPacker.new(num_bins)
+
+      File.readlines(File.expand_path('test/fixtures/files/hundred.txt')).each do |line|
+        number, name, = line.split(' ')
+        assert bp.add(number.to_i, name)
+      end
+    end
+  end
+
+  test "six items with a perfect fit" do
+    bp = BinPacker.new(3)
+    bp.add(100, 'A')
+    bp.add(300, 'B')
+    bp.add(50, 'C')
+    bp.add(350, 'D')
+    bp.add(200, 'E')
+    bp.add(200, 'F')
+
+    assert_equal 0, bp.empty_space
+  end
+
+end