measured 2.2.0 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 227e9d20759502ed90e5b6bd95d892a71542d570
-  data.tar.gz: 2e5b68e45e7964f8adce521923e7123faca090f5
+  metadata.gz: 2957338dafe1bf300930f97c9d23678175281ec0
+  data.tar.gz: f52c802978510562bfaf3df79b122a79c230addf
 SHA512:
-  metadata.gz: 2963af5b95284dec84bbd839b319af12f42f6837d1056b02408fe6a61f862b81edf5a3ffbeea933d85e763b5fa685319653e8146eb917bf30df4e008bf440130
-  data.tar.gz: 8aec1fbe448c07efe04024896ae2802e9e3f7deeb55aa5cd0586c20c803a0289371d6ce2e5fbdd98f6a98deb1abcd39f45670f4a922c88f2e6bd36c93dc7ca36
+  metadata.gz: ad9b8f66e912f434c51d9a344a18adaa419e19b483ff4aaf7ab8df26f82cd644ca2f49aa5d3a2f5359491a36e58d62e5b0ee3a916b8f38ff1085b450ce4f1f4d
+  data.tar.gz: 7292c1dfe2357087eee0e15f043b2ce572fe655faa40c3ea1fc228b7d8a102d472f9b9c5bd2b81d0b82401ffeef2ddba6d961c1883d789d2937d831ae4d4b40d

data/README.md

