measured 2.8.0 → 2.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 474f40f00059e15ec826a6ac74758ea6919f3b3c61a75bc42bcf181f9ac357dc
-  data.tar.gz: 356026fb5443a773928dbe21ac20f28f97ed72a987f6708b682cb665eeb511fc
+  metadata.gz: 5ec3f063994e56291a70f5b2726890e03b43ef00e512894a901bc8ea924ae895
+  data.tar.gz: 442e6cca31eb154cbe318287a64f9379ab987b9ddcd59629a2780960b52ea00d
 SHA512:
-  metadata.gz: be4796ff68ae8e99abdd8361c68c79624e5b6b10f143a3314edc834e28cd79aa8c6f2c5707d49564d42c8d80fd0521a3db38023cd688a70e733a8f737991ff22
-  data.tar.gz: 56a1cf4956fc1eb5802bd74841dfcef1114eaf3514f1a0c3c3c9585aa7643e0c36f2ec287c8933c879ce4a5ecd2e1232ce2a4ea0e30f7cef7fc1a5cc90db69e8
+  metadata.gz: 141a1214a375f0af9ae4d92c1e9c51d77e2a98d2a174321ee9e85eb4387fa72c3c98c49dcc5448d6617f7cc7d6bdf67e9ca4f12772d7446cb00e827329108d4f
+  data.tar.gz: f5a34f7aa0baf05177f216089dd9b4443ca2b04eecda5c0b72bf5899973a9a5a2a462b2e4f11ea7087dffcc8927e35835e9555da211bc628d50f76fadd110c35

data/CHANGELOG.md

@@ -1,6 +1,15 @@
 Unreleased
 -----
 
+
+
+2.8.1
+-----
+
+* Allow format without the conversion string. (@saraid)
+* Add special case for zero coercion to allow direct use of `sum` method. (@jmortlock)
+* Add useful numeric methods `finite?`, `infinite?`, `zero?`, `nonzero?`, `positive?` and `negative?`. (@jmortlock)
+
 2.8.0
 -----
 

data/README.md

@@ -149,6 +149,15 @@ Measured::Weight.new("3.14", "grams").format("%.1<value>f %<unit>s")
 
 If no string is passed to the `format` method it defaults to `"%.2<value>f %<unit>s"`.
 
+If the unit isn't the standard SI unit, it will include a conversion string.
+
+```ruby
+Measured::Weight.new("3.14", "kg").format
+> "3.14 kg (1000/1 g)"
+Measured::Weight.new("3.14", "kg").format(with_conversion_string: false)
+> "3.14 kg"
+```
+
 ## Units and conversions
 
 ### SI units support

data/lib/measured/arithmetic.rb

@@ -1,5 +1,8 @@
 # frozen_string_literal: true
 module Measured::Arithmetic
+  extend Forwardable
+  def_delegators :@value, :zero?, :positive?, :negative?, :finite?, :infinite?
+
   def +(other)
     arithmetic_operation(other, :+)
   end
@@ -19,6 +22,8 @@ module Measured::Arithmetic
   def coerce(other)
     if other.is_a?(self.class)
       [other, self]
+    elsif other.is_a?(Numeric) && other.zero?
+      [self.class.new(other, self.unit), self]
     else
       raise TypeError, "Cannot coerce #{other.class} to #{self.class}"
     end
@@ -28,6 +33,10 @@ module Measured::Arithmetic
     raise TypeError, "#{self.class} cannot be converted to an integer"
   end
 
+  def nonzero?
+    value.nonzero? ? self : false
+  end
+
   private
 
   def arithmetic_operation(other, operator)

data/lib/measured/measurable.rb

@@ -43,10 +43,10 @@ class Measured::Measurable < Numeric
     self.class.new(new_value, new_unit)
   end
 
-  def format(format_string=nil)
+  def format(format_string=nil, with_conversion_string: true)
     kwargs = {
       value: self.value,
-      unit: self.unit,
+      unit: self.unit.to_s(with_conversion_string: with_conversion_string),
     }
     (format_string || DEFAULT_FORMAT_STRING) % kwargs
   end

data/lib/measured/unit.rb

@@ -23,8 +23,8 @@ class Measured::Unit
     )
   end
 
