physical 0.4.9 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8198a4417d9f1dd923a4bfee9bf8695ecb1c270853182a92835e64c1b9f4e10c
-  data.tar.gz: 8a007792624c95421bce9a09abb978de1142b8a2bfbfe6cef049c860ca101416
+  metadata.gz: 03d9eb10ac73675e3aa2bac745e7a6d8a30f4b9c0c6cb810d4dac0235d0cc55f
+  data.tar.gz: ed902ddd5a9349009a43d0a883a5526f7097d759e742c6ff43b8baf904765f63
 SHA512:
-  metadata.gz: b39b9310b28cd5bd9cfe3ea0511f6c615f3c130060693296e6aa01b18d3c893c9cd1704954133e9655c6a47fbe66f636eabc95c4a012f1e34ae4a0e634f6c0b3
-  data.tar.gz: 4881137e7cd922d5a9e56bcaec2fd5701b1e21f3e4ed53528585c14a2c24e0f2b90d93b2b36c7327160dae03cdc9c3e0f3a6171abb898d17843de862bf1f02a1
+  metadata.gz: 52d08252ebda560e9abf682eb011c5e2281afbf0c3eead4acc650b9af8714555f465ffc9c613318eb2bed9e86caf72edddde1ad8edb5f26aea2233b7ebc38b96
+  data.tar.gz: cfdb971e4bdf9d1ce7c830b8f6da93614e630251ca7307f91baddf05353f43e1c1ef51aa84dc3db505ffb8221bf7fde68ee1e6348462e4fd9cacc9c820c2efb8

data/CHANGELOG.md

@@ -6,6 +6,14 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## Unreleased
 
