measured 2.6.0 → 2.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2de9a5e120aaab53f71956ad225722ed2d5cdd01d018104b214af063eb22b149
-  data.tar.gz: f65f75ed06c7118f76da05d638782c8b0049f928e6ce0ce96f93e27673d3dd48
+  metadata.gz: 82ffeb317f95fc3c354f43453eabc91b138a5e4f1b50eec651775425a27316e5
+  data.tar.gz: c664577f19d2ab99b95f7c533fb46323b60390c1b34da1bc3602b27979cddff6
 SHA512:
-  metadata.gz: c445792e2670c86ab8526ba7021880c6bef7db3850be768aae8a54ff024b4e56816b24cd4df88f6748971b7e176bb5eceefa48234511d9fbb25f67a065966733
-  data.tar.gz: 3eae614b358b735a68a6d8a17088f252d7f9db11db3f31c8cbc2a3e4e54d1ac0441d0af2d2f69a44bcbe2654c8839356ac00bc6b7c929d6c3e857f7afbc91d6e
+  metadata.gz: 4ae4538c2b2e9b00403b6363d639a6f0959704c4702b65cca3d1cd33d714f2eaf14c4fa4aa446b6247e1f9b7cd7977bc80581115965b21abbd4972b10b2e3eea
+  data.tar.gz: ee33ab98e63f586bcf1ce299909e4cd6ecc0c6b434e3f2e48340d5dc9f2641a8c34bcc2dd695f9c75f162f413b6533456f6c0ab22d29b3c93c21c186e647b671

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+2.7.0
+-----
+
+* Raises an exception on cyclic conversions. (@arturopie)
+* Deduplicate strings loaded from the cache.
+* Deduplicate parsed units.
+
 2.6.0
 -----
 

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)

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

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

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?

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: measured
 version: !ruby/object:Gem::Version
-  version: 2.6.0
+  version: 2.7.0
 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-05-06 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