active_shipping 1.11.0 → 1.11.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8af9e2153874a80f99898713503be8058c77beba
-  data.tar.gz: 44502b5f9555c1604dc1f59d822dd9a39d63943c
+  metadata.gz: db9e48561ceffa9fdbe447b4f87e2c6963a390c3
+  data.tar.gz: b723224d9f49d015405d9617ea2c3f6f019b4157
 SHA512:
-  metadata.gz: 234d7598e5596d9f0cea50f1923b8d678965a8b7b2b6c586c7c820948cb054480ee3a7d6e6a17fc835c6f79c180ba65338e7603d3a081b4d48d9bdefd9977397
-  data.tar.gz: 00ee373990ad7a7f95f998bc33ace440efdad4cfe65be76e5457fc39cd2b8fce353905becef31c3e5bcce9ec5365b717f6e4c7d2a2255af91db3e1d162d6d83a
+  metadata.gz: 6c42dfc9fe30274791e5e2afa140af5b37f4c619e478a62cc3daff9c2c39b28d4f1d048c29fcaac26b3c34d4cbacffb663bdbdb3851b97ea335cee25701e70e8
+  data.tar.gz: 71a56edd9faf22dc56561b01cbb267643a2bcfc2b02eab44cd034033106bd98d17dc78f1e057736b6bef0f79a36a98f6f61845ece0036ee6a1e61d7cc687d7b8

data/lib/active_shipping/shipment_packer.rb

@@ -11,63 +11,98 @@ module ActiveShipping
     # dimensions      - `[5.0, 15.0, 30.0]`
     # maximum_weight  - maximum weight in grams
     # currency        - ISO currency code
-    def self.pack(items, dimensions, maximum_weight, currency)
-      return [] if items.empty?
-      packages = []
-
-      # Naive in that it assumes weight is equally distributed across all items
-      # Should raise early enough in most cases
-      total_weight = 0
-      items.map!(&:symbolize_keys).each do |item|
-        total_weight += item[:quantity].to_i * item[:grams].to_i
-
-        if item[:grams].to_i > maximum_weight
-          raise OverweightItem, "The item with weight of #{item[:grams]}g is heavier than the allowable package weight of #{maximum_weight}g"
+
+    class << self
+      def pack(items, dimensions, maximum_weight, currency)
+        return [] if items.empty?
+        packages = []
+        items.map!(&:symbolize_keys)
+
+        # Naive in that it assumes weight is equally distributed across all items
+        # Should raise early enough in most cases
+        validate_total_weight(items, maximum_weight)
+        items_to_pack = items.map(&:dup).sort_by! { |i| i[:grams].to_i }
+
+        state = :package_empty
+        while state != :packing_finished
+          case state
+          when :package_empty
+            package_weight, package_value = 0, 0
+            state = :filling_package
+          when :filling_package
+            validate_package_quantity(packages.count)
+
+            items_to_pack.each do |item|
+              quantity = determine_fillable_quantity_for_package(item, maximum_weight, package_weight)
+              package_weight += item_weight(quantity, item[:grams])
+              package_value += item_value(quantity, item[:price])
+              item[:quantity] = item[:quantity].to_i - quantity
+            end
+
+            items_to_pack.reject! { |i| i[:quantity].to_i == 0 }
+            state = :package_full
+          when :package_full
+            packages << ActiveShipping::Package.new(package_weight, dimensions, value: package_value, currency: currency)
+            state = items_to_pack.any? ? :package_empty : :packing_finished
+          end
         end
 
-        if total_weight > maximum_weight * EXCESS_PACKAGE_QUANTITY_THRESHOLD
-          raise ExcessPackageQuantity, "Unable to pack more than #{EXCESS_PACKAGE_QUANTITY_THRESHOLD} packages"
+        packages
+      end
+
+      private
+
+      def validate_total_weight(items, maximum_weight)
+        total_weight = 0
+        items.each do |item|
+          total_weight += item[:quantity].to_i * item[:grams].to_i
+
+          if overweight_item?(item[:grams], maximum_weight)
+            raise OverweightItem, "The item with weight of #{item[:grams]}g is heavier than the allowable package weight of #{maximum_weight}g"
+          end
+
+          raise_excess_quantity_error if maybe_excess_package_quantity?(total_weight, maximum_weight)
         end
       end
 
