measured 2.3.0 → 2.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2957338dafe1bf300930f97c9d23678175281ec0
-  data.tar.gz: f52c802978510562bfaf3df79b122a79c230addf
+  metadata.gz: b181078ed94c22d305d95b445287def5a9ee7386
+  data.tar.gz: 2694f75fc2085f93c93075435ad1955b5f872e36
 SHA512:
-  metadata.gz: ad9b8f66e912f434c51d9a344a18adaa419e19b483ff4aaf7ab8df26f82cd644ca2f49aa5d3a2f5359491a36e58d62e5b0ee3a916b8f38ff1085b450ce4f1f4d
-  data.tar.gz: 7292c1dfe2357087eee0e15f043b2ce572fe655faa40c3ea1fc228b7d8a102d472f9b9c5bd2b81d0b82401ffeef2ddba6d961c1883d789d2937d831ae4d4b40d
+  metadata.gz: 961ab0ba4ac6cec71002b1c4a65a179880db5e8336a722aef32849ab6bf1a1f3bb2b137687ca3a8e4fd651d90b76ab1616d6306f03e3a12d82e64c248ae377c7
+  data.tar.gz: 757eba32db074dfba1712fd1c9c751630d5f5bae413dbb9fea0735bc0255f63fd28ca1a8b39aea9057b308acc14d3de7330305b1711ef45f87d4bdcf4b8f879f

data/.travis.yml

@@ -6,9 +6,12 @@ rvm:
   - 2.2.4
   - 2.3.1
   - 2.4.0
+  - 2.5.0
 gemfile:
   - Gemfile
   - gemfiles/activesupport-4.2.gemfile
+before_script:
+  - gem update --system
 matrix:
   exclude:
     - gemfile: Gemfile

data/Rakefile

@@ -8,9 +8,12 @@ task default: :test
 
 desc 'Run the test stuite'
 Rake::TestTask.new do |t|
+  files = ARGV[1..-1]
+  files = "test/**/*_test.rb" if !files || files.length == 0
+
   t.libs << "test"
   t.libs << "lib/**/*"
-  t.test_files = FileList['test/**/*_test.rb']
+  t.test_files = FileList[files]
   t.verbose = true
 end
 

data/dev.yml