@@ -141,6 +141,14 @@ Measured::Weight.unit_names_with_aliases
 > ["g", "gram", "grams", "kg", "kilogram", "kilograms", "lb", "lbs", "ounce", "ounces", "oz", "pound", "pounds"]
 ```
 
+String formatting:
+```ruby
+weight = Measured::Weight.new("3.14", "grams")
+weight.format("%.1<value>f %<unit>s")
+> "3.1 g"
+
+If no formatting string is passed, it uses `'%.2<value>f %<unit>s'`.
+```
 ## Units and conversions
 
 ### SI units support
@@ -183,6 +191,19 @@ There is support for SI units through the use of `si_unit`. Units declared throu
   * ft, foot, feet
   * yd, yard, yards
   * mi, mile, miles
+* `Measured::Volume`
+  * l, liter, litre, liters, litres, and all SI prefixes
+  * m3, cubic_meter, cubic_meters, cubic_metre, cubic_metres
+  * ft3, cubic_foot, cubic_feet
+  * in3, cubic_inch, cubic_inches
+  * gal, imp_gal, imperial_gallon, imp_gals, imperial_gallons
+  * us_gal, us_gallon, us_gals, us_gallons
+  * qt, imp_qt, imperial_quart, imp_qts, imperial_quarts
+  * us_qt, us_quart, us_quarts
+  * pt, imp_pt, imperial_pint, imp_pts, imperial_pints
+  * us_pt, us_pint, us_pints
+  * oz, fl_oz, imp_fl_oz, imperial_fluid_ounce, imperial_fluid_ounces
+  * us_oz, us_fl_oz, us_fluid_ounce, us_fluid_ounces 
 
 You can skip these and only define your own units by doing:
 

data/dev.yml

@@ -16,7 +16,3 @@ commands:
       else
         bundle exec ruby -Itest "$@"
       fi
-
-packages:
-  - git@github.com:Shopify/dev-shopify.git
-

data/lib/measured.rb

@@ -2,3 +2,4 @@ require "measured/base"
 
 require "measured/units/length"
 require "measured/units/weight"
+require "measured/units/volume"

data/lib/measured/measurable.rb

@@ -1,4 +1,6 @@
 class Measured::Measurable < Numeric
+  DEFAULT_FORMAT_STRING = '%.2<value>f %<unit>s'
+
   include Measured::Arithmetic
 
   attr_reader :unit, :value
@@ -28,6 +30,14 @@ class Measured::Measurable < Numeric
     self.class.new(new_value, new_unit)
   end
 
+  def format(format_string=nil)
+    kwargs = {
+      value: self.value,
+      unit: self.unit,
+    }
+    (format_string || DEFAULT_FORMAT_STRING) % kwargs
+  end
+
   def to_s
     @to_s ||= "#{value_string} #{unit.name}"
   end

data/lib/measured/units/volume.rb

@@ -0,0 +1,15 @@
+Measured::Volume = Measured.build do
+  si_unit :l, aliases: [:liter, :litre, :liters, :litres]
+
+  unit :m3, value: "1000 l", aliases: [:cubic_meter, :cubic_metre, :cubic_meters, :cubic_metres]
+  unit :in3, value: "0.016387064 l", aliases: [:cubic_inch, :cubic_inches]
+  unit :ft3, value: "1728 in3", aliases: [:cubic_foot, :cubic_feet]
+  unit :gal, value: "4.54609 l", aliases: [:imp_gal, :imperial_gallon, :imp_gals, :imperial_gallons]
+  unit :us_gal, value: "231 in3", aliases: [:us_gallon, :us_gals, :us_gallons]
+  unit :qt, value: "0.25 gal", aliases: [:imp_qt, :imperial_quart, :imp_qts, :imperial_quarts]
+  unit :us_qt, value: "0.25 us_gal", aliases: [:us_quart, :us_quarts]
+  unit :pt, value: "0.125 gal", aliases: [:imp_pt, :imperial_pint, :imp_pts, :imperial_pints]
+  unit :us_pt, value: "0.125 us_gal", aliases: [:us_pint, :us_pints]
+  unit :oz, value: "0.00625 gal", aliases: [:fl_oz, :imp_fl_oz, :imperial_fluid_ounce, :imperial_fluid_ounces]
+  unit :us_oz, value: "0.0078125 us_gal", aliases: [:us_fl_oz, :us_fluid_ounce, :us_fluid_ounces]
+end

data/lib/measured/version.rb

@@ -1,3 +1,3 @@
 module Measured
-  VERSION = "2.2.0"
+  VERSION = "2.3.0"
 end

data/test/measurable_test.rb

@@ -220,6 +220,18 @@ class Measured::MeasurableTest < ActiveSupport::TestCase
     assert_equal "9.3 fireball", Magic.new(9.3, :fire).to_s
   end
 
+  test "#format outputs a formatted string" do
+    measured_object = Magic.new(9.342, :magic_missile)
+    assert_equal "9.3", measured_object.format("%.1<value>f")
+    assert_equal "magic_missile", measured_object.format("%<unit>s")
+    assert_equal "9.34 magic_missile", measured_object.format("%.2<value>f %<unit>s")
+    assert_equal "9.342000 magic_missile", measured_object.format("%<value>f %<unit>s")
+  end
+
+  test "#format with no formatting string uses the default one" do
+    assert_equal "9.34 magic_missile", Magic.new(9.342, :magic_missile).format
+  end
+
   test "#humanize outputs the number and the unit properly pluralized" do
     assert_equal "1 fireball", Magic.new("1", :fire).humanize
     assert_equal "10 fireballs", Magic.new(10, :fire).humanize

data/test/units/volume_test.rb

@@ -0,0 +1,390 @@
+require "test_helper"
+
+class Measured::VolumeTest < ActiveSupport::TestCase
+  setup do
+    @volume = Measured::Volume.new(1, 'm3')
+  end
+
+  test ".unit_names_with_aliases should be the expected list of valid units" do
+    expected_units = %w(
+      m3
+      cubic_meter
+      cubic_metre
+      cubic_meters
+      cubic_metres
+      l
+      liter
+      litre
+      liters
+      litres
+      ft3
+      cubic_foot
+      cubic_feet
+      in3
+      cubic_inch
+      cubic_inches
+      gal
+      imp_gal
+      imperial_gallon
+      imp_gals
+      imperial_gallons
+      us_gal
+      us_gallon
+      us_gals
+      us_gallons
+      qt
+      imp_qt
+      imperial_quart
+      imp_qts
+      imperial_quarts
+      us_qt
+      us_quart
+      us_quarts
+      pt
+      imp_pt
+      imperial_pint
+      imp_pts
+      imperial_pints
+      us_pt
+      us_pint
+      us_pints
+      oz
+      fl_oz
+      imp_fl_oz
+      imperial_fluid_ounce
+      imperial_fluid_ounces
+      us_oz
+      us_fl_oz
+      us_fluid_ounce
+      us_fluid_ounces
+    )
+    expected_units += Measured::UnitSystemBuilder::SI_PREFIXES.flat_map do |short, long, _|
+      ["#{short}l", "#{long}liter", "#{long}litre", "#{long}liters", "#{long}litres"]
+    end
+
+    assert_equal expected_units.sort, Measured::Volume.unit_names_with_aliases
+  end
+
+  test ".unit_names should be the list of base unit names" do
+    expected_units = %w(l m3 ft3 in3 gal us_gal qt us_qt pt us_pt oz us_oz)
+    expected_units += Measured::UnitSystemBuilder::SI_PREFIXES.map { |short, _, _| "#{short}l" }
+    assert_equal expected_units.sort, Measured::Volume.unit_names 
+  end
+
+  test ".name" do
+    assert_equal "volume", Measured::Volume.name
+  end
+
+  test "Measured::Volume() delegates automatically to .new" do
+    assert_equal Measured::Volume.new(1, :ml), Measured::Volume(1, :ml)
+    assert_equal Measured::Volume.new(2, :fl_oz), Measured::Volume(2, :fl_oz)
+  end
+
+  test ".convert_to from ml to ml" do
+    assert_conversion Measured::Volume, "2000 ml", "2000 ml"
+  end
+
+  test ".convert_to from ft3 to ft3" do
+    assert_conversion Measured::Volume, "2000 ft3", "2000 ft3"
+  end
+
+  test ".convert_to from in3 to in3" do
+    assert_conversion Measured::Volume, "2000 in3", "2000 in3"
+  end
+
+  test ".convert_to from gal to gal" do
+    assert_conversion Measured::Volume, "2000 gal", "2000 gal"
+  end
+  
+  test ".convert_to from us_gal to us_gal" do
+    assert_conversion Measured::Volume, "2000 us_gal", "2000 us_gal"
+  end
+
+  test ".convert_to from qt to qt" do
+    assert_conversion Measured::Volume, "2000 qt", "2000 qt"
+  end
+
+  test ".convert_to from us_qt to us_qt" do
+    assert_conversion Measured::Volume, "2000 us_qt", "2000 us_qt"
+  end
+
+  test ".convert_to from pt to pt" do
+    assert_conversion Measured::Volume, "2000 pt", "2000 pt"
+  end
+
+  test ".convert_to from us_pt to us_pt" do
+    assert_conversion Measured::Volume, "2000 us_pt", "2000 us_pt"
+  end
+
+  test ".convert_to from oz to oz" do
+    assert_conversion Measured::Volume, "2000 oz", "2000 oz"
+  end
+
+  test ".convert_to from us_oz to us_oz" do
+    assert_conversion Measured::Volume, "2000 us_oz", "2000 us_oz"
+  end
+  
+  test ".convert_to from ml to m3" do
+    assert_conversion Measured::Volume, "2000 ml", "0.002 m3"
+  end
+
+  test ".convert_to from ml to ft3" do
+    assert_conversion Measured::Volume, "2000 ml", "0.07062933344 ft3"
+  end
+
+  test ".convert_to from ml to in3" do
+    assert_conversion Measured::Volume, "2000 ml", "122.0474881895 in3"
+  end
+
+  test ".convert_to from ml to gal" do
+    assert_conversion Measured::Volume, "2000 ml", "0.4399384966 gal"
+  end
+
+  test ".convert_to from ml to us_gal" do
+    assert_conversion Measured::Volume, "2000 ml", "0.5283441 us_gal"
+  end
+
+  test ".convert_to from ml to qt" do
+    assert_conversion Measured::Volume, "2000 ml", "1.759754 qt"
+  end
+
+  test ".convert_to from ml to us_qt" do
+    assert_conversion Measured::Volume, "2000 ml", "2.1133774149 us_qt"
+  end
+
+  test ".convert_to from ml to pt" do
+    assert_conversion Measured::Volume, "2000 ml", "3.519508 pt"
+  end
+
+  test ".convert_to from ml to us_pt" do
+    assert_conversion Measured::Volume, "2000 ml", "4.2267528377 us_pt"
+  end
+
+  test ".convert_to from ml to oz" do
+    assert_conversion Measured::Volume, "2000 ml", "70.39016 oz"
+  end
+
+  test ".convert_to from ml to us_oz" do
+    assert_conversion Measured::Volume, "2000 ml", "67.6280454037 us_oz"
+  end
+
+  test ".convert_to from m3 to ft3" do
+    assert_conversion Measured::Volume, "2 m3", "70.629333443 ft3"
+  end
+
+  test ".convert_to from m3 to in3" do
+    assert_conversion Measured::Volume, "2 m3", "122047.488189465 in3"
+  end
+
+  test ".convert_to from m3 to gal" do
+    assert_conversion Measured::Volume, "2 m3", "439.9384965982 gal"
+  end
+
+  test ".convert_to from m3 to us_gal" do
+    assert_conversion Measured::Volume, "2 m3", "528.3441047163 us_gal"
+  end
+
+  test ".convert_to from m3 to qt" do
+    assert_conversion Measured::Volume, "2 m3", "1759.7539863927 qt"
+  end
+
+  test ".convert_to from m3 to us_qt" do
+    assert_conversion Measured::Volume, "2 m3", "2113.3764188652 us_qt"
+  end
+
+  test ".convert_to from m3 to pt" do
+    assert_conversion Measured::Volume, "2 m3", "3519.5079727854 pt"
+  end
+
+  test ".convert_to from m3 to us_pt" do
+    assert_conversion Measured::Volume, "2 m3", "4226.7528377304 us_pt"
+  end
+
+  test ".convert_to from m3 to oz" do
+    assert_conversion Measured::Volume, "2 m3", "70390.1594557081 oz"
+  end
+
+  test ".convert_to from m3 to us_oz" do
+    assert_conversion Measured::Volume, "2 m3", "67628.045403686 us_oz"
+  end
+
+  test ".convert_to from ft3 to in3" do
+    assert_conversion Measured::Volume, "2 ft3", "3456 in3"
+  end
+
+  test ".convert_to from ft3 to gal" do
+    assert_conversion Measured::Volume, "2 ft3", "12.4576709181 gal"
+  end
+
+  test ".convert_to from ft3 to us_gal" do
+    assert_conversion Measured::Volume, "2 ft3", "14.961038961 us_gal"
+  end
+
+  test ".convert_to from ft3 to qt" do
+    assert_conversion Measured::Volume, "2 ft3", "49.8306836723 qt"
+  end
+
+  test ".convert_to from ft3 to us_qt" do
+    assert_conversion Measured::Volume, "2 ft3", "59.8441558442 us_qt"
+  end
+
+  test ".convert_to from ft3 to pt" do
+    assert_conversion Measured::Volume, "2 ft3", "99.6613673447 pt"
+  end
+
+  test ".convert_to from ft3 to us_pt" do
+    assert_conversion Measured::Volume, "2 ft3", "119.6883116883 us_pt"
+  end
+
+  test ".convert_to from ft3 to oz" do
+    assert_conversion Measured::Volume, "2 ft3", "1993.2273468937 oz"
+  end
+
+  test ".convert_to from ft3 to us_oz" do
+    assert_conversion Measured::Volume, "2 ft3", "1915.012987013 us_oz"
+  end
+
+  test ".convert_to from in3 to gal" do
+    assert_conversion Measured::Volume, "2 in3", "0.0072093003 gal"
+  end
+
+  test ".convert_to from in3 to us_gal" do
+    assert_conversion Measured::Volume, "2 in3", "0.008658008658 us_gal"
+  end
+
+  test ".convert_to from in3 to qt" do
+    assert_conversion Measured::Volume, "2 in3", "0.0288372012 qt"
+  end
+
+  test ".convert_to from in3 to us_qt" do
+    assert_conversion Measured::Volume, "2 in3", "0.03463203463 us_qt"
+  end
+
+  test ".convert_to from in3 to pt" do
+    assert_conversion Measured::Volume, "2 in3", "0.0576744024 pt"
+  end
+
+  test ".convert_to from in3 to us_pt" do
+    assert_conversion Measured::Volume, "2 in3", "0.06926406926 us_pt"
+  end
+
+  test ".convert_to from in3 to oz" do
+    assert_conversion Measured::Volume, "2 in3", "1.153488048 oz"
+  end
+
+  test ".convert_to from in3 to us_oz" do
+    assert_conversion Measured::Volume, "2 in3", "1.1082251082 us_oz"
+  end
+
+  test ".convert_to from gal to us_gal" do
+    assert_conversion Measured::Volume, "2 gal", "2.401899851 us_gal"
+  end
+
+  test ".convert_to from gal to qt" do
+    assert_conversion Measured::Volume, "2 gal", "8 qt"
+  end
+
+  test ".convert_to from gal to us_qt" do
+    assert_conversion Measured::Volume, "2 gal", "9.607599404 us_qt"
+  end
+
+  test ".convert_to from gal to pt" do
+    assert_conversion Measured::Volume, "2 gal", "16 pt"
+  end
+
+  test ".convert_to from gal to us_pt" do
+    assert_conversion Measured::Volume, "2 gal", "19.2151988081 us_pt"
+  end
+
+  test ".convert_to from gal to oz" do
+    assert_conversion Measured::Volume, "2 gal", "320 oz"
+  end
+
+  test ".convert_to from gal to us_oz" do
+    assert_conversion Measured::Volume, "2 gal", "307.4431809292 us_oz"
+  end
+  
+  test ".convert_to from us_gal to qt" do
+    assert_conversion Measured::Volume, "2 us_gal", "6.661393477 qt"
+  end
+
+  test ".convert_to from us_gal to us_qt" do
+    assert_conversion Measured::Volume, "2 us_gal", "8 us_qt"
+  end
+
+  test ".convert_to from us_gal to pt" do
+    assert_conversion Measured::Volume, "2 us_gal", "13.3227869541 pt"
+  end
+
+  test ".convert_to from us_gal to us_pt" do
+    assert_conversion Measured::Volume, "2 us_gal", "16 us_pt"
+  end
+
+  test ".convert_to from us_gal to oz" do
+    assert_conversion Measured::Volume, "2 us_gal", "266.4557390813 oz"
+  end
+
+  test ".convert_to from us_gal to us_oz" do
+    assert_conversion Measured::Volume, "2 us_gal", "256 us_oz"
+  end
+
+  test ".convert_to from qt to us_qt" do
+    assert_conversion Measured::Volume, "2 qt", "2.401899851 us_qt"
+  end
+
+  test ".convert_to from qt to pt" do
+    assert_conversion Measured::Volume, "2 qt", "4 pt"
+  end
+
+  test ".convert_to from qt to us_pt" do
+    assert_conversion Measured::Volume, "2 qt", "4.803799702 us_pt"
+  end
+
+  test ".convert_to from qt to oz" do
+    assert_conversion Measured::Volume, "2 qt", "80 oz"
+  end
+
+  test ".convert_to from qt to us_oz" do
+    assert_conversion Measured::Volume, "2 qt", "76.8607952323 us_oz"
+  end
+
+  test ".convert_to from us_qt to pt" do
+    assert_conversion Measured::Volume, "2 us_qt", "3.3306967385 pt"
+  end
+
+  test ".convert_to from us_qt to us_pt" do
+    assert_conversion Measured::Volume, "2 us_qt", "4 us_pt"
+  end
+
+  test ".convert_to from us_qt to oz" do
+    assert_conversion Measured::Volume, "2 us_qt", "66.6139347703 oz"
+  end
+
+  test ".convert_to from us_qt to us_oz" do
+    assert_conversion Measured::Volume, "2 us_qt", "64 us_oz"
+  end
+
+  test ".convert_to from pt to us_pt" do
+    assert_conversion Measured::Volume, "2 pt", "2.401899851 us_pt"
+  end
+
+  test ".convert_to from pt to oz" do
+    assert_conversion Measured::Volume, "2 pt", "40 oz"
+  end
+
+  test ".convert_to from pt to us_oz" do
+    assert_conversion Measured::Volume, "2 pt", "38.4303976162 us_oz"
+  end
+
+  test ".convert_to from us_pt to oz" do
+    assert_conversion Measured::Volume, "2 us_pt", "33.3069673852 oz"
+  end
+
+  test ".convert_to from us_pt to us_oz" do
+    assert_conversion Measured::Volume, "2 us_pt", "32 us_oz"
+  end
+
+  test ".convert_to from oz to us_oz" do
+    assert_conversion Measured::Volume, "2 oz", "1.9215207864 us_oz"
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: measured
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 2.3.0
 platform: ruby
 authors:
 - Kevin McPhillips
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-19 00:00:00.000000000 Z
+date: 2018-01-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -120,6 +120,7 @@ files:
 - lib/measured/unit_system.rb
 - lib/measured/unit_system_builder.rb
 - lib/measured/units/length.rb
+- lib/measured/units/volume.rb
 - lib/measured/units/weight.rb
 - lib/measured/version.rb
 - measured.gemspec
@@ -135,6 +136,7 @@ files:
 - test/unit_system_test.rb
 - test/unit_test.rb
 - test/units/length_test.rb
+- test/units/volume_test.rb
 - test/units/weight_test.rb
 homepage: https://github.com/Shopify/measured
 licenses:
@@ -156,7 +158,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2.1
+rubygems_version: 2.6.14
 signing_key: 
 specification_version: 4
 summary: Encapsulate measurements with their units in Ruby
@@ -172,4 +174,5 @@ test_files:
 - test/unit_system_test.rb
 - test/unit_test.rb
 - test/units/length_test.rb
+- test/units/volume_test.rb
 - test/units/weight_test.rb