-      items = items.map(&:dup).sort_by! { |i| i[:grams].to_i }
-
-      state = :package_empty
-      while state != :packing_finished
-        case state
-        when :package_empty
-          package_weight, package_value = 0, 0
-          state = :filling_package
-        when :filling_package
-          items.each do |item|
-            quantity = if item[:grams].to_i <= 0
-              item[:quantity].to_i
-            else
-              # Grab the max amount of this item we can fit into this package
-              # Or, if there are fewer than the max for this item, put
-              # what is left into this package
-              [(maximum_weight - package_weight) / item[:grams].to_i, item[:quantity].to_i].min
-            end
+      def validate_package_quantity(number_of_packages)
+        raise_excess_quantity_error if number_of_packages >= EXCESS_PACKAGE_QUANTITY_THRESHOLD
+      end
 
-            item_weight = quantity * item[:grams].to_i
-            item_value = quantity * Package.cents_from(item[:price])
+      def raise_excess_quantity_error
+        raise ExcessPackageQuantity, "Unable to pack more than #{EXCESS_PACKAGE_QUANTITY_THRESHOLD} packages"
+      end
 
-            package_weight += item_weight
-            package_value += item_value
+      def overweight_item?(grams, maximum_weight)
+        grams.to_i > maximum_weight
+      end
 
-            item[:quantity] = item[:quantity].to_i - quantity
-          end
+      def maybe_excess_package_quantity?(total_weight, maximum_weight)
+        total_weight > (maximum_weight * EXCESS_PACKAGE_QUANTITY_THRESHOLD)
+      end
 
-          items.reject! { |i| i[:quantity].to_i == 0 }
+      def determine_fillable_quantity_for_package(item, maximum_weight, package_weight)
+        item_grams = item[:grams].to_i
+        item_quantity = item[:quantity].to_i
 
-          state = :package_full
-        when :package_full
-          packages << ActiveShipping::Package.new(package_weight, dimensions, :value => package_value, :currency => currency)
-          state = items.any? ? :package_empty : :packing_finished
+        if item_grams <= 0
+          item_quantity
+        else
+          # Grab the max amount of this item we can fit into this package
+          # Or, if there are fewer than the max for this item, put
+          # what is left into this package
+          available_grams = (maximum_weight - package_weight).to_i
+          [available_grams / item_grams, item_quantity].min
         end
       end
 
-      packages
+      def item_weight(quantity, grams)
+        quantity * grams.to_i
+      end
+
+      def item_value(quantity, price)
+        quantity * Package.cents_from(price)
+      end
     end
   end
 end

data/lib/active_shipping/version.rb

@@ -1,3 +1,3 @@
 module ActiveShipping
-  VERSION = "1.11.0"
+  VERSION = "1.11.1"
 end

data/test/unit/shipment_packer_test.rb

@@ -6,7 +6,7 @@ class ShipmentPackerTest < Minitest::Test
   end
 
   def test_pack_divide_order_into_a_single_package
-    items = [{:grams => 1, :quantity => 1, :price => 1.0}]
+    items = [{ grams: 1, quantity: 1, price: 1.0 }]
 
     packages = ShipmentPacker.pack(items, @dimensions, 1, 'USD')
     assert_equal 1, packages.size
@@ -16,7 +16,7 @@ class ShipmentPackerTest < Minitest::Test
   end
 
   def test_divide_order_with_multiple_lines_into_a_single_package
-    items = [{:grams => 1, :quantity => 2, :price => 1.0}]
+    items = [{ grams: 1, quantity: 2, price: 1.0 }]
 
     packages = ShipmentPacker.pack(items, @dimensions, 2, 'USD')
     assert_equal 1, packages.size
@@ -26,7 +26,7 @@ class ShipmentPackerTest < Minitest::Test
   end
 
   def test_divide_order_with_single_line_into_two_packages
-    items = [{:grams => 1, :quantity => 2, :price => 1.0}]
+    items = [{ grams: 1, quantity: 2, price: 1.0 }]
 
     packages = ShipmentPacker.pack(items, @dimensions, 1, 'USD')
     assert_equal 2, packages.size
@@ -36,10 +36,23 @@ class ShipmentPackerTest < Minitest::Test
     end
   end
 
