physical 0.3.3 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 436cc77723f0d4fd9fed0af142621244e8503eb2
-  data.tar.gz: ac7630ca5e91fb68d494659180994853445e5f76
+  metadata.gz: 69552008d60146d8d2aff0d47ae732a1baf06d3f
+  data.tar.gz: 4bdd77b725a51cf6aa989ddf34ca4b08fc92e5f6
 SHA512:
-  metadata.gz: 187cacca3d21bf5d18d65b5937ca3d29938947dec49580ef76fe3efe3cb4c2fd2e8844caf9ce0272526c9ae58eb5919b88755233b07096104b8dfda75688490a
-  data.tar.gz: a8a717b05c47c40eb866750f8852e22d5ce3bbd4389ace0f72190faa759119fa3fe80752d3a2c754acf95627de777b45903b20244ef6a03b192f16df5b2ebe7a
+  metadata.gz: 02e59b75eab848337c424e2c941a752d3328235987f65e031330de022cd50e04b41db8f5488c31bc614a0374e10627478b87a93db2e697f6b8319e633f25372c
+  data.tar.gz: eb257f74a3353fed64edf7579043e8dcf76a2d52b35653201841d05d091f528cbd66abd1faf4d2c5207557eb66c8e193c513aa6dbdaf47cabf30eec43b252849

data/CHANGELOG.md

@@ -0,0 +1,12 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [0.4.0] - 2019-07-10
+### Added
+- `Measured::Density` Type and density calculations [@tvdeyen](https://github.com/mamhoff/physical/pull/19)
+- Use `Measured::Density` Type when initializing `Physical::Package#void_fill_density` [@mamhoff](https://github.com/mamhoff/physical/pull/22)

data/lib/measured/density.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require 'measured'
+
+Measured::Density = Measured.build do
+  si_unit :kg_m3, aliases: [
+    :kilogram_per_cubic_meter,
+    :kilogram_per_cubic_metre,
+    :kilograms_per_cubic_meter,
+    :kilograms_per_cubic_metre
+  ]
+
+  unit :g_ml, aliases: [
+    :gram_per_milliliter,
+    :gram_per_millilitre,
+    :grams_per_milliliter,
+    :grams_per_millilitre
+  ], value: '1000 kg_m3'
+
+  # UPS Freight classes use pound per cubic feet as density unit
+  unit :lb_ft3, aliases: [
+    :lbs_ft3,
+    :pound_per_cubiq_foot,
+    :pound_per_cubiq_feet,
+    :pounds_per_cubiq_foot,
+    :pounds_per_cubiq_feet
+  ], value: '16.0184897305 kg_m3'
+end

data/lib/physical.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require "measured/density"
 require "physical/types"
 require "physical/version"
 require "physical/cuboid"

data/lib/physical/cuboid.rb

@@ -19,6 +19,12 @@ module Physical
       Measured::Volume(dimensions.map { |d| d.convert_to(:cm).value }.reduce(1, &:*), :ml)
     end
 
+    def density
+      return Measured::Density(Float::INFINITY, :g_ml) if volume.value.zero?
+      return Measured::Density(0.0, :g_ml) if volume.value.infinite?
+      Measured::Density(weight.convert_to(:g).value / volume.convert_to(:ml).value, :g_ml)
+    end
+
     def ==(other)
       id == other.id
     end

data/lib/physical/package.rb

@@ -5,14 +5,14 @@ module Physical
     extend Forwardable
     attr_reader :container, :items, :void_fill_density, :id
 
-    def initialize(id: nil, container: nil, items: [], void_fill_density: Measured::Weight(0, :g), dimensions: nil, weight: nil, properties: {})
+    def initialize(id: nil, container: nil, items: [], void_fill_density: Measured::Density(0, :g_ml), dimensions: nil, weight: nil, properties: {})
       @id = id || SecureRandom.uuid
-      @void_fill_density = Types::Weight[void_fill_density]
+      @void_fill_density = Types::Density[void_fill_density]
       @container = container || Physical::Box.new(dimensions: dimensions || [], weight: weight || Measured::Weight(0, :g), properties: properties)
       @items = Set[*items]
     end
 
-    delegate [:dimensions, :width, :length, :height, :properties] => :container
+    delegate [:dimensions, :width, :length, :height, :properties, :volume] => :container
 
     def <<(item)
       @items.add(item)
@@ -35,7 +35,13 @@ module Physical
     def void_fill_weight
       return Measured::Weight(0, :g) if container.volume.value.infinite?
 
-      Measured::Weight(void_fill_density.value * remaining_volume.value, void_fill_density.unit)
+      Measured::Weight(void_fill_density.convert_to(:g_ml).value * remaining_volume.convert_to(:ml).value, :g)
+    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/spec_support/factories/box_factory.rb

@@ -4,7 +4,7 @@ require 'factory_bot'
 
 FactoryBot.define do
   factory :physical_box, class: "Physical::Box" do
-    dimensions { [4, 5, 6].map { |d| Measured::Length(d, :dm) } }
+    dimensions { [20, 15, 30].map { |d| Measured::Length(d, :cm) } }
     inner_dimensions { dimensions.map { |d| d - Measured::Length(1, :cm) } }
     weight { Measured::Weight(0.1, :kg) }
     initialize_with { new(attributes) }

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

@@ -8,7 +8,7 @@ FactoryBot.define do
   factory :physical_package, class: "Physical::Package" do
     container { FactoryBot.build(:physical_box) }
     items { build_list(:physical_item, 2) }
-    void_fill_density { Measured::Weight(0.01, :g) }
+    void_fill_density { Measured::Density(0.01, :g_ml) }
     initialize_with { new(attributes) }
   end
 end

data/lib/physical/types.rb

@@ -8,6 +8,7 @@ module Physical
     Weight = Types.Instance(::Measured::Weight)
     Length = Types.Instance(::Measured::Length)
     Volume = Types.Instance(::Measured::Volume)
+    Density = Types.Instance(::Measured::Density)
 
     Dimensions = Types::Strict::Array.of(Length)
   end

data/lib/physical/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: physical
 version: !ruby/object:Gem::Version
-  version: 0.3.3
+  version: 0.4.0
 platform: ruby
 authors:
 - Martin Meyerhoff
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-07-01 00:00:00.000000000 Z
+date: 2019-07-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: carmen
@@ -127,6 +127,7 @@ files:
 - ".rubocop.yml"
 - ".ruby-version"
 - ".travis.yml"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
@@ -134,6 +135,7 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- lib/measured/density.rb
 - lib/physical.rb
 - lib/physical/box.rb
 - lib/physical/cuboid.rb