+## [0.5.0] - 2023-12-19
+
+### Added
+- Introduce `Physical::Structure` class [#31]
+
+### Changed
+- Use legitimate state/zip in location factory [#30]
+
 ## [0.4.9] - 2023-08-02
 
 ### Added

data/lib/physical/package.rb

@@ -3,12 +3,13 @@
 module Physical
   class Package
     extend Forwardable
-    attr_reader :id, :container, :items, :void_fill_density, :items_weight, :used_volume
+    attr_reader :id, :container, :items, :void_fill_density, :items_weight, :used_volume, :description
 
-    def initialize(id: nil, container: nil, items: [], void_fill_density: Measured::Density(0, :g_ml), dimensions: nil, weight: nil, properties: {})
+    def initialize(id: nil, container: nil, items: [], void_fill_density: Measured::Density(0, :g_ml), dimensions: nil, weight: nil, description: nil, properties: {})
       @id = id || SecureRandom.uuid
       @void_fill_density = Types::Density[void_fill_density]
       @container = container || Physical::Box.new(dimensions: dimensions || [], weight: weight || Measured::Weight(0, :g), properties: properties)
+      @description = description
 
       @items = Set[*items]
       @items_weight = @items.map(&:weight).reduce(Measured::Weight(0, :g), &:+)

data/lib/physical/shipment.rb

@@ -7,17 +7,23 @@ module Physical
                 :destination,
                 :service_code,
                 :pallets,
+                :structures,
                 :packages,
                 :options
 
-    def initialize(id: nil, origin: nil, destination: nil, service_code: nil, pallets: [], packages: [], options: {})
+    def initialize(id: nil, origin: nil, destination: nil, service_code: nil, pallets: [], structures: [], packages: [], options: {})
       @id = id || SecureRandom.uuid
       @origin = origin
       @destination = destination
       @service_code = service_code
-      @pallets = pallets
+      @structures = structures
       @packages = packages
       @options = options
+
+      return unless pallets.any?
+
+      warn "[DEPRECATION] `pallets` is deprecated.  Please use `structures` instead."
+      @pallets = pallets
     end
   end
 end

data/lib/physical/spec_support/factories/location_factory.rb

@@ -4,15 +4,15 @@ FactoryBot.define do
   factory :physical_location, class: 'Physical::Location' do
     transient do
       country_code { 'US' }
-      region_code { 'IL' }
+      region_code { 'VA' }
     end
 
     name { 'Jane Doe' }
     company_name { 'Company' }
     address1 { '11 Lovely Street' }
-    address2 { 'South' }
+    address2 { 'Suite 100' }
     city { 'Herndon' }
-    sequence(:zip, 10_001, &:to_s)
+    zip { '20170' }
     phone { '555-555-0199' }
     email { 'jane@company.com' }
     region { country.subregions.coded(region_code) }

data/lib/physical/spec_support/factories/shipment_factory.rb

@@ -4,9 +4,14 @@ FactoryBot.define do
   factory :physical_shipment, class: "Physical::Shipment" do
     origin { FactoryBot.build(:physical_location) }
     destination { FactoryBot.build(:physical_location) }
-    pallets { build_list(:physical_pallet, 1) }
+    pallets { build_list(:physical_pallet, 1) } # deprecated, will be removed
     packages { build_list(:physical_package, 2) }
     service_code { "usps_priority_mail" }
     initialize_with { new(**attributes) }
+
+    trait :freight do
+      structures { build_list(:physical_structure, 1) }
+      service_code { "tforce_freight" }
+    end
   end
 end

data/lib/physical/spec_support/factories/structure_factory.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+FactoryBot.define do
+  factory :physical_structure, class: "Physical::Structure" do
+    container { FactoryBot.build(:physical_pallet) }
+    packages { build_list(:physical_package, 2) }
+    initialize_with { new(**attributes) }
+  end
+end

data/lib/physical/structure.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+module Physical
+  class Structure
+    extend Forwardable
+    attr_reader :id, :container, :packages, :packages_weight, :used_volume
+
+    def initialize(id: nil, container: nil, packages: [], dimensions: nil, weight: nil, properties: {})
+      @id = id || SecureRandom.uuid
+      @container = container || Physical::Pallet.new(dimensions: dimensions || [], weight: weight || Measured::Weight(0, :g), properties: properties)
+
+      @packages = Set[*packages]
+      @packages_weight = @packages.map(&:weight).reduce(Measured::Weight(0, :g), &:+)
+      @used_volume = @packages.map(&:volume).reduce(Measured::Volume(0, :ml), &:+)
+    end
+
+    delegate [:dimensions, :width, :length, :height, :properties, :volume] => :container
+
+    def <<(other)
+      @packages.add(other)
+      @packages_weight += other.weight
+      @used_volume += other.volume
+    end
+    alias_method :add, :<<
+
+    def >>(other)
+      @packages.delete(other)
+      @packages_weight -= other.weight
+      @used_volume -= other.volume
+    end
+    alias_method :delete, :>>
+
+    def weight
+      container.weight + packages_weight
+    end
+
+    # Cost is optional. We will only return an aggregate if all packages
+    # have items value defined. Otherwise we will return nil.
+    # @return Money
+    def packages_value
+      packages_cost = packages.map(&:items_value)
+      packages_cost.reduce(&:+) if packages_cost.compact.size == packages_cost.size
+    end
+
+    def remaining_volume
+      container.inner_volume - used_volume
+    end
+
+    def density
+      return Measured::Density(Float::INFINITY, :g_ml) if container.volume.value.zero?
+      return Measured::Density(0.0, :g_ml) if container.volume.value.infinite?
+
+      Measured::Density(weight.convert_to(:g).value / container.volume.convert_to(:ml).value, :g_ml)
+    end
+  end
+end

data/lib/physical/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Physical
-  VERSION = "0.4.9"
+  VERSION = "0.5.0"
 end

data/lib/physical.rb

@@ -12,6 +12,7 @@ require "physical/pallet"
 require "physical/item"
 require "physical/location"
 require "physical/shipment"
+require "physical/structure"
 
 module Physical
   # Your code goes here...

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: physical
 version: !ruby/object:Gem::Version
-  version: 0.4.9
+  version: 0.5.0
 platform: ruby
 authors:
 - Martin Meyerhoff
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-08-02 00:00:00.000000000 Z
+date: 2023-12-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: carmen
@@ -207,9 +207,11 @@ files:
 - lib/physical/spec_support/factories/package_factory.rb
 - lib/physical/spec_support/factories/pallet_factory.rb
 - lib/physical/spec_support/factories/shipment_factory.rb
+- lib/physical/spec_support/factories/structure_factory.rb
 - lib/physical/spec_support/shared_examples.rb
 - lib/physical/spec_support/shared_examples/a_cuboid.rb
 - lib/physical/spec_support/shared_examples/has_property_readers.rb
+- lib/physical/structure.rb
 - lib/physical/test_support.rb
 - lib/physical/types.rb
 - lib/physical/version.rb
@@ -233,7 +235,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
+rubygems_version: 3.4.22
 signing_key:
 specification_version: 4
 summary: A facade to deal with physical packages