divvy_up 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 13df8fba53cef5c26b453bdfb56828dfcb70b36e
-  data.tar.gz: 58d128d044bbca50a8a76e07775e2e893265842b
+  metadata.gz: a1f81d17ce9ba4eafe46a66f3aa25828e44499cc
+  data.tar.gz: 009551861b5cfd507505eba3496164a1a17890d9
 SHA512:
-  metadata.gz: e5da9da7c428b2260b50931151c95609def33a8883707113572701df727dbb4b9e0e55d5e16b9ddcad28d173257e392614a2f2812e15008a97567296b39c4fae
-  data.tar.gz: 06e9f4ed191d2759ade0ca39cc348e800cc40924a82dc3a8613165b18a3e9febdb63645c292294a3feaf2f70967d95ef97abbee2ad8529bba69464cd5ceaa405
+  metadata.gz: 91fa9383f65ae1ebb2aff88ab916ea7c08e9a17c10d5d8bb7baaf25ff77ea0dd21d1194a5ba4ba36b101b8103c2f273ae1a8661aa43515fa65144ffd5ad42d5f
+  data.tar.gz: c5a48f2b4c21ce19510a7f00f2421f794c4e293e8aaa97a93ccfb5625760e77cb979a928d57ef0d9cb9526048faf7a1b07ef4bc281b57263c121df314b2c3e63

data/CHANGELOG.md