+  def test_divide_order_with_single_line_into_two_packages_max_weight_as_float
+    max_weight = 68038.8555
+
+    items = [{ grams: 45359, quantity: 2, price: 1.0 }]
+
+    packages = ShipmentPacker.pack(items, @dimensions, max_weight, 'USD')
+    assert_equal 2, packages.size
+
+    packages.each do |package|
+      assert_equal 45359, package.weight
+    end
+  end
+
   def test_divide_order_with_multiple_lines_into_two_packages
     items = [
-      {:grams => 1, :quantity => 1, :price => 1.0},
-      {:grams => 1, :quantity => 1, :price => 1.0}
+      { grams: 1, quantity: 1, price: 1.0 },
+      { grams: 1, quantity: 1, price: 1.0 }
     ]
 
     packages = ShipmentPacker.pack(items, @dimensions, 1, 'USD')
@@ -52,9 +65,9 @@ class ShipmentPackerTest < Minitest::Test
 
   def test_divide_order_into_two_packages_mixing_line_items
     items = [
-      {:grams => 1, :quantity => 1, :price => 1.0},
-      {:grams => 1, :quantity => 1, :price => 1.0},
-      {:grams => 1, :quantity => 1, :price => 1.0}
+      { grams: 1, quantity: 1, price: 1.0 },
+      { grams: 1, quantity: 1, price: 1.0 },
+      { grams: 1, quantity: 1, price: 1.0 }
     ]
 
     packages = ShipmentPacker.pack(items, @dimensions, 2, 'USD')
@@ -66,16 +79,16 @@ class ShipmentPackerTest < Minitest::Test
 
   def test_raise_overweight_exception_when_a_single_item_exceeds_the_maximum_weight_of_a_package
     assert_raises(ShipmentPacker::OverweightItem) do
-      items = [{:grams => 2, :quantity => 1, :price => 1.0}]
+      items = [{ grams: 2, quantity: 1, price: 1.0 }]
       ShipmentPacker.pack(items, @dimensions, 1, 'USD')
     end
   end
 
   def test_raise_over_weight_exceptions_before_over_package_limit_exceptions
-      assert_raises(ShipmentPacker::OverweightItem) do
-        items = [{:grams => 5, :quantity => ShipmentPacker::EXCESS_PACKAGE_QUANTITY_THRESHOLD + 1, :price => 1.0}]
-        ShipmentPacker.pack(items, @dimensions, 4, 'USD')
-      end
+    assert_raises(ShipmentPacker::OverweightItem) do
+      items = [{ grams: 5, quantity: ShipmentPacker::EXCESS_PACKAGE_QUANTITY_THRESHOLD + 1, price: 1.0 }]
+      ShipmentPacker.pack(items, @dimensions, 4, 'USD')
+    end
   end
 
   def test_returns_an_empty_list_when_no_items_provided
@@ -84,8 +97,8 @@ class ShipmentPackerTest < Minitest::Test
 
   def test_add_summarized_prices_for_all_items_and_currency_to_package
     items = [
-      {:grams => 1, :quantity => 3, :price => 1.0},
-      {:grams => 2, :quantity => 1, :price => 2.0}
+      { grams: 1, quantity: 3, price: 1.0 },
+      { grams: 2, quantity: 1, price: 2.0 }
     ]
     packages = ShipmentPacker.pack(items, @dimensions, 5, 'USD')
     assert_equal 1, packages.size
@@ -95,9 +108,9 @@ class ShipmentPackerTest < Minitest::Test
 
   def test_divide_items_and_prices_accordingly_when_splitting_into_two_packages
     items = [
-      {:grams => 1, :quantity => 1, :price => 1.0},
-      {:grams => 1, :quantity => 1, :price => 1.0},
-      {:grams => 1, :quantity => 1, :price => 1.0}
+      { grams: 1, quantity: 1, price: 1.0 },
+      { grams: 1, quantity: 1, price: 1.0 },
+      { grams: 1, quantity: 1, price: 1.0 }
     ]
 
     packages = ShipmentPacker.pack(items, @dimensions, 2, 'USD')
@@ -110,8 +123,8 @@ class ShipmentPackerTest < Minitest::Test
   end
 
   def test_symbolize_item_keys
-    string_key_items          = [{'grams' => 1, 'quantity' => 1, 'price' => 1.0}]
-    indifferent_access_items  = [{'grams' => 1, 'quantity' => 1, 'price' => 1.0}.with_indifferent_access]
+    string_key_items          = [{ 'grams' => 1, 'quantity' => 1, 'price' => 1.0 }]
+    indifferent_access_items  = [{ 'grams' => 1, 'quantity' => 1, 'price' => 1.0 }.with_indifferent_access]
 
     [string_key_items, indifferent_access_items].each do |items|
       packages = ShipmentPacker.pack(items, @dimensions, 1, 'USD')