-  def to_s
-    if @conversion_string
+  def to_s(with_conversion_string: true)
+    if with_conversion_string && @conversion_string
       "#{name} (#{@conversion_string})".freeze
     else
       name

data/lib/measured/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module Measured
-  VERSION = "2.8.0"
+  VERSION = "2.8.1"
 end

data/test/arithmetic_test.rb

@@ -8,6 +8,41 @@ class Measured::ArithmeticTest < ActiveSupport::TestCase
     @four = Magic.new(4, :magic_missile)
   end
 
+  test "should be able to sum same units" do
+    assert_equal Magic.new(9, :magic_missile), [@two, @three, @four].sum
+  end
+
+  test 'can check for finite?' do
+    assert Magic.new(0, :magic_missile).finite?
+    refute Magic.new(Float::INFINITY, :magic_missile).finite?
+  end
+
+  test 'can check for infinite?' do
+    assert Magic.new(Float::INFINITY, :magic_missile).infinite?
+    refute Magic.new(0, :magic_missile).infinite?
+  end
+
+  test 'can check for zero?' do
+    assert Magic.new(0, :magic_missile).zero?
+    refute Magic.new(1, :magic_missile).zero?
+  end
+
+  test 'can check for nonzero?' do
+    assert_equal Magic.new(10, :magic_missile), Magic.new(10, :magic_missile).nonzero?
+    assert Magic.new(10, :magic_missile).nonzero?
+    refute Magic.new(0, :magic_missile).nonzero?
+  end
+
+  test 'can check for positive?' do
+    assert Magic.new(1, :magic_missile).positive?
+    refute Magic.new(-1, :magic_missile).positive?
+  end
+
+  test 'can check for negative?' do
+    assert Magic.new(-1, :magic_missile).negative?
+    refute Magic.new(1, :magic_missile).negative?
+  end
+
   test "#+ should add together same units" do
     assert_equal Magic.new(5, :magic_missile), @two + @three
     assert_equal Magic.new(5, :magic_missile), @three + @two

data/test/measurable_test.rb

@@ -232,6 +232,11 @@ class Measured::MeasurableTest < ActiveSupport::TestCase
     assert_equal "9.34 magic_missile", Magic.new(9.342, :magic_missile).format
   end
 
+  test "#format can drop the conversion amount" do
+    assert_equal "1.00 fireball (2/3 magic_missile)", Magic.new(1, :fireball).format
+    assert_equal "1.00 fireball", Magic.new(1, :fireball).format(with_conversion_string: false)
+  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
@@ -246,12 +251,6 @@ class Measured::MeasurableTest < ActiveSupport::TestCase
     assert_equal "#<Magic: 1.234 #<Measured::Unit: magic_missile (magic_missiles, magic missile)>>", Magic.new(1.234, :magic_missile).inspect
   end
 
-  test "#zero? always returns false" do
-    refute_predicate Magic.new(0, :fire), :zero?
-    refute_predicate Magic.new(0.0, :fire), :zero?
-    refute_predicate Magic.new("0.0", :fire), :zero?
-  end
-
   test "#<=> compares regardless of the unit" do
     assert_equal (-1), @magic <=> Magic.new(20, :fire)
     assert_equal 1, @magic <=> Magic.new(9, :magic_missile)

data/test/unit_test.rb

@@ -43,6 +43,10 @@ class Measured::UnitTest < ActiveSupport::TestCase
     assert_equal "pie (1/2 sweet)", Measured::Unit.new(:pie, aliases: ["cake"], value: "0.5 sweet").to_s
   end
 
+  test "#to_s can drop the conversion amount" do
+    assert_equal "pie", Measured::Unit.new(:pie).to_s(with_conversion_string: false)
+  end
+
   test "#inspect returns an expected string" do
     assert_equal "#<Measured::Unit: pie>", Measured::Unit.new(:pie).inspect
     assert_equal "#<Measured::Unit: pie (cake, semi-sweet)>", Measured::Unit.new(:pie, aliases: ["cake", "semi-sweet"]).inspect

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: measured
 version: !ruby/object:Gem::Version
-  version: 2.8.0
+  version: 2.8.1
 platform: ruby
 authors:
 - Kevin McPhillips
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-11-08 00:00:00.000000000 Z
+date: 2021-12-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport