measured 2.3.0 → 2.6.0

data/test/test_helper.rb

@@ -1,17 +1,19 @@
+# frozen_string_literal: true
+require "pry" unless ENV["CI"]
 require "measured"
 require "minitest/reporters"
 require "minitest/autorun"
-require "mocha/setup"
-require "pry"
+require "mocha/minitest"
 
 ActiveSupport.test_order = :random
 
 Minitest::Reporters.use! [Minitest::Reporters::ProgressReporter.new(color: true)]
 
+require "support/subclasses"
 require "support/fake_system"
+require "support/always_true_cache"
 
 class ActiveSupport::TestCase
-
   protected
 
   def assert_close_bigdecimal exp, act, delta = BigDecimal('0.000001')

data/test/unit_error_test.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require "test_helper"
 
 class Measured::UnitErrorTest < ActiveSupport::TestCase

data/test/unit_system_builder_test.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require "test_helper"
 
 class Measured::UnitSystemBuilderTest < ActiveSupport::TestCase
@@ -11,15 +12,17 @@ class Measured::UnitSystemBuilderTest < ActiveSupport::TestCase
   end
 
   test "#unit cannot add duplicate unit names" do
-    assert_raises Measured::UnitError do
+    error = assert_raises Measured::UnitAlreadyAdded do
       Measured.build do
         unit :m
         unit :in, aliases: [:inch], value: "0.0254 m"
         unit :in, aliases: [:thing], value: "123 m"
       end
     end
+    assert_equal("in", error.unit_name)
+    assert_equal("Unit in has already been added.", error.message)
 
-    assert_raises Measured::UnitError do
+    assert_raises Measured::UnitAlreadyAdded do
       Measured.build do
         unit :m
         unit :in, aliases: [:inch], value: "0.0254 m"
@@ -28,6 +31,19 @@ class Measured::UnitSystemBuilderTest < ActiveSupport::TestCase
     end
   end
 
+  test "#unit raises when cannot find conversion path" do
+    error = assert_raises Measured::MissingConversionPath do
+      Measured.build do
+        unit :m
+        unit :in, value: "0.0254 m"
+        unit :pallets, value: "5 cases"
+      end
+    end
+    assert_equal("pallets", error.from)
+    assert_equal("m", error.to)
+    assert_equal("Cannot find conversion path from pallets to m.", error.message)
+  end
+
   test "#unit is case sensitive" do
     measurable = Measured.build do
       unit :normal
@@ -38,6 +54,16 @@ class Measured::UnitSystemBuilderTest < ActiveSupport::TestCase
     assert_equal 'BOLD', measurable.unit_system.unit_for!(:BOLD).name
   end
 
+  test "#unit traverses aliases" do
+    measurable = Measured.build do
+      unit :piece, aliases: [:pieces]
+      unit :dozen, aliases: [:dz], value: "12 pieces"
+    end
+
+    assert_equal 12, measurable.unit_system.units.last.conversion_amount
+    assert_equal "piece", measurable.unit_system.units.last.conversion_unit
+  end
+
   test "#si_unit adds 21 new units" do
     measurable = Measured.build do
       unit :ft
@@ -54,7 +80,7 @@ class Measured::UnitSystemBuilderTest < ActiveSupport::TestCase
     end
 
     prefixes = Measured::UnitSystemBuilder::SI_PREFIXES.map { |short, _, _| "#{short}ft" }
-    prefixes += %w(in ft) 
+    prefixes += %w(in ft)
     assert_equal prefixes.sort, measurable.unit_names
   end
 
@@ -109,4 +135,24 @@ class Measured::UnitSystemBuilderTest < ActiveSupport::TestCase
     assert_equal (2240), measurable.unit_system.unit_for!(:long_ton).conversion_amount
     assert_equal "lb", measurable.unit_system.unit_for!(:long_ton).conversion_unit
   end
+
+  test "#cache sets no cache by default" do
+    measurable = Measured.build do
+      unit :m
+      unit :km, value: "1000 m"
+    end
+
+    refute_predicate measurable.unit_system, :cached?
+  end
+
+  test "#cache sets the class and args" do
+    measurable = Measured.build do
+      unit :m
+      unit :km, value: "1000 m"
+
+      cache AlwaysTrueCache
+    end
+
+    assert_predicate measurable.unit_system, :cached?
+  end
 end

data/test/unit_system_test.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require "test_helper"
 
 class Measured::UnitSystemTest < ActiveSupport::TestCase
@@ -99,4 +100,18 @@ class Measured::UnitSystemTest < ActiveSupport::TestCase
   test "#convert handles the same unit" do
     assert_equal 2, @conversion.convert(2, from: @unit_in, to: @unit_in)
   end
+
+  test "#update_cache calls the builder" do
+    Measured::ConversionTableBuilder.any_instance.expects(:update_cache)
+    @conversion.update_cache
+  end
+
+  test "#cached? calls the builder and is false" do
+    refute_predicate @conversion, :cached?
+  end
+
+  test "#cached? calls the builder and is true" do
+    conversion = Measured::UnitSystem.new([@unit_m, @unit_in, @unit_ft], cache: { class: AlwaysTrueCache })
+    assert_predicate conversion, :cached?
+  end
 end

data/test/unit_test.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require "test_helper"
 
 class Measured::UnitTest < ActiveSupport::TestCase
@@ -78,4 +79,8 @@ class Measured::UnitTest < ActiveSupport::TestCase
   test "#inverse_conversion_amount returns 1/amount" do
     assert_equal Rational(1, 10), @unit.inverse_conversion_amount
   end
+
+  test "#inverse_conversion_amount handles nil for base unit" do
+    assert_nil Measured::Unit.new(:pie).inverse_conversion_amount
+  end
 end

data/test/units/length_test.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require "test_helper"
 
 class Measured::LengthTest < ActiveSupport::TestCase
@@ -142,7 +143,7 @@ class Measured::LengthTest < ActiveSupport::TestCase
   end
 
   test ".convert_to from km to mi" do
-    assert_conversion Measured::Length, "2000 km", "0.1242742384475E4 mi" 
+    assert_conversion Measured::Length, "2000 km", "0.1242742384475E4 mi"
   end
 
   test ".convert_to from km to mm" do
@@ -150,7 +151,7 @@ class Measured::LengthTest < ActiveSupport::TestCase
   end
 
   test ".convert_to from km to yd" do
-    assert_conversion Measured::Length, "2000 km", "0.218722659667542E7 yd" 
+    assert_conversion Measured::Length, "2000 km", "0.218722659667542E7 yd"
   end
 
   test ".convert_to from m to cm" do
@@ -206,7 +207,7 @@ class Measured::LengthTest < ActiveSupport::TestCase
   end
 
   test ".convert_to from mi to mi" do
-    assert_exact_conversion Measured::Length, "2000 mi", "2000 mi" 
+    assert_exact_conversion Measured::Length, "2000 mi", "2000 mi"
   end
 
   test ".convert_to from mi to mm" do
@@ -214,7 +215,7 @@ class Measured::LengthTest < ActiveSupport::TestCase
   end
 
   test ".convert_to from mi to yd" do
-    assert_exact_conversion Measured::Length, "2000 mi", "3520000 yd" 
+    assert_exact_conversion Measured::Length, "2000 mi", "3520000 yd"
   end
 
   test ".convert_to from mm to cm" do

data/test/units/volume_test.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require "test_helper"
 
 class Measured::VolumeTest < ActiveSupport::TestCase
@@ -68,7 +69,7 @@ class Measured::VolumeTest < ActiveSupport::TestCase
   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 
+    assert_equal expected_units.sort, Measured::Volume.unit_names
   end
 
   test ".name" do
@@ -95,7 +96,7 @@ class Measured::VolumeTest < ActiveSupport::TestCase
   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
@@ -123,7 +124,7 @@ class Measured::VolumeTest < ActiveSupport::TestCase
   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
@@ -303,7 +304,7 @@ class Measured::VolumeTest < ActiveSupport::TestCase
   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
@@ -387,4 +388,4 @@ class Measured::VolumeTest < ActiveSupport::TestCase
   test ".convert_to from oz to us_oz" do
     assert_conversion Measured::Volume, "2 oz", "1.9215207864 us_oz"
   end
-end
+end

data/test/units/weight_test.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require "test_helper"
 
 class Measured::WeightTest < ActiveSupport::TestCase

metadata

@@ -1,14 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: measured
 version: !ruby/object:Gem::Version
-  version: 2.3.0
+  version: 2.6.0
 platform: ruby
 authors:
 - Kevin McPhillips
+- Jason Gedge
+- Javier Honduvilla Coto
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-01-17 00:00:00.000000000 Z
+date: 2020-12-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -16,14 +18,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '5.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '5.2'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -70,16 +72,16 @@ dependencies:
   name: mocha
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.1.0
+        version: 1.4.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.1.0
+        version: 1.4.0
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -94,29 +96,42 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Wrapper objects which encapsulate measurments and their associated units
+description: Wrapper objects which encapsulate measurements and their associated units
   in Ruby.
 email:
-- github@kevinmcphillips.ca
+- gems@shopify.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ci.yml"
 - ".gitignore"
-- ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE
 - README.md
 - Rakefile
+- cache/.keep
+- cache/length.json
+- cache/volume.json
+- cache/weight.json
 - dev.yml
-- gemfiles/activesupport-4.2.gemfile
+- gemfiles/activesupport-5.2.gemfile
+- gemfiles/activesupport-6.0.gemfile
+- gemfiles/activesupport-6.1.gemfile
 - lib/measured.rb
 - lib/measured/arithmetic.rb
 - lib/measured/base.rb
-- lib/measured/conversion_table.rb
+- lib/measured/cache/json.rb
+- lib/measured/cache/json_writer.rb
+- lib/measured/cache/null.rb
+- lib/measured/conversion_table_builder.rb
 - lib/measured/measurable.rb
+- lib/measured/missing_conversion_path.rb
 - lib/measured/parser.rb
 - lib/measured/unit.rb
+- lib/measured/unit_already_added.rb
+- lib/measured/unit_error.rb
 - lib/measured/unit_system.rb
 - lib/measured/unit_system_builder.rb
 - lib/measured/units/length.rb
@@ -126,10 +141,16 @@ files:
 - measured.gemspec
 - shipit.rubygems.yml
 - test/arithmetic_test.rb
-- test/conversion_table_test.rb
+- test/cache/json_test.rb
+- test/cache/json_writer_test.rb
+- test/cache/null_test.rb
+- test/cache_consistency_test.rb
+- test/conversion_table_builder_test.rb
 - test/measurable_test.rb
 - test/parser_test.rb
+- test/support/always_true_cache.rb
 - test/support/fake_system.rb
+- test/support/subclasses.rb
 - test/test_helper.rb
 - test/unit_error_test.rb
 - test/unit_system_builder_test.rb
@@ -141,7 +162,8 @@ files:
 homepage: https://github.com/Shopify/measured
 licenses:
 - MIT
-metadata: {}
+metadata:
+  allowed_push_host: https://rubygems.org
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -157,17 +179,22 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.14
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Encapsulate measurements with their units in Ruby
 test_files:
 - test/arithmetic_test.rb
-- test/conversion_table_test.rb
+- test/cache/json_test.rb
+- test/cache/json_writer_test.rb
+- test/cache/null_test.rb
+- test/cache_consistency_test.rb
+- test/conversion_table_builder_test.rb
 - test/measurable_test.rb
 - test/parser_test.rb
+- test/support/always_true_cache.rb
 - test/support/fake_system.rb
+- test/support/subclasses.rb
 - test/test_helper.rb
 - test/unit_error_test.rb
 - test/unit_system_builder_test.rb

data/.travis.yml

@@ -1,17 +0,0 @@
-language: ruby
-sudo: false
-cache: bundler
-rvm:
-  - 2.1.8
-  - 2.2.4
-  - 2.3.1
-  - 2.4.0
-gemfile:
-  - Gemfile
-  - gemfiles/activesupport-4.2.gemfile
-matrix:
-  exclude:
-    - gemfile: Gemfile
-      rvm: 2.1.8
-    - gemfile: gemfiles/activesupport-4.2.gemfile
-      rvm: 2.4.0

data/lib/measured/conversion_table.rb

@@ -1,65 +0,0 @@
-module Measured::ConversionTable
-  extend self
-
-  def build(units)
-    table = {}
-
-    units.map{|u| u.name}.each do |to_unit|
-      to_table = {to_unit => BigDecimal("1")}
-
-      table.each do |from_unit, from_table|
-        to_table[from_unit] = find_conversion(units, to: from_unit, from: to_unit)
-        from_table[to_unit] = find_conversion(units, to: to_unit, from: from_unit)
-      end
-
-      table[to_unit] = to_table
-    end
-
-    table
-  end
-
-  private
-
-  def find_conversion(units, to:, from:)
-    conversion = find_direct_conversion(units, to: to, from: from) || find_tree_traversal_conversion(units, to: to, from: from)
-
-    raise Measured::UnitError, "Cannot find conversion path from #{ from } to #{ to }." unless conversion
-
-    conversion
-  end
-
-  def find_direct_conversion(units, to:, from:)
-    units.each do |unit|
-      return unit.conversion_amount if unit.name == from && unit.conversion_unit == to
-    end
-
-    units.each do |unit|
-      return unit.inverse_conversion_amount if unit.name == to && unit.conversion_unit == from
-    end
-
-    nil
-  end
-
-  def find_tree_traversal_conversion(units, to:, from:)
-    traverse(units, from: from, to: to, unit_names: units.map(&:name), amount: 1)
-  end
-
-  def traverse(units, from:, to:, unit_names:, amount:)
-    unit_names = unit_names - [from]
-
-    unit_names.each do |name|
-      if conversion = find_direct_conversion(units, from: from, to: name)
-        new_amount = amount * conversion
-        if name == to
-          return new_amount
-        else
-          result = traverse(units, from: name, to: to, unit_names: unit_names, amount: new_amount)
-          return result if result
-        end
-      end
-    end
-
-    nil
-  end
-
-end