@@ -14,5 +14,5 @@ commands:
       if [[ $# -eq 0 ]]; then
         bundle exec rake test
       else
-        bundle exec ruby -Itest "$@"
+        bundle exec rake test "$@"
       fi

data/lib/measured/base.rb

@@ -1,3 +1,4 @@
+require "forwardable"
 require "measured/version"
 require "active_support/all"
 require "bigdecimal"
@@ -42,5 +43,5 @@ require "measured/parser"
 require "measured/unit"
 require "measured/unit_system"
 require "measured/unit_system_builder"
-require "measured/conversion_table"
+require "measured/conversion_table_builder"
 require "measured/measurable"

data/lib/measured/conversion_table_builder.rb

@@ -0,0 +1,80 @@
+class Measured::ConversionTableBuilder
+  attr_reader :units
+
+  def initialize(units)
+    @units = units
+  end
+
+  def to_h
+    table = {}
+
+    units.map{|u| u.name}.each do |to_unit|
+      to_table = {to_unit => Rational(1, 1)}
+
+      table.each do |from_unit, from_table|
+        conversion = find_conversion(to: from_unit, from: to_unit)
+        to_table[from_unit] = conversion
+        from_table[to_unit] = 1 / conversion
+      end
+
+      table[to_unit] = to_table
+    end
+
+    table
+  end
+
+  private
+
+  def find_conversion(to:, from:)
+    conversion = find_direct_conversion_cached(to: to, from: from) || find_tree_traversal_conversion(to: to, from: from)
+
+    raise Measured::UnitError, "Cannot find conversion path from #{ from } to #{ to }." unless conversion
+
+    conversion
+  end
+
+  def find_direct_conversion_cached(to:, from:)
+    @cache ||= {}
+    @cache[to] ||= {}
+
+    if @cache[to].key?(from)
+       @cache[to][from]
+    else
+      @cache[to][from] = find_direct_conversion(to: to, from: from)
+    end
+  end
+
+  def find_direct_conversion(to:, from:)
+    units.each do |unit|
+      return unit.conversion_amount if unit.name == from && unit.conversion_unit == to
+      return unit.inverse_conversion_amount if unit.name == to && unit.conversion_unit == from
+    end
+
+    nil
+  end
+
+  def find_tree_traversal_conversion(to:, from:)
+    traverse(from: from, to: to, units_remaining: units.map(&:name), amount: 1)
+  end
+
+  def traverse(from:, to:, units_remaining:, amount:)
+    units_remaining = units_remaining - [from]
+
+    units_remaining.each do |name|
+      conversion = find_direct_conversion_cached(from: from, to: name)
+
+      if conversion
+        new_amount = amount * conversion
+        if name == to
+          return new_amount
+        else
+          result = traverse(from: name, to: to, units_remaining: units_remaining, amount: new_amount)
+          return result if result
+        end
+      end
+    end
+
+    nil
+  end
+
+end

data/lib/measured/unit.rb

@@ -54,7 +54,7 @@ class Measured::Unit
   end
 
   def inverse_conversion_amount
-    @inverse_conversion_amount ||= 1 / conversion_amount
+    @inverse_conversion_amount ||= 1 / conversion_amount if conversion_amount
   end
 
   private

data/lib/measured/unit_system.rb

@@ -3,6 +3,7 @@ class Measured::UnitSystem
 
   def initialize(units)
     @units = units.map { |unit| unit.with_unit_system(self) }
+    @conversion_table_builder = Measured::ConversionTableBuilder.new(@units)
   end
 
   def unit_names_with_aliases
@@ -43,7 +44,7 @@ class Measured::UnitSystem
   protected
 
   def conversion_table
-    @conversion_table ||= Measured::ConversionTable.build(@units)
+    @conversion_table ||= @conversion_table_builder.to_h
   end
 
   def unit_name_to_unit

data/lib/measured/version.rb

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

data/measured.gemspec

@@ -6,10 +6,10 @@ require 'measured/version'
 Gem::Specification.new do |spec|
   spec.name          = "measured"
   spec.version       = Measured::VERSION
-  spec.authors       = ["Kevin McPhillips"]
-  spec.email         = ["github@kevinmcphillips.ca"]
+  spec.authors       = ["Kevin McPhillips", "Jason Gedge", "Javier Honduvilla Coto"]
+  spec.email         = ["gems@shopify.com"]
   spec.summary       = %q{Encapsulate measurements with their units in Ruby}
-  spec.description   = %q{Wrapper objects which encapsulate measurments and their associated units in Ruby.}
+  spec.description   = %q{Wrapper objects which encapsulate measurements and their associated units in Ruby.}
   spec.homepage      = "https://github.com/Shopify/measured"
   spec.license       = "MIT"
 

data/test/conversion_table_builder_test.rb

@@ -0,0 +1,118 @@
+require "test_helper"
+
+class Measured::ConversionTableBuilderTest < ActiveSupport::TestCase
+  test "#initialize creates a new object with the units" do
+    units = [Measured::Unit.new(:test)]
+
+    assert_equal units, Measured::ConversionTableBuilder.new(units).units
+  end
+
+  test "#to_h should return a hash for the simple case" do
+    conversion_table = Measured::ConversionTableBuilder.new([Measured::Unit.new(:test)]).to_h
+
+    expected = {
+      "test" => {"test" => Rational(1, 1)}
+    }
+
+    assert_equal expected, conversion_table
+    assert_instance_of Rational, conversion_table.values.first.values.first
+  end
+
+  test "#to_h returns expected nested hashes with BigDecimal conversion factors in a tiny data set" do
+    conversion_table = Measured::ConversionTableBuilder.new([
+      Measured::Unit.new(:m),
+      Measured::Unit.new(:cm, value: "0.01 m"),
+    ]).to_h
+
+    expected = {
+      "m" => {
+        "m" => Rational(1, 1),
+        "cm" => Rational(100, 1),
+      },
+      "cm" => {
+        "m" => Rational(1, 100),
+        "cm" => Rational(1, 1),
+      }
+    }
+
+    assert_equal expected, conversion_table
+
+    conversion_table.values.map(&:values).flatten.each do |value|
+      assert_instance_of Rational, value
+    end
+  end
+
+  test "#to_h returns expected nested hashes factors" do
+    conversion_table = Measured::ConversionTableBuilder.new([
+      Measured::Unit.new(:m),
+      Measured::Unit.new(:cm, value: "0.01 m"),
+      Measured::Unit.new(:mm, value: "0.001 m"),
+    ]).to_h
+
+    expected = {
+      "m" => {
+        "m" => Rational(1, 1),
+        "cm" => Rational(100, 1),
+        "mm" => Rational(1000, 1),
+      },
+      "cm" => {
+        "m" => Rational(1, 100),
+        "cm" => Rational(1, 1),
+        "mm" => Rational(10, 1),
+      },
+      "mm" => {
+        "m" => Rational(1, 1000),
+        "cm" => Rational(1, 10),
+        "mm" => Rational(1, 1),
+      }
+    }
+
+    assert_equal expected, conversion_table
+
+    conversion_table.values.map(&:values).flatten.each do |value|
+      assert_instance_of Rational, value
+    end
+  end
+
+  test "#to_h returns expected nested hashes in an indrect path" do
+    conversion_table = Measured::ConversionTableBuilder.new([
+      Measured::Unit.new(:mm),
+      Measured::Unit.new(:cm, value: "10 mm"),
+      Measured::Unit.new(:dm, value: "10 cm"),
+      Measured::Unit.new(:m, value: "10 dm"),
+    ]).to_h
+
+    expected = {
+      "m" => {
+        "m" => Rational(1, 1),
+        "dm" => Rational(10, 1),
+        "cm" => Rational(100, 1),
+        "mm" => Rational(1000, 1),
+      },
+      "cm" => {
+        "m" => Rational(1, 100),
+        "dm" => Rational(1, 10),
+        "cm" => Rational(1, 1),
+        "mm" => Rational(10, 1),
+      },
+      "dm" => {
+        "m" => Rational(1, 10),
+        "cm" => Rational(10, 1),
+        "dm" => Rational(1, 1),
+        "mm" => Rational(100, 1),
+      },
+      "mm" => {
+        "m" => Rational(1, 1000),
+        "dm" => Rational(1, 100),
+        "cm" => Rational(1, 10),
+        "mm" => Rational(1, 1),
+      }
+    }
+
+    assert_equal expected, conversion_table
+
+    conversion_table.values.map(&:values).flatten.each do |value|
+      assert_instance_of Rational, value
+    end
+  end
+end

data/test/test_helper.rb

@@ -2,7 +2,7 @@ require "measured"
 require "minitest/reporters"
 require "minitest/autorun"
 require "mocha/setup"
-require "pry"
+require "pry" unless ENV["CI"]
 
 ActiveSupport.test_order = :random
 

data/test/unit_test.rb

@@ -78,4 +78,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

metadata

@@ -1,14 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: measured
 version: !ruby/object:Gem::Version
-  version: 2.3.0
+  version: 2.4.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: 2018-01-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -94,10 +96,10 @@ 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: []
@@ -113,7 +115,7 @@ files:
 - lib/measured.rb
 - lib/measured/arithmetic.rb
 - lib/measured/base.rb
-- lib/measured/conversion_table.rb
+- lib/measured/conversion_table_builder.rb
 - lib/measured/measurable.rb
 - lib/measured/parser.rb
 - lib/measured/unit.rb
@@ -126,7 +128,7 @@ files:
 - measured.gemspec
 - shipit.rubygems.yml
 - test/arithmetic_test.rb
-- test/conversion_table_test.rb
+- test/conversion_table_builder_test.rb
 - test/measurable_test.rb
 - test/parser_test.rb
 - test/support/fake_system.rb
@@ -164,7 +166,7 @@ specification_version: 4
 summary: Encapsulate measurements with their units in Ruby
 test_files:
 - test/arithmetic_test.rb
-- test/conversion_table_test.rb
+- test/conversion_table_builder_test.rb
 - test/measurable_test.rb
 - test/parser_test.rb
 - test/support/fake_system.rb

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

data/test/conversion_table_test.rb

@@ -1,98 +0,0 @@
-require "test_helper"
-
-class Measured::ConversionTableTest < ActiveSupport::TestCase
-  test ".build should return a hash for the simple case" do
-    expected = {
-      "test" => {"test" => BigDecimal("1")}
-    }
-
-    assert_equal expected, Measured::ConversionTable.build([Measured::Unit.new(:test)])
-  end
-
-  test ".build returns expected nested hashes with BigDecimal conversion factors in a tiny data set" do
-    conversion_table = Measured::ConversionTable.build([
-      Measured::Unit.new(:m),
-      Measured::Unit.new(:cm, value: "0.01 m"),
-    ])
-
-    expected = {
-      "m" => {
-        "m" => BigDecimal("1"),
-        "cm" => BigDecimal("100"),
-      },
-      "cm" => {
-        "m" => BigDecimal("0.01"),
-        "cm" => BigDecimal("1"),
-      }
-    }
-
-    assert_equal expected, conversion_table
-  end
-
-  test ".build returns expected nested hashes with BigDecimal conversion factors" do
-    conversion_table = Measured::ConversionTable.build([
-      Measured::Unit.new(:m),
-      Measured::Unit.new(:cm, value: "0.01 m"),
-      Measured::Unit.new(:mm, value: "0.001 m"),
-    ])
-
-    expected = {
-      "m" => {
-        "m" => BigDecimal("1"),
-        "cm" => BigDecimal("100"),
-        "mm" => BigDecimal("1000"),
-      },
-      "cm" => {
-        "m" => BigDecimal("0.01"),
-        "cm" => BigDecimal("1"),
-        "mm" => BigDecimal("10"),
-      },
-      "mm" => {
-        "m" => BigDecimal("0.001"),
-        "cm" => BigDecimal("0.1"),
-        "mm" => BigDecimal("1"),
-      }
-    }
-
-    assert_equal expected, conversion_table
-  end
-
-  test ".build returns expected nested hashes with BigDecimal conversion factors in an indrect path" do
-    conversion_table = Measured::ConversionTable.build([
-      Measured::Unit.new(:mm),
-      Measured::Unit.new(:cm, value: "10 mm"),
-      Measured::Unit.new(:dm, value: "10 cm"),
-      Measured::Unit.new(:m, value: "10 dm"),
-    ])
-
-    expected = {
-      "m" => {
-        "m" => BigDecimal("1"),
-        "dm" => BigDecimal("10"),
-        "cm" => BigDecimal("100"),
-        "mm" => BigDecimal("1000"),
-      },
-      "cm" => {
-        "m" => BigDecimal("0.01"),
-        "dm" => BigDecimal("0.1"),
-        "cm" => BigDecimal("1"),
-        "mm" => BigDecimal("10"),
-      },
-      "dm" => {
-        "m" => BigDecimal("0.1"),
-        "cm" => BigDecimal("10"),
-        "dm" => BigDecimal("1"),
-        "mm" => BigDecimal("100"),
-      },
-      "mm" => {
-        "m" => BigDecimal("0.001"),
-        "dm" => BigDecimal("0.01"),
-        "cm" => BigDecimal("0.1"),
-        "mm" => BigDecimal("1"),
-      }
-    }
-
-    assert_equal expected, conversion_table
-  end
-
-end