@@ -124,7 +137,7 @@ class ShipmentPackerTest < Minitest::Test
   end
 
   def test_cast_quantity_and_grams_to_int
-    items = [{:grams => '1', :quantity => '1', :price => '1.0'}]
+    items = [{ grams: '1', quantity: '1', price: '1.0' }]
 
     packages = ShipmentPacker.pack(items, @dimensions, 1, 'USD')
 
@@ -133,15 +146,40 @@ class ShipmentPackerTest < Minitest::Test
     assert_equal 100, package.value
   end
 
-  def test_excess_packages
+  def test_excess_packages_raised_over_threshold_before_packing_begins
+    ActiveShipping::Package.expects(:new).never
+    items = [{ grams: 1, quantity: ShipmentPacker::EXCESS_PACKAGE_QUANTITY_THRESHOLD + 1, price: 1.0 }]
+
     assert_raises(ShipmentPacker::ExcessPackageQuantity) do
-      items = [{:grams => 1, :quantity => ShipmentPacker::EXCESS_PACKAGE_QUANTITY_THRESHOLD + 1, :price => 1.0}]
       ShipmentPacker.pack(items, @dimensions, 1, 'USD')
     end
   end
 
+  def test_excess_packages_not_raised_at_threshold
+    items = [{ grams: 1, quantity: ShipmentPacker::EXCESS_PACKAGE_QUANTITY_THRESHOLD, price: 1.0 }]
+    packages = ShipmentPacker.pack(items, @dimensions, 1, 'USD')
+
+    assert_predicate packages, :present?
+  end
+
+  def test_excess_packages_not_raised_below_threshold
+    items = [{ grams: 1, quantity: ShipmentPacker::EXCESS_PACKAGE_QUANTITY_THRESHOLD - 1, price: 1.0 }]
+    packages = ShipmentPacker.pack(items, @dimensions, 1, 'USD')
+
+    assert_predicate packages, :present?
+  end
+
+  def test_excess_packages_with_slightly_larger_max_weight_than_item_weight
+    max_weight = 750
+    items = [{ grams: 500, quantity: ShipmentPacker::EXCESS_PACKAGE_QUANTITY_THRESHOLD + 1, price: 1.0 }]
+
+    assert_raises(ShipmentPacker::ExcessPackageQuantity) do
+      ShipmentPacker.pack(items, @dimensions, max_weight, 'USD')
+    end
+  end
+
   def test_lots_of_zero_weight_items
-    items = [{:grams => 0, :quantity => 1_000_000, :price => 1.0}]
+    items = [{ grams: 0, quantity: 1_000_000, price: 1.0 }]
     packages = ShipmentPacker.pack(items, @dimensions, 1, 'USD')
 
     assert_equal 1, packages.size
@@ -150,7 +188,7 @@ class ShipmentPackerTest < Minitest::Test
   end
 
   def test_dont_destroy_input_items
-    items = [{:grams => 1, :quantity => 5, :price => 1.0}]
+    items = [{ grams: 1, quantity: 5, price: 1.0 }]
 
     packages = ShipmentPacker.pack(items, @dimensions, 10, 'USD')
 
@@ -159,14 +197,14 @@ class ShipmentPackerTest < Minitest::Test
   end
 
   def test_dont_modify_input_item_quantities
-    items = [{:grams => 1, :quantity => 5, :price => 1.0}]
+    items = [{ grams: 1, quantity: 5, price: 1.0 }]
 
     ShipmentPacker.pack(items, @dimensions, 10, 'USD')
     assert_equal 5, items.first[:quantity]
   end
 
   def test_items_with_negative_weight
-    items = [{:grams => -1, :quantity => 5, :price => 1.0}]
+    items = [{ grams: -1, quantity: 5, price: 1.0 }]
 
     ShipmentPacker.pack(items, @dimensions, 10, 'USD')
     assert_equal 5, items.first[:quantity]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: active_shipping
 version: !ruby/object:Gem::Version
-  version: 1.11.0
+  version: 1.11.1
 platform: ruby
 authors:
 - Shopify
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-02-13 00:00:00.000000000 Z
+date: 2017-02-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: quantified