measured 2.6.0 → 2.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2de9a5e120aaab53f71956ad225722ed2d5cdd01d018104b214af063eb22b149
-  data.tar.gz: f65f75ed06c7118f76da05d638782c8b0049f928e6ce0ce96f93e27673d3dd48
+  metadata.gz: 5ec3f063994e56291a70f5b2726890e03b43ef00e512894a901bc8ea924ae895
+  data.tar.gz: 442e6cca31eb154cbe318287a64f9379ab987b9ddcd59629a2780960b52ea00d
 SHA512:
-  metadata.gz: c445792e2670c86ab8526ba7021880c6bef7db3850be768aae8a54ff024b4e56816b24cd4df88f6748971b7e176bb5eceefa48234511d9fbb25f67a065966733
-  data.tar.gz: 3eae614b358b735a68a6d8a17088f252d7f9db11db3f31c8cbc2a3e4e54d1ac0441d0af2d2f69a44bcbe2654c8839356ac00bc6b7c929d6c3e857f7afbc91d6e
+  metadata.gz: 141a1214a375f0af9ae4d92c1e9c51d77e2a98d2a174321ee9e85eb4387fa72c3c98c49dcc5448d6617f7cc7d6bdf67e9ca4f12772d7446cb00e827329108d4f
+  data.tar.gz: f5a34f7aa0baf05177f216089dd9b4443ca2b04eecda5c0b72bf5899973a9a5a2a462b2e4f11ea7087dffcc8927e35835e9555da211bc628d50f76fadd110c35

data/.github/workflows/ci.yml

@@ -10,9 +10,9 @@ jobs:
     strategy:
       matrix:
         ruby:
-          - 2.5
-          - 2.6
-          - 2.7
+          - '2.6'
+          - '2.7'
+          - '3.0'
         gemfile:
           - Gemfile
           - gemfiles/activesupport-5.2.gemfile

data/CHANGELOG.md

@@ -1,3 +1,33 @@
+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
+-----
+
+* Drop support for Ruby 2.5
+* Use Ruby 3.0.2 for development
+
+2.7.1
+-----
+
+* Fix Ruby 3.0 compatibility
+
+2.7.0
+-----
+
+* Raises an exception on cyclic conversions. (@arturopie)
+* Deduplicate strings loaded from the cache.
+* Deduplicate parsed units.
+
 2.6.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/dev.yml

@@ -2,7 +2,7 @@ name: measured
 
 up:
   - ruby:
-      version: 2.6.3
+      version: 3.0.2
   - bundler
 
 commands:

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/base.rb

@@ -38,6 +38,7 @@ module Measured
 end
 
 require "measured/unit_error"
+require "measured/cycle_detected"
 require "measured/unit_already_added"
 require "measured/missing_conversion_path"
 require "measured/arithmetic"

data/lib/measured/cache/json.rb

@@ -14,7 +14,7 @@ module Measured::Cache
 
     def read
       return unless exist?
-      decode(JSON.load(File.read(@path)))
+      decode(JSON.load(File.read(@path), nil, freeze: true))
     end
 
     def write(table)
@@ -37,11 +37,17 @@ module Measured::Cache
     end
 
     def decode(table)
-      table.each_with_object(table.dup) do |(k1, v1), accu|
-        v1.each do |k2, v2|
-          if v2.is_a?(Hash)
-            accu[k1][k2] = Rational(v2["numerator"], v2["denominator"])
+      table.transform_values do |value1|
+        if value1.is_a?(Hash)
+          value1.transform_values do |value2|
+            if value2.is_a?(Hash)
+              Rational(value2["numerator"], value2["denominator"])
+            else
+              value2
+            end
           end
+        else
+          value1
         end
       end
     end

data/lib/measured/conversion_table_builder.rb

@@ -24,6 +24,8 @@ class Measured::ConversionTableBuilder
   private
 
   def generate_table
+    validate_no_cycles
+
     units.map(&:name).each_with_object({}) do |to_unit, table|
       to_table = {to_unit => Rational(1, 1)}
 
@@ -37,6 +39,23 @@ class Measured::ConversionTableBuilder
     end
   end
 
+  def validate_no_cycles
+    graph = units.select { |unit| unit.conversion_unit.present? }.group_by { |unit| unit.name }
+    validate_acyclic_graph(graph, from: graph.keys[0])
+  end
+
+  # This uses a depth-first search algorithm: https://en.wikipedia.org/wiki/Depth-first_search
+  def validate_acyclic_graph(graph, from:, visited: [])
+    graph[from]&.each do |edge|
+      adjacent_node = edge.conversion_unit
+      if visited.include?(adjacent_node)
+        raise Measured::CycleDetected.new(edge)
+      else
+        validate_acyclic_graph(graph, from: adjacent_node, visited: visited + [adjacent_node])
+      end
+    end
+  end
+
   def find_conversion(to:, from:)
     conversion = find_direct_conversion_cached(to: to, from: from) || find_tree_traversal_conversion(to: to, from: from)
 

data/lib/measured/cycle_detected.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+module Measured
+  class CycleDetected < UnitError
+    attr_reader :unit
+
+    def initialize(unit)
+      super("The following conversion introduces cycles in the unit system: #{unit}. Remove the conversion or fix the cycle.")
+      @unit = unit
+    end
+  end
+end

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/parser.rb

@@ -33,6 +33,6 @@ module Measured::Parser
 
     raise Measured::UnitError, "Cannot parse measurement from '#{string}'" unless result
 
-    [result.captures[0].to_r, result.captures[1]]
+    [result.captures[0].to_r, -result.captures[1]]
   end
 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.6.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/conversion_table_builder_test.rb

@@ -117,6 +117,16 @@ class Measured::ConversionTableBuilderTest < ActiveSupport::TestCase
     end
   end
 
+  test "#to_h raises exception when there are cycles" do
+    unit1 = Measured::Unit.new(:pallets, value: "1 liters")
+    unit2 = Measured::Unit.new(:liters, value: "0.1 cases")
+    unit3 = Measured::Unit.new(:cases, value: "0.1 pallets")
+
+    assert_raises(Measured::CycleDetected) do
+      Measured::ConversionTableBuilder.new([unit1, unit2, unit3]).to_h
+    end
+  end
+
   test "#cached? returns true if there's a cache" do
     builder = Measured::ConversionTableBuilder.new([Measured::Unit.new(:test)], cache: { class: AlwaysTrueCache })
     assert_predicate builder, :cached?

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.6.0
+  version: 2.8.1
 platform: ruby
 authors:
 - Kevin McPhillips
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-12-10 00:00:00.000000000 Z
+date: 2021-12-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -126,6 +126,7 @@ files:
 - lib/measured/cache/json_writer.rb
 - lib/measured/cache/null.rb
 - lib/measured/conversion_table_builder.rb
+- lib/measured/cycle_detected.rb
 - lib/measured/measurable.rb
 - lib/measured/missing_conversion_path.rb
 - lib/measured/parser.rb
@@ -179,7 +180,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.2.20
 signing_key: 
 specification_version: 4
 summary: Encapsulate measurements with their units in Ruby