@@ -0,0 +1,17 @@
+# Change Log
+All notable changes to this project will be documented in this file.
+This project adheres to [Semantic Versioning](http://semver.org/).
+
+## [Unreleased]
+
+- Your contribution here!
+
+## [0.1.0] - 2015-07-04
+### Changed
+- Process list through two additional algorithms to handle edge cases and ensure optimal results when using `#split` method
+
+## 0.0.1 - 2015-03-09
+- Initial release
+
+[unreleased]: https://github.com/djpowers/divvy_up/compare/v0.1.0...HEAD
+[0.1.0]: https://github.com/djpowers/divvy_up/compare/v0.0.1...v0.1.0

data/README.md

@@ -1,7 +1,11 @@
 # DivvyUp
 
+[![Gem Version](https://badge.fury.io/rb/divvy_up.svg)](http://badge.fury.io/rb/divvy_up)
+
 A Ruby gem to divvy up a list of item prices into smaller groups,
-for the purpose of splitting up purchases (somehwat) equally.
+for the purpose of splitting up purchases (somewhat) equally.
+
+A variation of sorts on the [knapsack problem](http://en.wikipedia.org/wiki/Knapsack_problem).
 
 ## Installation
 

data/lib/divvy_up/list.rb

@@ -8,14 +8,54 @@ module DivvyUp
 
     def split(groups)
       return [self.items] if groups == 1
+      determine_best_result(groups)
+    end
+
+    private
+
+    def permute(groups)
       permutations = generate_list_permutations
       permutation_price_differences = calculate_permutation_price_differences(permutations, groups)
       sorted_price_differences = generate_list_combinations(permutation_price_differences)
       list_possibilities = find_full_list(permutation_price_differences, sorted_price_differences)
-      output_final_lists(list_possibilities, groups)
+      calculate_list_totals(list_possibilities, groups)
     end
 
-    private
+    def snake(groups)
+      unassigned_items = self.items.sort_by { |item, price| price }.to_a
+      permutations = []
+      groups.times { permutations << {} }
+      until unassigned_items.empty? do
+        permutations.each do |permutation|
+          permutation[unassigned_items.last.first] = unassigned_items.last.last
+          unassigned_items.pop
+        end
+        permutations.reverse_each do |permutation|
+          permutation[unassigned_items.last.first] = unassigned_items.last.last unless unassigned_items.empty?
+          unassigned_items.pop
+        end
+      end
+      calculate_list_totals(permutations, groups)
+    end
+
+    def price_is_right(groups)
+      unassigned_items = self.items.sort_by { |item, price| price }.to_a
+      permutations = []
+      groups.times { permutations << {} }
+      permutations.each do |permutation|
+        total = 0
+        until total > target_amount(groups) || unassigned_items.empty? do
+          next_item = unassigned_items.pop
+          permutation[next_item.first] = next_item.last
+          total = permutation.values.reduce(:+).nil? ? 0 : permutation.values.reduce(:+)
+          if total > target_amount(groups)
+            permutation.delete(next_item.first)
+            unassigned_items << next_item
+          end unless permutation == permutations.last || permutation.count == 1
+        end
+      end
+      calculate_list_totals(permutations, groups)
+    end
 
     def target_amount(divisor)
       (self.items.values.reduce(:+) / divisor).round(2)
@@ -74,7 +114,7 @@ module DivvyUp
       output
     end
 
-    def output_final_lists(lists, groups)
+    def calculate_list_totals(lists, groups)
       output = []
       accounted_items = []
       until output.size == groups
@@ -88,5 +128,24 @@ module DivvyUp
       end
       output
     end
+
+    def determine_best_result(groups)
+      permute_result = permute(groups)
+      snake_result = snake(groups)
+      price_is_right_result = price_is_right(groups)
+      results = [permute_result, snake_result, price_is_right_result]
+      target = target_amount(groups)
+      result_differences = []
+      results.each do |result|
+        result_totals = []
+        result.each do |list|
+          result_totals << list.last
+        end
+        min_difference = (result_totals.min - target).abs
+        max_difference = (result_totals.max - target).abs
+        result_differences << (min_difference > max_difference ? min_difference : max_difference)
+      end
+      results[result_differences.index(result_differences.min)]
+    end
   end
 end

data/lib/divvy_up/version.rb

@@ -1,3 +1,3 @@
 module DivvyUp
-  VERSION = "0.0.1"
+  VERSION = "0.1.0"
 end

data/spec/divvy_up/list_spec.rb

@@ -42,7 +42,7 @@ module DivvyUp
                                    [{bananas: 2.40, pears: 3.20}, 5.60]])
     end
 
-    it "split a list into three groups" do
+    it "splits a list into three groups" do
       list = DivvyUp::List.new(shopping_list)
       expect(list.split(3)).to eql(
         [
@@ -52,5 +52,29 @@ module DivvyUp
         ]
       )
     end
+
+    it "splits a list using the 'snake' technique" do
+      shopping_list = { orange_juice: 3, colored_pepper: 1.99, spring_mix_7_oz: 4.99, pasta_sauce: 2.50, blueberries: 3.99, onion: 1.25 }
+      list = DivvyUp::List.new(shopping_list)
+      expect(list.split(3)).to eql(
+        [
+          [{spring_mix_7_oz: 4.99, onion: 1.25}, 6.24],
+          [{blueberries: 3.99, colored_pepper: 1.99}, 5.98],
+          [{orange_juice: 3, pasta_sauce: 2.5}, 5.5]
+        ]
+      )
+    end
+
+    it "splits a list using the 'price is right' technique" do
+      shopping_list = { milk: 2.49, bread: 1.99, cheese: 3.50, celery: 2.99, yogurt: 2.99, ham: 4.99, potatoes: 2, belvita_bars: 3.49, rice: 5, chicken: 6.49 }
+      list = DivvyUp::List.new(shopping_list)
+      expect(list.split(3)).to eql(
+        [
+          [{chicken: 6.49, rice: 5}, 11.49],
+          [{ham: 4.99, cheese: 3.5, belvita_bars: 3.49}, 11.98],
+          [{yogurt: 2.99, celery: 2.99, milk: 2.49, potatoes: 2, bread: 1.99}, 12.46]
+        ]
+      )
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: divvy_up
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Dave Powers
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-10 00:00:00.000000000 Z
+date: 2015-07-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -75,6 +75,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -105,7 +106,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.4
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Divvy up purchases to split amongst friends